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