lustre/include/lustre/lustre_user.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 #include <lustre/ll_fiemap.h>
  45 #if defined(__linux__)
  46 #include <linux/lustre_user.h>
  47 #elif defined(__APPLE__)
  48 #include <darwin/lustre_user.h>
  49 #elif defined(__WINNT__)
  50 #include <winnt/lustre_user.h>
  51 #else
  52 #error Unsupported operating system.
  53 #endif
  54
  55 /* for statfs() */
  56 #define LL_SUPER_MAGIC 0x0BD00BD0
  57
  58 #ifndef FSFILT_IOC_GETFLAGS
  59 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
  60 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
  61 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
  62 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
  63 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  64 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  65 #define FSFILT_IOC_FIEMAP                 _IOWR('f', 11, struct ll_user_fiemap)
  66 #endif
  67
  68 /* FIEMAP flags supported by Lustre */
  69 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
  70
  71 enum obd_statfs_state {
  72         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
  73         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
  74         OS_STATE_RDONLY_1       = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
  75         OS_STATE_RDONLY_2       = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
  76         OS_STATE_RDONLY_3       = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
  77 };
  78
  79 struct obd_statfs {
  80         __u64           os_type;
  81         __u64           os_blocks;
  82         __u64           os_bfree;
  83         __u64           os_bavail;
  84         __u64           os_files;
  85         __u64           os_ffree;
  86         __u8            os_fsid[40];
  87         __u32           os_bsize;
  88         __u32           os_namelen;
  89         __u64           os_maxbytes;
  90         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
  91         __u32           os_spare1;
  92         __u32           os_spare2;
  93         __u32           os_spare3;
  94         __u32           os_spare4;
  95         __u32           os_spare5;
  96         __u32           os_spare6;
  97         __u32           os_spare7;
  98         __u32           os_spare8;
  99         __u32           os_spare9;
 100 };
 101
 102
 103 /*
 104  * The ioctl naming rules:
 105  * LL_*     - works on the currently opened filehandle instead of parent dir
 106  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 107  * *_MDC_*  - gets/sets data related to MDC
 108  * *_LOV_*  - gets/sets data related to OSC/LOV
 109  * *FILE*   - called on parent dir and passes in a filename
 110  * *STRIPE* - set/get lov_user_md
 111  * *INFO    - set/get lov_user_mds_data
 112  */
 113 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 114 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 115 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 116 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 117 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 118 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 119 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
 120 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 121 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 122 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
 123 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
 124 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl *)
 125 #define LL_IOC_JOIN                     _IOW ('f', 163, long)
 126 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 127 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
 128 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 129 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
 130
 131 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 132
 133 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 134 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 135 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, long)
 136 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 137 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 138
 139 #define LL_STATFS_MDC           1
 140 #define LL_STATFS_LOV           2
 141
 142 #define IOC_MDC_TYPE            'i'
 143 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 144 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 145 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 146 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 147
 148 /* Keep these for backward compartability. */
 149 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
 150 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
 151
 152 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
 153
 154 #define LL_FILE_IGNORE_LOCK             0x00000001
 155 #define LL_FILE_GROUP_LOCKED            0x00000002
 156 #define LL_FILE_READAHEAD               0x00000004
 157 #define LL_FILE_RMTACL                  0x00000008
 158
 159 #define LOV_USER_MAGIC_V1 0x0BD10BD0
 160 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
 161 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
 162 #define LOV_USER_MAGIC_V3 0x0BD30BD0
 163
 164 #define LOV_PATTERN_RAID0 0x001
 165 #define LOV_PATTERN_RAID1 0x002
 166 #define LOV_PATTERN_FIRST 0x100
 167
 168 #define LOV_MAXPOOLNAME 16
 169 #define LOV_POOLNAMEF "%.16s"
 170
 171 #define lov_user_ost_data lov_user_ost_data_v1
 172 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 173         __u64 l_object_id;        /* OST object ID */
 174         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 175         __u32 l_ost_gen;          /* generation of this OST index */
 176         __u32 l_ost_idx;          /* OST index in LOV */
 177 } __attribute__((packed));
 178
 179 #define lov_user_md lov_user_md_v1
 180 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 181         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 182         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 183         __u64 lmm_object_id;      /* LOV object ID */
 184         __u64 lmm_object_gr;      /* LOV object group */
 185         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 186         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 187         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 188         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 189 } __attribute__((packed));
 190
 191 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 192         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 193         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 194         __u64 lmm_object_id;      /* LOV object ID */
 195         __u64 lmm_object_gr;      /* LOV object group */
 196         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 197         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 198         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 199         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
 200         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 201 } __attribute__((packed));
 202
 203 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 204  * use this.  It is unsafe to #define those values in this header as it
 205  * is possible the application has already #included <sys/stat.h>. */
 206 #ifdef HAVE_LOV_USER_MDS_DATA
 207 #define lov_user_mds_data lov_user_mds_data_v1
 208 struct lov_user_mds_data_v1 {
 209         lstat_t lmd_st;                 /* MDS stat struct */
 210         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 211 } __attribute__((packed));
 212
 213 struct lov_user_mds_data_v3 {
 214         lstat_t lmd_st;                 /* MDS stat struct */
 215         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 216 } __attribute__((packed));
 217 #endif
 218
 219 struct ll_recreate_obj {
 220         __u64 lrc_id;
 221         __u64 lrc_group;
 222         __u32 lrc_ost_idx;
 223 };
 224
 225 struct ll_fid {
 226         __u64 id;         /* holds object id */
 227         __u32 generation; /* holds object generation */
 228         __u32 f_type;     /* holds object type or stripe idx when passing it to
 229                            * OST for saving into EA. */
 230 };
 231
 232 struct filter_fid {
 233         struct ll_fid   ff_fid;  /* ff_fid.f_type == file stripe number */
 234         __u64           ff_objid;
 235         __u64           ff_group;
 236 };
 237
 238 struct obd_uuid {
 239         char uuid[40];
 240 };
 241
 242 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
 243 {
 244         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 245 }
 246
 247 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 248 {
 249         return uuid->uuid[0] == '\0';
 250 }
 251
 252 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 253 {
 254         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 255         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 256 }
 257
 258 /* For printf's only, make sure uuid is terminated */
 259 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 260 {
 261         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 262                 /* Obviously not safe, but for printfs, no real harm done...
 263                    we're always null-terminated, even in a race. */
 264                 static char temp[sizeof(*uuid)];
 265                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 266                 temp[sizeof(*uuid) - 1] = '\0';
 267                 return temp;
 268         }
 269         return (char *)(uuid->uuid);
 270 }
 271
 272 /* Extract fsname from uuid (or target name) of a target
 273    e.g. (myfs-OST0007_UUID -> myfs)
 274    see also deuuidify. */
 275 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 276 {
 277         char *p;
 278
 279         strncpy(buf, uuid, buflen - 1);
 280         buf[buflen - 1] = '\0';
 281         p = strrchr(buf, '-');
 282         if (p)
 283            *p = '\0';
 284 }
 285
 286 /**
 287  * File IDentifier.
 288  *
 289  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 290  * FIDs are never reused.
 291  */
 292 struct lu_fid {
 293         /**
 294          * FID sequence. Sequence is a unit of migration: all files (objects)
 295          * with FIDs from a given sequence are stored on the same server.
 296          * Lustre should support 2^64 objects, so even if each sequence
 297          * has only a single object we can still enumerate 2^64 objects.
 298          */
 299         __u64 f_seq;
 300         /** FID number within sequence. */
 301         __u32 f_oid;
 302         /**
 303          * FID version, used to distinguish different versions (in the sense
 304          * of snapshots, etc.) of the same file system object. Not currently
 305          * used.
 306          */
 307         __u32 f_ver;
 308 };
 309
 310 /* Userspace should treat lu_fid as opaque, and only use the following methods
 311    to print or parse them.  Other functions (e.g. compare, swab) could be moved
 312    here from lustre_idl.h if needed. */
 313 typedef struct lu_fid lustre_fid;
 314
 315 /* printf display format
 316    e.g. printf("file FID is "DFID"\n", PFID(fid)); */
 317 #define DFID "["LPX64":0x%x:0x%x]"
 318 #define PFID(fid)     \
 319         (fid)->f_seq, \
 320         (fid)->f_oid, \
 321         (fid)->f_ver
 322
 323 /* scanf input parse format -- strip '[' first.
 324    e.g. sscanf(fidstr, SFID, RFID(&fid)); */
 325 #define SFID "0x%llx:0x%x:0x%x"
 326 #define RFID(fid)     \
 327         &((fid)->f_seq), \
 328         &((fid)->f_oid), \
 329         &((fid)->f_ver)
 330
 331
 332 /********* Quotas **********/
 333
 334 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 335 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
 336 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
 337 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 338 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 339 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 340 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 341 /* lustre-specific control commands */
 342 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
 343 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
 344
 345 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 346 #define IMMQUOTA 0x4    /* set immutable quota flag, cannot be turned on/off
 347                          * on-fly. temporary used by SOM */
 348
 349 struct if_quotacheck {
 350         char                    obd_type[16];
 351         struct obd_uuid         obd_uuid;
 352 };
 353
 354 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd620
 355
 356 /* permission */
 357 #define N_PERMS_MAX      64
 358
 359 struct perm_downcall_data {
 360         __u64 pdd_nid;
 361         __u32 pdd_perm;
 362 };
 363
 364 struct identity_downcall_data {
 365         __u32                            idd_magic;
 366         __u32                            idd_err;
 367         __u32                            idd_uid;
 368         __u32                            idd_gid;
 369         __u32                            idd_nperms;
 370         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 371         __u32                            idd_ngroups;
 372         __u32                            idd_groups[0];
 373 };
 374
 375 /* for non-mapped uid/gid */
 376 #define NOBODY_UID      99
 377 #define NOBODY_GID      99
 378
 379 #define INVALID_ID      (-1)
 380
 381 enum {
 382         RMT_LSETFACL    = 1,
 383         RMT_LGETFACL    = 2,
 384         RMT_RSETFACL    = 3,
 385         RMT_RGETFACL    = 4
 386 };
 387
 388 #ifdef NEED_QUOTA_DEFS
 389 #ifndef QUOTABLOCK_BITS
 390 #define QUOTABLOCK_BITS 10
 391 #endif
 392
 393 #ifndef QUOTABLOCK_SIZE
 394 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
 395 #endif
 396
 397 #ifndef toqb
 398 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
 399 #endif
 400
 401 #ifndef QIF_BLIMITS
 402 #define QIF_BLIMITS     1
 403 #define QIF_SPACE       2
 404 #define QIF_ILIMITS     4
 405 #define QIF_INODES      8
 406 #define QIF_BTIME       16
 407 #define QIF_ITIME       32
 408 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 409 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 410 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 411 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 412 #endif
 413
 414 #endif /* !__KERNEL__ */
 415
 416 typedef enum lustre_quota_version {
 417         LUSTRE_QUOTA_V2 = 1
 418 } lustre_quota_version_t;
 419
 420 /* XXX: same as if_dqinfo struct in kernel */
 421 struct obd_dqinfo {
 422         __u64 dqi_bgrace;
 423         __u64 dqi_igrace;
 424         __u32 dqi_flags;
 425         __u32 dqi_valid;
 426 };
 427
 428 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 429 struct obd_dqblk {
 430         __u64 dqb_bhardlimit;
 431         __u64 dqb_bsoftlimit;
 432         __u64 dqb_curspace;
 433         __u64 dqb_ihardlimit;
 434         __u64 dqb_isoftlimit;
 435         __u64 dqb_curinodes;
 436         __u64 dqb_btime;
 437         __u64 dqb_itime;
 438         __u32 dqb_valid;
 439         __u32 padding;
 440 };
 441
 442 enum {
 443         QC_GENERAL      = 0,
 444         QC_MDTIDX       = 1,
 445         QC_OSTIDX       = 2,
 446         QC_UUID         = 3
 447 };
 448
 449 struct if_quotactl {
 450         __u32                   qc_cmd;
 451         __u32                   qc_type;
 452         __u32                   qc_id;
 453         __u32                   qc_stat;
 454         __u32                   qc_valid;
 455         __u32                   qc_idx;
 456         struct obd_dqinfo       qc_dqinfo;
 457         struct obd_dqblk        qc_dqblk;
 458         char                    obd_type[16];
 459         struct obd_uuid         obd_uuid;
 460 };
 461
 462
 463 /********* Changelogs **********/
 464 /** Changelog record types */
 465 enum changelog_rec_type {
 466         CL_MARK     = 0,
 467         CL_CREATE   = 1,  /* namespace */
 468         CL_MKDIR    = 2,  /* namespace */
 469         CL_HARDLINK = 3,  /* namespace */
 470         CL_SOFTLINK = 4,  /* namespace */
 471         CL_MKNOD    = 5,  /* namespace */
 472         CL_UNLINK   = 6,  /* namespace */
 473         CL_RMDIR    = 7,  /* namespace */
 474         CL_RENAME   = 8,  /* namespace */
 475         CL_EXT      = 9,  /* namespace extended record (2nd half of rename) */
 476         CL_OPEN     = 10, /* not currently used */
 477         CL_CLOSE    = 11, /* may be written to log only with mtime change */
 478         CL_IOCTL    = 12,
 479         CL_TRUNC    = 13,
 480         CL_SETATTR  = 14,
 481         CL_XATTR    = 15,
 482         CL_HSM      = 16, /* HSM specific events, see flags */
 483         CL_LAST
 484 };
 485
 486 static inline const char *changelog_type2str(int type) {
 487         static const char *changelog_str[] = {
 488                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
 489                 "RMDIR", "RNMFM", "RNMTO", "OPEN",  "CLOSE", "IOCTL", "TRUNC",
 490                 "SATTR", "XATTR", "HSM"   };
 491         if (type >= 0 && type < CL_LAST)
 492                 return changelog_str[type];
 493         return NULL;
 494 }
 495
 496 /* per-record flags */
 497 #define CLF_VERSION  0x1000
 498 #define CLF_FLAGMASK 0x0FFF
 499 /* Anything under the flagmask may be per-type (if desired) */
 500
 501 #define CR_MAXSIZE (PATH_MAX + sizeof(struct changelog_rec))
 502 struct changelog_rec {
 503         __u16                 cr_namelen;
 504         __u16                 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
 505         __u32                 cr_type;  /**< \a changelog_rec_type */
 506         __u64                 cr_index; /**< changelog record number */
 507         __u64                 cr_prev;  /**< last index for this target fid */
 508         __u64                 cr_time;
 509         union {
 510                 lustre_fid    cr_tfid;        /**< target fid */
 511                 __u32         cr_markerflags; /**< CL_MARK flags */
 512         };
 513         lustre_fid            cr_pfid;        /**< parent fid */
 514         char                  cr_name[0];     /**< last element */
 515 } __attribute__((packed));
 516
 517 struct ioc_changelog_clear {
 518         __u32 icc_mdtindex;
 519         __u32 icc_id;
 520         __u64 icc_recno;
 521 };
 522
 523 enum changelog_message_type {
 524         CL_RECORD = 10, /* message is a changelog_rec */
 525         CL_EOF    = 11, /* at end of current changelog */
 526 };
 527
 528 /********* Misc **********/
 529
 530 #ifndef offsetof
 531 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 532 #endif
 533
 534 #define dot_lustre_name ".lustre"
 535
 536
 537 /********* HSM **********/
 538 enum hsm_message_type {
 539         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
 540 };
 541
 542 /* User-generated (ioctl) request types */
 543 enum hsm_request {
 544         HSMR_ARCHIVE = 10, /* copy to hsm */
 545         HSMR_RESTORE = 11, /* prestage */
 546         HSMR_RELEASE = 12, /* drop ost objects */
 547         HSMR_REMOVE  = 13, /* remove from archive */
 548         HSMR_CANCEL  = 14
 549 };
 550
 551 /* Copytool commands */
 552 enum hsm_action {
 553         HSMA_ARCHIVE = 20, /* arbitrary offset */
 554         HSMA_RESTORE = 21,
 555         HSMA_REMOVE  = 22,
 556         HSMA_CANCEL  = 23
 557 };
 558
 559 /* Copytool item action description */
 560 struct hsm_action_item {
 561         __u32      hai_len;     /* valid size of this struct */
 562         __u32      hai_action;  /* enum actually, but use known size */
 563         lustre_fid hai_fid;     /* Lustre FID to operated on */
 564         __u64      hai_cookie;  /* action cookie from coordinator */
 565         __u64      hai_extent_start;  /* byte range to operate on */
 566         __u64      hai_extent_end;
 567         __u64      hai_gid;     /* grouplock id */
 568         char       hai_data[0]; /* variable length */
 569 } __attribute__((packed));
 570
 571 /* Copytool action list */
 572 #define HAL_VERSION 1
 573 #define HAL_MAXSIZE 4096 /* bytes, used in userspace only */
 574 struct hsm_action_list {
 575         __u32 hal_version;
 576         __u32 hal_count;       /* number of hai's to follow */
 577         __u32 hal_archive_num; /* which archive backend */
 578         __u32 padding1;
 579         char  hal_fsname[0];   /* null-terminated */
 580         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
 581            boundaries. See hai_zero */
 582 } __attribute__((packed));
 583
 584 /* Return pointer to first hai in action list */
 585 static __inline__ struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
 586 {
 587         return (struct hsm_action_item *)(hal->hal_fsname +
 588                                           size_round(strlen(hal->hal_fsname)));
 589 }
 590 /* Return pointer to next hai */
 591 static __inline__ struct hsm_action_item * hai_next(struct hsm_action_item *hai)
 592 {
 593         return (struct hsm_action_item *)((char *)hai +
 594                                           size_round(hai->hai_len));
 595 }
 596
 597
 598 #endif /* _LUSTRE_USER_H */