Whamcloud - gitweb
4afa860137a04ae077f0a92f3c17dd92535c7d40
[fs/lustre-release.git] / 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 #define LL_IOC_GETFLAGS                 _IOR ('f', 151, long)
37 #define LL_IOC_SETFLAGS                 _IOW ('f', 152, long)
38 #define LL_IOC_CLRFLAGS                 _IOW ('f', 153, long)
39 #define LL_IOC_LOV_SETSTRIPE            _IOW ('f', 154, long)
40 #define LL_IOC_LOV_GETSTRIPE            _IOW ('f', 155, long)
41 #define LL_IOC_LOV_SETEA                _IOW ('f', 156, long)
42 #define LL_IOC_RECREATE_OBJ             _IOW ('f', 157, long)
43 #define LL_IOC_GROUP_LOCK               _IOW ('f', 158, long)
44 #define LL_IOC_GROUP_UNLOCK             _IOW ('f', 159, long)
45 #define LL_IOC_QUOTACHECK               _IOW ('f', 160, int)
46 #define LL_IOC_POLL_QUOTACHECK          _IOR ('f', 161, struct if_quotacheck *)
47 #define LL_IOC_QUOTACTL                 _IOWR('f', 162, struct if_quotactl *)
48 #define LL_IOC_JOIN                     _IOW ('f', 163, long)
49 #define LL_IOC_OBD_STATFS               _IOWR('f', 164, struct obd_statfs *)
50
51 #define LL_STATFS_MDC           1
52 #define LL_STATFS_LOV           2
53
54 #define IOC_MDC_TYPE            'i'
55 #define IOC_MDC_LOOKUP          _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
56 #define IOC_MDC_GETSTRIPE       _IOWR(IOC_MDC_TYPE, 21, struct lov_mds_md *)
57 #define IOC_MDC_GETFILEINFO     _IOWR(IOC_MDC_TYPE, 22, struct lov_mds_data *)
58
59 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
60 #define O_JOIN_FILE        0400000000  /* hopefully this does not conflict */
61
62 #define LL_FILE_IGNORE_LOCK             0x00000001
63 #define LL_FILE_GROUP_LOCKED            0x00000002
64 #define LL_FILE_READAHEAD               0x00000004
65
66 #define LOV_USER_MAGIC_V1 0x0BD10BD0
67 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
68
69 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
70
71 #define LOV_PATTERN_RAID0 0x001
72 #define LOV_PATTERN_RAID1 0x002
73 #define LOV_PATTERN_FIRST 0x100
74
75 #define lov_user_ost_data lov_user_ost_data_v1
76 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
77         __u64 l_object_id;        /* OST object ID */
78         __u64 l_object_gr;        /* OST object group (creating MDS number) */
79         __u32 l_ost_gen;          /* generation of this OST index */
80         __u32 l_ost_idx;          /* OST index in LOV */
81 } __attribute__((packed));
82
83 #define lov_user_md lov_user_md_v1
84 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
85         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
86         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
87         __u64 lmm_object_id;      /* LOV object ID */
88         __u64 lmm_object_gr;      /* LOV object group */
89         __u32 lmm_stripe_size;    /* size of stripe in bytes */
90         __u16 lmm_stripe_count;   /* num stripes in use for this object */
91         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
92         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
93 } __attribute__((packed));
94
95 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
96  * use this.  It is unsafe to #define those values in this header as it
97  * is possible the application has already #included <sys/stat.h>. */
98 #ifdef HAVE_LOV_USER_MDS_DATA
99 #define lov_user_mds_data lov_user_mds_data_v1
100 struct lov_user_mds_data_v1 {
101         lstat_t lmd_st;                 /* MDS stat struct */
102         struct lov_user_md_v1 lmd_lmm;  /* LOV EA user data */
103 } __attribute__((packed));
104 #endif
105
106 struct ll_recreate_obj {
107         __u64 lrc_id;
108         __u32 lrc_ost_idx;
109 };
110
111 struct obd_uuid {
112         __u8 uuid[40];
113 };
114
115 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
116 {
117         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
118 }
119
120 static inline int obd_uuid_empty(struct obd_uuid *uuid)
121 {
122         return uuid->uuid[0] == '\0';
123 }
124
125 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
126 {
127         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
128         uuid->uuid[sizeof(*uuid) - 1] = '\0';
129 }
130
131 /* For printf's only, make sure uuid is terminated */
132 static inline char *obd_uuid2str(struct obd_uuid *uuid) 
133 {
134         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
135                 /* Obviously not safe, but for printfs, no real harm done...*/
136                 static char temp[sizeof(*uuid)];
137                 memcpy(temp, uuid->uuid, sizeof(*uuid));
138                 temp[sizeof(*uuid) - 1] = '\0';
139                 return temp;
140         }
141         return (char *)(uuid->uuid);
142 }
143
144 #define LUSTRE_Q_QUOTAON  0x800002     /* turn quotas on */
145 #define LUSTRE_Q_QUOTAOFF 0x800003     /* turn quotas off */
146 #define LUSTRE_Q_GETINFO  0x800005     /* get information about quota files */
147 #define LUSTRE_Q_SETINFO  0x800006     /* set information about quota files */
148 #define LUSTRE_Q_GETQUOTA 0x800007     /* get user quota structure */
149 #define LUSTRE_Q_SETQUOTA 0x800008     /* set user quota structure */
150
151 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
152
153 #define QFMT_LDISKFS 2  /* QFMT_VFS_V0(2), quota format for ldiskfs */
154
155 struct if_quotacheck {
156         __u8                    obd_type[16];
157         struct obd_uuid         obd_uuid;
158 };
159
160 #define MDS_GRP_DOWNCALL_MAGIC 0x6d6dd620
161
162 struct mds_grp_downcall_data {
163         __u32           mgd_magic;
164         __u32           mgd_err;
165         __u32           mgd_uid;
166         __u32           mgd_gid;
167         __u32           mgd_ngroups;
168         __u32           mgd_groups[0];
169 };
170
171 #ifdef NEED_QUOTA_DEFS
172 #ifndef QUOTABLOCK_BITS
173 #define QUOTABLOCK_BITS 10
174 #endif
175
176 #ifndef QUOTABLOCK_SIZE
177 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
178 #endif
179
180 #ifndef toqb
181 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
182 #endif
183
184 #ifndef QIF_BLIMITS
185 #define QIF_BLIMITS     1
186 #define QIF_SPACE       2
187 #define QIF_ILIMITS     4
188 #define QIF_INODES      8
189 #define QIF_BTIME       16
190 #define QIF_ITIME       32
191 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
192 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
193 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
194 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
195 #endif
196
197 #endif /* !__KERNEL__ */
198
199 /* XXX: same as if_dqinfo struct in kernel */
200 struct obd_dqinfo {
201         __u64 dqi_bgrace;
202         __u64 dqi_igrace;
203         __u32 dqi_flags;
204         __u32 dqi_valid;
205 };
206
207 /* XXX: same as if_dqblk struct in kernel, plus one padding */
208 struct obd_dqblk {
209         __u64 dqb_bhardlimit;
210         __u64 dqb_bsoftlimit;
211         __u64 dqb_curspace;
212         __u64 dqb_ihardlimit;
213         __u64 dqb_isoftlimit;
214         __u64 dqb_curinodes;
215         __u64 dqb_btime;
216         __u64 dqb_itime;
217         __u32 dqb_valid;
218         __u32 padding;
219 };
220
221 struct if_quotactl {
222         __u32                   qc_cmd;
223         __u32                   qc_type;
224         __u32                   qc_id;
225         __u32                   qc_stat;
226         struct obd_dqinfo       qc_dqinfo;
227         struct obd_dqblk        qc_dqblk;
228         __u8                    obd_type[16];
229         struct obd_uuid         obd_uuid;
230 };
231
232 #ifndef offsetof
233 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
234 #endif
235
236 #endif /* _LUSTRE_USER_H */