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