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