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