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