fs/orangefs/pvfs2-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 PVFS2 Linux kernel support allows PVFS2 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 PVFS2 Linux kernel support.
  16  */
  17
  18 #ifndef __PVFS2KERNEL_H
  19 #define __PVFS2KERNEL_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 "pvfs2-dev-proto.h"
  57
  58 #ifdef PVFS2_KERNEL_DEBUG
  59 #define PVFS2_DEFAULT_OP_TIMEOUT_SECS       10
  60 #else
  61 #define PVFS2_DEFAULT_OP_TIMEOUT_SECS       20
  62 #endif
  63
  64 #define PVFS2_BUFMAP_WAIT_TIMEOUT_SECS      30
  65
  66 #define PVFS2_DEFAULT_SLOT_TIMEOUT_SECS     900 /* 15 minutes */
  67
  68 #define PVFS2_REQDEVICE_NAME          "pvfs2-req"
  69
  70 #define PVFS2_DEVREQ_MAGIC             0x20030529
  71 #define PVFS2_LINK_MAX                 0x000000FF
  72 #define PVFS2_PURGE_RETRY_COUNT        0x00000005
  73 #define PVFS2_SEEK_END                 0x00000002
  74 #define PVFS2_MAX_NUM_OPTIONS          0x00000004
  75 #define PVFS2_MAX_MOUNT_OPT_LEN        0x00000080
  76 #define PVFS2_MAX_FSKEY_LEN            64
  77
  78 #define MAX_DEV_REQ_UPSIZE (2*sizeof(__s32) +   \
  79 sizeof(__u64) + sizeof(struct pvfs2_upcall_s))
  80 #define MAX_DEV_REQ_DOWNSIZE (2*sizeof(__s32) + \
  81 sizeof(__u64) + sizeof(struct pvfs2_downcall_s))
  82
  83 #define BITS_PER_LONG_DIV_8 (BITS_PER_LONG >> 3)
  84
  85 /* borrowed from irda.h */
  86 #ifndef MSECS_TO_JIFFIES
  87 #define MSECS_TO_JIFFIES(ms) (((ms)*HZ+999)/1000)
  88 #endif
  89
  90 #define MAX_ALIGNED_DEV_REQ_UPSIZE                              \
  91                 (MAX_DEV_REQ_UPSIZE +                           \
  92                         ((((MAX_DEV_REQ_UPSIZE /                \
  93                                 (BITS_PER_LONG_DIV_8)) *        \
  94                                 (BITS_PER_LONG_DIV_8)) +        \
  95                             (BITS_PER_LONG_DIV_8)) -            \
  96                         MAX_DEV_REQ_UPSIZE))
  97
  98 #define MAX_ALIGNED_DEV_REQ_DOWNSIZE                            \
  99                 (MAX_DEV_REQ_DOWNSIZE +                         \
 100                         ((((MAX_DEV_REQ_DOWNSIZE /              \
 101                                 (BITS_PER_LONG_DIV_8)) *        \
 102                                 (BITS_PER_LONG_DIV_8)) +        \
 103                             (BITS_PER_LONG_DIV_8)) -            \
 104                         MAX_DEV_REQ_DOWNSIZE))
 105
 106 /*
 107  * valid pvfs2 kernel operation states
 108  *
 109  * unknown  - op was just initialized
 110  * waiting  - op is on request_list (upward bound)
 111  * inprogr  - op is in progress (waiting for downcall)
 112  * serviced - op has matching downcall; ok
 113  * purged   - op has to start a timer since client-core
 114  *            exited uncleanly before servicing op
 115  */
 116 enum pvfs2_vfs_op_states {
 117         OP_VFS_STATE_UNKNOWN = 0,
 118         OP_VFS_STATE_WAITING = 1,
 119         OP_VFS_STATE_INPROGR = 2,
 120         OP_VFS_STATE_SERVICED = 4,
 121         OP_VFS_STATE_PURGED = 8,
 122 };
 123
 124 #define set_op_state_waiting(op)     ((op)->op_state = OP_VFS_STATE_WAITING)
 125 #define set_op_state_inprogress(op)  ((op)->op_state = OP_VFS_STATE_INPROGR)
 126 #define set_op_state_serviced(op)    ((op)->op_state = OP_VFS_STATE_SERVICED)
 127 #define set_op_state_purged(op)      ((op)->op_state |= OP_VFS_STATE_PURGED)
 128
 129 #define op_state_waiting(op)     ((op)->op_state & OP_VFS_STATE_WAITING)
 130 #define op_state_in_progress(op) ((op)->op_state & OP_VFS_STATE_INPROGR)
 131 #define op_state_serviced(op)    ((op)->op_state & OP_VFS_STATE_SERVICED)
 132 #define op_state_purged(op)      ((op)->op_state & OP_VFS_STATE_PURGED)
 133
 134 #define get_op(op)                                      \
 135         do {                                            \
 136                 atomic_inc(&(op)->aio_ref_count);       \
 137                 gossip_debug(GOSSIP_DEV_DEBUG,  \
 138                         "(get) Alloced OP (%p:%llu)\n", \
 139                         op,                             \
 140                         llu((op)->tag));                \
 141         } while (0)
 142
 143 #define put_op(op)                                                      \
 144         do {                                                            \
 145                 if (atomic_sub_and_test(1, &(op)->aio_ref_count) == 1) {  \
 146                         gossip_debug(GOSSIP_DEV_DEBUG,          \
 147                                 "(put) Releasing OP (%p:%llu)\n",       \
 148                                 op,                                     \
 149                                 llu((op)->tag));                        \
 150                         op_release(op);                                 \
 151                         }                                               \
 152         } while (0)
 153
 154 #define op_wait(op) (atomic_read(&(op)->aio_ref_count) <= 2 ? 0 : 1)
 155
 156 /*
 157  * Defines for controlling whether I/O upcalls are for async or sync operations
 158  */
 159 enum PVFS_async_io_type {
 160         PVFS_VFS_SYNC_IO = 0,
 161         PVFS_VFS_ASYNC_IO = 1,
 162 };
 163
 164 /*
 165  * An array of client_debug_mask will be built to hold debug keyword/mask
 166  * values fetched from userspace.
 167  */
 168 struct client_debug_mask {
 169         char *keyword;
 170         __u64 mask1;
 171         __u64 mask2;
 172 };
 173
 174 /*
 175  * pvfs2 kernel memory related flags
 176  */
 177
 178 #if ((defined PVFS2_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB))
 179 #define PVFS2_CACHE_CREATE_FLAGS SLAB_RED_ZONE
 180 #else
 181 #define PVFS2_CACHE_CREATE_FLAGS 0
 182 #endif /* ((defined PVFS2_KERNEL_DEBUG) && (defined CONFIG_DEBUG_SLAB)) */
 183
 184 #define PVFS2_CACHE_ALLOC_FLAGS (GFP_KERNEL)
 185 #define PVFS2_GFP_FLAGS (GFP_KERNEL)
 186 #define PVFS2_BUFMAP_GFP_FLAGS (GFP_KERNEL)
 187
 188 #define pvfs2_kmap(page) kmap(page)
 189 #define pvfs2_kunmap(page) kunmap(page)
 190
 191 /* pvfs2 xattr and acl related defines */
 192 #define PVFS2_XATTR_INDEX_POSIX_ACL_ACCESS  1
 193 #define PVFS2_XATTR_INDEX_POSIX_ACL_DEFAULT 2
 194 #define PVFS2_XATTR_INDEX_TRUSTED           3
 195 #define PVFS2_XATTR_INDEX_DEFAULT           4
 196
 197 #if 0
 198 #ifndef POSIX_ACL_XATTR_ACCESS
 199 #define POSIX_ACL_XATTR_ACCESS  "system.posix_acl_access"
 200 #endif
 201 #ifndef POSIX_ACL_XATTR_DEFAULT
 202 #define POSIX_ACL_XATTR_DEFAULT "system.posix_acl_default"
 203 #endif
 204 #endif
 205
 206 #define PVFS2_XATTR_NAME_ACL_ACCESS  POSIX_ACL_XATTR_ACCESS
 207 #define PVFS2_XATTR_NAME_ACL_DEFAULT POSIX_ACL_XATTR_DEFAULT
 208 #define PVFS2_XATTR_NAME_TRUSTED_PREFIX "trusted."
 209 #define PVFS2_XATTR_NAME_DEFAULT_PREFIX ""
 210
 211 /* these functions are defined in pvfs2-utils.c */
 212 int orangefs_prepare_cdm_array(char *debug_array_string);
 213 int orangefs_prepare_debugfs_help_string(int);
 214
 215 /* defined in pvfs2-debugfs.c */
 216 int pvfs2_client_debug_init(void);
 217
 218 void debug_string_to_mask(char *, void *, int);
 219 void do_c_mask(int, char *, struct client_debug_mask **);
 220 void do_k_mask(int, char *, __u64 **);
 221
 222 void debug_mask_to_string(void *, int);
 223 void do_k_string(void *, int);
 224 void do_c_string(void *, int);
 225 int check_amalgam_keyword(void *, int);
 226 int keyword_is_amalgam(char *);
 227
 228 /*these variables are defined in pvfs2-mod.c */
 229 extern char kernel_debug_string[PVFS2_MAX_DEBUG_STRING_LEN];
 230 extern char client_debug_string[PVFS2_MAX_DEBUG_STRING_LEN];
 231 extern char client_debug_array_string[PVFS2_MAX_DEBUG_STRING_LEN];
 232 extern unsigned int kernel_mask_set_mod_init;
 233
 234 extern int pvfs2_init_acl(struct inode *inode, struct inode *dir);
 235 extern const struct xattr_handler *pvfs2_xattr_handlers[];
 236
 237 extern struct posix_acl *pvfs2_get_acl(struct inode *inode, int type);
 238 extern int pvfs2_set_acl(struct inode *inode, struct posix_acl *acl, int type);
 239
 240 int pvfs2_xattr_set_default(struct dentry *dentry,
 241                             const char *name,
 242                             const void *buffer,
 243                             size_t size,
 244                             int flags,
 245                             int handler_flags);
 246
 247 int pvfs2_xattr_get_default(struct dentry *dentry,
 248                             const char *name,
 249                             void *buffer,
 250                             size_t size,
 251                             int handler_flags);
 252
 253 /*
 254  * Redefine xtvec structure so that we could move helper functions out of
 255  * the define
 256  */
 257 struct xtvec {
 258         __kernel_off_t xtv_off;         /* must be off_t */
 259         __kernel_size_t xtv_len;        /* must be size_t */
 260 };
 261
 262 /*
 263  * pvfs2 data structures
 264  */
 265 struct pvfs2_kernel_op_s {
 266         enum pvfs2_vfs_op_states op_state;
 267         __u64 tag;
 268
 269         /*
 270          * Set uses_shared_memory to 1 if this operation uses shared memory.
 271          * If true, then a retry on the op must also get a new shared memory
 272          * buffer and re-populate it.
 273          */
 274         int uses_shared_memory;
 275
 276         struct pvfs2_upcall_s upcall;
 277         struct pvfs2_downcall_s downcall;
 278
 279         wait_queue_head_t waitq;
 280         spinlock_t lock;
 281
 282         int io_completed;
 283         wait_queue_head_t io_completion_waitq;
 284
 285         /*
 286          * upcalls requiring variable length trailers require that this struct
 287          * be in the request list even after client-core does a read() on the
 288          * device to dequeue the upcall.
 289          * if op_linger field goes to 0, we dequeue this op off the list.
 290          * else we let it stay. What gets passed to the read() is
 291          * a) if op_linger field is = 1, pvfs2_kernel_op_s itself
 292          * b) else if = 0, we pass ->upcall.trailer_buf
 293          * We expect to have only a single upcall trailer buffer,
 294          * so we expect callers with trailers
 295          * to set this field to 2 and others to set it to 1.
 296          */
 297         __s32 op_linger, op_linger_tmp;
 298         /* VFS aio fields */
 299
 300         /* used by the async I/O code to stash the pvfs2_kiocb_s structure */
 301         void *priv;
 302
 303         /* used again for the async I/O code for deallocation */
 304         atomic_t aio_ref_count;
 305
 306         int attempts;
 307
 308         struct list_head list;
 309 };
 310
 311 /* per inode private pvfs2 info */
 312 struct pvfs2_inode_s {
 313         struct pvfs2_object_kref refn;
 314         char link_target[PVFS_NAME_MAX];
 315         __s64 blksize;
 316         /*
 317          * Reading/Writing Extended attributes need to acquire the appropriate
 318          * reader/writer semaphore on the pvfs2_inode_s structure.
 319          */
 320         struct rw_semaphore xattr_sem;
 321
 322         struct inode vfs_inode;
 323         sector_t last_failed_block_index_read;
 324
 325         /*
 326          * State of in-memory attributes not yet flushed to disk associated
 327          * with this object
 328          */
 329         unsigned long pinode_flags;
 330
 331         /* All allocated pvfs2_inode_s objects are chained to a list */
 332         struct list_head list;
 333 };
 334
 335 #define P_ATIME_FLAG 0
 336 #define P_MTIME_FLAG 1
 337 #define P_CTIME_FLAG 2
 338 #define P_MODE_FLAG  3
 339
 340 #define ClearAtimeFlag(pinode) clear_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
 341 #define SetAtimeFlag(pinode)   set_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
 342 #define AtimeFlag(pinode)      test_bit(P_ATIME_FLAG, &(pinode)->pinode_flags)
 343
 344 #define ClearMtimeFlag(pinode) clear_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
 345 #define SetMtimeFlag(pinode)   set_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
 346 #define MtimeFlag(pinode)      test_bit(P_MTIME_FLAG, &(pinode)->pinode_flags)
 347
 348 #define ClearCtimeFlag(pinode) clear_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
 349 #define SetCtimeFlag(pinode)   set_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
 350 #define CtimeFlag(pinode)      test_bit(P_CTIME_FLAG, &(pinode)->pinode_flags)
 351
 352 #define ClearModeFlag(pinode) clear_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
 353 #define SetModeFlag(pinode)   set_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
 354 #define ModeFlag(pinode)      test_bit(P_MODE_FLAG, &(pinode)->pinode_flags)
 355
 356 /* per superblock private pvfs2 info */
 357 struct pvfs2_sb_info_s {
 358         struct pvfs2_khandle root_khandle;
 359         __s32 fs_id;
 360         int id;
 361         int flags;
 362 #define PVFS2_OPT_INTR          0x01
 363 #define PVFS2_OPT_LOCAL_LOCK    0x02
 364         char devname[PVFS_MAX_SERVER_ADDR_LEN];
 365         struct super_block *sb;
 366         int mount_pending;
 367         struct list_head list;
 368 };
 369
 370 /*
 371  * a temporary structure used only for sb mount time that groups the
 372  * mount time data provided along with a private superblock structure
 373  * that is allocated before a 'kernel' superblock is allocated.
 374 */
 375 struct pvfs2_mount_sb_info_s {
 376         void *data;
 377         struct pvfs2_khandle root_khandle;
 378         __s32 fs_id;
 379         int id;
 380 };
 381
 382 /*
 383  * structure that holds the state of any async I/O operation issued
 384  * through the VFS. Needed especially to handle cancellation requests
 385  * or even completion notification so that the VFS client-side daemon
 386  * can free up its vfs_request slots.
 387  */
 388 struct pvfs2_kiocb_s {
 389         /* the pointer to the task that initiated the AIO */
 390         struct task_struct *tsk;
 391
 392         /* pointer to the kiocb that kicked this operation */
 393         struct kiocb *kiocb;
 394
 395         /* buffer index that was used for the I/O */
 396         struct pvfs2_bufmap *bufmap;
 397         int buffer_index;
 398
 399         /* pvfs2 kernel operation type */
 400         struct pvfs2_kernel_op_s *op;
 401
 402         /* The user space buffers from/to which I/O is being staged */
 403         struct iovec *iov;
 404
 405         /* number of elements in the iovector */
 406         unsigned long nr_segs;
 407
 408         /* set to indicate the type of the operation */
 409         int rw;
 410
 411         /* file offset */
 412         loff_t offset;
 413
 414         /* and the count in bytes */
 415         size_t bytes_to_be_copied;
 416
 417         ssize_t bytes_copied;
 418         int needs_cleanup;
 419 };
 420
 421 struct pvfs2_stats {
 422         unsigned long cache_hits;
 423         unsigned long cache_misses;
 424         unsigned long reads;
 425         unsigned long writes;
 426 };
 427
 428 extern struct pvfs2_stats g_pvfs2_stats;
 429
 430 /*
 431  * NOTE: See Documentation/filesystems/porting for information
 432  * on implementing FOO_I and properly accessing fs private data
 433  */
 434 static inline struct pvfs2_inode_s *PVFS2_I(struct inode *inode)
 435 {
 436         return container_of(inode, struct pvfs2_inode_s, vfs_inode);
 437 }
 438
 439 static inline struct pvfs2_sb_info_s *PVFS2_SB(struct super_block *sb)
 440 {
 441         return (struct pvfs2_sb_info_s *) sb->s_fs_info;
 442 }
 443
 444 /* ino_t descends from "unsigned long", 8 bytes, 64 bits. */
 445 static inline ino_t pvfs2_khandle_to_ino(struct pvfs2_khandle *khandle)
 446 {
 447         union {
 448                 unsigned char u[8];
 449                 __u64 ino;
 450         } ihandle;
 451
 452         ihandle.u[0] = khandle->u[0] ^ khandle->u[4];
 453         ihandle.u[1] = khandle->u[1] ^ khandle->u[5];
 454         ihandle.u[2] = khandle->u[2] ^ khandle->u[6];
 455         ihandle.u[3] = khandle->u[3] ^ khandle->u[7];
 456         ihandle.u[4] = khandle->u[12] ^ khandle->u[8];
 457         ihandle.u[5] = khandle->u[13] ^ khandle->u[9];
 458         ihandle.u[6] = khandle->u[14] ^ khandle->u[10];
 459         ihandle.u[7] = khandle->u[15] ^ khandle->u[11];
 460
 461         return ihandle.ino;
 462 }
 463
 464 static inline struct pvfs2_khandle *get_khandle_from_ino(struct inode *inode)
 465 {
 466         return &(PVFS2_I(inode)->refn.khandle);
 467 }
 468
 469 static inline __s32 get_fsid_from_ino(struct inode *inode)
 470 {
 471         return PVFS2_I(inode)->refn.fs_id;
 472 }
 473
 474 static inline ino_t get_ino_from_khandle(struct inode *inode)
 475 {
 476         struct pvfs2_khandle *khandle;
 477         ino_t ino;
 478
 479         khandle = get_khandle_from_ino(inode);
 480         ino = pvfs2_khandle_to_ino(khandle);
 481         return ino;
 482 }
 483
 484 static inline ino_t get_parent_ino_from_dentry(struct dentry *dentry)
 485 {
 486         return get_ino_from_khandle(dentry->d_parent->d_inode);
 487 }
 488
 489 static inline int is_root_handle(struct inode *inode)
 490 {
 491         gossip_debug(GOSSIP_DCACHE_DEBUG,
 492                      "%s: root handle: %pU, this handle: %pU:\n",
 493                      __func__,
 494                      &PVFS2_SB(inode->i_sb)->root_khandle,
 495                      get_khandle_from_ino(inode));
 496
 497         if (PVFS_khandle_cmp(&(PVFS2_SB(inode->i_sb)->root_khandle),
 498                              get_khandle_from_ino(inode)))
 499                 return 0;
 500         else
 501                 return 1;
 502 }
 503
 504 static inline int match_handle(struct pvfs2_khandle resp_handle,
 505                                struct inode *inode)
 506 {
 507         gossip_debug(GOSSIP_DCACHE_DEBUG,
 508                      "%s: one handle: %pU, another handle:%pU:\n",
 509                      __func__,
 510                      &resp_handle,
 511                      get_khandle_from_ino(inode));
 512
 513         if (PVFS_khandle_cmp(&resp_handle, get_khandle_from_ino(inode)))
 514                 return 0;
 515         else
 516                 return 1;
 517 }
 518
 519 /*
 520  * defined in pvfs2-cache.c
 521  */
 522 int op_cache_initialize(void);
 523 int op_cache_finalize(void);
 524 struct pvfs2_kernel_op_s *op_alloc(__s32 type);
 525 struct pvfs2_kernel_op_s *op_alloc_trailer(__s32 type);
 526 char *get_opname_string(struct pvfs2_kernel_op_s *new_op);
 527 void op_release(struct pvfs2_kernel_op_s *op);
 528
 529 int dev_req_cache_initialize(void);
 530 int dev_req_cache_finalize(void);
 531 void *dev_req_alloc(void);
 532 void dev_req_release(void *);
 533
 534 int pvfs2_inode_cache_initialize(void);
 535 int pvfs2_inode_cache_finalize(void);
 536
 537 int kiocb_cache_initialize(void);
 538 int kiocb_cache_finalize(void);
 539 struct pvfs2_kiocb_s *kiocb_alloc(void);
 540 void kiocb_release(struct pvfs2_kiocb_s *ptr);
 541
 542 /*
 543  * defined in pvfs2-mod.c
 544  */
 545 void purge_inprogress_ops(void);
 546
 547 /*
 548  * defined in waitqueue.c
 549  */
 550 int wait_for_matching_downcall(struct pvfs2_kernel_op_s *op);
 551 int wait_for_cancellation_downcall(struct pvfs2_kernel_op_s *op);
 552 void pvfs2_clean_up_interrupted_operation(struct pvfs2_kernel_op_s *op);
 553 void purge_waiting_ops(void);
 554
 555 /*
 556  * defined in super.c
 557  */
 558 struct dentry *pvfs2_mount(struct file_system_type *fst,
 559                            int flags,
 560                            const char *devname,
 561                            void *data);
 562
 563 void pvfs2_kill_sb(struct super_block *sb);
 564 int pvfs2_remount(struct super_block *sb);
 565
 566 int fsid_key_table_initialize(void);
 567 void fsid_key_table_finalize(void);
 568
 569 /*
 570  * defined in inode.c
 571  */
 572 __u32 convert_to_pvfs2_mask(unsigned long lite_mask);
 573 struct inode *pvfs2_new_inode(struct super_block *sb,
 574                               struct inode *dir,
 575                               int mode,
 576                               dev_t dev,
 577                               struct pvfs2_object_kref *ref);
 578
 579 int pvfs2_setattr(struct dentry *dentry, struct iattr *iattr);
 580
 581 int pvfs2_getattr(struct vfsmount *mnt,
 582                   struct dentry *dentry,
 583                   struct kstat *kstat);
 584
 585 /*
 586  * defined in xattr.c
 587  */
 588 int pvfs2_setxattr(struct dentry *dentry,
 589                    const char *name,
 590                    const void *value,
 591                    size_t size,
 592                    int flags);
 593
 594 ssize_t pvfs2_getxattr(struct dentry *dentry,
 595                        const char *name,
 596                        void *buffer,
 597                        size_t size);
 598
 599 ssize_t pvfs2_listxattr(struct dentry *dentry, char *buffer, size_t size);
 600
 601 /*
 602  * defined in namei.c
 603  */
 604 struct inode *pvfs2_iget(struct super_block *sb,
 605                          struct pvfs2_object_kref *ref);
 606
 607 ssize_t pvfs2_inode_read(struct inode *inode,
 608                          char __user *buf,
 609                          size_t count,
 610                          loff_t *offset,
 611                          loff_t readahead_size);
 612
 613 /*
 614  * defined in devpvfs2-req.c
 615  */
 616 int pvfs2_dev_init(void);
 617 void pvfs2_dev_cleanup(void);
 618 int is_daemon_in_service(void);
 619 int fs_mount_pending(__s32 fsid);
 620
 621 /*
 622  * defined in pvfs2-utils.c
 623  */
 624 __s32 fsid_of_op(struct pvfs2_kernel_op_s *op);
 625
 626 int pvfs2_flush_inode(struct inode *inode);
 627
 628 ssize_t pvfs2_inode_getxattr(struct inode *inode,
 629                              const char *prefix,
 630                              const char *name,
 631                              void *buffer,
 632                              size_t size);
 633
 634 int pvfs2_inode_setxattr(struct inode *inode,
 635                          const char *prefix,
 636                          const char *name,
 637                          const void *value,
 638                          size_t size,
 639                          int flags);
 640
 641 int pvfs2_inode_getattr(struct inode *inode, __u32 mask);
 642
 643 int pvfs2_inode_setattr(struct inode *inode, struct iattr *iattr);
 644
 645 void pvfs2_op_initialize(struct pvfs2_kernel_op_s *op);
 646
 647 void pvfs2_make_bad_inode(struct inode *inode);
 648
 649 void block_signals(sigset_t *);
 650
 651 void set_signals(sigset_t *);
 652
 653 int pvfs2_unmount_sb(struct super_block *sb);
 654
 655 int pvfs2_cancel_op_in_progress(__u64 tag);
 656
 657 __u64 pvfs2_convert_time_field(void *time_ptr);
 658
 659 int pvfs2_normalize_to_errno(__s32 error_code);
 660
 661 extern struct mutex devreq_mutex;
 662 extern struct mutex request_mutex;
 663 extern int debug;
 664 extern int op_timeout_secs;
 665 extern int slot_timeout_secs;
 666 extern struct list_head pvfs2_superblocks;
 667 extern spinlock_t pvfs2_superblocks_lock;
 668 extern struct list_head pvfs2_request_list;
 669 extern spinlock_t pvfs2_request_list_lock;
 670 extern wait_queue_head_t pvfs2_request_list_waitq;
 671 extern struct list_head *htable_ops_in_progress;
 672 extern spinlock_t htable_ops_in_progress_lock;
 673 extern int hash_table_size;
 674
 675 extern const struct address_space_operations pvfs2_address_operations;
 676 extern struct backing_dev_info pvfs2_backing_dev_info;
 677 extern struct inode_operations pvfs2_file_inode_operations;
 678 extern const struct file_operations pvfs2_file_operations;
 679 extern struct inode_operations pvfs2_symlink_inode_operations;
 680 extern struct inode_operations pvfs2_dir_inode_operations;
 681 extern const struct file_operations pvfs2_dir_operations;
 682 extern const struct dentry_operations pvfs2_dentry_operations;
 683 extern const struct file_operations pvfs2_devreq_file_operations;
 684
 685 extern wait_queue_head_t pvfs2_bufmap_init_waitq;
 686
 687 /*
 688  * misc convenience macros
 689  */
 690 #define add_op_to_request_list(op)                              \
 691 do {                                                            \
 692         spin_lock(&pvfs2_request_list_lock);                    \
 693         spin_lock(&op->lock);                                   \
 694         set_op_state_waiting(op);                               \
 695         list_add_tail(&op->list, &pvfs2_request_list);          \
 696         spin_unlock(&pvfs2_request_list_lock);                  \
 697         spin_unlock(&op->lock);                                 \
 698         wake_up_interruptible(&pvfs2_request_list_waitq);       \
 699 } while (0)
 700
 701 #define add_priority_op_to_request_list(op)                             \
 702         do {                                                            \
 703                 spin_lock(&pvfs2_request_list_lock);                    \
 704                 spin_lock(&op->lock);                                   \
 705                 set_op_state_waiting(op);                               \
 706                                                                         \
 707                 list_add(&op->list, &pvfs2_request_list);               \
 708                 spin_unlock(&pvfs2_request_list_lock);                  \
 709                 spin_unlock(&op->lock);                                 \
 710                 wake_up_interruptible(&pvfs2_request_list_waitq);       \
 711 } while (0)
 712
 713 #define remove_op_from_request_list(op)                                 \
 714         do {                                                            \
 715                 struct list_head *tmp = NULL;                           \
 716                 struct list_head *tmp_safe = NULL;                      \
 717                 struct pvfs2_kernel_op_s *tmp_op = NULL;                \
 718                                                                         \
 719                 spin_lock(&pvfs2_request_list_lock);                    \
 720                 list_for_each_safe(tmp, tmp_safe, &pvfs2_request_list) { \
 721                         tmp_op = list_entry(tmp,                        \
 722                                             struct pvfs2_kernel_op_s,   \
 723                                             list);                      \
 724                         if (tmp_op && (tmp_op == op)) {                 \
 725                                 list_del(&tmp_op->list);                \
 726                                 break;                                  \
 727                         }                                               \
 728                 }                                                       \
 729                 spin_unlock(&pvfs2_request_list_lock);                  \
 730         } while (0)
 731
 732 #define PVFS2_OP_INTERRUPTIBLE 1   /* service_operation() is interruptible */
 733 #define PVFS2_OP_PRIORITY      2   /* service_operation() is high priority */
 734 #define PVFS2_OP_CANCELLATION  4   /* this is a cancellation */
 735 #define PVFS2_OP_NO_SEMAPHORE  8   /* don't acquire semaphore */
 736 #define PVFS2_OP_ASYNC         16  /* Queue it, but don't wait */
 737
 738 int service_operation(struct pvfs2_kernel_op_s *op,
 739                       const char *op_name,
 740                       int flags);
 741
 742 /*
 743  * handles two possible error cases, depending on context.
 744  *
 745  * by design, our vfs i/o errors need to be handled in one of two ways,
 746  * depending on where the error occured.
 747  *
 748  * if the error happens in the waitqueue code because we either timed
 749  * out or a signal was raised while waiting, we need to cancel the
 750  * userspace i/o operation and free the op manually.  this is done to
 751  * avoid having the device start writing application data to our shared
 752  * bufmap pages without us expecting it.
 753  *
 754  * FIXME: POSSIBLE OPTIMIZATION:
 755  * However, if we timed out or if we got a signal AND our upcall was never
 756  * picked off the queue (i.e. we were in OP_VFS_STATE_WAITING), then we don't
 757  * need to send a cancellation upcall. The way we can handle this is
 758  * set error_exit to 2 in such cases and 1 whenever cancellation has to be
 759  * sent and have handle_error
 760  * take care of this situation as well..
 761  *
 762  * if a pvfs2 sysint level error occured and i/o has been completed,
 763  * there is no need to cancel the operation, as the user has finished
 764  * using the bufmap page and so there is no danger in this case.  in
 765  * this case, we wake up the device normally so that it may free the
 766  * op, as normal.
 767  *
 768  * note the only reason this is a macro is because both read and write
 769  * cases need the exact same handling code.
 770  */
 771 #define handle_io_error()                                       \
 772 do {                                                            \
 773         if (!op_state_serviced(new_op)) {                       \
 774                 pvfs2_cancel_op_in_progress(new_op->tag);       \
 775                 op_release(new_op);                             \
 776         } else {                                                \
 777                 wake_up_daemon_for_return(new_op);              \
 778         }                                                       \
 779         new_op = NULL;                                          \
 780         pvfs_bufmap_put(bufmap, buffer_index);                          \
 781         buffer_index = -1;                                      \
 782 } while (0)
 783
 784 #define get_interruptible_flag(inode) \
 785         ((PVFS2_SB(inode->i_sb)->flags & PVFS2_OPT_INTR) ? \
 786                 PVFS2_OP_INTERRUPTIBLE : 0)
 787
 788 #define add_pvfs2_sb(sb)                                                \
 789 do {                                                                    \
 790         gossip_debug(GOSSIP_SUPER_DEBUG,                                \
 791                      "Adding SB %p to pvfs2 superblocks\n",             \
 792                      PVFS2_SB(sb));                                     \
 793         spin_lock(&pvfs2_superblocks_lock);                             \
 794         list_add_tail(&PVFS2_SB(sb)->list, &pvfs2_superblocks);         \
 795         spin_unlock(&pvfs2_superblocks_lock); \
 796 } while (0)
 797
 798 #define remove_pvfs2_sb(sb)                                             \
 799 do {                                                                    \
 800         struct list_head *tmp = NULL;                                   \
 801         struct list_head *tmp_safe = NULL;                              \
 802         struct pvfs2_sb_info_s *pvfs2_sb = NULL;                        \
 803                                                                         \
 804         spin_lock(&pvfs2_superblocks_lock);                             \
 805         list_for_each_safe(tmp, tmp_safe, &pvfs2_superblocks) {         \
 806                 pvfs2_sb = list_entry(tmp,                              \
 807                                       struct pvfs2_sb_info_s,           \
 808                                       list);                            \
 809                 if (pvfs2_sb && (pvfs2_sb->sb == sb)) {                 \
 810                         gossip_debug(GOSSIP_SUPER_DEBUG,                \
 811                             "Removing SB %p from pvfs2 superblocks\n",  \
 812                         pvfs2_sb);                                      \
 813                         list_del(&pvfs2_sb->list);                      \
 814                         break;                                          \
 815                 }                                                       \
 816         }                                                               \
 817         spin_unlock(&pvfs2_superblocks_lock);                           \
 818 } while (0)
 819
 820 #define pvfs2_lock_inode(inode) spin_lock(&inode->i_lock)
 821 #define pvfs2_unlock_inode(inode) spin_unlock(&inode->i_lock)
 822 #define pvfs2_current_signal_lock current->sighand->siglock
 823 #define pvfs2_current_sigaction current->sighand->action
 824
 825 #define fill_default_sys_attrs(sys_attr, type, mode)                    \
 826 do {                                                                    \
 827         sys_attr.owner = from_kuid(current_user_ns(), current_fsuid()); \
 828         sys_attr.group = from_kgid(current_user_ns(), current_fsgid()); \
 829         sys_attr.size = 0;                                              \
 830         sys_attr.perms = PVFS_util_translate_mode(mode);                \
 831         sys_attr.objtype = type;                                        \
 832         sys_attr.mask = PVFS_ATTR_SYS_ALL_SETABLE;                      \
 833 } while (0)
 834
 835 #define pvfs2_inode_lock(__i)  mutex_lock(&(__i)->i_mutex)
 836
 837 #define pvfs2_inode_unlock(__i) mutex_unlock(&(__i)->i_mutex)
 838
 839 static inline void pvfs2_i_size_write(struct inode *inode, loff_t i_size)
 840 {
 841 #if BITS_PER_LONG == 32 && defined(CONFIG_SMP)
 842         pvfs2_inode_lock(inode);
 843 #endif
 844         i_size_write(inode, i_size);
 845 #if BITS_PER_LONG == 32 && defined(CONFIG_SMP)
 846         pvfs2_inode_unlock(inode);
 847 #endif
 848 }
 849
 850 static inline unsigned int diff(struct timeval *end, struct timeval *begin)
 851 {
 852         if (end->tv_usec < begin->tv_usec) {
 853                 end->tv_usec += 1000000;
 854                 end->tv_sec--;
 855         }
 856         end->tv_sec -= begin->tv_sec;
 857         end->tv_usec -= begin->tv_usec;
 858         return (end->tv_sec * 1000000) + end->tv_usec;
 859 }
 860
 861 #endif /* __PVFS2KERNEL_H */