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