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