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