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