lustre/include/lustre/lustreapi.h

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