*/
/*
* This file is part of Lustre, http://www.lustre.org/
- * Lustre is a trademark of Sun Microsystems, Inc.
*/
#ifndef _LUSTREAPI_H_
#define LL_MAXQUOTAS 3
#endif
-#ifndef ARRAY_SIZE
-#define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0])))
+#ifndef SEL_UNIT_SIZE
+#define SEL_UNIT_SIZE 1024llu
#endif
+#ifndef LOV_PATTERN_DEFAULT
+#define LOV_PATTERN_DEFAULT 0xffffffff
+#endif
+
+#ifndef fallthrough
+# if defined(__GNUC__) && __GNUC__ >= 7
+# define fallthrough __attribute__((fallthrough)) /* fallthrough */
+# else
+# define fallthrough do {} while (0) /* fallthrough */
+# endif
+#endif
+
+typedef struct statx lstatx_t;
+
#define lustre_fid struct lu_fid
+/*
+ * BUILD_BUG_ON() is Compile-time check which verifies correctness at
+ * compile-time rather than runtime. If "cond" is true, (1 - 2*!!(cond))
+ * will be a negative value, which will cause the compiler to complain.
+ *
+ */
+#ifndef BUILD_BUG_ON
+#define BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2*!!(cond)]))
+#endif
+
/* 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
/* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
int lsp_stripe_count;
bool lsp_is_specific;
+ bool lsp_is_create;
+ __u8 lsp_max_inherit;
+ __u8 lsp_max_inherit_rr;
__u32 lsp_osts[0];
};
#define lsp_tgts lsp_osts
+enum {
+ LLAPI_MIGRATION_NONBLOCK = 0x0001,
+ LLAPI_MIGRATION_MIRROR = 0x0002,
+ LLAPI_MIGRATION_NONDIRECT = 0x0004,
+ LLAPI_MIGRATION_VERBOSE = 0x0008,
+};
+
__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_is_encrypted(int fd);
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,
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_poolbuf(const char *name, char **buf,
+ char ***poolist, int *poolcount);
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,
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_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_INHERIT = 0x80000,
+ VERBOSE_INHERIT_RR = 0x100000,
VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
VERBOSE_OBJID | VERBOSE_GENERATION |
VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
VERBOSE_COMP_START | VERBOSE_COMP_END |
VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
- VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE
+ VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE |
+ VERBOSE_INHERIT | VERBOSE_INHERIT_RR
};
/* Compatibility with original names */
#define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
NEWERXY_MAX,
};
+enum lfs_find_perm {
+ LFS_FIND_PERM_EXACT = -2,
+ LFS_FIND_PERM_ANY = -1,
+ LFS_FIND_PERM_OFF = 0,
+ LFS_FIND_PERM_ALL = 1,
+};
+
struct find_param {
unsigned int fp_max_depth;
dev_t fp_dev;
mode_t fp_type; /* S_IFIFO,... */
uid_t fp_uid;
gid_t fp_gid;
+ mode_t fp_perm;
time_t fp_atime;
time_t fp_mtime;
time_t fp_ctime;
fp_mdt_count_sign:2,
fp_blocks_sign:2,
fp_ext_size_sign:2,
- fp_unused1_sign:2, /* Fields available to use*/
+ fp_perm_sign:2,
fp_unused2_sign:2, /* Once used we must add */
fp_unused3_sign:2, /* a separate flag field */
fp_unused4_sign:2; /* at end of the struct. */
fp_exclude_mirror_index:1,
fp_check_mdt_count:1,
fp_exclude_mdt_count:1,
- fp_check_hash_type:1,
+ fp_check_hash_flag:1,
fp_exclude_hash_type:1,
fp_yaml:1, /* output layout in YAML */
fp_check_blocks:1,
fp_lazy:1,
fp_newerxy:1,
fp_exclude_btime:1,
- fp_unused_bit3:1, /* All of these unused bit */
- fp_unused_bit4:1, /* fields available to use.*/
- fp_unused_bit5:1, /* Once all unused fields */
- fp_unused_bit6:1, /* are used we need to add */
- fp_unused_bit7:1; /* a separate flag field at*/
- /* the end of the struct. */
+ fp_exclude_perm:1,
+ fp_unused_bit4:1, /* Once all unused fields */
+ fp_unused_bit5:1, /* are used we need to add */
+ fp_unused_bit6:1, /* a separate flag field at*/
+ fp_unused_bit7:1; /* the end of the struct. */
enum llapi_layout_verbose fp_verbose;
int fp_quiet;
unsigned long long fp_comp_end;
unsigned long long fp_comp_end_units;
unsigned long long fp_mdt_count;
- unsigned fp_projid;
+ unsigned int fp_projid;
unsigned long long fp_blocks;
unsigned long long fp_blocks_units;
time_t fp_btime;
int fp_bsign;
+ unsigned int fp_hash_inflags;
+ unsigned int fp_hash_exflags;
+ /* Print all information (lfs find only) */
+ char *fp_format_printf_str;
};
int llapi_ostlist(char *path, struct find_param *param);
int stripe_count, int stripe_pattern,
const char *poolname);
int llapi_direntry_remove(char *dname);
+int llapi_unlink_foreign(char *dname);
int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
int llapi_cp(int argc, char *argv[]);
int llapi_ls(int argc, char *argv[]);
int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
+int llapi_fid2path_at(int mnt_fd, const struct lu_fid *fid, char *path,
+ int pathlen, long long *recno, int *linkno);
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);
/* 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 extended 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
int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
/* JSON handling */
+enum llapi_json_types {
+ LLAPI_JSON_INTEGER = 1,
+ LLAPI_JSON_BIGNUM,
+ LLAPI_JSON_REAL,
+ LLAPI_JSON_STRING
+};
+
+struct llapi_json_item {
+ char *lji_key;
+ __u32 lji_type;
+ union {
+ int lji_integer;
+ __u64 lji_u64;
+ double lji_real;
+ char *lji_string;
+ };
+ struct llapi_json_item *lji_next;
+};
+
+struct llapi_json_item_list {
+ int ljil_item_count;
+ struct llapi_json_item *ljil_items;
+};
+
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,
/* Group lock */
int llapi_group_lock(int fd, int gid);
int llapi_group_unlock(int fd, int gid);
+int llapi_group_lock64(int fd, __u64 gid);
+int llapi_group_unlock64(int fd, __u64 gid);
+
+bool llapi_file_is_sparse(int fd);
+off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
+int llapi_hole_punch(int fd, off_t start, size_t length);
/* Ladvise */
int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
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(struct llapi_layout *layout, uint64_t file_start,
+ uint64_t file_end, uint64_t *endp);
int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
struct llapi_layout *m_layout);
* Flags to control how layouts are retrieved.
*/
-/* Replace non-specified values with expected inherited values. */
-#define LAYOUT_GET_EXPECTED 0x1
+enum llapi_layout_get_flags {
+ /** Replace non-specified values with expected inherited values. */
+ LLAPI_LAYOUT_GET_EXPECTED = 0x0001,
+ /** Use a temporary buffer to swab and return xattrs. */
+ LLAPI_LAYOUT_GET_COPY = 0x0002,
+ /** Verify xattr contains sane layout values. */
+ LLAPI_LAYOUT_GET_CHECK = 0x0004,
+};
+/* compatibility macros for old interfaces */
+#define LAYOUT_GET_EXPECTED LLAPI_LAYOUT_GET_EXPECTED
+#define LLAPI_LXF_COPY LLAPI_LAYOUT_GET_COPY
+#define LLAPI_LXF_CHECK LLAPI_LAYOUT_GET_CHECK
/**
* Return a pointer to a newly-allocated opaque data structure containing
* 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);
+struct llapi_layout *llapi_layout_get_by_path(const char *path,
+ enum llapi_layout_get_flags flags);
/**
* Return a pointer to a newly-allocated opaque data type containing the
* 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);
+struct llapi_layout *llapi_layout_get_by_fd(int fd,
+ enum llapi_layout_get_flags flags);
/**
* Return a pointer to a newly-allocated opaque data type containing the
*/
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,
-};
+ enum llapi_layout_get_flags flags);
/**
* Return a pointer to a newly-allocated opaque data type containing the
* 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
+ * check only apply to regular file, so \a LLAPI_LAYOUT_GET_CHECK flag should
+ * be cleared if the xattr belongs to a directory. If the flag \a
+ * LLAPI_LAYOUT_GET_COPY 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);
+ ssize_t lov_xattr_size,
+ enum llapi_layout_get_flags flags);
/**
* Allocate a new layout. Use this when creating a new file with
#define LLAPI_LAYOUT_OVERSTRIPING 4ULL
/**
-* The layout includes a specific set of OSTs on which to allocate.
-*/
+ * The layout includes a specific set of OSTs on which to allocate.
+ */
#define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
/**
*/
int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
+/**
+ * Check if the stripe count \a stripe_count \a is valid.
+ */
+bool llapi_layout_stripe_count_is_valid(int64_t stripe_count);
/******************** Stripe Size ********************/
/**
* \retval -1 Invalid argument, errno set to EINVAL.
*/
int llapi_layout_pool_name_set(struct llapi_layout *layout,
- const char *pool_name);
+ const char *pool_name);
/******************** File Creation ********************/
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);
+__u16 llapi_layout_string_flags(char *string);
/**
* llapi_layout_mirror_count_get() - Get mirror count from the header of
{ LCME_FL_OFFLINE, "offline" },
{ LCME_FL_NOSYNC, "nosync" },
{ LCME_FL_EXTENSION, "extension" },
+ { LCME_FL_PARITY, "parity" },
};
/**
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);
+ off_t pos, size_t count);
+off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size);
+int llapi_mirror_punch(int fd, unsigned int id, off_t start, size_t length);
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);
int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);