*
* You should have received a copy of the GNU General Public License
* version 2 along with this program; If not, see
- * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
- *
- * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
- * CA 95054 USA or visit www.sun.com if you need additional information or
- * have any questions.
+ * http://www.gnu.org/licenses/gpl-2.0.html
*
* GPL HEADER END
*/
* Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
* Use is subject to license terms.
*
- * Copyright (c) 2011, 2013, Intel Corporation.
+ * Copyright (c) 2011, 2017, Intel Corporation.
*/
/*
* This file is part of Lustre, http://www.lustre.org/
*/
#include <stdarg.h>
-#include <lustre/lustre_user.h>
+#include <stdint.h>
+#include <linux/lustre/lustre_user.h>
+
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
+#ifndef LL_MAXQUOTAS
+#define LL_MAXQUOTAS 3
+#endif
+
+#ifndef ARRAY_SIZE
+#define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0])))
+#endif
+
+#define lustre_fid struct lu_fid
+
+/* Currently external applications can access this but in the
+ * future this will no longer be exposed for the user. Instead
+ * if you want to know if the library is initialized just call
+ * llapi_liblustreapi_initialized() which is now available. */
+extern bool liblustreapi_initialized;
typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
void *args);
typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
const char *fmt, va_list ap);
+static inline bool llapi_liblustreapi_initialized(void)
+{
+ return liblustreapi_initialized;
+}
/* the bottom three bits reserved for llapi_message_level */
#define LLAPI_MSG_MASK 0x00000007
return levels[level];
}
-extern void llapi_msg_set_level(int level);
-extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
-extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
+
+void llapi_msg_set_level(int level);
+int llapi_msg_get_level(void);
+llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
+llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
__attribute__((__format__(__printf__, 3, 4)));
void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
__attribute__((__format__(__printf__, 2, 3)));
-extern int llapi_file_create(const char *name, unsigned long long stripe_size,
- int stripe_offset, int stripe_count,
- int stripe_pattern);
-extern int llapi_file_open(const char *name, int flags, int mode,
- unsigned long long stripe_size, int stripe_offset,
- int stripe_count, int stripe_pattern);
-extern int llapi_file_create_pool(const char *name,
- unsigned long long stripe_size,
- int stripe_offset, int stripe_count,
- int stripe_pattern, char *pool_name);
-extern int llapi_file_open_pool(const char *name, int flags, int mode,
- unsigned long long stripe_size,
- int stripe_offset, int stripe_count,
- int stripe_pattern, char *pool_name);
-extern int llapi_poollist(const char *name);
-extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
- char *buffer, int buffer_size);
-extern int llapi_get_poolmembers(const char *poolname, char **members,
- int list_size, char *buffer, int buffer_size);
-extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
-#define HAVE_LLAPI_FILE_LOOKUP
-extern int llapi_file_lookup(int dirfd, const char *name);
-
-#define VERBOSE_COUNT 0x1
-#define VERBOSE_SIZE 0x2
-#define VERBOSE_OFFSET 0x4
-#define VERBOSE_POOL 0x8
-#define VERBOSE_DETAIL 0x10
-#define VERBOSE_OBJID 0x20
-#define VERBOSE_GENERATION 0x40
-#define VERBOSE_MDTINDEX 0x80
-#define VERBOSE_LAYOUT 0x100
-#define VERBOSE_ALL (VERBOSE_COUNT | VERBOSE_SIZE | \
- VERBOSE_OFFSET | VERBOSE_POOL | \
- VERBOSE_OBJID | VERBOSE_GENERATION |\
- VERBOSE_LAYOUT)
+struct llapi_stripe_param {
+ unsigned long long lsp_stripe_size;
+ char *lsp_pool;
+ int lsp_stripe_offset;
+ int lsp_stripe_pattern;
+ /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
+ int lsp_stripe_count;
+ bool lsp_is_specific;
+ __u32 lsp_osts[0];
+};
+
+#define lsp_tgts lsp_osts
+
+__u32 llapi_pattern_to_lov(uint64_t pattern);
+
+int llapi_file_open_param(const char *name, int flags, mode_t mode,
+ const struct llapi_stripe_param *param);
+int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
+ __u32 flags, char *foreign_lov);
+int llapi_file_create(const char *name, unsigned long long stripe_size,
+ int stripe_offset, int stripe_count, int stripe_pattern);
+int llapi_file_open(const char *name, int flags, int mode,
+ unsigned long long stripe_size, int stripe_offset,
+ int stripe_count, int stripe_pattern);
+int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
+ int stripe_offset, int stripe_count,
+ int stripe_pattern, char *pool_name);
+int llapi_file_open_pool(const char *name, int flags, int mode,
+ unsigned long long stripe_size, int stripe_offset,
+ int stripe_count, int stripe_pattern, char *pool_name);
+int llapi_poollist(const char *name);
+int llapi_get_poollist(const char *name, char **poollist, int list_size,
+ char *buffer, int buffer_size);
+int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
+ char *buffer, int buffer_size);
+int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
+int llapi_file_lookup(int dirfd, const char *name);
+void llapi_set_command_name(const char *cmd);
+void llapi_clear_command_name(void);
+
+enum llapi_layout_verbose {
+ VERBOSE_STRIPE_COUNT = 0x1,
+ VERBOSE_STRIPE_SIZE = 0x2,
+ VERBOSE_STRIPE_OFFSET = 0x4,
+ VERBOSE_POOL = 0x8,
+ VERBOSE_DETAIL = 0x10,
+ VERBOSE_OBJID = 0x20,
+ VERBOSE_GENERATION = 0x40,
+ VERBOSE_MDTINDEX = 0x80,
+ VERBOSE_PATTERN = 0x100,
+ VERBOSE_COMP_COUNT = 0x200,
+ VERBOSE_COMP_FLAGS = 0x400,
+ VERBOSE_COMP_START = 0x800,
+ VERBOSE_COMP_END = 0x1000,
+ VERBOSE_COMP_ID = 0x2000,
+ VERBOSE_DFID = 0x4000,
+ VERBOSE_HASH_TYPE = 0x8000,
+ VERBOSE_MIRROR_COUNT = 0x10000,
+ VERBOSE_MIRROR_ID = 0x20000,
+ VERBOSE_EXT_SIZE = 0x40000,
+ VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
+ VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
+ VERBOSE_OBJID | VERBOSE_GENERATION |
+ VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
+ VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
+ VERBOSE_COMP_START | VERBOSE_COMP_END |
+ VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
+ VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE
+};
+/* Compatibility with original names */
+#define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
+#define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
+#define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
+#define VERBOSE_LAYOUT VERBOSE_PATTERN
struct find_param {
unsigned int fp_max_depth;
int fp_msign;
int fp_csign;
/* these need to be signed values */
- int size_sign:2,
- stripesize_sign:2,
- stripecount_sign:2;
- unsigned long long size;
- unsigned long long size_units;
-
- unsigned long zeroend:1,
- recursive:1,
- exclude_pattern:1,
+ int fp_size_sign:2,
+ fp_stripe_size_sign:2,
+ fp_stripe_count_sign:2,
+ fp_comp_start_sign:2,
+ fp_comp_end_sign:2,
+ fp_comp_count_sign:2,
+ fp_mirror_count_sign:2,
+ fp_mirror_index_sign:2,
+ fp_mirror_id_sign:2,
+ fp_mdt_count_sign:2,
+ fp_blocks_sign:2,
+ fp_ext_size_sign:2;
+ unsigned long long fp_size;
+ unsigned long long fp_size_units;
+
+ unsigned long long fp_zero_end:1,
+ fp_recursive:1,
+ fp_exclude_pattern:1,
fp_exclude_type:1,
- exclude_obd:1,
- exclude_mdt:1,
+ fp_exclude_obd:1,
+ fp_exclude_mdt:1,
fp_exclude_gid:1,
fp_exclude_uid:1,
fp_check_gid:1,
fp_check_uid:1,
- check_pool:1, /* LOV pool name */
- check_size:1, /* file size */
- exclude_pool:1,
- exclude_size:1,
+ fp_check_pool:1, /* LOV pool name */
+ fp_check_size:1, /* file size */
+ fp_exclude_pool:1,
+ fp_exclude_size:1,
fp_exclude_atime:1,
fp_exclude_mtime:1,
fp_exclude_ctime:1,
- get_lmv:1, /* get MDT list from LMV */
- raw:1, /* do not fill in defaults */
- check_stripesize:1, /* LOV stripe size */
- exclude_stripesize:1,
- check_stripecount:1, /* LOV stripe count */
- exclude_stripecount:1,
- check_layout:1,
- exclude_layout:1,
- get_default_lmv:1, /* Get default LMV */
- migrate:1;
-
- int verbose;
- int quiet;
+ fp_get_lmv:1, /* get MDT list from LMV */
+ fp_raw:1, /* do not fill in defaults */
+ fp_check_stripe_size:1, /* LOV stripe size */
+ fp_exclude_stripe_size:1,
+ fp_check_stripe_count:1, /* LOV stripe count */
+ fp_exclude_stripe_count:1,
+ fp_check_layout:1,
+ fp_exclude_layout:1,
+ fp_get_default_lmv:1, /* Get default LMV */
+ fp_migrate:1,
+ fp_check_projid:1,
+ fp_exclude_projid:1,
+ fp_check_comp_count:1,
+ fp_exclude_comp_count:1,
+ fp_check_mirror_count:1,
+ fp_exclude_mirror_count:1,
+ fp_check_comp_flags:1,
+ fp_check_mirror_state:1,
+ fp_check_comp_start:1,
+ fp_exclude_comp_start:1,
+ fp_check_comp_end:1,
+ fp_exclude_comp_end:1,
+ fp_check_comp_id:1,
+ fp_exclude_comp_id:1,
+ fp_check_mirror_id:1,
+ fp_exclude_mirror_id:1,
+ fp_check_mirror_index:1,
+ fp_exclude_mirror_index:1,
+ fp_check_mdt_count:1,
+ fp_exclude_mdt_count:1,
+ fp_check_hash_type:1,
+ fp_exclude_hash_type:1,
+ fp_yaml:1, /* output layout in YAML */
+ fp_check_blocks:1,
+ fp_exclude_blocks:1,
+ fp_check_foreign:1,
+ fp_exclude_foreign:1,
+ fp_check_ext_size:1, /* extension size */
+ fp_exclude_ext_size:1;
+
+ enum llapi_layout_verbose fp_verbose;
+ int fp_quiet;
/* regular expression */
- char *pattern;
+ char *fp_pattern;
- struct obd_uuid *obduuid;
- int num_obds;
- int num_alloc_obds;
- int obdindex;
- int *obdindexes;
+ struct obd_uuid *fp_obd_uuid;
+ int fp_num_obds;
+ int fp_num_alloc_obds;
+ int fp_obd_index;
+ int *fp_obd_indexes;
- struct obd_uuid *mdtuuid;
- int num_mdts;
- int num_alloc_mdts;
- int mdtindex;
- int *mdtindexes;
- int file_mdtindex;
+ struct obd_uuid *fp_mdt_uuid;
+ int fp_num_mdts;
+ int fp_num_alloc_mdts;
+ int fp_mdt_index;
+ int *fp_mdt_indexes;
+ int fp_file_mdt_index;
- int lumlen;
- struct lov_user_mds_data *lmd;
+ size_t fp_lum_size;
+ struct lov_user_mds_data *fp_lmd;
- char poolname[LOV_MAXPOOLNAME + 1];
+ char fp_poolname[LOV_MAXPOOLNAME + 1];
- int fp_lmv_count;
+ __u32 fp_lmv_stripe_count;
struct lmv_user_md *fp_lmv_md;
- unsigned long long stripesize;
- unsigned long long stripesize_units;
- unsigned long long stripecount;
- __u32 layout;
+ unsigned long long fp_stripe_size;
+ unsigned long long fp_stripe_size_units;
+ unsigned long long fp_stripe_count;
+ __u32 fp_layout;
+
+ __u32 fp_comp_count;
+ __u32 fp_mirror_count;
+ __u32 fp_comp_flags;
+ __u32 fp_comp_neg_flags;
+ __u16 fp_mirror_state;
+ __u16 fp_mirror_neg_state;
+ __u32 fp_comp_id;
+ __u16 fp_mirror_id;
+ __u16 fp_mirror_index;
+ unsigned long long fp_comp_start;
+ unsigned long long fp_comp_start_units;
+ unsigned long long fp_comp_end;
+ unsigned long long fp_comp_end_units;
+ unsigned long long fp_mdt_count;
+ unsigned fp_projid;
+ unsigned long long fp_blocks;
+ unsigned long long fp_blocks_units;
+ unsigned long long fp_ext_size;
+ unsigned long long fp_ext_size_units;
/* In-process parameters. */
- unsigned long got_uuids:1,
- obds_printed:1,
- have_fileinfo:1; /* file attrs and LOV xattr */
+ unsigned long fp_got_uuids:1,
+ fp_obds_printed:1;
unsigned int fp_depth;
+ unsigned int fp_hash_type;
+ unsigned int fp_time_margin; /* time margin in seconds */
+ __u32 fp_foreign_type;
};
-extern int llapi_ostlist(char *path, struct find_param *param);
-extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
-extern int llapi_getstripe(char *path, struct find_param *param);
-extern int llapi_find(char *path, struct find_param *param);
-
-extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
-extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
- int stripe_count, int stripe_pattern,
- const char *pool_name);
-extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
- int stripe_count, int stripe_pattern,
- const char *poolname);
+int llapi_ostlist(char *path, struct find_param *param);
+int llapi_uuid_match(char *real_uuid, char *search_uuid);
+int llapi_getstripe(char *path, struct find_param *param);
+int llapi_find(char *path, struct find_param *param);
+
+int llapi_file_fget_mdtidx(int fd, int *mdtidx);
+int llapi_dir_set_default_lmv(const char *name,
+ const struct llapi_stripe_param *param);
+int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
+ int stripe_count, int stripe_pattern,
+ const char *pool_name);
+int llapi_dir_create(const char *name, mode_t mode,
+ const struct llapi_stripe_param *param);
+int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
+ __u32 flags, const char *value);
+int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
+ int stripe_count, int stripe_pattern,
+ const char *poolname);
int llapi_direntry_remove(char *dname);
-extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
- struct obd_statfs *stat_buf,
- struct obd_uuid *uuid_buf);
-extern int llapi_ping(char *obd_type, char *obd_name);
-extern int llapi_target_check(int num_types, char **obd_types, char *dir);
-extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
-extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
-extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
-extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
-extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
-extern int llapi_is_lustre_mnttype(const char *type);
-extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
-extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
-extern int llapi_parse_size(const char *optarg, unsigned long long *size,
- unsigned long long *size_units, int bytes_spec);
-extern int llapi_search_mounts(const char *pathname, int index,
- char *mntdir, char *fsname);
-extern int llapi_search_fsname(const char *pathname, char *fsname);
-extern int llapi_getname(const char *path, char *buf, size_t size);
-
-extern int llapi_search_rootpath(char *pathname, const char *fsname);
-extern int llapi_nodemap_exists(const char *name);
-extern int llapi_mv(char *path, struct find_param *param);
+
+int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
+ struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
+int llapi_obd_statfs(char *path, __u32 type, __u32 index,
+ struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
+int llapi_ping(char *obd_type, char *obd_name);
+int llapi_target_check(int num_types, char **obd_types, char *dir);
+int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
+int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
+int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
+int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
+int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
+int llapi_is_lustre_mnttype(const char *type);
+int llapi_search_tgt(const char *fsname, const char *poolname,
+ const char *tgtname, bool is_mdt);
+int llapi_search_mdt(const char *fsname, const char *poolname,
+ const char *mdtname);
+int llapi_search_ost(const char *fsname, const char *poolname,
+ const char *ostname);
+int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
+int llapi_parse_size(const char *optarg, unsigned long long *size,
+ unsigned long long *size_units, int bytes_spec);
+int llapi_search_mounts(const char *pathname, int index, char *mntdir,
+ char *fsname);
+int llapi_search_fsname(const char *pathname, char *fsname);
+int llapi_getname(const char *path, char *buf, size_t size);
+int llapi_search_fileset(const char *pathname, char *fileset);
+
+int llapi_search_rootpath(char *pathname, const char *fsname);
+int llapi_nodemap_exists(const char *name);
+int llapi_migrate_mdt(char *path, struct find_param *param);
+int llapi_mv(char *path, struct find_param *param);
struct mntent;
+
#define HAVE_LLAPI_IS_LUSTRE_MNT
-extern int llapi_is_lustre_mnt(struct mntent *mnt);
-extern int llapi_quotachown(char *path, int flag);
-extern int llapi_quotacheck(char *mnt, int check_type);
-extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
-extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
-extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
- llapi_cb_t cb);
-extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
-extern int llapi_lsetfacl(int argc, char *argv[]);
-extern int llapi_lgetfacl(int argc, char *argv[]);
-extern int llapi_rsetfacl(int argc, char *argv[]);
-extern int llapi_rgetfacl(int argc, char *argv[]);
-extern int llapi_cp(int argc, char *argv[]);
-extern int llapi_ls(int argc, char *argv[]);
-extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
- int pathlen, long long *recno, int *linkno);
-extern int llapi_path2fid(const char *path, lustre_fid *fid);
-extern int llapi_fd2fid(const int fd, lustre_fid *fid);
-extern int llapi_chomp_string(char *buf);
-
-extern int llapi_get_version(char *buffer, int buffer_size, char **version);
-extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
-extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
-extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
-extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
- __u32 archive_id);
-extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
- __u32 archive_id);
-extern int llapi_hsm_register_event_fifo(const char *path);
-extern int llapi_hsm_unregister_event_fifo(const char *path);
-extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
- const char *fmt, va_list args);
-
-extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
-extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
-static inline int llapi_create_volatile(char *directory, int mode)
+int llapi_is_lustre_mnt(struct mntent *mnt);
+int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
+int llapi_target_iterate(int type_num, char **obd_type, void *args,
+ llapi_cb_t cb);
+int llapi_get_connect_flags(const char *mnt, __u64 *flags);
+int llapi_cp(int argc, char *argv[]);
+int llapi_ls(int argc, char *argv[]);
+int llapi_fid2path(const char *device, const char *fidstr, char *path,
+ int pathlen, long long *recno, int *linkno);
+int llapi_path2fid(const char *path, struct lu_fid *fid);
+int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
+ int *mdt_index);
+int llapi_fd2fid(int fd, struct lu_fid *fid);
+/* get FID of parent dir + the related name of entry in this parent dir */
+int llapi_path2parent(const char *path, unsigned int linkno,
+ struct lu_fid *parent_fid, char *name, size_t name_size);
+int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
+ char *name, size_t name_size);
+int llapi_rmfid(const char *path, struct fid_array *fa);
+int llapi_chomp_string(char *buf);
+int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
+ int open_flags);
+int llapi_get_version_string(char *version, unsigned int version_size);
+/* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
+int llapi_get_version(char *buffer, int buffer_size, char **version)
+ __attribute__((deprecated));
+int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
+int llapi_file_flush(int fd);
+extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
+int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
+int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
+int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
+ __u32 archive_id);
+int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
+ __u32 archive_id);
+int llapi_hsm_register_event_fifo(const char *path);
+int llapi_hsm_unregister_event_fifo(const char *path);
+void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
+ const char *fmt, va_list args);
+
+int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
+int llapi_create_volatile_idx(const char *directory, int mdt_idx,
+ int open_flags);
+int llapi_create_volatile_param(const char *directory, int mdt_idx,
+ int open_flags, mode_t mode,
+ const struct llapi_stripe_param *stripe_param);
+
+static inline int llapi_create_volatile(char *directory, int open_flags)
{
- return llapi_create_volatile_idx(directory, -1, mode);
+ return llapi_create_volatile_idx(directory, -1, open_flags);
}
-extern int llapi_fswap_layouts(const int fd1, const int fd2,
- __u64 dv1, __u64 dv2, __u64 flags);
-extern int llapi_swap_layouts(const char *path1, const char *path2,
- __u64 dv1, __u64 dv2, __u64 flags);
+int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
+ int gid, __u64 flags);
+int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
+int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
+ __u64 dv2, __u64 flags);
-/* Changelog interface. priv is private state, managed internally
- by these functions */
-#define CHANGELOG_FLAG_FOLLOW 0x01 /* Not yet implemented */
-#define CHANGELOG_FLAG_BLOCK 0x02 /* Blocking IO makes sense in case of
- slow user parsing of the records, but it also prevents us from cleaning
- up if the records are not consumed. */
+/* Changelog interface. priv is private state, managed internally by these
+ * functions */
-/* Records received are in extentded format now, though most of them are still
+/* Records received are in extended format now, though most of them are still
* written in disk in changelog_rec format (to save space and time), it's
- * converted to extented format in the lustre api to ease changelog analysis. */
+ * converted to extended format in the lustre api to ease changelog analysis. */
#define HAVE_CHANGELOG_EXTEND_REC 1
-extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
- long long startrec);
-extern int llapi_changelog_fini(void **priv);
-extern int llapi_changelog_recv(void *priv, struct changelog_ext_rec **rech);
-extern int llapi_changelog_free(struct changelog_ext_rec **rech);
+int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
+ const char *mdtname, long long startrec);
+int llapi_changelog_fini(void **priv);
+int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
+int llapi_changelog_in_buf(void *priv);
+int llapi_changelog_free(struct changelog_rec **rech);
+int llapi_changelog_get_fd(void *priv);
/* Allow records up to endrec to be destroyed; requires registered id. */
-extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
- long long endrec);
+int llapi_changelog_clear(const char *mdtname, const char *idstr,
+ long long endrec);
+extern int llapi_changelog_set_xflags(void *priv,
+ enum changelog_send_extra_flag extra_flags);
/* HSM copytool interface.
* priv is private state, managed internally by these functions
struct hsm_copytool_private;
struct hsm_copyaction_private;
-extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
- const char *mnt, int archive_count,
- int *archives, int rfd_flags);
-extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
-extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
-extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
- struct hsm_action_list **hal, int *msgsize);
-extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
- const struct hsm_copytool_private *ct,
- const struct hsm_action_item *hai,
- int restore_mdt_index, int restore_open_flags,
- bool is_error);
-extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
- const struct hsm_extent *he,
- int hp_flags, int errval);
-extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
- const struct hsm_extent *he, __u64 total,
- int hp_flags);
-extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
- lustre_fid *fid);
-extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
-extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
- unsigned long long stripe_size, int stripe_offset,
- int stripe_count, int stripe_pattern,
- char *pool_name, lustre_fid *newfid);
+int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
+ const char *mnt, int archive_count,
+ int *archives, int rfd_flags);
+int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
+int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
+int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
+ struct hsm_action_list **hal, int *msgsize);
+int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
+ const struct hsm_copytool_private *ct,
+ const struct hsm_action_item *hai,
+ int restore_mdt_index, int restore_open_flags,
+ bool is_error);
+int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
+ const struct hsm_extent *he, int hp_flags, int errval);
+int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
+ const struct hsm_extent *he, __u64 total,
+ int hp_flags);
+int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
+ struct lu_fid *fid);
+int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
+int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
+ unsigned long long stripe_size, int stripe_offset,
+ int stripe_count, int stripe_pattern, char *pool_name,
+ struct lu_fid *newfid);
/* HSM user interface */
-extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
- int data_len);
-extern int llapi_hsm_request(const char *path,
- const struct hsm_user_request *request);
-extern int llapi_hsm_current_action(const char *path,
- struct hsm_current_action *hca);
+struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
+ int data_len);
+int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
+int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
/* JSON handling */
-extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
-extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
-extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
- char *key, __u32 type, void *val);
-extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
- FILE *fp);
+int llapi_json_init_list(struct llapi_json_item_list **item_list);
+int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
+int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
+ __u32 type, void *val);
+int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
+
+/* File lease */
+int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
+int llapi_lease_release(int fd);
+int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
+int llapi_lease_check(int fd);
+int llapi_lease_get(int fd, int mode); /* obsoleted */
+int llapi_lease_put(int fd); /* obsoleted */
+
+/* Group lock */
+int llapi_group_lock(int fd, int gid);
+int llapi_group_unlock(int fd, int gid);
+
+/* Ladvise */
+int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
+ struct llapi_lu_ladvise *ladvise);
+
+/* PCC */
+int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
+int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
+ __u32 id, enum lu_pcc_type type);
+int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
+ __u32 id, enum lu_pcc_type type);
+int llapi_pcc_detach_fd(int fd, __u32 option);
+int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
+ __u32 option);
+int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
+ __u32 option);
+int llapi_pcc_detach_file(const char *path, __u32 option);
+int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
+int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
+int llapi_pccdev_set(const char *mntpath, const char *cmd);
+int llapi_pccdev_get(const char *mntpath);
/** @} llapi */
-#endif
+/* llapi_layout user interface */
+
+/**
+ * An array element storing component info to be resynced during mirror
+ * resynchronization.
+ */
+struct llapi_resync_comp {
+ uint64_t lrc_start;
+ uint64_t lrc_end;
+ uint32_t lrc_mirror_id;
+ uint32_t lrc_id; /* component id */
+ bool lrc_synced;
+};
+
+/** Opaque data type abstracting the layout of a Lustre file. */
+struct llapi_layout;
+
+int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
+ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
+ size_t count, off_t pos);
+uint32_t llapi_mirror_find(struct llapi_layout *layout,
+ uint64_t file_start, uint64_t file_end,
+ uint64_t *endp);
+int llapi_mirror_find_stale(struct llapi_layout *layout,
+ struct llapi_resync_comp *comp, size_t comp_size,
+ __u16 *mirror_ids, int ids_nr);
+int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
+ struct llapi_resync_comp *comp_array,
+ int comp_size, uint64_t start, uint64_t end);
+/*
+ * Flags to control how layouts are retrieved.
+ */
+
+/* Replace non-specified values with expected inherited values. */
+#define LAYOUT_GET_EXPECTED 0x1
+
+/**
+ * Return a pointer to a newly-allocated opaque data structure containing
+ * the layout for the file at \a path. The pointer should be freed with
+ * llapi_layout_free() when it is no longer needed. Failure is indicated
+ * by a NULL return value and an appropriate error code stored in errno.
+ */
+struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
+
+/**
+ * Return a pointer to a newly-allocated opaque data type containing the
+ * layout for the file referenced by open file descriptor \a fd. The
+ * pointer should be freed with llapi_layout_free() when it is no longer
+ * needed. Failure is indicated by a NULL return value and an
+ * appropriate error code stored in errno.
+ */
+struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
+
+/**
+ * Return a pointer to a newly-allocated opaque data type containing the
+ * layout for the file associated with Lustre file identifier
+ * \a fid. The string \a path must name a path within the
+ * filesystem that contains the file being looked up, such as the
+ * filesystem root. The returned pointer should be freed with
+ * llapi_layout_free() when it is no longer needed. Failure is
+ * indicated with a NULL return value and an appropriate error code
+ * stored in errno.
+ */
+struct llapi_layout *llapi_layout_get_by_fid(const char *path,
+ const struct lu_fid *fid,
+ uint32_t flags);
+enum llapi_layout_xattr_flags {
+ LLAPI_LXF_CHECK = 0x0001,
+ LLAPI_LXF_COPY = 0x0002,
+};
+
+/**
+ * Return a pointer to a newly-allocated opaque data type containing the
+ * layout for the file associated with extended attribute \a lov_xattr. The
+ * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
+ * should be raw xattr without being swapped, since this function will swap it
+ * properly. Thus, \a lov_xattr will be modified during the process. If the
+ * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
+ * the objects count in lum is consistent with the stripe count in lum. This
+ * check only apply to regular file, so \a LLAPI_LXF_CHECK flag should be
+ * cleared if the xattr belongs to a directory. If the \a LLAPI_LXF_COPY flag
+ * of \a flags is set, this function will use a temporary buffer for byte
+ * swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the byte
+ * swapping will be done to the \a lov_xattr buffer directly. The returned
+ * pointer should be freed with llapi_layout_free() when it is no longer
+ * needed. Failure is * indicated with a NULL return value and an appropriate
+ * error code stored in errno.
+ */
+struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
+ ssize_t lov_xattr_size,
+ uint32_t flags);
+
+/**
+ * Allocate a new layout. Use this when creating a new file with
+ * llapi_layout_file_create().
+ */
+struct llapi_layout *llapi_layout_alloc(void);
+
+/**
+ * Free memory allocated for \a layout.
+ */
+void llapi_layout_free(struct llapi_layout *layout);
+
+/**
+ * llapi_layout_merge() - Merge a composite layout into another one.
+ * @dst_layout: Destination composite layout.
+ * @src_layout: Source composite layout.
+ *
+ * This function copies all of the components from @src_layout and
+ * appends them to @dst_layout.
+ *
+ * Return: 0 on success or -1 on failure.
+ */
+int llapi_layout_merge(struct llapi_layout **dst_layout,
+ const struct llapi_layout *src_layout);
+
+/** Not a valid stripe size, offset, or RAID pattern. */
+#define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
+
+/**
+ * When specified or returned as the value for stripe count,
+ * stripe size, offset, or RAID pattern, the filesystem-wide
+ * default behavior will apply.
+ */
+#define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
+
+/**
+ * When specified or returned as the value for stripe count, all
+ * available OSTs will be used.
+ */
+#define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
+
+/**
+ * When specified as the value for layout pattern, file objects will be
+ * stored using RAID0. That is, data will be split evenly and without
+ * redundancy across all OSTs in the layout.
+ */
+#define LLAPI_LAYOUT_RAID0 0ULL
+#define LLAPI_LAYOUT_MDT 2ULL
+#define LLAPI_LAYOUT_OVERSTRIPING 4ULL
+
+/**
+* The layout includes a specific set of OSTs on which to allocate.
+*/
+#define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
+
+/**
+ * A valid ost index should be less than maximum valid OST index (UINT_MAX).
+ */
+#define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
+
+/**
+ * Flags to modify how layouts are retrieved.
+ */
+/******************** Stripe Count ********************/
+/**
+ * Store the stripe count of \a layout in \a count.
+ *
+ * \retval 0 Success
+ * \retval -1 Error with status code in errno.
+ */
+int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
+ uint64_t *count);
+
+/**
+ * Set the stripe count of \a layout to \a count.
+ *
+ * \retval 0 Success.
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
+
+/******************** Stripe Size ********************/
+
+/**
+ * Store the stripe size of \a layout in \a size.
+ *
+ * \retval 0 Success.
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
+ uint64_t *size);
+
+/**
+ * Set the stripe size of \a layout to \a stripe_size.
+ *
+ * \retval 0 Success.
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
+
+/******************** Extension Size ********************/
+
+/**
+ * Store the extension size of \a layout in \a size.
+ *
+ * \retval 0 Success.
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_extension_size_get(const struct llapi_layout *layout,
+ uint64_t *size);
+
+/**
+ * Set the extension size of \a layout to \a stripe_size.
+ *
+ * \retval 0 Success.
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
+
+
+/******************** Stripe Pattern ********************/
+
+/**
+ * Store the stripe pattern of \a layout in \a pattern.
+ *
+ * \retval 0 Success.
+ * \retval -1 Error with status code in errno.
+ */
+int llapi_layout_pattern_get(const struct llapi_layout *layout,
+ uint64_t *pattern);
+
+/**
+ * Set the stripe pattern of \a layout to \a pattern.
+ *
+ * \retval 0 Success.
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
+
+/******************** OST Index ********************/
+
+/**
+ * Store the index of the OST where stripe number \a stripe_number is stored
+ * in \a index.
+ *
+ * An error return value will result from a NULL layout, if \a
+ * stripe_number is out of range, or if \a layout was not initialized
+ * with llapi_layout_lookup_by{path,fd,fid}().
+ *
+ * \retval 0 Success
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_ost_index_get(const struct llapi_layout *layout,
+ uint64_t stripe_number, uint64_t *index);
+
+/**
+ * Set the OST index associated with stripe number \a stripe_number to
+ * \a ost_index.
+ * NB: This is currently supported only for \a stripe_number = 0 and
+ * other usage will return ENOTSUPP in errno. A NULL \a layout or
+ * out-of-range \a stripe_number will return EINVAL in errno.
+ *
+ * \retval 0 Success.
+ * \retval -1 Error with errno set to non-zero value.
+ */
+int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
+ uint64_t index);
+
+/******************** Pool Name ********************/
+
+/**
+ * Store up to \a pool_name_len characters of the name of the pool of
+ * OSTs associated with \a layout into the buffer pointed to by
+ * \a pool_name.
+ *
+ * The correct calling form is:
+ *
+ * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
+ *
+ * A pool defines a set of OSTs from which file objects may be
+ * allocated for a file using \a layout.
+ *
+ * On success, the number of bytes stored is returned, excluding the
+ * terminating '\0' character (zero indicates that \a layout does not
+ * have an associated OST pool). On error, -1 is returned and errno is
+ * set appropriately. Possible sources of error include a NULL pointer
+ * argument or insufficient space in \a dest to store the pool name,
+ * in which cases errno will be set to EINVAL.
+ *
+ * \retval 0+ The number of bytes stored in \a dest.
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_pool_name_get(const struct llapi_layout *layout,
+ char *pool_name, size_t pool_name_len);
+
+/**
+ * Set the name of the pool of OSTs from which file objects will be
+ * allocated to \a pool_name.
+ *
+ * If the pool name uses "fsname.pool" notation to qualify the pool name
+ * with a filesystem name, the "fsname." portion will be silently
+ * discarded before storing the value. No validation that \a pool_name
+ * is an existing non-empty pool in filesystem \a fsname will be
+ * performed. Such validation can be performed by the application if
+ * desired using the llapi_search_ost() function. The maximum length of
+ * the stored value is defined by the constant LOV_MAXPOOLNAME.
+ *
+ * \retval 0 Success.
+ * \retval -1 Invalid argument, errno set to EINVAL.
+ */
+int llapi_layout_pool_name_set(struct llapi_layout *layout,
+ const char *pool_name);
+
+/******************** File Creation ********************/
+
+/**
+ * Open an existing file at \a path, or create it with the specified
+ * \a layout and \a mode.
+ *
+ * One access mode and zero or more file creation flags and file status
+ * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
+ * open file descriptor for the file. If \a layout is non-NULL and
+ * \a path is not on a Lustre filesystem this function will fail and set
+ * errno to ENOTTY.
+ *
+ * An already existing file may be opened with this function, but
+ * \a layout and \a mode will not be applied to it. Callers requiring a
+ * guarantee that the opened file is created with the specified
+ * \a layout and \a mode should use llapi_layout_file_create().
+ *
+ * A NULL \a layout may be specified, in which case the standard Lustre
+ * behavior for assigning layouts to newly-created files will apply.
+ *
+ * \retval 0+ An open file descriptor.
+ * \retval -1 Error with status code in errno.
+ */
+int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
+ const struct llapi_layout *layout);
+
+/**
+ * Create a new file at \a path with the specified \a layout and \a mode.
+ *
+ * One access mode and zero or more file creation flags and file status
+ * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
+ * open file descriptor for the file. If \a layout is non-NULL and
+ * \a path is not on a Lustre filesystem this function will fail and set
+ * errno to ENOTTY.
+ *
+ * The function call
+ *
+ * llapi_layout_file_create(path, open_flags, mode, layout)
+ *
+ * shall be equivalent to:
+ *
+ * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
+ *
+ * It is an error if \a path specifies an existing file.
+ *
+ * A NULL \a layout may be specified, in which the standard Lustre
+ * behavior for assigning layouts to newly-created files will apply.
+ *
+ * \retval 0+ An open file descriptor.
+ * \retval -1 Error with status code in errno.
+ */
+int llapi_layout_file_create(const char *path, int open_flags, int mode,
+ const struct llapi_layout *layout);
+
+/**
+ * Set flags to the header of component layout.
+ */
+int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
+int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
+const char *llapi_layout_flags_string(uint32_t flags);
+const __u16 llapi_layout_string_flags(char *string);
+
+/**
+ * llapi_layout_mirror_count_get() - Get mirror count from the header of
+ * a layout.
+ * @layout: Layout to get mirror count from.
+ * @count: Returned mirror count value.
+ *
+ * This function gets mirror count from the header of a layout.
+ *
+ * Return: 0 on success or -1 on failure.
+ */
+int llapi_layout_mirror_count_get(struct llapi_layout *layout,
+ uint16_t *count);
+
+/**
+ * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
+ * @layout: Layout to set mirror count in.
+ * @count: Mirror count value to be set.
+ *
+ * This function sets mirror count to the header of a layout.
+ *
+ * Return: 0 on success or -1 on failure.
+ */
+int llapi_layout_mirror_count_set(struct llapi_layout *layout,
+ uint16_t count);
+
+/**
+ * Fetch the start and end offset of the current layout component.
+ */
+int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
+ uint64_t *start, uint64_t *end);
+/**
+ * Set the extent of current layout component.
+ */
+int llapi_layout_comp_extent_set(struct llapi_layout *layout,
+ uint64_t start, uint64_t end);
+
+/* PFL component flags table */
+static const struct comp_flag_name {
+ enum lov_comp_md_entry_flags cfn_flag;
+ const char *cfn_name;
+} comp_flags_table[] = {
+ { LCME_FL_INIT, "init" },
+ { LCME_FL_STALE, "stale" },
+ { LCME_FL_PREF_RW, "prefer" },
+ { LCME_FL_OFFLINE, "offline" },
+ { LCME_FL_NOSYNC, "nosync" },
+ { LCME_FL_EXTENSION, "extension" },
+};
+
+/**
+ * Gets the attribute flags of the current component.
+ */
+int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
+ uint32_t *flags);
+/**
+ * Sets the specified flags of the current component leaving other flags as-is.
+ */
+int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
+/**
+ * Clears the flags specified in the flags leaving other flags as-is.
+ */
+int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
+/**
+ * Fetches the file-unique component ID of the current layout component.
+ */
+int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
+/**
+ * Fetches the mirror ID of the current layout component.
+ */
+int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
+/**
+ * Adds one component to the existing composite or plain layout.
+ */
+int llapi_layout_comp_add(struct llapi_layout *layout);
+/**
+ * Adds a first component of a mirror to the existing composite layout.
+ */
+int llapi_layout_add_first_comp(struct llapi_layout *layout);
+/**
+ * Deletes the current layout component from the composite layout.
+ */
+int llapi_layout_comp_del(struct llapi_layout *layout);
+
+enum llapi_layout_comp_use {
+ LLAPI_LAYOUT_COMP_USE_FIRST = 1,
+ LLAPI_LAYOUT_COMP_USE_LAST = 2,
+ LLAPI_LAYOUT_COMP_USE_NEXT = 3,
+ LLAPI_LAYOUT_COMP_USE_PREV = 4,
+};
+
+/**
+ * Set the currently active component to the specified component ID.
+ */
+int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
+/**
+ * Select the currently active component at the specified position.
+ */
+int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
+/**
+ * Add layout components to an existing file.
+ */
+int llapi_layout_file_comp_add(const char *path,
+ const struct llapi_layout *layout);
+/**
+ * Delete component(s) by the specified component id or flags.
+ */
+int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
+/**
+ * Change flags or other parameters of the component(s) by component ID of an
+ * existing file. The component to be modified is specified by the
+ * comp->lcme_id value, which must be an unique component ID. The new
+ * attributes are passed in by @comp and @valid is used to specify which
+ * attributes in the component are going to be changed.
+ */
+int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
+ size_t count);
+/**
+ * Check if the file layout is composite.
+ */
+bool llapi_layout_is_composite(struct llapi_layout *layout);
+
+enum {
+ LLAPI_LAYOUT_ITER_CONT = 0,
+ LLAPI_LAYOUT_ITER_STOP = 1,
+};
+
+/**
+ * Iteration callback function.
+ *
+ * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
+ * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
+ * \retval < 0 error code
+ */
+typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
+
+/**
+ * Iterate all components in the corresponding layout
+ */
+int llapi_layout_comp_iterate(struct llapi_layout *layout,
+ llapi_layout_iter_cb cb, void *cbdata);
+
+/**
+ * FLR: mirror operation APIs
+ */
+int llapi_mirror_set(int fd, unsigned int id);
+int llapi_mirror_clear(int fd);
+ssize_t llapi_mirror_read(int fd, unsigned int id,
+ void *buf, size_t count, off_t pos);
+ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
+int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
+ off_t pos, size_t count);
+
+int llapi_heat_get(int fd, struct lu_heat *heat);
+int llapi_heat_set(int fd, __u64 flags);
+int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
+void llapi_layout_sanity_perror(int error);
+
+/** @} llapi */
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif
git://git.whamcloud.com / fs / lustre-release.git / blobdiff