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