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