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