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
  54 #ifndef __KERNEL__
  55 # define __USE_ISOC99   1
  56 # include <stdbool.h>
  57 # include <stdio.h> /* snprintf() */
  58 # include <sys/stat.h>
  59 # define FILEID_LUSTRE 0x97 /* for name_to_handle_at() (and llapi_fd2fid()) */
  60 #endif /* !__KERNEL__ */
  61
  62 #if defined(__cplusplus)
  63 extern "C" {
  64 #endif
  65
  66 #ifdef __STRICT_ANSI__
  67 #define typeof  __typeof__
  68 #endif
  69
  70 /*
  71  * This is a temporary solution of adding quota type.
  72  * Should be removed as soon as system header is updated.
  73  */
  74 #undef LL_MAXQUOTAS
  75 #define LL_MAXQUOTAS 3
  76 #undef INITQFNAMES
  77 #define INITQFNAMES { \
  78     "user",     /* USRQUOTA */ \
  79     "group",    /* GRPQUOTA */ \
  80     "project",  /* PRJQUOTA */ \
  81     "undefined", \
  82 };
  83 #ifndef USRQUOTA
  84 #define USRQUOTA 0
  85 #endif
  86 #ifndef GRPQUOTA
  87 #define GRPQUOTA 1
  88 #endif
  89 #ifndef PRJQUOTA
  90 #define PRJQUOTA 2
  91 #endif
  92
  93 /*
  94  * We need to always use 64bit version because the structure
  95  * is shared across entire cluster where 32bit and 64bit machines
  96  * are co-existing.
  97  */
  98 #if __BITS_PER_LONG != 64 || defined(__ARCH_WANT_STAT64)
  99 typedef struct stat64   lstat_t;
 100 #define lstat_f  lstat64
 101 #define fstat_f         fstat64
 102 #define fstatat_f       fstatat64
 103 #else
 104 typedef struct stat     lstat_t;
 105 #define lstat_f  lstat
 106 #define fstat_f         fstat
 107 #define fstatat_f       fstatat
 108 #endif
 109
 110 #ifndef STATX_BASIC_STATS
 111 /*
 112  * Timestamp structure for the timestamps in struct statx.
 113  *
 114  * tv_sec holds the number of seconds before (negative) or after (positive)
 115  * 00:00:00 1st January 1970 UTC.
 116  *
 117  * tv_nsec holds a number of nanoseconds (0..999,999,999) after the tv_sec time.
 118  *
 119  * __reserved is held in case we need a yet finer resolution.
 120  */
 121 struct statx_timestamp {
 122         __s64   tv_sec;
 123         __u32   tv_nsec;
 124         __s32   __reserved;
 125 };
 126
 127 /*
 128  * Structures for the extended file attribute retrieval system call
 129  * (statx()).
 130  *
 131  * The caller passes a mask of what they're specifically interested in as a
 132  * parameter to statx().  What statx() actually got will be indicated in
 133  * st_mask upon return.
 134  *
 135  * For each bit in the mask argument:
 136  *
 137  * - if the datum is not supported:
 138  *
 139  *   - the bit will be cleared, and
 140  *
 141  *   - the datum will be set to an appropriate fabricated value if one is
 142  *     available (eg. CIFS can take a default uid and gid), otherwise
 143  *
 144  *   - the field will be cleared;
 145  *
 146  * - otherwise, if explicitly requested:
 147  *
 148  *   - the datum will be synchronised to the server if AT_STATX_FORCE_SYNC is
 149  *     set or if the datum is considered out of date, and
 150  *
 151  *   - the field will be filled in and the bit will be set;
 152  *
 153  * - otherwise, if not requested, but available in approximate form without any
 154  *   effort, it will be filled in anyway, and the bit will be set upon return
 155  *   (it might not be up to date, however, and no attempt will be made to
 156  *   synchronise the internal state first);
 157  *
 158  * - otherwise the field and the bit will be cleared before returning.
 159  *
 160  * Items in STATX_BASIC_STATS may be marked unavailable on return, but they
 161  * will have values installed for compatibility purposes so that stat() and
 162  * co. can be emulated in userspace.
 163  */
 164 struct statx {
 165         /* 0x00 */
 166         __u32   stx_mask;       /* What results were written [uncond] */
 167         __u32   stx_blksize;    /* Preferred general I/O size [uncond] */
 168         __u64   stx_attributes; /* Flags conveying information about the file [uncond] */
 169         /* 0x10 */
 170         __u32   stx_nlink;      /* Number of hard links */
 171         __u32   stx_uid;        /* User ID of owner */
 172         __u32   stx_gid;        /* Group ID of owner */
 173         __u16   stx_mode;       /* File mode */
 174         __u16   __spare0[1];
 175         /* 0x20 */
 176         __u64   stx_ino;        /* Inode number */
 177         __u64   stx_size;       /* File size */
 178         __u64   stx_blocks;     /* Number of 512-byte blocks allocated */
 179         __u64   stx_attributes_mask; /* Mask to show what's supported in stx_attributes */
 180         /* 0x40 */
 181         struct statx_timestamp  stx_atime;      /* Last access time */
 182         struct statx_timestamp  stx_btime;      /* File creation time */
 183         struct statx_timestamp  stx_ctime;      /* Last attribute change time */
 184         struct statx_timestamp  stx_mtime;      /* Last data modification time */
 185         /* 0x80 */
 186         __u32   stx_rdev_major; /* Device ID of special file [if bdev/cdev] */
 187         __u32   stx_rdev_minor;
 188         __u32   stx_dev_major;  /* ID of device containing file [uncond] */
 189         __u32   stx_dev_minor;
 190         /* 0x90 */
 191         __u64   __spare2[14];   /* Spare space for future expansion */
 192         /* 0x100 */
 193 };
 194
 195 /*
 196  * Flags to be stx_mask
 197  *
 198  * Query request/result mask for statx() and struct statx::stx_mask.
 199  *
 200  * These bits should be set in the mask argument of statx() to request
 201  * particular items when calling statx().
 202  */
 203 #define STATX_TYPE              0x00000001U     /* Want/got stx_mode & S_IFMT */
 204 #define STATX_MODE              0x00000002U     /* Want/got stx_mode & ~S_IFMT */
 205 #define STATX_NLINK             0x00000004U     /* Want/got stx_nlink */
 206 #define STATX_UID               0x00000008U     /* Want/got stx_uid */
 207 #define STATX_GID               0x00000010U     /* Want/got stx_gid */
 208 #define STATX_ATIME             0x00000020U     /* Want/got stx_atime */
 209 #define STATX_MTIME             0x00000040U     /* Want/got stx_mtime */
 210 #define STATX_CTIME             0x00000080U     /* Want/got stx_ctime */
 211 #define STATX_INO               0x00000100U     /* Want/got stx_ino */
 212 #define STATX_SIZE              0x00000200U     /* Want/got stx_size */
 213 #define STATX_BLOCKS            0x00000400U     /* Want/got stx_blocks */
 214 #define STATX_BASIC_STATS       0x000007ffU     /* The stuff in the normal stat struct */
 215 #define STATX_BTIME             0x00000800U     /* Want/got stx_btime */
 216 #define STATX_ALL               0x00000fffU     /* All currently supported flags */
 217 #define STATX__RESERVED         0x80000000U     /* Reserved for future struct statx expansion */
 218
 219 /*
 220  * Attributes to be found in stx_attributes and masked in stx_attributes_mask.
 221  *
 222  * These give information about the features or the state of a file that might
 223  * be of use to ordinary userspace programs such as GUIs or ls rather than
 224  * specialised tools.
 225  *
 226  * Note that the flags marked [I] correspond to generic FS_IOC_FLAGS
 227  * semantically.  Where possible, the numerical value is picked to correspond
 228  * also.
 229  */
 230 #define STATX_ATTR_COMPRESSED           0x00000004 /* [I] File is compressed by the fs */
 231 #define STATX_ATTR_IMMUTABLE            0x00000010 /* [I] File is marked immutable */
 232 #define STATX_ATTR_APPEND               0x00000020 /* [I] File is append-only */
 233 #define STATX_ATTR_NODUMP               0x00000040 /* [I] File is not to be dumped */
 234 #define STATX_ATTR_ENCRYPTED            0x00000800 /* [I] File requires key to decrypt in fs */
 235
 236 #define STATX_ATTR_AUTOMOUNT            0x00001000 /* Dir: Automount trigger */
 237
 238 #define AT_STATX_SYNC_TYPE      0x6000  /* Type of synchronisation required from statx() */
 239 #define AT_STATX_SYNC_AS_STAT   0x0000  /* - Do whatever stat() does */
 240 #define AT_STATX_FORCE_SYNC     0x2000  /* - Force the attributes to be sync'd with the server */
 241 #define AT_STATX_DONT_SYNC      0x4000  /* - Don't sync attributes with the server */
 242
 243 #endif /* STATX_BASIC_STATS */
 244
 245 typedef struct statx lstatx_t;
 246
 247 #define HAVE_LOV_USER_MDS_DATA
 248
 249 #define LUSTRE_EOF 0xffffffffffffffffULL
 250
 251 /* for statfs() */
 252 #define LL_SUPER_MAGIC 0x0BD00BD0
 253
 254 #define FSFILT_IOC_GETVERSION           _IOR('f', 3, long)
 255
 256 /* FIEMAP flags supported by Lustre */
 257 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
 258
 259 enum obd_statfs_state {
 260         OS_STATFS_DEGRADED      = 0x00000001, /**< RAID degraded/rebuilding */
 261         OS_STATFS_READONLY      = 0x00000002, /**< filesystem is read-only */
 262         OS_STATFS_NOPRECREATE   = 0x00000004, /**< no object precreation */
 263         OS_STATFS_UNUSED1       = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
 264         OS_STATFS_UNUSED2       = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
 265         OS_STATFS_ENOSPC        = 0x00000020, /**< not enough free space */
 266         OS_STATFS_ENOINO        = 0x00000040, /**< not enough inodes */
 267         OS_STATFS_SUM           = 0x00000100, /**< aggregated for all tagrets */
 268         OS_STATFS_NONROT        = 0x00000200, /**< non-rotational device */
 269 };
 270
 271 /** filesystem statistics/attributes for target device */
 272 struct obd_statfs {
 273         __u64           os_type;        /* EXT4_SUPER_MAGIC, UBERBLOCK_MAGIC */
 274         __u64           os_blocks;      /* total size in #os_bsize blocks */
 275         __u64           os_bfree;       /* number of unused blocks */
 276         __u64           os_bavail;      /* blocks available for allocation */
 277         __u64           os_files;       /* total number of objects */
 278         __u64           os_ffree;       /* # objects that could be created */
 279         __u8            os_fsid[40];    /* identifier for filesystem */
 280         __u32           os_bsize;       /* block size in bytes for os_blocks */
 281         __u32           os_namelen;     /* maximum length of filename in bytes*/
 282         __u64           os_maxbytes;    /* maximum object size in bytes */
 283         __u32           os_state;       /**< obd_statfs_state OS_STATFS_* */
 284         __u32           os_fprecreated; /* objs available now to the caller */
 285                                         /* used in QoS code to find preferred
 286                                          * OSTs */
 287         __u32           os_granted;     /* space granted for MDS */
 288         __u32           os_spare3;      /* Unused padding fields.  Remember */
 289         __u32           os_spare4;      /* to fix lustre_swab_obd_statfs() */
 290         __u32           os_spare5;
 291         __u32           os_spare6;
 292         __u32           os_spare7;
 293         __u32           os_spare8;
 294         __u32           os_spare9;
 295 };
 296
 297 /** additional filesystem attributes for target device */
 298 struct obd_statfs_info {
 299         __u32           os_reserved_mb_low;     /* reserved mb low */
 300         __u32           os_reserved_mb_high;    /* reserved mb high */
 301         bool            os_enable_pre;          /* enable pre create logic */
 302 };
 303
 304 /**
 305  * File IDentifier.
 306  *
 307  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 308  * FIDs are never reused.
 309  **/
 310 struct lu_fid {
 311        /**
 312         * FID sequence. Sequence is a unit of migration: all files (objects)
 313         * with FIDs from a given sequence are stored on the same server.
 314         * Lustre should support 2^64 objects, so even if each sequence
 315         * has only a single object we can still enumerate 2^64 objects.
 316         **/
 317         __u64 f_seq;
 318         /* FID number within sequence. */
 319         __u32 f_oid;
 320         /**
 321          * FID version, used to distinguish different versions (in the sense
 322          * of snapshots, etc.) of the same file system object. Not currently
 323          * used.
 324          **/
 325         __u32 f_ver;
 326 } __attribute__((packed));
 327
 328 static inline bool fid_is_zero(const struct lu_fid *fid)
 329 {
 330         return fid->f_seq == 0 && fid->f_oid == 0;
 331 }
 332
 333 /* The data name_to_handle_at() places in a struct file_handle (at f_handle) */
 334 struct lustre_file_handle {
 335         struct lu_fid lfh_child;
 336         struct lu_fid lfh_parent;
 337 };
 338
 339 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
 340  * MDT-object's FID::f_ver, instead it is the OST-object index in its
 341  * parent MDT-object's layout EA. */
 342 #define f_stripe_idx f_ver
 343
 344 struct ost_layout {
 345         __u32   ol_stripe_size;
 346         __u32   ol_stripe_count;
 347         __u64   ol_comp_start;
 348         __u64   ol_comp_end;
 349         __u32   ol_comp_id;
 350 } __attribute__((packed));
 351
 352 /* The filter_fid structure has changed several times over its lifetime.
 353  * For a long time "trusted.fid" held the MDT inode parent FID/IGIF and
 354  * stripe_index and the "self FID" (objid/seq) to be able to recover the
 355  * OST objects in case of corruption.  With the move to 2.4 and OSD-API for
 356  * the OST, the "trusted.lma" xattr was added to the OST objects to store
 357  * the "self FID" to be consistent with the MDT on-disk format, and the
 358  * filter_fid only stored the MDT inode parent FID and stripe index.
 359  *
 360  * In 2.10, the addition of PFL composite layouts required more information
 361  * to be stored into the filter_fid in order to be able to identify which
 362  * component the OST object belonged.  As well, the stripe size may vary
 363  * between components, so it was no longer safe to assume the stripe size
 364  * or stripe_count of a file.  This is also more robust for plain layouts.
 365  *
 366  * For ldiskfs OSTs that were formatted with 256-byte inodes, there is not
 367  * enough space to store both the filter_fid and LMA in the inode, so they
 368  * are packed into struct lustre_ost_attrs on disk in trusted.lma to avoid
 369  * an extra seek for every OST object access.
 370  *
 371  * In 2.11, FLR mirror layouts also need to store the layout version and
 372  * range so that writes to old versions of the layout are not allowed.
 373  * That ensures that mirrored objects are not modified by evicted clients,
 374  * and ensures that the components are correctly marked stale on the MDT.
 375  */
 376 struct filter_fid_18_23 {
 377         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 378         __u64                   ff_objid;
 379         __u64                   ff_seq;
 380 };
 381
 382 struct filter_fid_24_29 {
 383         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 384 };
 385
 386 struct filter_fid_210 {
 387         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 388         struct ost_layout       ff_layout;
 389 };
 390
 391 struct filter_fid {
 392         struct lu_fid           ff_parent;      /* stripe_idx in f_ver */
 393         struct ost_layout       ff_layout;
 394         __u32                   ff_layout_version;
 395         __u32                   ff_range; /* range of layout version that
 396                                            * write are allowed */
 397 } __attribute__((packed));
 398
 399 /* Userspace should treat lu_fid as opaque, and only use the following methods
 400  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
 401  * here from lustre_idl.h if needed. */
 402 struct lu_fid;
 403
 404 enum lma_compat {
 405         LMAC_HSM         = 0x00000001,
 406 /*      LMAC_SOM         = 0x00000002, obsolete since 2.8.0 */
 407         LMAC_NOT_IN_OI   = 0x00000004, /* the object does NOT need OI mapping */
 408         LMAC_FID_ON_OST  = 0x00000008, /* For OST-object, its OI mapping is
 409                                        * under /O/<seq>/d<x>. */
 410         LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
 411         LMAC_COMP_INFO   = 0x00000020, /* Component info in the LMA EA. */
 412         LMAC_IDX_BACKUP  = 0x00000040, /* Has index backup. */
 413 };
 414
 415 /**
 416  * Masks for all features that should be supported by a Lustre version to
 417  * access a specific file.
 418  * This information is stored in lustre_mdt_attrs::lma_incompat.
 419  */
 420 enum lma_incompat {
 421         LMAI_RELEASED           = 0x00000001, /* file is released */
 422         LMAI_AGENT              = 0x00000002, /* agent inode */
 423         LMAI_REMOTE_PARENT      = 0x00000004, /* the parent of the object
 424                                                  is on the remote MDT */
 425         LMAI_STRIPED            = 0x00000008, /* striped directory inode */
 426         LMAI_ORPHAN             = 0x00000010, /* inode is orphan */
 427         LMAI_ENCRYPT            = 0x00000020, /* inode is encrypted */
 428         LMA_INCOMPAT_SUPP       = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
 429                                    LMAI_STRIPED | LMAI_ORPHAN | LMAI_ENCRYPT)
 430 };
 431
 432
 433 /**
 434  * Following struct for object attributes, that will be kept inode's EA.
 435  * Introduced in 2.0 release (please see b15993, for details)
 436  * Added to all objects since Lustre 2.4 as contains self FID
 437  */
 438 struct lustre_mdt_attrs {
 439         /**
 440          * Bitfield for supported data in this structure. From enum lma_compat.
 441          * lma_self_fid and lma_flags are always available.
 442          */
 443         __u32   lma_compat;
 444         /**
 445          * Per-file incompat feature list. Lustre version should support all
 446          * flags set in this field. The supported feature mask is available in
 447          * LMA_INCOMPAT_SUPP.
 448          */
 449         __u32   lma_incompat;
 450         /** FID of this inode */
 451         struct lu_fid  lma_self_fid;
 452 };
 453
 454 struct lustre_ost_attrs {
 455         /* Use lustre_mdt_attrs directly for now, need a common header
 456          * structure if want to change lustre_mdt_attrs in future. */
 457         struct lustre_mdt_attrs loa_lma;
 458
 459         /* Below five elements are for OST-object's PFID EA, the
 460          * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
 461          * and the stripe_index (low 16 bits), the size should not exceed
 462          * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
 463          * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
 464          * are valid; if the flag LMAC_COMP_INFO is set, then the next three
 465          * loa_comp_* elements are valid. */
 466         struct lu_fid   loa_parent_fid;
 467         __u32           loa_stripe_size;
 468         __u32           loa_comp_id;
 469         __u64           loa_comp_start;
 470         __u64           loa_comp_end;
 471 };
 472
 473 /**
 474  * Prior to 2.4, the LMA structure also included SOM attributes which has since
 475  * been moved to a dedicated xattr
 476  * lma_flags was also removed because of lma_compat/incompat fields.
 477  */
 478 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
 479
 480 enum lustre_som_flags {
 481         /* Unknow or no SoM data, must get size from OSTs. */
 482         SOM_FL_UNKNOWN  = 0x0000,
 483         /* Known strictly correct, FLR or DoM file (SoM guaranteed). */
 484         SOM_FL_STRICT   = 0x0001,
 485         /* Known stale - was right at some point in the past, but it is
 486          * known (or likely) to be incorrect now (e.g. opened for write). */
 487         SOM_FL_STALE    = 0x0002,
 488         /* Approximate, may never have been strictly correct,
 489          * need to sync SOM data to achieve eventual consistency. */
 490         SOM_FL_LAZY     = 0x0004,
 491 };
 492
 493 struct lustre_som_attrs {
 494         __u16   lsa_valid;
 495         __u16   lsa_reserved[3];
 496         __u64   lsa_size;
 497         __u64   lsa_blocks;
 498 };
 499
 500 /**
 501  * OST object IDentifier.
 502  */
 503 struct ost_id {
 504         union {
 505                 struct {
 506                         __u64   oi_id;
 507                         __u64   oi_seq;
 508                 } oi;
 509                 struct lu_fid oi_fid;
 510         };
 511 } __attribute__((packed));
 512
 513 #define DOSTID "%#llx:%llu"
 514 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
 515                    ((unsigned long long)ostid_id(oi))
 516
 517 struct ll_futimes_3 {
 518         __u64 lfu_atime_sec;
 519         __u64 lfu_atime_nsec;
 520         __u64 lfu_mtime_sec;
 521         __u64 lfu_mtime_nsec;
 522         __u64 lfu_ctime_sec;
 523         __u64 lfu_ctime_nsec;
 524 };
 525
 526 /*
 527  * Maximum number of mirrors currently implemented.
 528  */
 529 #define LUSTRE_MIRROR_COUNT_MAX         16
 530
 531 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
 532 enum ll_lease_mode {
 533         LL_LEASE_RDLCK  = 0x01,
 534         LL_LEASE_WRLCK  = 0x02,
 535         LL_LEASE_UNLCK  = 0x04,
 536 };
 537
 538 enum ll_lease_flags {
 539         LL_LEASE_RESYNC         = 0x1,
 540         LL_LEASE_RESYNC_DONE    = 0x2,
 541         LL_LEASE_LAYOUT_MERGE   = 0x4,
 542         LL_LEASE_LAYOUT_SPLIT   = 0x8,
 543         LL_LEASE_PCC_ATTACH     = 0x10,
 544 };
 545
 546 #define IOC_IDS_MAX     4096
 547 struct ll_ioc_lease {
 548         __u32           lil_mode;
 549         __u32           lil_flags;
 550         __u32           lil_count;
 551         __u32           lil_ids[0];
 552 };
 553
 554 struct ll_ioc_lease_id {
 555         __u32           lil_mode;
 556         __u32           lil_flags;
 557         __u32           lil_count;
 558         __u16           lil_mirror_id;
 559         __u16           lil_padding1;
 560         __u64           lil_padding2;
 561         __u32           lil_ids[0];
 562 };
 563
 564 /*
 565  * The ioctl naming rules:
 566  * LL_*     - works on the currently opened filehandle instead of parent dir
 567  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 568  * *_MDC_*  - gets/sets data related to MDC
 569  * *_LOV_*  - gets/sets data related to OSC/LOV
 570  * *FILE*   - called on parent dir and passes in a filename
 571  * *STRIPE* - set/get lov_user_md
 572  * *INFO    - set/get lov_user_mds_data
 573  */
 574 /*      lustre_ioctl.h                  101-150 */
 575 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 576 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 577 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 578 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 579 #define LL_IOC_LOV_SETSTRIPE_NEW        _IOWR('f', 154, struct lov_user_md)
 580 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 581 #define LL_IOC_LOV_GETSTRIPE_NEW        _IOR('f', 155, struct lov_user_md)
 582 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 583 /*      LL_IOC_RECREATE_OBJ             157 obsolete */
 584 /*      LL_IOC_RECREATE_FID             157 obsolete */
 585 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 586 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 587 /*      LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
 588 /*      LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
 589 /*      LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
 590 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 591 /*      IOC_LOV_GETINFO                 165 obsolete */
 592 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 593 /*      LL_IOC_RMTACL                   167 obsolete */
 594 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 595 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 596 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 597 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
 598 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 599 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 600 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 601 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 602 #define LL_IOC_FUTIMES_3                _IOWR('f', 176, struct ll_futimes_3)
 603 #define LL_IOC_FLR_SET_MIRROR           _IOW ('f', 177, long)
 604 /*      lustre_ioctl.h                  177-210 */
 605 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
 606 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
 607 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
 608 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
 609 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
 610 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
 611 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
 612 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
 613 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
 614                                                 struct lustre_swap_layouts)
 615 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
 616                                                 struct hsm_current_action)
 617 /*      lustre_ioctl.h                  221-232 */
 618 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
 619 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
 620 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
 621 #define LL_IOC_RMFID                    _IOR('f', 242, struct fid_array)
 622 #define LL_IOC_SET_LEASE                _IOWR('f', 243, struct ll_ioc_lease)
 623 #define LL_IOC_SET_LEASE_OLD            _IOWR('f', 243, long)
 624 #define LL_IOC_GET_LEASE                _IO('f', 244)
 625 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
 626 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
 627 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
 628 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
 629 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
 630 #define LL_IOC_LADVISE                  _IOR('f', 250, struct llapi_lu_ladvise)
 631 #define LL_IOC_HEAT_GET                 _IOWR('f', 251, struct lu_heat)
 632 #define LL_IOC_HEAT_SET                 _IOW('f', 251, __u64)
 633 #define LL_IOC_PCC_DETACH               _IOW('f', 252, struct lu_pcc_detach)
 634 #define LL_IOC_PCC_DETACH_BY_FID        _IOW('f', 252, struct lu_pcc_detach_fid)
 635 #define LL_IOC_PCC_STATE                _IOR('f', 252, struct lu_pcc_state)
 636
 637 #ifndef FS_IOC_FSGETXATTR
 638 /*
 639  * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
 640 */
 641 struct fsxattr {
 642         __u32           fsx_xflags;     /* xflags field value (get/set) */
 643         __u32           fsx_extsize;    /* extsize field value (get/set)*/
 644         __u32           fsx_nextents;   /* nextents field value (get)   */
 645         __u32           fsx_projid;     /* project identifier (get/set) */
 646         unsigned char   fsx_pad[12];
 647 };
 648 #define FS_IOC_FSGETXATTR               _IOR('X', 31, struct fsxattr)
 649 #define FS_IOC_FSSETXATTR               _IOW('X', 32, struct fsxattr)
 650 #endif
 651 #ifndef FS_XFLAG_PROJINHERIT
 652 #define FS_XFLAG_PROJINHERIT            0x00000200
 653 #endif
 654
 655
 656 #define LL_STATFS_LMV           1
 657 #define LL_STATFS_LOV           2
 658 #define LL_STATFS_NODELAY       4
 659
 660 #define IOC_MDC_TYPE            'i'
 661 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 662 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 663 #ifdef HAVE_LOV_USER_MDS_DATA
 664 #define IOC_MDC_GETFILEINFO_OLD _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data_v1 *)
 665 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data)
 666 #define LL_IOC_MDC_GETINFO_OLD  _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data_v1 *)
 667 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data)
 668 #endif
 669
 670 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 671
 672 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
 673  * files, but are unlikely to be used in practice and are not harmful if
 674  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
 675  * devices and are safe for use on new files. See LU-4209. */
 676 /* To be compatible with old statically linked binary we keep the check for
 677  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
 678 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
 679 #ifndef FASYNC
 680 #define FASYNC                  00020000   /* fcntl, for BSD compatibility */
 681 #endif
 682 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
 683 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
 684                                          O_LOV_DELAY_CREATE_MASK)
 685
 686 #define LL_FILE_IGNORE_LOCK     0x00000001
 687 #define LL_FILE_GROUP_LOCKED    0x00000002
 688 #define LL_FILE_READAHEA        0x00000004
 689 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 690 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 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 #define SEPOL_DOWNCALL_MAGIC 0x8b8bb842
1292
1293 /* permission */
1294 #define N_PERMS_MAX      64
1295
1296 struct perm_downcall_data {
1297         __u64 pdd_nid;
1298         __u32 pdd_perm;
1299         __u32 pdd_padding;
1300 };
1301
1302 struct identity_downcall_data {
1303         __u32                            idd_magic;
1304         __u32                            idd_err;
1305         __u32                            idd_uid;
1306         __u32                            idd_gid;
1307         __u32                            idd_nperms;
1308         __u32                            idd_ngroups;
1309         struct perm_downcall_data idd_perms[N_PERMS_MAX];
1310         __u32                            idd_groups[0];
1311 };
1312
1313 struct sepol_downcall_data {
1314         __u32           sdd_magic;
1315         __s64           sdd_sepol_mtime;
1316         __u16           sdd_sepol_len;
1317         char            sdd_sepol[0];
1318 };
1319
1320 #ifdef NEED_QUOTA_DEFS
1321 #ifndef QIF_BLIMITS
1322 #define QIF_BLIMITS     1
1323 #define QIF_SPACE       2
1324 #define QIF_ILIMITS     4
1325 #define QIF_INODES      8
1326 #define QIF_BTIME       16
1327 #define QIF_ITIME       32
1328 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
1329 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
1330 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
1331 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
1332 #endif
1333
1334 #endif /* !__KERNEL__ */
1335
1336 /* lustre volatile file support
1337  * file name header: ".^L^S^T^R:volatile"
1338  */
1339 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
1340 #define LUSTRE_VOLATILE_HDR_LEN 14
1341
1342 enum lustre_quota_version {
1343         LUSTRE_QUOTA_V2 = 1
1344 };
1345
1346 /* XXX: same as if_dqinfo struct in kernel */
1347 struct obd_dqinfo {
1348         __u64 dqi_bgrace;
1349         __u64 dqi_igrace;
1350         __u32 dqi_flags;
1351         __u32 dqi_valid;
1352 };
1353
1354 /* XXX: same as if_dqblk struct in kernel, plus one padding */
1355 struct obd_dqblk {
1356         __u64 dqb_bhardlimit;
1357         __u64 dqb_bsoftlimit;
1358         __u64 dqb_curspace;
1359         __u64 dqb_ihardlimit;
1360         __u64 dqb_isoftlimit;
1361         __u64 dqb_curinodes;
1362         __u64 dqb_btime;
1363         __u64 dqb_itime;
1364         __u32 dqb_valid;
1365         __u32 dqb_padding;
1366 };
1367
1368 enum {
1369         QC_GENERAL      = 0,
1370         QC_MDTIDX       = 1,
1371         QC_OSTIDX       = 2,
1372         QC_UUID         = 3
1373 };
1374
1375 struct if_quotactl {
1376         __u32                   qc_cmd;
1377         __u32                   qc_type;
1378         __u32                   qc_id;
1379         __u32                   qc_stat;
1380         __u32                   qc_valid;
1381         __u32                   qc_idx;
1382         struct obd_dqinfo       qc_dqinfo;
1383         struct obd_dqblk        qc_dqblk;
1384         char                    obd_type[16];
1385         struct obd_uuid         obd_uuid;
1386         char                    qc_poolname[0];
1387 };
1388
1389 /* swap layout flags */
1390 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
1391 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
1392 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
1393 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
1394 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
1395
1396 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
1397 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
1398 struct lustre_swap_layouts {
1399         __u64   sl_flags;
1400         __u32   sl_fd;
1401         __u32   sl_gid;
1402         __u64   sl_dv1;
1403         __u64   sl_dv2;
1404 };
1405
1406 /** Bit-mask of valid attributes */
1407 /* The LA_* flags are written to disk as part of the ChangeLog records
1408  * so they are part of the on-disk and network protocol, and cannot be changed.
1409  * Only the first 12 bits are currently saved.
1410  */
1411 enum la_valid {
1412         LA_ATIME        = 1 << 0,       /* 0x00001 */
1413         LA_MTIME        = 1 << 1,       /* 0x00002 */
1414         LA_CTIME        = 1 << 2,       /* 0x00004 */
1415         LA_SIZE         = 1 << 3,       /* 0x00008 */
1416         LA_MODE         = 1 << 4,       /* 0x00010 */
1417         LA_UID          = 1 << 5,       /* 0x00020 */
1418         LA_GID          = 1 << 6,       /* 0x00040 */
1419         LA_BLOCKS       = 1 << 7,       /* 0x00080 */
1420         LA_TYPE         = 1 << 8,       /* 0x00100 */
1421         LA_FLAGS        = 1 << 9,       /* 0x00200 */
1422         LA_NLINK        = 1 << 10,      /* 0x00400 */
1423         LA_RDEV         = 1 << 11,      /* 0x00800 */
1424         LA_BLKSIZE      = 1 << 12,      /* 0x01000 */
1425         LA_KILL_SUID    = 1 << 13,      /* 0x02000 */
1426         LA_KILL_SGID    = 1 << 14,      /* 0x04000 */
1427         LA_PROJID       = 1 << 15,      /* 0x08000 */
1428         LA_LAYOUT_VERSION = 1 << 16,    /* 0x10000 */
1429         LA_LSIZE        = 1 << 17,      /* 0x20000 */
1430         LA_LBLOCKS      = 1 << 18,      /* 0x40000 */
1431         LA_BTIME        = 1 << 19,      /* 0x80000 */
1432         /**
1433          * Attributes must be transmitted to OST objects
1434          */
1435         LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1436 };
1437
1438 #define MDS_FMODE_READ           00000001
1439 #define MDS_FMODE_WRITE          00000002
1440
1441 #define MDS_FMODE_CLOSED         00000000
1442 #define MDS_FMODE_EXEC           00000004
1443 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
1444 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
1445 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
1446
1447 #define MDS_OPEN_CREATED         00000010
1448 /*      MDS_OPEN_CROSS           00000020 obsolete in 2.12, internal use only */
1449
1450 #define MDS_OPEN_CREAT           00000100
1451 #define MDS_OPEN_EXCL            00000200
1452 #define MDS_OPEN_TRUNC           00001000
1453 #define MDS_OPEN_APPEND          00002000
1454 #define MDS_OPEN_SYNC            00010000
1455 #define MDS_OPEN_DIRECTORY       00200000
1456
1457 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
1458 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1459 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1460 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1461                                            * We do not support JOIN FILE
1462                                            * anymore, reserve this flags
1463                                            * just for preventing such bit
1464                                            * to be reused. */
1465
1466 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1467 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1468 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1469 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
1470 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
1471                                               * hsm restore) */
1472 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
1473                                                 unlinked */
1474 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
1475                                               * delegation, succeed if it's not
1476                                               * being opened with conflict mode.
1477                                               */
1478 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
1479
1480 #define MDS_OPEN_RESYNC    04000000000000ULL /* FLR: file resync */
1481 #define MDS_OPEN_PCC      010000000000000ULL /* PCC: auto RW-PCC cache attach
1482                                               * for newly created file */
1483
1484 /* lustre internal open flags, which should not be set from user space */
1485 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
1486                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
1487                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
1488                               MDS_OPEN_RELEASE | MDS_OPEN_RESYNC |      \
1489                               MDS_OPEN_PCC)
1490
1491
1492 /********* Changelogs **********/
1493 /** Changelog record types */
1494 enum changelog_rec_type {
1495         CL_NONE     = -1,
1496         CL_MARK     = 0,
1497         CL_CREATE   = 1,  /* namespace */
1498         CL_MKDIR    = 2,  /* namespace */
1499         CL_HARDLINK = 3,  /* namespace */
1500         CL_SOFTLINK = 4,  /* namespace */
1501         CL_MKNOD    = 5,  /* namespace */
1502         CL_UNLINK   = 6,  /* namespace */
1503         CL_RMDIR    = 7,  /* namespace */
1504         CL_RENAME   = 8,  /* namespace */
1505         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
1506         CL_OPEN     = 10, /* not currently used */
1507         CL_CLOSE    = 11, /* may be written to log only with mtime change */
1508         CL_LAYOUT   = 12, /* file layout/striping modified */
1509         CL_TRUNC    = 13,
1510         CL_SETATTR  = 14,
1511         CL_SETXATTR = 15,
1512         CL_XATTR    = CL_SETXATTR, /* Deprecated name */
1513         CL_HSM      = 16, /* HSM specific events, see flags */
1514         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
1515         CL_CTIME    = 18,
1516         CL_ATIME    = 19,
1517         CL_MIGRATE  = 20,
1518         CL_FLRW     = 21, /* FLR: file was firstly written */
1519         CL_RESYNC   = 22, /* FLR: file was resync-ed */
1520         CL_GETXATTR = 23,
1521         CL_DN_OPEN  = 24, /* denied open */
1522         CL_LAST
1523 };
1524
1525 static inline const char *changelog_type2str(int type) {
1526         static const char *changelog_str[] = {
1527                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1528                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
1529                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT",
1530                 "FLRW",  "RESYNC","GXATR", "NOPEN",
1531         };
1532
1533         if (type >= 0 && type < CL_LAST)
1534                 return changelog_str[type];
1535         return NULL;
1536 }
1537
1538 /* 12 bits of per-record data can be stored in the bottom of the flags */
1539 #define CLF_FLAGSHIFT   12
1540 enum changelog_rec_flags {
1541         CLF_VERSION     = 0x1000,
1542         CLF_RENAME      = 0x2000,
1543         CLF_JOBID       = 0x4000,
1544         CLF_EXTRA_FLAGS = 0x8000,
1545         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID |
1546                           CLF_EXTRA_FLAGS,
1547         CLF_FLAGMASK    = (1U << CLF_FLAGSHIFT) - 1,
1548         CLF_VERMASK     = ~CLF_FLAGMASK,
1549 };
1550
1551
1552 /* Anything under the flagmask may be per-type (if desired) */
1553 /* Flags for unlink */
1554 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
1555 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1556                                      /* HSM cleaning needed */
1557 /* Flags for rename */
1558 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
1559                                         * of target */
1560 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
1561                                         * has an archive in backend */
1562
1563 /* Flags for HSM */
1564 /* 12b used (from high weight to low weight):
1565  * 2b for flags
1566  * 3b for event
1567  * 7b for error code
1568  */
1569 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
1570 #define CLF_HSM_ERR_H        6
1571 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
1572 #define CLF_HSM_EVENT_H      9
1573 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
1574 #define CLF_HSM_FLAG_H      11
1575 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
1576 #define CLF_HSM_SPARE_H     15
1577 #define CLF_HSM_LAST        15
1578
1579 /* Remove bits higher than _h, then extract the value
1580  * between _h and _l by shifting lower weigth to bit 0. */
1581 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1582                                    >> (CLF_HSM_LAST - _h + _l))
1583
1584 #define CLF_HSM_SUCCESS      0x00
1585 #define CLF_HSM_MAXERROR     0x7E
1586 #define CLF_HSM_ERROVERFLOW  0x7F
1587
1588 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
1589
1590 /* 3 bits field => 8 values allowed */
1591 enum hsm_event {
1592         HE_ARCHIVE      = 0,
1593         HE_RESTORE      = 1,
1594         HE_CANCEL       = 2,
1595         HE_RELEASE      = 3,
1596         HE_REMOVE       = 4,
1597         HE_STATE        = 5,
1598         HE_SPARE1       = 6,
1599         HE_SPARE2       = 7,
1600 };
1601
1602 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1603 {
1604         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1605                                             CLF_HSM_EVENT_L);
1606 }
1607
1608 static inline void hsm_set_cl_event(enum changelog_rec_flags *clf_flags,
1609                                     enum hsm_event he)
1610 {
1611         *clf_flags = (enum changelog_rec_flags)
1612                 (*clf_flags | (he << CLF_HSM_EVENT_L));
1613 }
1614
1615 static inline __u16 hsm_get_cl_flags(enum changelog_rec_flags clf_flags)
1616 {
1617         return CLF_GET_BITS(clf_flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1618 }
1619
1620 static inline void hsm_set_cl_flags(enum changelog_rec_flags *clf_flags,
1621                                     unsigned int bits)
1622 {
1623         *clf_flags = (enum changelog_rec_flags)
1624                 (*clf_flags | (bits << CLF_HSM_FLAG_L));
1625 }
1626
1627 static inline int hsm_get_cl_error(enum changelog_rec_flags clf_flags)
1628 {
1629         return CLF_GET_BITS(clf_flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1630 }
1631
1632 static inline void hsm_set_cl_error(enum changelog_rec_flags *clf_flags,
1633                                     unsigned int error)
1634 {
1635         *clf_flags = (enum changelog_rec_flags)
1636                 (*clf_flags | (error << CLF_HSM_ERR_L));
1637 }
1638
1639 enum changelog_rec_extra_flags {
1640         CLFE_INVALID    = 0,
1641         CLFE_UIDGID     = 0x0001,
1642         CLFE_NID        = 0x0002,
1643         CLFE_OPEN       = 0x0004,
1644         CLFE_XATTR      = 0x0008,
1645         CLFE_SUPPORTED  = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1646 };
1647
1648 enum changelog_send_flag {
1649         /* Not yet implemented */
1650         CHANGELOG_FLAG_FOLLOW      = 0x01,
1651         /* Blocking IO makes sense in case of slow user parsing of the records,
1652          * but it also prevents us from cleaning up if the records are not
1653          * consumed. */
1654         CHANGELOG_FLAG_BLOCK       = 0x02,
1655         /* Pack jobid into the changelog records if available. */
1656         CHANGELOG_FLAG_JOBID       = 0x04,
1657         /* Pack additional flag bits into the changelog record */
1658         CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1659 };
1660
1661 enum changelog_send_extra_flag {
1662         /* Pack uid/gid into the changelog record */
1663         CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1664         /* Pack nid into the changelog record */
1665         CHANGELOG_EXTRA_FLAG_NID    = 0x02,
1666         /* Pack open mode into the changelog record */
1667         CHANGELOG_EXTRA_FLAG_OMODE  = 0x04,
1668         /* Pack xattr name into the changelog record */
1669         CHANGELOG_EXTRA_FLAG_XATTR  = 0x08,
1670 };
1671
1672 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1673                                   changelog_rec_offset(CLF_SUPPORTED, \
1674                                                        CLFE_SUPPORTED), 8)
1675
1676 /* 31 usable bytes string + null terminator. */
1677 #define LUSTRE_JOBID_SIZE       32
1678
1679 /* This is the minimal changelog record. It can contain extensions
1680  * such as rename fields or process jobid. Its exact content is described
1681  * by the cr_flags and cr_extra_flags.
1682  *
1683  * Extensions are packed in the same order as their corresponding flags,
1684  * then in the same order as their corresponding extra flags.
1685  */
1686 struct changelog_rec {
1687         __u16                   cr_namelen;
1688         __u16                   cr_flags; /**< \a changelog_rec_flags */
1689         __u32                   cr_type;  /**< \a changelog_rec_type */
1690         __u64                   cr_index; /**< changelog record number */
1691         __u64                   cr_prev;  /**< last index for this target fid */
1692         __u64                   cr_time;
1693         union {
1694                 struct lu_fid   cr_tfid;        /**< target fid */
1695                 __u32           cr_markerflags; /**< CL_MARK flags */
1696         };
1697         struct lu_fid           cr_pfid;        /**< parent fid */
1698 } __attribute__ ((packed));
1699
1700 /* Changelog extension for RENAME. */
1701 struct changelog_ext_rename {
1702         struct lu_fid           cr_sfid;     /**< source fid, or zero */
1703         struct lu_fid           cr_spfid;    /**< source parent fid, or zero */
1704 };
1705
1706 /* Changelog extension to include JOBID. */
1707 struct changelog_ext_jobid {
1708         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
1709 };
1710
1711 /* Changelog extension to include additional flags. */
1712 struct changelog_ext_extra_flags {
1713         __u64 cr_extra_flags; /* Additional CLFE_* flags */
1714 };
1715
1716 /* Changelog extra extension to include UID/GID. */
1717 struct changelog_ext_uidgid {
1718         __u64   cr_uid;
1719         __u64   cr_gid;
1720 };
1721
1722 /* Changelog extra extension to include NID. */
1723 struct changelog_ext_nid {
1724         /* have __u64 instead of lnet_nid_t type for use by client api */
1725         __u64 cr_nid;
1726         /* for use when IPv6 support is added */
1727         __u64 extra;
1728         __u32 padding;
1729 };
1730
1731 /* Changelog extra extension to include low 32 bits of MDS_OPEN_* flags. */
1732 struct changelog_ext_openmode {
1733         __u32 cr_openflags;
1734 };
1735
1736 /* Changelog extra extension to include xattr */
1737 struct changelog_ext_xattr {
1738         char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1739 };
1740
1741 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1742         const struct changelog_rec *rec);
1743
1744 static inline __kernel_size_t changelog_rec_offset(enum changelog_rec_flags crf,
1745                                           enum changelog_rec_extra_flags cref)
1746 {
1747         __kernel_size_t size = sizeof(struct changelog_rec);
1748
1749         if (crf & CLF_RENAME)
1750                 size += sizeof(struct changelog_ext_rename);
1751
1752         if (crf & CLF_JOBID)
1753                 size += sizeof(struct changelog_ext_jobid);
1754
1755         if (crf & CLF_EXTRA_FLAGS) {
1756                 size += sizeof(struct changelog_ext_extra_flags);
1757                 if (cref & CLFE_UIDGID)
1758                         size += sizeof(struct changelog_ext_uidgid);
1759                 if (cref & CLFE_NID)
1760                         size += sizeof(struct changelog_ext_nid);
1761                 if (cref & CLFE_OPEN)
1762                         size += sizeof(struct changelog_ext_openmode);
1763                 if (cref & CLFE_XATTR)
1764                         size += sizeof(struct changelog_ext_xattr);
1765         }
1766
1767         return size;
1768 }
1769
1770 static inline __kernel_size_t changelog_rec_size(const struct changelog_rec *rec)
1771 {
1772         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1773
1774         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1775                 cref = (enum changelog_rec_extra_flags)
1776                          changelog_rec_extra_flags(rec)->cr_extra_flags;
1777
1778         return changelog_rec_offset(
1779                 (enum changelog_rec_flags)rec->cr_flags, cref);
1780 }
1781
1782 static inline __kernel_size_t changelog_rec_varsize(const struct changelog_rec *rec)
1783 {
1784         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1785 }
1786
1787 static inline
1788 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1789 {
1790         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1791                 (rec->cr_flags & CLF_VERSION);
1792
1793         return (struct changelog_ext_rename *)((char *)rec +
1794                                                changelog_rec_offset(crf,
1795                                                                  CLFE_INVALID));
1796 }
1797
1798 /* The jobid follows the rename extension, if present */
1799 static inline
1800 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1801 {
1802         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1803                                 (rec->cr_flags & (CLF_VERSION | CLF_RENAME));
1804
1805         return (struct changelog_ext_jobid *)((char *)rec +
1806                                               changelog_rec_offset(crf,
1807                                                                  CLFE_INVALID));
1808 }
1809
1810 /* The additional flags follow the rename and jobid extensions, if present */
1811 static inline
1812 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1813         const struct changelog_rec *rec)
1814 {
1815         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1816             (rec->cr_flags & (CLF_VERSION | CLF_RENAME | CLF_JOBID));
1817
1818         return (struct changelog_ext_extra_flags *)((char *)rec +
1819                                                  changelog_rec_offset(crf,
1820                                                                  CLFE_INVALID));
1821 }
1822
1823 /* The uid/gid is the first extra extension */
1824 static inline
1825 struct changelog_ext_uidgid *changelog_rec_uidgid(
1826         const struct changelog_rec *rec)
1827 {
1828         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1829             (rec->cr_flags &
1830                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
1831
1832         return (struct changelog_ext_uidgid *)((char *)rec +
1833                                                changelog_rec_offset(crf,
1834                                                                  CLFE_INVALID));
1835 }
1836
1837 /* The nid is the second extra extension */
1838 static inline
1839 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
1840 {
1841         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1842             (rec->cr_flags &
1843              (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
1844         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1845
1846         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1847                 cref = (enum changelog_rec_extra_flags)
1848                         (changelog_rec_extra_flags(rec)->cr_extra_flags &
1849                          CLFE_UIDGID);
1850
1851         return (struct changelog_ext_nid *)((char *)rec +
1852                                             changelog_rec_offset(crf, cref));
1853 }
1854
1855 /* The OPEN mode is the third extra extension */
1856 static inline
1857 struct changelog_ext_openmode *changelog_rec_openmode(
1858         const struct changelog_rec *rec)
1859 {
1860         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1861                 (rec->cr_flags &
1862                  (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
1863         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1864
1865         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1866                 cref = (enum changelog_rec_extra_flags)
1867                         (changelog_rec_extra_flags(rec)->cr_extra_flags &
1868                          (CLFE_UIDGID | CLFE_NID));
1869         }
1870
1871         return (struct changelog_ext_openmode *)((char *)rec +
1872                                                changelog_rec_offset(crf, cref));
1873 }
1874
1875 /* The xattr name is the fourth extra extension */
1876 static inline
1877 struct changelog_ext_xattr *changelog_rec_xattr(
1878         const struct changelog_rec *rec)
1879 {
1880         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1881             (rec->cr_flags &
1882              (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
1883         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1884
1885         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1886                 cref = (enum changelog_rec_extra_flags)
1887                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
1888                         (CLFE_UIDGID | CLFE_NID | CLFE_OPEN));
1889
1890         return (struct changelog_ext_xattr *)((char *)rec +
1891                                               changelog_rec_offset(crf, cref));
1892 }
1893
1894 /* The name follows the rename, jobid  and extra flags extns, if present */
1895 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1896 {
1897         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1898
1899         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1900                 cref = (enum changelog_rec_extra_flags)
1901                     changelog_rec_extra_flags(rec)->cr_extra_flags;
1902
1903         return (char *)rec + changelog_rec_offset(
1904                 (enum changelog_rec_flags)(rec->cr_flags & CLF_SUPPORTED),
1905                 (enum changelog_rec_extra_flags)(cref & CLFE_SUPPORTED));
1906 }
1907
1908 static inline __kernel_size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1909 {
1910         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1911 }
1912
1913 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1914 {
1915         char *cr_name = changelog_rec_name(rec);
1916
1917         return cr_name + strlen(cr_name) + 1;
1918 }
1919
1920 /**
1921  * Remap a record to the desired format as specified by the crf flags.
1922  * The record must be big enough to contain the final remapped version.
1923  * Superfluous extension fields are removed and missing ones are added
1924  * and zeroed. The flags of the record are updated accordingly.
1925  *
1926  * The jobid and rename extensions can be added to a record, to match the
1927  * format an application expects, typically. In this case, the newly added
1928  * fields will be zeroed.
1929  * The Jobid field can be removed, to guarantee compatibility with older
1930  * clients that don't expect this field in the records they process.
1931  *
1932  * The following assumptions are being made:
1933  *   - CLF_RENAME will not be removed
1934  *   - CLF_JOBID will not be added without CLF_RENAME being added too
1935  *   - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
1936  *
1937  * @param[in,out]  rec         The record to remap.
1938  * @param[in]      crf_wanted  Flags describing the desired extensions.
1939  * @param[in]      cref_want   Flags describing the desired extra extensions.
1940  */
1941 static inline void changelog_remap_rec(struct changelog_rec *rec,
1942                                        enum changelog_rec_flags crf_wanted,
1943                                        enum changelog_rec_extra_flags cref_want)
1944 {
1945         char *xattr_mov = NULL;
1946         char *omd_mov = NULL;
1947         char *nid_mov = NULL;
1948         char *uidgid_mov = NULL;
1949         char *ef_mov;
1950         char *jid_mov;
1951         char *rnm_mov;
1952         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1953
1954         crf_wanted = (enum changelog_rec_flags)
1955             (crf_wanted & CLF_SUPPORTED);
1956         cref_want = (enum changelog_rec_extra_flags)
1957             (cref_want & CLFE_SUPPORTED);
1958
1959         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
1960                 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
1961                     (rec->cr_flags & CLF_EXTRA_FLAGS &&
1962                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
1963                                                         CLFE_SUPPORTED) ==
1964                                                                      cref_want))
1965                         return;
1966         }
1967
1968         /* First move the variable-length name field */
1969         memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
1970                 changelog_rec_name(rec), rec->cr_namelen);
1971
1972         /* Locations of extensions in the remapped record */
1973         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1974                 xattr_mov = (char *)rec +
1975                         changelog_rec_offset(
1976                             (enum changelog_rec_flags)
1977                                     (crf_wanted & CLF_SUPPORTED),
1978                             (enum changelog_rec_extra_flags)
1979                                     (cref_want & ~CLFE_XATTR));
1980                 omd_mov = (char *)rec +
1981                         changelog_rec_offset(
1982                             (enum changelog_rec_flags)
1983                                     (crf_wanted & CLF_SUPPORTED),
1984                             (enum changelog_rec_extra_flags)
1985                                     (cref_want & ~(CLFE_OPEN | CLFE_XATTR)));
1986                 nid_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 &
1992                                  ~(CLFE_NID | CLFE_OPEN | CLFE_XATTR)));
1993                 uidgid_mov = (char *)rec +
1994                         changelog_rec_offset(
1995                                 (enum changelog_rec_flags)
1996                                     (crf_wanted & CLF_SUPPORTED),
1997                                 (enum changelog_rec_extra_flags)
1998                                     (cref_want & ~(CLFE_UIDGID |
1999                                                            CLFE_NID |
2000                                                            CLFE_OPEN |
2001                                                            CLFE_XATTR)));
2002                 cref = (enum changelog_rec_extra_flags)
2003                         changelog_rec_extra_flags(rec)->cr_extra_flags;
2004         }
2005
2006         ef_mov  = (char *)rec +
2007                   changelog_rec_offset(
2008                                 (enum changelog_rec_flags)
2009                                  (crf_wanted & ~CLF_EXTRA_FLAGS), CLFE_INVALID);
2010         jid_mov = (char *)rec +
2011                   changelog_rec_offset((enum changelog_rec_flags)(crf_wanted &
2012                                        ~(CLF_EXTRA_FLAGS | CLF_JOBID)),
2013                                        CLFE_INVALID);
2014         rnm_mov = (char *)rec +
2015                   changelog_rec_offset((enum changelog_rec_flags)(crf_wanted &
2016                                        ~(CLF_EXTRA_FLAGS |
2017                                          CLF_JOBID |
2018                                          CLF_RENAME)),
2019                                        CLFE_INVALID);
2020
2021         /* Move the extension fields to the desired positions */
2022         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
2023             (rec->cr_flags & CLF_EXTRA_FLAGS)) {
2024                 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
2025                         memmove(xattr_mov, changelog_rec_xattr(rec),
2026                                 sizeof(struct changelog_ext_xattr));
2027
2028                 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
2029                         memmove(omd_mov, changelog_rec_openmode(rec),
2030                                 sizeof(struct changelog_ext_openmode));
2031
2032                 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
2033                         memmove(nid_mov, changelog_rec_nid(rec),
2034                                 sizeof(struct changelog_ext_nid));
2035
2036                 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
2037                         memmove(uidgid_mov, changelog_rec_uidgid(rec),
2038                                 sizeof(struct changelog_ext_uidgid));
2039
2040                 memmove(ef_mov, changelog_rec_extra_flags(rec),
2041                         sizeof(struct changelog_ext_extra_flags));
2042         }
2043
2044         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
2045                 memmove(jid_mov, changelog_rec_jobid(rec),
2046                         sizeof(struct changelog_ext_jobid));
2047
2048         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
2049                 memmove(rnm_mov, changelog_rec_rename(rec),
2050                         sizeof(struct changelog_ext_rename));
2051
2052         /* Clear newly added fields */
2053         if (xattr_mov && (cref_want & CLFE_XATTR) &&
2054             !(cref & CLFE_XATTR))
2055                 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
2056
2057         if (omd_mov && (cref_want & CLFE_OPEN) &&
2058             !(cref & CLFE_OPEN))
2059                 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
2060
2061         if (nid_mov && (cref_want & CLFE_NID) &&
2062             !(cref & CLFE_NID))
2063                 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
2064
2065         if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
2066             !(cref & CLFE_UIDGID))
2067                 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
2068
2069         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
2070             !(rec->cr_flags & CLF_EXTRA_FLAGS))
2071                 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
2072
2073         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
2074                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
2075
2076         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
2077                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
2078
2079         /* Update the record's flags accordingly */
2080         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
2081         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2082                 changelog_rec_extra_flags(rec)->cr_extra_flags =
2083                         changelog_rec_extra_flags(rec)->cr_extra_flags |
2084                         cref_want;
2085 }
2086
2087 enum changelog_message_type {
2088         CL_RECORD = 10, /* message is a changelog_rec */
2089         CL_EOF    = 11, /* at end of current changelog */
2090 };
2091
2092 /********* Misc **********/
2093
2094 struct ioc_data_version {
2095         __u64   idv_version;
2096         __u32   idv_layout_version; /* FLR: layout version for OST objects */
2097         __u32   idv_flags;      /* enum ioc_data_version_flags */
2098 };
2099
2100 enum ioc_data_version_flags {
2101         LL_DV_RD_FLUSH  = (1 << 0), /* Flush dirty pages from clients */
2102         LL_DV_WR_FLUSH  = (1 << 1), /* Flush all caching pages from clients */
2103 };
2104
2105 #ifndef offsetof
2106 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
2107 #endif
2108
2109 #define dot_lustre_name ".lustre"
2110
2111
2112 /********* HSM **********/
2113
2114 /** HSM per-file state
2115  * See HSM_FLAGS below.
2116  */
2117 enum hsm_states {
2118         HS_NONE         = 0x00000000,
2119         HS_EXISTS       = 0x00000001,
2120         HS_DIRTY        = 0x00000002,
2121         HS_RELEASED     = 0x00000004,
2122         HS_ARCHIVED     = 0x00000008,
2123         HS_NORELEASE    = 0x00000010,
2124         HS_NOARCHIVE    = 0x00000020,
2125         HS_LOST         = 0x00000040,
2126 };
2127
2128 /* HSM user-setable flags. */
2129 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
2130
2131 /* Other HSM flags. */
2132 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
2133
2134 /*
2135  * All HSM-related possible flags that could be applied to a file.
2136  * This should be kept in sync with hsm_states.
2137  */
2138 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
2139
2140 /**
2141  * HSM request progress state
2142  */
2143 enum hsm_progress_states {
2144         HPS_NONE        = 0,
2145         HPS_WAITING     = 1,
2146         HPS_RUNNING     = 2,
2147         HPS_DONE        = 3,
2148 };
2149
2150 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
2151 {
2152         switch  (s) {
2153         case HPS_WAITING:       return "waiting";
2154         case HPS_RUNNING:       return "running";
2155         case HPS_DONE:          return "done";
2156         default:                return "unknown";
2157         }
2158 }
2159
2160 struct hsm_extent {
2161         __u64 offset;
2162         __u64 length;
2163 } __attribute__((packed));
2164
2165 /**
2166  * Current HSM states of a Lustre file.
2167  *
2168  * This structure purpose is to be sent to user-space mainly. It describes the
2169  * current HSM flags and in-progress action.
2170  */
2171 struct hsm_user_state {
2172         /** Current HSM states, from enum hsm_states. */
2173         __u32                   hus_states;
2174         __u32                   hus_archive_id;
2175         /**  The current undergoing action, if there is one */
2176         __u32                   hus_in_progress_state;
2177         __u32                   hus_in_progress_action;
2178         struct hsm_extent       hus_in_progress_location;
2179         char                    hus_extended_info[];
2180 };
2181
2182 struct hsm_state_set_ioc {
2183         struct lu_fid   hssi_fid;
2184         __u64           hssi_setmask;
2185         __u64           hssi_clearmask;
2186 };
2187
2188 /*
2189  * This structure describes the current in-progress action for a file.
2190  * it is retuned to user space and send over the wire
2191  */
2192 struct hsm_current_action {
2193         /**  The current undergoing action, if there is one */
2194         /* state is one of hsm_progress_states */
2195         __u32                   hca_state;
2196         /* action is one of hsm_user_action */
2197         __u32                   hca_action;
2198         struct hsm_extent       hca_location;
2199 };
2200
2201 /***** HSM user requests ******/
2202 /* User-generated (lfs/ioctl) request types */
2203 enum hsm_user_action {
2204         HUA_NONE    =  1, /* no action (noop) */
2205         HUA_ARCHIVE = 10, /* copy to hsm */
2206         HUA_RESTORE = 11, /* prestage */
2207         HUA_RELEASE = 12, /* drop ost objects */
2208         HUA_REMOVE  = 13, /* remove from archive */
2209         HUA_CANCEL  = 14  /* cancel a request */
2210 };
2211
2212 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
2213 {
2214         switch  (a) {
2215         case HUA_NONE:    return "NOOP";
2216         case HUA_ARCHIVE: return "ARCHIVE";
2217         case HUA_RESTORE: return "RESTORE";
2218         case HUA_RELEASE: return "RELEASE";
2219         case HUA_REMOVE:  return "REMOVE";
2220         case HUA_CANCEL:  return "CANCEL";
2221         default:          return "UNKNOWN";
2222         }
2223 }
2224
2225 /*
2226  * List of hr_flags (bit field)
2227  */
2228 #define HSM_FORCE_ACTION 0x0001
2229 /* used by CT, cannot be set by user */
2230 #define HSM_GHOST_COPY   0x0002
2231
2232 /**
2233  * Contains all the fixed part of struct hsm_user_request.
2234  *
2235  */
2236 struct hsm_request {
2237         __u32 hr_action;        /* enum hsm_user_action */
2238         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
2239         __u64 hr_flags;         /* request flags */
2240         __u32 hr_itemcount;     /* item count in hur_user_item vector */
2241         __u32 hr_data_len;
2242 };
2243
2244 struct hsm_user_item {
2245        struct lu_fid        hui_fid;
2246        struct hsm_extent hui_extent;
2247 } __attribute__((packed));
2248
2249 struct hsm_user_request {
2250         struct hsm_request      hur_request;
2251         struct hsm_user_item    hur_user_item[0];
2252         /* extra data blob at end of struct (after all
2253          * hur_user_items), only use helpers to access it
2254          */
2255 } __attribute__((packed));
2256
2257 /** Return pointer to data field in a hsm user request */
2258 static inline void *hur_data(struct hsm_user_request *hur)
2259 {
2260         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
2261 }
2262
2263 /**
2264  * Compute the current length of the provided hsm_user_request.  This returns -1
2265  * instead of an errno because __kernel_ssize_t is defined to be only
2266  * [ -1, SSIZE_MAX ]
2267  *
2268  * return -1 on bounds check error.
2269  */
2270 static inline __kernel_size_t hur_len(struct hsm_user_request *hur)
2271 {
2272         __u64   size;
2273
2274         /* can't overflow a __u64 since hr_itemcount is only __u32 */
2275         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
2276                 (__u64)hur->hur_request.hr_itemcount *
2277                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
2278
2279         if ((__kernel_ssize_t)size < 0)
2280                 return -1;
2281
2282         return size;
2283 }
2284
2285 /****** HSM RPCs to copytool *****/
2286 /* Message types the copytool may receive */
2287 enum hsm_message_type {
2288         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
2289 };
2290
2291 /* Actions the copytool may be instructed to take for a given action_item */
2292 enum hsm_copytool_action {
2293         HSMA_NONE    = 10, /* no action */
2294         HSMA_ARCHIVE = 20, /* arbitrary offset */
2295         HSMA_RESTORE = 21,
2296         HSMA_REMOVE  = 22,
2297         HSMA_CANCEL  = 23
2298 };
2299
2300 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
2301 {
2302         switch  (a) {
2303         case HSMA_NONE:    return "NOOP";
2304         case HSMA_ARCHIVE: return "ARCHIVE";
2305         case HSMA_RESTORE: return "RESTORE";
2306         case HSMA_REMOVE:  return "REMOVE";
2307         case HSMA_CANCEL:  return "CANCEL";
2308         default:           return "UNKNOWN";
2309         }
2310 }
2311
2312 /* Copytool item action description */
2313 struct hsm_action_item {
2314         __u32      hai_len;     /* valid size of this struct */
2315         __u32      hai_action;  /* hsm_copytool_action, but use known size */
2316         struct lu_fid hai_fid;     /* Lustre FID to operate on */
2317         struct lu_fid hai_dfid;    /* fid used for data access */
2318         struct hsm_extent hai_extent;  /* byte range to operate on */
2319         __u64      hai_cookie;  /* action cookie from coordinator */
2320         __u64      hai_gid;     /* grouplock id */
2321         char       hai_data[0]; /* variable length */
2322 } __attribute__((packed));
2323
2324 /**
2325  * helper function which print in hexa the first bytes of
2326  * hai opaque field
2327  *
2328  * \param hai [IN]        record to print
2329  * \param buffer [IN,OUT] buffer to write the hex string to
2330  * \param len [IN]        max buffer length
2331  *
2332  * \retval buffer
2333  */
2334 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
2335                                         char *buffer, __kernel_size_t len)
2336 {
2337         int i;
2338         int data_len;
2339         char *ptr;
2340
2341         ptr = buffer;
2342         data_len = hai->hai_len - sizeof(*hai);
2343         for (i = 0; (i < data_len) && (len > 2); i++) {
2344                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
2345                 ptr += 2;
2346                 len -= 2;
2347         }
2348
2349         *ptr = '\0';
2350
2351         return buffer;
2352 }
2353
2354 /* Copytool action list */
2355 #define HAL_VERSION 1
2356 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
2357 struct hsm_action_list {
2358         __u32 hal_version;
2359         __u32 hal_count;       /* number of hai's to follow */
2360         __u64 hal_compound_id; /* returned by coordinator, ignored */
2361         __u64 hal_flags;
2362         __u32 hal_archive_id; /* which archive backend */
2363         __u32 padding1;
2364         char  hal_fsname[0];   /* null-terminated */
2365         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
2366            boundaries. See hai_zero */
2367 } __attribute__((packed));
2368
2369 /* Return pointer to first hai in action list */
2370 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
2371 {
2372         __kernel_size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2373
2374         return (struct hsm_action_item *)(hal->hal_fsname + offset);
2375 }
2376
2377 /* Return pointer to next hai */
2378 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
2379 {
2380         __kernel_size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
2381
2382         return (struct hsm_action_item *)((char *)hai + offset);
2383 }
2384
2385 /* Return size of an hsm_action_list */
2386 static inline __kernel_size_t hal_size(struct hsm_action_list *hal)
2387 {
2388         __u32 i;
2389         __kernel_size_t sz;
2390         struct hsm_action_item *hai;
2391
2392         sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2393         hai = hai_first(hal);
2394         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
2395                 sz += __ALIGN_KERNEL(hai->hai_len, 8);
2396
2397         return sz;
2398 }
2399
2400 /* HSM file import
2401  * describe the attributes to be set on imported file
2402  */
2403 struct hsm_user_import {
2404         __u64           hui_size;
2405         __u64           hui_atime;
2406         __u64           hui_mtime;
2407         __u32           hui_atime_ns;
2408         __u32           hui_mtime_ns;
2409         __u32           hui_uid;
2410         __u32           hui_gid;
2411         __u32           hui_mode;
2412         __u32           hui_archive_id;
2413 };
2414
2415 /* Copytool progress reporting */
2416 #define HP_FLAG_COMPLETED 0x01
2417 #define HP_FLAG_RETRY     0x02
2418
2419 struct hsm_progress {
2420         struct lu_fid           hp_fid;
2421         __u64                   hp_cookie;
2422         struct hsm_extent       hp_extent;
2423         __u16                   hp_flags;
2424         __u16                   hp_errval; /* positive val */
2425         __u32                   padding;
2426 };
2427
2428 struct hsm_copy {
2429         __u64                   hc_data_version;
2430         __u16                   hc_flags;
2431         __u16                   hc_errval; /* positive val */
2432         __u32                   padding;
2433         struct hsm_action_item  hc_hai;
2434 };
2435
2436 enum lu_ladvise_type {
2437         LU_LADVISE_INVALID      = 0,
2438         LU_LADVISE_WILLREAD     = 1,
2439         LU_LADVISE_DONTNEED     = 2,
2440         LU_LADVISE_LOCKNOEXPAND = 3,
2441         LU_LADVISE_LOCKAHEAD    = 4,
2442         LU_LADVISE_MAX
2443 };
2444
2445 #define LU_LADVISE_NAMES {                                              \
2446         [LU_LADVISE_WILLREAD]           = "willread",                   \
2447         [LU_LADVISE_DONTNEED]           = "dontneed",                   \
2448         [LU_LADVISE_LOCKNOEXPAND]       = "locknoexpand",               \
2449         [LU_LADVISE_LOCKAHEAD]          = "lockahead",                  \
2450 }
2451
2452 /* This is the userspace argument for ladvise.  It is currently the same as
2453  * what goes on the wire (struct lu_ladvise), but is defined separately as we
2454  * may need info which is only used locally. */
2455 struct llapi_lu_ladvise {
2456         __u16 lla_advice;       /* advice type */
2457         __u16 lla_value1;       /* values for different advice types */
2458         __u32 lla_value2;
2459         __u64 lla_start;        /* first byte of extent for advice */
2460         __u64 lla_end;          /* last byte of extent for advice */
2461         __u32 lla_value3;
2462         __u32 lla_value4;
2463 };
2464
2465 enum ladvise_flag {
2466         LF_ASYNC        = 0x00000001,
2467         LF_UNSET        = 0x00000002,
2468 };
2469
2470 #define LADVISE_MAGIC 0x1ADF1CE0
2471 /* Masks of valid flags for each advice */
2472 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2473 /* Flags valid for all advices not explicitly specified */
2474 #define LF_DEFAULT_MASK LF_ASYNC
2475 /* All flags */
2476 #define LF_MASK (LF_ASYNC | LF_UNSET)
2477
2478 #define lla_lockahead_mode   lla_value1
2479 #define lla_peradvice_flags    lla_value2
2480 #define lla_lockahead_result lla_value3
2481
2482 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2483  * is used on the wire.  It is defined separately as we may need info which is
2484  * only used locally. */
2485 struct llapi_ladvise_hdr {
2486         __u32                   lah_magic;      /* LADVISE_MAGIC */
2487         __u32                   lah_count;      /* number of advices */
2488         __u64                   lah_flags;      /* from enum ladvise_flag */
2489         __u32                   lah_value1;     /* unused */
2490         __u32                   lah_value2;     /* unused */
2491         __u64                   lah_value3;     /* unused */
2492         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
2493 };
2494
2495 #define LAH_COUNT_MAX   (1024)
2496
2497 /* Shared key */
2498 enum sk_crypt_alg {
2499         SK_CRYPT_INVALID        = -1,
2500         SK_CRYPT_EMPTY          = 0,
2501         SK_CRYPT_AES256_CTR     = 1,
2502 };
2503
2504 enum sk_hmac_alg {
2505         SK_HMAC_INVALID = -1,
2506         SK_HMAC_EMPTY   = 0,
2507         SK_HMAC_SHA256  = 1,
2508         SK_HMAC_SHA512  = 2,
2509 };
2510
2511 struct sk_crypt_type {
2512         const char     *sct_name;
2513         int             sct_type;
2514 };
2515
2516 struct sk_hmac_type {
2517         const char     *sht_name;
2518         int             sht_type;
2519 };
2520
2521 enum lock_mode_user {
2522         MODE_READ_USER = 1,
2523         MODE_WRITE_USER,
2524         MODE_MAX_USER,
2525 };
2526
2527 #define LOCK_MODE_NAMES { \
2528         [MODE_READ_USER]  = "READ",\
2529         [MODE_WRITE_USER] = "WRITE"\
2530 }
2531
2532 enum lockahead_results {
2533         LLA_RESULT_SENT = 0,
2534         LLA_RESULT_DIFFERENT,
2535         LLA_RESULT_SAME,
2536 };
2537
2538 enum lu_heat_flag_bit {
2539         LU_HEAT_FLAG_BIT_INVALID = 0,
2540         LU_HEAT_FLAG_BIT_OFF,
2541         LU_HEAT_FLAG_BIT_CLEAR,
2542 };
2543
2544 enum lu_heat_flag {
2545         LU_HEAT_FLAG_OFF        = 1ULL << LU_HEAT_FLAG_BIT_OFF,
2546         LU_HEAT_FLAG_CLEAR      = 1ULL << LU_HEAT_FLAG_BIT_CLEAR,
2547 };
2548
2549 enum obd_heat_type {
2550         OBD_HEAT_READSAMPLE     = 0,
2551         OBD_HEAT_WRITESAMPLE    = 1,
2552         OBD_HEAT_READBYTE       = 2,
2553         OBD_HEAT_WRITEBYTE      = 3,
2554         OBD_HEAT_COUNT
2555 };
2556
2557 #define LU_HEAT_NAMES {                                 \
2558         [OBD_HEAT_READSAMPLE]   = "readsample",         \
2559         [OBD_HEAT_WRITESAMPLE]  = "writesample",        \
2560         [OBD_HEAT_READBYTE]     = "readbyte",           \
2561         [OBD_HEAT_WRITEBYTE]    = "writebyte",          \
2562 }
2563
2564 struct lu_heat {
2565         __u32 lh_count;
2566         __u32 lh_flags;
2567         __u64 lh_heat[0];
2568 };
2569
2570 enum lu_pcc_type {
2571         LU_PCC_NONE = 0,
2572         LU_PCC_READWRITE,
2573         LU_PCC_MAX
2574 };
2575
2576 static inline const char *pcc_type2string(enum lu_pcc_type type)
2577 {
2578         switch (type) {
2579         case LU_PCC_NONE:
2580                 return "none";
2581         case LU_PCC_READWRITE:
2582                 return "readwrite";
2583         default:
2584                 return "fault";
2585         }
2586 }
2587
2588 struct lu_pcc_attach {
2589         __u32 pcca_type; /* PCC type */
2590         __u32 pcca_id; /* archive ID for readwrite, group ID for readonly */
2591 };
2592
2593 enum lu_pcc_detach_opts {
2594         PCC_DETACH_OPT_NONE = 0, /* Detach only, keep the PCC copy */
2595         PCC_DETACH_OPT_UNCACHE, /* Remove the cached file after detach */
2596 };
2597
2598 struct lu_pcc_detach_fid {
2599         /* fid of the file to detach */
2600         struct lu_fid   pccd_fid;
2601         __u32           pccd_opt;
2602 };
2603
2604 struct lu_pcc_detach {
2605         __u32           pccd_opt;
2606 };
2607
2608 enum lu_pcc_state_flags {
2609         PCC_STATE_FL_NONE               = 0x0,
2610         /* The inode attr is cached locally */
2611         PCC_STATE_FL_ATTR_VALID         = 0x01,
2612         /* The file is being attached into PCC */
2613         PCC_STATE_FL_ATTACHING          = 0x02,
2614 };
2615
2616 struct lu_pcc_state {
2617         __u32   pccs_type; /* enum lu_pcc_type */
2618         __u32   pccs_open_count;
2619         __u32   pccs_flags; /* enum lu_pcc_state_flags */
2620         __u32   pccs_padding;
2621         char    pccs_path[PATH_MAX];
2622 };
2623
2624 struct fid_array {
2625         __u32 fa_nr;
2626         /* make header's size equal lu_fid */
2627         __u32 fa_padding0;
2628         __u64 fa_padding1;
2629         struct lu_fid fa_fids[0];
2630 };
2631 #define OBD_MAX_FIDS_IN_ARRAY   4096
2632
2633 #if defined(__cplusplus)
2634 }
2635 #endif
2636
2637 /** @} lustreuser */
2638
2639 #endif /* _LUSTRE_USER_H */