xref: /openbmc/linux/fs/afs/internal.h (revision 8e8d7f13b6d5a93b3d2cf9a4ceaaf923809fd5ac)
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/rxrpc.h>
17 #include <linux/key.h>
18 #include <linux/workqueue.h>
19 #include <linux/sched.h>
20 #include <linux/fscache.h>
21 #include <linux/backing-dev.h>
22 #include <net/af_rxrpc.h>
23 
24 #include "afs.h"
25 #include "afs_vl.h"
26 
27 #define AFS_CELL_MAX_ADDRS 15
28 
29 struct pagevec;
30 struct afs_call;
31 
32 typedef enum {
33 	AFS_VL_NEW,			/* new, uninitialised record */
34 	AFS_VL_CREATING,		/* creating record */
35 	AFS_VL_VALID,			/* record is pending */
36 	AFS_VL_NO_VOLUME,		/* no such volume available */
37 	AFS_VL_UPDATING,		/* update in progress */
38 	AFS_VL_VOLUME_DELETED,		/* volume was deleted */
39 	AFS_VL_UNCERTAIN,		/* uncertain state (update failed) */
40 } __attribute__((packed)) afs_vlocation_state_t;
41 
42 struct afs_mount_params {
43 	bool			rwpath;		/* T if the parent should be considered R/W */
44 	bool			force;		/* T to force cell type */
45 	bool			autocell;	/* T if set auto mount operation */
46 	afs_voltype_t		type;		/* type of volume requested */
47 	int			volnamesz;	/* size of volume name */
48 	const char		*volname;	/* name of volume to mount */
49 	struct afs_cell		*cell;		/* cell in which to find volume */
50 	struct afs_volume	*volume;	/* volume record */
51 	struct key		*key;		/* key to use for secure mounting */
52 };
53 
54 /*
55  * definition of how to wait for the completion of an operation
56  */
57 struct afs_wait_mode {
58 	/* RxRPC received message notification */
59 	rxrpc_notify_rx_t notify_rx;
60 
61 	/* synchronous call waiter and call dispatched notification */
62 	int (*wait)(struct afs_call *call);
63 
64 	/* asynchronous call completion */
65 	void (*async_complete)(void *reply, int error);
66 };
67 
68 extern const struct afs_wait_mode afs_sync_call;
69 extern const struct afs_wait_mode afs_async_call;
70 
71 enum afs_call_state {
72 	AFS_CALL_REQUESTING,	/* request is being sent for outgoing call */
73 	AFS_CALL_AWAIT_REPLY,	/* awaiting reply to outgoing call */
74 	AFS_CALL_AWAIT_OP_ID,	/* awaiting op ID on incoming call */
75 	AFS_CALL_AWAIT_REQUEST,	/* awaiting request data on incoming call */
76 	AFS_CALL_REPLYING,	/* replying to incoming call */
77 	AFS_CALL_AWAIT_ACK,	/* awaiting final ACK of incoming call */
78 	AFS_CALL_COMPLETE,	/* Completed or failed */
79 };
80 /*
81  * a record of an in-progress RxRPC call
82  */
83 struct afs_call {
84 	const struct afs_call_type *type;	/* type of call */
85 	const struct afs_wait_mode *wait_mode;	/* completion wait mode */
86 	wait_queue_head_t	waitq;		/* processes awaiting completion */
87 	struct work_struct	async_work;	/* asynchronous work processor */
88 	struct work_struct	work;		/* actual work processor */
89 	struct rxrpc_call	*rxcall;	/* RxRPC call handle */
90 	struct key		*key;		/* security for this call */
91 	struct afs_server	*server;	/* server affected by incoming CM call */
92 	void			*request;	/* request data (first part) */
93 	struct address_space	*mapping;	/* page set */
94 	struct afs_writeback	*wb;		/* writeback being performed */
95 	void			*buffer;	/* reply receive buffer */
96 	void			*reply;		/* reply buffer (first part) */
97 	void			*reply2;	/* reply buffer (second part) */
98 	void			*reply3;	/* reply buffer (third part) */
99 	void			*reply4;	/* reply buffer (fourth part) */
100 	pgoff_t			first;		/* first page in mapping to deal with */
101 	pgoff_t			last;		/* last page in mapping to deal with */
102 	size_t			offset;		/* offset into received data store */
103 	enum afs_call_state	state;
104 	int			error;		/* error code */
105 	u32			abort_code;	/* Remote abort ID or 0 */
106 	unsigned		request_size;	/* size of request data */
107 	unsigned		reply_max;	/* maximum size of reply */
108 	unsigned		first_offset;	/* offset into mapping[first] */
109 	unsigned		last_to;	/* amount of mapping[last] */
110 	unsigned char		unmarshall;	/* unmarshalling phase */
111 	bool			incoming;	/* T if incoming call */
112 	bool			send_pages;	/* T if data from mapping should be sent */
113 	bool			need_attention;	/* T if RxRPC poked us */
114 	u16			service_id;	/* RxRPC service ID to call */
115 	__be16			port;		/* target UDP port */
116 	u32			operation_ID;	/* operation ID for an incoming call */
117 	u32			count;		/* count for use in unmarshalling */
118 	__be32			tmp;		/* place to extract temporary data */
119 	afs_dataversion_t	store_version;	/* updated version expected from store */
120 };
121 
122 struct afs_call_type {
123 	const char *name;
124 
125 	/* deliver request or reply data to an call
126 	 * - returning an error will cause the call to be aborted
127 	 */
128 	int (*deliver)(struct afs_call *call);
129 
130 	/* map an abort code to an error number */
131 	int (*abort_to_error)(u32 abort_code);
132 
133 	/* clean up a call */
134 	void (*destructor)(struct afs_call *call);
135 };
136 
137 /*
138  * Record of an outstanding read operation on a vnode.
139  */
140 struct afs_read {
141 	loff_t			pos;		/* Where to start reading */
142 	loff_t			len;		/* How much to read */
143 	loff_t			actual_len;	/* How much we're actually getting */
144 	atomic_t		usage;
145 	unsigned int		remain;		/* Amount remaining */
146 	unsigned int		index;		/* Which page we're reading into */
147 	unsigned int		pg_offset;	/* Offset in page we're at */
148 	unsigned int		nr_pages;
149 	void (*page_done)(struct afs_call *, struct afs_read *);
150 	struct page		*pages[];
151 };
152 
153 /*
154  * record of an outstanding writeback on a vnode
155  */
156 struct afs_writeback {
157 	struct list_head	link;		/* link in vnode->writebacks */
158 	struct work_struct	writer;		/* work item to perform the writeback */
159 	struct afs_vnode	*vnode;		/* vnode to which this write applies */
160 	struct key		*key;		/* owner of this write */
161 	wait_queue_head_t	waitq;		/* completion and ready wait queue */
162 	pgoff_t			first;		/* first page in batch */
163 	pgoff_t			point;		/* last page in current store op */
164 	pgoff_t			last;		/* last page in batch (inclusive) */
165 	unsigned		offset_first;	/* offset into first page of start of write */
166 	unsigned		to_last;	/* offset into last page of end of write */
167 	int			num_conflicts;	/* count of conflicting writes in list */
168 	int			usage;
169 	bool			conflicts;	/* T if has dependent conflicts */
170 	enum {
171 		AFS_WBACK_SYNCING,		/* synchronisation being performed */
172 		AFS_WBACK_PENDING,		/* write pending */
173 		AFS_WBACK_CONFLICTING,		/* conflicting writes posted */
174 		AFS_WBACK_WRITING,		/* writing back */
175 		AFS_WBACK_COMPLETE		/* the writeback record has been unlinked */
176 	} state __attribute__((packed));
177 };
178 
179 /*
180  * AFS superblock private data
181  * - there's one superblock per volume
182  */
183 struct afs_super_info {
184 	struct afs_volume	*volume;	/* volume record */
185 	char			rwparent;	/* T if parent is R/W AFS volume */
186 };
187 
188 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
189 {
190 	return sb->s_fs_info;
191 }
192 
193 extern struct file_system_type afs_fs_type;
194 
195 /*
196  * entry in the cached cell catalogue
197  */
198 struct afs_cache_cell {
199 	char		name[AFS_MAXCELLNAME];	/* cell name (padded with NULs) */
200 	struct in_addr	vl_servers[15];		/* cached cell VL servers */
201 };
202 
203 /*
204  * AFS cell record
205  */
206 struct afs_cell {
207 	atomic_t		usage;
208 	struct list_head	link;		/* main cell list link */
209 	struct key		*anonymous_key;	/* anonymous user key for this cell */
210 	struct list_head	proc_link;	/* /proc cell list link */
211 #ifdef CONFIG_AFS_FSCACHE
212 	struct fscache_cookie	*cache;		/* caching cookie */
213 #endif
214 
215 	/* server record management */
216 	rwlock_t		servers_lock;	/* active server list lock */
217 	struct list_head	servers;	/* active server list */
218 
219 	/* volume location record management */
220 	struct rw_semaphore	vl_sem;		/* volume management serialisation semaphore */
221 	struct list_head	vl_list;	/* cell's active VL record list */
222 	spinlock_t		vl_lock;	/* vl_list lock */
223 	unsigned short		vl_naddrs;	/* number of VL servers in addr list */
224 	unsigned short		vl_curr_svix;	/* current server index */
225 	struct in_addr		vl_addrs[AFS_CELL_MAX_ADDRS];	/* cell VL server addresses */
226 
227 	char			name[0];	/* cell name - must go last */
228 };
229 
230 /*
231  * entry in the cached volume location catalogue
232  */
233 struct afs_cache_vlocation {
234 	/* volume name (lowercase, padded with NULs) */
235 	uint8_t			name[AFS_MAXVOLNAME + 1];
236 
237 	uint8_t			nservers;	/* number of entries used in servers[] */
238 	uint8_t			vidmask;	/* voltype mask for vid[] */
239 	uint8_t			srvtmask[8];	/* voltype masks for servers[] */
240 #define AFS_VOL_VTM_RW	0x01 /* R/W version of the volume is available (on this server) */
241 #define AFS_VOL_VTM_RO	0x02 /* R/O version of the volume is available (on this server) */
242 #define AFS_VOL_VTM_BAK	0x04 /* backup version of the volume is available (on this server) */
243 
244 	afs_volid_t		vid[3];		/* volume IDs for R/W, R/O and Bak volumes */
245 	struct in_addr		servers[8];	/* fileserver addresses */
246 	time_t			rtime;		/* last retrieval time */
247 };
248 
249 /*
250  * volume -> vnode hash table entry
251  */
252 struct afs_cache_vhash {
253 	afs_voltype_t		vtype;		/* which volume variation */
254 	uint8_t			hash_bucket;	/* which hash bucket this represents */
255 } __attribute__((packed));
256 
257 /*
258  * AFS volume location record
259  */
260 struct afs_vlocation {
261 	atomic_t		usage;
262 	time_t			time_of_death;	/* time at which put reduced usage to 0 */
263 	struct list_head	link;		/* link in cell volume location list */
264 	struct list_head	grave;		/* link in master graveyard list */
265 	struct list_head	update;		/* link in master update list */
266 	struct afs_cell		*cell;		/* cell to which volume belongs */
267 #ifdef CONFIG_AFS_FSCACHE
268 	struct fscache_cookie	*cache;		/* caching cookie */
269 #endif
270 	struct afs_cache_vlocation vldb;	/* volume information DB record */
271 	struct afs_volume	*vols[3];	/* volume access record pointer (index by type) */
272 	wait_queue_head_t	waitq;		/* status change waitqueue */
273 	time_t			update_at;	/* time at which record should be updated */
274 	spinlock_t		lock;		/* access lock */
275 	afs_vlocation_state_t	state;		/* volume location state */
276 	unsigned short		upd_rej_cnt;	/* ENOMEDIUM count during update */
277 	unsigned short		upd_busy_cnt;	/* EBUSY count during update */
278 	bool			valid;		/* T if valid */
279 };
280 
281 /*
282  * AFS fileserver record
283  */
284 struct afs_server {
285 	atomic_t		usage;
286 	time_t			time_of_death;	/* time at which put reduced usage to 0 */
287 	struct in_addr		addr;		/* server address */
288 	struct afs_cell		*cell;		/* cell in which server resides */
289 	struct list_head	link;		/* link in cell's server list */
290 	struct list_head	grave;		/* link in master graveyard list */
291 	struct rb_node		master_rb;	/* link in master by-addr tree */
292 	struct rw_semaphore	sem;		/* access lock */
293 
294 	/* file service access */
295 	struct rb_root		fs_vnodes;	/* vnodes backed by this server (ordered by FID) */
296 	unsigned long		fs_act_jif;	/* time at which last activity occurred */
297 	unsigned long		fs_dead_jif;	/* time at which no longer to be considered dead */
298 	spinlock_t		fs_lock;	/* access lock */
299 	int			fs_state;      	/* 0 or reason FS currently marked dead (-errno) */
300 
301 	/* callback promise management */
302 	struct rb_root		cb_promises;	/* vnode expiration list (ordered earliest first) */
303 	struct delayed_work	cb_updater;	/* callback updater */
304 	struct delayed_work	cb_break_work;	/* collected break dispatcher */
305 	wait_queue_head_t	cb_break_waitq;	/* space available in cb_break waitqueue */
306 	spinlock_t		cb_lock;	/* access lock */
307 	struct afs_callback	cb_break[64];	/* ring of callbacks awaiting breaking */
308 	atomic_t		cb_break_n;	/* number of pending breaks */
309 	u8			cb_break_head;	/* head of callback breaking ring */
310 	u8			cb_break_tail;	/* tail of callback breaking ring */
311 };
312 
313 /*
314  * AFS volume access record
315  */
316 struct afs_volume {
317 	atomic_t		usage;
318 	struct afs_cell		*cell;		/* cell to which belongs (unrefd ptr) */
319 	struct afs_vlocation	*vlocation;	/* volume location */
320 #ifdef CONFIG_AFS_FSCACHE
321 	struct fscache_cookie	*cache;		/* caching cookie */
322 #endif
323 	afs_volid_t		vid;		/* volume ID */
324 	afs_voltype_t		type;		/* type of volume */
325 	char			type_force;	/* force volume type (suppress R/O -> R/W) */
326 	unsigned short		nservers;	/* number of server slots filled */
327 	unsigned short		rjservers;	/* number of servers discarded due to -ENOMEDIUM */
328 	struct afs_server	*servers[8];	/* servers on which volume resides (ordered) */
329 	struct rw_semaphore	server_sem;	/* lock for accessing current server */
330 	struct backing_dev_info	bdi;
331 };
332 
333 /*
334  * vnode catalogue entry
335  */
336 struct afs_cache_vnode {
337 	afs_vnodeid_t		vnode_id;	/* vnode ID */
338 	unsigned		vnode_unique;	/* vnode ID uniquifier */
339 	afs_dataversion_t	data_version;	/* data version */
340 };
341 
342 /*
343  * AFS inode private data
344  */
345 struct afs_vnode {
346 	struct inode		vfs_inode;	/* the VFS's inode record */
347 
348 	struct afs_volume	*volume;	/* volume on which vnode resides */
349 	struct afs_server	*server;	/* server currently supplying this file */
350 	struct afs_fid		fid;		/* the file identifier for this inode */
351 	struct afs_file_status	status;		/* AFS status info for this file */
352 #ifdef CONFIG_AFS_FSCACHE
353 	struct fscache_cookie	*cache;		/* caching cookie */
354 #endif
355 	struct afs_permits	*permits;	/* cache of permits so far obtained */
356 	struct mutex		permits_lock;	/* lock for altering permits list */
357 	struct mutex		validate_lock;	/* lock for validating this vnode */
358 	wait_queue_head_t	update_waitq;	/* status fetch waitqueue */
359 	int			update_cnt;	/* number of outstanding ops that will update the
360 						 * status */
361 	spinlock_t		writeback_lock;	/* lock for writebacks */
362 	spinlock_t		lock;		/* waitqueue/flags lock */
363 	unsigned long		flags;
364 #define AFS_VNODE_CB_BROKEN	0		/* set if vnode's callback was broken */
365 #define AFS_VNODE_UNSET		1		/* set if vnode attributes not yet set */
366 #define AFS_VNODE_MODIFIED	2		/* set if vnode's data modified */
367 #define AFS_VNODE_ZAP_DATA	3		/* set if vnode's data should be invalidated */
368 #define AFS_VNODE_DELETED	4		/* set if vnode deleted on server */
369 #define AFS_VNODE_MOUNTPOINT	5		/* set if vnode is a mountpoint symlink */
370 #define AFS_VNODE_LOCKING	6		/* set if waiting for lock on vnode */
371 #define AFS_VNODE_READLOCKED	7		/* set if vnode is read-locked on the server */
372 #define AFS_VNODE_WRITELOCKED	8		/* set if vnode is write-locked on the server */
373 #define AFS_VNODE_UNLOCKING	9		/* set if vnode is being unlocked on the server */
374 #define AFS_VNODE_AUTOCELL	10		/* set if Vnode is an auto mount point */
375 #define AFS_VNODE_PSEUDODIR	11		/* set if Vnode is a pseudo directory */
376 
377 	long			acl_order;	/* ACL check count (callback break count) */
378 
379 	struct list_head	writebacks;	/* alterations in pagecache that need writing */
380 	struct list_head	pending_locks;	/* locks waiting to be granted */
381 	struct list_head	granted_locks;	/* locks granted on this file */
382 	struct delayed_work	lock_work;	/* work to be done in locking */
383 	struct key		*unlock_key;	/* key to be used in unlocking */
384 
385 	/* outstanding callback notification on this file */
386 	struct rb_node		server_rb;	/* link in server->fs_vnodes */
387 	struct rb_node		cb_promise;	/* link in server->cb_promises */
388 	struct work_struct	cb_broken_work;	/* work to be done on callback break */
389 	time_t			cb_expires;	/* time at which callback expires */
390 	time_t			cb_expires_at;	/* time used to order cb_promise */
391 	unsigned		cb_version;	/* callback version */
392 	unsigned		cb_expiry;	/* callback expiry time */
393 	afs_callback_type_t	cb_type;	/* type of callback */
394 	bool			cb_promised;	/* true if promise still holds */
395 };
396 
397 /*
398  * cached security record for one user's attempt to access a vnode
399  */
400 struct afs_permit {
401 	struct key		*key;		/* RxRPC ticket holding a security context */
402 	afs_access_t		access_mask;	/* access mask for this key */
403 };
404 
405 /*
406  * cache of security records from attempts to access a vnode
407  */
408 struct afs_permits {
409 	struct rcu_head		rcu;		/* disposal procedure */
410 	int			count;		/* number of records */
411 	struct afs_permit	permits[0];	/* the permits so far examined */
412 };
413 
414 /*
415  * record of one of a system's set of network interfaces
416  */
417 struct afs_interface {
418 	struct in_addr	address;	/* IPv4 address bound to interface */
419 	struct in_addr	netmask;	/* netmask applied to address */
420 	unsigned	mtu;		/* MTU of interface */
421 };
422 
423 /*
424  * UUID definition [internet draft]
425  * - the timestamp is a 60-bit value, split 32/16/12, and goes in 100ns
426  *   increments since midnight 15th October 1582
427  *   - add AFS_UUID_TO_UNIX_TIME to convert unix time in 100ns units to UUID
428  *     time
429  * - the clock sequence is a 14-bit counter to avoid duplicate times
430  */
431 struct afs_uuid {
432 	u32		time_low;			/* low part of timestamp */
433 	u16		time_mid;			/* mid part of timestamp */
434 	u16		time_hi_and_version;		/* high part of timestamp and version  */
435 #define AFS_UUID_TO_UNIX_TIME	0x01b21dd213814000ULL
436 #define AFS_UUID_TIMEHI_MASK	0x0fff
437 #define AFS_UUID_VERSION_TIME	0x1000	/* time-based UUID */
438 #define AFS_UUID_VERSION_NAME	0x3000	/* name-based UUID */
439 #define AFS_UUID_VERSION_RANDOM	0x4000	/* (pseudo-)random generated UUID */
440 	u8		clock_seq_hi_and_reserved;	/* clock seq hi and variant */
441 #define AFS_UUID_CLOCKHI_MASK	0x3f
442 #define AFS_UUID_VARIANT_STD	0x80
443 	u8		clock_seq_low;			/* clock seq low */
444 	u8		node[6];			/* spatially unique node ID (MAC addr) */
445 };
446 
447 /*****************************************************************************/
448 /*
449  * cache.c
450  */
451 #ifdef CONFIG_AFS_FSCACHE
452 extern struct fscache_netfs afs_cache_netfs;
453 extern struct fscache_cookie_def afs_cell_cache_index_def;
454 extern struct fscache_cookie_def afs_vlocation_cache_index_def;
455 extern struct fscache_cookie_def afs_volume_cache_index_def;
456 extern struct fscache_cookie_def afs_vnode_cache_index_def;
457 #else
458 #define afs_cell_cache_index_def	(*(struct fscache_cookie_def *) NULL)
459 #define afs_vlocation_cache_index_def	(*(struct fscache_cookie_def *) NULL)
460 #define afs_volume_cache_index_def	(*(struct fscache_cookie_def *) NULL)
461 #define afs_vnode_cache_index_def	(*(struct fscache_cookie_def *) NULL)
462 #endif
463 
464 /*
465  * callback.c
466  */
467 extern void afs_init_callback_state(struct afs_server *);
468 extern void afs_broken_callback_work(struct work_struct *);
469 extern void afs_break_callbacks(struct afs_server *, size_t,
470 				struct afs_callback[]);
471 extern void afs_discard_callback_on_delete(struct afs_vnode *);
472 extern void afs_give_up_callback(struct afs_vnode *);
473 extern void afs_dispatch_give_up_callbacks(struct work_struct *);
474 extern void afs_flush_callback_breaks(struct afs_server *);
475 extern int __init afs_callback_update_init(void);
476 extern void afs_callback_update_kill(void);
477 
478 /*
479  * cell.c
480  */
481 extern struct rw_semaphore afs_proc_cells_sem;
482 extern struct list_head afs_proc_cells;
483 
484 #define afs_get_cell(C) do { atomic_inc(&(C)->usage); } while(0)
485 extern int afs_cell_init(char *);
486 extern struct afs_cell *afs_cell_create(const char *, unsigned, char *, bool);
487 extern struct afs_cell *afs_cell_lookup(const char *, unsigned, bool);
488 extern struct afs_cell *afs_grab_cell(struct afs_cell *);
489 extern void afs_put_cell(struct afs_cell *);
490 extern void afs_cell_purge(void);
491 
492 /*
493  * cmservice.c
494  */
495 extern bool afs_cm_incoming_call(struct afs_call *);
496 
497 /*
498  * dir.c
499  */
500 extern const struct inode_operations afs_dir_inode_operations;
501 extern const struct dentry_operations afs_fs_dentry_operations;
502 extern const struct file_operations afs_dir_file_operations;
503 
504 /*
505  * file.c
506  */
507 extern const struct address_space_operations afs_fs_aops;
508 extern const struct inode_operations afs_file_inode_operations;
509 extern const struct file_operations afs_file_operations;
510 
511 extern int afs_open(struct inode *, struct file *);
512 extern int afs_release(struct inode *, struct file *);
513 extern int afs_page_filler(void *, struct page *);
514 extern void afs_put_read(struct afs_read *);
515 
516 /*
517  * flock.c
518  */
519 extern void __exit afs_kill_lock_manager(void);
520 extern void afs_lock_work(struct work_struct *);
521 extern void afs_lock_may_be_available(struct afs_vnode *);
522 extern int afs_lock(struct file *, int, struct file_lock *);
523 extern int afs_flock(struct file *, int, struct file_lock *);
524 
525 /*
526  * fsclient.c
527  */
528 extern int afs_fs_fetch_file_status(struct afs_server *, struct key *,
529 				    struct afs_vnode *, struct afs_volsync *,
530 				    const struct afs_wait_mode *);
531 extern int afs_fs_give_up_callbacks(struct afs_server *,
532 				    const struct afs_wait_mode *);
533 extern int afs_fs_fetch_data(struct afs_server *, struct key *,
534 			     struct afs_vnode *, struct afs_read *,
535 			     const struct afs_wait_mode *);
536 extern int afs_fs_create(struct afs_server *, struct key *,
537 			 struct afs_vnode *, const char *, umode_t,
538 			 struct afs_fid *, struct afs_file_status *,
539 			 struct afs_callback *,
540 			 const struct afs_wait_mode *);
541 extern int afs_fs_remove(struct afs_server *, struct key *,
542 			 struct afs_vnode *, const char *, bool,
543 			 const struct afs_wait_mode *);
544 extern int afs_fs_link(struct afs_server *, struct key *, struct afs_vnode *,
545 		       struct afs_vnode *, const char *,
546 		       const struct afs_wait_mode *);
547 extern int afs_fs_symlink(struct afs_server *, struct key *,
548 			  struct afs_vnode *, const char *, const char *,
549 			  struct afs_fid *, struct afs_file_status *,
550 			  const struct afs_wait_mode *);
551 extern int afs_fs_rename(struct afs_server *, struct key *,
552 			 struct afs_vnode *, const char *,
553 			 struct afs_vnode *, const char *,
554 			 const struct afs_wait_mode *);
555 extern int afs_fs_store_data(struct afs_server *, struct afs_writeback *,
556 			     pgoff_t, pgoff_t, unsigned, unsigned,
557 			     const struct afs_wait_mode *);
558 extern int afs_fs_setattr(struct afs_server *, struct key *,
559 			  struct afs_vnode *, struct iattr *,
560 			  const struct afs_wait_mode *);
561 extern int afs_fs_get_volume_status(struct afs_server *, struct key *,
562 				    struct afs_vnode *,
563 				    struct afs_volume_status *,
564 				    const struct afs_wait_mode *);
565 extern int afs_fs_set_lock(struct afs_server *, struct key *,
566 			   struct afs_vnode *, afs_lock_type_t,
567 			   const struct afs_wait_mode *);
568 extern int afs_fs_extend_lock(struct afs_server *, struct key *,
569 			      struct afs_vnode *,
570 			      const struct afs_wait_mode *);
571 extern int afs_fs_release_lock(struct afs_server *, struct key *,
572 			       struct afs_vnode *,
573 			       const struct afs_wait_mode *);
574 
575 /*
576  * inode.c
577  */
578 extern struct inode *afs_iget_autocell(struct inode *, const char *, int,
579 				       struct key *);
580 extern struct inode *afs_iget(struct super_block *, struct key *,
581 			      struct afs_fid *, struct afs_file_status *,
582 			      struct afs_callback *);
583 extern void afs_zap_data(struct afs_vnode *);
584 extern int afs_validate(struct afs_vnode *, struct key *);
585 extern int afs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
586 extern int afs_setattr(struct dentry *, struct iattr *);
587 extern void afs_evict_inode(struct inode *);
588 extern int afs_drop_inode(struct inode *);
589 
590 /*
591  * main.c
592  */
593 extern struct workqueue_struct *afs_wq;
594 extern struct afs_uuid afs_uuid;
595 
596 /*
597  * misc.c
598  */
599 extern int afs_abort_to_error(u32);
600 
601 /*
602  * mntpt.c
603  */
604 extern const struct inode_operations afs_mntpt_inode_operations;
605 extern const struct inode_operations afs_autocell_inode_operations;
606 extern const struct file_operations afs_mntpt_file_operations;
607 
608 extern struct vfsmount *afs_d_automount(struct path *);
609 extern int afs_mntpt_check_symlink(struct afs_vnode *, struct key *);
610 extern void afs_mntpt_kill_timer(void);
611 
612 /*
613  * proc.c
614  */
615 extern int afs_proc_init(void);
616 extern void afs_proc_cleanup(void);
617 extern int afs_proc_cell_setup(struct afs_cell *);
618 extern void afs_proc_cell_remove(struct afs_cell *);
619 
620 /*
621  * rxrpc.c
622  */
623 extern struct socket *afs_socket;
624 
625 extern int afs_open_socket(void);
626 extern void afs_close_socket(void);
627 extern int afs_make_call(struct in_addr *, struct afs_call *, gfp_t,
628 			 const struct afs_wait_mode *);
629 extern struct afs_call *afs_alloc_flat_call(const struct afs_call_type *,
630 					    size_t, size_t);
631 extern void afs_flat_call_destructor(struct afs_call *);
632 extern void afs_send_empty_reply(struct afs_call *);
633 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
634 extern int afs_extract_data(struct afs_call *, void *, size_t, bool);
635 
636 static inline int afs_transfer_reply(struct afs_call *call)
637 {
638 	return afs_extract_data(call, call->buffer, call->reply_max, false);
639 }
640 
641 /*
642  * security.c
643  */
644 extern void afs_clear_permits(struct afs_vnode *);
645 extern void afs_cache_permit(struct afs_vnode *, struct key *, long);
646 extern void afs_zap_permits(struct rcu_head *);
647 extern struct key *afs_request_key(struct afs_cell *);
648 extern int afs_permission(struct inode *, int);
649 
650 /*
651  * server.c
652  */
653 extern spinlock_t afs_server_peer_lock;
654 
655 #define afs_get_server(S)					\
656 do {								\
657 	_debug("GET SERVER %d", atomic_read(&(S)->usage));	\
658 	atomic_inc(&(S)->usage);				\
659 } while(0)
660 
661 extern struct afs_server *afs_lookup_server(struct afs_cell *,
662 					    const struct in_addr *);
663 extern struct afs_server *afs_find_server(const struct sockaddr_rxrpc *);
664 extern void afs_put_server(struct afs_server *);
665 extern void __exit afs_purge_servers(void);
666 
667 /*
668  * super.c
669  */
670 extern int afs_fs_init(void);
671 extern void afs_fs_exit(void);
672 
673 /*
674  * use-rtnetlink.c
675  */
676 extern int afs_get_ipv4_interfaces(struct afs_interface *, size_t, bool);
677 extern int afs_get_MAC_address(u8 *, size_t);
678 
679 /*
680  * vlclient.c
681  */
682 extern int afs_vl_get_entry_by_name(struct in_addr *, struct key *,
683 				    const char *, struct afs_cache_vlocation *,
684 				    const struct afs_wait_mode *);
685 extern int afs_vl_get_entry_by_id(struct in_addr *, struct key *,
686 				  afs_volid_t, afs_voltype_t,
687 				  struct afs_cache_vlocation *,
688 				  const struct afs_wait_mode *);
689 
690 /*
691  * vlocation.c
692  */
693 #define afs_get_vlocation(V) do { atomic_inc(&(V)->usage); } while(0)
694 
695 extern int __init afs_vlocation_update_init(void);
696 extern struct afs_vlocation *afs_vlocation_lookup(struct afs_cell *,
697 						  struct key *,
698 						  const char *, size_t);
699 extern void afs_put_vlocation(struct afs_vlocation *);
700 extern void afs_vlocation_purge(void);
701 
702 /*
703  * vnode.c
704  */
705 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
706 {
707 	return container_of(inode, struct afs_vnode, vfs_inode);
708 }
709 
710 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
711 {
712 	return &vnode->vfs_inode;
713 }
714 
715 extern void afs_vnode_finalise_status_update(struct afs_vnode *,
716 					     struct afs_server *);
717 extern int afs_vnode_fetch_status(struct afs_vnode *, struct afs_vnode *,
718 				  struct key *);
719 extern int afs_vnode_fetch_data(struct afs_vnode *, struct key *,
720 				struct afs_read *);
721 extern int afs_vnode_create(struct afs_vnode *, struct key *, const char *,
722 			    umode_t, struct afs_fid *, struct afs_file_status *,
723 			    struct afs_callback *, struct afs_server **);
724 extern int afs_vnode_remove(struct afs_vnode *, struct key *, const char *,
725 			    bool);
726 extern int afs_vnode_link(struct afs_vnode *, struct afs_vnode *, struct key *,
727 			  const char *);
728 extern int afs_vnode_symlink(struct afs_vnode *, struct key *, const char *,
729 			     const char *, struct afs_fid *,
730 			     struct afs_file_status *, struct afs_server **);
731 extern int afs_vnode_rename(struct afs_vnode *, struct afs_vnode *,
732 			    struct key *, const char *, const char *);
733 extern int afs_vnode_store_data(struct afs_writeback *, pgoff_t, pgoff_t,
734 				unsigned, unsigned);
735 extern int afs_vnode_setattr(struct afs_vnode *, struct key *, struct iattr *);
736 extern int afs_vnode_get_volume_status(struct afs_vnode *, struct key *,
737 				       struct afs_volume_status *);
738 extern int afs_vnode_set_lock(struct afs_vnode *, struct key *,
739 			      afs_lock_type_t);
740 extern int afs_vnode_extend_lock(struct afs_vnode *, struct key *);
741 extern int afs_vnode_release_lock(struct afs_vnode *, struct key *);
742 
743 /*
744  * volume.c
745  */
746 #define afs_get_volume(V) do { atomic_inc(&(V)->usage); } while(0)
747 
748 extern void afs_put_volume(struct afs_volume *);
749 extern struct afs_volume *afs_volume_lookup(struct afs_mount_params *);
750 extern struct afs_server *afs_volume_pick_fileserver(struct afs_vnode *);
751 extern int afs_volume_release_fileserver(struct afs_vnode *,
752 					 struct afs_server *, int);
753 
754 /*
755  * write.c
756  */
757 extern int afs_set_page_dirty(struct page *);
758 extern void afs_put_writeback(struct afs_writeback *);
759 extern int afs_write_begin(struct file *file, struct address_space *mapping,
760 			loff_t pos, unsigned len, unsigned flags,
761 			struct page **pagep, void **fsdata);
762 extern int afs_write_end(struct file *file, struct address_space *mapping,
763 			loff_t pos, unsigned len, unsigned copied,
764 			struct page *page, void *fsdata);
765 extern int afs_writepage(struct page *, struct writeback_control *);
766 extern int afs_writepages(struct address_space *, struct writeback_control *);
767 extern void afs_pages_written_back(struct afs_vnode *, struct afs_call *);
768 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
769 extern int afs_writeback_all(struct afs_vnode *);
770 extern int afs_fsync(struct file *, loff_t, loff_t, int);
771 
772 
773 /*****************************************************************************/
774 /*
775  * debug tracing
776  */
777 #include <trace/events/afs.h>
778 
779 extern unsigned afs_debug;
780 
781 #define dbgprintk(FMT,...) \
782 	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
783 
784 #define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
785 #define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
786 #define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
787 
788 
789 #if defined(__KDEBUG)
790 #define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
791 #define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
792 #define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
793 
794 #elif defined(CONFIG_AFS_DEBUG)
795 #define AFS_DEBUG_KENTER	0x01
796 #define AFS_DEBUG_KLEAVE	0x02
797 #define AFS_DEBUG_KDEBUG	0x04
798 
799 #define _enter(FMT,...)					\
800 do {							\
801 	if (unlikely(afs_debug & AFS_DEBUG_KENTER))	\
802 		kenter(FMT,##__VA_ARGS__);		\
803 } while (0)
804 
805 #define _leave(FMT,...)					\
806 do {							\
807 	if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))	\
808 		kleave(FMT,##__VA_ARGS__);		\
809 } while (0)
810 
811 #define _debug(FMT,...)					\
812 do {							\
813 	if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))	\
814 		kdebug(FMT,##__VA_ARGS__);		\
815 } while (0)
816 
817 #else
818 #define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
819 #define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
820 #define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
821 #endif
822 
823 /*
824  * debug assertion checking
825  */
826 #if 1 // defined(__KDEBUGALL)
827 
828 #define ASSERT(X)						\
829 do {								\
830 	if (unlikely(!(X))) {					\
831 		printk(KERN_ERR "\n");				\
832 		printk(KERN_ERR "AFS: Assertion failed\n");	\
833 		BUG();						\
834 	}							\
835 } while(0)
836 
837 #define ASSERTCMP(X, OP, Y)						\
838 do {									\
839 	if (unlikely(!((X) OP (Y)))) {					\
840 		printk(KERN_ERR "\n");					\
841 		printk(KERN_ERR "AFS: Assertion failed\n");		\
842 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
843 		       (unsigned long)(X), (unsigned long)(Y));		\
844 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
845 		       (unsigned long)(X), (unsigned long)(Y));		\
846 		BUG();							\
847 	}								\
848 } while(0)
849 
850 #define ASSERTRANGE(L, OP1, N, OP2, H)					\
851 do {									\
852 	if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {		\
853 		printk(KERN_ERR "\n");					\
854 		printk(KERN_ERR "AFS: Assertion failed\n");		\
855 		printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n",	\
856 		       (unsigned long)(L), (unsigned long)(N),		\
857 		       (unsigned long)(H));				\
858 		printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
859 		       (unsigned long)(L), (unsigned long)(N),		\
860 		       (unsigned long)(H));				\
861 		BUG();							\
862 	}								\
863 } while(0)
864 
865 #define ASSERTIF(C, X)						\
866 do {								\
867 	if (unlikely((C) && !(X))) {				\
868 		printk(KERN_ERR "\n");				\
869 		printk(KERN_ERR "AFS: Assertion failed\n");	\
870 		BUG();						\
871 	}							\
872 } while(0)
873 
874 #define ASSERTIFCMP(C, X, OP, Y)					\
875 do {									\
876 	if (unlikely((C) && !((X) OP (Y)))) {				\
877 		printk(KERN_ERR "\n");					\
878 		printk(KERN_ERR "AFS: Assertion failed\n");		\
879 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
880 		       (unsigned long)(X), (unsigned long)(Y));		\
881 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
882 		       (unsigned long)(X), (unsigned long)(Y));		\
883 		BUG();							\
884 	}								\
885 } while(0)
886 
887 #else
888 
889 #define ASSERT(X)				\
890 do {						\
891 } while(0)
892 
893 #define ASSERTCMP(X, OP, Y)			\
894 do {						\
895 } while(0)
896 
897 #define ASSERTRANGE(L, OP1, N, OP2, H)		\
898 do {						\
899 } while(0)
900 
901 #define ASSERTIF(C, X)				\
902 do {						\
903 } while(0)
904 
905 #define ASSERTIFCMP(C, X, OP, Y)		\
906 do {						\
907 } while(0)
908 
909 #endif /* __KDEBUGALL */
910