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