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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2010, 2012, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/include/lustre/lustre_user.h
  37  *
  38  * Lustre public user-space interface definitions.
  39  */
  40
  41 #ifndef _LUSTRE_USER_H
  42 #define _LUSTRE_USER_H
  43
  44 /** \defgroup lustreuser lustreuser
  45  *
  46  * @{
  47  */
  48
  49 #ifndef __KERNEL__
  50 #include <libcfs/posix/posix-types.h>
  51 #endif
  52 #include <lustre/ll_fiemap.h>
  53 #if defined(__linux__)
  54 #include <linux/lustre_user.h>
  55 #elif defined(__APPLE__)
  56 #include <darwin/lustre_user.h>
  57 #elif defined(__WINNT__)
  58 #include <winnt/lustre_user.h>
  59 #else
  60 #error Unsupported operating system.
  61 #endif
  62
  63 /* for statfs() */
  64 #define LL_SUPER_MAGIC 0x0BD00BD0
  65
  66 #ifndef FSFILT_IOC_GETFLAGS
  67 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
  68 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
  69 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
  70 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
  71 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  72 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  73 #define FSFILT_IOC_FIEMAP                 _IOWR('f', 11, struct ll_user_fiemap)
  74 #endif
  75
  76 /* FIEMAP flags supported by Lustre */
  77 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
  78
  79 enum obd_statfs_state {
  80         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
  81         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
  82         OS_STATE_RDONLY_1       = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
  83         OS_STATE_RDONLY_2       = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
  84         OS_STATE_RDONLY_3       = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
  85 };
  86
  87 struct obd_statfs {
  88         __u64           os_type;
  89         __u64           os_blocks;
  90         __u64           os_bfree;
  91         __u64           os_bavail;
  92         __u64           os_files;
  93         __u64           os_ffree;
  94         __u8            os_fsid[40];
  95         __u32           os_bsize;
  96         __u32           os_namelen;
  97         __u64           os_maxbytes;
  98         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
  99         __u32           os_fprecreated; /* objs available now to the caller */
 100                                         /* used in QoS code to find preferred
 101                                          * OSTs */
 102         __u32           os_spare2;
 103         __u32           os_spare3;
 104         __u32           os_spare4;
 105         __u32           os_spare5;
 106         __u32           os_spare6;
 107         __u32           os_spare7;
 108         __u32           os_spare8;
 109         __u32           os_spare9;
 110 };
 111
 112
 113 /*
 114  * The ioctl naming rules:
 115  * LL_*     - works on the currently opened filehandle instead of parent dir
 116  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 117  * *_MDC_*  - gets/sets data related to MDC
 118  * *_LOV_*  - gets/sets data related to OSC/LOV
 119  * *FILE*   - called on parent dir and passes in a filename
 120  * *STRIPE* - set/get lov_user_md
 121  * *INFO    - set/get lov_user_mds_data
 122  */
 123 /* see <lustre_lib.h> for ioctl numberss 101-150 */
 124 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 125 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 126 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 127 /* LL_IOC_LOV_SETSTRIPE: See also OBD_IOC_LOV_SETSTRIPE */
 128 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 129 /* LL_IOC_LOV_GETSTRIPE: See also OBD_IOC_LOV_GETSTRIPE */
 130 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 131 /* LL_IOC_LOV_SETEA: See also OBD_IOC_LOV_SETEA */
 132 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 133 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
 134 #define LL_IOC_RECREATE_FID             _IOW ('f', 157, struct lu_fid)
 135 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 136 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 137 /* LL_IOC_QUOTACHECK: See also OBD_IOC_QUOTACHECK */
 138 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
 139 /* LL_IOC_POLL_QUOTACHECK: See also OBD_IOC_POLL_QUOTACHECK */
 140 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
 141 /* LL_IOC_QUOTACTL: See also OBD_IOC_QUOTACTL */
 142 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl)
 143 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 144 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
 145 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 146 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
 147 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 148 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 149 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 150 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, struct lu_fid)
 151 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 152 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 153 #define LL_IOC_GET_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 154 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 155
 156 /* see <lustre_lib.h> for ioctl numbers 177-210 */
 157
 158 #define LL_IOC_HSM_STATE_GET            _IOR('f', 211, struct hsm_user_state)
 159 #define LL_IOC_HSM_STATE_SET            _IOW('f', 212, struct hsm_state_set)
 160 #define LL_IOC_HSM_CT_START             _IOW('f', 213, struct lustre_kernelcomm)
 161 #define LL_IOC_HSM_COPY_START           _IOW('f', 214, struct hsm_copy *)
 162 #define LL_IOC_HSM_COPY_END             _IOW('f', 215, struct hsm_copy *)
 163 #define LL_IOC_HSM_PROGRESS             _IOW('f', 216, struct hsm_user_request)
 164 #define LL_IOC_HSM_REQUEST              _IOW('f', 217, struct hsm_user_request)
 165 #define LL_IOC_DATA_VERSION             _IOR('f', 218, struct ioc_data_version)
 166
 167 #define LL_STATFS_LMV           1
 168 #define LL_STATFS_LOV           2
 169 #define LL_STATFS_NODELAY       4
 170
 171 #define IOC_MDC_TYPE            'i'
 172 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 173 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 174 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 175 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 176
 177 /* Keep these for backward compartability. */
 178 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
 179 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
 180
 181
 182 #define MAX_OBD_NAME 128 /* If this changes, a NEW ioctl must be added */
 183
 184 /* Hopefully O_LOV_DELAY_CREATE does not conflict with standard O_xxx flags.
 185  * Previously it was defined as 0100000000 and conflicts with FMODE_NONOTIFY
 186  * which was added since kernel 2.6.36, so we redefine it as 020000000.
 187  * To be compatible with old version's statically linked binary, finally we
 188  * define it as (020000000 | 0100000000).
 189  * */
 190 #define O_LOV_DELAY_CREATE      0120000000
 191
 192 #define LL_FILE_IGNORE_LOCK     0x00000001
 193 #define LL_FILE_GROUP_LOCKED    0x00000002
 194 #define LL_FILE_READAHEA        0x00000004
 195 #define LL_FILE_LOCKED_DIRECTIO 0x00000008 /* client-side locks with dio */
 196 #define LL_FILE_LOCKLESS_IO     0x00000010 /* server-side locks with cio */
 197 #define LL_FILE_RMTACL          0x00000020
 198
 199 #define LOV_USER_MAGIC_V1 0x0BD10BD0
 200 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
 201 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
 202 #define LOV_USER_MAGIC_V3 0x0BD30BD0
 203
 204 #define LOV_PATTERN_RAID0 0x001
 205 #define LOV_PATTERN_RAID1 0x002
 206 #define LOV_PATTERN_FIRST 0x100
 207
 208 #define LOV_MAXPOOLNAME 16
 209 #define LOV_POOLNAMEF "%.16s"
 210
 211 #define LOV_MIN_STRIPE_BITS 16   /* maximum PAGE_SIZE (ia64), power of 2 */
 212 #define LOV_MIN_STRIPE_SIZE (1<<LOV_MIN_STRIPE_BITS)
 213 #define LOV_MAX_STRIPE_COUNT_OLD 160
 214 /* This calculation is crafted so that input of 4096 will result in 160
 215  * which in turn is equal to old maximal stripe count.
 216  * XXX: In fact this is too simpified for now, what it also need is to get
 217  * ea_type argument to clearly know how much space each stripe consumes.
 218  *
 219  * The limit of 12 pages is somewhat arbitrary, but is a reasonably large
 220  * allocation that is sufficient for the current generation of systems.
 221  *
 222  * (max buffer size - lov+rpc header) / sizeof(struct lov_ost_data_v1) */
 223 #define LOV_MAX_STRIPE_COUNT 2000  /* ((12 * 4096 - 256) / 24) */
 224 #define LOV_ALL_STRIPES       0xffff /* only valid for directories */
 225 #define LOV_V1_INSANE_STRIPE_COUNT 65532 /* maximum stripe count bz13933 */
 226
 227 #define lov_user_ost_data lov_user_ost_data_v1
 228 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 229         __u64 l_object_id;        /* OST object ID */
 230         __u64 l_object_seq;       /* OST object seq number */
 231         __u32 l_ost_gen;          /* generation of this OST index */
 232         __u32 l_ost_idx;          /* OST index in LOV */
 233 } __attribute__((packed));
 234
 235 #define lov_user_md lov_user_md_v1
 236 #define lmm_stripe_offset u.lum_stripe_offset
 237 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 238         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 239         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 240         __u64 lmm_object_id;      /* LOV object ID */
 241         __u64 lmm_object_seq;     /* LOV object seq */
 242         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 243         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 244         union {
 245                 __u16 lum_stripe_offset;  /* starting stripe offset in
 246                                            * lmm_objects, use when writing */
 247                 __u16 lum_layout_gen;     /* layout generation number
 248                                            * used when reading */
 249         } u;
 250         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 251 } __attribute__((packed,  __may_alias__));
 252
 253 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 254         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 255         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 256         __u64 lmm_object_id;      /* LOV object ID */
 257         __u64 lmm_object_seq;     /* LOV object seq */
 258         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 259         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 260         union {
 261                 __u16 lum_stripe_offset;  /* starting stripe offset in
 262                                            * lmm_objects, use when writing */
 263                 __u16 lum_layout_gen;     /* layout generation number
 264                                            * used when reading */
 265         } u;
 266         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
 267         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 268 } __attribute__((packed));
 269
 270 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 271  * use this.  It is unsafe to #define those values in this header as it
 272  * is possible the application has already #included <sys/stat.h>. */
 273 #ifdef HAVE_LOV_USER_MDS_DATA
 274 #define lov_user_mds_data lov_user_mds_data_v1
 275 struct lov_user_mds_data_v1 {
 276         lstat_t lmd_st;                 /* MDS stat struct */
 277         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 278 } __attribute__((packed));
 279
 280 struct lov_user_mds_data_v3 {
 281         lstat_t lmd_st;                 /* MDS stat struct */
 282         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 283 } __attribute__((packed));
 284 #endif
 285
 286 struct ll_recreate_obj {
 287         __u64 lrc_id;
 288         __u32 lrc_ost_idx;
 289 };
 290
 291 struct ll_fid {
 292         __u64 id;         /* holds object id */
 293         __u32 generation; /* holds object generation */
 294         __u32 f_type;     /* holds object type or stripe idx when passing it to
 295                            * OST for saving into EA. */
 296 };
 297
 298 #define UUID_MAX        40
 299 struct obd_uuid {
 300         char uuid[UUID_MAX];
 301 };
 302
 303 static inline int obd_uuid_equals(const struct obd_uuid *u1,
 304                                   const struct obd_uuid *u2)
 305 {
 306         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 307 }
 308
 309 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 310 {
 311         return uuid->uuid[0] == '\0';
 312 }
 313
 314 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 315 {
 316         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 317         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 318 }
 319
 320 /* For printf's only, make sure uuid is terminated */
 321 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 322 {
 323         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 324                 /* Obviously not safe, but for printfs, no real harm done...
 325                    we're always null-terminated, even in a race. */
 326                 static char temp[sizeof(*uuid)];
 327                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 328                 temp[sizeof(*uuid) - 1] = '\0';
 329                 return temp;
 330         }
 331         return (char *)(uuid->uuid);
 332 }
 333
 334 /* Extract fsname from uuid (or target name) of a target
 335    e.g. (myfs-OST0007_UUID -> myfs)
 336    see also deuuidify. */
 337 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 338 {
 339         char *p;
 340
 341         strncpy(buf, uuid, buflen - 1);
 342         buf[buflen - 1] = '\0';
 343         p = strrchr(buf, '-');
 344         if (p)
 345            *p = '\0';
 346 }
 347
 348 /**
 349  * File IDentifier.
 350  *
 351  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 352  * FIDs are never reused.
 353  */
 354 struct lu_fid {
 355         /**
 356          * FID sequence. Sequence is a unit of migration: all files (objects)
 357          * with FIDs from a given sequence are stored on the same server.
 358          * Lustre should support 2^64 objects, so even if each sequence
 359          * has only a single object we can still enumerate 2^64 objects.
 360          */
 361         __u64 f_seq;
 362         /** FID number within sequence. */
 363         __u32 f_oid;
 364         /**
 365          * FID version, used to distinguish different versions (in the sense
 366          * of snapshots, etc.) of the same file system object. Not currently
 367          * used.
 368          */
 369         __u32 f_ver;
 370 };
 371
 372 struct filter_fid {
 373         struct lu_fid   ff_parent;  /* ff_parent.f_ver == file stripe number */
 374         __u64           ff_objid;
 375         __u64           ff_seq;
 376 };
 377
 378 /* Userspace should treat lu_fid as opaque, and only use the following methods
 379    to print or parse them.  Other functions (e.g. compare, swab) could be moved
 380    here from lustre_idl.h if needed. */
 381 typedef struct lu_fid lustre_fid;
 382
 383 /* printf display format
 384    e.g. printf("file FID is "DFID"\n", PFID(fid)); */
 385 #define DFID_NOBRACE LPX64":0x%x:0x%x"
 386 #define DFID "["DFID_NOBRACE"]"
 387 #define PFID(fid)     \
 388         (fid)->f_seq, \
 389         (fid)->f_oid, \
 390         (fid)->f_ver
 391
 392 /* scanf input parse format -- strip '[' first.
 393    e.g. sscanf(fidstr, SFID, RFID(&fid)); */
 394 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
 395 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
 396 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
 397 */
 398 #define SFID "0x"LPX64i":0x%x:0x%x"
 399 #define RFID(fid)     \
 400         &((fid)->f_seq), \
 401         &((fid)->f_oid), \
 402         &((fid)->f_ver)
 403
 404
 405 /********* Quotas **********/
 406
 407 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 408 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
 409 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
 410 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 411 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 412 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 413 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 414 /* lustre-specific control commands */
 415 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
 416 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
 417
 418 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 419
 420 struct if_quotacheck {
 421         char                    obd_type[16];
 422         struct obd_uuid         obd_uuid;
 423 };
 424
 425 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd629
 426
 427 /* permission */
 428 #define N_PERMS_MAX      64
 429
 430 struct perm_downcall_data {
 431         __u64 pdd_nid;
 432         __u32 pdd_perm;
 433         __u32 pdd_padding;
 434 };
 435
 436 struct identity_downcall_data {
 437         __u32                            idd_magic;
 438         __u32                            idd_err;
 439         __u32                            idd_uid;
 440         __u32                            idd_gid;
 441         __u32                            idd_nperms;
 442         __u32                            idd_ngroups;
 443         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 444         __u32                            idd_groups[0];
 445 };
 446
 447 /* for non-mapped uid/gid */
 448 #define NOBODY_UID      99
 449 #define NOBODY_GID      99
 450
 451 #define INVALID_ID      (-1)
 452
 453 enum {
 454         RMT_LSETFACL    = 1,
 455         RMT_LGETFACL    = 2,
 456         RMT_RSETFACL    = 3,
 457         RMT_RGETFACL    = 4
 458 };
 459
 460 #ifdef NEED_QUOTA_DEFS
 461 #ifndef QIF_BLIMITS
 462 #define QIF_BLIMITS     1
 463 #define QIF_SPACE       2
 464 #define QIF_ILIMITS     4
 465 #define QIF_INODES      8
 466 #define QIF_BTIME       16
 467 #define QIF_ITIME       32
 468 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 469 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 470 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 471 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 472 #endif
 473
 474 #endif /* !__KERNEL__ */
 475
 476 /* lustre volatile file support
 477  * file name header: .^L^S^T^R:volatile"
 478  */
 479 #define LUSTRE_VOLATILE_HDR     ".\x0c\x13\x14\x12:VOLATILE"
 480 #define LUSTRE_VOLATILE_HDR_LEN 14
 481 /* hdr + MDT index */
 482 #define LUSTRE_VOLATILE_IDX     LUSTRE_VOLATILE_HDR":%.4X:"
 483
 484 typedef enum lustre_quota_version {
 485         LUSTRE_QUOTA_V2 = 1
 486 } lustre_quota_version_t;
 487
 488 /* XXX: same as if_dqinfo struct in kernel */
 489 struct obd_dqinfo {
 490         __u64 dqi_bgrace;
 491         __u64 dqi_igrace;
 492         __u32 dqi_flags;
 493         __u32 dqi_valid;
 494 };
 495
 496 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 497 struct obd_dqblk {
 498         __u64 dqb_bhardlimit;
 499         __u64 dqb_bsoftlimit;
 500         __u64 dqb_curspace;
 501         __u64 dqb_ihardlimit;
 502         __u64 dqb_isoftlimit;
 503         __u64 dqb_curinodes;
 504         __u64 dqb_btime;
 505         __u64 dqb_itime;
 506         __u32 dqb_valid;
 507         __u32 dqb_padding;
 508 };
 509
 510 enum {
 511         QC_GENERAL      = 0,
 512         QC_MDTIDX       = 1,
 513         QC_OSTIDX       = 2,
 514         QC_UUID         = 3
 515 };
 516
 517 struct if_quotactl {
 518         __u32                   qc_cmd;
 519         __u32                   qc_type;
 520         __u32                   qc_id;
 521         __u32                   qc_stat;
 522         __u32                   qc_valid;
 523         __u32                   qc_idx;
 524         struct obd_dqinfo       qc_dqinfo;
 525         struct obd_dqblk        qc_dqblk;
 526         char                    obd_type[16];
 527         struct obd_uuid         obd_uuid;
 528 };
 529
 530
 531 /********* Changelogs **********/
 532 /** Changelog record types */
 533 enum changelog_rec_type {
 534         CL_MARK     = 0,
 535         CL_CREATE   = 1,  /* namespace */
 536         CL_MKDIR    = 2,  /* namespace */
 537         CL_HARDLINK = 3,  /* namespace */
 538         CL_SOFTLINK = 4,  /* namespace */
 539         CL_MKNOD    = 5,  /* namespace */
 540         CL_UNLINK   = 6,  /* namespace */
 541         CL_RMDIR    = 7,  /* namespace */
 542         CL_RENAME   = 8,  /* namespace */
 543         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
 544         CL_OPEN     = 10, /* not currently used */
 545         CL_CLOSE    = 11, /* may be written to log only with mtime change */
 546         CL_IOCTL    = 12,
 547         CL_TRUNC    = 13,
 548         CL_SETATTR  = 14,
 549         CL_XATTR    = 15,
 550         CL_HSM      = 16, /* HSM specific events, see flags */
 551         CL_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
 552         CL_CTIME    = 18,
 553         CL_ATIME    = 19,
 554         CL_LAST
 555 };
 556
 557 static inline const char *changelog_type2str(int type) {
 558         static const char *changelog_str[] = {
 559                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
 560                 "RMDIR", "RENME", "RNMTO", "OPEN",  "CLOSE", "IOCTL", "TRUNC",
 561                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME"  };
 562         if (type >= 0 && type < CL_LAST)
 563                 return changelog_str[type];
 564         return NULL;
 565 }
 566
 567 /* per-record flags */
 568 #define CLF_VERSION     0x1000
 569 #define CLF_EXT_VERSION 0x2000
 570 #define CLF_FLAGSHIFT   12
 571 #define CLF_FLAGMASK    ((1U << CLF_FLAGSHIFT) - 1)
 572 #define CLF_VERMASK     (~CLF_FLAGMASK)
 573 /* Anything under the flagmask may be per-type (if desired) */
 574 /* Flags for unlink */
 575 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
 576 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
 577                                      /* HSM cleaning needed */
 578 /* Flags for rename */
 579 #define CLF_RENAME_LAST       0x0001 /* rename unlink last hardlink of target */
 580
 581 /* Flags for HSM */
 582 /* 12b used (from high weight to low weight):
 583  * 2b for flags
 584  * 3b for event
 585  * 7b for error code
 586  */
 587 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
 588 #define CLF_HSM_ERR_H        6
 589 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
 590 #define CLF_HSM_EVENT_H      9
 591 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
 592 #define CLF_HSM_FLAG_H      11
 593 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
 594 #define CLF_HSM_SPARE_H     15
 595 #define CLF_HSM_LAST        15
 596
 597 /* Remove bits higher than _h, then extract the value
 598  * between _h and _l by shifting lower weigth to bit 0. */
 599 #define CLF_GET_BITS(_b, _h, _l) (((_b << (CLF_HSM_LAST - _h)) & 0xFFFF) \
 600                                    >> (CLF_HSM_LAST - _h + _l))
 601
 602 #define CLF_HSM_SUCCESS      0x00
 603 #define CLF_HSM_MAXERROR     0x7E
 604 #define CLF_HSM_ERROVERFLOW  0x7F
 605
 606 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
 607
 608 /* 3 bits field => 8 values allowed */
 609 enum hsm_event {
 610         HE_ARCHIVE      = 0,
 611         HE_RESTORE      = 1,
 612         HE_CANCEL       = 2,
 613         HE_RELEASE      = 3,
 614         HE_REMOVE       = 4,
 615         HE_STATE        = 5,
 616         HE_SPARE1       = 6,
 617         HE_SPARE2       = 7,
 618 };
 619
 620 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
 621 {
 622         return CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
 623 }
 624
 625 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
 626 {
 627         *flags |= (he << CLF_HSM_EVENT_L);
 628 }
 629
 630 static inline __u16 hsm_get_cl_flags(int flags)
 631 {
 632         return CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
 633 }
 634
 635 static inline void hsm_set_cl_flags(int *flags, int bits)
 636 {
 637         *flags |= (bits << CLF_HSM_FLAG_L);
 638 }
 639
 640 static inline int hsm_get_cl_error(int flags)
 641 {
 642         return CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
 643 }
 644
 645 static inline void hsm_set_cl_error(int *flags, int error)
 646 {
 647         *flags |= (error << CLF_HSM_ERR_L);
 648 }
 649
 650 #define CR_MAXSIZE cfs_size_round(2*NAME_MAX + 1 + sizeof(struct changelog_rec))
 651
 652 struct changelog_rec {
 653         __u16                 cr_namelen;
 654         __u16                 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
 655         __u32                 cr_type;  /**< \a changelog_rec_type */
 656         __u64                 cr_index; /**< changelog record number */
 657         __u64                 cr_prev;  /**< last index for this target fid */
 658         __u64                 cr_time;
 659         union {
 660                 lustre_fid    cr_tfid;        /**< target fid */
 661                 __u32         cr_markerflags; /**< CL_MARK flags */
 662         };
 663         lustre_fid            cr_pfid;        /**< parent fid */
 664         char                  cr_name[0];     /**< last element */
 665 } __attribute__((packed));
 666
 667 /* changelog_ext_rec is 2*sizeof(lu_fid) bigger than changelog_rec, to save
 668  * space, only rename uses changelog_ext_rec, while others use changelog_rec to
 669  * store records.
 670  */
 671 struct changelog_ext_rec {
 672         __u16                   cr_namelen;
 673         __u16                   cr_flags; /**< (flags & CLF_FLAGMASK) |
 674                                                 CLF_EXT_VERSION */
 675         __u32                   cr_type;  /**< \a changelog_rec_type */
 676         __u64                   cr_index; /**< changelog record number */
 677         __u64                   cr_prev;  /**< last index for this target fid */
 678         __u64                   cr_time;
 679         union {
 680                 lustre_fid      cr_tfid;        /**< target fid */
 681                 __u32           cr_markerflags; /**< CL_MARK flags */
 682         };
 683         lustre_fid              cr_pfid;        /**< target parent fid */
 684         lustre_fid              cr_sfid;        /**< source fid, or zero */
 685         lustre_fid              cr_spfid;       /**< source parent fid, or zero */
 686         char                    cr_name[0];     /**< last element */
 687 } __attribute__((packed));
 688
 689 #define CHANGELOG_REC_EXTENDED(rec) \
 690         (((rec)->cr_flags & CLF_VERMASK) == CLF_EXT_VERSION)
 691
 692 static inline int changelog_rec_size(struct changelog_rec *rec)
 693 {
 694         return CHANGELOG_REC_EXTENDED(rec) ? sizeof(struct changelog_ext_rec):
 695                                              sizeof(*rec);
 696 }
 697
 698 static inline char *changelog_rec_name(struct changelog_rec *rec)
 699 {
 700         return CHANGELOG_REC_EXTENDED(rec) ?
 701                 ((struct changelog_ext_rec *)rec)->cr_name: rec->cr_name;
 702 }
 703
 704 static inline int changelog_rec_snamelen(struct changelog_ext_rec *rec)
 705 {
 706         return rec->cr_namelen - strlen(rec->cr_name) - 1;
 707 }
 708
 709 static inline char *changelog_rec_sname(struct changelog_ext_rec *rec)
 710 {
 711         return rec->cr_name + strlen(rec->cr_name) + 1;
 712 }
 713
 714 struct ioc_changelog {
 715         __u64 icc_recno;
 716         __u32 icc_mdtindex;
 717         __u32 icc_id;
 718         __u32 icc_flags;
 719 };
 720
 721 enum changelog_message_type {
 722         CL_RECORD = 10, /* message is a changelog_rec */
 723         CL_EOF    = 11, /* at end of current changelog */
 724 };
 725
 726 /********* Misc **********/
 727
 728 struct ioc_data_version {
 729         __u64 idv_version;
 730         __u64 idv_flags;     /* See LL_DV_xxx */
 731 };
 732 #define LL_DV_NOFLUSH 0x01   /* Do not take READ EXTENT LOCK before sampling
 733                                 version. Dirty caches are left unchanged. */
 734
 735 #ifndef offsetof
 736 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 737 #endif
 738
 739 #define dot_lustre_name ".lustre"
 740
 741
 742 /********* HSM **********/
 743
 744 /** HSM per-file state
 745  * See HSM_FLAGS below.
 746  */
 747 enum hsm_states {
 748         HS_EXISTS    = 0x00000001,
 749         HS_DIRTY     = 0x00000002,
 750         HS_RELEASED  = 0x00000004,
 751         HS_ARCHIVED  = 0x00000008,
 752         HS_NORELEASE = 0x00000010,
 753         HS_NOARCHIVE = 0x00000020,
 754         HS_LOST      = 0x00000040,
 755 };
 756
 757 /* HSM user-setable flags. */
 758 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
 759
 760 /* Other HSM flags. */
 761 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
 762
 763 /*
 764  * All HSM-related possible flags that could be applied to a file.
 765  * This should be kept in sync with hsm_states.
 766  */
 767 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
 768
 769 /**
 770  * HSM request progress state
 771  */
 772 enum hsm_progress_states {
 773         HPS_WAITING     = 1,
 774         HPS_RUNNING     = 2,
 775         HPS_DONE        = 3,
 776 };
 777 #define HPS_NONE        0
 778
 779 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
 780 {
 781         switch  (s) {
 782         case HPS_WAITING: return "waiting";
 783         case HPS_RUNNING: return "running";
 784         case HPS_DONE:    return "done";
 785         default:          return "unknown";
 786         }
 787 }
 788
 789 struct hsm_extent {
 790         __u64 offset;
 791         __u64 length;
 792 } __attribute__((packed));
 793
 794 /**
 795  * Current HSM states of a Lustre file.
 796  *
 797  * This structure purpose is to be sent to user-space mainly. It describes the
 798  * current HSM flags and in-progress action.
 799  */
 800 struct hsm_user_state {
 801         /** Current HSM states, from enum hsm_states. */
 802         __u32              hus_states;
 803         __u32              hus_archive_num;
 804         /**  The current undergoing action, if there is one */
 805         __u32              hus_in_progress_state;
 806         __u32              hus_in_progress_action;
 807         struct hsm_extent  hus_in_progress_location;
 808         char               hus_extended_info[];
 809 };
 810
 811 struct hsm_state_set_ioc {
 812         struct lu_fid  hssi_fid;
 813         __u64          hssi_setmask;
 814         __u64          hssi_clearmask;
 815 };
 816
 817 /***** HSM user requests ******/
 818 /* User-generated (lfs/ioctl) request types */
 819 enum hsm_user_action {
 820         HUA_NONE    =  1, /* no action (noop) */
 821         HUA_ARCHIVE = 10, /* copy to hsm */
 822         HUA_RESTORE = 11, /* prestage */
 823         HUA_RELEASE = 12, /* drop ost objects */
 824         HUA_REMOVE  = 13, /* remove from archive */
 825         HUA_CANCEL  = 14  /* cancel a request */
 826 };
 827
 828 static inline char *hsm_user_action2name(enum hsm_user_action  a)
 829 {
 830         switch  (a) {
 831         case HUA_NONE:    return "NOOP";
 832         case HUA_ARCHIVE: return "ARCHIVE";
 833         case HUA_RESTORE: return "RESTORE";
 834         case HUA_RELEASE: return "RELEASE";
 835         case HUA_REMOVE:  return "REMOVE";
 836         case HUA_CANCEL:  return "CANCEL";
 837         default:          return "UNKNOWN";
 838         }
 839 }
 840
 841 struct hsm_user_item {
 842        lustre_fid        hui_fid;
 843        struct hsm_extent hui_extent;
 844 } __attribute__((packed));
 845
 846 struct hsm_user_request {
 847         __u32 hur_action;    /* enum hsm_user_action */
 848         __u32 hur_archive_num; /* archive number, used only with HUA_ARCHIVE */
 849         __u32 hur_itemcount;
 850         __u32 hur_data_len;
 851         struct hsm_user_item hur_user_item[0];
 852         /* extra data blob at end of struct (after all
 853          * hur_user_items), only use helpers to access it
 854          */
 855 } __attribute__((packed));
 856
 857 /** Return pointer to data field in a hsm user request */
 858 static inline void *hur_data(struct hsm_user_request *hur)
 859 {
 860         return &(hur->hur_user_item[hur->hur_itemcount]);
 861 }
 862
 863 /** Compute the current length of the provided hsm_user_request. */
 864 static inline int hur_len(struct hsm_user_request *hur)
 865 {
 866         int data_offset;
 867
 868         data_offset = hur_data(hur) - (void *)hur;
 869         return (data_offset + hur->hur_data_len);
 870 }
 871
 872 /****** HSM RPCs to copytool *****/
 873 /* Message types the copytool may receive */
 874 enum hsm_message_type {
 875         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
 876 };
 877
 878 /* Actions the copytool may be instructed to take for a given action_item */
 879 enum hsm_copytool_action {
 880         HSMA_NONE    = 10, /* no action */
 881         HSMA_ARCHIVE = 20, /* arbitrary offset */
 882         HSMA_RESTORE = 21,
 883         HSMA_REMOVE  = 22,
 884         HSMA_CANCEL  = 23
 885 };
 886
 887 static inline char *hsm_copytool_action2name(enum hsm_copytool_action  a)
 888 {
 889         switch  (a) {
 890         case HSMA_NONE:    return "NOOP";
 891         case HSMA_ARCHIVE: return "ARCHIVE";
 892         case HSMA_RESTORE: return "RESTORE";
 893         case HSMA_REMOVE:  return "REMOVE";
 894         case HSMA_CANCEL:  return "CANCEL";
 895         default:           return "UNKNOWN";
 896         }
 897 }
 898
 899 /* Copytool item action description */
 900 struct hsm_action_item {
 901         __u32      hai_len;     /* valid size of this struct */
 902         __u32      hai_action;  /* hsm_copytool_action, but use known size */
 903         lustre_fid hai_fid;     /* Lustre FID to operated on */
 904         lustre_fid hai_dfid;    /* fid used for data access */
 905         struct hsm_extent hai_extent;  /* byte range to operate on */
 906         __u64      hai_cookie;  /* action cookie from coordinator */
 907         __u64      hai_gid;     /* grouplock id */
 908         char       hai_data[0]; /* variable length */
 909 } __attribute__((packed));
 910
 911 /*
 912  * helper function which print in hexa the first bytes of
 913  * hai opaque field
 914  * \param hai [IN] record to print
 915  * \param buffer [OUT] output buffer
 916  * \param len [IN] max buffer len
 917  * \retval buffer
 918  */
 919 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
 920                                         char *buffer, int len)
 921 {
 922         int i, sz, data_len;
 923         char *ptr;
 924
 925         ptr = buffer;
 926         sz = len;
 927         data_len = hai->hai_len - sizeof(*hai);
 928         for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
 929         {
 930                 int cnt;
 931
 932                 cnt = snprintf(ptr, sz, "%.2X",
 933                                (unsigned char)hai->hai_data[i]);
 934                 ptr += cnt;
 935                 sz -= cnt;
 936         }
 937         *ptr = '\0';
 938         return buffer;
 939 }
 940
 941 /* Copytool action list */
 942 #define HAL_VERSION 1
 943 #define HAL_MAXSIZE LNET_MTU /* bytes, used in userspace only */
 944 struct hsm_action_list {
 945         __u32 hal_version;
 946         __u32 hal_count;       /* number of hai's to follow */
 947         __u64 hal_compound_id; /* returned by coordinator */
 948         __u64 hal_flags;
 949         __u32 hal_archive_num; /* which archive backend */
 950         __u32 padding1;
 951         char  hal_fsname[0];   /* null-terminated */
 952         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
 953            boundaries. See hai_zero */
 954 } __attribute__((packed));
 955
 956 #ifndef HAVE_CFS_SIZE_ROUND
 957 static inline int cfs_size_round (int val)
 958 {
 959         return (val + 7) & (~0x7);
 960 }
 961 #define HAVE_CFS_SIZE_ROUND
 962 #endif
 963
 964 /* Return pointer to first hai in action list */
 965 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
 966 {
 967         return (struct hsm_action_item *)(hal->hal_fsname +
 968                                           cfs_size_round(strlen(hal-> \
 969                                                                 hal_fsname)));
 970 }
 971 /* Return pointer to next hai */
 972 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
 973 {
 974         return (struct hsm_action_item *)((char *)hai +
 975                                           cfs_size_round(hai->hai_len));
 976 }
 977
 978 /* Return size of an hsm_action_list */
 979 static inline int hal_size(struct hsm_action_list *hal)
 980 {
 981         int i, sz;
 982         struct hsm_action_item *hai;
 983
 984         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
 985         hai = hai_zero(hal);
 986         for (i = 0 ; i < hal->hal_count ; i++) {
 987                 sz += cfs_size_round(hai->hai_len);
 988                 hai = hai_next(hai);
 989         }
 990         return(sz);
 991 }
 992
 993 /* Copytool progress reporting */
 994 #define HP_FLAG_COMPLETED 0x01
 995 #define HP_FLAG_RETRY     0x02
 996
 997 struct hsm_progress {
 998         lustre_fid              hp_fid;
 999         __u64                   hp_cookie;
1000         struct hsm_extent       hp_extent;
1001         __u16                   hp_flags;
1002         __u16                   hp_errval; /* positive val */
1003         __u32                   padding;
1004 };
1005
1006 /**
1007  * Use by copytool during any hsm request they handled.
1008  * This structure is initialized by llapi_hsm_copy_start()
1009  * which is an helper over the ioctl() interface
1010  * Store Lustre, internal use only, data.
1011  */
1012 struct hsm_copy {
1013         __u64                   hc_data_version;
1014         __u16                   hc_flags;
1015         __u16                   hc_errval; /* positive val */
1016         __u32                   padding;
1017         struct hsm_action_item  hc_hai;
1018 };
1019
1020 /** @} lustreuser */
1021
1022 #endif /* _LUSTRE_USER_H */