[AFS]: Fix VLocation record update wakeup
[wrt350n-kernel.git] / fs / afs / internal.h
blob6dd3197d1d8d55250adb3228e7de1b42dafbcf7c
1 /* internal AFS stuff
3 * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
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"
22 #define AFS_CELL_MAX_ADDRS 15
24 struct afs_call;
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;
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 */
48 * definition of how to wait for the completion of an operation
50 struct afs_wait_mode {
51 /* RxRPC received message notification */
52 void (*rx_wakeup)(struct afs_call *call);
54 /* synchronous call waiter and call dispatched notification */
55 int (*wait)(struct afs_call *call);
57 /* asynchronous call completion */
58 void (*async_complete)(void *reply, int error);
61 extern const struct afs_wait_mode afs_sync_call;
62 extern const struct afs_wait_mode afs_async_call;
65 * a record of an in-progress RxRPC call
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 void *reply4; /* reply buffer (fourth part) */
84 enum { /* call state */
85 AFS_CALL_REQUESTING, /* request is being sent for outgoing call */
86 AFS_CALL_AWAIT_REPLY, /* awaiting reply to outgoing call */
87 AFS_CALL_AWAIT_OP_ID, /* awaiting op ID on incoming call */
88 AFS_CALL_AWAIT_REQUEST, /* awaiting request data on incoming call */
89 AFS_CALL_REPLYING, /* replying to incoming call */
90 AFS_CALL_AWAIT_ACK, /* awaiting final ACK of incoming call */
91 AFS_CALL_COMPLETE, /* successfully completed */
92 AFS_CALL_BUSY, /* server was busy */
93 AFS_CALL_ABORTED, /* call was aborted */
94 AFS_CALL_ERROR, /* call failed due to error */
95 } state;
96 int error; /* error code */
97 unsigned request_size; /* size of request data */
98 unsigned reply_max; /* maximum size of reply */
99 unsigned reply_size; /* current size of reply */
100 unsigned short offset; /* offset into received data store */
101 unsigned char unmarshall; /* unmarshalling phase */
102 bool incoming; /* T if incoming call */
103 u16 service_id; /* RxRPC service ID to call */
104 __be16 port; /* target UDP port */
105 __be32 operation_ID; /* operation ID for an incoming call */
106 u32 count; /* count for use in unmarshalling */
107 __be32 tmp; /* place to extract temporary data */
110 struct afs_call_type {
111 const char *name;
113 /* deliver request or reply data to an call
114 * - returning an error will cause the call to be aborted
116 int (*deliver)(struct afs_call *call, struct sk_buff *skb,
117 bool last);
119 /* map an abort code to an error number */
120 int (*abort_to_error)(u32 abort_code);
122 /* clean up a call */
123 void (*destructor)(struct afs_call *call);
127 * AFS superblock private data
128 * - there's one superblock per volume
130 struct afs_super_info {
131 struct afs_volume *volume; /* volume record */
132 char rwparent; /* T if parent is R/W AFS volume */
135 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
137 return sb->s_fs_info;
140 extern struct file_system_type afs_fs_type;
143 * entry in the cached cell catalogue
145 struct afs_cache_cell {
146 char name[AFS_MAXCELLNAME]; /* cell name (padded with NULs) */
147 struct in_addr vl_servers[15]; /* cached cell VL servers */
151 * AFS cell record
153 struct afs_cell {
154 atomic_t usage;
155 struct list_head link; /* main cell list link */
156 struct key *anonymous_key; /* anonymous user key for this cell */
157 struct list_head proc_link; /* /proc cell list link */
158 struct proc_dir_entry *proc_dir; /* /proc dir for this cell */
159 #ifdef AFS_CACHING_SUPPORT
160 struct cachefs_cookie *cache; /* caching cookie */
161 #endif
163 /* server record management */
164 rwlock_t servers_lock; /* active server list lock */
165 struct list_head servers; /* active server list */
167 /* volume location record management */
168 struct rw_semaphore vl_sem; /* volume management serialisation semaphore */
169 struct list_head vl_list; /* cell's active VL record list */
170 spinlock_t vl_lock; /* vl_list lock */
171 unsigned short vl_naddrs; /* number of VL servers in addr list */
172 unsigned short vl_curr_svix; /* current server index */
173 struct in_addr vl_addrs[AFS_CELL_MAX_ADDRS]; /* cell VL server addresses */
175 char name[0]; /* cell name - must go last */
179 * entry in the cached volume location catalogue
181 struct afs_cache_vlocation {
182 /* volume name (lowercase, padded with NULs) */
183 uint8_t name[AFS_MAXVOLNAME + 1];
185 uint8_t nservers; /* number of entries used in servers[] */
186 uint8_t vidmask; /* voltype mask for vid[] */
187 uint8_t srvtmask[8]; /* voltype masks for servers[] */
188 #define AFS_VOL_VTM_RW 0x01 /* R/W version of the volume is available (on this server) */
189 #define AFS_VOL_VTM_RO 0x02 /* R/O version of the volume is available (on this server) */
190 #define AFS_VOL_VTM_BAK 0x04 /* backup version of the volume is available (on this server) */
192 afs_volid_t vid[3]; /* volume IDs for R/W, R/O and Bak volumes */
193 struct in_addr servers[8]; /* fileserver addresses */
194 time_t rtime; /* last retrieval time */
198 * volume -> vnode hash table entry
200 struct afs_cache_vhash {
201 afs_voltype_t vtype; /* which volume variation */
202 uint8_t hash_bucket; /* which hash bucket this represents */
203 } __attribute__((packed));
206 * AFS volume location record
208 struct afs_vlocation {
209 atomic_t usage;
210 time_t time_of_death; /* time at which put reduced usage to 0 */
211 struct list_head link; /* link in cell volume location list */
212 struct list_head grave; /* link in master graveyard list */
213 struct list_head update; /* link in master update list */
214 struct afs_cell *cell; /* cell to which volume belongs */
215 #ifdef AFS_CACHING_SUPPORT
216 struct cachefs_cookie *cache; /* caching cookie */
217 #endif
218 struct afs_cache_vlocation vldb; /* volume information DB record */
219 struct afs_volume *vols[3]; /* volume access record pointer (index by type) */
220 wait_queue_head_t waitq; /* status change waitqueue */
221 time_t update_at; /* time at which record should be updated */
222 spinlock_t lock; /* access lock */
223 afs_vlocation_state_t state; /* volume location state */
224 unsigned short upd_rej_cnt; /* ENOMEDIUM count during update */
225 unsigned short upd_busy_cnt; /* EBUSY count during update */
226 bool valid; /* T if valid */
230 * AFS fileserver record
232 struct afs_server {
233 atomic_t usage;
234 time_t time_of_death; /* time at which put reduced usage to 0 */
235 struct in_addr addr; /* server address */
236 struct afs_cell *cell; /* cell in which server resides */
237 struct list_head link; /* link in cell's server list */
238 struct list_head grave; /* link in master graveyard list */
239 struct rb_node master_rb; /* link in master by-addr tree */
240 struct rw_semaphore sem; /* access lock */
242 /* file service access */
243 struct rb_root fs_vnodes; /* vnodes backed by this server (ordered by FID) */
244 unsigned long fs_act_jif; /* time at which last activity occurred */
245 unsigned long fs_dead_jif; /* time at which no longer to be considered dead */
246 spinlock_t fs_lock; /* access lock */
247 int fs_state; /* 0 or reason FS currently marked dead (-errno) */
249 /* callback promise management */
250 struct rb_root cb_promises; /* vnode expiration list (ordered earliest first) */
251 struct delayed_work cb_updater; /* callback updater */
252 struct delayed_work cb_break_work; /* collected break dispatcher */
253 wait_queue_head_t cb_break_waitq; /* space available in cb_break waitqueue */
254 spinlock_t cb_lock; /* access lock */
255 struct afs_callback cb_break[64]; /* ring of callbacks awaiting breaking */
256 atomic_t cb_break_n; /* number of pending breaks */
257 u8 cb_break_head; /* head of callback breaking ring */
258 u8 cb_break_tail; /* tail of callback breaking ring */
262 * AFS volume access record
264 struct afs_volume {
265 atomic_t usage;
266 struct afs_cell *cell; /* cell to which belongs (unrefd ptr) */
267 struct afs_vlocation *vlocation; /* volume location */
268 #ifdef AFS_CACHING_SUPPORT
269 struct cachefs_cookie *cache; /* caching cookie */
270 #endif
271 afs_volid_t vid; /* volume ID */
272 afs_voltype_t type; /* type of volume */
273 char type_force; /* force volume type (suppress R/O -> R/W) */
274 unsigned short nservers; /* number of server slots filled */
275 unsigned short rjservers; /* number of servers discarded due to -ENOMEDIUM */
276 struct afs_server *servers[8]; /* servers on which volume resides (ordered) */
277 struct rw_semaphore server_sem; /* lock for accessing current server */
281 * vnode catalogue entry
283 struct afs_cache_vnode {
284 afs_vnodeid_t vnode_id; /* vnode ID */
285 unsigned vnode_unique; /* vnode ID uniquifier */
286 afs_dataversion_t data_version; /* data version */
290 * AFS inode private data
292 struct afs_vnode {
293 struct inode vfs_inode; /* the VFS's inode record */
295 struct afs_volume *volume; /* volume on which vnode resides */
296 struct afs_server *server; /* server currently supplying this file */
297 struct afs_fid fid; /* the file identifier for this inode */
298 struct afs_file_status status; /* AFS status info for this file */
299 #ifdef AFS_CACHING_SUPPORT
300 struct cachefs_cookie *cache; /* caching cookie */
301 #endif
302 struct afs_permits *permits; /* cache of permits so far obtained */
303 struct mutex permits_lock; /* lock for altering permits list */
304 struct mutex validate_lock; /* lock for validating this vnode */
305 wait_queue_head_t update_waitq; /* status fetch waitqueue */
306 int update_cnt; /* number of outstanding ops that will update the
307 * status */
308 spinlock_t lock; /* waitqueue/flags lock */
309 unsigned long flags;
310 #define AFS_VNODE_CB_BROKEN 0 /* set if vnode's callback was broken */
311 #define AFS_VNODE_UNSET 1 /* set if vnode attributes not yet set */
312 #define AFS_VNODE_MODIFIED 2 /* set if vnode's data modified */
313 #define AFS_VNODE_ZAP_DATA 3 /* set if vnode's data should be invalidated */
314 #define AFS_VNODE_DELETED 4 /* set if vnode deleted on server */
315 #define AFS_VNODE_MOUNTPOINT 5 /* set if vnode is a mountpoint symlink */
317 long acl_order; /* ACL check count (callback break count) */
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 time_t cb_expires; /* time at which callback expires */
324 time_t cb_expires_at; /* time used to order cb_promise */
325 unsigned cb_version; /* callback version */
326 unsigned cb_expiry; /* callback expiry time */
327 afs_callback_type_t cb_type; /* type of callback */
328 bool cb_promised; /* true if promise still holds */
332 * cached security record for one user's attempt to access a vnode
334 struct afs_permit {
335 struct key *key; /* RxRPC ticket holding a security context */
336 afs_access_t access_mask; /* access mask for this key */
340 * cache of security records from attempts to access a vnode
342 struct afs_permits {
343 struct rcu_head rcu; /* disposal procedure */
344 int count; /* number of records */
345 struct afs_permit permits[0]; /* the permits so far examined */
349 * record of one of a system's set of network interfaces
351 struct afs_interface {
352 unsigned index; /* interface index */
353 struct in_addr address; /* IPv4 address bound to interface */
354 struct in_addr netmask; /* netmask applied to address */
355 unsigned mtu; /* MTU of interface */
359 * UUID definition [internet draft]
360 * - the timestamp is a 60-bit value, split 32/16/12, and goes in 100ns
361 * increments since midnight 15th October 1582
362 * - add AFS_UUID_TO_UNIX_TIME to convert unix time in 100ns units to UUID
363 * time
364 * - the clock sequence is a 14-bit counter to avoid duplicate times
366 struct afs_uuid {
367 u32 time_low; /* low part of timestamp */
368 u16 time_mid; /* mid part of timestamp */
369 u16 time_hi_and_version; /* high part of timestamp and version */
370 #define AFS_UUID_TO_UNIX_TIME 0x01b21dd213814000
371 #define AFS_UUID_TIMEHI_MASK 0x0fff
372 #define AFS_UUID_VERSION_TIME 0x1000 /* time-based UUID */
373 #define AFS_UUID_VERSION_NAME 0x3000 /* name-based UUID */
374 #define AFS_UUID_VERSION_RANDOM 0x4000 /* (pseudo-)random generated UUID */
375 u8 clock_seq_hi_and_reserved; /* clock seq hi and variant */
376 #define AFS_UUID_CLOCKHI_MASK 0x3f
377 #define AFS_UUID_VARIANT_STD 0x80
378 u8 clock_seq_low; /* clock seq low */
379 u8 node[6]; /* spatially unique node ID (MAC addr) */
382 /*****************************************************************************/
384 * callback.c
386 extern void afs_init_callback_state(struct afs_server *);
387 extern void afs_broken_callback_work(struct work_struct *);
388 extern void afs_break_callbacks(struct afs_server *, size_t,
389 struct afs_callback[]);
390 extern void afs_discard_callback_on_delete(struct afs_vnode *);
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);
398 * cell.c
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
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);
415 * cmservice.c
417 extern bool afs_cm_incoming_call(struct afs_call *);
420 * dir.c
422 extern const struct inode_operations afs_dir_inode_operations;
423 extern const struct file_operations afs_dir_file_operations;
425 extern int afs_permission(struct inode *, int, struct nameidata *);
428 * file.c
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;
434 extern int afs_open(struct inode *, struct file *);
435 extern int afs_release(struct inode *, struct file *);
437 #ifdef AFS_CACHING_SUPPORT
438 extern int afs_cache_get_page_cookie(struct page *, struct cachefs_page **);
439 #endif
442 * fsclient.c
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 const struct afs_wait_mode *);
452 extern int afs_fs_create(struct afs_server *, struct key *,
453 struct afs_vnode *, const char *, umode_t,
454 struct afs_fid *, struct afs_file_status *,
455 struct afs_callback *,
456 const struct afs_wait_mode *);
457 extern int afs_fs_remove(struct afs_server *, struct key *,
458 struct afs_vnode *, const char *, bool,
459 const struct afs_wait_mode *);
460 extern int afs_fs_link(struct afs_server *, struct key *, struct afs_vnode *,
461 struct afs_vnode *, const char *,
462 const struct afs_wait_mode *);
463 extern int afs_fs_symlink(struct afs_server *, struct key *,
464 struct afs_vnode *, const char *, const char *,
465 struct afs_fid *, struct afs_file_status *,
466 const struct afs_wait_mode *);
467 extern int afs_fs_rename(struct afs_server *, struct key *,
468 struct afs_vnode *, const char *,
469 struct afs_vnode *, const char *,
470 const struct afs_wait_mode *);
473 * inode.c
475 extern struct inode *afs_iget(struct super_block *, struct key *,
476 struct afs_fid *, struct afs_file_status *,
477 struct afs_callback *);
478 extern int afs_validate(struct afs_vnode *, struct key *);
479 extern int afs_inode_getattr(struct vfsmount *, struct dentry *,
480 struct kstat *);
481 extern void afs_zap_permits(struct rcu_head *);
482 extern void afs_clear_inode(struct inode *);
485 * main.c
487 extern struct afs_uuid afs_uuid;
488 #ifdef AFS_CACHING_SUPPORT
489 extern struct cachefs_netfs afs_cache_netfs;
490 #endif
493 * misc.c
495 extern int afs_abort_to_error(u32);
498 * mntpt.c
500 extern const struct inode_operations afs_mntpt_inode_operations;
501 extern const struct file_operations afs_mntpt_file_operations;
502 extern unsigned long afs_mntpt_expiry_timeout;
504 extern int afs_mntpt_check_symlink(struct afs_vnode *, struct key *);
505 extern void afs_mntpt_kill_timer(void);
506 extern void afs_umount_begin(struct vfsmount *, int);
509 * proc.c
511 extern int afs_proc_init(void);
512 extern void afs_proc_cleanup(void);
513 extern int afs_proc_cell_setup(struct afs_cell *);
514 extern void afs_proc_cell_remove(struct afs_cell *);
517 * rxrpc.c
519 extern int afs_open_socket(void);
520 extern void afs_close_socket(void);
521 extern int afs_make_call(struct in_addr *, struct afs_call *, gfp_t,
522 const struct afs_wait_mode *);
523 extern struct afs_call *afs_alloc_flat_call(const struct afs_call_type *,
524 size_t, size_t);
525 extern void afs_flat_call_destructor(struct afs_call *);
526 extern void afs_transfer_reply(struct afs_call *, struct sk_buff *);
527 extern void afs_send_empty_reply(struct afs_call *);
528 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
529 extern int afs_extract_data(struct afs_call *, struct sk_buff *, bool, void *,
530 size_t);
533 * security.c
535 extern void afs_clear_permits(struct afs_vnode *);
536 extern void afs_cache_permit(struct afs_vnode *, struct key *, long);
537 extern struct key *afs_request_key(struct afs_cell *);
538 extern int afs_permission(struct inode *, int, struct nameidata *);
541 * server.c
543 extern spinlock_t afs_server_peer_lock;
545 #define afs_get_server(S) \
546 do { \
547 _debug("GET SERVER %d", atomic_read(&(S)->usage)); \
548 atomic_inc(&(S)->usage); \
549 } while(0)
551 extern struct afs_server *afs_lookup_server(struct afs_cell *,
552 const struct in_addr *);
553 extern struct afs_server *afs_find_server(const struct in_addr *);
554 extern void afs_put_server(struct afs_server *);
555 extern void __exit afs_purge_servers(void);
558 * super.c
560 extern int afs_fs_init(void);
561 extern void afs_fs_exit(void);
564 * use-rtnetlink.c
566 extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
567 extern int afs_get_MAC_address(u8 [6]);
570 * vlclient.c
572 #ifdef AFS_CACHING_SUPPORT
573 extern struct cachefs_index_def afs_vlocation_cache_index_def;
574 #endif
576 extern int afs_vl_get_entry_by_name(struct in_addr *, struct key *,
577 const char *, struct afs_cache_vlocation *,
578 const struct afs_wait_mode *);
579 extern int afs_vl_get_entry_by_id(struct in_addr *, struct key *,
580 afs_volid_t, afs_voltype_t,
581 struct afs_cache_vlocation *,
582 const struct afs_wait_mode *);
585 * vlocation.c
587 #define afs_get_vlocation(V) do { atomic_inc(&(V)->usage); } while(0)
589 extern int __init afs_vlocation_update_init(void);
590 extern struct afs_vlocation *afs_vlocation_lookup(struct afs_cell *,
591 struct key *,
592 const char *, size_t);
593 extern void afs_put_vlocation(struct afs_vlocation *);
594 extern void __exit afs_vlocation_purge(void);
597 * vnode.c
599 #ifdef AFS_CACHING_SUPPORT
600 extern struct cachefs_index_def afs_vnode_cache_index_def;
601 #endif
603 extern struct afs_timer_ops afs_vnode_cb_timed_out_ops;
605 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
607 return container_of(inode, struct afs_vnode, vfs_inode);
610 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
612 return &vnode->vfs_inode;
615 extern void afs_vnode_finalise_status_update(struct afs_vnode *,
616 struct afs_server *);
617 extern int afs_vnode_fetch_status(struct afs_vnode *, struct afs_vnode *,
618 struct key *);
619 extern int afs_vnode_fetch_data(struct afs_vnode *, struct key *,
620 off_t, size_t, struct page *);
621 extern int afs_vnode_create(struct afs_vnode *, struct key *, const char *,
622 umode_t, struct afs_fid *, struct afs_file_status *,
623 struct afs_callback *, struct afs_server **);
624 extern int afs_vnode_remove(struct afs_vnode *, struct key *, const char *,
625 bool);
626 extern int afs_vnode_link(struct afs_vnode *, struct afs_vnode *, struct key *,
627 const char *);
628 extern int afs_vnode_symlink(struct afs_vnode *, struct key *, const char *,
629 const char *, struct afs_fid *,
630 struct afs_file_status *, struct afs_server **);
631 extern int afs_vnode_rename(struct afs_vnode *, struct afs_vnode *,
632 struct key *, const char *, const char *);
635 * volume.c
637 #ifdef AFS_CACHING_SUPPORT
638 extern struct cachefs_index_def afs_volume_cache_index_def;
639 #endif
641 #define afs_get_volume(V) do { atomic_inc(&(V)->usage); } while(0)
643 extern void afs_put_volume(struct afs_volume *);
644 extern struct afs_volume *afs_volume_lookup(struct afs_mount_params *);
645 extern struct afs_server *afs_volume_pick_fileserver(struct afs_vnode *);
646 extern int afs_volume_release_fileserver(struct afs_vnode *,
647 struct afs_server *, int);
649 /*****************************************************************************/
651 * debug tracing
653 extern unsigned afs_debug;
655 #define dbgprintk(FMT,...) \
656 printk("[%x%-6.6s] "FMT"\n", smp_processor_id(), current->comm ,##__VA_ARGS__)
658 /* make sure we maintain the format strings, even when debugging is disabled */
659 static inline __attribute__((format(printf,1,2)))
660 void _dbprintk(const char *fmt, ...)
664 #define kenter(FMT,...) dbgprintk("==> %s("FMT")",__FUNCTION__ ,##__VA_ARGS__)
665 #define kleave(FMT,...) dbgprintk("<== %s()"FMT"",__FUNCTION__ ,##__VA_ARGS__)
666 #define kdebug(FMT,...) dbgprintk(" "FMT ,##__VA_ARGS__)
669 #if defined(__KDEBUG)
670 #define _enter(FMT,...) kenter(FMT,##__VA_ARGS__)
671 #define _leave(FMT,...) kleave(FMT,##__VA_ARGS__)
672 #define _debug(FMT,...) kdebug(FMT,##__VA_ARGS__)
674 #elif defined(CONFIG_AFS_DEBUG)
675 #define AFS_DEBUG_KENTER 0x01
676 #define AFS_DEBUG_KLEAVE 0x02
677 #define AFS_DEBUG_KDEBUG 0x04
679 #define _enter(FMT,...) \
680 do { \
681 if (unlikely(afs_debug & AFS_DEBUG_KENTER)) \
682 kenter(FMT,##__VA_ARGS__); \
683 } while (0)
685 #define _leave(FMT,...) \
686 do { \
687 if (unlikely(afs_debug & AFS_DEBUG_KLEAVE)) \
688 kleave(FMT,##__VA_ARGS__); \
689 } while (0)
691 #define _debug(FMT,...) \
692 do { \
693 if (unlikely(afs_debug & AFS_DEBUG_KDEBUG)) \
694 kdebug(FMT,##__VA_ARGS__); \
695 } while (0)
697 #else
698 #define _enter(FMT,...) _dbprintk("==> %s("FMT")",__FUNCTION__ ,##__VA_ARGS__)
699 #define _leave(FMT,...) _dbprintk("<== %s()"FMT"",__FUNCTION__ ,##__VA_ARGS__)
700 #define _debug(FMT,...) _dbprintk(" "FMT ,##__VA_ARGS__)
701 #endif
704 * debug assertion checking
706 #if 1 // defined(__KDEBUGALL)
708 #define ASSERT(X) \
709 do { \
710 if (unlikely(!(X))) { \
711 printk(KERN_ERR "\n"); \
712 printk(KERN_ERR "AFS: Assertion failed\n"); \
713 BUG(); \
715 } while(0)
717 #define ASSERTCMP(X, OP, Y) \
718 do { \
719 if (unlikely(!((X) OP (Y)))) { \
720 printk(KERN_ERR "\n"); \
721 printk(KERN_ERR "AFS: Assertion failed\n"); \
722 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
723 (unsigned long)(X), (unsigned long)(Y)); \
724 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
725 (unsigned long)(X), (unsigned long)(Y)); \
726 BUG(); \
728 } while(0)
730 #define ASSERTIF(C, X) \
731 do { \
732 if (unlikely((C) && !(X))) { \
733 printk(KERN_ERR "\n"); \
734 printk(KERN_ERR "AFS: Assertion failed\n"); \
735 BUG(); \
737 } while(0)
739 #define ASSERTIFCMP(C, X, OP, Y) \
740 do { \
741 if (unlikely((C) && !((X) OP (Y)))) { \
742 printk(KERN_ERR "\n"); \
743 printk(KERN_ERR "AFS: Assertion failed\n"); \
744 printk(KERN_ERR "%lu " #OP " %lu is false\n", \
745 (unsigned long)(X), (unsigned long)(Y)); \
746 printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n", \
747 (unsigned long)(X), (unsigned long)(Y)); \
748 BUG(); \
750 } while(0)
752 #else
754 #define ASSERT(X) \
755 do { \
756 } while(0)
758 #define ASSERTCMP(X, OP, Y) \
759 do { \
760 } while(0)
762 #define ASSERTIF(C, X) \
763 do { \
764 } while(0)
766 #define ASSERTIFCMP(C, X, OP, Y) \
767 do { \
768 } while(0)
770 #endif /* __KDEBUGALL */