lustre/include/lustre/lustre_user.h

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