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