LU-11974 llapi: improve llapi_layout_get_by_xattr(3) API

[fs/lustre-release.git] / lustre / include / lustre / lustreapi.h

diff --git a/lustre/include/lustre/lustreapi.h b/lustre/include/lustre/lustreapi.h
index b593f7f..d2a3608 100644 (file)
--- a/lustre/include/lustre/lustreapi.h
+++ b/lustre/include/lustre/lustreapi.h
@@ -149,32 +149,39 @@ 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_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;
@@ -258,7 +265,7 @@ struct find_param {
                                 fp_check_blocks:1,
                                 fp_exclude_blocks:1;
 
-       int                      fp_verbose;
+       enum llapi_layout_verbose fp_verbose;
        int                      fp_quiet;
 
        /* regular expression */
@@ -558,8 +565,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
@@ -570,6 +577,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().
@@ -869,6 +902,7 @@ static const struct comp_flag_name {
        { LCME_FL_STALE,        "stale" },
        { LCME_FL_PREF_RW,      "prefer" },
        { LCME_FL_OFFLINE,      "offline" },
+       { LCME_FL_NOSYNC,       "nosync" },
 };
 
 /**