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  2008 Sun Microsystems, Inc. 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 #include <lustre/ll_fiemap.h>
  45 #if defined(__linux__)
  46 #include <linux/lustre_user.h>
  47 #elif defined(__APPLE__)
  48 #include <darwin/lustre_user.h>
  49 #elif defined(__WINNT__)
  50 #include <winnt/lustre_user.h>
  51 #else
  52 #error Unsupported operating system.
  53 #endif
  54
  55 /* for statfs() */
  56 #define LL_SUPER_MAGIC 0x0BD00BD0
  57
  58 #ifndef FSFILT_IOC_GETFLAGS
  59 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
  60 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
  61 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
  62 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
  63 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  64 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  65 #define FSFILT_IOC_FIEMAP                 _IOWR('f', 11, struct ll_user_fiemap)
  66 #endif
  67
  68 /* FIEMAP flags supported by Lustre */
  69 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
  70
  71 struct obd_statfs;
  72
  73 /*
  74  * The ioctl naming rules:
  75  * LL_*     - works on the currently opened filehandle instead of parent dir
  76  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
  77  * *_MDC_*  - gets/sets data related to MDC
  78  * *_LOV_*  - gets/sets data related to OSC/LOV
  79  * *FILE*   - called on parent dir and passes in a filename
  80  * *STRIPE* - set/get lov_user_md
  81  * *INFO    - set/get lov_user_mds_data
  82  */
  83 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
  84 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
  85 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
  86 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
  87 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
  88 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
  89 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
  90 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
  91 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
  92 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
  93 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
  94 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl *)
  95 #define LL_IOC_JOIN                     _IOW ('f', 163, long)
  96 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
  97 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
  98 #define LL_IOC_FLUSHCTX                 _IOW ('f', 166, long)
  99 #define LL_IOC_RMTACL                   _IOW ('f', 167, long)
 100
 101 #define LL_IOC_GETOBDCOUNT              _IOR ('f', 168, long)
 102
 103 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 169, long)
 104 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 170, long)
 105 #define LL_IOC_LLOOP_INFO               _IOWR('f', 171, long)
 106 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 172, long)
 107 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 108
 109 #define LL_STATFS_MDC           1
 110 #define LL_STATFS_LOV           2
 111
 112 #define IOC_MDC_TYPE            'i'
 113 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 114 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 115 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 116 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 117
 118 /* Keep these for backward compartability. */
 119 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
 120 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
 121
 122 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
 123
 124 #define LL_FILE_IGNORE_LOCK             0x00000001
 125 #define LL_FILE_GROUP_LOCKED            0x00000002
 126 #define LL_FILE_READAHEAD               0x00000004
 127 #define LL_FILE_RMTACL                  0x00000008
 128
 129 #define LOV_USER_MAGIC_V1 0x0BD10BD0
 130 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
 131 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
 132 #define LOV_USER_MAGIC_V3 0x0BD30BD0
 133
 134 #define LOV_PATTERN_RAID0 0x001
 135 #define LOV_PATTERN_RAID1 0x002
 136 #define LOV_PATTERN_FIRST 0x100
 137
 138 #define LOV_MAXPOOLNAME 16
 139 #define LOV_POOLNAMEF "%.16s"
 140
 141 #define lov_user_ost_data lov_user_ost_data_v1
 142 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 143         __u64 l_object_id;        /* OST object ID */
 144         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 145         __u32 l_ost_gen;          /* generation of this OST index */
 146         __u32 l_ost_idx;          /* OST index in LOV */
 147 } __attribute__((packed));
 148
 149 #define lov_user_md lov_user_md_v1
 150 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 151         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 152         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 153         __u64 lmm_object_id;      /* LOV object ID */
 154         __u64 lmm_object_gr;      /* LOV object group */
 155         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 156         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 157         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 158         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 159 } __attribute__((packed));
 160
 161 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 162         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 163         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 164         __u64 lmm_object_id;      /* LOV object ID */
 165         __u64 lmm_object_gr;      /* LOV object group */
 166         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 167         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 168         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 169         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
 170         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 171 } __attribute__((packed));
 172
 173 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 174  * use this.  It is unsafe to #define those values in this header as it
 175  * is possible the application has already #included <sys/stat.h>. */
 176 #ifdef HAVE_LOV_USER_MDS_DATA
 177 #define lov_user_mds_data lov_user_mds_data_v1
 178 struct lov_user_mds_data_v1 {
 179         lstat_t lmd_st;                 /* MDS stat struct */
 180         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 181 } __attribute__((packed));
 182
 183 struct lov_user_mds_data_v3 {
 184         lstat_t lmd_st;                 /* MDS stat struct */
 185         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 186 } __attribute__((packed));
 187 #endif
 188
 189 struct ll_recreate_obj {
 190         __u64 lrc_id;
 191         __u64 lrc_group;
 192         __u32 lrc_ost_idx;
 193 };
 194
 195 struct obd_uuid {
 196         char uuid[40];
 197 };
 198
 199 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
 200 {
 201         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 202 }
 203
 204 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 205 {
 206         return uuid->uuid[0] == '\0';
 207 }
 208
 209 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
 210 {
 211         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 212         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 213 }
 214
 215 /* For printf's only, make sure uuid is terminated */
 216 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 217 {
 218         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 219                 /* Obviously not safe, but for printfs, no real harm done...
 220                    we're always null-terminated, even in a race. */
 221                 static char temp[sizeof(*uuid)];
 222                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 223                 temp[sizeof(*uuid) - 1] = '\0';
 224                 return temp;
 225         }
 226         return (char *)(uuid->uuid);
 227 }
 228
 229 /* Extract fsname from uuid (or target name) of a target
 230    e.g. (myfs-OST0007_UUID -> myfs)
 231    see also deuuidify. */
 232 static inline void obd_uuid2fsname(char *buf, char *uuid, int buflen)
 233 {
 234         char *p;
 235
 236         strncpy(buf, uuid, buflen - 1);
 237         buf[buflen - 1] = '\0';
 238         p = strrchr(buf, '-');
 239         if (p)
 240            *p = '\0';
 241 }
 242
 243 /**
 244  * File IDentifier.
 245  *
 246  * FID is a cluster-wide unique identifier of a file or an object (stripe).
 247  * FIDs are never reused.
 248  */
 249 struct lu_fid {
 250         /**
 251          * FID sequence. Sequence is a unit of migration: all files (objects)
 252          * with FIDs from a given sequence are stored on the same server.
 253          * Lustre should support 2^64 objects, so even if each sequence
 254          * has only a single object we can still enumerate 2^64 objects.
 255          */
 256         __u64 f_seq;
 257         /** FID number within sequence. */
 258         __u32 f_oid;
 259         /**
 260          * FID version, used to distinguish different versions (in the sense
 261          * of snapshots, etc.) of the same file system object. Not currently
 262          * used.
 263          */
 264         __u32 f_ver;
 265 };
 266
 267 /* Userspace should treat lu_fid as opaque, and only use the following methods
 268    to print or parse them.  Other functions (e.g. compare, swab) could be moved
 269    here from lustre_idl.h if needed. */
 270 typedef struct lu_fid lustre_fid;
 271
 272 /* printf display format
 273    e.g. printf("file FID is "DFID"\n", PFID(fid)); */
 274 #define DFID "["LPX64":0x%x:0x%x]"
 275 #define PFID(fid)     \
 276         (fid)->f_seq, \
 277         (fid)->f_oid, \
 278         (fid)->f_ver
 279
 280 /* scanf input parse format -- strip '[' first.
 281    e.g. sscanf(fidstr, SFID, RFID(&fid)); */
 282 #define SFID "0x%llx:0x%x:0x%x"
 283 #define RFID(fid)     \
 284         &((fid)->f_seq), \
 285         &((fid)->f_oid), \
 286         &((fid)->f_ver)
 287
 288
 289 /********* Quotas **********/
 290
 291 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 292 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
 293 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
 294 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 295 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 296 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 297 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 298 /* lustre-specific control commands */
 299 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
 300 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
 301
 302 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 303 #define IMMQUOTA 0x4    /* set immutable quota flag, cannot be turned on/off
 304                          * on-fly. temporary used by SOM */
 305
 306 struct if_quotacheck {
 307         char                    obd_type[16];
 308         struct obd_uuid         obd_uuid;
 309 };
 310
 311 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd620
 312
 313 /* permission */
 314 #define N_PERMS_MAX      64
 315
 316 struct perm_downcall_data {
 317         __u64 pdd_nid;
 318         __u32 pdd_perm;
 319 };
 320
 321 struct identity_downcall_data {
 322         __u32                            idd_magic;
 323         __u32                            idd_err;
 324         __u32                            idd_uid;
 325         __u32                            idd_gid;
 326         __u32                            idd_nperms;
 327         struct perm_downcall_data idd_perms[N_PERMS_MAX];
 328         __u32                            idd_ngroups;
 329         __u32                            idd_groups[0];
 330 };
 331
 332 /* for non-mapped uid/gid */
 333 #define NOBODY_UID      99
 334 #define NOBODY_GID      99
 335
 336 #define INVALID_ID      (-1)
 337
 338 enum {
 339         RMT_LSETFACL    = 1,
 340         RMT_LGETFACL    = 2,
 341         RMT_RSETFACL    = 3,
 342         RMT_RGETFACL    = 4
 343 };
 344
 345 #ifdef NEED_QUOTA_DEFS
 346 #ifndef QUOTABLOCK_BITS
 347 #define QUOTABLOCK_BITS 10
 348 #endif
 349
 350 #ifndef QUOTABLOCK_SIZE
 351 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
 352 #endif
 353
 354 #ifndef toqb
 355 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
 356 #endif
 357
 358 #ifndef QIF_BLIMITS
 359 #define QIF_BLIMITS     1
 360 #define QIF_SPACE       2
 361 #define QIF_ILIMITS     4
 362 #define QIF_INODES      8
 363 #define QIF_BTIME       16
 364 #define QIF_ITIME       32
 365 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 366 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 367 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 368 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 369 #endif
 370
 371 #endif /* !__KERNEL__ */
 372
 373 typedef enum lustre_quota_version {
 374         LUSTRE_QUOTA_V2 = 1
 375 } lustre_quota_version_t;
 376
 377 /* XXX: same as if_dqinfo struct in kernel */
 378 struct obd_dqinfo {
 379         __u64 dqi_bgrace;
 380         __u64 dqi_igrace;
 381         __u32 dqi_flags;
 382         __u32 dqi_valid;
 383 };
 384
 385 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 386 struct obd_dqblk {
 387         __u64 dqb_bhardlimit;
 388         __u64 dqb_bsoftlimit;
 389         __u64 dqb_curspace;
 390         __u64 dqb_ihardlimit;
 391         __u64 dqb_isoftlimit;
 392         __u64 dqb_curinodes;
 393         __u64 dqb_btime;
 394         __u64 dqb_itime;
 395         __u32 dqb_valid;
 396         __u32 padding;
 397 };
 398
 399 enum {
 400         QC_GENERAL      = 0,
 401         QC_MDTIDX       = 1,
 402         QC_OSTIDX       = 2,
 403         QC_UUID         = 3
 404 };
 405
 406 struct if_quotactl {
 407         __u32                   qc_cmd;
 408         __u32                   qc_type;
 409         __u32                   qc_id;
 410         __u32                   qc_stat;
 411         __u32                   qc_valid;
 412         __u32                   qc_idx;
 413         struct obd_dqinfo       qc_dqinfo;
 414         struct obd_dqblk        qc_dqblk;
 415         char                    obd_type[16];
 416         struct obd_uuid         obd_uuid;
 417 };
 418
 419
 420 /********* Misc **********/
 421
 422 struct ioc_changelog_clear {
 423         __u32 icc_mdtindex;
 424         __u32 icc_id;
 425         __u64 icc_recno;
 426 };
 427
 428 #ifndef offsetof
 429 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 430 #endif
 431
 432 #define dot_lustre_name ".lustre"
 433
 434
 435 /********* HSM **********/
 436 enum hsm_message_type {
 437         HMT_ACTION_LIST = 100, /* message is a hsm_action_list */
 438 };
 439
 440 /* User-generated (ioctl) request types */
 441 enum hsm_request {
 442         HSMR_ARCHIVE = 10, /* copy to hsm */
 443         HSMR_RESTORE = 11, /* prestage */
 444         HSMR_RELEASE = 12, /* drop ost objects */
 445         HSMR_REMOVE  = 13, /* remove from archive */
 446         HSMR_CANCEL  = 14
 447 };
 448
 449 /* Copytool commands */
 450 enum hsm_action {
 451         HSMA_ARCHIVE = 20, /* arbitrary offset */
 452         HSMA_RESTORE = 21,
 453         HSMA_REMOVE  = 22,
 454         HSMA_CANCEL  = 23
 455 };
 456
 457 /* Copytool item action description */
 458 struct hsm_action_item {
 459         __u32      hai_len;     /* valid size of this struct */
 460         __u32      hai_action;  /* enum actually, but use known size */
 461         lustre_fid hai_fid;     /* Lustre FID to operated on */
 462         __u64      hai_cookie;  /* action cookie from coordinator */
 463         __u64      hai_extent_start;  /* byte range to operate on */
 464         __u64      hai_extent_end;
 465         __u64      hai_gid;     /* grouplock id */
 466         char       hai_data[0]; /* variable length */
 467 } __attribute__((packed));
 468
 469 /* Copytool action list */
 470 #define HAL_VERSION 1
 471 #define HAL_MAXSIZE 4096 /* bytes, used in userspace only */
 472 struct hsm_action_list {
 473         __u32 hal_version;
 474         __u32 hal_count;       /* number of hai's to follow */
 475         __u32 hal_archive_num; /* which archive backend */
 476         __u32 padding1;
 477         char  hal_fsname[0];   /* null-terminated */
 478         /* struct hsm_action_item[hal_count] follows, aligned on 8-byte
 479            boundaries. See hai_zero */
 480 } __attribute__((packed));
 481
 482 /* Return pointer to first hai in action list */
 483 static __inline__ struct hsm_action_item * hai_zero(struct hsm_action_list *hal)
 484 {
 485         return (struct hsm_action_item *)(hal->hal_fsname +
 486                                           size_round(strlen(hal->hal_fsname)));
 487 }
 488 /* Return pointer to next hai */
 489 static __inline__ struct hsm_action_item * hai_next(struct hsm_action_item *hai)
 490 {
 491         return (struct hsm_action_item *)((char *)hai +
 492                                           size_round(hai->hai_len));
 493 }
 494
 495
 496 #endif /* _LUSTRE_USER_H */