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  *   This file is part of Lustre, http://www.lustre.org
   5  *
   6  * Lustre public user-space interface definitions.
   7  */
   8
   9 #ifndef _LUSTRE_USER_H
  10 #define _LUSTRE_USER_H
  11
  12 #if defined(__linux__)
  13 #include <linux/lustre_user.h>
  14 #elif defined(__APPLE__)
  15 #include <darwin/lustre_user.h>
  16 #elif defined(__WINNT__)
  17 #include <winnt/lustre_user.h>
  18 #else
  19 #error Unsupported operating system.
  20 #endif
  21
  22 /* for statfs() */
  23 #define LL_SUPER_MAGIC 0x0BD00BD0
  24
  25 #ifndef EXT3_IOC_GETFLAGS
  26 #define EXT3_IOC_GETFLAGS               _IOR('f', 1, long)
  27 #define EXT3_IOC_SETFLAGS               _IOW('f', 2, long)
  28 #define EXT3_IOC_GETVERSION             _IOR('f', 3, long)
  29 #define EXT3_IOC_SETVERSION             _IOW('f', 4, long)
  30 #define EXT3_IOC_GETVERSION_OLD         _IOR('v', 1, long)
  31 #define EXT3_IOC_SETVERSION_OLD         _IOW('v', 2, long)
  32 #endif
  33
  34 struct obd_statfs;
  35
  36 /*
  37  * The ioctl naming rules:
  38  * LL_*     - works on the currently opened filehandle instead of parent dir
  39  * *_OBD_*  - gets data for both OSC or MDC (LOV, LMV indirectly)
  40  * *_MDC_*  - gets/sets data related to MDC
  41  * *_LOV_*  - gets/sets data related to OSC/LOV
  42  * *FILE*   - called on parent dir and passes in a filename
  43  * *STRIPE* - set/get lov_user_md
  44  * *INFO    - set/get lov_user_mds_data
  45  */
  46 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
  47 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
  48 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
  49 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
  50 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
  51 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
  52 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
  53 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
  54 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
  55 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
  56 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
  57 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl *)
  58 #define LL_IOC_JOIN                     _IOW ('f', 163, long)
  59 #define IOC_OBD_STATFS                  _IOWR('f', 164, struct obd_statfs *)
  60 #define IOC_LOV_GETINFO                 _IOWR('f', 165, struct lov_user_mds_data *)
  61
  62 #define LL_IOC_LLOOP_ATTACH             _IOWR('f', 166, OBD_IOC_DATA_TYPE)
  63 #define LL_IOC_LLOOP_DETACH             _IOWR('f', 167, OBD_IOC_DATA_TYPE)
  64 #define LL_IOC_LLOOP_INFO               _IOWR('f', 168, OBD_IOC_DATA_TYPE)
  65 #define LL_IOC_LLOOP_DETACH_BYDEV       _IOWR('f', 169, OBD_IOC_DATA_TYPE)
  66
  67 #define LL_STATFS_MDC           1
  68 #define LL_STATFS_LOV           2
  69
  70 #define IOC_MDC_TYPE            'i'
  71 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
  72 #define IOC_MDC_GETFILESTRIPE   _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
  73 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
  74 #define LL_IOC_MDC_GETINFO      _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
  75
  76 /* Keep these for backward compartability. */
  77 #define LL_IOC_OBD_STATFS       IOC_OBD_STATFS
  78 #define IOC_MDC_GETSTRIPE       IOC_MDC_GETFILESTRIPE
  79
  80 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
  81 #define O_JOIN_FILE        0400000000  /* hopefully this does not conflict */
  82
  83 #define LL_FILE_IGNORE_LOCK             0x00000001
  84 #define LL_FILE_GROUP_LOCKED            0x00000002
  85 #define LL_FILE_READAHEAD               0x00000004
  86
  87 #define LOV_USER_MAGIC_V1 0x0BD10BD0
  88 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
  89
  90 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
  91
  92 #define LOV_PATTERN_RAID0 0x001
  93 #define LOV_PATTERN_RAID1 0x002
  94 #define LOV_PATTERN_FIRST 0x100
  95
  96 #define lov_user_ost_data lov_user_ost_data_v1
  97 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
  98         __u64 l_object_id;        /* OST object ID */
  99         __u64 l_object_gr;        /* OST object group (creating MDS number) */
 100         __u32 l_ost_gen;          /* generation of this OST index */
 101         __u32 l_ost_idx;          /* OST index in LOV */
 102 } __attribute__((packed));
 103
 104 #define lov_user_md lov_user_md_v1
 105 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
 106         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
 107         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
 108         __u64 lmm_object_id;      /* LOV object ID */
 109         __u64 lmm_object_gr;      /* LOV object group */
 110         __u32 lmm_stripe_size;    /* size of stripe in bytes */
 111         __u16 lmm_stripe_count;   /* num stripes in use for this object */
 112         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
 113         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
 114 } __attribute__((packed));
 115
 116 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
 117  * use this.  It is unsafe to #define those values in this header as it
 118  * is possible the application has already #included <sys/stat.h>. */
 119 #ifdef HAVE_LOV_USER_MDS_DATA
 120 #define lov_user_mds_data lov_user_mds_data_v1
 121 struct lov_user_mds_data_v1 {
 122         lstat_t lmd_st;                 /* MDS stat struct */
 123         struct lov_user_md_v1 lmd_lmm;  /* LOV EA user data */
 124 } __attribute__((packed));
 125 #endif
 126
 127 struct ll_recreate_obj {
 128         __u64 lrc_id;
 129         __u32 lrc_ost_idx;
 130 };
 131
 132 struct obd_uuid {
 133         char uuid[40];
 134 };
 135
 136 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
 137 {
 138         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
 139 }
 140
 141 static inline int obd_uuid_empty(struct obd_uuid *uuid)
 142 {
 143         return uuid->uuid[0] == '\0';
 144 }
 145
 146 static inline void obd_str2uuid(struct obd_uuid *uuid, char *tmp)
 147 {
 148         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
 149         uuid->uuid[sizeof(*uuid) - 1] = '\0';
 150 }
 151
 152 /* For printf's only, make sure uuid is terminated */
 153 static inline char *obd_uuid2str(struct obd_uuid *uuid)
 154 {
 155         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
 156                 /* Obviously not safe, but for printfs, no real harm done...
 157                    we're always null-terminated, even in a race. */
 158                 static char temp[sizeof(*uuid)];
 159                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
 160                 temp[sizeof(*uuid) - 1] = '\0';
 161                 return temp;
 162         }
 163         return (char *)(uuid->uuid);
 164 }
 165
 166 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
 167 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
 168 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
 169 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
 170 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
 171 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
 172 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
 173 /* lustre-specific control commands */
 174 #define LUSTRE_Q_INVALIDATE 0x80000b     /* invalidate quota data */
 175
 176 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
 177
 178 #define QFMT_LDISKFS 2  /* QFMT_VFS_V0(2), quota format for ldiskfs */
 179
 180 struct if_quotacheck {
 181         char                    obd_type[16];
 182         struct obd_uuid         obd_uuid;
 183 };
 184
 185 #define MDS_GRP_DOWNCALL_MAGIC 0x6d6dd620
 186
 187 struct mds_grp_downcall_data {
 188         __u32           mgd_magic;
 189         __u32           mgd_err;
 190         __u32           mgd_uid;
 191         __u32           mgd_gid;
 192         __u32           mgd_ngroups;
 193         __u32           mgd_groups[0];
 194 };
 195
 196 #ifdef NEED_QUOTA_DEFS
 197 #ifndef QUOTABLOCK_BITS
 198 #define QUOTABLOCK_BITS 10
 199 #endif
 200
 201 #ifndef QUOTABLOCK_SIZE
 202 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
 203 #endif
 204
 205 #ifndef toqb
 206 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
 207 #endif
 208
 209 #ifndef QIF_BLIMITS
 210 #define QIF_BLIMITS     1
 211 #define QIF_SPACE       2
 212 #define QIF_ILIMITS     4
 213 #define QIF_INODES      8
 214 #define QIF_BTIME       16
 215 #define QIF_ITIME       32
 216 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 217 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 218 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 219 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 220 #endif
 221
 222 #endif /* !__KERNEL__ */
 223
 224 typedef enum lustre_quota_version {
 225         LUSTRE_QUOTA_V1 = 0,
 226         LUSTRE_QUOTA_V2 = 1
 227 } lustre_quota_version_t;
 228
 229 /* XXX: same as if_dqinfo struct in kernel */
 230 struct obd_dqinfo {
 231         __u64 dqi_bgrace;
 232         __u64 dqi_igrace;
 233         __u32 dqi_flags;
 234         __u32 dqi_valid;
 235 };
 236
 237 /* XXX: same as if_dqblk struct in kernel, plus one padding */
 238 struct obd_dqblk {
 239         __u64 dqb_bhardlimit;
 240         __u64 dqb_bsoftlimit;
 241         __u64 dqb_curspace;
 242         __u64 dqb_ihardlimit;
 243         __u64 dqb_isoftlimit;
 244         __u64 dqb_curinodes;
 245         __u64 dqb_btime;
 246         __u64 dqb_itime;
 247         __u32 dqb_valid;
 248         __u32 padding;
 249 };
 250
 251 struct if_quotactl {
 252         __u32                   qc_cmd;
 253         __u32                   qc_type;
 254         __u32                   qc_id;
 255         __u32                   qc_stat;
 256         struct obd_dqinfo       qc_dqinfo;
 257         struct obd_dqblk        qc_dqblk;
 258         char                    obd_type[16];
 259         struct obd_uuid         obd_uuid;
 260 };
 261
 262 #ifndef offsetof
 263 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
 264 #endif
 265
 266 #endif /* _LUSTRE_USER_H */