lustre/include/lustre/lustre_user.h

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