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