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 #define LOV_PATTERN_COMPRESS            0x800
 728
 729 #define LOV_PATTERN_F_MASK      0xffff0000
 730 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
 731 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
 732 #define LOV_PATTERN_DEFAULT     0xffffffff
 733
 734 #define LOV_OFFSET_DEFAULT      ((__u16)-1)
 735 #define LMV_OFFSET_DEFAULT      ((__u32)-1)
 736
 737 static inline bool lov_pattern_supported(__u32 pattern)
 738 {
 739         return (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_RAID0 ||
 740                (pattern & ~LOV_PATTERN_F_RELEASED) ==
 741                         (LOV_PATTERN_RAID0 | LOV_PATTERN_OVERSTRIPING) ||
 742                (pattern & ~LOV_PATTERN_F_RELEASED) == LOV_PATTERN_MDT;
 743 }
 744
 745 /* RELEASED and MDT patterns are not valid in many places, so rather than
 746  * having many extra checks on lov_pattern_supported, we have this separate
 747  * check for non-released, non-DOM components
 748  */
 749 static inline bool lov_pattern_supported_normal_comp(__u32 pattern)
 750 {
 751         return pattern == LOV_PATTERN_RAID0 ||
 752                pattern == (LOV_PATTERN_RAID0 | LOV_PATTERN_OVERSTRIPING);
 753
 754 }
 755
 756 #define LOV_MAXPOOLNAME 15
 757 #define LOV_POOLNAMEF "%.15s"
 758 /* The poolname "ignore" is used to force a component creation without pool */
 759 #define LOV_POOL_IGNORE "ignore"
 760 /* The poolname "inherit" is used to force a component to inherit the pool from
 761  * parent or root directory
 762  */
 763 #define LOV_POOL_INHERIT "inherit"
 764 /* The poolname "none" is deprecated in 2.15 (same behavior as "inherit") */
 765 #define LOV_POOL_NONE "none"
 766
 767 static inline bool lov_pool_is_ignored(const char *pool)
 768 {
 769         return pool && strncmp(pool, LOV_POOL_IGNORE, LOV_MAXPOOLNAME) == 0;
 770 }
 771
 772 static inline bool lov_pool_is_inherited(const char *pool)
 773 {
 774         return pool && (strncmp(pool, LOV_POOL_INHERIT, LOV_MAXPOOLNAME) == 0 ||
 775                         strncmp(pool, LOV_POOL_NONE, LOV_MAXPOOLNAME) == 0);
 776 }
 777
 778 static inline bool lov_pool_is_reserved(const char *pool)
 779 {
 780         return lov_pool_is_ignored(pool) || lov_pool_is_inherited(pool);
 781 }
 782
 783 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 784 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 785 #define LOV_MAX_STRIPE_COUNT_OLD 160
 786 /* This calculation is crafted so that input of 4096 will result in 160
 787  * which in turn is equal to old maximal stripe count.
 788  * XXX: In fact this is too simpified for now, what it also need is to get
 789  * ea_type argument to clearly know how much space each stripe consumes.
 790  *
 791  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 792  * allocation that is sufficient for the current generation of systems.
 793  *
 794  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 795 #define LOV_MAX_STRIPE_COUNT 2000  /* ~((12 * 4096 - 256) / 24) */
 796 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 797 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 798
 799 #define XATTR_LUSTRE_PREFIX     "lustre."
 800 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 801
 802 /* Please update if XATTR_LUSTRE_LOV".set" groks more flags in the future */
 803 #define allowed_lustre_lov(att) (strcmp((att), XATTR_LUSTRE_LOV".add") == 0 || \
 804                         strcmp((att), XATTR_LUSTRE_LOV".set") == 0 || \
 805                         strcmp((att), XATTR_LUSTRE_LOV".set.flags") == 0 || \
 806                         strcmp((att), XATTR_LUSTRE_LOV".del") == 0)
 807
 808 #define lov_user_ost_data lov_user_ost_data_v1
 809 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 810         struct ost_id l_ost_oi;   /* OST object ID */
 811         __u32 l_ost_gen;          /* generation of this OST index */
 812         __u32 l_ost_idx;          /* OST index in LOV */
 813 } __attribute__((packed));
 814
 815 #define lov_user_md lov_user_md_v1
 816 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 817         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 818         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 819         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 820         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 821         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 822         union {
 823                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 824                                            * lmm_objects, use when writing */
 825                 __u16 lmm_layout_gen;     /* layout generation number
 826                                            * used when reading */
 827         };
 828         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 829 } __attribute__((packed, __may_alias__));
 830
 831 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 832         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 833         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 834         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 835         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 836         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 837         union {
 838                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 839                                            * lmm_objects, use when writing */
 840                 __u16 lmm_layout_gen;     /* layout generation number
 841                                            * used when reading */
 842         };
 843         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 844         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 845 } __attribute__((packed, __may_alias__));
 846
 847 struct lov_foreign_md {
 848         __u32 lfm_magic;        /* magic number = LOV_MAGIC_FOREIGN */
 849         __u32 lfm_length;       /* length of lfm_value */
 850         __u32 lfm_type;         /* type, see LU_FOREIGN_TYPE_ */
 851         __u32 lfm_flags;        /* flags, type specific */
 852         char lfm_value[];
 853 } __attribute__((packed));
 854
 855 #define foreign_size(lfm) (((struct lov_foreign_md *)lfm)->lfm_length + \
 856                            offsetof(struct lov_foreign_md, lfm_value))
 857
 858 #define foreign_size_le(lfm) \
 859         (le32_to_cpu(((struct lov_foreign_md *)lfm)->lfm_length) + \
 860         offsetof(struct lov_foreign_md, lfm_value))
 861
 862 /**
 863  * The stripe size fields are shared for the extension size storage, however
 864  * the extension size is stored in KB, not bytes.
 865  */
 866 #define SEL_UNIT_SIZE 1024llu
 867
 868 struct lu_extent {
 869         __u64   e_start;
 870         __u64   e_end;
 871 } __attribute__((packed));
 872
 873 #define DEXT "[%#llx, %#llx)"
 874 #define PEXT(ext) (unsigned long long)(ext)->e_start, (unsigned long long)(ext)->e_end
 875
 876 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
 877                                            struct lu_extent *e2)
 878 {
 879         return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
 880 }
 881
 882 static inline bool lu_extent_is_whole(struct lu_extent *e)
 883 {
 884         return e->e_start == 0 && e->e_end == LUSTRE_EOF;
 885 }
 886
 887 enum lov_comp_md_entry_flags {
 888         LCME_FL_STALE     = 0x00000001, /* FLR: stale data */
 889         LCME_FL_PREF_RD   = 0x00000002, /* FLR: preferred for reading */
 890         LCME_FL_PREF_WR   = 0x00000004, /* FLR: preferred for writing */
 891         LCME_FL_PREF_RW   = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
 892         LCME_FL_OFFLINE   = 0x00000008, /* Not used */
 893         LCME_FL_INIT      = 0x00000010, /* instantiated */
 894         LCME_FL_NOSYNC    = 0x00000020, /* FLR: no sync for the mirror */
 895         LCME_FL_EXTENSION = 0x00000040, /* extension comp, never init */
 896         LCME_FL_PARITY    = 0x00000080, /* EC: a parity code component */
 897         LCME_FL_COMPRESS  = 0x00000100, /* the component should be compressed */
 898         LCME_FL_PARTIAL   = 0x00000200, /* some chunks in the component are
 899                                          * uncompressed
 900                                          */
 901         LCME_FL_NOCOMPR   = 0x00000400, /* the component should not be
 902                                          * compressed
 903                                          */
 904         LCME_FL_NEG       = 0x80000000  /* used to indicate a negative flag,
 905                                          * won't be stored on disk
 906                                          */
 907 };
 908
 909 #define LCME_KNOWN_FLAGS        (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
 910                                  LCME_FL_PREF_RW | LCME_FL_NOSYNC | \
 911                                  LCME_FL_EXTENSION)
 912
 913 /* The component flags can be set by users at creation/modification time. */
 914 #define LCME_USER_COMP_FLAGS    (LCME_FL_PREF_RW | LCME_FL_NOSYNC | \
 915                                  LCME_FL_EXTENSION)
 916
 917 /* The mirror flags can be set by users at creation time. */
 918 #define LCME_USER_MIRROR_FLAGS  (LCME_FL_PREF_RW)
 919
 920 /* The allowed flags obtained from the client at component creation time. */
 921 #define LCME_CL_COMP_FLAGS      (LCME_USER_MIRROR_FLAGS | LCME_FL_EXTENSION)
 922
 923 /* The mirror flags sent by client */
 924 #define LCME_MIRROR_FLAGS       (LCME_FL_NOSYNC)
 925
 926 /* These flags have meaning when set in a default layout and will be inherited
 927  * from the default/template layout set on a directory.
 928  */
 929 #define LCME_TEMPLATE_FLAGS     (LCME_FL_PREF_RW | LCME_FL_NOSYNC | \
 930                                  LCME_FL_EXTENSION)
 931
 932 /* lcme_id can be specified as certain flags, and the the first
 933  * bit of lcme_id is used to indicate that the ID is representing
 934  * certain LCME_FL_* but not a real ID. Which implies we can have
 935  * at most 31 flags (see LCME_FL_XXX). */
 936 enum lcme_id {
 937         LCME_ID_INVAL   = 0x0,
 938         LCME_ID_MAX     = 0x7FFFFFFF,
 939         LCME_ID_ALL     = 0xFFFFFFFF,
 940         LCME_ID_NOT_ID  = LCME_FL_NEG
 941 };
 942
 943 /* layout version equals to lcme_id, except some bits have special meanings */
 944 enum layout_version_flags {
 945         /* layout version reaches the high water mark to be increased to
 946          * circularly reuse the smallest value
 947          */
 948         LU_LAYOUT_HIGEN         = 0x40000000,
 949         /* the highest bit is used to mark if the file is being resynced */
 950         LU_LAYOUT_RESYNC        = 0x80000000,
 951 };
 952
 953 #define LCME_ID_MASK    LCME_ID_MAX
 954
 955 struct lov_comp_md_entry_v1 {
 956         __u32                   lcme_id;        /* unique id of component */
 957         __u32                   lcme_flags;     /* LCME_FL_XXX */
 958         /* file extent for component. If it's an EC code component, its flags
 959          * contains LCME_FL_PARITY, and its extent covers the same extent of
 960          * its corresponding data component.
 961          */
 962         struct lu_extent        lcme_extent;
 963         __u32                   lcme_offset;    /* offset of component blob,
 964                                                    start from lov_comp_md_v1 */
 965         __u32                   lcme_size;      /* size of component blob */
 966         __u32                   lcme_layout_gen;
 967         __u64                   lcme_timestamp; /* snapshot time if applicable*/
 968         __u8                    lcme_dstripe_count;     /* data stripe count,
 969                                                          * k value in EC
 970                                                          */
 971         __u8                    lcme_cstripe_count;     /* code stripe count,
 972                                                          * p value in EC
 973                                                          */
 974         __u8                    lcme_compr_type;        /* compress type */
 975         __u8                    lcme_compr_lvl:4;       /* compress level */
 976         __u8                    lcme_compr_chunk_log_bits:4;
 977                                      /* chunk_size = 2^(16+chunk_log_bits)
 978                                       * i.e. power-of-two multiple of 64KiB */
 979 } __attribute__((packed));
 980
 981 #define SEQ_ID_MAX              0x0000FFFF
 982 #define SEQ_ID_MASK             SEQ_ID_MAX
 983 /* bit 30:16 of lcme_id is used to store mirror id */
 984 #define MIRROR_ID_MASK          0x7FFF0000
 985 #define MIRROR_ID_NEG           0x8000
 986 #define MIRROR_ID_SHIFT         16
 987
 988 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
 989 {
 990         return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
 991 }
 992
 993 static inline __u16 mirror_id_of(__u32 id)
 994 {
 995         return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
 996 }
 997
 998 /**
 999  * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
1000  */
1001 enum lov_comp_md_flags {
1002         /* the least 4 bits are used by FLR to record file state */
1003         LCM_FL_NONE             = 0x0,
1004         LCM_FL_RDONLY           = 0x1,
1005         LCM_FL_WRITE_PENDING    = 0x2,
1006         LCM_FL_SYNC_PENDING     = 0x3,
1007         LCM_FL_PCC_RDONLY       = 0x8,
1008         LCM_FL_FLR_MASK         = 0xB,
1009 };
1010
1011 struct lov_comp_md_v1 {
1012         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
1013         __u32   lcm_size;       /* overall size including this struct */
1014         __u32   lcm_layout_gen;
1015         __u16   lcm_flags;
1016         __u16   lcm_entry_count;
1017         /* lcm_mirror_count stores the number of actual mirrors minus 1,
1018          * so that non-flr files will have value 0 meaning 1 mirror. */
1019         __u16   lcm_mirror_count;
1020         /* code components count, non-EC file contains 0 ec_count */
1021         __u8    lcm_ec_count;
1022         __u8    lcm_padding3[1];
1023         __u16   lcm_padding1[2];
1024         __u64   lcm_padding2;
1025         struct lov_comp_md_entry_v1 lcm_entries[0];
1026 } __attribute__((packed));
1027
1028 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
1029 {
1030         if (stripes == (__u16)-1)
1031                 stripes = 0;
1032
1033         if (lmm_magic == LOV_USER_MAGIC_V1)
1034                 return sizeof(struct lov_user_md_v1) +
1035                               stripes * sizeof(struct lov_user_ost_data_v1);
1036         return sizeof(struct lov_user_md_v3) +
1037                                 stripes * sizeof(struct lov_user_ost_data_v1);
1038 }
1039
1040 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
1041  * use this.  It is unsafe to #define those values in this header as it
1042  * is possible the application has already #included <sys/stat.h>. */
1043 #define lov_user_mds_data lov_user_mds_data_v2
1044 struct lov_user_mds_data_v1 {
1045         lstat_t lmd_st;                 /* MDS stat struct */
1046         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
1047 } __attribute__((packed));
1048
1049 struct lov_user_mds_data_v2 {
1050         struct lu_fid lmd_fid;          /* Lustre FID */
1051         lstatx_t lmd_stx;               /* MDS statx struct */
1052         __u64 lmd_flags;                /* MDS stat flags */
1053         __u32 lmd_lmmsize;              /* LOV EA size */
1054         __u32 lmd_padding;              /* unused */
1055         struct lov_user_md_v1 lmd_lmm;  /* LOV EA user data */
1056 } __attribute__((packed));
1057
1058 struct lmv_user_mds_data {
1059         struct lu_fid   lum_fid;
1060         __u32           lum_padding;
1061         __u32           lum_mds;
1062 } __attribute__((packed, __may_alias__));
1063
1064 enum lmv_hash_type {
1065         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
1066         LMV_HASH_TYPE_ALL_CHARS = 1,    /* simple sum of characters */
1067         LMV_HASH_TYPE_FNV_1A_64 = 2,    /* reasonable non-cryptographic hash */
1068         LMV_HASH_TYPE_CRUSH     = 3,    /* double-hash to optimize migration */
1069         LMV_HASH_TYPE_CRUSH2    = 4,    /* CRUSH with small fixes, LU-15692 */
1070         LMV_HASH_TYPE_MAX,
1071         LMV_HASH_TYPE_DEFAULT   = LMV_HASH_TYPE_FNV_1A_64
1072 };
1073
1074 static __attribute__((unused)) const char *mdt_hash_name[] = {
1075         "none",
1076         "all_char",
1077         "fnv_1a_64",
1078         "crush",
1079         "crush2",
1080 };
1081
1082
1083 /* Right now only the lower part(0-16bits) of lmv_hash_type is being used,
1084  * and the higher part will be the flag to indicate the status of object,
1085  * for example the object is being migrated. And the hash function
1086  * might be interpreted differently with different flags. */
1087 #define LMV_HASH_TYPE_MASK 0x0000ffff
1088
1089 static inline bool lmv_is_known_hash_type(__u32 type)
1090 {
1091         return (type & LMV_HASH_TYPE_MASK) > LMV_HASH_TYPE_UNKNOWN &&
1092                (type & LMV_HASH_TYPE_MASK) < LMV_HASH_TYPE_MAX;
1093 }
1094
1095 /* This flag indicates that overstriping (>1 stripe per MDT) is desired */
1096 #define LMV_HASH_FLAG_OVERSTRIPED       0x01000000
1097 /* fixed layout, such directories won't split automatically */
1098 /* NB, update LMV_HASH_FLAG_KNOWN when adding new flag */
1099 #define LMV_HASH_FLAG_FIXED             0x02000000
1100 #define LMV_HASH_FLAG_MERGE             0x04000000
1101 #define LMV_HASH_FLAG_SPLIT             0x08000000
1102
1103 /* The striped directory has ever lost its master LMV EA, then LFSCK
1104  * re-generated it. This flag is used to indicate such case. It is an
1105  * on-disk flag. */
1106 #define LMV_HASH_FLAG_LOST_LMV          0x10000000
1107
1108 #define LMV_HASH_FLAG_BAD_TYPE          0x20000000
1109 #define LMV_HASH_FLAG_MIGRATION         0x80000000
1110
1111 #define LMV_HASH_FLAG_LAYOUT_CHANGE     \
1112         (LMV_HASH_FLAG_MIGRATION | LMV_HASH_FLAG_SPLIT | LMV_HASH_FLAG_MERGE)
1113
1114 #define LMV_HASH_FLAG_KNOWN             0xbe000000
1115
1116 /* both SPLIT and MIGRATION are set for directory split */
1117 static inline bool lmv_hash_is_splitting(__u32 hash)
1118 {
1119         return (hash & LMV_HASH_FLAG_LAYOUT_CHANGE) ==
1120                (LMV_HASH_FLAG_SPLIT | LMV_HASH_FLAG_MIGRATION);
1121 }
1122
1123 /* both MERGE and MIGRATION are set for directory merge */
1124 static inline bool lmv_hash_is_merging(__u32 hash)
1125 {
1126         return (hash & LMV_HASH_FLAG_LAYOUT_CHANGE) ==
1127                (LMV_HASH_FLAG_MERGE | LMV_HASH_FLAG_MIGRATION);
1128 }
1129
1130 /* only MIGRATION is set for directory migration */
1131 static inline bool lmv_hash_is_migrating(__u32 hash)
1132 {
1133         return (hash & LMV_HASH_FLAG_LAYOUT_CHANGE) == LMV_HASH_FLAG_MIGRATION;
1134 }
1135
1136 static inline bool lmv_hash_is_restriping(__u32 hash)
1137 {
1138         return lmv_hash_is_splitting(hash) || lmv_hash_is_merging(hash);
1139 }
1140
1141 static inline bool lmv_hash_is_layout_changing(__u32 hash)
1142 {
1143         return lmv_hash_is_splitting(hash) || lmv_hash_is_merging(hash) ||
1144                lmv_hash_is_migrating(hash);
1145 }
1146
1147 struct lustre_foreign_type {
1148         __u32           lft_type;
1149         const char      *lft_name;
1150 };
1151
1152 /**
1153  * LOV/LMV foreign types
1154  **/
1155 enum lustre_foreign_types {
1156         LU_FOREIGN_TYPE_NONE = 0,
1157         /* HSM copytool lhsm_posix */
1158         LU_FOREIGN_TYPE_POSIX   = 1,
1159         /* Used for PCC-RW. PCCRW components are local to a single archive. */
1160         LU_FOREIGN_TYPE_PCCRW   = 2,
1161         /* Used for PCC-RO. PCCRO components may be shared between archives. */
1162         LU_FOREIGN_TYPE_PCCRO   = 3,
1163         /* Used for S3 */
1164         LU_FOREIGN_TYPE_S3      = 4,
1165         /* Used for DAOS */
1166         LU_FOREIGN_TYPE_SYMLINK = 0xda05,
1167         /* must be the max/last one */
1168         LU_FOREIGN_TYPE_UNKNOWN = 0xffffffff,
1169 };
1170
1171 extern struct lustre_foreign_type lu_foreign_types[];
1172
1173 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
1174  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
1175 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
1176 #define lmv_user_md lmv_user_md_v1
1177 struct lmv_user_md_v1 {
1178         __u32   lum_magic;         /* must be the first field */
1179         __u32   lum_stripe_count;  /* dirstripe count */
1180         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
1181         __u32   lum_hash_type;     /* Dir stripe policy */
1182         __u32   lum_type;          /* LMV type: default */
1183         __u8    lum_max_inherit;   /* inherit depth of default LMV */
1184         __u8    lum_max_inherit_rr;     /* inherit depth of default LMV to round-robin mkdir */
1185         __u16   lum_padding1;
1186         __u32   lum_padding2;
1187         __u32   lum_padding3;
1188         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
1189         struct  lmv_user_mds_data  lum_objects[0];
1190 } __attribute__((packed));
1191
1192 static inline __u32 lmv_foreign_to_md_stripes(__u32 size)
1193 {
1194         if (size <= sizeof(struct lmv_user_md))
1195                 return 0;
1196
1197         size -= sizeof(struct lmv_user_md);
1198         return (size + sizeof(struct lmv_user_mds_data) - 1) /
1199                sizeof(struct lmv_user_mds_data);
1200 }
1201
1202 /*
1203  * NB, historically default layout didn't set type, but use XATTR name to differ
1204  * from normal layout, for backward compatibility, define LMV_TYPE_DEFAULT 0x0,
1205  * and still use the same method.
1206  */
1207 enum lmv_type {
1208         LMV_TYPE_DEFAULT = 0x0000,
1209 };
1210
1211 /* lum_max_inherit will be decreased by 1 after each inheritance if it's not
1212  * LMV_INHERIT_UNLIMITED or > LMV_INHERIT_MAX.
1213  */
1214 enum {
1215         /* for historical reason, 0 means unlimited inheritance */
1216         LMV_INHERIT_UNLIMITED           = 0,
1217         /* unlimited lum_max_inherit by default for plain stripe (0 or 1) */
1218         LMV_INHERIT_DEFAULT_PLAIN       = LMV_INHERIT_UNLIMITED,
1219         /* not inherit any more */
1220         LMV_INHERIT_END                 = 1,
1221         /* for multiple stripes, the default lum_max_inherit is 3 */
1222         LMV_INHERIT_DEFAULT_STRIPED     = 3,
1223         /* max inherit depth */
1224         LMV_INHERIT_MAX                 = 250,
1225         /* [251, 254] are reserved */
1226         /* not set, or when inherit depth goes beyond end,  */
1227         LMV_INHERIT_NONE                = 255,
1228 };
1229
1230 enum {
1231         /* not set, or when inherit_rr depth goes beyond end,  */
1232         LMV_INHERIT_RR_NONE             = 0,
1233         /* disable lum_max_inherit_rr by default */
1234         LMV_INHERIT_RR_DEFAULT          = LMV_INHERIT_RR_NONE,
1235         /* not inherit any more */
1236         LMV_INHERIT_RR_END              = 1,
1237         /* default inherit_rr of ROOT */
1238         LMV_INHERIT_RR_ROOT             = 3,
1239         /* max inherit depth */
1240         LMV_INHERIT_RR_MAX              = 250,
1241         /* [251, 254] are reserved */
1242         /* unlimited inheritance */
1243         LMV_INHERIT_RR_UNLIMITED        = 255,
1244 };
1245
1246 static inline int lmv_user_md_size(int stripes, int lmm_magic)
1247 {
1248         int size = sizeof(struct lmv_user_md);
1249
1250         if (lmm_magic == LMV_USER_MAGIC_SPECIFIC)
1251                 size += stripes * sizeof(struct lmv_user_mds_data);
1252
1253         return size;
1254 }
1255
1256 struct ll_recreate_obj {
1257         __u64 lrc_id;
1258         __u32 lrc_ost_idx;
1259 };
1260
1261 struct ll_fid {
1262         __u64 id;         /* holds object id */
1263         __u32 generation; /* holds object generation */
1264         __u32 f_type;     /* holds object type or stripe idx when passing it to
1265                            * OST for saving into EA. */
1266 };
1267
1268 #define UUID_MAX        40
1269 struct obd_uuid {
1270         char uuid[UUID_MAX];
1271 };
1272
1273 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
1274                                    const struct obd_uuid *u2)
1275 {
1276         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
1277 }
1278
1279 static inline int obd_uuid_empty(struct obd_uuid *uuid)
1280 {
1281         return uuid->uuid[0] == '\0';
1282 }
1283
1284 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
1285 {
1286         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
1287         uuid->uuid[sizeof(*uuid) - 1] = '\0';
1288 }
1289
1290 /* For printf's only, make sure uuid is terminated */
1291 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
1292 {
1293         if (uuid == NULL)
1294                 return NULL;
1295
1296         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
1297                 /* Obviously not safe, but for printfs, no real harm done...
1298                    we're always null-terminated, even in a race. */
1299                 static char temp[sizeof(*uuid->uuid)];
1300
1301                 memcpy(temp, uuid->uuid, sizeof(*uuid->uuid) - 1);
1302                 temp[sizeof(*uuid->uuid) - 1] = '\0';
1303
1304                 return temp;
1305         }
1306         return (char *)(uuid->uuid);
1307 }
1308
1309 #define LUSTRE_MAXFSNAME 8
1310 #define LUSTRE_MAXINSTANCE 16
1311
1312 /* Extract fsname from uuid (or target name) of a target
1313    e.g. (myfs-OST0007_UUID -> myfs)
1314    see also deuuidify. */
1315 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
1316 {
1317         char *p;
1318
1319         strncpy(buf, uuid, buflen - 1);
1320         buf[buflen - 1] = '\0';
1321         p = strrchr(buf, '-');
1322         if (p != NULL)
1323                 *p = '\0';
1324 }
1325
1326 /* printf display format for Lustre FIDs
1327  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
1328 #define FID_NOBRACE_LEN 40
1329 #define FID_LEN (FID_NOBRACE_LEN + 2)
1330 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
1331 #define DFID "[" DFID_NOBRACE "]"
1332 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
1333
1334 /* scanf input parse format for fids in DFID_NOBRACE format
1335  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
1336  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
1337 #define SFID "0x%llx:0x%x:0x%x"
1338 #define RFID(fid) (unsigned long long *)&((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
1339 #define PLOGID(logid) (unsigned long long)(logid)->lgl_oi.oi.oi_seq, (__u32)(logid)->lgl_oi.oi.oi_id, 0
1340
1341 /********* Quotas **********/
1342
1343 /* From linux/fs/quota/quota.c */
1344 static inline __u64 toqb(__kernel_size_t space)
1345 {
1346         return (space + QIF_DQBLKSIZE - 1) >> QIF_DQBLKSIZE_BITS;
1347 }
1348
1349 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
1350 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
1351 #define Q_GETOINFO      0x800102 /* get obd quota info */
1352 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
1353 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
1354
1355 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
1356 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
1357 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
1358 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
1359 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
1360 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
1361 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
1362 /* lustre-specific control commands */
1363 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
1364 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
1365 #define LUSTRE_Q_GETDEFAULT  0x80000d     /* get default quota */
1366 #define LUSTRE_Q_SETDEFAULT  0x80000e     /* set default quota */
1367 #define LUSTRE_Q_GETQUOTAPOOL   0x80000f  /* get user pool quota */
1368 #define LUSTRE_Q_SETQUOTAPOOL   0x800010  /* set user pool quota */
1369 #define LUSTRE_Q_GETINFOPOOL    0x800011  /* get pool quota info */
1370 #define LUSTRE_Q_SETINFOPOOL    0x800012  /* set pool quota info */
1371 #define LUSTRE_Q_GETDEFAULT_POOL        0x800013  /* get default pool quota*/
1372 #define LUSTRE_Q_SETDEFAULT_POOL        0x800014  /* set default pool quota */
1373 #define LUSTRE_Q_DELETEQID      0x800015  /* delete quota ID */
1374 #define LUSTRE_Q_RESETQID       0x800016  /* reset quota ID */
1375 /* In the current Lustre implementation, the grace time is either the time
1376  * or the timestamp to be used after some quota ID exceeds the soft limt,
1377  * 48 bits should be enough, its high 16 bits can be used as quota flags.
1378  * */
1379 #define LQUOTA_GRACE_BITS       48
1380 #define LQUOTA_GRACE_MASK       ((1ULL << LQUOTA_GRACE_BITS) - 1)
1381 #define LQUOTA_GRACE_MAX        LQUOTA_GRACE_MASK
1382 #define LQUOTA_GRACE(t)         (t & LQUOTA_GRACE_MASK)
1383 #define LQUOTA_FLAG(t)          (t >> LQUOTA_GRACE_BITS)
1384 #define LQUOTA_GRACE_FLAG(t, f) ((__u64)t | (__u64)f << LQUOTA_GRACE_BITS)
1385
1386 /* special grace time, only notify the user when its quota is over soft limit
1387  * but doesn't block new writes until the hard limit is reached. */
1388 #define NOTIFY_GRACE            "notify"
1389 #define NOTIFY_GRACE_TIME       LQUOTA_GRACE_MASK
1390
1391 /* different quota flags */
1392
1393 /* the default quota flag, the corresponding quota ID will use the default
1394  * quota setting, the hardlimit and softlimit of its quota record in the global
1395  * quota file will be set to 0, the low 48 bits of the grace will be set to 0
1396  * and high 16 bits will contain this flag (see above comment).
1397  * */
1398 #define LQUOTA_FLAG_DEFAULT     0x0001
1399 #define LQUOTA_FLAG_DELETED     0x0002
1400 #define LQUOTA_FLAG_RESET       0x0004
1401
1402 #define LUSTRE_Q_CMD_IS_POOL(cmd)               \
1403         (cmd == LUSTRE_Q_GETQUOTAPOOL ||        \
1404          cmd == LUSTRE_Q_SETQUOTAPOOL ||        \
1405          cmd == LUSTRE_Q_SETINFOPOOL ||         \
1406          cmd == LUSTRE_Q_GETINFOPOOL ||         \
1407          cmd == LUSTRE_Q_SETDEFAULT_POOL ||     \
1408          cmd == LUSTRE_Q_GETDEFAULT_POOL)
1409
1410 #define ALLQUOTA 255       /* set all quota */
1411 static inline const char *qtype_name(int qtype)
1412 {
1413         switch (qtype) {
1414         case USRQUOTA:
1415                 return "usr";
1416         case GRPQUOTA:
1417                 return "grp";
1418         case PRJQUOTA:
1419                 return "prj";
1420         }
1421         return "unknown";
1422 }
1423
1424 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
1425
1426 /* permission */
1427 #define N_PERMS_MAX      64
1428
1429 struct perm_downcall_data {
1430         __u64 pdd_nid;
1431         __u32 pdd_perm;
1432         __u32 pdd_padding;
1433 };
1434
1435 struct identity_downcall_data {
1436         __u32                            idd_magic;
1437         __u32                            idd_err;
1438         __u32                            idd_uid;
1439         __u32                            idd_gid;
1440         __u32                            idd_nperms;
1441         __u32                            idd_ngroups;
1442         struct perm_downcall_data idd_perms[N_PERMS_MAX];
1443         __u32                            idd_groups[0];
1444 };
1445
1446 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 16, 53, 0)
1447 /* old interface struct is deprecated in 2.14 */
1448 #define SEPOL_DOWNCALL_MAGIC_OLD 0x8b8bb842
1449 struct sepol_downcall_data_old {
1450         __u32           sdd_magic;
1451         __s64           sdd_sepol_mtime;
1452         __u16           sdd_sepol_len;
1453         char            sdd_sepol[0];
1454 };
1455 #endif
1456
1457 #define SEPOL_DOWNCALL_MAGIC 0x8b8bb843
1458 struct sepol_downcall_data {
1459         __u32           sdd_magic;
1460         __u16           sdd_sepol_len;
1461         __u16           sdd_padding1;
1462         __s64           sdd_sepol_mtime;
1463         char            sdd_sepol[0];
1464 };
1465
1466 #ifdef NEED_QUOTA_DEFS
1467 #ifndef QIF_BLIMITS
1468 #define QIF_BLIMITS     1
1469 #define QIF_SPACE       2
1470 #define QIF_ILIMITS     4
1471 #define QIF_INODES      8
1472 #define QIF_BTIME       16
1473 #define QIF_ITIME       32
1474 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
1475 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
1476 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
1477 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
1478 #endif
1479
1480 #endif /* !__KERNEL__ */
1481
1482 /* lustre volatile file support
1483  * file name header: ".^L^S^T^R:volatile"
1484  */
1485 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
1486 #define LUSTRE_VOLATILE_HDR_LEN 14
1487
1488 enum lustre_quota_version {
1489         LUSTRE_QUOTA_V2 = 1
1490 };
1491
1492 /* XXX: same as if_dqinfo struct in kernel */
1493 struct obd_dqinfo {
1494         __u64 dqi_bgrace;
1495         __u64 dqi_igrace;
1496         __u32 dqi_flags;
1497         __u32 dqi_valid;
1498 };
1499
1500 /* XXX: same as if_dqblk struct in kernel, plus one padding */
1501 struct obd_dqblk {
1502         __u64 dqb_bhardlimit;   /* kbytes unit */
1503         __u64 dqb_bsoftlimit;   /* kbytes unit */
1504         __u64 dqb_curspace;     /* bytes unit */
1505         __u64 dqb_ihardlimit;
1506         __u64 dqb_isoftlimit;
1507         __u64 dqb_curinodes;
1508         __u64 dqb_btime;
1509         __u64 dqb_itime;
1510         __u32 dqb_valid;
1511         __u32 dqb_padding;
1512 };
1513
1514 enum {
1515         QC_GENERAL      = 0,
1516         QC_MDTIDX       = 1,
1517         QC_OSTIDX       = 2,
1518         QC_UUID         = 3
1519 };
1520
1521 struct if_quotactl {
1522         __u32                   qc_cmd;
1523         __u32                   qc_type;
1524         __u32                   qc_id;
1525         __u32                   qc_stat;
1526         __u32                   qc_valid;
1527         __u32                   qc_idx;
1528         struct obd_dqinfo       qc_dqinfo;
1529         struct obd_dqblk        qc_dqblk;
1530         char                    obd_type[16];
1531         struct obd_uuid         obd_uuid;
1532         char                    qc_poolname[];
1533 };
1534
1535 /* swap layout flags */
1536 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
1537 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
1538 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
1539 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
1540 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
1541
1542 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
1543 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
1544 struct lustre_swap_layouts {
1545         __u64   sl_flags;
1546         __u32   sl_fd;
1547         __u32   sl_gid;
1548         __u64   sl_dv1;
1549         __u64   sl_dv2;
1550 };
1551
1552 /** Bit-mask of valid attributes */
1553 /* The LA_* flags are written to disk as part of the ChangeLog records
1554  * so they are part of the on-disk and network protocol, and cannot be changed.
1555  * Only the first 12 bits are currently saved.
1556  */
1557 enum la_valid {
1558         LA_ATIME        = 1 << 0,       /* 0x00001 */
1559         LA_MTIME        = 1 << 1,       /* 0x00002 */
1560         LA_CTIME        = 1 << 2,       /* 0x00004 */
1561         LA_SIZE         = 1 << 3,       /* 0x00008 */
1562         LA_MODE         = 1 << 4,       /* 0x00010 */
1563         LA_UID          = 1 << 5,       /* 0x00020 */
1564         LA_GID          = 1 << 6,       /* 0x00040 */
1565         LA_BLOCKS       = 1 << 7,       /* 0x00080 */
1566         LA_TYPE         = 1 << 8,       /* 0x00100 */
1567         LA_FLAGS        = 1 << 9,       /* 0x00200 */
1568         LA_NLINK        = 1 << 10,      /* 0x00400 */
1569         LA_RDEV         = 1 << 11,      /* 0x00800 */
1570         LA_BLKSIZE      = 1 << 12,      /* 0x01000 */
1571         LA_KILL_SUID    = 1 << 13,      /* 0x02000 */
1572         LA_KILL_SGID    = 1 << 14,      /* 0x04000 */
1573         LA_PROJID       = 1 << 15,      /* 0x08000 */
1574         LA_LAYOUT_VERSION = 1 << 16,    /* 0x10000 */
1575         LA_LSIZE        = 1 << 17,      /* 0x20000 */
1576         LA_LBLOCKS      = 1 << 18,      /* 0x40000 */
1577         LA_BTIME        = 1 << 19,      /* 0x80000 */
1578         /**
1579          * Attributes must be transmitted to OST objects
1580          */
1581         LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
1582 };
1583
1584 #define MDS_FMODE_READ           00000001
1585 #define MDS_FMODE_WRITE          00000002
1586
1587 #define MDS_FMODE_CLOSED         00000000
1588 #define MDS_FMODE_EXEC           00000004
1589 /*      MDS_FMODE_EPOCH          01000000 obsolete since 2.8.0 */
1590 /*      MDS_FMODE_TRUNC          02000000 obsolete since 2.8.0 */
1591 /*      MDS_FMODE_SOM            04000000 obsolete since 2.8.0 */
1592
1593 #define MDS_OPEN_CREATED         00000010
1594 /*      MDS_OPEN_CROSS           00000020 obsolete in 2.12, internal use only */
1595
1596 #define MDS_OPEN_CREAT           00000100
1597 #define MDS_OPEN_EXCL            00000200
1598 #define MDS_OPEN_TRUNC           00001000
1599 #define MDS_OPEN_APPEND          00002000
1600 #define MDS_OPEN_SYNC            00010000
1601 #define MDS_OPEN_DIRECTORY       00200000
1602
1603 #define MDS_OPEN_BY_FID         040000000 /* open_by_fid for known object */
1604 #define MDS_OPEN_DELAY_CREATE  0100000000 /* delay initial object create */
1605 #define MDS_OPEN_OWNEROVERRIDE 0200000000 /* NFSD rw-reopen ro file for owner */
1606 #define MDS_OPEN_JOIN_FILE     0400000000 /* open for join file.
1607                                            * We do not support JOIN FILE
1608                                            * anymore, reserve this flags
1609                                            * just for preventing such bit
1610                                            * to be reused. */
1611
1612 #define MDS_OPEN_LOCK         04000000000 /* This open requires open lock */
1613 #define MDS_OPEN_HAS_EA      010000000000 /* specify object create pattern */
1614 #define MDS_OPEN_HAS_OBJS    020000000000 /* Just set the EA the obj exist */
1615 #define MDS_OPEN_NORESTORE  0100000000000ULL /* Do not restore file at open */
1616 #define MDS_OPEN_NEWSTRIPE  0200000000000ULL /* New stripe needed (restripe or
1617                                               * hsm restore) */
1618 #define MDS_OPEN_VOLATILE   0400000000000ULL /* File is volatile = created
1619                                                 unlinked */
1620 #define MDS_OPEN_LEASE     01000000000000ULL /* Open the file and grant lease
1621                                               * delegation, succeed if it's not
1622                                               * being opened with conflict mode.
1623                                               */
1624 #define MDS_OPEN_RELEASE   02000000000000ULL /* Open the file for HSM release */
1625
1626 #define MDS_OPEN_RESYNC    04000000000000ULL /* FLR: file resync */
1627 #define MDS_OPEN_PCC      010000000000000ULL /* PCC: auto RW-PCC cache attach
1628                                               * for newly created file */
1629 #define MDS_OP_WITH_FID   020000000000000ULL /* operation carried out by FID */
1630 #define MDS_OPEN_DEFAULT_LMV  040000000000000ULL /* open fetches default LMV */
1631
1632 /* lustre internal open flags, which should not be set from user space */
1633 #define MDS_OPEN_FL_INTERNAL (MDS_OPEN_HAS_EA | MDS_OPEN_HAS_OBJS |     \
1634                               MDS_OPEN_OWNEROVERRIDE | MDS_OPEN_LOCK |  \
1635                               MDS_OPEN_BY_FID | MDS_OPEN_LEASE |        \
1636                               MDS_OPEN_RELEASE | MDS_OPEN_RESYNC |      \
1637                               MDS_OPEN_PCC | MDS_OP_WITH_FID |          \
1638                               MDS_OPEN_DEFAULT_LMV)
1639
1640
1641 /********* Changelogs **********/
1642 /** Changelog record types */
1643 enum changelog_rec_type {
1644         CL_NONE     = -1,
1645         CL_MARK     = 0,
1646         CL_CREATE   = 1,  /* namespace */
1647         CL_MKDIR    = 2,  /* namespace */
1648         CL_HARDLINK = 3,  /* namespace */
1649         CL_SOFTLINK = 4,  /* namespace */
1650         CL_MKNOD    = 5,  /* namespace */
1651         CL_UNLINK   = 6,  /* namespace */
1652         CL_RMDIR    = 7,  /* namespace */
1653         CL_RENAME   = 8,  /* namespace */
1654         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
1655         CL_OPEN     = 10, /* not currently used */
1656         CL_CLOSE    = 11, /* may be written to log only with mtime change */
1657         CL_LAYOUT   = 12, /* file layout/striping modified */
1658         CL_TRUNC    = 13,
1659         CL_SETATTR  = 14,
1660         CL_SETXATTR = 15,
1661         CL_XATTR    = CL_SETXATTR, /* Deprecated name */
1662         CL_HSM      = 16, /* HSM specific events, see flags */
1663         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
1664         CL_CTIME    = 18,
1665         CL_ATIME    = 19,
1666         CL_MIGRATE  = 20,
1667         CL_FLRW     = 21, /* FLR: file was firstly written */
1668         CL_RESYNC   = 22, /* FLR: file was resync-ed */
1669         CL_GETXATTR = 23,
1670         CL_DN_OPEN  = 24, /* denied open */
1671         CL_LAST,
1672 };
1673
1674 static inline const char *changelog_type2str(int type) {
1675         static const char *const changelog_str[] = {
1676                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1677                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
1678                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT",
1679                 "FLRW",  "RESYNC","GXATR", "NOPEN",
1680         };
1681
1682         if (type >= 0 && type < CL_LAST)
1683                 return changelog_str[type];
1684         return NULL;
1685 }
1686
1687 /* 12 bits of per-record data can be stored in the bottom of the flags */
1688 #define CLF_FLAGSHIFT   12
1689 enum changelog_rec_flags {
1690         CLF_VERSION     = 0x1000,
1691         CLF_RENAME      = 0x2000,
1692         CLF_JOBID       = 0x4000,
1693         CLF_EXTRA_FLAGS = 0x8000,
1694         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID |
1695                           CLF_EXTRA_FLAGS,
1696         CLF_FLAGMASK    = (1U << CLF_FLAGSHIFT) - 1,
1697         CLF_VERMASK     = ~CLF_FLAGMASK,
1698 };
1699
1700
1701 /* Anything under the flagmask may be per-type (if desired) */
1702 /* Flags for unlink */
1703 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
1704 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1705                                      /* HSM cleaning needed */
1706 /* Flags for rename */
1707 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
1708                                         * of target */
1709 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
1710                                         * has an archive in backend */
1711
1712 /* Flags for HSM */
1713 /* 12b used (from high weight to low weight):
1714  * 2b for flags
1715  * 3b for event
1716  * 7b for error code
1717  */
1718 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
1719 #define CLF_HSM_ERR_H        6
1720 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
1721 #define CLF_HSM_EVENT_H      9
1722 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
1723 #define CLF_HSM_FLAG_H      11
1724 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
1725 #define CLF_HSM_SPARE_H     15
1726 #define CLF_HSM_LAST        15
1727
1728 /* Remove bits higher than _h, then extract the value
1729  * between _h and _l by shifting lower weigth to bit 0. */
1730 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1731                                    >> (CLF_HSM_LAST - _h + _l))
1732
1733 #define CLF_HSM_SUCCESS      0x00
1734 #define CLF_HSM_MAXERROR     0x7E
1735 #define CLF_HSM_ERROVERFLOW  0x7F
1736
1737 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
1738
1739 /* 3 bits field => 8 values allowed */
1740 enum hsm_event {
1741         HE_ARCHIVE      = 0,
1742         HE_RESTORE      = 1,
1743         HE_CANCEL       = 2,
1744         HE_RELEASE      = 3,
1745         HE_REMOVE       = 4,
1746         HE_STATE        = 5,
1747         HE_SPARE1       = 6,
1748         HE_SPARE2       = 7,
1749 };
1750
1751 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1752 {
1753         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1754                                             CLF_HSM_EVENT_L);
1755 }
1756
1757 static inline void hsm_set_cl_event(enum changelog_rec_flags *clf_flags,
1758                                     enum hsm_event he)
1759 {
1760         *clf_flags = (enum changelog_rec_flags)
1761                 (*clf_flags | (he << CLF_HSM_EVENT_L));
1762 }
1763
1764 static inline __u16 hsm_get_cl_flags(enum changelog_rec_flags clf_flags)
1765 {
1766         return CLF_GET_BITS(clf_flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1767 }
1768
1769 static inline void hsm_set_cl_flags(enum changelog_rec_flags *clf_flags,
1770                                     unsigned int bits)
1771 {
1772         *clf_flags = (enum changelog_rec_flags)
1773                 (*clf_flags | (bits << CLF_HSM_FLAG_L));
1774 }
1775
1776 static inline int hsm_get_cl_error(enum changelog_rec_flags clf_flags)
1777 {
1778         return CLF_GET_BITS(clf_flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1779 }
1780
1781 static inline int hsm_set_cl_error(enum changelog_rec_flags *clf_flags,
1782                                    int error)
1783 {
1784         /* In case a negative error is given */
1785         error = abs(error);
1786
1787         if (error > CLF_HSM_MAXERROR)
1788                 error = CLF_HSM_ERROVERFLOW;
1789
1790         *clf_flags = (enum changelog_rec_flags)
1791                 (*clf_flags | (error << CLF_HSM_ERR_L));
1792
1793         return error == CLF_HSM_ERROVERFLOW ? -EOVERFLOW : 0;
1794 }
1795
1796 enum changelog_rec_extra_flags {
1797         CLFE_INVALID    = 0,
1798         CLFE_UIDGID     = 0x0001,
1799         CLFE_NID        = 0x0002,
1800         CLFE_OPEN       = 0x0004,
1801         CLFE_XATTR      = 0x0008,
1802         CLFE_SUPPORTED  = CLFE_UIDGID | CLFE_NID | CLFE_OPEN | CLFE_XATTR
1803 };
1804
1805 enum changelog_send_flag {
1806         /* Use changelog follow mode: llapi_changelog_recv() will not stop at
1807          * the end of records and wait for new records to be generated.
1808          */
1809         CHANGELOG_FLAG_FOLLOW      = 0x01,
1810         /* Deprecated since Lustre 2.10 */
1811         CHANGELOG_FLAG_BLOCK       = 0x02,
1812         /* Pack jobid into the changelog records if available. */
1813         CHANGELOG_FLAG_JOBID       = 0x04,
1814         /* Pack additional flag bits into the changelog record */
1815         CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1816 };
1817
1818 enum changelog_send_extra_flag {
1819         /* Pack uid/gid into the changelog record */
1820         CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1821         /* Pack nid into the changelog record */
1822         CHANGELOG_EXTRA_FLAG_NID    = 0x02,
1823         /* Pack open mode into the changelog record */
1824         CHANGELOG_EXTRA_FLAG_OMODE  = 0x04,
1825         /* Pack xattr name into the changelog record */
1826         CHANGELOG_EXTRA_FLAG_XATTR  = 0x08,
1827 };
1828
1829 #define CR_MAXSIZE __ALIGN_KERNEL(2 * NAME_MAX + 2 + \
1830                                   changelog_rec_offset(CLF_SUPPORTED, \
1831                                                        CLFE_SUPPORTED), 8)
1832
1833 /* 31 usable bytes string + null terminator. */
1834 #define LUSTRE_JOBID_SIZE       32
1835
1836 /* This is the minimal changelog record. It can contain extensions
1837  * such as rename fields or process jobid. Its exact content is described
1838  * by the cr_flags and cr_extra_flags.
1839  *
1840  * Extensions are packed in the same order as their corresponding flags,
1841  * then in the same order as their corresponding extra flags.
1842  */
1843 struct changelog_rec {
1844         __u16                   cr_namelen;
1845         __u16                   cr_flags; /**< \a changelog_rec_flags */
1846         __u32                   cr_type;  /**< \a changelog_rec_type */
1847         __u64                   cr_index; /**< changelog record number */
1848         __u64                   cr_prev;  /**< last index for this target fid */
1849         __u64                   cr_time;
1850         union {
1851                 struct lu_fid   cr_tfid;        /**< target fid */
1852                 __u32           cr_markerflags; /**< CL_MARK flags */
1853         };
1854         struct lu_fid           cr_pfid;        /**< parent fid */
1855 } __attribute__ ((packed));
1856
1857 /* Changelog extension for RENAME. */
1858 struct changelog_ext_rename {
1859         struct lu_fid           cr_sfid;     /**< source fid, or zero */
1860         struct lu_fid           cr_spfid;    /**< source parent fid, or zero */
1861 };
1862
1863 /* Changelog extension to include JOBID. */
1864 struct changelog_ext_jobid {
1865         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
1866 };
1867
1868 /* Changelog extension to include additional flags. */
1869 struct changelog_ext_extra_flags {
1870         __u64 cr_extra_flags; /* Additional CLFE_* flags */
1871 };
1872
1873 /* Changelog extra extension to include UID/GID. */
1874 struct changelog_ext_uidgid {
1875         __u64   cr_uid;
1876         __u64   cr_gid;
1877 };
1878
1879 /* Changelog extra extension to include NID. */
1880 struct changelog_ext_nid {
1881         /* have __u64 instead of lnet_nid_t type for use by client api */
1882         __u64 cr_nid;
1883         /* for use when IPv6 support is added */
1884         __u64 extra;
1885         __u32 padding;
1886 };
1887
1888 /* Changelog extra extension to include low 32 bits of MDS_OPEN_* flags. */
1889 struct changelog_ext_openmode {
1890         __u32 cr_openflags;
1891 };
1892
1893 /* Changelog extra extension to include xattr */
1894 struct changelog_ext_xattr {
1895         char cr_xattr[XATTR_NAME_MAX + 1]; /**< zero-terminated string. */
1896 };
1897
1898 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1899         const struct changelog_rec *rec);
1900
1901 static inline __kernel_size_t changelog_rec_offset(enum changelog_rec_flags crf,
1902                                           enum changelog_rec_extra_flags cref)
1903 {
1904         __kernel_size_t size = sizeof(struct changelog_rec);
1905
1906         if (crf & CLF_RENAME)
1907                 size += sizeof(struct changelog_ext_rename);
1908
1909         if (crf & CLF_JOBID)
1910                 size += sizeof(struct changelog_ext_jobid);
1911
1912         if (crf & CLF_EXTRA_FLAGS) {
1913                 size += sizeof(struct changelog_ext_extra_flags);
1914                 if (cref & CLFE_UIDGID)
1915                         size += sizeof(struct changelog_ext_uidgid);
1916                 if (cref & CLFE_NID)
1917                         size += sizeof(struct changelog_ext_nid);
1918                 if (cref & CLFE_OPEN)
1919                         size += sizeof(struct changelog_ext_openmode);
1920                 if (cref & CLFE_XATTR)
1921                         size += sizeof(struct changelog_ext_xattr);
1922         }
1923
1924         return size;
1925 }
1926
1927 static inline __kernel_size_t changelog_rec_size(const struct changelog_rec *rec)
1928 {
1929         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1930
1931         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1932                 cref = (enum changelog_rec_extra_flags)
1933                          changelog_rec_extra_flags(rec)->cr_extra_flags;
1934
1935         return changelog_rec_offset(
1936                 (enum changelog_rec_flags)rec->cr_flags, cref);
1937 }
1938
1939 static inline __kernel_size_t changelog_rec_varsize(const struct changelog_rec *rec)
1940 {
1941         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1942 }
1943
1944 static inline
1945 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1946 {
1947         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1948                 (rec->cr_flags & CLF_VERSION);
1949
1950         return (struct changelog_ext_rename *)((char *)rec +
1951                                                changelog_rec_offset(crf,
1952                                                                  CLFE_INVALID));
1953 }
1954
1955 /* The jobid follows the rename extension, if present */
1956 static inline
1957 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1958 {
1959         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1960                                 (rec->cr_flags & (CLF_VERSION | CLF_RENAME));
1961
1962         return (struct changelog_ext_jobid *)((char *)rec +
1963                                               changelog_rec_offset(crf,
1964                                                                  CLFE_INVALID));
1965 }
1966
1967 /* The additional flags follow the rename and jobid extensions, if present */
1968 static inline
1969 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1970         const struct changelog_rec *rec)
1971 {
1972         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1973             (rec->cr_flags & (CLF_VERSION | CLF_RENAME | CLF_JOBID));
1974
1975         return (struct changelog_ext_extra_flags *)((char *)rec +
1976                                                  changelog_rec_offset(crf,
1977                                                                  CLFE_INVALID));
1978 }
1979
1980 /* The uid/gid is the first extra extension */
1981 static inline
1982 struct changelog_ext_uidgid *changelog_rec_uidgid(
1983         const struct changelog_rec *rec)
1984 {
1985         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1986             (rec->cr_flags &
1987                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
1988
1989         return (struct changelog_ext_uidgid *)((char *)rec +
1990                                                changelog_rec_offset(crf,
1991                                                                  CLFE_INVALID));
1992 }
1993
1994 /* The nid is the second extra extension */
1995 static inline
1996 struct changelog_ext_nid *changelog_rec_nid(const struct changelog_rec *rec)
1997 {
1998         enum changelog_rec_flags crf = (enum changelog_rec_flags)
1999             (rec->cr_flags &
2000              (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
2001         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2002
2003         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2004                 cref = (enum changelog_rec_extra_flags)
2005                         (changelog_rec_extra_flags(rec)->cr_extra_flags &
2006                          CLFE_UIDGID);
2007
2008         return (struct changelog_ext_nid *)((char *)rec +
2009                                             changelog_rec_offset(crf, cref));
2010 }
2011
2012 /* The OPEN mode is the third extra extension */
2013 static inline
2014 struct changelog_ext_openmode *changelog_rec_openmode(
2015         const struct changelog_rec *rec)
2016 {
2017         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2018                 (rec->cr_flags &
2019                  (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
2020         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2021
2022         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
2023                 cref = (enum changelog_rec_extra_flags)
2024                         (changelog_rec_extra_flags(rec)->cr_extra_flags &
2025                          (CLFE_UIDGID | CLFE_NID));
2026         }
2027
2028         return (struct changelog_ext_openmode *)((char *)rec +
2029                                                changelog_rec_offset(crf, cref));
2030 }
2031
2032 /* The xattr name is the fourth extra extension */
2033 static inline
2034 struct changelog_ext_xattr *changelog_rec_xattr(
2035         const struct changelog_rec *rec)
2036 {
2037         enum changelog_rec_flags crf = (enum changelog_rec_flags)
2038             (rec->cr_flags &
2039              (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS));
2040         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2041
2042         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2043                 cref = (enum changelog_rec_extra_flags)
2044                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
2045                         (CLFE_UIDGID | CLFE_NID | CLFE_OPEN));
2046
2047         return (struct changelog_ext_xattr *)((char *)rec +
2048                                               changelog_rec_offset(crf, cref));
2049 }
2050
2051 /* The name follows the rename, jobid  and extra flags extns, if present */
2052 static inline char *changelog_rec_name(const struct changelog_rec *rec)
2053 {
2054         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2055
2056         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2057                 cref = (enum changelog_rec_extra_flags)
2058                     changelog_rec_extra_flags(rec)->cr_extra_flags;
2059
2060         return (char *)rec + changelog_rec_offset(
2061                 (enum changelog_rec_flags)(rec->cr_flags & CLF_SUPPORTED),
2062                 (enum changelog_rec_extra_flags)(cref & CLFE_SUPPORTED));
2063 }
2064
2065 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
2066 {
2067         char *str = changelog_rec_name(rec);
2068
2069         while (*str != '\0')
2070                 str++;
2071         return str + 1;
2072 }
2073
2074 static inline __kernel_size_t changelog_rec_snamelen(const struct changelog_rec *rec)
2075 {
2076         return strlen(changelog_rec_sname(rec));
2077 }
2078
2079 /**
2080  * Remap a record to the desired format as specified by the crf flags.
2081  * The record must be big enough to contain the final remapped version.
2082  * Superfluous extension fields are removed and missing ones are added
2083  * and zeroed. The flags of the record are updated accordingly.
2084  *
2085  * The jobid and rename extensions can be added to a record, to match the
2086  * format an application expects, typically. In this case, the newly added
2087  * fields will be zeroed.
2088  * The Jobid field can be removed, to guarantee compatibility with older
2089  * clients that don't expect this field in the records they process.
2090  *
2091  * The following assumptions are being made:
2092  *   - CLF_RENAME will not be removed
2093  *   - CLF_JOBID will not be added without CLF_RENAME being added too
2094  *   - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
2095  *
2096  * @param[in,out]  rec         The record to remap.
2097  * @param[in]      crf_wanted  Flags describing the desired extensions.
2098  * @param[in]      cref_want   Flags describing the desired extra extensions.
2099  */
2100 static inline void changelog_remap_rec(struct changelog_rec *rec,
2101                                        enum changelog_rec_flags crf_wanted,
2102                                        enum changelog_rec_extra_flags cref_want)
2103 {
2104         char *xattr_mov = NULL;
2105         char *omd_mov = NULL;
2106         char *nid_mov = NULL;
2107         char *uidgid_mov = NULL;
2108         char *ef_mov;
2109         char *jid_mov;
2110         char *rnm_mov;
2111         enum changelog_rec_extra_flags cref = CLFE_INVALID;
2112
2113         crf_wanted = (enum changelog_rec_flags)
2114             (crf_wanted & CLF_SUPPORTED);
2115         cref_want = (enum changelog_rec_extra_flags)
2116             (cref_want & CLFE_SUPPORTED);
2117
2118         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
2119                 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
2120                     (rec->cr_flags & CLF_EXTRA_FLAGS &&
2121                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
2122                                                         CLFE_SUPPORTED) ==
2123                                                                      cref_want))
2124                         return;
2125         }
2126
2127         /* First move the variable-length name field */
2128         memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
2129                 changelog_rec_name(rec), rec->cr_namelen);
2130
2131         /* Locations of extensions in the remapped record */
2132         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
2133                 xattr_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 & ~CLFE_XATTR));
2139                 omd_mov = (char *)rec +
2140                         changelog_rec_offset(
2141                             (enum changelog_rec_flags)
2142                                     (crf_wanted & CLF_SUPPORTED),
2143                             (enum changelog_rec_extra_flags)
2144                                     (cref_want & ~(CLFE_OPEN | CLFE_XATTR)));
2145                 nid_mov = (char *)rec +
2146                         changelog_rec_offset(
2147                             (enum changelog_rec_flags)
2148                                 (crf_wanted & CLF_SUPPORTED),
2149                             (enum changelog_rec_extra_flags)
2150                                 (cref_want &
2151                                  ~(CLFE_NID | CLFE_OPEN | CLFE_XATTR)));
2152                 uidgid_mov = (char *)rec +
2153                         changelog_rec_offset(
2154                                 (enum changelog_rec_flags)
2155                                     (crf_wanted & CLF_SUPPORTED),
2156                                 (enum changelog_rec_extra_flags)
2157                                     (cref_want & ~(CLFE_UIDGID |
2158                                                            CLFE_NID |
2159                                                            CLFE_OPEN |
2160                                                            CLFE_XATTR)));
2161                 cref = (enum changelog_rec_extra_flags)
2162                         changelog_rec_extra_flags(rec)->cr_extra_flags;
2163         }
2164
2165         ef_mov  = (char *)rec +
2166                   changelog_rec_offset(
2167                                 (enum changelog_rec_flags)
2168                                  (crf_wanted & ~CLF_EXTRA_FLAGS), CLFE_INVALID);
2169         jid_mov = (char *)rec +
2170                   changelog_rec_offset((enum changelog_rec_flags)(crf_wanted &
2171                                        ~(CLF_EXTRA_FLAGS | CLF_JOBID)),
2172                                        CLFE_INVALID);
2173         rnm_mov = (char *)rec +
2174                   changelog_rec_offset((enum changelog_rec_flags)(crf_wanted &
2175                                        ~(CLF_EXTRA_FLAGS |
2176                                          CLF_JOBID |
2177                                          CLF_RENAME)),
2178                                        CLFE_INVALID);
2179
2180         /* Move the extension fields to the desired positions */
2181         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
2182             (rec->cr_flags & CLF_EXTRA_FLAGS)) {
2183                 if ((cref_want & CLFE_XATTR) && (cref & CLFE_XATTR))
2184                         memmove(xattr_mov, changelog_rec_xattr(rec),
2185                                 sizeof(struct changelog_ext_xattr));
2186
2187                 if ((cref_want & CLFE_OPEN) && (cref & CLFE_OPEN))
2188                         memmove(omd_mov, changelog_rec_openmode(rec),
2189                                 sizeof(struct changelog_ext_openmode));
2190
2191                 if ((cref_want & CLFE_NID) && (cref & CLFE_NID))
2192                         memmove(nid_mov, changelog_rec_nid(rec),
2193                                 sizeof(struct changelog_ext_nid));
2194
2195                 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
2196                         memmove(uidgid_mov, changelog_rec_uidgid(rec),
2197                                 sizeof(struct changelog_ext_uidgid));
2198
2199                 memmove(ef_mov, changelog_rec_extra_flags(rec),
2200                         sizeof(struct changelog_ext_extra_flags));
2201         }
2202
2203         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
2204                 memmove(jid_mov, changelog_rec_jobid(rec),
2205                         sizeof(struct changelog_ext_jobid));
2206
2207         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
2208                 memmove(rnm_mov, changelog_rec_rename(rec),
2209                         sizeof(struct changelog_ext_rename));
2210
2211         /* Clear newly added fields */
2212         if (xattr_mov && (cref_want & CLFE_XATTR) &&
2213             !(cref & CLFE_XATTR))
2214                 memset(xattr_mov, 0, sizeof(struct changelog_ext_xattr));
2215
2216         if (omd_mov && (cref_want & CLFE_OPEN) &&
2217             !(cref & CLFE_OPEN))
2218                 memset(omd_mov, 0, sizeof(struct changelog_ext_openmode));
2219
2220         if (nid_mov && (cref_want & CLFE_NID) &&
2221             !(cref & CLFE_NID))
2222                 memset(nid_mov, 0, sizeof(struct changelog_ext_nid));
2223
2224         if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
2225             !(cref & CLFE_UIDGID))
2226                 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
2227
2228         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
2229             !(rec->cr_flags & CLF_EXTRA_FLAGS))
2230                 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
2231
2232         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
2233                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
2234
2235         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
2236                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
2237
2238         /* Update the record's flags accordingly */
2239         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
2240         if (rec->cr_flags & CLF_EXTRA_FLAGS)
2241                 changelog_rec_extra_flags(rec)->cr_extra_flags =
2242                         changelog_rec_extra_flags(rec)->cr_extra_flags |
2243                         cref_want;
2244 }
2245
2246 enum changelog_message_type {
2247         CL_RECORD = 10, /* message is a changelog_rec */
2248         CL_EOF    = 11, /* at end of current changelog */
2249 };
2250
2251 /********* Misc **********/
2252
2253 struct ioc_data_version {
2254         __u64   idv_version;
2255         __u32   idv_layout_version; /* FLR: layout version for OST objects */
2256         __u32   idv_flags;      /* enum ioc_data_version_flags */
2257 };
2258
2259 enum ioc_data_version_flags {
2260         LL_DV_RD_FLUSH  = (1 << 0), /* Flush dirty pages from clients */
2261         LL_DV_WR_FLUSH  = (1 << 1), /* Flush all caching pages from clients */
2262         LL_DV_SZ_UPDATE = (1 << 2), /* Update the file size on the client */
2263 };
2264
2265 #ifndef offsetof
2266 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
2267 #endif
2268
2269 #define dot_lustre_name ".lustre"
2270 #define dot_fscrypt_name ".fscrypt"
2271
2272
2273 /********* HSM **********/
2274
2275 /** HSM per-file state
2276  * See HSM_FLAGS below.
2277  */
2278 enum hsm_states {
2279         HS_NONE         = 0x00000000,
2280         HS_EXISTS       = 0x00000001,
2281         HS_DIRTY        = 0x00000002,
2282         HS_RELEASED     = 0x00000004,
2283         HS_ARCHIVED     = 0x00000008,
2284         HS_NORELEASE    = 0x00000010,
2285         HS_NOARCHIVE    = 0x00000020,
2286         HS_LOST         = 0x00000040,
2287         HS_PCCRW        = 0x00000080,
2288         HS_PCCRO        = 0x00000100,
2289 };
2290
2291 /* HSM user-setable flags. */
2292 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
2293
2294 /* Other HSM flags. */
2295 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
2296
2297 /*
2298  * All HSM-related possible flags that could be applied to a file.
2299  * This should be kept in sync with hsm_states.
2300  */
2301 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
2302
2303 /**
2304  * HSM request progress state
2305  */
2306 enum hsm_progress_states {
2307         HPS_NONE        = 0,
2308         HPS_WAITING     = 1,
2309         HPS_RUNNING     = 2,
2310         HPS_DONE        = 3,
2311 };
2312
2313 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
2314 {
2315         switch  (s) {
2316         case HPS_WAITING:       return "waiting";
2317         case HPS_RUNNING:       return "running";
2318         case HPS_DONE:          return "done";
2319         default:                return "unknown";
2320         }
2321 }
2322
2323 struct hsm_extent {
2324         __u64 offset;
2325         __u64 length;
2326 } __attribute__((packed));
2327
2328 /**
2329  * Current HSM states of a Lustre file.
2330  *
2331  * This structure purpose is to be sent to user-space mainly. It describes the
2332  * current HSM flags and in-progress action.
2333  */
2334 struct hsm_user_state {
2335         /** Current HSM states, from enum hsm_states. */
2336         __u32                   hus_states;
2337         __u32                   hus_archive_id;
2338         /**  The current undergoing action, if there is one */
2339         __u32                   hus_in_progress_state;
2340         __u32                   hus_in_progress_action;
2341         struct hsm_extent       hus_in_progress_location;
2342         char                    hus_extended_info[];
2343 };
2344
2345 struct hsm_state_set_ioc {
2346         struct lu_fid   hssi_fid;
2347         __u64           hssi_setmask;
2348         __u64           hssi_clearmask;
2349 };
2350
2351 /*
2352  * This structure describes the current in-progress action for a file.
2353  * it is retuned to user space and send over the wire
2354  */
2355 struct hsm_current_action {
2356         /**  The current undergoing action, if there is one */
2357         /* state is one of hsm_progress_states */
2358         __u32                   hca_state;
2359         /* action is one of hsm_user_action */
2360         __u32                   hca_action;
2361         struct hsm_extent       hca_location;
2362 };
2363
2364 /***** HSM user requests ******/
2365 /* User-generated (lfs/ioctl) request types */
2366 enum hsm_user_action {
2367         HUA_NONE    =  1, /* no action (noop) */
2368         HUA_ARCHIVE = 10, /* copy to hsm */
2369         HUA_RESTORE = 11, /* prestage */
2370         HUA_RELEASE = 12, /* drop ost objects */
2371         HUA_REMOVE  = 13, /* remove from archive */
2372         HUA_CANCEL  = 14  /* cancel a request */
2373 };
2374
2375 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
2376 {
2377         switch  (a) {
2378         case HUA_NONE:    return "NOOP";
2379         case HUA_ARCHIVE: return "ARCHIVE";
2380         case HUA_RESTORE: return "RESTORE";
2381         case HUA_RELEASE: return "RELEASE";
2382         case HUA_REMOVE:  return "REMOVE";
2383         case HUA_CANCEL:  return "CANCEL";
2384         default:          return "UNKNOWN";
2385         }
2386 }
2387
2388 /*
2389  * List of hr_flags (bit field)
2390  */
2391 #define HSM_FORCE_ACTION 0x0001
2392 /* used by CT, cannot be set by user */
2393 #define HSM_GHOST_COPY   0x0002
2394
2395 /**
2396  * Contains all the fixed part of struct hsm_user_request.
2397  *
2398  */
2399 struct hsm_request {
2400         __u32 hr_action;        /* enum hsm_user_action */
2401         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
2402         __u64 hr_flags;         /* request flags */
2403         __u32 hr_itemcount;     /* item count in hur_user_item vector */
2404         __u32 hr_data_len;
2405 };
2406
2407 struct hsm_user_item {
2408        struct lu_fid        hui_fid;
2409        struct hsm_extent hui_extent;
2410 } __attribute__((packed));
2411
2412 struct hsm_user_request {
2413         struct hsm_request      hur_request;
2414         struct hsm_user_item    hur_user_item[0];
2415         /* extra data blob at end of struct (after all
2416          * hur_user_items), only use helpers to access it
2417          */
2418 } __attribute__((packed));
2419
2420 /** Return pointer to data field in a hsm user request */
2421 static inline void *hur_data(struct hsm_user_request *hur)
2422 {
2423         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
2424 }
2425
2426 /**
2427  * Compute the current length of the provided hsm_user_request.  This returns -1
2428  * instead of an errno because __kernel_ssize_t is defined to be only
2429  * [ -1, SSIZE_MAX ]
2430  *
2431  * return -1 on bounds check error.
2432  */
2433 static inline __kernel_size_t hur_len(struct hsm_user_request *hur)
2434 {
2435         __u64   size;
2436
2437         /* can't overflow a __u64 since hr_itemcount is only __u32 */
2438         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
2439                 (__u64)hur->hur_request.hr_itemcount *
2440                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
2441
2442         if ((__kernel_ssize_t)size < 0)
2443                 return -1;
2444
2445         return size;
2446 }
2447
2448 /****** HSM RPCs to copytool *****/
2449 /* Message types the copytool may receive */
2450 enum hsm_message_type {
2451         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
2452 };
2453
2454 /* Actions the copytool may be instructed to take for a given action_item */
2455 enum hsm_copytool_action {
2456         HSMA_NONE    = 10, /* no action */
2457         HSMA_ARCHIVE = 20, /* arbitrary offset */
2458         HSMA_RESTORE = 21,
2459         HSMA_REMOVE  = 22,
2460         HSMA_CANCEL  = 23
2461 };
2462
2463 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
2464 {
2465         switch  (a) {
2466         case HSMA_NONE:    return "NOOP";
2467         case HSMA_ARCHIVE: return "ARCHIVE";
2468         case HSMA_RESTORE: return "RESTORE";
2469         case HSMA_REMOVE:  return "REMOVE";
2470         case HSMA_CANCEL:  return "CANCEL";
2471         default:           return "UNKNOWN";
2472         }
2473 }
2474
2475 /* Copytool item action description */
2476 struct hsm_action_item {
2477         __u32      hai_len;     /* valid size of this struct */
2478         __u32      hai_action;  /* hsm_copytool_action, but use known size */
2479         struct lu_fid hai_fid;     /* Lustre FID to operate on */
2480         struct lu_fid hai_dfid;    /* fid used for data access */
2481         struct hsm_extent hai_extent;  /* byte range to operate on */
2482         __u64      hai_cookie;  /* action cookie from coordinator */
2483         __u64      hai_gid;     /* grouplock id */
2484         char       hai_data[0]; /* variable length */
2485 } __attribute__((packed));
2486
2487 /**
2488  * helper function which print in hexa the first bytes of
2489  * hai opaque field
2490  *
2491  * \param hai [IN]        record to print
2492  * \param buffer [IN,OUT] buffer to write the hex string to
2493  * \param len [IN]        max buffer length
2494  *
2495  * \retval buffer
2496  */
2497 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
2498                                         char *buffer, __kernel_size_t len)
2499 {
2500         int i;
2501         int data_len;
2502         char *ptr;
2503
2504         ptr = buffer;
2505         data_len = hai->hai_len - sizeof(*hai);
2506         for (i = 0; (i < data_len) && (len > 2); i++) {
2507                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
2508                 ptr += 2;
2509                 len -= 2;
2510         }
2511
2512         *ptr = '\0';
2513
2514         return buffer;
2515 }
2516
2517 /* Copytool action list */
2518 #define HAL_VERSION 1
2519 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
2520 struct hsm_action_list {
2521         __u32 hal_version;
2522         __u32 hal_count;       /* number of hai's to follow */
2523         __u64 hal_compound_id; /* returned by coordinator, ignored */
2524         __u64 hal_flags;
2525         __u32 hal_archive_id; /* which archive backend */
2526         __u32 padding1;
2527         char  hal_fsname[0];   /* null-terminated */
2528         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
2529            boundaries. See hai_zero */
2530 } __attribute__((packed));
2531
2532 /* Return pointer to first hai in action list */
2533 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
2534 {
2535         __kernel_size_t offset = __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2536
2537         return (struct hsm_action_item *)(hal->hal_fsname + offset);
2538 }
2539
2540 /* Return pointer to next hai */
2541 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
2542 {
2543         __kernel_size_t offset = __ALIGN_KERNEL(hai->hai_len, 8);
2544
2545         return (struct hsm_action_item *)((char *)hai + offset);
2546 }
2547
2548 /* Return size of an hsm_action_list */
2549 static inline __kernel_size_t hal_size(struct hsm_action_list *hal)
2550 {
2551         __u32 i;
2552         __kernel_size_t sz;
2553         struct hsm_action_item *hai;
2554
2555         sz = sizeof(*hal) + __ALIGN_KERNEL(strlen(hal->hal_fsname) + 1, 8);
2556         hai = hai_first(hal);
2557         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
2558                 sz += __ALIGN_KERNEL(hai->hai_len, 8);
2559
2560         return sz;
2561 }
2562
2563 /* HSM file import
2564  * describe the attributes to be set on imported file
2565  */
2566 struct hsm_user_import {
2567         __u64           hui_size;
2568         __u64           hui_atime;
2569         __u64           hui_mtime;
2570         __u32           hui_atime_ns;
2571         __u32           hui_mtime_ns;
2572         __u32           hui_uid;
2573         __u32           hui_gid;
2574         __u32           hui_mode;
2575         __u32           hui_archive_id;
2576 };
2577
2578 /* Copytool progress reporting */
2579 #define HP_FLAG_COMPLETED 0x01
2580 #define HP_FLAG_RETRY     0x02
2581
2582 struct hsm_progress {
2583         struct lu_fid           hp_fid;
2584         __u64                   hp_cookie;
2585         struct hsm_extent       hp_extent;
2586         __u16                   hp_flags;
2587         __u16                   hp_errval; /* positive val */
2588         __u32                   padding;
2589 };
2590
2591 struct hsm_copy {
2592         __u64                   hc_data_version;
2593         __u16                   hc_flags;
2594         __u16                   hc_errval; /* positive val */
2595         __u32                   padding;
2596         struct hsm_action_item  hc_hai;
2597 };
2598
2599 enum lu_ladvise_type {
2600         LU_LADVISE_INVALID      = 0,
2601         LU_LADVISE_WILLREAD     = 1,
2602         LU_LADVISE_DONTNEED     = 2,
2603         LU_LADVISE_LOCKNOEXPAND = 3,
2604         LU_LADVISE_LOCKAHEAD    = 4,
2605         LU_LADVISE_MAX
2606 };
2607
2608 #define LU_LADVISE_NAMES {                                              \
2609         [LU_LADVISE_WILLREAD]           = "willread",                   \
2610         [LU_LADVISE_DONTNEED]           = "dontneed",                   \
2611         [LU_LADVISE_LOCKNOEXPAND]       = "locknoexpand",               \
2612         [LU_LADVISE_LOCKAHEAD]          = "lockahead",                  \
2613 }
2614
2615 /* This is the userspace argument for ladvise.  It is currently the same as
2616  * what goes on the wire (struct lu_ladvise), but is defined separately as we
2617  * may need info which is only used locally. */
2618 struct llapi_lu_ladvise {
2619         __u16 lla_advice;       /* advice type */
2620         __u16 lla_value1;       /* values for different advice types */
2621         __u32 lla_value2;
2622         __u64 lla_start;        /* first byte of extent for advice */
2623         __u64 lla_end;          /* last byte of extent for advice */
2624         __u32 lla_value3;
2625         __u32 lla_value4;
2626 };
2627
2628 enum ladvise_flag {
2629         LF_ASYNC        = 0x00000001,
2630         LF_UNSET        = 0x00000002,
2631 };
2632
2633 #define LADVISE_MAGIC 0x1ADF1CE0
2634 /* Masks of valid flags for each advice */
2635 #define LF_LOCKNOEXPAND_MASK LF_UNSET
2636 /* Flags valid for all advices not explicitly specified */
2637 #define LF_DEFAULT_MASK LF_ASYNC
2638 /* All flags */
2639 #define LF_MASK (LF_ASYNC | LF_UNSET)
2640
2641 #define lla_lockahead_mode   lla_value1
2642 #define lla_peradvice_flags    lla_value2
2643 #define lla_lockahead_result lla_value3
2644
2645 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
2646  * is used on the wire.  It is defined separately as we may need info which is
2647  * only used locally. */
2648 struct llapi_ladvise_hdr {
2649         __u32                   lah_magic;      /* LADVISE_MAGIC */
2650         __u32                   lah_count;      /* number of advices */
2651         __u64                   lah_flags;      /* from enum ladvise_flag */
2652         __u32                   lah_value1;     /* unused */
2653         __u32                   lah_value2;     /* unused */
2654         __u64                   lah_value3;     /* unused */
2655         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
2656 };
2657
2658 #define LAH_COUNT_MAX   (1024)
2659
2660 /* Shared key */
2661 enum sk_crypt_alg {
2662         SK_CRYPT_EMPTY          = 0,
2663         SK_CRYPT_AES256_CTR     = 1,
2664         SK_CRYPT_INVALID        = __UINT16_MAX__
2665 };
2666
2667 enum sk_hmac_alg {
2668         SK_HMAC_EMPTY   = 0,
2669         SK_HMAC_SHA256  = 1,
2670         SK_HMAC_SHA512  = 2,
2671         SK_HMAC_INVALID = __UINT16_MAX__
2672 };
2673
2674 struct sk_crypt_type {
2675         const char     *sct_name;
2676         int             sct_type;
2677 };
2678
2679 struct sk_hmac_type {
2680         const char     *sht_name;
2681         int             sht_type;
2682 };
2683
2684 enum lock_mode_user {
2685         MODE_READ_USER = 1,
2686         MODE_WRITE_USER,
2687         MODE_MAX_USER,
2688 };
2689
2690 #define LOCK_MODE_NAMES { \
2691         [MODE_READ_USER]  = "READ",\
2692         [MODE_WRITE_USER] = "WRITE"\
2693 }
2694
2695 enum lockahead_results {
2696         LLA_RESULT_SENT = 0,
2697         LLA_RESULT_DIFFERENT,
2698         LLA_RESULT_SAME,
2699 };
2700
2701 enum lu_heat_flag_bit {
2702         LU_HEAT_FLAG_BIT_INVALID = 0,
2703         LU_HEAT_FLAG_BIT_OFF,
2704         LU_HEAT_FLAG_BIT_CLEAR,
2705 };
2706
2707 enum lu_heat_flag {
2708         LU_HEAT_FLAG_OFF        = 1ULL << LU_HEAT_FLAG_BIT_OFF,
2709         LU_HEAT_FLAG_CLEAR      = 1ULL << LU_HEAT_FLAG_BIT_CLEAR,
2710 };
2711
2712 enum obd_heat_type {
2713         OBD_HEAT_READSAMPLE     = 0,
2714         OBD_HEAT_WRITESAMPLE    = 1,
2715         OBD_HEAT_READBYTE       = 2,
2716         OBD_HEAT_WRITEBYTE      = 3,
2717         OBD_HEAT_COUNT
2718 };
2719
2720 #define LU_HEAT_NAMES {                                 \
2721         [OBD_HEAT_READSAMPLE]   = "readsample",         \
2722         [OBD_HEAT_WRITESAMPLE]  = "writesample",        \
2723         [OBD_HEAT_READBYTE]     = "readbyte",           \
2724         [OBD_HEAT_WRITEBYTE]    = "writebyte",          \
2725 }
2726
2727 struct lu_heat {
2728         __u32 lh_count;
2729         __u32 lh_flags;
2730         __u64 lh_heat[0];
2731 };
2732
2733 enum lu_pcc_type {
2734         LU_PCC_NONE             = 0x0,
2735         LU_PCC_READWRITE        = 0x01,
2736         LU_PCC_READONLY         = 0x02,
2737         LU_PCC_TYPE_MASK        = LU_PCC_READWRITE | LU_PCC_READONLY,
2738         LU_PCC_FL_ASYNC         = 0x10,
2739         LU_PCC_MAX
2740 };
2741
2742 static inline const char *pcc_type2string(enum lu_pcc_type type)
2743 {
2744         switch (type & LU_PCC_TYPE_MASK) {
2745         case LU_PCC_NONE:
2746                 return "none";
2747         case LU_PCC_READWRITE:
2748                 return "readwrite";
2749         case LU_PCC_READONLY:
2750                 return "readonly";
2751         default:
2752                 return "fault";
2753         }
2754 }
2755
2756 struct lu_pcc_attach {
2757         __u32 pcca_type; /* PCC type */
2758         __u32 pcca_id; /* archive ID for readwrite, group ID for readonly */
2759 };
2760
2761 enum lu_pcc_detach_opts {
2762         PCC_DETACH_OPT_NONE = 0, /* Detach only, keep the PCC copy */
2763         PCC_DETACH_OPT_UNCACHE, /* Remove the cached file after detach */
2764 };
2765
2766 struct lu_pcc_detach_fid {
2767         /* fid of the file to detach */
2768         struct lu_fid   pccd_fid;
2769         __u32           pccd_opt;
2770 };
2771
2772 struct lu_pcc_detach {
2773         __u32           pccd_opt;
2774 };
2775
2776 enum lu_pcc_state_flags {
2777         PCC_STATE_FL_NONE               = 0x0,
2778         /* The inode attr is cached locally */
2779         PCC_STATE_FL_ATTR_VALID         = 0x01,
2780         /* The file is being attached into PCC */
2781         PCC_STATE_FL_ATTACHING          = 0x02,
2782         /* The PCC copy is unlinked */
2783         PCC_STATE_FL_UNLINKED           = 0x04,
2784 };
2785
2786 struct lu_pcc_state {
2787         __u32   pccs_type; /* enum lu_pcc_type */
2788         __u32   pccs_open_count;
2789         __u32   pccs_flags; /* enum lu_pcc_state_flags */
2790         __u32   pccs_padding;
2791         char    pccs_path[PATH_MAX];
2792 };
2793
2794 enum lu_project_type {
2795         LU_PROJECT_NONE = 0,
2796         LU_PROJECT_SET,
2797         LU_PROJECT_GET,
2798         LU_PROJECT_MAX
2799 };
2800
2801 struct lu_project {
2802         __u32   project_type; /* enum lu_project_type */
2803         __u32   project_id;
2804         __u32   project_xflags;
2805         __u32   project_reserved;
2806         char    project_name[NAME_MAX + 1];
2807 };
2808
2809 struct fid_array {
2810         __u32 fa_nr;
2811         /* make header's size equal lu_fid */
2812         __u32 fa_padding0;
2813         __u64 fa_padding1;
2814         struct lu_fid fa_fids[0];
2815 };
2816 #define OBD_MAX_FIDS_IN_ARRAY   4096
2817
2818 /* more types could be defined upon need for more complex
2819  * format to be used in foreign symlink LOV/LMV EAs, like
2820  * one to describe a delimiter string and occurence number
2821  * of delimited sub-string, ...
2822  */
2823 enum ll_foreign_symlink_upcall_item_type {
2824         EOB_TYPE = 1,
2825         STRING_TYPE = 2,
2826         POSLEN_TYPE = 3,
2827 };
2828
2829 /* may need to be modified to allow for more format items to be defined, and
2830  * like for ll_foreign_symlink_upcall_item_type enum
2831  */
2832 struct ll_foreign_symlink_upcall_item {
2833         __u32 type;
2834         union {
2835                 struct {
2836                         __u32 pos;
2837                         __u32 len;
2838                 };
2839                 struct {
2840                         size_t size;
2841                         union {
2842                                 /* internal storage of constant string */
2843                                 char *string;
2844                                 /* upcall stores constant string in a raw */
2845                                 char bytestring[0];
2846                         };
2847                 };
2848         };
2849 };
2850
2851 #define POSLEN_ITEM_SZ (offsetof(struct ll_foreign_symlink_upcall_item, len) + \
2852                 sizeof(((struct ll_foreign_symlink_upcall_item *)0)->len))
2853 #define STRING_ITEM_SZ(sz) ( \
2854         offsetof(struct ll_foreign_symlink_upcall_item, bytestring) + \
2855         (sz + sizeof(__u32) - 1) / sizeof(__u32) * sizeof(__u32))
2856
2857 /* presently limited to not cause max stack frame size to be reached
2858  * because of temporary automatic array of
2859  * "struct ll_foreign_symlink_upcall_item" presently used in
2860  * foreign_symlink_upcall_info_store()
2861  */
2862 #define MAX_NB_UPCALL_ITEMS 32
2863
2864 #if defined(__cplusplus)
2865 }
2866 #endif
2867
2868 /** @} lustreuser */
2869
2870 #endif /* _LUSTRE_USER_H */