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