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 #define FSFILT_IOC_GETFLAGS               _IOR('f', 1, long)
  59 #define FSFILT_IOC_SETFLAGS               _IOW('f', 2, long)
  60 #define FSFILT_IOC_GETVERSION             _IOR('f', 3, long)
  61 #define FSFILT_IOC_SETVERSION             _IOW('f', 4, long)
  62 #define FSFILT_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  63 #define FSFILT_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  64 #define FSFILT_IOC_FIEMAP                 _IOWR('f', 11, struct ll_user_fiemap)
  65
  66 /* FIEMAP flags supported by Lustre */
  67 #define LUSTRE_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_DEVICE_ORDER)
  68
  69 enum obd_statfs_state {
  70         OS_STATE_DEGRADED       = 0x00000001, /**< RAID degraded/rebuilding */
  71         OS_STATE_READONLY       = 0x00000002, /**< filesystem is read-only */
  72         OS_STATE_RDONLY_1       = 0x00000004, /**< obsolete 1.6, was EROFS=30 */
  73         OS_STATE_RDONLY_2       = 0x00000008, /**< obsolete 1.6, was EROFS=30 */
  74         OS_STATE_RDONLY_3       = 0x00000010, /**< obsolete 1.6, was EROFS=30 */
  75 };
  76
  77 struct obd_statfs {
  78         __u64           os_type;
  79         __u64           os_blocks;
  80         __u64           os_bfree;
  81         __u64           os_bavail;
  82         __u64           os_files;
  83         __u64           os_ffree;
  84         __u8            os_fsid[40];
  85         __u32           os_bsize;
  86         __u32           os_namelen;
  87         __u64           os_maxbytes;
  88         __u32           os_state;       /**< obd_statfs_state OS_STATE_* flag */
  89         __u32           os_spare1;
  90         __u32           os_spare2;
  91         __u32           os_spare3;
  92         __u32           os_spare4;
  93         __u32           os_spare5;
  94         __u32           os_spare6;
  95         __u32           os_spare7;
  96         __u32           os_spare8;
  97         __u32           os_spare9;
  98 };
  99
 100
 101 /*
 102  * The ioctl naming rules:
 103  * LL_*     - works on the currently opened filehandle instead of parent dir
 104  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
 105  * *_MDC_*  - gets/sets data related to MDC
 106  * *_LOV_*  - gets/sets data related to OSC/LOV
 107  * *FILE*   - called on parent dir and passes in a filename
 108  * *STRIPE* - set/get lov_user_md
 109  * *INFO    - set/get lov_user_mds_data
 110  */
 111 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
 112 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
 113 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
 114 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
 115 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
 116 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
 117 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
 118 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
 119 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
 120 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
 121 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
 122 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl *)
 123 #define LL_IOC_JOIN                     _IOW ('f', 163, long)
 124 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
 125 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
 126
 127 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 166, OBD_IOC_DATA_TYPE)
 128 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 167, OBD_IOC_DATA_TYPE)
 129 #define LL_IOC_LLOOP_INFO               _IOWR('f', 168, OBD_IOC_DATA_TYPE)
 130 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 169, OBD_IOC_DATA_TYPE)
 131
 132 #define LL_IOC_PATH2FID                 _IOR ('f', 173, long)
 133
 134 #define LL_STATFS_MDC           1
 135 #define LL_STATFS_LOV           2
 136
 137 #define IOC_MDC_TYPE            'i'
 138 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 139 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 140 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 141 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 142
 143 /* Keep these for backward compartability. */
 144 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
 145 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
 146
 147 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
 148
 149 #define LL_FILE_IGNORE_LOCK         0x00000001
 150 #define LL_FILE_GROUP_LOCKED        0x00000002
 151 #define LL_FILE_READAHEAD           0x00000004
 152 #define LL_FILE_LOCKED_DIRECTIO     0x00000008 /* client-side locks with dio */
 153 #define LL_FILE_LOCKLESS_IO         0x00000010 /* server-side locks with cio */
 154
 155 #define LOV_USER_MAGIC_V1 0x0BD10BD0
 156 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
 157 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
 158 #define LOV_USER_MAGIC_V3 0x0BD30BD0
 159
 160 #define LOV_USER_MAGIC_V1_SWABBED 0xD00BD10B
 161 #define LOV_USER_MAGIC_V3_SWABBED 0xD00BD30B
 162
 163 #define LOV_PATTERN_RAID0 0x001
 164 #define LOV_PATTERN_RAID1 0x002
 165 #define LOV_PATTERN_FIRST 0x100
 166
 167 #define LOV_MAXPOOLNAME 16
 168 #define LOV_POOLNAMEF "%.16s"
 169
 170 #define lov_user_ost_data lov_user_ost_data_v1
 171 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 172         __u64 l_object_id;        /* OST object ID */
 173         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 174         __u32 l_ost_gen;          /* generation of this OST index */
 175         __u32 l_ost_idx;          /* OST index in LOV */
 176 } __attribute__((packed));
 177
 178 #define lov_user_md lov_user_md_v1
 179 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 180         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 181         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 182         __u64 lmm_object_id;      /* LOV object ID */
 183         __u64 lmm_object_gr;      /* LOV object group */
 184         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 185         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 186         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 187         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 188 } __attribute__((packed));
 189
 190 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 191         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 192         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 193         __u64 lmm_object_id;      /* LOV object ID */
 194         __u64 lmm_object_gr;      /* LOV object group */
 195         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 196         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 197         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 198         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
 199         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 200 } __attribute__((packed));
 201
 202 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 203  * use this.  It is unsafe to #define those values in this header as it
 204  * is possible the application has already #included <sys/stat.h>. */
 205 #ifdef HAVE_LOV_USER_MDS_DATA
 206 #define lov_user_mds_data lov_user_mds_data_v1
 207 struct lov_user_mds_data_v1 {
 208         lstat_t lmd_st;                 /* MDS stat struct */
 209         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 210 } __attribute__((packed));
 211
 212 struct lov_user_mds_data_v3 {
 213         lstat_t lmd_st;                 /* MDS stat struct */
 214         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 215 } __attribute__((packed));
 216 #endif
 217
 218 struct ll_recreate_obj {
 219         __u64 lrc_id;
 220         __u32 lrc_ost_idx;
 221 };
 222
 223 struct ll_fid {
 224         __u64 id;         /* holds object id */
 225         __u32 generation; /* holds object generation */
 226         __u32 f_type;     /* holds object type or stripe idx when passing it to
 227                            * OST for saving into EA. */
 228 };
 229
 230 struct filter_fid {
 231         struct ll_fid   ff_fid;  /* ff_fid.f_type == file stripe number */
 232         __u64           ff_objid;
 233         __u64           ff_group;
 234 };
 235
 236 struct obd_uuid {
 237         char uuid[40];
 238 };
 239
 240 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
 241 {
 242         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 243 }
 244
 245 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 246 {
 247         return uuid->uuid[0] == '\0';
 248 }
 249
 250 static inline void obd_str2uuid(struct obd_uuid *uuid, char *tmp)
 251 {
 252         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 253         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 254 }
 255
 256 /* For printf's only, make sure uuid is terminated */
 257 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 258 {
 259         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 260                 /* Obviously not safe, but for printfs, no real harm done...
 261                    we're always null-terminated, even in a race. */
 262                 static char temp[sizeof(*uuid)];
 263                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 264                 temp[sizeof(*uuid) - 1] = '\0';
 265                 return temp;
 266         }
 267         return (char *)(uuid->uuid);
 268 }
 269
 270 struct lu_fid {
 271         __u64 f_seq;  /* holds fid sequence. Lustre should support 2^64
 272                        * objects, thus even if one sequence has one object we
 273                        * reach this value. */
 274         __u32 f_oid;  /* fid number within its sequence. */
 275         __u32 f_ver;  /* holds fid version. */
 276 };
 277
 278 /* Userspace should treat lu_fid as opaque, and only use the following methods
 279    to print or parse them.  Other functions (e.g. compare, swab) could be moved
 280    here from lustre_idl.h if needed. */
 281 typedef struct lu_fid lustre_fid;
 282
 283 /* printf display format
 284    e.g. printf("file FID is "DFID"\n", PFID(fid)); */
 285 #define DFID "["LPX64":0x%x:0x%x]"
 286 #define PFID(fid)     \
 287         fid_seq(fid), \
 288         fid_oid(fid), \
 289         fid_ver(fid)
 290
 291 /* scanf input parse format -- strip '[' first.
 292    e.g. sscanf(fidstr, SFID, RFID(&fid)); */
 293 #define SFID "0x%llx:0x%x:0x%x"
 294 #define RFID(fid)     \
 295         &((fid)->f_seq), \
 296         &((fid)->f_oid), \
 297         &((fid)->f_ver)
 298
 299 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 300 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
 301 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
 302 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 303 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 304 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 305 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 306 /* lustre-specific control commands */
 307 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
 308 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
 309
 310 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 311
 312 struct if_quotacheck {
 313         char                    obd_type[16];
 314         struct obd_uuid         obd_uuid;
 315 };
 316
 317 #define MDS_GRP_DOWNCALL_MAGIC 0x6d6dd620
 318
 319 struct mds_grp_downcall_data {
 320         __u32           mgd_magic;
 321         __u32           mgd_err;
 322         __u32           mgd_uid;
 323         __u32           mgd_gid;
 324         __u32           mgd_ngroups;
 325         __u32           mgd_groups[0];
 326 };
 327
 328 #ifdef NEED_QUOTA_DEFS
 329
 330 #ifndef QIF_BLIMITS
 331 #define QIF_BLIMITS     1
 332 #define QIF_SPACE       2
 333 #define QIF_ILIMITS     4
 334 #define QIF_INODES      8
 335 #define QIF_BTIME       16
 336 #define QIF_ITIME       32
 337 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 338 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 339 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 340 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 341 #endif
 342
 343 #endif /* !__KERNEL__ */
 344
 345 #define QFMT_LDISKFS 2 /* pre-1.6.6 compatibility */
 346
 347 typedef enum lustre_quota_version {
 348         LUSTRE_QUOTA_V1 = 0,
 349         LUSTRE_QUOTA_V2 = 1
 350 } lustre_quota_version_t;
 351
 352 /* XXX: same as if_dqinfo struct in kernel */
 353 struct obd_dqinfo {
 354         __u64 dqi_bgrace;
 355         __u64 dqi_igrace;
 356         __u32 dqi_flags;
 357         __u32 dqi_valid;
 358 };
 359
 360 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 361 struct obd_dqblk {
 362         __u64 dqb_bhardlimit;
 363         __u64 dqb_bsoftlimit;
 364         __u64 dqb_curspace;
 365         __u64 dqb_ihardlimit;
 366         __u64 dqb_isoftlimit;
 367         __u64 dqb_curinodes;
 368         __u64 dqb_btime;
 369         __u64 dqb_itime;
 370         __u32 dqb_valid;
 371         __u32 padding;
 372 };
 373
 374 struct if_quotactl {
 375         __u32                   qc_cmd;
 376         __u32                   qc_type;
 377         __u32                   qc_id;
 378         __u32                   qc_stat;
 379         struct obd_dqinfo       qc_dqinfo;
 380         struct obd_dqblk        qc_dqblk;
 381         char                    obd_type[16];
 382         struct obd_uuid         obd_uuid;
 383 };
 384
 385 #ifndef offsetof
 386 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 387 #endif
 388
 389 #endif /* _LUSTRE_USER_H */