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