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