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