fs/afs/internal.h

   1 /* internal AFS stuff
   2  *
   3  * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <linux/compiler.h>
  13 #include <linux/kernel.h>
  14 #include <linux/fs.h>
  15 #include <linux/pagemap.h>
  16 #include <linux/skbuff.h>
  17 #include <linux/rxrpc.h>
  18 #include <linux/key.h>
  19 #include "afs.h"
  20 #include "afs_vl.h"
  21
  22 #define AFS_CELL_MAX_ADDRS 15
  23
  24 struct afs_call;
  25
  26 typedef enum {
  27         AFS_VL_NEW,                     /* new, uninitialised record */
  28         AFS_VL_CREATING,                /* creating record */
  29         AFS_VL_VALID,                   /* record is pending */
  30         AFS_VL_NO_VOLUME,               /* no such volume available */
  31         AFS_VL_UPDATING,                /* update in progress */
  32         AFS_VL_VOLUME_DELETED,          /* volume was deleted */
  33         AFS_VL_UNCERTAIN,               /* uncertain state (update failed) */
  34 } __attribute__((packed)) afs_vlocation_state_t;
  35
  36 struct afs_mount_params {
  37         bool                    rwpath;         /* T if the parent should be considered R/W */
  38         bool                    force;          /* T to force cell type */
  39         afs_voltype_t           type;           /* type of volume requested */
  40         int                     volnamesz;      /* size of volume name */
  41         const char              *volname;       /* name of volume to mount */
  42         struct afs_cell         *cell;          /* cell in which to find volume */
  43         struct afs_volume       *volume;        /* volume record */
  44         struct key              *key;           /* key to use for secure mounting */
  45 };
  46
  47 /*
  48  * definition of how to wait for the completion of an operation
  49  */
  50 struct afs_wait_mode {
  51         /* RxRPC received message notification */
  52         void (*rx_wakeup)(struct afs_call *call);
  53
  54         /* synchronous call waiter and call dispatched notification */
  55         int (*wait)(struct afs_call *call);
  56
  57         /* asynchronous call completion */
  58         void (*async_complete)(void *reply, int error);
  59 };
  60
  61 extern const struct afs_wait_mode afs_sync_call;
  62 extern const struct afs_wait_mode afs_async_call;
  63
  64 /*
  65  * a record of an in-progress RxRPC call
  66  */
  67 struct afs_call {
  68         const struct afs_call_type *type;       /* type of call */
  69         const struct afs_wait_mode *wait_mode;  /* completion wait mode */
  70         wait_queue_head_t       waitq;          /* processes awaiting completion */
  71         struct work_struct      async_work;     /* asynchronous work processor */
  72         struct work_struct      work;           /* actual work processor */
  73         struct sk_buff_head     rx_queue;       /* received packets */
  74         struct rxrpc_call       *rxcall;        /* RxRPC call handle */
  75         struct key              *key;           /* security for this call */
  76         struct afs_server       *server;        /* server affected by incoming CM call */
  77         void                    *request;       /* request data (first part) */
  78         void                    *request2;      /* request data (second part) */
  79         void                    *buffer;        /* reply receive buffer */
  80         void                    *reply;         /* reply buffer (first part) */
  81         void                    *reply2;        /* reply buffer (second part) */
  82         void                    *reply3;        /* reply buffer (third part) */
  83         enum {                                  /* call state */
  84                 AFS_CALL_REQUESTING,    /* request is being sent for outgoing call */
  85                 AFS_CALL_AWAIT_REPLY,   /* awaiting reply to outgoing call */
  86                 AFS_CALL_AWAIT_OP_ID,   /* awaiting op ID on incoming call */
  87                 AFS_CALL_AWAIT_REQUEST, /* awaiting request data on incoming call */
  88                 AFS_CALL_REPLYING,      /* replying to incoming call */
  89                 AFS_CALL_AWAIT_ACK,     /* awaiting final ACK of incoming call */
  90                 AFS_CALL_COMPLETE,      /* successfully completed */
  91                 AFS_CALL_BUSY,          /* server was busy */
  92                 AFS_CALL_ABORTED,       /* call was aborted */
  93                 AFS_CALL_ERROR,         /* call failed due to error */
  94         }                       state;
  95         int                     error;          /* error code */
  96         unsigned                request_size;   /* size of request data */
  97         unsigned                reply_max;      /* maximum size of reply */
  98         unsigned                reply_size;     /* current size of reply */
  99         unsigned short          offset;         /* offset into received data store */
 100         unsigned char           unmarshall;     /* unmarshalling phase */
 101         bool                    incoming;       /* T if incoming call */
 102         u16                     service_id;     /* RxRPC service ID to call */
 103         __be16                  port;           /* target UDP port */
 104         __be32                  operation_ID;   /* operation ID for an incoming call */
 105         u32                     count;          /* count for use in unmarshalling */
 106         __be32                  tmp;            /* place to extract temporary data */
 107 };
 108
 109 struct afs_call_type {
 110         const char *name;
 111
 112         /* deliver request or reply data to an call
 113          * - returning an error will cause the call to be aborted
 114          */
 115         int (*deliver)(struct afs_call *call, struct sk_buff *skb,
 116                        bool last);
 117
 118         /* map an abort code to an error number */
 119         int (*abort_to_error)(u32 abort_code);
 120
 121         /* clean up a call */
 122         void (*destructor)(struct afs_call *call);
 123 };
 124
 125 /*
 126  * AFS superblock private data
 127  * - there's one superblock per volume
 128  */
 129 struct afs_super_info {
 130         struct afs_volume       *volume;        /* volume record */
 131         char                    rwparent;       /* T if parent is R/W AFS volume */
 132 };
 133
 134 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
 135 {
 136         return sb->s_fs_info;
 137 }
 138
 139 extern struct file_system_type afs_fs_type;
 140
 141 /*
 142  * entry in the cached cell catalogue
 143  */
 144 struct afs_cache_cell {
 145         char            name[AFS_MAXCELLNAME];  /* cell name (padded with NULs) */
 146         struct in_addr  vl_servers[15];         /* cached cell VL servers */
 147 };
 148
 149 /*
 150  * AFS cell record
 151  */
 152 struct afs_cell {
 153         atomic_t                usage;
 154         struct list_head        link;           /* main cell list link */
 155         struct key              *anonymous_key; /* anonymous user key for this cell */
 156         struct list_head        proc_link;      /* /proc cell list link */
 157         struct proc_dir_entry   *proc_dir;      /* /proc dir for this cell */
 158 #ifdef AFS_CACHING_SUPPORT
 159         struct cachefs_cookie   *cache;         /* caching cookie */
 160 #endif
 161
 162         /* server record management */
 163         rwlock_t                servers_lock;   /* active server list lock */
 164         struct list_head        servers;        /* active server list */
 165
 166         /* volume location record management */
 167         struct rw_semaphore     vl_sem;         /* volume management serialisation semaphore */
 168         struct list_head        vl_list;        /* cell's active VL record list */
 169         spinlock_t              vl_lock;        /* vl_list lock */
 170         unsigned short          vl_naddrs;      /* number of VL servers in addr list */
 171         unsigned short          vl_curr_svix;   /* current server index */
 172         struct in_addr          vl_addrs[AFS_CELL_MAX_ADDRS];   /* cell VL server addresses */
 173
 174         char                    name[0];        /* cell name - must go last */
 175 };
 176
 177 /*
 178  * entry in the cached volume location catalogue
 179  */
 180 struct afs_cache_vlocation {
 181         /* volume name (lowercase, padded with NULs) */
 182         uint8_t                 name[AFS_MAXVOLNAME + 1];
 183
 184         uint8_t                 nservers;       /* number of entries used in servers[] */
 185         uint8_t                 vidmask;        /* voltype mask for vid[] */
 186         uint8_t                 srvtmask[8];    /* voltype masks for servers[] */
 187 #define AFS_VOL_VTM_RW  0x01 /* R/W version of the volume is available (on this server) */
 188 #define AFS_VOL_VTM_RO  0x02 /* R/O version of the volume is available (on this server) */
 189 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
 190
 191         afs_volid_t             vid[3];         /* volume IDs for R/W, R/O and Bak volumes */
 192         struct in_addr          servers[8];     /* fileserver addresses */
 193         time_t                  rtime;          /* last retrieval time */
 194 };
 195
 196 /*
 197  * volume -> vnode hash table entry
 198  */
 199 struct afs_cache_vhash {
 200         afs_voltype_t           vtype;          /* which volume variation */
 201         uint8_t                 hash_bucket;    /* which hash bucket this represents */
 202 } __attribute__((packed));
 203
 204 /*
 205  * AFS volume location record
 206  */
 207 struct afs_vlocation {
 208         atomic_t                usage;
 209         time_t                  time_of_death;  /* time at which put reduced usage to 0 */
 210         struct list_head        link;           /* link in cell volume location list */
 211         struct list_head        grave;          /* link in master graveyard list */
 212         struct list_head        update;         /* link in master update list */
 213         struct afs_cell         *cell;          /* cell to which volume belongs */
 214 #ifdef AFS_CACHING_SUPPORT
 215         struct cachefs_cookie   *cache;         /* caching cookie */
 216 #endif
 217         struct afs_cache_vlocation vldb;        /* volume information DB record */
 218         struct afs_volume       *vols[3];       /* volume access record pointer (index by type) */
 219         wait_queue_head_t       waitq;          /* status change waitqueue */
 220         time_t                  update_at;      /* time at which record should be updated */
 221         rwlock_t                lock;           /* access lock */
 222         afs_vlocation_state_t   state;          /* volume location state */
 223         unsigned short          upd_rej_cnt;    /* ENOMEDIUM count during update */
 224         unsigned short          upd_busy_cnt;   /* EBUSY count during update */
 225         bool                    valid;          /* T if valid */
 226 };
 227
 228 /*
 229  * AFS fileserver record
 230  */
 231 struct afs_server {
 232         atomic_t                usage;
 233         time_t                  time_of_death;  /* time at which put reduced usage to 0 */
 234         struct in_addr          addr;           /* server address */
 235         struct afs_cell         *cell;          /* cell in which server resides */
 236         struct list_head        link;           /* link in cell's server list */
 237         struct list_head        grave;          /* link in master graveyard list */
 238         struct rb_node          master_rb;      /* link in master by-addr tree */
 239         struct rw_semaphore     sem;            /* access lock */
 240
 241         /* file service access */
 242         struct rb_root          fs_vnodes;      /* vnodes backed by this server (ordered by FID) */
 243         unsigned long           fs_act_jif;     /* time at which last activity occurred */
 244         unsigned long           fs_dead_jif;    /* time at which no longer to be considered dead */
 245         spinlock_t              fs_lock;        /* access lock */
 246         int                     fs_state;       /* 0 or reason FS currently marked dead (-errno) */
 247
 248         /* callback promise management */
 249         struct rb_root          cb_promises;    /* vnode expiration list (ordered earliest first) */
 250         struct delayed_work     cb_updater;     /* callback updater */
 251         struct delayed_work     cb_break_work;  /* collected break dispatcher */
 252         wait_queue_head_t       cb_break_waitq; /* space available in cb_break waitqueue */
 253         spinlock_t              cb_lock;        /* access lock */
 254         struct afs_callback     cb_break[64];   /* ring of callbacks awaiting breaking */
 255         atomic_t                cb_break_n;     /* number of pending breaks */
 256         u8                      cb_break_head;  /* head of callback breaking ring */
 257         u8                      cb_break_tail;  /* tail of callback breaking ring */
 258 };
 259
 260 /*
 261  * AFS volume access record
 262  */
 263 struct afs_volume {
 264         atomic_t                usage;
 265         struct afs_cell         *cell;          /* cell to which belongs (unrefd ptr) */
 266         struct afs_vlocation    *vlocation;     /* volume location */
 267 #ifdef AFS_CACHING_SUPPORT
 268         struct cachefs_cookie   *cache;         /* caching cookie */
 269 #endif
 270         afs_volid_t             vid;            /* volume ID */
 271         afs_voltype_t           type;           /* type of volume */
 272         char                    type_force;     /* force volume type (suppress R/O -> R/W) */
 273         unsigned short          nservers;       /* number of server slots filled */
 274         unsigned short          rjservers;      /* number of servers discarded due to -ENOMEDIUM */
 275         struct afs_server       *servers[8];    /* servers on which volume resides (ordered) */
 276         struct rw_semaphore     server_sem;     /* lock for accessing current server */
 277 };
 278
 279 /*
 280  * vnode catalogue entry
 281  */
 282 struct afs_cache_vnode {
 283         afs_vnodeid_t           vnode_id;       /* vnode ID */
 284         unsigned                vnode_unique;   /* vnode ID uniquifier */
 285         afs_dataversion_t       data_version;   /* data version */
 286 };
 287
 288 /*
 289  * AFS inode private data
 290  */
 291 struct afs_vnode {
 292         struct inode            vfs_inode;      /* the VFS's inode record */
 293
 294         struct afs_volume       *volume;        /* volume on which vnode resides */
 295         struct afs_server       *server;        /* server currently supplying this file */
 296         struct afs_fid          fid;            /* the file identifier for this inode */
 297         struct afs_file_status  status;         /* AFS status info for this file */
 298 #ifdef AFS_CACHING_SUPPORT
 299         struct cachefs_cookie   *cache;         /* caching cookie */
 300 #endif
 301         struct afs_permits      *permits;       /* cache of permits so far obtained */
 302         struct mutex            permits_lock;   /* lock for altering permits list */
 303         wait_queue_head_t       update_waitq;   /* status fetch waitqueue */
 304         unsigned                update_cnt;     /* number of outstanding ops that will update the
 305                                                  * status */
 306         spinlock_t              lock;           /* waitqueue/flags lock */
 307         unsigned long           flags;
 308 #define AFS_VNODE_CB_BROKEN     0               /* set if vnode's callback was broken */
 309 #define AFS_VNODE_CHANGED       1               /* set if vnode's metadata changed */
 310 #define AFS_VNODE_MODIFIED      2               /* set if vnode's data modified */
 311 #define AFS_VNODE_ZAP_DATA      3               /* set if vnode's data should be invalidated */
 312 #define AFS_VNODE_DELETED       4               /* set if vnode deleted on server */
 313 #define AFS_VNODE_MOUNTPOINT    5               /* set if vnode is a mountpoint symlink */
 314 #define AFS_VNODE_DIR_CHANGED   6               /* set if vnode's parent dir metadata changed */
 315 #define AFS_VNODE_DIR_MODIFIED  7               /* set if vnode's parent dir data modified */
 316
 317         long                    acl_order;      /* ACL check count (callback break count) */
 318
 319         /* outstanding callback notification on this file */
 320         struct rb_node          server_rb;      /* link in server->fs_vnodes */
 321         struct rb_node          cb_promise;     /* link in server->cb_promises */
 322         struct work_struct      cb_broken_work; /* work to be done on callback break */
 323         struct mutex            cb_broken_lock; /* lock against multiple attempts to fix break */
 324         time_t                  cb_expires;     /* time at which callback expires */
 325         time_t                  cb_expires_at;  /* time used to order cb_promise */
 326         unsigned                cb_version;     /* callback version */
 327         unsigned                cb_expiry;      /* callback expiry time */
 328         afs_callback_type_t     cb_type;        /* type of callback */
 329         bool                    cb_promised;    /* true if promise still holds */
 330 };
 331
 332 /*
 333  * cached security record for one user's attempt to access a vnode
 334  */
 335 struct afs_permit {
 336         struct key              *key;           /* RxRPC ticket holding a security context */
 337         afs_access_t            access_mask;    /* access mask for this key */
 338 };
 339
 340 /*
 341  * cache of security records from attempts to access a vnode
 342  */
 343 struct afs_permits {
 344         struct rcu_head         rcu;            /* disposal procedure */
 345         int                     count;          /* number of records */
 346         struct afs_permit       permits[0];     /* the permits so far examined */
 347 };
 348
 349 /*
 350  * record of one of a system's set of network interfaces
 351  */
 352 struct afs_interface {
 353         unsigned        index;          /* interface index */
 354         struct in_addr  address;        /* IPv4 address bound to interface */
 355         struct in_addr  netmask;        /* netmask applied to address */
 356         unsigned        mtu;            /* MTU of interface */
 357 };
 358
 359 /*
 360  * UUID definition [internet draft]
 361  * - the timestamp is a 60-bit value, split 32/16/12, and goes in 100ns
 362  *   increments since midnight 15th October 1582
 363  *   - add AFS_UUID_TO_UNIX_TIME to convert unix time in 100ns units to UUID
 364  *     time
 365  * - the clock sequence is a 14-bit counter to avoid duplicate times
 366  */
 367 struct afs_uuid {
 368         u32             time_low;                       /* low part of timestamp */
 369         u16             time_mid;                       /* mid part of timestamp */
 370         u16             time_hi_and_version;            /* high part of timestamp and version  */
 371 #define AFS_UUID_TO_UNIX_TIME   0x01b21dd213814000
 372 #define AFS_UUID_TIMEHI_MASK    0x0fff
 373 #define AFS_UUID_VERSION_TIME   0x1000  /* time-based UUID */
 374 #define AFS_UUID_VERSION_NAME   0x3000  /* name-based UUID */
 375 #define AFS_UUID_VERSION_RANDOM 0x4000  /* (pseudo-)random generated UUID */
 376         u8              clock_seq_hi_and_reserved;      /* clock seq hi and variant */
 377 #define AFS_UUID_CLOCKHI_MASK   0x3f
 378 #define AFS_UUID_VARIANT_STD    0x80
 379         u8              clock_seq_low;                  /* clock seq low */
 380         u8              node[6];                        /* spatially unique node ID (MAC addr) */
 381 };
 382
 383 /*****************************************************************************/
 384 /*
 385  * callback.c
 386  */
 387 extern void afs_init_callback_state(struct afs_server *);
 388 extern void afs_broken_callback_work(struct work_struct *);
 389 extern void afs_break_callbacks(struct afs_server *, size_t,
 390                                 struct afs_callback[]);
 391 extern void afs_give_up_callback(struct afs_vnode *);
 392 extern void afs_dispatch_give_up_callbacks(struct work_struct *);
 393 extern void afs_flush_callback_breaks(struct afs_server *);
 394 extern int __init afs_callback_update_init(void);
 395 extern void __exit afs_callback_update_kill(void);
 396
 397 /*
 398  * cell.c
 399  */
 400 extern struct rw_semaphore afs_proc_cells_sem;
 401 extern struct list_head afs_proc_cells;
 402 #ifdef AFS_CACHING_SUPPORT
 403 extern struct cachefs_index_def afs_cache_cell_index_def;
 404 #endif
 405
 406 #define afs_get_cell(C) do { atomic_inc(&(C)->usage); } while(0)
 407 extern int afs_cell_init(char *);
 408 extern struct afs_cell *afs_cell_create(const char *, char *);
 409 extern struct afs_cell *afs_cell_lookup(const char *, unsigned);
 410 extern struct afs_cell *afs_grab_cell(struct afs_cell *);
 411 extern void afs_put_cell(struct afs_cell *);
 412 extern void afs_cell_purge(void);
 413
 414 /*
 415  * cmservice.c
 416  */
 417 extern bool afs_cm_incoming_call(struct afs_call *);
 418
 419 /*
 420  * dir.c
 421  */
 422 extern const struct inode_operations afs_dir_inode_operations;
 423 extern const struct file_operations afs_dir_file_operations;
 424
 425 extern int afs_permission(struct inode *, int, struct nameidata *);
 426
 427 /*
 428  * file.c
 429  */
 430 extern const struct address_space_operations afs_fs_aops;
 431 extern const struct inode_operations afs_file_inode_operations;
 432 extern const struct file_operations afs_file_operations;
 433
 434 extern int afs_open(struct inode *, struct file *);
 435 extern int afs_release(struct inode *, struct file *);
 436
 437 #ifdef AFS_CACHING_SUPPORT
 438 extern int afs_cache_get_page_cookie(struct page *, struct cachefs_page **);
 439 #endif
 440
 441 /*
 442  * fsclient.c
 443  */
 444 extern int afs_fs_fetch_file_status(struct afs_server *, struct key *,
 445                                     struct afs_vnode *, struct afs_volsync *,
 446                                     const struct afs_wait_mode *);
 447 extern int afs_fs_give_up_callbacks(struct afs_server *,
 448                                     const struct afs_wait_mode *);
 449 extern int afs_fs_fetch_data(struct afs_server *, struct key *,
 450                              struct afs_vnode *, off_t, size_t, struct page *,
 451                              struct afs_volsync *,
 452                              const struct afs_wait_mode *);
 453
 454 /*
 455  * inode.c
 456  */
 457 extern struct inode *afs_iget(struct super_block *, struct key *,
 458                               struct afs_fid *);
 459 extern int afs_inode_getattr(struct vfsmount *, struct dentry *,
 460                              struct kstat *);
 461 extern void afs_zap_permits(struct rcu_head *);
 462 extern void afs_clear_inode(struct inode *);
 463
 464 /*
 465  * main.c
 466  */
 467 extern struct afs_uuid afs_uuid;
 468 #ifdef AFS_CACHING_SUPPORT
 469 extern struct cachefs_netfs afs_cache_netfs;
 470 #endif
 471
 472 /*
 473  * misc.c
 474  */
 475 extern int afs_abort_to_error(u32);
 476
 477 /*
 478  * mntpt.c
 479  */
 480 extern const struct inode_operations afs_mntpt_inode_operations;
 481 extern const struct file_operations afs_mntpt_file_operations;
 482 extern unsigned long afs_mntpt_expiry_timeout;
 483
 484 extern int afs_mntpt_check_symlink(struct afs_vnode *, struct key *);
 485 extern void afs_mntpt_kill_timer(void);
 486 extern void afs_umount_begin(struct vfsmount *, int);
 487
 488 /*
 489  * proc.c
 490  */
 491 extern int afs_proc_init(void);
 492 extern void afs_proc_cleanup(void);
 493 extern int afs_proc_cell_setup(struct afs_cell *);
 494 extern void afs_proc_cell_remove(struct afs_cell *);
 495
 496 /*
 497  * rxrpc.c
 498  */
 499 extern int afs_open_socket(void);
 500 extern void afs_close_socket(void);
 501 extern int afs_make_call(struct in_addr *, struct afs_call *, gfp_t,
 502                          const struct afs_wait_mode *);
 503 extern struct afs_call *afs_alloc_flat_call(const struct afs_call_type *,
 504                                             size_t, size_t);
 505 extern void afs_flat_call_destructor(struct afs_call *);
 506 extern void afs_transfer_reply(struct afs_call *, struct sk_buff *);
 507 extern void afs_send_empty_reply(struct afs_call *);
 508 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
 509 extern int afs_extract_data(struct afs_call *, struct sk_buff *, bool, void *,
 510                             size_t);
 511
 512 /*
 513  * security.c
 514  */
 515 extern void afs_clear_permits(struct afs_vnode *);
 516 extern void afs_cache_permit(struct afs_vnode *, struct key *, long);
 517 extern struct key *afs_request_key(struct afs_cell *);
 518 extern int afs_permission(struct inode *, int, struct nameidata *);
 519
 520 /*
 521  * server.c
 522  */
 523 extern spinlock_t afs_server_peer_lock;
 524
 525 #define afs_get_server(S) do { atomic_inc(&(S)->usage); } while(0)
 526
 527 extern struct afs_server *afs_lookup_server(struct afs_cell *,
 528                                             const struct in_addr *);
 529 extern struct afs_server *afs_find_server(const struct in_addr *);
 530 extern void afs_put_server(struct afs_server *);
 531 extern void __exit afs_purge_servers(void);
 532
 533 /*
 534  * super.c
 535  */
 536 extern int afs_fs_init(void);
 537 extern void afs_fs_exit(void);
 538
 539 /*
 540  * use-rtnetlink.c
 541  */
 542 extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
 543 extern int afs_get_MAC_address(u8 [6]);
 544
 545 /*
 546  * vlclient.c
 547  */
 548 #ifdef AFS_CACHING_SUPPORT
 549 extern struct cachefs_index_def afs_vlocation_cache_index_def;
 550 #endif
 551
 552 extern int afs_vl_get_entry_by_name(struct in_addr *, struct key *,
 553                                     const char *, struct afs_cache_vlocation *,
 554                                     const struct afs_wait_mode *);
 555 extern int afs_vl_get_entry_by_id(struct in_addr *, struct key *,
 556                                   afs_volid_t, afs_voltype_t,
 557                                   struct afs_cache_vlocation *,
 558                                   const struct afs_wait_mode *);
 559
 560 /*
 561  * vlocation.c
 562  */
 563 #define afs_get_vlocation(V) do { atomic_inc(&(V)->usage); } while(0)
 564
 565 extern int __init afs_vlocation_update_init(void);
 566 extern struct afs_vlocation *afs_vlocation_lookup(struct afs_cell *,
 567                                                   struct key *,
 568                                                   const char *, size_t);
 569 extern void afs_put_vlocation(struct afs_vlocation *);
 570 extern void __exit afs_vlocation_purge(void);
 571
 572 /*
 573  * vnode.c
 574  */
 575 #ifdef AFS_CACHING_SUPPORT
 576 extern struct cachefs_index_def afs_vnode_cache_index_def;
 577 #endif
 578
 579 extern struct afs_timer_ops afs_vnode_cb_timed_out_ops;
 580
 581 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
 582 {
 583         return container_of(inode, struct afs_vnode, vfs_inode);
 584 }
 585
 586 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
 587 {
 588         return &vnode->vfs_inode;
 589 }
 590
 591 extern int afs_vnode_fetch_status(struct afs_vnode *, struct afs_vnode *,
 592                                   struct key *);
 593 extern int afs_vnode_fetch_data(struct afs_vnode *, struct key *,
 594                                 off_t, size_t, struct page *);
 595
 596 /*
 597  * volume.c
 598  */
 599 #ifdef AFS_CACHING_SUPPORT
 600 extern struct cachefs_index_def afs_volume_cache_index_def;
 601 #endif
 602
 603 #define afs_get_volume(V) do { atomic_inc(&(V)->usage); } while(0)
 604
 605 extern void afs_put_volume(struct afs_volume *);
 606 extern struct afs_volume *afs_volume_lookup(struct afs_mount_params *);
 607 extern struct afs_server *afs_volume_pick_fileserver(struct afs_vnode *);
 608 extern int afs_volume_release_fileserver(struct afs_vnode *,
 609                                          struct afs_server *, int);
 610
 611 /*****************************************************************************/
 612 /*
 613  * debug tracing
 614  */
 615 extern unsigned afs_debug;
 616
 617 #define dbgprintk(FMT,...) \
 618         printk("[%x%-6.6s] "FMT"\n", smp_processor_id(), current->comm ,##__VA_ARGS__)
 619
 620 /* make sure we maintain the format strings, even when debugging is disabled */
 621 static inline __attribute__((format(printf,1,2)))
 622 void _dbprintk(const char *fmt, ...)
 623 {
 624 }
 625
 626 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__FUNCTION__ ,##__VA_ARGS__)
 627 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__FUNCTION__ ,##__VA_ARGS__)
 628 #define kdebug(FMT,...) dbgprintk("    "FMT ,##__VA_ARGS__)
 629
 630
 631 #if defined(__KDEBUG)
 632 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
 633 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
 634 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
 635
 636 #elif defined(CONFIG_AFS_DEBUG)
 637 #define AFS_DEBUG_KENTER        0x01
 638 #define AFS_DEBUG_KLEAVE        0x02
 639 #define AFS_DEBUG_KDEBUG        0x04
 640
 641 #define _enter(FMT,...)                                 \
 642 do {                                                    \
 643         if (unlikely(afs_debug & AFS_DEBUG_KENTER))     \
 644                 kenter(FMT,##__VA_ARGS__);              \
 645 } while (0)
 646
 647 #define _leave(FMT,...)                                 \
 648 do {                                                    \
 649         if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))     \
 650                 kleave(FMT,##__VA_ARGS__);              \
 651 } while (0)
 652
 653 #define _debug(FMT,...)                                 \
 654 do {                                                    \
 655         if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))     \
 656                 kdebug(FMT,##__VA_ARGS__);              \
 657 } while (0)
 658
 659 #else
 660 #define _enter(FMT,...) _dbprintk("==> %s("FMT")",__FUNCTION__ ,##__VA_ARGS__)
 661 #define _leave(FMT,...) _dbprintk("<== %s()"FMT"",__FUNCTION__ ,##__VA_ARGS__)
 662 #define _debug(FMT,...) _dbprintk("    "FMT ,##__VA_ARGS__)
 663 #endif
 664
 665 /*
 666  * debug assertion checking
 667  */
 668 #if 1 // defined(__KDEBUGALL)
 669
 670 #define ASSERT(X)                                               \
 671 do {                                                            \
 672         if (unlikely(!(X))) {                                   \
 673                 printk(KERN_ERR "\n");                          \
 674                 printk(KERN_ERR "AFS: Assertion failed\n");     \
 675                 BUG();                                          \
 676         }                                                       \
 677 } while(0)
 678
 679 #define ASSERTCMP(X, OP, Y)                                             \
 680 do {                                                                    \
 681         if (unlikely(!((X) OP (Y)))) {                                  \
 682                 printk(KERN_ERR "\n");                                  \
 683                 printk(KERN_ERR "AFS: Assertion failed\n");             \
 684                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
 685                        (unsigned long)(X), (unsigned long)(Y));         \
 686                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
 687                        (unsigned long)(X), (unsigned long)(Y));         \
 688                 BUG();                                                  \
 689         }                                                               \
 690 } while(0)
 691
 692 #define ASSERTIF(C, X)                                          \
 693 do {                                                            \
 694         if (unlikely((C) && !(X))) {                            \
 695                 printk(KERN_ERR "\n");                          \
 696                 printk(KERN_ERR "AFS: Assertion failed\n");     \
 697                 BUG();                                          \
 698         }                                                       \
 699 } while(0)
 700
 701 #define ASSERTIFCMP(C, X, OP, Y)                                        \
 702 do {                                                                    \
 703         if (unlikely((C) && !((X) OP (Y)))) {                           \
 704                 printk(KERN_ERR "\n");                                  \
 705                 printk(KERN_ERR "AFS: Assertion failed\n");             \
 706                 printk(KERN_ERR "%lu " #OP " %lu is false\n",           \
 707                        (unsigned long)(X), (unsigned long)(Y));         \
 708                 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",       \
 709                        (unsigned long)(X), (unsigned long)(Y));         \
 710                 BUG();                                                  \
 711         }                                                               \
 712 } while(0)
 713
 714 #else
 715
 716 #define ASSERT(X)                               \
 717 do {                                            \
 718 } while(0)
 719
 720 #define ASSERTCMP(X, OP, Y)                     \
 721 do {                                            \
 722 } while(0)
 723
 724 #define ASSERTIF(C, X)                          \
 725 do {                                            \
 726 } while(0)
 727
 728 #define ASSERTIFCMP(C, X, OP, Y)                \
 729 do {                                            \
 730 } while(0)
 731
 732 #endif /* __KDEBUGALL */