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  */
  31
  32 #ifndef _LUSTREAPI_H_
  33 #define _LUSTREAPI_H_
  34
  35 /** \defgroup llapi llapi
  36  *
  37  * @{
  38  */
  39
  40 #include <glob.h>
  41 #include <stdarg.h>
  42 #include <stdint.h>
  43 #include <time.h>
  44 #include <unistd.h>
  45 #include <sys/types.h>
  46 #include <linux/lustre/lustre_user.h>
  47
  48 #if defined(__cplusplus)
  49 extern "C" {
  50 #endif
  51
  52 #ifndef LL_MAXQUOTAS
  53 #define LL_MAXQUOTAS 3
  54 #endif
  55
  56 #ifndef SEL_UNIT_SIZE
  57 #define SEL_UNIT_SIZE 1024llu
  58 #endif
  59
  60 #ifndef LOV_PATTERN_DEFAULT
  61 #define LOV_PATTERN_DEFAULT     0xffffffff
  62 #endif
  63
  64 typedef struct statx lstatx_t;
  65
  66 #define lustre_fid struct lu_fid
  67
  68 /*
  69  * BUILD_BUG_ON() is Compile-time check which verifies correctness at
  70  * compile-time rather than runtime. If "cond" is true, (1 - 2*!!(cond))
  71  * will be a negative value, which will cause the compiler to complain.
  72  *
  73  */
  74 #ifndef BUILD_BUG_ON
  75 #define BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2*!!(cond)]))
  76 #endif
  77
  78 /* Currently external applications can access this but in the
  79  * future this will no longer be exposed for the user. Instead
  80  * if you want to know if the library is initialized just call
  81  * llapi_liblustreapi_initialized() which is now available. */
  82 extern bool liblustreapi_initialized;
  83
  84 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
  85                            void *args);
  86
  87 /* lustreapi message severity level */
  88 enum llapi_message_level {
  89         LLAPI_MSG_OFF    = 0,
  90         LLAPI_MSG_FATAL  = 1,
  91         LLAPI_MSG_ERROR  = 2,
  92         LLAPI_MSG_WARN   = 3,
  93         LLAPI_MSG_NORMAL = 4,
  94         LLAPI_MSG_INFO   = 5,
  95         LLAPI_MSG_DEBUG  = 6,
  96         LLAPI_MSG_MAX
  97 };
  98
  99 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
 100                                      const char *fmt, va_list ap);
 101
 102 static inline bool llapi_liblustreapi_initialized(void)
 103 {
 104         return liblustreapi_initialized;
 105 }
 106
 107 /* the bottom three bits reserved for llapi_message_level */
 108 #define LLAPI_MSG_MASK          0x00000007
 109 #define LLAPI_MSG_NO_ERRNO      0x00000010
 110
 111 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
 112 {
 113         static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
 114                                                     "WARNING", "NORMAL",
 115                                                     "INFO", "DEBUG"};
 116
 117         if (level >= LLAPI_MSG_MAX)
 118                 return NULL;
 119
 120         return levels[level];
 121 }
 122
 123 void llapi_msg_set_level(int level);
 124 int llapi_msg_get_level(void);
 125 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
 126 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
 127
 128 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
 129         __attribute__((__format__(__printf__, 3, 4)));
 130 #define llapi_err_noerrno(level, fmt, a...)                     \
 131         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
 132 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
 133         __attribute__((__format__(__printf__, 2, 3)));
 134
 135 struct llapi_stripe_param {
 136         unsigned long long      lsp_stripe_size;
 137         char                    *lsp_pool;
 138         int                     lsp_stripe_offset;
 139         int                     lsp_stripe_pattern;
 140         /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
 141         int                     lsp_stripe_count;
 142         bool                    lsp_is_specific;
 143         bool                    lsp_is_create;
 144         __u8                    lsp_max_inherit;
 145         __u8                    lsp_max_inherit_rr;
 146         __u32                   lsp_osts[0];
 147 };
 148
 149 #define lsp_tgts        lsp_osts
 150
 151 __u32 llapi_pattern_to_lov(uint64_t pattern);
 152
 153 int llapi_file_open_param(const char *name, int flags, mode_t mode,
 154                           const struct llapi_stripe_param *param);
 155 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
 156                               __u32 flags, char *foreign_lov);
 157 int llapi_file_create(const char *name, unsigned long long stripe_size,
 158                       int stripe_offset, int stripe_count, int stripe_pattern);
 159 int llapi_file_open(const char *name, int flags, int mode,
 160                     unsigned long long stripe_size, int stripe_offset,
 161                     int stripe_count, int stripe_pattern);
 162 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
 163                            int stripe_offset, int stripe_count,
 164                            int stripe_pattern, char *pool_name);
 165 int llapi_file_open_pool(const char *name, int flags, int mode,
 166                          unsigned long long stripe_size, int stripe_offset,
 167                          int stripe_count, int stripe_pattern, char *pool_name);
 168 int llapi_poollist(const char *name);
 169 int llapi_get_poolbuf(const char *name, char **buf,
 170                       char ***poolist, int *poolcount);
 171 int llapi_get_poollist(const char *name, char **poollist, int list_size,
 172                        char *buffer, int buffer_size);
 173 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
 174                           char *buffer, int buffer_size);
 175 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
 176 int llapi_file_lookup(int dirfd, const char *name);
 177 void llapi_set_command_name(const char *cmd);
 178 void llapi_clear_command_name(void);
 179
 180 enum llapi_layout_verbose  {
 181         VERBOSE_STRIPE_COUNT    =      0x1,
 182         VERBOSE_STRIPE_SIZE     =      0x2,
 183         VERBOSE_STRIPE_OFFSET   =      0x4,
 184         VERBOSE_POOL            =      0x8,
 185         VERBOSE_DETAIL          =     0x10,
 186         VERBOSE_OBJID           =     0x20,
 187         VERBOSE_GENERATION      =     0x40,
 188         VERBOSE_MDTINDEX        =     0x80,
 189         VERBOSE_PATTERN         =    0x100,
 190         VERBOSE_COMP_COUNT      =    0x200,
 191         VERBOSE_COMP_FLAGS      =    0x400,
 192         VERBOSE_COMP_START      =    0x800,
 193         VERBOSE_COMP_END        =   0x1000,
 194         VERBOSE_COMP_ID         =   0x2000,
 195         VERBOSE_DFID            =   0x4000,
 196         VERBOSE_HASH_TYPE       =   0x8000,
 197         VERBOSE_MIRROR_COUNT    =  0x10000,
 198         VERBOSE_MIRROR_ID       =  0x20000,
 199         VERBOSE_EXT_SIZE        =  0x40000,
 200         VERBOSE_INHERIT         =  0x80000,
 201         VERBOSE_INHERIT_RR      = 0x100000,
 202         VERBOSE_DEFAULT         = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
 203                                   VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
 204                                   VERBOSE_OBJID | VERBOSE_GENERATION |
 205                                   VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
 206                                   VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
 207                                   VERBOSE_COMP_START | VERBOSE_COMP_END |
 208                                   VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
 209                                   VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE |
 210                                   VERBOSE_INHERIT | VERBOSE_INHERIT_RR
 211 };
 212 /* Compatibility with original names */
 213 #define VERBOSE_SIZE    VERBOSE_STRIPE_SIZE
 214 #define VERBOSE_COUNT   VERBOSE_STRIPE_COUNT
 215 #define VERBOSE_OFFSET  VERBOSE_STRIPE_OFFSET
 216 #define VERBOSE_LAYOUT  VERBOSE_PATTERN
 217
 218 enum {
 219         NEWERXY_ATIME = 0,      /* neweraY */
 220         NEWERXY_MTIME = 1,      /* newermY */
 221         NEWERXY_CTIME = 2,      /* newercY */
 222         NEWERXY_BTIME = 3,      /* newerbY | newerBY */
 223         NEWERXY_MAX,
 224 };
 225
 226 enum lfs_find_perm {
 227         LFS_FIND_PERM_EXACT = -2,
 228         LFS_FIND_PERM_ANY   = -1,
 229         LFS_FIND_PERM_OFF   =  0,
 230         LFS_FIND_PERM_ALL   =  1,
 231 };
 232
 233 struct find_param {
 234         unsigned int             fp_max_depth;
 235         dev_t                    fp_dev;
 236         mode_t                   fp_type; /* S_IFIFO,... */
 237         uid_t                    fp_uid;
 238         gid_t                    fp_gid;
 239         mode_t                   fp_perm;
 240         time_t                   fp_atime;
 241         time_t                   fp_mtime;
 242         time_t                   fp_ctime;
 243         /* {a,m,c,b}sign cannot be bitfields due to using pointers to
 244          * access them during argument parsing. */
 245         int                      fp_asign;
 246         int                      fp_msign;
 247         int                      fp_csign;
 248         /* these need to be signed values */
 249         int                      fp_size_sign:2,
 250                                  fp_stripe_size_sign:2,
 251                                  fp_stripe_count_sign:2,
 252                                  fp_comp_start_sign:2,
 253                                  fp_comp_end_sign:2,
 254                                  fp_comp_count_sign:2,
 255                                  fp_mirror_count_sign:2,
 256                                  fp_mirror_index_sign:2,
 257                                  fp_mirror_id_sign:2,
 258                                  fp_mdt_count_sign:2,
 259                                  fp_blocks_sign:2,
 260                                  fp_ext_size_sign:2,
 261                                  fp_perm_sign:2,
 262                                  fp_unused2_sign:2, /* Once used we must add  */
 263                                  fp_unused3_sign:2, /* a separate flag field  */
 264                                  fp_unused4_sign:2; /* at end of the struct.  */
 265         unsigned long long       fp_size;
 266         unsigned long long       fp_size_units;
 267
 268         unsigned long long       fp_zero_end:1,
 269                                  fp_recursive:1,
 270                                  fp_exclude_pattern:1,
 271                                  fp_exclude_type:1,
 272                                  fp_exclude_obd:1,
 273                                  fp_exclude_mdt:1,
 274                                  fp_exclude_gid:1,
 275                                  fp_exclude_uid:1,
 276                                  fp_check_gid:1,
 277                                  fp_check_uid:1,
 278                                  fp_check_pool:1,       /* LOV pool name */
 279                                  fp_check_size:1,       /* file size */
 280                                  fp_exclude_pool:1,
 281                                  fp_exclude_size:1,
 282                                  fp_exclude_atime:1,
 283                                  fp_exclude_mtime:1,
 284                                  fp_exclude_ctime:1,
 285                                  fp_get_lmv:1,  /* get MDT list from LMV */
 286                                  fp_raw:1,      /* do not fill in defaults */
 287                                  fp_check_stripe_size:1, /* LOV stripe size */
 288                                  fp_exclude_stripe_size:1,
 289                                  fp_check_stripe_count:1, /* LOV stripe count */
 290                                  fp_exclude_stripe_count:1,
 291                                  fp_check_layout:1,
 292                                  fp_exclude_layout:1,
 293                                  fp_get_default_lmv:1, /* Get default LMV */
 294                                  fp_migrate:1,
 295                                  fp_check_projid:1,
 296                                  fp_exclude_projid:1,
 297                                  fp_check_comp_count:1,
 298                                  fp_exclude_comp_count:1,
 299                                  fp_check_mirror_count:1,
 300                                  fp_exclude_mirror_count:1,
 301                                  fp_check_comp_flags:1,
 302                                  fp_check_mirror_state:1,
 303                                  fp_check_comp_start:1,
 304                                  fp_exclude_comp_start:1,
 305                                  fp_check_comp_end:1,
 306                                  fp_exclude_comp_end:1,
 307                                  fp_check_comp_id:1,
 308                                  fp_exclude_comp_id:1,
 309                                  fp_check_mirror_id:1,
 310                                  fp_exclude_mirror_id:1,
 311                                  fp_check_mirror_index:1,
 312                                  fp_exclude_mirror_index:1,
 313                                  fp_check_mdt_count:1,
 314                                  fp_exclude_mdt_count:1,
 315                                  fp_check_hash_flag:1,
 316                                  fp_exclude_hash_type:1,
 317                                  fp_yaml:1,     /* output layout in YAML */
 318                                  fp_check_blocks:1,
 319                                  fp_exclude_blocks:1,
 320                                  fp_check_foreign:1,
 321                                  fp_exclude_foreign:1,
 322                                  fp_check_ext_size:1, /* extension size */
 323                                  fp_exclude_ext_size:1,
 324                                  fp_lazy:1,
 325                                  fp_newerxy:1,
 326                                  fp_exclude_btime:1,
 327                                  fp_exclude_perm:1,
 328                                  fp_unused_bit4:1, /* Once all unused fields  */
 329                                  fp_unused_bit5:1, /* are used we need to add */
 330                                  fp_unused_bit6:1, /* a separate flag field at*/
 331                                  fp_unused_bit7:1; /* the end of the struct.  */
 332
 333         enum llapi_layout_verbose fp_verbose;
 334         int                      fp_quiet;
 335
 336         /* regular expression */
 337         char                    *fp_pattern;
 338
 339         struct  obd_uuid        *fp_obd_uuid;
 340         int                      fp_num_obds;
 341         int                      fp_num_alloc_obds;
 342         int                      fp_obd_index;
 343         int                     *fp_obd_indexes;
 344
 345         struct  obd_uuid        *fp_mdt_uuid;
 346         int                      fp_num_mdts;
 347         int                      fp_num_alloc_mdts;
 348         int                      fp_mdt_index;
 349         int                     *fp_mdt_indexes;
 350         int                      fp_file_mdt_index;
 351
 352         size_t                   fp_lum_size;
 353         struct  lov_user_mds_data *fp_lmd;
 354
 355         char                     fp_poolname[LOV_MAXPOOLNAME + 1];
 356
 357         __u32                    fp_lmv_stripe_count;
 358         struct lmv_user_md      *fp_lmv_md;
 359
 360         unsigned long long       fp_stripe_size;
 361         unsigned long long       fp_stripe_size_units;
 362         unsigned long long       fp_stripe_count;
 363         __u32                    fp_layout;
 364
 365         __u32                    fp_comp_count;
 366         __u32                    fp_mirror_count;
 367         __u32                    fp_comp_flags;
 368         __u32                    fp_comp_neg_flags;
 369         __u16                    fp_mirror_state;
 370         __u16                    fp_mirror_neg_state;
 371         __u32                    fp_comp_id;
 372         __u16                    fp_mirror_id;
 373         __u16                    fp_mirror_index;
 374         unsigned long long       fp_comp_start;
 375         unsigned long long       fp_comp_start_units;
 376         unsigned long long       fp_comp_end;
 377         unsigned long long       fp_comp_end_units;
 378         unsigned long long       fp_mdt_count;
 379         unsigned                 fp_projid;
 380         unsigned long long       fp_blocks;
 381         unsigned long long       fp_blocks_units;
 382
 383         unsigned long            fp_got_uuids:1,
 384                                  fp_obds_printed:1;
 385         unsigned int             fp_depth;
 386         unsigned int             fp_hash_type;
 387         unsigned int             fp_time_margin; /* time margin in seconds */
 388         __u32                    fp_foreign_type;
 389         unsigned long long       fp_ext_size;
 390         unsigned long long       fp_ext_size_units;
 391
 392         /*
 393          * fp_newery[NEWERXY_MAX][0]: --newerXY reference
 394          * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
 395          */
 396         time_t                   fp_newery[NEWERXY_MAX][2];
 397
 398         time_t                   fp_btime;
 399         int                      fp_bsign;
 400         unsigned int             fp_hash_inflags;
 401         unsigned int             fp_hash_exflags;
 402 };
 403
 404 int llapi_ostlist(char *path, struct find_param *param);
 405 int llapi_uuid_match(char *real_uuid, char *search_uuid);
 406 int llapi_getstripe(char *path, struct find_param *param);
 407 int llapi_find(char *path, struct find_param *param);
 408
 409 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 410 int llapi_dir_set_default_lmv(const char *name,
 411                               const struct llapi_stripe_param *param);
 412 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
 413                                      int stripe_count, int stripe_pattern,
 414                                      const char *pool_name);
 415 int llapi_dir_create(const char *name, mode_t mode,
 416                      const struct llapi_stripe_param *param);
 417 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
 418                              __u32 flags, const char *value);
 419 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
 420                           int stripe_count, int stripe_pattern,
 421                           const char *poolname);
 422 int llapi_direntry_remove(char *dname);
 423 int llapi_unlink_foreign(char *dname);
 424
 425 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
 426                       struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
 427 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 428                      struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
 429 int llapi_ping(char *obd_type, char *obd_name);
 430 int llapi_target_check(int num_types, char **obd_types, char *dir);
 431 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 432 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
 433 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 434 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 435 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 436 int llapi_is_lustre_mnttype(const char *type);
 437 int llapi_search_tgt(const char *fsname, const char *poolname,
 438                      const char *tgtname, bool is_mdt);
 439 int llapi_search_mdt(const char *fsname, const char *poolname,
 440                      const char *mdtname);
 441 int llapi_search_ost(const char *fsname, const char *poolname,
 442                      const char *ostname);
 443 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
 444 int llapi_parse_size(const char *optarg, unsigned long long *size,
 445                      unsigned long long *size_units, int bytes_spec);
 446 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
 447                         char *fsname);
 448 int llapi_search_fsname(const char *pathname, char *fsname);
 449 int llapi_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
 450                               char *instance, size_t instance_len);
 451 int llapi_get_instance(const char *path, char *instance, size_t instance_len);
 452 int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
 453 int llapi_getname(const char *path, char *name, size_t namelen);
 454 int llapi_search_fileset(const char *pathname, char *fileset);
 455
 456 int llapi_search_rootpath(char *pathname, const char *fsname);
 457 int llapi_nodemap_exists(const char *name);
 458 int llapi_migrate_mdt(char *path, struct find_param *param);
 459 int llapi_mv(char *path, struct find_param *param);
 460
 461 struct mntent;
 462
 463 #define HAVE_LLAPI_IS_LUSTRE_MNT
 464 int llapi_is_lustre_mnt(struct mntent *mnt);
 465 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 466 int llapi_target_iterate(int type_num, char **obd_type, void *args,
 467                          llapi_cb_t cb);
 468 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 469 int llapi_cp(int argc, char *argv[]);
 470 int llapi_ls(int argc, char *argv[]);
 471 int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
 472 int llapi_fid2path_at(int mnt_fd, const struct lu_fid *fid, char *path,
 473                       int pathlen, long long *recno, int *linkno);
 474 int llapi_fid2path(const char *device, const char *fidstr, char *path,
 475                    int pathlen, long long *recno, int *linkno);
 476 int llapi_path2fid(const char *path, struct lu_fid *fid);
 477 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
 478                                int *mdt_index);
 479 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
 480                        struct lov_user_md *lum, size_t lumsize);
 481 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
 482                       struct lov_user_md *lum, size_t lumsize);
 483 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
 484                           lstatx_t *statx, struct lov_user_md *lum,
 485                           size_t lumsize);
 486 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
 487                          struct lov_user_md *lum, size_t lumsize);
 488
 489 int llapi_fd2fid(int fd, struct lu_fid *fid);
 490 /* get FID of parent dir + the related name of entry in this parent dir */
 491 int llapi_path2parent(const char *path, unsigned int linkno,
 492                       struct lu_fid *parent_fid, char *name, size_t name_size);
 493 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
 494                     char *name, size_t name_size);
 495 int llapi_rmfid(const char *path, struct fid_array *fa);
 496 int llapi_chomp_string(char *buf);
 497 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
 498                       int open_flags);
 499 int llapi_get_version_string(char *version, unsigned int version_size);
 500 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
 501 int llapi_get_version(char *buffer, int buffer_size, char **version)
 502         __attribute__((deprecated));
 503 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 504 int llapi_file_flush(int fd);
 505 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
 506 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
 507 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
 508 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
 509                            __u32 archive_id);
 510 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
 511                         __u32 archive_id);
 512 int llapi_hsm_register_event_fifo(const char *path);
 513 int llapi_hsm_unregister_event_fifo(const char *path);
 514 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
 515                          const char *fmt, va_list args);
 516
 517 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
 518 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
 519                               int open_flags);
 520 int llapi_create_volatile_param(const char *directory, int mdt_idx,
 521                                 int open_flags, mode_t mode,
 522                                 const struct llapi_stripe_param *stripe_param);
 523
 524 static inline int llapi_create_volatile(char *directory, int open_flags)
 525 {
 526         return llapi_create_volatile_idx(directory, -1, open_flags);
 527 }
 528
 529
 530 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
 531                                   int gid, __u64 flags);
 532 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
 533 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
 534                        __u64 dv2, __u64 flags);
 535
 536 /* Changelog interface.  priv is private state, managed internally by these
 537  * functions */
 538
 539 /* Records received are in extended format now, though most of them are still
 540  * written in disk in changelog_rec format (to save space and time), it's
 541  * converted to extended format in the lustre api to ease changelog analysis. */
 542 #define HAVE_CHANGELOG_EXTEND_REC 1
 543
 544 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
 545                           const char *mdtname, long long startrec);
 546 int llapi_changelog_fini(void **priv);
 547 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
 548 int llapi_changelog_in_buf(void *priv);
 549 int llapi_changelog_free(struct changelog_rec **rech);
 550 int llapi_changelog_get_fd(void *priv);
 551 /* Allow records up to endrec to be destroyed; requires registered id. */
 552 int llapi_changelog_clear(const char *mdtname, const char *idstr,
 553                           long long endrec);
 554 extern int llapi_changelog_set_xflags(void *priv,
 555                                     enum changelog_send_extra_flag extra_flags);
 556
 557 /* HSM copytool interface.
 558  * priv is private state, managed internally by these functions
 559  */
 560 struct hsm_copytool_private;
 561 struct hsm_copyaction_private;
 562
 563 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 564                                 const char *mnt, int archive_count,
 565                                 int *archives, int rfd_flags);
 566 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
 567 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
 568 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
 569                             struct hsm_action_list **hal, int *msgsize);
 570 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
 571                            const struct hsm_copytool_private *ct,
 572                            const struct hsm_action_item *hai,
 573                            int restore_mdt_index, int restore_open_flags,
 574                            bool is_error);
 575 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
 576                          const struct hsm_extent *he, int hp_flags, int errval);
 577 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
 578                               const struct hsm_extent *he, __u64 total,
 579                               int hp_flags);
 580 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
 581                               struct lu_fid *fid);
 582 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
 583 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
 584                      unsigned long long stripe_size, int stripe_offset,
 585                      int stripe_count, int stripe_pattern, char *pool_name,
 586                      struct lu_fid *newfid);
 587
 588 /* HSM user interface */
 589 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
 590                                                       int data_len);
 591 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
 592 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
 593
 594 /* JSON handling */
 595 enum llapi_json_types {
 596         LLAPI_JSON_INTEGER = 1,
 597         LLAPI_JSON_BIGNUM,
 598         LLAPI_JSON_REAL,
 599         LLAPI_JSON_STRING
 600 };
 601
 602 struct llapi_json_item {
 603         char                    *lji_key;
 604         __u32                   lji_type;
 605         union {
 606                 int             lji_integer;
 607                 __u64           lji_u64;
 608                 double          lji_real;
 609                 char            *lji_string;
 610         };
 611         struct llapi_json_item  *lji_next;
 612 };
 613
 614 struct llapi_json_item_list {
 615         int                     ljil_item_count;
 616         struct llapi_json_item  *ljil_items;
 617 };
 618
 619 int llapi_json_init_list(struct llapi_json_item_list **item_list);
 620 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
 621 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
 622                         __u32 type, void *val);
 623 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
 624
 625 /* File lease */
 626 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
 627 int llapi_lease_release(int fd);
 628 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
 629 int llapi_lease_check(int fd);
 630 int llapi_lease_get(int fd, int mode); /* obsoleted */
 631 int llapi_lease_put(int fd); /* obsoleted */
 632
 633 /* Group lock */
 634 int llapi_group_lock(int fd, int gid);
 635 int llapi_group_unlock(int fd, int gid);
 636 int llapi_group_lock64(int fd, __u64 gid);
 637 int llapi_group_unlock64(int fd, __u64 gid);
 638
 639 bool llapi_file_is_sparse(int fd);
 640 off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
 641 int llapi_hole_punch(int fd, off_t start, size_t length);
 642
 643 /* Ladvise */
 644 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
 645                   struct llapi_lu_ladvise *ladvise);
 646
 647 /* PCC */
 648 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
 649 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
 650                          __u32 id, enum lu_pcc_type type);
 651 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
 652                              __u32 id, enum lu_pcc_type type);
 653 int llapi_pcc_detach_fd(int fd, __u32 option);
 654 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
 655                          __u32 option);
 656 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
 657                              __u32 option);
 658 int llapi_pcc_detach_file(const char *path, __u32 option);
 659 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
 660 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
 661 int llapi_pccdev_set(const char *mntpath, const char *cmd);
 662 int llapi_pccdev_get(const char *mntpath);
 663 /** @} llapi */
 664
 665 /* llapi_layout user interface */
 666
 667 /**
 668  * An array element storing component info to be resynced during mirror
 669  * resynchronization.
 670  */
 671 struct llapi_resync_comp {
 672         uint64_t lrc_start;
 673         uint64_t lrc_end;
 674         uint32_t lrc_mirror_id;
 675         uint32_t lrc_id;        /* component id */
 676         bool lrc_synced;
 677 };
 678
 679 /** Opaque data type abstracting the layout of a Lustre file. */
 680 struct llapi_layout;
 681
 682 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
 683 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
 684                            size_t count, off_t pos);
 685 uint32_t llapi_mirror_find(struct llapi_layout *layout,
 686                            uint64_t file_start, uint64_t file_end,
 687                            uint64_t *endp);
 688 int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
 689 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
 690                                 struct llapi_layout *m_layout);
 691 int llapi_mirror_find_stale(struct llapi_layout *layout,
 692                 struct llapi_resync_comp *comp, size_t comp_size,
 693                 __u16 *mirror_ids, int ids_nr);
 694 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
 695                              struct llapi_resync_comp *comp_array,
 696                              int comp_size,  uint64_t start, uint64_t end);
 697 /*
 698  * Flags to control how layouts are retrieved.
 699  */
 700
 701 enum llapi_layout_get_flags {
 702         /** Replace non-specified values with expected inherited values. */
 703         LLAPI_LAYOUT_GET_EXPECTED       = 0x0001,
 704         /** Use a temporary buffer to swab and return xattrs. */
 705         LLAPI_LAYOUT_GET_COPY           = 0x0002,
 706         /** Verify xattr contains sane layout values. */
 707         LLAPI_LAYOUT_GET_CHECK          = 0x0004,
 708 };
 709 /* compatibility macros for old interfaces */
 710 #define LAYOUT_GET_EXPECTED     LLAPI_LAYOUT_GET_EXPECTED
 711 #define LLAPI_LXF_COPY          LLAPI_LAYOUT_GET_COPY
 712 #define LLAPI_LXF_CHECK         LLAPI_LAYOUT_GET_CHECK
 713
 714 /**
 715  * Return a pointer to a newly-allocated opaque data structure containing
 716  * the layout for the file at \a path.  The pointer should be freed with
 717  * llapi_layout_free() when it is no longer needed. Failure is indicated
 718  * by a NULL return value and an appropriate error code stored in errno.
 719  */
 720 struct llapi_layout *llapi_layout_get_by_path(const char *path,
 721                                              enum llapi_layout_get_flags flags);
 722
 723 /**
 724  * Return a pointer to a newly-allocated opaque data type containing the
 725  * layout for the file referenced by open file descriptor \a fd.  The
 726  * pointer should be freed with llapi_layout_free() when it is no longer
 727  * needed. Failure is indicated by a NULL return value and an
 728  * appropriate error code stored in errno.
 729  */
 730 struct llapi_layout *llapi_layout_get_by_fd(int fd,
 731                                             enum llapi_layout_get_flags flags);
 732
 733 /**
 734  * Return a pointer to a newly-allocated opaque data type containing the
 735  * layout for the file associated with Lustre file identifier
 736  * \a fid.  The string \a path must name a path within the
 737  * filesystem that contains the file being looked up, such as the
 738  * filesystem root.  The returned pointer should be freed with
 739  * llapi_layout_free() when it is no longer needed.  Failure is
 740  * indicated with a NULL return value and an appropriate error code
 741  * stored in errno.
 742  */
 743 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
 744                                              const struct lu_fid *fid,
 745                                              enum llapi_layout_get_flags flags);
 746
 747 /**
 748  * Return a pointer to a newly-allocated opaque data type containing the
 749  * layout for the file associated with extended attribute \a lov_xattr.  The
 750  * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
 751  * should be raw xattr without being swapped, since this function will swap it
 752  * properly. Thus, \a lov_xattr will be modified during the process. If the
 753  * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
 754  * the objects count in lum is consistent with the stripe count in lum. This
 755  * check only apply to regular file, so \a LLAPI_LAYOUT_GET_CHECK flag should
 756  * be cleared if the xattr belongs to a directory. If the flag \a
 757  * LLAPI_LAYOUT_GET_COPY is set, this function will use a temporary buffer for
 758  * byte swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the
 759  * byte swapping will be done to the \a lov_xattr buffer directly.  The returned
 760  * pointer should be freed with llapi_layout_free() when it is no longer
 761  * needed.  Failure is  * indicated with a NULL return value and an appropriate
 762  * error code stored in errno.
 763  */
 764 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
 765                                              ssize_t lov_xattr_size,
 766                                              enum llapi_layout_get_flags flags);
 767
 768 /**
 769  * Allocate a new layout. Use this when creating a new file with
 770  * llapi_layout_file_create().
 771  */
 772 struct llapi_layout *llapi_layout_alloc(void);
 773
 774 /**
 775  * Free memory allocated for \a layout.
 776  */
 777 void llapi_layout_free(struct llapi_layout *layout);
 778
 779 /**
 780  * llapi_layout_merge() - Merge a composite layout into another one.
 781  * @dst_layout: Destination composite layout.
 782  * @src_layout: Source composite layout.
 783  *
 784  * This function copies all of the components from @src_layout and
 785  * appends them to @dst_layout.
 786  *
 787  * Return: 0 on success or -1 on failure.
 788  */
 789 int llapi_layout_merge(struct llapi_layout **dst_layout,
 790                        const struct llapi_layout *src_layout);
 791
 792 /** Not a valid stripe size, offset, or RAID pattern. */
 793 #define LLAPI_LAYOUT_INVALID    0x1000000000000001ULL
 794
 795 /**
 796  * When specified or returned as the value for stripe count,
 797  * stripe size, offset, or RAID pattern, the filesystem-wide
 798  * default behavior will apply.
 799  */
 800 #define LLAPI_LAYOUT_DEFAULT    (LLAPI_LAYOUT_INVALID + 1)
 801
 802 /**
 803  * When specified or returned as the value for stripe count, all
 804  * available OSTs will be used.
 805  */
 806 #define LLAPI_LAYOUT_WIDE       (LLAPI_LAYOUT_INVALID + 2)
 807
 808 /**
 809  * When specified as the value for layout pattern, file objects will be
 810  * stored using RAID0.  That is, data will be split evenly and without
 811  * redundancy across all OSTs in the layout.
 812  */
 813 #define LLAPI_LAYOUT_RAID0              0ULL
 814 #define LLAPI_LAYOUT_MDT                2ULL
 815 #define LLAPI_LAYOUT_OVERSTRIPING       4ULL
 816
 817 /**
 818 * The layout includes a specific set of OSTs on which to allocate.
 819 */
 820 #define LLAPI_LAYOUT_SPECIFIC   0x2000000000000000ULL
 821
 822 /**
 823  * A valid ost index should be less than maximum valid OST index (UINT_MAX).
 824  */
 825 #define LLAPI_LAYOUT_IDX_MAX    0x00000000FFFFFFFFULL
 826
 827 /**
 828  * Flags to modify how layouts are retrieved.
 829  */
 830 /******************** Stripe Count ********************/
 831
 832 /**
 833  * Store the stripe count of \a layout in \a count.
 834  *
 835  * \retval  0 Success
 836  * \retval -1 Error with status code in errno.
 837  */
 838 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
 839                                   uint64_t *count);
 840
 841 /**
 842  * Set the stripe count of \a layout to \a count.
 843  *
 844  * \retval  0 Success.
 845  * \retval -1 Invalid argument, errno set to EINVAL.
 846  */
 847 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
 848
 849 /**
 850  * Check if the stripe count \a stripe_count \a is valid.
 851  */
 852 bool llapi_layout_stripe_count_is_valid(int64_t stripe_count);
 853 /******************** Stripe Size ********************/
 854
 855 /**
 856  * Store the stripe size of \a layout in \a size.
 857  *
 858  * \retval  0 Success.
 859  * \retval -1 Invalid argument, errno set to EINVAL.
 860  */
 861 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
 862                                  uint64_t *size);
 863
 864 /**
 865  * Set the stripe size of \a layout to \a stripe_size.
 866  *
 867  * \retval  0 Success.
 868  * \retval -1 Invalid argument, errno set to EINVAL.
 869  */
 870 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
 871
 872
 873 /******************** Extension Size ********************/
 874
 875 /**
 876  * Store the extension size of \a layout in \a size.
 877  *
 878  * \retval  0 Success.
 879  * \retval -1 Invalid argument, errno set to EINVAL.
 880  */
 881 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
 882                                     uint64_t *size);
 883
 884 /**
 885  * Set the extension size of \a layout to \a stripe_size.
 886  *
 887  * \retval  0 Success.
 888  * \retval -1 Invalid argument, errno set to EINVAL.
 889  */
 890 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
 891
 892
 893 /******************** Stripe Pattern ********************/
 894
 895 /**
 896  * Store the stripe pattern of \a layout in \a pattern.
 897  *
 898  * \retval 0  Success.
 899  * \retval -1 Error with status code in errno.
 900  */
 901 int llapi_layout_pattern_get(const struct llapi_layout *layout,
 902                              uint64_t *pattern);
 903
 904 /**
 905  * Set the stripe pattern of \a layout to \a pattern.
 906  *
 907  * \retval  0 Success.
 908  * \retval -1 Invalid argument, errno set to EINVAL.
 909  */
 910 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
 911
 912 /******************** OST Index ********************/
 913
 914 /**
 915  * Store the index of the OST where stripe number \a stripe_number is stored
 916  * in \a index.
 917  *
 918  * An error return value will result from a NULL layout, if \a
 919  * stripe_number is out of range, or if \a layout was not initialized
 920  * with llapi_layout_lookup_by{path,fd,fid}().
 921  *
 922  * \retval  0 Success
 923  * \retval -1 Invalid argument, errno set to EINVAL.
 924  */
 925 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
 926                                uint64_t stripe_number, uint64_t *index);
 927
 928 /**
 929  * Set the OST index associated with stripe number \a stripe_number to
 930  * \a ost_index.
 931  * NB: This is currently supported only for \a stripe_number = 0 and
 932  * other usage will return ENOTSUPP in errno.  A NULL \a layout or
 933  * out-of-range \a stripe_number will return EINVAL in errno.
 934  *
 935  * \retval  0 Success.
 936  * \retval -1 Error with errno set to non-zero value.
 937  */
 938 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
 939                                uint64_t index);
 940
 941 /******************** Pool Name ********************/
 942
 943 /**
 944  * Store up to \a pool_name_len characters of the name of the pool of
 945  * OSTs associated with \a layout into the buffer pointed to by
 946  * \a pool_name.
 947  *
 948  * The correct calling form is:
 949  *
 950  *   llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
 951  *
 952  * A pool defines a set of OSTs from which file objects may be
 953  * allocated for a file using \a layout.
 954  *
 955  * On success, the number of bytes stored is returned, excluding the
 956  * terminating '\0' character (zero indicates that \a layout does not
 957  * have an associated OST pool).  On error, -1 is returned and errno is
 958  * set appropriately. Possible sources of error include a NULL pointer
 959  * argument or insufficient space in \a dest to store the pool name,
 960  * in which cases errno will be set to EINVAL.
 961  *
 962  * \retval 0+           The number of bytes stored in \a dest.
 963  * \retval -1           Invalid argument, errno set to EINVAL.
 964  */
 965 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
 966                               char *pool_name, size_t pool_name_len);
 967
 968 /**
 969  * Set the name of the pool of OSTs from which file objects will be
 970  * allocated to \a pool_name.
 971  *
 972  * If the pool name uses "fsname.pool" notation to qualify the pool name
 973  * with a filesystem name, the "fsname." portion will be silently
 974  * discarded before storing the value. No validation that \a pool_name
 975  * is an existing non-empty pool in filesystem \a fsname will be
 976  * performed.  Such validation can be performed by the application if
 977  * desired using the llapi_search_ost() function.  The maximum length of
 978  * the stored value is defined by the constant LOV_MAXPOOLNAME.
 979  *
 980  * \retval  0   Success.
 981  * \retval -1   Invalid argument, errno set to EINVAL.
 982  */
 983 int llapi_layout_pool_name_set(struct llapi_layout *layout,
 984                                char *pool_name);
 985
 986 /******************** File Creation ********************/
 987
 988 /**
 989  * Open an existing file at \a path, or create it with the specified
 990  * \a layout and \a mode.
 991  *
 992  * One access mode and zero or more file creation flags and file status
 993  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 994  * open file descriptor for the file.  If \a layout is non-NULL and
 995  * \a path is not on a Lustre filesystem this function will fail and set
 996  * errno to ENOTTY.
 997  *
 998  * An already existing file may be opened with this function, but
 999  * \a layout and \a mode will not be applied to it.  Callers requiring a
1000  * guarantee that the opened file is created with the specified
1001  * \a layout and \a mode should use llapi_layout_file_create().
1002  *
1003  * A NULL \a layout may be specified, in which case the standard Lustre
1004  * behavior for assigning layouts to newly-created files will apply.
1005  *
1006  * \retval 0+ An open file descriptor.
1007  * \retval -1 Error with status code in errno.
1008  */
1009 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
1010                            const struct llapi_layout *layout);
1011
1012 /**
1013  * Create a new file at \a path with the specified \a layout and \a mode.
1014  *
1015  * One access mode and zero or more file creation flags and file status
1016  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
1017  * open file descriptor for the file.  If \a layout is non-NULL and
1018  * \a path is not on a Lustre filesystem this function will fail and set
1019  * errno to ENOTTY.
1020  *
1021  * The function call
1022  *
1023  *   llapi_layout_file_create(path, open_flags, mode, layout)
1024  *
1025  * shall be equivalent to:
1026  *
1027  *   llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
1028  *
1029  * It is an error if \a path specifies an existing file.
1030  *
1031  * A NULL \a layout may be specified, in which the standard Lustre
1032  * behavior for assigning layouts to newly-created files will apply.
1033  *
1034  * \retval 0+ An open file descriptor.
1035  * \retval -1 Error with status code in errno.
1036  */
1037 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1038                              const struct llapi_layout *layout);
1039
1040 /**
1041  * Set flags to the header of component layout.
1042  */
1043 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
1044 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
1045 const char *llapi_layout_flags_string(uint32_t flags);
1046 __u16 llapi_layout_string_flags(char *string);
1047
1048 /**
1049  * llapi_layout_mirror_count_get() - Get mirror count from the header of
1050  *                                   a layout.
1051  * @layout: Layout to get mirror count from.
1052  * @count:  Returned mirror count value.
1053  *
1054  * This function gets mirror count from the header of a layout.
1055  *
1056  * Return: 0 on success or -1 on failure.
1057  */
1058 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1059                                   uint16_t *count);
1060
1061 /**
1062  * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1063  * @layout: Layout to set mirror count in.
1064  * @count:  Mirror count value to be set.
1065  *
1066  * This function sets mirror count to the header of a layout.
1067  *
1068  * Return: 0 on success or -1 on failure.
1069  */
1070 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1071                                   uint16_t count);
1072
1073 /**
1074  * Fetch the start and end offset of the current layout component.
1075  */
1076 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1077                                  uint64_t *start, uint64_t *end);
1078 /**
1079  * Set the extent of current layout component.
1080  */
1081 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1082                                  uint64_t start, uint64_t end);
1083
1084 /* PFL component flags table */
1085 static const struct comp_flag_name {
1086         enum lov_comp_md_entry_flags cfn_flag;
1087         const char *cfn_name;
1088 } comp_flags_table[] = {
1089         { LCME_FL_INIT,         "init" },
1090         { LCME_FL_STALE,        "stale" },
1091         { LCME_FL_PREF_RW,      "prefer" },
1092         { LCME_FL_OFFLINE,      "offline" },
1093         { LCME_FL_NOSYNC,       "nosync" },
1094         { LCME_FL_EXTENSION,    "extension" },
1095 };
1096
1097 /**
1098  * Gets the attribute flags of the current component.
1099  */
1100 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1101                                 uint32_t *flags);
1102 /**
1103  * Sets the specified flags of the current component leaving other flags as-is.
1104  */
1105 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1106 /**
1107  * Clears the flags specified in the flags leaving other flags as-is.
1108  */
1109 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1110 /**
1111  * Fetches the file-unique component ID of the current layout component.
1112  */
1113 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1114 /**
1115  * Fetches the mirror ID of the current layout component.
1116  */
1117 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1118 /**
1119  * Adds one component to the existing composite or plain layout.
1120  */
1121 int llapi_layout_comp_add(struct llapi_layout *layout);
1122 /**
1123  * Adds a first component of a mirror to the existing composite layout.
1124  */
1125 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1126 /**
1127  * Deletes the current layout component from the composite layout.
1128  */
1129 int llapi_layout_comp_del(struct llapi_layout *layout);
1130
1131 enum llapi_layout_comp_use {
1132         LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1133         LLAPI_LAYOUT_COMP_USE_LAST = 2,
1134         LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1135         LLAPI_LAYOUT_COMP_USE_PREV = 4,
1136 };
1137
1138 /**
1139  * Set the currently active component to the specified component ID.
1140  */
1141 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1142 /**
1143  * Select the currently active component at the specified position.
1144  */
1145 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1146 /**
1147  * Add layout components to an existing file.
1148  */
1149 int llapi_layout_file_comp_add(const char *path,
1150                                const struct llapi_layout *layout);
1151 /**
1152  * Delete component(s) by the specified component id or flags.
1153  */
1154 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1155 /**
1156  * Change flags or other parameters of the component(s) by component ID of an
1157  * existing file. The component to be modified is specified by the
1158  * comp->lcme_id value, which must be an unique component ID. The new
1159  * attributes are passed in by @comp and @valid is used to specify which
1160  * attributes in the component are going to be changed.
1161  */
1162 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1163                                size_t count);
1164 /**
1165  * Check if the file layout is composite.
1166  */
1167 bool llapi_layout_is_composite(struct llapi_layout *layout);
1168
1169 enum {
1170         LLAPI_LAYOUT_ITER_CONT = 0,
1171         LLAPI_LAYOUT_ITER_STOP = 1,
1172 };
1173
1174 /**
1175  * Iteration callback function.
1176  *
1177  * \retval LLAPI_LAYOUT_ITER_CONT       Iteration proceeds
1178  * \retval LLAPI_LAYOUT_ITER_STOP       Stop iteration
1179  * \retval < 0                          error code
1180  */
1181 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1182
1183 /**
1184  * Iterate all components in the corresponding layout
1185  */
1186 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1187                               llapi_layout_iter_cb cb, void *cbdata);
1188
1189 /**
1190  * FLR: mirror operation APIs
1191  */
1192 int llapi_mirror_set(int fd, unsigned int id);
1193 int llapi_mirror_clear(int fd);
1194 ssize_t llapi_mirror_read(int fd, unsigned int id,
1195                            void *buf, size_t count, off_t pos);
1196 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1197 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1198                       off_t pos, size_t count);
1199 off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size);
1200 int llapi_mirror_punch(int fd, unsigned int id, off_t start, size_t length);
1201
1202 int llapi_heat_get(int fd, struct lu_heat *heat);
1203 int llapi_heat_set(int fd, __u64 flags);
1204
1205 int llapi_layout_sanity(struct llapi_layout *layout, const char *fname,
1206                         bool incomplete, bool flr);
1207 void llapi_layout_sanity_perror(int error);
1208 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1209
1210 int llapi_param_get_paths(const char *pattern, glob_t *paths);
1211 int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
1212 void llapi_param_paths_free(glob_t *paths);
1213
1214 /** @} llapi */
1215
1216 #if defined(__cplusplus)
1217 }
1218 #endif
1219
1220 #endif