lustre/include/lustre/lustreapi.h

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