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