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