fs/orangefs/orangefs-kernel.h

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