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