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