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