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