lustre/include/lustre/lustreapi.h

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