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