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