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