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