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