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