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