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