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

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