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 EXT3_IOC_GETFLAGS
  59 #define EXT3_IOC_GETFLAGS               _IOR('f', 1, long)
  60 #define EXT3_IOC_SETFLAGS               _IOW('f', 2, long)
  61 #define EXT3_IOC_GETVERSION             _IOR('f', 3, long)
  62 #define EXT3_IOC_SETVERSION             _IOW('f', 4, long)
  63 #define EXT3_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  64 #define EXT3_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  65 #define EXT3_IOC_FIEMAP                 _IOWR('f', 10, 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
  99 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 166, OBD_IOC_DATA_TYPE)
 100 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 167, OBD_IOC_DATA_TYPE)
 101 #define LL_IOC_LLOOP_INFO               _IOWR('f', 168, OBD_IOC_DATA_TYPE)
 102 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 169, OBD_IOC_DATA_TYPE)
 103
 104 #define LL_STATFS_MDC           1
 105 #define LL_STATFS_LOV           2
 106
 107 #define IOC_MDC_TYPE            'i'
 108 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
 109 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
 110 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
 111 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
 112
 113 /* Keep these for backward compartability. */
 114 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
 115 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
 116
 117 /* Do not define O_CHECK_STALE as 0200000000,
 118  * which is conflict with MDS_OPEN_OWNEROVERRIDE */
 119 #define O_CHECK_STALE       020000000  /* hopefully this does not conflict */
 120
 121 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
 122 #define O_JOIN_FILE        0400000000  /* 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
 128 #define LOV_USER_MAGIC_V1 0x0BD10BD0
 129 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
 130 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
 131 #define LOV_USER_MAGIC_V3 0x0BD30BD0
 132
 133 #define LOV_PATTERN_RAID0 0x001
 134 #define LOV_PATTERN_RAID1 0x002
 135 #define LOV_PATTERN_FIRST 0x100
 136
 137 #define LOV_MAXPOOLNAME 16
 138 #define LOV_POOLNAMEF "%.16s"
 139
 140 #define lov_user_ost_data lov_user_ost_data_v1
 141 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
 142         __u64 l_object_id;        /* OST object ID */
 143         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 144         __u32 l_ost_gen;          /* generation of this OST index */
 145         __u32 l_ost_idx;          /* OST index in LOV */
 146 } __attribute__((packed));
 147
 148 #define lov_user_md lov_user_md_v1
 149 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 150         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 151         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 152         __u64 lmm_object_id;      /* LOV object ID */
 153         __u64 lmm_object_gr;      /* LOV object group */
 154         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 155         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 156         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 157         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 158 } __attribute__((packed));
 159
 160 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
 161         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
 162         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 163         __u64 lmm_object_id;      /* LOV object ID */
 164         __u64 lmm_object_gr;      /* LOV object group */
 165         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 166         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 167         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 168         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
 169         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 170 } __attribute__((packed));
 171
 172 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 173  * use this.  It is unsafe to #define those values in this header as it
 174  * is possible the application has already #included <sys/stat.h>. */
 175 #ifdef HAVE_LOV_USER_MDS_DATA
 176 #define lov_user_mds_data lov_user_mds_data_v1
 177 struct lov_user_mds_data_v1 {
 178         lstat_t lmd_st;                 /* MDS stat struct */
 179         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
 180 } __attribute__((packed));
 181
 182 struct lov_user_mds_data_v3 {
 183         lstat_t lmd_st;                 /* MDS stat struct */
 184         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
 185 } __attribute__((packed));
 186 #endif
 187
 188 struct ll_recreate_obj {
 189         __u64 lrc_id;
 190         __u32 lrc_ost_idx;
 191 };
 192
 193 struct ll_fid {
 194         __u64 id;         /* holds object id */
 195         __u32 generation; /* holds object generation */
 196         __u32 f_type;     /* holds object type or stripe idx when passing it to
 197                            * OST for saving into EA. */
 198 };
 199
 200 struct filter_fid {
 201         struct ll_fid   ff_fid;  /* ff_fid.f_type == file stripe number */
 202         __u64           ff_objid;
 203         __u64           ff_group;
 204 };
 205
 206 struct obd_uuid {
 207         char uuid[40];
 208 };
 209
 210 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
 211 {
 212         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 213 }
 214
 215 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 216 {
 217         return uuid->uuid[0] == '\0';
 218 }
 219
 220 static inline void obd_str2uuid(struct obd_uuid *uuid, char *tmp)
 221 {
 222         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 223         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 224 }
 225
 226 /* For printf's only, make sure uuid is terminated */
 227 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 228 {
 229         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 230                 /* Obviously not safe, but for printfs, no real harm done...
 231                    we're always null-terminated, even in a race. */
 232                 static char temp[sizeof(*uuid)];
 233                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 234                 temp[sizeof(*uuid) - 1] = '\0';
 235                 return temp;
 236         }
 237         return (char *)(uuid->uuid);
 238 }
 239
 240 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 241 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
 242 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
 243 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 244 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 245 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 246 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 247 /* lustre-specific control commands */
 248 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
 249 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
 250
 251 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 252
 253 struct if_quotacheck {
 254         char                    obd_type[16];
 255         struct obd_uuid         obd_uuid;
 256 };
 257
 258 #define MDS_GRP_DOWNCALL_MAGIC 0x6d6dd620
 259
 260 struct mds_grp_downcall_data {
 261         __u32           mgd_magic;
 262         __u32           mgd_err;
 263         __u32           mgd_uid;
 264         __u32           mgd_gid;
 265         __u32           mgd_ngroups;
 266         __u32           mgd_groups[0];
 267 };
 268
 269 #ifdef NEED_QUOTA_DEFS
 270 #ifndef QUOTABLOCK_BITS
 271 #define QUOTABLOCK_BITS 10
 272 #endif
 273
 274 #ifndef QUOTABLOCK_SIZE
 275 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
 276 #endif
 277
 278 #ifndef toqb
 279 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
 280 #endif
 281
 282 #ifndef QIF_BLIMITS
 283 #define QIF_BLIMITS     1
 284 #define QIF_SPACE       2
 285 #define QIF_ILIMITS     4
 286 #define QIF_INODES      8
 287 #define QIF_BTIME       16
 288 #define QIF_ITIME       32
 289 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 290 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 291 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 292 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 293 #endif
 294
 295 #endif /* !__KERNEL__ */
 296
 297 #define QFMT_LDISKFS 2 /* pre-1.6.6 compatibility */
 298
 299 typedef enum lustre_quota_version {
 300         LUSTRE_QUOTA_V1 = 0,
 301         LUSTRE_QUOTA_V2 = 1
 302 } lustre_quota_version_t;
 303
 304 /* XXX: same as if_dqinfo struct in kernel */
 305 struct obd_dqinfo {
 306         __u64 dqi_bgrace;
 307         __u64 dqi_igrace;
 308         __u32 dqi_flags;
 309         __u32 dqi_valid;
 310 };
 311
 312 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 313 struct obd_dqblk {
 314         __u64 dqb_bhardlimit;
 315         __u64 dqb_bsoftlimit;
 316         __u64 dqb_curspace;
 317         __u64 dqb_ihardlimit;
 318         __u64 dqb_isoftlimit;
 319         __u64 dqb_curinodes;
 320         __u64 dqb_btime;
 321         __u64 dqb_itime;
 322         __u32 dqb_valid;
 323         __u32 padding;
 324 };
 325
 326 struct if_quotactl {
 327         __u32                   qc_cmd;
 328         __u32                   qc_type;
 329         __u32                   qc_id;
 330         __u32                   qc_stat;
 331         struct obd_dqinfo       qc_dqinfo;
 332         struct obd_dqblk        qc_dqblk;
 333         char                    obd_type[16];
 334         struct obd_uuid         obd_uuid;
 335 };
 336
 337 #ifndef offsetof
 338 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 339 #endif
 340
 341 #endif /* _LUSTRE_USER_H */