Commit | Line | Data |
---|---|---|
f7ab093f MM |
1 | /* |
2 | * (C) 2001 Clemson University and The University of Chicago | |
3 | * | |
4 | * See COPYING in top-level directory. | |
5 | */ | |
6 | ||
7 | /* | |
8bb8aefd | 8 | * The ORANGEFS Linux kernel support allows ORANGEFS volumes to be mounted and |
f7ab093f MM |
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. | |
11 | * | |
12 | */ | |
13 | ||
14 | /* | |
8bb8aefd | 15 | * Declarations and macros for the ORANGEFS Linux kernel support. |
f7ab093f MM |
16 | */ |
17 | ||
8bb8aefd YL |
18 | #ifndef __ORANGEFSKERNEL_H |
19 | #define __ORANGEFSKERNEL_H | |
f7ab093f MM |
20 | |
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> | |
33 | #include <linux/fs.h> | |
34 | #include <linux/vmalloc.h> | |
35 | ||
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> | |
45 | #include <linux/mm.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> | |
53 | ||
54 | #include <asm/unaligned.h> | |
55 | ||
575e9461 | 56 | #include "orangefs-dev-proto.h" |
f7ab093f | 57 | |
8bb8aefd YL |
58 | #ifdef ORANGEFS_KERNEL_DEBUG |
59 | #define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 10 | |
f7ab093f | 60 | #else |
8bb8aefd | 61 | #define ORANGEFS_DEFAULT_OP_TIMEOUT_SECS 20 |
f7ab093f MM |
62 | #endif |
63 | ||
8bb8aefd | 64 | #define ORANGEFS_BUFMAP_WAIT_TIMEOUT_SECS 30 |
f7ab093f | 65 | |
8bb8aefd | 66 | #define ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS 900 /* 15 minutes */ |
f7ab093f | 67 | |
8bb8aefd | 68 | #define ORANGEFS_REQDEVICE_NAME "pvfs2-req" |
f7ab093f | 69 | |
8bb8aefd YL |
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 | |
f7ab093f MM |
77 | |
78 | #define MAX_DEV_REQ_UPSIZE (2*sizeof(__s32) + \ | |
8bb8aefd | 79 | sizeof(__u64) + sizeof(struct orangefs_upcall_s)) |
f7ab093f | 80 | #define MAX_DEV_REQ_DOWNSIZE (2*sizeof(__s32) + \ |
8bb8aefd | 81 | sizeof(__u64) + sizeof(struct orangefs_downcall_s)) |
f7ab093f | 82 | |
f7ab093f MM |
83 | /* borrowed from irda.h */ |
84 | #ifndef MSECS_TO_JIFFIES | |
85 | #define MSECS_TO_JIFFIES(ms) (((ms)*HZ+999)/1000) | |
86 | #endif | |
87 | ||
f7ab093f | 88 | /* |
8bb8aefd | 89 | * valid orangefs kernel operation states |
f7ab093f MM |
90 | * |
91 | * unknown - op was just initialized | |
92 | * waiting - op is on request_list (upward bound) | |
93 | * inprogr - op is in progress (waiting for downcall) | |
94 | * serviced - op has matching downcall; ok | |
95 | * purged - op has to start a timer since client-core | |
96 | * exited uncleanly before servicing op | |
97 | */ | |
8bb8aefd | 98 | enum orangefs_vfs_op_states { |
f7ab093f MM |
99 | OP_VFS_STATE_UNKNOWN = 0, |
100 | OP_VFS_STATE_WAITING = 1, | |
101 | OP_VFS_STATE_INPROGR = 2, | |
102 | OP_VFS_STATE_SERVICED = 4, | |
103 | OP_VFS_STATE_PURGED = 8, | |
104 | }; | |
105 | ||
106 | #define set_op_state_waiting(op) ((op)->op_state = OP_VFS_STATE_WAITING) | |
107 | #define set_op_state_inprogress(op) ((op)->op_state = OP_VFS_STATE_INPROGR) | |
108 | #define set_op_state_serviced(op) ((op)->op_state = OP_VFS_STATE_SERVICED) | |
109 | #define set_op_state_purged(op) ((op)->op_state |= OP_VFS_STATE_PURGED) | |
110 | ||
111 | #define op_state_waiting(op) ((op)->op_state & OP_VFS_STATE_WAITING) | |
112 | #define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR) | |
113 | #define op_state_serviced(op) ((op)->op_state & OP_VFS_STATE_SERVICED) | |
114 | #define op_state_purged(op) ((op)->op_state & OP_VFS_STATE_PURGED) | |
115 | ||
116 | #define get_op(op) \ | |
117 | do { \ | |
c817e266 | 118 | atomic_inc(&(op)->ref_count); \ |
f7ab093f MM |
119 | gossip_debug(GOSSIP_DEV_DEBUG, \ |
120 | "(get) Alloced OP (%p:%llu)\n", \ | |
121 | op, \ | |
122 | llu((op)->tag)); \ | |
123 | } while (0) | |
124 | ||
125 | #define put_op(op) \ | |
126 | do { \ | |
c817e266 | 127 | if (atomic_sub_and_test(1, &(op)->ref_count) == 1) { \ |
f7ab093f MM |
128 | gossip_debug(GOSSIP_DEV_DEBUG, \ |
129 | "(put) Releasing OP (%p:%llu)\n", \ | |
130 | op, \ | |
131 | llu((op)->tag)); \ | |
132 | op_release(op); \ | |
133 | } \ | |
134 | } while (0) | |
135 | ||
c817e266 | 136 | #define op_wait(op) (atomic_read(&(op)->ref_count) <= 2 ? 0 : 1) |
f7ab093f MM |
137 | |
138 | /* | |
139 | * Defines for controlling whether I/O upcalls are for async or sync operations | |
140 | */ | |
8bb8aefd YL |
141 | enum ORANGEFS_async_io_type { |
142 | ORANGEFS_VFS_SYNC_IO = 0, | |
143 | ORANGEFS_VFS_ASYNC_IO = 1, | |
f7ab093f MM |
144 | }; |
145 | ||
146 | /* | |
147 | * An array of client_debug_mask will be built to hold debug keyword/mask | |
148 | * values fetched from userspace. | |
149 | */ | |
150 | struct client_debug_mask { | |
151 | char *keyword; | |
152 | __u64 mask1; | |
153 | __u64 mask2; | |
154 | }; | |
155 | ||
156 | /* | |
8bb8aefd | 157 | * orangefs kernel memory related flags |
f7ab093f MM |
158 | */ |
159 | ||
8bb8aefd YL |
160 | #if ((defined ORANGEFS_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB)) |
161 | #define ORANGEFS_CACHE_CREATE_FLAGS SLAB_RED_ZONE | |
f7ab093f | 162 | #else |
8bb8aefd YL |
163 | #define ORANGEFS_CACHE_CREATE_FLAGS 0 |
164 | #endif /* ((defined ORANGEFS_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB)) */ | |
f7ab093f | 165 | |
8bb8aefd YL |
166 | #define ORANGEFS_CACHE_ALLOC_FLAGS (GFP_KERNEL) |
167 | #define ORANGEFS_GFP_FLAGS (GFP_KERNEL) | |
168 | #define ORANGEFS_BUFMAP_GFP_FLAGS (GFP_KERNEL) | |
f7ab093f | 169 | |
8bb8aefd YL |
170 | /* orangefs xattr and acl related defines */ |
171 | #define ORANGEFS_XATTR_INDEX_POSIX_ACL_ACCESS 1 | |
172 | #define ORANGEFS_XATTR_INDEX_POSIX_ACL_DEFAULT 2 | |
173 | #define ORANGEFS_XATTR_INDEX_TRUSTED 3 | |
174 | #define ORANGEFS_XATTR_INDEX_DEFAULT 4 | |
f7ab093f | 175 | |
fef8b67c MM |
176 | #define ORANGEFS_XATTR_NAME_ACL_ACCESS XATTR_NAME_POSIX_ACL_ACCESS |
177 | #define ORANGEFS_XATTR_NAME_ACL_DEFAULT XATTR_NAME_POSIX_ACL_DEFAULT | |
8bb8aefd YL |
178 | #define ORANGEFS_XATTR_NAME_TRUSTED_PREFIX "trusted." |
179 | #define ORANGEFS_XATTR_NAME_DEFAULT_PREFIX "" | |
f7ab093f | 180 | |
8bb8aefd | 181 | /* these functions are defined in orangefs-utils.c */ |
f7ab093f MM |
182 | int orangefs_prepare_cdm_array(char *debug_array_string); |
183 | int orangefs_prepare_debugfs_help_string(int); | |
184 | ||
8bb8aefd YL |
185 | /* defined in orangefs-debugfs.c */ |
186 | int orangefs_client_debug_init(void); | |
f7ab093f MM |
187 | |
188 | void debug_string_to_mask(char *, void *, int); | |
189 | void do_c_mask(int, char *, struct client_debug_mask **); | |
190 | void do_k_mask(int, char *, __u64 **); | |
191 | ||
192 | void debug_mask_to_string(void *, int); | |
193 | void do_k_string(void *, int); | |
194 | void do_c_string(void *, int); | |
195 | int check_amalgam_keyword(void *, int); | |
196 | int keyword_is_amalgam(char *); | |
197 | ||
8bb8aefd YL |
198 | /*these variables are defined in orangefs-mod.c */ |
199 | extern char kernel_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN]; | |
200 | extern char client_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN]; | |
201 | extern char client_debug_array_string[ORANGEFS_MAX_DEBUG_STRING_LEN]; | |
f7ab093f MM |
202 | extern unsigned int kernel_mask_set_mod_init; |
203 | ||
8bb8aefd YL |
204 | extern int orangefs_init_acl(struct inode *inode, struct inode *dir); |
205 | extern const struct xattr_handler *orangefs_xattr_handlers[]; | |
f7ab093f | 206 | |
8bb8aefd YL |
207 | extern struct posix_acl *orangefs_get_acl(struct inode *inode, int type); |
208 | extern int orangefs_set_acl(struct inode *inode, struct posix_acl *acl, int type); | |
f7ab093f | 209 | |
f7ab093f MM |
210 | /* |
211 | * Redefine xtvec structure so that we could move helper functions out of | |
212 | * the define | |
213 | */ | |
214 | struct xtvec { | |
215 | __kernel_off_t xtv_off; /* must be off_t */ | |
216 | __kernel_size_t xtv_len; /* must be size_t */ | |
217 | }; | |
218 | ||
219 | /* | |
8bb8aefd | 220 | * orangefs data structures |
f7ab093f | 221 | */ |
8bb8aefd YL |
222 | struct orangefs_kernel_op_s { |
223 | enum orangefs_vfs_op_states op_state; | |
f7ab093f MM |
224 | __u64 tag; |
225 | ||
226 | /* | |
227 | * Set uses_shared_memory to 1 if this operation uses shared memory. | |
228 | * If true, then a retry on the op must also get a new shared memory | |
229 | * buffer and re-populate it. | |
230 | */ | |
231 | int uses_shared_memory; | |
232 | ||
8bb8aefd YL |
233 | struct orangefs_upcall_s upcall; |
234 | struct orangefs_downcall_s downcall; | |
f7ab093f MM |
235 | |
236 | wait_queue_head_t waitq; | |
237 | spinlock_t lock; | |
238 | ||
239 | int io_completed; | |
240 | wait_queue_head_t io_completion_waitq; | |
241 | ||
c817e266 MM |
242 | atomic_t ref_count; |
243 | ||
f7ab093f MM |
244 | /* VFS aio fields */ |
245 | ||
8bb8aefd | 246 | /* used by the async I/O code to stash the orangefs_kiocb_s structure */ |
f7ab093f MM |
247 | void *priv; |
248 | ||
f7ab093f MM |
249 | int attempts; |
250 | ||
251 | struct list_head list; | |
252 | }; | |
253 | ||
8bb8aefd YL |
254 | /* per inode private orangefs info */ |
255 | struct orangefs_inode_s { | |
256 | struct orangefs_object_kref refn; | |
257 | char link_target[ORANGEFS_NAME_MAX]; | |
f7ab093f MM |
258 | __s64 blksize; |
259 | /* | |
260 | * Reading/Writing Extended attributes need to acquire the appropriate | |
8bb8aefd | 261 | * reader/writer semaphore on the orangefs_inode_s structure. |
f7ab093f MM |
262 | */ |
263 | struct rw_semaphore xattr_sem; | |
264 | ||
265 | struct inode vfs_inode; | |
266 | sector_t last_failed_block_index_read; | |
267 | ||
268 | /* | |
269 | * State of in-memory attributes not yet flushed to disk associated | |
270 | * with this object | |
271 | */ | |
272 | unsigned long pinode_flags; | |
273 | ||
8bb8aefd | 274 | /* All allocated orangefs_inode_s objects are chained to a list */ |
f7ab093f MM |
275 | struct list_head list; |
276 | }; | |
277 | ||
278 | #define P_ATIME_FLAG 0 | |
279 | #define P_MTIME_FLAG 1 | |
280 | #define P_CTIME_FLAG 2 | |
281 | #define P_MODE_FLAG 3 | |
282 | ||
283 | #define ClearAtimeFlag(pinode) clear_bit(P_ATIME_FLAG, &(pinode)->pinode_flags) | |
284 | #define SetAtimeFlag(pinode) set_bit(P_ATIME_FLAG, &(pinode)->pinode_flags) | |
285 | #define AtimeFlag(pinode) test_bit(P_ATIME_FLAG, &(pinode)->pinode_flags) | |
286 | ||
287 | #define ClearMtimeFlag(pinode) clear_bit(P_MTIME_FLAG, &(pinode)->pinode_flags) | |
288 | #define SetMtimeFlag(pinode) set_bit(P_MTIME_FLAG, &(pinode)->pinode_flags) | |
289 | #define MtimeFlag(pinode) test_bit(P_MTIME_FLAG, &(pinode)->pinode_flags) | |
290 | ||
291 | #define ClearCtimeFlag(pinode) clear_bit(P_CTIME_FLAG, &(pinode)->pinode_flags) | |
292 | #define SetCtimeFlag(pinode) set_bit(P_CTIME_FLAG, &(pinode)->pinode_flags) | |
293 | #define CtimeFlag(pinode) test_bit(P_CTIME_FLAG, &(pinode)->pinode_flags) | |
294 | ||
295 | #define ClearModeFlag(pinode) clear_bit(P_MODE_FLAG, &(pinode)->pinode_flags) | |
296 | #define SetModeFlag(pinode) set_bit(P_MODE_FLAG, &(pinode)->pinode_flags) | |
297 | #define ModeFlag(pinode) test_bit(P_MODE_FLAG, &(pinode)->pinode_flags) | |
298 | ||
8bb8aefd YL |
299 | /* per superblock private orangefs info */ |
300 | struct orangefs_sb_info_s { | |
301 | struct orangefs_khandle root_khandle; | |
f7ab093f MM |
302 | __s32 fs_id; |
303 | int id; | |
304 | int flags; | |
8bb8aefd YL |
305 | #define ORANGEFS_OPT_INTR 0x01 |
306 | #define ORANGEFS_OPT_LOCAL_LOCK 0x02 | |
307 | char devname[ORANGEFS_MAX_SERVER_ADDR_LEN]; | |
f7ab093f MM |
308 | struct super_block *sb; |
309 | int mount_pending; | |
310 | struct list_head list; | |
311 | }; | |
312 | ||
f7ab093f MM |
313 | /* |
314 | * structure that holds the state of any async I/O operation issued | |
315 | * through the VFS. Needed especially to handle cancellation requests | |
316 | * or even completion notification so that the VFS client-side daemon | |
317 | * can free up its vfs_request slots. | |
318 | */ | |
8bb8aefd | 319 | struct orangefs_kiocb_s { |
f7ab093f MM |
320 | /* the pointer to the task that initiated the AIO */ |
321 | struct task_struct *tsk; | |
322 | ||
323 | /* pointer to the kiocb that kicked this operation */ | |
324 | struct kiocb *kiocb; | |
325 | ||
326 | /* buffer index that was used for the I/O */ | |
8bb8aefd | 327 | struct orangefs_bufmap *bufmap; |
f7ab093f MM |
328 | int buffer_index; |
329 | ||
8bb8aefd YL |
330 | /* orangefs kernel operation type */ |
331 | struct orangefs_kernel_op_s *op; | |
f7ab093f MM |
332 | |
333 | /* The user space buffers from/to which I/O is being staged */ | |
334 | struct iovec *iov; | |
335 | ||
336 | /* number of elements in the iovector */ | |
337 | unsigned long nr_segs; | |
338 | ||
339 | /* set to indicate the type of the operation */ | |
340 | int rw; | |
341 | ||
342 | /* file offset */ | |
343 | loff_t offset; | |
344 | ||
345 | /* and the count in bytes */ | |
346 | size_t bytes_to_be_copied; | |
347 | ||
348 | ssize_t bytes_copied; | |
349 | int needs_cleanup; | |
350 | }; | |
351 | ||
8bb8aefd | 352 | struct orangefs_stats { |
f7ab093f MM |
353 | unsigned long cache_hits; |
354 | unsigned long cache_misses; | |
355 | unsigned long reads; | |
356 | unsigned long writes; | |
357 | }; | |
358 | ||
8bb8aefd | 359 | extern struct orangefs_stats g_orangefs_stats; |
f7ab093f MM |
360 | |
361 | /* | |
54804949 MM |
362 | * NOTE: See Documentation/filesystems/porting for information |
363 | * on implementing FOO_I and properly accessing fs private data | |
364 | */ | |
8bb8aefd | 365 | static inline struct orangefs_inode_s *ORANGEFS_I(struct inode *inode) |
f7ab093f | 366 | { |
8bb8aefd | 367 | return container_of(inode, struct orangefs_inode_s, vfs_inode); |
f7ab093f MM |
368 | } |
369 | ||
8bb8aefd | 370 | static inline struct orangefs_sb_info_s *ORANGEFS_SB(struct super_block *sb) |
f7ab093f | 371 | { |
8bb8aefd | 372 | return (struct orangefs_sb_info_s *) sb->s_fs_info; |
f7ab093f MM |
373 | } |
374 | ||
375 | /* ino_t descends from "unsigned long", 8 bytes, 64 bits. */ | |
8bb8aefd | 376 | static inline ino_t orangefs_khandle_to_ino(struct orangefs_khandle *khandle) |
f7ab093f MM |
377 | { |
378 | union { | |
379 | unsigned char u[8]; | |
380 | __u64 ino; | |
381 | } ihandle; | |
382 | ||
383 | ihandle.u[0] = khandle->u[0] ^ khandle->u[4]; | |
384 | ihandle.u[1] = khandle->u[1] ^ khandle->u[5]; | |
385 | ihandle.u[2] = khandle->u[2] ^ khandle->u[6]; | |
386 | ihandle.u[3] = khandle->u[3] ^ khandle->u[7]; | |
387 | ihandle.u[4] = khandle->u[12] ^ khandle->u[8]; | |
388 | ihandle.u[5] = khandle->u[13] ^ khandle->u[9]; | |
389 | ihandle.u[6] = khandle->u[14] ^ khandle->u[10]; | |
390 | ihandle.u[7] = khandle->u[15] ^ khandle->u[11]; | |
391 | ||
392 | return ihandle.ino; | |
393 | } | |
394 | ||
8bb8aefd | 395 | static inline struct orangefs_khandle *get_khandle_from_ino(struct inode *inode) |
f7ab093f | 396 | { |
8bb8aefd | 397 | return &(ORANGEFS_I(inode)->refn.khandle); |
f7ab093f MM |
398 | } |
399 | ||
400 | static inline __s32 get_fsid_from_ino(struct inode *inode) | |
401 | { | |
8bb8aefd | 402 | return ORANGEFS_I(inode)->refn.fs_id; |
f7ab093f MM |
403 | } |
404 | ||
405 | static inline ino_t get_ino_from_khandle(struct inode *inode) | |
406 | { | |
8bb8aefd | 407 | struct orangefs_khandle *khandle; |
f7ab093f MM |
408 | ino_t ino; |
409 | ||
410 | khandle = get_khandle_from_ino(inode); | |
8bb8aefd | 411 | ino = orangefs_khandle_to_ino(khandle); |
f7ab093f MM |
412 | return ino; |
413 | } | |
414 | ||
415 | static inline ino_t get_parent_ino_from_dentry(struct dentry *dentry) | |
416 | { | |
417 | return get_ino_from_khandle(dentry->d_parent->d_inode); | |
418 | } | |
419 | ||
420 | static inline int is_root_handle(struct inode *inode) | |
421 | { | |
422 | gossip_debug(GOSSIP_DCACHE_DEBUG, | |
423 | "%s: root handle: %pU, this handle: %pU:\n", | |
424 | __func__, | |
8bb8aefd | 425 | &ORANGEFS_SB(inode->i_sb)->root_khandle, |
f7ab093f MM |
426 | get_khandle_from_ino(inode)); |
427 | ||
8bb8aefd | 428 | if (ORANGEFS_khandle_cmp(&(ORANGEFS_SB(inode->i_sb)->root_khandle), |
f7ab093f MM |
429 | get_khandle_from_ino(inode))) |
430 | return 0; | |
431 | else | |
432 | return 1; | |
433 | } | |
434 | ||
8bb8aefd | 435 | static inline int match_handle(struct orangefs_khandle resp_handle, |
f7ab093f MM |
436 | struct inode *inode) |
437 | { | |
438 | gossip_debug(GOSSIP_DCACHE_DEBUG, | |
439 | "%s: one handle: %pU, another handle:%pU:\n", | |
440 | __func__, | |
441 | &resp_handle, | |
442 | get_khandle_from_ino(inode)); | |
443 | ||
8bb8aefd | 444 | if (ORANGEFS_khandle_cmp(&resp_handle, get_khandle_from_ino(inode))) |
f7ab093f MM |
445 | return 0; |
446 | else | |
447 | return 1; | |
448 | } | |
449 | ||
450 | /* | |
8bb8aefd | 451 | * defined in orangefs-cache.c |
f7ab093f MM |
452 | */ |
453 | int op_cache_initialize(void); | |
454 | int op_cache_finalize(void); | |
8bb8aefd YL |
455 | struct orangefs_kernel_op_s *op_alloc(__s32 type); |
456 | char *get_opname_string(struct orangefs_kernel_op_s *new_op); | |
457 | void op_release(struct orangefs_kernel_op_s *op); | |
f7ab093f MM |
458 | |
459 | int dev_req_cache_initialize(void); | |
460 | int dev_req_cache_finalize(void); | |
461 | void *dev_req_alloc(void); | |
462 | void dev_req_release(void *); | |
463 | ||
8bb8aefd YL |
464 | int orangefs_inode_cache_initialize(void); |
465 | int orangefs_inode_cache_finalize(void); | |
f7ab093f MM |
466 | |
467 | int kiocb_cache_initialize(void); | |
468 | int kiocb_cache_finalize(void); | |
8bb8aefd YL |
469 | struct orangefs_kiocb_s *kiocb_alloc(void); |
470 | void kiocb_release(struct orangefs_kiocb_s *ptr); | |
f7ab093f MM |
471 | |
472 | /* | |
8bb8aefd | 473 | * defined in orangefs-mod.c |
f7ab093f MM |
474 | */ |
475 | void purge_inprogress_ops(void); | |
476 | ||
477 | /* | |
478 | * defined in waitqueue.c | |
479 | */ | |
8bb8aefd YL |
480 | int wait_for_matching_downcall(struct orangefs_kernel_op_s *op); |
481 | int wait_for_cancellation_downcall(struct orangefs_kernel_op_s *op); | |
482 | void orangefs_clean_up_interrupted_operation(struct orangefs_kernel_op_s *op); | |
f7ab093f MM |
483 | void purge_waiting_ops(void); |
484 | ||
485 | /* | |
486 | * defined in super.c | |
487 | */ | |
8bb8aefd | 488 | struct dentry *orangefs_mount(struct file_system_type *fst, |
f7ab093f MM |
489 | int flags, |
490 | const char *devname, | |
491 | void *data); | |
492 | ||
8bb8aefd YL |
493 | void orangefs_kill_sb(struct super_block *sb); |
494 | int orangefs_remount(struct super_block *sb); | |
f7ab093f MM |
495 | |
496 | int fsid_key_table_initialize(void); | |
497 | void fsid_key_table_finalize(void); | |
498 | ||
499 | /* | |
500 | * defined in inode.c | |
501 | */ | |
8bb8aefd YL |
502 | __u32 convert_to_orangefs_mask(unsigned long lite_mask); |
503 | struct inode *orangefs_new_inode(struct super_block *sb, | |
f7ab093f MM |
504 | struct inode *dir, |
505 | int mode, | |
506 | dev_t dev, | |
8bb8aefd | 507 | struct orangefs_object_kref *ref); |
f7ab093f | 508 | |
8bb8aefd | 509 | int orangefs_setattr(struct dentry *dentry, struct iattr *iattr); |
f7ab093f | 510 | |
8bb8aefd | 511 | int orangefs_getattr(struct vfsmount *mnt, |
f7ab093f MM |
512 | struct dentry *dentry, |
513 | struct kstat *kstat); | |
514 | ||
515 | /* | |
516 | * defined in xattr.c | |
517 | */ | |
8bb8aefd | 518 | int orangefs_setxattr(struct dentry *dentry, |
f7ab093f MM |
519 | const char *name, |
520 | const void *value, | |
521 | size_t size, | |
522 | int flags); | |
523 | ||
8bb8aefd | 524 | ssize_t orangefs_getxattr(struct dentry *dentry, |
f7ab093f MM |
525 | const char *name, |
526 | void *buffer, | |
527 | size_t size); | |
528 | ||
8bb8aefd | 529 | ssize_t orangefs_listxattr(struct dentry *dentry, char *buffer, size_t size); |
f7ab093f MM |
530 | |
531 | /* | |
532 | * defined in namei.c | |
533 | */ | |
8bb8aefd YL |
534 | struct inode *orangefs_iget(struct super_block *sb, |
535 | struct orangefs_object_kref *ref); | |
f7ab093f | 536 | |
8bb8aefd YL |
537 | ssize_t orangefs_inode_read(struct inode *inode, |
538 | struct iov_iter *iter, | |
539 | loff_t *offset, | |
540 | loff_t readahead_size); | |
f7ab093f MM |
541 | |
542 | /* | |
8bb8aefd | 543 | * defined in devorangefs-req.c |
f7ab093f | 544 | */ |
8bb8aefd YL |
545 | int orangefs_dev_init(void); |
546 | void orangefs_dev_cleanup(void); | |
f7ab093f MM |
547 | int is_daemon_in_service(void); |
548 | int fs_mount_pending(__s32 fsid); | |
549 | ||
550 | /* | |
8bb8aefd | 551 | * defined in orangefs-utils.c |
f7ab093f | 552 | */ |
8bb8aefd | 553 | __s32 fsid_of_op(struct orangefs_kernel_op_s *op); |
f7ab093f | 554 | |
8bb8aefd | 555 | int orangefs_flush_inode(struct inode *inode); |
f7ab093f | 556 | |
8bb8aefd | 557 | ssize_t orangefs_inode_getxattr(struct inode *inode, |
f7ab093f MM |
558 | const char *prefix, |
559 | const char *name, | |
560 | void *buffer, | |
561 | size_t size); | |
562 | ||
8bb8aefd | 563 | int orangefs_inode_setxattr(struct inode *inode, |
f7ab093f MM |
564 | const char *prefix, |
565 | const char *name, | |
566 | const void *value, | |
567 | size_t size, | |
568 | int flags); | |
569 | ||
8bb8aefd | 570 | int orangefs_inode_getattr(struct inode *inode, __u32 mask); |
f7ab093f | 571 | |
8bb8aefd | 572 | int orangefs_inode_setattr(struct inode *inode, struct iattr *iattr); |
f7ab093f | 573 | |
8bb8aefd | 574 | void orangefs_op_initialize(struct orangefs_kernel_op_s *op); |
f7ab093f | 575 | |
8bb8aefd | 576 | void orangefs_make_bad_inode(struct inode *inode); |
f7ab093f | 577 | |
c146c0b8 | 578 | void orangefs_block_signals(sigset_t *); |
f7ab093f | 579 | |
c146c0b8 | 580 | void orangefs_set_signals(sigset_t *); |
f7ab093f | 581 | |
8bb8aefd | 582 | int orangefs_unmount_sb(struct super_block *sb); |
f7ab093f | 583 | |
8bb8aefd | 584 | int orangefs_cancel_op_in_progress(__u64 tag); |
f7ab093f | 585 | |
8bb8aefd | 586 | static inline __u64 orangefs_convert_time_field(const struct timespec *ts) |
5714156b AV |
587 | { |
588 | return (__u64)ts->tv_sec; | |
589 | } | |
f7ab093f | 590 | |
8bb8aefd | 591 | int orangefs_normalize_to_errno(__s32 error_code); |
f7ab093f MM |
592 | |
593 | extern struct mutex devreq_mutex; | |
594 | extern struct mutex request_mutex; | |
595 | extern int debug; | |
596 | extern int op_timeout_secs; | |
597 | extern int slot_timeout_secs; | |
8bb8aefd YL |
598 | extern struct list_head orangefs_superblocks; |
599 | extern spinlock_t orangefs_superblocks_lock; | |
600 | extern struct list_head orangefs_request_list; | |
601 | extern spinlock_t orangefs_request_list_lock; | |
602 | extern wait_queue_head_t orangefs_request_list_waitq; | |
f7ab093f MM |
603 | extern struct list_head *htable_ops_in_progress; |
604 | extern spinlock_t htable_ops_in_progress_lock; | |
605 | extern int hash_table_size; | |
606 | ||
8bb8aefd YL |
607 | extern const struct address_space_operations orangefs_address_operations; |
608 | extern struct backing_dev_info orangefs_backing_dev_info; | |
609 | extern struct inode_operations orangefs_file_inode_operations; | |
610 | extern const struct file_operations orangefs_file_operations; | |
611 | extern struct inode_operations orangefs_symlink_inode_operations; | |
612 | extern struct inode_operations orangefs_dir_inode_operations; | |
613 | extern const struct file_operations orangefs_dir_operations; | |
614 | extern const struct dentry_operations orangefs_dentry_operations; | |
615 | extern const struct file_operations orangefs_devreq_file_operations; | |
f7ab093f | 616 | |
8bb8aefd | 617 | extern wait_queue_head_t orangefs_bufmap_init_waitq; |
f7ab093f MM |
618 | |
619 | /* | |
620 | * misc convenience macros | |
621 | */ | |
622 | #define add_op_to_request_list(op) \ | |
623 | do { \ | |
8bb8aefd | 624 | spin_lock(&orangefs_request_list_lock); \ |
f7ab093f MM |
625 | spin_lock(&op->lock); \ |
626 | set_op_state_waiting(op); \ | |
8bb8aefd YL |
627 | list_add_tail(&op->list, &orangefs_request_list); \ |
628 | spin_unlock(&orangefs_request_list_lock); \ | |
f7ab093f | 629 | spin_unlock(&op->lock); \ |
8bb8aefd | 630 | wake_up_interruptible(&orangefs_request_list_waitq); \ |
f7ab093f MM |
631 | } while (0) |
632 | ||
633 | #define add_priority_op_to_request_list(op) \ | |
634 | do { \ | |
8bb8aefd | 635 | spin_lock(&orangefs_request_list_lock); \ |
f7ab093f MM |
636 | spin_lock(&op->lock); \ |
637 | set_op_state_waiting(op); \ | |
638 | \ | |
8bb8aefd YL |
639 | list_add(&op->list, &orangefs_request_list); \ |
640 | spin_unlock(&orangefs_request_list_lock); \ | |
f7ab093f | 641 | spin_unlock(&op->lock); \ |
8bb8aefd | 642 | wake_up_interruptible(&orangefs_request_list_waitq); \ |
f7ab093f MM |
643 | } while (0) |
644 | ||
645 | #define remove_op_from_request_list(op) \ | |
646 | do { \ | |
647 | struct list_head *tmp = NULL; \ | |
648 | struct list_head *tmp_safe = NULL; \ | |
8bb8aefd | 649 | struct orangefs_kernel_op_s *tmp_op = NULL; \ |
f7ab093f | 650 | \ |
8bb8aefd YL |
651 | spin_lock(&orangefs_request_list_lock); \ |
652 | list_for_each_safe(tmp, tmp_safe, &orangefs_request_list) { \ | |
f7ab093f | 653 | tmp_op = list_entry(tmp, \ |
8bb8aefd | 654 | struct orangefs_kernel_op_s, \ |
f7ab093f MM |
655 | list); \ |
656 | if (tmp_op && (tmp_op == op)) { \ | |
657 | list_del(&tmp_op->list); \ | |
658 | break; \ | |
659 | } \ | |
660 | } \ | |
8bb8aefd | 661 | spin_unlock(&orangefs_request_list_lock); \ |
f7ab093f MM |
662 | } while (0) |
663 | ||
8bb8aefd YL |
664 | #define ORANGEFS_OP_INTERRUPTIBLE 1 /* service_operation() is interruptible */ |
665 | #define ORANGEFS_OP_PRIORITY 2 /* service_operation() is high priority */ | |
666 | #define ORANGEFS_OP_CANCELLATION 4 /* this is a cancellation */ | |
667 | #define ORANGEFS_OP_NO_SEMAPHORE 8 /* don't acquire semaphore */ | |
668 | #define ORANGEFS_OP_ASYNC 16 /* Queue it, but don't wait */ | |
f7ab093f | 669 | |
8bb8aefd | 670 | int service_operation(struct orangefs_kernel_op_s *op, |
f7ab093f MM |
671 | const char *op_name, |
672 | int flags); | |
673 | ||
674 | /* | |
675 | * handles two possible error cases, depending on context. | |
676 | * | |
677 | * by design, our vfs i/o errors need to be handled in one of two ways, | |
678 | * depending on where the error occured. | |
679 | * | |
680 | * if the error happens in the waitqueue code because we either timed | |
681 | * out or a signal was raised while waiting, we need to cancel the | |
682 | * userspace i/o operation and free the op manually. this is done to | |
683 | * avoid having the device start writing application data to our shared | |
684 | * bufmap pages without us expecting it. | |
685 | * | |
686 | * FIXME: POSSIBLE OPTIMIZATION: | |
687 | * However, if we timed out or if we got a signal AND our upcall was never | |
688 | * picked off the queue (i.e. we were in OP_VFS_STATE_WAITING), then we don't | |
689 | * need to send a cancellation upcall. The way we can handle this is | |
690 | * set error_exit to 2 in such cases and 1 whenever cancellation has to be | |
691 | * sent and have handle_error | |
692 | * take care of this situation as well.. | |
693 | * | |
8bb8aefd | 694 | * if a orangefs sysint level error occured and i/o has been completed, |
f7ab093f MM |
695 | * there is no need to cancel the operation, as the user has finished |
696 | * using the bufmap page and so there is no danger in this case. in | |
697 | * this case, we wake up the device normally so that it may free the | |
698 | * op, as normal. | |
699 | * | |
700 | * note the only reason this is a macro is because both read and write | |
701 | * cases need the exact same handling code. | |
702 | */ | |
703 | #define handle_io_error() \ | |
704 | do { \ | |
705 | if (!op_state_serviced(new_op)) { \ | |
8bb8aefd | 706 | orangefs_cancel_op_in_progress(new_op->tag); \ |
f7ab093f MM |
707 | op_release(new_op); \ |
708 | } else { \ | |
709 | wake_up_daemon_for_return(new_op); \ | |
710 | } \ | |
711 | new_op = NULL; \ | |
8bb8aefd | 712 | orangefs_bufmap_put(bufmap, buffer_index); \ |
f7ab093f MM |
713 | buffer_index = -1; \ |
714 | } while (0) | |
715 | ||
716 | #define get_interruptible_flag(inode) \ | |
8bb8aefd YL |
717 | ((ORANGEFS_SB(inode->i_sb)->flags & ORANGEFS_OPT_INTR) ? \ |
718 | ORANGEFS_OP_INTERRUPTIBLE : 0) | |
f7ab093f | 719 | |
8bb8aefd | 720 | #define add_orangefs_sb(sb) \ |
f7ab093f MM |
721 | do { \ |
722 | gossip_debug(GOSSIP_SUPER_DEBUG, \ | |
8bb8aefd YL |
723 | "Adding SB %p to orangefs superblocks\n", \ |
724 | ORANGEFS_SB(sb)); \ | |
725 | spin_lock(&orangefs_superblocks_lock); \ | |
726 | list_add_tail(&ORANGEFS_SB(sb)->list, &orangefs_superblocks); \ | |
727 | spin_unlock(&orangefs_superblocks_lock); \ | |
f7ab093f MM |
728 | } while (0) |
729 | ||
8bb8aefd | 730 | #define remove_orangefs_sb(sb) \ |
f7ab093f MM |
731 | do { \ |
732 | struct list_head *tmp = NULL; \ | |
733 | struct list_head *tmp_safe = NULL; \ | |
8bb8aefd | 734 | struct orangefs_sb_info_s *orangefs_sb = NULL; \ |
f7ab093f | 735 | \ |
8bb8aefd YL |
736 | spin_lock(&orangefs_superblocks_lock); \ |
737 | list_for_each_safe(tmp, tmp_safe, &orangefs_superblocks) { \ | |
738 | orangefs_sb = list_entry(tmp, \ | |
739 | struct orangefs_sb_info_s, \ | |
f7ab093f | 740 | list); \ |
8bb8aefd | 741 | if (orangefs_sb && (orangefs_sb->sb == sb)) { \ |
f7ab093f | 742 | gossip_debug(GOSSIP_SUPER_DEBUG, \ |
8bb8aefd YL |
743 | "Removing SB %p from orangefs superblocks\n", \ |
744 | orangefs_sb); \ | |
745 | list_del(&orangefs_sb->list); \ | |
f7ab093f MM |
746 | break; \ |
747 | } \ | |
748 | } \ | |
8bb8aefd | 749 | spin_unlock(&orangefs_superblocks_lock); \ |
f7ab093f MM |
750 | } while (0) |
751 | ||
8bb8aefd YL |
752 | #define orangefs_lock_inode(inode) spin_lock(&inode->i_lock) |
753 | #define orangefs_unlock_inode(inode) spin_unlock(&inode->i_lock) | |
f7ab093f MM |
754 | |
755 | #define fill_default_sys_attrs(sys_attr, type, mode) \ | |
756 | do { \ | |
757 | sys_attr.owner = from_kuid(current_user_ns(), current_fsuid()); \ | |
758 | sys_attr.group = from_kgid(current_user_ns(), current_fsgid()); \ | |
759 | sys_attr.size = 0; \ | |
8bb8aefd | 760 | sys_attr.perms = ORANGEFS_util_translate_mode(mode); \ |
f7ab093f | 761 | sys_attr.objtype = type; \ |
8bb8aefd | 762 | sys_attr.mask = ORANGEFS_ATTR_SYS_ALL_SETABLE; \ |
f7ab093f MM |
763 | } while (0) |
764 | ||
8bb8aefd | 765 | #define orangefs_inode_lock(__i) mutex_lock(&(__i)->i_mutex) |
f7ab093f | 766 | |
8bb8aefd | 767 | #define orangefs_inode_unlock(__i) mutex_unlock(&(__i)->i_mutex) |
f7ab093f | 768 | |
8bb8aefd | 769 | static inline void orangefs_i_size_write(struct inode *inode, loff_t i_size) |
f7ab093f MM |
770 | { |
771 | #if BITS_PER_LONG == 32 && defined(CONFIG_SMP) | |
eb57bcc2 | 772 | orangefs_inode_lock(inode); |
f7ab093f MM |
773 | #endif |
774 | i_size_write(inode, i_size); | |
775 | #if BITS_PER_LONG == 32 && defined(CONFIG_SMP) | |
8bb8aefd | 776 | orangefs_inode_unlock(inode); |
f7ab093f MM |
777 | #endif |
778 | } | |
779 | ||
780 | static inline unsigned int diff(struct timeval *end, struct timeval *begin) | |
781 | { | |
782 | if (end->tv_usec < begin->tv_usec) { | |
783 | end->tv_usec += 1000000; | |
784 | end->tv_sec--; | |
785 | } | |
786 | end->tv_sec -= begin->tv_sec; | |
787 | end->tv_usec -= begin->tv_usec; | |
788 | return (end->tv_sec * 1000000) + end->tv_usec; | |
789 | } | |
790 | ||
8bb8aefd | 791 | #endif /* __ORANGEFSKERNEL_H */ |