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 (c) 2003, 2010, Oracle and/or its affiliates. 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 /* see <lustre_obd.h> for ioctl numberss 101-150 */
 119 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 120 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 121 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 122 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 123 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 124 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 125 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
 126 #define LL_IOC_RECREATE_FID             _IOW ('f', 157, struct lu_fid)
 127 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 128 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 129 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
 130 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
 131 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl *)
 132 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 133 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
 134 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
 135 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
 136 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 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_CONNECT_FLAGS        _IOWR('f', 174, __u64 *)
 143 #define LL_IOC_GET_MDTIDX               _IOR ('f', 175, int)
 144 #define LL_IOC_HSM_CT_START             _IOW ('f', 176,struct lustre_kernelcomm)
 145 /* see <lustre_obd.h> for ioctl numbers 177-210 */
 146
 147
 148 #define LL_STATFS_MDC           1
 149 #define LL_STATFS_LOV           2
 150
 151 #define IOC_MDC_TYPE            'i'
 152 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 153 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 154 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 155 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 156
 157 /* Keep these for backward compartability. */
 158 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
 159 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
 160
 161 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
 162
 163 #define LL_FILE_IGNORE_LOCK             0x00000001
 164 #define LL_FILE_GROUP_LOCKED            0x00000002
 165 #define LL_FILE_READAHEAD               0x00000004
 166 #define LL_FILE_RMTACL                  0x00000008
 167
 168 #define LOV_USER_MAGIC_V1 0x0BD10BD0
 169 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
 170 #define LOV_USER_MAGIC_JOIN_V1 0x0BD20BD0
 171 #define LOV_USER_MAGIC_V3 0x0BD30BD0
 172
 173 #define LOV_PATTERN_RAID0 0x001
 174 #define LOV_PATTERN_RAID1 0x002
 175 #define LOV_PATTERN_FIRST 0x100
 176
 177 #define LOV_MAXPOOLNAME 16
 178 #define LOV_POOLNAMEF "%.16s"
 179
 180 #define lov_user_ost_data lov_user_ost_data_v1
 181 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 182         __u64 l_object_id;        /* OST object ID */
 183         __u64 l_object_seq;       /* OST object seq number */
 184         __u32 l_ost_gen;          /* generation of this OST index */
 185         __u32 l_ost_idx;          /* OST index in LOV */
 186 } __attribute__((packed));
 187
 188 #define lov_user_md lov_user_md_v1
 189 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 190         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 191         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 192         __u64 lmm_object_id;      /* LOV object ID */
 193         __u64 lmm_object_seq;     /* LOV object seq */
 194         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 195         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 196         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 197         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 198 } __attribute__((packed,  __may_alias__));
 199
 200 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 201         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 202         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 203         __u64 lmm_object_id;      /* LOV object ID */
 204         __u64 lmm_object_seq;     /* LOV object seq */
 205         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 206         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 207         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 208         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
 209         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 210 } __attribute__((packed));
 211
 212 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 213  * use this.  It is unsafe to #define those values in this header as it
 214  * is possible the application has already #included <sys/stat.h>. */
 215 #ifdef HAVE_LOV_USER_MDS_DATA
 216 #define lov_user_mds_data lov_user_mds_data_v1
 217 struct lov_user_mds_data_v1 {
 218         lstat_t lmd_st;                 /* MDS stat struct */
 219         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 220 } __attribute__((packed));
 221
 222 struct lov_user_mds_data_v3 {
 223         lstat_t lmd_st;                 /* MDS stat struct */
 224         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 225 } __attribute__((packed));
 226 #endif
 227
 228 struct ll_recreate_obj {
 229         __u64 lrc_id;
 230         __u32 lrc_ost_idx;
 231 };
 232
 233 struct ll_fid {
 234         __u64 id;         /* holds object id */
 235         __u32 generation; /* holds object generation */
 236         __u32 f_type;     /* holds object type or stripe idx when passing it to
 237                            * OST for saving into EA. */
 238 };
 239
 240 struct obd_uuid {
 241         char uuid[40];
 242 };
 243
 244 static inline int obd_uuid_equals(const struct obd_uuid *u1,
 245                                   const struct obd_uuid *u2)
 246 {
 247         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 248 }
 249
 250 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 251 {
 252         return uuid->uuid[0] == '\0';
 253 }
 254
 255 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 256 {
 257         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 258         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 259 }
 260
 261 /* For printf's only, make sure uuid is terminated */
 262 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 263 {
 264         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 265                 /* Obviously not safe, but for printfs, no real harm done...
 266                    we're always null-terminated, even in a race. */
 267                 static char temp[sizeof(*uuid)];
 268                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 269                 temp[sizeof(*uuid) - 1] = '\0';
 270                 return temp;
 271         }
 272         return (char *)(uuid->uuid);
 273 }
 274
 275 /* Extract fsname from uuid (or target name) of a target
 276    e.g. (myfs-OST0007_UUID -> myfs)
 277    see also deuuidify. */
 278 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 279 {
 280         char *p;
 281
 282         strncpy(buf, uuid, buflen - 1);
 283         buf[buflen - 1] = '\0';
 284         p = strrchr(buf, '-');
 285         if (p)
 286            *p = '\0';
 287 }
 288
 289 /**
 290  * File IDentifier.
 291  *
 292  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 293  * FIDs are never reused.
 294  */
 295 struct lu_fid {
 296         /**
 297          * FID sequence. Sequence is a unit of migration: all files (objects)
 298          * with FIDs from a given sequence are stored on the same server.
 299          * Lustre should support 2^64 objects, so even if each sequence
 300          * has only a single object we can still enumerate 2^64 objects.
 301          */
 302         __u64 f_seq;
 303         /** FID number within sequence. */
 304         __u32 f_oid;
 305         /**
 306          * FID version, used to distinguish different versions (in the sense
 307          * of snapshots, etc.) of the same file system object. Not currently
 308          * used.
 309          */
 310         __u32 f_ver;
 311 };
 312
 313 struct filter_fid {
 314         struct lu_fid   ff_parent;  /* ff_parent.f_ver == file stripe number */
 315         __u64           ff_objid;
 316         __u64           ff_seq;
 317 };
 318
 319 /* Userspace should treat lu_fid as opaque, and only use the following methods
 320    to print or parse them.  Other functions (e.g. compare, swab) could be moved
 321    here from lustre_idl.h if needed. */
 322 typedef struct lu_fid lustre_fid;
 323
 324 /* printf display format
 325    e.g. printf("file FID is "DFID"\n", PFID(fid)); */
 326 #define DFID_NOBRACE LPX64":0x%x:0x%x"
 327 #define DFID "["DFID_NOBRACE"]"
 328 #define PFID(fid)     \
 329         (fid)->f_seq, \
 330         (fid)->f_oid, \
 331         (fid)->f_ver
 332
 333 /* scanf input parse format -- strip '[' first.
 334    e.g. sscanf(fidstr, SFID, RFID(&fid)); */
 335 /* #define SFID "0x"LPX64i":0x"LPSZX":0x"LPSZX""
 336 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 4 has type 'unsigned int *'
 337 liblustreapi.c:2893: warning: format '%lx' expects type 'long unsigned int *', but argument 5 has type 'unsigned int *'
 338 */
 339 #define SFID "0x"LPX64i":0x%x:0x%x"
 340 #define RFID(fid)     \
 341         &((fid)->f_seq), \
 342         &((fid)->f_oid), \
 343         &((fid)->f_ver)
 344
 345
 346 /********* Quotas **********/
 347
 348 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 349 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
 350 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
 351 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 352 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 353 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 354 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 355 /* lustre-specific control commands */
 356 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
 357 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
 358
 359 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 360
 361 struct if_quotacheck {
 362         char                    obd_type[16];
 363         struct obd_uuid         obd_uuid;
 364 };
 365
 366 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd620
 367
 368 /* permission */
 369 #define N_PERMS_MAX      64
 370
 371 struct perm_downcall_data {
 372         __u64 pdd_nid;
 373         __u32 pdd_perm;
 374 };
 375
 376 struct identity_downcall_data {
 377         __u32                            idd_magic;
 378         __u32                            idd_err;
 379         __u32                            idd_uid;
 380         __u32                            idd_gid;
 381         __u32                            idd_nperms;
 382         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 383         __u32                            idd_ngroups;
 384         __u32                            idd_groups[0];
 385 };
 386
 387 /* for non-mapped uid/gid */
 388 #define NOBODY_UID      99
 389 #define NOBODY_GID      99
 390
 391 #define INVALID_ID      (-1)
 392
 393 enum {
 394         RMT_LSETFACL    = 1,
 395         RMT_LGETFACL    = 2,
 396         RMT_RSETFACL    = 3,
 397         RMT_RGETFACL    = 4
 398 };
 399
 400 #ifdef NEED_QUOTA_DEFS
 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_MTIME    = 17, /* Precedence: setattr > mtime > ctime > atime */
 484         CL_CTIME    = 18,
 485         CL_ATIME    = 19,
 486         CL_LAST
 487 };
 488
 489 static inline const char *changelog_type2str(int type) {
 490         static const char *changelog_str[] = {
 491                 "MARK",  "CREAT", "MKDIR", "HLINK", "SLINK", "MKNOD", "UNLNK",
 492                 "RMDIR", "RNMFM", "RNMTO", "OPEN",  "CLOSE", "IOCTL", "TRUNC",
 493                 "SATTR", "XATTR", "HSM",   "MTIME", "CTIME", "ATIME"  };
 494         if (type >= 0 && type < CL_LAST)
 495                 return changelog_str[type];
 496         return NULL;
 497 }
 498
 499 /* per-record flags */
 500 #define CLF_VERSION  0x1000
 501 #define CLF_FLAGMASK 0x0FFF
 502 /* Anything under the flagmask may be per-type (if desired) */
 503 /* Flags for unlink */
 504 #define CLF_UNLINK_LAST       0x0001 /* Unlink of last hardlink */
 505 #define CLF_UNLINK_HSM_EXISTS 0x0002 /* File has something in HSM */
 506                                      /* HSM cleaning needed */
 507 /* Flags for HSM */
 508 /* 12b used (from high weight to low weight):
 509  * 2b for flags
 510  * 3b for event
 511  * 7b for error code
 512  */
 513 #define CLF_HSM_ERR_L        0 /* HSM return code, 7 bits */
 514 #define CLF_HSM_ERR_H        6
 515 #define CLF_HSM_EVENT_L      7 /* HSM event, 3 bits, see enum hsm_event */
 516 #define CLF_HSM_EVENT_H      9
 517 #define CLF_HSM_FLAG_L      10 /* HSM flags, 2 bits, 1 used, 1 spare */
 518 #define CLF_HSM_FLAG_H      11
 519 #define CLF_HSM_SPARE_L     12 /* 4 spare bits */
 520 #define CLF_HSM_SPARE_H     15
 521 #define CLF_HSM_LAST        15
 522
 523 #define CLF_GET_BITS(_b, _h, _l) \
 524  _b &= (0xFFFF << (CLF_HSM_LAST - _h)); \
 525  _b = _b >> (_l + CLF_HSM_LAST - _h)
 526
 527 #define CLF_HSM_SUCCESS      0x00
 528 #define CLF_HSM_MAXERROR     0x7E
 529 #define CLF_HSM_ERROVERFLOW  0x7F
 530
 531 #define CLF_HSM_DIRTY        1 /* file is dirty after HSM request end */
 532
 533 /* 3 bits field => 8 values allowed */
 534 enum hsm_event {
 535         HE_ARCHIVE      = 0,
 536         HE_RESTORE      = 1,
 537         HE_CANCEL       = 2,
 538         HE_RELEASE      = 3,
 539         HE_REMOVE       = 4,
 540         HE_STATE        = 5,
 541         HE_SPARE1       = 6,
 542         HE_SPARE2       = 7,
 543 };
 544
 545 static inline enum hsm_event hsm_get_cl_event(__u16 flags)
 546 {
 547         enum hsm_event he;
 548
 549         CLF_GET_BITS(flags, CLF_HSM_EVENT_H, CLF_HSM_EVENT_L);
 550         he = flags;
 551         return he;
 552 }
 553
 554 static inline void hsm_set_cl_event(int *flags, enum hsm_event he)
 555 {
 556         *flags |= (he << CLF_HSM_EVENT_L);
 557 }
 558
 559 static inline __u16 hsm_get_cl_flags(int flags)
 560 {
 561         CLF_GET_BITS(flags, CLF_HSM_FLAG_H, CLF_HSM_FLAG_L);
 562         return flags;
 563 }
 564
 565 static inline void hsm_set_cl_flags(int *flags, int bits)
 566 {
 567         *flags |= (bits << CLF_HSM_FLAG_L);
 568 }
 569
 570 static inline int hsm_get_cl_error(int flags)
 571 {
 572         CLF_GET_BITS(flags, CLF_HSM_ERR_H, CLF_HSM_ERR_L);
 573         return flags;
 574 }
 575
 576 static inline void hsm_set_cl_error(int *flags, int error)
 577 {
 578         *flags |= (error << CLF_HSM_ERR_L);
 579 }
 580
 581 #define CR_MAXSIZE (PATH_MAX + sizeof(struct changelog_rec))
 582 struct changelog_rec {
 583         __u16                 cr_namelen;
 584         __u16                 cr_flags; /**< (flags&CLF_FLAGMASK)|CLF_VERSION */
 585         __u32                 cr_type;  /**< \a changelog_rec_type */
 586         __u64                 cr_index; /**< changelog record number */
 587         __u64                 cr_prev;  /**< last index for this target fid */
 588         __u64                 cr_time;
 589         union {
 590                 lustre_fid    cr_tfid;        /**< target fid */
 591                 __u32         cr_markerflags; /**< CL_MARK flags */
 592         };
 593         lustre_fid            cr_pfid;        /**< parent fid */
 594         char                  cr_name[0];     /**< last element */
 595 } __attribute__((packed));
 596
 597 struct ioc_changelog {
 598         __u64 icc_recno;
 599         __u32 icc_mdtindex;
 600         __u32 icc_id;
 601         __u32 icc_flags;
 602 };
 603
 604 enum changelog_message_type {
 605         CL_RECORD = 10, /* message is a changelog_rec */
 606         CL_EOF    = 11, /* at end of current changelog */
 607 };
 608
 609 /********* Misc **********/
 610
 611 #ifndef offsetof
 612 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 613 #endif
 614
 615 #define dot_lustre_name ".lustre"
 616
 617
 618 /********* HSM **********/
 619
 620 /** HSM per-file state
 621  * See HSM_FLAGS below.
 622  */
 623 enum hsm_states {
 624         HS_EXISTS    = 0x00000001,
 625         HS_DIRTY     = 0x00000002,
 626         HS_RELEASED  = 0x00000004,
 627         HS_ARCHIVED  = 0x00000008,
 628         HS_NORELEASE = 0x00000010,
 629         HS_NOARCHIVE = 0x00000020,
 630         HS_LOST      = 0x00000040,
 631 };
 632
 633 /* HSM user-setable flags. */
 634 #define HSM_USER_MASK   (HS_NORELEASE | HS_NOARCHIVE | HS_DIRTY)
 635
 636 /* Other HSM flags. */
 637 #define HSM_STATUS_MASK (HS_EXISTS | HS_LOST | HS_RELEASED | HS_ARCHIVED)
 638
 639 /*
 640  * All HSM-related possible flags that could be applied to a file.
 641  * This should be kept in sync with hsm_states.
 642  */
 643 #define HSM_FLAGS_MASK  (HSM_USER_MASK | HSM_STATUS_MASK)
 644
 645 /**
 646  * HSM request progress state
 647  */
 648 enum hsm_progress_states {
 649         HPS_WAITING     = 1,
 650         HPS_RUNNING     = 2,
 651         HPS_DONE        = 3,
 652 };
 653 #define HPS_NONE        0
 654
 655 static inline char *hsm_progress_state2name(enum hsm_progress_states s)
 656 {
 657         switch  (s) {
 658         case HPS_WAITING: return "waiting";
 659         case HPS_RUNNING: return "running";
 660         case HPS_DONE:    return "done";
 661         default:          return "unknown";
 662         }
 663 }
 664
 665 struct hsm_extent {
 666         __u64 offset;
 667         __u64 length;
 668 } __attribute__((packed));
 669
 670 /**
 671  * Current HSM states of a Lustre file.
 672  *
 673  * This structure purpose is to be sent to user-space mainly. It describes the
 674  * current HSM flags and in-progress action.
 675  */
 676 struct hsm_user_state {
 677         /** Current HSM states, from enum hsm_states. */
 678         __u32              hus_states;
 679         __u32              hus_archive_num;
 680         /**  The current undergoing action, if there is one */
 681         __u32              hus_in_progress_state;
 682         __u32              hus_in_progress_action;
 683         struct hsm_extent  hus_in_progress_location;
 684         char               hus_extended_info[];
 685 };
 686
 687 struct hsm_state_set_ioc {
 688         struct lu_fid  hssi_fid;
 689         __u64          hssi_setmask;
 690         __u64          hssi_clearmask;
 691 };
 692
 693 /***** HSM user requests ******/
 694 /* User-generated (lfs/ioctl) request types */
 695 enum hsm_user_action {
 696         HUA_NONE    =  1, /* no action (noop) */
 697         HUA_ARCHIVE = 10, /* copy to hsm */
 698         HUA_RESTORE = 11, /* prestage */
 699         HUA_RELEASE = 12, /* drop ost objects */
 700         HUA_REMOVE  = 13, /* remove from archive */
 701         HUA_CANCEL  = 14  /* cancel a request */
 702 };
 703
 704 static inline char *hsm_user_action2name(enum hsm_user_action  a)
 705 {
 706         switch  (a) {
 707         case HUA_NONE:    return "NOOP";
 708         case HUA_ARCHIVE: return "ARCHIVE";
 709         case HUA_RESTORE: return "RESTORE";
 710         case HUA_RELEASE: return "RELEASE";
 711         case HUA_REMOVE:  return "REMOVE";
 712         case HUA_CANCEL:  return "CANCEL";
 713         default:          return "UNKNOWN";
 714         }
 715 }
 716
 717 struct hsm_user_item {
 718        lustre_fid        hui_fid;
 719        struct hsm_extent hui_extent;
 720 } __attribute__((packed));
 721
 722 struct hsm_user_request {
 723         __u32 hur_action;    /* enum hsm_user_action */
 724         __u32 hur_archive_num; /* archive number, used only with HUA_ARCHIVE */
 725         __u32 hur_itemcount;
 726         __u32 hur_data_len;
 727         struct hsm_user_item hur_user_item[0];
 728         /* extra data blob at end of struct (after all
 729          * hur_user_items), only use helpers to access it
 730          */
 731 } __attribute__((packed));
 732
 733 /** Return pointer to data field in a hsm user request */
 734 static inline void *hur_data(struct hsm_user_request *hur)
 735 {
 736         return &(hur->hur_user_item[hur->hur_itemcount]);
 737 }
 738
 739 /** Compute the current length of the provided hsm_user_request. */
 740 static inline int hur_len(struct hsm_user_request *hur)
 741 {
 742         int data_offset;
 743
 744         data_offset = hur_data(hur) - (void *)hur;
 745         return (data_offset + hur->hur_data_len);
 746 }
 747
 748 /****** HSM RPCs to copytool *****/
 749 /* Message types the copytool may receive */
 750 enum hsm_message_type {
 751         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
 752 };
 753
 754 /* Actions the copytool may be instructed to take for a given action_item */
 755 enum hsm_copytool_action {
 756         HSMA_NONE    = 10, /* no action */
 757         HSMA_ARCHIVE = 20, /* arbitrary offset */
 758         HSMA_RESTORE = 21,
 759         HSMA_REMOVE  = 22,
 760         HSMA_CANCEL  = 23
 761 };
 762
 763 static inline char *hsm_copytool_action2name(enum hsm_copytool_action  a)
 764 {
 765         switch  (a) {
 766         case HSMA_NONE:    return "NOOP";
 767         case HSMA_ARCHIVE: return "ARCHIVE";
 768         case HSMA_RESTORE: return "RESTORE";
 769         case HSMA_REMOVE:  return "REMOVE";
 770         case HSMA_CANCEL:  return "CANCEL";
 771         default:           return "UNKNOWN";
 772         }
 773 }
 774
 775 /* Copytool item action description */
 776 struct hsm_action_item {
 777         __u32      hai_len;     /* valid size of this struct */
 778         __u32      hai_action;  /* hsm_copytool_action, but use known size */
 779         lustre_fid hai_fid;     /* Lustre FID to operated on */
 780         struct hsm_extent hai_extent;  /* byte range to operate on */
 781         __u64      hai_cookie;  /* action cookie from coordinator */
 782         __u64      hai_gid;     /* grouplock id */
 783         char       hai_data[0]; /* variable length */
 784 } __attribute__((packed));
 785
 786 /*
 787  * helper function which print in hexa the first bytes of
 788  * hai opaque field
 789  * \param hai [IN] record to print
 790  * \param buffer [OUT] output buffer
 791  * \param len [IN] max buffer len
 792  * \retval buffer
 793  */
 794 static inline char *hai_dump_data_field(struct hsm_action_item *hai,
 795                                         char *buffer, int len)
 796 {
 797         int i, sz, data_len;
 798         char *ptr;
 799
 800         ptr = buffer;
 801         sz = len;
 802         data_len = hai->hai_len - sizeof(*hai);
 803         for (i = 0 ; (i < data_len) && (sz > 0) ; i++)
 804         {
 805                 int cnt;
 806
 807                 cnt = snprintf(ptr, sz, "%.2X",
 808                                (unsigned char)hai->hai_data[i]);
 809                 ptr += cnt;
 810                 sz -= cnt;
 811         }
 812         *ptr = '\0';
 813         return buffer;
 814 }
 815
 816 /* Copytool action list */
 817 #define HAL_VERSION 1
 818 #define HAL_MAXSIZE 4096 /* bytes, used in userspace only */
 819 struct hsm_action_list {
 820         __u32 hal_version;
 821         __u32 hal_count;       /* number of hai's to follow */
 822         __u64 hal_compound_id; /* returned by coordinator */
 823         __u32 hal_archive_num; /* which archive backend */
 824         __u32 padding1;
 825         char  hal_fsname[0];   /* null-terminated */
 826         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
 827            boundaries. See hai_zero */
 828 } __attribute__((packed));
 829
 830 #ifndef HAVE_CFS_SIZE_ROUND
 831 static inline int cfs_size_round (int val)
 832 {
 833         return (val + 7) & (~0x7);
 834 }
 835 #define HAVE_CFS_SIZE_ROUND
 836 #endif
 837
 838 /* Return pointer to first hai in action list */
 839 static inline struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
 840 {
 841         return (struct hsm_action_item *)(hal->hal_fsname +
 842                                           cfs_size_round(strlen(hal-> \
 843                                                                 hal_fsname)));
 844 }
 845 /* Return pointer to next hai */
 846 static inline struct hsm_action_item * hai_next(struct hsm_action_item *hai)
 847 {
 848         return (struct hsm_action_item *)((char *)hai +
 849                                           cfs_size_round(hai->hai_len));
 850 }
 851
 852 /* Return size of an hsm_action_list */
 853 static inline int hal_size(struct hsm_action_list *hal)
 854 {
 855         int i, sz;
 856         struct hsm_action_item *hai;
 857
 858         sz = sizeof(*hal) + cfs_size_round(strlen(hal->hal_fsname));
 859         hai = hai_zero(hal);
 860         for (i = 0 ; i < hal->hal_count ; i++) {
 861                 sz += cfs_size_round(hai->hai_len);
 862                 hai = hai_next(hai);
 863         }
 864         return(sz);
 865 }
 866
 867 /* Copytool progress reporting */
 868 #define HP_FLAG_COMPLETED 0x01
 869 #define HP_FLAG_RETRY     0x02
 870
 871 struct hsm_progress {
 872         lustre_fid        hp_fid;
 873         __u64             hp_cookie;
 874         struct hsm_extent hp_extent;
 875         __u16             hp_flags;
 876         __u16             hp_errval; /* positive val */
 877 } __attribute__((packed));
 878
 879 /** @} lustreuser */
 880
 881 #endif /* _LUSTRE_USER_H */