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