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