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