1 #include <linux/types.h>
2 #include <linux/spinlock_types.h>
3 #include <linux/slab.h>
4 #include <linux/ioctl.h>
6 extern struct client_debug_mask
*cdm_array
;
7 extern char *debug_help_string
;
8 extern int help_string_initialized
;
9 extern struct dentry
*debug_dir
;
10 extern struct dentry
*help_file_dentry
;
11 extern struct dentry
*client_debug_dentry
;
12 extern const struct file_operations debug_help_fops
;
13 extern int client_all_index
;
14 extern int client_verbose_index
;
15 extern int cdm_element_count
;
16 #define DEBUG_HELP_STRING_SIZE 4096
17 #define HELP_STRING_UNINITIALIZED \
18 "Client Debug Keywords are unknown until the first time\n" \
19 "the client is started after boot.\n"
20 #define ORANGEFS_KMOD_DEBUG_HELP_FILE "debug-help"
21 #define ORANGEFS_KMOD_DEBUG_FILE "kernel-debug"
22 #define ORANGEFS_CLIENT_DEBUG_FILE "client-debug"
23 #define ORANGEFS_VERBOSE "verbose"
24 #define ORANGEFS_ALL "all"
26 /* pvfs2-config.h ***********************************************************/
27 #define ORANGEFS_VERSION_MAJOR 2
28 #define ORANGEFS_VERSION_MINOR 9
29 #define ORANGEFS_VERSION_SUB 0
31 /* khandle stuff ***********************************************************/
34 * The 2.9 core will put 64 bit handles in here like this:
36 * The 3.0 and beyond cores will put 128 bit handles in here like this:
38 * The kernel module will always use the first four bytes and
39 * the last four bytes as an inum.
41 struct orangefs_khandle
{
46 * kernel version of an object ref.
48 struct orangefs_object_kref
{
49 struct orangefs_khandle khandle
;
55 * compare 2 khandles assumes little endian thus from large address to
58 static inline int ORANGEFS_khandle_cmp(const struct orangefs_khandle
*kh1
,
59 const struct orangefs_khandle
*kh2
)
63 for (i
= 15; i
>= 0; i
--) {
64 if (kh1
->u
[i
] > kh2
->u
[i
])
66 if (kh1
->u
[i
] < kh2
->u
[i
])
73 static inline void ORANGEFS_khandle_to(const struct orangefs_khandle
*kh
,
82 static inline void ORANGEFS_khandle_from(struct orangefs_khandle
*kh
,
90 /* pvfs2-types.h ************************************************************/
91 typedef __u32 ORANGEFS_uid
;
92 typedef __u32 ORANGEFS_gid
;
93 typedef __s32 ORANGEFS_fs_id
;
94 typedef __u32 ORANGEFS_permissions
;
95 typedef __u64 ORANGEFS_time
;
96 typedef __s64 ORANGEFS_size
;
97 typedef __u64 ORANGEFS_flags
;
98 typedef __u64 ORANGEFS_ds_position
;
99 typedef __s32 ORANGEFS_error
;
100 typedef __s64 ORANGEFS_offset
;
102 #define ORANGEFS_SUPER_MAGIC 0x20030528
105 * ORANGEFS error codes are a signed 32-bit integer. Error codes are negative, but
106 * the sign is stripped before decoding.
109 /* Bit 31 is not used since it is the sign. */
112 * Bit 30 specifies that this is a ORANGEFS error. A ORANGEFS error is either an
113 * encoded errno value or a ORANGEFS protocol error.
115 #define ORANGEFS_ERROR_BIT (1 << 30)
118 * Bit 29 specifies that this is a ORANGEFS protocol error and not an encoded
121 #define ORANGEFS_NON_ERRNO_ERROR_BIT (1 << 29)
124 * Bits 9, 8, and 7 specify the error class, which encodes the section of
125 * server code the error originated in for logging purposes. It is not used
126 * in the kernel except to be masked out.
128 #define ORANGEFS_ERROR_CLASS_BITS 0x380
130 /* Bits 6 - 0 are reserved for the actual error code. */
131 #define ORANGEFS_ERROR_NUMBER_BITS 0x7f
133 /* Encoded errno values are decoded by PINT_errno_mapping in pvfs2-utils.c. */
135 /* Our own ORANGEFS protocol error codes. */
136 #define ORANGEFS_ECANCEL (1|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
137 #define ORANGEFS_EDEVINIT (2|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
138 #define ORANGEFS_EDETAIL (3|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
139 #define ORANGEFS_EHOSTNTFD (4|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
140 #define ORANGEFS_EADDRNTFD (5|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
141 #define ORANGEFS_ENORECVR (6|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
142 #define ORANGEFS_ETRYAGAIN (7|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
143 #define ORANGEFS_ENOTPVFS (8|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
144 #define ORANGEFS_ESECURITY (9|ORANGEFS_NON_ERRNO_ERROR_BIT|ORANGEFS_ERROR_BIT)
146 /* permission bits */
147 #define ORANGEFS_O_EXECUTE (1 << 0)
148 #define ORANGEFS_O_WRITE (1 << 1)
149 #define ORANGEFS_O_READ (1 << 2)
150 #define ORANGEFS_G_EXECUTE (1 << 3)
151 #define ORANGEFS_G_WRITE (1 << 4)
152 #define ORANGEFS_G_READ (1 << 5)
153 #define ORANGEFS_U_EXECUTE (1 << 6)
154 #define ORANGEFS_U_WRITE (1 << 7)
155 #define ORANGEFS_U_READ (1 << 8)
156 /* no ORANGEFS_U_VTX (sticky bit) */
157 #define ORANGEFS_G_SGID (1 << 10)
158 #define ORANGEFS_U_SUID (1 << 11)
160 /* definition taken from stdint.h */
161 #define INT32_MAX (2147483647)
162 #define ORANGEFS_ITERATE_START (INT32_MAX - 1)
163 #define ORANGEFS_ITERATE_END (INT32_MAX - 2)
164 #define ORANGEFS_ITERATE_NEXT (INT32_MAX - 3)
165 #define ORANGEFS_READDIR_START ORANGEFS_ITERATE_START
166 #define ORANGEFS_READDIR_END ORANGEFS_ITERATE_END
167 #define ORANGEFS_IMMUTABLE_FL FS_IMMUTABLE_FL
168 #define ORANGEFS_APPEND_FL FS_APPEND_FL
169 #define ORANGEFS_NOATIME_FL FS_NOATIME_FL
170 #define ORANGEFS_MIRROR_FL 0x01000000ULL
171 #define ORANGEFS_O_EXECUTE (1 << 0)
172 #define ORANGEFS_FS_ID_NULL ((__s32)0)
173 #define ORANGEFS_ATTR_SYS_UID (1 << 0)
174 #define ORANGEFS_ATTR_SYS_GID (1 << 1)
175 #define ORANGEFS_ATTR_SYS_PERM (1 << 2)
176 #define ORANGEFS_ATTR_SYS_ATIME (1 << 3)
177 #define ORANGEFS_ATTR_SYS_CTIME (1 << 4)
178 #define ORANGEFS_ATTR_SYS_MTIME (1 << 5)
179 #define ORANGEFS_ATTR_SYS_TYPE (1 << 6)
180 #define ORANGEFS_ATTR_SYS_ATIME_SET (1 << 7)
181 #define ORANGEFS_ATTR_SYS_MTIME_SET (1 << 8)
182 #define ORANGEFS_ATTR_SYS_SIZE (1 << 20)
183 #define ORANGEFS_ATTR_SYS_LNK_TARGET (1 << 24)
184 #define ORANGEFS_ATTR_SYS_DFILE_COUNT (1 << 25)
185 #define ORANGEFS_ATTR_SYS_DIRENT_COUNT (1 << 26)
186 #define ORANGEFS_ATTR_SYS_BLKSIZE (1 << 28)
187 #define ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT (1 << 29)
188 #define ORANGEFS_ATTR_SYS_COMMON_ALL \
189 (ORANGEFS_ATTR_SYS_UID | \
190 ORANGEFS_ATTR_SYS_GID | \
191 ORANGEFS_ATTR_SYS_PERM | \
192 ORANGEFS_ATTR_SYS_ATIME | \
193 ORANGEFS_ATTR_SYS_CTIME | \
194 ORANGEFS_ATTR_SYS_MTIME | \
195 ORANGEFS_ATTR_SYS_TYPE)
197 #define ORANGEFS_ATTR_SYS_ALL_SETABLE \
198 (ORANGEFS_ATTR_SYS_COMMON_ALL-ORANGEFS_ATTR_SYS_TYPE)
200 #define ORANGEFS_ATTR_SYS_ALL_NOHINT \
201 (ORANGEFS_ATTR_SYS_COMMON_ALL | \
202 ORANGEFS_ATTR_SYS_SIZE | \
203 ORANGEFS_ATTR_SYS_LNK_TARGET | \
204 ORANGEFS_ATTR_SYS_DFILE_COUNT | \
205 ORANGEFS_ATTR_SYS_MIRROR_COPIES_COUNT | \
206 ORANGEFS_ATTR_SYS_DIRENT_COUNT | \
207 ORANGEFS_ATTR_SYS_BLKSIZE)
208 #define ORANGEFS_XATTR_REPLACE 0x2
209 #define ORANGEFS_XATTR_CREATE 0x1
210 #define ORANGEFS_MAX_SERVER_ADDR_LEN 256
211 #define ORANGEFS_NAME_MAX 256
213 * max extended attribute name len as imposed by the VFS and exploited for the
214 * upcall request types.
215 * NOTE: Please retain them as multiples of 8 even if you wish to change them
216 * This is *NECESSARY* for supporting 32 bit user-space binaries on a 64-bit
217 * kernel. Due to implementation within DBPF, this really needs to be
218 * ORANGEFS_NAME_MAX, which it was the same value as, but no reason to let it
219 * break if that changes in the future.
221 #define ORANGEFS_MAX_XATTR_NAMELEN ORANGEFS_NAME_MAX /* Not the same as
222 * XATTR_NAME_MAX defined
225 #define ORANGEFS_MAX_XATTR_VALUELEN 8192 /* Not the same as XATTR_SIZE_MAX
226 * defined by <linux/xattr.h>
228 #define ORANGEFS_MAX_XATTR_LISTLEN 16 /* Not the same as XATTR_LIST_MAX
229 * defined by <linux/xattr.h>
232 * ORANGEFS I/O operation types, used in both system and server interfaces.
234 enum ORANGEFS_io_type
{
235 ORANGEFS_IO_READ
= 1,
236 ORANGEFS_IO_WRITE
= 2
240 * If this enum is modified the server parameters related to the precreate pool
241 * batch and low threshold sizes may need to be modified to reflect this
244 enum orangefs_ds_type
{
245 ORANGEFS_TYPE_NONE
= 0,
246 ORANGEFS_TYPE_METAFILE
= (1 << 0),
247 ORANGEFS_TYPE_DATAFILE
= (1 << 1),
248 ORANGEFS_TYPE_DIRECTORY
= (1 << 2),
249 ORANGEFS_TYPE_SYMLINK
= (1 << 3),
250 ORANGEFS_TYPE_DIRDATA
= (1 << 4),
251 ORANGEFS_TYPE_INTERNAL
= (1 << 5) /* for the server's private use */
255 * ORANGEFS_certificate simply stores a buffer with the buffer size.
256 * The buffer can be converted to an OpenSSL X509 struct for use.
258 struct ORANGEFS_certificate
{
264 * A credential identifies a user and is signed by the client/user
267 struct ORANGEFS_credential
{
268 __u32 userid
; /* user id */
269 __u32 num_groups
; /* length of group_array */
270 __u32
*group_array
; /* groups for which the user is a member */
271 char *issuer
; /* alias of the issuing server */
272 __u64 timeout
; /* seconds after epoch to time out */
273 __u32 sig_size
; /* length of the signature in bytes */
274 unsigned char *signature
; /* digital signature */
275 struct ORANGEFS_certificate certificate
; /* user certificate buffer */
277 #define extra_size_ORANGEFS_credential (ORANGEFS_REQ_LIMIT_GROUPS * \
279 ORANGEFS_REQ_LIMIT_ISSUER + \
280 ORANGEFS_REQ_LIMIT_SIGNATURE + \
281 extra_size_ORANGEFS_certificate)
283 /* This structure is used by the VFS-client interaction alone */
284 struct ORANGEFS_keyval_pair
{
285 char key
[ORANGEFS_MAX_XATTR_NAMELEN
];
286 __s32 key_sz
; /* __s32 for portable, fixed-size structures */
288 char val
[ORANGEFS_MAX_XATTR_VALUELEN
];
291 /* pvfs2-sysint.h ***********************************************************/
292 /* Describes attributes for a file, directory, or symlink. */
293 struct ORANGEFS_sys_attr_s
{
302 /* NOTE: caller must free if valid */
305 /* Changed to __s32 so that size of structure does not change */
308 /* Changed to __s32 so that size of structure does not change */
309 __s32 distr_dir_servers_initial
;
311 /* Changed to __s32 so that size of structure does not change */
312 __s32 distr_dir_servers_max
;
314 /* Changed to __s32 so that size of structure does not change */
315 __s32 distr_dir_split_size
;
317 __u32 mirror_copies_count
;
319 /* NOTE: caller must free if valid */
322 /* NOTE: caller must free if valid */
326 enum orangefs_ds_type objtype
;
332 #define ORANGEFS_LOOKUP_LINK_NO_FOLLOW 0
333 #define ORANGEFS_LOOKUP_LINK_FOLLOW 1
335 /* pint-dev.h ***************************************************************/
337 /* parameter structure used in ORANGEFS_DEV_DEBUG ioctl command */
338 struct dev_mask_info_s
{
346 struct dev_mask2_info_s
{
351 /* pvfs2-util.h *************************************************************/
352 __s32
ORANGEFS_util_translate_mode(int mode
);
354 /* pvfs2-debug.h ************************************************************/
355 #include "pvfs2-debug.h"
357 /* pvfs2-internal.h *********************************************************/
358 #define llu(x) (unsigned long long)(x)
359 #define lld(x) (long long)(x)
361 /* pint-dev-shared.h ********************************************************/
362 #define ORANGEFS_DEV_MAGIC 'k'
364 #define ORANGEFS_READDIR_DEFAULT_DESC_COUNT 5
366 #define DEV_GET_MAGIC 0x1
367 #define DEV_GET_MAX_UPSIZE 0x2
368 #define DEV_GET_MAX_DOWNSIZE 0x3
370 #define DEV_REMOUNT_ALL 0x5
371 #define DEV_DEBUG 0x6
372 #define DEV_UPSTREAM 0x7
373 #define DEV_CLIENT_MASK 0x8
374 #define DEV_CLIENT_STRING 0x9
375 #define DEV_MAX_NR 0xa
377 /* supported ioctls, codes are with respect to user-space */
379 ORANGEFS_DEV_GET_MAGIC
= _IOW(ORANGEFS_DEV_MAGIC
, DEV_GET_MAGIC
, __s32
),
380 ORANGEFS_DEV_GET_MAX_UPSIZE
=
381 _IOW(ORANGEFS_DEV_MAGIC
, DEV_GET_MAX_UPSIZE
, __s32
),
382 ORANGEFS_DEV_GET_MAX_DOWNSIZE
=
383 _IOW(ORANGEFS_DEV_MAGIC
, DEV_GET_MAX_DOWNSIZE
, __s32
),
384 ORANGEFS_DEV_MAP
= _IO(ORANGEFS_DEV_MAGIC
, DEV_MAP
),
385 ORANGEFS_DEV_REMOUNT_ALL
= _IO(ORANGEFS_DEV_MAGIC
, DEV_REMOUNT_ALL
),
386 ORANGEFS_DEV_DEBUG
= _IOR(ORANGEFS_DEV_MAGIC
, DEV_DEBUG
, __s32
),
387 ORANGEFS_DEV_UPSTREAM
= _IOW(ORANGEFS_DEV_MAGIC
, DEV_UPSTREAM
, int),
388 ORANGEFS_DEV_CLIENT_MASK
= _IOW(ORANGEFS_DEV_MAGIC
,
390 struct dev_mask2_info_s
),
391 ORANGEFS_DEV_CLIENT_STRING
= _IOW(ORANGEFS_DEV_MAGIC
,
394 ORANGEFS_DEV_MAXNR
= DEV_MAX_NR
,
398 * version number for use in communicating between kernel space and user
399 * space. Zero signifies the upstream version of the kernel module.
401 #define ORANGEFS_KERNEL_PROTO_VERSION 0
404 * describes memory regions to map in the ORANGEFS_DEV_MAP ioctl.
405 * NOTE: See devpvfs2-req.c for 32 bit compat structure.
406 * Since this structure has a variable-sized layout that is different
407 * on 32 and 64 bit platforms, we need to normalize to a 64 bit layout
408 * on such systems before servicing ioctl calls from user-space binaries
409 * that may be 32 bit!
411 struct ORANGEFS_dev_map_desc
{
418 /* gossip.h *****************************************************************/
420 #ifdef GOSSIP_DISABLE_DEBUG
421 #define gossip_debug(mask, format, f...) do {} while (0)
423 extern __u64 gossip_debug_mask
;
424 extern struct client_debug_mask client_debug_mask
;
426 /* try to avoid function call overhead by checking masks in macro */
427 #define gossip_debug(mask, format, f...) \
429 if (gossip_debug_mask & mask) \
430 printk(format, ##f); \
432 #endif /* GOSSIP_DISABLE_DEBUG */
434 /* do file and line number printouts w/ the GNU preprocessor */
435 #define gossip_ldebug(mask, format, f...) \
436 gossip_debug(mask, "%s: " format, __func__, ##f)
438 #define gossip_err printk
439 #define gossip_lerr(format, f...) \
440 gossip_err("%s line %d: " format, \