2 * (C) 2001 Clemson University and The University of Chicago
4 * See COPYING in top-level directory.
8 * The ORANGEFS Linux kernel support allows ORANGEFS volumes to be mounted and
9 * accessed through the Linux VFS (i.e. using standard I/O system calls).
10 * This support is only needed on clients that wish to mount the file system.
15 * Declarations and macros for the ORANGEFS Linux kernel support.
18 #ifndef __ORANGEFSKERNEL_H
19 #define __ORANGEFSKERNEL_H
21 #include <linux/kernel.h>
22 #include <linux/moduleparam.h>
23 #include <linux/statfs.h>
24 #include <linux/backing-dev.h>
25 #include <linux/device.h>
26 #include <linux/mpage.h>
27 #include <linux/namei.h>
28 #include <linux/errno.h>
29 #include <linux/init.h>
30 #include <linux/module.h>
31 #include <linux/slab.h>
32 #include <linux/types.h>
34 #include <linux/vmalloc.h>
36 #include <linux/aio.h>
37 #include <linux/posix_acl.h>
38 #include <linux/posix_acl_xattr.h>
39 #include <linux/compat.h>
40 #include <linux/mount.h>
41 #include <linux/uaccess.h>
42 #include <linux/atomic.h>
43 #include <linux/uio.h>
44 #include <linux/sched.h>
46 #include <linux/wait.h>
47 #include <linux/dcache.h>
48 #include <linux/pagemap.h>
49 #include <linux/poll.h>
50 #include <linux/rwsem.h>
51 #include <linux/xattr.h>
52 #include <linux/exportfs.h>
54 #include <asm/unaligned.h>
56 #include "orangefs-dev-proto.h"
58 #ifdef ORANGEFS_KERNEL_DEBUG
59 #define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 10
61 #define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 20
64 #define ORANGEFS_BUFMAP_WAIT_TIMEOUT_SECS 30
66 #define ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS 900 /* 15 minutes */
68 #define ORANGEFS_REQDEVICE_NAME "pvfs2-req"
70 #define ORANGEFS_DEVREQ_MAGIC 0x20030529
71 #define ORANGEFS_LINK_MAX 0x000000FF
72 #define ORANGEFS_PURGE_RETRY_COUNT 0x00000005
73 #define ORANGEFS_SEEK_END 0x00000002
74 #define ORANGEFS_MAX_NUM_OPTIONS 0x00000004
75 #define ORANGEFS_MAX_MOUNT_OPT_LEN 0x00000080
76 #define ORANGEFS_MAX_FSKEY_LEN 64
78 #define MAX_DEV_REQ_UPSIZE (2 * sizeof(__s32) + \
79 sizeof(__u64) + sizeof(struct orangefs_upcall_s))
80 #define MAX_DEV_REQ_DOWNSIZE (2 * sizeof(__s32) + \
81 sizeof(__u64) + sizeof(struct orangefs_downcall_s))
84 * valid orangefs kernel operation states
86 * unknown - op was just initialized
87 * waiting - op is on request_list (upward bound)
88 * inprogr - op is in progress (waiting for downcall)
89 * serviced - op has matching downcall; ok
90 * purged - op has to start a timer since client-core
91 * exited uncleanly before servicing op
92 * given up - submitter has given up waiting for it
94 enum orangefs_vfs_op_states
{
95 OP_VFS_STATE_UNKNOWN
= 0,
96 OP_VFS_STATE_WAITING
= 1,
97 OP_VFS_STATE_INPROGR
= 2,
98 OP_VFS_STATE_SERVICED
= 4,
99 OP_VFS_STATE_PURGED
= 8,
100 OP_VFS_STATE_GIVEN_UP
= 16,
104 * An array of client_debug_mask will be built to hold debug keyword/mask
105 * values fetched from userspace.
107 struct client_debug_mask
{
114 * orangefs kernel memory related flags
117 #if ((defined ORANGEFS_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB))
118 #define ORANGEFS_CACHE_CREATE_FLAGS SLAB_RED_ZONE
120 #define ORANGEFS_CACHE_CREATE_FLAGS 0
121 #endif /* ((defined ORANGEFS_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB)) */
123 #define ORANGEFS_GFP_FLAGS (GFP_KERNEL)
124 #define ORANGEFS_BUFMAP_GFP_FLAGS (GFP_KERNEL)
126 /* orangefs xattr and acl related defines */
127 #define ORANGEFS_XATTR_INDEX_POSIX_ACL_ACCESS 1
128 #define ORANGEFS_XATTR_INDEX_POSIX_ACL_DEFAULT 2
129 #define ORANGEFS_XATTR_INDEX_TRUSTED 3
130 #define ORANGEFS_XATTR_INDEX_DEFAULT 4
132 #define ORANGEFS_XATTR_NAME_ACL_ACCESS XATTR_NAME_POSIX_ACL_ACCESS
133 #define ORANGEFS_XATTR_NAME_ACL_DEFAULT XATTR_NAME_POSIX_ACL_DEFAULT
134 #define ORANGEFS_XATTR_NAME_TRUSTED_PREFIX "trusted."
135 #define ORANGEFS_XATTR_NAME_DEFAULT_PREFIX ""
137 /* these functions are defined in orangefs-utils.c */
138 int orangefs_prepare_cdm_array(char *debug_array_string
);
139 int orangefs_prepare_debugfs_help_string(int);
141 /* defined in orangefs-debugfs.c */
142 int orangefs_client_debug_init(void);
144 void debug_string_to_mask(char *, void *, int);
145 void do_c_mask(int, char *, struct client_debug_mask
**);
146 void do_k_mask(int, char *, __u64
**);
148 void debug_mask_to_string(void *, int);
149 void do_k_string(void *, int);
150 void do_c_string(void *, int);
151 int check_amalgam_keyword(void *, int);
152 int keyword_is_amalgam(char *);
154 /*these variables are defined in orangefs-mod.c */
155 extern char kernel_debug_string
[ORANGEFS_MAX_DEBUG_STRING_LEN
];
156 extern char client_debug_string
[ORANGEFS_MAX_DEBUG_STRING_LEN
];
157 extern char client_debug_array_string
[ORANGEFS_MAX_DEBUG_STRING_LEN
];
158 extern unsigned int kernel_mask_set_mod_init
;
160 extern int orangefs_init_acl(struct inode
*inode
, struct inode
*dir
);
161 extern const struct xattr_handler
*orangefs_xattr_handlers
[];
163 extern struct posix_acl
*orangefs_get_acl(struct inode
*inode
, int type
);
164 extern int orangefs_set_acl(struct inode
*inode
, struct posix_acl
*acl
, int type
);
167 * Redefine xtvec structure so that we could move helper functions out of
171 __kernel_off_t xtv_off
; /* must be off_t */
172 __kernel_size_t xtv_len
; /* must be size_t */
176 * orangefs data structures
178 struct orangefs_kernel_op_s
{
179 enum orangefs_vfs_op_states op_state
;
183 * Set uses_shared_memory to non zero if this operation uses
184 * shared memory. If true, then a retry on the op must also
185 * get a new shared memory buffer and re-populate it.
186 * Cancels don't care - it only matters for service_operation()
187 * retry logics and cancels don't go through it anymore. It
188 * safely stays non-zero when we use it as slot_to_free.
191 int uses_shared_memory
;
195 struct orangefs_upcall_s upcall
;
196 struct orangefs_downcall_s downcall
;
198 struct completion waitq
;
203 struct list_head list
;
206 #define set_op_state_waiting(op) ((op)->op_state = OP_VFS_STATE_WAITING)
207 #define set_op_state_inprogress(op) ((op)->op_state = OP_VFS_STATE_INPROGR)
208 #define set_op_state_given_up(op) ((op)->op_state = OP_VFS_STATE_GIVEN_UP)
209 static inline void set_op_state_serviced(struct orangefs_kernel_op_s
*op
)
211 op
->op_state
= OP_VFS_STATE_SERVICED
;
212 complete(&op
->waitq
);
215 #define op_state_waiting(op) ((op)->op_state & OP_VFS_STATE_WAITING)
216 #define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR)
217 #define op_state_serviced(op) ((op)->op_state & OP_VFS_STATE_SERVICED)
218 #define op_state_purged(op) ((op)->op_state & OP_VFS_STATE_PURGED)
219 #define op_state_given_up(op) ((op)->op_state & OP_VFS_STATE_GIVEN_UP)
220 #define op_is_cancel(op) ((op)->upcall.type == ORANGEFS_VFS_OP_CANCEL)
222 void op_release(struct orangefs_kernel_op_s
*op
);
224 extern void orangefs_bufmap_put(int);
225 static inline void put_cancel(struct orangefs_kernel_op_s
*op
)
227 orangefs_bufmap_put(op
->slot_to_free
);
231 static inline void set_op_state_purged(struct orangefs_kernel_op_s
*op
)
233 spin_lock(&op
->lock
);
234 if (unlikely(op_is_cancel(op
))) {
235 list_del_init(&op
->list
);
236 spin_unlock(&op
->lock
);
239 op
->op_state
|= OP_VFS_STATE_PURGED
;
240 complete(&op
->waitq
);
241 spin_unlock(&op
->lock
);
245 /* per inode private orangefs info */
246 struct orangefs_inode_s
{
247 struct orangefs_object_kref refn
;
248 char link_target
[ORANGEFS_NAME_MAX
];
251 * Reading/Writing Extended attributes need to acquire the appropriate
252 * reader/writer semaphore on the orangefs_inode_s structure.
254 struct rw_semaphore xattr_sem
;
256 struct inode vfs_inode
;
257 sector_t last_failed_block_index_read
;
260 * State of in-memory attributes not yet flushed to disk associated
263 unsigned long pinode_flags
;
266 #define P_ATIME_FLAG 0
267 #define P_MTIME_FLAG 1
268 #define P_CTIME_FLAG 2
269 #define P_MODE_FLAG 3
271 #define ClearAtimeFlag(pinode) clear_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
272 #define SetAtimeFlag(pinode) set_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
273 #define AtimeFlag(pinode) test_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
275 #define ClearMtimeFlag(pinode) clear_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
276 #define SetMtimeFlag(pinode) set_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
277 #define MtimeFlag(pinode) test_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
279 #define ClearCtimeFlag(pinode) clear_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
280 #define SetCtimeFlag(pinode) set_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
281 #define CtimeFlag(pinode) test_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
283 #define ClearModeFlag(pinode) clear_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
284 #define SetModeFlag(pinode) set_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
285 #define ModeFlag(pinode) test_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
287 /* per superblock private orangefs info */
288 struct orangefs_sb_info_s
{
289 struct orangefs_khandle root_khandle
;
293 #define ORANGEFS_OPT_INTR 0x01
294 #define ORANGEFS_OPT_LOCAL_LOCK 0x02
295 char devname
[ORANGEFS_MAX_SERVER_ADDR_LEN
];
296 struct super_block
*sb
;
298 struct list_head list
;
302 * structure that holds the state of any async I/O operation issued
303 * through the VFS. Needed especially to handle cancellation requests
304 * or even completion notification so that the VFS client-side daemon
305 * can free up its vfs_request slots.
307 struct orangefs_kiocb_s
{
308 /* the pointer to the task that initiated the AIO */
309 struct task_struct
*tsk
;
311 /* pointer to the kiocb that kicked this operation */
314 /* buffer index that was used for the I/O */
315 struct orangefs_bufmap
*bufmap
;
318 /* orangefs kernel operation type */
319 struct orangefs_kernel_op_s
*op
;
321 /* The user space buffers from/to which I/O is being staged */
324 /* number of elements in the iovector */
325 unsigned long nr_segs
;
327 /* set to indicate the type of the operation */
333 /* and the count in bytes */
334 size_t bytes_to_be_copied
;
336 ssize_t bytes_copied
;
340 struct orangefs_stats
{
341 unsigned long cache_hits
;
342 unsigned long cache_misses
;
344 unsigned long writes
;
347 extern struct orangefs_stats g_orangefs_stats
;
350 * NOTE: See Documentation/filesystems/porting for information
351 * on implementing FOO_I and properly accessing fs private data
353 static inline struct orangefs_inode_s
*ORANGEFS_I(struct inode
*inode
)
355 return container_of(inode
, struct orangefs_inode_s
, vfs_inode
);
358 static inline struct orangefs_sb_info_s
*ORANGEFS_SB(struct super_block
*sb
)
360 return (struct orangefs_sb_info_s
*) sb
->s_fs_info
;
363 /* ino_t descends from "unsigned long", 8 bytes, 64 bits. */
364 static inline ino_t
orangefs_khandle_to_ino(struct orangefs_khandle
*khandle
)
371 ihandle
.u
[0] = khandle
->u
[0] ^ khandle
->u
[4];
372 ihandle
.u
[1] = khandle
->u
[1] ^ khandle
->u
[5];
373 ihandle
.u
[2] = khandle
->u
[2] ^ khandle
->u
[6];
374 ihandle
.u
[3] = khandle
->u
[3] ^ khandle
->u
[7];
375 ihandle
.u
[4] = khandle
->u
[12] ^ khandle
->u
[8];
376 ihandle
.u
[5] = khandle
->u
[13] ^ khandle
->u
[9];
377 ihandle
.u
[6] = khandle
->u
[14] ^ khandle
->u
[10];
378 ihandle
.u
[7] = khandle
->u
[15] ^ khandle
->u
[11];
383 static inline struct orangefs_khandle
*get_khandle_from_ino(struct inode
*inode
)
385 return &(ORANGEFS_I(inode
)->refn
.khandle
);
388 static inline __s32
get_fsid_from_ino(struct inode
*inode
)
390 return ORANGEFS_I(inode
)->refn
.fs_id
;
393 static inline ino_t
get_ino_from_khandle(struct inode
*inode
)
395 struct orangefs_khandle
*khandle
;
398 khandle
= get_khandle_from_ino(inode
);
399 ino
= orangefs_khandle_to_ino(khandle
);
403 static inline ino_t
get_parent_ino_from_dentry(struct dentry
*dentry
)
405 return get_ino_from_khandle(dentry
->d_parent
->d_inode
);
408 static inline int is_root_handle(struct inode
*inode
)
410 gossip_debug(GOSSIP_DCACHE_DEBUG
,
411 "%s: root handle: %pU, this handle: %pU:\n",
413 &ORANGEFS_SB(inode
->i_sb
)->root_khandle
,
414 get_khandle_from_ino(inode
));
416 if (ORANGEFS_khandle_cmp(&(ORANGEFS_SB(inode
->i_sb
)->root_khandle
),
417 get_khandle_from_ino(inode
)))
423 static inline int match_handle(struct orangefs_khandle resp_handle
,
426 gossip_debug(GOSSIP_DCACHE_DEBUG
,
427 "%s: one handle: %pU, another handle:%pU:\n",
430 get_khandle_from_ino(inode
));
432 if (ORANGEFS_khandle_cmp(&resp_handle
, get_khandle_from_ino(inode
)))
439 * defined in orangefs-cache.c
441 int op_cache_initialize(void);
442 int op_cache_finalize(void);
443 struct orangefs_kernel_op_s
*op_alloc(__s32 type
);
444 void orangefs_new_tag(struct orangefs_kernel_op_s
*op
);
445 char *get_opname_string(struct orangefs_kernel_op_s
*new_op
);
447 int orangefs_inode_cache_initialize(void);
448 int orangefs_inode_cache_finalize(void);
451 * defined in orangefs-mod.c
453 void purge_inprogress_ops(void);
456 * defined in waitqueue.c
458 void purge_waiting_ops(void);
463 struct dentry
*orangefs_mount(struct file_system_type
*fst
,
468 void orangefs_kill_sb(struct super_block
*sb
);
469 int orangefs_remount(struct super_block
*sb
);
471 int fsid_key_table_initialize(void);
472 void fsid_key_table_finalize(void);
477 __u32
convert_to_orangefs_mask(unsigned long lite_mask
);
478 struct inode
*orangefs_new_inode(struct super_block
*sb
,
482 struct orangefs_object_kref
*ref
);
484 int orangefs_setattr(struct dentry
*dentry
, struct iattr
*iattr
);
486 int orangefs_getattr(struct vfsmount
*mnt
,
487 struct dentry
*dentry
,
488 struct kstat
*kstat
);
490 int orangefs_permission(struct inode
*inode
, int mask
);
495 int orangefs_setxattr(struct dentry
*dentry
,
501 ssize_t
orangefs_getxattr(struct dentry
*dentry
,
506 ssize_t
orangefs_listxattr(struct dentry
*dentry
, char *buffer
, size_t size
);
511 struct inode
*orangefs_iget(struct super_block
*sb
,
512 struct orangefs_object_kref
*ref
);
514 ssize_t
orangefs_inode_read(struct inode
*inode
,
515 struct iov_iter
*iter
,
517 loff_t readahead_size
);
520 * defined in devorangefs-req.c
522 int orangefs_dev_init(void);
523 void orangefs_dev_cleanup(void);
524 int is_daemon_in_service(void);
525 bool __is_daemon_in_service(void);
526 int fs_mount_pending(__s32 fsid
);
529 * defined in orangefs-utils.c
531 __s32
fsid_of_op(struct orangefs_kernel_op_s
*op
);
533 int orangefs_flush_inode(struct inode
*inode
);
535 ssize_t
orangefs_inode_getxattr(struct inode
*inode
,
541 int orangefs_inode_setxattr(struct inode
*inode
,
548 int orangefs_inode_getattr(struct inode
*inode
, __u32 mask
, int check
);
550 int orangefs_inode_setattr(struct inode
*inode
, struct iattr
*iattr
);
552 void orangefs_make_bad_inode(struct inode
*inode
);
554 int orangefs_unmount_sb(struct super_block
*sb
);
556 bool orangefs_cancel_op_in_progress(struct orangefs_kernel_op_s
*op
);
558 static inline __u64
orangefs_convert_time_field(const struct timespec
*ts
)
560 return (__u64
)ts
->tv_sec
;
563 int orangefs_normalize_to_errno(__s32 error_code
);
565 extern struct mutex devreq_mutex
;
566 extern struct mutex request_mutex
;
568 extern int op_timeout_secs
;
569 extern int slot_timeout_secs
;
570 extern struct list_head orangefs_superblocks
;
571 extern spinlock_t orangefs_superblocks_lock
;
572 extern struct list_head orangefs_request_list
;
573 extern spinlock_t orangefs_request_list_lock
;
574 extern wait_queue_head_t orangefs_request_list_waitq
;
575 extern struct list_head
*htable_ops_in_progress
;
576 extern spinlock_t htable_ops_in_progress_lock
;
577 extern int hash_table_size
;
579 extern const struct address_space_operations orangefs_address_operations
;
580 extern struct backing_dev_info orangefs_backing_dev_info
;
581 extern struct inode_operations orangefs_file_inode_operations
;
582 extern const struct file_operations orangefs_file_operations
;
583 extern struct inode_operations orangefs_symlink_inode_operations
;
584 extern struct inode_operations orangefs_dir_inode_operations
;
585 extern const struct file_operations orangefs_dir_operations
;
586 extern const struct dentry_operations orangefs_dentry_operations
;
587 extern const struct file_operations orangefs_devreq_file_operations
;
589 extern wait_queue_head_t orangefs_bufmap_init_waitq
;
592 * misc convenience macros
595 #define ORANGEFS_OP_INTERRUPTIBLE 1 /* service_operation() is interruptible */
596 #define ORANGEFS_OP_PRIORITY 2 /* service_operation() is high priority */
597 #define ORANGEFS_OP_CANCELLATION 4 /* this is a cancellation */
598 #define ORANGEFS_OP_NO_MUTEX 8 /* don't acquire request_mutex */
599 #define ORANGEFS_OP_ASYNC 16 /* Queue it, but don't wait */
601 int service_operation(struct orangefs_kernel_op_s
*op
,
605 #define get_interruptible_flag(inode) \
606 ((ORANGEFS_SB(inode->i_sb)->flags & ORANGEFS_OPT_INTR) ? \
607 ORANGEFS_OP_INTERRUPTIBLE : 0)
609 #define add_orangefs_sb(sb) \
611 gossip_debug(GOSSIP_SUPER_DEBUG, \
612 "Adding SB %p to orangefs superblocks\n", \
614 spin_lock(&orangefs_superblocks_lock); \
615 list_add_tail(&ORANGEFS_SB(sb)->list, &orangefs_superblocks); \
616 spin_unlock(&orangefs_superblocks_lock); \
619 #define remove_orangefs_sb(sb) \
621 struct list_head *tmp = NULL; \
622 struct list_head *tmp_safe = NULL; \
623 struct orangefs_sb_info_s *orangefs_sb = NULL; \
625 spin_lock(&orangefs_superblocks_lock); \
626 list_for_each_safe(tmp, tmp_safe, &orangefs_superblocks) { \
627 orangefs_sb = list_entry(tmp, \
628 struct orangefs_sb_info_s, \
630 if (orangefs_sb && (orangefs_sb->sb == sb)) { \
631 gossip_debug(GOSSIP_SUPER_DEBUG, \
632 "Removing SB %p from orangefs superblocks\n", \
634 list_del(&orangefs_sb->list); \
638 spin_unlock(&orangefs_superblocks_lock); \
641 #define orangefs_lock_inode(inode) spin_lock(&inode->i_lock)
642 #define orangefs_unlock_inode(inode) spin_unlock(&inode->i_lock)
644 #define fill_default_sys_attrs(sys_attr, type, mode) \
646 sys_attr.owner = from_kuid(current_user_ns(), current_fsuid()); \
647 sys_attr.group = from_kgid(current_user_ns(), current_fsgid()); \
649 sys_attr.perms = ORANGEFS_util_translate_mode(mode); \
650 sys_attr.objtype = type; \
651 sys_attr.mask = ORANGEFS_ATTR_SYS_ALL_SETABLE; \
654 #define orangefs_inode_lock(__i) mutex_lock(&(__i)->i_mutex)
656 #define orangefs_inode_unlock(__i) mutex_unlock(&(__i)->i_mutex)
658 static inline void orangefs_i_size_write(struct inode
*inode
, loff_t i_size
)
660 #if BITS_PER_LONG == 32 && defined(CONFIG_SMP)
661 orangefs_inode_lock(inode
);
663 i_size_write(inode
, i_size
);
664 #if BITS_PER_LONG == 32 && defined(CONFIG_SMP)
665 orangefs_inode_unlock(inode
);
669 static inline unsigned int diff(struct timeval
*end
, struct timeval
*begin
)
671 if (end
->tv_usec
< begin
->tv_usec
) {
672 end
->tv_usec
+= 1000000;
675 end
->tv_sec
-= begin
->tv_sec
;
676 end
->tv_usec
-= begin
->tv_usec
;
677 return (end
->tv_sec
* 1000000) + end
->tv_usec
;
680 #endif /* __ORANGEFSKERNEL_H */