lustre/include/lustre/lustreapi.h

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