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