X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Finclude%2Flustre%2Flustreapi.h;h=392ba5da1bc0ca7e1fdc93f2ed185044f141d604;hb=e73cf72b82c4fe31acee81ffa6934312fd128359;hp=98cbf80f99022017790cc64bff28d260c755d331;hpb=3b18568dc07dac8550c36b33afb45dde2403ea49;p=fs%2Flustre-release.git diff --git a/lustre/include/lustre/lustreapi.h b/lustre/include/lustre/lustreapi.h index 98cbf80..392ba5d 100644 --- a/lustre/include/lustre/lustreapi.h +++ b/lustre/include/lustre/lustreapi.h @@ -42,9 +42,12 @@ * @{ */ +#include +#include #include -typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid, void *args); +typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid, + void *args); /* lustreapi message severity level */ enum llapi_message_level { @@ -58,17 +61,35 @@ enum llapi_message_level { LLAPI_MSG_MAX }; +typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err, + const char *fmt, va_list ap); + + /* the bottom three bits reserved for llapi_message_level */ #define LLAPI_MSG_MASK 0x00000007 #define LLAPI_MSG_NO_ERRNO 0x00000010 +static inline const char *llapi_msg_level2str(enum llapi_message_level level) +{ + static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR", + "WARNING", "NORMAL", + "INFO", "DEBUG"}; + + if (level >= LLAPI_MSG_MAX) + return NULL; + + return levels[level]; +} extern void llapi_msg_set_level(int level); +int llapi_msg_get_level(void); +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_error(int level, int rc, const char *fmt, ...) +void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...) __attribute__((__format__(__printf__, 3, 4))); #define llapi_err_noerrno(level, fmt, a...) \ llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a) -void llapi_printf(int level, const char *fmt, ...) +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, @@ -109,42 +130,43 @@ extern int llapi_file_lookup(int dirfd, const char *name); VERBOSE_LAYOUT) struct find_param { - unsigned int maxdepth; - time_t atime; - time_t mtime; - time_t ctime; - /* cannot be bitfields due to using pointers to */ - int asign; - /* access them during argument parsing. */ - int csign; - int msign; - int type; + unsigned int fp_max_depth; + dev_t fp_dev; + mode_t fp_type; /* S_IFIFO,... */ + uid_t fp_uid; + gid_t fp_gid; + time_t fp_atime; + time_t fp_mtime; + time_t fp_ctime; + /* {a,m,c}sign cannot be bitfields due to using pointers to + * access them during argument parsing. */ + int fp_asign; + 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; - uid_t uid; - gid_t gid; unsigned long zeroend:1, recursive:1, exclude_pattern:1, - exclude_type:1, + fp_exclude_type:1, exclude_obd:1, exclude_mdt:1, - exclude_gid:1, - exclude_uid:1, - check_gid:1, /* group ID */ - check_uid:1, /* user ID */ + 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, - exclude_atime:1, - exclude_mtime:1, - exclude_ctime: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 */ @@ -152,7 +174,9 @@ struct find_param { check_stripecount:1, /* LOV stripe count */ exclude_stripecount:1, check_layout:1, - exclude_layout:1; + exclude_layout:1, + get_default_lmv:1, /* Get default LMV */ + migrate:1; int verbose; int quiet; @@ -160,8 +184,6 @@ struct find_param { /* regular expression */ char *pattern; - char *print_fmt; - struct obd_uuid *obduuid; int num_obds; int num_alloc_obds; @@ -192,12 +214,7 @@ struct find_param { unsigned long got_uuids:1, obds_printed:1, have_fileinfo:1; /* file attrs and LOV xattr */ - unsigned int depth; - dev_t st_dev; - __u64 padding1; - __u64 padding2; - __u64 padding3; - __u64 padding4; + unsigned int fp_depth; }; extern int llapi_ostlist(char *path, struct find_param *param); @@ -206,9 +223,12 @@ 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, - char *poolname); + 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, @@ -230,10 +250,9 @@ extern int llapi_search_mounts(const char *pathname, int index, extern int llapi_search_fsname(const char *pathname, char *fsname); extern int llapi_getname(const char *path, char *buf, size_t size); -extern void llapi_ping_target(char *obd_type, char *obd_name, - char *obd_uuid, void *args); - 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); struct mntent; #define HAVE_LLAPI_IS_LUSTRE_MNT @@ -254,7 +273,12 @@ 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_get_mdt_index_by_fid(int fd, const lustre_fid *fid, + int *mdt_index); extern int llapi_fd2fid(const int fd, lustre_fid *fid); +extern int llapi_chomp_string(char *buf); +extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid, + int open_flags); 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); @@ -264,7 +288,12 @@ 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) { @@ -305,22 +334,23 @@ struct hsm_copytool_private; struct hsm_copyaction_private; extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv, - const char *mnt, int flags, - int archive_count, int *archives); + 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 void llapi_hsm_action_list_free(struct hsm_action_list **hal); 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 flags, - int errval); + 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, int hp_flags); + 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); @@ -336,9 +366,291 @@ 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); + +/* 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); + +/* File lease */ +extern int llapi_lease_get(int fd, int mode); +extern int llapi_lease_check(int fd); +extern int llapi_lease_put(int fd); + +/* Group lock */ +int llapi_group_lock(int fd, int gid); +int llapi_group_unlock(int fd, int gid); + /** @} llapi */ -#endif +/* llapi_layout user interface */ + +/** Opaque data type abstracting the layout of a Lustre file. */ +struct llapi_layout; + +/* + * 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 string + * \a fidstr. 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 lustre_fid *fid, + 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); + +/** 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 0 + +/** + * 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); + +/******************** 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); + +/** @} llapi */ + +#endif