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