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

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