lustre/include/lustre/lustre_user.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2010, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/include/lustre/lustre_user.h
  37  *
  38  * Lustre public user-space interface definitions.
  39  */
  40
  41 #ifndef _LUSTRE_USER_H
  42 #define _LUSTRE_USER_H
  43
  44 /** \defgroup lustreuser lustreuser
  45  *
  46  * @{
  47  */
  48
  49 #include <libcfs/types.h>
  50
  51 #ifdef __KERNEL__
  52 # include <linux/quota.h>
  53 # include <linux/string.h> /* snprintf() */
  54 # include <linux/version.h>
  55 #else /* !__KERNEL__ */
  56 # define NEED_QUOTA_DEFS
  57 # include <stdio.h> /* snprintf() */
  58 # include <string.h>
  59 # include <sys/quota.h>
  60 # include <sys/stat.h>
  61 #endif /* __KERNEL__ */
  62 #include <lustre/ll_fiemap.h>
  63
  64 #if defined(__x86_64__) || defined(__ia64__) || defined(__ppc64__) || \
  65     defined(__craynv) || defined(__mips64__) || defined(__powerpc64__)
  66 typedef struct stat     lstat_t;
  67 # define lstat_f        lstat
  68 # define fstat_f        fstat
  69 # define fstatat_f      fstatat
  70 # define HAVE_LOV_USER_MDS_DATA
  71 #elif defined(__USE_LARGEFILE64) || defined(__KERNEL__)
  72 typedef struct stat64   lstat_t;
  73 # define lstat_f        lstat64
  74 # define fstat_f        fstat64
  75 # define fstatat_f      fstatat64
  76 # define HAVE_LOV_USER_MDS_DATA
  77 #endif
  78
  79 #define LUSTRE_EOF 0xffffffffffffffffULL
  80
  81 /* for statfs() */
  82 #define LL_SUPER_MAGIC 0x0BD00BD0
  83
  84 #ifndef FSFILT_IOC_GETFLAGS
  85 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
  86 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
  87 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
  88 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
  89 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  90 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  91 #define FSFILT_IOC_FIEMAP                 _IOWR('f', 11, struct ll_user_fiemap)
  92 #endif
  93
  94 /* FIEMAP flags supported by Lustre */
  95 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
  96
  97 enum obd_statfs_state {
  98         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
  99         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
 100         OS_STATE_RDONLY_1       = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
 101         OS_STATE_RDONLY_2       = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
 102         OS_STATE_RDONLY_3       = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
 103 };
 104
 105 struct obd_statfs {
 106         __u64           os_type;
 107         __u64           os_blocks;
 108         __u64           os_bfree;
 109         __u64           os_bavail;
 110         __u64           os_files;
 111         __u64           os_ffree;
 112         __u8            os_fsid[40];
 113         __u32           os_bsize;
 114         __u32           os_namelen;
 115         __u64           os_maxbytes;
 116         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
 117         __u32           os_fprecreated; /* objs available now to the caller */
 118                                         /* used in QoS code to find preferred
 119                                          * OSTs */
 120         __u32           os_spare2;
 121         __u32           os_spare3;
 122         __u32           os_spare4;
 123         __u32           os_spare5;
 124         __u32           os_spare6;
 125         __u32           os_spare7;
 126         __u32           os_spare8;
 127         __u32           os_spare9;
 128 };
 129
 130 /**
 131  * File IDentifier.
 132  *
 133  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 134  * FIDs are never reused.
 135  **/
 136 struct lu_fid {
 137        /**
 138         * FID sequence. Sequence is a unit of migration: all files (objects)
 139         * with FIDs from a given sequence are stored on the same server.
 140         * Lustre should support 2^64 objects, so even if each sequence
 141         * has only a single object we can still enumerate 2^64 objects.
 142         **/
 143         __u64 f_seq;
 144         /* FID number within sequence. */
 145         __u32 f_oid;
 146         /**
 147          * FID version, used to distinguish different versions (in the sense
 148          * of snapshots, etc.) of the same file system object. Not currently
 149          * used.
 150          **/
 151         __u32 f_ver;
 152 };
 153
 154 static inline bool fid_is_zero(const struct lu_fid *fid)
 155 {
 156         return fid->f_seq == 0 && fid->f_oid == 0;
 157 }
 158
 159 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
 160  * MDT-object's FID::f_ver, instead it is the OST-object index in its
 161  * parent MDT-object's layout EA. */
 162 #define f_stripe_idx f_ver
 163
 164 struct filter_fid {
 165         struct lu_fid   ff_parent;  /* ff_parent.f_ver == file stripe number */
 166 };
 167
 168 /* keep this one for compatibility */
 169 struct filter_fid_old {
 170         struct lu_fid   ff_parent;
 171         __u64           ff_objid;
 172         __u64           ff_seq;
 173 };
 174
 175 /* Userspace should treat lu_fid as opaque, and only use the following methods
 176  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
 177  * here from lustre_idl.h if needed. */
 178 typedef struct lu_fid lustre_fid;
 179
 180 /**
 181  * Following struct for object attributes, that will be kept inode's EA.
 182  * Introduced in 2.0 release (please see b15993, for details)
 183  * Added to all objects since Lustre 2.4 as contains self FID
 184  */
 185 struct lustre_mdt_attrs {
 186         /**
 187          * Bitfield for supported data in this structure. From enum lma_compat.
 188          * lma_self_fid and lma_flags are always available.
 189          */
 190         __u32   lma_compat;
 191         /**
 192          * Per-file incompat feature list. Lustre version should support all
 193          * flags set in this field. The supported feature mask is available in
 194          * LMA_INCOMPAT_SUPP.
 195          */
 196         __u32   lma_incompat;
 197         /** FID of this inode */
 198         struct lu_fid  lma_self_fid;
 199 };
 200
 201 /**
 202  * Prior to 2.4, the LMA structure also included SOM attributes which has since
 203  * been moved to a dedicated xattr
 204  * lma_flags was also removed because of lma_compat/incompat fields.
 205  */
 206 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
 207
 208 /**
 209  * OST object IDentifier.
 210  */
 211 struct ost_id {
 212         union {
 213                 struct {
 214                         __u64   oi_id;
 215                         __u64   oi_seq;
 216                 } oi;
 217                 struct lu_fid oi_fid;
 218         };
 219 };
 220
 221 #define DOSTID LPX64":"LPU64
 222 #define POSTID(oi) ostid_seq(oi), ostid_id(oi)
 223
 224 /*
 225  * The ioctl naming rules:
 226  * LL_*     - works on the currently opened filehandle instead of parent dir
 227  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 228  * *_MDC_*  - gets/sets data related to MDC
 229  * *_LOV_*  - gets/sets data related to OSC/LOV
 230  * *FILE*   - called on parent dir and passes in a filename
 231  * *STRIPE* - set/get lov_user_md
 232  * *INFO    - set/get lov_user_mds_data
 233  */
 234 /*      lustre_ioctl.h                  101-150 */
 235 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 236 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 237 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 238 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 239 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 240 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 241 /*      LL_IOC_RECREATE_OBJ             157 obsolete */
 242 /*      LL_IOC_RECREATE_FID             157 obsolete */
 243 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 244 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 245 /*      LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
 246 /*      LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
 247 /*      LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
 248 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 249 /*      IOC_LOV_GETINFO                 165 obsolete */
 250 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 251 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
 252 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 253 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 254 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 255 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
 256 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 257 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 258 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 259 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 260 /*      lustre_ioctl.h                  177-210 */
 261 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
 262 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
 263 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
 264 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
 265 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
 266 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
 267 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
 268 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
 269 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
 270                                                 struct lustre_swap_layouts)
 271 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
 272                                                 struct hsm_current_action)
 273 /*      lustre_ioctl.h                  221-232 */
 274 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
 275 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
 276 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
 277 #define LL_IOC_SET_LEASE                _IOWR('f', 243, long)
 278 #define LL_IOC_GET_LEASE                _IO('f', 244)
 279 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
 280 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
 281 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
 282 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
 283 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
 284
 285 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
 286 enum ll_lease_type {
 287         LL_LEASE_RDLCK  = 0x1,
 288         LL_LEASE_WRLCK  = 0x2,
 289         LL_LEASE_UNLCK  = 0x4,
 290 };
 291
 292 #define LL_STATFS_LMV           1
 293 #define LL_STATFS_LOV           2
 294 #define LL_STATFS_NODELAY       4
 295
 296 #define IOC_MDC_TYPE            'i'
 297 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 298 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 299 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 300 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 301
 302 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 303
 304 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
 305  * files, but are unlikely to be used in practice and are not harmful if
 306  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
 307  * devices and are safe for use on new files. See LU-4209. */
 308 /* To be compatible with old statically linked binary we keep the check for
 309  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
 310 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
 311 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
 312 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
 313                                          O_LOV_DELAY_CREATE_MASK)
 314
 315 #define LL_FILE_IGNORE_LOCK     0x00000001
 316 #define LL_FILE_GROUP_LOCKED    0x00000002
 317 #define LL_FILE_READAHEA        0x00000004
 318 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 319 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 320 #define LL_FILE_RMTACL          0x00000020
 321
 322 #define LOV_USER_MAGIC_V1       0x0BD10BD0
 323 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
 324 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
 325 #define LOV_USER_MAGIC_V3       0x0BD30BD0
 326 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
 327 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
 328
 329 #define LMV_USER_MAGIC    0x0CD30CD0    /*default lmv magic*/
 330
 331 #define LOV_PATTERN_RAID0       0x001
 332 #define LOV_PATTERN_RAID1       0x002
 333 #define LOV_PATTERN_FIRST       0x100
 334 #define LOV_PATTERN_CMOBD       0x200
 335
 336 #define LOV_PATTERN_F_MASK      0xffff0000
 337 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
 338 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
 339
 340 #define LOV_MAXPOOLNAME 15
 341 #define LOV_POOLNAMEF "%.15s"
 342
 343 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 344 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 345 #define LOV_MAX_STRIPE_COUNT_OLD 160
 346 /* This calculation is crafted so that input of 4096 will result in 160
 347  * which in turn is equal to old maximal stripe count.
 348  * XXX: In fact this is too simpified for now, what it also need is to get
 349  * ea_type argument to clearly know how much space each stripe consumes.
 350  *
 351  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 352  * allocation that is sufficient for the current generation of systems.
 353  *
 354  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 355 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 356 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 357 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 358
 359 #define XATTR_LUSTRE_PREFIX     "lustre."
 360 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 361
 362 #define lov_user_ost_data lov_user_ost_data_v1
 363 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 364         struct ost_id l_ost_oi;   /* OST object ID */
 365         __u32 l_ost_gen;          /* generation of this OST index */
 366         __u32 l_ost_idx;          /* OST index in LOV */
 367 } __attribute__((packed));
 368
 369 #define lov_user_md lov_user_md_v1
 370 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 371         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 372         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 373         struct ost_id lmm_oi;     /* LOV object ID */
 374         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 375         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 376         union {
 377                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 378                                            * lmm_objects, use when writing */
 379                 __u16 lmm_layout_gen;     /* layout generation number
 380                                            * used when reading */
 381         };
 382         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 383 } __attribute__((packed,  __may_alias__));
 384
 385 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 386         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 387         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 388         struct ost_id lmm_oi;     /* LOV object ID */
 389         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 390         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 391         union {
 392                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 393                                            * lmm_objects, use when writing */
 394                 __u16 lmm_layout_gen;     /* layout generation number
 395                                            * used when reading */
 396         };
 397         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 398         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 399 } __attribute__((packed));
 400
 401 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
 402 {
 403         if (lmm_magic == LOV_USER_MAGIC_V1)
 404                 return sizeof(struct lov_user_md_v1) +
 405                               stripes * sizeof(struct lov_user_ost_data_v1);
 406         return sizeof(struct lov_user_md_v3) +
 407                                 stripes * sizeof(struct lov_user_ost_data_v1);
 408 }
 409
 410 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 411  * use this.  It is unsafe to #define those values in this header as it
 412  * is possible the application has already #included <sys/stat.h>. */
 413 #ifdef HAVE_LOV_USER_MDS_DATA
 414 #define lov_user_mds_data lov_user_mds_data_v1
 415 struct lov_user_mds_data_v1 {
 416         lstat_t lmd_st;                 /* MDS stat struct */
 417         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 418 } __attribute__((packed));
 419
 420 struct lov_user_mds_data_v3 {
 421         lstat_t lmd_st;                 /* MDS stat struct */
 422         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 423 } __attribute__((packed));
 424 #endif
 425
 426 struct lmv_user_mds_data {
 427         struct lu_fid   lum_fid;
 428         __u32           lum_padding;
 429         __u32           lum_mds;
 430 };
 431
 432 enum lmv_hash_type {
 433         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
 434         LMV_HASH_TYPE_ALL_CHARS = 1,
 435         LMV_HASH_TYPE_FNV_1A_64 = 2,
 436 };
 437
 438 #define LMV_HASH_NAME_ALL_CHARS "all_char"
 439 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
 440
 441 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
 442  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
 443 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 444 #define lmv_user_md lmv_user_md_v1
 445 struct lmv_user_md_v1 {
 446         __u32   lum_magic;       /* must be the first field */
 447         __u32   lum_stripe_count;  /* dirstripe count */
 448         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
 449         __u32   lum_hash_type;     /* Dir stripe policy */
 450         __u32   lum_type;         /* LMV type: default or normal */
 451         __u32   lum_padding1;
 452         __u32   lum_padding2;
 453         __u32   lum_padding3;
 454         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
 455         struct  lmv_user_mds_data  lum_objects[0];
 456 } __attribute__((packed));
 457
 458 static inline int lmv_user_md_size(int stripes, int lmm_magic)
 459 {
 460         return sizeof(struct lmv_user_md) +
 461                       stripes * sizeof(struct lmv_user_mds_data);
 462 }
 463
 464 extern void lustre_swab_lmv_user_md(struct lmv_user_md *lum);
 465
 466 struct ll_recreate_obj {
 467         __u64 lrc_id;
 468         __u32 lrc_ost_idx;
 469 };
 470
 471 struct ll_fid {
 472         __u64 id;         /* holds object id */
 473         __u32 generation; /* holds object generation */
 474         __u32 f_type;     /* holds object type or stripe idx when passing it to
 475                            * OST for saving into EA. */
 476 };
 477
 478 #define UUID_MAX        40
 479 struct obd_uuid {
 480         char uuid[UUID_MAX];
 481 };
 482
 483 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
 484                                    const struct obd_uuid *u2)
 485 {
 486         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 487 }
 488
 489 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 490 {
 491         return uuid->uuid[0] == '\0';
 492 }
 493
 494 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 495 {
 496         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 497         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 498 }
 499
 500 /* For printf's only, make sure uuid is terminated */
 501 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
 502 {
 503         if (uuid == NULL)
 504                 return NULL;
 505
 506         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 507                 /* Obviously not safe, but for printfs, no real harm done...
 508                    we're always null-terminated, even in a race. */
 509                 static char temp[sizeof(*uuid)];
 510                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 511                 temp[sizeof(*uuid) - 1] = '\0';
 512                 return temp;
 513         }
 514         return (char *)(uuid->uuid);
 515 }
 516
 517 /* Extract fsname from uuid (or target name) of a target
 518    e.g. (myfs-OST0007_UUID -> myfs)
 519    see also deuuidify. */
 520 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 521 {
 522         char *p;
 523
 524         strncpy(buf, uuid, buflen - 1);
 525         buf[buflen - 1] = '\0';
 526         p = strrchr(buf, '-');
 527         if (p != NULL)
 528                 *p = '\0';
 529 }
 530
 531 /* printf display format
 532    e.g. printf("file FID is "DFID"\n", PFID(fid)); */
 533 #define FID_NOBRACE_LEN 40
 534 #define FID_LEN (FID_NOBRACE_LEN + 2)
 535 #define DFID_NOBRACE LPX64":0x%x:0x%x"
 536 #define DFID "["DFID_NOBRACE"]"
 537 #define PFID(fid)     \
 538         (fid)->f_seq, \
 539         (fid)->f_oid, \
 540         (fid)->f_ver
 541
 542 /* scanf input parse format -- strip '[' first.
 543    e.g. sscanf(fidstr, SFID, RFID(&fid)); */
 544 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
 545 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
 546 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
 547 */
 548 #define SFID "0x"LPX64i":0x%x:0x%x"
 549 #define RFID(fid)     \
 550         &((fid)->f_seq), \
 551         &((fid)->f_oid), \
 552         &((fid)->f_ver)
 553
 554
 555 /********* Quotas **********/
 556
 557 #define LUSTRE_QUOTABLOCK_BITS 10
 558 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
 559
 560 static inline __u64 lustre_stoqb(size_t space)
 561 {
 562         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
 563 }
 564
 565 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
 566 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
 567 #define Q_GETOINFO      0x800102 /* get obd quota info */
 568 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
 569 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
 570
 571 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 572 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
 573 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
 574 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 575 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 576 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 577 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 578 /* lustre-specific control commands */
 579 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
 580 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
 581
 582 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 583
 584 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 585
 586 /* permission */
 587 #define N_PERMS_MAX      64
 588
 589 struct perm_downcall_data {
 590         __u64 pdd_nid;
 591         __u32 pdd_perm;
 592         __u32 pdd_padding;
 593 };
 594
 595 struct identity_downcall_data {
 596         __u32                            idd_magic;
 597         __u32                            idd_err;
 598         __u32                            idd_uid;
 599         __u32                            idd_gid;
 600         __u32                            idd_nperms;
 601         __u32                            idd_ngroups;
 602         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 603         __u32                            idd_groups[0];
 604 };
 605
 606 /* for non-mapped uid/gid */
 607 #define NOBODY_UID      99
 608 #define NOBODY_GID      99
 609
 610 #define INVALID_ID      (-1)
 611
 612 enum {
 613         RMT_LSETFACL    = 1,
 614         RMT_LGETFACL    = 2,
 615         RMT_RSETFACL    = 3,
 616         RMT_RGETFACL    = 4
 617 };
 618
 619 #ifdef NEED_QUOTA_DEFS
 620 #ifndef QIF_BLIMITS
 621 #define QIF_BLIMITS     1
 622 #define QIF_SPACE       2
 623 #define QIF_ILIMITS     4
 624 #define QIF_INODES      8
 625 #define QIF_BTIME       16
 626 #define QIF_ITIME       32
 627 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 628 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 629 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 630 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 631 #endif
 632
 633 #endif /* !__KERNEL__ */
 634
 635 /* lustre volatile file support
 636  * file name header: .^L^S^T^R:volatile"
 637  */
 638 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
 639 #define LUSTRE_VOLATILE_HDR_LEN 14
 640
 641 typedef enum lustre_quota_version {
 642         LUSTRE_QUOTA_V2 = 1
 643 } lustre_quota_version_t;
 644
 645 /* XXX: same as if_dqinfo struct in kernel */
 646 struct obd_dqinfo {
 647         __u64 dqi_bgrace;
 648         __u64 dqi_igrace;
 649         __u32 dqi_flags;
 650         __u32 dqi_valid;
 651 };
 652
 653 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 654 struct obd_dqblk {
 655         __u64 dqb_bhardlimit;
 656         __u64 dqb_bsoftlimit;
 657         __u64 dqb_curspace;
 658         __u64 dqb_ihardlimit;
 659         __u64 dqb_isoftlimit;
 660         __u64 dqb_curinodes;
 661         __u64 dqb_btime;
 662         __u64 dqb_itime;
 663         __u32 dqb_valid;
 664         __u32 dqb_padding;
 665 };
 666
 667 enum {
 668         QC_GENERAL      = 0,
 669         QC_MDTIDX       = 1,
 670         QC_OSTIDX       = 2,
 671         QC_UUID         = 3
 672 };
 673
 674 struct if_quotactl {
 675         __u32                   qc_cmd;
 676         __u32                   qc_type;
 677         __u32                   qc_id;
 678         __u32                   qc_stat;
 679         __u32                   qc_valid;
 680         __u32                   qc_idx;
 681         struct obd_dqinfo       qc_dqinfo;
 682         struct obd_dqblk        qc_dqblk;
 683         char                    obd_type[16];
 684         struct obd_uuid         obd_uuid;
 685 };
 686
 687 /* swap layout flags */
 688 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
 689 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
 690 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
 691 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
 692
 693 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
 694 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
 695 struct lustre_swap_layouts {
 696         __u64   sl_flags;
 697         __u32   sl_fd;
 698         __u32   sl_gid;
 699         __u64   sl_dv1;
 700         __u64   sl_dv2;
 701 };
 702
 703
 704 /********* Changelogs **********/
 705 /** Changelog record types */
 706 enum changelog_rec_type {
 707         CL_MARK     = 0,
 708         CL_CREATE   = 1,  /* namespace */
 709         CL_MKDIR    = 2,  /* namespace */
 710         CL_HARDLINK = 3,  /* namespace */
 711         CL_SOFTLINK = 4,  /* namespace */
 712         CL_MKNOD    = 5,  /* namespace */
 713         CL_UNLINK   = 6,  /* namespace */
 714         CL_RMDIR    = 7,  /* namespace */
 715         CL_RENAME   = 8,  /* namespace */
 716         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
 717         CL_OPEN     = 10, /* not currently used */
 718         CL_CLOSE    = 11, /* may be written to log only with mtime change */
 719         CL_LAYOUT   = 12, /* file layout/striping modified */
 720         CL_TRUNC    = 13,
 721         CL_SETATTR  = 14,
 722         CL_XATTR    = 15,
 723         CL_HSM      = 16, /* HSM specific events, see flags */
 724         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
 725         CL_CTIME    = 18,
 726         CL_ATIME    = 19,
 727         CL_LAST
 728 };
 729
 730 static inline const char *changelog_type2str(int type) {
 731         static const char *changelog_str[] = {
 732                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
 733                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
 734                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME",
 735         };
 736
 737         if (type >= 0 && type < CL_LAST)
 738                 return changelog_str[type];
 739         return NULL;
 740 }
 741
 742 /* per-record flags */
 743 #define CLF_FLAGSHIFT   12
 744 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
 745 #define CLF_VERMASK     (~CLF_FLAGMASK)
 746 enum changelog_rec_flags {
 747         CLF_VERSION     = 0x1000,
 748         CLF_RENAME      = 0x2000,
 749         CLF_JOBID       = 0x4000,
 750         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID
 751 };
 752
 753
 754 /* Anything under the flagmask may be per-type (if desired) */
 755 /* Flags for unlink */
 756 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
 757 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
 758                                      /* HSM cleaning needed */
 759 /* Flags for rename */
 760 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
 761                                         * of target */
 762 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
 763                                         * has an archive in backend */
 764
 765 /* Flags for HSM */
 766 /* 12b used (from high weight to low weight):
 767  * 2b for flags
 768  * 3b for event
 769  * 7b for error code
 770  */
 771 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
 772 #define CLF_HSM_ERR_H        6
 773 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
 774 #define CLF_HSM_EVENT_H      9
 775 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
 776 #define CLF_HSM_FLAG_H      11
 777 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
 778 #define CLF_HSM_SPARE_H     15
 779 #define CLF_HSM_LAST        15
 780
 781 /* Remove bits higher than _h, then extract the value
 782  * between _h and _l by shifting lower weigth to bit 0. */
 783 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
 784                                    >> (CLF_HSM_LAST - _h + _l))
 785
 786 #define CLF_HSM_SUCCESS      0x00
 787 #define CLF_HSM_MAXERROR     0x7E
 788 #define CLF_HSM_ERROVERFLOW  0x7F
 789
 790 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
 791
 792 /* 3 bits field => 8 values allowed */
 793 enum hsm_event {
 794         HE_ARCHIVE      = 0,
 795         HE_RESTORE      = 1,
 796         HE_CANCEL       = 2,
 797         HE_RELEASE      = 3,
 798         HE_REMOVE       = 4,
 799         HE_STATE        = 5,
 800         HE_SPARE1       = 6,
 801         HE_SPARE2       = 7,
 802 };
 803
 804 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
 805 {
 806         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
 807                                             CLF_HSM_EVENT_L);
 808 }
 809
 810 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
 811 {
 812         *flags |= (he << CLF_HSM_EVENT_L);
 813 }
 814
 815 static inline __u16 hsm_get_cl_flags(int flags)
 816 {
 817         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
 818 }
 819
 820 static inline void hsm_set_cl_flags(int *flags, int bits)
 821 {
 822         *flags |= (bits << CLF_HSM_FLAG_L);
 823 }
 824
 825 static inline int hsm_get_cl_error(int flags)
 826 {
 827         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
 828 }
 829
 830 static inline void hsm_set_cl_error(int *flags, int error)
 831 {
 832         *flags |= (error << CLF_HSM_ERR_L);
 833 }
 834
 835 enum changelog_send_flag {
 836         /* Not yet implemented */
 837         CHANGELOG_FLAG_FOLLOW   = 0x01,
 838         /* Blocking IO makes sense in case of slow user parsing of the records,
 839          * but it also prevents us from cleaning up if the records are not
 840          * consumed. */
 841         CHANGELOG_FLAG_BLOCK    = 0x02,
 842         /* Pack jobid into the changelog records if available. */
 843         CHANGELOG_FLAG_JOBID    = 0x04,
 844 };
 845
 846 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
 847                                   changelog_rec_offset(CLF_SUPPORTED))
 848
 849 /* 31 usable bytes string + null terminator. */
 850 #define LUSTRE_JOBID_SIZE       32
 851
 852 /* This is the minimal changelog record. It can contain extensions
 853  * such as rename fields or process jobid. Its exact content is described
 854  * by the cr_flags.
 855  *
 856  * Extensions are packed in the same order as their corresponding flags.
 857  */
 858 struct changelog_rec {
 859         __u16                   cr_namelen;
 860         __u16                   cr_flags; /**< \a changelog_rec_flags */
 861         __u32                   cr_type;  /**< \a changelog_rec_type */
 862         __u64                   cr_index; /**< changelog record number */
 863         __u64                   cr_prev;  /**< last index for this target fid */
 864         __u64                   cr_time;
 865         union {
 866                 lustre_fid      cr_tfid;        /**< target fid */
 867                 __u32           cr_markerflags; /**< CL_MARK flags */
 868         };
 869         lustre_fid              cr_pfid;        /**< parent fid */
 870 };
 871
 872 /* Changelog extension for RENAME. */
 873 struct changelog_ext_rename {
 874         lustre_fid              cr_sfid;     /**< source fid, or zero */
 875         lustre_fid              cr_spfid;    /**< source parent fid, or zero */
 876 };
 877
 878 /* Changelog extension to include JOBID. */
 879 struct changelog_ext_jobid {
 880         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
 881 };
 882
 883
 884 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
 885 {
 886         size_t size = sizeof(struct changelog_rec);
 887
 888         if (crf & CLF_RENAME)
 889                 size += sizeof(struct changelog_ext_rename);
 890
 891         if (crf & CLF_JOBID)
 892                 size += sizeof(struct changelog_ext_jobid);
 893
 894         return size;
 895 }
 896
 897 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
 898 {
 899         return changelog_rec_offset(rec->cr_flags);
 900 }
 901
 902 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
 903 {
 904         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
 905 }
 906
 907 static inline
 908 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
 909 {
 910         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
 911
 912         return (struct changelog_ext_rename *)((char *)rec +
 913                                                changelog_rec_offset(crf));
 914 }
 915
 916 /* The jobid follows the rename extension, if present */
 917 static inline
 918 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
 919 {
 920         enum changelog_rec_flags crf = rec->cr_flags &
 921                                         (CLF_VERSION | CLF_RENAME);
 922
 923         return (struct changelog_ext_jobid *)((char *)rec +
 924                                               changelog_rec_offset(crf));
 925 }
 926
 927 /* The name follows the rename and jobid extensions, if present */
 928 static inline char *changelog_rec_name(const struct changelog_rec *rec)
 929 {
 930         return (char *)rec + changelog_rec_offset(rec->cr_flags &
 931                                                   CLF_SUPPORTED);
 932 }
 933
 934 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
 935 {
 936         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
 937 }
 938
 939 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
 940 {
 941         char *cr_name = changelog_rec_name(rec);
 942
 943         return cr_name + strlen(cr_name) + 1;
 944 }
 945
 946 /**
 947  * Remap a record to the desired format as specified by the crf flags.
 948  * The record must be big enough to contain the final remapped version.
 949  * Superfluous extension fields are removed and missing ones are added
 950  * and zeroed. The flags of the record are updated accordingly.
 951  *
 952  * The jobid and rename extensions can be added to a record, to match the
 953  * format an application expects, typically. In this case, the newly added
 954  * fields will be zeroed.
 955  * The Jobid field can be removed, to guarantee compatibility with older
 956  * clients that don't expect this field in the records they process.
 957  *
 958  * The following assumptions are being made:
 959  *   - CLF_RENAME will not be removed
 960  *   - CLF_JOBID will not be added without CLF_RENAME being added too
 961  *
 962  * @param[in,out]  rec         The record to remap.
 963  * @param[in]      crf_wanted  Flags describing the desired extensions.
 964  */
 965 static inline void changelog_remap_rec(struct changelog_rec *rec,
 966                                        enum changelog_rec_flags crf_wanted)
 967 {
 968         char *jid_mov;
 969         char *rnm_mov;
 970
 971         crf_wanted &= CLF_SUPPORTED;
 972
 973         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
 974                 return;
 975
 976         /* First move the variable-length name field */
 977         memmove((char *)rec + changelog_rec_offset(crf_wanted),
 978                 changelog_rec_name(rec), rec->cr_namelen);
 979
 980         /* Locations of jobid and rename extensions in the remapped record */
 981         jid_mov = (char *)rec +
 982                   changelog_rec_offset(crf_wanted & ~CLF_JOBID);
 983         rnm_mov = (char *)rec +
 984                   changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
 985
 986         /* Move the extension fields to the desired positions */
 987         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
 988                 memmove(jid_mov, changelog_rec_jobid(rec),
 989                         sizeof(struct changelog_ext_jobid));
 990
 991         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
 992                 memmove(rnm_mov, changelog_rec_rename(rec),
 993                         sizeof(struct changelog_ext_rename));
 994
 995         /* Clear newly added fields */
 996         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
 997                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
 998
 999         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1000                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1001
1002         /* Update the record's flags accordingly */
1003         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1004 }
1005
1006 struct ioc_changelog {
1007         __u64 icc_recno;
1008         __u32 icc_mdtindex;
1009         __u32 icc_id;
1010         __u32 icc_flags;
1011 };
1012
1013 enum changelog_message_type {
1014         CL_RECORD = 10, /* message is a changelog_rec */
1015         CL_EOF    = 11, /* at end of current changelog */
1016 };
1017
1018 /********* Misc **********/
1019
1020 struct ioc_data_version {
1021         __u64 idv_version;
1022         __u64 idv_flags;     /* See LL_DV_xxx */
1023 };
1024 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
1025 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
1026
1027 #ifndef offsetof
1028 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1029 #endif
1030
1031 #define dot_lustre_name ".lustre"
1032
1033
1034 /********* HSM **********/
1035
1036 /** HSM per-file state
1037  * See HSM_FLAGS below.
1038  */
1039 enum hsm_states {
1040         HS_EXISTS       = 0x00000001,
1041         HS_DIRTY        = 0x00000002,
1042         HS_RELEASED     = 0x00000004,
1043         HS_ARCHIVED     = 0x00000008,
1044         HS_NORELEASE    = 0x00000010,
1045         HS_NOARCHIVE    = 0x00000020,
1046         HS_LOST         = 0x00000040,
1047 };
1048
1049 /* HSM user-setable flags. */
1050 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1051
1052 /* Other HSM flags. */
1053 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1054
1055 /*
1056  * All HSM-related possible flags that could be applied to a file.
1057  * This should be kept in sync with hsm_states.
1058  */
1059 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1060
1061 /**
1062  * HSM request progress state
1063  */
1064 enum hsm_progress_states {
1065         HPS_WAITING     = 1,
1066         HPS_RUNNING     = 2,
1067         HPS_DONE        = 3,
1068 };
1069 #define HPS_NONE        0
1070
1071 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1072 {
1073         switch  (s) {
1074         case HPS_WAITING:       return "waiting";
1075         case HPS_RUNNING:       return "running";
1076         case HPS_DONE:          return "done";
1077         default:                return "unknown";
1078         }
1079 }
1080
1081 struct hsm_extent {
1082         __u64 offset;
1083         __u64 length;
1084 } __attribute__((packed));
1085
1086 /**
1087  * Current HSM states of a Lustre file.
1088  *
1089  * This structure purpose is to be sent to user-space mainly. It describes the
1090  * current HSM flags and in-progress action.
1091  */
1092 struct hsm_user_state {
1093         /** Current HSM states, from enum hsm_states. */
1094         __u32                   hus_states;
1095         __u32                   hus_archive_id;
1096         /**  The current undergoing action, if there is one */
1097         __u32                   hus_in_progress_state;
1098         __u32                   hus_in_progress_action;
1099         struct hsm_extent       hus_in_progress_location;
1100         char                    hus_extended_info[];
1101 };
1102
1103 struct hsm_state_set_ioc {
1104         struct lu_fid   hssi_fid;
1105         __u64           hssi_setmask;
1106         __u64           hssi_clearmask;
1107 };
1108
1109 /*
1110  * This structure describes the current in-progress action for a file.
1111  * it is retuned to user space and send over the wire
1112  */
1113 struct hsm_current_action {
1114         /**  The current undergoing action, if there is one */
1115         /* state is one of hsm_progress_states */
1116         __u32                   hca_state;
1117         /* action is one of hsm_user_action */
1118         __u32                   hca_action;
1119         struct hsm_extent       hca_location;
1120 };
1121
1122 /***** HSM user requests ******/
1123 /* User-generated (lfs/ioctl) request types */
1124 enum hsm_user_action {
1125         HUA_NONE    =  1, /* no action (noop) */
1126         HUA_ARCHIVE = 10, /* copy to hsm */
1127         HUA_RESTORE = 11, /* prestage */
1128         HUA_RELEASE = 12, /* drop ost objects */
1129         HUA_REMOVE  = 13, /* remove from archive */
1130         HUA_CANCEL  = 14  /* cancel a request */
1131 };
1132
1133 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1134 {
1135         switch  (a) {
1136         case HUA_NONE:    return "NOOP";
1137         case HUA_ARCHIVE: return "ARCHIVE";
1138         case HUA_RESTORE: return "RESTORE";
1139         case HUA_RELEASE: return "RELEASE";
1140         case HUA_REMOVE:  return "REMOVE";
1141         case HUA_CANCEL:  return "CANCEL";
1142         default:          return "UNKNOWN";
1143         }
1144 }
1145
1146 /*
1147  * List of hr_flags (bit field)
1148  */
1149 #define HSM_FORCE_ACTION 0x0001
1150 /* used by CT, cannot be set by user */
1151 #define HSM_GHOST_COPY   0x0002
1152
1153 /**
1154  * Contains all the fixed part of struct hsm_user_request.
1155  *
1156  */
1157 struct hsm_request {
1158         __u32 hr_action;        /* enum hsm_user_action */
1159         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1160         __u64 hr_flags;         /* request flags */
1161         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1162         __u32 hr_data_len;
1163 };
1164
1165 struct hsm_user_item {
1166        lustre_fid        hui_fid;
1167        struct hsm_extent hui_extent;
1168 } __attribute__((packed));
1169
1170 struct hsm_user_request {
1171         struct hsm_request      hur_request;
1172         struct hsm_user_item    hur_user_item[0];
1173         /* extra data blob at end of struct (after all
1174          * hur_user_items), only use helpers to access it
1175          */
1176 } __attribute__((packed));
1177
1178 /** Return pointer to data field in a hsm user request */
1179 static inline void *hur_data(struct hsm_user_request *hur)
1180 {
1181         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1182 }
1183
1184 /**
1185  * Compute the current length of the provided hsm_user_request.  This returns -1
1186  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1187  *
1188  * return -1 on bounds check error.
1189  */
1190 static inline ssize_t hur_len(struct hsm_user_request *hur)
1191 {
1192         __u64   size;
1193
1194         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1195         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1196                 (__u64)hur->hur_request.hr_itemcount *
1197                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1198
1199         if (size != (ssize_t)size)
1200                 return -1;
1201
1202         return size;
1203 }
1204
1205 /****** HSM RPCs to copytool *****/
1206 /* Message types the copytool may receive */
1207 enum hsm_message_type {
1208         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1209 };
1210
1211 /* Actions the copytool may be instructed to take for a given action_item */
1212 enum hsm_copytool_action {
1213         HSMA_NONE    = 10, /* no action */
1214         HSMA_ARCHIVE = 20, /* arbitrary offset */
1215         HSMA_RESTORE = 21,
1216         HSMA_REMOVE  = 22,
1217         HSMA_CANCEL  = 23
1218 };
1219
1220 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1221 {
1222         switch  (a) {
1223         case HSMA_NONE:    return "NOOP";
1224         case HSMA_ARCHIVE: return "ARCHIVE";
1225         case HSMA_RESTORE: return "RESTORE";
1226         case HSMA_REMOVE:  return "REMOVE";
1227         case HSMA_CANCEL:  return "CANCEL";
1228         default:           return "UNKNOWN";
1229         }
1230 }
1231
1232 /* Copytool item action description */
1233 struct hsm_action_item {
1234         __u32      hai_len;     /* valid size of this struct */
1235         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1236         lustre_fid hai_fid;     /* Lustre FID to operate on */
1237         lustre_fid hai_dfid;    /* fid used for data access */
1238         struct hsm_extent hai_extent;  /* byte range to operate on */
1239         __u64      hai_cookie;  /* action cookie from coordinator */
1240         __u64      hai_gid;     /* grouplock id */
1241         char       hai_data[0]; /* variable length */
1242 } __attribute__((packed));
1243
1244 /*
1245  * helper function which print in hexa the first bytes of
1246  * hai opaque field
1247  * \param hai [IN] record to print
1248  * \param buffer [OUT] output buffer
1249  * \param len [IN] max buffer len
1250  * \retval buffer
1251  */
1252 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1253                                         char *buffer, int len)
1254 {
1255         int i, sz, data_len;
1256         char *ptr;
1257
1258         ptr = buffer;
1259         sz = len;
1260         data_len = hai->hai_len - sizeof(*hai);
1261         for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
1262         {
1263                 int cnt;
1264
1265                 cnt = snprintf(ptr, sz, "%.2X",
1266                                (unsigned char)hai->hai_data[i]);
1267                 ptr += cnt;
1268                 sz -= cnt;
1269         }
1270         *ptr = '\0';
1271         return buffer;
1272 }
1273
1274 /* Copytool action list */
1275 #define HAL_VERSION 1
1276 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1277 struct hsm_action_list {
1278         __u32 hal_version;
1279         __u32 hal_count;       /* number of hai's to follow */
1280         __u64 hal_compound_id; /* returned by coordinator */
1281         __u64 hal_flags;
1282         __u32 hal_archive_id; /* which archive backend */
1283         __u32 padding1;
1284         char  hal_fsname[0];   /* null-terminated */
1285         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1286            boundaries. See hai_zero */
1287 } __attribute__((packed));
1288
1289 #ifndef HAVE_CFS_SIZE_ROUND
1290 static inline int cfs_size_round (int val)
1291 {
1292         return (val + 7) & (~0x7);
1293 }
1294 #define HAVE_CFS_SIZE_ROUND
1295 #endif
1296
1297 /* Return pointer to first hai in action list */
1298 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1299 {
1300         return (struct hsm_action_item *)(hal->hal_fsname +
1301                                           cfs_size_round(strlen(hal-> \
1302                                                                 hal_fsname)
1303                                                          + 1));
1304 }
1305 /* Return pointer to next hai */
1306 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1307 {
1308         return (struct hsm_action_item *)((char *)hai +
1309                                           cfs_size_round(hai->hai_len));
1310 }
1311
1312 /* Return size of an hsm_action_list */
1313 static inline size_t hal_size(struct hsm_action_list *hal)
1314 {
1315         __u32 i;
1316         size_t sz;
1317         struct hsm_action_item *hai;
1318
1319         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1320         hai = hai_first(hal);
1321         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1322                 sz += cfs_size_round(hai->hai_len);
1323
1324         return sz;
1325 }
1326
1327 /* HSM file import
1328  * describe the attributes to be set on imported file
1329  */
1330 struct hsm_user_import {
1331         __u64           hui_size;
1332         __u64           hui_atime;
1333         __u64           hui_mtime;
1334         __u32           hui_atime_ns;
1335         __u32           hui_mtime_ns;
1336         __u32           hui_uid;
1337         __u32           hui_gid;
1338         __u32           hui_mode;
1339         __u32           hui_archive_id;
1340 };
1341
1342 /* Copytool progress reporting */
1343 #define HP_FLAG_COMPLETED 0x01
1344 #define HP_FLAG_RETRY     0x02
1345
1346 struct hsm_progress {
1347         lustre_fid              hp_fid;
1348         __u64                   hp_cookie;
1349         struct hsm_extent       hp_extent;
1350         __u16                   hp_flags;
1351         __u16                   hp_errval; /* positive val */
1352         __u32                   padding;
1353 };
1354
1355 struct hsm_copy {
1356         __u64                   hc_data_version;
1357         __u16                   hc_flags;
1358         __u16                   hc_errval; /* positive val */
1359         __u32                   padding;
1360         struct hsm_action_item  hc_hai;
1361 };
1362
1363 /* JSON objects */
1364 enum llapi_json_types {
1365         LLAPI_JSON_INTEGER = 1,
1366         LLAPI_JSON_BIGNUM,
1367         LLAPI_JSON_REAL,
1368         LLAPI_JSON_STRING
1369 };
1370
1371 struct llapi_json_item {
1372         char                    *lji_key;
1373         __u32                   lji_type;
1374         union {
1375                 int     lji_integer;
1376                 __u64   lji_u64;
1377                 double  lji_real;
1378                 char    *lji_string;
1379         };
1380         struct llapi_json_item  *lji_next;
1381 };
1382
1383 struct llapi_json_item_list {
1384         int                     ljil_item_count;
1385         struct llapi_json_item  *ljil_items;
1386 };
1387
1388 /** @} lustreuser */
1389
1390 #endif /* _LUSTRE_USER_H */