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