lustre/include/lustre/lustre_user.h

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