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 #define LL_IOC_HEAT_GET                 _IOWR('f', 251, struct lu_heat)
 481 #define LL_IOC_HEAT_SET                 _IOW('f', 252, long)
 482
 483 #ifndef FS_IOC_FSGETXATTR
 484 /*
 485  * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
 486 */
 487 struct fsxattr {
 488         __u32           fsx_xflags;     /* xflags field value (get/set) */
 489         __u32           fsx_extsize;    /* extsize field value (get/set)*/
 490         __u32           fsx_nextents;   /* nextents field value (get)   */
 491         __u32           fsx_projid;     /* project identifier (get/set) */
 492         unsigned char   fsx_pad[12];
 493 };
 494 #define FS_IOC_FSGETXATTR               _IOR('X', 31, struct fsxattr)
 495 #define FS_IOC_FSSETXATTR               _IOW('X', 32, struct fsxattr)
 496 #endif
 497 #define LL_IOC_FSGETXATTR               FS_IOC_FSGETXATTR
 498 #define LL_IOC_FSSETXATTR               FS_IOC_FSSETXATTR
 499 #ifndef FS_XFLAG_PROJINHERIT
 500 #define FS_XFLAG_PROJINHERIT            0x00000200
 501 #endif
 502
 503
 504 #define LL_STATFS_LMV           1
 505 #define LL_STATFS_LOV           2
 506 #define LL_STATFS_NODELAY       4
 507
 508 #define IOC_MDC_TYPE            'i'
 509 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 510 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 511 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 512 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 513
 514 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 515
 516 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
 517  * files, but are unlikely to be used in practice and are not harmful if
 518  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
 519  * devices and are safe for use on new files. See LU-4209. */
 520 /* To be compatible with old statically linked binary we keep the check for
 521  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
 522 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
 523 #ifndef FASYNC
 524 #define FASYNC                  00020000   /* fcntl, for BSD compatibility */
 525 #endif
 526 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
 527 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
 528                                          O_LOV_DELAY_CREATE_MASK)
 529
 530 #define LL_FILE_IGNORE_LOCK     0x00000001
 531 #define LL_FILE_GROUP_LOCKED    0x00000002
 532 #define LL_FILE_READAHEA        0x00000004
 533 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 534 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 535
 536 #define LOV_USER_MAGIC_V1       0x0BD10BD0
 537 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
 538 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
 539 #define LOV_USER_MAGIC_V3       0x0BD30BD0
 540 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
 541 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
 542 #define LOV_USER_MAGIC_COMP_V1  0x0BD60BD0
 543
 544 #define LMV_USER_MAGIC          0x0CD30CD0    /* default lmv magic */
 545 #define LMV_USER_MAGIC_V0       0x0CD20CD0    /* old default lmv magic*/
 546 #define LMV_USER_MAGIC_SPECIFIC 0x0CD40CD0
 547
 548 #define LOV_PATTERN_NONE        0x000
 549 #define LOV_PATTERN_RAID0       0x001
 550 #define LOV_PATTERN_RAID1       0x002
 551 #define LOV_PATTERN_MDT         0x100
 552 #define LOV_PATTERN_CMOBD       0x200
 553
 554 #define LOV_PATTERN_F_MASK      0xffff0000
 555 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
 556 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
 557 #define LOV_PATTERN_DEFAULT     0xffffffff
 558
 559 #define LOV_OFFSET_DEFAULT      ((__u16)-1)
 560
 561 static inline bool lov_pattern_supported(__u32 pattern)
 562 {
 563         return (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_RAID0 ||
 564                (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_MDT;
 565 }
 566
 567 #define LOV_MAXPOOLNAME 15
 568 #define LOV_POOLNAMEF "%.15s"
 569
 570 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 571 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 572 #define LOV_MAX_STRIPE_COUNT_OLD 160
 573 /* This calculation is crafted so that input of 4096 will result in 160
 574  * which in turn is equal to old maximal stripe count.
 575  * XXX: In fact this is too simpified for now, what it also need is to get
 576  * ea_type argument to clearly know how much space each stripe consumes.
 577  *
 578  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 579  * allocation that is sufficient for the current generation of systems.
 580  *
 581  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 582 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 583 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 584 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 585
 586 #define XATTR_LUSTRE_PREFIX     "lustre."
 587 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 588
 589 #define lov_user_ost_data lov_user_ost_data_v1
 590 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 591         struct ost_id l_ost_oi;   /* OST object ID */
 592         __u32 l_ost_gen;          /* generation of this OST index */
 593         __u32 l_ost_idx;          /* OST index in LOV */
 594 } __attribute__((packed));
 595
 596 #define lov_user_md lov_user_md_v1
 597 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 598         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 599         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 600         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 601         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 602         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 603         union {
 604                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 605                                            * lmm_objects, use when writing */
 606                 __u16 lmm_layout_gen;     /* layout generation number
 607                                            * used when reading */
 608         };
 609         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 610 } __attribute__((packed,  __may_alias__));
 611
 612 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 613         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 614         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 615         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 616         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 617         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 618         union {
 619                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 620                                            * lmm_objects, use when writing */
 621                 __u16 lmm_layout_gen;     /* layout generation number
 622                                            * used when reading */
 623         };
 624         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 625         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 626 } __attribute__((packed));
 627
 628 struct lu_extent {
 629         __u64   e_start;
 630         __u64   e_end;
 631 };
 632
 633 #define DEXT "[%#llx, %#llx)"
 634 #define PEXT(ext) (ext)->e_start, (ext)->e_end
 635
 636 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
 637                                            struct lu_extent *e2)
 638 {
 639         return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
 640 }
 641
 642 static inline bool lu_extent_is_whole(struct lu_extent *e)
 643 {
 644         return e->e_start == 0 && e->e_end == LUSTRE_EOF;
 645 }
 646
 647 enum lov_comp_md_entry_flags {
 648         LCME_FL_STALE   = 0x00000001,   /* FLR: stale data */
 649         LCME_FL_PREF_RD = 0x00000002,   /* FLR: preferred for reading */
 650         LCME_FL_PREF_WR = 0x00000004,   /* FLR: preferred for writing */
 651         LCME_FL_PREF_RW = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
 652         LCME_FL_OFFLINE = 0x00000008,   /* Not used */
 653         LCME_FL_INIT    = 0x00000010,   /* instantiated */
 654         LCME_FL_NOSYNC  = 0x00000020,   /* FLR: no sync for the mirror */
 655         LCME_FL_NEG     = 0x80000000    /* used to indicate a negative flag,
 656                                            won't be stored on disk */
 657 };
 658
 659 #define LCME_KNOWN_FLAGS        (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
 660                                  LCME_FL_PREF_RW | LCME_FL_NOSYNC)
 661 /* The flags can be set by users at mirror creation time. */
 662 #define LCME_USER_FLAGS         (LCME_FL_PREF_RW)
 663
 664 /* The flags are for mirrors */
 665 #define LCME_MIRROR_FLAGS       (LCME_FL_NOSYNC)
 666
 667 /* These flags have meaning when set in a default layout and will be inherited
 668  * from the default/template layout set on a directory.
 669  */
 670 #define LCME_TEMPLATE_FLAGS     (LCME_FL_PREF_RW | LCME_FL_NOSYNC)
 671
 672 /* the highest bit in obdo::o_layout_version is used to mark if the file is
 673  * being resynced. */
 674 #define LU_LAYOUT_RESYNC        LCME_FL_NEG
 675
 676 /* lcme_id can be specified as certain flags, and the the first
 677  * bit of lcme_id is used to indicate that the ID is representing
 678  * certain LCME_FL_* but not a real ID. Which implies we can have
 679  * at most 31 flags (see LCME_FL_XXX). */
 680 enum lcme_id {
 681         LCME_ID_INVAL   = 0x0,
 682         LCME_ID_MAX     = 0x7FFFFFFF,
 683         LCME_ID_ALL     = 0xFFFFFFFF,
 684         LCME_ID_NOT_ID  = LCME_FL_NEG
 685 };
 686
 687 #define LCME_ID_MASK    LCME_ID_MAX
 688
 689 struct lov_comp_md_entry_v1 {
 690         __u32                   lcme_id;        /* unique id of component */
 691         __u32                   lcme_flags;     /* LCME_FL_XXX */
 692         struct lu_extent        lcme_extent;    /* file extent for component */
 693         __u32                   lcme_offset;    /* offset of component blob,
 694                                                    start from lov_comp_md_v1 */
 695         __u32                   lcme_size;      /* size of component blob */
 696         __u32                   lcme_layout_gen;
 697         __u64                   lcme_timestamp; /* snapshot time if applicable*/
 698         __u32                   lcme_padding_1;
 699 } __attribute__((packed));
 700
 701 #define SEQ_ID_MAX              0x0000FFFF
 702 #define SEQ_ID_MASK             SEQ_ID_MAX
 703 /* bit 30:16 of lcme_id is used to store mirror id */
 704 #define MIRROR_ID_MASK          0x7FFF0000
 705 #define MIRROR_ID_NEG           0x8000
 706 #define MIRROR_ID_SHIFT         16
 707
 708 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
 709 {
 710         return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
 711 }
 712
 713 static inline __u16 mirror_id_of(__u32 id)
 714 {
 715         return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
 716 }
 717
 718 /**
 719  * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
 720  */
 721 enum lov_comp_md_flags {
 722         /* the least 2 bits are used by FLR to record file state */
 723         LCM_FL_NONE          = 0,
 724         LCM_FL_RDONLY           = 1,
 725         LCM_FL_WRITE_PENDING    = 2,
 726         LCM_FL_SYNC_PENDING     = 3,
 727         LCM_FL_FLR_MASK         = 0x3,
 728 };
 729
 730 struct lov_comp_md_v1 {
 731         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
 732         __u32   lcm_size;       /* overall size including this struct */
 733         __u32   lcm_layout_gen;
 734         __u16   lcm_flags;
 735         __u16   lcm_entry_count;
 736         /* lcm_mirror_count stores the number of actual mirrors minus 1,
 737          * so that non-flr files will have value 0 meaning 1 mirror. */
 738         __u16   lcm_mirror_count;
 739         __u16   lcm_padding1[3];
 740         __u64   lcm_padding2;
 741         struct lov_comp_md_entry_v1 lcm_entries[0];
 742 } __attribute__((packed));
 743
 744 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
 745 {
 746         if (stripes == (__u16)-1)
 747                 stripes = 0;
 748
 749         if (lmm_magic == LOV_USER_MAGIC_V1)
 750                 return sizeof(struct lov_user_md_v1) +
 751                               stripes * sizeof(struct lov_user_ost_data_v1);
 752         return sizeof(struct lov_user_md_v3) +
 753                                 stripes * sizeof(struct lov_user_ost_data_v1);
 754 }
 755
 756 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 757  * use this.  It is unsafe to #define those values in this header as it
 758  * is possible the application has already #included <sys/stat.h>. */
 759 #ifdef HAVE_LOV_USER_MDS_DATA
 760 #define lov_user_mds_data lov_user_mds_data_v1
 761 struct lov_user_mds_data_v1 {
 762         lstat_t lmd_st;                 /* MDS stat struct */
 763         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 764 } __attribute__((packed));
 765 #endif
 766
 767 struct lmv_user_mds_data {
 768         struct lu_fid   lum_fid;
 769         __u32           lum_padding;
 770         __u32           lum_mds;
 771 };
 772
 773 enum lmv_hash_type {
 774         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
 775         LMV_HASH_TYPE_ALL_CHARS = 1,
 776         LMV_HASH_TYPE_FNV_1A_64 = 2,
 777         LMV_HASH_TYPE_MAX,
 778 };
 779
 780 #define LMV_HASH_NAME_ALL_CHARS "all_char"
 781 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
 782
 783 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
 784
 785 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
 786  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
 787 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 788 #define lmv_user_md lmv_user_md_v1
 789 struct lmv_user_md_v1 {
 790         __u32   lum_magic;       /* must be the first field */
 791         __u32   lum_stripe_count;  /* dirstripe count */
 792         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
 793         __u32   lum_hash_type;     /* Dir stripe policy */
 794         __u32   lum_type;         /* LMV type: default or normal */
 795         __u32   lum_padding1;
 796         __u32   lum_padding2;
 797         __u32   lum_padding3;
 798         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
 799         struct  lmv_user_mds_data  lum_objects[0];
 800 } __attribute__((packed));
 801
 802 static inline int lmv_user_md_size(int stripes, int lmm_magic)
 803 {
 804         int size = sizeof(struct lmv_user_md);
 805
 806         if (lmm_magic == LMV_USER_MAGIC_SPECIFIC)
 807                 size += stripes * sizeof(struct lmv_user_mds_data);
 808
 809         return size;
 810 }
 811
 812 struct ll_recreate_obj {
 813         __u64 lrc_id;
 814         __u32 lrc_ost_idx;
 815 };
 816
 817 struct ll_fid {
 818         __u64 id;         /* holds object id */
 819         __u32 generation; /* holds object generation */
 820         __u32 f_type;     /* holds object type or stripe idx when passing it to
 821                            * OST for saving into EA. */
 822 };
 823
 824 #define UUID_MAX        40
 825 struct obd_uuid {
 826         char uuid[UUID_MAX];
 827 };
 828
 829 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
 830                                    const struct obd_uuid *u2)
 831 {
 832         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 833 }
 834
 835 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 836 {
 837         return uuid->uuid[0] == '\0';
 838 }
 839
 840 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 841 {
 842         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 843         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 844 }
 845
 846 /* For printf's only, make sure uuid is terminated */
 847 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
 848 {
 849         if (uuid == NULL)
 850                 return NULL;
 851
 852         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 853                 /* Obviously not safe, but for printfs, no real harm done...
 854                    we're always null-terminated, even in a race. */
 855                 static char temp[sizeof(*uuid)];
 856                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 857                 temp[sizeof(*uuid) - 1] = '\0';
 858                 return temp;
 859         }
 860         return (char *)(uuid->uuid);
 861 }
 862
 863 #define LUSTRE_MAXFSNAME 8
 864
 865 /* Extract fsname from uuid (or target name) of a target
 866    e.g. (myfs-OST0007_UUID -> myfs)
 867    see also deuuidify. */
 868 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 869 {
 870         char *p;
 871
 872         strncpy(buf, uuid, buflen - 1);
 873         buf[buflen - 1] = '\0';
 874         p = strrchr(buf, '-');
 875         if (p != NULL)
 876                 *p = '\0';
 877 }
 878
 879 /* printf display format for Lustre FIDs
 880  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
 881 #define FID_NOBRACE_LEN 40
 882 #define FID_LEN (FID_NOBRACE_LEN + 2)
 883 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
 884 #define DFID "["DFID_NOBRACE"]"
 885 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
 886
 887 /* scanf input parse format for fids in DFID_NOBRACE format
 888  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
 889  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
 890 #define SFID "0x%llx:0x%x:0x%x"
 891 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
 892
 893 /********* Quotas **********/
 894
 895 #define LUSTRE_QUOTABLOCK_BITS 10
 896 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
 897
 898 static inline __u64 lustre_stoqb(size_t space)
 899 {
 900         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
 901 }
 902
 903 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
 904 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
 905 #define Q_GETOINFO      0x800102 /* get obd quota info */
 906 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
 907 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
 908
 909 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 910 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
 911 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
 912 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 913 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 914 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 915 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 916 /* lustre-specific control commands */
 917 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
 918 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
 919 #define LUSTRE_Q_GETDEFAULT  0x80000d     /* get default quota */
 920 #define LUSTRE_Q_SETDEFAULT  0x80000e     /* set default quota */
 921
 922 /* In the current Lustre implementation, the grace time is either the time
 923  * or the timestamp to be used after some quota ID exceeds the soft limt,
 924  * 48 bits should be enough, its high 16 bits can be used as quota flags.
 925  * */
 926 #define LQUOTA_GRACE_BITS       48
 927 #define LQUOTA_GRACE_MASK       ((1ULL << LQUOTA_GRACE_BITS) - 1)
 928 #define LQUOTA_GRACE_MAX        LQUOTA_GRACE_MASK
 929 #define LQUOTA_GRACE(t)         (t & LQUOTA_GRACE_MASK)
 930 #define LQUOTA_FLAG(t)          (t >> LQUOTA_GRACE_BITS)
 931 #define LQUOTA_GRACE_FLAG(t, f) ((__u64)t | (__u64)f << LQUOTA_GRACE_BITS)
 932
 933 /* different quota flags */
 934
 935 /* the default quota flag, the corresponding quota ID will use the default
 936  * quota setting, the hardlimit and softlimit of its quota record in the global
 937  * quota file will be set to 0, the low 48 bits of the grace will be set to 0
 938  * and high 16 bits will contain this flag (see above comment).
 939  * */
 940 #define LQUOTA_FLAG_DEFAULT     0x0001
 941
 942 #define ALLQUOTA 255       /* set all quota */
 943 static inline char *qtype_name(int qtype)
 944 {
 945         switch (qtype) {
 946         case USRQUOTA:
 947                 return "usr";
 948         case GRPQUOTA:
 949                 return "grp";
 950         case PRJQUOTA:
 951                 return "prj";
 952         }
 953         return "unknown";
 954 }
 955
 956 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 957 #define SEPOL_DOWNCALL_MAGIC 0x8b8bb842
 958
 959 /* permission */
 960 #define N_PERMS_MAX      64
 961
 962 struct perm_downcall_data {
 963         __u64 pdd_nid;
 964         __u32 pdd_perm;
 965         __u32 pdd_padding;
 966 };
 967
 968 struct identity_downcall_data {
 969         __u32                            idd_magic;
 970         __u32                            idd_err;
 971         __u32                            idd_uid;
 972         __u32                            idd_gid;
 973         __u32                            idd_nperms;
 974         __u32                            idd_ngroups;
 975         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 976         __u32                            idd_groups[0];
 977 };
 978
 979 struct sepol_downcall_data {
 980         __u32          sdd_magic;
 981         time_t         sdd_sepol_mtime;
 982         __u16          sdd_sepol_len;
 983         char           sdd_sepol[0];
 984 };
 985
 986 #ifdef NEED_QUOTA_DEFS
 987 #ifndef QIF_BLIMITS
 988 #define QIF_BLIMITS     1
 989 #define QIF_SPACE       2
 990 #define QIF_ILIMITS     4
 991 #define QIF_INODES      8
 992 #define QIF_BTIME       16
 993 #define QIF_ITIME       32
 994 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 995 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 996 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 997 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 998 #endif
 999
1000 #endif /* !__KERNEL__ */
1001
1002 /* lustre volatile file support
1003  * file name header: ".^L^S^T^R:volatile"
1004  */
1005 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
1006 #define LUSTRE_VOLATILE_HDR_LEN 14
1007
1008 enum lustre_quota_version {
1009         LUSTRE_QUOTA_V2 = 1
1010 };
1011
1012 /* XXX: same as if_dqinfo struct in kernel */
1013 struct obd_dqinfo {
1014         __u64 dqi_bgrace;
1015         __u64 dqi_igrace;
1016         __u32 dqi_flags;
1017         __u32 dqi_valid;
1018 };
1019
1020 /* XXX: same as if_dqblk struct in kernel, plus one padding */
1021 struct obd_dqblk {
1022         __u64 dqb_bhardlimit;
1023         __u64 dqb_bsoftlimit;
1024         __u64 dqb_curspace;
1025         __u64 dqb_ihardlimit;
1026         __u64 dqb_isoftlimit;
1027         __u64 dqb_curinodes;
1028         __u64 dqb_btime;
1029         __u64 dqb_itime;
1030         __u32 dqb_valid;
1031         __u32 dqb_padding;
1032 };
1033
1034 enum {
1035         QC_GENERAL      = 0,
1036         QC_MDTIDX       = 1,
1037         QC_OSTIDX       = 2,
1038         QC_UUID         = 3
1039 };
1040
1041 struct if_quotactl {
1042         __u32                   qc_cmd;
1043         __u32                   qc_type;
1044         __u32                   qc_id;
1045         __u32                   qc_stat;
1046         __u32                   qc_valid;
1047         __u32                   qc_idx;
1048         struct obd_dqinfo       qc_dqinfo;
1049         struct obd_dqblk        qc_dqblk;
1050         char                    obd_type[16];
1051         struct obd_uuid         obd_uuid;
1052 };
1053
1054 /* swap layout flags */
1055 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
1056 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
1057 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
1058 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
1059 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
1060
1061 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
1062 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
1063 struct lustre_swap_layouts {
1064         __u64   sl_flags;
1065         __u32   sl_fd;
1066         __u32   sl_gid;
1067         __u64   sl_dv1;
1068         __u64   sl_dv2;
1069 };
1070
1071 /** Bit-mask of valid attributes */
1072 /* The LA_* flags are written to disk as part of the ChangeLog records
1073  * so they are part of the on-disk and network protocol, and cannot be changed.
1074  * Only the first 12 bits are currently saved.
1075  */
1076 enum la_valid {
1077         LA_ATIME        = 1 << 0,       /* 0x00001 */
1078         LA_MTIME        = 1 << 1,       /* 0x00002 */
1079         LA_CTIME        = 1 << 2,       /* 0x00004 */
1080         LA_SIZE         = 1 << 3,       /* 0x00008 */
1081         LA_MODE         = 1 << 4,       /* 0x00010 */
1082         LA_UID          = 1 << 5,       /* 0x00020 */
1083         LA_GID          = 1 << 6,       /* 0x00040 */
1084         LA_BLOCKS       = 1 << 7,       /* 0x00080 */
1085         LA_TYPE         = 1 << 8,       /* 0x00100 */
1086         LA_FLAGS        = 1 << 9,       /* 0x00200 */
1087         LA_NLINK        = 1 << 10,      /* 0x00400 */
1088         LA_RDEV         = 1 << 11,      /* 0x00800 */
1089         LA_BLKSIZE      = 1 << 12,      /* 0x01000 */
1090         LA_KILL_SUID    = 1 << 13,      /* 0x02000 */
1091         LA_KILL_SGID    = 1 << 14,      /* 0x04000 */
1092         LA_PROJID       = 1 << 15,      /* 0x08000 */
1093         LA_LAYOUT_VERSION = 1 << 16,    /* 0x10000 */
1094         LA_LSIZE        = 1 << 17,      /* 0x20000 */
1095         LA_LBLOCKS      = 1 << 18,      /* 0x40000 */
1096         /**
1097          * Attributes must be transmitted to OST objects
1098          */
1099         LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1100 };
1101
1102 #define MDS_FMODE_READ           00000001
1103 #define MDS_FMODE_WRITE          00000002
1104
1105 #define MDS_FMODE_CLOSED         00000000
1106 #define MDS_FMODE_EXEC           00000004
1107 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
1108 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
1109 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
1110
1111 #define MDS_OPEN_CREATED         00000010
1112 /*      MDS_OPEN_CROSS           00000020 obsolete in 2.12, internal use only */
1113
1114 #define MDS_OPEN_CREAT           00000100
1115 #define MDS_OPEN_EXCL            00000200
1116 #define MDS_OPEN_TRUNC           00001000
1117 #define MDS_OPEN_APPEND          00002000
1118 #define MDS_OPEN_SYNC            00010000
1119 #define MDS_OPEN_DIRECTORY       00200000
1120
1121 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
1122 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1123 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1124 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1125                                            * We do not support JOIN FILE
1126                                            * anymore, reserve this flags
1127                                            * just for preventing such bit
1128                                            * to be reused. */
1129
1130 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1131 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1132 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1133 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
1134 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
1135                                               * hsm restore) */
1136 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
1137                                                 unlinked */
1138 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
1139                                               * delegation, succeed if it's not
1140                                               * being opened with conflict mode.
1141                                               */
1142 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
1143
1144 #define MDS_OPEN_RESYNC    04000000000000ULL /* FLR: file resync */
1145
1146 /* lustre internal open flags, which should not be set from user space */
1147 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
1148                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
1149                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
1150                               MDS_OPEN_RELEASE | MDS_OPEN_RESYNC)
1151
1152
1153 /********* Changelogs **********/
1154 /** Changelog record types */
1155 enum changelog_rec_type {
1156         CL_NONE     = -1,
1157         CL_MARK     = 0,
1158         CL_CREATE   = 1,  /* namespace */
1159         CL_MKDIR    = 2,  /* namespace */
1160         CL_HARDLINK = 3,  /* namespace */
1161         CL_SOFTLINK = 4,  /* namespace */
1162         CL_MKNOD    = 5,  /* namespace */
1163         CL_UNLINK   = 6,  /* namespace */
1164         CL_RMDIR    = 7,  /* namespace */
1165         CL_RENAME   = 8,  /* namespace */
1166         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
1167         CL_OPEN     = 10, /* not currently used */
1168         CL_CLOSE    = 11, /* may be written to log only with mtime change */
1169         CL_LAYOUT   = 12, /* file layout/striping modified */
1170         CL_TRUNC    = 13,
1171         CL_SETATTR  = 14,
1172         CL_SETXATTR = 15,
1173         CL_XATTR    = CL_SETXATTR, /* Deprecated name */
1174         CL_HSM      = 16, /* HSM specific events, see flags */
1175         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
1176         CL_CTIME    = 18,
1177         CL_ATIME    = 19,
1178         CL_MIGRATE  = 20,
1179         CL_FLRW     = 21, /* FLR: file was firstly written */
1180         CL_RESYNC   = 22, /* FLR: file was resync-ed */
1181         CL_GETXATTR = 23,
1182         CL_DN_OPEN  = 24, /* denied open */
1183         CL_LAST
1184 };
1185
1186 static inline const char *changelog_type2str(int type) {
1187         static const char *changelog_str[] = {
1188                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1189                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
1190                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT",
1191                 "FLRW",  "RESYNC","GXATR", "NOPEN",
1192         };
1193
1194         if (type >= 0 && type < CL_LAST)
1195                 return changelog_str[type];
1196         return NULL;
1197 }
1198
1199 /* 12 bits of per-record data can be stored in the bottom of the flags */
1200 #define CLF_FLAGSHIFT   12
1201 enum changelog_rec_flags {
1202         CLF_VERSION     = 0x1000,
1203         CLF_RENAME      = 0x2000,
1204         CLF_JOBID       = 0x4000,
1205         CLF_EXTRA_FLAGS = 0x8000,
1206         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID |
1207                           CLF_EXTRA_FLAGS,
1208         CLF_FLAGMASK    = (1U << CLF_FLAGSHIFT) - 1,
1209         CLF_VERMASK     = ~CLF_FLAGMASK,
1210 };
1211
1212
1213 /* Anything under the flagmask may be per-type (if desired) */
1214 /* Flags for unlink */
1215 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
1216 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1217                                      /* HSM cleaning needed */
1218 /* Flags for rename */
1219 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
1220                                         * of target */
1221 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
1222                                         * has an archive in backend */
1223
1224 /* Flags for HSM */
1225 /* 12b used (from high weight to low weight):
1226  * 2b for flags
1227  * 3b for event
1228  * 7b for error code
1229  */
1230 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
1231 #define CLF_HSM_ERR_H        6
1232 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
1233 #define CLF_HSM_EVENT_H      9
1234 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
1235 #define CLF_HSM_FLAG_H      11
1236 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
1237 #define CLF_HSM_SPARE_H     15
1238 #define CLF_HSM_LAST        15
1239
1240 /* Remove bits higher than _h, then extract the value
1241  * between _h and _l by shifting lower weigth to bit 0. */
1242 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1243                                    >> (CLF_HSM_LAST - _h + _l))
1244
1245 #define CLF_HSM_SUCCESS      0x00
1246 #define CLF_HSM_MAXERROR     0x7E
1247 #define CLF_HSM_ERROVERFLOW  0x7F
1248
1249 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
1250
1251 /* 3 bits field => 8 values allowed */
1252 enum hsm_event {
1253         HE_ARCHIVE      = 0,
1254         HE_RESTORE      = 1,
1255         HE_CANCEL       = 2,
1256         HE_RELEASE      = 3,
1257         HE_REMOVE       = 4,
1258         HE_STATE        = 5,
1259         HE_SPARE1       = 6,
1260         HE_SPARE2       = 7,
1261 };
1262
1263 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1264 {
1265         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1266                                             CLF_HSM_EVENT_L);
1267 }
1268
1269 static inline void hsm_set_cl_event(enum changelog_rec_flags *clf_flags,
1270                                     enum hsm_event he)
1271 {
1272         *clf_flags |= (he << CLF_HSM_EVENT_L);
1273 }
1274
1275 static inline __u16 hsm_get_cl_flags(enum changelog_rec_flags clf_flags)
1276 {
1277         return CLF_GET_BITS(clf_flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1278 }
1279
1280 static inline void hsm_set_cl_flags(enum changelog_rec_flags *clf_flags,
1281                                     unsigned int bits)
1282 {
1283         *clf_flags |= (bits << CLF_HSM_FLAG_L);
1284 }
1285
1286 static inline int hsm_get_cl_error(enum changelog_rec_flags clf_flags)
1287 {
1288         return CLF_GET_BITS(clf_flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1289 }
1290
1291 static inline void hsm_set_cl_error(enum changelog_rec_flags *clf_flags,
1292                                     unsigned int error)
1293 {
1294         *clf_flags |= (error << CLF_HSM_ERR_L);
1295 }
1296
1297 enum changelog_rec_extra_flags {
1298         CLFE_INVALID    = 0,
1299         CLFE_UIDGID     = 0x0001,
1300         CLFE_NID        = 0x0002,
1301         CLFE_OPEN       = 0x0004,
1302         CLFE_XATTR      = 0x0008,
1303         CLFE_SUPPORTED  = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1304 };
1305
1306 enum changelog_send_flag {
1307         /* Not yet implemented */
1308         CHANGELOG_FLAG_FOLLOW      = 0x01,
1309         /* Blocking IO makes sense in case of slow user parsing of the records,
1310          * but it also prevents us from cleaning up if the records are not
1311          * consumed. */
1312         CHANGELOG_FLAG_BLOCK       = 0x02,
1313         /* Pack jobid into the changelog records if available. */
1314         CHANGELOG_FLAG_JOBID       = 0x04,
1315         /* Pack additional flag bits into the changelog record */
1316         CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1317 };
1318
1319 enum changelog_send_extra_flag {
1320         /* Pack uid/gid into the changelog record */
1321         CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1322         /* Pack nid into the changelog record */
1323         CHANGELOG_EXTRA_FLAG_NID    = 0x02,
1324         /* Pack open mode into the changelog record */
1325         CHANGELOG_EXTRA_FLAG_OMODE  = 0x04,
1326         /* Pack xattr name into the changelog record */
1327         CHANGELOG_EXTRA_FLAG_XATTR  = 0x08,
1328 };
1329
1330 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1331                                   changelog_rec_offset(CLF_SUPPORTED, \
1332                                                        CLFE_SUPPORTED), 8)
1333
1334 /* 31 usable bytes string + null terminator. */
1335 #define LUSTRE_JOBID_SIZE       32
1336
1337 /* This is the minimal changelog record. It can contain extensions
1338  * such as rename fields or process jobid. Its exact content is described
1339  * by the cr_flags and cr_extra_flags.
1340  *
1341  * Extensions are packed in the same order as their corresponding flags,
1342  * then in the same order as their corresponding extra flags.
1343  */
1344 struct changelog_rec {
1345         __u16                   cr_namelen;
1346         __u16                   cr_flags; /**< \a changelog_rec_flags */
1347         __u32                   cr_type;  /**< \a changelog_rec_type */
1348         __u64                   cr_index; /**< changelog record number */
1349         __u64                   cr_prev;  /**< last index for this target fid */
1350         __u64                   cr_time;
1351         union {
1352                 struct lu_fid   cr_tfid;        /**< target fid */
1353                 __u32           cr_markerflags; /**< CL_MARK flags */
1354         };
1355         struct lu_fid           cr_pfid;        /**< parent fid */
1356 };
1357
1358 /* Changelog extension for RENAME. */
1359 struct changelog_ext_rename {
1360         struct lu_fid           cr_sfid;     /**< source fid, or zero */
1361         struct lu_fid           cr_spfid;    /**< source parent fid, or zero */
1362 };
1363
1364 /* Changelog extension to include JOBID. */
1365 struct changelog_ext_jobid {
1366         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
1367 };
1368
1369 /* Changelog extension to include additional flags. */
1370 struct changelog_ext_extra_flags {
1371         __u64 cr_extra_flags; /* Additional CLFE_* flags */
1372 };
1373
1374 /* Changelog extra extension to include UID/GID. */
1375 struct changelog_ext_uidgid {
1376         __u64   cr_uid;
1377         __u64   cr_gid;
1378 };
1379
1380 /* Changelog extra extension to include NID. */
1381 struct changelog_ext_nid {
1382         /* have __u64 instead of lnet_nid_t type for use by client api */
1383         __u64 cr_nid;
1384         /* for use when IPv6 support is added */
1385         __u64 extra;
1386         __u32 padding;
1387 };
1388
1389 /* Changelog extra extension to include low 32 bits of MDS_OPEN_* flags. */
1390 struct changelog_ext_openmode {
1391         __u32 cr_openflags;
1392 };
1393
1394 /* Changelog extra extension to include xattr */
1395 struct changelog_ext_xattr {
1396         char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1397 };
1398
1399 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1400         const struct changelog_rec *rec);
1401
1402 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf,
1403                                           enum changelog_rec_extra_flags cref)
1404 {
1405         size_t size = sizeof(struct changelog_rec);
1406
1407         if (crf & CLF_RENAME)
1408                 size += sizeof(struct changelog_ext_rename);
1409
1410         if (crf & CLF_JOBID)
1411                 size += sizeof(struct changelog_ext_jobid);
1412
1413         if (crf & CLF_EXTRA_FLAGS) {
1414                 size += sizeof(struct changelog_ext_extra_flags);
1415                 if (cref & CLFE_UIDGID)
1416                         size += sizeof(struct changelog_ext_uidgid);
1417                 if (cref & CLFE_NID)
1418                         size += sizeof(struct changelog_ext_nid);
1419                 if (cref & CLFE_OPEN)
1420                         size += sizeof(struct changelog_ext_openmode);
1421                 if (cref & CLFE_XATTR)
1422                         size += sizeof(struct changelog_ext_xattr);
1423         }
1424
1425         return size;
1426 }
1427
1428 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1429 {
1430         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1431
1432         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1433                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1434
1435         return changelog_rec_offset(rec->cr_flags, cref);
1436 }
1437
1438 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1439 {
1440         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1441 }
1442
1443 static inline
1444 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1445 {
1446         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1447
1448         return (struct changelog_ext_rename *)((char *)rec +
1449                                                changelog_rec_offset(crf,
1450                                                                  CLFE_INVALID));
1451 }
1452
1453 /* The jobid follows the rename extension, if present */
1454 static inline
1455 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1456 {
1457         enum changelog_rec_flags crf = rec->cr_flags &
1458                                         (CLF_VERSION | CLF_RENAME);
1459
1460         return (struct changelog_ext_jobid *)((char *)rec +
1461                                               changelog_rec_offset(crf,
1462                                                                  CLFE_INVALID));
1463 }
1464
1465 /* The additional flags follow the rename and jobid extensions, if present */
1466 static inline
1467 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1468         const struct changelog_rec *rec)
1469 {
1470         enum changelog_rec_flags crf = rec->cr_flags &
1471                 (CLF_VERSION | CLF_RENAME | CLF_JOBID);
1472
1473         return (struct changelog_ext_extra_flags *)((char *)rec +
1474                                                  changelog_rec_offset(crf,
1475                                                                  CLFE_INVALID));
1476 }
1477
1478 /* The uid/gid is the first extra extension */
1479 static inline
1480 struct changelog_ext_uidgid *changelog_rec_uidgid(
1481         const struct changelog_rec *rec)
1482 {
1483         enum changelog_rec_flags crf = rec->cr_flags &
1484                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1485
1486         return (struct changelog_ext_uidgid *)((char *)rec +
1487                                                changelog_rec_offset(crf,
1488                                                                  CLFE_INVALID));
1489 }
1490
1491 /* The nid is the second extra extension */
1492 static inline
1493 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
1494 {
1495         enum changelog_rec_flags crf = rec->cr_flags &
1496                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1497         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1498
1499         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1500                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1501                        CLFE_UIDGID;
1502
1503         return (struct changelog_ext_nid *)((char *)rec +
1504                                             changelog_rec_offset(crf, cref));
1505 }
1506
1507 /* The OPEN mode is the third extra extension */
1508 static inline
1509 struct changelog_ext_openmode *changelog_rec_openmode(
1510         const struct changelog_rec *rec)
1511 {
1512         enum changelog_rec_flags crf = rec->cr_flags &
1513                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1514         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1515
1516         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1517                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1518                        (CLFE_UIDGID | CLFE_NID);
1519
1520         return (struct changelog_ext_openmode *)((char *)rec +
1521                                                changelog_rec_offset(crf, cref));
1522 }
1523
1524 /* The xattr name is the fourth extra extension */
1525 static inline
1526 struct changelog_ext_xattr *changelog_rec_xattr(
1527         const struct changelog_rec *rec)
1528 {
1529         enum changelog_rec_flags crf = rec->cr_flags &
1530                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1531         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1532
1533         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1534                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags &
1535                         (CLFE_UIDGID | CLFE_NID | CLFE_OPEN);
1536
1537         return (struct changelog_ext_xattr *)((char *)rec +
1538                                               changelog_rec_offset(crf, cref));
1539 }
1540
1541 /* The name follows the rename, jobid  and extra flags extns, if present */
1542 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1543 {
1544         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1545
1546         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1547                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1548
1549         return (char *)rec + changelog_rec_offset(rec->cr_flags & CLF_SUPPORTED,
1550                                                   cref & CLFE_SUPPORTED);
1551 }
1552
1553 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1554 {
1555         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1556 }
1557
1558 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1559 {
1560         char *cr_name = changelog_rec_name(rec);
1561
1562         return cr_name + strlen(cr_name) + 1;
1563 }
1564
1565 /**
1566  * Remap a record to the desired format as specified by the crf flags.
1567  * The record must be big enough to contain the final remapped version.
1568  * Superfluous extension fields are removed and missing ones are added
1569  * and zeroed. The flags of the record are updated accordingly.
1570  *
1571  * The jobid and rename extensions can be added to a record, to match the
1572  * format an application expects, typically. In this case, the newly added
1573  * fields will be zeroed.
1574  * The Jobid field can be removed, to guarantee compatibility with older
1575  * clients that don't expect this field in the records they process.
1576  *
1577  * The following assumptions are being made:
1578  *   - CLF_RENAME will not be removed
1579  *   - CLF_JOBID will not be added without CLF_RENAME being added too
1580  *   - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
1581  *
1582  * @param[in,out]  rec         The record to remap.
1583  * @param[in]      crf_wanted  Flags describing the desired extensions.
1584  * @param[in]      cref_want   Flags describing the desired extra extensions.
1585  */
1586 static inline void changelog_remap_rec(struct changelog_rec *rec,
1587                                        enum changelog_rec_flags crf_wanted,
1588                                        enum changelog_rec_extra_flags cref_want)
1589 {
1590         char *xattr_mov = NULL;
1591         char *omd_mov = NULL;
1592         char *nid_mov = NULL;
1593         char *uidgid_mov = NULL;
1594         char *ef_mov;
1595         char *jid_mov;
1596         char *rnm_mov;
1597         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1598
1599         crf_wanted &= CLF_SUPPORTED;
1600         cref_want &= CLFE_SUPPORTED;
1601
1602         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
1603                 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
1604                     (rec->cr_flags & CLF_EXTRA_FLAGS &&
1605                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
1606                                                         CLFE_SUPPORTED) ==
1607                                                                      cref_want))
1608                         return;
1609         }
1610
1611         /* First move the variable-length name field */
1612         memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
1613                 changelog_rec_name(rec), rec->cr_namelen);
1614
1615         /* Locations of extensions in the remapped record */
1616         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1617                 xattr_mov = (char *)rec +
1618                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1619                                              cref_want & ~CLFE_XATTR);
1620                 omd_mov = (char *)rec +
1621                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1622                                              cref_want & ~(CLFE_OPEN |
1623                                                            CLFE_XATTR));
1624                 nid_mov = (char *)rec +
1625                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1626                                              cref_want & ~(CLFE_NID |
1627                                                            CLFE_OPEN |
1628                                                            CLFE_XATTR));
1629                 uidgid_mov = (char *)rec +
1630                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1631                                              cref_want & ~(CLFE_UIDGID |
1632                                                            CLFE_NID |
1633                                                            CLFE_OPEN |
1634                                                            CLFE_XATTR));
1635                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1636         }
1637
1638         ef_mov  = (char *)rec +
1639                   changelog_rec_offset(crf_wanted & ~CLF_EXTRA_FLAGS,
1640                                        CLFE_INVALID);
1641         jid_mov = (char *)rec +
1642                   changelog_rec_offset(crf_wanted &
1643                                        ~(CLF_EXTRA_FLAGS | CLF_JOBID),
1644                                        CLFE_INVALID);
1645         rnm_mov = (char *)rec +
1646                   changelog_rec_offset(crf_wanted &
1647                                        ~(CLF_EXTRA_FLAGS |
1648                                          CLF_JOBID |
1649                                          CLF_RENAME),
1650                                        CLFE_INVALID);
1651
1652         /* Move the extension fields to the desired positions */
1653         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1654             (rec->cr_flags & CLF_EXTRA_FLAGS)) {
1655                 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
1656                         memmove(xattr_mov, changelog_rec_xattr(rec),
1657                                 sizeof(struct changelog_ext_xattr));
1658
1659                 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
1660                         memmove(omd_mov, changelog_rec_openmode(rec),
1661                                 sizeof(struct changelog_ext_openmode));
1662
1663                 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
1664                         memmove(nid_mov, changelog_rec_nid(rec),
1665                                 sizeof(struct changelog_ext_nid));
1666
1667                 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
1668                         memmove(uidgid_mov, changelog_rec_uidgid(rec),
1669                                 sizeof(struct changelog_ext_uidgid));
1670
1671                 memmove(ef_mov, changelog_rec_extra_flags(rec),
1672                         sizeof(struct changelog_ext_extra_flags));
1673         }
1674
1675         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1676                 memmove(jid_mov, changelog_rec_jobid(rec),
1677                         sizeof(struct changelog_ext_jobid));
1678
1679         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1680                 memmove(rnm_mov, changelog_rec_rename(rec),
1681                         sizeof(struct changelog_ext_rename));
1682
1683         /* Clear newly added fields */
1684         if (xattr_mov && (cref_want & CLFE_XATTR) &&
1685             !(cref & CLFE_XATTR))
1686                 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
1687
1688         if (omd_mov && (cref_want & CLFE_OPEN) &&
1689             !(cref & CLFE_OPEN))
1690                 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
1691
1692         if (nid_mov && (cref_want & CLFE_NID) &&
1693             !(cref & CLFE_NID))
1694                 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
1695
1696         if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
1697             !(cref & CLFE_UIDGID))
1698                 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
1699
1700         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1701             !(rec->cr_flags & CLF_EXTRA_FLAGS))
1702                 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
1703
1704         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1705                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1706
1707         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1708                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1709
1710         /* Update the record's flags accordingly */
1711         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1712         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1713                 changelog_rec_extra_flags(rec)->cr_extra_flags =
1714                         changelog_rec_extra_flags(rec)->cr_extra_flags |
1715                         cref_want;
1716 }
1717
1718 enum changelog_message_type {
1719         CL_RECORD = 10, /* message is a changelog_rec */
1720         CL_EOF    = 11, /* at end of current changelog */
1721 };
1722
1723 /********* Misc **********/
1724
1725 struct ioc_data_version {
1726         __u64   idv_version;
1727         __u32   idv_layout_version; /* FLR: layout version for OST objects */
1728         __u32   idv_flags;      /* enum ioc_data_version_flags */
1729 };
1730
1731 enum ioc_data_version_flags {
1732         LL_DV_RD_FLUSH  = (1 << 0), /* Flush dirty pages from clients */
1733         LL_DV_WR_FLUSH  = (1 << 1), /* Flush all caching pages from clients */
1734 };
1735
1736 #ifndef offsetof
1737 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1738 #endif
1739
1740 #define dot_lustre_name ".lustre"
1741
1742
1743 /********* HSM **********/
1744
1745 /** HSM per-file state
1746  * See HSM_FLAGS below.
1747  */
1748 enum hsm_states {
1749         HS_NONE         = 0x00000000,
1750         HS_EXISTS       = 0x00000001,
1751         HS_DIRTY        = 0x00000002,
1752         HS_RELEASED     = 0x00000004,
1753         HS_ARCHIVED     = 0x00000008,
1754         HS_NORELEASE    = 0x00000010,
1755         HS_NOARCHIVE    = 0x00000020,
1756         HS_LOST         = 0x00000040,
1757 };
1758
1759 /* HSM user-setable flags. */
1760 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1761
1762 /* Other HSM flags. */
1763 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1764
1765 /*
1766  * All HSM-related possible flags that could be applied to a file.
1767  * This should be kept in sync with hsm_states.
1768  */
1769 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1770
1771 /**
1772  * HSM request progress state
1773  */
1774 enum hsm_progress_states {
1775         HPS_NONE        = 0,
1776         HPS_WAITING     = 1,
1777         HPS_RUNNING     = 2,
1778         HPS_DONE        = 3,
1779 };
1780
1781 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1782 {
1783         switch  (s) {
1784         case HPS_WAITING:       return "waiting";
1785         case HPS_RUNNING:       return "running";
1786         case HPS_DONE:          return "done";
1787         default:                return "unknown";
1788         }
1789 }
1790
1791 struct hsm_extent {
1792         __u64 offset;
1793         __u64 length;
1794 } __attribute__((packed));
1795
1796 /**
1797  * Current HSM states of a Lustre file.
1798  *
1799  * This structure purpose is to be sent to user-space mainly. It describes the
1800  * current HSM flags and in-progress action.
1801  */
1802 struct hsm_user_state {
1803         /** Current HSM states, from enum hsm_states. */
1804         __u32                   hus_states;
1805         __u32                   hus_archive_id;
1806         /**  The current undergoing action, if there is one */
1807         __u32                   hus_in_progress_state;
1808         __u32                   hus_in_progress_action;
1809         struct hsm_extent       hus_in_progress_location;
1810         char                    hus_extended_info[];
1811 };
1812
1813 struct hsm_state_set_ioc {
1814         struct lu_fid   hssi_fid;
1815         __u64           hssi_setmask;
1816         __u64           hssi_clearmask;
1817 };
1818
1819 /*
1820  * This structure describes the current in-progress action for a file.
1821  * it is retuned to user space and send over the wire
1822  */
1823 struct hsm_current_action {
1824         /**  The current undergoing action, if there is one */
1825         /* state is one of hsm_progress_states */
1826         __u32                   hca_state;
1827         /* action is one of hsm_user_action */
1828         __u32                   hca_action;
1829         struct hsm_extent       hca_location;
1830 };
1831
1832 /***** HSM user requests ******/
1833 /* User-generated (lfs/ioctl) request types */
1834 enum hsm_user_action {
1835         HUA_NONE    =  1, /* no action (noop) */
1836         HUA_ARCHIVE = 10, /* copy to hsm */
1837         HUA_RESTORE = 11, /* prestage */
1838         HUA_RELEASE = 12, /* drop ost objects */
1839         HUA_REMOVE  = 13, /* remove from archive */
1840         HUA_CANCEL  = 14  /* cancel a request */
1841 };
1842
1843 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1844 {
1845         switch  (a) {
1846         case HUA_NONE:    return "NOOP";
1847         case HUA_ARCHIVE: return "ARCHIVE";
1848         case HUA_RESTORE: return "RESTORE";
1849         case HUA_RELEASE: return "RELEASE";
1850         case HUA_REMOVE:  return "REMOVE";
1851         case HUA_CANCEL:  return "CANCEL";
1852         default:          return "UNKNOWN";
1853         }
1854 }
1855
1856 /*
1857  * List of hr_flags (bit field)
1858  */
1859 #define HSM_FORCE_ACTION 0x0001
1860 /* used by CT, cannot be set by user */
1861 #define HSM_GHOST_COPY   0x0002
1862
1863 /**
1864  * Contains all the fixed part of struct hsm_user_request.
1865  *
1866  */
1867 struct hsm_request {
1868         __u32 hr_action;        /* enum hsm_user_action */
1869         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1870         __u64 hr_flags;         /* request flags */
1871         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1872         __u32 hr_data_len;
1873 };
1874
1875 struct hsm_user_item {
1876        struct lu_fid        hui_fid;
1877        struct hsm_extent hui_extent;
1878 } __attribute__((packed));
1879
1880 struct hsm_user_request {
1881         struct hsm_request      hur_request;
1882         struct hsm_user_item    hur_user_item[0];
1883         /* extra data blob at end of struct (after all
1884          * hur_user_items), only use helpers to access it
1885          */
1886 } __attribute__((packed));
1887
1888 /** Return pointer to data field in a hsm user request */
1889 static inline void *hur_data(struct hsm_user_request *hur)
1890 {
1891         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1892 }
1893
1894 /**
1895  * Compute the current length of the provided hsm_user_request.  This returns -1
1896  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1897  *
1898  * return -1 on bounds check error.
1899  */
1900 static inline ssize_t hur_len(struct hsm_user_request *hur)
1901 {
1902         __u64   size;
1903
1904         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1905         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1906                 (__u64)hur->hur_request.hr_itemcount *
1907                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1908
1909         if (size != (ssize_t)size)
1910                 return -1;
1911
1912         return size;
1913 }
1914
1915 /****** HSM RPCs to copytool *****/
1916 /* Message types the copytool may receive */
1917 enum hsm_message_type {
1918         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1919 };
1920
1921 /* Actions the copytool may be instructed to take for a given action_item */
1922 enum hsm_copytool_action {
1923         HSMA_NONE    = 10, /* no action */
1924         HSMA_ARCHIVE = 20, /* arbitrary offset */
1925         HSMA_RESTORE = 21,
1926         HSMA_REMOVE  = 22,
1927         HSMA_CANCEL  = 23
1928 };
1929
1930 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1931 {
1932         switch  (a) {
1933         case HSMA_NONE:    return "NOOP";
1934         case HSMA_ARCHIVE: return "ARCHIVE";
1935         case HSMA_RESTORE: return "RESTORE";
1936         case HSMA_REMOVE:  return "REMOVE";
1937         case HSMA_CANCEL:  return "CANCEL";
1938         default:           return "UNKNOWN";
1939         }
1940 }
1941
1942 /* Copytool item action description */
1943 struct hsm_action_item {
1944         __u32      hai_len;     /* valid size of this struct */
1945         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1946         struct lu_fid hai_fid;     /* Lustre FID to operate on */
1947         struct lu_fid hai_dfid;    /* fid used for data access */
1948         struct hsm_extent hai_extent;  /* byte range to operate on */
1949         __u64      hai_cookie;  /* action cookie from coordinator */
1950         __u64      hai_gid;     /* grouplock id */
1951         char       hai_data[0]; /* variable length */
1952 } __attribute__((packed));
1953
1954 /**
1955  * helper function which print in hexa the first bytes of
1956  * hai opaque field
1957  *
1958  * \param hai [IN]        record to print
1959  * \param buffer [IN,OUT] buffer to write the hex string to
1960  * \param len [IN]        max buffer length
1961  *
1962  * \retval buffer
1963  */
1964 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1965                                         char *buffer, size_t len)
1966 {
1967         int i;
1968         int data_len;
1969         char *ptr;
1970
1971         ptr = buffer;
1972         data_len = hai->hai_len - sizeof(*hai);
1973         for (i = 0; (i < data_len) && (len > 2); i++) {
1974                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1975                 ptr += 2;
1976                 len -= 2;
1977         }
1978
1979         *ptr = '\0';
1980
1981         return buffer;
1982 }
1983
1984 /* Copytool action list */
1985 #define HAL_VERSION 1
1986 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1987 struct hsm_action_list {
1988         __u32 hal_version;
1989         __u32 hal_count;       /* number of hai's to follow */
1990         __u64 hal_compound_id; /* returned by coordinator, ignored */
1991         __u64 hal_flags;
1992         __u32 hal_archive_id; /* which archive backend */
1993         __u32 padding1;
1994         char  hal_fsname[0];   /* null-terminated */
1995         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1996            boundaries. See hai_zero */
1997 } __attribute__((packed));
1998
1999 /* Return pointer to first hai in action list */
2000 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
2001 {
2002         size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2003
2004         return (struct hsm_action_item *)(hal->hal_fsname + offset);
2005 }
2006
2007 /* Return pointer to next hai */
2008 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
2009 {
2010         size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
2011
2012         return (struct hsm_action_item *)((char *)hai + offset);
2013 }
2014
2015 /* Return size of an hsm_action_list */
2016 static inline size_t hal_size(struct hsm_action_list *hal)
2017 {
2018         __u32 i;
2019         size_t sz;
2020         struct hsm_action_item *hai;
2021
2022         sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2023         hai = hai_first(hal);
2024         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
2025                 sz += __ALIGN_KERNEL(hai->hai_len, 8);
2026
2027         return sz;
2028 }
2029
2030 /* HSM file import
2031  * describe the attributes to be set on imported file
2032  */
2033 struct hsm_user_import {
2034         __u64           hui_size;
2035         __u64           hui_atime;
2036         __u64           hui_mtime;
2037         __u32           hui_atime_ns;
2038         __u32           hui_mtime_ns;
2039         __u32           hui_uid;
2040         __u32           hui_gid;
2041         __u32           hui_mode;
2042         __u32           hui_archive_id;
2043 };
2044
2045 /* Copytool progress reporting */
2046 #define HP_FLAG_COMPLETED 0x01
2047 #define HP_FLAG_RETRY     0x02
2048
2049 struct hsm_progress {
2050         struct lu_fid           hp_fid;
2051         __u64                   hp_cookie;
2052         struct hsm_extent       hp_extent;
2053         __u16                   hp_flags;
2054         __u16                   hp_errval; /* positive val */
2055         __u32                   padding;
2056 };
2057
2058 struct hsm_copy {
2059         __u64                   hc_data_version;
2060         __u16                   hc_flags;
2061         __u16                   hc_errval; /* positive val */
2062         __u32                   padding;
2063         struct hsm_action_item  hc_hai;
2064 };
2065
2066 /* JSON objects */
2067 enum llapi_json_types {
2068         LLAPI_JSON_INTEGER = 1,
2069         LLAPI_JSON_BIGNUM,
2070         LLAPI_JSON_REAL,
2071         LLAPI_JSON_STRING
2072 };
2073
2074 struct llapi_json_item {
2075         char                    *lji_key;
2076         __u32                   lji_type;
2077         union {
2078                 int     lji_integer;
2079                 __u64   lji_u64;
2080                 double  lji_real;
2081                 char    *lji_string;
2082         };
2083         struct llapi_json_item  *lji_next;
2084 };
2085
2086 struct llapi_json_item_list {
2087         int                     ljil_item_count;
2088         struct llapi_json_item  *ljil_items;
2089 };
2090
2091 enum lu_ladvise_type {
2092         LU_LADVISE_INVALID      = 0,
2093         LU_LADVISE_WILLREAD     = 1,
2094         LU_LADVISE_DONTNEED     = 2,
2095         LU_LADVISE_LOCKNOEXPAND = 3,
2096         LU_LADVISE_LOCKAHEAD    = 4,
2097         LU_LADVISE_MAX
2098 };
2099
2100 #define LU_LADVISE_NAMES {                                              \
2101         [LU_LADVISE_WILLREAD]           = "willread",                   \
2102         [LU_LADVISE_DONTNEED]           = "dontneed",                   \
2103         [LU_LADVISE_LOCKNOEXPAND]       = "locknoexpand",               \
2104         [LU_LADVISE_LOCKAHEAD]          = "lockahead",                  \
2105 }
2106
2107 /* This is the userspace argument for ladvise.  It is currently the same as
2108  * what goes on the wire (struct lu_ladvise), but is defined separately as we
2109  * may need info which is only used locally. */
2110 struct llapi_lu_ladvise {
2111         __u16 lla_advice;       /* advice type */
2112         __u16 lla_value1;       /* values for different advice types */
2113         __u32 lla_value2;
2114         __u64 lla_start;        /* first byte of extent for advice */
2115         __u64 lla_end;          /* last byte of extent for advice */
2116         __u32 lla_value3;
2117         __u32 lla_value4;
2118 };
2119
2120 enum ladvise_flag {
2121         LF_ASYNC        = 0x00000001,
2122         LF_UNSET        = 0x00000002,
2123 };
2124
2125 #define LADVISE_MAGIC 0x1ADF1CE0
2126 /* Masks of valid flags for each advice */
2127 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2128 /* Flags valid for all advices not explicitly specified */
2129 #define LF_DEFAULT_MASK LF_ASYNC
2130 /* All flags */
2131 #define LF_MASK (LF_ASYNC | LF_UNSET)
2132
2133 #define lla_lockahead_mode   lla_value1
2134 #define lla_peradvice_flags    lla_value2
2135 #define lla_lockahead_result lla_value3
2136
2137 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2138  * is used on the wire.  It is defined separately as we may need info which is
2139  * only used locally. */
2140 struct llapi_ladvise_hdr {
2141         __u32                   lah_magic;      /* LADVISE_MAGIC */
2142         __u32                   lah_count;      /* number of advices */
2143         __u64                   lah_flags;      /* from enum ladvise_flag */
2144         __u32                   lah_value1;     /* unused */
2145         __u32                   lah_value2;     /* unused */
2146         __u64                   lah_value3;     /* unused */
2147         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
2148 };
2149
2150 #define LAH_COUNT_MAX   (1024)
2151
2152 /* Shared key */
2153 enum sk_crypt_alg {
2154         SK_CRYPT_INVALID        = -1,
2155         SK_CRYPT_EMPTY          = 0,
2156         SK_CRYPT_AES256_CTR     = 1,
2157 };
2158
2159 enum sk_hmac_alg {
2160         SK_HMAC_INVALID = -1,
2161         SK_HMAC_EMPTY   = 0,
2162         SK_HMAC_SHA256  = 1,
2163         SK_HMAC_SHA512  = 2,
2164 };
2165
2166 struct sk_crypt_type {
2167         const char     *sct_name;
2168         int             sct_type;
2169 };
2170
2171 struct sk_hmac_type {
2172         const char     *sht_name;
2173         int             sht_type;
2174 };
2175
2176 enum lock_mode_user {
2177         MODE_READ_USER = 1,
2178         MODE_WRITE_USER,
2179         MODE_MAX_USER,
2180 };
2181
2182 #define LOCK_MODE_NAMES { \
2183         [MODE_READ_USER]  = "READ",\
2184         [MODE_WRITE_USER] = "WRITE"\
2185 }
2186
2187 enum lockahead_results {
2188         LLA_RESULT_SENT = 0,
2189         LLA_RESULT_DIFFERENT,
2190         LLA_RESULT_SAME,
2191 };
2192
2193 enum lu_heat_flag_bit {
2194         LU_HEAT_FLAG_BIT_INVALID = 0,
2195         LU_HEAT_FLAG_BIT_OFF,
2196         LU_HEAT_FLAG_BIT_CLEAR,
2197 };
2198
2199 #define LU_HEAT_FLAG_CLEAR      (1 << LU_HEAT_FLAG_BIT_CLEAR)
2200 #define LU_HEAT_FLAG_OFF        (1 << LU_HEAT_FLAG_BIT_OFF)
2201
2202 enum obd_heat_type {
2203         OBD_HEAT_READSAMPLE     = 0,
2204         OBD_HEAT_WRITESAMPLE    = 1,
2205         OBD_HEAT_READBYTE       = 2,
2206         OBD_HEAT_WRITEBYTE      = 3,
2207         OBD_HEAT_COUNT
2208 };
2209
2210 #define LU_HEAT_NAMES {                                 \
2211         [OBD_HEAT_READSAMPLE]   = "readsample",         \
2212         [OBD_HEAT_WRITESAMPLE]  = "writesample",        \
2213         [OBD_HEAT_READBYTE]     = "readbyte",           \
2214         [OBD_HEAT_WRITEBYTE]    = "writebyte",          \
2215 }
2216
2217 struct lu_heat {
2218         __u32 lh_count;
2219         __u32 lh_flags;
2220         __u64 lh_heat[0];
2221 };
2222
2223 #if defined(__cplusplus)
2224 }
2225 #endif
2226
2227 /** @} lustreuser */
2228
2229 #endif /* _LUSTRE_USER_H */