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