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