Whamcloud - gitweb
12a0f0e0c3a68581b8eeaf9593de85c3c14ae4b6
[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  * 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 #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 /* Do not define O_CHECK_STALE as 0200000000,
123  * which is conflict with MDS_OPEN_OWNEROVERRIDE */
124 #define O_CHECK_STALE       020000000  /* hopefully this does not conflict */
125 #define O_LOV_DELAY_CREATE 0100000000  /* hopefully this does not conflict */
126 #define O_JOIN_FILE        0400000000  /* hopefully this does not conflict */
127
128 #define LL_FILE_IGNORE_LOCK             0x00000001
129 #define LL_FILE_GROUP_LOCKED            0x00000002
130 #define LL_FILE_READAHEAD               0x00000004
131 #define LL_FILE_RMTACL                  0x00000008
132
133 #define LOV_USER_MAGIC_V1 0x0BD10BD0
134 #define LOV_USER_MAGIC    LOV_USER_MAGIC_V1
135 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
136 #define LOV_USER_MAGIC_V3 0x0BD30BD0
137
138 #define LOV_PATTERN_RAID0 0x001
139 #define LOV_PATTERN_RAID1 0x002
140 #define LOV_PATTERN_FIRST 0x100
141
142 #define LOV_MAXPOOLNAME 16
143 #define LOV_POOLNAMEF "%.16s"
144
145 #define lov_user_ost_data lov_user_ost_data_v1
146 struct lov_user_ost_data_v1 {     /* per-stripe data structure */
147         __u64 l_object_id;        /* OST object ID */
148         __u64 l_object_gr;        /* OST object group (creating MDS number) */
149         __u32 l_ost_gen;          /* generation of this OST index */
150         __u32 l_ost_idx;          /* OST index in LOV */
151 } __attribute__((packed));
152
153 #define lov_user_md lov_user_md_v1
154 struct lov_user_md_v1 {           /* LOV EA user data (host-endian) */
155         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V1 */
156         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
157         __u64 lmm_object_id;      /* LOV object ID */
158         __u64 lmm_object_gr;      /* LOV object group */
159         __u32 lmm_stripe_size;    /* size of stripe in bytes */
160         __u16 lmm_stripe_count;   /* num stripes in use for this object */
161         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
162         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
163 } __attribute__((packed));
164
165 struct lov_user_md_v3 {           /* LOV EA user data (host-endian) */
166         __u32 lmm_magic;          /* magic number = LOV_USER_MAGIC_V3 */
167         __u32 lmm_pattern;        /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
168         __u64 lmm_object_id;      /* LOV object ID */
169         __u64 lmm_object_gr;      /* LOV object group */
170         __u32 lmm_stripe_size;    /* size of stripe in bytes */
171         __u16 lmm_stripe_count;   /* num stripes in use for this object */
172         __u16 lmm_stripe_offset;  /* starting stripe offset in lmm_objects */
173         char  lmm_pool_name[LOV_MAXPOOLNAME]; /* pool name */
174         struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
175 } __attribute__((packed));
176
177 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
178  * use this.  It is unsafe to #define those values in this header as it
179  * is possible the application has already #included <sys/stat.h>. */
180 #ifdef HAVE_LOV_USER_MDS_DATA
181 #define lov_user_mds_data lov_user_mds_data_v1
182 struct lov_user_mds_data_v1 {
183         lstat_t lmd_st;                 /* MDS stat struct */
184         struct lov_user_md_v1 lmd_lmm;  /* LOV EA V1 user data */
185 } __attribute__((packed));
186
187 struct lov_user_mds_data_v3 {
188         lstat_t lmd_st;                 /* MDS stat struct */
189         struct lov_user_md_v3 lmd_lmm;  /* LOV EA V3 user data */
190 } __attribute__((packed));
191 #endif
192
193 struct ll_recreate_obj {
194         __u64 lrc_id;
195         __u64 lrc_group;
196         __u32 lrc_ost_idx;
197 };
198
199 struct obd_uuid {
200         char uuid[40];
201 };
202
203 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
204 {
205         return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
206 }
207
208 static inline int obd_uuid_empty(struct obd_uuid *uuid)
209 {
210         return uuid->uuid[0] == '\0';
211 }
212
213 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
214 {
215         strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
216         uuid->uuid[sizeof(*uuid) - 1] = '\0';
217 }
218
219 /* For printf's only, make sure uuid is terminated */
220 static inline char *obd_uuid2str(struct obd_uuid *uuid) 
221 {
222         if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
223                 /* Obviously not safe, but for printfs, no real harm done...
224                    we're always null-terminated, even in a race. */
225                 static char temp[sizeof(*uuid)];
226                 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
227                 temp[sizeof(*uuid) - 1] = '\0';
228                 return temp;
229         }
230         return (char *)(uuid->uuid);
231 }
232
233 /* these must be explicitly translated into linux Q_* in ll_dir_ioctl */
234 #define LUSTRE_Q_QUOTAON    0x800002     /* turn quotas on */
235 #define LUSTRE_Q_QUOTAOFF   0x800003     /* turn quotas off */
236 #define LUSTRE_Q_GETINFO    0x800005     /* get information about quota files */
237 #define LUSTRE_Q_SETINFO    0x800006     /* set information about quota files */
238 #define LUSTRE_Q_GETQUOTA   0x800007     /* get user quota structure */
239 #define LUSTRE_Q_SETQUOTA   0x800008     /* set user quota structure */
240 /* lustre-specific control commands */
241 #define LUSTRE_Q_INVALIDATE  0x80000b     /* invalidate quota data */
242 #define LUSTRE_Q_FINVALIDATE 0x80000c     /* invalidate filter quota data */
243
244 #define UGQUOTA 2       /* set both USRQUOTA and GRPQUOTA */
245
246 struct if_quotacheck {
247         char                    obd_type[16];
248         struct obd_uuid         obd_uuid;
249 };
250
251 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd620
252
253 /* permission */
254 #define N_PERMS_MAX      64
255
256 struct perm_downcall_data {
257         __u64 pdd_nid;
258         __u32 pdd_perm;
259 };
260
261 struct identity_downcall_data {
262         __u32                            idd_magic;
263         __u32                            idd_err;
264         __u32                            idd_uid;
265         __u32                            idd_gid;
266         __u32                            idd_nperms;
267         struct perm_downcall_data idd_perms[N_PERMS_MAX];
268         __u32                            idd_ngroups;
269         __u32                            idd_groups[0];
270 };
271
272 /* for non-mapped uid/gid */
273 #define NOBODY_UID      99
274 #define NOBODY_GID      99
275
276 #define INVALID_ID      (-1)
277
278 enum {
279         RMT_LSETFACL    = 1,
280         RMT_LGETFACL    = 2,
281         RMT_RSETFACL    = 3,
282         RMT_RGETFACL    = 4
283 };
284
285 #ifdef NEED_QUOTA_DEFS
286 #ifndef QUOTABLOCK_BITS
287 #define QUOTABLOCK_BITS 10
288 #endif
289
290 #ifndef QUOTABLOCK_SIZE
291 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
292 #endif
293
294 #ifndef toqb
295 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
296 #endif
297
298 #ifndef QIF_BLIMITS
299 #define QIF_BLIMITS     1
300 #define QIF_SPACE       2
301 #define QIF_ILIMITS     4
302 #define QIF_INODES      8
303 #define QIF_BTIME       16
304 #define QIF_ITIME       32
305 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
306 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
307 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
308 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
309 #endif
310
311 #endif /* !__KERNEL__ */
312
313 typedef enum lustre_quota_version {
314         LUSTRE_QUOTA_V2 = 1
315 } lustre_quota_version_t;
316
317 /* XXX: same as if_dqinfo struct in kernel */
318 struct obd_dqinfo {
319         __u64 dqi_bgrace;
320         __u64 dqi_igrace;
321         __u32 dqi_flags;
322         __u32 dqi_valid;
323 };
324
325 /* XXX: same as if_dqblk struct in kernel, plus one padding */
326 struct obd_dqblk {
327         __u64 dqb_bhardlimit;
328         __u64 dqb_bsoftlimit;
329         __u64 dqb_curspace;
330         __u64 dqb_ihardlimit;
331         __u64 dqb_isoftlimit;
332         __u64 dqb_curinodes;
333         __u64 dqb_btime;
334         __u64 dqb_itime;
335         __u32 dqb_valid;
336         __u32 padding;
337 };
338
339 enum {
340         QC_GENERAL      = 0,
341         QC_MDTIDX       = 1,
342         QC_OSTIDX       = 2,
343         QC_UUID         = 3
344 };
345
346 struct if_quotactl {
347         __u32                   qc_cmd;
348         __u32                   qc_type;
349         __u32                   qc_id;
350         __u32                   qc_stat;
351         __u32                   qc_valid;
352         __u32                   qc_idx;
353         struct obd_dqinfo       qc_dqinfo;
354         struct obd_dqblk        qc_dqblk;
355         char                    obd_type[16];
356         struct obd_uuid         obd_uuid;
357 };
358
359 #ifndef offsetof
360 # define offsetof(typ,memb)     ((unsigned long)((char *)&(((typ *)0)->memb)))
361 #endif
362
363 #endif /* _LUSTRE_USER_H */