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