lustre/include/lustre/lustreapi.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef _LUSTREAPI_H_
  38 #define _LUSTREAPI_H_
  39
  40 /** \defgroup llapi llapi
  41  *
  42  * @{
  43  */
  44
  45 #include <lustre/lustre_user.h>
  46
  47 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid, void *args);
  48
  49 /* lustreapi message severity level */
  50 enum llapi_message_level {
  51         LLAPI_MSG_OFF    = 0,
  52         LLAPI_MSG_FATAL  = 1,
  53         LLAPI_MSG_ERROR  = 2,
  54         LLAPI_MSG_WARN   = 3,
  55         LLAPI_MSG_NORMAL = 4,
  56         LLAPI_MSG_INFO   = 5,
  57         LLAPI_MSG_DEBUG  = 6,
  58         LLAPI_MSG_MAX
  59 };
  60
  61 /* the bottom three bits reserved for llapi_message_level */
  62 #define LLAPI_MSG_MASK          0x00000007
  63 #define LLAPI_MSG_NO_ERRNO      0x00000010
  64
  65 extern void llapi_msg_set_level(int level);
  66 extern void llapi_error(int level, int rc, char *fmt, ...);
  67 #define llapi_err_noerrno(level, fmt, a...)                             \
  68         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
  69 extern void llapi_printf(int level, char *fmt, ...);
  70 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
  71                              int stripe_offset, int stripe_count,
  72                              int stripe_pattern);
  73 extern int llapi_file_open(const char *name, int flags, int mode,
  74                            unsigned long long stripe_size, int stripe_offset,
  75                            int stripe_count, int stripe_pattern);
  76 extern int llapi_file_create_pool(const char *name,
  77                                   unsigned long long stripe_size,
  78                                   int stripe_offset, int stripe_count,
  79                                   int stripe_pattern, char *pool_name);
  80 extern int llapi_file_open_pool(const char *name, int flags, int mode,
  81                                 unsigned long long stripe_size,
  82                                 int stripe_offset, int stripe_count,
  83                                 int stripe_pattern, char *pool_name);
  84 extern int llapi_poollist(const char *name);
  85 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
  86                               char *buffer, int buffer_size);
  87 extern int llapi_get_poolmembers(const char *poolname, char **members,
  88                                  int list_size, char *buffer, int buffer_size);
  89 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
  90 #define HAVE_LLAPI_FILE_LOOKUP
  91 extern int llapi_file_lookup(int dirfd, const char *name);
  92
  93 #define VERBOSE_COUNT           0x1
  94 #define VERBOSE_SIZE            0x2
  95 #define VERBOSE_OFFSET          0x4
  96 #define VERBOSE_POOL            0x8
  97 #define VERBOSE_DETAIL          0x10
  98 #define VERBOSE_OBJID           0x20
  99 #define VERBOSE_GENERATION      0x40
 100 #define VERBOSE_MDTINDEX        0x80
 101 #define VERBOSE_LAYOUT          0x100
 102 #define VERBOSE_ALL             (VERBOSE_COUNT | VERBOSE_SIZE | \
 103                                  VERBOSE_OFFSET | VERBOSE_POOL | \
 104                                  VERBOSE_OBJID | VERBOSE_GENERATION |\
 105                                  VERBOSE_LAYOUT)
 106
 107 struct find_param {
 108         unsigned int             maxdepth;
 109         time_t                   atime;
 110         time_t                   mtime;
 111         time_t                   ctime;
 112         /* cannot be bitfields due to using pointers to */
 113         int                      asign;
 114         /* access them during argument parsing. */
 115         int                      csign;
 116         int                      msign;
 117         int                      type;
 118         /* these need to be signed values */
 119         int                      size_sign:2,
 120                                  stripesize_sign:2,
 121                                  stripecount_sign:2;
 122         unsigned long long       size;
 123         unsigned long long       size_units;
 124         uid_t                    uid;
 125         gid_t                    gid;
 126
 127         unsigned long            zeroend:1,
 128                                  recursive:1,
 129                                  exclude_pattern:1,
 130                                  exclude_type:1,
 131                                  exclude_obd:1,
 132                                  exclude_mdt:1,
 133                                  exclude_gid:1,
 134                                  exclude_uid:1,
 135                                  check_gid:1,           /* group ID */
 136                                  check_uid:1,           /* user ID */
 137                                  check_pool:1,          /* LOV pool name */
 138                                  check_size:1,          /* file size */
 139                                  exclude_pool:1,
 140                                  exclude_size:1,
 141                                  exclude_atime:1,
 142                                  exclude_mtime:1,
 143                                  exclude_ctime:1,
 144                                  get_lmv:1,     /* get MDT list from LMV */
 145                                  raw:1,         /* do not fill in defaults */
 146                                  check_stripesize:1,    /* LOV stripe size */
 147                                  exclude_stripesize:1,
 148                                  check_stripecount:1,   /* LOV stripe count */
 149                                  exclude_stripecount:1,
 150                                  check_layout:1,
 151                                  exclude_layout:1;
 152
 153         int                      verbose;
 154         int                      quiet;
 155
 156         /* regular expression */
 157         char                    *pattern;
 158
 159         char                    *print_fmt;
 160
 161         struct  obd_uuid        *obduuid;
 162         int                      num_obds;
 163         int                      num_alloc_obds;
 164         int                      obdindex;
 165         int                     *obdindexes;
 166
 167         struct  obd_uuid        *mdtuuid;
 168         int                      num_mdts;
 169         int                      num_alloc_mdts;
 170         int                      mdtindex;
 171         int                     *mdtindexes;
 172         int                      file_mdtindex;
 173
 174         int                      lumlen;
 175         struct  lov_user_mds_data       *lmd;
 176
 177         char                    poolname[LOV_MAXPOOLNAME + 1];
 178
 179         int                      fp_lmv_count;
 180         struct lmv_user_md      *fp_lmv_md;
 181
 182         unsigned long long       stripesize;
 183         unsigned long long       stripesize_units;
 184         unsigned long long       stripecount;
 185         __u32                    layout;
 186
 187         /* In-process parameters. */
 188         unsigned long            got_uuids:1,
 189                                  obds_printed:1,
 190                                  have_fileinfo:1; /* file attrs and LOV xattr */
 191         unsigned int             depth;
 192         dev_t                    st_dev;
 193         __u64                    padding1;
 194         __u64                    padding2;
 195         __u64                    padding3;
 196         __u64                    padding4;
 197 };
 198
 199 extern int llapi_ostlist(char *path, struct find_param *param);
 200 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
 201 extern int llapi_getstripe(char *path, struct find_param *param);
 202 extern int llapi_find(char *path, struct find_param *param);
 203
 204 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 205 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
 206                                  int stripe_count, int stripe_pattern,
 207                                  char *poolname);
 208 int llapi_direntry_remove(char *dname);
 209 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 210                      struct obd_statfs *stat_buf,
 211                      struct obd_uuid *uuid_buf);
 212 extern int llapi_ping(char *obd_type, char *obd_name);
 213 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
 214 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 215 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
 216 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 217 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 218 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 219 extern int llapi_is_lustre_mnttype(const char *type);
 220 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
 221 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
 222 extern int parse_size(char *optarg, unsigned long long *size,
 223                       unsigned long long *size_units, int bytes_spec);
 224 extern int llapi_search_mounts(const char *pathname, int index,
 225                                char *mntdir, char *fsname);
 226 extern int llapi_search_fsname(const char *pathname, char *fsname);
 227 extern int llapi_getname(const char *path, char *buf, size_t size);
 228
 229 extern void llapi_ping_target(char *obd_type, char *obd_name,
 230                               char *obd_uuid, void *args);
 231
 232 extern int llapi_search_rootpath(char *pathname, const char *fsname);
 233
 234 struct mntent;
 235 #define HAVE_LLAPI_IS_LUSTRE_MNT
 236 extern int llapi_is_lustre_mnt(struct mntent *mnt);
 237 extern int llapi_quotachown(char *path, int flag);
 238 extern int llapi_quotacheck(char *mnt, int check_type);
 239 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
 240 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 241 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
 242                                 llapi_cb_t cb);
 243 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 244 extern int llapi_lsetfacl(int argc, char *argv[]);
 245 extern int llapi_lgetfacl(int argc, char *argv[]);
 246 extern int llapi_rsetfacl(int argc, char *argv[]);
 247 extern int llapi_rgetfacl(int argc, char *argv[]);
 248 extern int llapi_cp(int argc, char *argv[]);
 249 extern int llapi_ls(int argc, char *argv[]);
 250 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
 251                           int pathlen, long long *recno, int *linkno);
 252 extern int llapi_path2fid(const char *path, lustre_fid *fid);
 253 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
 254
 255 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
 256 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 257 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
 258 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
 259 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
 260                                   __u32 archive_id);
 261 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
 262                                __u32 archive_id);
 263
 264 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
 265 static inline int llapi_create_volatile(char *directory, int mode)
 266 {
 267         return llapi_create_volatile_idx(directory, -1, mode);
 268 }
 269
 270
 271 extern int llapi_fswap_layouts(const int fd1, const int fd2,
 272                                __u64 dv1, __u64 dv2, __u64 flags);
 273 extern int llapi_swap_layouts(const char *path1, const char *path2,
 274                               __u64 dv1, __u64 dv2, __u64 flags);
 275
 276 /* Changelog interface.  priv is private state, managed internally
 277    by these functions */
 278 #define CHANGELOG_FLAG_FOLLOW 0x01   /* Not yet implemented */
 279 #define CHANGELOG_FLAG_BLOCK  0x02   /* Blocking IO makes sense in case of
 280    slow user parsing of the records, but it also prevents us from cleaning
 281    up if the records are not consumed. */
 282
 283 /* Records received are in extentded format now, though most of them are still
 284  * written in disk in changelog_rec format (to save space and time), it's
 285  * converted to extented format in the lustre api to ease changelog analysis. */
 286 #define HAVE_CHANGELOG_EXTEND_REC 1
 287
 288 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
 289                                  long long startrec);
 290 extern int llapi_changelog_fini(void **priv);
 291 extern int llapi_changelog_recv(void *priv, struct changelog_ext_rec **rech);
 292 extern int llapi_changelog_free(struct changelog_ext_rec **rech);
 293 /* Allow records up to endrec to be destroyed; requires registered id. */
 294 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
 295                                  long long endrec);
 296
 297 /* HSM copytool interface.
 298  * priv is private state, managed internally by these functions
 299  */
 300 struct hsm_copytool_private;
 301 extern int llapi_hsm_copytool_start(struct hsm_copytool_private **priv,
 302                                     char *fsname, int flags,
 303                                     int archive_count, int *archives);
 304 extern int llapi_hsm_copytool_fini(struct hsm_copytool_private **priv);
 305 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
 306                                    struct hsm_action_list **hal, int *msgsize);
 307 extern int llapi_hsm_copytool_free(struct hsm_action_list **hal);
 308 extern int llapi_hsm_copy_start(char *mnt, struct hsm_copy *copy,
 309                                 const struct hsm_action_item *hai);
 310 extern int llapi_hsm_copy_end(char *mnt, struct hsm_copy *copy,
 311                               const struct hsm_progress *hp);
 312 extern int llapi_hsm_progress(char *mnt, struct hsm_progress *hp);
 313 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
 314                             unsigned long long stripe_size, int stripe_offset,
 315                             int stripe_count, int stripe_pattern,
 316                             char *pool_name, lustre_fid *newfid);
 317
 318 /* HSM user interface */
 319 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
 320                                                              int data_len);
 321 extern int llapi_hsm_request(char *mnt, struct hsm_user_request *request);
 322 extern int llapi_hsm_current_action(const char *path,
 323                                     struct hsm_current_action *hca);
 324 /** @} llapi */
 325
 326 #endif
 327
 328
 329