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