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