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