xref: /openbmc/linux/fs/afs/internal.h (revision 349f631d)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* internal AFS stuff
3  *
4  * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
5  * Written by David Howells (dhowells@redhat.com)
6  */
7 
8 #include <linux/compiler.h>
9 #include <linux/kernel.h>
10 #include <linux/ktime.h>
11 #include <linux/fs.h>
12 #include <linux/pagemap.h>
13 #include <linux/rxrpc.h>
14 #include <linux/key.h>
15 #include <linux/workqueue.h>
16 #include <linux/sched.h>
17 #define FSCACHE_USE_NEW_IO_API
18 #include <linux/fscache.h>
19 #include <linux/backing-dev.h>
20 #include <linux/uuid.h>
21 #include <linux/mm_types.h>
22 #include <linux/dns_resolver.h>
23 #include <net/net_namespace.h>
24 #include <net/netns/generic.h>
25 #include <net/sock.h>
26 #include <net/af_rxrpc.h>
27 
28 #include "afs.h"
29 #include "afs_vl.h"
30 
31 #define AFS_CELL_MAX_ADDRS 15
32 
33 struct pagevec;
34 struct afs_call;
35 struct afs_vnode;
36 
37 /*
38  * Partial file-locking emulation mode.  (The problem being that AFS3 only
39  * allows whole-file locks and no upgrading/downgrading).
40  */
41 enum afs_flock_mode {
42 	afs_flock_mode_unset,
43 	afs_flock_mode_local,	/* Local locking only */
44 	afs_flock_mode_openafs,	/* Don't get server lock for a partial lock */
45 	afs_flock_mode_strict,	/* Always get a server lock for a partial lock */
46 	afs_flock_mode_write,	/* Get an exclusive server lock for a partial lock */
47 };
48 
49 struct afs_fs_context {
50 	bool			force;		/* T to force cell type */
51 	bool			autocell;	/* T if set auto mount operation */
52 	bool			dyn_root;	/* T if dynamic root */
53 	bool			no_cell;	/* T if the source is "none" (for dynroot) */
54 	enum afs_flock_mode	flock_mode;	/* Partial file-locking emulation mode */
55 	afs_voltype_t		type;		/* type of volume requested */
56 	unsigned int		volnamesz;	/* size of volume name */
57 	const char		*volname;	/* name of volume to mount */
58 	struct afs_net		*net;		/* the AFS net namespace stuff */
59 	struct afs_cell		*cell;		/* cell in which to find volume */
60 	struct afs_volume	*volume;	/* volume record */
61 	struct key		*key;		/* key to use for secure mounting */
62 };
63 
64 enum afs_call_state {
65 	AFS_CALL_CL_REQUESTING,		/* Client: Request is being sent */
66 	AFS_CALL_CL_AWAIT_REPLY,	/* Client: Awaiting reply */
67 	AFS_CALL_CL_PROC_REPLY,		/* Client: rxrpc call complete; processing reply */
68 	AFS_CALL_SV_AWAIT_OP_ID,	/* Server: Awaiting op ID */
69 	AFS_CALL_SV_AWAIT_REQUEST,	/* Server: Awaiting request data */
70 	AFS_CALL_SV_REPLYING,		/* Server: Replying */
71 	AFS_CALL_SV_AWAIT_ACK,		/* Server: Awaiting final ACK */
72 	AFS_CALL_COMPLETE,		/* Completed or failed */
73 };
74 
75 /*
76  * List of server addresses.
77  */
78 struct afs_addr_list {
79 	struct rcu_head		rcu;
80 	refcount_t		usage;
81 	u32			version;	/* Version */
82 	unsigned char		max_addrs;
83 	unsigned char		nr_addrs;
84 	unsigned char		preferred;	/* Preferred address */
85 	unsigned char		nr_ipv4;	/* Number of IPv4 addresses */
86 	enum dns_record_source	source:8;
87 	enum dns_lookup_status	status:8;
88 	unsigned long		failed;		/* Mask of addrs that failed locally/ICMP */
89 	unsigned long		responded;	/* Mask of addrs that responded */
90 	struct sockaddr_rxrpc	addrs[];
91 #define AFS_MAX_ADDRESSES ((unsigned int)(sizeof(unsigned long) * 8))
92 };
93 
94 /*
95  * a record of an in-progress RxRPC call
96  */
97 struct afs_call {
98 	const struct afs_call_type *type;	/* type of call */
99 	struct afs_addr_list	*alist;		/* Address is alist[addr_ix] */
100 	wait_queue_head_t	waitq;		/* processes awaiting completion */
101 	struct work_struct	async_work;	/* async I/O processor */
102 	struct work_struct	work;		/* actual work processor */
103 	struct rxrpc_call	*rxcall;	/* RxRPC call handle */
104 	struct key		*key;		/* security for this call */
105 	struct afs_net		*net;		/* The network namespace */
106 	struct afs_server	*server;	/* The fileserver record if fs op (pins ref) */
107 	struct afs_vlserver	*vlserver;	/* The vlserver record if vl op */
108 	void			*request;	/* request data (first part) */
109 	size_t			iov_len;	/* Size of *iter to be used */
110 	struct iov_iter		def_iter;	/* Default buffer/data iterator */
111 	struct iov_iter		*write_iter;	/* Iterator defining write to be made */
112 	struct iov_iter		*iter;		/* Iterator currently in use */
113 	union {	/* Convenience for ->def_iter */
114 		struct kvec	kvec[1];
115 		struct bio_vec	bvec[1];
116 	};
117 	void			*buffer;	/* reply receive buffer */
118 	union {
119 		long			ret0;	/* Value to reply with instead of 0 */
120 		struct afs_addr_list	*ret_alist;
121 		struct afs_vldb_entry	*ret_vldb;
122 		char			*ret_str;
123 	};
124 	struct afs_operation	*op;
125 	unsigned int		server_index;
126 	atomic_t		usage;
127 	enum afs_call_state	state;
128 	spinlock_t		state_lock;
129 	int			error;		/* error code */
130 	u32			abort_code;	/* Remote abort ID or 0 */
131 	unsigned int		max_lifespan;	/* Maximum lifespan to set if not 0 */
132 	unsigned		request_size;	/* size of request data */
133 	unsigned		reply_max;	/* maximum size of reply */
134 	unsigned		count2;		/* count used in unmarshalling */
135 	unsigned char		unmarshall;	/* unmarshalling phase */
136 	unsigned char		addr_ix;	/* Address in ->alist */
137 	bool			drop_ref;	/* T if need to drop ref for incoming call */
138 	bool			need_attention;	/* T if RxRPC poked us */
139 	bool			async;		/* T if asynchronous */
140 	bool			upgrade;	/* T to request service upgrade */
141 	bool			have_reply_time; /* T if have got reply_time */
142 	bool			intr;		/* T if interruptible */
143 	bool			unmarshalling_error; /* T if an unmarshalling error occurred */
144 	u16			service_id;	/* Actual service ID (after upgrade) */
145 	unsigned int		debug_id;	/* Trace ID */
146 	u32			operation_ID;	/* operation ID for an incoming call */
147 	u32			count;		/* count for use in unmarshalling */
148 	union {					/* place to extract temporary data */
149 		struct {
150 			__be32	tmp_u;
151 			__be32	tmp;
152 		} __attribute__((packed));
153 		__be64		tmp64;
154 	};
155 	ktime_t			reply_time;	/* Time of first reply packet */
156 };
157 
158 struct afs_call_type {
159 	const char *name;
160 	unsigned int op; /* Really enum afs_fs_operation */
161 
162 	/* deliver request or reply data to an call
163 	 * - returning an error will cause the call to be aborted
164 	 */
165 	int (*deliver)(struct afs_call *call);
166 
167 	/* clean up a call */
168 	void (*destructor)(struct afs_call *call);
169 
170 	/* Work function */
171 	void (*work)(struct work_struct *work);
172 
173 	/* Call done function (gets called immediately on success or failure) */
174 	void (*done)(struct afs_call *call);
175 };
176 
177 /*
178  * Key available for writeback on a file.
179  */
180 struct afs_wb_key {
181 	refcount_t		usage;
182 	struct key		*key;
183 	struct list_head	vnode_link;	/* Link in vnode->wb_keys */
184 };
185 
186 /*
187  * AFS open file information record.  Pointed to by file->private_data.
188  */
189 struct afs_file {
190 	struct key		*key;		/* The key this file was opened with */
191 	struct afs_wb_key	*wb;		/* Writeback key record for this file */
192 };
193 
194 static inline struct key *afs_file_key(struct file *file)
195 {
196 	struct afs_file *af = file->private_data;
197 
198 	return af->key;
199 }
200 
201 /*
202  * Record of an outstanding read operation on a vnode.
203  */
204 struct afs_read {
205 	loff_t			pos;		/* Where to start reading */
206 	loff_t			len;		/* How much we're asking for */
207 	loff_t			actual_len;	/* How much we're actually getting */
208 	loff_t			file_size;	/* File size returned by server */
209 	struct key		*key;		/* The key to use to reissue the read */
210 	struct afs_vnode	*vnode;		/* The file being read into. */
211 	struct netfs_read_subrequest *subreq;	/* Fscache helper read request this belongs to */
212 	afs_dataversion_t	data_version;	/* Version number returned by server */
213 	refcount_t		usage;
214 	unsigned int		call_debug_id;
215 	unsigned int		nr_pages;
216 	int			error;
217 	void (*done)(struct afs_read *);
218 	void (*cleanup)(struct afs_read *);
219 	struct iov_iter		*iter;		/* Iterator representing the buffer */
220 	struct iov_iter		def_iter;	/* Default iterator */
221 };
222 
223 /*
224  * AFS superblock private data
225  * - there's one superblock per volume
226  */
227 struct afs_super_info {
228 	struct net		*net_ns;	/* Network namespace */
229 	struct afs_cell		*cell;		/* The cell in which the volume resides */
230 	struct afs_volume	*volume;	/* volume record */
231 	enum afs_flock_mode	flock_mode:8;	/* File locking emulation mode */
232 	bool			dyn_root;	/* True if dynamic root */
233 };
234 
235 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
236 {
237 	return sb->s_fs_info;
238 }
239 
240 extern struct file_system_type afs_fs_type;
241 
242 /*
243  * Set of substitutes for @sys.
244  */
245 struct afs_sysnames {
246 #define AFS_NR_SYSNAME 16
247 	char			*subs[AFS_NR_SYSNAME];
248 	refcount_t		usage;
249 	unsigned short		nr;
250 	char			blank[1];
251 };
252 
253 /*
254  * AFS network namespace record.
255  */
256 struct afs_net {
257 	struct net		*net;		/* Backpointer to the owning net namespace */
258 	struct afs_uuid		uuid;
259 	bool			live;		/* F if this namespace is being removed */
260 
261 	/* AF_RXRPC I/O stuff */
262 	struct socket		*socket;
263 	struct afs_call		*spare_incoming_call;
264 	struct work_struct	charge_preallocation_work;
265 	struct mutex		socket_mutex;
266 	atomic_t		nr_outstanding_calls;
267 	atomic_t		nr_superblocks;
268 
269 	/* Cell database */
270 	struct rb_root		cells;
271 	struct afs_cell		*ws_cell;
272 	struct work_struct	cells_manager;
273 	struct timer_list	cells_timer;
274 	atomic_t		cells_outstanding;
275 	struct rw_semaphore	cells_lock;
276 	struct mutex		cells_alias_lock;
277 
278 	struct mutex		proc_cells_lock;
279 	struct hlist_head	proc_cells;
280 
281 	/* Known servers.  Theoretically each fileserver can only be in one
282 	 * cell, but in practice, people create aliases and subsets and there's
283 	 * no easy way to distinguish them.
284 	 */
285 	seqlock_t		fs_lock;	/* For fs_servers, fs_probe_*, fs_proc */
286 	struct rb_root		fs_servers;	/* afs_server (by server UUID or address) */
287 	struct list_head	fs_probe_fast;	/* List of afs_server to probe at 30s intervals */
288 	struct list_head	fs_probe_slow;	/* List of afs_server to probe at 5m intervals */
289 	struct hlist_head	fs_proc;	/* procfs servers list */
290 
291 	struct hlist_head	fs_addresses4;	/* afs_server (by lowest IPv4 addr) */
292 	struct hlist_head	fs_addresses6;	/* afs_server (by lowest IPv6 addr) */
293 	seqlock_t		fs_addr_lock;	/* For fs_addresses[46] */
294 
295 	struct work_struct	fs_manager;
296 	struct timer_list	fs_timer;
297 
298 	struct work_struct	fs_prober;
299 	struct timer_list	fs_probe_timer;
300 	atomic_t		servers_outstanding;
301 
302 	/* File locking renewal management */
303 	struct mutex		lock_manager_mutex;
304 
305 	/* Misc */
306 	struct super_block	*dynroot_sb;	/* Dynamic root mount superblock */
307 	struct proc_dir_entry	*proc_afs;	/* /proc/net/afs directory */
308 	struct afs_sysnames	*sysnames;
309 	rwlock_t		sysnames_lock;
310 
311 	/* Statistics counters */
312 	atomic_t		n_lookup;	/* Number of lookups done */
313 	atomic_t		n_reval;	/* Number of dentries needing revalidation */
314 	atomic_t		n_inval;	/* Number of invalidations by the server */
315 	atomic_t		n_relpg;	/* Number of invalidations by releasepage */
316 	atomic_t		n_read_dir;	/* Number of directory pages read */
317 	atomic_t		n_dir_cr;	/* Number of directory entry creation edits */
318 	atomic_t		n_dir_rm;	/* Number of directory entry removal edits */
319 	atomic_t		n_stores;	/* Number of store ops */
320 	atomic_long_t		n_store_bytes;	/* Number of bytes stored */
321 	atomic_long_t		n_fetch_bytes;	/* Number of bytes fetched */
322 	atomic_t		n_fetches;	/* Number of data fetch ops */
323 };
324 
325 extern const char afs_init_sysname[];
326 
327 enum afs_cell_state {
328 	AFS_CELL_UNSET,
329 	AFS_CELL_ACTIVATING,
330 	AFS_CELL_ACTIVE,
331 	AFS_CELL_DEACTIVATING,
332 	AFS_CELL_INACTIVE,
333 	AFS_CELL_FAILED,
334 	AFS_CELL_REMOVED,
335 };
336 
337 /*
338  * AFS cell record.
339  *
340  * This is a tricky concept to get right as it is possible to create aliases
341  * simply by pointing AFSDB/SRV records for two names at the same set of VL
342  * servers; it is also possible to do things like setting up two sets of VL
343  * servers, one of which provides a superset of the volumes provided by the
344  * other (for internal/external division, for example).
345  *
346  * Cells only exist in the sense that (a) a cell's name maps to a set of VL
347  * servers and (b) a cell's name is used by the client to select the key to use
348  * for authentication and encryption.  The cell name is not typically used in
349  * the protocol.
350  *
351  * Two cells are determined to be aliases if they have an explicit alias (YFS
352  * only), share any VL servers in common or have at least one volume in common.
353  * "In common" means that the address list of the VL servers or the fileservers
354  * share at least one endpoint.
355  */
356 struct afs_cell {
357 	union {
358 		struct rcu_head	rcu;
359 		struct rb_node	net_node;	/* Node in net->cells */
360 	};
361 	struct afs_net		*net;
362 	struct afs_cell		*alias_of;	/* The cell this is an alias of */
363 	struct afs_volume	*root_volume;	/* The root.cell volume if there is one */
364 	struct key		*anonymous_key;	/* anonymous user key for this cell */
365 	struct work_struct	manager;	/* Manager for init/deinit/dns */
366 	struct hlist_node	proc_link;	/* /proc cell list link */
367 #ifdef CONFIG_AFS_FSCACHE
368 	struct fscache_cookie	*cache;		/* caching cookie */
369 #endif
370 	time64_t		dns_expiry;	/* Time AFSDB/SRV record expires */
371 	time64_t		last_inactive;	/* Time of last drop of usage count */
372 	atomic_t		ref;		/* Struct refcount */
373 	atomic_t		active;		/* Active usage counter */
374 	unsigned long		flags;
375 #define AFS_CELL_FL_NO_GC	0		/* The cell was added manually, don't auto-gc */
376 #define AFS_CELL_FL_DO_LOOKUP	1		/* DNS lookup requested */
377 #define AFS_CELL_FL_CHECK_ALIAS	2		/* Need to check for aliases */
378 	enum afs_cell_state	state;
379 	short			error;
380 	enum dns_record_source	dns_source:8;	/* Latest source of data from lookup */
381 	enum dns_lookup_status	dns_status:8;	/* Latest status of data from lookup */
382 	unsigned int		dns_lookup_count; /* Counter of DNS lookups */
383 	unsigned int		debug_id;
384 
385 	/* The volumes belonging to this cell */
386 	struct rb_root		volumes;	/* Tree of volumes on this server */
387 	struct hlist_head	proc_volumes;	/* procfs volume list */
388 	seqlock_t		volume_lock;	/* For volumes */
389 
390 	/* Active fileserver interaction state. */
391 	struct rb_root		fs_servers;	/* afs_server (by server UUID) */
392 	seqlock_t		fs_lock;	/* For fs_servers  */
393 	struct rw_semaphore	fs_open_mmaps_lock;
394 	struct list_head	fs_open_mmaps;	/* List of vnodes that are mmapped */
395 	atomic_t		fs_s_break;	/* Counter of CB.InitCallBackState messages */
396 
397 	/* VL server list. */
398 	rwlock_t		vl_servers_lock; /* Lock on vl_servers */
399 	struct afs_vlserver_list __rcu *vl_servers;
400 
401 	u8			name_len;	/* Length of name */
402 	char			*name;		/* Cell name, case-flattened and NUL-padded */
403 };
404 
405 /*
406  * Volume Location server record.
407  */
408 struct afs_vlserver {
409 	struct rcu_head		rcu;
410 	struct afs_addr_list	__rcu *addresses; /* List of addresses for this VL server */
411 	unsigned long		flags;
412 #define AFS_VLSERVER_FL_PROBED	0		/* The VL server has been probed */
413 #define AFS_VLSERVER_FL_PROBING	1		/* VL server is being probed */
414 #define AFS_VLSERVER_FL_IS_YFS	2		/* Server is YFS not AFS */
415 #define AFS_VLSERVER_FL_RESPONDING 3		/* VL server is responding */
416 	rwlock_t		lock;		/* Lock on addresses */
417 	atomic_t		usage;
418 	unsigned int		rtt;		/* Server's current RTT in uS */
419 
420 	/* Probe state */
421 	wait_queue_head_t	probe_wq;
422 	atomic_t		probe_outstanding;
423 	spinlock_t		probe_lock;
424 	struct {
425 		unsigned int	rtt;		/* RTT in uS */
426 		u32		abort_code;
427 		short		error;
428 		unsigned short	flags;
429 #define AFS_VLSERVER_PROBE_RESPONDED		0x01 /* At least once response (may be abort) */
430 #define AFS_VLSERVER_PROBE_IS_YFS		0x02 /* The peer appears to be YFS */
431 #define AFS_VLSERVER_PROBE_NOT_YFS		0x04 /* The peer appears not to be YFS */
432 #define AFS_VLSERVER_PROBE_LOCAL_FAILURE	0x08 /* A local failure prevented a probe */
433 	} probe;
434 
435 	u16			port;
436 	u16			name_len;	/* Length of name */
437 	char			name[];		/* Server name, case-flattened */
438 };
439 
440 /*
441  * Weighted list of Volume Location servers.
442  */
443 struct afs_vlserver_entry {
444 	u16			priority;	/* Preference (as SRV) */
445 	u16			weight;		/* Weight (as SRV) */
446 	enum dns_record_source	source:8;
447 	enum dns_lookup_status	status:8;
448 	struct afs_vlserver	*server;
449 };
450 
451 struct afs_vlserver_list {
452 	struct rcu_head		rcu;
453 	atomic_t		usage;
454 	u8			nr_servers;
455 	u8			index;		/* Server currently in use */
456 	u8			preferred;	/* Preferred server */
457 	enum dns_record_source	source:8;
458 	enum dns_lookup_status	status:8;
459 	rwlock_t		lock;
460 	struct afs_vlserver_entry servers[];
461 };
462 
463 /*
464  * Cached VLDB entry.
465  *
466  * This is pointed to by cell->vldb_entries, indexed by name.
467  */
468 struct afs_vldb_entry {
469 	afs_volid_t		vid[3];		/* Volume IDs for R/W, R/O and Bak volumes */
470 
471 	unsigned long		flags;
472 #define AFS_VLDB_HAS_RW		0		/* - R/W volume exists */
473 #define AFS_VLDB_HAS_RO		1		/* - R/O volume exists */
474 #define AFS_VLDB_HAS_BAK	2		/* - Backup volume exists */
475 #define AFS_VLDB_QUERY_VALID	3		/* - Record is valid */
476 #define AFS_VLDB_QUERY_ERROR	4		/* - VL server returned error */
477 
478 	uuid_t			fs_server[AFS_NMAXNSERVERS];
479 	u32			addr_version[AFS_NMAXNSERVERS]; /* Registration change counters */
480 	u8			fs_mask[AFS_NMAXNSERVERS];
481 #define AFS_VOL_VTM_RW	0x01 /* R/W version of the volume is available (on this server) */
482 #define AFS_VOL_VTM_RO	0x02 /* R/O version of the volume is available (on this server) */
483 #define AFS_VOL_VTM_BAK	0x04 /* backup version of the volume is available (on this server) */
484 	short			error;
485 	u8			nr_servers;	/* Number of server records */
486 	u8			name_len;
487 	u8			name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
488 };
489 
490 /*
491  * Record of fileserver with which we're actively communicating.
492  */
493 struct afs_server {
494 	struct rcu_head		rcu;
495 	union {
496 		uuid_t		uuid;		/* Server ID */
497 		struct afs_uuid	_uuid;
498 	};
499 
500 	struct afs_addr_list	__rcu *addresses;
501 	struct afs_cell		*cell;		/* Cell to which belongs (pins ref) */
502 	struct rb_node		uuid_rb;	/* Link in net->fs_servers */
503 	struct afs_server __rcu	*uuid_next;	/* Next server with same UUID */
504 	struct afs_server	*uuid_prev;	/* Previous server with same UUID */
505 	struct list_head	probe_link;	/* Link in net->fs_probe_list */
506 	struct hlist_node	addr4_link;	/* Link in net->fs_addresses4 */
507 	struct hlist_node	addr6_link;	/* Link in net->fs_addresses6 */
508 	struct hlist_node	proc_link;	/* Link in net->fs_proc */
509 	struct work_struct	initcb_work;	/* Work for CB.InitCallBackState* */
510 	struct afs_server	*gc_next;	/* Next server in manager's list */
511 	time64_t		unuse_time;	/* Time at which last unused */
512 	unsigned long		flags;
513 #define AFS_SERVER_FL_RESPONDING 0		/* The server is responding */
514 #define AFS_SERVER_FL_UPDATING	1
515 #define AFS_SERVER_FL_NEEDS_UPDATE 2		/* Fileserver address list is out of date */
516 #define AFS_SERVER_FL_NOT_READY	4		/* The record is not ready for use */
517 #define AFS_SERVER_FL_NOT_FOUND	5		/* VL server says no such server */
518 #define AFS_SERVER_FL_VL_FAIL	6		/* Failed to access VL server */
519 #define AFS_SERVER_FL_MAY_HAVE_CB 8		/* May have callbacks on this fileserver */
520 #define AFS_SERVER_FL_IS_YFS	16		/* Server is YFS not AFS */
521 #define AFS_SERVER_FL_NO_IBULK	17		/* Fileserver doesn't support FS.InlineBulkStatus */
522 #define AFS_SERVER_FL_NO_RM2	18		/* Fileserver doesn't support YFS.RemoveFile2 */
523 #define AFS_SERVER_FL_HAS_FS64	19		/* Fileserver supports FS.{Fetch,Store}Data64 */
524 	atomic_t		ref;		/* Object refcount */
525 	atomic_t		active;		/* Active user count */
526 	u32			addr_version;	/* Address list version */
527 	unsigned int		rtt;		/* Server's current RTT in uS */
528 	unsigned int		debug_id;	/* Debugging ID for traces */
529 
530 	/* file service access */
531 	rwlock_t		fs_lock;	/* access lock */
532 
533 	/* callback promise management */
534 	unsigned		cb_s_break;	/* Break-everything counter. */
535 
536 	/* Probe state */
537 	unsigned long		probed_at;	/* Time last probe was dispatched (jiffies) */
538 	wait_queue_head_t	probe_wq;
539 	atomic_t		probe_outstanding;
540 	spinlock_t		probe_lock;
541 	struct {
542 		unsigned int	rtt;		/* RTT in uS */
543 		u32		abort_code;
544 		short		error;
545 		bool		responded:1;
546 		bool		is_yfs:1;
547 		bool		not_yfs:1;
548 		bool		local_failure:1;
549 	} probe;
550 };
551 
552 /*
553  * Replaceable volume server list.
554  */
555 struct afs_server_entry {
556 	struct afs_server	*server;
557 };
558 
559 struct afs_server_list {
560 	afs_volid_t		vids[AFS_MAXTYPES]; /* Volume IDs */
561 	refcount_t		usage;
562 	unsigned char		nr_servers;
563 	unsigned char		preferred;	/* Preferred server */
564 	unsigned short		vnovol_mask;	/* Servers to be skipped due to VNOVOL */
565 	unsigned int		seq;		/* Set to ->servers_seq when installed */
566 	rwlock_t		lock;
567 	struct afs_server_entry	servers[];
568 };
569 
570 /*
571  * Live AFS volume management.
572  */
573 struct afs_volume {
574 	union {
575 		struct rcu_head	rcu;
576 		afs_volid_t	vid;		/* volume ID */
577 	};
578 	atomic_t		usage;
579 	time64_t		update_at;	/* Time at which to next update */
580 	struct afs_cell		*cell;		/* Cell to which belongs (pins ref) */
581 	struct rb_node		cell_node;	/* Link in cell->volumes */
582 	struct hlist_node	proc_link;	/* Link in cell->proc_volumes */
583 	struct super_block __rcu *sb;		/* Superblock on which inodes reside */
584 	unsigned long		flags;
585 #define AFS_VOLUME_NEEDS_UPDATE	0	/* - T if an update needs performing */
586 #define AFS_VOLUME_UPDATING	1	/* - T if an update is in progress */
587 #define AFS_VOLUME_WAIT		2	/* - T if users must wait for update */
588 #define AFS_VOLUME_DELETED	3	/* - T if volume appears deleted */
589 #define AFS_VOLUME_OFFLINE	4	/* - T if volume offline notice given */
590 #define AFS_VOLUME_BUSY		5	/* - T if volume busy notice given */
591 #define AFS_VOLUME_MAYBE_NO_IBULK 6	/* - T if some servers don't have InlineBulkStatus */
592 #ifdef CONFIG_AFS_FSCACHE
593 	struct fscache_cookie	*cache;		/* caching cookie */
594 #endif
595 	struct afs_server_list __rcu *servers;	/* List of servers on which volume resides */
596 	rwlock_t		servers_lock;	/* Lock for ->servers */
597 	unsigned int		servers_seq;	/* Incremented each time ->servers changes */
598 
599 	unsigned		cb_v_break;	/* Break-everything counter. */
600 	rwlock_t		cb_v_break_lock;
601 
602 	afs_voltype_t		type;		/* type of volume */
603 	char			type_force;	/* force volume type (suppress R/O -> R/W) */
604 	u8			name_len;
605 	u8			name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
606 };
607 
608 enum afs_lock_state {
609 	AFS_VNODE_LOCK_NONE,		/* The vnode has no lock on the server */
610 	AFS_VNODE_LOCK_WAITING_FOR_CB,	/* We're waiting for the server to break the callback */
611 	AFS_VNODE_LOCK_SETTING,		/* We're asking the server for a lock */
612 	AFS_VNODE_LOCK_GRANTED,		/* We have a lock on the server */
613 	AFS_VNODE_LOCK_EXTENDING,	/* We're extending a lock on the server */
614 	AFS_VNODE_LOCK_NEED_UNLOCK,	/* We need to unlock on the server */
615 	AFS_VNODE_LOCK_UNLOCKING,	/* We're telling the server to unlock */
616 	AFS_VNODE_LOCK_DELETED,		/* The vnode has been deleted whilst we have a lock */
617 };
618 
619 /*
620  * AFS inode private data.
621  *
622  * Note that afs_alloc_inode() *must* reset anything that could incorrectly
623  * leak from one inode to another.
624  */
625 struct afs_vnode {
626 	struct inode		vfs_inode;	/* the VFS's inode record */
627 
628 	struct afs_volume	*volume;	/* volume on which vnode resides */
629 	struct afs_fid		fid;		/* the file identifier for this inode */
630 	struct afs_file_status	status;		/* AFS status info for this file */
631 	afs_dataversion_t	invalid_before;	/* Child dentries are invalid before this */
632 #ifdef CONFIG_AFS_FSCACHE
633 	struct fscache_cookie	*cache;		/* caching cookie */
634 #endif
635 	struct afs_permits __rcu *permit_cache;	/* cache of permits so far obtained */
636 	struct mutex		io_lock;	/* Lock for serialising I/O on this mutex */
637 	struct rw_semaphore	validate_lock;	/* lock for validating this vnode */
638 	struct rw_semaphore	rmdir_lock;	/* Lock for rmdir vs sillyrename */
639 	struct key		*silly_key;	/* Silly rename key */
640 	spinlock_t		wb_lock;	/* lock for wb_keys */
641 	spinlock_t		lock;		/* waitqueue/flags lock */
642 	unsigned long		flags;
643 #define AFS_VNODE_CB_PROMISED	0		/* Set if vnode has a callback promise */
644 #define AFS_VNODE_UNSET		1		/* set if vnode attributes not yet set */
645 #define AFS_VNODE_DIR_VALID	2		/* Set if dir contents are valid */
646 #define AFS_VNODE_ZAP_DATA	3		/* set if vnode's data should be invalidated */
647 #define AFS_VNODE_DELETED	4		/* set if vnode deleted on server */
648 #define AFS_VNODE_MOUNTPOINT	5		/* set if vnode is a mountpoint symlink */
649 #define AFS_VNODE_AUTOCELL	6		/* set if Vnode is an auto mount point */
650 #define AFS_VNODE_PSEUDODIR	7 		/* set if Vnode is a pseudo directory */
651 #define AFS_VNODE_NEW_CONTENT	8		/* Set if file has new content (create/trunc-0) */
652 #define AFS_VNODE_SILLY_DELETED	9		/* Set if file has been silly-deleted */
653 #define AFS_VNODE_MODIFYING	10		/* Set if we're performing a modification op */
654 
655 	struct list_head	wb_keys;	/* List of keys available for writeback */
656 	struct list_head	pending_locks;	/* locks waiting to be granted */
657 	struct list_head	granted_locks;	/* locks granted on this file */
658 	struct delayed_work	lock_work;	/* work to be done in locking */
659 	struct key		*lock_key;	/* Key to be used in lock ops */
660 	ktime_t			locked_at;	/* Time at which lock obtained */
661 	enum afs_lock_state	lock_state : 8;
662 	afs_lock_type_t		lock_type : 8;
663 
664 	/* outstanding callback notification on this file */
665 	struct work_struct	cb_work;	/* Work for mmap'd files */
666 	struct list_head	cb_mmap_link;	/* Link in cell->fs_open_mmaps */
667 	void			*cb_server;	/* Server with callback/filelock */
668 	atomic_t		cb_nr_mmap;	/* Number of mmaps */
669 	unsigned int		cb_fs_s_break;	/* Mass server break counter (cell->fs_s_break) */
670 	unsigned int		cb_s_break;	/* Mass break counter on ->server */
671 	unsigned int		cb_v_break;	/* Mass break counter on ->volume */
672 	unsigned int		cb_break;	/* Break counter on vnode */
673 	seqlock_t		cb_lock;	/* Lock for ->cb_server, ->status, ->cb_*break */
674 
675 	time64_t		cb_expires_at;	/* time at which callback expires */
676 };
677 
678 static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
679 {
680 #ifdef CONFIG_AFS_FSCACHE
681 	return vnode->cache;
682 #else
683 	return NULL;
684 #endif
685 }
686 
687 /*
688  * cached security record for one user's attempt to access a vnode
689  */
690 struct afs_permit {
691 	struct key		*key;		/* RxRPC ticket holding a security context */
692 	afs_access_t		access;		/* CallerAccess value for this key */
693 };
694 
695 /*
696  * Immutable cache of CallerAccess records from attempts to access vnodes.
697  * These may be shared between multiple vnodes.
698  */
699 struct afs_permits {
700 	struct rcu_head		rcu;
701 	struct hlist_node	hash_node;	/* Link in hash */
702 	unsigned long		h;		/* Hash value for this permit list */
703 	refcount_t		usage;
704 	unsigned short		nr_permits;	/* Number of records */
705 	bool			invalidated;	/* Invalidated due to key change */
706 	struct afs_permit	permits[];	/* List of permits sorted by key pointer */
707 };
708 
709 /*
710  * Error prioritisation and accumulation.
711  */
712 struct afs_error {
713 	short	error;			/* Accumulated error */
714 	bool	responded;		/* T if server responded */
715 };
716 
717 /*
718  * Cursor for iterating over a server's address list.
719  */
720 struct afs_addr_cursor {
721 	struct afs_addr_list	*alist;		/* Current address list (pins ref) */
722 	unsigned long		tried;		/* Tried addresses */
723 	signed char		index;		/* Current address */
724 	bool			responded;	/* T if the current address responded */
725 	unsigned short		nr_iterations;	/* Number of address iterations */
726 	short			error;
727 	u32			abort_code;
728 };
729 
730 /*
731  * Cursor for iterating over a set of volume location servers.
732  */
733 struct afs_vl_cursor {
734 	struct afs_addr_cursor	ac;
735 	struct afs_cell		*cell;		/* The cell we're querying */
736 	struct afs_vlserver_list *server_list;	/* Current server list (pins ref) */
737 	struct afs_vlserver	*server;	/* Server on which this resides */
738 	struct key		*key;		/* Key for the server */
739 	unsigned long		untried;	/* Bitmask of untried servers */
740 	short			index;		/* Current server */
741 	short			error;
742 	unsigned short		flags;
743 #define AFS_VL_CURSOR_STOP	0x0001		/* Set to cease iteration */
744 #define AFS_VL_CURSOR_RETRY	0x0002		/* Set to do a retry */
745 #define AFS_VL_CURSOR_RETRIED	0x0004		/* Set if started a retry */
746 	unsigned short		nr_iterations;	/* Number of server iterations */
747 };
748 
749 /*
750  * Fileserver operation methods.
751  */
752 struct afs_operation_ops {
753 	void (*issue_afs_rpc)(struct afs_operation *op);
754 	void (*issue_yfs_rpc)(struct afs_operation *op);
755 	void (*success)(struct afs_operation *op);
756 	void (*aborted)(struct afs_operation *op);
757 	void (*failed)(struct afs_operation *op);
758 	void (*edit_dir)(struct afs_operation *op);
759 	void (*put)(struct afs_operation *op);
760 };
761 
762 struct afs_vnode_param {
763 	struct afs_vnode	*vnode;
764 	struct afs_fid		fid;		/* Fid to access */
765 	struct afs_status_cb	scb;		/* Returned status and callback promise */
766 	afs_dataversion_t	dv_before;	/* Data version before the call */
767 	unsigned int		cb_break_before; /* cb_break + cb_s_break before the call */
768 	u8			dv_delta;	/* Expected change in data version */
769 	bool			put_vnode:1;	/* T if we have a ref on the vnode */
770 	bool			need_io_lock:1;	/* T if we need the I/O lock on this */
771 	bool			update_ctime:1;	/* Need to update the ctime */
772 	bool			set_size:1;	/* Must update i_size */
773 	bool			op_unlinked:1;	/* True if file was unlinked by op */
774 	bool			speculative:1;	/* T if speculative status fetch (no vnode lock) */
775 	bool			modification:1;	/* Set if the content gets modified */
776 };
777 
778 /*
779  * Fileserver operation wrapper, handling server and address rotation
780  * asynchronously.  May make simultaneous calls to multiple servers.
781  */
782 struct afs_operation {
783 	struct afs_net		*net;		/* Network namespace */
784 	struct key		*key;		/* Key for the cell */
785 	const struct afs_call_type *type;	/* Type of call done */
786 	const struct afs_operation_ops *ops;
787 
788 	/* Parameters/results for the operation */
789 	struct afs_volume	*volume;	/* Volume being accessed */
790 	struct afs_vnode_param	file[2];
791 	struct afs_vnode_param	*more_files;
792 	struct afs_volsync	volsync;
793 	struct dentry		*dentry;	/* Dentry to be altered */
794 	struct dentry		*dentry_2;	/* Second dentry to be altered */
795 	struct timespec64	mtime;		/* Modification time to record */
796 	struct timespec64	ctime;		/* Change time to set */
797 	short			nr_files;	/* Number of entries in file[], more_files */
798 	short			error;
799 	unsigned int		debug_id;
800 
801 	unsigned int		cb_v_break;	/* Volume break counter before op */
802 	unsigned int		cb_s_break;	/* Server break counter before op */
803 
804 	union {
805 		struct {
806 			int	which;		/* Which ->file[] to fetch for */
807 		} fetch_status;
808 		struct {
809 			int	reason;		/* enum afs_edit_dir_reason */
810 			mode_t	mode;
811 			const char *symlink;
812 		} create;
813 		struct {
814 			bool	need_rehash;
815 		} unlink;
816 		struct {
817 			struct dentry *rehash;
818 			struct dentry *tmp;
819 			bool	new_negative;
820 		} rename;
821 		struct {
822 			struct afs_read *req;
823 		} fetch;
824 		struct {
825 			afs_lock_type_t type;
826 		} lock;
827 		struct {
828 			struct iov_iter	*write_iter;
829 			loff_t	pos;
830 			loff_t	size;
831 			loff_t	i_size;
832 			bool	laundering;	/* Laundering page, PG_writeback not set */
833 		} store;
834 		struct {
835 			struct iattr	*attr;
836 			loff_t		old_i_size;
837 		} setattr;
838 		struct afs_acl	*acl;
839 		struct yfs_acl	*yacl;
840 		struct {
841 			struct afs_volume_status vs;
842 			struct kstatfs		*buf;
843 		} volstatus;
844 	};
845 
846 	/* Fileserver iteration state */
847 	struct afs_addr_cursor	ac;
848 	struct afs_server_list	*server_list;	/* Current server list (pins ref) */
849 	struct afs_server	*server;	/* Server we're using (ref pinned by server_list) */
850 	struct afs_call		*call;
851 	unsigned long		untried;	/* Bitmask of untried servers */
852 	short			index;		/* Current server */
853 	unsigned short		nr_iterations;	/* Number of server iterations */
854 
855 	unsigned int		flags;
856 #define AFS_OPERATION_STOP		0x0001	/* Set to cease iteration */
857 #define AFS_OPERATION_VBUSY		0x0002	/* Set if seen VBUSY */
858 #define AFS_OPERATION_VMOVED		0x0004	/* Set if seen VMOVED */
859 #define AFS_OPERATION_VNOVOL		0x0008	/* Set if seen VNOVOL */
860 #define AFS_OPERATION_CUR_ONLY		0x0010	/* Set if current server only (file lock held) */
861 #define AFS_OPERATION_NO_VSLEEP		0x0020	/* Set to prevent sleep on VBUSY, VOFFLINE, ... */
862 #define AFS_OPERATION_UNINTR		0x0040	/* Set if op is uninterruptible */
863 #define AFS_OPERATION_DOWNGRADE		0x0080	/* Set to retry with downgraded opcode */
864 #define AFS_OPERATION_LOCK_0		0x0100	/* Set if have io_lock on file[0] */
865 #define AFS_OPERATION_LOCK_1		0x0200	/* Set if have io_lock on file[1] */
866 #define AFS_OPERATION_TRIED_ALL		0x0400	/* Set if we've tried all the fileservers */
867 #define AFS_OPERATION_RETRY_SERVER	0x0800	/* Set if we should retry the current server */
868 #define AFS_OPERATION_DIR_CONFLICT	0x1000	/* Set if we detected a 3rd-party dir change */
869 };
870 
871 /*
872  * Cache auxiliary data.
873  */
874 struct afs_vnode_cache_aux {
875 	u64			data_version;
876 } __packed;
877 
878 /*
879  * We use page->private to hold the amount of the page that we've written to,
880  * splitting the field into two parts.  However, we need to represent a range
881  * 0...PAGE_SIZE, so we reduce the resolution if the size of the page
882  * exceeds what we can encode.
883  */
884 #ifdef CONFIG_64BIT
885 #define __AFS_PAGE_PRIV_MASK	0x7fffffffUL
886 #define __AFS_PAGE_PRIV_SHIFT	32
887 #define __AFS_PAGE_PRIV_MMAPPED	0x80000000UL
888 #else
889 #define __AFS_PAGE_PRIV_MASK	0x7fffUL
890 #define __AFS_PAGE_PRIV_SHIFT	16
891 #define __AFS_PAGE_PRIV_MMAPPED	0x8000UL
892 #endif
893 
894 static inline unsigned int afs_page_dirty_resolution(struct page *page)
895 {
896 	int shift = thp_order(page) + PAGE_SHIFT - (__AFS_PAGE_PRIV_SHIFT - 1);
897 	return (shift > 0) ? shift : 0;
898 }
899 
900 static inline size_t afs_page_dirty_from(struct page *page, unsigned long priv)
901 {
902 	unsigned long x = priv & __AFS_PAGE_PRIV_MASK;
903 
904 	/* The lower bound is inclusive */
905 	return x << afs_page_dirty_resolution(page);
906 }
907 
908 static inline size_t afs_page_dirty_to(struct page *page, unsigned long priv)
909 {
910 	unsigned long x = (priv >> __AFS_PAGE_PRIV_SHIFT) & __AFS_PAGE_PRIV_MASK;
911 
912 	/* The upper bound is immediately beyond the region */
913 	return (x + 1) << afs_page_dirty_resolution(page);
914 }
915 
916 static inline unsigned long afs_page_dirty(struct page *page, size_t from, size_t to)
917 {
918 	unsigned int res = afs_page_dirty_resolution(page);
919 	from >>= res;
920 	to = (to - 1) >> res;
921 	return (to << __AFS_PAGE_PRIV_SHIFT) | from;
922 }
923 
924 static inline unsigned long afs_page_dirty_mmapped(unsigned long priv)
925 {
926 	return priv | __AFS_PAGE_PRIV_MMAPPED;
927 }
928 
929 static inline bool afs_is_page_dirty_mmapped(unsigned long priv)
930 {
931 	return priv & __AFS_PAGE_PRIV_MMAPPED;
932 }
933 
934 #include <trace/events/afs.h>
935 
936 /*****************************************************************************/
937 /*
938  * addr_list.c
939  */
940 static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
941 {
942 	if (alist)
943 		refcount_inc(&alist->usage);
944 	return alist;
945 }
946 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
947 						unsigned short,
948 						unsigned short);
949 extern void afs_put_addrlist(struct afs_addr_list *);
950 extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
951 						      const char *, size_t, char,
952 						      unsigned short, unsigned short);
953 extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
954 extern bool afs_iterate_addresses(struct afs_addr_cursor *);
955 extern int afs_end_cursor(struct afs_addr_cursor *);
956 
957 extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
958 extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
959 
960 /*
961  * cache.c
962  */
963 #ifdef CONFIG_AFS_FSCACHE
964 extern struct fscache_netfs afs_cache_netfs;
965 extern struct fscache_cookie_def afs_cell_cache_index_def;
966 extern struct fscache_cookie_def afs_volume_cache_index_def;
967 extern struct fscache_cookie_def afs_vnode_cache_index_def;
968 #else
969 #define afs_cell_cache_index_def	(*(struct fscache_cookie_def *) NULL)
970 #define afs_volume_cache_index_def	(*(struct fscache_cookie_def *) NULL)
971 #define afs_vnode_cache_index_def	(*(struct fscache_cookie_def *) NULL)
972 #endif
973 
974 /*
975  * callback.c
976  */
977 extern void afs_invalidate_mmap_work(struct work_struct *);
978 extern void afs_server_init_callback_work(struct work_struct *work);
979 extern void afs_init_callback_state(struct afs_server *);
980 extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
981 extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
982 extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
983 
984 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
985 {
986 	return vnode->cb_break + vnode->cb_v_break;
987 }
988 
989 static inline bool afs_cb_is_broken(unsigned int cb_break,
990 				    const struct afs_vnode *vnode)
991 {
992 	return cb_break != (vnode->cb_break + vnode->volume->cb_v_break);
993 }
994 
995 /*
996  * cell.c
997  */
998 extern int afs_cell_init(struct afs_net *, const char *);
999 extern struct afs_cell *afs_find_cell(struct afs_net *, const char *, unsigned,
1000 				      enum afs_cell_trace);
1001 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
1002 					const char *, bool);
1003 extern struct afs_cell *afs_use_cell(struct afs_cell *, enum afs_cell_trace);
1004 extern void afs_unuse_cell(struct afs_net *, struct afs_cell *, enum afs_cell_trace);
1005 extern struct afs_cell *afs_get_cell(struct afs_cell *, enum afs_cell_trace);
1006 extern void afs_see_cell(struct afs_cell *, enum afs_cell_trace);
1007 extern void afs_put_cell(struct afs_cell *, enum afs_cell_trace);
1008 extern void afs_queue_cell(struct afs_cell *, enum afs_cell_trace);
1009 extern void afs_manage_cells(struct work_struct *);
1010 extern void afs_cells_timer(struct timer_list *);
1011 extern void __net_exit afs_cell_purge(struct afs_net *);
1012 
1013 /*
1014  * cmservice.c
1015  */
1016 extern bool afs_cm_incoming_call(struct afs_call *);
1017 
1018 /*
1019  * dir.c
1020  */
1021 extern const struct file_operations afs_dir_file_operations;
1022 extern const struct inode_operations afs_dir_inode_operations;
1023 extern const struct address_space_operations afs_dir_aops;
1024 extern const struct dentry_operations afs_fs_dentry_operations;
1025 
1026 extern void afs_d_release(struct dentry *);
1027 extern void afs_check_for_remote_deletion(struct afs_operation *);
1028 
1029 /*
1030  * dir_edit.c
1031  */
1032 extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
1033 			     enum afs_edit_dir_reason);
1034 extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
1035 
1036 /*
1037  * dir_silly.c
1038  */
1039 extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
1040 			   struct dentry *, struct key *);
1041 extern int afs_silly_iput(struct dentry *, struct inode *);
1042 
1043 /*
1044  * dynroot.c
1045  */
1046 extern const struct inode_operations afs_dynroot_inode_operations;
1047 extern const struct dentry_operations afs_dynroot_dentry_operations;
1048 
1049 extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
1050 extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
1051 extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
1052 extern int afs_dynroot_populate(struct super_block *);
1053 extern void afs_dynroot_depopulate(struct super_block *);
1054 
1055 /*
1056  * file.c
1057  */
1058 extern const struct address_space_operations afs_fs_aops;
1059 extern const struct inode_operations afs_file_inode_operations;
1060 extern const struct file_operations afs_file_operations;
1061 extern const struct netfs_read_request_ops afs_req_ops;
1062 
1063 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
1064 extern void afs_put_wb_key(struct afs_wb_key *);
1065 extern int afs_open(struct inode *, struct file *);
1066 extern int afs_release(struct inode *, struct file *);
1067 extern int afs_fetch_data(struct afs_vnode *, struct afs_read *);
1068 extern struct afs_read *afs_alloc_read(gfp_t);
1069 extern void afs_put_read(struct afs_read *);
1070 
1071 static inline struct afs_read *afs_get_read(struct afs_read *req)
1072 {
1073 	refcount_inc(&req->usage);
1074 	return req;
1075 }
1076 
1077 /*
1078  * flock.c
1079  */
1080 extern struct workqueue_struct *afs_lock_manager;
1081 
1082 extern void afs_lock_op_done(struct afs_call *);
1083 extern void afs_lock_work(struct work_struct *);
1084 extern void afs_lock_may_be_available(struct afs_vnode *);
1085 extern int afs_lock(struct file *, int, struct file_lock *);
1086 extern int afs_flock(struct file *, int, struct file_lock *);
1087 
1088 /*
1089  * fsclient.c
1090  */
1091 extern void afs_fs_fetch_status(struct afs_operation *);
1092 extern void afs_fs_fetch_data(struct afs_operation *);
1093 extern void afs_fs_create_file(struct afs_operation *);
1094 extern void afs_fs_make_dir(struct afs_operation *);
1095 extern void afs_fs_remove_file(struct afs_operation *);
1096 extern void afs_fs_remove_dir(struct afs_operation *);
1097 extern void afs_fs_link(struct afs_operation *);
1098 extern void afs_fs_symlink(struct afs_operation *);
1099 extern void afs_fs_rename(struct afs_operation *);
1100 extern void afs_fs_store_data(struct afs_operation *);
1101 extern void afs_fs_setattr(struct afs_operation *);
1102 extern void afs_fs_get_volume_status(struct afs_operation *);
1103 extern void afs_fs_set_lock(struct afs_operation *);
1104 extern void afs_fs_extend_lock(struct afs_operation *);
1105 extern void afs_fs_release_lock(struct afs_operation *);
1106 extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
1107 					struct afs_addr_cursor *, struct key *);
1108 extern bool afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
1109 				    struct afs_addr_cursor *, struct key *);
1110 extern void afs_fs_inline_bulk_status(struct afs_operation *);
1111 
1112 struct afs_acl {
1113 	u32	size;
1114 	u8	data[];
1115 };
1116 
1117 extern void afs_fs_fetch_acl(struct afs_operation *);
1118 extern void afs_fs_store_acl(struct afs_operation *);
1119 
1120 /*
1121  * fs_operation.c
1122  */
1123 extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1124 extern int afs_put_operation(struct afs_operation *);
1125 extern bool afs_begin_vnode_operation(struct afs_operation *);
1126 extern void afs_wait_for_operation(struct afs_operation *);
1127 extern int afs_do_sync_operation(struct afs_operation *);
1128 
1129 static inline void afs_op_nomem(struct afs_operation *op)
1130 {
1131 	op->error = -ENOMEM;
1132 }
1133 
1134 static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1135 				    struct afs_vnode *vnode)
1136 {
1137 	op->file[n].vnode = vnode;
1138 	op->file[n].need_io_lock = true;
1139 }
1140 
1141 static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1142 				  const struct afs_fid *fid)
1143 {
1144 	op->file[n].fid = *fid;
1145 }
1146 
1147 /*
1148  * fs_probe.c
1149  */
1150 extern void afs_fileserver_probe_result(struct afs_call *);
1151 extern void afs_fs_probe_fileserver(struct afs_net *, struct afs_server *, struct key *, bool);
1152 extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
1153 extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
1154 extern void afs_fs_probe_dispatcher(struct work_struct *);
1155 extern int afs_wait_for_one_fs_probe(struct afs_server *, bool);
1156 extern void afs_fs_probe_cleanup(struct afs_net *);
1157 
1158 /*
1159  * inode.c
1160  */
1161 extern const struct afs_operation_ops afs_fetch_status_operation;
1162 
1163 extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
1164 extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1165 extern int afs_ilookup5_test_by_fid(struct inode *, void *);
1166 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1167 extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1168 extern struct inode *afs_root_iget(struct super_block *, struct key *);
1169 extern bool afs_check_validity(struct afs_vnode *);
1170 extern int afs_validate(struct afs_vnode *, struct key *);
1171 extern int afs_getattr(struct user_namespace *mnt_userns, const struct path *,
1172 		       struct kstat *, u32, unsigned int);
1173 extern int afs_setattr(struct user_namespace *mnt_userns, struct dentry *, struct iattr *);
1174 extern void afs_evict_inode(struct inode *);
1175 extern int afs_drop_inode(struct inode *);
1176 
1177 /*
1178  * main.c
1179  */
1180 extern struct workqueue_struct *afs_wq;
1181 extern int afs_net_id;
1182 
1183 static inline struct afs_net *afs_net(struct net *net)
1184 {
1185 	return net_generic(net, afs_net_id);
1186 }
1187 
1188 static inline struct afs_net *afs_sb2net(struct super_block *sb)
1189 {
1190 	return afs_net(AFS_FS_S(sb)->net_ns);
1191 }
1192 
1193 static inline struct afs_net *afs_d2net(struct dentry *dentry)
1194 {
1195 	return afs_sb2net(dentry->d_sb);
1196 }
1197 
1198 static inline struct afs_net *afs_i2net(struct inode *inode)
1199 {
1200 	return afs_sb2net(inode->i_sb);
1201 }
1202 
1203 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1204 {
1205 	return afs_i2net(&vnode->vfs_inode);
1206 }
1207 
1208 static inline struct afs_net *afs_sock2net(struct sock *sk)
1209 {
1210 	return net_generic(sock_net(sk), afs_net_id);
1211 }
1212 
1213 static inline void __afs_stat(atomic_t *s)
1214 {
1215 	atomic_inc(s);
1216 }
1217 
1218 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1219 
1220 /*
1221  * misc.c
1222  */
1223 extern int afs_abort_to_error(u32);
1224 extern void afs_prioritise_error(struct afs_error *, int, u32);
1225 
1226 /*
1227  * mntpt.c
1228  */
1229 extern const struct inode_operations afs_mntpt_inode_operations;
1230 extern const struct inode_operations afs_autocell_inode_operations;
1231 extern const struct file_operations afs_mntpt_file_operations;
1232 
1233 extern struct vfsmount *afs_d_automount(struct path *);
1234 extern void afs_mntpt_kill_timer(void);
1235 
1236 /*
1237  * proc.c
1238  */
1239 #ifdef CONFIG_PROC_FS
1240 extern int __net_init afs_proc_init(struct afs_net *);
1241 extern void __net_exit afs_proc_cleanup(struct afs_net *);
1242 extern int afs_proc_cell_setup(struct afs_cell *);
1243 extern void afs_proc_cell_remove(struct afs_cell *);
1244 extern void afs_put_sysnames(struct afs_sysnames *);
1245 #else
1246 static inline int afs_proc_init(struct afs_net *net) { return 0; }
1247 static inline void afs_proc_cleanup(struct afs_net *net) {}
1248 static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1249 static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1250 static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1251 #endif
1252 
1253 /*
1254  * rotate.c
1255  */
1256 extern bool afs_select_fileserver(struct afs_operation *);
1257 extern void afs_dump_edestaddrreq(const struct afs_operation *);
1258 
1259 /*
1260  * rxrpc.c
1261  */
1262 extern struct workqueue_struct *afs_async_calls;
1263 
1264 extern int __net_init afs_open_socket(struct afs_net *);
1265 extern void __net_exit afs_close_socket(struct afs_net *);
1266 extern void afs_charge_preallocation(struct work_struct *);
1267 extern void afs_put_call(struct afs_call *);
1268 extern void afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t);
1269 extern long afs_wait_for_call_to_complete(struct afs_call *, struct afs_addr_cursor *);
1270 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1271 					    const struct afs_call_type *,
1272 					    size_t, size_t);
1273 extern void afs_flat_call_destructor(struct afs_call *);
1274 extern void afs_send_empty_reply(struct afs_call *);
1275 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
1276 extern int afs_extract_data(struct afs_call *, bool);
1277 extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
1278 
1279 static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1280 				    gfp_t gfp)
1281 {
1282 	op->call = call;
1283 	op->type = call->type;
1284 	call->op = op;
1285 	call->key = op->key;
1286 	call->intr = !(op->flags & AFS_OPERATION_UNINTR);
1287 	afs_make_call(&op->ac, call, gfp);
1288 }
1289 
1290 static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1291 {
1292 	call->iov_len = size;
1293 	call->kvec[0].iov_base = buf;
1294 	call->kvec[0].iov_len = size;
1295 	iov_iter_kvec(&call->def_iter, READ, call->kvec, 1, size);
1296 }
1297 
1298 static inline void afs_extract_to_tmp(struct afs_call *call)
1299 {
1300 	call->iov_len = sizeof(call->tmp);
1301 	afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1302 }
1303 
1304 static inline void afs_extract_to_tmp64(struct afs_call *call)
1305 {
1306 	call->iov_len = sizeof(call->tmp64);
1307 	afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1308 }
1309 
1310 static inline void afs_extract_discard(struct afs_call *call, size_t size)
1311 {
1312 	call->iov_len = size;
1313 	iov_iter_discard(&call->def_iter, READ, size);
1314 }
1315 
1316 static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1317 {
1318 	call->iov_len = size;
1319 	afs_extract_begin(call, call->buffer, size);
1320 }
1321 
1322 static inline int afs_transfer_reply(struct afs_call *call)
1323 {
1324 	return afs_extract_data(call, false);
1325 }
1326 
1327 static inline bool afs_check_call_state(struct afs_call *call,
1328 					enum afs_call_state state)
1329 {
1330 	return READ_ONCE(call->state) == state;
1331 }
1332 
1333 static inline bool afs_set_call_state(struct afs_call *call,
1334 				      enum afs_call_state from,
1335 				      enum afs_call_state to)
1336 {
1337 	bool ok = false;
1338 
1339 	spin_lock_bh(&call->state_lock);
1340 	if (call->state == from) {
1341 		call->state = to;
1342 		trace_afs_call_state(call, from, to, 0, 0);
1343 		ok = true;
1344 	}
1345 	spin_unlock_bh(&call->state_lock);
1346 	return ok;
1347 }
1348 
1349 static inline void afs_set_call_complete(struct afs_call *call,
1350 					 int error, u32 remote_abort)
1351 {
1352 	enum afs_call_state state;
1353 	bool ok = false;
1354 
1355 	spin_lock_bh(&call->state_lock);
1356 	state = call->state;
1357 	if (state != AFS_CALL_COMPLETE) {
1358 		call->abort_code = remote_abort;
1359 		call->error = error;
1360 		call->state = AFS_CALL_COMPLETE;
1361 		trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1362 				     error, remote_abort);
1363 		ok = true;
1364 	}
1365 	spin_unlock_bh(&call->state_lock);
1366 	if (ok) {
1367 		trace_afs_call_done(call);
1368 
1369 		/* Asynchronous calls have two refs to release - one from the alloc and
1370 		 * one queued with the work item - and we can't just deallocate the
1371 		 * call because the work item may be queued again.
1372 		 */
1373 		if (call->drop_ref)
1374 			afs_put_call(call);
1375 	}
1376 }
1377 
1378 /*
1379  * security.c
1380  */
1381 extern void afs_put_permits(struct afs_permits *);
1382 extern void afs_clear_permits(struct afs_vnode *);
1383 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1384 			     struct afs_status_cb *);
1385 extern void afs_zap_permits(struct rcu_head *);
1386 extern struct key *afs_request_key(struct afs_cell *);
1387 extern struct key *afs_request_key_rcu(struct afs_cell *);
1388 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1389 extern int afs_permission(struct user_namespace *, struct inode *, int);
1390 extern void __exit afs_clean_up_permit_cache(void);
1391 
1392 /*
1393  * server.c
1394  */
1395 extern spinlock_t afs_server_peer_lock;
1396 
1397 extern struct afs_server *afs_find_server(struct afs_net *,
1398 					  const struct sockaddr_rxrpc *);
1399 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
1400 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
1401 extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
1402 extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1403 extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1404 extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
1405 extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1406 extern void afs_manage_servers(struct work_struct *);
1407 extern void afs_servers_timer(struct timer_list *);
1408 extern void afs_fs_probe_timer(struct timer_list *);
1409 extern void __net_exit afs_purge_servers(struct afs_net *);
1410 extern bool afs_check_server_record(struct afs_operation *, struct afs_server *);
1411 
1412 static inline void afs_inc_servers_outstanding(struct afs_net *net)
1413 {
1414 	atomic_inc(&net->servers_outstanding);
1415 }
1416 
1417 static inline void afs_dec_servers_outstanding(struct afs_net *net)
1418 {
1419 	if (atomic_dec_and_test(&net->servers_outstanding))
1420 		wake_up_var(&net->servers_outstanding);
1421 }
1422 
1423 static inline bool afs_is_probing_server(struct afs_server *server)
1424 {
1425 	return list_empty(&server->probe_link);
1426 }
1427 
1428 /*
1429  * server_list.c
1430  */
1431 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1432 {
1433 	refcount_inc(&slist->usage);
1434 	return slist;
1435 }
1436 
1437 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1438 extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
1439 						     struct afs_vldb_entry *,
1440 						     u8);
1441 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1442 
1443 /*
1444  * super.c
1445  */
1446 extern int __init afs_fs_init(void);
1447 extern void afs_fs_exit(void);
1448 
1449 /*
1450  * vlclient.c
1451  */
1452 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1453 							 const char *, int);
1454 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
1455 extern struct afs_call *afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *,
1456 						struct key *, struct afs_vlserver *, unsigned int);
1457 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1458 extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
1459 
1460 /*
1461  * vl_alias.c
1462  */
1463 extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1464 
1465 /*
1466  * vl_probe.c
1467  */
1468 extern void afs_vlserver_probe_result(struct afs_call *);
1469 extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1470 extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1471 
1472 /*
1473  * vl_rotate.c
1474  */
1475 extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1476 					 struct afs_cell *, struct key *);
1477 extern bool afs_select_vlserver(struct afs_vl_cursor *);
1478 extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1479 extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1480 
1481 /*
1482  * vlserver_list.c
1483  */
1484 static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1485 {
1486 	atomic_inc(&vlserver->usage);
1487 	return vlserver;
1488 }
1489 
1490 static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1491 {
1492 	if (vllist)
1493 		atomic_inc(&vllist->usage);
1494 	return vllist;
1495 }
1496 
1497 extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1498 extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1499 extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1500 extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1501 extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1502 							   const void *, size_t);
1503 
1504 /*
1505  * volume.c
1506  */
1507 extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1508 extern void afs_activate_volume(struct afs_volume *);
1509 extern void afs_deactivate_volume(struct afs_volume *);
1510 extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1511 extern void afs_put_volume(struct afs_net *, struct afs_volume *, enum afs_volume_trace);
1512 extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
1513 
1514 /*
1515  * write.c
1516  */
1517 extern int afs_set_page_dirty(struct page *);
1518 extern int afs_write_begin(struct file *file, struct address_space *mapping,
1519 			loff_t pos, unsigned len, unsigned flags,
1520 			struct page **pagep, void **fsdata);
1521 extern int afs_write_end(struct file *file, struct address_space *mapping,
1522 			loff_t pos, unsigned len, unsigned copied,
1523 			struct page *page, void *fsdata);
1524 extern int afs_writepage(struct page *, struct writeback_control *);
1525 extern int afs_writepages(struct address_space *, struct writeback_control *);
1526 extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
1527 extern int afs_fsync(struct file *, loff_t, loff_t, int);
1528 extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
1529 extern void afs_prune_wb_keys(struct afs_vnode *);
1530 extern int afs_launder_page(struct page *);
1531 
1532 /*
1533  * xattr.c
1534  */
1535 extern const struct xattr_handler *afs_xattr_handlers[];
1536 
1537 /*
1538  * yfsclient.c
1539  */
1540 extern void yfs_fs_fetch_data(struct afs_operation *);
1541 extern void yfs_fs_create_file(struct afs_operation *);
1542 extern void yfs_fs_make_dir(struct afs_operation *);
1543 extern void yfs_fs_remove_file2(struct afs_operation *);
1544 extern void yfs_fs_remove_file(struct afs_operation *);
1545 extern void yfs_fs_remove_dir(struct afs_operation *);
1546 extern void yfs_fs_link(struct afs_operation *);
1547 extern void yfs_fs_symlink(struct afs_operation *);
1548 extern void yfs_fs_rename(struct afs_operation *);
1549 extern void yfs_fs_store_data(struct afs_operation *);
1550 extern void yfs_fs_setattr(struct afs_operation *);
1551 extern void yfs_fs_get_volume_status(struct afs_operation *);
1552 extern void yfs_fs_set_lock(struct afs_operation *);
1553 extern void yfs_fs_extend_lock(struct afs_operation *);
1554 extern void yfs_fs_release_lock(struct afs_operation *);
1555 extern void yfs_fs_fetch_status(struct afs_operation *);
1556 extern void yfs_fs_inline_bulk_status(struct afs_operation *);
1557 
1558 struct yfs_acl {
1559 	struct afs_acl	*acl;		/* Dir/file/symlink ACL */
1560 	struct afs_acl	*vol_acl;	/* Whole volume ACL */
1561 	u32		inherit_flag;	/* True if ACL is inherited from parent dir */
1562 	u32		num_cleaned;	/* Number of ACEs removed due to subject removal */
1563 	unsigned int	flags;
1564 #define YFS_ACL_WANT_ACL	0x01	/* Set if caller wants ->acl */
1565 #define YFS_ACL_WANT_VOL_ACL	0x02	/* Set if caller wants ->vol_acl */
1566 };
1567 
1568 extern void yfs_free_opaque_acl(struct yfs_acl *);
1569 extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1570 extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
1571 
1572 /*
1573  * Miscellaneous inline functions.
1574  */
1575 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1576 {
1577 	return container_of(inode, struct afs_vnode, vfs_inode);
1578 }
1579 
1580 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1581 {
1582 	return &vnode->vfs_inode;
1583 }
1584 
1585 /*
1586  * Note that a dentry got changed.  We need to set d_fsdata to the data version
1587  * number derived from the result of the operation.  It doesn't matter if
1588  * d_fsdata goes backwards as we'll just revalidate.
1589  */
1590 static inline void afs_update_dentry_version(struct afs_operation *op,
1591 					     struct afs_vnode_param *dir_vp,
1592 					     struct dentry *dentry)
1593 {
1594 	if (!op->error)
1595 		dentry->d_fsdata =
1596 			(void *)(unsigned long)dir_vp->scb.status.data_version;
1597 }
1598 
1599 /*
1600  * Set the file size and block count.  Estimate the number of 512 bytes blocks
1601  * used, rounded up to nearest 1K for consistency with other AFS clients.
1602  */
1603 static inline void afs_set_i_size(struct afs_vnode *vnode, u64 size)
1604 {
1605 	i_size_write(&vnode->vfs_inode, size);
1606 	vnode->vfs_inode.i_blocks = ((size + 1023) >> 10) << 1;
1607 }
1608 
1609 /*
1610  * Check for a conflicting operation on a directory that we just unlinked from.
1611  * If someone managed to sneak a link or an unlink in on the file we just
1612  * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1613  */
1614 static inline void afs_check_dir_conflict(struct afs_operation *op,
1615 					  struct afs_vnode_param *dvp)
1616 {
1617 	if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1618 		op->flags |= AFS_OPERATION_DIR_CONFLICT;
1619 }
1620 
1621 static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1622 {
1623 	trace_afs_io_error(call->debug_id, -EIO, where);
1624 	return -EIO;
1625 }
1626 
1627 static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1628 {
1629 	trace_afs_file_error(vnode, -EIO, where);
1630 	return -EIO;
1631 }
1632 
1633 /*****************************************************************************/
1634 /*
1635  * debug tracing
1636  */
1637 extern unsigned afs_debug;
1638 
1639 #define dbgprintk(FMT,...) \
1640 	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1641 
1642 #define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1643 #define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1644 #define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
1645 
1646 
1647 #if defined(__KDEBUG)
1648 #define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
1649 #define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
1650 #define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
1651 
1652 #elif defined(CONFIG_AFS_DEBUG)
1653 #define AFS_DEBUG_KENTER	0x01
1654 #define AFS_DEBUG_KLEAVE	0x02
1655 #define AFS_DEBUG_KDEBUG	0x04
1656 
1657 #define _enter(FMT,...)					\
1658 do {							\
1659 	if (unlikely(afs_debug & AFS_DEBUG_KENTER))	\
1660 		kenter(FMT,##__VA_ARGS__);		\
1661 } while (0)
1662 
1663 #define _leave(FMT,...)					\
1664 do {							\
1665 	if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))	\
1666 		kleave(FMT,##__VA_ARGS__);		\
1667 } while (0)
1668 
1669 #define _debug(FMT,...)					\
1670 do {							\
1671 	if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))	\
1672 		kdebug(FMT,##__VA_ARGS__);		\
1673 } while (0)
1674 
1675 #else
1676 #define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1677 #define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1678 #define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
1679 #endif
1680 
1681 /*
1682  * debug assertion checking
1683  */
1684 #if 1 // defined(__KDEBUGALL)
1685 
1686 #define ASSERT(X)						\
1687 do {								\
1688 	if (unlikely(!(X))) {					\
1689 		printk(KERN_ERR "\n");				\
1690 		printk(KERN_ERR "AFS: Assertion failed\n");	\
1691 		BUG();						\
1692 	}							\
1693 } while(0)
1694 
1695 #define ASSERTCMP(X, OP, Y)						\
1696 do {									\
1697 	if (unlikely(!((X) OP (Y)))) {					\
1698 		printk(KERN_ERR "\n");					\
1699 		printk(KERN_ERR "AFS: Assertion failed\n");		\
1700 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
1701 		       (unsigned long)(X), (unsigned long)(Y));		\
1702 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
1703 		       (unsigned long)(X), (unsigned long)(Y));		\
1704 		BUG();							\
1705 	}								\
1706 } while(0)
1707 
1708 #define ASSERTRANGE(L, OP1, N, OP2, H)					\
1709 do {									\
1710 	if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {		\
1711 		printk(KERN_ERR "\n");					\
1712 		printk(KERN_ERR "AFS: Assertion failed\n");		\
1713 		printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n",	\
1714 		       (unsigned long)(L), (unsigned long)(N),		\
1715 		       (unsigned long)(H));				\
1716 		printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1717 		       (unsigned long)(L), (unsigned long)(N),		\
1718 		       (unsigned long)(H));				\
1719 		BUG();							\
1720 	}								\
1721 } while(0)
1722 
1723 #define ASSERTIF(C, X)						\
1724 do {								\
1725 	if (unlikely((C) && !(X))) {				\
1726 		printk(KERN_ERR "\n");				\
1727 		printk(KERN_ERR "AFS: Assertion failed\n");	\
1728 		BUG();						\
1729 	}							\
1730 } while(0)
1731 
1732 #define ASSERTIFCMP(C, X, OP, Y)					\
1733 do {									\
1734 	if (unlikely((C) && !((X) OP (Y)))) {				\
1735 		printk(KERN_ERR "\n");					\
1736 		printk(KERN_ERR "AFS: Assertion failed\n");		\
1737 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
1738 		       (unsigned long)(X), (unsigned long)(Y));		\
1739 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
1740 		       (unsigned long)(X), (unsigned long)(Y));		\
1741 		BUG();							\
1742 	}								\
1743 } while(0)
1744 
1745 #else
1746 
1747 #define ASSERT(X)				\
1748 do {						\
1749 } while(0)
1750 
1751 #define ASSERTCMP(X, OP, Y)			\
1752 do {						\
1753 } while(0)
1754 
1755 #define ASSERTRANGE(L, OP1, N, OP2, H)		\
1756 do {						\
1757 } while(0)
1758 
1759 #define ASSERTIF(C, X)				\
1760 do {						\
1761 } while(0)
1762 
1763 #define ASSERTIFCMP(C, X, OP, Y)		\
1764 do {						\
1765 } while(0)
1766 
1767 #endif /* __KDEBUGALL */
1768