lustre/include/uapi/linux/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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2010, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/include/lustre/lustre_user.h
  33  *
  34  * Lustre public user-space interface definitions.
  35  */
  36
  37 #ifndef _LUSTRE_USER_H
  38 #define _LUSTRE_USER_H
  39
  40 /** \defgroup lustreuser lustreuser
  41  *
  42  * @{
  43  */
  44
  45 #include <linux/types.h>
  46
  47 #ifdef __KERNEL__
  48 # include <linux/fs.h>
  49 # include <linux/quota.h>
  50 # include <linux/string.h> /* snprintf() */
  51 # include <linux/version.h>
  52 # include <uapi/linux/lustre/lustre_fiemap.h>
  53 #else /* !__KERNEL__ */
  54 # define NEED_QUOTA_DEFS
  55 # include <limits.h>
  56 # include <stdbool.h>
  57 # include <stdio.h> /* snprintf() */
  58 # include <string.h>
  59 # include <sys/quota.h>
  60 # include <sys/stat.h>
  61 # include <linux/lustre/lustre_fiemap.h>
  62 #endif /* __KERNEL__ */
  63
  64 #if defined(__cplusplus)
  65 extern "C" {
  66 #endif
  67
  68 /*
  69  * This is a temporary solution of adding quota type.
  70  * Should be removed as soon as system header is updated.
  71  */
  72 #undef LL_MAXQUOTAS
  73 #define LL_MAXQUOTAS 3
  74 #undef INITQFNAMES
  75 #define INITQFNAMES { \
  76     "user",     /* USRQUOTA */ \
  77     "group",    /* GRPQUOTA */ \
  78     "project",  /* PRJQUOTA */ \
  79     "undefined", \
  80 };
  81 #define PRJQUOTA 2
  82
  83 #if defined(__x86_64__) || defined(__ia64__) || defined(__ppc64__) || \
  84     defined(__craynv) || defined(__mips64__) || defined(__powerpc64__) || \
  85     defined(__aarch64__)
  86 typedef struct stat     lstat_t;
  87 # define lstat_f        lstat
  88 # define fstat_f        fstat
  89 # define fstatat_f      fstatat
  90 # define HAVE_LOV_USER_MDS_DATA
  91 #elif defined(__USE_LARGEFILE64) || defined(__KERNEL__)
  92 typedef struct stat64   lstat_t;
  93 # define lstat_f        lstat64
  94 # define fstat_f        fstat64
  95 # define fstatat_f      fstatat64
  96 # define HAVE_LOV_USER_MDS_DATA
  97 #endif
  98
  99 #define LUSTRE_EOF 0xffffffffffffffffULL
 100
 101 /* for statfs() */
 102 #define LL_SUPER_MAGIC 0x0BD00BD0
 103
 104 #ifndef FSFILT_IOC_GETFLAGS
 105 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
 106 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
 107 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
 108 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
 109 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
 110 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
 111 #endif
 112
 113 /* FIEMAP flags supported by Lustre */
 114 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
 115
 116 enum obd_statfs_state {
 117         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
 118         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
 119         OS_STATE_ENOSPC         = 0x00000020, /**< not enough free space */
 120         OS_STATE_ENOINO         = 0x00000040, /**< not enough inodes */
 121 };
 122
 123 /** filesystem statistics/attributes for target device */
 124 struct obd_statfs {
 125         __u64           os_type;        /* EXT4_SUPER_MAGIC, UBERBLOCK_MAGIC */
 126         __u64           os_blocks;      /* total size in #os_bsize blocks */
 127         __u64           os_bfree;       /* number of unused blocks */
 128         __u64           os_bavail;      /* blocks available for allocation */
 129         __u64           os_files;       /* total number of objects */
 130         __u64           os_ffree;       /* # objects that could be created */
 131         __u8            os_fsid[40];    /* identifier for filesystem */
 132         __u32           os_bsize;       /* block size in bytes for os_blocks */
 133         __u32           os_namelen;     /* maximum length of filename in bytes*/
 134         __u64           os_maxbytes;    /* maximum object size in bytes */
 135         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
 136         __u32           os_fprecreated; /* objs available now to the caller */
 137                                         /* used in QoS code to find preferred
 138                                          * OSTs */
 139         __u32           os_spare2;      /* Unused padding fields.  Remember */
 140         __u32           os_spare3;      /* to fix lustre_swab_obd_statfs() */
 141         __u32           os_spare4;
 142         __u32           os_spare5;
 143         __u32           os_spare6;
 144         __u32           os_spare7;
 145         __u32           os_spare8;
 146         __u32           os_spare9;
 147 };
 148
 149 /**
 150  * File IDentifier.
 151  *
 152  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 153  * FIDs are never reused.
 154  **/
 155 struct lu_fid {
 156        /**
 157         * FID sequence. Sequence is a unit of migration: all files (objects)
 158         * with FIDs from a given sequence are stored on the same server.
 159         * Lustre should support 2^64 objects, so even if each sequence
 160         * has only a single object we can still enumerate 2^64 objects.
 161         **/
 162         __u64 f_seq;
 163         /* FID number within sequence. */
 164         __u32 f_oid;
 165         /**
 166          * FID version, used to distinguish different versions (in the sense
 167          * of snapshots, etc.) of the same file system object. Not currently
 168          * used.
 169          **/
 170         __u32 f_ver;
 171 };
 172
 173 static inline bool fid_is_zero(const struct lu_fid *fid)
 174 {
 175         return fid->f_seq == 0 && fid->f_oid == 0;
 176 }
 177
 178 /* Currently, the filter_fid::ff_parent::f_ver is not the real parent
 179  * MDT-object's FID::f_ver, instead it is the OST-object index in its
 180  * parent MDT-object's layout EA. */
 181 #define f_stripe_idx f_ver
 182
 183 struct ost_layout {
 184         __u32   ol_stripe_size;
 185         __u32   ol_stripe_count;
 186         __u64   ol_comp_start;
 187         __u64   ol_comp_end;
 188         __u32   ol_comp_id;
 189 } __attribute__((packed));
 190
 191 /* keep this one for compatibility */
 192 struct filter_fid_old {
 193         struct lu_fid   ff_parent;
 194         __u64           ff_objid;
 195         __u64           ff_seq;
 196 };
 197
 198 struct filter_fid {
 199         struct lu_fid           ff_parent;
 200         struct ost_layout       ff_layout;
 201         __u32                   ff_layout_version;
 202         __u32                   ff_range; /* range of layout version that
 203                                            * write are allowed */
 204 } __attribute__((packed));
 205
 206 /* Userspace should treat lu_fid as opaque, and only use the following methods
 207  * to print or parse them.  Other functions (e.g. compare, swab) could be moved
 208  * here from lustre_idl.h if needed. */
 209 struct lu_fid;
 210
 211 enum lma_compat {
 212         LMAC_HSM         = 0x00000001,
 213 /*      LMAC_SOM         = 0x00000002, obsolete since 2.8.0 */
 214         LMAC_NOT_IN_OI   = 0x00000004, /* the object does NOT need OI mapping */
 215         LMAC_FID_ON_OST  = 0x00000008, /* For OST-object, its OI mapping is
 216                                        * under /O/<seq>/d<x>. */
 217         LMAC_STRIPE_INFO = 0x00000010, /* stripe info in the LMA EA. */
 218         LMAC_COMP_INFO   = 0x00000020, /* Component info in the LMA EA. */
 219 };
 220
 221 /**
 222  * Masks for all features that should be supported by a Lustre version to
 223  * access a specific file.
 224  * This information is stored in lustre_mdt_attrs::lma_incompat.
 225  */
 226 enum lma_incompat {
 227         LMAI_RELEASED           = 0x00000001, /* file is released */
 228         LMAI_AGENT              = 0x00000002, /* agent inode */
 229         LMAI_REMOTE_PARENT      = 0x00000004, /* the parent of the object
 230                                                  is on the remote MDT */
 231         LMAI_STRIPED            = 0x00000008, /* striped directory inode */
 232         LMAI_ORPHAN             = 0x00000010, /* inode is orphan */
 233         LMA_INCOMPAT_SUPP       = (LMAI_AGENT | LMAI_REMOTE_PARENT | \
 234                                    LMAI_STRIPED | LMAI_ORPHAN)
 235 };
 236
 237
 238 /**
 239  * Following struct for object attributes, that will be kept inode's EA.
 240  * Introduced in 2.0 release (please see b15993, for details)
 241  * Added to all objects since Lustre 2.4 as contains self FID
 242  */
 243 struct lustre_mdt_attrs {
 244         /**
 245          * Bitfield for supported data in this structure. From enum lma_compat.
 246          * lma_self_fid and lma_flags are always available.
 247          */
 248         __u32   lma_compat;
 249         /**
 250          * Per-file incompat feature list. Lustre version should support all
 251          * flags set in this field. The supported feature mask is available in
 252          * LMA_INCOMPAT_SUPP.
 253          */
 254         __u32   lma_incompat;
 255         /** FID of this inode */
 256         struct lu_fid  lma_self_fid;
 257 };
 258
 259 struct lustre_ost_attrs {
 260         /* Use lustre_mdt_attrs directly for now, need a common header
 261          * structure if want to change lustre_mdt_attrs in future. */
 262         struct lustre_mdt_attrs loa_lma;
 263
 264         /* Below five elements are for OST-object's PFID EA, the
 265          * lma_parent_fid::f_ver is composed of the stripe_count (high 16 bits)
 266          * and the stripe_index (low 16 bits), the size should not exceed
 267          * 5 * sizeof(__u64)) to be accessable by old Lustre. If the flag
 268          * LMAC_STRIPE_INFO is set, then loa_parent_fid and loa_stripe_size
 269          * are valid; if the flag LMAC_COMP_INFO is set, then the next three
 270          * loa_comp_* elements are valid. */
 271         struct lu_fid   loa_parent_fid;
 272         __u32           loa_stripe_size;
 273         __u32           loa_comp_id;
 274         __u64           loa_comp_start;
 275         __u64           loa_comp_end;
 276 };
 277
 278 /**
 279  * Prior to 2.4, the LMA structure also included SOM attributes which has since
 280  * been moved to a dedicated xattr
 281  * lma_flags was also removed because of lma_compat/incompat fields.
 282  */
 283 #define LMA_OLD_SIZE (sizeof(struct lustre_mdt_attrs) + 5 * sizeof(__u64))
 284
 285 enum {
 286         LSOM_FL_VALID = 1 << 0,
 287 };
 288
 289 struct lustre_som_attrs {
 290         __u16   lsa_valid;
 291         __u16   lsa_reserved[3];
 292         __u64   lsa_size;
 293         __u64   lsa_blocks;
 294 };
 295
 296 /**
 297  * OST object IDentifier.
 298  */
 299 struct ost_id {
 300         union {
 301                 struct {
 302                         __u64   oi_id;
 303                         __u64   oi_seq;
 304                 } oi;
 305                 struct lu_fid oi_fid;
 306         };
 307 };
 308
 309 #define DOSTID "%#llx:%llu"
 310 #define POSTID(oi) ((unsigned long long)ostid_seq(oi)), \
 311                    ((unsigned long long)ostid_id(oi))
 312
 313 struct ll_futimes_3 {
 314         __u64 lfu_atime_sec;
 315         __u64 lfu_atime_nsec;
 316         __u64 lfu_mtime_sec;
 317         __u64 lfu_mtime_nsec;
 318         __u64 lfu_ctime_sec;
 319         __u64 lfu_ctime_nsec;
 320 };
 321
 322 /*
 323  * Maximum number of mirrors currently implemented.
 324  */
 325 #define LUSTRE_MIRROR_COUNT_MAX         16
 326
 327 /* Lease types for use as arg and return of LL_IOC_{GET,SET}_LEASE ioctl. */
 328 enum ll_lease_mode {
 329         LL_LEASE_RDLCK  = 0x01,
 330         LL_LEASE_WRLCK  = 0x02,
 331         LL_LEASE_UNLCK  = 0x04,
 332 };
 333
 334 enum ll_lease_flags {
 335         LL_LEASE_RESYNC         = 0x1,
 336         LL_LEASE_RESYNC_DONE    = 0x2,
 337 };
 338
 339 #define IOC_IDS_MAX     4096
 340 struct ll_ioc_lease {
 341         __u32           lil_mode;
 342         __u32           lil_flags;
 343         __u32           lil_count;
 344         __u32           lil_ids[0];
 345 };
 346
 347 /*
 348  * The ioctl naming rules:
 349  * LL_*     - works on the currently opened filehandle instead of parent dir
 350  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 351  * *_MDC_*  - gets/sets data related to MDC
 352  * *_LOV_*  - gets/sets data related to OSC/LOV
 353  * *FILE*   - called on parent dir and passes in a filename
 354  * *STRIPE* - set/get lov_user_md
 355  * *INFO    - set/get lov_user_mds_data
 356  */
 357 /*      lustre_ioctl.h                  101-150 */
 358 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 359 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 360 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 361 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 362 #define LL_IOC_LOV_SETSTRIPE_NEW        _IOWR('f', 154, struct lov_user_md)
 363 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 364 #define LL_IOC_LOV_GETSTRIPE_NEW        _IOR('f', 155, struct lov_user_md)
 365 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 366 /*      LL_IOC_RECREATE_OBJ             157 obsolete */
 367 /*      LL_IOC_RECREATE_FID             157 obsolete */
 368 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 369 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 370 /*      LL_IOC_QUOTACHECK               160 OBD_IOC_QUOTACHECK */
 371 /*      LL_IOC_POLL_QUOTACHECK          161 OBD_IOC_POLL_QUOTACHECK */
 372 /*      LL_IOC_QUOTACTL                 162 OBD_IOC_QUOTACTL */
 373 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 374 /*      IOC_LOV_GETINFO                 165 obsolete */
 375 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 376 /*      LL_IOC_RMTACL                   167 obsolete */
 377 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 378 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 379 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 380 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
 381 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 382 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 383 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 384 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 385 #define LL_IOC_FUTIMES_3                _IOWR('f', 176, struct ll_futimes_3)
 386 #define LL_IOC_FLR_SET_MIRROR           _IOW ('f', 177, long)
 387 /*      lustre_ioctl.h                  177-210 */
 388 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
 389 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
 390 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
 391 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
 392 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
 393 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
 394 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
 395 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
 396 #define LL_IOC_LOV_SWAP_LAYOUTS         _IOW('f', 219, \
 397                                                 struct lustre_swap_layouts)
 398 #define LL_IOC_HSM_ACTION               _IOR('f', 220, \
 399                                                 struct hsm_current_action)
 400 /*      lustre_ioctl.h                  221-232 */
 401 #define LL_IOC_LMV_SETSTRIPE            _IOWR('f', 240, struct lmv_user_md)
 402 #define LL_IOC_LMV_GETSTRIPE            _IOWR('f', 241, struct lmv_user_md)
 403 #define LL_IOC_REMOVE_ENTRY             _IOWR('f', 242, __u64)
 404 #define LL_IOC_SET_LEASE                _IOWR('f', 243, struct ll_ioc_lease)
 405 #define LL_IOC_SET_LEASE_OLD            _IOWR('f', 243, long)
 406 #define LL_IOC_GET_LEASE                _IO('f', 244)
 407 #define LL_IOC_HSM_IMPORT               _IOWR('f', 245, struct hsm_user_import)
 408 #define LL_IOC_LMV_SET_DEFAULT_STRIPE   _IOWR('f', 246, struct lmv_user_md)
 409 #define LL_IOC_MIGRATE                  _IOR('f', 247, int)
 410 #define LL_IOC_FID2MDTIDX               _IOWR('f', 248, struct lu_fid)
 411 #define LL_IOC_GETPARENT                _IOWR('f', 249, struct getparent)
 412 #define LL_IOC_LADVISE                  _IOR('f', 250, struct llapi_lu_ladvise)
 413
 414 #ifndef FS_IOC_FSGETXATTR
 415 /*
 416  * Structure for FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR.
 417 */
 418 struct fsxattr {
 419         __u32           fsx_xflags;     /* xflags field value (get/set) */
 420         __u32           fsx_extsize;    /* extsize field value (get/set)*/
 421         __u32           fsx_nextents;   /* nextents field value (get)   */
 422         __u32           fsx_projid;     /* project identifier (get/set) */
 423         unsigned char   fsx_pad[12];
 424 };
 425 #define FS_IOC_FSGETXATTR               _IOR('X', 31, struct fsxattr)
 426 #define FS_IOC_FSSETXATTR               _IOW('X', 32, struct fsxattr)
 427 #endif
 428 #define LL_IOC_FSGETXATTR               FS_IOC_FSGETXATTR
 429 #define LL_IOC_FSSETXATTR               FS_IOC_FSSETXATTR
 430 #define LL_PROJINHERIT_FL               0x20000000
 431
 432
 433 #define LL_STATFS_LMV           1
 434 #define LL_STATFS_LOV           2
 435 #define LL_STATFS_NODELAY       4
 436
 437 #define IOC_MDC_TYPE            'i'
 438 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 439 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 440 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 441 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 442
 443 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 444
 445 /* Define O_LOV_DELAY_CREATE to be a mask that is not useful for regular
 446  * files, but are unlikely to be used in practice and are not harmful if
 447  * used incorrectly.  O_NOCTTY and FASYNC are only meaningful for character
 448  * devices and are safe for use on new files. See LU-4209. */
 449 /* To be compatible with old statically linked binary we keep the check for
 450  * the older 0100000000 flag.  This is already removed upstream.  LU-812. */
 451 #define O_LOV_DELAY_CREATE_1_8  0100000000 /* FMODE_NONOTIFY masked in 2.6.36 */
 452 #define O_LOV_DELAY_CREATE_MASK (O_NOCTTY | FASYNC)
 453 #define O_LOV_DELAY_CREATE              (O_LOV_DELAY_CREATE_1_8 | \
 454                                          O_LOV_DELAY_CREATE_MASK)
 455
 456 #define LL_FILE_IGNORE_LOCK     0x00000001
 457 #define LL_FILE_GROUP_LOCKED    0x00000002
 458 #define LL_FILE_READAHEA        0x00000004
 459 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 460 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 461
 462 #define LOV_USER_MAGIC_V1       0x0BD10BD0
 463 #define LOV_USER_MAGIC          LOV_USER_MAGIC_V1
 464 #define LOV_USER_MAGIC_JOIN_V1  0x0BD20BD0
 465 #define LOV_USER_MAGIC_V3       0x0BD30BD0
 466 /* 0x0BD40BD0 is occupied by LOV_MAGIC_MIGRATE */
 467 #define LOV_USER_MAGIC_SPECIFIC 0x0BD50BD0      /* for specific OSTs */
 468 #define LOV_USER_MAGIC_COMP_V1  0x0BD60BD0
 469
 470 #define LMV_USER_MAGIC          0x0CD30CD0    /* default lmv magic */
 471 #define LMV_USER_MAGIC_V0       0x0CD20CD0    /* old default lmv magic*/
 472 #define LMV_USER_MAGIC_SPECIFIC 0x0CD40CD0
 473
 474 #define LOV_PATTERN_NONE        0x000
 475 #define LOV_PATTERN_RAID0       0x001
 476 #define LOV_PATTERN_RAID1       0x002
 477 #define LOV_PATTERN_MDT         0x100
 478 #define LOV_PATTERN_CMOBD       0x200
 479
 480 #define LOV_PATTERN_F_MASK      0xffff0000
 481 #define LOV_PATTERN_F_HOLE      0x40000000 /* there is hole in LOV EA */
 482 #define LOV_PATTERN_F_RELEASED  0x80000000 /* HSM released file */
 483 #define LOV_PATTERN_DEFAULT     0xffffffff
 484
 485 static inline bool lov_pattern_supported(__u32 pattern)
 486 {
 487         return pattern == LOV_PATTERN_RAID0 ||
 488                pattern == LOV_PATTERN_MDT ||
 489                pattern == (LOV_PATTERN_RAID0 | LOV_PATTERN_F_RELEASED);
 490 }
 491
 492 #define LOV_MAXPOOLNAME 15
 493 #define LOV_POOLNAMEF "%.15s"
 494
 495 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 496 #define LOV_MIN_STRIPE_SIZE (1 << LOV_MIN_STRIPE_BITS)
 497 #define LOV_MAX_STRIPE_COUNT_OLD 160
 498 /* This calculation is crafted so that input of 4096 will result in 160
 499  * which in turn is equal to old maximal stripe count.
 500  * XXX: In fact this is too simpified for now, what it also need is to get
 501  * ea_type argument to clearly know how much space each stripe consumes.
 502  *
 503  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 504  * allocation that is sufficient for the current generation of systems.
 505  *
 506  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 507 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 508 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 509 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 510
 511 #define XATTR_LUSTRE_PREFIX     "lustre."
 512 #define XATTR_LUSTRE_LOV        XATTR_LUSTRE_PREFIX"lov"
 513
 514 #define lov_user_ost_data lov_user_ost_data_v1
 515 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 516         struct ost_id l_ost_oi;   /* OST object ID */
 517         __u32 l_ost_gen;          /* generation of this OST index */
 518         __u32 l_ost_idx;          /* OST index in LOV */
 519 } __attribute__((packed));
 520
 521 #define lov_user_md lov_user_md_v1
 522 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 523         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 524         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 525         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 526         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 527         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 528         union {
 529                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 530                                            * lmm_objects, use when writing */
 531                 __u16 lmm_layout_gen;     /* layout generation number
 532                                            * used when reading */
 533         };
 534         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 535 } __attribute__((packed,  __may_alias__));
 536
 537 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 538         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 539         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 540         struct ost_id lmm_oi;     /* MDT parent inode id/seq (id/0 for 1.x) */
 541         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 542         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 543         union {
 544                 __u16 lmm_stripe_offset;  /* starting stripe offset in
 545                                            * lmm_objects, use when writing */
 546                 __u16 lmm_layout_gen;     /* layout generation number
 547                                            * used when reading */
 548         };
 549         char  lmm_pool_name[LOV_MAXPOOLNAME + 1]; /* pool name */
 550         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 551 } __attribute__((packed));
 552
 553 struct lu_extent {
 554         __u64   e_start;
 555         __u64   e_end;
 556 };
 557
 558 #define DEXT "[%#llx, %#llx)"
 559 #define PEXT(ext) (ext)->e_start, (ext)->e_end
 560
 561 static inline bool lu_extent_is_overlapped(struct lu_extent *e1,
 562                                            struct lu_extent *e2)
 563 {
 564         return e1->e_start < e2->e_end && e2->e_start < e1->e_end;
 565 }
 566
 567 static inline bool lu_extent_is_whole(struct lu_extent *e)
 568 {
 569         return e->e_start == 0 && e->e_end == LUSTRE_EOF;
 570 }
 571
 572 enum lov_comp_md_entry_flags {
 573         LCME_FL_STALE   = 0x00000001,   /* FLR: stale data */
 574         LCME_FL_PREF_RD = 0x00000002,   /* FLR: preferred for reading */
 575         LCME_FL_PREF_WR = 0x00000004,   /* FLR: preferred for writing */
 576         LCME_FL_PREF_RW = LCME_FL_PREF_RD | LCME_FL_PREF_WR,
 577         LCME_FL_OFFLINE = 0x00000008,   /* Not used */
 578         LCME_FL_INIT    = 0x00000010,   /* instantiated */
 579         LCME_FL_NEG     = 0x80000000    /* used to indicate a negative flag,
 580                                            won't be stored on disk */
 581 };
 582
 583 #define LCME_KNOWN_FLAGS        (LCME_FL_NEG | LCME_FL_INIT | LCME_FL_STALE | \
 584                                  LCME_FL_PREF_RW)
 585 /* The flags can be set by users at mirror creation time. */
 586 #define LCME_USER_FLAGS         (LCME_FL_PREF_RW)
 587
 588 /* the highest bit in obdo::o_layout_version is used to mark if the file is
 589  * being resynced. */
 590 #define LU_LAYOUT_RESYNC        LCME_FL_NEG
 591
 592 /* lcme_id can be specified as certain flags, and the the first
 593  * bit of lcme_id is used to indicate that the ID is representing
 594  * certain LCME_FL_* but not a real ID. Which implies we can have
 595  * at most 31 flags (see LCME_FL_XXX). */
 596 enum lcme_id {
 597         LCME_ID_INVAL   = 0x0,
 598         LCME_ID_MAX     = 0x7FFFFFFF,
 599         LCME_ID_ALL     = 0xFFFFFFFF,
 600         LCME_ID_NOT_ID  = LCME_FL_NEG
 601 };
 602
 603 #define LCME_ID_MASK    LCME_ID_MAX
 604
 605 struct lov_comp_md_entry_v1 {
 606         __u32                   lcme_id;        /* unique id of component */
 607         __u32                   lcme_flags;     /* LCME_FL_XXX */
 608         struct lu_extent        lcme_extent;    /* file extent for component */
 609         __u32                   lcme_offset;    /* offset of component blob,
 610                                                    start from lov_comp_md_v1 */
 611         __u32                   lcme_size;      /* size of component blob */
 612         __u64                   lcme_padding[2];
 613 } __attribute__((packed));
 614
 615 #define SEQ_ID_MAX              0x0000FFFF
 616 #define SEQ_ID_MASK             SEQ_ID_MAX
 617 /* bit 30:16 of lcme_id is used to store mirror id */
 618 #define MIRROR_ID_MASK          0x7FFF0000
 619 #define MIRROR_ID_SHIFT         16
 620
 621 static inline __u32 pflr_id(__u16 mirror_id, __u16 seqid)
 622 {
 623         return ((mirror_id << MIRROR_ID_SHIFT) & MIRROR_ID_MASK) | seqid;
 624 }
 625
 626 static inline __u16 mirror_id_of(__u32 id)
 627 {
 628         return (id & MIRROR_ID_MASK) >> MIRROR_ID_SHIFT;
 629 }
 630
 631 /**
 632  * on-disk data for lcm_flags. Valid if lcm_magic is LOV_MAGIC_COMP_V1.
 633  */
 634 enum lov_comp_md_flags {
 635         /* the least 2 bits are used by FLR to record file state */
 636         LCM_FL_NOT_FLR          = 0,
 637         LCM_FL_RDONLY           = 1,
 638         LCM_FL_WRITE_PENDING    = 2,
 639         LCM_FL_SYNC_PENDING     = 3,
 640         LCM_FL_FLR_MASK         = 0x3,
 641 };
 642
 643 struct lov_comp_md_v1 {
 644         __u32   lcm_magic;      /* LOV_USER_MAGIC_COMP_V1 */
 645         __u32   lcm_size;       /* overall size including this struct */
 646         __u32   lcm_layout_gen;
 647         __u16   lcm_flags;
 648         __u16   lcm_entry_count;
 649         /* lcm_mirror_count stores the number of actual mirrors minus 1,
 650          * so that non-flr files will have value 0 meaning 1 mirror. */
 651         __u16   lcm_mirror_count;
 652         __u16   lcm_padding1[3];
 653         __u64   lcm_padding2;
 654         struct lov_comp_md_entry_v1 lcm_entries[0];
 655 } __attribute__((packed));
 656
 657 static inline __u32 lov_user_md_size(__u16 stripes, __u32 lmm_magic)
 658 {
 659         if (stripes == (__u16)-1)
 660                 stripes = 0;
 661
 662         if (lmm_magic == LOV_USER_MAGIC_V1)
 663                 return sizeof(struct lov_user_md_v1) +
 664                               stripes * sizeof(struct lov_user_ost_data_v1);
 665         return sizeof(struct lov_user_md_v3) +
 666                                 stripes * sizeof(struct lov_user_ost_data_v1);
 667 }
 668
 669 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 670  * use this.  It is unsafe to #define those values in this header as it
 671  * is possible the application has already #included <sys/stat.h>. */
 672 #ifdef HAVE_LOV_USER_MDS_DATA
 673 #define lov_user_mds_data lov_user_mds_data_v1
 674 struct lov_user_mds_data_v1 {
 675         lstat_t lmd_st;                 /* MDS stat struct */
 676         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 677 } __attribute__((packed));
 678
 679 struct lov_user_mds_data_v3 {
 680         lstat_t lmd_st;                 /* MDS stat struct */
 681         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 682 } __attribute__((packed));
 683 #endif
 684
 685 struct lmv_user_mds_data {
 686         struct lu_fid   lum_fid;
 687         __u32           lum_padding;
 688         __u32           lum_mds;
 689 };
 690
 691 enum lmv_hash_type {
 692         LMV_HASH_TYPE_UNKNOWN   = 0,    /* 0 is reserved for testing purpose */
 693         LMV_HASH_TYPE_ALL_CHARS = 1,
 694         LMV_HASH_TYPE_FNV_1A_64 = 2,
 695         LMV_HASH_TYPE_MAX,
 696 };
 697
 698 #define LMV_HASH_NAME_ALL_CHARS "all_char"
 699 #define LMV_HASH_NAME_FNV_1A_64 "fnv_1a_64"
 700
 701 extern char *mdt_hash_name[LMV_HASH_TYPE_MAX];
 702
 703 /* Got this according to how get LOV_MAX_STRIPE_COUNT, see above,
 704  * (max buffer size - lmv+rpc header) / sizeof(struct lmv_user_mds_data) */
 705 #define LMV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 706 #define lmv_user_md lmv_user_md_v1
 707 struct lmv_user_md_v1 {
 708         __u32   lum_magic;       /* must be the first field */
 709         __u32   lum_stripe_count;  /* dirstripe count */
 710         __u32   lum_stripe_offset; /* MDT idx for default dirstripe */
 711         __u32   lum_hash_type;     /* Dir stripe policy */
 712         __u32   lum_type;         /* LMV type: default or normal */
 713         __u32   lum_padding1;
 714         __u32   lum_padding2;
 715         __u32   lum_padding3;
 716         char    lum_pool_name[LOV_MAXPOOLNAME + 1];
 717         struct  lmv_user_mds_data  lum_objects[0];
 718 } __attribute__((packed));
 719
 720 static inline int lmv_user_md_size(int stripes, int lmm_magic)
 721 {
 722         return sizeof(struct lmv_user_md) +
 723                       stripes * sizeof(struct lmv_user_mds_data);
 724 }
 725
 726 struct ll_recreate_obj {
 727         __u64 lrc_id;
 728         __u32 lrc_ost_idx;
 729 };
 730
 731 struct ll_fid {
 732         __u64 id;         /* holds object id */
 733         __u32 generation; /* holds object generation */
 734         __u32 f_type;     /* holds object type or stripe idx when passing it to
 735                            * OST for saving into EA. */
 736 };
 737
 738 #define UUID_MAX        40
 739 struct obd_uuid {
 740         char uuid[UUID_MAX];
 741 };
 742
 743 static inline bool obd_uuid_equals(const struct obd_uuid *u1,
 744                                    const struct obd_uuid *u2)
 745 {
 746         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 747 }
 748
 749 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 750 {
 751         return uuid->uuid[0] == '\0';
 752 }
 753
 754 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 755 {
 756         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 757         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 758 }
 759
 760 /* For printf's only, make sure uuid is terminated */
 761 static inline char *obd_uuid2str(const struct obd_uuid *uuid)
 762 {
 763         if (uuid == NULL)
 764                 return NULL;
 765
 766         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 767                 /* Obviously not safe, but for printfs, no real harm done...
 768                    we're always null-terminated, even in a race. */
 769                 static char temp[sizeof(*uuid)];
 770                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 771                 temp[sizeof(*uuid) - 1] = '\0';
 772                 return temp;
 773         }
 774         return (char *)(uuid->uuid);
 775 }
 776
 777 #define LUSTRE_MAXFSNAME 8
 778
 779 /* Extract fsname from uuid (or target name) of a target
 780    e.g. (myfs-OST0007_UUID -> myfs)
 781    see also deuuidify. */
 782 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 783 {
 784         char *p;
 785
 786         strncpy(buf, uuid, buflen - 1);
 787         buf[buflen - 1] = '\0';
 788         p = strrchr(buf, '-');
 789         if (p != NULL)
 790                 *p = '\0';
 791 }
 792
 793 /* printf display format for Lustre FIDs
 794  * usage: printf("file FID is "DFID"\n", PFID(fid)); */
 795 #define FID_NOBRACE_LEN 40
 796 #define FID_LEN (FID_NOBRACE_LEN + 2)
 797 #define DFID_NOBRACE "%#llx:0x%x:0x%x"
 798 #define DFID "["DFID_NOBRACE"]"
 799 #define PFID(fid) (unsigned long long)(fid)->f_seq, (fid)->f_oid, (fid)->f_ver
 800
 801 /* scanf input parse format for fids in DFID_NOBRACE format
 802  * Need to strip '[' from DFID format first or use "["SFID"]" at caller.
 803  * usage: sscanf(fidstr, SFID, RFID(&fid)); */
 804 #define SFID "0x%llx:0x%x:0x%x"
 805 #define RFID(fid) &((fid)->f_seq), &((fid)->f_oid), &((fid)->f_ver)
 806
 807 /********* Quotas **********/
 808
 809 #define LUSTRE_QUOTABLOCK_BITS 10
 810 #define LUSTRE_QUOTABLOCK_SIZE (1 << LUSTRE_QUOTABLOCK_BITS)
 811
 812 static inline __u64 lustre_stoqb(size_t space)
 813 {
 814         return (space + LUSTRE_QUOTABLOCK_SIZE - 1) >> LUSTRE_QUOTABLOCK_BITS;
 815 }
 816
 817 #define Q_QUOTACHECK    0x800100 /* deprecated as of 2.4 */
 818 #define Q_INITQUOTA     0x800101 /* deprecated as of 2.4  */
 819 #define Q_GETOINFO      0x800102 /* get obd quota info */
 820 #define Q_GETOQUOTA     0x800103 /* get obd quotas */
 821 #define Q_FINVALIDATE   0x800104 /* deprecated as of 2.4 */
 822
 823 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 824 #define LUSTRE_Q_QUOTAON    0x800002     /* deprecated as of 2.4 */
 825 #define LUSTRE_Q_QUOTAOFF   0x800003     /* deprecated as of 2.4 */
 826 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 827 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 828 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 829 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 830 /* lustre-specific control commands */
 831 #define LUSTRE_Q_INVALIDATE  0x80000b     /* deprecated as of 2.4 */
 832 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* deprecated as of 2.4 */
 833
 834 #define ALLQUOTA 255       /* set all quota */
 835 static inline char *qtype_name(int qtype)
 836 {
 837         switch (qtype) {
 838         case USRQUOTA:
 839                 return "usr";
 840         case GRPQUOTA:
 841                 return "grp";
 842         case PRJQUOTA:
 843                 return "prj";
 844         }
 845         return "unknown";
 846 }
 847
 848 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 849
 850 /* permission */
 851 #define N_PERMS_MAX      64
 852
 853 struct perm_downcall_data {
 854         __u64 pdd_nid;
 855         __u32 pdd_perm;
 856         __u32 pdd_padding;
 857 };
 858
 859 struct identity_downcall_data {
 860         __u32                            idd_magic;
 861         __u32                            idd_err;
 862         __u32                            idd_uid;
 863         __u32                            idd_gid;
 864         __u32                            idd_nperms;
 865         __u32                            idd_ngroups;
 866         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 867         __u32                            idd_groups[0];
 868 };
 869
 870 #ifdef NEED_QUOTA_DEFS
 871 #ifndef QIF_BLIMITS
 872 #define QIF_BLIMITS     1
 873 #define QIF_SPACE       2
 874 #define QIF_ILIMITS     4
 875 #define QIF_INODES      8
 876 #define QIF_BTIME       16
 877 #define QIF_ITIME       32
 878 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 879 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 880 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 881 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 882 #endif
 883
 884 #endif /* !__KERNEL__ */
 885
 886 /* lustre volatile file support
 887  * file name header: .^L^S^T^R:volatile"
 888  */
 889 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
 890 #define LUSTRE_VOLATILE_HDR_LEN 14
 891
 892 typedef enum lustre_quota_version {
 893         LUSTRE_QUOTA_V2 = 1
 894 } lustre_quota_version_t;
 895
 896 /* XXX: same as if_dqinfo struct in kernel */
 897 struct obd_dqinfo {
 898         __u64 dqi_bgrace;
 899         __u64 dqi_igrace;
 900         __u32 dqi_flags;
 901         __u32 dqi_valid;
 902 };
 903
 904 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 905 struct obd_dqblk {
 906         __u64 dqb_bhardlimit;
 907         __u64 dqb_bsoftlimit;
 908         __u64 dqb_curspace;
 909         __u64 dqb_ihardlimit;
 910         __u64 dqb_isoftlimit;
 911         __u64 dqb_curinodes;
 912         __u64 dqb_btime;
 913         __u64 dqb_itime;
 914         __u32 dqb_valid;
 915         __u32 dqb_padding;
 916 };
 917
 918 enum {
 919         QC_GENERAL      = 0,
 920         QC_MDTIDX       = 1,
 921         QC_OSTIDX       = 2,
 922         QC_UUID         = 3
 923 };
 924
 925 struct if_quotactl {
 926         __u32                   qc_cmd;
 927         __u32                   qc_type;
 928         __u32                   qc_id;
 929         __u32                   qc_stat;
 930         __u32                   qc_valid;
 931         __u32                   qc_idx;
 932         struct obd_dqinfo       qc_dqinfo;
 933         struct obd_dqblk        qc_dqblk;
 934         char                    obd_type[16];
 935         struct obd_uuid         obd_uuid;
 936 };
 937
 938 /* swap layout flags */
 939 #define SWAP_LAYOUTS_CHECK_DV1          (1 << 0)
 940 #define SWAP_LAYOUTS_CHECK_DV2          (1 << 1)
 941 #define SWAP_LAYOUTS_KEEP_MTIME         (1 << 2)
 942 #define SWAP_LAYOUTS_KEEP_ATIME         (1 << 3)
 943 #define SWAP_LAYOUTS_CLOSE              (1 << 4)
 944 #define MERGE_LAYOUTS_CLOSE             (1 << 5)
 945 #define INTENT_LAYOUTS_CLOSE    (SWAP_LAYOUTS_CLOSE | MERGE_LAYOUTS_CLOSE)
 946
 947 /* Swap XATTR_NAME_HSM as well, only on the MDT so far */
 948 #define SWAP_LAYOUTS_MDS_HSM            (1 << 31)
 949 struct lustre_swap_layouts {
 950         __u64   sl_flags;
 951         __u32   sl_fd;
 952         __u32   sl_gid;
 953         __u64   sl_dv1;
 954         __u64   sl_dv2;
 955 };
 956
 957 /** Bit-mask of valid attributes */
 958 /* The LA_* flags are written to disk as part of the ChangeLog records
 959  * so they are part of the on-disk and network protocol, and cannot be changed.
 960  * Only the first 12 bits are currently saved.
 961  */
 962 enum la_valid {
 963         LA_ATIME = 1 << 0,
 964         LA_MTIME = 1 << 1,
 965         LA_CTIME = 1 << 2,
 966         LA_SIZE  = 1 << 3,
 967         LA_MODE  = 1 << 4,
 968         LA_UID   = 1 << 5,
 969         LA_GID   = 1 << 6,
 970         LA_BLOCKS = 1 << 7,
 971         LA_TYPE   = 1 << 8,
 972         LA_FLAGS  = 1 << 9,
 973         LA_NLINK  = 1 << 10,
 974         LA_RDEV   = 1 << 11,
 975         LA_BLKSIZE = 1 << 12,
 976         LA_KILL_SUID = 1 << 13,
 977         LA_KILL_SGID = 1 << 14,
 978         LA_PROJID    = 1 << 15,
 979         LA_LAYOUT_VERSION = 1 << 16,
 980         /**
 981          * Attributes must be transmitted to OST objects
 982          */
 983         LA_REMOTE_ATTR_SET = (LA_UID | LA_GID | LA_PROJID | LA_LAYOUT_VERSION)
 984 };
 985
 986 /********* Changelogs **********/
 987 /** Changelog record types */
 988 enum changelog_rec_type {
 989         CL_MARK     = 0,
 990         CL_CREATE   = 1,  /* namespace */
 991         CL_MKDIR    = 2,  /* namespace */
 992         CL_HARDLINK = 3,  /* namespace */
 993         CL_SOFTLINK = 4,  /* namespace */
 994         CL_MKNOD    = 5,  /* namespace */
 995         CL_UNLINK   = 6,  /* namespace */
 996         CL_RMDIR    = 7,  /* namespace */
 997         CL_RENAME   = 8,  /* namespace */
 998         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
 999         CL_OPEN     = 10, /* not currently used */
1000         CL_CLOSE    = 11, /* may be written to log only with mtime change */
1001         CL_LAYOUT   = 12, /* file layout/striping modified */
1002         CL_TRUNC    = 13,
1003         CL_SETATTR  = 14,
1004         CL_XATTR    = 15,
1005         CL_HSM      = 16, /* HSM specific events, see flags */
1006         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
1007         CL_CTIME    = 18,
1008         CL_ATIME    = 19,
1009         CL_MIGRATE  = 20,
1010         CL_FLRW     = 21, /* FLR: file was firstly written */
1011         CL_RESYNC   = 22, /* FLR: file was resync-ed */
1012         CL_LAST
1013 };
1014
1015 static inline const char *changelog_type2str(int type) {
1016         static const char *changelog_str[] = {
1017                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
1018                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "LYOUT", "TRUNC",
1019                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME", "MIGRT",
1020                 "FLRW",  "RESYNC",
1021         };
1022
1023         if (type >= 0 && type < CL_LAST)
1024                 return changelog_str[type];
1025         return NULL;
1026 }
1027
1028 /* per-record flags */
1029 #define CLF_FLAGSHIFT   12
1030 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
1031 #define CLF_VERMASK     (~CLF_FLAGMASK)
1032 enum changelog_rec_flags {
1033         CLF_VERSION     = 0x1000,
1034         CLF_RENAME      = 0x2000,
1035         CLF_JOBID       = 0x4000,
1036         CLF_EXTRA_FLAGS = 0x8000,
1037         CLF_SUPPORTED   = CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS
1038 };
1039
1040
1041 /* Anything under the flagmask may be per-type (if desired) */
1042 /* Flags for unlink */
1043 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
1044 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
1045                                      /* HSM cleaning needed */
1046 /* Flags for rename */
1047 #define CLF_RENAME_LAST         0x0001 /* rename unlink last hardlink
1048                                         * of target */
1049 #define CLF_RENAME_LAST_EXISTS  0x0002 /* rename unlink last hardlink of target
1050                                         * has an archive in backend */
1051
1052 /* Flags for HSM */
1053 /* 12b used (from high weight to low weight):
1054  * 2b for flags
1055  * 3b for event
1056  * 7b for error code
1057  */
1058 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
1059 #define CLF_HSM_ERR_H        6
1060 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
1061 #define CLF_HSM_EVENT_H      9
1062 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
1063 #define CLF_HSM_FLAG_H      11
1064 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
1065 #define CLF_HSM_SPARE_H     15
1066 #define CLF_HSM_LAST        15
1067
1068 /* Remove bits higher than _h, then extract the value
1069  * between _h and _l by shifting lower weigth to bit 0. */
1070 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
1071                                    >> (CLF_HSM_LAST - _h + _l))
1072
1073 #define CLF_HSM_SUCCESS      0x00
1074 #define CLF_HSM_MAXERROR     0x7E
1075 #define CLF_HSM_ERROVERFLOW  0x7F
1076
1077 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
1078
1079 /* 3 bits field => 8 values allowed */
1080 enum hsm_event {
1081         HE_ARCHIVE      = 0,
1082         HE_RESTORE      = 1,
1083         HE_CANCEL       = 2,
1084         HE_RELEASE      = 3,
1085         HE_REMOVE       = 4,
1086         HE_STATE        = 5,
1087         HE_SPARE1       = 6,
1088         HE_SPARE2       = 7,
1089 };
1090
1091 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
1092 {
1093         return (enum hsm_event)CLF_GET_BITS(flags, CLF_HSM_EVENT_H,
1094                                             CLF_HSM_EVENT_L);
1095 }
1096
1097 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
1098 {
1099         *flags |= (he << CLF_HSM_EVENT_L);
1100 }
1101
1102 static inline __u16 hsm_get_cl_flags(int flags)
1103 {
1104         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
1105 }
1106
1107 static inline void hsm_set_cl_flags(int *flags, int bits)
1108 {
1109         *flags |= (bits << CLF_HSM_FLAG_L);
1110 }
1111
1112 static inline int hsm_get_cl_error(int flags)
1113 {
1114         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
1115 }
1116
1117 static inline void hsm_set_cl_error(int *flags, int error)
1118 {
1119         *flags |= (error << CLF_HSM_ERR_L);
1120 }
1121
1122 enum changelog_rec_extra_flags {
1123         CLFE_INVALID    = 0,
1124         CLFE_UIDGID     = 0x0001,
1125         CLFE_SUPPORTED  = CLFE_UIDGID
1126 };
1127
1128 enum changelog_send_flag {
1129         /* Not yet implemented */
1130         CHANGELOG_FLAG_FOLLOW      = 0x01,
1131         /* Blocking IO makes sense in case of slow user parsing of the records,
1132          * but it also prevents us from cleaning up if the records are not
1133          * consumed. */
1134         CHANGELOG_FLAG_BLOCK       = 0x02,
1135         /* Pack jobid into the changelog records if available. */
1136         CHANGELOG_FLAG_JOBID       = 0x04,
1137         /* Pack additional flag bits into the changelog record */
1138         CHANGELOG_FLAG_EXTRA_FLAGS = 0x08,
1139 };
1140
1141 enum changelog_send_extra_flag {
1142         /* Pack uid/gid into the changelog record */
1143         CHANGELOG_EXTRA_FLAG_UIDGID = 0x01,
1144 };
1145
1146 #define CR_MAXSIZE cfs_size_round(2 * NAME_MAX + 2 + \
1147                                   changelog_rec_offset(CLF_SUPPORTED, \
1148                                                         CLFE_SUPPORTED))
1149
1150 /* 31 usable bytes string + null terminator. */
1151 #define LUSTRE_JOBID_SIZE       32
1152
1153 /* This is the minimal changelog record. It can contain extensions
1154  * such as rename fields or process jobid. Its exact content is described
1155  * by the cr_flags and cr_extra_flags.
1156  *
1157  * Extensions are packed in the same order as their corresponding flags,
1158  * then in the same order as their corresponding extra flags.
1159  */
1160 struct changelog_rec {
1161         __u16                   cr_namelen;
1162         __u16                   cr_flags; /**< \a changelog_rec_flags */
1163         __u32                   cr_type;  /**< \a changelog_rec_type */
1164         __u64                   cr_index; /**< changelog record number */
1165         __u64                   cr_prev;  /**< last index for this target fid */
1166         __u64                   cr_time;
1167         union {
1168                 struct lu_fid   cr_tfid;        /**< target fid */
1169                 __u32           cr_markerflags; /**< CL_MARK flags */
1170         };
1171         struct lu_fid           cr_pfid;        /**< parent fid */
1172 };
1173
1174 /* Changelog extension for RENAME. */
1175 struct changelog_ext_rename {
1176         struct lu_fid           cr_sfid;     /**< source fid, or zero */
1177         struct lu_fid           cr_spfid;    /**< source parent fid, or zero */
1178 };
1179
1180 /* Changelog extension to include JOBID. */
1181 struct changelog_ext_jobid {
1182         char    cr_jobid[LUSTRE_JOBID_SIZE];    /**< zero-terminated string. */
1183 };
1184
1185 /* Changelog extension to include additional flags. */
1186 struct changelog_ext_extra_flags {
1187         __u64 cr_extra_flags; /* Additional CLFE_* flags */
1188 };
1189
1190 /* Changelog extra extension to include UID/GID. */
1191 struct changelog_ext_uidgid {
1192         __u64   cr_uid;
1193         __u64   cr_gid;
1194 };
1195
1196 static inline struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1197         const struct changelog_rec *rec);
1198
1199 static inline size_t changelog_rec_offset(enum changelog_rec_flags crf,
1200                                           enum changelog_rec_extra_flags cref)
1201 {
1202         size_t size = sizeof(struct changelog_rec);
1203
1204         if (crf & CLF_RENAME)
1205                 size += sizeof(struct changelog_ext_rename);
1206
1207         if (crf & CLF_JOBID)
1208                 size += sizeof(struct changelog_ext_jobid);
1209
1210         if (crf & CLF_EXTRA_FLAGS) {
1211                 size += sizeof(struct changelog_ext_extra_flags);
1212                 if (cref & CLFE_UIDGID)
1213                         size += sizeof(struct changelog_ext_uidgid);
1214         }
1215
1216         return size;
1217 }
1218
1219 static inline size_t changelog_rec_size(const struct changelog_rec *rec)
1220 {
1221         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1222
1223         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1224                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1225
1226         return changelog_rec_offset(rec->cr_flags, cref);
1227 }
1228
1229 static inline size_t changelog_rec_varsize(const struct changelog_rec *rec)
1230 {
1231         return changelog_rec_size(rec) - sizeof(*rec) + rec->cr_namelen;
1232 }
1233
1234 static inline
1235 struct changelog_ext_rename *changelog_rec_rename(const struct changelog_rec *rec)
1236 {
1237         enum changelog_rec_flags crf = rec->cr_flags & CLF_VERSION;
1238
1239         return (struct changelog_ext_rename *)((char *)rec +
1240                                                changelog_rec_offset(crf,
1241                                                                  CLFE_INVALID));
1242 }
1243
1244 /* The jobid follows the rename extension, if present */
1245 static inline
1246 struct changelog_ext_jobid *changelog_rec_jobid(const struct changelog_rec *rec)
1247 {
1248         enum changelog_rec_flags crf = rec->cr_flags &
1249                                         (CLF_VERSION | CLF_RENAME);
1250
1251         return (struct changelog_ext_jobid *)((char *)rec +
1252                                               changelog_rec_offset(crf,
1253                                                                  CLFE_INVALID));
1254 }
1255
1256 /* The additional flags follow the rename and jobid extensions, if present */
1257 static inline
1258 struct changelog_ext_extra_flags *changelog_rec_extra_flags(
1259         const struct changelog_rec *rec)
1260 {
1261         enum changelog_rec_flags crf = rec->cr_flags &
1262                 (CLF_VERSION | CLF_RENAME | CLF_JOBID);
1263
1264         return (struct changelog_ext_extra_flags *)((char *)rec +
1265                                                  changelog_rec_offset(crf,
1266                                                                  CLFE_INVALID));
1267 }
1268
1269 /* The uid/gid is the first extra extension */
1270 static inline
1271 struct changelog_ext_uidgid *changelog_rec_uidgid(
1272         const struct changelog_rec *rec)
1273 {
1274         enum changelog_rec_flags crf = rec->cr_flags &
1275                 (CLF_VERSION | CLF_RENAME | CLF_JOBID | CLF_EXTRA_FLAGS);
1276
1277         return (struct changelog_ext_uidgid *)((char *)rec +
1278                                                changelog_rec_offset(crf,
1279                                                                  CLFE_INVALID));
1280 }
1281
1282 /* The name follows the rename, jobid  and extra flags extns, if present */
1283 static inline char *changelog_rec_name(const struct changelog_rec *rec)
1284 {
1285         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1286
1287         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1288                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1289
1290         return (char *)rec + changelog_rec_offset(rec->cr_flags & CLF_SUPPORTED,
1291                                                   cref & CLFE_SUPPORTED);
1292 }
1293
1294 static inline size_t changelog_rec_snamelen(const struct changelog_rec *rec)
1295 {
1296         return rec->cr_namelen - strlen(changelog_rec_name(rec)) - 1;
1297 }
1298
1299 static inline char *changelog_rec_sname(const struct changelog_rec *rec)
1300 {
1301         char *cr_name = changelog_rec_name(rec);
1302
1303         return cr_name + strlen(cr_name) + 1;
1304 }
1305
1306 /**
1307  * Remap a record to the desired format as specified by the crf flags.
1308  * The record must be big enough to contain the final remapped version.
1309  * Superfluous extension fields are removed and missing ones are added
1310  * and zeroed. The flags of the record are updated accordingly.
1311  *
1312  * The jobid and rename extensions can be added to a record, to match the
1313  * format an application expects, typically. In this case, the newly added
1314  * fields will be zeroed.
1315  * The Jobid field can be removed, to guarantee compatibility with older
1316  * clients that don't expect this field in the records they process.
1317  *
1318  * The following assumptions are being made:
1319  *   - CLF_RENAME will not be removed
1320  *   - CLF_JOBID will not be added without CLF_RENAME being added too
1321  *   - CLF_EXTRA_FLAGS will not be added without CLF_JOBID being added too
1322  *
1323  * @param[in,out]  rec         The record to remap.
1324  * @param[in]      crf_wanted  Flags describing the desired extensions.
1325  * @param[in]      cref_want   Flags describing the desired extra extensions.
1326  */
1327 static inline void changelog_remap_rec(struct changelog_rec *rec,
1328                                        enum changelog_rec_flags crf_wanted,
1329                                        enum changelog_rec_extra_flags cref_want)
1330 {
1331         char *uidgid_mov = NULL;
1332         char *ef_mov;
1333         char *jid_mov;
1334         char *rnm_mov;
1335         enum changelog_rec_extra_flags cref = CLFE_INVALID;
1336
1337         crf_wanted &= CLF_SUPPORTED;
1338         cref_want &= CLFE_SUPPORTED;
1339
1340         if ((rec->cr_flags & CLF_SUPPORTED) == crf_wanted) {
1341                 if (!(rec->cr_flags & CLF_EXTRA_FLAGS) ||
1342                     (rec->cr_flags & CLF_EXTRA_FLAGS &&
1343                     (changelog_rec_extra_flags(rec)->cr_extra_flags &
1344                                                         CLFE_SUPPORTED) ==
1345                                                                      cref_want))
1346                         return;
1347         }
1348
1349         /* First move the variable-length name field */
1350         memmove((char *)rec + changelog_rec_offset(crf_wanted, cref_want),
1351                 changelog_rec_name(rec), rec->cr_namelen);
1352
1353         /* Locations of extensions in the remapped record */
1354         if (rec->cr_flags & CLF_EXTRA_FLAGS) {
1355                 uidgid_mov = (char *)rec +
1356                         changelog_rec_offset(crf_wanted & CLF_SUPPORTED,
1357                                              CLFE_INVALID);
1358                 cref = changelog_rec_extra_flags(rec)->cr_extra_flags;
1359         }
1360
1361         ef_mov  = (char *)rec +
1362                   changelog_rec_offset(crf_wanted & ~CLF_EXTRA_FLAGS,
1363                                        CLFE_INVALID);
1364         jid_mov = (char *)rec +
1365                   changelog_rec_offset(crf_wanted &
1366                                        ~(CLF_EXTRA_FLAGS | CLF_JOBID),
1367                                        CLFE_INVALID);
1368         rnm_mov = (char *)rec +
1369                   changelog_rec_offset(crf_wanted &
1370                                        ~(CLF_EXTRA_FLAGS |
1371                                          CLF_JOBID |
1372                                          CLF_RENAME),
1373                                        CLFE_INVALID);
1374
1375         /* Move the extension fields to the desired positions */
1376         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1377             (rec->cr_flags & CLF_EXTRA_FLAGS)) {
1378                 if ((cref_want & CLFE_UIDGID) && (cref & CLFE_UIDGID))
1379                         memmove(uidgid_mov, changelog_rec_uidgid(rec),
1380                                 sizeof(struct changelog_ext_uidgid));
1381
1382                 memmove(ef_mov, changelog_rec_extra_flags(rec),
1383                         sizeof(struct changelog_ext_extra_flags));
1384         }
1385
1386         if ((crf_wanted & CLF_JOBID) && (rec->cr_flags & CLF_JOBID))
1387                 memmove(jid_mov, changelog_rec_jobid(rec),
1388                         sizeof(struct changelog_ext_jobid));
1389
1390         if ((crf_wanted & CLF_RENAME) && (rec->cr_flags & CLF_RENAME))
1391                 memmove(rnm_mov, changelog_rec_rename(rec),
1392                         sizeof(struct changelog_ext_rename));
1393
1394         /* Clear newly added fields */
1395         if (uidgid_mov && (cref_want & CLFE_UIDGID) &&
1396             !(cref & CLFE_UIDGID))
1397                 memset(uidgid_mov, 0, sizeof(struct changelog_ext_uidgid));
1398
1399         if ((crf_wanted & CLF_EXTRA_FLAGS) &&
1400             !(rec->cr_flags & CLF_EXTRA_FLAGS))
1401                 memset(ef_mov, 0, sizeof(struct changelog_ext_extra_flags));
1402
1403         if ((crf_wanted & CLF_JOBID) && !(rec->cr_flags & CLF_JOBID))
1404                 memset(jid_mov, 0, sizeof(struct changelog_ext_jobid));
1405
1406         if ((crf_wanted & CLF_RENAME) && !(rec->cr_flags & CLF_RENAME))
1407                 memset(rnm_mov, 0, sizeof(struct changelog_ext_rename));
1408
1409         /* Update the record's flags accordingly */
1410         rec->cr_flags = (rec->cr_flags & CLF_FLAGMASK) | crf_wanted;
1411         if (rec->cr_flags & CLF_EXTRA_FLAGS)
1412                 changelog_rec_extra_flags(rec)->cr_extra_flags =
1413                         changelog_rec_extra_flags(rec)->cr_extra_flags |
1414                         cref_want;
1415 }
1416
1417 enum changelog_message_type {
1418         CL_RECORD = 10, /* message is a changelog_rec */
1419         CL_EOF    = 11, /* at end of current changelog */
1420 };
1421
1422 /********* Misc **********/
1423
1424 struct ioc_data_version {
1425         __u64   idv_version;
1426         __u32   idv_layout_version; /* FLR: layout version for OST objects */
1427         __u32   idv_flags;      /* enum ioc_data_version_flags */
1428 };
1429
1430 enum ioc_data_version_flags {
1431         LL_DV_RD_FLUSH  = (1 << 0), /* Flush dirty pages from clients */
1432         LL_DV_WR_FLUSH  = (1 << 1), /* Flush all caching pages from clients */
1433 };
1434
1435 #ifndef offsetof
1436 #define offsetof(typ, memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
1437 #endif
1438
1439 #define dot_lustre_name ".lustre"
1440
1441
1442 /********* HSM **********/
1443
1444 /** HSM per-file state
1445  * See HSM_FLAGS below.
1446  */
1447 enum hsm_states {
1448         HS_NONE         = 0x00000000,
1449         HS_EXISTS       = 0x00000001,
1450         HS_DIRTY        = 0x00000002,
1451         HS_RELEASED     = 0x00000004,
1452         HS_ARCHIVED     = 0x00000008,
1453         HS_NORELEASE    = 0x00000010,
1454         HS_NOARCHIVE    = 0x00000020,
1455         HS_LOST         = 0x00000040,
1456 };
1457
1458 /* HSM user-setable flags. */
1459 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
1460
1461 /* Other HSM flags. */
1462 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
1463
1464 /*
1465  * All HSM-related possible flags that could be applied to a file.
1466  * This should be kept in sync with hsm_states.
1467  */
1468 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
1469
1470 /**
1471  * HSM request progress state
1472  */
1473 enum hsm_progress_states {
1474         HPS_WAITING     = 1,
1475         HPS_RUNNING     = 2,
1476         HPS_DONE        = 3,
1477 };
1478 #define HPS_NONE        0
1479
1480 static inline const char *hsm_progress_state2name(enum hsm_progress_states s)
1481 {
1482         switch  (s) {
1483         case HPS_WAITING:       return "waiting";
1484         case HPS_RUNNING:       return "running";
1485         case HPS_DONE:          return "done";
1486         default:                return "unknown";
1487         }
1488 }
1489
1490 struct hsm_extent {
1491         __u64 offset;
1492         __u64 length;
1493 } __attribute__((packed));
1494
1495 /**
1496  * Current HSM states of a Lustre file.
1497  *
1498  * This structure purpose is to be sent to user-space mainly. It describes the
1499  * current HSM flags and in-progress action.
1500  */
1501 struct hsm_user_state {
1502         /** Current HSM states, from enum hsm_states. */
1503         __u32                   hus_states;
1504         __u32                   hus_archive_id;
1505         /**  The current undergoing action, if there is one */
1506         __u32                   hus_in_progress_state;
1507         __u32                   hus_in_progress_action;
1508         struct hsm_extent       hus_in_progress_location;
1509         char                    hus_extended_info[];
1510 };
1511
1512 struct hsm_state_set_ioc {
1513         struct lu_fid   hssi_fid;
1514         __u64           hssi_setmask;
1515         __u64           hssi_clearmask;
1516 };
1517
1518 /*
1519  * This structure describes the current in-progress action for a file.
1520  * it is retuned to user space and send over the wire
1521  */
1522 struct hsm_current_action {
1523         /**  The current undergoing action, if there is one */
1524         /* state is one of hsm_progress_states */
1525         __u32                   hca_state;
1526         /* action is one of hsm_user_action */
1527         __u32                   hca_action;
1528         struct hsm_extent       hca_location;
1529 };
1530
1531 /***** HSM user requests ******/
1532 /* User-generated (lfs/ioctl) request types */
1533 enum hsm_user_action {
1534         HUA_NONE    =  1, /* no action (noop) */
1535         HUA_ARCHIVE = 10, /* copy to hsm */
1536         HUA_RESTORE = 11, /* prestage */
1537         HUA_RELEASE = 12, /* drop ost objects */
1538         HUA_REMOVE  = 13, /* remove from archive */
1539         HUA_CANCEL  = 14  /* cancel a request */
1540 };
1541
1542 static inline const char *hsm_user_action2name(enum hsm_user_action  a)
1543 {
1544         switch  (a) {
1545         case HUA_NONE:    return "NOOP";
1546         case HUA_ARCHIVE: return "ARCHIVE";
1547         case HUA_RESTORE: return "RESTORE";
1548         case HUA_RELEASE: return "RELEASE";
1549         case HUA_REMOVE:  return "REMOVE";
1550         case HUA_CANCEL:  return "CANCEL";
1551         default:          return "UNKNOWN";
1552         }
1553 }
1554
1555 /*
1556  * List of hr_flags (bit field)
1557  */
1558 #define HSM_FORCE_ACTION 0x0001
1559 /* used by CT, cannot be set by user */
1560 #define HSM_GHOST_COPY   0x0002
1561
1562 /**
1563  * Contains all the fixed part of struct hsm_user_request.
1564  *
1565  */
1566 struct hsm_request {
1567         __u32 hr_action;        /* enum hsm_user_action */
1568         __u32 hr_archive_id;    /* archive id, used only with HUA_ARCHIVE */
1569         __u64 hr_flags;         /* request flags */
1570         __u32 hr_itemcount;     /* item count in hur_user_item vector */
1571         __u32 hr_data_len;
1572 };
1573
1574 struct hsm_user_item {
1575        struct lu_fid        hui_fid;
1576        struct hsm_extent hui_extent;
1577 } __attribute__((packed));
1578
1579 struct hsm_user_request {
1580         struct hsm_request      hur_request;
1581         struct hsm_user_item    hur_user_item[0];
1582         /* extra data blob at end of struct (after all
1583          * hur_user_items), only use helpers to access it
1584          */
1585 } __attribute__((packed));
1586
1587 /** Return pointer to data field in a hsm user request */
1588 static inline void *hur_data(struct hsm_user_request *hur)
1589 {
1590         return &(hur->hur_user_item[hur->hur_request.hr_itemcount]);
1591 }
1592
1593 /**
1594  * Compute the current length of the provided hsm_user_request.  This returns -1
1595  * instead of an errno because ssize_t is defined to be only [ -1, SSIZE_MAX ]
1596  *
1597  * return -1 on bounds check error.
1598  */
1599 static inline ssize_t hur_len(struct hsm_user_request *hur)
1600 {
1601         __u64   size;
1602
1603         /* can't overflow a __u64 since hr_itemcount is only __u32 */
1604         size = offsetof(struct hsm_user_request, hur_user_item[0]) +
1605                 (__u64)hur->hur_request.hr_itemcount *
1606                 sizeof(hur->hur_user_item[0]) + hur->hur_request.hr_data_len;
1607
1608         if (size != (ssize_t)size)
1609                 return -1;
1610
1611         return size;
1612 }
1613
1614 /****** HSM RPCs to copytool *****/
1615 /* Message types the copytool may receive */
1616 enum hsm_message_type {
1617         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
1618 };
1619
1620 /* Actions the copytool may be instructed to take for a given action_item */
1621 enum hsm_copytool_action {
1622         HSMA_NONE    = 10, /* no action */
1623         HSMA_ARCHIVE = 20, /* arbitrary offset */
1624         HSMA_RESTORE = 21,
1625         HSMA_REMOVE  = 22,
1626         HSMA_CANCEL  = 23
1627 };
1628
1629 static inline const char *hsm_copytool_action2name(enum hsm_copytool_action  a)
1630 {
1631         switch  (a) {
1632         case HSMA_NONE:    return "NOOP";
1633         case HSMA_ARCHIVE: return "ARCHIVE";
1634         case HSMA_RESTORE: return "RESTORE";
1635         case HSMA_REMOVE:  return "REMOVE";
1636         case HSMA_CANCEL:  return "CANCEL";
1637         default:           return "UNKNOWN";
1638         }
1639 }
1640
1641 /* Copytool item action description */
1642 struct hsm_action_item {
1643         __u32      hai_len;     /* valid size of this struct */
1644         __u32      hai_action;  /* hsm_copytool_action, but use known size */
1645         struct lu_fid hai_fid;     /* Lustre FID to operate on */
1646         struct lu_fid hai_dfid;    /* fid used for data access */
1647         struct hsm_extent hai_extent;  /* byte range to operate on */
1648         __u64      hai_cookie;  /* action cookie from coordinator */
1649         __u64      hai_gid;     /* grouplock id */
1650         char       hai_data[0]; /* variable length */
1651 } __attribute__((packed));
1652
1653 /**
1654  * helper function which print in hexa the first bytes of
1655  * hai opaque field
1656  *
1657  * \param hai [IN]        record to print
1658  * \param buffer [IN,OUT] buffer to write the hex string to
1659  * \param len [IN]        max buffer length
1660  *
1661  * \retval buffer
1662  */
1663 static inline char *hai_dump_data_field(const struct hsm_action_item *hai,
1664                                         char *buffer, size_t len)
1665 {
1666         int i;
1667         int data_len;
1668         char *ptr;
1669
1670         ptr = buffer;
1671         data_len = hai->hai_len - sizeof(*hai);
1672         for (i = 0; (i < data_len) && (len > 2); i++) {
1673                 snprintf(ptr, 3, "%02X", (unsigned char)hai->hai_data[i]);
1674                 ptr += 2;
1675                 len -= 2;
1676         }
1677
1678         *ptr = '\0';
1679
1680         return buffer;
1681 }
1682
1683 /* Copytool action list */
1684 #define HAL_VERSION 1
1685 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
1686 struct hsm_action_list {
1687         __u32 hal_version;
1688         __u32 hal_count;       /* number of hai's to follow */
1689         __u64 hal_compound_id; /* returned by coordinator */
1690         __u64 hal_flags;
1691         __u32 hal_archive_id; /* which archive backend */
1692         __u32 padding1;
1693         char  hal_fsname[0];   /* null-terminated */
1694         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
1695            boundaries. See hai_zero */
1696 } __attribute__((packed));
1697
1698 #ifndef HAVE_CFS_SIZE_ROUND
1699 static inline int cfs_size_round (int val)
1700 {
1701         return (val + 7) & (~0x7);
1702 }
1703 #define HAVE_CFS_SIZE_ROUND
1704 #endif
1705
1706 /* Return pointer to first hai in action list */
1707 static inline struct hsm_action_item *hai_first(struct hsm_action_list *hal)
1708 {
1709         return (struct hsm_action_item *)(hal->hal_fsname +
1710                                           cfs_size_round(strlen(hal-> \
1711                                                                 hal_fsname)
1712                                                          + 1));
1713 }
1714 /* Return pointer to next hai */
1715 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
1716 {
1717         return (struct hsm_action_item *)((char *)hai +
1718                                           cfs_size_round(hai->hai_len));
1719 }
1720
1721 /* Return size of an hsm_action_list */
1722 static inline size_t hal_size(struct hsm_action_list *hal)
1723 {
1724         __u32 i;
1725         size_t sz;
1726         struct hsm_action_item *hai;
1727
1728         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname) + 1);
1729         hai = hai_first(hal);
1730         for (i = 0; i < hal->hal_count ; i++, hai = hai_next(hai))
1731                 sz += cfs_size_round(hai->hai_len);
1732
1733         return sz;
1734 }
1735
1736 /* HSM file import
1737  * describe the attributes to be set on imported file
1738  */
1739 struct hsm_user_import {
1740         __u64           hui_size;
1741         __u64           hui_atime;
1742         __u64           hui_mtime;
1743         __u32           hui_atime_ns;
1744         __u32           hui_mtime_ns;
1745         __u32           hui_uid;
1746         __u32           hui_gid;
1747         __u32           hui_mode;
1748         __u32           hui_archive_id;
1749 };
1750
1751 /* Copytool progress reporting */
1752 #define HP_FLAG_COMPLETED 0x01
1753 #define HP_FLAG_RETRY     0x02
1754
1755 struct hsm_progress {
1756         struct lu_fid           hp_fid;
1757         __u64                   hp_cookie;
1758         struct hsm_extent       hp_extent;
1759         __u16                   hp_flags;
1760         __u16                   hp_errval; /* positive val */
1761         __u32                   padding;
1762 };
1763
1764 struct hsm_copy {
1765         __u64                   hc_data_version;
1766         __u16                   hc_flags;
1767         __u16                   hc_errval; /* positive val */
1768         __u32                   padding;
1769         struct hsm_action_item  hc_hai;
1770 };
1771
1772 /* JSON objects */
1773 enum llapi_json_types {
1774         LLAPI_JSON_INTEGER = 1,
1775         LLAPI_JSON_BIGNUM,
1776         LLAPI_JSON_REAL,
1777         LLAPI_JSON_STRING
1778 };
1779
1780 struct llapi_json_item {
1781         char                    *lji_key;
1782         __u32                   lji_type;
1783         union {
1784                 int     lji_integer;
1785                 __u64   lji_u64;
1786                 double  lji_real;
1787                 char    *lji_string;
1788         };
1789         struct llapi_json_item  *lji_next;
1790 };
1791
1792 struct llapi_json_item_list {
1793         int                     ljil_item_count;
1794         struct llapi_json_item  *ljil_items;
1795 };
1796
1797 enum lu_ladvise_type {
1798         LU_LADVISE_INVALID      = 0,
1799         LU_LADVISE_WILLREAD     = 1,
1800         LU_LADVISE_DONTNEED     = 2,
1801         LU_LADVISE_LOCKNOEXPAND = 3,
1802         LU_LADVISE_LOCKAHEAD    = 4,
1803         LU_LADVISE_MAX
1804 };
1805
1806 #define LU_LADVISE_NAMES {                                              \
1807         [LU_LADVISE_WILLREAD]           = "willread",                   \
1808         [LU_LADVISE_DONTNEED]           = "dontneed",                   \
1809         [LU_LADVISE_LOCKNOEXPAND]       = "locknoexpand",               \
1810         [LU_LADVISE_LOCKAHEAD]          = "lockahead",                  \
1811 }
1812
1813 /* This is the userspace argument for ladvise.  It is currently the same as
1814  * what goes on the wire (struct lu_ladvise), but is defined separately as we
1815  * may need info which is only used locally. */
1816 struct llapi_lu_ladvise {
1817         __u16 lla_advice;       /* advice type */
1818         __u16 lla_value1;       /* values for different advice types */
1819         __u32 lla_value2;
1820         __u64 lla_start;        /* first byte of extent for advice */
1821         __u64 lla_end;          /* last byte of extent for advice */
1822         __u32 lla_value3;
1823         __u32 lla_value4;
1824 };
1825
1826 enum ladvise_flag {
1827         LF_ASYNC        = 0x00000001,
1828         LF_UNSET        = 0x00000002,
1829 };
1830
1831 #define LADVISE_MAGIC 0x1ADF1CE0
1832 /* Masks of valid flags for each advice */
1833 #define LF_LOCKNOEXPAND_MASK LF_UNSET
1834 /* Flags valid for all advices not explicitly specified */
1835 #define LF_DEFAULT_MASK LF_ASYNC
1836 /* All flags */
1837 #define LF_MASK (LF_ASYNC | LF_UNSET)
1838
1839 #define lla_lockahead_mode   lla_value1
1840 #define lla_peradvice_flags    lla_value2
1841 #define lla_lockahead_result lla_value3
1842
1843 /* This is the userspace argument for ladvise, corresponds to ladvise_hdr which
1844  * is used on the wire.  It is defined separately as we may need info which is
1845  * only used locally. */
1846 struct llapi_ladvise_hdr {
1847         __u32                   lah_magic;      /* LADVISE_MAGIC */
1848         __u32                   lah_count;      /* number of advices */
1849         __u64                   lah_flags;      /* from enum ladvise_flag */
1850         __u32                   lah_value1;     /* unused */
1851         __u32                   lah_value2;     /* unused */
1852         __u64                   lah_value3;     /* unused */
1853         struct llapi_lu_ladvise lah_advise[0];  /* advices in this header */
1854 };
1855
1856 #define LAH_COUNT_MAX   (1024)
1857
1858 /* Shared key */
1859 enum sk_crypt_alg {
1860         SK_CRYPT_INVALID        = -1,
1861         SK_CRYPT_EMPTY          = 0,
1862         SK_CRYPT_AES256_CTR     = 1,
1863         SK_CRYPT_MAX            = 2,
1864 };
1865
1866 enum sk_hmac_alg {
1867         SK_HMAC_INVALID = -1,
1868         SK_HMAC_EMPTY   = 0,
1869         SK_HMAC_SHA256  = 1,
1870         SK_HMAC_SHA512  = 2,
1871         SK_HMAC_MAX     = 3,
1872 };
1873
1874 struct sk_crypt_type {
1875         char    *sct_name;
1876         size_t   sct_bytes;
1877 };
1878
1879 struct sk_hmac_type {
1880         char    *sht_name;
1881         size_t   sht_bytes;
1882 };
1883
1884 enum lock_mode_user {
1885         MODE_READ_USER = 1,
1886         MODE_WRITE_USER,
1887         MODE_MAX_USER,
1888 };
1889
1890 #define LOCK_MODE_NAMES { \
1891         [MODE_READ_USER]  = "READ",\
1892         [MODE_WRITE_USER] = "WRITE"\
1893 }
1894
1895 enum lockahead_results {
1896         LLA_RESULT_SENT = 0,
1897         LLA_RESULT_DIFFERENT,
1898         LLA_RESULT_SAME,
1899 };
1900
1901 #if defined(__cplusplus)
1902 }
1903 #endif
1904
1905 /** @} lustreuser */
1906
1907 #endif /* _LUSTRE_USER_H */