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 #define LOV_MAXPOOLNAME 15
 351 #define LOV_POOLNAMEF "%.15s"
 352
 353 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 354 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 355 #define LOV_MAX_STRIPE_COUNT_OLD 160
 356 /* This calculation is crafted so that input of 4096 will result in 160
 357  * which in turn is equal to old maximal stripe count.
 358  * XXX: In fact this is too simpified for now, what it also need is to get
 359  * ea_type argument to clearly know how much space each stripe consumes.
 360  *
 361  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 362  * allocation that is sufficient for the current generation of systems.
 363  *
 364  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 365 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 366 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 367 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 368
 369 #define XATTR_LUSTRE_PREFIX     "lustre."
 370 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 371
 372 #define lov_user_ost_data lov_user_ost_data_v1
 373 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 374         struct ost_id l_ost_oi;   /* OST object ID */
 375         __u32 l_ost_gen;          /* generation of this OST index */
 376         __u32 l_ost_idx;          /* OST index in LOV */
 377 } __attribute__((packed));
 378
 379 #define lov_user_md lov_user_md_v1
 380 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 381         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 382         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 383         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 384         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 385         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 386         union {
 387                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 388                                            * lmm_objects, use when writing */
 389                 __u16 lmm_layout_gen;     /* layout generation number
 390                                            * used when reading */
 391         };
 392         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 393 } __attribute__((packed,  __may_alias__));
 394
 395 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 396         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 397         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 398         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 399         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 400         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 401         union {
 402                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 403                                            * lmm_objects, use when writing */
 404                 __u16 lmm_layout_gen;     /* layout generation number
 405                                            * used when reading */
 406         };
 407         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 408         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 409 } __attribute__((packed));
 410
 411 struct lu_extent {
 412         __u64   e_start;
 413         __u64   e_end;
 414 };
 415
 416 enum lov_comp_md_entry_flags {
 417         LCME_FL_PRIMARY = 0x00000001,   /* Not used */
 418         LCME_FL_STALE   = 0x00000002,   /* Not used */
 419         LCME_FL_OFFLINE = 0x00000004,   /* Not used */
 420         LCME_FL_PREFERRED = 0x00000008, /* Not used */
 421         LCME_FL_INIT    = 0x00000010,   /* instantiated */
 422 };
 423
 424 #define LCME_KNOWN_FLAGS        LCME_FL_INIT
 425
 426 /* lcme_id can be specified as certain flags, and the the first
 427  * bit of lcme_id is used to indicate that the ID is representing
 428  * certain lcme_flags but not a real ID. Which implies we can have
 429  * at most 31 flags (see LCME_FL_XXX). */
 430 enum lcme_id {
 431         LCME_ID_INVAL   = 0x0,
 432         LCME_ID_MAX     = 0x7FFFFFFF,
 433         LCME_ID_ALL     = 0xFFFFFFFF,
 434         LCME_ID_NONE    = 0x80000000
 435 };
 436
 437 #define LCME_ID_MASK    LCME_ID_MAX
 438
 439 struct lov_comp_md_entry_v1 {
 440         __u32                   lcme_id;        /* unique id of component */
 441         __u32                   lcme_flags;     /* LCME_FL_XXX */
 442         struct lu_extent        lcme_extent;    /* file extent for component */
 443         __u32                   lcme_offset;    /* offset of component blob,
 444                                                    start from lov_comp_md_v1 */
 445         __u32                   lcme_size;      /* size of component blob */
 446         __u64                   lcme_padding[2];
 447 } __attribute__((packed));
 448
 449 enum lov_comp_md_flags;
 450
 451 struct lov_comp_md_v1 {
 452         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
 453         __u32   lcm_size;       /* overall size including this struct */
 454         __u32   lcm_layout_gen;
 455         __u16   lcm_flags;
 456         __u16   lcm_entry_count;
 457         __u64   lcm_padding1;
 458         __u64   lcm_padding2;
 459         struct lov_comp_md_entry_v1 lcm_entries[0];
 460 } __attribute__((packed));
 461
 462
 463 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
 464 {
 465         if (lmm_magic == LOV_USER_MAGIC_V1)
 466                 return sizeof(struct lov_user_md_v1) +
 467                               stripes * sizeof(struct lov_user_ost_data_v1);
 468         return sizeof(struct lov_user_md_v3) +
 469                                 stripes * sizeof(struct lov_user_ost_data_v1);
 470 }
 471
 472 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 473  * use this.  It is unsafe to #define those values in this header as it
 474  * is possible the application has already #included <sys/stat.h>. */
 475 #ifdef HAVE_LOV_USER_MDS_DATA
 476 #define lov_user_mds_data lov_user_mds_data_v1
 477 struct lov_user_mds_data_v1 {
 478         lstat_t lmd_st;                 /* MDS stat struct */
 479         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 480 } __attribute__((packed));
 481
 482 struct lov_user_mds_data_v3 {
 483         lstat_t lmd_st;                 /* MDS stat struct */
 484         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 485 } __attribute__((packed));
 486 #endif
 487
 488 struct lmv_user_mds_data {
 489         struct lu_fid   lum_fid;
 490         __u32           lum_padding;
 491         __u32           lum_mds;
 492 };
 493
 494 enum lmv_hash_type {
 495         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
 496         LMV_HASH_TYPE_ALL_CHARS = 1,
 497         LMV_HASH_TYPE_FNV_1A_64 = 2,
 498         LMV_HASH_TYPE_MAX,
 499 };
 500
 501 #define LMV_HASH_NAME_ALL_CHARS "all_char"
 502 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
 503
 504 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
 505
 506 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
 507  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
 508 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 509 #define lmv_user_md lmv_user_md_v1
 510 struct lmv_user_md_v1 {
 511         __u32   lum_magic;       /* must be the first field */
 512         __u32   lum_stripe_count;  /* dirstripe count */
 513         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
 514         __u32   lum_hash_type;     /* Dir stripe policy */
 515         __u32   lum_type;         /* LMV type: default or normal */
 516         __u32   lum_padding1;
 517         __u32   lum_padding2;
 518         __u32   lum_padding3;
 519         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
 520         struct  lmv_user_mds_data  lum_objects[0];
 521 } __attribute__((packed));
 522
 523 static inline int lmv_user_md_size(int stripes, int lmm_magic)
 524 {
 525         return sizeof(struct lmv_user_md) +
 526                       stripes * sizeof(struct lmv_user_mds_data);
 527 }
 528
 529 struct ll_recreate_obj {
 530         __u64 lrc_id;
 531         __u32 lrc_ost_idx;
 532 };
 533
 534 struct ll_fid {
 535         __u64 id;         /* holds object id */
 536         __u32 generation; /* holds object generation */
 537         __u32 f_type;     /* holds object type or stripe idx when passing it to
 538                            * OST for saving into EA. */
 539 };
 540
 541 #define UUID_MAX        40
 542 struct obd_uuid {
 543         char uuid[UUID_MAX];
 544 };
 545
 546 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
 547                                    const struct obd_uuid *u2)
 548 {
 549         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 550 }
 551
 552 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 553 {
 554         return uuid->uuid[0] == '\0';
 555 }
 556
 557 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 558 {
 559         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 560         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 561 }
 562
 563 /* For printf's only, make sure uuid is terminated */
 564 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
 565 {
 566         if (uuid == NULL)
 567                 return NULL;
 568
 569         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 570                 /* Obviously not safe, but for printfs, no real harm done...
 571                    we're always null-terminated, even in a race. */
 572                 static char temp[sizeof(*uuid)];
 573                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 574                 temp[sizeof(*uuid) - 1] = '\0';
 575                 return temp;
 576         }
 577         return (char *)(uuid->uuid);
 578 }
 579
 580 /* Extract fsname from uuid (or target name) of a target
 581    e.g. (myfs-OST0007_UUID -> myfs)
 582    see also deuuidify. */
 583 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 584 {
 585         char *p;
 586
 587         strncpy(buf, uuid, buflen - 1);
 588         buf[buflen - 1] = '\0';
 589         p = strrchr(buf, '-');
 590         if (p != NULL)
 591                 *p = '\0';
 592 }
 593
 594 /* printf display format for Lustre FIDs
 595  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
 596 #define FID_NOBRACE_LEN 40
 597 #define FID_LEN (FID_NOBRACE_LEN + 2)
 598 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
 599 #define DFID "["DFID_NOBRACE"]"
 600 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
 601
 602 /* scanf input parse format for fids in DFID_NOBRACE format
 603  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
 604  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
 605 #define SFID "0x%llx:0x%x:0x%x"
 606 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
 607
 608 /********* Quotas **********/
 609
 610 #define LUSTRE_QUOTABLOCK_BITS 10
 611 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
 612
 613 static inline __u64 lustre_stoqb(size_t space)
 614 {
 615         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
 616 }
 617
 618 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
 619 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
 620 #define Q_GETOINFO      0x800102 /* get obd quota info */
 621 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
 622 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
 623
 624 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 625 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
 626 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
 627 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 628 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 629 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 630 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 631 /* lustre-specific control commands */
 632 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
 633 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
 634
 635 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 636
 637 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 638
 639 /* permission */
 640 #define N_PERMS_MAX      64
 641
 642 struct perm_downcall_data {
 643         __u64 pdd_nid;
 644         __u32 pdd_perm;
 645         __u32 pdd_padding;
 646 };
 647
 648 struct identity_downcall_data {
 649         __u32                            idd_magic;
 650         __u32                            idd_err;
 651         __u32                            idd_uid;
 652         __u32                            idd_gid;
 653         __u32                            idd_nperms;
 654         __u32                            idd_ngroups;
 655         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 656         __u32                            idd_groups[0];
 657 };
 658
 659 #ifdef NEED_QUOTA_DEFS
 660 #ifndef QIF_BLIMITS
 661 #define QIF_BLIMITS     1
 662 #define QIF_SPACE       2
 663 #define QIF_ILIMITS     4
 664 #define QIF_INODES      8
 665 #define QIF_BTIME       16
 666 #define QIF_ITIME       32
 667 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 668 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 669 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 670 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 671 #endif
 672
 673 #endif /* !__KERNEL__ */
 674
 675 /* lustre volatile file support
 676  * file name header: .^L^S^T^R:volatile"
 677  */
 678 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
 679 #define LUSTRE_VOLATILE_HDR_LEN 14
 680
 681 typedef enum lustre_quota_version {
 682         LUSTRE_QUOTA_V2 = 1
 683 } lustre_quota_version_t;
 684
 685 /* XXX: same as if_dqinfo struct in kernel */
 686 struct obd_dqinfo {
 687         __u64 dqi_bgrace;
 688         __u64 dqi_igrace;
 689         __u32 dqi_flags;
 690         __u32 dqi_valid;
 691 };
 692
 693 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 694 struct obd_dqblk {
 695         __u64 dqb_bhardlimit;
 696         __u64 dqb_bsoftlimit;
 697         __u64 dqb_curspace;
 698         __u64 dqb_ihardlimit;
 699         __u64 dqb_isoftlimit;
 700         __u64 dqb_curinodes;
 701         __u64 dqb_btime;
 702         __u64 dqb_itime;
 703         __u32 dqb_valid;
 704         __u32 dqb_padding;
 705 };
 706
 707 enum {
 708         QC_GENERAL      = 0,
 709         QC_MDTIDX       = 1,
 710         QC_OSTIDX       = 2,
 711         QC_UUID         = 3
 712 };
 713
 714 struct if_quotactl {
 715         __u32                   qc_cmd;
 716         __u32                   qc_type;
 717         __u32                   qc_id;
 718         __u32                   qc_stat;
 719         __u32                   qc_valid;
 720         __u32                   qc_idx;
 721         struct obd_dqinfo       qc_dqinfo;
 722         struct obd_dqblk        qc_dqblk;
 723         char                    obd_type[16];
 724         struct obd_uuid         obd_uuid;
 725 };
 726
 727 /* swap layout flags */
 728 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
 729 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
 730 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
 731 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
 732 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
 733
 734 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
 735 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
 736 struct lustre_swap_layouts {
 737         __u64   sl_flags;
 738         __u32   sl_fd;
 739         __u32   sl_gid;
 740         __u64   sl_dv1;
 741         __u64   sl_dv2;
 742 };
 743
 744
 745 /********* Changelogs **********/
 746 /** Changelog record types */
 747 enum changelog_rec_type {
 748         CL_MARK     = 0,
 749         CL_CREATE   = 1,  /* namespace */
 750         CL_MKDIR    = 2,  /* namespace */
 751         CL_HARDLINK = 3,  /* namespace */
 752         CL_SOFTLINK = 4,  /* namespace */
 753         CL_MKNOD    = 5,  /* namespace */
 754         CL_UNLINK   = 6,  /* namespace */
 755         CL_RMDIR    = 7,  /* namespace */
 756         CL_RENAME   = 8,  /* namespace */
 757         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
 758         CL_OPEN     = 10, /* not currently used */
 759         CL_CLOSE    = 11, /* may be written to log only with mtime change */
 760         CL_LAYOUT   = 12, /* file layout/striping modified */
 761         CL_TRUNC    = 13,
 762         CL_SETATTR  = 14,
 763         CL_XATTR    = 15,
 764         CL_HSM      = 16, /* HSM specific events, see flags */
 765         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
 766         CL_CTIME    = 18,
 767         CL_ATIME    = 19,
 768         CL_MIGRATE  = 20,
 769         CL_LAST
 770 };
 771
 772 static inline const char *changelog_type2str(int type) {
 773         static const char *changelog_str[] = {
 774                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
 775                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
 776                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT"
 777         };
 778
 779         if (type >= 0 && type < CL_LAST)
 780                 return changelog_str[type];
 781         return NULL;
 782 }
 783
 784 /* per-record flags */
 785 #define CLF_FLAGSHIFT   12
 786 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
 787 #define CLF_VERMASK     (~CLF_FLAGMASK)
 788 enum changelog_rec_flags {
 789         CLF_VERSION     = 0x1000,
 790         CLF_RENAME      = 0x2000,
 791         CLF_JOBID       = 0x4000,
 792         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID
 793 };
 794
 795
 796 /* Anything under the flagmask may be per-type (if desired) */
 797 /* Flags for unlink */
 798 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
 799 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
 800                                      /* HSM cleaning needed */
 801 /* Flags for rename */
 802 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
 803                                         * of target */
 804 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
 805                                         * has an archive in backend */
 806
 807 /* Flags for HSM */
 808 /* 12b used (from high weight to low weight):
 809  * 2b for flags
 810  * 3b for event
 811  * 7b for error code
 812  */
 813 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
 814 #define CLF_HSM_ERR_H        6
 815 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
 816 #define CLF_HSM_EVENT_H      9
 817 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
 818 #define CLF_HSM_FLAG_H      11
 819 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
 820 #define CLF_HSM_SPARE_H     15
 821 #define CLF_HSM_LAST        15
 822
 823 /* Remove bits higher than _h, then extract the value
 824  * between _h and _l by shifting lower weigth to bit 0. */
 825 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
 826                                    >> (CLF_HSM_LAST - _h + _l))
 827
 828 #define CLF_HSM_SUCCESS      0x00
 829 #define CLF_HSM_MAXERROR     0x7E
 830 #define CLF_HSM_ERROVERFLOW  0x7F
 831
 832 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
 833
 834 /* 3 bits field => 8 values allowed */
 835 enum hsm_event {
 836         HE_ARCHIVE      = 0,
 837         HE_RESTORE      = 1,
 838         HE_CANCEL       = 2,
 839         HE_RELEASE      = 3,
 840         HE_REMOVE       = 4,
 841         HE_STATE        = 5,
 842         HE_SPARE1       = 6,
 843         HE_SPARE2       = 7,
 844 };
 845
 846 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
 847 {
 848         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
 849                                             CLF_HSM_EVENT_L);
 850 }
 851
 852 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
 853 {
 854         *flags |= (he << CLF_HSM_EVENT_L);
 855 }
 856
 857 static inline __u16 hsm_get_cl_flags(int flags)
 858 {
 859         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
 860 }
 861
 862 static inline void hsm_set_cl_flags(int *flags, int bits)
 863 {
 864         *flags |= (bits << CLF_HSM_FLAG_L);
 865 }
 866
 867 static inline int hsm_get_cl_error(int flags)
 868 {
 869         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
 870 }
 871
 872 static inline void hsm_set_cl_error(int *flags, int error)
 873 {
 874         *flags |= (error << CLF_HSM_ERR_L);
 875 }
 876
 877 enum changelog_send_flag {
 878         /* Not yet implemented */
 879         CHANGELOG_FLAG_FOLLOW   = 0x01,
 880         /* Blocking IO makes sense in case of slow user parsing of the records,
 881          * but it also prevents us from cleaning up if the records are not
 882          * consumed. */
 883         CHANGELOG_FLAG_BLOCK    = 0x02,
 884         /* Pack jobid into the changelog records if available. */
 885         CHANGELOG_FLAG_JOBID    = 0x04,
 886 };
 887
 888 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
 889                                   changelog_rec_offset(CLF_SUPPORTED))
 890
 891 /* 31 usable bytes string + null terminator. */
 892 #define LUSTRE_JOBID_SIZE       32
 893
 894 /* This is the minimal changelog record. It can contain extensions
 895  * such as rename fields or process jobid. Its exact content is described
 896  * by the cr_flags.
 897  *
 898  * Extensions are packed in the same order as their corresponding flags.
 899  */
 900 struct changelog_rec {
 901         __u16                   cr_namelen;
 902         __u16                   cr_flags; /**< \a changelog_rec_flags */
 903         __u32                   cr_type;  /**< \a changelog_rec_type */
 904         __u64                   cr_index; /**< changelog record number */
 905         __u64                   cr_prev;  /**< last index for this target fid */
 906         __u64                   cr_time;
 907         union {
 908                 lustre_fid      cr_tfid;        /**< target fid */
 909                 __u32           cr_markerflags; /**< CL_MARK flags */
 910         };
 911         lustre_fid              cr_pfid;        /**< parent fid */
 912 };
 913
 914 /* Changelog extension for RENAME. */
 915 struct changelog_ext_rename {
 916         lustre_fid              cr_sfid;     /**< source fid, or zero */
 917         lustre_fid              cr_spfid;    /**< source parent fid, or zero */
 918 };
 919
 920 /* Changelog extension to include JOBID. */
 921 struct changelog_ext_jobid {
 922         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
 923 };
 924
 925
 926 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf)
 927 {
 928         size_t size = sizeof(struct changelog_rec);
 929
 930         if (crf & CLF_RENAME)
 931                 size += sizeof(struct changelog_ext_rename);
 932
 933         if (crf & CLF_JOBID)
 934                 size += sizeof(struct changelog_ext_jobid);
 935
 936         return size;
 937 }
 938
 939 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
 940 {
 941         return changelog_rec_offset(rec->cr_flags);
 942 }
 943
 944 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
 945 {
 946         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
 947 }
 948
 949 static inline
 950 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
 951 {
 952         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
 953
 954         return (struct changelog_ext_rename *)((char *)rec +
 955                                                changelog_rec_offset(crf));
 956 }
 957
 958 /* The jobid follows the rename extension, if present */
 959 static inline
 960 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
 961 {
 962         enum changelog_rec_flags crf = rec->cr_flags &
 963                                         (CLF_VERSION | CLF_RENAME);
 964
 965         return (struct changelog_ext_jobid *)((char *)rec +
 966                                               changelog_rec_offset(crf));
 967 }
 968
 969 /* The name follows the rename and jobid extensions, if present */
 970 static inline char *changelog_rec_name(const struct changelog_rec *rec)
 971 {
 972         return (char *)rec + changelog_rec_offset(rec->cr_flags &
 973                                                   CLF_SUPPORTED);
 974 }
 975
 976 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
 977 {
 978         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
 979 }
 980
 981 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
 982 {
 983         char *cr_name = changelog_rec_name(rec);
 984
 985         return cr_name + strlen(cr_name) + 1;
 986 }
 987
 988 /**
 989  * Remap a record to the desired format as specified by the crf flags.
 990  * The record must be big enough to contain the final remapped version.
 991  * Superfluous extension fields are removed and missing ones are added
 992  * and zeroed. The flags of the record are updated accordingly.
 993  *
 994  * The jobid and rename extensions can be added to a record, to match the
 995  * format an application expects, typically. In this case, the newly added
 996  * fields will be zeroed.
 997  * The Jobid field can be removed, to guarantee compatibility with older
 998  * clients that don't expect this field in the records they process.
 999  *
1000  * The following assumptions are being made:
1001  *   - CLF_RENAME will not be removed
1002  *   - CLF_JOBID will not be added without CLF_RENAME being added too
1003  *
1004  * @param[in,out]  rec         The record to remap.
1005  * @param[in]      crf_wanted  Flags describing the desired extensions.
1006  */
1007 static inline void changelog_remap_rec(struct changelog_rec *rec,
1008                                        enum changelog_rec_flags crf_wanted)
1009 {
1010         char *jid_mov;
1011         char *rnm_mov;
1012
1013         crf_wanted &= CLF_SUPPORTED;
1014
1015         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted)
1016                 return;
1017
1018         /* First move the variable-length name field */
1019         memmove((char *)rec + changelog_rec_offset(crf_wanted),
1020                 changelog_rec_name(rec), rec->cr_namelen);
1021
1022         /* Locations of jobid and rename extensions in the remapped record */
1023         jid_mov = (char *)rec +
1024                   changelog_rec_offset(crf_wanted & ~CLF_JOBID);
1025         rnm_mov = (char *)rec +
1026                   changelog_rec_offset(crf_wanted & ~(CLF_JOBID | CLF_RENAME));
1027
1028         /* Move the extension fields to the desired positions */
1029         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1030                 memmove(jid_mov, changelog_rec_jobid(rec),
1031                         sizeof(struct changelog_ext_jobid));
1032
1033         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1034                 memmove(rnm_mov, changelog_rec_rename(rec),
1035                         sizeof(struct changelog_ext_rename));
1036
1037         /* Clear newly added fields */
1038         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1039                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1040
1041         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1042                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1043
1044         /* Update the record's flags accordingly */
1045         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1046 }
1047
1048 struct ioc_changelog {
1049         __u64 icc_recno;
1050         __u32 icc_mdtindex;
1051         __u32 icc_id;
1052         __u32 icc_flags;
1053 };
1054
1055 enum changelog_message_type {
1056         CL_RECORD = 10, /* message is a changelog_rec */
1057         CL_EOF    = 11, /* at end of current changelog */
1058 };
1059
1060 /********* Misc **********/
1061
1062 struct ioc_data_version {
1063         __u64 idv_version;
1064         __u64 idv_flags;     /* See LL_DV_xxx */
1065 };
1066 #define LL_DV_RD_FLUSH (1 << 0) /* Flush dirty pages from clients */
1067 #define LL_DV_WR_FLUSH (1 << 1) /* Flush all caching pages from clients */
1068
1069 #ifndef offsetof
1070 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1071 #endif
1072
1073 #define dot_lustre_name ".lustre"
1074
1075
1076 /********* HSM **********/
1077
1078 /** HSM per-file state
1079  * See HSM_FLAGS below.
1080  */
1081 enum hsm_states {
1082         HS_NONE         = 0x00000000,
1083         HS_EXISTS       = 0x00000001,
1084         HS_DIRTY        = 0x00000002,
1085         HS_RELEASED     = 0x00000004,
1086         HS_ARCHIVED     = 0x00000008,
1087         HS_NORELEASE    = 0x00000010,
1088         HS_NOARCHIVE    = 0x00000020,
1089         HS_LOST         = 0x00000040,
1090 };
1091
1092 /* HSM user-setable flags. */
1093 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1094
1095 /* Other HSM flags. */
1096 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1097
1098 /*
1099  * All HSM-related possible flags that could be applied to a file.
1100  * This should be kept in sync with hsm_states.
1101  */
1102 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1103
1104 /**
1105  * HSM request progress state
1106  */
1107 enum hsm_progress_states {
1108         HPS_WAITING     = 1,
1109         HPS_RUNNING     = 2,
1110         HPS_DONE        = 3,
1111 };
1112 #define HPS_NONE        0
1113
1114 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1115 {
1116         switch  (s) {
1117         case HPS_WAITING:       return "waiting";
1118         case HPS_RUNNING:       return "running";
1119         case HPS_DONE:          return "done";
1120         default:                return "unknown";
1121         }
1122 }
1123
1124 struct hsm_extent {
1125         __u64 offset;
1126         __u64 length;
1127 } __attribute__((packed));
1128
1129 /**
1130  * Current HSM states of a Lustre file.
1131  *
1132  * This structure purpose is to be sent to user-space mainly. It describes the
1133  * current HSM flags and in-progress action.
1134  */
1135 struct hsm_user_state {
1136         /** Current HSM states, from enum hsm_states. */
1137         __u32                   hus_states;
1138         __u32                   hus_archive_id;
1139         /**  The current undergoing action, if there is one */
1140         __u32                   hus_in_progress_state;
1141         __u32                   hus_in_progress_action;
1142         struct hsm_extent       hus_in_progress_location;
1143         char                    hus_extended_info[];
1144 };
1145
1146 struct hsm_state_set_ioc {
1147         struct lu_fid   hssi_fid;
1148         __u64           hssi_setmask;
1149         __u64           hssi_clearmask;
1150 };
1151
1152 /*
1153  * This structure describes the current in-progress action for a file.
1154  * it is retuned to user space and send over the wire
1155  */
1156 struct hsm_current_action {
1157         /**  The current undergoing action, if there is one */
1158         /* state is one of hsm_progress_states */
1159         __u32                   hca_state;
1160         /* action is one of hsm_user_action */
1161         __u32                   hca_action;
1162         struct hsm_extent       hca_location;
1163 };
1164
1165 /***** HSM user requests ******/
1166 /* User-generated (lfs/ioctl) request types */
1167 enum hsm_user_action {
1168         HUA_NONE    =  1, /* no action (noop) */
1169         HUA_ARCHIVE = 10, /* copy to hsm */
1170         HUA_RESTORE = 11, /* prestage */
1171         HUA_RELEASE = 12, /* drop ost objects */
1172         HUA_REMOVE  = 13, /* remove from archive */
1173         HUA_CANCEL  = 14  /* cancel a request */
1174 };
1175
1176 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1177 {
1178         switch  (a) {
1179         case HUA_NONE:    return "NOOP";
1180         case HUA_ARCHIVE: return "ARCHIVE";
1181         case HUA_RESTORE: return "RESTORE";
1182         case HUA_RELEASE: return "RELEASE";
1183         case HUA_REMOVE:  return "REMOVE";
1184         case HUA_CANCEL:  return "CANCEL";
1185         default:          return "UNKNOWN";
1186         }
1187 }
1188
1189 /*
1190  * List of hr_flags (bit field)
1191  */
1192 #define HSM_FORCE_ACTION 0x0001
1193 /* used by CT, cannot be set by user */
1194 #define HSM_GHOST_COPY   0x0002
1195
1196 /**
1197  * Contains all the fixed part of struct hsm_user_request.
1198  *
1199  */
1200 struct hsm_request {
1201         __u32 hr_action;        /* enum hsm_user_action */
1202         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1203         __u64 hr_flags;         /* request flags */
1204         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1205         __u32 hr_data_len;
1206 };
1207
1208 struct hsm_user_item {
1209        lustre_fid        hui_fid;
1210        struct hsm_extent hui_extent;
1211 } __attribute__((packed));
1212
1213 struct hsm_user_request {
1214         struct hsm_request      hur_request;
1215         struct hsm_user_item    hur_user_item[0];
1216         /* extra data blob at end of struct (after all
1217          * hur_user_items), only use helpers to access it
1218          */
1219 } __attribute__((packed));
1220
1221 /** Return pointer to data field in a hsm user request */
1222 static inline void *hur_data(struct hsm_user_request *hur)
1223 {
1224         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1225 }
1226
1227 /**
1228  * Compute the current length of the provided hsm_user_request.  This returns -1
1229  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1230  *
1231  * return -1 on bounds check error.
1232  */
1233 static inline ssize_t hur_len(struct hsm_user_request *hur)
1234 {
1235         __u64   size;
1236
1237         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1238         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1239                 (__u64)hur->hur_request.hr_itemcount *
1240                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1241
1242         if (size != (ssize_t)size)
1243                 return -1;
1244
1245         return size;
1246 }
1247
1248 /****** HSM RPCs to copytool *****/
1249 /* Message types the copytool may receive */
1250 enum hsm_message_type {
1251         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1252 };
1253
1254 /* Actions the copytool may be instructed to take for a given action_item */
1255 enum hsm_copytool_action {
1256         HSMA_NONE    = 10, /* no action */
1257         HSMA_ARCHIVE = 20, /* arbitrary offset */
1258         HSMA_RESTORE = 21,
1259         HSMA_REMOVE  = 22,
1260         HSMA_CANCEL  = 23
1261 };
1262
1263 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1264 {
1265         switch  (a) {
1266         case HSMA_NONE:    return "NOOP";
1267         case HSMA_ARCHIVE: return "ARCHIVE";
1268         case HSMA_RESTORE: return "RESTORE";
1269         case HSMA_REMOVE:  return "REMOVE";
1270         case HSMA_CANCEL:  return "CANCEL";
1271         default:           return "UNKNOWN";
1272         }
1273 }
1274
1275 /* Copytool item action description */
1276 struct hsm_action_item {
1277         __u32      hai_len;     /* valid size of this struct */
1278         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1279         lustre_fid hai_fid;     /* Lustre FID to operate on */
1280         lustre_fid hai_dfid;    /* fid used for data access */
1281         struct hsm_extent hai_extent;  /* byte range to operate on */
1282         __u64      hai_cookie;  /* action cookie from coordinator */
1283         __u64      hai_gid;     /* grouplock id */
1284         char       hai_data[0]; /* variable length */
1285 } __attribute__((packed));
1286
1287 /**
1288  * helper function which print in hexa the first bytes of
1289  * hai opaque field
1290  *
1291  * \param hai [IN]        record to print
1292  * \param buffer [IN,OUT] buffer to write the hex string to
1293  * \param len [IN]        max buffer length
1294  *
1295  * \retval buffer
1296  */
1297 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1298                                         char *buffer, size_t len)
1299 {
1300         int i;
1301         int data_len;
1302         char *ptr;
1303
1304         ptr = buffer;
1305         data_len = hai->hai_len - sizeof(*hai);
1306         for (i = 0; (i < data_len) && (len > 2); i++) {
1307                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1308                 ptr += 2;
1309                 len -= 2;
1310         }
1311
1312         *ptr = '\0';
1313
1314         return buffer;
1315 }
1316
1317 /* Copytool action list */
1318 #define HAL_VERSION 1
1319 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1320 struct hsm_action_list {
1321         __u32 hal_version;
1322         __u32 hal_count;       /* number of hai's to follow */
1323         __u64 hal_compound_id; /* returned by coordinator */
1324         __u64 hal_flags;
1325         __u32 hal_archive_id; /* which archive backend */
1326         __u32 padding1;
1327         char  hal_fsname[0];   /* null-terminated */
1328         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1329            boundaries. See hai_zero */
1330 } __attribute__((packed));
1331
1332 #ifndef HAVE_CFS_SIZE_ROUND
1333 static inline int cfs_size_round (int val)
1334 {
1335         return (val + 7) & (~0x7);
1336 }
1337 #define HAVE_CFS_SIZE_ROUND
1338 #endif
1339
1340 /* Return pointer to first hai in action list */
1341 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1342 {
1343         return (struct hsm_action_item *)(hal->hal_fsname +
1344                                           cfs_size_round(strlen(hal-> \
1345                                                                 hal_fsname)
1346                                                          + 1));
1347 }
1348 /* Return pointer to next hai */
1349 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1350 {
1351         return (struct hsm_action_item *)((char *)hai +
1352                                           cfs_size_round(hai->hai_len));
1353 }
1354
1355 /* Return size of an hsm_action_list */
1356 static inline size_t hal_size(struct hsm_action_list *hal)
1357 {
1358         __u32 i;
1359         size_t sz;
1360         struct hsm_action_item *hai;
1361
1362         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1363         hai = hai_first(hal);
1364         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1365                 sz += cfs_size_round(hai->hai_len);
1366
1367         return sz;
1368 }
1369
1370 /* HSM file import
1371  * describe the attributes to be set on imported file
1372  */
1373 struct hsm_user_import {
1374         __u64           hui_size;
1375         __u64           hui_atime;
1376         __u64           hui_mtime;
1377         __u32           hui_atime_ns;
1378         __u32           hui_mtime_ns;
1379         __u32           hui_uid;
1380         __u32           hui_gid;
1381         __u32           hui_mode;
1382         __u32           hui_archive_id;
1383 };
1384
1385 /* Copytool progress reporting */
1386 #define HP_FLAG_COMPLETED 0x01
1387 #define HP_FLAG_RETRY     0x02
1388
1389 struct hsm_progress {
1390         lustre_fid              hp_fid;
1391         __u64                   hp_cookie;
1392         struct hsm_extent       hp_extent;
1393         __u16                   hp_flags;
1394         __u16                   hp_errval; /* positive val */
1395         __u32                   padding;
1396 };
1397
1398 struct hsm_copy {
1399         __u64                   hc_data_version;
1400         __u16                   hc_flags;
1401         __u16                   hc_errval; /* positive val */
1402         __u32                   padding;
1403         struct hsm_action_item  hc_hai;
1404 };
1405
1406 /* JSON objects */
1407 enum llapi_json_types {
1408         LLAPI_JSON_INTEGER = 1,
1409         LLAPI_JSON_BIGNUM,
1410         LLAPI_JSON_REAL,
1411         LLAPI_JSON_STRING
1412 };
1413
1414 struct llapi_json_item {
1415         char                    *lji_key;
1416         __u32                   lji_type;
1417         union {
1418                 int     lji_integer;
1419                 __u64   lji_u64;
1420                 double  lji_real;
1421                 char    *lji_string;
1422         };
1423         struct llapi_json_item  *lji_next;
1424 };
1425
1426 struct llapi_json_item_list {
1427         int                     ljil_item_count;
1428         struct llapi_json_item  *ljil_items;
1429 };
1430
1431 enum lu_ladvise_type {
1432         LU_LADVISE_INVALID      = 0,
1433         LU_LADVISE_WILLREAD     = 1,
1434         LU_LADVISE_DONTNEED     = 2,
1435 };
1436
1437 #define LU_LADVISE_NAMES {                                              \
1438         [LU_LADVISE_WILLREAD]   = "willread",                           \
1439         [LU_LADVISE_DONTNEED]   = "dontneed",                           \
1440 }
1441
1442 /* This is the userspace argument for ladvise.  It is currently the same as
1443  * what goes on the wire (struct lu_ladvise), but is defined separately as we
1444  * may need info which is only used locally. */
1445 struct llapi_lu_ladvise {
1446         __u16 lla_advice;       /* advice type */
1447         __u16 lla_value1;       /* values for different advice types */
1448         __u32 lla_value2;
1449         __u64 lla_start;        /* first byte of extent for advice */
1450         __u64 lla_end;          /* last byte of extent for advice */
1451         __u32 lla_value3;
1452         __u32 lla_value4;
1453 };
1454
1455 enum ladvise_flag {
1456         LF_ASYNC        = 0x00000001,
1457 };
1458
1459 #define LADVISE_MAGIC 0x1ADF1CE0
1460 #define LF_MASK LF_ASYNC
1461
1462 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
1463  * is used on the wire.  It is defined separately as we may need info which is
1464  * only used locally. */
1465 struct llapi_ladvise_hdr {
1466         __u32                   lah_magic;      /* LADVISE_MAGIC */
1467         __u32                   lah_count;      /* number of advices */
1468         __u64                   lah_flags;      /* from enum ladvise_flag */
1469         __u32                   lah_value1;     /* unused */
1470         __u32                   lah_value2;     /* unused */
1471         __u64                   lah_value3;     /* unused */
1472         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
1473 };
1474
1475 #define LAH_COUNT_MAX   (1024)
1476
1477 /* Shared key */
1478 enum sk_crypt_alg {
1479         SK_CRYPT_INVALID        = -1,
1480         SK_CRYPT_EMPTY          = 0,
1481         SK_CRYPT_AES256_CTR     = 1,
1482         SK_CRYPT_MAX            = 2,
1483 };
1484
1485 struct sk_crypt_type {
1486         char            *cht_name;
1487         unsigned int     cht_key;
1488         unsigned int     cht_bytes;
1489 };
1490
1491 /** @} lustreuser */
1492 #endif /* _LUSTRE_USER_H */