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, 2016, 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 #ifndef LL_MAXQUOTAS
  46 #define LL_MAXQUOTAS 3
  47 #endif
  48
  49 #ifndef ARRAY_SIZE
  50 #define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0])))
  51 #endif
  52
  53 extern bool liblustreapi_initialized;
  54
  55
  56 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
  57                            void *args);
  58
  59 /* lustreapi message severity level */
  60 enum llapi_message_level {
  61         LLAPI_MSG_OFF    = 0,
  62         LLAPI_MSG_FATAL  = 1,
  63         LLAPI_MSG_ERROR  = 2,
  64         LLAPI_MSG_WARN   = 3,
  65         LLAPI_MSG_NORMAL = 4,
  66         LLAPI_MSG_INFO   = 5,
  67         LLAPI_MSG_DEBUG  = 6,
  68         LLAPI_MSG_MAX
  69 };
  70
  71 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
  72                                      const char *fmt, va_list ap);
  73
  74
  75 /* the bottom three bits reserved for llapi_message_level */
  76 #define LLAPI_MSG_MASK          0x00000007
  77 #define LLAPI_MSG_NO_ERRNO      0x00000010
  78
  79 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
  80 {
  81         static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
  82                                                     "WARNING", "NORMAL",
  83                                                     "INFO", "DEBUG"};
  84
  85         if (level >= LLAPI_MSG_MAX)
  86                 return NULL;
  87
  88         return levels[level];
  89 }
  90 extern void llapi_msg_set_level(int level);
  91 int llapi_msg_get_level(void);
  92 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
  93 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
  94
  95 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
  96         __attribute__((__format__(__printf__, 3, 4)));
  97 #define llapi_err_noerrno(level, fmt, a...)                     \
  98         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
  99 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
 100         __attribute__((__format__(__printf__, 2, 3)));
 101
 102 struct llapi_stripe_param {
 103         unsigned long long      lsp_stripe_size;
 104         char                    *lsp_pool;
 105         int                     lsp_stripe_offset;
 106         int                     lsp_stripe_pattern;
 107         /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
 108         int                     lsp_stripe_count;
 109         bool                    lsp_is_specific;
 110         __u32                   lsp_osts[0];
 111 };
 112
 113 extern int llapi_file_open_param(const char *name, int flags, mode_t mode,
 114                                  const struct llapi_stripe_param *param);
 115 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
 116                              int stripe_offset, int stripe_count,
 117                              int stripe_pattern);
 118 extern int llapi_file_open(const char *name, int flags, int mode,
 119                            unsigned long long stripe_size, int stripe_offset,
 120                            int stripe_count, int stripe_pattern);
 121 extern int llapi_file_create_pool(const char *name,
 122                                   unsigned long long stripe_size,
 123                                   int stripe_offset, int stripe_count,
 124                                   int stripe_pattern, char *pool_name);
 125 extern int llapi_file_open_pool(const char *name, int flags, int mode,
 126                                 unsigned long long stripe_size,
 127                                 int stripe_offset, int stripe_count,
 128                                 int stripe_pattern, char *pool_name);
 129 extern int llapi_poollist(const char *name);
 130 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
 131                               char *buffer, int buffer_size);
 132 extern int llapi_get_poolmembers(const char *poolname, char **members,
 133                                  int list_size, char *buffer, int buffer_size);
 134 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
 135 extern int llapi_file_lookup(int dirfd, const char *name);
 136
 137 #define VERBOSE_COUNT              0x1
 138 #define VERBOSE_SIZE               0x2
 139 #define VERBOSE_OFFSET             0x4
 140 #define VERBOSE_POOL               0x8
 141 #define VERBOSE_DETAIL            0x10
 142 #define VERBOSE_OBJID             0x20
 143 #define VERBOSE_GENERATION        0x40
 144 #define VERBOSE_MDTINDEX          0x80
 145 #define VERBOSE_LAYOUT           0x100
 146 #define VERBOSE_COMP_COUNT       0x200
 147 #define VERBOSE_COMP_FLAGS       0x400
 148 #define VERBOSE_COMP_START       0x800
 149 #define VERBOSE_COMP_END        0x1000
 150 #define VERBOSE_COMP_ID         0x2000
 151 #define VERBOSE_DFID            0x4000
 152 #define VERBOSE_HASH_TYPE       0x8000
 153 #define VERBOSE_DEFAULT         (VERBOSE_COUNT | VERBOSE_SIZE | \
 154                                  VERBOSE_OFFSET | VERBOSE_POOL | \
 155                                  VERBOSE_OBJID | VERBOSE_GENERATION | \
 156                                  VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
 157                                  VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
 158                                  VERBOSE_COMP_START | VERBOSE_COMP_END | \
 159                                  VERBOSE_COMP_ID)
 160
 161 struct find_param {
 162         unsigned int             fp_max_depth;
 163         dev_t                    fp_dev;
 164         mode_t                   fp_type; /* S_IFIFO,... */
 165         uid_t                    fp_uid;
 166         gid_t                    fp_gid;
 167         time_t                   fp_atime;
 168         time_t                   fp_mtime;
 169         time_t                   fp_ctime;
 170         /* {a,m,c}sign cannot be bitfields due to using pointers to
 171          * access them during argument parsing. */
 172         int                      fp_asign;
 173         int                      fp_msign;
 174         int                      fp_csign;
 175         /* these need to be signed values */
 176         int                      fp_size_sign:2,
 177                                  fp_stripe_size_sign:2,
 178                                  fp_stripe_count_sign:2,
 179                                  fp_comp_start_sign:2,
 180                                  fp_comp_end_sign:2,
 181                                  fp_comp_count_sign:2,
 182                                  fp_mdt_count_sign:2;
 183         unsigned long long       fp_size;
 184         unsigned long long       fp_size_units;
 185
 186         unsigned long long       fp_zero_end:1,
 187                                  fp_recursive:1,
 188                                  fp_exclude_pattern:1,
 189                                  fp_exclude_type:1,
 190                                  fp_exclude_obd:1,
 191                                  fp_exclude_mdt:1,
 192                                  fp_exclude_gid:1,
 193                                  fp_exclude_uid:1,
 194                                  fp_check_gid:1,
 195                                  fp_check_uid:1,
 196                                  fp_check_pool:1,       /* LOV pool name */
 197                                  fp_check_size:1,       /* file size */
 198                                  fp_exclude_pool:1,
 199                                  fp_exclude_size:1,
 200                                  fp_exclude_atime:1,
 201                                  fp_exclude_mtime:1,
 202                                  fp_exclude_ctime:1,
 203                                  fp_get_lmv:1,  /* get MDT list from LMV */
 204                                  fp_raw:1,      /* do not fill in defaults */
 205                                  fp_check_stripe_size:1, /* LOV stripe size */
 206                                  fp_exclude_stripe_size:1,
 207                                  fp_check_stripe_count:1, /* LOV stripe count */
 208                                  fp_exclude_stripe_count:1,
 209                                  fp_check_layout:1,
 210                                  fp_exclude_layout:1,
 211                                  fp_get_default_lmv:1, /* Get default LMV */
 212                                  fp_migrate:1,
 213                                  fp_check_projid:1,
 214                                  fp_exclude_projid:1,
 215                                  fp_check_comp_count:1,
 216                                  fp_exclude_comp_count:1,
 217                                  fp_check_comp_flags:1,
 218                                  fp_exclude_comp_flags:1,
 219                                  fp_check_comp_start:1,
 220                                  fp_exclude_comp_start:1,
 221                                  fp_check_comp_end:1,
 222                                  fp_exclude_comp_end:1,
 223                                  fp_check_comp_id:1,
 224                                  fp_exclude_comp_id:1,
 225                                  fp_check_mdt_count:1,
 226                                  fp_exclude_mdt_count:1,
 227                                  fp_check_hash_type:1,
 228                                  fp_exclude_hash_type:1,
 229                                  fp_yaml:1;     /* output layout in YAML */
 230
 231         int                      fp_verbose;
 232         int                      fp_quiet;
 233
 234         /* regular expression */
 235         char                    *fp_pattern;
 236
 237         struct  obd_uuid        *fp_obd_uuid;
 238         int                      fp_num_obds;
 239         int                      fp_num_alloc_obds;
 240         int                      fp_obd_index;
 241         int                     *fp_obd_indexes;
 242
 243         struct  obd_uuid        *fp_mdt_uuid;
 244         int                      fp_num_mdts;
 245         int                      fp_num_alloc_mdts;
 246         int                      fp_mdt_index;
 247         int                     *fp_mdt_indexes;
 248         int                      fp_file_mdt_index;
 249
 250         size_t                   fp_lum_size;
 251         struct  lov_user_mds_data *fp_lmd;
 252
 253         char                     fp_poolname[LOV_MAXPOOLNAME + 1];
 254
 255         __u32                    fp_lmv_stripe_count;
 256         struct lmv_user_md      *fp_lmv_md;
 257
 258         unsigned long long       fp_stripe_size;
 259         unsigned long long       fp_stripe_size_units;
 260         unsigned long long       fp_stripe_count;
 261         __u32                    fp_layout;
 262
 263         __u32                    fp_comp_count;
 264         __u32                    fp_comp_flags;
 265         __u32                    fp_comp_id;
 266         unsigned long long       fp_comp_start;
 267         unsigned long long       fp_comp_start_units;
 268         unsigned long long       fp_comp_end;
 269         unsigned long long       fp_comp_end_units;
 270         unsigned long long       fp_mdt_count;
 271         unsigned                 fp_projid;
 272
 273         /* In-process parameters. */
 274         unsigned long            fp_got_uuids:1,
 275                                  fp_obds_printed:1;
 276         unsigned int             fp_depth;
 277         unsigned int             fp_hash_type;
 278 };
 279
 280 extern int llapi_ostlist(char *path, struct find_param *param);
 281 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
 282 extern int llapi_getstripe(char *path, struct find_param *param);
 283 extern int llapi_find(char *path, struct find_param *param);
 284
 285 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 286 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
 287                                            int stripe_count, int stripe_pattern,
 288                                             const char *pool_name);
 289 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
 290                                  int stripe_count, int stripe_pattern,
 291                                  const char *poolname);
 292 int llapi_direntry_remove(char *dname);
 293
 294 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
 295                       struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
 296 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 297                      struct obd_statfs *stat_buf,
 298                      struct obd_uuid *uuid_buf);
 299 extern int llapi_ping(char *obd_type, char *obd_name);
 300 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
 301 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 302 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
 303 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 304 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 305 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 306 extern int llapi_is_lustre_mnttype(const char *type);
 307 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
 308 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
 309 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
 310                             unsigned long long *size_units, int bytes_spec);
 311 extern int llapi_search_mounts(const char *pathname, int index,
 312                                char *mntdir, char *fsname);
 313 extern int llapi_search_fsname(const char *pathname, char *fsname);
 314 extern int llapi_getname(const char *path, char *buf, size_t size);
 315 extern int llapi_search_fileset(const char *pathname, char *fileset);
 316
 317 extern int llapi_search_rootpath(char *pathname, const char *fsname);
 318 extern int llapi_nodemap_exists(const char *name);
 319 extern int llapi_migrate_mdt(char *path, struct find_param *param);
 320 extern int llapi_mv(char *path, struct find_param *param);
 321
 322 struct mntent;
 323 #define HAVE_LLAPI_IS_LUSTRE_MNT
 324 extern int llapi_is_lustre_mnt(struct mntent *mnt);
 325 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 326 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
 327                                 llapi_cb_t cb);
 328 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 329 extern int llapi_cp(int argc, char *argv[]);
 330 extern int llapi_ls(int argc, char *argv[]);
 331 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
 332                           int pathlen, long long *recno, int *linkno);
 333 extern int llapi_path2fid(const char *path, lustre_fid *fid);
 334 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
 335                                       int *mdt_index);
 336 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
 337 /* get FID of parent dir + the related name of entry in this parent dir */
 338 extern int llapi_path2parent(const char *path, unsigned int linkno,
 339                              lustre_fid *parent_fid, char *name,
 340                              size_t name_size);
 341 extern int llapi_fd2parent(int fd, unsigned int linkno,
 342                            lustre_fid *parent_fid, char *name,
 343                            size_t name_size);
 344 extern int llapi_chomp_string(char *buf);
 345 extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid,
 346                              int open_flags);
 347
 348 extern int llapi_get_version_string(char *version, unsigned int version_size);
 349 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
 350 extern int llapi_get_version(char *buffer, int buffer_size, char **version)
 351         __attribute__((deprecated));
 352 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 353 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
 354 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
 355 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
 356                                   __u32 archive_id);
 357 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
 358                                __u32 archive_id);
 359 extern int llapi_hsm_register_event_fifo(const char *path);
 360 extern int llapi_hsm_unregister_event_fifo(const char *path);
 361 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
 362                                 const char *fmt, va_list args);
 363
 364 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
 365 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
 366 static inline int llapi_create_volatile(char *directory, int mode)
 367 {
 368         return llapi_create_volatile_idx(directory, -1, mode);
 369 }
 370
 371
 372 extern int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
 373                                          int gid, __u64 flags);
 374 extern int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2,
 375                                __u64 flags);
 376 extern int llapi_swap_layouts(const char *path1, const char *path2,
 377                               __u64 dv1, __u64 dv2, __u64 flags);
 378
 379 /* Changelog interface.  priv is private state, managed internally by these
 380  * functions */
 381
 382 /* Records received are in extended format now, though most of them are still
 383  * written in disk in changelog_rec format (to save space and time), it's
 384  * converted to extended format in the lustre api to ease changelog analysis. */
 385 #define HAVE_CHANGELOG_EXTEND_REC 1
 386
 387 extern int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
 388                                  const char *mdtname, long long startrec);
 389 extern int llapi_changelog_fini(void **priv);
 390 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
 391 extern int llapi_changelog_free(struct changelog_rec **rech);
 392 extern int llapi_changelog_get_fd(void *priv);
 393 /* Allow records up to endrec to be destroyed; requires registered id. */
 394 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
 395                                  long long endrec);
 396
 397 /* HSM copytool interface.
 398  * priv is private state, managed internally by these functions
 399  */
 400 struct hsm_copytool_private;
 401 struct hsm_copyaction_private;
 402
 403 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 404                                        const char *mnt, int archive_count,
 405                                        int *archives, int rfd_flags);
 406 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
 407 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
 408 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
 409                                    struct hsm_action_list **hal, int *msgsize);
 410 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
 411                                   const struct hsm_copytool_private *ct,
 412                                   const struct hsm_action_item *hai,
 413                                   int restore_mdt_index, int restore_open_flags,
 414                                   bool is_error);
 415 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
 416                                 const struct hsm_extent *he,
 417                                 int hp_flags, int errval);
 418 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
 419                                      const struct hsm_extent *he, __u64 total,
 420                                      int hp_flags);
 421 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
 422                                      lustre_fid *fid);
 423 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
 424 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
 425                             unsigned long long stripe_size, int stripe_offset,
 426                             int stripe_count, int stripe_pattern,
 427                             char *pool_name, lustre_fid *newfid);
 428
 429 /* HSM user interface */
 430 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
 431                                                              int data_len);
 432 extern int llapi_hsm_request(const char *path,
 433                              const struct hsm_user_request *request);
 434 extern int llapi_hsm_current_action(const char *path,
 435                                     struct hsm_current_action *hca);
 436
 437 /* JSON handling */
 438 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
 439 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
 440 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
 441                                char *key, __u32 type, void *val);
 442 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
 443                                  FILE *fp);
 444
 445 /* File lease */
 446 extern int llapi_lease_get(int fd, int mode);
 447 extern int llapi_lease_check(int fd);
 448 extern int llapi_lease_put(int fd);
 449
 450 /* Group lock */
 451 int llapi_group_lock(int fd, int gid);
 452 int llapi_group_unlock(int fd, int gid);
 453
 454 /* Ladvise */
 455 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
 456                   struct llapi_lu_ladvise *ladvise);
 457 /** @} llapi */
 458
 459 /* llapi_layout user interface */
 460
 461 /** Opaque data type abstracting the layout of a Lustre file. */
 462 struct llapi_layout;
 463
 464 /*
 465  * Flags to control how layouts are retrieved.
 466  */
 467
 468 /* Replace non-specified values with expected inherited values. */
 469 #define LAYOUT_GET_EXPECTED 0x1
 470
 471 /**
 472  * Return a pointer to a newly-allocated opaque data structure containing
 473  * the layout for the file at \a path.  The pointer should be freed with
 474  * llapi_layout_free() when it is no longer needed. Failure is indicated
 475  * by a NULL return value and an appropriate error code stored in errno.
 476  */
 477 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
 478
 479 /**
 480  * Return a pointer to a newly-allocated opaque data type containing the
 481  * layout for the file referenced by open file descriptor \a fd.  The
 482  * pointer should be freed with llapi_layout_free() when it is no longer
 483  * needed. Failure is indicated by a NULL return value and an
 484  * appropriate error code stored in errno.
 485  */
 486 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
 487
 488 /**
 489  * Return a pointer to a newly-allocated opaque data type containing the
 490  * layout for the file associated with Lustre file identifier string
 491  * \a fidstr.  The string \a path must name a path within the
 492  * filesystem that contains the file being looked up, such as the
 493  * filesystem root.  The returned pointer should be freed with
 494  * llapi_layout_free() when it is no longer needed.  Failure is
 495  * indicated with a NULL return value and an appropriate error code
 496  * stored in errno.
 497  */
 498 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
 499                                              const lustre_fid *fid,
 500                                              uint32_t flags);
 501
 502 /**
 503  * Allocate a new layout. Use this when creating a new file with
 504  * llapi_layout_file_create().
 505  */
 506 struct llapi_layout *llapi_layout_alloc(void);
 507
 508 /**
 509  * Free memory allocated for \a layout.
 510  */
 511 void llapi_layout_free(struct llapi_layout *layout);
 512
 513 /** Not a valid stripe size, offset, or RAID pattern. */
 514 #define LLAPI_LAYOUT_INVALID    0x1000000000000001ULL
 515
 516 /**
 517  * When specified or returned as the value for stripe count,
 518  * stripe size, offset, or RAID pattern, the filesystem-wide
 519  * default behavior will apply.
 520  */
 521 #define LLAPI_LAYOUT_DEFAULT    (LLAPI_LAYOUT_INVALID + 1)
 522
 523 /**
 524  * When specified or returned as the value for stripe count, all
 525  * available OSTs will be used.
 526  */
 527 #define LLAPI_LAYOUT_WIDE       (LLAPI_LAYOUT_INVALID + 2)
 528
 529 /**
 530  * When specified as the value for layout pattern, file objects will be
 531  * stored using RAID0.  That is, data will be split evenly and without
 532  * redundancy across all OSTs in the layout.
 533  */
 534 #define LLAPI_LAYOUT_RAID0      0
 535
 536 /**
 537 * The layout includes a specific set of OSTs on which to allocate.
 538 */
 539 #define LLAPI_LAYOUT_SPECIFIC   0x2000000000000000ULL
 540
 541 /**
 542  * A valid ost index should be less than maximum valid OST index (UINT_MAX).
 543  */
 544 #define LLAPI_LAYOUT_IDX_MAX    0x00000000FFFFFFFFULL
 545
 546 /**
 547  * Flags to modify how layouts are retrieved.
 548  */
 549 /******************** Stripe Count ********************/
 550
 551 /**
 552  * Store the stripe count of \a layout in \a count.
 553  *
 554  * \retval  0 Success
 555  * \retval -1 Error with status code in errno.
 556  */
 557 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
 558                                   uint64_t *count);
 559
 560 /**
 561  * Set the stripe count of \a layout to \a count.
 562  *
 563  * \retval  0 Success.
 564  * \retval -1 Invalid argument, errno set to EINVAL.
 565  */
 566 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
 567
 568 /******************** Stripe Size ********************/
 569
 570 /**
 571  * Store the stripe size of \a layout in \a size.
 572  *
 573  * \retval  0 Success.
 574  * \retval -1 Invalid argument, errno set to EINVAL.
 575  */
 576 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
 577                                  uint64_t *size);
 578
 579 /**
 580  * Set the stripe size of \a layout to \a stripe_size.
 581  *
 582  * \retval  0 Success.
 583  * \retval -1 Invalid argument, errno set to EINVAL.
 584  */
 585 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
 586
 587 /******************** Stripe Pattern ********************/
 588
 589 /**
 590  * Store the stripe pattern of \a layout in \a pattern.
 591  *
 592  * \retval 0  Success.
 593  * \retval -1 Error with status code in errno.
 594  */
 595 int llapi_layout_pattern_get(const struct llapi_layout *layout,
 596                              uint64_t *pattern);
 597
 598 /**
 599  * Set the stripe pattern of \a layout to \a pattern.
 600  *
 601  * \retval  0 Success.
 602  * \retval -1 Invalid argument, errno set to EINVAL.
 603  */
 604 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
 605
 606 /******************** OST Index ********************/
 607
 608 /**
 609  * Store the index of the OST where stripe number \a stripe_number is stored
 610  * in \a index.
 611  *
 612  * An error return value will result from a NULL layout, if \a
 613  * stripe_number is out of range, or if \a layout was not initialized
 614  * with llapi_layout_lookup_by{path,fd,fid}().
 615  *
 616  * \retval  0 Success
 617  * \retval -1 Invalid argument, errno set to EINVAL.
 618  */
 619 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
 620                                uint64_t stripe_number, uint64_t *index);
 621
 622 /**
 623  * Set the OST index associated with stripe number \a stripe_number to
 624  * \a ost_index.
 625  * NB: This is currently supported only for \a stripe_number = 0 and
 626  * other usage will return ENOTSUPP in errno.  A NULL \a layout or
 627  * out-of-range \a stripe_number will return EINVAL in errno.
 628  *
 629  * \retval  0 Success.
 630  * \retval -1 Error with errno set to non-zero value.
 631  */
 632 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
 633                                uint64_t index);
 634
 635 /******************** Pool Name ********************/
 636
 637 /**
 638  * Store up to \a pool_name_len characters of the name of the pool of
 639  * OSTs associated with \a layout into the buffer pointed to by
 640  * \a pool_name.
 641  *
 642  * The correct calling form is:
 643  *
 644  *   llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
 645  *
 646  * A pool defines a set of OSTs from which file objects may be
 647  * allocated for a file using \a layout.
 648  *
 649  * On success, the number of bytes stored is returned, excluding the
 650  * terminating '\0' character (zero indicates that \a layout does not
 651  * have an associated OST pool).  On error, -1 is returned and errno is
 652  * set appropriately. Possible sources of error include a NULL pointer
 653  * argument or insufficient space in \a dest to store the pool name,
 654  * in which cases errno will be set to EINVAL.
 655  *
 656  * \retval 0+           The number of bytes stored in \a dest.
 657  * \retval -1           Invalid argument, errno set to EINVAL.
 658  */
 659 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
 660                               char *pool_name, size_t pool_name_len);
 661
 662 /**
 663  * Set the name of the pool of OSTs from which file objects will be
 664  * allocated to \a pool_name.
 665  *
 666  * If the pool name uses "fsname.pool" notation to qualify the pool name
 667  * with a filesystem name, the "fsname." portion will be silently
 668  * discarded before storing the value. No validation that \a pool_name
 669  * is an existing non-empty pool in filesystem \a fsname will be
 670  * performed.  Such validation can be performed by the application if
 671  * desired using the llapi_search_ost() function.  The maximum length of
 672  * the stored value is defined by the constant LOV_MAXPOOLNAME.
 673  *
 674  * \retval  0   Success.
 675  * \retval -1   Invalid argument, errno set to EINVAL.
 676  */
 677 int llapi_layout_pool_name_set(struct llapi_layout *layout,
 678                               const char *pool_name);
 679
 680 /******************** File Creation ********************/
 681
 682 /**
 683  * Open an existing file at \a path, or create it with the specified
 684  * \a layout and \a mode.
 685  *
 686  * One access mode and zero or more file creation flags and file status
 687  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 688  * open file descriptor for the file.  If \a layout is non-NULL and
 689  * \a path is not on a Lustre filesystem this function will fail and set
 690  * errno to ENOTTY.
 691  *
 692  * An already existing file may be opened with this function, but
 693  * \a layout and \a mode will not be applied to it.  Callers requiring a
 694  * guarantee that the opened file is created with the specified
 695  * \a layout and \a mode should use llapi_layout_file_create().
 696  *
 697  * A NULL \a layout may be specified, in which case the standard Lustre
 698  * behavior for assigning layouts to newly-created files will apply.
 699  *
 700  * \retval 0+ An open file descriptor.
 701  * \retval -1 Error with status code in errno.
 702  */
 703 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
 704                            const struct llapi_layout *layout);
 705
 706 /**
 707  * Create a new file at \a path with the specified \a layout and \a mode.
 708  *
 709  * One access mode and zero or more file creation flags and file status
 710  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 711  * open file descriptor for the file.  If \a layout is non-NULL and
 712  * \a path is not on a Lustre filesystem this function will fail and set
 713  * errno to ENOTTY.
 714  *
 715  * The function call
 716  *
 717  *   llapi_layout_file_create(path, open_flags, mode, layout)
 718  *
 719  * shall be equivalent to:
 720  *
 721  *   llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
 722  *
 723  * It is an error if \a path specifies an existing file.
 724  *
 725  * A NULL \a layout may be specified, in which the standard Lustre
 726  * behavior for assigning layouts to newly-created files will apply.
 727  *
 728  * \retval 0+ An open file descriptor.
 729  * \retval -1 Error with status code in errno.
 730  */
 731 int llapi_layout_file_create(const char *path, int open_flags, int mode,
 732                              const struct llapi_layout *layout);
 733
 734 /**
 735  * Fetch the start and end offset of the current layout component.
 736  */
 737 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
 738                                  uint64_t *start, uint64_t *end);
 739 /**
 740  * Set the extent of current layout component.
 741  */
 742 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
 743                                  uint64_t start, uint64_t end);
 744
 745 /* PFL component flags table */
 746 static const struct comp_flag_name {
 747         enum lov_comp_md_entry_flags cfn_flag;
 748         const char *cfn_name;
 749 } comp_flags_table[] = {
 750         { LCME_FL_INIT,         "init" },
 751         /* For now, only "init" is supported
 752         { LCME_FL_PRIMARY,      "primary" },
 753         { LCME_FL_STALE,        "stale" },
 754         { LCME_FL_OFFLINE,      "offline" },
 755         { LCME_FL_PREFERRED,    "preferred" }
 756         */
 757 };
 758
 759 /**
 760  * Gets the attribute flags of the current component.
 761  */
 762 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
 763                                 uint32_t *flags);
 764 /**
 765  * Sets the specified flags of the current component leaving other flags as-is.
 766  */
 767 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
 768 /**
 769  * Clears the flags specified in the flags leaving other flags as-is.
 770  */
 771 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
 772 /**
 773  * Fetches the file-unique component ID of the current layout component.
 774  */
 775 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
 776 /**
 777  * Adds one component to the existing composite or plain layout.
 778  */
 779 int llapi_layout_comp_add(struct llapi_layout *layout);
 780 /**
 781  * Deletes the current layout component from the composite layout.
 782  */
 783 int llapi_layout_comp_del(struct llapi_layout *layout);
 784
 785 enum llapi_layout_comp_use {
 786         LLAPI_LAYOUT_COMP_USE_FIRST = 1,
 787         LLAPI_LAYOUT_COMP_USE_LAST = 2,
 788         LLAPI_LAYOUT_COMP_USE_NEXT = 3,
 789         LLAPI_LAYOUT_COMP_USE_PREV = 4,
 790 };
 791
 792 /**
 793  * Set the currently active component to the specified component ID.
 794  */
 795 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
 796 /**
 797  * Select the currently active component at the specified position.
 798  */
 799 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
 800 /**
 801  * Add layout components to an existing file.
 802  */
 803 int llapi_layout_file_comp_add(const char *path,
 804                                const struct llapi_layout *layout);
 805 /**
 806  * Delete component(s) by the specified component id or flags.
 807  */
 808 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
 809 /**
 810  * Change flags or other parameters of the component(s) by component ID of an
 811  * existing file. The component to be modified is specified by the
 812  * comp->lcme_id value, which must be an unique component ID. The new
 813  * attributes are passed in by @comp and @valid is used to specify which
 814  * attributes in the component are going to be changed.
 815  */
 816 int llapi_layout_file_comp_set(const char *path,
 817                                const struct llapi_layout *comp,
 818                                uint32_t valid);
 819 /**
 820  * Check if the file layout is composite.
 821  */
 822 bool llapi_layout_is_composite(struct llapi_layout *layout);
 823
 824 /** @} llapi */
 825
 826 #endif