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