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