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