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