Whamcloud - gitweb
LU-13397 lfs: mirror extend/copy keeps sparseness
[fs/lustre-release.git] / lustre / include / lustre / lustreapi.h
index 59f7129..905fba6 100644 (file)
  * @{
  */
 
+#include <glob.h>
 #include <stdarg.h>
 #include <stdint.h>
+#include <time.h>
+#include <unistd.h>
+#include <sys/types.h>
 #include <linux/lustre/lustre_user.h>
 
 #if defined(__cplusplus)
@@ -50,10 +54,16 @@ extern "C" {
 #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
+
+typedef struct statx lstatx_t;
+
 #define lustre_fid struct lu_fid
 
 /* Currently external applications can access this but in the
@@ -126,8 +136,12 @@ struct llapi_stripe_param {
 
 #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,
@@ -149,32 +163,48 @@ int llapi_file_lookup(int dirfd, const char *name);
 void llapi_set_command_name(const char *cmd);
 void llapi_clear_command_name(void);
 
-#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_MIRROR_ID      0x20000
-#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| \
-                                VERBOSE_MIRROR_ID)
+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
+
+enum {
+       NEWERXY_ATIME = 0,      /* neweraY */
+       NEWERXY_MTIME = 1,      /* newermY */
+       NEWERXY_CTIME = 2,      /* newercY */
+       NEWERXY_BTIME = 3,      /* newerbY | newerBY */
+       NEWERXY_MAX,
+};
 
 struct find_param {
        unsigned int             fp_max_depth;
@@ -185,7 +215,7 @@ struct find_param {
        time_t                   fp_atime;
        time_t                   fp_mtime;
        time_t                   fp_ctime;
-       /* {a,m,c}sign cannot be bitfields due to using pointers to
+       /* {a,m,c,b}sign cannot be bitfields due to using pointers to
         * access them during argument parsing. */
        int                      fp_asign;
        int                      fp_msign;
@@ -201,7 +231,12 @@ struct find_param {
                                 fp_mirror_index_sign:2,
                                 fp_mirror_id_sign:2,
                                 fp_mdt_count_sign:2,
-                                fp_blocks_sign:2;
+                                fp_blocks_sign:2,
+                                fp_ext_size_sign:2,
+                                fp_unused1_sign:2, /* Fields available to use*/
+                                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.  */
        unsigned long long       fp_size;
        unsigned long long       fp_size_units;
 
@@ -256,9 +291,22 @@ struct find_param {
                                 fp_exclude_hash_type:1,
                                 fp_yaml:1,     /* output layout in YAML */
                                 fp_check_blocks:1,
-                                fp_exclude_blocks:1;
-
-       int                      fp_verbose;
+                                fp_exclude_blocks:1,
+                                fp_check_foreign:1,
+                                fp_exclude_foreign:1,
+                                fp_check_ext_size:1, /* extension size */
+                                fp_exclude_ext_size: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.  */
+
+       enum llapi_layout_verbose fp_verbose;
        int                      fp_quiet;
 
        /* regular expression */
@@ -308,11 +356,23 @@ struct find_param {
        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 */
+       __u32                    fp_foreign_type;
+       unsigned long long       fp_ext_size;
+       unsigned long long       fp_ext_size_units;
+
+       /*
+        * fp_newery[NEWERXY_MAX][0]: --newerXY reference
+        * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
+        */
+       time_t                   fp_newery[NEWERXY_MAX][2];
+
+       time_t                   fp_btime;
+       int                      fp_bsign;
 };
 
 int llapi_ostlist(char *path, struct find_param *param);
@@ -328,10 +388,13 @@ int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
                                     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);
+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);
@@ -345,15 +408,23 @@ 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_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_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
+                             char *instance, size_t instance_len);
+int llapi_get_instance(const char *path, char *instance, size_t instance_len);
+int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
+int llapi_getname(const char *path, char *name, size_t namelen);
 int llapi_search_fileset(const char *pathname, char *fileset);
 
 int llapi_search_rootpath(char *pathname, const char *fsname);
@@ -371,17 +442,31 @@ int llapi_target_iterate(int type_num, char **obd_type, void *args,
 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_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);
 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
                               int *mdt_index);
+int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
+                      struct lov_user_md *lum, size_t lumsize);
+int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
+                     struct lov_user_md *lum, size_t lumsize);
+int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
+                         lstatx_t *statx, struct lov_user_md *lum,
+                         size_t lumsize);
+int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
+                        struct lov_user_md *lum, size_t lumsize);
+
 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);
@@ -404,11 +489,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);
 }
 
 
@@ -430,6 +519,7 @@ 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. */
@@ -476,6 +566,30 @@ 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 */
+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,
@@ -494,9 +608,29 @@ int llapi_lease_put(int fd); /* obsoleted */
 int llapi_group_lock(int fd, int gid);
 int llapi_group_unlock(int fd, int gid);
 
+bool llapi_file_is_sparse(int fd);
+off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
+
 /* 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 */
 
 /* llapi_layout user interface */
@@ -516,11 +650,21 @@ 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_layout_get_last_init_comp(struct llapi_layout *layout);
+int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
+                               struct llapi_layout *m_layout);
 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.
  */
@@ -547,8 +691,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
@@ -559,6 +703,32 @@ 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().
@@ -604,8 +774,9 @@ int llapi_layout_merge(struct llapi_layout **dst_layout,
  * 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_RAID0             0ULL
+#define LLAPI_LAYOUT_MDT               2ULL
+#define LLAPI_LAYOUT_OVERSTRIPING      4ULL
 
 /**
 * The layout includes a specific set of OSTs on which to allocate.
@@ -658,6 +829,27 @@ int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
  */
 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 ********************/
 
 /**
@@ -858,6 +1050,8 @@ static const struct comp_flag_name {
        { LCME_FL_STALE,        "stale" },
        { LCME_FL_PREF_RW,      "prefer" },
        { LCME_FL_OFFLINE,      "offline" },
+       { LCME_FL_NOSYNC,       "nosync" },
+       { LCME_FL_EXTENSION,    "extension" },
 };
 
 /**
@@ -959,10 +1153,21 @@ 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);
+                     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_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);
+
+int llapi_param_get_paths(const char *pattern, glob_t *paths);
+int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
+void llapi_param_paths_free(glob_t *paths);
 
 /** @} llapi */