lustre/include/uapi/linux/lustre/lustre_user.h

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