lustre/include/lustre/lustre_user.h

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