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, 2017, 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/kernel.h>
  46 #include <linux/types.h>
  47
  48 #ifdef __KERNEL__
  49 # include <linux/fs.h>
  50 # include <linux/quota.h>
  51 # include <linux/string.h> /* snprintf() */
  52 # include <linux/version.h>
  53 # include <uapi/linux/lustre/lustre_fiemap.h>
  54 #else /* !__KERNEL__ */
  55 # include <limits.h>
  56 # include <stdbool.h>
  57 # include <stdio.h> /* snprintf() */
  58 # include <string.h>
  59 # define NEED_QUOTA_DEFS
  60 /* # include <sys/quota.h> - this causes complaints about caddr_t */
  61 # include <sys/stat.h>
  62 # include <linux/lustre/lustre_fiemap.h>
  63 #endif /* __KERNEL__ */
  64
  65 /* Handle older distros */
  66 #ifndef __ALIGN_KERNEL
  67 # define __ALIGN_KERNEL(x, a)   __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
  68 # define __ALIGN_KERNEL_MASK(x, mask)   (((x) + (mask)) & ~(mask))
  69 #endif
  70
  71 #if defined(__cplusplus)
  72 extern "C" {
  73 #endif
  74
  75 /*
  76  * This is a temporary solution of adding quota type.
  77  * Should be removed as soon as system header is updated.
  78  */
  79 #undef LL_MAXQUOTAS
  80 #define LL_MAXQUOTAS 3
  81 #undef INITQFNAMES
  82 #define INITQFNAMES { \
  83     "user",     /* USRQUOTA */ \
  84     "group",    /* GRPQUOTA */ \
  85     "project",  /* PRJQUOTA */ \
  86     "undefined", \
  87 };
  88 #ifndef USRQUOTA
  89 #define USRQUOTA 0
  90 #endif
  91 #ifndef GRPQUOTA
  92 #define GRPQUOTA 1
  93 #endif
  94 #ifndef PRJQUOTA
  95 #define PRJQUOTA 2
  96 #endif
  97
  98 /*
  99  * We need to always use 64bit version because the structure
 100  * is shared across entire cluster where 32bit and 64bit machines
 101  * are co-existing.
 102  */
 103 #if __BITS_PER_LONG != 64 || defined(__ARCH_WANT_STAT64)
 104 typedef struct stat64   lstat_t;
 105 #define lstat_f  lstat64
 106 #define fstat_f         fstat64
 107 #define fstatat_f       fstatat64
 108 #else
 109 typedef struct stat     lstat_t;
 110 #define lstat_f  lstat
 111 #define fstat_f         fstat
 112 #define fstatat_f       fstatat
 113 #endif
 114
 115 #define HAVE_LOV_USER_MDS_DATA
 116
 117 #define LUSTRE_EOF 0xffffffffffffffffULL
 118
 119 /* for statfs() */
 120 #define LL_SUPER_MAGIC 0x0BD00BD0
 121
 122 #define FSFILT_IOC_GETVERSION           _IOR('f', 3, long)
 123
 124 /* FIEMAP flags supported by Lustre */
 125 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
 126
 127 enum obd_statfs_state {
 128         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
 129         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
 130         OS_STATE_NOPRECREATE    = 0x00000004, /**< no object precreation */
 131         OS_STATE_ENOSPC         = 0x00000020, /**< not enough free space */
 132         OS_STATE_ENOINO         = 0x00000040, /**< not enough inodes */
 133         OS_STATE_SUM            = 0x00000100, /**< aggregated for all tagrets */
 134 };
 135
 136 /** filesystem statistics/attributes for target device */
 137 struct obd_statfs {
 138         __u64           os_type;        /* EXT4_SUPER_MAGIC, UBERBLOCK_MAGIC */
 139         __u64           os_blocks;      /* total size in #os_bsize blocks */
 140         __u64           os_bfree;       /* number of unused blocks */
 141         __u64           os_bavail;      /* blocks available for allocation */
 142         __u64           os_files;       /* total number of objects */
 143         __u64           os_ffree;       /* # objects that could be created */
 144         __u8            os_fsid[40];    /* identifier for filesystem */
 145         __u32           os_bsize;       /* block size in bytes for os_blocks */
 146         __u32           os_namelen;     /* maximum length of filename in bytes*/
 147         __u64           os_maxbytes;    /* maximum object size in bytes */
 148         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
 149         __u32           os_fprecreated; /* objs available now to the caller */
 150                                         /* used in QoS code to find preferred
 151                                          * OSTs */
 152         __u32           os_granted;     /* space granted for MDS */
 153         __u32           os_spare3;      /* Unused padding fields.  Remember */
 154         __u32           os_spare4;      /* to fix lustre_swab_obd_statfs() */
 155         __u32           os_spare5;
 156         __u32           os_spare6;
 157         __u32           os_spare7;
 158         __u32           os_spare8;
 159         __u32           os_spare9;
 160 };
 161
 162 /**
 163  * File IDentifier.
 164  *
 165  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 166  * FIDs are never reused.
 167  **/
 168 struct lu_fid {
 169        /**
 170         * FID sequence. Sequence is a unit of migration: all files (objects)
 171         * with FIDs from a given sequence are stored on the same server.
 172         * Lustre should support 2^64 objects, so even if each sequence
 173         * has only a single object we can still enumerate 2^64 objects.
 174         **/
 175         __u64 f_seq;
 176         /* FID number within sequence. */
 177         __u32 f_oid;
 178         /**
 179          * FID version, used to distinguish different versions (in the sense
 180          * of snapshots, etc.) of the same file system object. Not currently
 181          * used.
 182          **/
 183         __u32 f_ver;
 184 };
 185
 186 static inline bool fid_is_zero(const struct lu_fid *fid)
 187 {
 188         return fid->f_seq == 0 && fid->f_oid == 0;
 189 }
 190
 191 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
 192  * MDT-object's FID::f_ver, instead it is the OST-object index in its
 193  * parent MDT-object's layout EA. */
 194 #define f_stripe_idx f_ver
 195
 196 struct ost_layout {
 197         __u32   ol_stripe_size;
 198         __u32   ol_stripe_count;
 199         __u64   ol_comp_start;
 200         __u64   ol_comp_end;
 201         __u32   ol_comp_id;
 202 } __attribute__((packed));
 203
 204 /* The filter_fid structure has changed several times over its lifetime.
 205  * For a long time "trusted.fid" held the MDT inode parent FID/IGIF and
 206  * stripe_index and the "self FID" (objid/seq) to be able to recover the
 207  * OST objects in case of corruption.  With the move to 2.4 and OSD-API for
 208  * the OST, the "trusted.lma" xattr was added to the OST objects to store
 209  * the "self FID" to be consistent with the MDT on-disk format, and the
 210  * filter_fid only stored the MDT inode parent FID and stripe index.
 211  *
 212  * In 2.10, the addition of PFL composite layouts required more information
 213  * to be stored into the filter_fid in order to be able to identify which
 214  * component the OST object belonged.  As well, the stripe size may vary
 215  * between components, so it was no longer safe to assume the stripe size
 216  * or stripe_count of a file.  This is also more robust for plain layouts.
 217  *
 218  * For ldiskfs OSTs that were formatted with 256-byte inodes, there is not
 219  * enough space to store both the filter_fid and LMA in the inode, so they
 220  * are packed into struct lustre_ost_attrs on disk in trusted.lma to avoid
 221  * an extra seek for every OST object access.
 222  *
 223  * In 2.11, FLR mirror layouts also need to store the layout version and
 224  * range so that writes to old versions of the layout are not allowed.
 225  * That ensures that mirrored objects are not modified by evicted clients,
 226  * and ensures that the components are correctly marked stale on the MDT.
 227  */
 228 struct filter_fid_18_23 {
 229         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 230         __u64                   ff_objid;
 231         __u64                   ff_seq;
 232 };
 233
 234 struct filter_fid_24_29 {
 235         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 236 };
 237
 238 struct filter_fid_210 {
 239         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 240         struct ost_layout       ff_layout;
 241 };
 242
 243 struct filter_fid {
 244         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 245         struct ost_layout       ff_layout;
 246         __u32                   ff_layout_version;
 247         __u32                   ff_range; /* range of layout version that
 248                                            * write are allowed */
 249 } __attribute__((packed));
 250
 251 /* Userspace should treat lu_fid as opaque, and only use the following methods
 252  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
 253  * here from lustre_idl.h if needed. */
 254 struct lu_fid;
 255
 256 enum lma_compat {
 257         LMAC_HSM         = 0x00000001,
 258 /*      LMAC_SOM         = 0x00000002, obsolete since 2.8.0 */
 259         LMAC_NOT_IN_OI   = 0x00000004, /* the object does NOT need OI mapping */
 260         LMAC_FID_ON_OST  = 0x00000008, /* For OST-object, its OI mapping is
 261                                        * under /O/<seq>/d<x>. */
 262         LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
 263         LMAC_COMP_INFO   = 0x00000020, /* Component info in the LMA EA. */
 264         LMAC_IDX_BACKUP  = 0x00000040, /* Has index backup. */
 265 };
 266
 267 /**
 268  * Masks for all features that should be supported by a Lustre version to
 269  * access a specific file.
 270  * This information is stored in lustre_mdt_attrs::lma_incompat.
 271  */
 272 enum lma_incompat {
 273         LMAI_RELEASED           = 0x00000001, /* file is released */
 274         LMAI_AGENT              = 0x00000002, /* agent inode */
 275         LMAI_REMOTE_PARENT      = 0x00000004, /* the parent of the object
 276                                                  is on the remote MDT */
 277         LMAI_STRIPED            = 0x00000008, /* striped directory inode */
 278         LMAI_ORPHAN             = 0x00000010, /* inode is orphan */
 279         LMA_INCOMPAT_SUPP       = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
 280                                    LMAI_STRIPED | LMAI_ORPHAN)
 281 };
 282
 283
 284 /**
 285  * Following struct for object attributes, that will be kept inode's EA.
 286  * Introduced in 2.0 release (please see b15993, for details)
 287  * Added to all objects since Lustre 2.4 as contains self FID
 288  */
 289 struct lustre_mdt_attrs {
 290         /**
 291          * Bitfield for supported data in this structure. From enum lma_compat.
 292          * lma_self_fid and lma_flags are always available.
 293          */
 294         __u32   lma_compat;
 295         /**
 296          * Per-file incompat feature list. Lustre version should support all
 297          * flags set in this field. The supported feature mask is available in
 298          * LMA_INCOMPAT_SUPP.
 299          */
 300         __u32   lma_incompat;
 301         /** FID of this inode */
 302         struct lu_fid  lma_self_fid;
 303 };
 304
 305 struct lustre_ost_attrs {
 306         /* Use lustre_mdt_attrs directly for now, need a common header
 307          * structure if want to change lustre_mdt_attrs in future. */
 308         struct lustre_mdt_attrs loa_lma;
 309
 310         /* Below five elements are for OST-object's PFID EA, the
 311          * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
 312          * and the stripe_index (low 16 bits), the size should not exceed
 313          * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
 314          * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
 315          * are valid; if the flag LMAC_COMP_INFO is set, then the next three
 316          * loa_comp_* elements are valid. */
 317         struct lu_fid   loa_parent_fid;
 318         __u32           loa_stripe_size;
 319         __u32           loa_comp_id;
 320         __u64           loa_comp_start;
 321         __u64           loa_comp_end;
 322 };
 323
 324 /**
 325  * Prior to 2.4, the LMA structure also included SOM attributes which has since
 326  * been moved to a dedicated xattr
 327  * lma_flags was also removed because of lma_compat/incompat fields.
 328  */
 329 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
 330
 331 enum lustre_som_flags {
 332         /* Unknow or no SoM data, must get size from OSTs. */
 333         SOM_FL_UNKNOWN  = 0x0000,
 334         /* Known strictly correct, FLR or DoM file (SoM guaranteed). */
 335         SOM_FL_STRICT   = 0x0001,
 336         /* Known stale - was right at some point in the past, but it is
 337          * known (or likely) to be incorrect now (e.g. opened for write). */
 338         SOM_FL_STALE    = 0x0002,
 339         /* Approximate, may never have been strictly correct,
 340          * need to sync SOM data to achieve eventual consistency. */
 341         SOM_FL_LAZY     = 0x0004,
 342 };
 343
 344 struct lustre_som_attrs {
 345         __u16   lsa_valid;
 346         __u16   lsa_reserved[3];
 347         __u64   lsa_size;
 348         __u64   lsa_blocks;
 349 };
 350
 351 /**
 352  * OST object IDentifier.
 353  */
 354 struct ost_id {
 355         union {
 356                 struct {
 357                         __u64   oi_id;
 358                         __u64   oi_seq;
 359                 } oi;
 360                 struct lu_fid oi_fid;
 361         };
 362 };
 363
 364 #define DOSTID "%#llx:%llu"
 365 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
 366                    ((unsigned long long)ostid_id(oi))
 367
 368 struct ll_futimes_3 {
 369         __u64 lfu_atime_sec;
 370         __u64 lfu_atime_nsec;
 371         __u64 lfu_mtime_sec;
 372         __u64 lfu_mtime_nsec;
 373         __u64 lfu_ctime_sec;
 374         __u64 lfu_ctime_nsec;
 375 };
 376
 377 /*
 378  * Maximum number of mirrors currently implemented.
 379  */
 380 #define LUSTRE_MIRROR_COUNT_MAX         16
 381
 382 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
 383 enum ll_lease_mode {
 384         LL_LEASE_RDLCK  = 0x01,
 385         LL_LEASE_WRLCK  = 0x02,
 386         LL_LEASE_UNLCK  = 0x04,
 387 };
 388
 389 enum ll_lease_flags {
 390         LL_LEASE_RESYNC         = 0x1,
 391         LL_LEASE_RESYNC_DONE    = 0x2,
 392         LL_LEASE_LAYOUT_MERGE   = 0x4,
 393         LL_LEASE_LAYOUT_SPLIT   = 0x8,
 394 };
 395
 396 #define IOC_IDS_MAX     4096
 397 struct ll_ioc_lease {
 398         __u32           lil_mode;
 399         __u32           lil_flags;
 400         __u32           lil_count;
 401         __u32           lil_ids[0];
 402 };
 403
 404 struct ll_ioc_lease_id {
 405         __u32           lil_mode;
 406         __u32           lil_flags;
 407         __u32           lil_count;
 408         __u16           lil_mirror_id;
 409         __u16           lil_padding1;
 410         __u64           lil_padding2;
 411         __u32           lil_ids[0];
 412 };
 413
 414 /*
 415  * The ioctl naming rules:
 416  * LL_*     - works on the currently opened filehandle instead of parent dir
 417  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 418  * *_MDC_*  - gets/sets data related to MDC
 419  * *_LOV_*  - gets/sets data related to OSC/LOV
 420  * *FILE*   - called on parent dir and passes in a filename
 421  * *STRIPE* - set/get lov_user_md
 422  * *INFO    - set/get lov_user_mds_data
 423  */
 424 /*      lustre_ioctl.h                  101-150 */
 425 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 426 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 427 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 428 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 429 #define LL_IOC_LOV_SETSTRIPE_NEW        _IOWR('f', 154, struct lov_user_md)
 430 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 431 #define LL_IOC_LOV_GETSTRIPE_NEW        _IOR('f', 155, struct lov_user_md)
 432 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 433 /*      LL_IOC_RECREATE_OBJ             157 obsolete */
 434 /*      LL_IOC_RECREATE_FID             157 obsolete */
 435 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 436 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 437 /*      LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
 438 /*      LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
 439 /*      LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
 440 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 441 /*      IOC_LOV_GETINFO                 165 obsolete */
 442 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 443 /*      LL_IOC_RMTACL                   167 obsolete */
 444 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 445 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 446 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 447 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
 448 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 449 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 450 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 451 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 452 #define LL_IOC_FUTIMES_3                _IOWR('f', 176, struct ll_futimes_3)
 453 #define LL_IOC_FLR_SET_MIRROR           _IOW ('f', 177, long)
 454 /*      lustre_ioctl.h                  177-210 */
 455 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
 456 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
 457 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
 458 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
 459 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
 460 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
 461 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
 462 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
 463 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
 464                                                 struct lustre_swap_layouts)
 465 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
 466                                                 struct hsm_current_action)
 467 /*      lustre_ioctl.h                  221-232 */
 468 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
 469 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
 470 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
 471 #define LL_IOC_SET_LEASE                _IOWR('f', 243, struct ll_ioc_lease)
 472 #define LL_IOC_SET_LEASE_OLD            _IOWR('f', 243, long)
 473 #define LL_IOC_GET_LEASE                _IO('f', 244)
 474 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
 475 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
 476 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
 477 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
 478 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
 479 #define LL_IOC_LADVISE                  _IOR('f', 250, struct llapi_lu_ladvise)
 480
 481 #ifndef FS_IOC_FSGETXATTR
 482 /*
 483  * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
 484 */
 485 struct fsxattr {
 486         __u32           fsx_xflags;     /* xflags field value (get/set) */
 487         __u32           fsx_extsize;    /* extsize field value (get/set)*/
 488         __u32           fsx_nextents;   /* nextents field value (get)   */
 489         __u32           fsx_projid;     /* project identifier (get/set) */
 490         unsigned char   fsx_pad[12];
 491 };
 492 #define FS_IOC_FSGETXATTR               _IOR('X', 31, struct fsxattr)
 493 #define FS_IOC_FSSETXATTR               _IOW('X', 32, struct fsxattr)
 494 #endif
 495 #define LL_IOC_FSGETXATTR               FS_IOC_FSGETXATTR
 496 #define LL_IOC_FSSETXATTR               FS_IOC_FSSETXATTR
 497 #ifndef FS_XFLAG_PROJINHERIT
 498 #define FS_XFLAG_PROJINHERIT            0x00000200
 499 #endif
 500
 501
 502 #define LL_STATFS_LMV           1
 503 #define LL_STATFS_LOV           2
 504 #define LL_STATFS_NODELAY       4
 505
 506 #define IOC_MDC_TYPE            'i'
 507 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 508 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 509 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 510 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 511
 512 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 513
 514 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
 515  * files, but are unlikely to be used in practice and are not harmful if
 516  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
 517  * devices and are safe for use on new files. See LU-4209. */
 518 /* To be compatible with old statically linked binary we keep the check for
 519  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
 520 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
 521 #ifndef FASYNC
 522 #define FASYNC                  00020000   /* fcntl, for BSD compatibility */
 523 #endif
 524 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
 525 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
 526                                          O_LOV_DELAY_CREATE_MASK)
 527
 528 #define LL_FILE_IGNORE_LOCK     0x00000001
 529 #define LL_FILE_GROUP_LOCKED    0x00000002
 530 #define LL_FILE_READAHEA        0x00000004
 531 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 532 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 533
 534 #define LOV_USER_MAGIC_V1       0x0BD10BD0
 535 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
 536 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
 537 #define LOV_USER_MAGIC_V3       0x0BD30BD0
 538 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
 539 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
 540 #define LOV_USER_MAGIC_COMP_V1  0x0BD60BD0
 541
 542 #define LMV_USER_MAGIC          0x0CD30CD0    /* default lmv magic */
 543 #define LMV_USER_MAGIC_V0       0x0CD20CD0    /* old default lmv magic*/
 544 #define LMV_USER_MAGIC_SPECIFIC 0x0CD40CD0
 545
 546 #define LOV_PATTERN_NONE        0x000
 547 #define LOV_PATTERN_RAID0       0x001
 548 #define LOV_PATTERN_RAID1       0x002
 549 #define LOV_PATTERN_MDT         0x100
 550 #define LOV_PATTERN_CMOBD       0x200
 551
 552 #define LOV_PATTERN_F_MASK      0xffff0000
 553 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
 554 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
 555 #define LOV_PATTERN_DEFAULT     0xffffffff
 556
 557 static inline bool lov_pattern_supported(__u32 pattern)
 558 {
 559         return (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_RAID0 ||
 560                (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_MDT;
 561 }
 562
 563 #define LOV_MAXPOOLNAME 15
 564 #define LOV_POOLNAMEF "%.15s"
 565
 566 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 567 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 568 #define LOV_MAX_STRIPE_COUNT_OLD 160
 569 /* This calculation is crafted so that input of 4096 will result in 160
 570  * which in turn is equal to old maximal stripe count.
 571  * XXX: In fact this is too simpified for now, what it also need is to get
 572  * ea_type argument to clearly know how much space each stripe consumes.
 573  *
 574  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 575  * allocation that is sufficient for the current generation of systems.
 576  *
 577  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 578 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 579 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 580 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 581
 582 #define XATTR_LUSTRE_PREFIX     "lustre."
 583 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 584
 585 #define lov_user_ost_data lov_user_ost_data_v1
 586 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 587         struct ost_id l_ost_oi;   /* OST object ID */
 588         __u32 l_ost_gen;          /* generation of this OST index */
 589         __u32 l_ost_idx;          /* OST index in LOV */
 590 } __attribute__((packed));
 591
 592 #define lov_user_md lov_user_md_v1
 593 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 594         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 595         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 596         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 597         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 598         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 599         union {
 600                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 601                                            * lmm_objects, use when writing */
 602                 __u16 lmm_layout_gen;     /* layout generation number
 603                                            * used when reading */
 604         };
 605         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 606 } __attribute__((packed,  __may_alias__));
 607
 608 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 609         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 610         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 611         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 612         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 613         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 614         union {
 615                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 616                                            * lmm_objects, use when writing */
 617                 __u16 lmm_layout_gen;     /* layout generation number
 618                                            * used when reading */
 619         };
 620         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 621         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 622 } __attribute__((packed));
 623
 624 struct lu_extent {
 625         __u64   e_start;
 626         __u64   e_end;
 627 };
 628
 629 #define DEXT "[%#llx, %#llx)"
 630 #define PEXT(ext) (ext)->e_start, (ext)->e_end
 631
 632 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
 633                                            struct lu_extent *e2)
 634 {
 635         return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
 636 }
 637
 638 static inline bool lu_extent_is_whole(struct lu_extent *e)
 639 {
 640         return e->e_start == 0 && e->e_end == LUSTRE_EOF;
 641 }
 642
 643 enum lov_comp_md_entry_flags {
 644         LCME_FL_STALE   = 0x00000001,   /* FLR: stale data */
 645         LCME_FL_PREF_RD = 0x00000002,   /* FLR: preferred for reading */
 646         LCME_FL_PREF_WR = 0x00000004,   /* FLR: preferred for writing */
 647         LCME_FL_PREF_RW = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
 648         LCME_FL_OFFLINE = 0x00000008,   /* Not used */
 649         LCME_FL_INIT    = 0x00000010,   /* instantiated */
 650         LCME_FL_NOSYNC  = 0x00000020,   /* FLR: no sync for the mirror */
 651         LCME_FL_NEG     = 0x80000000    /* used to indicate a negative flag,
 652                                            won't be stored on disk */
 653 };
 654
 655 #define LCME_KNOWN_FLAGS        (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
 656                                  LCME_FL_PREF_RW | LCME_FL_NOSYNC)
 657 /* The flags can be set by users at mirror creation time. */
 658 #define LCME_USER_FLAGS         (LCME_FL_PREF_RW)
 659
 660 /* The flags are for mirrors */
 661 #define LCME_MIRROR_FLAGS       (LCME_FL_NOSYNC)
 662
 663 /* These flags have meaning when set in a default layout and will be inherited
 664  * from the default/template layout set on a directory.
 665  */
 666 #define LCME_TEMPLATE_FLAGS     (LCME_FL_PREF_RW | LCME_FL_NOSYNC)
 667
 668 /* the highest bit in obdo::o_layout_version is used to mark if the file is
 669  * being resynced. */
 670 #define LU_LAYOUT_RESYNC        LCME_FL_NEG
 671
 672 /* lcme_id can be specified as certain flags, and the the first
 673  * bit of lcme_id is used to indicate that the ID is representing
 674  * certain LCME_FL_* but not a real ID. Which implies we can have
 675  * at most 31 flags (see LCME_FL_XXX). */
 676 enum lcme_id {
 677         LCME_ID_INVAL   = 0x0,
 678         LCME_ID_MAX     = 0x7FFFFFFF,
 679         LCME_ID_ALL     = 0xFFFFFFFF,
 680         LCME_ID_NOT_ID  = LCME_FL_NEG
 681 };
 682
 683 #define LCME_ID_MASK    LCME_ID_MAX
 684
 685 struct lov_comp_md_entry_v1 {
 686         __u32                   lcme_id;        /* unique id of component */
 687         __u32                   lcme_flags;     /* LCME_FL_XXX */
 688         struct lu_extent        lcme_extent;    /* file extent for component */
 689         __u32                   lcme_offset;    /* offset of component blob,
 690                                                    start from lov_comp_md_v1 */
 691         __u32                   lcme_size;      /* size of component blob */
 692         __u32                   lcme_layout_gen;
 693         __u64                   lcme_timestamp; /* snapshot time if applicable*/
 694         __u32                   lcme_padding_1;
 695 } __attribute__((packed));
 696
 697 #define SEQ_ID_MAX              0x0000FFFF
 698 #define SEQ_ID_MASK             SEQ_ID_MAX
 699 /* bit 30:16 of lcme_id is used to store mirror id */
 700 #define MIRROR_ID_MASK          0x7FFF0000
 701 #define MIRROR_ID_NEG           0x8000
 702 #define MIRROR_ID_SHIFT         16
 703
 704 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
 705 {
 706         return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
 707 }
 708
 709 static inline __u16 mirror_id_of(__u32 id)
 710 {
 711         return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
 712 }
 713
 714 /**
 715  * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
 716  */
 717 enum lov_comp_md_flags {
 718         /* the least 2 bits are used by FLR to record file state */
 719         LCM_FL_NONE          = 0,
 720         LCM_FL_RDONLY           = 1,
 721         LCM_FL_WRITE_PENDING    = 2,
 722         LCM_FL_SYNC_PENDING     = 3,
 723         LCM_FL_FLR_MASK         = 0x3,
 724 };
 725
 726 struct lov_comp_md_v1 {
 727         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
 728         __u32   lcm_size;       /* overall size including this struct */
 729         __u32   lcm_layout_gen;
 730         __u16   lcm_flags;
 731         __u16   lcm_entry_count;
 732         /* lcm_mirror_count stores the number of actual mirrors minus 1,
 733          * so that non-flr files will have value 0 meaning 1 mirror. */
 734         __u16   lcm_mirror_count;
 735         __u16   lcm_padding1[3];
 736         __u64   lcm_padding2;
 737         struct lov_comp_md_entry_v1 lcm_entries[0];
 738 } __attribute__((packed));
 739
 740 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
 741 {
 742         if (stripes == (__u16)-1)
 743                 stripes = 0;
 744
 745         if (lmm_magic == LOV_USER_MAGIC_V1)
 746                 return sizeof(struct lov_user_md_v1) +
 747                               stripes * sizeof(struct lov_user_ost_data_v1);
 748         return sizeof(struct lov_user_md_v3) +
 749                                 stripes * sizeof(struct lov_user_ost_data_v1);
 750 }
 751
 752 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 753  * use this.  It is unsafe to #define those values in this header as it
 754  * is possible the application has already #included <sys/stat.h>. */
 755 #ifdef HAVE_LOV_USER_MDS_DATA
 756 #define lov_user_mds_data lov_user_mds_data_v1
 757 struct lov_user_mds_data_v1 {
 758         lstat_t lmd_st;                 /* MDS stat struct */
 759         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 760 } __attribute__((packed));
 761 #endif
 762
 763 struct lmv_user_mds_data {
 764         struct lu_fid   lum_fid;
 765         __u32           lum_padding;
 766         __u32           lum_mds;
 767 };
 768
 769 enum lmv_hash_type {
 770         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
 771         LMV_HASH_TYPE_ALL_CHARS = 1,
 772         LMV_HASH_TYPE_FNV_1A_64 = 2,
 773         LMV_HASH_TYPE_MAX,
 774 };
 775
 776 #define LMV_HASH_NAME_ALL_CHARS "all_char"
 777 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
 778
 779 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
 780
 781 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
 782  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
 783 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 784 #define lmv_user_md lmv_user_md_v1
 785 struct lmv_user_md_v1 {
 786         __u32   lum_magic;       /* must be the first field */
 787         __u32   lum_stripe_count;  /* dirstripe count */
 788         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
 789         __u32   lum_hash_type;     /* Dir stripe policy */
 790         __u32   lum_type;         /* LMV type: default or normal */
 791         __u32   lum_padding1;
 792         __u32   lum_padding2;
 793         __u32   lum_padding3;
 794         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
 795         struct  lmv_user_mds_data  lum_objects[0];
 796 } __attribute__((packed));
 797
 798 static inline int lmv_user_md_size(int stripes, int lmm_magic)
 799 {
 800         int size = sizeof(struct lmv_user_md);
 801
 802         if (lmm_magic == LMV_USER_MAGIC_SPECIFIC)
 803                 size += stripes * sizeof(struct lmv_user_mds_data);
 804
 805         return size;
 806 }
 807
 808 struct ll_recreate_obj {
 809         __u64 lrc_id;
 810         __u32 lrc_ost_idx;
 811 };
 812
 813 struct ll_fid {
 814         __u64 id;         /* holds object id */
 815         __u32 generation; /* holds object generation */
 816         __u32 f_type;     /* holds object type or stripe idx when passing it to
 817                            * OST for saving into EA. */
 818 };
 819
 820 #define UUID_MAX        40
 821 struct obd_uuid {
 822         char uuid[UUID_MAX];
 823 };
 824
 825 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
 826                                    const struct obd_uuid *u2)
 827 {
 828         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 829 }
 830
 831 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 832 {
 833         return uuid->uuid[0] == '\0';
 834 }
 835
 836 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 837 {
 838         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 839         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 840 }
 841
 842 /* For printf's only, make sure uuid is terminated */
 843 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
 844 {
 845         if (uuid == NULL)
 846                 return NULL;
 847
 848         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 849                 /* Obviously not safe, but for printfs, no real harm done...
 850                    we're always null-terminated, even in a race. */
 851                 static char temp[sizeof(*uuid)];
 852                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 853                 temp[sizeof(*uuid) - 1] = '\0';
 854                 return temp;
 855         }
 856         return (char *)(uuid->uuid);
 857 }
 858
 859 #define LUSTRE_MAXFSNAME 8
 860
 861 /* Extract fsname from uuid (or target name) of a target
 862    e.g. (myfs-OST0007_UUID -> myfs)
 863    see also deuuidify. */
 864 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 865 {
 866         char *p;
 867
 868         strncpy(buf, uuid, buflen - 1);
 869         buf[buflen - 1] = '\0';
 870         p = strrchr(buf, '-');
 871         if (p != NULL)
 872                 *p = '\0';
 873 }
 874
 875 /* printf display format for Lustre FIDs
 876  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
 877 #define FID_NOBRACE_LEN 40
 878 #define FID_LEN (FID_NOBRACE_LEN + 2)
 879 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
 880 #define DFID "["DFID_NOBRACE"]"
 881 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
 882
 883 /* scanf input parse format for fids in DFID_NOBRACE format
 884  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
 885  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
 886 #define SFID "0x%llx:0x%x:0x%x"
 887 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
 888
 889 /********* Quotas **********/
 890
 891 #define LUSTRE_QUOTABLOCK_BITS 10
 892 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
 893
 894 static inline __u64 lustre_stoqb(size_t space)
 895 {
 896         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
 897 }
 898
 899 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
 900 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
 901 #define Q_GETOINFO      0x800102 /* get obd quota info */
 902 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
 903 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
 904
 905 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 906 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
 907 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
 908 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 909 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 910 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 911 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 912 /* lustre-specific control commands */
 913 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
 914 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
 915 #define LUSTRE_Q_GETDEFAULT  0x80000d     /* get default quota */
 916 #define LUSTRE_Q_SETDEFAULT  0x80000e     /* set default quota */
 917
 918 /* In the current Lustre implementation, the grace time is either the time
 919  * or the timestamp to be used after some quota ID exceeds the soft limt,
 920  * 48 bits should be enough, its high 16 bits can be used as quota flags.
 921  * */
 922 #define LQUOTA_GRACE_BITS       48
 923 #define LQUOTA_GRACE_MASK       ((1ULL << LQUOTA_GRACE_BITS) - 1)
 924 #define LQUOTA_GRACE_MAX        LQUOTA_GRACE_MASK
 925 #define LQUOTA_GRACE(t)         (t & LQUOTA_GRACE_MASK)
 926 #define LQUOTA_FLAG(t)          (t >> LQUOTA_GRACE_BITS)
 927 #define LQUOTA_GRACE_FLAG(t, f) ((__u64)t | (__u64)f << LQUOTA_GRACE_BITS)
 928
 929 /* different quota flags */
 930
 931 /* the default quota flag, the corresponding quota ID will use the default
 932  * quota setting, the hardlimit and softlimit of its quota record in the global
 933  * quota file will be set to 0, the low 48 bits of the grace will be set to 0
 934  * and high 16 bits will contain this flag (see above comment).
 935  * */
 936 #define LQUOTA_FLAG_DEFAULT     0x0001
 937
 938 #define ALLQUOTA 255       /* set all quota */
 939 static inline char *qtype_name(int qtype)
 940 {
 941         switch (qtype) {
 942         case USRQUOTA:
 943                 return "usr";
 944         case GRPQUOTA:
 945                 return "grp";
 946         case PRJQUOTA:
 947                 return "prj";
 948         }
 949         return "unknown";
 950 }
 951
 952 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 953 #define SEPOL_DOWNCALL_MAGIC 0x8b8bb842
 954
 955 /* permission */
 956 #define N_PERMS_MAX      64
 957
 958 struct perm_downcall_data {
 959         __u64 pdd_nid;
 960         __u32 pdd_perm;
 961         __u32 pdd_padding;
 962 };
 963
 964 struct identity_downcall_data {
 965         __u32                            idd_magic;
 966         __u32                            idd_err;
 967         __u32                            idd_uid;
 968         __u32                            idd_gid;
 969         __u32                            idd_nperms;
 970         __u32                            idd_ngroups;
 971         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 972         __u32                            idd_groups[0];
 973 };
 974
 975 struct sepol_downcall_data {
 976         __u32          sdd_magic;
 977         time_t         sdd_sepol_mtime;
 978         __u16          sdd_sepol_len;
 979         char           sdd_sepol[0];
 980 };
 981
 982 #ifdef NEED_QUOTA_DEFS
 983 #ifndef QIF_BLIMITS
 984 #define QIF_BLIMITS     1
 985 #define QIF_SPACE       2
 986 #define QIF_ILIMITS     4
 987 #define QIF_INODES      8
 988 #define QIF_BTIME       16
 989 #define QIF_ITIME       32
 990 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 991 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 992 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 993 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 994 #endif
 995
 996 #endif /* !__KERNEL__ */
 997
 998 /* lustre volatile file support
 999  * file name header: ".^L^S^T^R:volatile"
1000  */
1001 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
1002 #define LUSTRE_VOLATILE_HDR_LEN 14
1003
1004 enum lustre_quota_version {
1005         LUSTRE_QUOTA_V2 = 1
1006 };
1007
1008 /* XXX: same as if_dqinfo struct in kernel */
1009 struct obd_dqinfo {
1010         __u64 dqi_bgrace;
1011         __u64 dqi_igrace;
1012         __u32 dqi_flags;
1013         __u32 dqi_valid;
1014 };
1015
1016 /* XXX: same as if_dqblk struct in kernel, plus one padding */
1017 struct obd_dqblk {
1018         __u64 dqb_bhardlimit;
1019         __u64 dqb_bsoftlimit;
1020         __u64 dqb_curspace;
1021         __u64 dqb_ihardlimit;
1022         __u64 dqb_isoftlimit;
1023         __u64 dqb_curinodes;
1024         __u64 dqb_btime;
1025         __u64 dqb_itime;
1026         __u32 dqb_valid;
1027         __u32 dqb_padding;
1028 };
1029
1030 enum {
1031         QC_GENERAL      = 0,
1032         QC_MDTIDX       = 1,
1033         QC_OSTIDX       = 2,
1034         QC_UUID         = 3
1035 };
1036
1037 struct if_quotactl {
1038         __u32                   qc_cmd;
1039         __u32                   qc_type;
1040         __u32                   qc_id;
1041         __u32                   qc_stat;
1042         __u32                   qc_valid;
1043         __u32                   qc_idx;
1044         struct obd_dqinfo       qc_dqinfo;
1045         struct obd_dqblk        qc_dqblk;
1046         char                    obd_type[16];
1047         struct obd_uuid         obd_uuid;
1048 };
1049
1050 /* swap layout flags */
1051 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
1052 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
1053 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
1054 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
1055 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
1056
1057 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
1058 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
1059 struct lustre_swap_layouts {
1060         __u64   sl_flags;
1061         __u32   sl_fd;
1062         __u32   sl_gid;
1063         __u64   sl_dv1;
1064         __u64   sl_dv2;
1065 };
1066
1067 /** Bit-mask of valid attributes */
1068 /* The LA_* flags are written to disk as part of the ChangeLog records
1069  * so they are part of the on-disk and network protocol, and cannot be changed.
1070  * Only the first 12 bits are currently saved.
1071  */
1072 enum la_valid {
1073         LA_ATIME        = 1 << 0,       /* 0x00001 */
1074         LA_MTIME        = 1 << 1,       /* 0x00002 */
1075         LA_CTIME        = 1 << 2,       /* 0x00004 */
1076         LA_SIZE         = 1 << 3,       /* 0x00008 */
1077         LA_MODE         = 1 << 4,       /* 0x00010 */
1078         LA_UID          = 1 << 5,       /* 0x00020 */
1079         LA_GID          = 1 << 6,       /* 0x00040 */
1080         LA_BLOCKS       = 1 << 7,       /* 0x00080 */
1081         LA_TYPE         = 1 << 8,       /* 0x00100 */
1082         LA_FLAGS        = 1 << 9,       /* 0x00200 */
1083         LA_NLINK        = 1 << 10,      /* 0x00400 */
1084         LA_RDEV         = 1 << 11,      /* 0x00800 */
1085         LA_BLKSIZE      = 1 << 12,      /* 0x01000 */
1086         LA_KILL_SUID    = 1 << 13,      /* 0x02000 */
1087         LA_KILL_SGID    = 1 << 14,      /* 0x04000 */
1088         LA_PROJID       = 1 << 15,      /* 0x08000 */
1089         LA_LAYOUT_VERSION = 1 << 16,    /* 0x10000 */
1090         LA_LSIZE        = 1 << 17,      /* 0x20000 */
1091         LA_LBLOCKS      = 1 << 18,      /* 0x40000 */
1092         /**
1093          * Attributes must be transmitted to OST objects
1094          */
1095         LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1096 };
1097
1098 #define MDS_FMODE_READ           00000001
1099 #define MDS_FMODE_WRITE          00000002
1100
1101 #define MDS_FMODE_CLOSED         00000000
1102 #define MDS_FMODE_EXEC           00000004
1103 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
1104 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
1105 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
1106
1107 #define MDS_OPEN_CREATED         00000010
1108 /*      MDS_OPEN_CROSS           00000020 obsolete in 2.12, internal use only */
1109
1110 #define MDS_OPEN_CREAT           00000100
1111 #define MDS_OPEN_EXCL            00000200
1112 #define MDS_OPEN_TRUNC           00001000
1113 #define MDS_OPEN_APPEND          00002000
1114 #define MDS_OPEN_SYNC            00010000
1115 #define MDS_OPEN_DIRECTORY       00200000
1116
1117 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
1118 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1119 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1120 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1121                                            * We do not support JOIN FILE
1122                                            * anymore, reserve this flags
1123                                            * just for preventing such bit
1124                                            * to be reused. */
1125
1126 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1127 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1128 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1129 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
1130 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
1131                                               * hsm restore) */
1132 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
1133                                                 unlinked */
1134 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
1135                                               * delegation, succeed if it's not
1136                                               * being opened with conflict mode.
1137                                               */
1138 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
1139
1140 #define MDS_OPEN_RESYNC    04000000000000ULL /* FLR: file resync */
1141
1142 /* lustre internal open flags, which should not be set from user space */
1143 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
1144                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
1145                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
1146                               MDS_OPEN_RELEASE | MDS_OPEN_RESYNC)
1147
1148
1149 /********* Changelogs **********/
1150 /** Changelog record types */
1151 enum changelog_rec_type {
1152         CL_NONE     = -1,
1153         CL_MARK     = 0,
1154         CL_CREATE   = 1,  /* namespace */
1155         CL_MKDIR    = 2,  /* namespace */
1156         CL_HARDLINK = 3,  /* namespace */
1157         CL_SOFTLINK = 4,  /* namespace */
1158         CL_MKNOD    = 5,  /* namespace */
1159         CL_UNLINK   = 6,  /* namespace */
1160         CL_RMDIR    = 7,  /* namespace */
1161         CL_RENAME   = 8,  /* namespace */
1162         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
1163         CL_OPEN     = 10, /* not currently used */
1164         CL_CLOSE    = 11, /* may be written to log only with mtime change */
1165         CL_LAYOUT   = 12, /* file layout/striping modified */
1166         CL_TRUNC    = 13,
1167         CL_SETATTR  = 14,
1168         CL_SETXATTR = 15,
1169         CL_XATTR    = CL_SETXATTR, /* Deprecated name */
1170         CL_HSM      = 16, /* HSM specific events, see flags */
1171         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
1172         CL_CTIME    = 18,
1173         CL_ATIME    = 19,
1174         CL_MIGRATE  = 20,
1175         CL_FLRW     = 21, /* FLR: file was firstly written */
1176         CL_RESYNC   = 22, /* FLR: file was resync-ed */
1177         CL_GETXATTR = 23,
1178         CL_DN_OPEN  = 24, /* denied open */
1179         CL_LAST
1180 };
1181
1182 static inline const char *changelog_type2str(int type) {
1183         static const char *changelog_str[] = {
1184                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1185                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
1186                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT",
1187                 "FLRW",  "RESYNC","GXATR", "NOPEN",
1188         };
1189
1190         if (type >= 0 && type < CL_LAST)
1191                 return changelog_str[type];
1192         return NULL;
1193 }
1194
1195 /* 12 bits of per-record data can be stored in the bottom of the flags */
1196 #define CLF_FLAGSHIFT   12
1197 enum changelog_rec_flags {
1198         CLF_VERSION     = 0x1000,
1199         CLF_RENAME      = 0x2000,
1200         CLF_JOBID       = 0x4000,
1201         CLF_EXTRA_FLAGS = 0x8000,
1202         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID |
1203                           CLF_EXTRA_FLAGS,
1204         CLF_FLAGMASK    = (1U << CLF_FLAGSHIFT) - 1,
1205         CLF_VERMASK     = ~CLF_FLAGMASK,
1206 };
1207
1208
1209 /* Anything under the flagmask may be per-type (if desired) */
1210 /* Flags for unlink */
1211 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
1212 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1213                                      /* HSM cleaning needed */
1214 /* Flags for rename */
1215 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
1216                                         * of target */
1217 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
1218                                         * has an archive in backend */
1219
1220 /* Flags for HSM */
1221 /* 12b used (from high weight to low weight):
1222  * 2b for flags
1223  * 3b for event
1224  * 7b for error code
1225  */
1226 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
1227 #define CLF_HSM_ERR_H        6
1228 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
1229 #define CLF_HSM_EVENT_H      9
1230 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
1231 #define CLF_HSM_FLAG_H      11
1232 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
1233 #define CLF_HSM_SPARE_H     15
1234 #define CLF_HSM_LAST        15
1235
1236 /* Remove bits higher than _h, then extract the value
1237  * between _h and _l by shifting lower weigth to bit 0. */
1238 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1239                                    >> (CLF_HSM_LAST - _h + _l))
1240
1241 #define CLF_HSM_SUCCESS      0x00
1242 #define CLF_HSM_MAXERROR     0x7E
1243 #define CLF_HSM_ERROVERFLOW  0x7F
1244
1245 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
1246
1247 /* 3 bits field => 8 values allowed */
1248 enum hsm_event {
1249         HE_ARCHIVE      = 0,
1250         HE_RESTORE      = 1,
1251         HE_CANCEL       = 2,
1252         HE_RELEASE      = 3,
1253         HE_REMOVE       = 4,
1254         HE_STATE        = 5,
1255         HE_SPARE1       = 6,
1256         HE_SPARE2       = 7,
1257 };
1258
1259 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1260 {
1261         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1262                                             CLF_HSM_EVENT_L);
1263 }
1264
1265 static inline void hsm_set_cl_event(enum changelog_rec_flags *clf_flags,
1266                                     enum hsm_event he)
1267 {
1268         *clf_flags |= (he << CLF_HSM_EVENT_L);
1269 }
1270
1271 static inline __u16 hsm_get_cl_flags(enum changelog_rec_flags clf_flags)
1272 {
1273         return CLF_GET_BITS(clf_flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1274 }
1275
1276 static inline void hsm_set_cl_flags(enum changelog_rec_flags *clf_flags,
1277                                     unsigned int bits)
1278 {
1279         *clf_flags |= (bits << CLF_HSM_FLAG_L);
1280 }
1281
1282 static inline int hsm_get_cl_error(enum changelog_rec_flags clf_flags)
1283 {
1284         return CLF_GET_BITS(clf_flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1285 }
1286
1287 static inline void hsm_set_cl_error(enum changelog_rec_flags *clf_flags,
1288                                     unsigned int error)
1289 {
1290         *clf_flags |= (error << CLF_HSM_ERR_L);
1291 }
1292
1293 enum changelog_rec_extra_flags {
1294         CLFE_INVALID    = 0,
1295         CLFE_UIDGID     = 0x0001,
1296         CLFE_NID        = 0x0002,
1297         CLFE_OPEN       = 0x0004,
1298         CLFE_XATTR      = 0x0008,
1299         CLFE_SUPPORTED  = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1300 };
1301
1302 enum changelog_send_flag {
1303         /* Not yet implemented */
1304         CHANGELOG_FLAG_FOLLOW      = 0x01,
1305         /* Blocking IO makes sense in case of slow user parsing of the records,
1306          * but it also prevents us from cleaning up if the records are not
1307          * consumed. */
1308         CHANGELOG_FLAG_BLOCK       = 0x02,
1309         /* Pack jobid into the changelog records if available. */
1310         CHANGELOG_FLAG_JOBID       = 0x04,
1311         /* Pack additional flag bits into the changelog record */
1312         CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1313 };
1314
1315 enum changelog_send_extra_flag {
1316         /* Pack uid/gid into the changelog record */
1317         CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1318         /* Pack nid into the changelog record */
1319         CHANGELOG_EXTRA_FLAG_NID    = 0x02,
1320         /* Pack open mode into the changelog record */
1321         CHANGELOG_EXTRA_FLAG_OMODE  = 0x04,
1322         /* Pack xattr name into the changelog record */
1323         CHANGELOG_EXTRA_FLAG_XATTR  = 0x08,
1324 };
1325
1326 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1327                                   changelog_rec_offset(CLF_SUPPORTED, \
1328                                                        CLFE_SUPPORTED), 8)
1329
1330 /* 31 usable bytes string + null terminator. */
1331 #define LUSTRE_JOBID_SIZE       32
1332
1333 /* This is the minimal changelog record. It can contain extensions
1334  * such as rename fields or process jobid. Its exact content is described
1335  * by the cr_flags and cr_extra_flags.
1336  *
1337  * Extensions are packed in the same order as their corresponding flags,
1338  * then in the same order as their corresponding extra flags.
1339  */
1340 struct changelog_rec {
1341         __u16                   cr_namelen;
1342         __u16                   cr_flags; /**< \a changelog_rec_flags */
1343         __u32                   cr_type;  /**< \a changelog_rec_type */
1344         __u64                   cr_index; /**< changelog record number */
1345         __u64                   cr_prev;  /**< last index for this target fid */
1346         __u64                   cr_time;
1347         union {
1348                 struct lu_fid   cr_tfid;        /**< target fid */
1349                 __u32           cr_markerflags; /**< CL_MARK flags */
1350         };
1351         struct lu_fid           cr_pfid;        /**< parent fid */
1352 };
1353
1354 /* Changelog extension for RENAME. */
1355 struct changelog_ext_rename {
1356         struct lu_fid           cr_sfid;     /**< source fid, or zero */
1357         struct lu_fid           cr_spfid;    /**< source parent fid, or zero */
1358 };
1359
1360 /* Changelog extension to include JOBID. */
1361 struct changelog_ext_jobid {
1362         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
1363 };
1364
1365 /* Changelog extension to include additional flags. */
1366 struct changelog_ext_extra_flags {
1367         __u64 cr_extra_flags; /* Additional CLFE_* flags */
1368 };
1369
1370 /* Changelog extra extension to include UID/GID. */
1371 struct changelog_ext_uidgid {
1372         __u64   cr_uid;
1373         __u64   cr_gid;
1374 };
1375
1376 /* Changelog extra extension to include NID. */
1377 struct changelog_ext_nid {
1378         /* have __u64 instead of lnet_nid_t type for use by client api */
1379         __u64 cr_nid;
1380         /* for use when IPv6 support is added */
1381         __u64 extra;
1382         __u32 padding;
1383 };
1384
1385 /* Changelog extra extension to include low 32 bits of MDS_OPEN_* flags. */
1386 struct changelog_ext_openmode {
1387         __u32 cr_openflags;
1388 };
1389
1390 /* Changelog extra extension to include xattr */
1391 struct changelog_ext_xattr {
1392         char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1393 };
1394
1395 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1396         const struct changelog_rec *rec);
1397
1398 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf,
1399                                           enum changelog_rec_extra_flags cref)
1400 {
1401         size_t size = sizeof(struct changelog_rec);
1402
1403         if (crf & CLF_RENAME)
1404                 size += sizeof(struct changelog_ext_rename);
1405
1406         if (crf & CLF_JOBID)
1407                 size += sizeof(struct changelog_ext_jobid);
1408
1409         if (crf & CLF_EXTRA_FLAGS) {
1410                 size += sizeof(struct changelog_ext_extra_flags);
1411                 if (cref & CLFE_UIDGID)
1412                         size += sizeof(struct changelog_ext_uidgid);
1413                 if (cref & CLFE_NID)
1414                         size += sizeof(struct changelog_ext_nid);
1415                 if (cref & CLFE_OPEN)
1416                         size += sizeof(struct changelog_ext_openmode);
1417                 if (cref & CLFE_XATTR)
1418                         size += sizeof(struct changelog_ext_xattr);
1419         }
1420
1421         return size;
1422 }
1423
1424 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1425 {
1426         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1427
1428         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1429                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1430
1431         return changelog_rec_offset(rec->cr_flags, cref);
1432 }
1433
1434 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1435 {
1436         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1437 }
1438
1439 static inline
1440 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1441 {
1442         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1443
1444         return (struct changelog_ext_rename *)((char *)rec +
1445                                                changelog_rec_offset(crf,
1446                                                                  CLFE_INVALID));
1447 }
1448
1449 /* The jobid follows the rename extension, if present */
1450 static inline
1451 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1452 {
1453         enum changelog_rec_flags crf = rec->cr_flags &
1454                                         (CLF_VERSION | CLF_RENAME);
1455
1456         return (struct changelog_ext_jobid *)((char *)rec +
1457                                               changelog_rec_offset(crf,
1458                                                                  CLFE_INVALID));
1459 }
1460
1461 /* The additional flags follow the rename and jobid extensions, if present */
1462 static inline
1463 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1464         const struct changelog_rec *rec)
1465 {
1466         enum changelog_rec_flags crf = rec->cr_flags &
1467                 (CLF_VERSION | CLF_RENAME | CLF_JOBID);
1468
1469         return (struct changelog_ext_extra_flags *)((char *)rec +
1470                                                  changelog_rec_offset(crf,
1471                                                                  CLFE_INVALID));
1472 }
1473
1474 /* The uid/gid is the first extra extension */
1475 static inline
1476 struct changelog_ext_uidgid *changelog_rec_uidgid(
1477         const struct changelog_rec *rec)
1478 {
1479         enum changelog_rec_flags crf = rec->cr_flags &
1480                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1481
1482         return (struct changelog_ext_uidgid *)((char *)rec +
1483                                                changelog_rec_offset(crf,
1484                                                                  CLFE_INVALID));
1485 }
1486
1487 /* The nid is the second extra extension */
1488 static inline
1489 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
1490 {
1491         enum changelog_rec_flags crf = rec->cr_flags &
1492                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1493         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1494
1495         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1496                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1497                        CLFE_UIDGID;
1498
1499         return (struct changelog_ext_nid *)((char *)rec +
1500                                             changelog_rec_offset(crf, cref));
1501 }
1502
1503 /* The OPEN mode is the third extra extension */
1504 static inline
1505 struct changelog_ext_openmode *changelog_rec_openmode(
1506         const struct changelog_rec *rec)
1507 {
1508         enum changelog_rec_flags crf = rec->cr_flags &
1509                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1510         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1511
1512         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1513                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1514                        (CLFE_UIDGID | CLFE_NID);
1515
1516         return (struct changelog_ext_openmode *)((char *)rec +
1517                                                changelog_rec_offset(crf, cref));
1518 }
1519
1520 /* The xattr name is the fourth extra extension */
1521 static inline
1522 struct changelog_ext_xattr *changelog_rec_xattr(
1523         const struct changelog_rec *rec)
1524 {
1525         enum changelog_rec_flags crf = rec->cr_flags &
1526                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1527         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1528
1529         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1530                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1531                         (CLFE_UIDGID | CLFE_NID | CLFE_OPEN);
1532
1533         return (struct changelog_ext_xattr *)((char *)rec +
1534                                               changelog_rec_offset(crf, cref));
1535 }
1536
1537 /* The name follows the rename, jobid  and extra flags extns, if present */
1538 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1539 {
1540         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1541
1542         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1543                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1544
1545         return (char *)rec + changelog_rec_offset(rec->cr_flags & CLF_SUPPORTED,
1546                                                   cref & CLFE_SUPPORTED);
1547 }
1548
1549 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1550 {
1551         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1552 }
1553
1554 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1555 {
1556         char *cr_name = changelog_rec_name(rec);
1557
1558         return cr_name + strlen(cr_name) + 1;
1559 }
1560
1561 /**
1562  * Remap a record to the desired format as specified by the crf flags.
1563  * The record must be big enough to contain the final remapped version.
1564  * Superfluous extension fields are removed and missing ones are added
1565  * and zeroed. The flags of the record are updated accordingly.
1566  *
1567  * The jobid and rename extensions can be added to a record, to match the
1568  * format an application expects, typically. In this case, the newly added
1569  * fields will be zeroed.
1570  * The Jobid field can be removed, to guarantee compatibility with older
1571  * clients that don't expect this field in the records they process.
1572  *
1573  * The following assumptions are being made:
1574  *   - CLF_RENAME will not be removed
1575  *   - CLF_JOBID will not be added without CLF_RENAME being added too
1576  *   - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
1577  *
1578  * @param[in,out]  rec         The record to remap.
1579  * @param[in]      crf_wanted  Flags describing the desired extensions.
1580  * @param[in]      cref_want   Flags describing the desired extra extensions.
1581  */
1582 static inline void changelog_remap_rec(struct changelog_rec *rec,
1583                                        enum changelog_rec_flags crf_wanted,
1584                                        enum changelog_rec_extra_flags cref_want)
1585 {
1586         char *xattr_mov = NULL;
1587         char *omd_mov = NULL;
1588         char *nid_mov = NULL;
1589         char *uidgid_mov = NULL;
1590         char *ef_mov;
1591         char *jid_mov;
1592         char *rnm_mov;
1593         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1594
1595         crf_wanted &= CLF_SUPPORTED;
1596         cref_want &= CLFE_SUPPORTED;
1597
1598         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
1599                 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
1600                     (rec->cr_flags & CLF_EXTRA_FLAGS &&
1601                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
1602                                                         CLFE_SUPPORTED) ==
1603                                                                      cref_want))
1604                         return;
1605         }
1606
1607         /* First move the variable-length name field */
1608         memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
1609                 changelog_rec_name(rec), rec->cr_namelen);
1610
1611         /* Locations of extensions in the remapped record */
1612         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1613                 xattr_mov = (char *)rec +
1614                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1615                                              cref_want & ~CLFE_XATTR);
1616                 omd_mov = (char *)rec +
1617                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1618                                              cref_want & ~(CLFE_OPEN |
1619                                                            CLFE_XATTR));
1620                 nid_mov = (char *)rec +
1621                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1622                                              cref_want & ~(CLFE_NID |
1623                                                            CLFE_OPEN |
1624                                                            CLFE_XATTR));
1625                 uidgid_mov = (char *)rec +
1626                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1627                                              cref_want & ~(CLFE_UIDGID |
1628                                                            CLFE_NID |
1629                                                            CLFE_OPEN |
1630                                                            CLFE_XATTR));
1631                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1632         }
1633
1634         ef_mov  = (char *)rec +
1635                   changelog_rec_offset(crf_wanted & ~CLF_EXTRA_FLAGS,
1636                                        CLFE_INVALID);
1637         jid_mov = (char *)rec +
1638                   changelog_rec_offset(crf_wanted &
1639                                        ~(CLF_EXTRA_FLAGS | CLF_JOBID),
1640                                        CLFE_INVALID);
1641         rnm_mov = (char *)rec +
1642                   changelog_rec_offset(crf_wanted &
1643                                        ~(CLF_EXTRA_FLAGS |
1644                                          CLF_JOBID |
1645                                          CLF_RENAME),
1646                                        CLFE_INVALID);
1647
1648         /* Move the extension fields to the desired positions */
1649         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1650             (rec->cr_flags & CLF_EXTRA_FLAGS)) {
1651                 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
1652                         memmove(xattr_mov, changelog_rec_xattr(rec),
1653                                 sizeof(struct changelog_ext_xattr));
1654
1655                 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
1656                         memmove(omd_mov, changelog_rec_openmode(rec),
1657                                 sizeof(struct changelog_ext_openmode));
1658
1659                 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
1660                         memmove(nid_mov, changelog_rec_nid(rec),
1661                                 sizeof(struct changelog_ext_nid));
1662
1663                 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
1664                         memmove(uidgid_mov, changelog_rec_uidgid(rec),
1665                                 sizeof(struct changelog_ext_uidgid));
1666
1667                 memmove(ef_mov, changelog_rec_extra_flags(rec),
1668                         sizeof(struct changelog_ext_extra_flags));
1669         }
1670
1671         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1672                 memmove(jid_mov, changelog_rec_jobid(rec),
1673                         sizeof(struct changelog_ext_jobid));
1674
1675         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1676                 memmove(rnm_mov, changelog_rec_rename(rec),
1677                         sizeof(struct changelog_ext_rename));
1678
1679         /* Clear newly added fields */
1680         if (xattr_mov && (cref_want & CLFE_XATTR) &&
1681             !(cref & CLFE_XATTR))
1682                 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
1683
1684         if (omd_mov && (cref_want & CLFE_OPEN) &&
1685             !(cref & CLFE_OPEN))
1686                 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
1687
1688         if (nid_mov && (cref_want & CLFE_NID) &&
1689             !(cref & CLFE_NID))
1690                 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
1691
1692         if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
1693             !(cref & CLFE_UIDGID))
1694                 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
1695
1696         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1697             !(rec->cr_flags & CLF_EXTRA_FLAGS))
1698                 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
1699
1700         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1701                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1702
1703         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1704                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1705
1706         /* Update the record's flags accordingly */
1707         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1708         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1709                 changelog_rec_extra_flags(rec)->cr_extra_flags =
1710                         changelog_rec_extra_flags(rec)->cr_extra_flags |
1711                         cref_want;
1712 }
1713
1714 enum changelog_message_type {
1715         CL_RECORD = 10, /* message is a changelog_rec */
1716         CL_EOF    = 11, /* at end of current changelog */
1717 };
1718
1719 /********* Misc **********/
1720
1721 struct ioc_data_version {
1722         __u64   idv_version;
1723         __u32   idv_layout_version; /* FLR: layout version for OST objects */
1724         __u32   idv_flags;      /* enum ioc_data_version_flags */
1725 };
1726
1727 enum ioc_data_version_flags {
1728         LL_DV_RD_FLUSH  = (1 << 0), /* Flush dirty pages from clients */
1729         LL_DV_WR_FLUSH  = (1 << 1), /* Flush all caching pages from clients */
1730 };
1731
1732 #ifndef offsetof
1733 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1734 #endif
1735
1736 #define dot_lustre_name ".lustre"
1737
1738
1739 /********* HSM **********/
1740
1741 /** HSM per-file state
1742  * See HSM_FLAGS below.
1743  */
1744 enum hsm_states {
1745         HS_NONE         = 0x00000000,
1746         HS_EXISTS       = 0x00000001,
1747         HS_DIRTY        = 0x00000002,
1748         HS_RELEASED     = 0x00000004,
1749         HS_ARCHIVED     = 0x00000008,
1750         HS_NORELEASE    = 0x00000010,
1751         HS_NOARCHIVE    = 0x00000020,
1752         HS_LOST         = 0x00000040,
1753 };
1754
1755 /* HSM user-setable flags. */
1756 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1757
1758 /* Other HSM flags. */
1759 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1760
1761 /*
1762  * All HSM-related possible flags that could be applied to a file.
1763  * This should be kept in sync with hsm_states.
1764  */
1765 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1766
1767 /**
1768  * HSM request progress state
1769  */
1770 enum hsm_progress_states {
1771         HPS_NONE        = 0,
1772         HPS_WAITING     = 1,
1773         HPS_RUNNING     = 2,
1774         HPS_DONE        = 3,
1775 };
1776
1777 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1778 {
1779         switch  (s) {
1780         case HPS_WAITING:       return "waiting";
1781         case HPS_RUNNING:       return "running";
1782         case HPS_DONE:          return "done";
1783         default:                return "unknown";
1784         }
1785 }
1786
1787 struct hsm_extent {
1788         __u64 offset;
1789         __u64 length;
1790 } __attribute__((packed));
1791
1792 /**
1793  * Current HSM states of a Lustre file.
1794  *
1795  * This structure purpose is to be sent to user-space mainly. It describes the
1796  * current HSM flags and in-progress action.
1797  */
1798 struct hsm_user_state {
1799         /** Current HSM states, from enum hsm_states. */
1800         __u32                   hus_states;
1801         __u32                   hus_archive_id;
1802         /**  The current undergoing action, if there is one */
1803         __u32                   hus_in_progress_state;
1804         __u32                   hus_in_progress_action;
1805         struct hsm_extent       hus_in_progress_location;
1806         char                    hus_extended_info[];
1807 };
1808
1809 struct hsm_state_set_ioc {
1810         struct lu_fid   hssi_fid;
1811         __u64           hssi_setmask;
1812         __u64           hssi_clearmask;
1813 };
1814
1815 /*
1816  * This structure describes the current in-progress action for a file.
1817  * it is retuned to user space and send over the wire
1818  */
1819 struct hsm_current_action {
1820         /**  The current undergoing action, if there is one */
1821         /* state is one of hsm_progress_states */
1822         __u32                   hca_state;
1823         /* action is one of hsm_user_action */
1824         __u32                   hca_action;
1825         struct hsm_extent       hca_location;
1826 };
1827
1828 /***** HSM user requests ******/
1829 /* User-generated (lfs/ioctl) request types */
1830 enum hsm_user_action {
1831         HUA_NONE    =  1, /* no action (noop) */
1832         HUA_ARCHIVE = 10, /* copy to hsm */
1833         HUA_RESTORE = 11, /* prestage */
1834         HUA_RELEASE = 12, /* drop ost objects */
1835         HUA_REMOVE  = 13, /* remove from archive */
1836         HUA_CANCEL  = 14  /* cancel a request */
1837 };
1838
1839 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1840 {
1841         switch  (a) {
1842         case HUA_NONE:    return "NOOP";
1843         case HUA_ARCHIVE: return "ARCHIVE";
1844         case HUA_RESTORE: return "RESTORE";
1845         case HUA_RELEASE: return "RELEASE";
1846         case HUA_REMOVE:  return "REMOVE";
1847         case HUA_CANCEL:  return "CANCEL";
1848         default:          return "UNKNOWN";
1849         }
1850 }
1851
1852 /*
1853  * List of hr_flags (bit field)
1854  */
1855 #define HSM_FORCE_ACTION 0x0001
1856 /* used by CT, cannot be set by user */
1857 #define HSM_GHOST_COPY   0x0002
1858
1859 /**
1860  * Contains all the fixed part of struct hsm_user_request.
1861  *
1862  */
1863 struct hsm_request {
1864         __u32 hr_action;        /* enum hsm_user_action */
1865         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1866         __u64 hr_flags;         /* request flags */
1867         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1868         __u32 hr_data_len;
1869 };
1870
1871 struct hsm_user_item {
1872        struct lu_fid        hui_fid;
1873        struct hsm_extent hui_extent;
1874 } __attribute__((packed));
1875
1876 struct hsm_user_request {
1877         struct hsm_request      hur_request;
1878         struct hsm_user_item    hur_user_item[0];
1879         /* extra data blob at end of struct (after all
1880          * hur_user_items), only use helpers to access it
1881          */
1882 } __attribute__((packed));
1883
1884 /** Return pointer to data field in a hsm user request */
1885 static inline void *hur_data(struct hsm_user_request *hur)
1886 {
1887         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1888 }
1889
1890 /**
1891  * Compute the current length of the provided hsm_user_request.  This returns -1
1892  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1893  *
1894  * return -1 on bounds check error.
1895  */
1896 static inline ssize_t hur_len(struct hsm_user_request *hur)
1897 {
1898         __u64   size;
1899
1900         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1901         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1902                 (__u64)hur->hur_request.hr_itemcount *
1903                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1904
1905         if (size != (ssize_t)size)
1906                 return -1;
1907
1908         return size;
1909 }
1910
1911 /****** HSM RPCs to copytool *****/
1912 /* Message types the copytool may receive */
1913 enum hsm_message_type {
1914         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1915 };
1916
1917 /* Actions the copytool may be instructed to take for a given action_item */
1918 enum hsm_copytool_action {
1919         HSMA_NONE    = 10, /* no action */
1920         HSMA_ARCHIVE = 20, /* arbitrary offset */
1921         HSMA_RESTORE = 21,
1922         HSMA_REMOVE  = 22,
1923         HSMA_CANCEL  = 23
1924 };
1925
1926 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1927 {
1928         switch  (a) {
1929         case HSMA_NONE:    return "NOOP";
1930         case HSMA_ARCHIVE: return "ARCHIVE";
1931         case HSMA_RESTORE: return "RESTORE";
1932         case HSMA_REMOVE:  return "REMOVE";
1933         case HSMA_CANCEL:  return "CANCEL";
1934         default:           return "UNKNOWN";
1935         }
1936 }
1937
1938 /* Copytool item action description */
1939 struct hsm_action_item {
1940         __u32      hai_len;     /* valid size of this struct */
1941         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1942         struct lu_fid hai_fid;     /* Lustre FID to operate on */
1943         struct lu_fid hai_dfid;    /* fid used for data access */
1944         struct hsm_extent hai_extent;  /* byte range to operate on */
1945         __u64      hai_cookie;  /* action cookie from coordinator */
1946         __u64      hai_gid;     /* grouplock id */
1947         char       hai_data[0]; /* variable length */
1948 } __attribute__((packed));
1949
1950 /**
1951  * helper function which print in hexa the first bytes of
1952  * hai opaque field
1953  *
1954  * \param hai [IN]        record to print
1955  * \param buffer [IN,OUT] buffer to write the hex string to
1956  * \param len [IN]        max buffer length
1957  *
1958  * \retval buffer
1959  */
1960 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1961                                         char *buffer, size_t len)
1962 {
1963         int i;
1964         int data_len;
1965         char *ptr;
1966
1967         ptr = buffer;
1968         data_len = hai->hai_len - sizeof(*hai);
1969         for (i = 0; (i < data_len) && (len > 2); i++) {
1970                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1971                 ptr += 2;
1972                 len -= 2;
1973         }
1974
1975         *ptr = '\0';
1976
1977         return buffer;
1978 }
1979
1980 /* Copytool action list */
1981 #define HAL_VERSION 1
1982 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1983 struct hsm_action_list {
1984         __u32 hal_version;
1985         __u32 hal_count;       /* number of hai's to follow */
1986         __u64 hal_compound_id; /* returned by coordinator, ignored */
1987         __u64 hal_flags;
1988         __u32 hal_archive_id; /* which archive backend */
1989         __u32 padding1;
1990         char  hal_fsname[0];   /* null-terminated */
1991         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1992            boundaries. See hai_zero */
1993 } __attribute__((packed));
1994
1995 /* Return pointer to first hai in action list */
1996 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1997 {
1998         size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
1999
2000         return (struct hsm_action_item *)(hal->hal_fsname + offset);
2001 }
2002
2003 /* Return pointer to next hai */
2004 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
2005 {
2006         size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
2007
2008         return (struct hsm_action_item *)((char *)hai + offset);
2009 }
2010
2011 /* Return size of an hsm_action_list */
2012 static inline size_t hal_size(struct hsm_action_list *hal)
2013 {
2014         __u32 i;
2015         size_t sz;
2016         struct hsm_action_item *hai;
2017
2018         sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2019         hai = hai_first(hal);
2020         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
2021                 sz += __ALIGN_KERNEL(hai->hai_len, 8);
2022
2023         return sz;
2024 }
2025
2026 /* HSM file import
2027  * describe the attributes to be set on imported file
2028  */
2029 struct hsm_user_import {
2030         __u64           hui_size;
2031         __u64           hui_atime;
2032         __u64           hui_mtime;
2033         __u32           hui_atime_ns;
2034         __u32           hui_mtime_ns;
2035         __u32           hui_uid;
2036         __u32           hui_gid;
2037         __u32           hui_mode;
2038         __u32           hui_archive_id;
2039 };
2040
2041 /* Copytool progress reporting */
2042 #define HP_FLAG_COMPLETED 0x01
2043 #define HP_FLAG_RETRY     0x02
2044
2045 struct hsm_progress {
2046         struct lu_fid           hp_fid;
2047         __u64                   hp_cookie;
2048         struct hsm_extent       hp_extent;
2049         __u16                   hp_flags;
2050         __u16                   hp_errval; /* positive val */
2051         __u32                   padding;
2052 };
2053
2054 struct hsm_copy {
2055         __u64                   hc_data_version;
2056         __u16                   hc_flags;
2057         __u16                   hc_errval; /* positive val */
2058         __u32                   padding;
2059         struct hsm_action_item  hc_hai;
2060 };
2061
2062 /* JSON objects */
2063 enum llapi_json_types {
2064         LLAPI_JSON_INTEGER = 1,
2065         LLAPI_JSON_BIGNUM,
2066         LLAPI_JSON_REAL,
2067         LLAPI_JSON_STRING
2068 };
2069
2070 struct llapi_json_item {
2071         char                    *lji_key;
2072         __u32                   lji_type;
2073         union {
2074                 int     lji_integer;
2075                 __u64   lji_u64;
2076                 double  lji_real;
2077                 char    *lji_string;
2078         };
2079         struct llapi_json_item  *lji_next;
2080 };
2081
2082 struct llapi_json_item_list {
2083         int                     ljil_item_count;
2084         struct llapi_json_item  *ljil_items;
2085 };
2086
2087 enum lu_ladvise_type {
2088         LU_LADVISE_INVALID      = 0,
2089         LU_LADVISE_WILLREAD     = 1,
2090         LU_LADVISE_DONTNEED     = 2,
2091         LU_LADVISE_LOCKNOEXPAND = 3,
2092         LU_LADVISE_LOCKAHEAD    = 4,
2093         LU_LADVISE_MAX
2094 };
2095
2096 #define LU_LADVISE_NAMES {                                              \
2097         [LU_LADVISE_WILLREAD]           = "willread",                   \
2098         [LU_LADVISE_DONTNEED]           = "dontneed",                   \
2099         [LU_LADVISE_LOCKNOEXPAND]       = "locknoexpand",               \
2100         [LU_LADVISE_LOCKAHEAD]          = "lockahead",                  \
2101 }
2102
2103 /* This is the userspace argument for ladvise.  It is currently the same as
2104  * what goes on the wire (struct lu_ladvise), but is defined separately as we
2105  * may need info which is only used locally. */
2106 struct llapi_lu_ladvise {
2107         __u16 lla_advice;       /* advice type */
2108         __u16 lla_value1;       /* values for different advice types */
2109         __u32 lla_value2;
2110         __u64 lla_start;        /* first byte of extent for advice */
2111         __u64 lla_end;          /* last byte of extent for advice */
2112         __u32 lla_value3;
2113         __u32 lla_value4;
2114 };
2115
2116 enum ladvise_flag {
2117         LF_ASYNC        = 0x00000001,
2118         LF_UNSET        = 0x00000002,
2119 };
2120
2121 #define LADVISE_MAGIC 0x1ADF1CE0
2122 /* Masks of valid flags for each advice */
2123 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2124 /* Flags valid for all advices not explicitly specified */
2125 #define LF_DEFAULT_MASK LF_ASYNC
2126 /* All flags */
2127 #define LF_MASK (LF_ASYNC | LF_UNSET)
2128
2129 #define lla_lockahead_mode   lla_value1
2130 #define lla_peradvice_flags    lla_value2
2131 #define lla_lockahead_result lla_value3
2132
2133 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2134  * is used on the wire.  It is defined separately as we may need info which is
2135  * only used locally. */
2136 struct llapi_ladvise_hdr {
2137         __u32                   lah_magic;      /* LADVISE_MAGIC */
2138         __u32                   lah_count;      /* number of advices */
2139         __u64                   lah_flags;      /* from enum ladvise_flag */
2140         __u32                   lah_value1;     /* unused */
2141         __u32                   lah_value2;     /* unused */
2142         __u64                   lah_value3;     /* unused */
2143         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
2144 };
2145
2146 #define LAH_COUNT_MAX   (1024)
2147
2148 /* Shared key */
2149 enum sk_crypt_alg {
2150         SK_CRYPT_INVALID        = -1,
2151         SK_CRYPT_EMPTY          = 0,
2152         SK_CRYPT_AES256_CTR     = 1,
2153 };
2154
2155 enum sk_hmac_alg {
2156         SK_HMAC_INVALID = -1,
2157         SK_HMAC_EMPTY   = 0,
2158         SK_HMAC_SHA256  = 1,
2159         SK_HMAC_SHA512  = 2,
2160 };
2161
2162 struct sk_crypt_type {
2163         const char     *sct_name;
2164         int             sct_type;
2165 };
2166
2167 struct sk_hmac_type {
2168         const char     *sht_name;
2169         int             sht_type;
2170 };
2171
2172 enum lock_mode_user {
2173         MODE_READ_USER = 1,
2174         MODE_WRITE_USER,
2175         MODE_MAX_USER,
2176 };
2177
2178 #define LOCK_MODE_NAMES { \
2179         [MODE_READ_USER]  = "READ",\
2180         [MODE_WRITE_USER] = "WRITE"\
2181 }
2182
2183 enum lockahead_results {
2184         LLA_RESULT_SENT = 0,
2185         LLA_RESULT_DIFFERENT,
2186         LLA_RESULT_SAME,
2187 };
2188
2189 #if defined(__cplusplus)
2190 }
2191 #endif
2192
2193 /** @} lustreuser */
2194
2195 #endif /* _LUSTRE_USER_H */