lustre/include/lustre/lustre_user.h

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