Whamcloud - gitweb
LU-6201 llite: remove duplicate fiemap defines
[fs/lustre-release.git] / lustre / include / lustre / lustre_user.h
index e016d59..7f746e1 100644 (file)
@@ -27,7 +27,7 @@
  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  *
- * Copyright (c) 2010, 2013, Intel Corporation.
+ * Copyright (c) 2010, 2014, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
 #include <libcfs/types.h>
 
 #ifdef __KERNEL__
+# include <linux/quota.h>
 # include <linux/string.h> /* snprintf() */
-#else
+# include <linux/version.h>
+#else /* !__KERNEL__ */
+# define NEED_QUOTA_DEFS
 # include <stdio.h> /* snprintf() */
-#endif
+# include <string.h>
+# include <sys/quota.h>
+# include <sys/stat.h>
+#endif /* __KERNEL__ */
 #include <lustre/ll_fiemap.h>
-#include <linux/lustre_user.h>
+
+#if defined(__x86_64__) || defined(__ia64__) || defined(__ppc64__) || \
+    defined(__craynv) || defined(__mips64__) || defined(__powerpc64__)
+typedef struct stat    lstat_t;
+# define lstat_f       lstat
+# define fstat_f       fstat
+# define fstatat_f     fstatat
+# define HAVE_LOV_USER_MDS_DATA
+#elif defined(__USE_LARGEFILE64) || defined(__KERNEL__)
+typedef struct stat64  lstat_t;
+# define lstat_f       lstat64
+# define fstat_f       fstat64
+# define fstatat_f     fstatat64
+# define HAVE_LOV_USER_MDS_DATA
+#endif
 
 #define LUSTRE_EOF 0xffffffffffffffffULL
 
@@ -68,7 +88,6 @@
 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
-#define FSFILT_IOC_FIEMAP                 _IOWR('f', 11, struct ll_user_fiemap)
 #endif
 
 /* FIEMAP flags supported by Lustre */
@@ -218,15 +237,15 @@ struct ost_id {
 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
-#define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
-#define LL_IOC_RECREATE_FID             _IOW ('f', 157, struct lu_fid)
+/*     LL_IOC_RECREATE_OBJ             157 obsolete */
+/*     LL_IOC_RECREATE_FID             157 obsolete */
 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 /*     LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
 /*     LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
 /*     LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
-#define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
+/*     IOC_LOV_GETINFO                 165 obsolete */
 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
@@ -260,6 +279,7 @@ struct ost_id {
 #define LL_IOC_LMV_SET_DEFAULT_STRIPE  _IOWR('f', 246, struct lmv_user_md)
 #define LL_IOC_MIGRATE                 _IOR('f', 247, int)
 #define LL_IOC_FID2MDTIDX              _IOWR('f', 248, struct lu_fid)
+#define LL_IOC_GETPARENT               _IOWR('f', 249, struct getparent)
 
 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
 enum ll_lease_type {
@@ -298,10 +318,12 @@ enum ll_lease_type {
 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 #define LL_FILE_RMTACL          0x00000020
 
-#define LOV_USER_MAGIC_V1 0x0BD10BD0
-#define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
-#define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
-#define LOV_USER_MAGIC_V3 0x0BD30BD0
+#define LOV_USER_MAGIC_V1      0x0BD10BD0
+#define LOV_USER_MAGIC         LOV_USER_MAGIC_V1
+#define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
+#define LOV_USER_MAGIC_V3      0x0BD30BD0
+/* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
+#define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0     /* for specific OSTs */
 
 #define LMV_USER_MAGIC    0x0CD30CD0    /*default lmv magic*/
 
@@ -314,8 +336,8 @@ enum ll_lease_type {
 #define LOV_PATTERN_F_HOLE     0x40000000 /* there is hole in LOV EA */
 #define LOV_PATTERN_F_RELEASED 0x80000000 /* HSM released file */
 
-#define LOV_MAXPOOLNAME 16
-#define LOV_POOLNAMEF "%.16s"
+#define LOV_MAXPOOLNAME 15
+#define LOV_POOLNAMEF "%.15s"
 
 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
@@ -371,17 +393,16 @@ struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
                __u16 lmm_layout_gen;     /* layout generation number
                                           * used when reading */
        };
-       char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
+       char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
        struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 } __attribute__((packed));
 
 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
 {
-       if (lmm_magic == LOV_USER_MAGIC_V3)
-               return sizeof(struct lov_user_md_v3) +
-                               stripes * sizeof(struct lov_user_ost_data_v1);
-       else
+       if (lmm_magic == LOV_USER_MAGIC_V1)
                return sizeof(struct lov_user_md_v1) +
+                             stripes * sizeof(struct lov_user_ost_data_v1);
+       return sizeof(struct lov_user_md_v3) +
                                stripes * sizeof(struct lov_user_ost_data_v1);
 }
 
@@ -429,7 +450,7 @@ struct lmv_user_md_v1 {
        __u32   lum_padding1;
        __u32   lum_padding2;
        __u32   lum_padding3;
-       char    lum_pool_name[LOV_MAXPOOLNAME];
+       char    lum_pool_name[LOV_MAXPOOLNAME + 1];
        struct  lmv_user_mds_data  lum_objects[0];
 } __attribute__((packed));
 
@@ -547,23 +568,18 @@ static inline __u64 lustre_stoqb(size_t space)
 #define Q_FINVALIDATE  0x800104 /* deprecated as of 2.4 */
 
 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
-#define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
-#define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
+#define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
+#define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 /* lustre-specific control commands */
-#define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
-#define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
+#define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
+#define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
 
 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 
-struct if_quotacheck {
-        char                    obd_type[16];
-        struct obd_uuid         obd_uuid;
-};
-
 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 
 /* permission */
@@ -672,6 +688,7 @@ struct if_quotactl {
 #define SWAP_LAYOUTS_CHECK_DV2         (1 << 1)
 #define SWAP_LAYOUTS_KEEP_MTIME                (1 << 2)
 #define SWAP_LAYOUTS_KEEP_ATIME                (1 << 3)
+#define SWAP_LAYOUTS_CLOSE             (1 << 4)
 
 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
 #define SWAP_LAYOUTS_MDS_HSM           (1 << 31)
@@ -723,11 +740,17 @@ static inline const char *changelog_type2str(int type) {
 }
 
 /* per-record flags */
-#define CLF_VERSION     0x1000
-#define CLF_EXT_VERSION 0x2000
 #define CLF_FLAGSHIFT   12
 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
 #define CLF_VERMASK     (~CLF_FLAGMASK)
+enum changelog_rec_flags {
+       CLF_VERSION     = 0x1000,
+       CLF_RENAME      = 0x2000,
+       CLF_JOBID       = 0x4000,
+       CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID
+};
+
+
 /* Anything under the flagmask may be per-type (if desired) */
 /* Flags for unlink */
 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
@@ -809,69 +832,175 @@ static inline void hsm_set_cl_error(int *flags, int error)
         *flags |= (error << CLF_HSM_ERR_L);
 }
 
-#define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + \
-                                 sizeof(struct changelog_ext_rec))
+enum changelog_send_flag {
+       /* Not yet implemented */
+       CHANGELOG_FLAG_FOLLOW   = 0x01,
+       /* Blocking IO makes sense in case of slow user parsing of the records,
+        * but it also prevents us from cleaning up if the records are not
+        * consumed. */
+       CHANGELOG_FLAG_BLOCK    = 0x02,
+       /* Pack jobid into the changelog records if available. */
+       CHANGELOG_FLAG_JOBID    = 0x04,
+};
 
-struct changelog_rec {
-        __u16                 cr_namelen;
-        __u16                 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
-        __u32                 cr_type;  /**< \a changelog_rec_type */
-        __u64                 cr_index; /**< changelog record number */
-        __u64                 cr_prev;  /**< last index for this target fid */
-        __u64                 cr_time;
-        union {
-                lustre_fid    cr_tfid;        /**< target fid */
-                __u32         cr_markerflags; /**< CL_MARK flags */
-        };
-        lustre_fid            cr_pfid;        /**< parent fid */
-        char                  cr_name[0];     /**< last element */
-} __attribute__((packed));
+#define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
+                                 changelog_rec_offset(CLF_SUPPORTED))
+
+/* 31 usable bytes string + null terminator. */
+#define LUSTRE_JOBID_SIZE      32
 
-/* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
- * space, only rename uses changelog_ext_rec, while others use changelog_rec to
- * store records.
+/* This is the minimal changelog record. It can contain extensions
+ * such as rename fields or process jobid. Its exact content is described
+ * by the cr_flags.
+ *
+ * Extensions are packed in the same order as their corresponding flags.
  */
-struct changelog_ext_rec {
+struct changelog_rec {
        __u16                   cr_namelen;
-       __u16                   cr_flags; /**< (flags & CLF_FLAGMASK) |
-                                               CLF_EXT_VERSION */
+       __u16                   cr_flags; /**< \a changelog_rec_flags */
        __u32                   cr_type;  /**< \a changelog_rec_type */
        __u64                   cr_index; /**< changelog record number */
        __u64                   cr_prev;  /**< last index for this target fid */
        __u64                   cr_time;
        union {
-               lustre_fid      cr_tfid;        /**< target fid */
+               lustre_fid      cr_tfid;        /**< target fid */
                __u32           cr_markerflags; /**< CL_MARK flags */
        };
-       lustre_fid              cr_pfid;        /**< target parent fid */
-       lustre_fid              cr_sfid;        /**< source fid, or zero */
-       lustre_fid              cr_spfid;       /**< source parent fid, or zero */
-       char                    cr_name[0];     /**< last element */
-} __attribute__((packed));
+       lustre_fid              cr_pfid;        /**< parent fid */
+};
+
+/* Changelog extension for RENAME. */
+struct changelog_ext_rename {
+       lustre_fid              cr_sfid;     /**< source fid, or zero */
+       lustre_fid              cr_spfid;    /**< source parent fid, or zero */
+};
+
+/* Changelog extension to include JOBID. */
+struct changelog_ext_jobid {
+       char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
+};
 
-#define CHANGELOG_REC_EXTENDED(rec) \
-       (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
 
-static inline int changelog_rec_size(struct changelog_rec *rec)
+static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
 {
-       return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
-                                            sizeof(*rec);
+       size_t size = sizeof(struct changelog_rec);
+
+       if (crf & CLF_RENAME)
+               size += sizeof(struct changelog_ext_rename);
+
+       if (crf & CLF_JOBID)
+               size += sizeof(struct changelog_ext_jobid);
+
+       return size;
 }
 
-static inline char *changelog_rec_name(struct changelog_rec *rec)
+static inline size_t changelog_rec_size(const struct changelog_rec *rec)
 {
-       return CHANGELOG_REC_EXTENDED(rec) ?
-               ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
+       return changelog_rec_offset(rec->cr_flags);
 }
 
-static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
+static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
 {
-       return rec->cr_namelen - strlen(rec->cr_name) - 1;
+       return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
 }
 
-static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
+static inline
+struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
 {
-       return rec->cr_name + strlen(rec->cr_name) + 1;
+       enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
+
+       return (struct changelog_ext_rename *)((char *)rec +
+                                              changelog_rec_offset(crf));
+}
+
+/* The jobid follows the rename extension, if present */
+static inline
+struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
+{
+       enum changelog_rec_flags crf = rec->cr_flags &
+                                       (CLF_VERSION | CLF_RENAME);
+
+       return (struct changelog_ext_jobid *)((char *)rec +
+                                             changelog_rec_offset(crf));
+}
+
+/* The name follows the rename and jobid extensions, if present */
+static inline char *changelog_rec_name(const struct changelog_rec *rec)
+{
+       return (char *)rec + changelog_rec_offset(rec->cr_flags &
+                                                 CLF_SUPPORTED);
+}
+
+static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
+{
+       return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
+}
+
+static inline char *changelog_rec_sname(const struct changelog_rec *rec)
+{
+       char *cr_name = changelog_rec_name(rec);
+
+       return cr_name + strlen(cr_name) + 1;
+}
+
+/**
+ * Remap a record to the desired format as specified by the crf flags.
+ * The record must be big enough to contain the final remapped version.
+ * Superfluous extension fields are removed and missing ones are added
+ * and zeroed. The flags of the record are updated accordingly.
+ *
+ * The jobid and rename extensions can be added to a record, to match the
+ * format an application expects, typically. In this case, the newly added
+ * fields will be zeroed.
+ * The Jobid field can be removed, to guarantee compatibility with older
+ * clients that don't expect this field in the records they process.
+ *
+ * The following assumptions are being made:
+ *   - CLF_RENAME will not be removed
+ *   - CLF_JOBID will not be added without CLF_RENAME being added too
+ *
+ * @param[in,out]  rec         The record to remap.
+ * @param[in]      crf_wanted  Flags describing the desired extensions.
+ */
+static inline void changelog_remap_rec(struct changelog_rec *rec,
+                                      enum changelog_rec_flags crf_wanted)
+{
+       char *jid_mov;
+       char *rnm_mov;
+
+       crf_wanted &= CLF_SUPPORTED;
+
+       if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
+               return;
+
+       /* First move the variable-length name field */
+       memmove((char *)rec + changelog_rec_offset(crf_wanted),
+               changelog_rec_name(rec), rec->cr_namelen);
+
+       /* Locations of jobid and rename extensions in the remapped record */
+       jid_mov = (char *)rec +
+                 changelog_rec_offset(crf_wanted & ~CLF_JOBID);
+       rnm_mov = (char *)rec +
+                 changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
+
+       /* Move the extension fields to the desired positions */
+       if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
+               memmove(jid_mov, changelog_rec_jobid(rec),
+                       sizeof(struct changelog_ext_jobid));
+
+       if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
+               memmove(rnm_mov, changelog_rec_rename(rec),
+                       sizeof(struct changelog_ext_rename));
+
+       /* Clear newly added fields */
+       if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
+               memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
+
+       if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
+               memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
+
+       /* Update the record's flags accordingly */
+       rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
 }
 
 struct ioc_changelog {
@@ -1018,7 +1147,7 @@ static inline const char *hsm_user_action2name(enum hsm_user_action  a)
  * List of hr_flags (bit field)
  */
 #define HSM_FORCE_ACTION 0x0001
-/* used by CT, connot be set by user */
+/* used by CT, cannot be set by user */
 #define HSM_GHOST_COPY   0x0002
 
 /**
@@ -1067,7 +1196,7 @@ static inline ssize_t hur_len(struct hsm_user_request *hur)
                (__u64)hur->hur_request.hr_itemcount *
                sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
 
-       if (size > ~((size_t)0)>>1)
+       if (size != (ssize_t)size)
                return -1;
 
        return size;
@@ -1104,7 +1233,7 @@ static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
 struct hsm_action_item {
        __u32      hai_len;     /* valid size of this struct */
        __u32      hai_action;  /* hsm_copytool_action, but use known size */
-       lustre_fid hai_fid;     /* Lustre FID to operated on */
+       lustre_fid hai_fid;     /* Lustre FID to operate on */
        lustre_fid hai_dfid;    /* fid used for data access */
        struct hsm_extent hai_extent;  /* byte range to operate on */
        __u64      hai_cookie;  /* action cookie from coordinator */