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