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