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, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef _LUSTREAPI_H_
  34 #define _LUSTREAPI_H_
  35
  36 /** \defgroup llapi llapi
  37  *
  38  * @{
  39  */
  40
  41 #include <stdarg.h>
  42 #include <stdint.h>
  43 #include <linux/lustre/lustre_user.h>
  44
  45 #if defined(__cplusplus)
  46 extern "C" {
  47 #endif
  48
  49 #ifndef LL_MAXQUOTAS
  50 #define LL_MAXQUOTAS 3
  51 #endif
  52
  53 #ifndef ARRAY_SIZE
  54 #define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0])))
  55 #endif
  56
  57 #define lustre_fid struct lu_fid
  58
  59 /* Currently external applications can access this but in the
  60  * future this will no longer be exposed for the user. Instead
  61  * if you want to know if the library is initialized just call
  62  * llapi_liblustreapi_initialized() which is now available. */
  63 extern bool liblustreapi_initialized;
  64
  65 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
  66                            void *args);
  67
  68 /* lustreapi message severity level */
  69 enum llapi_message_level {
  70         LLAPI_MSG_OFF    = 0,
  71         LLAPI_MSG_FATAL  = 1,
  72         LLAPI_MSG_ERROR  = 2,
  73         LLAPI_MSG_WARN   = 3,
  74         LLAPI_MSG_NORMAL = 4,
  75         LLAPI_MSG_INFO   = 5,
  76         LLAPI_MSG_DEBUG  = 6,
  77         LLAPI_MSG_MAX
  78 };
  79
  80 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
  81                                      const char *fmt, va_list ap);
  82
  83 static inline bool llapi_liblustreapi_initialized(void)
  84 {
  85         return liblustreapi_initialized;
  86 }
  87
  88 /* the bottom three bits reserved for llapi_message_level */
  89 #define LLAPI_MSG_MASK          0x00000007
  90 #define LLAPI_MSG_NO_ERRNO      0x00000010
  91
  92 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
  93 {
  94         static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
  95                                                     "WARNING", "NORMAL",
  96                                                     "INFO", "DEBUG"};
  97
  98         if (level >= LLAPI_MSG_MAX)
  99                 return NULL;
 100
 101         return levels[level];
 102 }
 103
 104 void llapi_msg_set_level(int level);
 105 int llapi_msg_get_level(void);
 106 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
 107 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
 108
 109 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
 110         __attribute__((__format__(__printf__, 3, 4)));
 111 #define llapi_err_noerrno(level, fmt, a...)                     \
 112         llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
 113 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
 114         __attribute__((__format__(__printf__, 2, 3)));
 115
 116 struct llapi_stripe_param {
 117         unsigned long long      lsp_stripe_size;
 118         char                    *lsp_pool;
 119         int                     lsp_stripe_offset;
 120         int                     lsp_stripe_pattern;
 121         /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
 122         int                     lsp_stripe_count;
 123         bool                    lsp_is_specific;
 124         __u32                   lsp_osts[0];
 125 };
 126
 127 #define lsp_tgts        lsp_osts
 128
 129 __u32 llapi_pattern_to_lov(uint64_t pattern);
 130
 131 int llapi_file_open_param(const char *name, int flags, mode_t mode,
 132                           const struct llapi_stripe_param *param);
 133 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
 134                               __u32 flags, char *foreign_lov);
 135 int llapi_file_create(const char *name, unsigned long long stripe_size,
 136                       int stripe_offset, int stripe_count, int stripe_pattern);
 137 int llapi_file_open(const char *name, int flags, int mode,
 138                     unsigned long long stripe_size, int stripe_offset,
 139                     int stripe_count, int stripe_pattern);
 140 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
 141                            int stripe_offset, int stripe_count,
 142                            int stripe_pattern, char *pool_name);
 143 int llapi_file_open_pool(const char *name, int flags, int mode,
 144                          unsigned long long stripe_size, int stripe_offset,
 145                          int stripe_count, int stripe_pattern, char *pool_name);
 146 int llapi_poollist(const char *name);
 147 int llapi_get_poollist(const char *name, char **poollist, int list_size,
 148                        char *buffer, int buffer_size);
 149 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
 150                           char *buffer, int buffer_size);
 151 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
 152 int llapi_file_lookup(int dirfd, const char *name);
 153 void llapi_set_command_name(const char *cmd);
 154 void llapi_clear_command_name(void);
 155
 156 enum llapi_layout_verbose  {
 157         VERBOSE_STRIPE_COUNT    =     0x1,
 158         VERBOSE_STRIPE_SIZE     =     0x2,
 159         VERBOSE_STRIPE_OFFSET   =     0x4,
 160         VERBOSE_POOL            =     0x8,
 161         VERBOSE_DETAIL          =    0x10,
 162         VERBOSE_OBJID           =    0x20,
 163         VERBOSE_GENERATION      =    0x40,
 164         VERBOSE_MDTINDEX        =    0x80,
 165         VERBOSE_PATTERN         =   0x100,
 166         VERBOSE_COMP_COUNT      =   0x200,
 167         VERBOSE_COMP_FLAGS      =   0x400,
 168         VERBOSE_COMP_START      =   0x800,
 169         VERBOSE_COMP_END        =  0x1000,
 170         VERBOSE_COMP_ID         =  0x2000,
 171         VERBOSE_DFID            =  0x4000,
 172         VERBOSE_HASH_TYPE       =  0x8000,
 173         VERBOSE_MIRROR_COUNT    = 0x10000,
 174         VERBOSE_MIRROR_ID       = 0x20000,
 175         VERBOSE_DEFAULT         = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
 176                                   VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
 177                                   VERBOSE_OBJID | VERBOSE_GENERATION |
 178                                   VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
 179                                   VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
 180                                   VERBOSE_COMP_START | VERBOSE_COMP_END |
 181                                   VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
 182                                   VERBOSE_MIRROR_ID
 183 };
 184 /* Compatibility with original names */
 185 #define VERBOSE_SIZE    VERBOSE_STRIPE_SIZE
 186 #define VERBOSE_COUNT   VERBOSE_STRIPE_COUNT
 187 #define VERBOSE_OFFSET  VERBOSE_STRIPE_OFFSET
 188 #define VERBOSE_LAYOUT  VERBOSE_PATTERN
 189
 190 struct find_param {
 191         unsigned int             fp_max_depth;
 192         dev_t                    fp_dev;
 193         mode_t                   fp_type; /* S_IFIFO,... */
 194         uid_t                    fp_uid;
 195         gid_t                    fp_gid;
 196         time_t                   fp_atime;
 197         time_t                   fp_mtime;
 198         time_t                   fp_ctime;
 199         /* {a,m,c}sign cannot be bitfields due to using pointers to
 200          * access them during argument parsing. */
 201         int                      fp_asign;
 202         int                      fp_msign;
 203         int                      fp_csign;
 204         /* these need to be signed values */
 205         int                      fp_size_sign:2,
 206                                  fp_stripe_size_sign:2,
 207                                  fp_stripe_count_sign:2,
 208                                  fp_comp_start_sign:2,
 209                                  fp_comp_end_sign:2,
 210                                  fp_comp_count_sign:2,
 211                                  fp_mirror_count_sign:2,
 212                                  fp_mirror_index_sign:2,
 213                                  fp_mirror_id_sign:2,
 214                                  fp_mdt_count_sign:2,
 215                                  fp_blocks_sign:2;
 216         unsigned long long       fp_size;
 217         unsigned long long       fp_size_units;
 218
 219         unsigned long long       fp_zero_end:1,
 220                                  fp_recursive:1,
 221                                  fp_exclude_pattern:1,
 222                                  fp_exclude_type:1,
 223                                  fp_exclude_obd:1,
 224                                  fp_exclude_mdt:1,
 225                                  fp_exclude_gid:1,
 226                                  fp_exclude_uid:1,
 227                                  fp_check_gid:1,
 228                                  fp_check_uid:1,
 229                                  fp_check_pool:1,       /* LOV pool name */
 230                                  fp_check_size:1,       /* file size */
 231                                  fp_exclude_pool:1,
 232                                  fp_exclude_size:1,
 233                                  fp_exclude_atime:1,
 234                                  fp_exclude_mtime:1,
 235                                  fp_exclude_ctime:1,
 236                                  fp_get_lmv:1,  /* get MDT list from LMV */
 237                                  fp_raw:1,      /* do not fill in defaults */
 238                                  fp_check_stripe_size:1, /* LOV stripe size */
 239                                  fp_exclude_stripe_size:1,
 240                                  fp_check_stripe_count:1, /* LOV stripe count */
 241                                  fp_exclude_stripe_count:1,
 242                                  fp_check_layout:1,
 243                                  fp_exclude_layout:1,
 244                                  fp_get_default_lmv:1, /* Get default LMV */
 245                                  fp_migrate:1,
 246                                  fp_check_projid:1,
 247                                  fp_exclude_projid:1,
 248                                  fp_check_comp_count:1,
 249                                  fp_exclude_comp_count:1,
 250                                  fp_check_mirror_count:1,
 251                                  fp_exclude_mirror_count:1,
 252                                  fp_check_comp_flags:1,
 253                                  fp_check_mirror_state:1,
 254                                  fp_check_comp_start:1,
 255                                  fp_exclude_comp_start:1,
 256                                  fp_check_comp_end:1,
 257                                  fp_exclude_comp_end:1,
 258                                  fp_check_comp_id:1,
 259                                  fp_exclude_comp_id:1,
 260                                  fp_check_mirror_id:1,
 261                                  fp_exclude_mirror_id:1,
 262                                  fp_check_mirror_index:1,
 263                                  fp_exclude_mirror_index:1,
 264                                  fp_check_mdt_count:1,
 265                                  fp_exclude_mdt_count:1,
 266                                  fp_check_hash_type:1,
 267                                  fp_exclude_hash_type:1,
 268                                  fp_yaml:1,     /* output layout in YAML */
 269                                  fp_check_blocks:1,
 270                                  fp_exclude_blocks:1,
 271                                  fp_check_foreign:1,
 272                                  fp_exclude_foreign:1;
 273
 274         enum llapi_layout_verbose fp_verbose;
 275         int                      fp_quiet;
 276
 277         /* regular expression */
 278         char                    *fp_pattern;
 279
 280         struct  obd_uuid        *fp_obd_uuid;
 281         int                      fp_num_obds;
 282         int                      fp_num_alloc_obds;
 283         int                      fp_obd_index;
 284         int                     *fp_obd_indexes;
 285
 286         struct  obd_uuid        *fp_mdt_uuid;
 287         int                      fp_num_mdts;
 288         int                      fp_num_alloc_mdts;
 289         int                      fp_mdt_index;
 290         int                     *fp_mdt_indexes;
 291         int                      fp_file_mdt_index;
 292
 293         size_t                   fp_lum_size;
 294         struct  lov_user_mds_data *fp_lmd;
 295
 296         char                     fp_poolname[LOV_MAXPOOLNAME + 1];
 297
 298         __u32                    fp_lmv_stripe_count;
 299         struct lmv_user_md      *fp_lmv_md;
 300
 301         unsigned long long       fp_stripe_size;
 302         unsigned long long       fp_stripe_size_units;
 303         unsigned long long       fp_stripe_count;
 304         __u32                    fp_layout;
 305
 306         __u32                    fp_comp_count;
 307         __u32                    fp_mirror_count;
 308         __u32                    fp_comp_flags;
 309         __u32                    fp_comp_neg_flags;
 310         __u16                    fp_mirror_state;
 311         __u16                    fp_mirror_neg_state;
 312         __u32                    fp_comp_id;
 313         __u16                    fp_mirror_id;
 314         __u16                    fp_mirror_index;
 315         unsigned long long       fp_comp_start;
 316         unsigned long long       fp_comp_start_units;
 317         unsigned long long       fp_comp_end;
 318         unsigned long long       fp_comp_end_units;
 319         unsigned long long       fp_mdt_count;
 320         unsigned                 fp_projid;
 321         unsigned long long       fp_blocks;
 322         unsigned long long       fp_blocks_units;
 323
 324         /* In-process parameters. */
 325         unsigned long            fp_got_uuids:1,
 326                                  fp_obds_printed:1;
 327         unsigned int             fp_depth;
 328         unsigned int             fp_hash_type;
 329         unsigned int             fp_time_margin; /* time margin in seconds */
 330         __u32                    fp_foreign_type;
 331 };
 332
 333 int llapi_ostlist(char *path, struct find_param *param);
 334 int llapi_uuid_match(char *real_uuid, char *search_uuid);
 335 int llapi_getstripe(char *path, struct find_param *param);
 336 int llapi_find(char *path, struct find_param *param);
 337
 338 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
 339 int llapi_dir_set_default_lmv(const char *name,
 340                               const struct llapi_stripe_param *param);
 341 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
 342                                      int stripe_count, int stripe_pattern,
 343                                      const char *pool_name);
 344 int llapi_dir_create(const char *name, mode_t mode,
 345                      const struct llapi_stripe_param *param);
 346 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
 347                              __u32 flags, const char *value);
 348 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
 349                           int stripe_count, int stripe_pattern,
 350                           const char *poolname);
 351 int llapi_direntry_remove(char *dname);
 352
 353 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
 354                       struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
 355 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
 356                      struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
 357 int llapi_ping(char *obd_type, char *obd_name);
 358 int llapi_target_check(int num_types, char **obd_types, char *dir);
 359 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
 360 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
 361 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
 362 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
 363 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
 364 int llapi_is_lustre_mnttype(const char *type);
 365 int llapi_search_tgt(char *fsname, char *poolname, char *tgtname, bool is_mdt);
 366 int llapi_search_ost(char *fsname, char *poolname, char *ostname);
 367 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
 368 int llapi_parse_size(const char *optarg, unsigned long long *size,
 369                      unsigned long long *size_units, int bytes_spec);
 370 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
 371                         char *fsname);
 372 int llapi_search_fsname(const char *pathname, char *fsname);
 373 int llapi_getname(const char *path, char *buf, size_t size);
 374 int llapi_search_fileset(const char *pathname, char *fileset);
 375
 376 int llapi_search_rootpath(char *pathname, const char *fsname);
 377 int llapi_nodemap_exists(const char *name);
 378 int llapi_migrate_mdt(char *path, struct find_param *param);
 379 int llapi_mv(char *path, struct find_param *param);
 380
 381 struct mntent;
 382
 383 #define HAVE_LLAPI_IS_LUSTRE_MNT
 384 int llapi_is_lustre_mnt(struct mntent *mnt);
 385 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
 386 int llapi_target_iterate(int type_num, char **obd_type, void *args,
 387                          llapi_cb_t cb);
 388 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
 389 int llapi_cp(int argc, char *argv[]);
 390 int llapi_ls(int argc, char *argv[]);
 391 int llapi_fid2path(const char *device, const char *fidstr, char *path,
 392                    int pathlen, long long *recno, int *linkno);
 393 int llapi_path2fid(const char *path, struct lu_fid *fid);
 394 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
 395                                int *mdt_index);
 396 int llapi_fd2fid(int fd, struct lu_fid *fid);
 397 /* get FID of parent dir + the related name of entry in this parent dir */
 398 int llapi_path2parent(const char *path, unsigned int linkno,
 399                       struct lu_fid *parent_fid, char *name, size_t name_size);
 400 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
 401                     char *name, size_t name_size);
 402 int llapi_chomp_string(char *buf);
 403 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
 404                       int open_flags);
 405 int llapi_get_version_string(char *version, unsigned int version_size);
 406 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
 407 int llapi_get_version(char *buffer, int buffer_size, char **version)
 408         __attribute__((deprecated));
 409 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
 410 int llapi_file_flush(int fd);
 411 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
 412 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
 413 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
 414 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
 415                            __u32 archive_id);
 416 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
 417                         __u32 archive_id);
 418 int llapi_hsm_register_event_fifo(const char *path);
 419 int llapi_hsm_unregister_event_fifo(const char *path);
 420 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
 421                          const char *fmt, va_list args);
 422
 423 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
 424 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
 425                               int open_flags);
 426 int llapi_create_volatile_param(const char *directory, int mdt_idx,
 427                                 int open_flags, mode_t mode,
 428                                 const struct llapi_stripe_param *stripe_param);
 429
 430 static inline int llapi_create_volatile(char *directory, int open_flags)
 431 {
 432         return llapi_create_volatile_idx(directory, -1, open_flags);
 433 }
 434
 435
 436 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
 437                                   int gid, __u64 flags);
 438 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
 439 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
 440                        __u64 dv2, __u64 flags);
 441
 442 /* Changelog interface.  priv is private state, managed internally by these
 443  * functions */
 444
 445 /* Records received are in extended format now, though most of them are still
 446  * written in disk in changelog_rec format (to save space and time), it's
 447  * converted to extended format in the lustre api to ease changelog analysis. */
 448 #define HAVE_CHANGELOG_EXTEND_REC 1
 449
 450 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
 451                           const char *mdtname, long long startrec);
 452 int llapi_changelog_fini(void **priv);
 453 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
 454 int llapi_changelog_free(struct changelog_rec **rech);
 455 int llapi_changelog_get_fd(void *priv);
 456 /* Allow records up to endrec to be destroyed; requires registered id. */
 457 int llapi_changelog_clear(const char *mdtname, const char *idstr,
 458                           long long endrec);
 459 extern int llapi_changelog_set_xflags(void *priv,
 460                                     enum changelog_send_extra_flag extra_flags);
 461
 462 /* HSM copytool interface.
 463  * priv is private state, managed internally by these functions
 464  */
 465 struct hsm_copytool_private;
 466 struct hsm_copyaction_private;
 467
 468 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
 469                                 const char *mnt, int archive_count,
 470                                 int *archives, int rfd_flags);
 471 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
 472 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
 473 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
 474                             struct hsm_action_list **hal, int *msgsize);
 475 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
 476                            const struct hsm_copytool_private *ct,
 477                            const struct hsm_action_item *hai,
 478                            int restore_mdt_index, int restore_open_flags,
 479                            bool is_error);
 480 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
 481                          const struct hsm_extent *he, int hp_flags, int errval);
 482 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
 483                               const struct hsm_extent *he, __u64 total,
 484                               int hp_flags);
 485 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
 486                               struct lu_fid *fid);
 487 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
 488 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
 489                      unsigned long long stripe_size, int stripe_offset,
 490                      int stripe_count, int stripe_pattern, char *pool_name,
 491                      struct lu_fid *newfid);
 492
 493 /* HSM user interface */
 494 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
 495                                                       int data_len);
 496 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
 497 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
 498
 499 /* JSON handling */
 500 int llapi_json_init_list(struct llapi_json_item_list **item_list);
 501 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
 502 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
 503                         __u32 type, void *val);
 504 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
 505
 506 /* File lease */
 507 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
 508 int llapi_lease_release(int fd);
 509 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
 510 int llapi_lease_check(int fd);
 511 int llapi_lease_get(int fd, int mode); /* obsoleted */
 512 int llapi_lease_put(int fd); /* obsoleted */
 513
 514 /* Group lock */
 515 int llapi_group_lock(int fd, int gid);
 516 int llapi_group_unlock(int fd, int gid);
 517
 518 /* Ladvise */
 519 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
 520                   struct llapi_lu_ladvise *ladvise);
 521 /** @} llapi */
 522
 523 /* llapi_layout user interface */
 524
 525 /**
 526  * An array element storing component info to be resynced during mirror
 527  * resynchronization.
 528  */
 529 struct llapi_resync_comp {
 530         uint64_t lrc_start;
 531         uint64_t lrc_end;
 532         uint32_t lrc_mirror_id;
 533         uint32_t lrc_id;        /* component id */
 534         bool lrc_synced;
 535 };
 536
 537 /** Opaque data type abstracting the layout of a Lustre file. */
 538 struct llapi_layout;
 539
 540 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
 541 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
 542                            size_t count, off_t pos);
 543 uint32_t llapi_mirror_find(struct llapi_layout *layout,
 544                            uint64_t file_start, uint64_t file_end,
 545                            uint64_t *endp);
 546 int llapi_mirror_find_stale(struct llapi_layout *layout,
 547                 struct llapi_resync_comp *comp, size_t comp_size,
 548                 __u16 *mirror_ids, int ids_nr);
 549 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
 550                              struct llapi_resync_comp *comp_array,
 551                              int comp_size,  uint64_t start, uint64_t end);
 552 /*
 553  * Flags to control how layouts are retrieved.
 554  */
 555
 556 /* Replace non-specified values with expected inherited values. */
 557 #define LAYOUT_GET_EXPECTED 0x1
 558
 559 /**
 560  * Return a pointer to a newly-allocated opaque data structure containing
 561  * the layout for the file at \a path.  The pointer should be freed with
 562  * llapi_layout_free() when it is no longer needed. Failure is indicated
 563  * by a NULL return value and an appropriate error code stored in errno.
 564  */
 565 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
 566
 567 /**
 568  * Return a pointer to a newly-allocated opaque data type containing the
 569  * layout for the file referenced by open file descriptor \a fd.  The
 570  * pointer should be freed with llapi_layout_free() when it is no longer
 571  * needed. Failure is indicated by a NULL return value and an
 572  * appropriate error code stored in errno.
 573  */
 574 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
 575
 576 /**
 577  * Return a pointer to a newly-allocated opaque data type containing the
 578  * layout for the file associated with Lustre file identifier
 579  * \a fid.  The string \a path must name a path within the
 580  * filesystem that contains the file being looked up, such as the
 581  * filesystem root.  The returned pointer should be freed with
 582  * llapi_layout_free() when it is no longer needed.  Failure is
 583  * indicated with a NULL return value and an appropriate error code
 584  * stored in errno.
 585  */
 586 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
 587                                              const struct lu_fid *fid,
 588                                              uint32_t flags);
 589
 590 enum llapi_layout_xattr_flags {
 591         LLAPI_LXF_CHECK = 0x0001,
 592         LLAPI_LXF_COPY  = 0x0002,
 593 };
 594
 595 /**
 596  * Return a pointer to a newly-allocated opaque data type containing the
 597  * layout for the file associated with extended attribute \a lov_xattr.  The
 598  * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
 599  * should be raw xattr without being swapped, since this function will swap it
 600  * properly. Thus, \a lov_xattr will be modified during the process. If the
 601  * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
 602  * the objects count in lum is consistent with the stripe count in lum. This
 603  * check only apply to regular file, so \a LLAPI_LXF_CHECK flag should be
 604  * cleared if the xattr belongs to a directory. If the \a LLAPI_LXF_COPY flag
 605  * of \a flags is set, this function will use a temporary buffer for byte
 606  * swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the byte
 607  * swapping will be done to the \a lov_xattr buffer directly.  The returned
 608  * pointer should be freed with llapi_layout_free() when it is no longer
 609  * needed.  Failure is  * indicated with a NULL return value and an appropriate
 610  * error code stored in errno.
 611  */
 612 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
 613                                                ssize_t lov_xattr_size,
 614                                                uint32_t flags);
 615
 616 /**
 617  * Allocate a new layout. Use this when creating a new file with
 618  * llapi_layout_file_create().
 619  */
 620 struct llapi_layout *llapi_layout_alloc(void);
 621
 622 /**
 623  * Free memory allocated for \a layout.
 624  */
 625 void llapi_layout_free(struct llapi_layout *layout);
 626
 627 /**
 628  * llapi_layout_merge() - Merge a composite layout into another one.
 629  * @dst_layout: Destination composite layout.
 630  * @src_layout: Source composite layout.
 631  *
 632  * This function copies all of the components from @src_layout and
 633  * appends them to @dst_layout.
 634  *
 635  * Return: 0 on success or -1 on failure.
 636  */
 637 int llapi_layout_merge(struct llapi_layout **dst_layout,
 638                        const struct llapi_layout *src_layout);
 639
 640 /** Not a valid stripe size, offset, or RAID pattern. */
 641 #define LLAPI_LAYOUT_INVALID    0x1000000000000001ULL
 642
 643 /**
 644  * When specified or returned as the value for stripe count,
 645  * stripe size, offset, or RAID pattern, the filesystem-wide
 646  * default behavior will apply.
 647  */
 648 #define LLAPI_LAYOUT_DEFAULT    (LLAPI_LAYOUT_INVALID + 1)
 649
 650 /**
 651  * When specified or returned as the value for stripe count, all
 652  * available OSTs will be used.
 653  */
 654 #define LLAPI_LAYOUT_WIDE       (LLAPI_LAYOUT_INVALID + 2)
 655
 656 /**
 657  * When specified as the value for layout pattern, file objects will be
 658  * stored using RAID0.  That is, data will be split evenly and without
 659  * redundancy across all OSTs in the layout.
 660  */
 661 #define LLAPI_LAYOUT_RAID0              0ULL
 662 #define LLAPI_LAYOUT_MDT                2ULL
 663 #define LLAPI_LAYOUT_OVERSTRIPING       4ULL
 664
 665 /**
 666 * The layout includes a specific set of OSTs on which to allocate.
 667 */
 668 #define LLAPI_LAYOUT_SPECIFIC   0x2000000000000000ULL
 669
 670 /**
 671  * A valid ost index should be less than maximum valid OST index (UINT_MAX).
 672  */
 673 #define LLAPI_LAYOUT_IDX_MAX    0x00000000FFFFFFFFULL
 674
 675 /**
 676  * Flags to modify how layouts are retrieved.
 677  */
 678 /******************** Stripe Count ********************/
 679
 680 /**
 681  * Store the stripe count of \a layout in \a count.
 682  *
 683  * \retval  0 Success
 684  * \retval -1 Error with status code in errno.
 685  */
 686 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
 687                                   uint64_t *count);
 688
 689 /**
 690  * Set the stripe count of \a layout to \a count.
 691  *
 692  * \retval  0 Success.
 693  * \retval -1 Invalid argument, errno set to EINVAL.
 694  */
 695 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
 696
 697 /******************** Stripe Size ********************/
 698
 699 /**
 700  * Store the stripe size of \a layout in \a size.
 701  *
 702  * \retval  0 Success.
 703  * \retval -1 Invalid argument, errno set to EINVAL.
 704  */
 705 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
 706                                  uint64_t *size);
 707
 708 /**
 709  * Set the stripe size of \a layout to \a stripe_size.
 710  *
 711  * \retval  0 Success.
 712  * \retval -1 Invalid argument, errno set to EINVAL.
 713  */
 714 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
 715
 716 /******************** Stripe Pattern ********************/
 717
 718 /**
 719  * Store the stripe pattern of \a layout in \a pattern.
 720  *
 721  * \retval 0  Success.
 722  * \retval -1 Error with status code in errno.
 723  */
 724 int llapi_layout_pattern_get(const struct llapi_layout *layout,
 725                              uint64_t *pattern);
 726
 727 /**
 728  * Set the stripe pattern of \a layout to \a pattern.
 729  *
 730  * \retval  0 Success.
 731  * \retval -1 Invalid argument, errno set to EINVAL.
 732  */
 733 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
 734
 735 /******************** OST Index ********************/
 736
 737 /**
 738  * Store the index of the OST where stripe number \a stripe_number is stored
 739  * in \a index.
 740  *
 741  * An error return value will result from a NULL layout, if \a
 742  * stripe_number is out of range, or if \a layout was not initialized
 743  * with llapi_layout_lookup_by{path,fd,fid}().
 744  *
 745  * \retval  0 Success
 746  * \retval -1 Invalid argument, errno set to EINVAL.
 747  */
 748 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
 749                                uint64_t stripe_number, uint64_t *index);
 750
 751 /**
 752  * Set the OST index associated with stripe number \a stripe_number to
 753  * \a ost_index.
 754  * NB: This is currently supported only for \a stripe_number = 0 and
 755  * other usage will return ENOTSUPP in errno.  A NULL \a layout or
 756  * out-of-range \a stripe_number will return EINVAL in errno.
 757  *
 758  * \retval  0 Success.
 759  * \retval -1 Error with errno set to non-zero value.
 760  */
 761 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
 762                                uint64_t index);
 763
 764 /******************** Pool Name ********************/
 765
 766 /**
 767  * Store up to \a pool_name_len characters of the name of the pool of
 768  * OSTs associated with \a layout into the buffer pointed to by
 769  * \a pool_name.
 770  *
 771  * The correct calling form is:
 772  *
 773  *   llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
 774  *
 775  * A pool defines a set of OSTs from which file objects may be
 776  * allocated for a file using \a layout.
 777  *
 778  * On success, the number of bytes stored is returned, excluding the
 779  * terminating '\0' character (zero indicates that \a layout does not
 780  * have an associated OST pool).  On error, -1 is returned and errno is
 781  * set appropriately. Possible sources of error include a NULL pointer
 782  * argument or insufficient space in \a dest to store the pool name,
 783  * in which cases errno will be set to EINVAL.
 784  *
 785  * \retval 0+           The number of bytes stored in \a dest.
 786  * \retval -1           Invalid argument, errno set to EINVAL.
 787  */
 788 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
 789                               char *pool_name, size_t pool_name_len);
 790
 791 /**
 792  * Set the name of the pool of OSTs from which file objects will be
 793  * allocated to \a pool_name.
 794  *
 795  * If the pool name uses "fsname.pool" notation to qualify the pool name
 796  * with a filesystem name, the "fsname." portion will be silently
 797  * discarded before storing the value. No validation that \a pool_name
 798  * is an existing non-empty pool in filesystem \a fsname will be
 799  * performed.  Such validation can be performed by the application if
 800  * desired using the llapi_search_ost() function.  The maximum length of
 801  * the stored value is defined by the constant LOV_MAXPOOLNAME.
 802  *
 803  * \retval  0   Success.
 804  * \retval -1   Invalid argument, errno set to EINVAL.
 805  */
 806 int llapi_layout_pool_name_set(struct llapi_layout *layout,
 807                               const char *pool_name);
 808
 809 /******************** File Creation ********************/
 810
 811 /**
 812  * Open an existing file at \a path, or create it with the specified
 813  * \a layout and \a mode.
 814  *
 815  * One access mode and zero or more file creation flags and file status
 816  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 817  * open file descriptor for the file.  If \a layout is non-NULL and
 818  * \a path is not on a Lustre filesystem this function will fail and set
 819  * errno to ENOTTY.
 820  *
 821  * An already existing file may be opened with this function, but
 822  * \a layout and \a mode will not be applied to it.  Callers requiring a
 823  * guarantee that the opened file is created with the specified
 824  * \a layout and \a mode should use llapi_layout_file_create().
 825  *
 826  * A NULL \a layout may be specified, in which case the standard Lustre
 827  * behavior for assigning layouts to newly-created files will apply.
 828  *
 829  * \retval 0+ An open file descriptor.
 830  * \retval -1 Error with status code in errno.
 831  */
 832 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
 833                            const struct llapi_layout *layout);
 834
 835 /**
 836  * Create a new file at \a path with the specified \a layout and \a mode.
 837  *
 838  * One access mode and zero or more file creation flags and file status
 839  * flags May be bitwise-or'd in \a open_flags (see open(2)).  Return an
 840  * open file descriptor for the file.  If \a layout is non-NULL and
 841  * \a path is not on a Lustre filesystem this function will fail and set
 842  * errno to ENOTTY.
 843  *
 844  * The function call
 845  *
 846  *   llapi_layout_file_create(path, open_flags, mode, layout)
 847  *
 848  * shall be equivalent to:
 849  *
 850  *   llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
 851  *
 852  * It is an error if \a path specifies an existing file.
 853  *
 854  * A NULL \a layout may be specified, in which the standard Lustre
 855  * behavior for assigning layouts to newly-created files will apply.
 856  *
 857  * \retval 0+ An open file descriptor.
 858  * \retval -1 Error with status code in errno.
 859  */
 860 int llapi_layout_file_create(const char *path, int open_flags, int mode,
 861                              const struct llapi_layout *layout);
 862
 863 /**
 864  * Set flags to the header of component layout.
 865  */
 866 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
 867 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
 868 const char *llapi_layout_flags_string(uint32_t flags);
 869 const __u16 llapi_layout_string_flags(char *string);
 870
 871 /**
 872  * llapi_layout_mirror_count_get() - Get mirror count from the header of
 873  *                                   a layout.
 874  * @layout: Layout to get mirror count from.
 875  * @count:  Returned mirror count value.
 876  *
 877  * This function gets mirror count from the header of a layout.
 878  *
 879  * Return: 0 on success or -1 on failure.
 880  */
 881 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
 882                                   uint16_t *count);
 883
 884 /**
 885  * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
 886  * @layout: Layout to set mirror count in.
 887  * @count:  Mirror count value to be set.
 888  *
 889  * This function sets mirror count to the header of a layout.
 890  *
 891  * Return: 0 on success or -1 on failure.
 892  */
 893 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
 894                                   uint16_t count);
 895
 896 /**
 897  * Fetch the start and end offset of the current layout component.
 898  */
 899 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
 900                                  uint64_t *start, uint64_t *end);
 901 /**
 902  * Set the extent of current layout component.
 903  */
 904 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
 905                                  uint64_t start, uint64_t end);
 906
 907 /* PFL component flags table */
 908 static const struct comp_flag_name {
 909         enum lov_comp_md_entry_flags cfn_flag;
 910         const char *cfn_name;
 911 } comp_flags_table[] = {
 912         { LCME_FL_INIT,         "init" },
 913         { LCME_FL_STALE,        "stale" },
 914         { LCME_FL_PREF_RW,      "prefer" },
 915         { LCME_FL_OFFLINE,      "offline" },
 916         { LCME_FL_NOSYNC,       "nosync" },
 917 };
 918
 919 /**
 920  * Gets the attribute flags of the current component.
 921  */
 922 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
 923                                 uint32_t *flags);
 924 /**
 925  * Sets the specified flags of the current component leaving other flags as-is.
 926  */
 927 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
 928 /**
 929  * Clears the flags specified in the flags leaving other flags as-is.
 930  */
 931 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
 932 /**
 933  * Fetches the file-unique component ID of the current layout component.
 934  */
 935 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
 936 /**
 937  * Fetches the mirror ID of the current layout component.
 938  */
 939 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
 940 /**
 941  * Adds one component to the existing composite or plain layout.
 942  */
 943 int llapi_layout_comp_add(struct llapi_layout *layout);
 944 /**
 945  * Adds a first component of a mirror to the existing composite layout.
 946  */
 947 int llapi_layout_add_first_comp(struct llapi_layout *layout);
 948 /**
 949  * Deletes the current layout component from the composite layout.
 950  */
 951 int llapi_layout_comp_del(struct llapi_layout *layout);
 952
 953 enum llapi_layout_comp_use {
 954         LLAPI_LAYOUT_COMP_USE_FIRST = 1,
 955         LLAPI_LAYOUT_COMP_USE_LAST = 2,
 956         LLAPI_LAYOUT_COMP_USE_NEXT = 3,
 957         LLAPI_LAYOUT_COMP_USE_PREV = 4,
 958 };
 959
 960 /**
 961  * Set the currently active component to the specified component ID.
 962  */
 963 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
 964 /**
 965  * Select the currently active component at the specified position.
 966  */
 967 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
 968 /**
 969  * Add layout components to an existing file.
 970  */
 971 int llapi_layout_file_comp_add(const char *path,
 972                                const struct llapi_layout *layout);
 973 /**
 974  * Delete component(s) by the specified component id or flags.
 975  */
 976 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
 977 /**
 978  * Change flags or other parameters of the component(s) by component ID of an
 979  * existing file. The component to be modified is specified by the
 980  * comp->lcme_id value, which must be an unique component ID. The new
 981  * attributes are passed in by @comp and @valid is used to specify which
 982  * attributes in the component are going to be changed.
 983  */
 984 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
 985                                size_t count);
 986 /**
 987  * Check if the file layout is composite.
 988  */
 989 bool llapi_layout_is_composite(struct llapi_layout *layout);
 990
 991 enum {
 992         LLAPI_LAYOUT_ITER_CONT = 0,
 993         LLAPI_LAYOUT_ITER_STOP = 1,
 994 };
 995
 996 /**
 997  * Iteration callback function.
 998  *
 999  * \retval LLAPI_LAYOUT_ITER_CONT       Iteration proceeds
1000  * \retval LLAPI_LAYOUT_ITER_STOP       Stop iteration
1001  * \retval < 0                          error code
1002  */
1003 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1004
1005 /**
1006  * Iterate all components in the corresponding layout
1007  */
1008 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1009                               llapi_layout_iter_cb cb, void *cbdata);
1010
1011 /**
1012  * FLR: mirror operation APIs
1013  */
1014 int llapi_mirror_set(int fd, unsigned int id);
1015 int llapi_mirror_clear(int fd);
1016 ssize_t llapi_mirror_read(int fd, unsigned int id,
1017                            void *buf, size_t count, off_t pos);
1018 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1019 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1020                        off_t pos, size_t count);
1021
1022 int llapi_heat_get(int fd, struct lu_heat *heat);
1023 int llapi_heat_set(int fd, __u64 flags);
1024
1025 /** @} llapi */
1026
1027 #if defined(__cplusplus)
1028 }
1029 #endif
1030
1031 #endif