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