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