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

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