lustre/include/uapi/linux/lustre/lustre_user.h

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