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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef _LUSTREAPI_H_
  34 #define _LUSTREAPI_H_
  35
  36 /** \defgroup llapi llapi
  37  *
  38  * @{
  39  */
  40
  41 #include <stdarg.h>
  42 #include <stdint.h>
  43 #include <lustre/lustre_user.h>
  44
  45 #ifndef LL_MAXQUOTAS
  46 #define LL_MAXQUOTAS 3
  47 #endif
  48
  49 extern bool liblustreapi_initialized;
  50
  51
  52 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
  53                            void *args);
  54
  55 /* lustreapi message severity level */
  56 enum llapi_message_level {
  57         LLAPI_MSG_OFF    = 0,
  58         LLAPI_MSG_FATAL  = 1,
  59         LLAPI_MSG_ERROR  = 2,
  60         LLAPI_MSG_WARN   = 3,
  61         LLAPI_MSG_NORMAL = 4,
  62         LLAPI_MSG_INFO   = 5,
  63         LLAPI_MSG_DEBUG  = 6,
  64         LLAPI_MSG_MAX
  65 };
  66
  67 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
  68                                      const char *fmt, va_list ap);
  69
  70
  71 /* the bottom three bits reserved for llapi_message_level */
  72 #define LLAPI_MSG_MASK          0x00000007
  73 #define LLAPI_MSG_NO_ERRNO      0x00000010
  74
  75 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
  76 {
  77         static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
  78                                                     "WARNING", "NORMAL",
  79                                                     "INFO", "DEBUG"};
  80
  81         if (level >= LLAPI_MSG_MAX)
  82                 return NULL;
  83
  84         return levels[level];
  85 }
  86 extern void llapi_msg_set_level(int level);
  87 int llapi_msg_get_level(void);
  88 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
  89 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
  90
  91 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
  92         __attribute__((__format__(__printf__, 3, 4)));
  93 #define llapi_err_noerrno(level, fmt, a...)                     \
  94         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
  95 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
  96         __attribute__((__format__(__printf__, 2, 3)));
  97
  98 struct llapi_stripe_param {
  99         unsigned long long      lsp_stripe_size;
 100         char                    *lsp_pool;
 101         int                     lsp_stripe_offset;
 102         int                     lsp_stripe_pattern;
 103         /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
 104         int                     lsp_stripe_count;
 105         bool                    lsp_is_specific;
 106         __u32                   lsp_osts[0];
 107 };
 108
 109 extern int llapi_file_open_param(const char *name, int flags, mode_t mode,
 110                                  const struct llapi_stripe_param *param);
 111 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
 112                              int stripe_offset, int stripe_count,
 113                              int stripe_pattern);
 114 extern int llapi_file_open(const char *name, int flags, int mode,
 115                            unsigned long long stripe_size, int stripe_offset,
 116                            int stripe_count, int stripe_pattern);
 117 extern int llapi_file_create_pool(const char *name,
 118                                   unsigned long long stripe_size,
 119                                   int stripe_offset, int stripe_count,
 120                                   int stripe_pattern, char *pool_name);
 121 extern int llapi_file_open_pool(const char *name, int flags, int mode,
 122                                 unsigned long long stripe_size,
 123                                 int stripe_offset, int stripe_count,
 124                                 int stripe_pattern, char *pool_name);
 125 extern int llapi_poollist(const char *name);
 126 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
 127                               char *buffer, int buffer_size);
 128 extern int llapi_get_poolmembers(const char *poolname, char **members,
 129                                  int list_size, char *buffer, int buffer_size);
 130 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
 131 extern int llapi_file_lookup(int dirfd, const char *name);
 132
 133 #define VERBOSE_COUNT              0x1
 134 #define VERBOSE_SIZE               0x2
 135 #define VERBOSE_OFFSET             0x4
 136 #define VERBOSE_POOL               0x8
 137 #define VERBOSE_DETAIL            0x10
 138 #define VERBOSE_OBJID             0x20
 139 #define VERBOSE_GENERATION        0x40
 140 #define VERBOSE_MDTINDEX          0x80
 141 #define VERBOSE_LAYOUT           0x100
 142 #define VERBOSE_COMP_COUNT       0x200
 143 #define VERBOSE_COMP_FLAGS       0x400
 144 #define VERBOSE_COMP_START       0x800
 145 #define VERBOSE_COMP_END        0x1000
 146 #define VERBOSE_COMP_ID         0x2000
 147 #define VERBOSE_DFID            0x4000
 148 #define VERBOSE_HASH_TYPE       0x8000
 149 #define VERBOSE_DEFAULT         (VERBOSE_COUNT | VERBOSE_SIZE | \
 150                                  VERBOSE_OFFSET | VERBOSE_POOL | \
 151                                  VERBOSE_OBJID | VERBOSE_GENERATION | \
 152                                  VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
 153                                  VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
 154                                  VERBOSE_COMP_START | VERBOSE_COMP_END | \
 155                                  VERBOSE_COMP_ID)
 156
 157 struct find_param {
 158         unsigned int             fp_max_depth;
 159         dev_t                    fp_dev;
 160         mode_t                   fp_type; /* S_IFIFO,... */
 161         uid_t                    fp_uid;
 162         gid_t                    fp_gid;
 163         time_t                   fp_atime;
 164         time_t                   fp_mtime;
 165         time_t                   fp_ctime;
 166         /* {a,m,c}sign cannot be bitfields due to using pointers to
 167          * access them during argument parsing. */
 168         int                      fp_asign;
 169         int                      fp_msign;
 170         int                      fp_csign;
 171         /* these need to be signed values */
 172         int                      fp_size_sign:2,
 173                                  fp_stripe_size_sign:2,
 174                                  fp_stripe_count_sign:2,
 175                                  fp_comp_start_sign:2,
 176                                  fp_comp_end_sign:2,
 177                                  fp_comp_count_sign:2,
 178                                  fp_mdt_count_sign:2;
 179         unsigned long long       fp_size;
 180         unsigned long long       fp_size_units;
 181
 182         unsigned long long       fp_zero_end:1,
 183                                  fp_recursive:1,
 184                                  fp_exclude_pattern:1,
 185                                  fp_exclude_type:1,
 186                                  fp_exclude_obd:1,
 187                                  fp_exclude_mdt:1,
 188                                  fp_exclude_gid:1,
 189                                  fp_exclude_uid:1,
 190                                  fp_check_gid:1,
 191                                  fp_check_uid:1,
 192                                  fp_check_pool:1,       /* LOV pool name */
 193                                  fp_check_size:1,       /* file size */
 194                                  fp_exclude_pool:1,
 195                                  fp_exclude_size:1,
 196                                  fp_exclude_atime:1,
 197                                  fp_exclude_mtime:1,
 198                                  fp_exclude_ctime:1,
 199                                  fp_get_lmv:1,  /* get MDT list from LMV */
 200                                  fp_raw:1,      /* do not fill in defaults */
 201                                  fp_check_stripe_size:1, /* LOV stripe size */
 202                                  fp_exclude_stripe_size:1,
 203                                  fp_check_stripe_count:1, /* LOV stripe count */
 204                                  fp_exclude_stripe_count:1,
 205                                  fp_check_layout:1,
 206                                  fp_exclude_layout:1,
 207                                  fp_get_default_lmv:1, /* Get default LMV */
 208                                  fp_migrate:1,
 209                                  fp_check_comp_count:1,
 210                                  fp_exclude_comp_count:1,
 211                                  fp_check_comp_flags:1,
 212                                  fp_exclude_comp_flags:1,
 213                                  fp_check_comp_start:1,
 214                                  fp_exclude_comp_start:1,
 215                                  fp_check_comp_end:1,
 216                                  fp_exclude_comp_end:1,
 217                                  fp_check_comp_id:1,
 218                                  fp_exclude_comp_id:1,
 219                                  fp_check_mdt_count:1,
 220                                  fp_exclude_mdt_count:1,
 221                                  fp_check_hash_type:1,
 222                                  fp_exclude_hash_type:1;
 223
 224         int                      fp_verbose;
 225         int                      fp_quiet;
 226
 227         /* regular expression */
 228         char                    *fp_pattern;
 229
 230         struct  obd_uuid        *fp_obd_uuid;
 231         int                      fp_num_obds;
 232         int                      fp_num_alloc_obds;
 233         int                      fp_obd_index;
 234         int                     *fp_obd_indexes;
 235
 236         struct  obd_uuid        *fp_mdt_uuid;
 237         int                      fp_num_mdts;
 238         int                      fp_num_alloc_mdts;
 239         int                      fp_mdt_index;
 240         int                     *fp_mdt_indexes;
 241         int                      fp_file_mdt_index;
 242
 243         size_t                   fp_lum_size;
 244         struct  lov_user_mds_data *fp_lmd;
 245
 246         char                     fp_poolname[LOV_MAXPOOLNAME + 1];
 247
 248         __u32                    fp_lmv_stripe_count;
 249         struct lmv_user_md      *fp_lmv_md;
 250
 251         unsigned long long       fp_stripe_size;
 252         unsigned long long       fp_stripe_size_units;
 253         unsigned long long       fp_stripe_count;
 254         __u32                    fp_layout;
 255
 256         __u32                    fp_comp_count;
 257         __u32                    fp_comp_flags;
 258         __u32                    fp_comp_id;
 259         unsigned long long       fp_comp_start;
 260         unsigned long long       fp_comp_start_units;
 261         unsigned long long       fp_comp_end;
 262         unsigned long long       fp_comp_end_units;
 263         unsigned long long       fp_mdt_count;
 264
 265         /* In-process parameters. */
 266         unsigned long            fp_got_uuids:1,
 267                                  fp_obds_printed:1;
 268         unsigned int             fp_depth;
 269         unsigned int             fp_hash_type;
 270 };
 271
 272 extern int llapi_ostlist(char *path, struct find_param *param);
 273 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
 274 extern int llapi_getstripe(char *path, struct find_param *param);
 275 extern int llapi_find(char *path, struct find_param *param);
 276
 277 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 278 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
 279                                            int stripe_count, int stripe_pattern,
 280                                             const char *pool_name);
 281 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
 282                                  int stripe_count, int stripe_pattern,
 283                                  const char *poolname);
 284 int llapi_direntry_remove(char *dname);
 285
 286 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
 287                       struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
 288 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 289                      struct obd_statfs *stat_buf,
 290                      struct obd_uuid *uuid_buf);
 291 extern int llapi_ping(char *obd_type, char *obd_name);
 292 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
 293 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 294 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
 295 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 296 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 297 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 298 extern int llapi_is_lustre_mnttype(const char *type);
 299 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
 300 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
 301 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
 302                             unsigned long long *size_units, int bytes_spec);
 303 extern int llapi_search_mounts(const char *pathname, int index,
 304                                char *mntdir, char *fsname);
 305 extern int llapi_search_fsname(const char *pathname, char *fsname);
 306 extern int llapi_getname(const char *path, char *buf, size_t size);
 307 extern int llapi_search_fileset(const char *pathname, char *fileset);
 308
 309 extern int llapi_search_rootpath(char *pathname, const char *fsname);
 310 extern int llapi_nodemap_exists(const char *name);
 311 extern int llapi_migrate_mdt(char *path, struct find_param *param);
 312 extern int llapi_mv(char *path, struct find_param *param);
 313
 314 struct mntent;
 315 #define HAVE_LLAPI_IS_LUSTRE_MNT
 316 extern int llapi_is_lustre_mnt(struct mntent *mnt);
 317 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 318 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
 319                                 llapi_cb_t cb);
 320 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 321 extern int llapi_cp(int argc, char *argv[]);
 322 extern int llapi_ls(int argc, char *argv[]);
 323 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
 324                           int pathlen, long long *recno, int *linkno);
 325 extern int llapi_path2fid(const char *path, lustre_fid *fid);
 326 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
 327                                       int *mdt_index);
 328 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
 329 /* get FID of parent dir + the related name of entry in this parent dir */
 330 extern int llapi_path2parent(const char *path, unsigned int linkno,
 331                              lustre_fid *parent_fid, char *name,
 332                              size_t name_size);
 333 extern int llapi_fd2parent(int fd, unsigned int linkno,
 334                            lustre_fid *parent_fid, char *name,
 335                            size_t name_size);
 336 extern int llapi_chomp_string(char *buf);
 337 extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid,
 338                              int open_flags);
 339
 340 extern int llapi_get_version_string(char *version, unsigned int version_size);
 341 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
 342 extern int llapi_get_version(char *buffer, int buffer_size, char **version)
 343         __attribute__((deprecated));
 344 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 345 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
 346 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
 347 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
 348                                   __u32 archive_id);
 349 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
 350                                __u32 archive_id);
 351 extern int llapi_hsm_register_event_fifo(const char *path);
 352 extern int llapi_hsm_unregister_event_fifo(const char *path);
 353 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
 354                                 const char *fmt, va_list args);
 355
 356 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
 357 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
 358 static inline int llapi_create_volatile(char *directory, int mode)
 359 {
 360         return llapi_create_volatile_idx(directory, -1, mode);
 361 }
 362
 363
 364 extern int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
 365                                          int gid, __u64 flags);
 366 extern int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2,
 367                                __u64 flags);
 368 extern int llapi_swap_layouts(const char *path1, const char *path2,
 369                               __u64 dv1, __u64 dv2, __u64 flags);
 370
 371 /* Changelog interface.  priv is private state, managed internally by these
 372  * functions */
 373
 374 /* Records received are in extended format now, though most of them are still
 375  * written in disk in changelog_rec format (to save space and time), it's
 376  * converted to extended format in the lustre api to ease changelog analysis. */
 377 #define HAVE_CHANGELOG_EXTEND_REC 1
 378
 379 extern int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
 380                                  const char *mdtname, long long startrec);
 381 extern int llapi_changelog_fini(void **priv);
 382 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
 383 extern int llapi_changelog_free(struct changelog_rec **rech);
 384 extern int llapi_changelog_get_fd(void *priv);
 385 /* Allow records up to endrec to be destroyed; requires registered id. */
 386 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
 387                                  long long endrec);
 388
 389 /* HSM copytool interface.
 390  * priv is private state, managed internally by these functions
 391  */
 392 struct hsm_copytool_private;
 393 struct hsm_copyaction_private;
 394
 395 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 396                                        const char *mnt, int archive_count,
 397                                        int *archives, int rfd_flags);
 398 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
 399 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
 400 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
 401                                    struct hsm_action_list **hal, int *msgsize);
 402 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
 403                                   const struct hsm_copytool_private *ct,
 404                                   const struct hsm_action_item *hai,
 405                                   int restore_mdt_index, int restore_open_flags,
 406                                   bool is_error);
 407 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
 408                                 const struct hsm_extent *he,
 409                                 int hp_flags, int errval);
 410 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
 411                                      const struct hsm_extent *he, __u64 total,
 412                                      int hp_flags);
 413 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
 414                                      lustre_fid *fid);
 415 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
 416 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
 417                             unsigned long long stripe_size, int stripe_offset,
 418                             int stripe_count, int stripe_pattern,
 419                             char *pool_name, lustre_fid *newfid);
 420
 421 /* HSM user interface */
 422 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
 423                                                              int data_len);
 424 extern int llapi_hsm_request(const char *path,
 425                              const struct hsm_user_request *request);
 426 extern int llapi_hsm_current_action(const char *path,
 427                                     struct hsm_current_action *hca);
 428
 429 /* JSON handling */
 430 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
 431 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
 432 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
 433                                char *key, __u32 type, void *val);
 434 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
 435                                  FILE *fp);
 436
 437 /* File lease */
 438 extern int llapi_lease_get(int fd, int mode);
 439 extern int llapi_lease_check(int fd);
 440 extern int llapi_lease_put(int fd);
 441
 442 /* Group lock */
 443 int llapi_group_lock(int fd, int gid);
 444 int llapi_group_unlock(int fd, int gid);
 445
 446 /* Ladvise */
 447 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
 448                   struct llapi_lu_ladvise *ladvise);
 449 /** @} llapi */
 450
 451 /* llapi_layout user interface */
 452
 453 /** Opaque data type abstracting the layout of a Lustre file. */
 454 struct llapi_layout;
 455
 456 /*
 457  * Flags to control how layouts are retrieved.
 458  */
 459
 460 /* Replace non-specified values with expected inherited values. */
 461 #define LAYOUT_GET_EXPECTED 0x1
 462
 463 /**
 464  * Return a pointer to a newly-allocated opaque data structure containing
 465  * the layout for the file at \a path.  The pointer should be freed with
 466  * llapi_layout_free() when it is no longer needed. Failure is indicated
 467  * by a NULL return value and an appropriate error code stored in errno.
 468  */
 469 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
 470
 471 /**
 472  * Return a pointer to a newly-allocated opaque data type containing the
 473  * layout for the file referenced by open file descriptor \a fd.  The
 474  * pointer should be freed with llapi_layout_free() when it is no longer
 475  * needed. Failure is indicated by a NULL return value and an
 476  * appropriate error code stored in errno.
 477  */
 478 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
 479
 480 /**
 481  * Return a pointer to a newly-allocated opaque data type containing the
 482  * layout for the file associated with Lustre file identifier string
 483  * \a fidstr.  The string \a path must name a path within the
 484  * filesystem that contains the file being looked up, such as the
 485  * filesystem root.  The returned pointer should be freed with
 486  * llapi_layout_free() when it is no longer needed.  Failure is
 487  * indicated with a NULL return value and an appropriate error code
 488  * stored in errno.
 489  */
 490 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
 491                                              const lustre_fid *fid,
 492                                              uint32_t flags);
 493
 494 /**
 495  * Allocate a new layout. Use this when creating a new file with
 496  * llapi_layout_file_create().
 497  */
 498 struct llapi_layout *llapi_layout_alloc(void);
 499
 500 /**
 501  * Free memory allocated for \a layout.
 502  */
 503 void llapi_layout_free(struct llapi_layout *layout);
 504
 505 /** Not a valid stripe size, offset, or RAID pattern. */
 506 #define LLAPI_LAYOUT_INVALID    0x1000000000000001ULL
 507
 508 /**
 509  * When specified or returned as the value for stripe count,
 510  * stripe size, offset, or RAID pattern, the filesystem-wide
 511  * default behavior will apply.
 512  */
 513 #define LLAPI_LAYOUT_DEFAULT    (LLAPI_LAYOUT_INVALID + 1)
 514
 515 /**
 516  * When specified or returned as the value for stripe count, all
 517  * available OSTs will be used.
 518  */
 519 #define LLAPI_LAYOUT_WIDE       (LLAPI_LAYOUT_INVALID + 2)
 520
 521 /**
 522  * When specified as the value for layout pattern, file objects will be
 523  * stored using RAID0.  That is, data will be split evenly and without
 524  * redundancy across all OSTs in the layout.
 525  */
 526 #define LLAPI_LAYOUT_RAID0      0
 527
 528 /**
 529 * The layout includes a specific set of OSTs on which to allocate.
 530 */
 531 #define LLAPI_LAYOUT_SPECIFIC   0x2000000000000000ULL
 532
 533 /**
 534  * A valid ost index should be less than maximum valid OST index (UINT_MAX).
 535  */
 536 #define LLAPI_LAYOUT_IDX_MAX    0x00000000FFFFFFFFULL
 537
 538 /**
 539  * Flags to modify how layouts are retrieved.
 540  */
 541 /******************** Stripe Count ********************/
 542
 543 /**
 544  * Store the stripe count of \a layout in \a count.
 545  *
 546  * \retval  0 Success
 547  * \retval -1 Error with status code in errno.
 548  */
 549 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
 550                                   uint64_t *count);
 551
 552 /**
 553  * Set the stripe count of \a layout to \a count.
 554  *
 555  * \retval  0 Success.
 556  * \retval -1 Invalid argument, errno set to EINVAL.
 557  */
 558 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
 559
 560 /******************** Stripe Size ********************/
 561
 562 /**
 563  * Store the stripe size of \a layout in \a size.
 564  *
 565  * \retval  0 Success.
 566  * \retval -1 Invalid argument, errno set to EINVAL.
 567  */
 568 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
 569                                  uint64_t *size);
 570
 571 /**
 572  * Set the stripe size of \a layout to \a stripe_size.
 573  *
 574  * \retval  0 Success.
 575  * \retval -1 Invalid argument, errno set to EINVAL.
 576  */
 577 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
 578
 579 /******************** Stripe Pattern ********************/
 580
 581 /**
 582  * Store the stripe pattern of \a layout in \a pattern.
 583  *
 584  * \retval 0  Success.
 585  * \retval -1 Error with status code in errno.
 586  */
 587 int llapi_layout_pattern_get(const struct llapi_layout *layout,
 588                              uint64_t *pattern);
 589
 590 /**
 591  * Set the stripe pattern of \a layout to \a pattern.
 592  *
 593  * \retval  0 Success.
 594  * \retval -1 Invalid argument, errno set to EINVAL.
 595  */
 596 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
 597
 598 /******************** OST Index ********************/
 599
 600 /**
 601  * Store the index of the OST where stripe number \a stripe_number is stored
 602  * in \a index.
 603  *
 604  * An error return value will result from a NULL layout, if \a
 605  * stripe_number is out of range, or if \a layout was not initialized
 606  * with llapi_layout_lookup_by{path,fd,fid}().
 607  *
 608  * \retval  0 Success
 609  * \retval -1 Invalid argument, errno set to EINVAL.
 610  */
 611 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
 612                                uint64_t stripe_number, uint64_t *index);
 613
 614 /**
 615  * Set the OST index associated with stripe number \a stripe_number to
 616  * \a ost_index.
 617  * NB: This is currently supported only for \a stripe_number = 0 and
 618  * other usage will return ENOTSUPP in errno.  A NULL \a layout or
 619  * out-of-range \a stripe_number will return EINVAL in errno.
 620  *
 621  * \retval  0 Success.
 622  * \retval -1 Error with errno set to non-zero value.
 623  */
 624 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
 625                                uint64_t index);
 626
 627 /******************** Pool Name ********************/
 628
 629 /**
 630  * Store up to \a pool_name_len characters of the name of the pool of
 631  * OSTs associated with \a layout into the buffer pointed to by
 632  * \a pool_name.
 633  *
 634  * The correct calling form is:
 635  *
 636  *   llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
 637  *
 638  * A pool defines a set of OSTs from which file objects may be
 639  * allocated for a file using \a layout.
 640  *
 641  * On success, the number of bytes stored is returned, excluding the
 642  * terminating '\0' character (zero indicates that \a layout does not
 643  * have an associated OST pool).  On error, -1 is returned and errno is
 644  * set appropriately. Possible sources of error include a NULL pointer
 645  * argument or insufficient space in \a dest to store the pool name,
 646  * in which cases errno will be set to EINVAL.
 647  *
 648  * \retval 0+           The number of bytes stored in \a dest.
 649  * \retval -1           Invalid argument, errno set to EINVAL.
 650  */
 651 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
 652                               char *pool_name, size_t pool_name_len);
 653
 654 /**
 655  * Set the name of the pool of OSTs from which file objects will be
 656  * allocated to \a pool_name.
 657  *
 658  * If the pool name uses "fsname.pool" notation to qualify the pool name
 659  * with a filesystem name, the "fsname." portion will be silently
 660  * discarded before storing the value. No validation that \a pool_name
 661  * is an existing non-empty pool in filesystem \a fsname will be
 662  * performed.  Such validation can be performed by the application if
 663  * desired using the llapi_search_ost() function.  The maximum length of
 664  * the stored value is defined by the constant LOV_MAXPOOLNAME.
 665  *
 666  * \retval  0   Success.
 667  * \retval -1   Invalid argument, errno set to EINVAL.
 668  */
 669 int llapi_layout_pool_name_set(struct llapi_layout *layout,
 670                               const char *pool_name);
 671
 672 /******************** File Creation ********************/
 673
 674 /**
 675  * Open an existing file at \a path, or create it with the specified
 676  * \a layout and \a mode.
 677  *
 678  * One access mode and zero or more file creation flags and file status
 679  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 680  * open file descriptor for the file.  If \a layout is non-NULL and
 681  * \a path is not on a Lustre filesystem this function will fail and set
 682  * errno to ENOTTY.
 683  *
 684  * An already existing file may be opened with this function, but
 685  * \a layout and \a mode will not be applied to it.  Callers requiring a
 686  * guarantee that the opened file is created with the specified
 687  * \a layout and \a mode should use llapi_layout_file_create().
 688  *
 689  * A NULL \a layout may be specified, in which case the standard Lustre
 690  * behavior for assigning layouts to newly-created files will apply.
 691  *
 692  * \retval 0+ An open file descriptor.
 693  * \retval -1 Error with status code in errno.
 694  */
 695 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
 696                            const struct llapi_layout *layout);
 697
 698 /**
 699  * Create a new file at \a path with the specified \a layout and \a mode.
 700  *
 701  * One access mode and zero or more file creation flags and file status
 702  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 703  * open file descriptor for the file.  If \a layout is non-NULL and
 704  * \a path is not on a Lustre filesystem this function will fail and set
 705  * errno to ENOTTY.
 706  *
 707  * The function call
 708  *
 709  *   llapi_layout_file_create(path, open_flags, mode, layout)
 710  *
 711  * shall be equivalent to:
 712  *
 713  *   llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
 714  *
 715  * It is an error if \a path specifies an existing file.
 716  *
 717  * A NULL \a layout may be specified, in which the standard Lustre
 718  * behavior for assigning layouts to newly-created files will apply.
 719  *
 720  * \retval 0+ An open file descriptor.
 721  * \retval -1 Error with status code in errno.
 722  */
 723 int llapi_layout_file_create(const char *path, int open_flags, int mode,
 724                              const struct llapi_layout *layout);
 725
 726 /**
 727  * Fetch the start and end offset of the current layout component.
 728  */
 729 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
 730                                  uint64_t *start, uint64_t *end);
 731 /**
 732  * Set the extent of current layout component.
 733  */
 734 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
 735                                  uint64_t start, uint64_t end);
 736 /**
 737  * Gets the attribute flags of the current component.
 738  */
 739 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
 740                                 uint32_t *flags);
 741 /**
 742  * Sets the specified flags of the current component leaving other flags as-is.
 743  */
 744 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
 745 /**
 746  * Clears the flags specified in the flags leaving other flags as-is.
 747  */
 748 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
 749 /**
 750  * Fetches the file-unique component ID of the current layout component.
 751  */
 752 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
 753 /**
 754  * Adds one component to the existing composite or plain layout.
 755  */
 756 int llapi_layout_comp_add(struct llapi_layout *layout);
 757 /**
 758  * Deletes the current layout component from the composite layout.
 759  */
 760 int llapi_layout_comp_del(struct llapi_layout *layout);
 761
 762 enum {
 763         LLAPI_LAYOUT_COMP_POS_NEXT = 0,
 764         LLAPI_LAYOUT_COMP_POS_FIRST = 1,
 765         LLAPI_LAYOUT_COMP_POS_LAST = 2
 766 };
 767
 768 /**
 769  * Move the current component pointer by specified component ID.
 770  */
 771 int llapi_layout_comp_move_at(struct llapi_layout *layout, uint32_t id);
 772 /**
 773  * Move the current component pointer to a specified position.
 774  */
 775 int llapi_layout_comp_move(struct llapi_layout *layout, uint32_t pos);
 776 /**
 777  * Add layout components to an existing file.
 778  */
 779 int llapi_layout_file_comp_add(const char *path,
 780                                const struct llapi_layout *layout);
 781 /**
 782  * Delete component(s) by the specified component id (accepting lcme_id
 783  * wildcards also) from an existing file.
 784  */
 785 int llapi_layout_file_comp_del(const char *path, uint32_t id);
 786 /**
 787  * Change flags or other parameters of the component(s) by component ID of an
 788  * existing file. The component to be modified is specified by the
 789  * comp->lcme_id value, which must be an unique component ID. The new
 790  * attributes are passed in by @comp and @valid is used to specify which
 791  * attributes in the component are going to be changed.
 792  */
 793 int llapi_layout_file_comp_set(const char *path,
 794                                const struct llapi_layout *comp,
 795                                uint32_t valid);
 796
 797 /** @} llapi */
 798
 799 #endif