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