X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;ds=sidebyside;f=lustre%2Finclude%2Flustre%2Flustreapi.h;h=9844822692d70df7dc4c1f6f1498325c55393870;hb=5b6569affc9a0e33fa5d7d2061834397da13e0cb;hp=ab87e1533a64e4750ef167908c0917606f1a2aef;hpb=521a697f68de50125e21c90fa5d05ea59e4f0827;p=fs%2Flustre-release.git diff --git a/lustre/include/lustre/lustreapi.h b/lustre/include/lustre/lustreapi.h index ab87e15..9844822 100644 --- a/lustre/include/lustre/lustreapi.h +++ b/lustre/include/lustre/lustreapi.h @@ -23,7 +23,7 @@ * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved. * Use is subject to license terms. * - * Copyright (c) 2011, 2016, Intel Corporation. + * Copyright (c) 2011, 2017, Intel Corporation. */ /* * This file is part of Lustre, http://www.lustre.org/ @@ -42,6 +42,10 @@ #include #include +#if defined(__cplusplus) +extern "C" { +#endif + #ifndef LL_MAXQUOTAS #define LL_MAXQUOTAS 3 #endif @@ -50,8 +54,13 @@ #define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0]))) #endif -extern bool liblustreapi_initialized; +#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); @@ -71,6 +80,10 @@ enum llapi_message_level { 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 @@ -111,6 +124,8 @@ struct llapi_stripe_param { __u32 lsp_osts[0]; }; +#define lsp_tgts lsp_osts + int llapi_file_open_param(const char *name, int flags, mode_t mode, const struct llapi_stripe_param *param); int llapi_file_create(const char *name, unsigned long long stripe_size, @@ -131,31 +146,42 @@ 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); - -#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_COMP_COUNT 0x200 -#define VERBOSE_COMP_FLAGS 0x400 -#define VERBOSE_COMP_START 0x800 -#define VERBOSE_COMP_END 0x1000 -#define VERBOSE_COMP_ID 0x2000 -#define VERBOSE_DFID 0x4000 -#define VERBOSE_HASH_TYPE 0x8000 -#define VERBOSE_MIRROR_COUNT 0x10000 -#define VERBOSE_DEFAULT (VERBOSE_COUNT | VERBOSE_SIZE | \ - VERBOSE_OFFSET | VERBOSE_POOL | \ - VERBOSE_OBJID | VERBOSE_GENERATION | \ - VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \ - VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \ - VERBOSE_COMP_START | VERBOSE_COMP_END | \ - VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT) +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_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 +}; +/* 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; @@ -178,7 +204,11 @@ struct find_param { fp_comp_start_sign:2, fp_comp_end_sign:2, fp_comp_count_sign:2, - fp_mdt_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; unsigned long long fp_size; unsigned long long fp_size_units; @@ -213,21 +243,30 @@ struct find_param { 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_exclude_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_yaml:1, /* output layout in YAML */ + fp_check_blocks:1, + fp_exclude_blocks:1, + fp_lazy:1; - int fp_verbose; + enum llapi_layout_verbose fp_verbose; int fp_quiet; /* regular expression */ @@ -260,20 +299,29 @@ struct find_param { __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; /* In-process parameters. */ 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 */ }; int llapi_ostlist(char *path, struct find_param *param); @@ -282,9 +330,13 @@ 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_pool(const char *name, int flags, int stripe_offset, int stripe_count, int stripe_pattern, const char *poolname); @@ -302,6 +354,7 @@ 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(char *fsname, char *poolname, char *tgtname, bool is_mdt); int llapi_search_ost(char *fsname, char *poolname, 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, @@ -318,6 +371,7 @@ 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 int llapi_is_lustre_mnt(struct mntent *mnt); int llapi_quotactl(char *mnt, struct if_quotactl *qctl); @@ -328,22 +382,24 @@ 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, lustre_fid *fid); -int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid, int *mdt_index); -int llapi_fd2fid(int fd, lustre_fid *fid); +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, - lustre_fid *parent_fid, char *name, size_t name_size); -int llapi_fd2parent(int fd, unsigned int linkno, lustre_fid *parent_fid, + 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_chomp_string(char *buf); -int llapi_open_by_fid(const char *dir, const lustre_fid *fid, int open_flags); - +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); @@ -357,11 +413,15 @@ 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(char *directory, int idx, int mode); +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 mode) +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); } @@ -388,6 +448,8 @@ int llapi_changelog_get_fd(void *priv); /* Allow records up to endrec to be destroyed; requires registered id. */ 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 @@ -413,12 +475,12 @@ 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, - lustre_fid *fid); + 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, - lustre_fid *newfid); + struct lu_fid *newfid); /* HSM user interface */ struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount, @@ -434,10 +496,12 @@ int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key, int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp); /* File lease */ -int llapi_lease_get(int fd, int mode); +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_put(int fd); -extern int llapi_lease_get_ext(int fd, struct ll_ioc_lease *data); +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); @@ -450,22 +514,6 @@ int llapi_ladvise(int fd, unsigned long long flags, int num_advise, /* llapi_layout user interface */ -static inline const char *lcm_flags_string(__u16 flags) -{ - switch (flags & LCM_FL_FLR_MASK) { - case LCM_FL_NOT_FLR: - return "not_flr"; - case LCM_FL_RDONLY: - return "ro"; - case LCM_FL_WRITE_PENDING: - return "wp"; - case LCM_FL_SYNC_PENDING: - return "sp"; - default: - return ""; - } -} - /** * An array element storing component info to be resynced during mirror * resynchronization. @@ -481,11 +529,18 @@ struct llapi_resync_comp { /** 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); -ssize_t llapi_mirror_resync_one(int fd, struct llapi_layout *layout, - uint32_t dst, uint64_t start, uint64_t end); +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. */ @@ -512,8 +567,8 @@ 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 string - * \a fidstr. The string \a path must name a path within 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 @@ -521,9 +576,35 @@ struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags); * stored in errno. */ struct llapi_layout *llapi_layout_get_by_fid(const char *path, - const lustre_fid *fid, + 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(). @@ -775,6 +856,8 @@ int llapi_layout_file_create(const char *path, int open_flags, int mode, */ 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 @@ -818,10 +901,10 @@ static const struct comp_flag_name { const char *cfn_name; } comp_flags_table[] = { { LCME_FL_INIT, "init" }, - { LCME_FL_PRIMARY, "primary" }, { LCME_FL_STALE, "stale" }, + { LCME_FL_PREF_RW, "prefer" }, { LCME_FL_OFFLINE, "offline" }, - { LCME_FL_PREFERRED, "preferred" } + { LCME_FL_NOSYNC, "nosync" }, }; /** @@ -850,6 +933,10 @@ int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id); */ 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); @@ -885,14 +972,33 @@ int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags); * 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, - const struct llapi_layout *comp, - uint32_t valid); +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 */ @@ -900,11 +1006,17 @@ 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, unsigned int src, - unsigned int *dst, size_t count); +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); + /** @} llapi */ +#if defined(__cplusplus) +} +#endif + #endif