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
 268         enum llapi_layout_verbose fp_verbose;
 269         int                      fp_quiet;
 270
 271         /* regular expression */
 272         char                    *fp_pattern;
 273
 274         struct  obd_uuid        *fp_obd_uuid;
 275         int                      fp_num_obds;
 276         int                      fp_num_alloc_obds;
 277         int                      fp_obd_index;
 278         int                     *fp_obd_indexes;
 279
 280         struct  obd_uuid        *fp_mdt_uuid;
 281         int                      fp_num_mdts;
 282         int                      fp_num_alloc_mdts;
 283         int                      fp_mdt_index;
 284         int                     *fp_mdt_indexes;
 285         int                      fp_file_mdt_index;
 286
 287         size_t                   fp_lum_size;
 288         struct  lov_user_mds_data *fp_lmd;
 289
 290         char                     fp_poolname[LOV_MAXPOOLNAME + 1];
 291
 292         __u32                    fp_lmv_stripe_count;
 293         struct lmv_user_md      *fp_lmv_md;
 294
 295         unsigned long long       fp_stripe_size;
 296         unsigned long long       fp_stripe_size_units;
 297         unsigned long long       fp_stripe_count;
 298         __u32                    fp_layout;
 299
 300         __u32                    fp_comp_count;
 301         __u32                    fp_mirror_count;
 302         __u32                    fp_comp_flags;
 303         __u32                    fp_comp_neg_flags;
 304         __u16                    fp_mirror_state;
 305         __u16                    fp_mirror_neg_state;
 306         __u32                    fp_comp_id;
 307         __u16                    fp_mirror_id;
 308         __u16                    fp_mirror_index;
 309         unsigned long long       fp_comp_start;
 310         unsigned long long       fp_comp_start_units;
 311         unsigned long long       fp_comp_end;
 312         unsigned long long       fp_comp_end_units;
 313         unsigned long long       fp_mdt_count;
 314         unsigned                 fp_projid;
 315         unsigned long long       fp_blocks;
 316         unsigned long long       fp_blocks_units;
 317
 318         /* In-process parameters. */
 319         unsigned long            fp_got_uuids:1,
 320                                  fp_obds_printed:1;
 321         unsigned int             fp_depth;
 322         unsigned int             fp_hash_type;
 323 };
 324
 325 int llapi_ostlist(char *path, struct find_param *param);
 326 int llapi_uuid_match(char *real_uuid, char *search_uuid);
 327 int llapi_getstripe(char *path, struct find_param *param);
 328 int llapi_find(char *path, struct find_param *param);
 329
 330 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 331 int llapi_dir_set_default_lmv(const char *name,
 332                               const struct llapi_stripe_param *param);
 333 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
 334                                      int stripe_count, int stripe_pattern,
 335                                      const char *pool_name);
 336 int llapi_dir_create(const char *name, mode_t mode,
 337                      const struct llapi_stripe_param *param);
 338 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
 339                           int stripe_count, int stripe_pattern,
 340                           const char *poolname);
 341 int llapi_direntry_remove(char *dname);
 342
 343 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
 344                       struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
 345 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 346                      struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
 347 int llapi_ping(char *obd_type, char *obd_name);
 348 int llapi_target_check(int num_types, char **obd_types, char *dir);
 349 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 350 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
 351 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 352 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 353 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 354 int llapi_is_lustre_mnttype(const char *type);
 355 int llapi_search_tgt(char *fsname, char *poolname, char *tgtname, bool is_mdt);
 356 int llapi_search_ost(char *fsname, char *poolname, char *ostname);
 357 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
 358 int llapi_parse_size(const char *optarg, unsigned long long *size,
 359                      unsigned long long *size_units, int bytes_spec);
 360 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
 361                         char *fsname);
 362 int llapi_search_fsname(const char *pathname, char *fsname);
 363 int llapi_getname(const char *path, char *buf, size_t size);
 364 int llapi_search_fileset(const char *pathname, char *fileset);
 365
 366 int llapi_search_rootpath(char *pathname, const char *fsname);
 367 int llapi_nodemap_exists(const char *name);
 368 int llapi_migrate_mdt(char *path, struct find_param *param);
 369 int llapi_mv(char *path, struct find_param *param);
 370
 371 struct mntent;
 372
 373 #define HAVE_LLAPI_IS_LUSTRE_MNT
 374 int llapi_is_lustre_mnt(struct mntent *mnt);
 375 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 376 int llapi_target_iterate(int type_num, char **obd_type, void *args,
 377                          llapi_cb_t cb);
 378 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 379 int llapi_cp(int argc, char *argv[]);
 380 int llapi_ls(int argc, char *argv[]);
 381 int llapi_fid2path(const char *device, const char *fidstr, char *path,
 382                    int pathlen, long long *recno, int *linkno);
 383 int llapi_path2fid(const char *path, struct lu_fid *fid);
 384 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
 385                                int *mdt_index);
 386 int llapi_fd2fid(int fd, struct lu_fid *fid);
 387 /* get FID of parent dir + the related name of entry in this parent dir */
 388 int llapi_path2parent(const char *path, unsigned int linkno,
 389                       struct lu_fid *parent_fid, char *name, size_t name_size);
 390 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
 391                     char *name, size_t name_size);
 392 int llapi_chomp_string(char *buf);
 393 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
 394                       int open_flags);
 395 int llapi_get_version_string(char *version, unsigned int version_size);
 396 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
 397 int llapi_get_version(char *buffer, int buffer_size, char **version)
 398         __attribute__((deprecated));
 399 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 400 int llapi_file_flush(int fd);
 401 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
 402 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
 403 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
 404 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
 405                            __u32 archive_id);
 406 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
 407                         __u32 archive_id);
 408 int llapi_hsm_register_event_fifo(const char *path);
 409 int llapi_hsm_unregister_event_fifo(const char *path);
 410 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
 411                          const char *fmt, va_list args);
 412
 413 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
 414 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
 415                               int open_flags);
 416 int llapi_create_volatile_param(const char *directory, int mdt_idx,
 417                                 int open_flags, mode_t mode,
 418                                 const struct llapi_stripe_param *stripe_param);
 419
 420 static inline int llapi_create_volatile(char *directory, int open_flags)
 421 {
 422         return llapi_create_volatile_idx(directory, -1, open_flags);
 423 }
 424
 425
 426 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
 427                                   int gid, __u64 flags);
 428 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
 429 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
 430                        __u64 dv2, __u64 flags);
 431
 432 /* Changelog interface.  priv is private state, managed internally by these
 433  * functions */
 434
 435 /* Records received are in extended format now, though most of them are still
 436  * written in disk in changelog_rec format (to save space and time), it's
 437  * converted to extended format in the lustre api to ease changelog analysis. */
 438 #define HAVE_CHANGELOG_EXTEND_REC 1
 439
 440 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
 441                           const char *mdtname, long long startrec);
 442 int llapi_changelog_fini(void **priv);
 443 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
 444 int llapi_changelog_free(struct changelog_rec **rech);
 445 int llapi_changelog_get_fd(void *priv);
 446 /* Allow records up to endrec to be destroyed; requires registered id. */
 447 int llapi_changelog_clear(const char *mdtname, const char *idstr,
 448                           long long endrec);
 449 extern int llapi_changelog_set_xflags(void *priv,
 450                                     enum changelog_send_extra_flag extra_flags);
 451
 452 /* HSM copytool interface.
 453  * priv is private state, managed internally by these functions
 454  */
 455 struct hsm_copytool_private;
 456 struct hsm_copyaction_private;
 457
 458 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 459                                 const char *mnt, int archive_count,
 460                                 int *archives, int rfd_flags);
 461 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
 462 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
 463 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
 464                             struct hsm_action_list **hal, int *msgsize);
 465 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
 466                            const struct hsm_copytool_private *ct,
 467                            const struct hsm_action_item *hai,
 468                            int restore_mdt_index, int restore_open_flags,
 469                            bool is_error);
 470 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
 471                          const struct hsm_extent *he, int hp_flags, int errval);
 472 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
 473                               const struct hsm_extent *he, __u64 total,
 474                               int hp_flags);
 475 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
 476                               struct lu_fid *fid);
 477 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
 478 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
 479                      unsigned long long stripe_size, int stripe_offset,
 480                      int stripe_count, int stripe_pattern, char *pool_name,
 481                      struct lu_fid *newfid);
 482
 483 /* HSM user interface */
 484 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
 485                                                       int data_len);
 486 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
 487 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
 488
 489 /* JSON handling */
 490 int llapi_json_init_list(struct llapi_json_item_list **item_list);
 491 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
 492 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
 493                         __u32 type, void *val);
 494 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
 495
 496 /* File lease */
 497 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
 498 int llapi_lease_release(int fd);
 499 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
 500 int llapi_lease_check(int fd);
 501 int llapi_lease_get(int fd, int mode); /* obsoleted */
 502 int llapi_lease_put(int fd); /* obsoleted */
 503
 504 /* Group lock */
 505 int llapi_group_lock(int fd, int gid);
 506 int llapi_group_unlock(int fd, int gid);
 507
 508 /* Ladvise */
 509 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
 510                   struct llapi_lu_ladvise *ladvise);
 511 /** @} llapi */
 512
 513 /* llapi_layout user interface */
 514
 515 /**
 516  * An array element storing component info to be resynced during mirror
 517  * resynchronization.
 518  */
 519 struct llapi_resync_comp {
 520         uint64_t lrc_start;
 521         uint64_t lrc_end;
 522         uint32_t lrc_mirror_id;
 523         uint32_t lrc_id;        /* component id */
 524         bool lrc_synced;
 525 };
 526
 527 /** Opaque data type abstracting the layout of a Lustre file. */
 528 struct llapi_layout;
 529
 530 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
 531 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
 532                            size_t count, off_t pos);
 533 uint32_t llapi_mirror_find(struct llapi_layout *layout,
 534                            uint64_t file_start, uint64_t file_end,
 535                            uint64_t *endp);
 536 int llapi_mirror_find_stale(struct llapi_layout *layout,
 537                 struct llapi_resync_comp *comp, size_t comp_size,
 538                 __u16 *mirror_ids, int ids_nr);
 539 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
 540                              struct llapi_resync_comp *comp_array,
 541                              int comp_size,  uint64_t start, uint64_t end);
 542 /*
 543  * Flags to control how layouts are retrieved.
 544  */
 545
 546 /* Replace non-specified values with expected inherited values. */
 547 #define LAYOUT_GET_EXPECTED 0x1
 548
 549 /**
 550  * Return a pointer to a newly-allocated opaque data structure containing
 551  * the layout for the file at \a path.  The pointer should be freed with
 552  * llapi_layout_free() when it is no longer needed. Failure is indicated
 553  * by a NULL return value and an appropriate error code stored in errno.
 554  */
 555 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
 556
 557 /**
 558  * Return a pointer to a newly-allocated opaque data type containing the
 559  * layout for the file referenced by open file descriptor \a fd.  The
 560  * pointer should be freed with llapi_layout_free() when it is no longer
 561  * needed. Failure is indicated by a NULL return value and an
 562  * appropriate error code stored in errno.
 563  */
 564 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
 565
 566 /**
 567  * Return a pointer to a newly-allocated opaque data type containing the
 568  * layout for the file associated with Lustre file identifier
 569  * \a fid.  The string \a path must name a path within the
 570  * filesystem that contains the file being looked up, such as the
 571  * filesystem root.  The returned pointer should be freed with
 572  * llapi_layout_free() when it is no longer needed.  Failure is
 573  * indicated with a NULL return value and an appropriate error code
 574  * stored in errno.
 575  */
 576 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
 577                                              const struct lu_fid *fid,
 578                                              uint32_t flags);
 579
 580 enum llapi_layout_xattr_flags {
 581         LLAPI_LXF_CHECK = 0x0001,
 582         LLAPI_LXF_COPY  = 0x0002,
 583 };
 584
 585 /**
 586  * Return a pointer to a newly-allocated opaque data type containing the
 587  * layout for the file associated with extended attribute \a lov_xattr.  The
 588  * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
 589  * should be raw xattr without being swapped, since this function will swap it
 590  * properly. Thus, \a lov_xattr will be modified during the process. If the
 591  * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
 592  * the objects count in lum is consistent with the stripe count in lum. This
 593  * check only apply to regular file, so \a LLAPI_LXF_CHECK flag should be
 594  * cleared if the xattr belongs to a directory. If the \a LLAPI_LXF_COPY flag
 595  * of \a flags is set, this function will use a temporary buffer for byte
 596  * swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the byte
 597  * swapping will be done to the \a lov_xattr buffer directly.  The returned
 598  * pointer should be freed with llapi_layout_free() when it is no longer
 599  * needed.  Failure is  * indicated with a NULL return value and an appropriate
 600  * error code stored in errno.
 601  */
 602 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
 603                                                ssize_t lov_xattr_size,
 604                                                uint32_t flags);
 605
 606 /**
 607  * Allocate a new layout. Use this when creating a new file with
 608  * llapi_layout_file_create().
 609  */
 610 struct llapi_layout *llapi_layout_alloc(void);
 611
 612 /**
 613  * Free memory allocated for \a layout.
 614  */
 615 void llapi_layout_free(struct llapi_layout *layout);
 616
 617 /**
 618  * llapi_layout_merge() - Merge a composite layout into another one.
 619  * @dst_layout: Destination composite layout.
 620  * @src_layout: Source composite layout.
 621  *
 622  * This function copies all of the components from @src_layout and
 623  * appends them to @dst_layout.
 624  *
 625  * Return: 0 on success or -1 on failure.
 626  */
 627 int llapi_layout_merge(struct llapi_layout **dst_layout,
 628                        const struct llapi_layout *src_layout);
 629
 630 /** Not a valid stripe size, offset, or RAID pattern. */
 631 #define LLAPI_LAYOUT_INVALID    0x1000000000000001ULL
 632
 633 /**
 634  * When specified or returned as the value for stripe count,
 635  * stripe size, offset, or RAID pattern, the filesystem-wide
 636  * default behavior will apply.
 637  */
 638 #define LLAPI_LAYOUT_DEFAULT    (LLAPI_LAYOUT_INVALID + 1)
 639
 640 /**
 641  * When specified or returned as the value for stripe count, all
 642  * available OSTs will be used.
 643  */
 644 #define LLAPI_LAYOUT_WIDE       (LLAPI_LAYOUT_INVALID + 2)
 645
 646 /**
 647  * When specified as the value for layout pattern, file objects will be
 648  * stored using RAID0.  That is, data will be split evenly and without
 649  * redundancy across all OSTs in the layout.
 650  */
 651 #define LLAPI_LAYOUT_RAID0      0ULL
 652 #define LLAPI_LAYOUT_MDT        2ULL
 653
 654 /**
 655 * The layout includes a specific set of OSTs on which to allocate.
 656 */
 657 #define LLAPI_LAYOUT_SPECIFIC   0x2000000000000000ULL
 658
 659 /**
 660  * A valid ost index should be less than maximum valid OST index (UINT_MAX).
 661  */
 662 #define LLAPI_LAYOUT_IDX_MAX    0x00000000FFFFFFFFULL
 663
 664 /**
 665  * Flags to modify how layouts are retrieved.
 666  */
 667 /******************** Stripe Count ********************/
 668
 669 /**
 670  * Store the stripe count of \a layout in \a count.
 671  *
 672  * \retval  0 Success
 673  * \retval -1 Error with status code in errno.
 674  */
 675 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
 676                                   uint64_t *count);
 677
 678 /**
 679  * Set the stripe count of \a layout to \a count.
 680  *
 681  * \retval  0 Success.
 682  * \retval -1 Invalid argument, errno set to EINVAL.
 683  */
 684 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
 685
 686 /******************** Stripe Size ********************/
 687
 688 /**
 689  * Store the stripe size of \a layout in \a size.
 690  *
 691  * \retval  0 Success.
 692  * \retval -1 Invalid argument, errno set to EINVAL.
 693  */
 694 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
 695                                  uint64_t *size);
 696
 697 /**
 698  * Set the stripe size of \a layout to \a stripe_size.
 699  *
 700  * \retval  0 Success.
 701  * \retval -1 Invalid argument, errno set to EINVAL.
 702  */
 703 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
 704
 705 /******************** Stripe Pattern ********************/
 706
 707 /**
 708  * Store the stripe pattern of \a layout in \a pattern.
 709  *
 710  * \retval 0  Success.
 711  * \retval -1 Error with status code in errno.
 712  */
 713 int llapi_layout_pattern_get(const struct llapi_layout *layout,
 714                              uint64_t *pattern);
 715
 716 /**
 717  * Set the stripe pattern of \a layout to \a pattern.
 718  *
 719  * \retval  0 Success.
 720  * \retval -1 Invalid argument, errno set to EINVAL.
 721  */
 722 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
 723
 724 /******************** OST Index ********************/
 725
 726 /**
 727  * Store the index of the OST where stripe number \a stripe_number is stored
 728  * in \a index.
 729  *
 730  * An error return value will result from a NULL layout, if \a
 731  * stripe_number is out of range, or if \a layout was not initialized
 732  * with llapi_layout_lookup_by{path,fd,fid}().
 733  *
 734  * \retval  0 Success
 735  * \retval -1 Invalid argument, errno set to EINVAL.
 736  */
 737 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
 738                                uint64_t stripe_number, uint64_t *index);
 739
 740 /**
 741  * Set the OST index associated with stripe number \a stripe_number to
 742  * \a ost_index.
 743  * NB: This is currently supported only for \a stripe_number = 0 and
 744  * other usage will return ENOTSUPP in errno.  A NULL \a layout or
 745  * out-of-range \a stripe_number will return EINVAL in errno.
 746  *
 747  * \retval  0 Success.
 748  * \retval -1 Error with errno set to non-zero value.
 749  */
 750 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
 751                                uint64_t index);
 752
 753 /******************** Pool Name ********************/
 754
 755 /**
 756  * Store up to \a pool_name_len characters of the name of the pool of
 757  * OSTs associated with \a layout into the buffer pointed to by
 758  * \a pool_name.
 759  *
 760  * The correct calling form is:
 761  *
 762  *   llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
 763  *
 764  * A pool defines a set of OSTs from which file objects may be
 765  * allocated for a file using \a layout.
 766  *
 767  * On success, the number of bytes stored is returned, excluding the
 768  * terminating '\0' character (zero indicates that \a layout does not
 769  * have an associated OST pool).  On error, -1 is returned and errno is
 770  * set appropriately. Possible sources of error include a NULL pointer
 771  * argument or insufficient space in \a dest to store the pool name,
 772  * in which cases errno will be set to EINVAL.
 773  *
 774  * \retval 0+           The number of bytes stored in \a dest.
 775  * \retval -1           Invalid argument, errno set to EINVAL.
 776  */
 777 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
 778                               char *pool_name, size_t pool_name_len);
 779
 780 /**
 781  * Set the name of the pool of OSTs from which file objects will be
 782  * allocated to \a pool_name.
 783  *
 784  * If the pool name uses "fsname.pool" notation to qualify the pool name
 785  * with a filesystem name, the "fsname." portion will be silently
 786  * discarded before storing the value. No validation that \a pool_name
 787  * is an existing non-empty pool in filesystem \a fsname will be
 788  * performed.  Such validation can be performed by the application if
 789  * desired using the llapi_search_ost() function.  The maximum length of
 790  * the stored value is defined by the constant LOV_MAXPOOLNAME.
 791  *
 792  * \retval  0   Success.
 793  * \retval -1   Invalid argument, errno set to EINVAL.
 794  */
 795 int llapi_layout_pool_name_set(struct llapi_layout *layout,
 796                               const char *pool_name);
 797
 798 /******************** File Creation ********************/
 799
 800 /**
 801  * Open an existing file at \a path, or create it with the specified
 802  * \a layout and \a mode.
 803  *
 804  * One access mode and zero or more file creation flags and file status
 805  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 806  * open file descriptor for the file.  If \a layout is non-NULL and
 807  * \a path is not on a Lustre filesystem this function will fail and set
 808  * errno to ENOTTY.
 809  *
 810  * An already existing file may be opened with this function, but
 811  * \a layout and \a mode will not be applied to it.  Callers requiring a
 812  * guarantee that the opened file is created with the specified
 813  * \a layout and \a mode should use llapi_layout_file_create().
 814  *
 815  * A NULL \a layout may be specified, in which case the standard Lustre
 816  * behavior for assigning layouts to newly-created files will apply.
 817  *
 818  * \retval 0+ An open file descriptor.
 819  * \retval -1 Error with status code in errno.
 820  */
 821 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
 822                            const struct llapi_layout *layout);
 823
 824 /**
 825  * Create a new file at \a path with the specified \a layout and \a mode.
 826  *
 827  * One access mode and zero or more file creation flags and file status
 828  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 829  * open file descriptor for the file.  If \a layout is non-NULL and
 830  * \a path is not on a Lustre filesystem this function will fail and set
 831  * errno to ENOTTY.
 832  *
 833  * The function call
 834  *
 835  *   llapi_layout_file_create(path, open_flags, mode, layout)
 836  *
 837  * shall be equivalent to:
 838  *
 839  *   llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
 840  *
 841  * It is an error if \a path specifies an existing file.
 842  *
 843  * A NULL \a layout may be specified, in which the standard Lustre
 844  * behavior for assigning layouts to newly-created files will apply.
 845  *
 846  * \retval 0+ An open file descriptor.
 847  * \retval -1 Error with status code in errno.
 848  */
 849 int llapi_layout_file_create(const char *path, int open_flags, int mode,
 850                              const struct llapi_layout *layout);
 851
 852 /**
 853  * Set flags to the header of component layout.
 854  */
 855 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
 856 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
 857 const char *llapi_layout_flags_string(uint32_t flags);
 858 const __u16 llapi_layout_string_flags(char *string);
 859
 860 /**
 861  * llapi_layout_mirror_count_get() - Get mirror count from the header of
 862  *                                   a layout.
 863  * @layout: Layout to get mirror count from.
 864  * @count:  Returned mirror count value.
 865  *
 866  * This function gets mirror count from the header of a layout.
 867  *
 868  * Return: 0 on success or -1 on failure.
 869  */
 870 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
 871                                   uint16_t *count);
 872
 873 /**
 874  * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
 875  * @layout: Layout to set mirror count in.
 876  * @count:  Mirror count value to be set.
 877  *
 878  * This function sets mirror count to the header of a layout.
 879  *
 880  * Return: 0 on success or -1 on failure.
 881  */
 882 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
 883                                   uint16_t count);
 884
 885 /**
 886  * Fetch the start and end offset of the current layout component.
 887  */
 888 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
 889                                  uint64_t *start, uint64_t *end);
 890 /**
 891  * Set the extent of current layout component.
 892  */
 893 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
 894                                  uint64_t start, uint64_t end);
 895
 896 /* PFL component flags table */
 897 static const struct comp_flag_name {
 898         enum lov_comp_md_entry_flags cfn_flag;
 899         const char *cfn_name;
 900 } comp_flags_table[] = {
 901         { LCME_FL_INIT,         "init" },
 902         { LCME_FL_STALE,        "stale" },
 903         { LCME_FL_PREF_RW,      "prefer" },
 904         { LCME_FL_OFFLINE,      "offline" },
 905         { LCME_FL_NOSYNC,       "nosync" },
 906 };
 907
 908 /**
 909  * Gets the attribute flags of the current component.
 910  */
 911 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
 912                                 uint32_t *flags);
 913 /**
 914  * Sets the specified flags of the current component leaving other flags as-is.
 915  */
 916 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
 917 /**
 918  * Clears the flags specified in the flags leaving other flags as-is.
 919  */
 920 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
 921 /**
 922  * Fetches the file-unique component ID of the current layout component.
 923  */
 924 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
 925 /**
 926  * Fetches the mirror ID of the current layout component.
 927  */
 928 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
 929 /**
 930  * Adds one component to the existing composite or plain layout.
 931  */
 932 int llapi_layout_comp_add(struct llapi_layout *layout);
 933 /**
 934  * Adds a first component of a mirror to the existing composite layout.
 935  */
 936 int llapi_layout_add_first_comp(struct llapi_layout *layout);
 937 /**
 938  * Deletes the current layout component from the composite layout.
 939  */
 940 int llapi_layout_comp_del(struct llapi_layout *layout);
 941
 942 enum llapi_layout_comp_use {
 943         LLAPI_LAYOUT_COMP_USE_FIRST = 1,
 944         LLAPI_LAYOUT_COMP_USE_LAST = 2,
 945         LLAPI_LAYOUT_COMP_USE_NEXT = 3,
 946         LLAPI_LAYOUT_COMP_USE_PREV = 4,
 947 };
 948
 949 /**
 950  * Set the currently active component to the specified component ID.
 951  */
 952 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
 953 /**
 954  * Select the currently active component at the specified position.
 955  */
 956 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
 957 /**
 958  * Add layout components to an existing file.
 959  */
 960 int llapi_layout_file_comp_add(const char *path,
 961                                const struct llapi_layout *layout);
 962 /**
 963  * Delete component(s) by the specified component id or flags.
 964  */
 965 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
 966 /**
 967  * Change flags or other parameters of the component(s) by component ID of an
 968  * existing file. The component to be modified is specified by the
 969  * comp->lcme_id value, which must be an unique component ID. The new
 970  * attributes are passed in by @comp and @valid is used to specify which
 971  * attributes in the component are going to be changed.
 972  */
 973 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
 974                                size_t count);
 975 /**
 976  * Check if the file layout is composite.
 977  */
 978 bool llapi_layout_is_composite(struct llapi_layout *layout);
 979
 980 enum {
 981         LLAPI_LAYOUT_ITER_CONT = 0,
 982         LLAPI_LAYOUT_ITER_STOP = 1,
 983 };
 984
 985 /**
 986  * Iteration callback function.
 987  *
 988  * \retval LLAPI_LAYOUT_ITER_CONT       Iteration proceeds
 989  * \retval LLAPI_LAYOUT_ITER_STOP       Stop iteration
 990  * \retval < 0                          error code
 991  */
 992 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
 993
 994 /**
 995  * Iterate all components in the corresponding layout
 996  */
 997 int llapi_layout_comp_iterate(struct llapi_layout *layout,
 998                               llapi_layout_iter_cb cb, void *cbdata);
 999
1000 /**
1001  * FLR: mirror operation APIs
1002  */
1003 int llapi_mirror_set(int fd, unsigned int id);
1004 int llapi_mirror_clear(int fd);
1005 ssize_t llapi_mirror_read(int fd, unsigned int id,
1006                            void *buf, size_t count, off_t pos);
1007 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1008 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1009                        off_t pos, size_t count);
1010
1011 /** @} llapi */
1012
1013 #if defined(__cplusplus)
1014 }
1015 #endif
1016
1017 #endif