lustre/include/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, 2016, 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/types.h>
  46
  47 #ifdef __KERNEL__
  48 # include <linux/fs.h>
  49 # include <linux/quota.h>
  50 # include <linux/string.h> /* snprintf() */
  51 # include <linux/version.h>
  52 #else /* !__KERNEL__ */
  53 # define NEED_QUOTA_DEFS
  54 # include <limits.h>
  55 # include <stdbool.h>
  56 # include <stdio.h> /* snprintf() */
  57 # include <string.h>
  58 # include <sys/quota.h>
  59 # include <sys/stat.h>
  60 #endif /* __KERNEL__ */
  61 #include <lustre/ll_fiemap.h>
  62
  63 #if defined(__x86_64__) || defined(__ia64__) || defined(__ppc64__) || \
  64     defined(__craynv) || defined(__mips64__) || defined(__powerpc64__) || \
  65     defined(__aarch64__)
  66 typedef struct stat     lstat_t;
  67 # define lstat_f        lstat
  68 # define fstat_f        fstat
  69 # define fstatat_f      fstatat
  70 # define HAVE_LOV_USER_MDS_DATA
  71 #elif defined(__USE_LARGEFILE64) || defined(__KERNEL__)
  72 typedef struct stat64   lstat_t;
  73 # define lstat_f        lstat64
  74 # define fstat_f        fstat64
  75 # define fstatat_f      fstatat64
  76 # define HAVE_LOV_USER_MDS_DATA
  77 #endif
  78
  79 #define LUSTRE_EOF 0xffffffffffffffffULL
  80
  81 /* for statfs() */
  82 #define LL_SUPER_MAGIC 0x0BD00BD0
  83
  84 #ifndef FSFILT_IOC_GETFLAGS
  85 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
  86 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
  87 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
  88 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
  89 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  90 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  91 #endif
  92
  93 /* FIEMAP flags supported by Lustre */
  94 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
  95
  96 enum obd_statfs_state {
  97         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
  98         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
  99         OS_STATE_ENOSPC         = 0x00000020, /**< not enough free space */
 100         OS_STATE_ENOINO         = 0x00000040, /**< not enough inodes */
 101 };
 102
 103 struct obd_statfs {
 104         __u64           os_type;
 105         __u64           os_blocks;
 106         __u64           os_bfree;
 107         __u64           os_bavail;
 108         __u64           os_files;
 109         __u64           os_ffree;
 110         __u8            os_fsid[40];
 111         __u32           os_bsize;
 112         __u32           os_namelen;
 113         __u64           os_maxbytes;
 114         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
 115         __u32           os_fprecreated; /* objs available now to the caller */
 116                                         /* used in QoS code to find preferred
 117                                          * OSTs */
 118         __u32           os_spare2;
 119         __u32           os_spare3;
 120         __u32           os_spare4;
 121         __u32           os_spare5;
 122         __u32           os_spare6;
 123         __u32           os_spare7;
 124         __u32           os_spare8;
 125         __u32           os_spare9;
 126 };
 127
 128 /**
 129  * File IDentifier.
 130  *
 131  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 132  * FIDs are never reused.
 133  **/
 134 struct lu_fid {
 135        /**
 136         * FID sequence. Sequence is a unit of migration: all files (objects)
 137         * with FIDs from a given sequence are stored on the same server.
 138         * Lustre should support 2^64 objects, so even if each sequence
 139         * has only a single object we can still enumerate 2^64 objects.
 140         **/
 141         __u64 f_seq;
 142         /* FID number within sequence. */
 143         __u32 f_oid;
 144         /**
 145          * FID version, used to distinguish different versions (in the sense
 146          * of snapshots, etc.) of the same file system object. Not currently
 147          * used.
 148          **/
 149         __u32 f_ver;
 150 };
 151
 152 static inline bool fid_is_zero(const struct lu_fid *fid)
 153 {
 154         return fid->f_seq == 0 && fid->f_oid == 0;
 155 }
 156
 157 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
 158  * MDT-object's FID::f_ver, instead it is the OST-object index in its
 159  * parent MDT-object's layout EA. */
 160 #define f_stripe_idx f_ver
 161
 162 struct filter_fid {
 163         struct lu_fid   ff_parent;  /* ff_parent.f_ver == file stripe number */
 164 };
 165
 166 /* keep this one for compatibility */
 167 struct filter_fid_old {
 168         struct lu_fid   ff_parent;
 169         __u64           ff_objid;
 170         __u64           ff_seq;
 171 };
 172
 173 /* Userspace should treat lu_fid as opaque, and only use the following methods
 174  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
 175  * here from lustre_idl.h if needed. */
 176 typedef struct lu_fid lustre_fid;
 177
 178 /**
 179  * Following struct for object attributes, that will be kept inode's EA.
 180  * Introduced in 2.0 release (please see b15993, for details)
 181  * Added to all objects since Lustre 2.4 as contains self FID
 182  */
 183 struct lustre_mdt_attrs {
 184         /**
 185          * Bitfield for supported data in this structure. From enum lma_compat.
 186          * lma_self_fid and lma_flags are always available.
 187          */
 188         __u32   lma_compat;
 189         /**
 190          * Per-file incompat feature list. Lustre version should support all
 191          * flags set in this field. The supported feature mask is available in
 192          * LMA_INCOMPAT_SUPP.
 193          */
 194         __u32   lma_incompat;
 195         /** FID of this inode */
 196         struct lu_fid  lma_self_fid;
 197 };
 198
 199 /**
 200  * Prior to 2.4, the LMA structure also included SOM attributes which has since
 201  * been moved to a dedicated xattr
 202  * lma_flags was also removed because of lma_compat/incompat fields.
 203  */
 204 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
 205
 206 /**
 207  * OST object IDentifier.
 208  */
 209 struct ost_id {
 210         union {
 211                 struct {
 212                         __u64   oi_id;
 213                         __u64   oi_seq;
 214                 } oi;
 215                 struct lu_fid oi_fid;
 216         };
 217 };
 218
 219 #define DOSTID "%#llx:%llu"
 220 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
 221                    ((unsigned long long)ostid_id(oi))
 222
 223 struct ll_futimes_3 {
 224         __u64 lfu_atime_sec;
 225         __u64 lfu_atime_nsec;
 226         __u64 lfu_mtime_sec;
 227         __u64 lfu_mtime_nsec;
 228         __u64 lfu_ctime_sec;
 229         __u64 lfu_ctime_nsec;
 230 };
 231
 232 /*
 233  * The ioctl naming rules:
 234  * LL_*     - works on the currently opened filehandle instead of parent dir
 235  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 236  * *_MDC_*  - gets/sets data related to MDC
 237  * *_LOV_*  - gets/sets data related to OSC/LOV
 238  * *FILE*   - called on parent dir and passes in a filename
 239  * *STRIPE* - set/get lov_user_md
 240  * *INFO    - set/get lov_user_mds_data
 241  */
 242 /*      lustre_ioctl.h                  101-150 */
 243 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 244 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 245 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 246 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 247 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 248 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 249 /*      LL_IOC_RECREATE_OBJ             157 obsolete */
 250 /*      LL_IOC_RECREATE_FID             157 obsolete */
 251 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 252 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 253 /*      LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
 254 /*      LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
 255 /*      LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
 256 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 257 /*      IOC_LOV_GETINFO                 165 obsolete */
 258 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 259 /*      LL_IOC_RMTACL                   167 obsolete */
 260 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 261 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 262 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 263 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
 264 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 265 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 266 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 267 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 268 #define LL_IOC_FUTIMES_3                _IOWR('f', 176, struct ll_futimes_3)
 269 /*      lustre_ioctl.h                  177-210 */
 270 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
 271 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
 272 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
 273 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
 274 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
 275 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
 276 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
 277 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
 278 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
 279                                                 struct lustre_swap_layouts)
 280 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
 281                                                 struct hsm_current_action)
 282 /*      lustre_ioctl.h                  221-232 */
 283 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
 284 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
 285 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
 286 #define LL_IOC_SET_LEASE                _IOWR('f', 243, long)
 287 #define LL_IOC_GET_LEASE                _IO('f', 244)
 288 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
 289 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
 290 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
 291 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
 292 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
 293 #define LL_IOC_LADVISE                  _IOR('f', 250, struct llapi_lu_ladvise)
 294
 295 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
 296 enum ll_lease_type {
 297         LL_LEASE_RDLCK  = 0x1,
 298         LL_LEASE_WRLCK  = 0x2,
 299         LL_LEASE_UNLCK  = 0x4,
 300 };
 301
 302 #define LL_STATFS_LMV           1
 303 #define LL_STATFS_LOV           2
 304 #define LL_STATFS_NODELAY       4
 305
 306 #define IOC_MDC_TYPE            'i'
 307 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 308 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 309 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 310 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 311
 312 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 313
 314 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
 315  * files, but are unlikely to be used in practice and are not harmful if
 316  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
 317  * devices and are safe for use on new files. See LU-4209. */
 318 /* To be compatible with old statically linked binary we keep the check for
 319  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
 320 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
 321 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
 322 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
 323                                          O_LOV_DELAY_CREATE_MASK)
 324
 325 #define LL_FILE_IGNORE_LOCK     0x00000001
 326 #define LL_FILE_GROUP_LOCKED    0x00000002
 327 #define LL_FILE_READAHEA        0x00000004
 328 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 329 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 330
 331 #define LOV_USER_MAGIC_V1       0x0BD10BD0
 332 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
 333 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
 334 #define LOV_USER_MAGIC_V3       0x0BD30BD0
 335 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
 336 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
 337 #define LOV_USER_MAGIC_COMP_V1  0x0BD60BD0
 338
 339 #define LMV_USER_MAGIC    0x0CD30CD0    /*default lmv magic*/
 340
 341 #define LOV_PATTERN_RAID0       0x001
 342 #define LOV_PATTERN_RAID1       0x002
 343 #define LOV_PATTERN_FIRST       0x100
 344 #define LOV_PATTERN_CMOBD       0x200
 345
 346 #define LOV_PATTERN_F_MASK      0xffff0000
 347 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
 348 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
 349
 350 static inline bool lov_pattern_supported(__u32 pattern)
 351 {
 352         return pattern == LOV_PATTERN_RAID0 ||
 353                pattern == (LOV_PATTERN_RAID0 | LOV_PATTERN_F_RELEASED);
 354 }
 355
 356 #define LOV_MAXPOOLNAME 15
 357 #define LOV_POOLNAMEF "%.15s"
 358
 359 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 360 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 361 #define LOV_MAX_STRIPE_COUNT_OLD 160
 362 /* This calculation is crafted so that input of 4096 will result in 160
 363  * which in turn is equal to old maximal stripe count.
 364  * XXX: In fact this is too simpified for now, what it also need is to get
 365  * ea_type argument to clearly know how much space each stripe consumes.
 366  *
 367  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 368  * allocation that is sufficient for the current generation of systems.
 369  *
 370  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 371 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 372 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 373 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 374
 375 #define XATTR_LUSTRE_PREFIX     "lustre."
 376 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 377
 378 #define lov_user_ost_data lov_user_ost_data_v1
 379 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 380         struct ost_id l_ost_oi;   /* OST object ID */
 381         __u32 l_ost_gen;          /* generation of this OST index */
 382         __u32 l_ost_idx;          /* OST index in LOV */
 383 } __attribute__((packed));
 384
 385 #define lov_user_md lov_user_md_v1
 386 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 387         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 388         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 389         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 390         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 391         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 392         union {
 393                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 394                                            * lmm_objects, use when writing */
 395                 __u16 lmm_layout_gen;     /* layout generation number
 396                                            * used when reading */
 397         };
 398         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 399 } __attribute__((packed,  __may_alias__));
 400
 401 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 402         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 403         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 404         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 405         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 406         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 407         union {
 408                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 409                                            * lmm_objects, use when writing */
 410                 __u16 lmm_layout_gen;     /* layout generation number
 411                                            * used when reading */
 412         };
 413         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 414         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 415 } __attribute__((packed));
 416
 417 struct lu_extent {
 418         __u64   e_start;
 419         __u64   e_end;
 420 };
 421
 422 enum lov_comp_md_entry_flags {
 423         LCME_FL_PRIMARY = 0x00000001,   /* Not used */
 424         LCME_FL_STALE   = 0x00000002,   /* Not used */
 425         LCME_FL_OFFLINE = 0x00000004,   /* Not used */
 426         LCME_FL_PREFERRED = 0x00000008, /* Not used */
 427         LCME_FL_INIT    = 0x00000010,   /* instantiated */
 428 };
 429
 430 #define LCME_KNOWN_FLAGS        LCME_FL_INIT
 431
 432 /* lcme_id can be specified as certain flags, and the the first
 433  * bit of lcme_id is used to indicate that the ID is representing
 434  * certain LCME_FL_* but not a real ID. Which implies we can have
 435  * at most 31 flags (see LCME_FL_XXX). */
 436 enum lcme_id {
 437         LCME_ID_INVAL   = 0x0,
 438         LCME_ID_MAX     = 0x7FFFFFFF,
 439         LCME_ID_ALL     = 0xFFFFFFFF,
 440         LCME_ID_NONE    = 0x80000000
 441 };
 442
 443 #define LCME_ID_MASK    LCME_ID_MAX
 444
 445 struct lov_comp_md_entry_v1 {
 446         __u32                   lcme_id;        /* unique id of component */
 447         __u32                   lcme_flags;     /* LCME_FL_XXX */
 448         struct lu_extent        lcme_extent;    /* file extent for component */
 449         __u32                   lcme_offset;    /* offset of component blob,
 450                                                    start from lov_comp_md_v1 */
 451         __u32                   lcme_size;      /* size of component blob */
 452         __u64                   lcme_padding[2];
 453 } __attribute__((packed));
 454
 455 enum lov_comp_md_flags;
 456
 457 struct lov_comp_md_v1 {
 458         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
 459         __u32   lcm_size;       /* overall size including this struct */
 460         __u32   lcm_layout_gen;
 461         __u16   lcm_flags;
 462         __u16   lcm_entry_count;
 463         __u64   lcm_padding1;
 464         __u64   lcm_padding2;
 465         struct lov_comp_md_entry_v1 lcm_entries[0];
 466 } __attribute__((packed));
 467
 468
 469 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
 470 {
 471         if (lmm_magic == LOV_USER_MAGIC_V1)
 472                 return sizeof(struct lov_user_md_v1) +
 473                               stripes * sizeof(struct lov_user_ost_data_v1);
 474         return sizeof(struct lov_user_md_v3) +
 475                                 stripes * sizeof(struct lov_user_ost_data_v1);
 476 }
 477
 478 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 479  * use this.  It is unsafe to #define those values in this header as it
 480  * is possible the application has already #included <sys/stat.h>. */
 481 #ifdef HAVE_LOV_USER_MDS_DATA
 482 #define lov_user_mds_data lov_user_mds_data_v1
 483 struct lov_user_mds_data_v1 {
 484         lstat_t lmd_st;                 /* MDS stat struct */
 485         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 486 } __attribute__((packed));
 487
 488 struct lov_user_mds_data_v3 {
 489         lstat_t lmd_st;                 /* MDS stat struct */
 490         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 491 } __attribute__((packed));
 492 #endif
 493
 494 struct lmv_user_mds_data {
 495         struct lu_fid   lum_fid;
 496         __u32           lum_padding;
 497         __u32           lum_mds;
 498 };
 499
 500 enum lmv_hash_type {
 501         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
 502         LMV_HASH_TYPE_ALL_CHARS = 1,
 503         LMV_HASH_TYPE_FNV_1A_64 = 2,
 504         LMV_HASH_TYPE_MAX,
 505 };
 506
 507 #define LMV_HASH_NAME_ALL_CHARS "all_char"
 508 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
 509
 510 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
 511
 512 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
 513  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
 514 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 515 #define lmv_user_md lmv_user_md_v1
 516 struct lmv_user_md_v1 {
 517         __u32   lum_magic;       /* must be the first field */
 518         __u32   lum_stripe_count;  /* dirstripe count */
 519         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
 520         __u32   lum_hash_type;     /* Dir stripe policy */
 521         __u32   lum_type;         /* LMV type: default or normal */
 522         __u32   lum_padding1;
 523         __u32   lum_padding2;
 524         __u32   lum_padding3;
 525         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
 526         struct  lmv_user_mds_data  lum_objects[0];
 527 } __attribute__((packed));
 528
 529 static inline int lmv_user_md_size(int stripes, int lmm_magic)
 530 {
 531         return sizeof(struct lmv_user_md) +
 532                       stripes * sizeof(struct lmv_user_mds_data);
 533 }
 534
 535 struct ll_recreate_obj {
 536         __u64 lrc_id;
 537         __u32 lrc_ost_idx;
 538 };
 539
 540 struct ll_fid {
 541         __u64 id;         /* holds object id */
 542         __u32 generation; /* holds object generation */
 543         __u32 f_type;     /* holds object type or stripe idx when passing it to
 544                            * OST for saving into EA. */
 545 };
 546
 547 #define UUID_MAX        40
 548 struct obd_uuid {
 549         char uuid[UUID_MAX];
 550 };
 551
 552 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
 553                                    const struct obd_uuid *u2)
 554 {
 555         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 556 }
 557
 558 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 559 {
 560         return uuid->uuid[0] == '\0';
 561 }
 562
 563 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 564 {
 565         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 566         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 567 }
 568
 569 /* For printf's only, make sure uuid is terminated */
 570 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
 571 {
 572         if (uuid == NULL)
 573                 return NULL;
 574
 575         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 576                 /* Obviously not safe, but for printfs, no real harm done...
 577                    we're always null-terminated, even in a race. */
 578                 static char temp[sizeof(*uuid)];
 579                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 580                 temp[sizeof(*uuid) - 1] = '\0';
 581                 return temp;
 582         }
 583         return (char *)(uuid->uuid);
 584 }
 585
 586 /* Extract fsname from uuid (or target name) of a target
 587    e.g. (myfs-OST0007_UUID -> myfs)
 588    see also deuuidify. */
 589 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 590 {
 591         char *p;
 592
 593         strncpy(buf, uuid, buflen - 1);
 594         buf[buflen - 1] = '\0';
 595         p = strrchr(buf, '-');
 596         if (p != NULL)
 597                 *p = '\0';
 598 }
 599
 600 /* printf display format for Lustre FIDs
 601  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
 602 #define FID_NOBRACE_LEN 40
 603 #define FID_LEN (FID_NOBRACE_LEN + 2)
 604 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
 605 #define DFID "["DFID_NOBRACE"]"
 606 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
 607
 608 /* scanf input parse format for fids in DFID_NOBRACE format
 609  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
 610  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
 611 #define SFID "0x%llx:0x%x:0x%x"
 612 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
 613
 614 /********* Quotas **********/
 615
 616 #define LUSTRE_QUOTABLOCK_BITS 10
 617 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
 618
 619 static inline __u64 lustre_stoqb(size_t space)
 620 {
 621         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
 622 }
 623
 624 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
 625 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
 626 #define Q_GETOINFO      0x800102 /* get obd quota info */
 627 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
 628 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
 629
 630 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 631 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
 632 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
 633 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 634 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 635 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 636 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 637 /* lustre-specific control commands */
 638 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
 639 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
 640
 641 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 642
 643 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 644
 645 /* permission */
 646 #define N_PERMS_MAX      64
 647
 648 struct perm_downcall_data {
 649         __u64 pdd_nid;
 650         __u32 pdd_perm;
 651         __u32 pdd_padding;
 652 };
 653
 654 struct identity_downcall_data {
 655         __u32                            idd_magic;
 656         __u32                            idd_err;
 657         __u32                            idd_uid;
 658         __u32                            idd_gid;
 659         __u32                            idd_nperms;
 660         __u32                            idd_ngroups;
 661         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 662         __u32                            idd_groups[0];
 663 };
 664
 665 #ifdef NEED_QUOTA_DEFS
 666 #ifndef QIF_BLIMITS
 667 #define QIF_BLIMITS     1
 668 #define QIF_SPACE       2
 669 #define QIF_ILIMITS     4
 670 #define QIF_INODES      8
 671 #define QIF_BTIME       16
 672 #define QIF_ITIME       32
 673 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 674 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 675 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 676 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 677 #endif
 678
 679 #endif /* !__KERNEL__ */
 680
 681 /* lustre volatile file support
 682  * file name header: .^L^S^T^R:volatile"
 683  */
 684 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
 685 #define LUSTRE_VOLATILE_HDR_LEN 14
 686
 687 typedef enum lustre_quota_version {
 688         LUSTRE_QUOTA_V2 = 1
 689 } lustre_quota_version_t;
 690
 691 /* XXX: same as if_dqinfo struct in kernel */
 692 struct obd_dqinfo {
 693         __u64 dqi_bgrace;
 694         __u64 dqi_igrace;
 695         __u32 dqi_flags;
 696         __u32 dqi_valid;
 697 };
 698
 699 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 700 struct obd_dqblk {
 701         __u64 dqb_bhardlimit;
 702         __u64 dqb_bsoftlimit;
 703         __u64 dqb_curspace;
 704         __u64 dqb_ihardlimit;
 705         __u64 dqb_isoftlimit;
 706         __u64 dqb_curinodes;
 707         __u64 dqb_btime;
 708         __u64 dqb_itime;
 709         __u32 dqb_valid;
 710         __u32 dqb_padding;
 711 };
 712
 713 enum {
 714         QC_GENERAL      = 0,
 715         QC_MDTIDX       = 1,
 716         QC_OSTIDX       = 2,
 717         QC_UUID         = 3
 718 };
 719
 720 struct if_quotactl {
 721         __u32                   qc_cmd;
 722         __u32                   qc_type;
 723         __u32                   qc_id;
 724         __u32                   qc_stat;
 725         __u32                   qc_valid;
 726         __u32                   qc_idx;
 727         struct obd_dqinfo       qc_dqinfo;
 728         struct obd_dqblk        qc_dqblk;
 729         char                    obd_type[16];
 730         struct obd_uuid         obd_uuid;
 731 };
 732
 733 /* swap layout flags */
 734 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
 735 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
 736 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
 737 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
 738 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
 739
 740 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
 741 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
 742 struct lustre_swap_layouts {
 743         __u64   sl_flags;
 744         __u32   sl_fd;
 745         __u32   sl_gid;
 746         __u64   sl_dv1;
 747         __u64   sl_dv2;
 748 };
 749
 750
 751 /********* Changelogs **********/
 752 /** Changelog record types */
 753 enum changelog_rec_type {
 754         CL_MARK     = 0,
 755         CL_CREATE   = 1,  /* namespace */
 756         CL_MKDIR    = 2,  /* namespace */
 757         CL_HARDLINK = 3,  /* namespace */
 758         CL_SOFTLINK = 4,  /* namespace */
 759         CL_MKNOD    = 5,  /* namespace */
 760         CL_UNLINK   = 6,  /* namespace */
 761         CL_RMDIR    = 7,  /* namespace */
 762         CL_RENAME   = 8,  /* namespace */
 763         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
 764         CL_OPEN     = 10, /* not currently used */
 765         CL_CLOSE    = 11, /* may be written to log only with mtime change */
 766         CL_LAYOUT   = 12, /* file layout/striping modified */
 767         CL_TRUNC    = 13,
 768         CL_SETATTR  = 14,
 769         CL_XATTR    = 15,
 770         CL_HSM      = 16, /* HSM specific events, see flags */
 771         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
 772         CL_CTIME    = 18,
 773         CL_ATIME    = 19,
 774         CL_MIGRATE  = 20,
 775         CL_LAST
 776 };
 777
 778 static inline const char *changelog_type2str(int type) {
 779         static const char *changelog_str[] = {
 780                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
 781                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
 782                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT"
 783         };
 784
 785         if (type >= 0 && type < CL_LAST)
 786                 return changelog_str[type];
 787         return NULL;
 788 }
 789
 790 /* per-record flags */
 791 #define CLF_FLAGSHIFT   12
 792 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
 793 #define CLF_VERMASK     (~CLF_FLAGMASK)
 794 enum changelog_rec_flags {
 795         CLF_VERSION     = 0x1000,
 796         CLF_RENAME      = 0x2000,
 797         CLF_JOBID       = 0x4000,
 798         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID
 799 };
 800
 801
 802 /* Anything under the flagmask may be per-type (if desired) */
 803 /* Flags for unlink */
 804 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
 805 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
 806                                      /* HSM cleaning needed */
 807 /* Flags for rename */
 808 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
 809                                         * of target */
 810 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
 811                                         * has an archive in backend */
 812
 813 /* Flags for HSM */
 814 /* 12b used (from high weight to low weight):
 815  * 2b for flags
 816  * 3b for event
 817  * 7b for error code
 818  */
 819 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
 820 #define CLF_HSM_ERR_H        6
 821 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
 822 #define CLF_HSM_EVENT_H      9
 823 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
 824 #define CLF_HSM_FLAG_H      11
 825 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
 826 #define CLF_HSM_SPARE_H     15
 827 #define CLF_HSM_LAST        15
 828
 829 /* Remove bits higher than _h, then extract the value
 830  * between _h and _l by shifting lower weigth to bit 0. */
 831 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
 832                                    >> (CLF_HSM_LAST - _h + _l))
 833
 834 #define CLF_HSM_SUCCESS      0x00
 835 #define CLF_HSM_MAXERROR     0x7E
 836 #define CLF_HSM_ERROVERFLOW  0x7F
 837
 838 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
 839
 840 /* 3 bits field => 8 values allowed */
 841 enum hsm_event {
 842         HE_ARCHIVE      = 0,
 843         HE_RESTORE      = 1,
 844         HE_CANCEL       = 2,
 845         HE_RELEASE      = 3,
 846         HE_REMOVE       = 4,
 847         HE_STATE        = 5,
 848         HE_SPARE1       = 6,
 849         HE_SPARE2       = 7,
 850 };
 851
 852 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
 853 {
 854         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
 855                                             CLF_HSM_EVENT_L);
 856 }
 857
 858 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
 859 {
 860         *flags |= (he << CLF_HSM_EVENT_L);
 861 }
 862
 863 static inline __u16 hsm_get_cl_flags(int flags)
 864 {
 865         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
 866 }
 867
 868 static inline void hsm_set_cl_flags(int *flags, int bits)
 869 {
 870         *flags |= (bits << CLF_HSM_FLAG_L);
 871 }
 872
 873 static inline int hsm_get_cl_error(int flags)
 874 {
 875         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
 876 }
 877
 878 static inline void hsm_set_cl_error(int *flags, int error)
 879 {
 880         *flags |= (error << CLF_HSM_ERR_L);
 881 }
 882
 883 enum changelog_send_flag {
 884         /* Not yet implemented */
 885         CHANGELOG_FLAG_FOLLOW   = 0x01,
 886         /* Blocking IO makes sense in case of slow user parsing of the records,
 887          * but it also prevents us from cleaning up if the records are not
 888          * consumed. */
 889         CHANGELOG_FLAG_BLOCK    = 0x02,
 890         /* Pack jobid into the changelog records if available. */
 891         CHANGELOG_FLAG_JOBID    = 0x04,
 892 };
 893
 894 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
 895                                   changelog_rec_offset(CLF_SUPPORTED))
 896
 897 /* 31 usable bytes string + null terminator. */
 898 #define LUSTRE_JOBID_SIZE       32
 899
 900 /* This is the minimal changelog record. It can contain extensions
 901  * such as rename fields or process jobid. Its exact content is described
 902  * by the cr_flags.
 903  *
 904  * Extensions are packed in the same order as their corresponding flags.
 905  */
 906 struct changelog_rec {
 907         __u16                   cr_namelen;
 908         __u16                   cr_flags; /**< \a changelog_rec_flags */
 909         __u32                   cr_type;  /**< \a changelog_rec_type */
 910         __u64                   cr_index; /**< changelog record number */
 911         __u64                   cr_prev;  /**< last index for this target fid */
 912         __u64                   cr_time;
 913         union {
 914                 lustre_fid      cr_tfid;        /**< target fid */
 915                 __u32           cr_markerflags; /**< CL_MARK flags */
 916         };
 917         lustre_fid              cr_pfid;        /**< parent fid */
 918 };
 919
 920 /* Changelog extension for RENAME. */
 921 struct changelog_ext_rename {
 922         lustre_fid              cr_sfid;     /**< source fid, or zero */
 923         lustre_fid              cr_spfid;    /**< source parent fid, or zero */
 924 };
 925
 926 /* Changelog extension to include JOBID. */
 927 struct changelog_ext_jobid {
 928         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
 929 };
 930
 931
 932 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
 933 {
 934         size_t size = sizeof(struct changelog_rec);
 935
 936         if (crf & CLF_RENAME)
 937                 size += sizeof(struct changelog_ext_rename);
 938
 939         if (crf & CLF_JOBID)
 940                 size += sizeof(struct changelog_ext_jobid);
 941
 942         return size;
 943 }
 944
 945 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
 946 {
 947         return changelog_rec_offset(rec->cr_flags);
 948 }
 949
 950 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
 951 {
 952         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
 953 }
 954
 955 static inline
 956 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
 957 {
 958         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
 959
 960         return (struct changelog_ext_rename *)((char *)rec +
 961                                                changelog_rec_offset(crf));
 962 }
 963
 964 /* The jobid follows the rename extension, if present */
 965 static inline
 966 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
 967 {
 968         enum changelog_rec_flags crf = rec->cr_flags &
 969                                         (CLF_VERSION | CLF_RENAME);
 970
 971         return (struct changelog_ext_jobid *)((char *)rec +
 972                                               changelog_rec_offset(crf));
 973 }
 974
 975 /* The name follows the rename and jobid extensions, if present */
 976 static inline char *changelog_rec_name(const struct changelog_rec *rec)
 977 {
 978         return (char *)rec + changelog_rec_offset(rec->cr_flags &
 979                                                   CLF_SUPPORTED);
 980 }
 981
 982 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
 983 {
 984         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
 985 }
 986
 987 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
 988 {
 989         char *cr_name = changelog_rec_name(rec);
 990
 991         return cr_name + strlen(cr_name) + 1;
 992 }
 993
 994 /**
 995  * Remap a record to the desired format as specified by the crf flags.
 996  * The record must be big enough to contain the final remapped version.
 997  * Superfluous extension fields are removed and missing ones are added
 998  * and zeroed. The flags of the record are updated accordingly.
 999  *
1000  * The jobid and rename extensions can be added to a record, to match the
1001  * format an application expects, typically. In this case, the newly added
1002  * fields will be zeroed.
1003  * The Jobid field can be removed, to guarantee compatibility with older
1004  * clients that don't expect this field in the records they process.
1005  *
1006  * The following assumptions are being made:
1007  *   - CLF_RENAME will not be removed
1008  *   - CLF_JOBID will not be added without CLF_RENAME being added too
1009  *
1010  * @param[in,out]  rec         The record to remap.
1011  * @param[in]      crf_wanted  Flags describing the desired extensions.
1012  */
1013 static inline void changelog_remap_rec(struct changelog_rec *rec,
1014                                        enum changelog_rec_flags crf_wanted)
1015 {
1016         char *jid_mov;
1017         char *rnm_mov;
1018
1019         crf_wanted &= CLF_SUPPORTED;
1020
1021         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
1022                 return;
1023
1024         /* First move the variable-length name field */
1025         memmove((char *)rec + changelog_rec_offset(crf_wanted),
1026                 changelog_rec_name(rec), rec->cr_namelen);
1027
1028         /* Locations of jobid and rename extensions in the remapped record */
1029         jid_mov = (char *)rec +
1030                   changelog_rec_offset(crf_wanted & ~CLF_JOBID);
1031         rnm_mov = (char *)rec +
1032                   changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
1033
1034         /* Move the extension fields to the desired positions */
1035         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1036                 memmove(jid_mov, changelog_rec_jobid(rec),
1037                         sizeof(struct changelog_ext_jobid));
1038
1039         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1040                 memmove(rnm_mov, changelog_rec_rename(rec),
1041                         sizeof(struct changelog_ext_rename));
1042
1043         /* Clear newly added fields */
1044         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1045                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1046
1047         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1048                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1049
1050         /* Update the record's flags accordingly */
1051         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1052 }
1053
1054 struct ioc_changelog {
1055         __u64 icc_recno;
1056         __u32 icc_mdtindex;
1057         __u32 icc_id;
1058         __u32 icc_flags;
1059 };
1060
1061 enum changelog_message_type {
1062         CL_RECORD = 10, /* message is a changelog_rec */
1063         CL_EOF    = 11, /* at end of current changelog */
1064 };
1065
1066 /********* Misc **********/
1067
1068 struct ioc_data_version {
1069         __u64 idv_version;
1070         __u64 idv_flags;     /* See LL_DV_xxx */
1071 };
1072 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
1073 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
1074
1075 #ifndef offsetof
1076 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1077 #endif
1078
1079 #define dot_lustre_name ".lustre"
1080
1081
1082 /********* HSM **********/
1083
1084 /** HSM per-file state
1085  * See HSM_FLAGS below.
1086  */
1087 enum hsm_states {
1088         HS_NONE         = 0x00000000,
1089         HS_EXISTS       = 0x00000001,
1090         HS_DIRTY        = 0x00000002,
1091         HS_RELEASED     = 0x00000004,
1092         HS_ARCHIVED     = 0x00000008,
1093         HS_NORELEASE    = 0x00000010,
1094         HS_NOARCHIVE    = 0x00000020,
1095         HS_LOST         = 0x00000040,
1096 };
1097
1098 /* HSM user-setable flags. */
1099 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1100
1101 /* Other HSM flags. */
1102 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1103
1104 /*
1105  * All HSM-related possible flags that could be applied to a file.
1106  * This should be kept in sync with hsm_states.
1107  */
1108 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1109
1110 /**
1111  * HSM request progress state
1112  */
1113 enum hsm_progress_states {
1114         HPS_WAITING     = 1,
1115         HPS_RUNNING     = 2,
1116         HPS_DONE        = 3,
1117 };
1118 #define HPS_NONE        0
1119
1120 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1121 {
1122         switch  (s) {
1123         case HPS_WAITING:       return "waiting";
1124         case HPS_RUNNING:       return "running";
1125         case HPS_DONE:          return "done";
1126         default:                return "unknown";
1127         }
1128 }
1129
1130 struct hsm_extent {
1131         __u64 offset;
1132         __u64 length;
1133 } __attribute__((packed));
1134
1135 /**
1136  * Current HSM states of a Lustre file.
1137  *
1138  * This structure purpose is to be sent to user-space mainly. It describes the
1139  * current HSM flags and in-progress action.
1140  */
1141 struct hsm_user_state {
1142         /** Current HSM states, from enum hsm_states. */
1143         __u32                   hus_states;
1144         __u32                   hus_archive_id;
1145         /**  The current undergoing action, if there is one */
1146         __u32                   hus_in_progress_state;
1147         __u32                   hus_in_progress_action;
1148         struct hsm_extent       hus_in_progress_location;
1149         char                    hus_extended_info[];
1150 };
1151
1152 struct hsm_state_set_ioc {
1153         struct lu_fid   hssi_fid;
1154         __u64           hssi_setmask;
1155         __u64           hssi_clearmask;
1156 };
1157
1158 /*
1159  * This structure describes the current in-progress action for a file.
1160  * it is retuned to user space and send over the wire
1161  */
1162 struct hsm_current_action {
1163         /**  The current undergoing action, if there is one */
1164         /* state is one of hsm_progress_states */
1165         __u32                   hca_state;
1166         /* action is one of hsm_user_action */
1167         __u32                   hca_action;
1168         struct hsm_extent       hca_location;
1169 };
1170
1171 /***** HSM user requests ******/
1172 /* User-generated (lfs/ioctl) request types */
1173 enum hsm_user_action {
1174         HUA_NONE    =  1, /* no action (noop) */
1175         HUA_ARCHIVE = 10, /* copy to hsm */
1176         HUA_RESTORE = 11, /* prestage */
1177         HUA_RELEASE = 12, /* drop ost objects */
1178         HUA_REMOVE  = 13, /* remove from archive */
1179         HUA_CANCEL  = 14  /* cancel a request */
1180 };
1181
1182 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1183 {
1184         switch  (a) {
1185         case HUA_NONE:    return "NOOP";
1186         case HUA_ARCHIVE: return "ARCHIVE";
1187         case HUA_RESTORE: return "RESTORE";
1188         case HUA_RELEASE: return "RELEASE";
1189         case HUA_REMOVE:  return "REMOVE";
1190         case HUA_CANCEL:  return "CANCEL";
1191         default:          return "UNKNOWN";
1192         }
1193 }
1194
1195 /*
1196  * List of hr_flags (bit field)
1197  */
1198 #define HSM_FORCE_ACTION 0x0001
1199 /* used by CT, cannot be set by user */
1200 #define HSM_GHOST_COPY   0x0002
1201
1202 /**
1203  * Contains all the fixed part of struct hsm_user_request.
1204  *
1205  */
1206 struct hsm_request {
1207         __u32 hr_action;        /* enum hsm_user_action */
1208         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1209         __u64 hr_flags;         /* request flags */
1210         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1211         __u32 hr_data_len;
1212 };
1213
1214 struct hsm_user_item {
1215        lustre_fid        hui_fid;
1216        struct hsm_extent hui_extent;
1217 } __attribute__((packed));
1218
1219 struct hsm_user_request {
1220         struct hsm_request      hur_request;
1221         struct hsm_user_item    hur_user_item[0];
1222         /* extra data blob at end of struct (after all
1223          * hur_user_items), only use helpers to access it
1224          */
1225 } __attribute__((packed));
1226
1227 /** Return pointer to data field in a hsm user request */
1228 static inline void *hur_data(struct hsm_user_request *hur)
1229 {
1230         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1231 }
1232
1233 /**
1234  * Compute the current length of the provided hsm_user_request.  This returns -1
1235  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1236  *
1237  * return -1 on bounds check error.
1238  */
1239 static inline ssize_t hur_len(struct hsm_user_request *hur)
1240 {
1241         __u64   size;
1242
1243         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1244         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1245                 (__u64)hur->hur_request.hr_itemcount *
1246                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1247
1248         if (size != (ssize_t)size)
1249                 return -1;
1250
1251         return size;
1252 }
1253
1254 /****** HSM RPCs to copytool *****/
1255 /* Message types the copytool may receive */
1256 enum hsm_message_type {
1257         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1258 };
1259
1260 /* Actions the copytool may be instructed to take for a given action_item */
1261 enum hsm_copytool_action {
1262         HSMA_NONE    = 10, /* no action */
1263         HSMA_ARCHIVE = 20, /* arbitrary offset */
1264         HSMA_RESTORE = 21,
1265         HSMA_REMOVE  = 22,
1266         HSMA_CANCEL  = 23
1267 };
1268
1269 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1270 {
1271         switch  (a) {
1272         case HSMA_NONE:    return "NOOP";
1273         case HSMA_ARCHIVE: return "ARCHIVE";
1274         case HSMA_RESTORE: return "RESTORE";
1275         case HSMA_REMOVE:  return "REMOVE";
1276         case HSMA_CANCEL:  return "CANCEL";
1277         default:           return "UNKNOWN";
1278         }
1279 }
1280
1281 /* Copytool item action description */
1282 struct hsm_action_item {
1283         __u32      hai_len;     /* valid size of this struct */
1284         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1285         lustre_fid hai_fid;     /* Lustre FID to operate on */
1286         lustre_fid hai_dfid;    /* fid used for data access */
1287         struct hsm_extent hai_extent;  /* byte range to operate on */
1288         __u64      hai_cookie;  /* action cookie from coordinator */
1289         __u64      hai_gid;     /* grouplock id */
1290         char       hai_data[0]; /* variable length */
1291 } __attribute__((packed));
1292
1293 /**
1294  * helper function which print in hexa the first bytes of
1295  * hai opaque field
1296  *
1297  * \param hai [IN]        record to print
1298  * \param buffer [IN,OUT] buffer to write the hex string to
1299  * \param len [IN]        max buffer length
1300  *
1301  * \retval buffer
1302  */
1303 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1304                                         char *buffer, size_t len)
1305 {
1306         int i;
1307         int data_len;
1308         char *ptr;
1309
1310         ptr = buffer;
1311         data_len = hai->hai_len - sizeof(*hai);
1312         for (i = 0; (i < data_len) && (len > 2); i++) {
1313                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1314                 ptr += 2;
1315                 len -= 2;
1316         }
1317
1318         *ptr = '\0';
1319
1320         return buffer;
1321 }
1322
1323 /* Copytool action list */
1324 #define HAL_VERSION 1
1325 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1326 struct hsm_action_list {
1327         __u32 hal_version;
1328         __u32 hal_count;       /* number of hai's to follow */
1329         __u64 hal_compound_id; /* returned by coordinator */
1330         __u64 hal_flags;
1331         __u32 hal_archive_id; /* which archive backend */
1332         __u32 padding1;
1333         char  hal_fsname[0];   /* null-terminated */
1334         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1335            boundaries. See hai_zero */
1336 } __attribute__((packed));
1337
1338 #ifndef HAVE_CFS_SIZE_ROUND
1339 static inline int cfs_size_round (int val)
1340 {
1341         return (val + 7) & (~0x7);
1342 }
1343 #define HAVE_CFS_SIZE_ROUND
1344 #endif
1345
1346 /* Return pointer to first hai in action list */
1347 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1348 {
1349         return (struct hsm_action_item *)(hal->hal_fsname +
1350                                           cfs_size_round(strlen(hal-> \
1351                                                                 hal_fsname)
1352                                                          + 1));
1353 }
1354 /* Return pointer to next hai */
1355 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1356 {
1357         return (struct hsm_action_item *)((char *)hai +
1358                                           cfs_size_round(hai->hai_len));
1359 }
1360
1361 /* Return size of an hsm_action_list */
1362 static inline size_t hal_size(struct hsm_action_list *hal)
1363 {
1364         __u32 i;
1365         size_t sz;
1366         struct hsm_action_item *hai;
1367
1368         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1369         hai = hai_first(hal);
1370         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1371                 sz += cfs_size_round(hai->hai_len);
1372
1373         return sz;
1374 }
1375
1376 /* HSM file import
1377  * describe the attributes to be set on imported file
1378  */
1379 struct hsm_user_import {
1380         __u64           hui_size;
1381         __u64           hui_atime;
1382         __u64           hui_mtime;
1383         __u32           hui_atime_ns;
1384         __u32           hui_mtime_ns;
1385         __u32           hui_uid;
1386         __u32           hui_gid;
1387         __u32           hui_mode;
1388         __u32           hui_archive_id;
1389 };
1390
1391 /* Copytool progress reporting */
1392 #define HP_FLAG_COMPLETED 0x01
1393 #define HP_FLAG_RETRY     0x02
1394
1395 struct hsm_progress {
1396         lustre_fid              hp_fid;
1397         __u64                   hp_cookie;
1398         struct hsm_extent       hp_extent;
1399         __u16                   hp_flags;
1400         __u16                   hp_errval; /* positive val */
1401         __u32                   padding;
1402 };
1403
1404 struct hsm_copy {
1405         __u64                   hc_data_version;
1406         __u16                   hc_flags;
1407         __u16                   hc_errval; /* positive val */
1408         __u32                   padding;
1409         struct hsm_action_item  hc_hai;
1410 };
1411
1412 /* JSON objects */
1413 enum llapi_json_types {
1414         LLAPI_JSON_INTEGER = 1,
1415         LLAPI_JSON_BIGNUM,
1416         LLAPI_JSON_REAL,
1417         LLAPI_JSON_STRING
1418 };
1419
1420 struct llapi_json_item {
1421         char                    *lji_key;
1422         __u32                   lji_type;
1423         union {
1424                 int     lji_integer;
1425                 __u64   lji_u64;
1426                 double  lji_real;
1427                 char    *lji_string;
1428         };
1429         struct llapi_json_item  *lji_next;
1430 };
1431
1432 struct llapi_json_item_list {
1433         int                     ljil_item_count;
1434         struct llapi_json_item  *ljil_items;
1435 };
1436
1437 enum lu_ladvise_type {
1438         LU_LADVISE_INVALID      = 0,
1439         LU_LADVISE_WILLREAD     = 1,
1440         LU_LADVISE_DONTNEED     = 2,
1441 };
1442
1443 #define LU_LADVISE_NAMES {                                              \
1444         [LU_LADVISE_WILLREAD]   = "willread",                           \
1445         [LU_LADVISE_DONTNEED]   = "dontneed",                           \
1446 }
1447
1448 /* This is the userspace argument for ladvise.  It is currently the same as
1449  * what goes on the wire (struct lu_ladvise), but is defined separately as we
1450  * may need info which is only used locally. */
1451 struct llapi_lu_ladvise {
1452         __u16 lla_advice;       /* advice type */
1453         __u16 lla_value1;       /* values for different advice types */
1454         __u32 lla_value2;
1455         __u64 lla_start;        /* first byte of extent for advice */
1456         __u64 lla_end;          /* last byte of extent for advice */
1457         __u32 lla_value3;
1458         __u32 lla_value4;
1459 };
1460
1461 enum ladvise_flag {
1462         LF_ASYNC        = 0x00000001,
1463 };
1464
1465 #define LADVISE_MAGIC 0x1ADF1CE0
1466 #define LF_MASK LF_ASYNC
1467
1468 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
1469  * is used on the wire.  It is defined separately as we may need info which is
1470  * only used locally. */
1471 struct llapi_ladvise_hdr {
1472         __u32                   lah_magic;      /* LADVISE_MAGIC */
1473         __u32                   lah_count;      /* number of advices */
1474         __u64                   lah_flags;      /* from enum ladvise_flag */
1475         __u32                   lah_value1;     /* unused */
1476         __u32                   lah_value2;     /* unused */
1477         __u64                   lah_value3;     /* unused */
1478         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
1479 };
1480
1481 #define LAH_COUNT_MAX   (1024)
1482
1483 /* Shared key */
1484 enum sk_crypt_alg {
1485         SK_CRYPT_INVALID        = -1,
1486         SK_CRYPT_EMPTY          = 0,
1487         SK_CRYPT_AES256_CTR     = 1,
1488         SK_CRYPT_MAX            = 2,
1489 };
1490
1491 struct sk_crypt_type {
1492         char            *cht_name;
1493         unsigned int     cht_key;
1494         unsigned int     cht_bytes;
1495 };
1496
1497 /** @} lustreuser */
1498 #endif /* _LUSTRE_USER_H */