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