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