lustre/include/uapi/linux/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 # include <uapi/linux/lustre/lustre_fiemap.h>
  53 #else /* !__KERNEL__ */
  54 # define NEED_QUOTA_DEFS
  55 # include <limits.h>
  56 # include <stdbool.h>
  57 # include <stdio.h> /* snprintf() */
  58 # include <string.h>
  59 # include <sys/quota.h>
  60 # include <sys/stat.h>
  61 # include <linux/lustre/lustre_fiemap.h>
  62 #endif /* __KERNEL__ */
  63
  64 /*
  65  * This is a temporary solution of adding quota type.
  66  * Should be removed as soon as system header is updated.
  67  */
  68 #undef LL_MAXQUOTAS
  69 #define LL_MAXQUOTAS 3
  70 #undef INITQFNAMES
  71 #define INITQFNAMES { \
  72     "user",     /* USRQUOTA */ \
  73     "group",    /* GRPQUOTA */ \
  74     "project",  /* PRJQUOTA */ \
  75     "undefined", \
  76 };
  77 #define PRJQUOTA 2
  78
  79 #if defined(__x86_64__) || defined(__ia64__) || defined(__ppc64__) || \
  80     defined(__craynv) || defined(__mips64__) || defined(__powerpc64__) || \
  81     defined(__aarch64__)
  82 typedef struct stat     lstat_t;
  83 # define lstat_f        lstat
  84 # define fstat_f        fstat
  85 # define fstatat_f      fstatat
  86 # define HAVE_LOV_USER_MDS_DATA
  87 #elif defined(__USE_LARGEFILE64) || defined(__KERNEL__)
  88 typedef struct stat64   lstat_t;
  89 # define lstat_f        lstat64
  90 # define fstat_f        fstat64
  91 # define fstatat_f      fstatat64
  92 # define HAVE_LOV_USER_MDS_DATA
  93 #endif
  94
  95 #define LUSTRE_EOF 0xffffffffffffffffULL
  96
  97 /* for statfs() */
  98 #define LL_SUPER_MAGIC 0x0BD00BD0
  99
 100 #ifndef FSFILT_IOC_GETFLAGS
 101 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
 102 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
 103 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
 104 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
 105 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
 106 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
 107 #endif
 108
 109 /* FIEMAP flags supported by Lustre */
 110 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
 111
 112 enum obd_statfs_state {
 113         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
 114         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
 115         OS_STATE_ENOSPC         = 0x00000020, /**< not enough free space */
 116         OS_STATE_ENOINO         = 0x00000040, /**< not enough inodes */
 117 };
 118
 119 struct obd_statfs {
 120         __u64           os_type;
 121         __u64           os_blocks;
 122         __u64           os_bfree;
 123         __u64           os_bavail;
 124         __u64           os_files;
 125         __u64           os_ffree;
 126         __u8            os_fsid[40];
 127         __u32           os_bsize;
 128         __u32           os_namelen;
 129         __u64           os_maxbytes;
 130         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
 131         __u32           os_fprecreated; /* objs available now to the caller */
 132                                         /* used in QoS code to find preferred
 133                                          * OSTs */
 134         __u32           os_spare2;
 135         __u32           os_spare3;
 136         __u32           os_spare4;
 137         __u32           os_spare5;
 138         __u32           os_spare6;
 139         __u32           os_spare7;
 140         __u32           os_spare8;
 141         __u32           os_spare9;
 142 };
 143
 144 /**
 145  * File IDentifier.
 146  *
 147  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 148  * FIDs are never reused.
 149  **/
 150 struct lu_fid {
 151        /**
 152         * FID sequence. Sequence is a unit of migration: all files (objects)
 153         * with FIDs from a given sequence are stored on the same server.
 154         * Lustre should support 2^64 objects, so even if each sequence
 155         * has only a single object we can still enumerate 2^64 objects.
 156         **/
 157         __u64 f_seq;
 158         /* FID number within sequence. */
 159         __u32 f_oid;
 160         /**
 161          * FID version, used to distinguish different versions (in the sense
 162          * of snapshots, etc.) of the same file system object. Not currently
 163          * used.
 164          **/
 165         __u32 f_ver;
 166 };
 167
 168 static inline bool fid_is_zero(const struct lu_fid *fid)
 169 {
 170         return fid->f_seq == 0 && fid->f_oid == 0;
 171 }
 172
 173 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
 174  * MDT-object's FID::f_ver, instead it is the OST-object index in its
 175  * parent MDT-object's layout EA. */
 176 #define f_stripe_idx f_ver
 177
 178 struct ost_layout {
 179         __u32   ol_stripe_size;
 180         __u32   ol_stripe_count;
 181         __u64   ol_comp_start;
 182         __u64   ol_comp_end;
 183         __u32   ol_comp_id;
 184 } __attribute__((packed));
 185
 186 /* keep this one for compatibility */
 187 struct filter_fid_old {
 188         struct lu_fid   ff_parent;
 189         __u64           ff_objid;
 190         __u64           ff_seq;
 191 };
 192
 193 struct filter_fid {
 194         struct lu_fid           ff_parent;
 195         struct ost_layout       ff_layout;
 196 } __attribute__((packed));
 197
 198 /* Userspace should treat lu_fid as opaque, and only use the following methods
 199  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
 200  * here from lustre_idl.h if needed. */
 201 typedef struct lu_fid lustre_fid;
 202
 203 enum lma_compat {
 204         LMAC_HSM         = 0x00000001,
 205 /*      LMAC_SOM         = 0x00000002, obsolete since 2.8.0 */
 206         LMAC_NOT_IN_OI   = 0x00000004, /* the object does NOT need OI mapping */
 207         LMAC_FID_ON_OST  = 0x00000008, /* For OST-object, its OI mapping is
 208                                        * under /O/<seq>/d<x>. */
 209         LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
 210         LMAC_COMP_INFO   = 0x00000020, /* Component info in the LMA EA. */
 211 };
 212
 213 /**
 214  * Masks for all features that should be supported by a Lustre version to
 215  * access a specific file.
 216  * This information is stored in lustre_mdt_attrs::lma_incompat.
 217  */
 218 enum lma_incompat {
 219         LMAI_RELEASED           = 0x00000001, /* file is released */
 220         LMAI_AGENT              = 0x00000002, /* agent inode */
 221         LMAI_REMOTE_PARENT      = 0x00000004, /* the parent of the object
 222                                                  is on the remote MDT */
 223         LMAI_STRIPED            = 0x00000008, /* striped directory inode */
 224         LMAI_ORPHAN             = 0x00000010, /* inode is orphan */
 225         LMA_INCOMPAT_SUPP       = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
 226                                    LMAI_STRIPED | LMAI_ORPHAN)
 227 };
 228
 229
 230 /**
 231  * Following struct for object attributes, that will be kept inode's EA.
 232  * Introduced in 2.0 release (please see b15993, for details)
 233  * Added to all objects since Lustre 2.4 as contains self FID
 234  */
 235 struct lustre_mdt_attrs {
 236         /**
 237          * Bitfield for supported data in this structure. From enum lma_compat.
 238          * lma_self_fid and lma_flags are always available.
 239          */
 240         __u32   lma_compat;
 241         /**
 242          * Per-file incompat feature list. Lustre version should support all
 243          * flags set in this field. The supported feature mask is available in
 244          * LMA_INCOMPAT_SUPP.
 245          */
 246         __u32   lma_incompat;
 247         /** FID of this inode */
 248         struct lu_fid  lma_self_fid;
 249 };
 250
 251 struct lustre_ost_attrs {
 252         /* Use lustre_mdt_attrs directly for now, need a common header
 253          * structure if want to change lustre_mdt_attrs in future. */
 254         struct lustre_mdt_attrs loa_lma;
 255
 256         /* Below five elements are for OST-object's PFID EA, the
 257          * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
 258          * and the stripe_index (low 16 bits), the size should not exceed
 259          * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
 260          * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
 261          * are valid; if the flag LMAC_COMP_INFO is set, then the next three
 262          * loa_comp_* elements are valid. */
 263         struct lu_fid   loa_parent_fid;
 264         __u32           loa_stripe_size;
 265         __u32           loa_comp_id;
 266         __u64           loa_comp_start;
 267         __u64           loa_comp_end;
 268 };
 269
 270 /**
 271  * Prior to 2.4, the LMA structure also included SOM attributes which has since
 272  * been moved to a dedicated xattr
 273  * lma_flags was also removed because of lma_compat/incompat fields.
 274  */
 275 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
 276
 277 /**
 278  * OST object IDentifier.
 279  */
 280 struct ost_id {
 281         union {
 282                 struct {
 283                         __u64   oi_id;
 284                         __u64   oi_seq;
 285                 } oi;
 286                 struct lu_fid oi_fid;
 287         };
 288 };
 289
 290 #define DOSTID "%#llx:%llu"
 291 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
 292                    ((unsigned long long)ostid_id(oi))
 293
 294 struct ll_futimes_3 {
 295         __u64 lfu_atime_sec;
 296         __u64 lfu_atime_nsec;
 297         __u64 lfu_mtime_sec;
 298         __u64 lfu_mtime_nsec;
 299         __u64 lfu_ctime_sec;
 300         __u64 lfu_ctime_nsec;
 301 };
 302
 303 /*
 304  * The ioctl naming rules:
 305  * LL_*     - works on the currently opened filehandle instead of parent dir
 306  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 307  * *_MDC_*  - gets/sets data related to MDC
 308  * *_LOV_*  - gets/sets data related to OSC/LOV
 309  * *FILE*   - called on parent dir and passes in a filename
 310  * *STRIPE* - set/get lov_user_md
 311  * *INFO    - set/get lov_user_mds_data
 312  */
 313 /*      lustre_ioctl.h                  101-150 */
 314 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 315 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 316 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 317 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 318 #define LL_IOC_LOV_SETSTRIPE_NEW        _IOWR('f', 154, struct lov_user_md)
 319 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 320 #define LL_IOC_LOV_GETSTRIPE_NEW        _IOR('f', 155, struct lov_user_md)
 321 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 322 /*      LL_IOC_RECREATE_OBJ             157 obsolete */
 323 /*      LL_IOC_RECREATE_FID             157 obsolete */
 324 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 325 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 326 /*      LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
 327 /*      LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
 328 /*      LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
 329 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 330 /*      IOC_LOV_GETINFO                 165 obsolete */
 331 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 332 /*      LL_IOC_RMTACL                   167 obsolete */
 333 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 334 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 335 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 336 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
 337 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 338 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 339 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 340 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 341 #define LL_IOC_FUTIMES_3                _IOWR('f', 176, struct ll_futimes_3)
 342 /*      lustre_ioctl.h                  177-210 */
 343 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
 344 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
 345 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
 346 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
 347 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
 348 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
 349 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
 350 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
 351 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
 352                                                 struct lustre_swap_layouts)
 353 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
 354                                                 struct hsm_current_action)
 355 /*      lustre_ioctl.h                  221-232 */
 356 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
 357 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
 358 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
 359 #define LL_IOC_SET_LEASE                _IOWR('f', 243, long)
 360 #define LL_IOC_GET_LEASE                _IO('f', 244)
 361 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
 362 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
 363 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
 364 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
 365 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
 366 #define LL_IOC_LADVISE                  _IOR('f', 250, struct llapi_lu_ladvise)
 367
 368 #ifndef FS_IOC_FSGETXATTR
 369 /*
 370  * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
 371 */
 372 struct fsxattr {
 373         __u32           fsx_xflags;     /* xflags field value (get/set) */
 374         __u32           fsx_extsize;    /* extsize field value (get/set)*/
 375         __u32           fsx_nextents;   /* nextents field value (get)   */
 376         __u32           fsx_projid;     /* project identifier (get/set) */
 377         unsigned char   fsx_pad[12];
 378 };
 379 #define FS_IOC_FSGETXATTR               _IOR('X', 31, struct fsxattr)
 380 #define FS_IOC_FSSETXATTR               _IOW('X', 32, struct fsxattr)
 381 #endif
 382 #define LL_IOC_FSGETXATTR               FS_IOC_FSGETXATTR
 383 #define LL_IOC_FSSETXATTR               FS_IOC_FSSETXATTR
 384
 385
 386 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
 387 enum ll_lease_type {
 388         LL_LEASE_RDLCK  = 0x1,
 389         LL_LEASE_WRLCK  = 0x2,
 390         LL_LEASE_UNLCK  = 0x4,
 391 };
 392
 393 #define LL_STATFS_LMV           1
 394 #define LL_STATFS_LOV           2
 395 #define LL_STATFS_NODELAY       4
 396
 397 #define IOC_MDC_TYPE            'i'
 398 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 399 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 400 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 401 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 402
 403 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 404
 405 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
 406  * files, but are unlikely to be used in practice and are not harmful if
 407  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
 408  * devices and are safe for use on new files. See LU-4209. */
 409 /* To be compatible with old statically linked binary we keep the check for
 410  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
 411 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
 412 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
 413 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
 414                                          O_LOV_DELAY_CREATE_MASK)
 415
 416 #define LL_FILE_IGNORE_LOCK     0x00000001
 417 #define LL_FILE_GROUP_LOCKED    0x00000002
 418 #define LL_FILE_READAHEA        0x00000004
 419 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 420 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 421
 422 #define LOV_USER_MAGIC_V1       0x0BD10BD0
 423 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
 424 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
 425 #define LOV_USER_MAGIC_V3       0x0BD30BD0
 426 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
 427 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
 428 #define LOV_USER_MAGIC_COMP_V1  0x0BD60BD0
 429
 430 #define LMV_USER_MAGIC    0x0CD30CD0    /*default lmv magic*/
 431
 432 #define LOV_PATTERN_NONE        0x000
 433 #define LOV_PATTERN_RAID0       0x001
 434 #define LOV_PATTERN_RAID1       0x002
 435 #define LOV_PATTERN_MDT         0x100
 436 #define LOV_PATTERN_CMOBD       0x200
 437
 438 #define LOV_PATTERN_F_MASK      0xffff0000
 439 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
 440 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
 441 #define LOV_PATTERN_DEFAULT     0xffffffff
 442
 443 static inline bool lov_pattern_supported(__u32 pattern)
 444 {
 445         return pattern == LOV_PATTERN_RAID0 ||
 446                pattern == LOV_PATTERN_MDT ||
 447                pattern == (LOV_PATTERN_RAID0 | LOV_PATTERN_F_RELEASED);
 448 }
 449
 450 #define LOV_MAXPOOLNAME 15
 451 #define LOV_POOLNAMEF "%.15s"
 452
 453 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 454 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 455 #define LOV_MAX_STRIPE_COUNT_OLD 160
 456 /* This calculation is crafted so that input of 4096 will result in 160
 457  * which in turn is equal to old maximal stripe count.
 458  * XXX: In fact this is too simpified for now, what it also need is to get
 459  * ea_type argument to clearly know how much space each stripe consumes.
 460  *
 461  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 462  * allocation that is sufficient for the current generation of systems.
 463  *
 464  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 465 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 466 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 467 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 468
 469 #define XATTR_LUSTRE_PREFIX     "lustre."
 470 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 471
 472 #define lov_user_ost_data lov_user_ost_data_v1
 473 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 474         struct ost_id l_ost_oi;   /* OST object ID */
 475         __u32 l_ost_gen;          /* generation of this OST index */
 476         __u32 l_ost_idx;          /* OST index in LOV */
 477 } __attribute__((packed));
 478
 479 #define lov_user_md lov_user_md_v1
 480 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 481         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 482         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 483         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 484         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 485         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 486         union {
 487                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 488                                            * lmm_objects, use when writing */
 489                 __u16 lmm_layout_gen;     /* layout generation number
 490                                            * used when reading */
 491         };
 492         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 493 } __attribute__((packed,  __may_alias__));
 494
 495 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 496         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 497         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 498         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 499         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 500         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 501         union {
 502                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 503                                            * lmm_objects, use when writing */
 504                 __u16 lmm_layout_gen;     /* layout generation number
 505                                            * used when reading */
 506         };
 507         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 508         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 509 } __attribute__((packed));
 510
 511 struct lu_extent {
 512         __u64   e_start;
 513         __u64   e_end;
 514 };
 515
 516 #define DEXT "[ %#llx , %#llx )"
 517 #define PEXT(ext) (ext)->e_start, (ext)->e_end
 518
 519 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
 520                                            struct lu_extent *e2)
 521 {
 522         return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
 523 }
 524
 525 static inline bool lu_extent_is_whole(struct lu_extent *e)
 526 {
 527         return e->e_start == 0 && e->e_end == LUSTRE_EOF;
 528 }
 529
 530 enum lov_comp_md_entry_flags {
 531         LCME_FL_PRIMARY = 0x00000001,   /* Not used */
 532         LCME_FL_STALE   = 0x00000002,   /* Not used */
 533         LCME_FL_OFFLINE = 0x00000004,   /* Not used */
 534         LCME_FL_PREFERRED = 0x00000008, /* Not used */
 535         LCME_FL_INIT    = 0x00000010,   /* instantiated */
 536         LCME_FL_NEG     = 0x80000000    /* used to indicate a negative flag,
 537                                            won't be stored on disk */
 538 };
 539
 540 #define LCME_KNOWN_FLAGS        (LCME_FL_NEG | LCME_FL_INIT)
 541
 542 /* lcme_id can be specified as certain flags, and the the first
 543  * bit of lcme_id is used to indicate that the ID is representing
 544  * certain LCME_FL_* but not a real ID. Which implies we can have
 545  * at most 31 flags (see LCME_FL_XXX). */
 546 enum lcme_id {
 547         LCME_ID_INVAL   = 0x0,
 548         LCME_ID_MAX     = 0x7FFFFFFF,
 549         LCME_ID_ALL     = 0xFFFFFFFF,
 550         LCME_ID_NOT_ID  = LCME_FL_NEG
 551 };
 552
 553 #define LCME_ID_MASK    LCME_ID_MAX
 554
 555 struct lov_comp_md_entry_v1 {
 556         __u32                   lcme_id;        /* unique id of component */
 557         __u32                   lcme_flags;     /* LCME_FL_XXX */
 558         struct lu_extent        lcme_extent;    /* file extent for component */
 559         __u32                   lcme_offset;    /* offset of component blob,
 560                                                    start from lov_comp_md_v1 */
 561         __u32                   lcme_size;      /* size of component blob */
 562         __u64                   lcme_padding[2];
 563 } __attribute__((packed));
 564
 565 #define SEQ_ID_MAX              0x0000FFFF
 566 #define SEQ_ID_MASK             SEQ_ID_MAX
 567 /* bit 30:16 of lcme_id is used to store mirror id */
 568 #define MIRROR_ID_MASK          0x7FFF0000
 569 #define MIRROR_ID_SHIFT         16
 570
 571 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
 572 {
 573         return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
 574 }
 575
 576 static inline __u16 mirror_id_of(__u32 id)
 577 {
 578         return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
 579 }
 580
 581 /**
 582  * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
 583  */
 584 enum lov_comp_md_flags {
 585         /* the least 2 bits are used by FLR to record file state */
 586         LCM_FL_NOT_FLR          = 0,
 587         LCM_FL_RDONLY           = 1,
 588         LCM_FL_WRITE_PENDING    = 2,
 589         LCM_FL_SYNC_PENDING     = 3,
 590         LCM_FL_FLR_MASK         = 0x3,
 591 };
 592
 593 struct lov_comp_md_v1 {
 594         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
 595         __u32   lcm_size;       /* overall size including this struct */
 596         __u32   lcm_layout_gen;
 597         __u16   lcm_flags;
 598         __u16   lcm_entry_count;
 599         /* lcm_mirror_count stores the number of actual mirrors minus 1,
 600          * so that non-flr files will have value 0 meaning 1 mirror. */
 601         __u16   lcm_mirror_count;
 602         __u16   lcm_padding1[3];
 603         __u64   lcm_padding2;
 604         struct lov_comp_md_entry_v1 lcm_entries[0];
 605 } __attribute__((packed));
 606
 607 /*
 608  * Maximum number of mirrors Lustre can support.
 609  */
 610 #define LUSTRE_MIRROR_COUNT_MAX         16
 611
 612 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
 613 {
 614         if (stripes == (__u16)-1)
 615                 stripes = 0;
 616
 617         if (lmm_magic == LOV_USER_MAGIC_V1)
 618                 return sizeof(struct lov_user_md_v1) +
 619                               stripes * sizeof(struct lov_user_ost_data_v1);
 620         return sizeof(struct lov_user_md_v3) +
 621                                 stripes * sizeof(struct lov_user_ost_data_v1);
 622 }
 623
 624 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 625  * use this.  It is unsafe to #define those values in this header as it
 626  * is possible the application has already #included <sys/stat.h>. */
 627 #ifdef HAVE_LOV_USER_MDS_DATA
 628 #define lov_user_mds_data lov_user_mds_data_v1
 629 struct lov_user_mds_data_v1 {
 630         lstat_t lmd_st;                 /* MDS stat struct */
 631         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 632 } __attribute__((packed));
 633
 634 struct lov_user_mds_data_v3 {
 635         lstat_t lmd_st;                 /* MDS stat struct */
 636         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 637 } __attribute__((packed));
 638 #endif
 639
 640 struct lmv_user_mds_data {
 641         struct lu_fid   lum_fid;
 642         __u32           lum_padding;
 643         __u32           lum_mds;
 644 };
 645
 646 enum lmv_hash_type {
 647         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
 648         LMV_HASH_TYPE_ALL_CHARS = 1,
 649         LMV_HASH_TYPE_FNV_1A_64 = 2,
 650         LMV_HASH_TYPE_MAX,
 651 };
 652
 653 #define LMV_HASH_NAME_ALL_CHARS "all_char"
 654 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
 655
 656 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
 657
 658 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
 659  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
 660 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 661 #define lmv_user_md lmv_user_md_v1
 662 struct lmv_user_md_v1 {
 663         __u32   lum_magic;       /* must be the first field */
 664         __u32   lum_stripe_count;  /* dirstripe count */
 665         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
 666         __u32   lum_hash_type;     /* Dir stripe policy */
 667         __u32   lum_type;         /* LMV type: default or normal */
 668         __u32   lum_padding1;
 669         __u32   lum_padding2;
 670         __u32   lum_padding3;
 671         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
 672         struct  lmv_user_mds_data  lum_objects[0];
 673 } __attribute__((packed));
 674
 675 static inline int lmv_user_md_size(int stripes, int lmm_magic)
 676 {
 677         return sizeof(struct lmv_user_md) +
 678                       stripes * sizeof(struct lmv_user_mds_data);
 679 }
 680
 681 struct ll_recreate_obj {
 682         __u64 lrc_id;
 683         __u32 lrc_ost_idx;
 684 };
 685
 686 struct ll_fid {
 687         __u64 id;         /* holds object id */
 688         __u32 generation; /* holds object generation */
 689         __u32 f_type;     /* holds object type or stripe idx when passing it to
 690                            * OST for saving into EA. */
 691 };
 692
 693 #define UUID_MAX        40
 694 struct obd_uuid {
 695         char uuid[UUID_MAX];
 696 };
 697
 698 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
 699                                    const struct obd_uuid *u2)
 700 {
 701         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 702 }
 703
 704 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 705 {
 706         return uuid->uuid[0] == '\0';
 707 }
 708
 709 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 710 {
 711         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 712         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 713 }
 714
 715 /* For printf's only, make sure uuid is terminated */
 716 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
 717 {
 718         if (uuid == NULL)
 719                 return NULL;
 720
 721         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 722                 /* Obviously not safe, but for printfs, no real harm done...
 723                    we're always null-terminated, even in a race. */
 724                 static char temp[sizeof(*uuid)];
 725                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 726                 temp[sizeof(*uuid) - 1] = '\0';
 727                 return temp;
 728         }
 729         return (char *)(uuid->uuid);
 730 }
 731
 732 #define LUSTRE_MAXFSNAME 8
 733
 734 /* Extract fsname from uuid (or target name) of a target
 735    e.g. (myfs-OST0007_UUID -> myfs)
 736    see also deuuidify. */
 737 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 738 {
 739         char *p;
 740
 741         strncpy(buf, uuid, buflen - 1);
 742         buf[buflen - 1] = '\0';
 743         p = strrchr(buf, '-');
 744         if (p != NULL)
 745                 *p = '\0';
 746 }
 747
 748 /* printf display format for Lustre FIDs
 749  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
 750 #define FID_NOBRACE_LEN 40
 751 #define FID_LEN (FID_NOBRACE_LEN + 2)
 752 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
 753 #define DFID "["DFID_NOBRACE"]"
 754 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
 755
 756 /* scanf input parse format for fids in DFID_NOBRACE format
 757  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
 758  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
 759 #define SFID "0x%llx:0x%x:0x%x"
 760 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
 761
 762 /********* Quotas **********/
 763
 764 #define LUSTRE_QUOTABLOCK_BITS 10
 765 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
 766
 767 static inline __u64 lustre_stoqb(size_t space)
 768 {
 769         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
 770 }
 771
 772 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
 773 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
 774 #define Q_GETOINFO      0x800102 /* get obd quota info */
 775 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
 776 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
 777
 778 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 779 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
 780 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
 781 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 782 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 783 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 784 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 785 /* lustre-specific control commands */
 786 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
 787 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
 788
 789 #define ALLQUOTA 255       /* set all quota */
 790 static inline char *qtype_name(int qtype)
 791 {
 792         switch (qtype) {
 793         case USRQUOTA:
 794                 return "usr";
 795         case GRPQUOTA:
 796                 return "grp";
 797         case PRJQUOTA:
 798                 return "prj";
 799         }
 800         return "unknown";
 801 }
 802
 803 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 804
 805 /* permission */
 806 #define N_PERMS_MAX      64
 807
 808 struct perm_downcall_data {
 809         __u64 pdd_nid;
 810         __u32 pdd_perm;
 811         __u32 pdd_padding;
 812 };
 813
 814 struct identity_downcall_data {
 815         __u32                            idd_magic;
 816         __u32                            idd_err;
 817         __u32                            idd_uid;
 818         __u32                            idd_gid;
 819         __u32                            idd_nperms;
 820         __u32                            idd_ngroups;
 821         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 822         __u32                            idd_groups[0];
 823 };
 824
 825 #ifdef NEED_QUOTA_DEFS
 826 #ifndef QIF_BLIMITS
 827 #define QIF_BLIMITS     1
 828 #define QIF_SPACE       2
 829 #define QIF_ILIMITS     4
 830 #define QIF_INODES      8
 831 #define QIF_BTIME       16
 832 #define QIF_ITIME       32
 833 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 834 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 835 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 836 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 837 #endif
 838
 839 #endif /* !__KERNEL__ */
 840
 841 /* lustre volatile file support
 842  * file name header: .^L^S^T^R:volatile"
 843  */
 844 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
 845 #define LUSTRE_VOLATILE_HDR_LEN 14
 846
 847 typedef enum lustre_quota_version {
 848         LUSTRE_QUOTA_V2 = 1
 849 } lustre_quota_version_t;
 850
 851 /* XXX: same as if_dqinfo struct in kernel */
 852 struct obd_dqinfo {
 853         __u64 dqi_bgrace;
 854         __u64 dqi_igrace;
 855         __u32 dqi_flags;
 856         __u32 dqi_valid;
 857 };
 858
 859 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 860 struct obd_dqblk {
 861         __u64 dqb_bhardlimit;
 862         __u64 dqb_bsoftlimit;
 863         __u64 dqb_curspace;
 864         __u64 dqb_ihardlimit;
 865         __u64 dqb_isoftlimit;
 866         __u64 dqb_curinodes;
 867         __u64 dqb_btime;
 868         __u64 dqb_itime;
 869         __u32 dqb_valid;
 870         __u32 dqb_padding;
 871 };
 872
 873 enum {
 874         QC_GENERAL      = 0,
 875         QC_MDTIDX       = 1,
 876         QC_OSTIDX       = 2,
 877         QC_UUID         = 3
 878 };
 879
 880 struct if_quotactl {
 881         __u32                   qc_cmd;
 882         __u32                   qc_type;
 883         __u32                   qc_id;
 884         __u32                   qc_stat;
 885         __u32                   qc_valid;
 886         __u32                   qc_idx;
 887         struct obd_dqinfo       qc_dqinfo;
 888         struct obd_dqblk        qc_dqblk;
 889         char                    obd_type[16];
 890         struct obd_uuid         obd_uuid;
 891 };
 892
 893 /* swap layout flags */
 894 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
 895 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
 896 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
 897 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
 898 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
 899 #define MERGE_LAYOUTS_CLOSE             (1 << 5)
 900 #define INTENT_LAYOUTS_CLOSE    (SWAP_LAYOUTS_CLOSE | MERGE_LAYOUTS_CLOSE)
 901
 902 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
 903 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
 904 struct lustre_swap_layouts {
 905         __u64   sl_flags;
 906         __u32   sl_fd;
 907         __u32   sl_gid;
 908         __u64   sl_dv1;
 909         __u64   sl_dv2;
 910 };
 911
 912
 913 /********* Changelogs **********/
 914 /** Changelog record types */
 915 enum changelog_rec_type {
 916         CL_MARK     = 0,
 917         CL_CREATE   = 1,  /* namespace */
 918         CL_MKDIR    = 2,  /* namespace */
 919         CL_HARDLINK = 3,  /* namespace */
 920         CL_SOFTLINK = 4,  /* namespace */
 921         CL_MKNOD    = 5,  /* namespace */
 922         CL_UNLINK   = 6,  /* namespace */
 923         CL_RMDIR    = 7,  /* namespace */
 924         CL_RENAME   = 8,  /* namespace */
 925         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
 926         CL_OPEN     = 10, /* not currently used */
 927         CL_CLOSE    = 11, /* may be written to log only with mtime change */
 928         CL_LAYOUT   = 12, /* file layout/striping modified */
 929         CL_TRUNC    = 13,
 930         CL_SETATTR  = 14,
 931         CL_XATTR    = 15,
 932         CL_HSM      = 16, /* HSM specific events, see flags */
 933         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
 934         CL_CTIME    = 18,
 935         CL_ATIME    = 19,
 936         CL_MIGRATE  = 20,
 937         CL_LAST
 938 };
 939
 940 static inline const char *changelog_type2str(int type) {
 941         static const char *changelog_str[] = {
 942                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
 943                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
 944                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT"
 945         };
 946
 947         if (type >= 0 && type < CL_LAST)
 948                 return changelog_str[type];
 949         return NULL;
 950 }
 951
 952 /* per-record flags */
 953 #define CLF_FLAGSHIFT   12
 954 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
 955 #define CLF_VERMASK     (~CLF_FLAGMASK)
 956 enum changelog_rec_flags {
 957         CLF_VERSION     = 0x1000,
 958         CLF_RENAME      = 0x2000,
 959         CLF_JOBID       = 0x4000,
 960         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID
 961 };
 962
 963
 964 /* Anything under the flagmask may be per-type (if desired) */
 965 /* Flags for unlink */
 966 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
 967 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
 968                                      /* HSM cleaning needed */
 969 /* Flags for rename */
 970 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
 971                                         * of target */
 972 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
 973                                         * has an archive in backend */
 974
 975 /* Flags for HSM */
 976 /* 12b used (from high weight to low weight):
 977  * 2b for flags
 978  * 3b for event
 979  * 7b for error code
 980  */
 981 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
 982 #define CLF_HSM_ERR_H        6
 983 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
 984 #define CLF_HSM_EVENT_H      9
 985 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
 986 #define CLF_HSM_FLAG_H      11
 987 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
 988 #define CLF_HSM_SPARE_H     15
 989 #define CLF_HSM_LAST        15
 990
 991 /* Remove bits higher than _h, then extract the value
 992  * between _h and _l by shifting lower weigth to bit 0. */
 993 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
 994                                    >> (CLF_HSM_LAST - _h + _l))
 995
 996 #define CLF_HSM_SUCCESS      0x00
 997 #define CLF_HSM_MAXERROR     0x7E
 998 #define CLF_HSM_ERROVERFLOW  0x7F
 999
1000 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
1001
1002 /* 3 bits field => 8 values allowed */
1003 enum hsm_event {
1004         HE_ARCHIVE      = 0,
1005         HE_RESTORE      = 1,
1006         HE_CANCEL       = 2,
1007         HE_RELEASE      = 3,
1008         HE_REMOVE       = 4,
1009         HE_STATE        = 5,
1010         HE_SPARE1       = 6,
1011         HE_SPARE2       = 7,
1012 };
1013
1014 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1015 {
1016         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1017                                             CLF_HSM_EVENT_L);
1018 }
1019
1020 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
1021 {
1022         *flags |= (he << CLF_HSM_EVENT_L);
1023 }
1024
1025 static inline __u16 hsm_get_cl_flags(int flags)
1026 {
1027         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1028 }
1029
1030 static inline void hsm_set_cl_flags(int *flags, int bits)
1031 {
1032         *flags |= (bits << CLF_HSM_FLAG_L);
1033 }
1034
1035 static inline int hsm_get_cl_error(int flags)
1036 {
1037         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1038 }
1039
1040 static inline void hsm_set_cl_error(int *flags, int error)
1041 {
1042         *flags |= (error << CLF_HSM_ERR_L);
1043 }
1044
1045 enum changelog_send_flag {
1046         /* Not yet implemented */
1047         CHANGELOG_FLAG_FOLLOW   = 0x01,
1048         /* Blocking IO makes sense in case of slow user parsing of the records,
1049          * but it also prevents us from cleaning up if the records are not
1050          * consumed. */
1051         CHANGELOG_FLAG_BLOCK    = 0x02,
1052         /* Pack jobid into the changelog records if available. */
1053         CHANGELOG_FLAG_JOBID    = 0x04,
1054 };
1055
1056 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
1057                                   changelog_rec_offset(CLF_SUPPORTED))
1058
1059 /* 31 usable bytes string + null terminator. */
1060 #define LUSTRE_JOBID_SIZE       32
1061
1062 /* This is the minimal changelog record. It can contain extensions
1063  * such as rename fields or process jobid. Its exact content is described
1064  * by the cr_flags.
1065  *
1066  * Extensions are packed in the same order as their corresponding flags.
1067  */
1068 struct changelog_rec {
1069         __u16                   cr_namelen;
1070         __u16                   cr_flags; /**< \a changelog_rec_flags */
1071         __u32                   cr_type;  /**< \a changelog_rec_type */
1072         __u64                   cr_index; /**< changelog record number */
1073         __u64                   cr_prev;  /**< last index for this target fid */
1074         __u64                   cr_time;
1075         union {
1076                 lustre_fid      cr_tfid;        /**< target fid */
1077                 __u32           cr_markerflags; /**< CL_MARK flags */
1078         };
1079         lustre_fid              cr_pfid;        /**< parent fid */
1080 };
1081
1082 /* Changelog extension for RENAME. */
1083 struct changelog_ext_rename {
1084         lustre_fid              cr_sfid;     /**< source fid, or zero */
1085         lustre_fid              cr_spfid;    /**< source parent fid, or zero */
1086 };
1087
1088 /* Changelog extension to include JOBID. */
1089 struct changelog_ext_jobid {
1090         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
1091 };
1092
1093
1094 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
1095 {
1096         size_t size = sizeof(struct changelog_rec);
1097
1098         if (crf & CLF_RENAME)
1099                 size += sizeof(struct changelog_ext_rename);
1100
1101         if (crf & CLF_JOBID)
1102                 size += sizeof(struct changelog_ext_jobid);
1103
1104         return size;
1105 }
1106
1107 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1108 {
1109         return changelog_rec_offset(rec->cr_flags);
1110 }
1111
1112 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1113 {
1114         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1115 }
1116
1117 static inline
1118 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1119 {
1120         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1121
1122         return (struct changelog_ext_rename *)((char *)rec +
1123                                                changelog_rec_offset(crf));
1124 }
1125
1126 /* The jobid follows the rename extension, if present */
1127 static inline
1128 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1129 {
1130         enum changelog_rec_flags crf = rec->cr_flags &
1131                                         (CLF_VERSION | CLF_RENAME);
1132
1133         return (struct changelog_ext_jobid *)((char *)rec +
1134                                               changelog_rec_offset(crf));
1135 }
1136
1137 /* The name follows the rename and jobid extensions, if present */
1138 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1139 {
1140         return (char *)rec + changelog_rec_offset(rec->cr_flags &
1141                                                   CLF_SUPPORTED);
1142 }
1143
1144 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1145 {
1146         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1147 }
1148
1149 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1150 {
1151         char *cr_name = changelog_rec_name(rec);
1152
1153         return cr_name + strlen(cr_name) + 1;
1154 }
1155
1156 /**
1157  * Remap a record to the desired format as specified by the crf flags.
1158  * The record must be big enough to contain the final remapped version.
1159  * Superfluous extension fields are removed and missing ones are added
1160  * and zeroed. The flags of the record are updated accordingly.
1161  *
1162  * The jobid and rename extensions can be added to a record, to match the
1163  * format an application expects, typically. In this case, the newly added
1164  * fields will be zeroed.
1165  * The Jobid field can be removed, to guarantee compatibility with older
1166  * clients that don't expect this field in the records they process.
1167  *
1168  * The following assumptions are being made:
1169  *   - CLF_RENAME will not be removed
1170  *   - CLF_JOBID will not be added without CLF_RENAME being added too
1171  *
1172  * @param[in,out]  rec         The record to remap.
1173  * @param[in]      crf_wanted  Flags describing the desired extensions.
1174  */
1175 static inline void changelog_remap_rec(struct changelog_rec *rec,
1176                                        enum changelog_rec_flags crf_wanted)
1177 {
1178         char *jid_mov;
1179         char *rnm_mov;
1180
1181         crf_wanted &= CLF_SUPPORTED;
1182
1183         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
1184                 return;
1185
1186         /* First move the variable-length name field */
1187         memmove((char *)rec + changelog_rec_offset(crf_wanted),
1188                 changelog_rec_name(rec), rec->cr_namelen);
1189
1190         /* Locations of jobid and rename extensions in the remapped record */
1191         jid_mov = (char *)rec +
1192                   changelog_rec_offset(crf_wanted & ~CLF_JOBID);
1193         rnm_mov = (char *)rec +
1194                   changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
1195
1196         /* Move the extension fields to the desired positions */
1197         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1198                 memmove(jid_mov, changelog_rec_jobid(rec),
1199                         sizeof(struct changelog_ext_jobid));
1200
1201         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1202                 memmove(rnm_mov, changelog_rec_rename(rec),
1203                         sizeof(struct changelog_ext_rename));
1204
1205         /* Clear newly added fields */
1206         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1207                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1208
1209         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1210                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1211
1212         /* Update the record's flags accordingly */
1213         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1214 }
1215
1216 enum changelog_message_type {
1217         CL_RECORD = 10, /* message is a changelog_rec */
1218         CL_EOF    = 11, /* at end of current changelog */
1219 };
1220
1221 /********* Misc **********/
1222
1223 struct ioc_data_version {
1224         __u64 idv_version;
1225         __u64 idv_flags;     /* See LL_DV_xxx */
1226 };
1227 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
1228 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
1229
1230 #ifndef offsetof
1231 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1232 #endif
1233
1234 #define dot_lustre_name ".lustre"
1235
1236
1237 /********* HSM **********/
1238
1239 /** HSM per-file state
1240  * See HSM_FLAGS below.
1241  */
1242 enum hsm_states {
1243         HS_NONE         = 0x00000000,
1244         HS_EXISTS       = 0x00000001,
1245         HS_DIRTY        = 0x00000002,
1246         HS_RELEASED     = 0x00000004,
1247         HS_ARCHIVED     = 0x00000008,
1248         HS_NORELEASE    = 0x00000010,
1249         HS_NOARCHIVE    = 0x00000020,
1250         HS_LOST         = 0x00000040,
1251 };
1252
1253 /* HSM user-setable flags. */
1254 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1255
1256 /* Other HSM flags. */
1257 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1258
1259 /*
1260  * All HSM-related possible flags that could be applied to a file.
1261  * This should be kept in sync with hsm_states.
1262  */
1263 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1264
1265 /**
1266  * HSM request progress state
1267  */
1268 enum hsm_progress_states {
1269         HPS_WAITING     = 1,
1270         HPS_RUNNING     = 2,
1271         HPS_DONE        = 3,
1272 };
1273 #define HPS_NONE        0
1274
1275 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1276 {
1277         switch  (s) {
1278         case HPS_WAITING:       return "waiting";
1279         case HPS_RUNNING:       return "running";
1280         case HPS_DONE:          return "done";
1281         default:                return "unknown";
1282         }
1283 }
1284
1285 struct hsm_extent {
1286         __u64 offset;
1287         __u64 length;
1288 } __attribute__((packed));
1289
1290 /**
1291  * Current HSM states of a Lustre file.
1292  *
1293  * This structure purpose is to be sent to user-space mainly. It describes the
1294  * current HSM flags and in-progress action.
1295  */
1296 struct hsm_user_state {
1297         /** Current HSM states, from enum hsm_states. */
1298         __u32                   hus_states;
1299         __u32                   hus_archive_id;
1300         /**  The current undergoing action, if there is one */
1301         __u32                   hus_in_progress_state;
1302         __u32                   hus_in_progress_action;
1303         struct hsm_extent       hus_in_progress_location;
1304         char                    hus_extended_info[];
1305 };
1306
1307 struct hsm_state_set_ioc {
1308         struct lu_fid   hssi_fid;
1309         __u64           hssi_setmask;
1310         __u64           hssi_clearmask;
1311 };
1312
1313 /*
1314  * This structure describes the current in-progress action for a file.
1315  * it is retuned to user space and send over the wire
1316  */
1317 struct hsm_current_action {
1318         /**  The current undergoing action, if there is one */
1319         /* state is one of hsm_progress_states */
1320         __u32                   hca_state;
1321         /* action is one of hsm_user_action */
1322         __u32                   hca_action;
1323         struct hsm_extent       hca_location;
1324 };
1325
1326 /***** HSM user requests ******/
1327 /* User-generated (lfs/ioctl) request types */
1328 enum hsm_user_action {
1329         HUA_NONE    =  1, /* no action (noop) */
1330         HUA_ARCHIVE = 10, /* copy to hsm */
1331         HUA_RESTORE = 11, /* prestage */
1332         HUA_RELEASE = 12, /* drop ost objects */
1333         HUA_REMOVE  = 13, /* remove from archive */
1334         HUA_CANCEL  = 14  /* cancel a request */
1335 };
1336
1337 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1338 {
1339         switch  (a) {
1340         case HUA_NONE:    return "NOOP";
1341         case HUA_ARCHIVE: return "ARCHIVE";
1342         case HUA_RESTORE: return "RESTORE";
1343         case HUA_RELEASE: return "RELEASE";
1344         case HUA_REMOVE:  return "REMOVE";
1345         case HUA_CANCEL:  return "CANCEL";
1346         default:          return "UNKNOWN";
1347         }
1348 }
1349
1350 /*
1351  * List of hr_flags (bit field)
1352  */
1353 #define HSM_FORCE_ACTION 0x0001
1354 /* used by CT, cannot be set by user */
1355 #define HSM_GHOST_COPY   0x0002
1356
1357 /**
1358  * Contains all the fixed part of struct hsm_user_request.
1359  *
1360  */
1361 struct hsm_request {
1362         __u32 hr_action;        /* enum hsm_user_action */
1363         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1364         __u64 hr_flags;         /* request flags */
1365         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1366         __u32 hr_data_len;
1367 };
1368
1369 struct hsm_user_item {
1370        lustre_fid        hui_fid;
1371        struct hsm_extent hui_extent;
1372 } __attribute__((packed));
1373
1374 struct hsm_user_request {
1375         struct hsm_request      hur_request;
1376         struct hsm_user_item    hur_user_item[0];
1377         /* extra data blob at end of struct (after all
1378          * hur_user_items), only use helpers to access it
1379          */
1380 } __attribute__((packed));
1381
1382 /** Return pointer to data field in a hsm user request */
1383 static inline void *hur_data(struct hsm_user_request *hur)
1384 {
1385         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1386 }
1387
1388 /**
1389  * Compute the current length of the provided hsm_user_request.  This returns -1
1390  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1391  *
1392  * return -1 on bounds check error.
1393  */
1394 static inline ssize_t hur_len(struct hsm_user_request *hur)
1395 {
1396         __u64   size;
1397
1398         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1399         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1400                 (__u64)hur->hur_request.hr_itemcount *
1401                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1402
1403         if (size != (ssize_t)size)
1404                 return -1;
1405
1406         return size;
1407 }
1408
1409 /****** HSM RPCs to copytool *****/
1410 /* Message types the copytool may receive */
1411 enum hsm_message_type {
1412         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1413 };
1414
1415 /* Actions the copytool may be instructed to take for a given action_item */
1416 enum hsm_copytool_action {
1417         HSMA_NONE    = 10, /* no action */
1418         HSMA_ARCHIVE = 20, /* arbitrary offset */
1419         HSMA_RESTORE = 21,
1420         HSMA_REMOVE  = 22,
1421         HSMA_CANCEL  = 23
1422 };
1423
1424 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1425 {
1426         switch  (a) {
1427         case HSMA_NONE:    return "NOOP";
1428         case HSMA_ARCHIVE: return "ARCHIVE";
1429         case HSMA_RESTORE: return "RESTORE";
1430         case HSMA_REMOVE:  return "REMOVE";
1431         case HSMA_CANCEL:  return "CANCEL";
1432         default:           return "UNKNOWN";
1433         }
1434 }
1435
1436 /* Copytool item action description */
1437 struct hsm_action_item {
1438         __u32      hai_len;     /* valid size of this struct */
1439         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1440         lustre_fid hai_fid;     /* Lustre FID to operate on */
1441         lustre_fid hai_dfid;    /* fid used for data access */
1442         struct hsm_extent hai_extent;  /* byte range to operate on */
1443         __u64      hai_cookie;  /* action cookie from coordinator */
1444         __u64      hai_gid;     /* grouplock id */
1445         char       hai_data[0]; /* variable length */
1446 } __attribute__((packed));
1447
1448 /**
1449  * helper function which print in hexa the first bytes of
1450  * hai opaque field
1451  *
1452  * \param hai [IN]        record to print
1453  * \param buffer [IN,OUT] buffer to write the hex string to
1454  * \param len [IN]        max buffer length
1455  *
1456  * \retval buffer
1457  */
1458 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1459                                         char *buffer, size_t len)
1460 {
1461         int i;
1462         int data_len;
1463         char *ptr;
1464
1465         ptr = buffer;
1466         data_len = hai->hai_len - sizeof(*hai);
1467         for (i = 0; (i < data_len) && (len > 2); i++) {
1468                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1469                 ptr += 2;
1470                 len -= 2;
1471         }
1472
1473         *ptr = '\0';
1474
1475         return buffer;
1476 }
1477
1478 /* Copytool action list */
1479 #define HAL_VERSION 1
1480 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1481 struct hsm_action_list {
1482         __u32 hal_version;
1483         __u32 hal_count;       /* number of hai's to follow */
1484         __u64 hal_compound_id; /* returned by coordinator */
1485         __u64 hal_flags;
1486         __u32 hal_archive_id; /* which archive backend */
1487         __u32 padding1;
1488         char  hal_fsname[0];   /* null-terminated */
1489         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1490            boundaries. See hai_zero */
1491 } __attribute__((packed));
1492
1493 #ifndef HAVE_CFS_SIZE_ROUND
1494 static inline int cfs_size_round (int val)
1495 {
1496         return (val + 7) & (~0x7);
1497 }
1498 #define HAVE_CFS_SIZE_ROUND
1499 #endif
1500
1501 /* Return pointer to first hai in action list */
1502 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1503 {
1504         return (struct hsm_action_item *)(hal->hal_fsname +
1505                                           cfs_size_round(strlen(hal-> \
1506                                                                 hal_fsname)
1507                                                          + 1));
1508 }
1509 /* Return pointer to next hai */
1510 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1511 {
1512         return (struct hsm_action_item *)((char *)hai +
1513                                           cfs_size_round(hai->hai_len));
1514 }
1515
1516 /* Return size of an hsm_action_list */
1517 static inline size_t hal_size(struct hsm_action_list *hal)
1518 {
1519         __u32 i;
1520         size_t sz;
1521         struct hsm_action_item *hai;
1522
1523         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1524         hai = hai_first(hal);
1525         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1526                 sz += cfs_size_round(hai->hai_len);
1527
1528         return sz;
1529 }
1530
1531 /* HSM file import
1532  * describe the attributes to be set on imported file
1533  */
1534 struct hsm_user_import {
1535         __u64           hui_size;
1536         __u64           hui_atime;
1537         __u64           hui_mtime;
1538         __u32           hui_atime_ns;
1539         __u32           hui_mtime_ns;
1540         __u32           hui_uid;
1541         __u32           hui_gid;
1542         __u32           hui_mode;
1543         __u32           hui_archive_id;
1544 };
1545
1546 /* Copytool progress reporting */
1547 #define HP_FLAG_COMPLETED 0x01
1548 #define HP_FLAG_RETRY     0x02
1549
1550 struct hsm_progress {
1551         lustre_fid              hp_fid;
1552         __u64                   hp_cookie;
1553         struct hsm_extent       hp_extent;
1554         __u16                   hp_flags;
1555         __u16                   hp_errval; /* positive val */
1556         __u32                   padding;
1557 };
1558
1559 struct hsm_copy {
1560         __u64                   hc_data_version;
1561         __u16                   hc_flags;
1562         __u16                   hc_errval; /* positive val */
1563         __u32                   padding;
1564         struct hsm_action_item  hc_hai;
1565 };
1566
1567 /* JSON objects */
1568 enum llapi_json_types {
1569         LLAPI_JSON_INTEGER = 1,
1570         LLAPI_JSON_BIGNUM,
1571         LLAPI_JSON_REAL,
1572         LLAPI_JSON_STRING
1573 };
1574
1575 struct llapi_json_item {
1576         char                    *lji_key;
1577         __u32                   lji_type;
1578         union {
1579                 int     lji_integer;
1580                 __u64   lji_u64;
1581                 double  lji_real;
1582                 char    *lji_string;
1583         };
1584         struct llapi_json_item  *lji_next;
1585 };
1586
1587 struct llapi_json_item_list {
1588         int                     ljil_item_count;
1589         struct llapi_json_item  *ljil_items;
1590 };
1591
1592 enum lu_ladvise_type {
1593         LU_LADVISE_INVALID      = 0,
1594         LU_LADVISE_WILLREAD     = 1,
1595         LU_LADVISE_DONTNEED     = 2,
1596         LU_LADVISE_LOCKNOEXPAND = 3,
1597         LU_LADVISE_LOCKAHEAD    = 4,
1598         LU_LADVISE_MAX
1599 };
1600
1601 #define LU_LADVISE_NAMES {                                              \
1602         [LU_LADVISE_WILLREAD]           = "willread",                   \
1603         [LU_LADVISE_DONTNEED]           = "dontneed",                   \
1604         [LU_LADVISE_LOCKNOEXPAND]       = "locknoexpand",               \
1605         [LU_LADVISE_LOCKAHEAD]          = "lockahead",                  \
1606 }
1607
1608 /* This is the userspace argument for ladvise.  It is currently the same as
1609  * what goes on the wire (struct lu_ladvise), but is defined separately as we
1610  * may need info which is only used locally. */
1611 struct llapi_lu_ladvise {
1612         __u16 lla_advice;       /* advice type */
1613         __u16 lla_value1;       /* values for different advice types */
1614         __u32 lla_value2;
1615         __u64 lla_start;        /* first byte of extent for advice */
1616         __u64 lla_end;          /* last byte of extent for advice */
1617         __u32 lla_value3;
1618         __u32 lla_value4;
1619 };
1620
1621 enum ladvise_flag {
1622         LF_ASYNC        = 0x00000001,
1623         LF_UNSET        = 0x00000002,
1624 };
1625
1626 #define LADVISE_MAGIC 0x1ADF1CE0
1627 /* Masks of valid flags for each advice */
1628 #define LF_LOCKNOEXPAND_MASK LF_UNSET
1629 /* Flags valid for all advices not explicitly specified */
1630 #define LF_DEFAULT_MASK LF_ASYNC
1631 /* All flags */
1632 #define LF_MASK (LF_ASYNC | LF_UNSET)
1633
1634 #define lla_lockahead_mode   lla_value1
1635 #define lla_peradvice_flags    lla_value2
1636 #define lla_lockahead_result lla_value3
1637
1638 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
1639  * is used on the wire.  It is defined separately as we may need info which is
1640  * only used locally. */
1641 struct llapi_ladvise_hdr {
1642         __u32                   lah_magic;      /* LADVISE_MAGIC */
1643         __u32                   lah_count;      /* number of advices */
1644         __u64                   lah_flags;      /* from enum ladvise_flag */
1645         __u32                   lah_value1;     /* unused */
1646         __u32                   lah_value2;     /* unused */
1647         __u64                   lah_value3;     /* unused */
1648         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
1649 };
1650
1651 #define LAH_COUNT_MAX   (1024)
1652
1653 /* Shared key */
1654 enum sk_crypt_alg {
1655         SK_CRYPT_INVALID        = -1,
1656         SK_CRYPT_EMPTY          = 0,
1657         SK_CRYPT_AES256_CTR     = 1,
1658         SK_CRYPT_MAX            = 2,
1659 };
1660
1661 enum sk_hmac_alg {
1662         SK_HMAC_INVALID = -1,
1663         SK_HMAC_EMPTY   = 0,
1664         SK_HMAC_SHA256  = 1,
1665         SK_HMAC_SHA512  = 2,
1666         SK_HMAC_MAX     = 3,
1667 };
1668
1669 struct sk_crypt_type {
1670         char    *sct_name;
1671         size_t   sct_bytes;
1672 };
1673
1674 struct sk_hmac_type {
1675         char    *sht_name;
1676         size_t   sht_bytes;
1677 };
1678
1679 enum lock_mode_user {
1680         MODE_READ_USER = 1,
1681         MODE_WRITE_USER,
1682         MODE_MAX_USER,
1683 };
1684
1685 #define LOCK_MODE_NAMES { \
1686         [MODE_READ_USER]  = "READ",\
1687         [MODE_WRITE_USER] = "WRITE"\
1688 }
1689
1690 enum lockahead_results {
1691         LLA_RESULT_SENT = 0,
1692         LLA_RESULT_DIFFERENT,
1693         LLA_RESULT_SAME,
1694 };
1695
1696 /** @} lustreuser */
1697
1698 #endif /* _LUSTRE_USER_H */