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