lustre/include/lustre/lustreapi.h

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