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