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