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  *
  31  * lustre/include/lustre/lustre_user.h
  32  *
  33  * Lustre public user-space interface definitions.
  34  */
  35
  36 #ifndef _LUSTRE_USER_H
  37 #define _LUSTRE_USER_H
  38
  39 /** \defgroup lustreuser lustreuser
  40  *
  41  * @{
  42  */
  43 #ifndef __KERNEL__
  44 # define __USE_ISOC99   1
  45 # include <stdbool.h>
  46 # include <stdio.h> /* snprintf() */
  47 # include <stdlib.h> /* abs() */
  48 # include <errno.h>
  49 # include <sys/stat.h>
  50
  51 # define __USE_GNU      1
  52 # define __USE_XOPEN2K8  1
  53 # define FILEID_LUSTRE 0x97 /* for name_to_handle_at() (and llapi_fd2fid()) */
  54 #endif /* !__KERNEL__ */
  55
  56 #include <linux/fs.h>
  57 #include <linux/limits.h>
  58 #include <linux/kernel.h>
  59 #include <linux/string.h>
  60 #include <linux/quota.h>
  61 #include <linux/types.h>
  62 #include <linux/unistd.h>
  63 #include <linux/lustre/lustre_fiemap.h>
  64 #include <linux/lustre/lustre_ver.h>
  65
  66 #if defined(__cplusplus)
  67 extern "C" {
  68 #endif
  69
  70 #ifdef __STRICT_ANSI__
  71 #define typeof  __typeof__
  72 #endif
  73
  74 /*
  75  * This is a temporary solution of adding quota type.
  76  * Should be removed as soon as system header is updated.
  77  */
  78 #undef LL_MAXQUOTAS
  79 #define LL_MAXQUOTAS 3
  80 #undef INITQFNAMES
  81 #define INITQFNAMES { \
  82     "user",     /* USRQUOTA */ \
  83     "group",    /* GRPQUOTA */ \
  84     "project",  /* PRJQUOTA */ \
  85     "undefined", \
  86 };
  87 #ifndef USRQUOTA
  88 #define USRQUOTA 0
  89 #endif
  90 #ifndef GRPQUOTA
  91 #define GRPQUOTA 1
  92 #endif
  93 #ifndef PRJQUOTA
  94 #define PRJQUOTA 2
  95 #endif
  96
  97 /*
  98  * We need to always use 64bit version because the structure
  99  * is shared across entire cluster where 32bit and 64bit machines
 100  * are co-existing.
 101  */
 102 #if __BITS_PER_LONG != 64 || defined(__ARCH_WANT_STAT64)
 103 typedef struct stat64   lstat_t;
 104 #define lstat_f  lstat64
 105 #define fstat_f         fstat64
 106 #define fstatat_f       fstatat64
 107 #else
 108 typedef struct stat     lstat_t;
 109 #define lstat_f  lstat
 110 #define fstat_f         fstat
 111 #define fstatat_f       fstatat
 112 #endif
 113
 114 #ifndef STATX_BASIC_STATS
 115 /*
 116  * Timestamp structure for the timestamps in struct statx.
 117  *
 118  * tv_sec holds the number of seconds before (negative) or after (positive)
 119  * 00:00:00 1st January 1970 UTC.
 120  *
 121  * tv_nsec holds a number of nanoseconds (0..999,999,999) after the tv_sec time.
 122  *
 123  * __reserved is held in case we need a yet finer resolution.
 124  */
 125 struct statx_timestamp {
 126         __s64   tv_sec;
 127         __u32   tv_nsec;
 128         __s32   __reserved;
 129 };
 130
 131 /*
 132  * Structures for the extended file attribute retrieval system call
 133  * (statx()).
 134  *
 135  * The caller passes a mask of what they're specifically interested in as a
 136  * parameter to statx().  What statx() actually got will be indicated in
 137  * st_mask upon return.
 138  *
 139  * For each bit in the mask argument:
 140  *
 141  * - if the datum is not supported:
 142  *
 143  *   - the bit will be cleared, and
 144  *
 145  *   - the datum will be set to an appropriate fabricated value if one is
 146  *     available (eg. CIFS can take a default uid and gid), otherwise
 147  *
 148  *   - the field will be cleared;
 149  *
 150  * - otherwise, if explicitly requested:
 151  *
 152  *   - the datum will be synchronised to the server if AT_STATX_FORCE_SYNC is
 153  *     set or if the datum is considered out of date, and
 154  *
 155  *   - the field will be filled in and the bit will be set;
 156  *
 157  * - otherwise, if not requested, but available in approximate form without any
 158  *   effort, it will be filled in anyway, and the bit will be set upon return
 159  *   (it might not be up to date, however, and no attempt will be made to
 160  *   synchronise the internal state first);
 161  *
 162  * - otherwise the field and the bit will be cleared before returning.
 163  *
 164  * Items in STATX_BASIC_STATS may be marked unavailable on return, but they
 165  * will have values installed for compatibility purposes so that stat() and
 166  * co. can be emulated in userspace.
 167  */
 168 struct statx {
 169         /* 0x00 */
 170         __u32   stx_mask;       /* What results were written [uncond] */
 171         __u32   stx_blksize;    /* Preferred general I/O size [uncond] */
 172         __u64   stx_attributes; /* Flags information about the file [uncond] */
 173         /* 0x10 */
 174         __u32   stx_nlink;      /* Number of hard links */
 175         __u32   stx_uid;        /* User ID of owner */
 176         __u32   stx_gid;        /* Group ID of owner */
 177         __u16   stx_mode;       /* File mode */
 178         __u16   __spare0[1];
 179         /* 0x20 */
 180         __u64   stx_ino;        /* Inode number */
 181         __u64   stx_size;       /* File size */
 182         __u64   stx_blocks;     /* Number of 512-byte blocks allocated */
 183         __u64   stx_attributes_mask; /* Mask for what's supported in
 184                                       * stx_attributes
 185                                       */
 186         /* 0x40 */
 187         struct statx_timestamp  stx_atime;      /* Last access time */
 188         struct statx_timestamp  stx_btime;      /* File creation time */
 189         struct statx_timestamp  stx_ctime;      /* Last attribute change time */
 190         struct statx_timestamp  stx_mtime;      /* Last data modification time */
 191         /* 0x80 */
 192         __u32   stx_rdev_major; /* Device ID of special file [if bdev/cdev] */
 193         __u32   stx_rdev_minor;
 194         __u32   stx_dev_major;  /* ID of device containing file [uncond] */
 195         __u32   stx_dev_minor;
 196         /* 0x90 */
 197         __u64   __spare2[14];   /* Spare space for future expansion */
 198         /* 0x100 */
 199 };
 200
 201 /*
 202  * Flags to be stx_mask
 203  *
 204  * Query request/result mask for statx() and struct statx::stx_mask.
 205  *
 206  * These bits should be set in the mask argument of statx() to request
 207  * particular items when calling statx().
 208  */
 209 #define STATX_TYPE              0x00000001U     /* Want/got stx_mode & S_IFMT */
 210 #define STATX_MODE              0x00000002U     /* Want/got stx_mode & ~S_IFMT */
 211 #define STATX_NLINK             0x00000004U     /* Want/got stx_nlink */
 212 #define STATX_UID               0x00000008U     /* Want/got stx_uid */
 213 #define STATX_GID               0x00000010U     /* Want/got stx_gid */
 214 #define STATX_ATIME             0x00000020U     /* Want/got stx_atime */
 215 #define STATX_MTIME             0x00000040U     /* Want/got stx_mtime */
 216 #define STATX_CTIME             0x00000080U     /* Want/got stx_ctime */
 217 #define STATX_INO               0x00000100U     /* Want/got stx_ino */
 218 #define STATX_SIZE              0x00000200U     /* Want/got stx_size */
 219 #define STATX_BLOCKS            0x00000400U     /* Want/got stx_blocks */
 220 #define STATX_BASIC_STATS       0x000007ffU     /* The stuff in the normal stat struct */
 221 #define STATX_BTIME             0x00000800U     /* Want/got stx_btime */
 222 #define STATX_ALL               0x00000fffU     /* All currently supported flags */
 223 #define STATX__RESERVED         0x80000000U     /* Reserved for future struct statx expansion */
 224
 225 /*
 226  * Attributes to be found in stx_attributes and masked in stx_attributes_mask.
 227  *
 228  * These give information about the features or the state of a file that might
 229  * be of use to ordinary userspace programs such as GUIs or ls rather than
 230  * specialised tools.
 231  *
 232  * Note that the flags marked [I] correspond to generic FS_IOC_FLAGS
 233  * semantically.  Where possible, the numerical value is picked to correspond
 234  * also.
 235  */
 236 #define STATX_ATTR_COMPRESSED           0x00000004 /* [I] File is compressed by the fs */
 237 #define STATX_ATTR_IMMUTABLE            0x00000010 /* [I] File is marked immutable */
 238 #define STATX_ATTR_APPEND               0x00000020 /* [I] File is append-only */
 239 #define STATX_ATTR_NODUMP               0x00000040 /* [I] File is not to be dumped */
 240 #define STATX_ATTR_ENCRYPTED            0x00000800 /* [I] File requires key to decrypt in fs */
 241
 242 #define STATX_ATTR_AUTOMOUNT            0x00001000 /* Dir: Automount trigger */
 243 /* Update attrs_array in lustreapi.h if new attributes are added. */
 244
 245 #define AT_STATX_SYNC_TYPE      0x6000  /* Type of synchronisation required from statx() */
 246 #define AT_STATX_SYNC_AS_STAT   0x0000  /* - Do whatever stat() does */
 247 #define AT_STATX_FORCE_SYNC     0x2000  /* - Force the attributes to be sync'd with the server */
 248 #define AT_STATX_DONT_SYNC      0x4000  /* - Don't sync attributes with the server */
 249
 250 #endif /* STATX_BASIC_STATS */
 251
 252 typedef struct statx lstatx_t;
 253
 254 #define LUSTRE_EOF 0xffffffffffffffffULL
 255
 256 /* for statfs() */
 257 #define LL_SUPER_MAGIC 0x0BD00BD0
 258
 259 #define LL_IOC_GETVERSION               _IOR('f', 3, long)
 260 #define FSFILT_IOC_GETVERSION           LL_IOC_GETVERSION /* backward compat */
 261 #define LL_IOC_RESIZE_FS                _IOW('f', 16, __u64)
 262
 263 /* FIEMAP flags supported by Lustre */
 264 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
 265
 266 enum obd_statfs_state {
 267         OS_STATFS_DEGRADED      = 0x00000001, /**< RAID degraded/rebuilding */
 268         OS_STATFS_READONLY      = 0x00000002, /**< filesystem is read-only */
 269         OS_STATFS_NOCREATE      = 0x00000004, /**< no object creation */
 270         OS_STATFS_UNUSED1       = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
 271         OS_STATFS_UNUSED2       = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
 272         OS_STATFS_ENOSPC        = 0x00000020, /**< not enough free space */
 273         OS_STATFS_ENOINO        = 0x00000040, /**< not enough inodes */
 274         OS_STATFS_SUM           = 0x00000100, /**< aggregated for all tagrets */
 275         OS_STATFS_NONROT        = 0x00000200, /**< non-rotational device */
 276 };
 277 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 20, 53, 0)
 278 #define OS_STATFS_NOPRECREATE OS_STATFS_NOCREATE
 279 #endif
 280
 281 /** filesystem statistics/attributes for target device */
 282 struct obd_statfs {
 283         __u64           os_type;        /* EXT4_SUPER_MAGIC, UBERBLOCK_MAGIC */
 284         __u64           os_blocks;      /* total size in #os_bsize blocks */
 285         __u64           os_bfree;       /* number of unused blocks */
 286         __u64           os_bavail;      /* blocks available for allocation */
 287         __u64           os_files;       /* total number of objects */
 288         __u64           os_ffree;       /* # objects that could be created */
 289         __u8            os_fsid[40];    /* identifier for filesystem */
 290         __u32           os_bsize;       /* block size in bytes for os_blocks */
 291         __u32           os_namelen;     /* maximum length of filename in bytes*/
 292         __u64           os_maxbytes;    /* maximum object size in bytes */
 293         __u32           os_state;       /**< obd_statfs_state OS_STATFS_* */
 294         __u32           os_fprecreated; /* objs available now to the caller */
 295                                         /* used in QoS code to find preferred
 296                                          * OSTs
 297                                          */
 298         __u32           os_granted;     /* space granted for MDS */
 299         __u32           os_spare3;      /* Unused padding fields.  Remember */
 300         __u32           os_spare4;      /* to fix lustre_swab_obd_statfs() */
 301         __u32           os_spare5;
 302         __u32           os_spare6;
 303         __u32           os_spare7;
 304         __u32           os_spare8;
 305         __u32           os_spare9;
 306 };
 307
 308 /** additional filesystem attributes for target device */
 309 struct obd_statfs_info {
 310         __u32           os_reserved_mb_low;     /* reserved mb low */
 311         __u32           os_reserved_mb_high;    /* reserved mb high */
 312         bool            os_enable_pre;          /* enable pre create logic */
 313 };
 314
 315 /**
 316  * File IDentifier.
 317  *
 318  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 319  * FIDs are never reused.
 320  **/
 321 struct lu_fid {
 322        /**
 323         * FID sequence. Sequence is a unit of migration: all files (objects)
 324         * with FIDs from a given sequence are stored on the same server.
 325         * Lustre should support 2^64 objects, so even if each sequence
 326         * has only a single object we can still enumerate 2^64 objects.
 327         **/
 328         __u64 f_seq;
 329         /* FID number within sequence. */
 330         __u32 f_oid;
 331         /**
 332          * FID version, used to distinguish different versions (in the sense
 333          * of snapshots, etc.) of the same file system object. Not currently
 334          * used.
 335          **/
 336         __u32 f_ver;
 337 } __attribute__((packed));
 338
 339 static inline bool fid_is_zero(const struct lu_fid *fid)
 340 {
 341         return fid->f_seq == 0 && fid->f_oid == 0;
 342 }
 343
 344 /* The data name_to_handle_at() places in a struct file_handle (at f_handle) */
 345 struct lustre_file_handle {
 346         struct lu_fid lfh_child;
 347         struct lu_fid lfh_parent;
 348 };
 349
 350 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
 351  * MDT-object's FID::f_ver, instead it is the OST-object index in its
 352  * parent MDT-object's layout EA.
 353  */
 354 #define f_stripe_idx f_ver
 355
 356 struct ost_layout {
 357         __u32   ol_stripe_size;
 358         __u32   ol_stripe_count;
 359         __u64   ol_comp_start;
 360         __u64   ol_comp_end;
 361         __u32   ol_comp_id;
 362 } __attribute__((packed));
 363
 364 /* The filter_fid structure has changed several times over its lifetime.
 365  * For a long time "trusted.fid" held the MDT inode parent FID/IGIF and
 366  * stripe_index and the "self FID" (objid/seq) to be able to recover the
 367  * OST objects in case of corruption.  With the move to 2.4 and OSD-API for
 368  * the OST, the "trusted.lma" xattr was added to the OST objects to store
 369  * the "self FID" to be consistent with the MDT on-disk format, and the
 370  * filter_fid only stored the MDT inode parent FID and stripe index.
 371  *
 372  * In 2.10, the addition of PFL composite layouts required more information
 373  * to be stored into the filter_fid in order to be able to identify which
 374  * component the OST object belonged.  As well, the stripe size may vary
 375  * between components, so it was no longer safe to assume the stripe size
 376  * or stripe_count of a file.  This is also more robust for plain layouts.
 377  *
 378  * For ldiskfs OSTs that were formatted with 256-byte inodes, there is not
 379  * enough space to store both the filter_fid and LMA in the inode, so they
 380  * are packed into struct lustre_ost_attrs on disk in trusted.lma to avoid
 381  * an extra seek for every OST object access.
 382  *
 383  * In 2.11, FLR mirror layouts also need to store the layout version and
 384  * range so that writes to old versions of the layout are not allowed.
 385  * That ensures that mirrored objects are not modified by evicted clients,
 386  * and ensures that the components are correctly marked stale on the MDT.
 387  */
 388 struct filter_fid_18_23 {
 389         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 390         __u64                   ff_objid;
 391         __u64                   ff_seq;
 392 };
 393
 394 struct filter_fid_24_29 {
 395         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 396 };
 397
 398 struct filter_fid_210 {
 399         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 400         struct ost_layout       ff_layout;
 401 };
 402
 403 struct filter_fid {
 404         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 405         struct ost_layout       ff_layout;
 406         __u32                   ff_layout_version;
 407         __u32                   ff_range; /* range of layout version that
 408                                            * write are allowed
 409                                            */
 410 } __attribute__((packed));
 411
 412 /* Userspace should treat lu_fid as opaque, and only use the following methods
 413  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
 414  * here from lustre_idl.h if needed.
 415  */
 416 struct lu_fid;
 417
 418 enum lma_compat {
 419         LMAC_HSM         = 0x00000001,
 420 /*      LMAC_SOM         = 0x00000002, obsolete since 2.8.0 */
 421         LMAC_NOT_IN_OI   = 0x00000004, /* the object does NOT need OI mapping */
 422         LMAC_FID_ON_OST  = 0x00000008, /* For OST-object, its OI mapping is
 423                                         * under /O/<seq>/d<x>.
 424                                         */
 425         LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
 426         LMAC_COMP_INFO   = 0x00000020, /* Component info in the LMA EA. */
 427         LMAC_IDX_BACKUP  = 0x00000040, /* Has index backup. */
 428 };
 429
 430 /**
 431  * Masks for all features that should be supported by a Lustre version to
 432  * access a specific file.
 433  * This information is stored in lustre_mdt_attrs::lma_incompat.
 434  */
 435 enum lma_incompat {
 436         LMAI_RELEASED           = 0x00000001, /* file is released */
 437         LMAI_AGENT              = 0x00000002, /* agent inode */
 438         LMAI_REMOTE_PARENT      = 0x00000004, /* the parent of the object
 439                                                * is on the remote T
 440                                                */
 441         LMAI_STRIPED            = 0x00000008, /* striped directory inode */
 442         LMAI_ORPHAN             = 0x00000010, /* inode is orphan */
 443         LMAI_ENCRYPT            = 0x00000020, /* inode is encrypted */
 444         LMA_INCOMPAT_SUPP       = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
 445                                    LMAI_STRIPED | LMAI_ORPHAN | LMAI_ENCRYPT)
 446 };
 447
 448
 449 /**
 450  * Following struct for object attributes, that will be kept inode's EA.
 451  * Introduced in 2.0 release (please see b15993, for details)
 452  * Added to all objects since Lustre 2.4 as contains self FID
 453  */
 454 struct lustre_mdt_attrs {
 455         /**
 456          * Bitfield for supported data in this structure. From enum lma_compat.
 457          * lma_self_fid and lma_flags are always available.
 458          */
 459         __u32   lma_compat;
 460         /**
 461          * Per-file incompat feature list. Lustre version should support all
 462          * flags set in this field. The supported feature mask is available in
 463          * LMA_INCOMPAT_SUPP.
 464          */
 465         __u32   lma_incompat;
 466         /** FID of this inode */
 467         struct lu_fid  lma_self_fid;
 468 };
 469
 470 #define PFID_STRIPE_IDX_BITS   16
 471 #define PFID_STRIPE_COUNT_MASK ((1 << PFID_STRIPE_IDX_BITS) - 1)
 472
 473 struct lustre_ost_attrs {
 474         /* Use lustre_mdt_attrs directly for now, need a common header
 475          * structure if want to change lustre_mdt_attrs in future.
 476          */
 477         struct lustre_mdt_attrs loa_lma;
 478
 479         /* Below five elements are for OST-object's PFID EA, the
 480          * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
 481          * and the stripe_index (low 16 bits), the size should not exceed
 482          * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
 483          * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
 484          * are valid; if the flag LMAC_COMP_INFO is set, then the next three
 485          * loa_comp_* elements are valid.
 486          */
 487         struct lu_fid   loa_parent_fid;
 488         __u32           loa_stripe_size;
 489         __u32           loa_comp_id;
 490         __u64           loa_comp_start;
 491         __u64           loa_comp_end;
 492 };
 493
 494 /**
 495  * Prior to 2.4, the LMA structure also included SOM attributes which has since
 496  * been moved to a dedicated xattr
 497  * lma_flags was also removed because of lma_compat/incompat fields.
 498  */
 499 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
 500
 501 enum lustre_som_flags {
 502         /* Unknow or no SoM data, must get size from OSTs. */
 503         SOM_FL_UNKNOWN  = 0x0000,
 504         /* Known strictly correct, FLR or DoM file (SoM guaranteed). */
 505         SOM_FL_STRICT   = 0x0001,
 506         /* Known stale - was right at some point in the past, but it is
 507          * known (or likely) to be incorrect now (e.g. opened for write).
 508          */
 509         SOM_FL_STALE    = 0x0002,
 510         /* Approximate, may never have been strictly correct,
 511          * need to sync SOM data to achieve eventual consistency.
 512          */
 513         SOM_FL_LAZY     = 0x0004,
 514 };
 515
 516 struct lustre_som_attrs {
 517         __u16   lsa_valid;
 518         __u16   lsa_reserved[3];
 519         __u64   lsa_size;
 520         __u64   lsa_blocks;
 521 };
 522
 523 /**
 524  * OST object IDentifier.
 525  */
 526 struct ost_id {
 527         union {
 528                 struct {
 529                         __u64   oi_id;
 530                         __u64   oi_seq;
 531                 } oi;
 532                 struct lu_fid oi_fid;
 533         };
 534 } __attribute__((packed));
 535
 536 #define DOSTID "%#llx:%llu"
 537 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
 538                    ((unsigned long long)ostid_id(oi))
 539
 540 struct ll_futimes_3 {
 541         __u64 lfu_atime_sec;
 542         __u64 lfu_atime_nsec;
 543         __u64 lfu_mtime_sec;
 544         __u64 lfu_mtime_nsec;
 545         __u64 lfu_ctime_sec;
 546         __u64 lfu_ctime_nsec;
 547 };
 548
 549 /*
 550  * Maximum number of mirrors currently implemented.
 551  */
 552 #define LUSTRE_MIRROR_COUNT_MAX         16
 553
 554 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
 555 enum ll_lease_mode {
 556         LL_LEASE_RDLCK  = 0x01,
 557         LL_LEASE_WRLCK  = 0x02,
 558         LL_LEASE_UNLCK  = 0x04,
 559 };
 560
 561 enum ll_lease_flags {
 562         LL_LEASE_RESYNC         = 0x1,
 563         LL_LEASE_RESYNC_DONE    = 0x2,
 564         LL_LEASE_LAYOUT_MERGE   = 0x4,
 565         LL_LEASE_LAYOUT_SPLIT   = 0x8,
 566         LL_LEASE_PCC_ATTACH     = 0x10,
 567 };
 568
 569 #define IOC_IDS_MAX     4096
 570 struct ll_ioc_lease {
 571         __u32           lil_mode;
 572         __u32           lil_flags;
 573         __u32           lil_count;
 574         __u32           lil_ids[0];
 575 };
 576
 577 struct ll_ioc_lease_id {
 578         __u32           lil_mode;
 579         __u32           lil_flags;
 580         __u32           lil_count;
 581         __u16           lil_mirror_id;
 582         __u16           lil_padding1;
 583         __u64           lil_padding2;
 584         __u32           lil_ids[0];
 585 };
 586
 587 /*
 588  * The ioctl naming rules:
 589  * LL_*     - works on the currently opened filehandle instead of parent dir
 590  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 591  * *_MDC_*  - gets/sets data related to MDC
 592  * *_LOV_*  - gets/sets data related to OSC/LOV
 593  * *FILE*   - called on parent dir and passes in a filename
 594  * *STRIPE* - set/get lov_user_md
 595  * *INFO    - set/get lov_user_mds_data
 596  */
 597 /*      lustre_ioctl.h                  101-150 */
 598 /* ioctl codes 128-143 are reserved for fsverity */
 599 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 600 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 601 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 602 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 603 #define LL_IOC_LOV_SETSTRIPE_NEW        _IOWR('f', 154, struct lov_user_md)
 604 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 605 #define LL_IOC_LOV_GETSTRIPE_NEW        _IOR('f', 155, struct lov_user_md)
 606 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 607 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 608 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 609 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 610 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 611 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 612 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 613 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 614 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
 615 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 616 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 617 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 618 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 619 #define LL_IOC_FUTIMES_3                _IOWR('f', 176, struct ll_futimes_3)
 620 #define LL_IOC_FLR_SET_MIRROR           _IOW ('f', 177, long)
 621 /*      lustre_ioctl.h                  177-210 */
 622 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
 623 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
 624 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
 625 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
 626 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
 627 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
 628 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
 629 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
 630 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
 631                                                 struct lustre_swap_layouts)
 632 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
 633                                                 struct hsm_current_action)
 634 /*      lustre_ioctl.h                  221-233 */
 635 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
 636 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
 637 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
 638 #define LL_IOC_RMFID                    _IOR('f', 242, struct fid_array)
 639 #define LL_IOC_UNLOCK_FOREIGN           _IO('f', 242)
 640 #define LL_IOC_SET_LEASE                _IOWR('f', 243, struct ll_ioc_lease)
 641 #define LL_IOC_SET_LEASE_OLD            _IOWR('f', 243, long)
 642 #define LL_IOC_GET_LEASE                _IO('f', 244)
 643 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
 644 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
 645 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
 646 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
 647 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
 648 #define LL_IOC_LADVISE                  _IOR('f', 250, struct llapi_lu_ladvise)
 649 #define LL_IOC_LADVISE2                 _IOW('f', 250, struct llapi_lu_ladvise2)
 650 #define LL_IOC_HEAT_GET                 _IOWR('f', 251, struct lu_heat)
 651 #define LL_IOC_HEAT_SET                 _IOW('f', 251, __u64)
 652 #define LL_IOC_PCC_ATTACH               _IOW('f', 252, struct lu_pcc_attach)
 653 #define LL_IOC_PCC_DETACH               _IOW('f', 252, struct lu_pcc_detach)
 654 #define LL_IOC_PCC_DETACH_BY_FID        _IOW('f', 252, struct lu_pcc_detach_fid)
 655 #define LL_IOC_PCC_STATE                _IOR('f', 252, struct lu_pcc_state)
 656 #define LL_IOC_PROJECT                  _IOW('f', 253, struct lu_project)
 657
 658 #ifndef FS_IOC_FSGETXATTR
 659 /*
 660  * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
 661  */
 662 struct fsxattr {
 663         __u32           fsx_xflags;     /* xflags field value (get/set) */
 664         __u32           fsx_extsize;    /* extsize field value (get/set)*/
 665         __u32           fsx_nextents;   /* nextents field value (get)   */
 666         __u32           fsx_projid;     /* project identifier (get/set) */
 667         unsigned char   fsx_pad[12];
 668 };
 669 #define FS_IOC_FSGETXATTR               _IOR('X', 31, struct fsxattr)
 670 #define FS_IOC_FSSETXATTR               _IOW('X', 32, struct fsxattr)
 671 #endif
 672 #ifndef FS_XFLAG_PROJINHERIT
 673 #define FS_XFLAG_PROJINHERIT            0x00000200
 674 #endif
 675
 676
 677 #define LL_STATFS_LMV           1
 678 #define LL_STATFS_LOV           2
 679 #define LL_STATFS_NODELAY       4
 680
 681 #define IOC_MDC_TYPE            'i'
 682 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 683 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 684 #define IOC_MDC_GETFILEINFO_V1  _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data_v1 *)
 685 #define IOC_MDC_GETFILEINFO_V2  _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data)
 686 #define LL_IOC_MDC_GETINFO_V1   _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data_v1 *)
 687 #define LL_IOC_MDC_GETINFO_V2   _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data)
 688 #define IOC_MDC_GETFILEINFO     IOC_MDC_GETFILEINFO_V1
 689 #define LL_IOC_MDC_GETINFO      LL_IOC_MDC_GETINFO_V1
 690
 691 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 692
 693 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
 694  * files, but are unlikely to be used in practice and are not harmful if
 695  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
 696  * devices and are safe for use on new files. See LU-4209.
 697  */
 698 /* To be compatible with old statically linked binary we keep the check for
 699  * the older 0100000000 flag.  This is already removed upstream.  LU-812.
 700  */
 701 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
 702 #ifndef FASYNC
 703 #define FASYNC                  00020000   /* fcntl, for BSD compatibility */
 704 #endif
 705 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
 706 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
 707                                          O_LOV_DELAY_CREATE_MASK)
 708 /* O_CIPHERTEXT principle is similar to O_LOV_DELAY_CREATE above,
 709  * for access to encrypted files without the encryption key.
 710  */
 711 #define O_CIPHERTEXT            (O_NOCTTY | O_NDELAY | O_DSYNC)
 712
 713 #define LL_FILE_IGNORE_LOCK     0x00000001
 714 #define LL_FILE_GROUP_LOCKED    0x00000002
 715 #define LL_FILE_READAHEA        0x00000004
 716 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 717 #define LL_FILE_FLOCK_WARNING   0x00000020 /* warned about disabled flock */
 718
 719 #define LOV_USER_MAGIC_V1       0x0BD10BD0
 720 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
 721 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
 722 #define LOV_USER_MAGIC_V3       0x0BD30BD0
 723 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
 724 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
 725 #define LOV_USER_MAGIC_COMP_V1  0x0BD60BD0
 726 #define LOV_USER_MAGIC_FOREIGN  0x0BD70BD0
 727 #define LOV_USER_MAGIC_SEL      0x0BD80BD0
 728
 729 #define LMV_USER_MAGIC          0x0CD30CD0    /* default lmv magic */
 730 #define LMV_USER_MAGIC_V0       0x0CD20CD0    /* old default lmv magic*/
 731 #define LMV_USER_MAGIC_SPECIFIC 0x0CD40CD0
 732
 733 #define LOV_PATTERN_NONE                0x000
 734 #define LOV_PATTERN_RAID0               0x001
 735 #define LOV_PATTERN_RAID1               0x002
 736 #define LOV_PATTERN_MDT                 0x100
 737 #define LOV_PATTERN_OVERSTRIPING        0x200
 738 #define LOV_PATTERN_FOREIGN             0x400
 739 #define LOV_PATTERN_COMPRESS            0x800
 740
 741 /* combine exclusive patterns as a bad pattern */
 742 #define LOV_PATTERN_BAD         (LOV_PATTERN_RAID1 | LOV_PATTERN_MDT | \
 743                                  LOV_PATTERN_FOREIGN)
 744
 745 #define LOV_PATTERN_F_MASK      0xffff0000
 746 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
 747 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
 748 #define LOV_PATTERN_DEFAULT     0xffffffff
 749
 750 #define LOV_OFFSET_DEFAULT      ((__u16)-1)
 751 #define LMV_OFFSET_DEFAULT      ((__u32)-1)
 752
 753 static inline bool lov_pattern_supported(__u32 pattern)
 754 {
 755         __u32 pattern_base = pattern & ~LOV_PATTERN_F_RELEASED;
 756
 757         return pattern_base == LOV_PATTERN_RAID0 ||
 758                pattern_base == (LOV_PATTERN_RAID0 | LOV_PATTERN_OVERSTRIPING) ||
 759                pattern_base == LOV_PATTERN_MDT;
 760 }
 761
 762 /* RELEASED and MDT patterns are not valid in many places, so rather than
 763  * having many extra checks on lov_pattern_supported, we have this separate
 764  * check for non-released, non-readonly, non-DOM components
 765  */
 766 static inline bool lov_pattern_supported_normal_comp(__u32 pattern)
 767 {
 768         return pattern == LOV_PATTERN_RAID0 ||
 769                pattern == (LOV_PATTERN_RAID0 | LOV_PATTERN_OVERSTRIPING);
 770
 771 }
 772
 773 #define LOV_MAXPOOLNAME 15
 774 #define LOV_POOLNAMEF "%.15s"
 775 /* The poolname "ignore" is used to force a component creation without pool */
 776 #define LOV_POOL_IGNORE "ignore"
 777 /* The poolname "inherit" is used to force a component to inherit the pool from
 778  * parent or root directory
 779  */
 780 #define LOV_POOL_INHERIT "inherit"
 781 /* The poolname "none" is deprecated in 2.15 (same behavior as "inherit") */
 782 #define LOV_POOL_NONE "none"
 783
 784 static inline bool lov_pool_is_ignored(const char *pool)
 785 {
 786         return pool && strncmp(pool, LOV_POOL_IGNORE, LOV_MAXPOOLNAME) == 0;
 787 }
 788
 789 static inline bool lov_pool_is_inherited(const char *pool)
 790 {
 791         return pool && (strncmp(pool, LOV_POOL_INHERIT, LOV_MAXPOOLNAME) == 0 ||
 792                         strncmp(pool, LOV_POOL_NONE, LOV_MAXPOOLNAME) == 0);
 793 }
 794
 795 static inline bool lov_pool_is_reserved(const char *pool)
 796 {
 797         return lov_pool_is_ignored(pool) || lov_pool_is_inherited(pool);
 798 }
 799
 800 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 801 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 802 #define LOV_MAX_STRIPE_COUNT_OLD 160
 803 /* This calculation is crafted so that input of 4096 will result in 160
 804  * which in turn is equal to old maximal stripe count.
 805  * XXX: In fact this is too simpified for now, what it also need is to get
 806  * ea_type argument to clearly know how much space each stripe consumes.
 807  *
 808  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 809  * allocation that is sufficient for the current generation of systems.
 810  *
 811  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1)
 812  */
 813 #define LOV_MAX_STRIPE_COUNT 2000  /* ~((12 * 4096 - 256) / 24) */
 814 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 815 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 816
 817 #define XATTR_LUSTRE_PREFIX     "lustre."
 818 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 819
 820 /* Please update if XATTR_LUSTRE_LOV".set" groks more flags in the future */
 821 #define allowed_lustre_lov(att) (strcmp((att), XATTR_LUSTRE_LOV".add") == 0 || \
 822                         strcmp((att), XATTR_LUSTRE_LOV".set") == 0 || \
 823                         strcmp((att), XATTR_LUSTRE_LOV".set.flags") == 0 || \
 824                         strcmp((att), XATTR_LUSTRE_LOV".del") == 0)
 825
 826 #define lov_user_ost_data lov_user_ost_data_v1
 827 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 828         struct ost_id l_ost_oi;   /* OST object ID */
 829         __u32 l_ost_gen;          /* generation of this OST index */
 830         __u32 l_ost_idx;          /* OST index in LOV */
 831 } __attribute__((packed));
 832
 833 #define lov_user_md lov_user_md_v1
 834 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 835         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 836         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 837         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 838         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 839         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 840         union {
 841                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 842                                            * lmm_objects, use when writing
 843                                            */
 844                 __u16 lmm_layout_gen;     /* layout generation number
 845                                            * used when reading
 846                                            */
 847         };
 848         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 849 } __attribute__((packed, __may_alias__));
 850
 851 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 852         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 853         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 854         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 855         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 856         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 857         union {
 858                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 859                                            * lmm_objects, use when writing
 860                                            */
 861                 __u16 lmm_layout_gen;     /* layout generation number
 862                                            * used when reading
 863                                            */
 864         };
 865         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 866         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 867 } __attribute__((packed, __may_alias__));
 868
 869 struct lov_foreign_md {
 870         __u32 lfm_magic;        /* magic number = LOV_MAGIC_FOREIGN */
 871         __u32 lfm_length;       /* length of lfm_value */
 872         __u32 lfm_type;         /* type, see LU_FOREIGN_TYPE_ */
 873         __u32 lfm_flags;        /* flags, type specific */
 874         char lfm_value[];
 875 } __attribute__((packed));
 876
 877 #define lov_foreign_size(lfm) (((struct lov_foreign_md *)lfm)->lfm_length + \
 878                            offsetof(struct lov_foreign_md, lfm_value))
 879
 880 #define lov_foreign_size_le(lfm) \
 881         (le32_to_cpu(((struct lov_foreign_md *)lfm)->lfm_length) + \
 882         offsetof(struct lov_foreign_md, lfm_value))
 883
 884 /**
 885  * The stripe size fields are shared for the extension size storage, however
 886  * the extension size is stored in KB, not bytes.
 887  */
 888 #define SEL_UNIT_SIZE 1024llu
 889
 890 struct lu_extent {
 891         __u64   e_start;
 892         __u64   e_end;
 893 } __attribute__((packed));
 894
 895 #define DEXT "[%#llx, %#llx)"
 896 #define PEXT(ext) (unsigned long long)(ext)->e_start, (unsigned long long)(ext)->e_end
 897
 898 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
 899                                            struct lu_extent *e2)
 900 {
 901         return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
 902 }
 903
 904 static inline bool lu_extent_is_whole(struct lu_extent *e)
 905 {
 906         return e->e_start == 0 && e->e_end == LUSTRE_EOF;
 907 }
 908
 909 enum lov_comp_md_entry_flags {
 910         LCME_FL_STALE     = 0x00000001, /* FLR: stale data */
 911         LCME_FL_PREF_RD   = 0x00000002, /* FLR: preferred for reading */
 912         LCME_FL_PREF_WR   = 0x00000004, /* FLR: preferred for writing */
 913         LCME_FL_PREF_RW   = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
 914         LCME_FL_OFFLINE   = 0x00000008, /* Not used */
 915         LCME_FL_INIT      = 0x00000010, /* instantiated */
 916         LCME_FL_NOSYNC    = 0x00000020, /* FLR: no sync for the mirror */
 917         LCME_FL_EXTENSION = 0x00000040, /* extension comp, never init */
 918         LCME_FL_PARITY    = 0x00000080, /* EC: a parity code component */
 919         LCME_FL_COMPRESS  = 0x00000100, /* the component should be compressed */
 920         LCME_FL_PARTIAL   = 0x00000200, /* some chunks in the component are
 921                                          * uncompressed
 922                                          */
 923         LCME_FL_NOCOMPR   = 0x00000400, /* the component should not be
 924                                          * compressed
 925                                          */
 926         LCME_FL_NEG       = 0x80000000  /* used to indicate a negative flag,
 927                                          * won't be stored on disk
 928                                          */
 929 };
 930
 931 #define LCME_KNOWN_FLAGS        (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
 932                                  LCME_FL_PREF_RW | LCME_FL_NOSYNC | \
 933                                  LCME_FL_EXTENSION)
 934
 935 /* The component flags can be set by users at creation/modification time. */
 936 #define LCME_USER_COMP_FLAGS    (LCME_FL_PREF_RW | LCME_FL_NOSYNC | \
 937                                  LCME_FL_EXTENSION)
 938
 939 /* The mirror flags can be set by users at creation time. */
 940 #define LCME_USER_MIRROR_FLAGS  (LCME_FL_PREF_RW)
 941
 942 /* The allowed flags obtained from the client at component creation time. */
 943 #define LCME_CL_COMP_FLAGS      (LCME_USER_MIRROR_FLAGS | LCME_FL_EXTENSION)
 944
 945 /* The mirror flags sent by client */
 946 #define LCME_MIRROR_FLAGS       (LCME_FL_NOSYNC)
 947
 948 /* These flags have meaning when set in a default layout and will be inherited
 949  * from the default/template layout set on a directory.
 950  */
 951 #define LCME_TEMPLATE_FLAGS     (LCME_FL_PREF_RW | LCME_FL_NOSYNC | \
 952                                  LCME_FL_EXTENSION)
 953
 954 /* lcme_id can be specified as certain flags, and the the first
 955  * bit of lcme_id is used to indicate that the ID is representing
 956  * certain LCME_FL_* but not a real ID. Which implies we can have
 957  * at most 31 flags (see LCME_FL_XXX).
 958  */
 959 enum lcme_id {
 960         LCME_ID_INVAL   = 0x0,
 961         LCME_ID_MAX     = 0x7FFFFFFF,
 962         LCME_ID_ALL     = 0xFFFFFFFF,
 963         LCME_ID_NOT_ID  = LCME_FL_NEG
 964 };
 965
 966 /* layout version equals to lcme_id, except some bits have special meanings */
 967 enum layout_version_flags {
 968         /* layout version reaches the high water mark to be increased to
 969          * circularly reuse the smallest value
 970          */
 971         LU_LAYOUT_HIGEN         = 0x40000000,
 972         /* the highest bit is used to mark if the file is being resynced */
 973         LU_LAYOUT_RESYNC        = 0x80000000,
 974 };
 975
 976 #define LCME_ID_MASK    LCME_ID_MAX
 977
 978 struct lov_comp_md_entry_v1 {
 979         __u32                   lcme_id;        /* unique id of component */
 980         __u32                   lcme_flags;     /* LCME_FL_XXX */
 981         /* file extent for component. If it's an EC code component, its flags
 982          * contains LCME_FL_PARITY, and its extent covers the same extent of
 983          * its corresponding data component.
 984          */
 985         struct lu_extent        lcme_extent;
 986         __u32                   lcme_offset;    /* offset of component blob,
 987                                                  * start from v_comp_md_v1
 988                                                  */
 989         __u32                   lcme_size;      /* size of component blob */
 990         __u32                   lcme_layout_gen;
 991         __u64                   lcme_timestamp; /* snapshot time if applicable*/
 992         __u8                    lcme_dstripe_count;     /* data stripe count,
 993                                                          * k value in EC
 994                                                          */
 995         __u8                    lcme_cstripe_count;     /* code stripe count,
 996                                                          * p value in EC
 997                                                          */
 998         __u8                    lcme_compr_type;        /* compress type */
 999         __u8                    lcme_compr_lvl:4;       /* compress level */
1000         __u8                    lcme_compr_chunk_log_bits:4;
1001                                      /* chunk_size = 2^(16+chunk_log_bits)
1002                                       * i.e. power-of-two multiple of 64KiB
1003                                       */
1004 } __attribute__((packed));
1005
1006 #define SEQ_ID_MAX              0x0000FFFF
1007 #define SEQ_ID_MASK             SEQ_ID_MAX
1008 /* bit 30:16 of lcme_id is used to store mirror id */
1009 #define MIRROR_ID_MASK          0x7FFF0000
1010 #define MIRROR_ID_NEG           0x8000
1011 #define MIRROR_ID_SHIFT         16
1012
1013 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
1014 {
1015         return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
1016 }
1017
1018 static inline __u16 mirror_id_of(__u32 id)
1019 {
1020         return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
1021 }
1022
1023 /**
1024  * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
1025  */
1026 enum lov_comp_md_flags {
1027         /* the least 4 bits are used by FLR to record file state */
1028         LCM_FL_NONE             = 0x0,
1029         LCM_FL_RDONLY           = 0x1,
1030         LCM_FL_WRITE_PENDING    = 0x2,
1031         LCM_FL_SYNC_PENDING     = 0x3,
1032         LCM_FL_PCC_RDONLY       = 0x8,
1033         LCM_FL_FLR_MASK         = 0xB,
1034 };
1035
1036 struct lov_comp_md_v1 {
1037         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
1038         __u32   lcm_size;       /* overall size including this struct */
1039         __u32   lcm_layout_gen;
1040         __u16   lcm_flags;
1041         __u16   lcm_entry_count;
1042         /* lcm_mirror_count stores the number of actual mirrors minus 1,
1043          * so that non-flr files will have value 0 meaning 1 mirror.
1044          */
1045         __u16   lcm_mirror_count;
1046         /* code components count, non-EC file contains 0 ec_count */
1047         __u8    lcm_ec_count;
1048         __u8    lcm_padding3[1];
1049         __u16   lcm_padding1[2];
1050         __u64   lcm_padding2;
1051         struct lov_comp_md_entry_v1 lcm_entries[0];
1052 } __attribute__((packed));
1053
1054 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
1055 {
1056         if (stripes == LOV_ALL_STRIPES)
1057                 stripes = 0;
1058
1059         if (lmm_magic == LOV_USER_MAGIC_V1)
1060                 return sizeof(struct lov_user_md_v1) +
1061                               stripes * sizeof(struct lov_user_ost_data_v1);
1062         return sizeof(struct lov_user_md_v3) +
1063                                 stripes * sizeof(struct lov_user_ost_data_v1);
1064 }
1065
1066 static inline __u32 lov_foreign_md_size(__u32 length)
1067 {
1068         return length + offsetof(struct lov_foreign_md, lfm_value);
1069 }
1070
1071 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
1072  * use this.  It is unsafe to #define those values in this header as it
1073  * is possible the application has already #included <sys/stat.h>.
1074  */
1075 #define lov_user_mds_data lov_user_mds_data_v2
1076 struct lov_user_mds_data_v1 {
1077         lstat_t lmd_st;                 /* MDS stat struct */
1078         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
1079 } __attribute__((packed));
1080
1081 struct lov_user_mds_data_v2 {
1082         struct lu_fid lmd_fid;          /* Lustre FID */
1083         lstatx_t lmd_stx;               /* MDS statx struct */
1084         __u64 lmd_flags;                /* MDS stat flags */
1085         __u32 lmd_lmmsize;              /* LOV EA size */
1086         __u32 lmd_padding;              /* unused */
1087         struct lov_user_md_v1 lmd_lmm;  /* LOV EA user data */
1088 } __attribute__((packed));
1089
1090 struct lmv_user_mds_data {
1091         struct lu_fid   lum_fid;
1092         __u32           lum_padding;
1093         __u32           lum_mds;
1094 } __attribute__((packed, __may_alias__));
1095
1096 enum lmv_hash_type {
1097         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
1098         LMV_HASH_TYPE_ALL_CHARS = 1,    /* simple sum of characters */
1099         LMV_HASH_TYPE_FNV_1A_64 = 2,    /* reasonable non-cryptographic hash */
1100         LMV_HASH_TYPE_CRUSH     = 3,    /* double-hash to optimize migration */
1101         LMV_HASH_TYPE_CRUSH2    = 4,    /* CRUSH with small fixes, LU-15692 */
1102         LMV_HASH_TYPE_MAX,
1103         LMV_HASH_TYPE_DEFAULT   = LMV_HASH_TYPE_FNV_1A_64
1104 };
1105
1106 static __attribute__((unused)) const char *mdt_hash_name[] = {
1107         "none",
1108         "all_char",
1109         "fnv_1a_64",
1110         "crush",
1111         "crush2",
1112 };
1113
1114
1115 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
1116  * and the higher part will be the flag to indicate the status of object,
1117  * for example the object is being migrated. And the hash function
1118  * might be interpreted differently with different flags.
1119  */
1120 #define LMV_HASH_TYPE_MASK 0x0000ffff
1121
1122 static inline bool lmv_is_known_hash_type(__u32 type)
1123 {
1124         return (type & LMV_HASH_TYPE_MASK) > LMV_HASH_TYPE_UNKNOWN &&
1125                (type & LMV_HASH_TYPE_MASK) < LMV_HASH_TYPE_MAX;
1126 }
1127
1128 /* This flag indicates that overstriping (>1 stripe per MDT) is desired */
1129 #define LMV_HASH_FLAG_OVERSTRIPED       0x01000000
1130 /* fixed layout, such directories won't split automatically */
1131 /* NB, update LMV_HASH_FLAG_KNOWN when adding new flag */
1132 #define LMV_HASH_FLAG_FIXED             0x02000000
1133 #define LMV_HASH_FLAG_MERGE             0x04000000
1134 #define LMV_HASH_FLAG_SPLIT             0x08000000
1135
1136 /* The striped directory has ever lost its master LMV EA, then LFSCK
1137  * re-generated it. This flag is used to indicate such case. It is an
1138  * on-disk flag.
1139  */
1140 #define LMV_HASH_FLAG_LOST_LMV          0x10000000
1141
1142 #define LMV_HASH_FLAG_BAD_TYPE          0x20000000
1143 #define LMV_HASH_FLAG_MIGRATION         0x80000000
1144
1145 #define LMV_HASH_FLAG_LAYOUT_CHANGE     \
1146         (LMV_HASH_FLAG_MIGRATION | LMV_HASH_FLAG_SPLIT | LMV_HASH_FLAG_MERGE)
1147
1148 #define LMV_HASH_FLAG_KNOWN             0xbe000000
1149
1150 /* migration failure may leave hash type as
1151  * LMV_HASH_TYPE_UNKNOWN|LMV_HASH_FLAG_BAD_TYPE, which should be treated as
1152  * sane, so such directory can be accessed (resume migration or unlink).
1153  */
1154 static inline bool lmv_is_sane_hash_type(__u32 type)
1155 {
1156         return lmv_is_known_hash_type(type) ||
1157                type == (LMV_HASH_TYPE_UNKNOWN | LMV_HASH_FLAG_BAD_TYPE);
1158 }
1159
1160 /* both SPLIT and MIGRATION are set for directory split */
1161 static inline bool lmv_hash_is_splitting(__u32 hash)
1162 {
1163         return (hash & LMV_HASH_FLAG_LAYOUT_CHANGE) ==
1164                (LMV_HASH_FLAG_SPLIT | LMV_HASH_FLAG_MIGRATION);
1165 }
1166
1167 /* both MERGE and MIGRATION are set for directory merge */
1168 static inline bool lmv_hash_is_merging(__u32 hash)
1169 {
1170         return (hash & LMV_HASH_FLAG_LAYOUT_CHANGE) ==
1171                (LMV_HASH_FLAG_MERGE | LMV_HASH_FLAG_MIGRATION);
1172 }
1173
1174 /* only MIGRATION is set for directory migration */
1175 static inline bool lmv_hash_is_migrating(__u32 hash)
1176 {
1177         return (hash & LMV_HASH_FLAG_LAYOUT_CHANGE) == LMV_HASH_FLAG_MIGRATION;
1178 }
1179
1180 static inline bool lmv_hash_is_restriping(__u32 hash)
1181 {
1182         return lmv_hash_is_splitting(hash) || lmv_hash_is_merging(hash);
1183 }
1184
1185 static inline bool lmv_hash_is_layout_changing(__u32 hash)
1186 {
1187         return lmv_hash_is_splitting(hash) || lmv_hash_is_merging(hash) ||
1188                lmv_hash_is_migrating(hash);
1189 }
1190
1191 struct lustre_foreign_type {
1192         __u32           lft_type;
1193         const char      *lft_name;
1194 };
1195
1196 /**
1197  * LOV/LMV foreign types
1198  **/
1199 enum lustre_foreign_types {
1200         LU_FOREIGN_TYPE_NONE    = 0,
1201         /* HSM copytool lhsm_posix */
1202         LU_FOREIGN_TYPE_POSIX   = 1,
1203         /* Used for PCC-RW. PCCRW components are local to a single archive. */
1204         LU_FOREIGN_TYPE_PCCRW   = 2,
1205         /* Used for PCC-RO. PCCRO components may be shared between archives. */
1206         LU_FOREIGN_TYPE_PCCRO   = 3,
1207         /* Used for S3 */
1208         LU_FOREIGN_TYPE_S3      = 4,
1209         /* Used for DAOS */
1210         LU_FOREIGN_TYPE_SYMLINK = 0xda05,
1211         /* must be the max/last one */
1212         LU_FOREIGN_TYPE_UNKNOWN = 0xffffffff,
1213 };
1214
1215 extern struct lustre_foreign_type lu_foreign_types[];
1216
1217 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
1218  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data)
1219  */
1220 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
1221 #define lmv_user_md lmv_user_md_v1
1222 struct lmv_user_md_v1 {
1223         __u32   lum_magic;         /* must be the first field */
1224         __u32   lum_stripe_count;  /* dirstripe count */
1225         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
1226         __u32   lum_hash_type;     /* Dir stripe policy */
1227         __u32   lum_type;          /* LMV type: default */
1228         __u8    lum_max_inherit;   /* inherit depth of default LMV */
1229         __u8    lum_max_inherit_rr;     /* inherit depth of default LMV to
1230                                          * round-robin mkdir
1231                                          */
1232         __u16   lum_padding1;
1233         __u32   lum_padding2;
1234         __u32   lum_padding3;
1235         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
1236         struct  lmv_user_mds_data  lum_objects[0];
1237 } __attribute__((packed));
1238
1239 static inline __u32 lmv_foreign_to_md_stripes(__u32 size)
1240 {
1241         if (size <= sizeof(struct lmv_user_md))
1242                 return 0;
1243
1244         size -= sizeof(struct lmv_user_md);
1245         return (size + sizeof(struct lmv_user_mds_data) - 1) /
1246                sizeof(struct lmv_user_mds_data);
1247 }
1248
1249 /*
1250  * NB, historically default layout didn't set type, but use XATTR name to differ
1251  * from normal layout, for backward compatibility, define LMV_TYPE_DEFAULT 0x0,
1252  * and still use the same method.
1253  */
1254 enum lmv_type {
1255         LMV_TYPE_DEFAULT = 0x0000,
1256         /* fetch raw default LMV set on directory inode */
1257         LMV_TYPE_RAW     = 0x0001,
1258 };
1259
1260 /* lum_max_inherit will be decreased by 1 after each inheritance if it's not
1261  * LMV_INHERIT_UNLIMITED or > LMV_INHERIT_MAX.
1262  */
1263 enum {
1264         /* for historical reason, 0 means unlimited inheritance */
1265         LMV_INHERIT_UNLIMITED           = 0,
1266         /* unlimited lum_max_inherit by default for plain stripe (0 or 1) */
1267         LMV_INHERIT_DEFAULT_PLAIN       = LMV_INHERIT_UNLIMITED,
1268         /* not inherit any more */
1269         LMV_INHERIT_END                 = 1,
1270         /* for multiple stripes, the default lum_max_inherit is 3 */
1271         LMV_INHERIT_DEFAULT_STRIPED     = 3,
1272         /* max inherit depth */
1273         LMV_INHERIT_MAX                 = 250,
1274         /* [251, 254] are reserved */
1275         /* not set, or when inherit depth goes beyond end,  */
1276         LMV_INHERIT_NONE                = 255,
1277 };
1278
1279 enum {
1280         /* not set, or when inherit_rr depth goes beyond end,  */
1281         LMV_INHERIT_RR_NONE             = 0,
1282         /* disable lum_max_inherit_rr by default */
1283         LMV_INHERIT_RR_DEFAULT          = LMV_INHERIT_RR_NONE,
1284         /* not inherit any more */
1285         LMV_INHERIT_RR_END              = 1,
1286         /* default inherit_rr of ROOT */
1287         LMV_INHERIT_RR_ROOT             = 3,
1288         /* max inherit depth */
1289         LMV_INHERIT_RR_MAX              = 250,
1290         /* [251, 254] are reserved */
1291         /* unlimited inheritance */
1292         LMV_INHERIT_RR_UNLIMITED        = 255,
1293 };
1294
1295 static inline int lmv_user_md_size(int stripes, int lmm_magic)
1296 {
1297         int size = sizeof(struct lmv_user_md);
1298
1299         if (lmm_magic == LMV_USER_MAGIC_SPECIFIC)
1300                 size += stripes * sizeof(struct lmv_user_mds_data);
1301
1302         return size;
1303 }
1304
1305 struct ll_recreate_obj {
1306         __u64 lrc_id;
1307         __u32 lrc_ost_idx;
1308 };
1309
1310 struct ll_fid {
1311         __u64 id;         /* holds object id */
1312         __u32 generation; /* holds object generation */
1313         __u32 f_type;     /* holds object type or stripe idx when passing it to
1314                            * OST for saving into EA.
1315                            */
1316 };
1317
1318 #define UUID_MAX        40
1319 struct obd_uuid {
1320         char uuid[UUID_MAX];
1321 };
1322
1323 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
1324                                    const struct obd_uuid *u2)
1325 {
1326         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
1327 }
1328
1329 static inline int obd_uuid_empty(struct obd_uuid *uuid)
1330 {
1331         return uuid->uuid[0] == '\0';
1332 }
1333
1334 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
1335 {
1336         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
1337         uuid->uuid[sizeof(*uuid) - 1] = '\0';
1338 }
1339
1340 /* For printf's only, make sure uuid is terminated */
1341 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
1342 {
1343         if (uuid == NULL)
1344                 return NULL;
1345
1346         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
1347                 /* Obviously not safe, but for printfs, no real harm done...
1348                  * we're always null-terminated, even in a ce.
1349                  */
1350                 static char temp[sizeof(*uuid->uuid)];
1351
1352                 memcpy(temp, uuid->uuid, sizeof(*uuid->uuid) - 1);
1353                 temp[sizeof(*uuid->uuid) - 1] = '\0';
1354
1355                 return temp;
1356         }
1357         return (char *)(uuid->uuid);
1358 }
1359
1360 #define LUSTRE_MAXFSNAME 8
1361 #define LUSTRE_MAXINSTANCE 16
1362
1363 /* Extract fsname from uuid (or target name) of a target
1364  * e.g. (myfs-OST0007_UUID -> myfs)
1365  * see also deuuidify.
1366  */
1367 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
1368 {
1369         char *p;
1370
1371         strncpy(buf, uuid, buflen - 1);
1372         buf[buflen - 1] = '\0';
1373         p = strrchr(buf, '-');
1374         if (p != NULL)
1375                 *p = '\0';
1376 }
1377
1378 /* printf display format for Lustre FIDs
1379  * usage: printf("file FID is "DFID"\n", PFID(fid));
1380  */
1381 #define FID_NOBRACE_LEN 40
1382 #define FID_LEN (FID_NOBRACE_LEN + 2)
1383 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
1384 #define DFID "[" DFID_NOBRACE "]"
1385 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
1386
1387 /* scanf input parse format for fids in DFID_NOBRACE format
1388  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
1389  * usage: sscanf(fidstr, SFID, RFID(&fid));
1390  */
1391 #define SFID "0x%llx:0x%x:0x%x"
1392 #define RFID(fid) (unsigned long long *)&((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
1393 #define PLOGID(logid) (unsigned long long)(logid)->lgl_oi.oi.oi_seq, (__u32)(logid)->lgl_oi.oi.oi_id, 0
1394
1395 /********* Quotas **********/
1396
1397 /* From linux/fs/quota/quota.c */
1398 static inline __u64 toqb(__kernel_size_t space)
1399 {
1400         return (space + QIF_DQBLKSIZE - 1) >> QIF_DQBLKSIZE_BITS;
1401 }
1402
1403 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
1404 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
1405 #define Q_GETOINFO      0x800102 /* get obd quota info */
1406 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
1407 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
1408
1409 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
1410 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
1411 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
1412 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
1413 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
1414 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
1415 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
1416 /* lustre-specific control commands */
1417 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
1418 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
1419 #define LUSTRE_Q_GETDEFAULT  0x80000d     /* get default quota */
1420 #define LUSTRE_Q_SETDEFAULT  0x80000e     /* set default quota */
1421 #define LUSTRE_Q_GETQUOTAPOOL   0x80000f  /* get user pool quota */
1422 #define LUSTRE_Q_SETQUOTAPOOL   0x800010  /* set user pool quota */
1423 #define LUSTRE_Q_GETINFOPOOL    0x800011  /* get pool quota info */
1424 #define LUSTRE_Q_SETINFOPOOL    0x800012  /* set pool quota info */
1425 #define LUSTRE_Q_GETDEFAULT_POOL        0x800013  /* get default pool quota*/
1426 #define LUSTRE_Q_SETDEFAULT_POOL        0x800014  /* set default pool quota */
1427 #define LUSTRE_Q_DELETEQID      0x800015  /* delete quota ID */
1428 #define LUSTRE_Q_RESETQID       0x800016  /* reset quota ID */
1429 /* In the current Lustre implementation, the grace time is either the time
1430  * or the timestamp to be used after some quota ID exceeds the soft limt,
1431  * 48 bits should be enough, its high 16 bits can be used as quota flags.
1432  */
1433 #define LQUOTA_GRACE_BITS       48
1434 #define LQUOTA_GRACE_MASK       ((1ULL << LQUOTA_GRACE_BITS) - 1)
1435 #define LQUOTA_GRACE_MAX        LQUOTA_GRACE_MASK
1436 #define LQUOTA_GRACE(t)         (t & LQUOTA_GRACE_MASK)
1437 #define LQUOTA_FLAG(t)          (t >> LQUOTA_GRACE_BITS)
1438 #define LQUOTA_GRACE_FLAG(t, f) ((__u64)t | (__u64)f << LQUOTA_GRACE_BITS)
1439
1440 /* special grace time, only notify the user when its quota is over soft limit
1441  * but doesn't block new writes until the hard limit is reached.
1442  */
1443 #define NOTIFY_GRACE            "notify"
1444 #define NOTIFY_GRACE_TIME       LQUOTA_GRACE_MASK
1445
1446 /* different quota flags */
1447
1448 /* the default quota flag, the corresponding quota ID will use the default
1449  * quota setting, the hardlimit and softlimit of its quota record in the global
1450  * quota file will be set to 0, the low 48 bits of the grace will be set to 0
1451  * and high 16 bits will contain this flag (see above comment).
1452  */
1453 #define LQUOTA_FLAG_DEFAULT     0x0001
1454 #define LQUOTA_FLAG_DELETED     0x0002
1455 #define LQUOTA_FLAG_RESET       0x0004
1456 #define LQUOTA_FLAG_REVOKE      0x0008
1457
1458 #define LUSTRE_Q_CMD_IS_POOL(cmd)               \
1459         (cmd == LUSTRE_Q_GETQUOTAPOOL ||        \
1460          cmd == LUSTRE_Q_SETQUOTAPOOL ||        \
1461          cmd == LUSTRE_Q_SETINFOPOOL ||         \
1462          cmd == LUSTRE_Q_GETINFOPOOL ||         \
1463          cmd == LUSTRE_Q_SETDEFAULT_POOL ||     \
1464          cmd == LUSTRE_Q_GETDEFAULT_POOL)
1465
1466 #define ALLQUOTA 255       /* set all quota */
1467 static inline const char *qtype_name(int qtype)
1468 {
1469         switch (qtype) {
1470         case USRQUOTA:
1471                 return "usr";
1472         case GRPQUOTA:
1473                 return "grp";
1474         case PRJQUOTA:
1475                 return "prj";
1476         }
1477         return "unknown";
1478 }
1479
1480 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
1481
1482 /* permission */
1483 #define N_PERMS_MAX      64
1484
1485 struct perm_downcall_data {
1486         __u64 pdd_nid;
1487         __u32 pdd_perm;
1488         __u32 pdd_padding;
1489 };
1490
1491 struct identity_downcall_data {
1492         __u32                            idd_magic;
1493         __u32                            idd_err;
1494         __u32                            idd_uid;
1495         __u32                            idd_gid;
1496         __u32                            idd_nperms;
1497         __u32                            idd_ngroups;
1498         struct perm_downcall_data idd_perms[N_PERMS_MAX];
1499         __u32                            idd_groups[0];
1500 };
1501
1502 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 16, 53, 0)
1503 /* old interface struct is deprecated in 2.14 */
1504 #define SEPOL_DOWNCALL_MAGIC_OLD 0x8b8bb842
1505 struct sepol_downcall_data_old {
1506         __u32           sdd_magic;
1507         __s64           sdd_sepol_mtime;
1508         __u16           sdd_sepol_len;
1509         char            sdd_sepol[0];
1510 };
1511 #endif
1512
1513 #define SEPOL_DOWNCALL_MAGIC 0x8b8bb843
1514 struct sepol_downcall_data {
1515         __u32           sdd_magic;
1516         __u16           sdd_sepol_len;
1517         __u16           sdd_padding1;
1518         __s64           sdd_sepol_mtime;
1519         char            sdd_sepol[0];
1520 };
1521
1522 #ifdef NEED_QUOTA_DEFS
1523 #ifndef QIF_BLIMITS
1524 #define QIF_BLIMITS     1
1525 #define QIF_SPACE       2
1526 #define QIF_ILIMITS     4
1527 #define QIF_INODES      8
1528 #define QIF_BTIME       16
1529 #define QIF_ITIME       32
1530 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
1531 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
1532 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
1533 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
1534 #endif
1535
1536 #endif /* !__KERNEL__ */
1537
1538 /* lustre volatile file support
1539  * file name header: ".^L^S^T^R:volatile"
1540  */
1541 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
1542 #define LUSTRE_VOLATILE_HDR_LEN 14
1543
1544 enum lustre_quota_version {
1545         LUSTRE_QUOTA_V2 = 1
1546 };
1547
1548 /* XXX: same as if_dqinfo struct in kernel */
1549 struct obd_dqinfo {
1550         __u64 dqi_bgrace;
1551         __u64 dqi_igrace;
1552         __u32 dqi_flags;
1553         __u32 dqi_valid;
1554 };
1555
1556 /* XXX: same as if_dqblk struct in kernel, plus one padding */
1557 struct obd_dqblk {
1558         __u64 dqb_bhardlimit;   /* kbytes unit */
1559         __u64 dqb_bsoftlimit;   /* kbytes unit */
1560         __u64 dqb_curspace;     /* bytes unit */
1561         __u64 dqb_ihardlimit;
1562         __u64 dqb_isoftlimit;
1563         __u64 dqb_curinodes;
1564         __u64 dqb_btime;
1565         __u64 dqb_itime;
1566         __u32 dqb_valid;
1567         __u32 dqb_padding;
1568 };
1569
1570 enum {
1571         QC_GENERAL      = 0,
1572         QC_MDTIDX       = 1,
1573         QC_OSTIDX       = 2,
1574         QC_UUID         = 3
1575 };
1576
1577 struct if_quotactl {
1578         __u32                   qc_cmd;
1579         __u32                   qc_type;
1580         __u32                   qc_id;
1581         __u32                   qc_stat;
1582         __u32                   qc_valid;
1583         __u32                   qc_idx;
1584         struct obd_dqinfo       qc_dqinfo;
1585         struct obd_dqblk        qc_dqblk;
1586         char                    obd_type[16];
1587         struct obd_uuid         obd_uuid;
1588         char                    qc_poolname[];
1589 };
1590
1591 /* swap layout flags */
1592 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
1593 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
1594 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
1595 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
1596 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
1597
1598 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
1599 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
1600 struct lustre_swap_layouts {
1601         __u64   sl_flags;
1602         __u32   sl_fd;
1603         __u32   sl_gid;
1604         __u64   sl_dv1;
1605         __u64   sl_dv2;
1606 };
1607
1608 /** Bit-mask of valid attributes */
1609 /* The LA_* flags are written to disk as part of the ChangeLog records
1610  * so they are part of the on-disk and network protocol, and cannot be changed.
1611  * Only the first 12 bits are currently saved.
1612  */
1613 enum la_valid {
1614         LA_ATIME        = 1 << 0,       /* 0x00001 */
1615         LA_MTIME        = 1 << 1,       /* 0x00002 */
1616         LA_CTIME        = 1 << 2,       /* 0x00004 */
1617         LA_SIZE         = 1 << 3,       /* 0x00008 */
1618         LA_MODE         = 1 << 4,       /* 0x00010 */
1619         LA_UID          = 1 << 5,       /* 0x00020 */
1620         LA_GID          = 1 << 6,       /* 0x00040 */
1621         LA_BLOCKS       = 1 << 7,       /* 0x00080 */
1622         LA_TYPE         = 1 << 8,       /* 0x00100 */
1623         LA_FLAGS        = 1 << 9,       /* 0x00200 */
1624         LA_NLINK        = 1 << 10,      /* 0x00400 */
1625         LA_RDEV         = 1 << 11,      /* 0x00800 */
1626         LA_BLKSIZE      = 1 << 12,      /* 0x01000 */
1627         LA_KILL_SUID    = 1 << 13,      /* 0x02000 */
1628         LA_KILL_SGID    = 1 << 14,      /* 0x04000 */
1629         LA_PROJID       = 1 << 15,      /* 0x08000 */
1630         LA_LAYOUT_VERSION = 1 << 16,    /* 0x10000 */
1631         LA_LSIZE        = 1 << 17,      /* 0x20000 */
1632         LA_LBLOCKS      = 1 << 18,      /* 0x40000 */
1633         LA_BTIME        = 1 << 19,      /* 0x80000 */
1634         LA_DIRENT_CNT   = 1 << 20,     /* 0x100000 */
1635         /**
1636          * Attributes must be transmitted to OST objects
1637          */
1638         LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1639 };
1640
1641 #define MDS_FMODE_READ           00000001
1642 #define MDS_FMODE_WRITE          00000002
1643
1644 #define MDS_FMODE_CLOSED         00000000
1645 #define MDS_FMODE_EXEC           00000004
1646 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
1647 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
1648 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
1649
1650 #define MDS_OPEN_CREATED         00000010
1651 /*      MDS_OPEN_CROSS           00000020 obsolete in 2.12, internal use only */
1652
1653 #define MDS_OPEN_CREAT           00000100
1654 #define MDS_OPEN_EXCL            00000200
1655 #define MDS_OPEN_TRUNC           00001000
1656 #define MDS_OPEN_APPEND          00002000
1657 #define MDS_OPEN_SYNC            00010000
1658 #define MDS_OPEN_DIRECTORY       00200000
1659
1660 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
1661 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1662 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1663 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1664                                            * We do not support JOIN FILE
1665                                            * anymore, reserve this flags
1666                                            * just for preventing such bit
1667                                            * to be reused.
1668                                            */
1669
1670 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1671 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1672 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1673 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
1674 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
1675                                               * hsm restore)
1676                                               */
1677 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
1678                                               * linked
1679                                               */
1680 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
1681                                               * delegation, succeed if it's not
1682                                               * being opened with conflict mode.
1683                                               */
1684 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
1685
1686 #define MDS_OPEN_RESYNC    04000000000000ULL /* FLR: file resync */
1687 #define MDS_OPEN_PCC      010000000000000ULL /* PCC: auto RW-PCC cache attach
1688                                               * for newly created file
1689                                               */
1690 #define MDS_OP_WITH_FID   020000000000000ULL /* operation carried out by FID */
1691 #define MDS_OPEN_DEFAULT_LMV  040000000000000ULL /* open fetches default LMV,
1692                                                   * or mkdir with default LMV
1693                                                   */
1694
1695 /* lustre internal open flags, which should not be set from user space */
1696 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
1697                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
1698                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
1699                               MDS_OPEN_RELEASE | MDS_OPEN_RESYNC |      \
1700                               MDS_OPEN_PCC | MDS_OP_WITH_FID |          \
1701                               MDS_OPEN_DEFAULT_LMV)
1702
1703 /* mkdir fetches LMV, reuse bit of MDS_OPEN_RESYNC */
1704 #define MDS_MKDIR_LMV   MDS_OPEN_RESYNC
1705
1706 /********* Changelogs **********/
1707 /** Changelog record types */
1708 enum changelog_rec_type {
1709         CL_NONE     = -1,
1710         CL_MARK     = 0,
1711         CL_CREATE   = 1,  /* namespace */
1712         CL_MKDIR    = 2,  /* namespace */
1713         CL_HARDLINK = 3,  /* namespace */
1714         CL_SOFTLINK = 4,  /* namespace */
1715         CL_MKNOD    = 5,  /* namespace */
1716         CL_UNLINK   = 6,  /* namespace */
1717         CL_RMDIR    = 7,  /* namespace */
1718         CL_RENAME   = 8,  /* namespace */
1719         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
1720         CL_OPEN     = 10, /* not currently used */
1721         CL_CLOSE    = 11, /* may be written to log only with mtime change */
1722         CL_LAYOUT   = 12, /* file layout/striping modified */
1723         CL_TRUNC    = 13,
1724         CL_SETATTR  = 14,
1725         CL_SETXATTR = 15,
1726         CL_XATTR    = CL_SETXATTR, /* Deprecated name */
1727         CL_HSM      = 16, /* HSM specific events, see flags */
1728         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
1729         CL_CTIME    = 18,
1730         CL_ATIME    = 19,
1731         CL_MIGRATE  = 20,
1732         CL_FLRW     = 21, /* FLR: file was firstly written */
1733         CL_RESYNC   = 22, /* FLR: file was resync-ed */
1734         CL_GETXATTR = 23,
1735         CL_DN_OPEN  = 24, /* denied open */
1736         CL_LAST,
1737 };
1738
1739 static inline const char *changelog_type2str(int type)
1740 {
1741         static const char *const changelog_str[] = {
1742                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1743                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
1744                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT",
1745                 "FLRW",  "RESYNC", "GXATR", "NOPEN",
1746         };
1747
1748         if (type >= 0 && type < CL_LAST)
1749                 return changelog_str[type];
1750         return NULL;
1751 }
1752
1753 /* 12 bits of per-record data can be stored in the bottom of the flags */
1754 #define CLF_FLAGSHIFT   12
1755 enum changelog_rec_flags {
1756         CLF_VERSION     = 0x1000,
1757         CLF_RENAME      = 0x2000,
1758         CLF_JOBID       = 0x4000,
1759         CLF_EXTRA_FLAGS = 0x8000,
1760         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID |
1761                           CLF_EXTRA_FLAGS,
1762         CLF_FLAGMASK    = (1U << CLF_FLAGSHIFT) - 1,
1763         CLF_VERMASK     = ~CLF_FLAGMASK,
1764 };
1765
1766
1767 /* Anything under the flagmask may be per-type (if desired) */
1768 /* Flags for unlink */
1769 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
1770 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1771                                      /* HSM cleaning needed */
1772 /* Flags for rename */
1773 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
1774                                         * of target
1775                                         */
1776 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
1777                                         * has an archive in backend
1778                                         */
1779
1780 /* Flags for HSM */
1781 /* 12b used (from high weight to low weight):
1782  * 2b for flags
1783  * 3b for event
1784  * 7b for error code
1785  */
1786 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
1787 #define CLF_HSM_ERR_H        6
1788 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
1789 #define CLF_HSM_EVENT_H      9
1790 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
1791 #define CLF_HSM_FLAG_H      11
1792 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
1793 #define CLF_HSM_SPARE_H     15
1794 #define CLF_HSM_LAST        15
1795
1796 /* Remove bits higher than _h, then extract the value
1797  * between _h and _l by shifting lower weigth to bit 0.
1798  */
1799 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1800                                    >> (CLF_HSM_LAST - _h + _l))
1801
1802 #define CLF_HSM_SUCCESS      0x00
1803 #define CLF_HSM_MAXERROR     0x7E
1804 #define CLF_HSM_ERROVERFLOW  0x7F
1805
1806 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
1807
1808 /* 3 bits field => 8 values allowed */
1809 enum hsm_event {
1810         HE_ARCHIVE      = 0,
1811         HE_RESTORE      = 1,
1812         HE_CANCEL       = 2,
1813         HE_RELEASE      = 3,
1814         HE_REMOVE       = 4,
1815         HE_STATE        = 5,
1816         HE_SPARE1       = 6,
1817         HE_SPARE2       = 7,
1818 };
1819
1820 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1821 {
1822         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1823                                             CLF_HSM_EVENT_L);
1824 }
1825
1826 static inline void hsm_set_cl_event(enum changelog_rec_flags *clf_flags,
1827                                     enum hsm_event he)
1828 {
1829         *clf_flags = (enum changelog_rec_flags)
1830                 (*clf_flags | (he << CLF_HSM_EVENT_L));
1831 }
1832
1833 static inline __u16 hsm_get_cl_flags(enum changelog_rec_flags clf_flags)
1834 {
1835         return CLF_GET_BITS(clf_flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1836 }
1837
1838 static inline void hsm_set_cl_flags(enum changelog_rec_flags *clf_flags,
1839                                     unsigned int bits)
1840 {
1841         *clf_flags = (enum changelog_rec_flags)
1842                 (*clf_flags | (bits << CLF_HSM_FLAG_L));
1843 }
1844
1845 static inline int hsm_get_cl_error(enum changelog_rec_flags clf_flags)
1846 {
1847         return CLF_GET_BITS(clf_flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1848 }
1849
1850 static inline int hsm_set_cl_error(enum changelog_rec_flags *clf_flags,
1851                                    int error)
1852 {
1853         /* In case a negative error is given */
1854         error = abs(error);
1855
1856         if (error > CLF_HSM_MAXERROR)
1857                 error = CLF_HSM_ERROVERFLOW;
1858
1859         *clf_flags = (enum changelog_rec_flags)
1860                 (*clf_flags | (error << CLF_HSM_ERR_L));
1861
1862         return error == CLF_HSM_ERROVERFLOW ? -EOVERFLOW : 0;
1863 }
1864
1865 enum changelog_rec_extra_flags {
1866         CLFE_INVALID    = 0,
1867         CLFE_UIDGID     = 0x0001,
1868         CLFE_NID        = 0x0002,
1869         CLFE_OPEN       = 0x0004,
1870         CLFE_XATTR      = 0x0008,
1871         CLFE_SUPPORTED  = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1872 };
1873
1874 enum changelog_send_flag {
1875         /* Use changelog follow mode: llapi_changelog_recv() will not stop at
1876          * the end of records and wait for new records to be generated.
1877          */
1878         CHANGELOG_FLAG_FOLLOW      = 0x01,
1879         /* Deprecated since Lustre 2.10 */
1880         CHANGELOG_FLAG_BLOCK       = 0x02,
1881         /* Pack jobid into the changelog records if available. */
1882         CHANGELOG_FLAG_JOBID       = 0x04,
1883         /* Pack additional flag bits into the changelog record */
1884         CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1885 };
1886
1887 enum changelog_send_extra_flag {
1888         /* Pack uid/gid into the changelog record */
1889         CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1890         /* Pack nid into the changelog record */
1891         CHANGELOG_EXTRA_FLAG_NID    = 0x02,
1892         /* Pack open mode into the changelog record */
1893         CHANGELOG_EXTRA_FLAG_OMODE  = 0x04,
1894         /* Pack xattr name into the changelog record */
1895         CHANGELOG_EXTRA_FLAG_XATTR  = 0x08,
1896 };
1897
1898 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1899                                   changelog_rec_offset(CLF_SUPPORTED, \
1900                                                        CLFE_SUPPORTED), 8)
1901
1902 /* 31 usable bytes string + null terminator. */
1903 #define LUSTRE_JOBID_SIZE       32
1904
1905 /* This is the minimal changelog record. It can contain extensions
1906  * such as rename fields or process jobid. Its exact content is described
1907  * by the cr_flags and cr_extra_flags.
1908  *
1909  * Extensions are packed in the same order as their corresponding flags,
1910  * then in the same order as their corresponding extra flags.
1911  */
1912 struct changelog_rec {
1913         __u16                   cr_namelen;
1914         __u16                   cr_flags; /**< \a changelog_rec_flags */
1915         __u32                   cr_type;  /**< \a changelog_rec_type */
1916         __u64                   cr_index; /**< changelog record number */
1917         __u64                   cr_prev;  /**< last index for this target fid */
1918         __u64                   cr_time;
1919         union {
1920                 struct lu_fid   cr_tfid;        /**< target fid */
1921                 __u32           cr_markerflags; /**< CL_MARK flags */
1922         };
1923         struct lu_fid           cr_pfid;        /**< parent fid */
1924 } __attribute__ ((packed));
1925
1926 /* Changelog extension for RENAME. */
1927 struct changelog_ext_rename {
1928         struct lu_fid           cr_sfid;     /**< source fid, or zero */
1929         struct lu_fid           cr_spfid;    /**< source parent fid, or zero */
1930 };
1931
1932 /* Changelog extension to include JOBID. */
1933 struct changelog_ext_jobid {
1934         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
1935 };
1936
1937 /* Changelog extension to include additional flags. */
1938 struct changelog_ext_extra_flags {
1939         __u64 cr_extra_flags; /* Additional CLFE_* flags */
1940 };
1941
1942 /* Changelog extra extension to include UID/GID. */
1943 struct changelog_ext_uidgid {
1944         __u64   cr_uid;
1945         __u64   cr_gid;
1946 };
1947
1948 /* Changelog extra extension to include NID. */
1949 struct changelog_ext_nid {
1950         /* have __u64 instead of lnet_nid_t type for use by client api */
1951         __u64 cr_nid;
1952         /* for use when IPv6 support is added */
1953         __u64 extra;
1954         __u32 padding;
1955 };
1956
1957 /* Changelog extra extension to include low 32 bits of MDS_OPEN_* flags. */
1958 struct changelog_ext_openmode {
1959         __u32 cr_openflags;
1960 };
1961
1962 /* Changelog extra extension to include xattr */
1963 struct changelog_ext_xattr {
1964         char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1965 };
1966
1967 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1968         const struct changelog_rec *rec);
1969
1970 static
1971 inline __kernel_size_t changelog_rec_offset(enum changelog_rec_flags crf,
1972                                             enum changelog_rec_extra_flags cref)
1973 {
1974         __kernel_size_t size = sizeof(struct changelog_rec);
1975
1976         if (crf & CLF_RENAME)
1977                 size += sizeof(struct changelog_ext_rename);
1978
1979         if (crf & CLF_JOBID)
1980                 size += sizeof(struct changelog_ext_jobid);
1981
1982         if (crf & CLF_EXTRA_FLAGS) {
1983                 size += sizeof(struct changelog_ext_extra_flags);
1984                 if (cref & CLFE_UIDGID)
1985                         size += sizeof(struct changelog_ext_uidgid);
1986                 if (cref & CLFE_NID)
1987                         size += sizeof(struct changelog_ext_nid);
1988                 if (cref & CLFE_OPEN)
1989                         size += sizeof(struct changelog_ext_openmode);
1990                 if (cref & CLFE_XATTR)
1991                         size += sizeof(struct changelog_ext_xattr);
1992         }
1993
1994         return size;
1995 }
1996
1997 static
1998 inline __kernel_size_t changelog_rec_size(const struct changelog_rec *rec)
1999 {
2000         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2001
2002         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2003                 cref = (enum changelog_rec_extra_flags)
2004                          changelog_rec_extra_flags(rec)->cr_extra_flags;
2005
2006         return changelog_rec_offset(
2007                 (enum changelog_rec_flags)rec->cr_flags, cref);
2008 }
2009
2010 static
2011 inline __kernel_size_t changelog_rec_varsize(const struct changelog_rec *rec)
2012 {
2013         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
2014 }
2015
2016 static inline
2017 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
2018 {
2019         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2020                 (rec->cr_flags & CLF_VERSION);
2021
2022         return (struct changelog_ext_rename *)((char *)rec +
2023                                                changelog_rec_offset(crf,
2024                                                                  CLFE_INVALID));
2025 }
2026
2027 /* The jobid follows the rename extension, if present */
2028 static inline
2029 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
2030 {
2031         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2032                                 (rec->cr_flags & (CLF_VERSION | CLF_RENAME));
2033
2034         return (struct changelog_ext_jobid *)((char *)rec +
2035                                               changelog_rec_offset(crf,
2036                                                                  CLFE_INVALID));
2037 }
2038
2039 /* The additional flags follow the rename and jobid extensions, if present */
2040 static inline
2041 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
2042         const struct changelog_rec *rec)
2043 {
2044         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2045             (rec->cr_flags & (CLF_VERSION | CLF_RENAME | CLF_JOBID));
2046
2047         return (struct changelog_ext_extra_flags *)((char *)rec +
2048                                                  changelog_rec_offset(crf,
2049                                                                  CLFE_INVALID));
2050 }
2051
2052 /* The uid/gid is the first extra extension */
2053 static inline
2054 struct changelog_ext_uidgid *changelog_rec_uidgid(
2055         const struct changelog_rec *rec)
2056 {
2057         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2058             (rec->cr_flags &
2059                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
2060
2061         return (struct changelog_ext_uidgid *)((char *)rec +
2062                                                changelog_rec_offset(crf,
2063                                                                  CLFE_INVALID));
2064 }
2065
2066 /* The nid is the second extra extension */
2067 static inline
2068 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
2069 {
2070         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2071             (rec->cr_flags &
2072              (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
2073         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2074
2075         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2076                 cref = (enum changelog_rec_extra_flags)
2077                         (changelog_rec_extra_flags(rec)->cr_extra_flags &
2078                          CLFE_UIDGID);
2079
2080         return (struct changelog_ext_nid *)((char *)rec +
2081                                             changelog_rec_offset(crf, cref));
2082 }
2083
2084 /* The OPEN mode is the third extra extension */
2085 static inline
2086 struct changelog_ext_openmode *changelog_rec_openmode(
2087         const struct changelog_rec *rec)
2088 {
2089         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2090                 (rec->cr_flags &
2091                  (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
2092         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2093
2094         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
2095                 cref = (enum changelog_rec_extra_flags)
2096                         (changelog_rec_extra_flags(rec)->cr_extra_flags &
2097                          (CLFE_UIDGID | CLFE_NID));
2098         }
2099
2100         return (struct changelog_ext_openmode *)((char *)rec +
2101                                                changelog_rec_offset(crf, cref));
2102 }
2103
2104 /* The xattr name is the fourth extra extension */
2105 static inline
2106 struct changelog_ext_xattr *changelog_rec_xattr(
2107         const struct changelog_rec *rec)
2108 {
2109         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2110             (rec->cr_flags &
2111              (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
2112         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2113
2114         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2115                 cref = (enum changelog_rec_extra_flags)
2116                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
2117                         (CLFE_UIDGID | CLFE_NID | CLFE_OPEN));
2118
2119         return (struct changelog_ext_xattr *)((char *)rec +
2120                                               changelog_rec_offset(crf, cref));
2121 }
2122
2123 /* The name follows the rename, jobid  and extra flags extns, if present */
2124 static inline char *changelog_rec_name(const struct changelog_rec *rec)
2125 {
2126         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2127
2128         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2129                 cref = (enum changelog_rec_extra_flags)
2130                     changelog_rec_extra_flags(rec)->cr_extra_flags;
2131
2132         return (char *)rec + changelog_rec_offset(
2133                 (enum changelog_rec_flags)(rec->cr_flags & CLF_SUPPORTED),
2134                 (enum changelog_rec_extra_flags)(cref & CLFE_SUPPORTED));
2135 }
2136
2137 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
2138 {
2139         char *str = changelog_rec_name(rec);
2140         char *end = str + NAME_MAX; /* NB: NAME_MAX use in CR_MAXSIZE */
2141
2142         while (*str != '\0' && str <= end)
2143                 str++;
2144         return str + 1;
2145 }
2146
2147 static
2148 inline __kernel_size_t changelog_rec_snamelen(const struct changelog_rec *rec)
2149 {
2150         return rec->cr_namelen -
2151                (changelog_rec_sname(rec) - changelog_rec_name(rec));
2152 }
2153
2154 /**
2155  * Remap a record to the desired format as specified by the crf flags.
2156  * The record must be big enough to contain the final remapped version.
2157  * Superfluous extension fields are removed and missing ones are added
2158  * and zeroed. The flags of the record are updated accordingly.
2159  *
2160  * The jobid and rename extensions can be added to a record, to match the
2161  * format an application expects, typically. In this case, the newly added
2162  * fields will be zeroed.
2163  * The Jobid field can be removed, to guarantee compatibility with older
2164  * clients that don't expect this field in the records they process.
2165  *
2166  * The following assumptions are being made:
2167  *   - CLF_RENAME will not be removed
2168  *   - CLF_JOBID will not be added without CLF_RENAME being added too
2169  *   - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
2170  *
2171  * @param[in,out]  rec         The record to remap.
2172  * @param[in]      crf_wanted  Flags describing the desired extensions.
2173  * @param[in]      cref_want   Flags describing the desired extra extensions.
2174  */
2175 static inline void changelog_remap_rec(struct changelog_rec *rec,
2176                                        enum changelog_rec_flags crf_wanted,
2177                                        enum changelog_rec_extra_flags cref_want)
2178 {
2179         char *xattr_mov = NULL;
2180         char *omd_mov = NULL;
2181         char *nid_mov = NULL;
2182         char *uidgid_mov = NULL;
2183         char *ef_mov;
2184         char *jid_mov;
2185         char *rnm_mov;
2186         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2187
2188         crf_wanted = (enum changelog_rec_flags)
2189             (crf_wanted & CLF_SUPPORTED);
2190         cref_want = (enum changelog_rec_extra_flags)
2191             (cref_want & CLFE_SUPPORTED);
2192
2193         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
2194                 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
2195                     (rec->cr_flags & CLF_EXTRA_FLAGS &&
2196                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
2197                                                         CLFE_SUPPORTED) ==
2198                                                                      cref_want))
2199                         return;
2200         }
2201
2202         /* First move the variable-length name field */
2203         memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
2204                 changelog_rec_name(rec), rec->cr_namelen);
2205
2206         /* Locations of extensions in the remapped record */
2207         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
2208                 xattr_mov = (char *)rec +
2209                         changelog_rec_offset(
2210                             (enum changelog_rec_flags)
2211                                     (crf_wanted & CLF_SUPPORTED),
2212                             (enum changelog_rec_extra_flags)
2213                                     (cref_want & ~CLFE_XATTR));
2214                 omd_mov = (char *)rec +
2215                         changelog_rec_offset(
2216                             (enum changelog_rec_flags)
2217                                     (crf_wanted & CLF_SUPPORTED),
2218                             (enum changelog_rec_extra_flags)
2219                                     (cref_want & ~(CLFE_OPEN | CLFE_XATTR)));
2220                 nid_mov = (char *)rec +
2221                         changelog_rec_offset(
2222                             (enum changelog_rec_flags)
2223                                 (crf_wanted & CLF_SUPPORTED),
2224                             (enum changelog_rec_extra_flags)
2225                                 (cref_want &
2226                                  ~(CLFE_NID | CLFE_OPEN | CLFE_XATTR)));
2227                 uidgid_mov = (char *)rec +
2228                         changelog_rec_offset(
2229                                 (enum changelog_rec_flags)
2230                                     (crf_wanted & CLF_SUPPORTED),
2231                                 (enum changelog_rec_extra_flags)
2232                                     (cref_want & ~(CLFE_UIDGID |
2233                                                            CLFE_NID |
2234                                                            CLFE_OPEN |
2235                                                            CLFE_XATTR)));
2236                 cref = (enum changelog_rec_extra_flags)
2237                         changelog_rec_extra_flags(rec)->cr_extra_flags;
2238         }
2239
2240         ef_mov  = (char *)rec +
2241                   changelog_rec_offset(
2242                                 (enum changelog_rec_flags)
2243                                  (crf_wanted & ~CLF_EXTRA_FLAGS), CLFE_INVALID);
2244         jid_mov = (char *)rec +
2245                   changelog_rec_offset((enum changelog_rec_flags)(crf_wanted &
2246                                        ~(CLF_EXTRA_FLAGS | CLF_JOBID)),
2247                                        CLFE_INVALID);
2248         rnm_mov = (char *)rec +
2249                   changelog_rec_offset((enum changelog_rec_flags)(crf_wanted &
2250                                        ~(CLF_EXTRA_FLAGS |
2251                                          CLF_JOBID |
2252                                          CLF_RENAME)),
2253                                        CLFE_INVALID);
2254
2255         /* Move the extension fields to the desired positions */
2256         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
2257             (rec->cr_flags & CLF_EXTRA_FLAGS)) {
2258                 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
2259                         memmove(xattr_mov, changelog_rec_xattr(rec),
2260                                 sizeof(struct changelog_ext_xattr));
2261
2262                 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
2263                         memmove(omd_mov, changelog_rec_openmode(rec),
2264                                 sizeof(struct changelog_ext_openmode));
2265
2266                 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
2267                         memmove(nid_mov, changelog_rec_nid(rec),
2268                                 sizeof(struct changelog_ext_nid));
2269
2270                 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
2271                         memmove(uidgid_mov, changelog_rec_uidgid(rec),
2272                                 sizeof(struct changelog_ext_uidgid));
2273
2274                 memmove(ef_mov, changelog_rec_extra_flags(rec),
2275                         sizeof(struct changelog_ext_extra_flags));
2276         }
2277
2278         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
2279                 memmove(jid_mov, changelog_rec_jobid(rec),
2280                         sizeof(struct changelog_ext_jobid));
2281
2282         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
2283                 memmove(rnm_mov, changelog_rec_rename(rec),
2284                         sizeof(struct changelog_ext_rename));
2285
2286         /* Clear newly added fields */
2287         if (xattr_mov && (cref_want & CLFE_XATTR) &&
2288             !(cref & CLFE_XATTR))
2289                 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
2290
2291         if (omd_mov && (cref_want & CLFE_OPEN) &&
2292             !(cref & CLFE_OPEN))
2293                 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
2294
2295         if (nid_mov && (cref_want & CLFE_NID) &&
2296             !(cref & CLFE_NID))
2297                 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
2298
2299         if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
2300             !(cref & CLFE_UIDGID))
2301                 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
2302
2303         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
2304             !(rec->cr_flags & CLF_EXTRA_FLAGS))
2305                 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
2306
2307         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
2308                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
2309
2310         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
2311                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
2312
2313         /* Update the record's flags accordingly */
2314         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
2315         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2316                 changelog_rec_extra_flags(rec)->cr_extra_flags =
2317                         changelog_rec_extra_flags(rec)->cr_extra_flags |
2318                         cref_want;
2319 }
2320
2321 enum changelog_message_type {
2322         CL_RECORD = 10, /* message is a changelog_rec */
2323         CL_EOF    = 11, /* at end of current changelog */
2324 };
2325
2326 /********* Misc **********/
2327
2328 struct ioc_data_version {
2329         __u64   idv_version;
2330         __u32   idv_layout_version; /* FLR: layout version for OST objects */
2331         __u32   idv_flags;      /* enum ioc_data_version_flags */
2332 };
2333
2334 enum ioc_data_version_flags {
2335         LL_DV_RD_FLUSH  = (1 << 0), /* Flush dirty pages from clients */
2336         LL_DV_WR_FLUSH  = (1 << 1), /* Flush all caching pages from clients */
2337         LL_DV_SZ_UPDATE = (1 << 2), /* Update the file size on the client */
2338 };
2339
2340 #ifndef offsetof
2341 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
2342 #endif
2343
2344 #define dot_lustre_name ".lustre"
2345 #define dot_fscrypt_name ".fscrypt"
2346
2347
2348 /********* HSM **********/
2349
2350 #define UUID_MAX        40
2351
2352 struct lov_hsm_base {
2353         /* HSM archive ID */
2354         __u64   lhb_archive_id;
2355         /* Data version associated with the last archiving, if any. */
2356         __u64   lhb_archive_ver;
2357         /* Identifier within HSM backend */
2358         char    lhb_uuid[UUID_MAX];
2359 };
2360
2361 /**
2362  * HSM layout is a kind of FOREIGN layout.
2363  */
2364 struct lov_hsm_md {
2365         /* LOV_MAGIC_FOREIGN */
2366         __u32                   lhm_magic;
2367         /* To make HSM layout compatible with lov_foreign_md, this @length
2368          * includes everything after @lhm_flags: sizeof(lhm_archive_id) +
2369          * sizeof(lhm_archive_ver) + lenght of lhm_archive_uuid.
2370          */
2371         __u32                   lhm_length;
2372         /* HSM type, see LU_FOREIGN_TYPE_(POSIX, S3, PCCRW, PCCRO}. */
2373         __u32                   lhm_type;
2374         /* HSM flags, see enum hsm_states */
2375         __u32                   lhm_flags;
2376         /*
2377          * Data structure members above are compatible with @lov_foreign_md.
2378          * The following members are private to HSM layout.
2379          */
2380         struct lov_hsm_base     lhm_hsm;
2381 } __attribute__((packed));
2382
2383 #define lhm_archive_id          lhm_hsm.lhb_archive_id
2384 #define lhm_archive_ver         lhm_hsm.lhb_archive_ver
2385 #define lhm_archive_uuid        lhm_hsm.lhb_uuid
2386
2387 static inline bool lov_hsm_type_supported(__u32 type)
2388 {
2389         return type == LU_FOREIGN_TYPE_POSIX || type == LU_FOREIGN_TYPE_PCCRW ||
2390                type == LU_FOREIGN_TYPE_PCCRO || type == LU_FOREIGN_TYPE_S3;
2391 }
2392
2393 static inline bool lov_foreign_type_supported(__u32 type)
2394 {
2395         return lov_hsm_type_supported(type) || type == LU_FOREIGN_TYPE_SYMLINK;
2396 }
2397
2398 /**
2399  * HSM per-file state
2400  * See HSM_FLAGS below.
2401  */
2402 enum hsm_states {
2403         HS_NONE         = 0x00000000,
2404         HS_EXISTS       = 0x00000001,
2405         HS_DIRTY        = 0x00000002,
2406         HS_RELEASED     = 0x00000004,
2407         HS_ARCHIVED     = 0x00000008,
2408         HS_NORELEASE    = 0x00000010,
2409         HS_NOARCHIVE    = 0x00000020,
2410         HS_LOST         = 0x00000040,
2411         HS_PCCRW        = 0x00000080,
2412         HS_PCCRO        = 0x00000100,
2413 };
2414
2415 /* HSM user-setable flags. */
2416 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
2417
2418 /* Other HSM flags. */
2419 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED | \
2420                          HS_PCCRW | HS_PCCRO)
2421
2422 /*
2423  * All HSM-related possible flags that could be applied to a file.
2424  * This should be kept in sync with hsm_states.
2425  */
2426 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
2427
2428 /**
2429  * HSM request progress state
2430  */
2431 enum hsm_progress_states {
2432         HPS_NONE        = 0,
2433         HPS_WAITING     = 1,
2434         HPS_RUNNING     = 2,
2435         HPS_DONE        = 3,
2436 };
2437
2438 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
2439 {
2440         switch  (s) {
2441         case HPS_WAITING:       return "waiting";
2442         case HPS_RUNNING:       return "running";
2443         case HPS_DONE:          return "done";
2444         default:                return "unknown";
2445         }
2446 }
2447
2448 struct hsm_extent {
2449         __u64 offset;
2450         __u64 length;
2451 } __attribute__((packed));
2452
2453 /**
2454  * Current HSM states of a Lustre file.
2455  *
2456  * This structure purpose is to be sent to user-space mainly. It describes the
2457  * current HSM flags and in-progress action.
2458  */
2459 struct hsm_user_state {
2460         /** Current HSM states, from enum hsm_states. */
2461         __u32                   hus_states;
2462         __u32                   hus_archive_id;
2463         /**  The current undergoing action, if there is one */
2464         __u32                   hus_in_progress_state;
2465         __u32                   hus_in_progress_action;
2466         struct hsm_extent       hus_in_progress_location;
2467         char                    hus_extended_info[];
2468 };
2469
2470 struct hsm_state_set_ioc {
2471         struct lu_fid   hssi_fid;
2472         __u64           hssi_setmask;
2473         __u64           hssi_clearmask;
2474 };
2475
2476 /*
2477  * This structure describes the current in-progress action for a file.
2478  * it is retuned to user space and send over the wire
2479  */
2480 struct hsm_current_action {
2481         /**  The current undergoing action, if there is one */
2482         /* state is one of hsm_progress_states */
2483         __u32                   hca_state;
2484         /* action is one of hsm_user_action */
2485         __u32                   hca_action;
2486         struct hsm_extent       hca_location;
2487 };
2488
2489 /***** HSM user requests ******/
2490 /* User-generated (lfs/ioctl) request types */
2491 enum hsm_user_action {
2492         HUA_NONE    =  1, /* no action (noop) */
2493         HUA_ARCHIVE = 10, /* copy to hsm */
2494         HUA_RESTORE = 11, /* prestage */
2495         HUA_RELEASE = 12, /* drop ost objects */
2496         HUA_REMOVE  = 13, /* remove from archive */
2497         HUA_CANCEL  = 14  /* cancel a request */
2498 };
2499
2500 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
2501 {
2502         switch  (a) {
2503         case HUA_NONE:    return "NOOP";
2504         case HUA_ARCHIVE: return "ARCHIVE";
2505         case HUA_RESTORE: return "RESTORE";
2506         case HUA_RELEASE: return "RELEASE";
2507         case HUA_REMOVE:  return "REMOVE";
2508         case HUA_CANCEL:  return "CANCEL";
2509         default:          return "UNKNOWN";
2510         }
2511 }
2512
2513 /*
2514  * List of hr_flags (bit field)
2515  */
2516 #define HSM_FORCE_ACTION 0x0001
2517 /* used by CT, cannot be set by user */
2518 #define HSM_GHOST_COPY   0x0002
2519
2520 /**
2521  * Contains all the fixed part of struct hsm_user_request.
2522  */
2523 struct hsm_request {
2524         __u32 hr_action;        /* enum hsm_user_action */
2525         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
2526         __u64 hr_flags;         /* request flags */
2527         __u32 hr_itemcount;     /* item count in hur_user_item vector */
2528         __u32 hr_data_len;
2529 };
2530
2531 struct hsm_user_item {
2532         struct lu_fid hui_fid;
2533         struct hsm_extent hui_extent;
2534 } __attribute__((packed));
2535
2536 struct hsm_user_request {
2537         struct hsm_request      hur_request;
2538         struct hsm_user_item    hur_user_item[0];
2539         /* extra data blob at end of struct (after all
2540          * hur_user_items), only use helpers to access it
2541          */
2542 } __attribute__((packed));
2543
2544 /** Return pointer to data field in a hsm user request */
2545 static inline void *hur_data(struct hsm_user_request *hur)
2546 {
2547         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
2548 }
2549
2550 /**
2551  * Compute the current length of the provided hsm_user_request.  This returns -1
2552  * instead of an errno because __kernel_ssize_t is defined to be only
2553  * [ -1, SSIZE_MAX ]
2554  *
2555  * return -1 on bounds check error.
2556  */
2557 static inline __kernel_size_t hur_len(struct hsm_user_request *hur)
2558 {
2559         __u64   size;
2560
2561         /* can't overflow a __u64 since hr_itemcount is only __u32 */
2562         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
2563                 (__u64)hur->hur_request.hr_itemcount *
2564                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
2565
2566         if ((__kernel_ssize_t)size < 0)
2567                 return -1;
2568
2569         return size;
2570 }
2571
2572 /****** HSM RPCs to copytool *****/
2573 /* Message types the copytool may receive */
2574 enum hsm_message_type {
2575         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
2576 };
2577
2578 /* Actions the copytool may be instructed to take for a given action_item */
2579 enum hsm_copytool_action {
2580         HSMA_NONE    = 10, /* no action */
2581         HSMA_ARCHIVE = 20, /* arbitrary offset */
2582         HSMA_RESTORE = 21,
2583         HSMA_REMOVE  = 22,
2584         HSMA_CANCEL  = 23
2585 };
2586
2587 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
2588 {
2589         switch  (a) {
2590         case HSMA_NONE:    return "NOOP";
2591         case HSMA_ARCHIVE: return "ARCHIVE";
2592         case HSMA_RESTORE: return "RESTORE";
2593         case HSMA_REMOVE:  return "REMOVE";
2594         case HSMA_CANCEL:  return "CANCEL";
2595         default:           return "UNKNOWN";
2596         }
2597 }
2598
2599 /* Copytool item action description */
2600 struct hsm_action_item {
2601         __u32      hai_len;     /* valid size of this struct */
2602         __u32      hai_action;  /* hsm_copytool_action, but use known size */
2603         struct lu_fid hai_fid;     /* Lustre FID to operate on */
2604         struct lu_fid hai_dfid;    /* fid used for data access */
2605         struct hsm_extent hai_extent;  /* byte range to operate on */
2606         __u64      hai_cookie;  /* action cookie from coordinator */
2607         __u64      hai_gid;     /* grouplock id */
2608         char       hai_data[0]; /* variable length */
2609 } __attribute__((packed));
2610
2611 /**
2612  * helper function which print in hexa the first bytes of
2613  * hai opaque field
2614  *
2615  * \param hai [IN]        record to print
2616  * \param buffer [IN,OUT] buffer to write the hex string to
2617  * \param len [IN]        max buffer length
2618  *
2619  * \retval buffer
2620  */
2621 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
2622                                         char *buffer, __kernel_size_t len)
2623 {
2624         int i;
2625         int data_len;
2626         char *ptr;
2627
2628         ptr = buffer;
2629         data_len = hai->hai_len - sizeof(*hai);
2630         for (i = 0; (i < data_len) && (len > 2); i++) {
2631                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
2632                 ptr += 2;
2633                 len -= 2;
2634         }
2635
2636         *ptr = '\0';
2637
2638         return buffer;
2639 }
2640
2641 /* Copytool action list */
2642 #define HAL_VERSION 1
2643 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
2644 struct hsm_action_list {
2645         __u32 hal_version;
2646         __u32 hal_count;       /* number of hai's to follow */
2647         __u64 hal_compound_id; /* returned by coordinator, ignored */
2648         __u64 hal_flags;
2649         __u32 hal_archive_id; /* which archive backend */
2650         __u32 padding1;
2651         char  hal_fsname[0];   /* null-terminated */
2652         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
2653          * boundaries. See i_zero
2654          */
2655 } __attribute__((packed));
2656
2657 /* Return pointer to first hai in action list */
2658 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
2659 {
2660         __kernel_size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2661
2662         return (struct hsm_action_item *)(hal->hal_fsname + offset);
2663 }
2664
2665 /* Return pointer to next hai */
2666 static inline struct hsm_action_item *hai_next(struct hsm_action_item *hai)
2667 {
2668         __kernel_size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
2669
2670         return (struct hsm_action_item *)((char *)hai + offset);
2671 }
2672
2673 /* Return size of an hsm_action_list */
2674 static inline __kernel_size_t hal_size(struct hsm_action_list *hal)
2675 {
2676         __u32 i;
2677         __kernel_size_t sz;
2678         struct hsm_action_item *hai;
2679
2680         sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2681         hai = hai_first(hal);
2682         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
2683                 sz += __ALIGN_KERNEL(hai->hai_len, 8);
2684
2685         return sz;
2686 }
2687
2688 /* HSM file import
2689  * describe the attributes to be set on imported file
2690  */
2691 struct hsm_user_import {
2692         __u64           hui_size;
2693         __u64           hui_atime;
2694         __u64           hui_mtime;
2695         __u32           hui_atime_ns;
2696         __u32           hui_mtime_ns;
2697         __u32           hui_uid;
2698         __u32           hui_gid;
2699         __u32           hui_mode;
2700         __u32           hui_archive_id;
2701 };
2702
2703 /* Copytool progress reporting */
2704 #define HP_FLAG_COMPLETED 0x01
2705 #define HP_FLAG_RETRY     0x02
2706
2707 struct hsm_progress {
2708         struct lu_fid           hp_fid;
2709         __u64                   hp_cookie;
2710         struct hsm_extent       hp_extent;
2711         __u16                   hp_flags;
2712         __u16                   hp_errval; /* positive val */
2713         __u32                   padding;
2714 };
2715
2716 struct hsm_copy {
2717         __u64                   hc_data_version;
2718         __u16                   hc_flags;
2719         __u16                   hc_errval; /* positive val */
2720         __u32                   padding;
2721         struct hsm_action_item  hc_hai;
2722 };
2723
2724 enum lu_ladvise_type {
2725         LU_LADVISE_INVALID      = 0,
2726         LU_LADVISE_WILLREAD     = 1,
2727         LU_LADVISE_DONTNEED     = 2,
2728         LU_LADVISE_LOCKNOEXPAND = 3,
2729         LU_LADVISE_LOCKAHEAD    = 4,
2730         /* Ahead operations for open|create|stat|read|write. */
2731         LU_LADVISE_AHEAD        = 5,
2732         LU_LADVISE_MAX
2733 };
2734
2735 #define LU_LADVISE_NAMES {                                              \
2736         [LU_LADVISE_WILLREAD]           = "willread",                   \
2737         [LU_LADVISE_DONTNEED]           = "dontneed",                   \
2738         [LU_LADVISE_LOCKNOEXPAND]       = "locknoexpand",               \
2739         [LU_LADVISE_LOCKAHEAD]          = "lockahead",                  \
2740         [LU_LADVISE_AHEAD]              = "ahead",                      \
2741 }
2742
2743 /* This is the userspace argument for ladvise.  It is currently the same as
2744  * what goes on the wire (struct lu_ladvise), but is defined separately as we
2745  * may need info which is only used locally.
2746  */
2747 struct llapi_lu_ladvise {
2748         __u16 lla_advice;       /* advice type */
2749         __u16 lla_value1;       /* values for different advice types */
2750         __u32 lla_value2;
2751         __u64 lla_start;        /* first byte of extent for advice */
2752         __u64 lla_end;          /* last byte of extent for advice */
2753         __u32 lla_value3;
2754         __u32 lla_value4;
2755 };
2756
2757 struct llapi_lu_ladvise2 {
2758         __u16   lla_advice;     /* advice type */
2759         __u16   lla_value1;     /* values for different advice types */
2760         __u32   lla_value2;
2761         __u64   lla_start;
2762         __u64   lla_end;
2763         __u32   lla_value3;
2764         __u32   lla_value4;
2765         union {
2766                 struct {
2767                         __u32   lla_value5;
2768                         __u32   lla_value6;
2769                 };
2770                 char lla_buf[NAME_MAX + 1];
2771         };
2772 };
2773
2774 /* I/O call sequences in a batch access. */
2775 enum lu_access_flags {
2776         ACCESS_FL_NONE  = 0x0,
2777         ACCESS_FL_STAT  = 0x01,
2778         ACCESS_FL_OPEN  = 0x02,
2779         ACCESS_FL_CREAT = 0x04,
2780         ACCESS_FL_READ  = 0x08,
2781         ACCESS_FL_WRITE = 0x10,
2782         ACCESS_FL_OC    = ACCESS_FL_OPEN | ACCESS_FL_CREAT,
2783         ACCESS_FL_SOR   = ACCESS_FL_STAT | ACCESS_FL_OPEN | ACCESS_FL_READ,
2784         ACCESS_FL_OCW   = ACCESS_FL_OPEN | ACCESS_FL_CREAT | ACCESS_FL_WRITE,
2785 };
2786
2787 enum lu_ahead_mode {
2788         LU_AH_MODE_NONE         = 0,
2789         /*
2790          * The batch access pattern obeys certain naming rules, such as mdtest
2791          * with the file naming format mdtest.$rank.$i.
2792          */
2793         LU_AH_NAME_INDEX        = 1,
2794         /*
2795          * Provide a file name list as input to do batch accesses with
2796          * irregular file name format.
2797          */
2798         LU_AH_NAME_ARRAY        = 2,
2799         /* Prefetching in readdir() order under a directory. */
2800         LU_AH_NAME_READDIR      = 3,
2801         LU_AH_MODE_MAX,
2802 };
2803
2804 #define lla_ahead_mode          lla_value1
2805 #define lla_access_flags        lla_value2
2806 #define lla_batch_max           lla_value3
2807 #define lla_fname               lla_buf
2808
2809 enum ladvise_flag {
2810         LF_ASYNC        = 0x00000001,
2811         LF_UNSET        = 0x00000002,
2812 };
2813
2814 #define LADVISE_MAGIC 0x1ADF1CE0
2815 /* Masks of valid flags for each advice */
2816 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2817 /* Flags valid for all advices not explicitly specified */
2818 #define LF_DEFAULT_MASK LF_ASYNC
2819 /* All flags */
2820 #define LF_MASK (LF_ASYNC | LF_UNSET)
2821
2822 #define lla_lockahead_mode   lla_value1
2823 #define lla_peradvice_flags    lla_value2
2824 #define lla_lockahead_result lla_value3
2825
2826 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2827  * is used on the wire.  It is defined separately as we may need info which is
2828  * only used locally.
2829  */
2830 struct llapi_ladvise_hdr {
2831         __u32                   lah_magic;      /* LADVISE_MAGIC */
2832         __u32                   lah_count;      /* number of advices */
2833         __u64                   lah_flags;      /* from enum ladvise_flag */
2834         __u32                   lah_value1;     /* unused */
2835         __u32                   lah_value2;     /* unused */
2836         __u64                   lah_value3;     /* unused */
2837         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
2838 };
2839
2840 #define LAH_COUNT_MAX   (1024)
2841
2842 /* Shared key */
2843 enum sk_crypt_alg {
2844         SK_CRYPT_EMPTY          = 0,
2845         SK_CRYPT_AES256_CTR     = 1,
2846         SK_CRYPT_INVALID        = __UINT16_MAX__
2847 };
2848
2849 enum sk_hmac_alg {
2850         SK_HMAC_EMPTY   = 0,
2851         SK_HMAC_SHA256  = 1,
2852         SK_HMAC_SHA512  = 2,
2853         SK_HMAC_INVALID = __UINT16_MAX__
2854 };
2855
2856 struct sk_crypt_type {
2857         const char     *sct_name;
2858         int             sct_type;
2859 };
2860
2861 struct sk_hmac_type {
2862         const char     *sht_name;
2863         int             sht_type;
2864 };
2865
2866 enum lock_mode_user {
2867         MODE_READ_USER = 1,
2868         MODE_WRITE_USER,
2869         MODE_MAX_USER,
2870 };
2871
2872 #define LOCK_MODE_NAMES { \
2873         [MODE_READ_USER]  = "READ",\
2874         [MODE_WRITE_USER] = "WRITE"\
2875 }
2876
2877 enum lockahead_results {
2878         LLA_RESULT_SENT = 0,
2879         LLA_RESULT_DIFFERENT,
2880         LLA_RESULT_SAME,
2881 };
2882
2883 enum lu_heat_flag_bit {
2884         LU_HEAT_FLAG_BIT_INVALID = 0,
2885         LU_HEAT_FLAG_BIT_OFF,
2886         LU_HEAT_FLAG_BIT_CLEAR,
2887 };
2888
2889 enum lu_heat_flag {
2890         LU_HEAT_FLAG_OFF        = 1ULL << LU_HEAT_FLAG_BIT_OFF,
2891         LU_HEAT_FLAG_CLEAR      = 1ULL << LU_HEAT_FLAG_BIT_CLEAR,
2892 };
2893
2894 enum obd_heat_type {
2895         OBD_HEAT_READSAMPLE     = 0,
2896         OBD_HEAT_WRITESAMPLE    = 1,
2897         OBD_HEAT_READBYTE       = 2,
2898         OBD_HEAT_WRITEBYTE      = 3,
2899         OBD_HEAT_COUNT
2900 };
2901
2902 #define LU_HEAT_NAMES {                                 \
2903         [OBD_HEAT_READSAMPLE]   = "readsample",         \
2904         [OBD_HEAT_WRITESAMPLE]  = "writesample",        \
2905         [OBD_HEAT_READBYTE]     = "readbyte",           \
2906         [OBD_HEAT_WRITEBYTE]    = "writebyte",          \
2907 }
2908
2909 struct lu_heat {
2910         __u32 lh_count;
2911         __u32 lh_flags;
2912         __u64 lh_heat[0];
2913 };
2914
2915 enum lu_pcc_type {
2916         LU_PCC_NONE             = 0x0,
2917         LU_PCC_READWRITE        = 0x01,
2918         LU_PCC_READONLY         = 0x02,
2919         LU_PCC_TYPE_MASK        = LU_PCC_READWRITE | LU_PCC_READONLY,
2920         LU_PCC_FL_ASYNC         = 0x10,
2921         LU_PCC_MAX
2922 };
2923
2924 static inline const char *pcc_type2string(enum lu_pcc_type type)
2925 {
2926         switch (type & LU_PCC_TYPE_MASK) {
2927         case LU_PCC_NONE:
2928                 return "none";
2929         case LU_PCC_READWRITE:
2930                 return "readwrite";
2931         case LU_PCC_READONLY:
2932                 return "readonly";
2933         default:
2934                 return "fault";
2935         }
2936 }
2937
2938 struct lu_pcc_attach {
2939         __u32 pcca_type; /* PCC type */
2940         __u32 pcca_id; /* Attach ID */
2941 };
2942
2943 enum lu_pcc_detach_opts {
2944         PCC_DETACH_OPT_NONE = 0, /* Detach only, keep the PCC copy */
2945         PCC_DETACH_OPT_UNCACHE, /* Remove the cached file after detach */
2946 };
2947
2948 struct lu_pcc_detach_fid {
2949         /* fid of the file to detach */
2950         struct lu_fid   pccd_fid;
2951         __u32           pccd_opt;
2952 };
2953
2954 struct lu_pcc_detach {
2955         __u32           pccd_opt;
2956 };
2957
2958 enum lu_pcc_state_flags {
2959         PCC_STATE_FL_NONE               = 0x0,
2960         /* The inode attr is cached locally */
2961         PCC_STATE_FL_ATTR_VALID         = 0x01,
2962         /* The file is being attached into PCC */
2963         PCC_STATE_FL_ATTACHING          = 0x02,
2964         /* The PCC copy is unlinked */
2965         PCC_STATE_FL_UNLINKED           = 0x04,
2966 };
2967
2968 struct lu_pcc_state {
2969         __u32   pccs_type; /* enum lu_pcc_type */
2970         __u32   pccs_open_count;
2971         __u32   pccs_flags; /* enum lu_pcc_state_flags */
2972         __u32   pccs_padding;
2973         char    pccs_path[PATH_MAX];
2974 };
2975
2976 enum lu_project_type {
2977         LU_PROJECT_NONE = 0,
2978         LU_PROJECT_SET,
2979         LU_PROJECT_GET,
2980         LU_PROJECT_MAX
2981 };
2982
2983 struct lu_project {
2984         __u32   project_type; /* enum lu_project_type */
2985         __u32   project_id;
2986         __u32   project_xflags;
2987         __u32   project_reserved;
2988         char    project_name[NAME_MAX + 1];
2989 };
2990
2991 struct fid_array {
2992         __u32 fa_nr;
2993         /* make header's size equal lu_fid */
2994         __u32 fa_padding0;
2995         __u64 fa_padding1;
2996         struct lu_fid fa_fids[0];
2997 };
2998 #define OBD_MAX_FIDS_IN_ARRAY   4096
2999
3000 /* more types could be defined upon need for more complex
3001  * format to be used in foreign symlink LOV/LMV EAs, like
3002  * one to describe a delimiter string and occurence number
3003  * of delimited sub-string, ...
3004  */
3005 enum ll_foreign_symlink_upcall_item_type {
3006         EOB_TYPE = 1,
3007         STRING_TYPE = 2,
3008         POSLEN_TYPE = 3,
3009 };
3010
3011 /* may need to be modified to allow for more format items to be defined, and
3012  * like for ll_foreign_symlink_upcall_item_type enum
3013  */
3014 struct ll_foreign_symlink_upcall_item {
3015         __u32 type;
3016         union {
3017                 struct {
3018                         __u32 pos;
3019                         __u32 len;
3020                 };
3021                 struct {
3022                         size_t size;
3023                         union {
3024                                 /* internal storage of constant string */
3025                                 char *string;
3026                                 /* upcall stores constant string in a raw */
3027                                 char bytestring[0];
3028                         };
3029                 };
3030         };
3031 };
3032
3033 #define POSLEN_ITEM_SZ (offsetof(struct ll_foreign_symlink_upcall_item, len) + \
3034                 sizeof(((struct ll_foreign_symlink_upcall_item *)0)->len))
3035 #define STRING_ITEM_SZ(sz) ( \
3036         offsetof(struct ll_foreign_symlink_upcall_item, bytestring) + \
3037         (sz + sizeof(__u32) - 1) / sizeof(__u32) * sizeof(__u32))
3038
3039 /* presently limited to not cause max stack frame size to be reached
3040  * because of temporary automatic array of
3041  * "struct ll_foreign_symlink_upcall_item" presently used in
3042  * foreign_symlink_upcall_info_store()
3043  */
3044 #define MAX_NB_UPCALL_ITEMS 32
3045
3046 #if defined(__cplusplus)
3047 }
3048 #endif
3049
3050 /** @} lustreuser */
3051
3052 #endif /* _LUSTRE_USER_H */