1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/include/lustre/lustre_user.h
38 * Lustre public user-space interface definitions.
41 #ifndef _LUSTRE_USER_H
42 #define _LUSTRE_USER_H
44 #if defined(__linux__)
45 #include <linux/lustre_user.h>
46 #elif defined(__APPLE__)
47 #include <darwin/lustre_user.h>
48 #elif defined(__WINNT__)
49 #include <winnt/lustre_user.h>
51 #error Unsupported operating system.
55 #define LL_SUPER_MAGIC 0x0BD00BD0
57 #ifndef EXT3_IOC_GETFLAGS
58 #define EXT3_IOC_GETFLAGS _IOR('f', 1, long)
59 #define EXT3_IOC_SETFLAGS _IOW('f', 2, long)
60 #define EXT3_IOC_GETVERSION _IOR('f', 3, long)
61 #define EXT3_IOC_SETVERSION _IOW('f', 4, long)
62 #define EXT3_IOC_GETVERSION_OLD _IOR('v', 1, long)
63 #define EXT3_IOC_SETVERSION_OLD _IOW('v', 2, long)
69 * The ioctl naming rules:
70 * LL_* - works on the currently opened filehandle instead of parent dir
71 * *_OBD_* - gets data for both OSC or MDC (LOV, LMV indirectly)
72 * *_MDC_* - gets/sets data related to MDC
73 * *_LOV_* - gets/sets data related to OSC/LOV
74 * *FILE* - called on parent dir and passes in a filename
75 * *STRIPE* - set/get lov_user_md
76 * *INFO - set/get lov_user_mds_data
78 #define LL_IOC_GETFLAGS _IOR ('f', 151, long)
79 #define LL_IOC_SETFLAGS _IOW ('f', 152, long)
80 #define LL_IOC_CLRFLAGS _IOW ('f', 153, long)
81 #define LL_IOC_LOV_SETSTRIPE _IOW ('f', 154, long)
82 #define LL_IOC_LOV_GETSTRIPE _IOW ('f', 155, long)
83 #define LL_IOC_LOV_SETEA _IOW ('f', 156, long)
84 #define LL_IOC_RECREATE_OBJ _IOW ('f', 157, long)
85 #define LL_IOC_GROUP_LOCK _IOW ('f', 158, long)
86 #define LL_IOC_GROUP_UNLOCK _IOW ('f', 159, long)
87 #define LL_IOC_QUOTACHECK _IOW ('f', 160, int)
88 #define LL_IOC_POLL_QUOTACHECK _IOR ('f', 161, struct if_quotacheck *)
89 #define LL_IOC_QUOTACTL _IOWR('f', 162, struct if_quotactl *)
90 #define LL_IOC_JOIN _IOW ('f', 163, long)
91 #define IOC_OBD_STATFS _IOWR('f', 164, struct obd_statfs *)
92 #define IOC_LOV_GETINFO _IOWR('f', 165, struct lov_user_mds_data *)
93 #define LL_IOC_FLUSHCTX _IOW ('f', 166, long)
94 #define LL_IOC_RMTACL _IOW ('f', 167, long)
96 #define LL_IOC_LLOOP_ATTACH _IOWR('f', 169, long)
97 #define LL_IOC_LLOOP_DETACH _IOWR('f', 170, long)
98 #define LL_IOC_LLOOP_INFO _IOWR('f', 171, long)
99 #define LL_IOC_LLOOP_DETACH_BYDEV _IOWR('f', 172, long)
101 #define LL_STATFS_MDC 1
102 #define LL_STATFS_LOV 2
104 #define IOC_MDC_TYPE 'i'
105 #define IOC_MDC_LOOKUP _IOWR(IOC_MDC_TYPE, 20, struct obd_device *)
106 #define IOC_MDC_GETFILESTRIPE _IOWR(IOC_MDC_TYPE, 21, struct lov_user_md *)
107 #define IOC_MDC_GETFILEINFO _IOWR(IOC_MDC_TYPE, 22, struct lov_user_mds_data *)
108 #define LL_IOC_MDC_GETINFO _IOWR(IOC_MDC_TYPE, 23, struct lov_user_mds_data *)
110 /* Keep these for backward compartability. */
111 #define LL_IOC_OBD_STATFS IOC_OBD_STATFS
112 #define IOC_MDC_GETSTRIPE IOC_MDC_GETFILESTRIPE
114 /* Do not define O_CHECK_STALE as 0200000000,
115 * which is conflict with MDS_OPEN_OWNEROVERRIDE */
116 #define O_CHECK_STALE 020000000 /* hopefully this does not conflict */
117 #define O_LOV_DELAY_CREATE 0100000000 /* hopefully this does not conflict */
118 #define O_JOIN_FILE 0400000000 /* hopefully this does not conflict */
120 #define LL_FILE_IGNORE_LOCK 0x00000001
121 #define LL_FILE_GROUP_LOCKED 0x00000002
122 #define LL_FILE_READAHEAD 0x00000004
123 #define LL_FILE_RMTACL 0x00000008
125 #define LOV_USER_MAGIC_V1 0x0BD10BD0
126 #define LOV_USER_MAGIC LOV_USER_MAGIC_V1
128 #define LOV_USER_MAGIC_JOIN 0x0BD20BD0
130 #define LOV_PATTERN_RAID0 0x001
131 #define LOV_PATTERN_RAID1 0x002
132 #define LOV_PATTERN_FIRST 0x100
134 #define lov_user_ost_data lov_user_ost_data_v1
135 struct lov_user_ost_data_v1 { /* per-stripe data structure */
136 __u64 l_object_id; /* OST object ID */
137 __u64 l_object_gr; /* OST object group (creating MDS number) */
138 __u32 l_ost_gen; /* generation of this OST index */
139 __u32 l_ost_idx; /* OST index in LOV */
140 } __attribute__((packed));
142 #define lov_user_md lov_user_md_v1
143 struct lov_user_md_v1 { /* LOV EA user data (host-endian) */
144 __u32 lmm_magic; /* magic number = LOV_USER_MAGIC_V1 */
145 __u32 lmm_pattern; /* LOV_PATTERN_RAID0, LOV_PATTERN_RAID1 */
146 __u64 lmm_object_id; /* LOV object ID */
147 __u64 lmm_object_gr; /* LOV object group */
148 __u32 lmm_stripe_size; /* size of stripe in bytes */
149 __u16 lmm_stripe_count; /* num stripes in use for this object */
150 __u16 lmm_stripe_offset; /* starting stripe offset in lmm_objects */
151 struct lov_user_ost_data_v1 lmm_objects[0]; /* per-stripe data */
152 } __attribute__((packed));
154 /* Compile with -D_LARGEFILE64_SOURCE or -D_GNU_SOURCE (or #define) to
155 * use this. It is unsafe to #define those values in this header as it
156 * is possible the application has already #included <sys/stat.h>. */
157 #ifdef HAVE_LOV_USER_MDS_DATA
158 #define lov_user_mds_data lov_user_mds_data_v1
159 struct lov_user_mds_data_v1 {
160 lstat_t lmd_st; /* MDS stat struct */
161 struct lov_user_md_v1 lmd_lmm; /* LOV EA user data */
162 } __attribute__((packed));
165 struct ll_recreate_obj {
175 static inline int obd_uuid_equals(struct obd_uuid *u1, struct obd_uuid *u2)
177 return strcmp((char *)u1->uuid, (char *)u2->uuid) == 0;
180 static inline int obd_uuid_empty(struct obd_uuid *uuid)
182 return uuid->uuid[0] == '\0';
185 static inline void obd_str2uuid(struct obd_uuid *uuid, const char *tmp)
187 strncpy((char *)uuid->uuid, tmp, sizeof(*uuid));
188 uuid->uuid[sizeof(*uuid) - 1] = '\0';
191 /* For printf's only, make sure uuid is terminated */
192 static inline char *obd_uuid2str(struct obd_uuid *uuid)
194 if (uuid->uuid[sizeof(*uuid) - 1] != '\0') {
195 /* Obviously not safe, but for printfs, no real harm done...
196 we're always null-terminated, even in a race. */
197 static char temp[sizeof(*uuid)];
198 memcpy(temp, uuid->uuid, sizeof(*uuid) - 1);
199 temp[sizeof(*uuid) - 1] = '\0';
202 return (char *)(uuid->uuid);
205 #define LUSTRE_Q_QUOTAON 0x800002 /* turn quotas on */
206 #define LUSTRE_Q_QUOTAOFF 0x800003 /* turn quotas off */
207 #define LUSTRE_Q_GETINFO 0x800005 /* get information about quota files */
208 #define LUSTRE_Q_SETINFO 0x800006 /* set information about quota files */
209 #define LUSTRE_Q_GETQUOTA 0x800007 /* get user quota structure */
210 #define LUSTRE_Q_SETQUOTA 0x800008 /* set user quota structure */
212 #define UGQUOTA 2 /* set both USRQUOTA and GRPQUOTA */
214 #define QFMT_LDISKFS 2 /* QFMT_VFS_V0(2), quota format for ldiskfs */
216 struct if_quotacheck {
218 struct obd_uuid obd_uuid;
221 #define IDENTITY_DOWNCALL_MAGIC 0x6d6dd620
224 #define N_PERMS_MAX 64
226 struct perm_downcall_data {
231 struct identity_downcall_data {
237 struct perm_downcall_data idd_perms[N_PERMS_MAX];
242 /* for non-mapped uid/gid */
243 #define NOBODY_UID 99
244 #define NOBODY_GID 99
246 #define INVALID_ID (-1)
255 #ifdef NEED_QUOTA_DEFS
256 #ifndef QUOTABLOCK_BITS
257 #define QUOTABLOCK_BITS 10
260 #ifndef QUOTABLOCK_SIZE
261 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
265 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
269 #define QIF_BLIMITS 1
271 #define QIF_ILIMITS 4
275 #define QIF_LIMITS (QIF_BLIMITS | QIF_ILIMITS)
276 #define QIF_USAGE (QIF_SPACE | QIF_INODES)
277 #define QIF_TIMES (QIF_BTIME | QIF_ITIME)
278 #define QIF_ALL (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
281 #endif /* !__KERNEL__ */
283 /* XXX: same as if_dqinfo struct in kernel */
291 /* XXX: same as if_dqblk struct in kernel, plus one padding */
293 __u64 dqb_bhardlimit;
294 __u64 dqb_bsoftlimit;
296 __u64 dqb_ihardlimit;
297 __u64 dqb_isoftlimit;
310 struct obd_dqinfo qc_dqinfo;
311 struct obd_dqblk qc_dqblk;
313 struct obd_uuid obd_uuid;
317 # define offsetof(typ,memb) ((unsigned long)((char *)&(((typ *)0)->memb)))
320 #endif /* _LUSTRE_USER_H */