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

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