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