xref: /linux/fs/afs/internal.h (revision d56239a82e3721d38ff5496f2411bf0cb57ece5c)
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 work_struct	free_work;	/* Deferred free processor */
134 	struct rxrpc_call	*rxcall;	/* RxRPC call handle */
135 	struct rxrpc_peer	*peer;		/* Remote endpoint */
136 	struct key		*key;		/* security for this call */
137 	struct afs_net		*net;		/* The network namespace */
138 	struct afs_server	*server;	/* The fileserver record if fs op (pins ref) */
139 	struct afs_vlserver	*vlserver;	/* The vlserver record if vl op */
140 	void			*request;	/* request data (first part) */
141 	size_t			iov_len;	/* Size of *iter to be used */
142 	struct iov_iter		def_iter;	/* Default buffer/data iterator */
143 	struct iov_iter		*write_iter;	/* Iterator defining write to be made */
144 	struct iov_iter		*iter;		/* Iterator currently in use */
145 	union {	/* Convenience for ->def_iter */
146 		struct kvec	kvec[1];
147 		struct bio_vec	bvec[1];
148 	};
149 	void			*buffer;	/* reply receive buffer */
150 	union {
151 		struct afs_endpoint_state *probe;
152 		struct afs_addr_list	*vl_probe;
153 		struct afs_addr_list	*ret_alist;
154 		struct afs_vldb_entry	*ret_vldb;
155 		char			*ret_str;
156 	};
157 	struct afs_fid		fid;		/* Primary vnode ID (or all zeroes) */
158 	unsigned char		probe_index;	/* Address in ->probe_alist */
159 	struct afs_operation	*op;
160 	unsigned int		server_index;
161 	refcount_t		ref;
162 	enum afs_call_state	state;
163 	spinlock_t		state_lock;
164 	int			error;		/* error code */
165 	u32			abort_code;	/* Remote abort ID or 0 */
166 	unsigned int		max_lifespan;	/* Maximum lifespan in secs to set if not 0 */
167 	unsigned		request_size;	/* size of request data */
168 	unsigned		reply_max;	/* maximum size of reply */
169 	unsigned		count2;		/* count used in unmarshalling */
170 	unsigned char		unmarshall;	/* unmarshalling phase */
171 	bool			drop_ref;	/* T if need to drop ref for incoming call */
172 	bool			need_attention;	/* T if RxRPC poked us */
173 	bool			async;		/* T if asynchronous */
174 	bool			upgrade;	/* T to request service upgrade */
175 	bool			intr;		/* T if interruptible */
176 	bool			unmarshalling_error; /* T if an unmarshalling error occurred */
177 	bool			responded;	/* Got a response from the call (may be abort) */
178 	u16			service_id;	/* Actual service ID (after upgrade) */
179 	unsigned int		debug_id;	/* Trace ID */
180 	u32			operation_ID;	/* operation ID for an incoming call */
181 	u32			count;		/* count for use in unmarshalling */
182 	union {					/* place to extract temporary data */
183 		struct {
184 			__be32	tmp_u;
185 			__be32	tmp;
186 		} __attribute__((packed));
187 		__be64		tmp64;
188 	};
189 	ktime_t			issue_time;	/* Time of issue of operation */
190 };
191 
192 struct afs_call_type {
193 	const char *name;
194 	unsigned int op; /* Really enum afs_fs_operation */
195 
196 	/* deliver request or reply data to an call
197 	 * - returning an error will cause the call to be aborted
198 	 */
199 	int (*deliver)(struct afs_call *call);
200 
201 	/* clean up a call */
202 	void (*destructor)(struct afs_call *call);
203 
204 	/* Work function */
205 	void (*work)(struct work_struct *work);
206 
207 	/* Call done function (gets called immediately on success or failure) */
208 	void (*done)(struct afs_call *call);
209 };
210 
211 /*
212  * Key available for writeback on a file.
213  */
214 struct afs_wb_key {
215 	refcount_t		usage;
216 	struct key		*key;
217 	struct list_head	vnode_link;	/* Link in vnode->wb_keys */
218 };
219 
220 /*
221  * AFS open file information record.  Pointed to by file->private_data.
222  */
223 struct afs_file {
224 	struct key		*key;		/* The key this file was opened with */
225 	struct afs_wb_key	*wb;		/* Writeback key record for this file */
226 };
227 
afs_file_key(struct file * file)228 static inline struct key *afs_file_key(struct file *file)
229 {
230 	struct afs_file *af = file->private_data;
231 
232 	return af->key;
233 }
234 
235 /*
236  * Record of an outstanding read operation on a vnode.
237  */
238 struct afs_read {
239 	loff_t			pos;		/* Where to start reading */
240 	loff_t			len;		/* How much we're asking for */
241 	loff_t			actual_len;	/* How much we're actually getting */
242 	loff_t			file_size;	/* File size returned by server */
243 	struct key		*key;		/* The key to use to reissue the read */
244 	struct afs_vnode	*vnode;		/* The file being read into. */
245 	struct netfs_io_subrequest *subreq;	/* Fscache helper read request this belongs to */
246 	afs_dataversion_t	data_version;	/* Version number returned by server */
247 	refcount_t		usage;
248 	unsigned int		call_debug_id;
249 	unsigned int		nr_pages;
250 	int			error;
251 	void (*done)(struct afs_read *);
252 	void (*cleanup)(struct afs_read *);
253 	struct iov_iter		*iter;		/* Iterator representing the buffer */
254 	struct iov_iter		def_iter;	/* Default iterator */
255 };
256 
257 /*
258  * AFS superblock private data
259  * - there's one superblock per volume
260  */
261 struct afs_super_info {
262 	struct net		*net_ns;	/* Network namespace */
263 	struct afs_cell		*cell;		/* The cell in which the volume resides */
264 	struct afs_volume	*volume;	/* volume record */
265 	enum afs_flock_mode	flock_mode:8;	/* File locking emulation mode */
266 	bool			dyn_root;	/* True if dynamic root */
267 };
268 
AFS_FS_S(struct super_block * sb)269 static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
270 {
271 	return sb->s_fs_info;
272 }
273 
274 extern struct file_system_type afs_fs_type;
275 
276 /*
277  * Set of substitutes for @sys.
278  */
279 struct afs_sysnames {
280 #define AFS_NR_SYSNAME 16
281 	char			*subs[AFS_NR_SYSNAME];
282 	refcount_t		usage;
283 	unsigned short		nr;
284 	char			blank[1];
285 };
286 
287 /*
288  * AFS network namespace record.
289  */
290 struct afs_net {
291 	struct net		*net;		/* Backpointer to the owning net namespace */
292 	struct afs_uuid		uuid;
293 	bool			live;		/* F if this namespace is being removed */
294 
295 	/* AF_RXRPC I/O stuff */
296 	struct socket		*socket;
297 	struct afs_call		*spare_incoming_call;
298 	struct work_struct	charge_preallocation_work;
299 	struct mutex		socket_mutex;
300 	atomic_t		nr_outstanding_calls;
301 	atomic_t		nr_superblocks;
302 
303 	/* Cell database */
304 	struct rb_root		cells;
305 	struct afs_cell		*ws_cell;
306 	struct work_struct	cells_manager;
307 	struct timer_list	cells_timer;
308 	atomic_t		cells_outstanding;
309 	struct rw_semaphore	cells_lock;
310 	struct mutex		cells_alias_lock;
311 
312 	struct mutex		proc_cells_lock;
313 	struct hlist_head	proc_cells;
314 
315 	/* Known servers.  Theoretically each fileserver can only be in one
316 	 * cell, but in practice, people create aliases and subsets and there's
317 	 * no easy way to distinguish them.
318 	 */
319 	seqlock_t		fs_lock;	/* For fs_servers, fs_probe_*, fs_proc */
320 	struct rb_root		fs_servers;	/* afs_server (by server UUID or address) */
321 	struct list_head	fs_probe_fast;	/* List of afs_server to probe at 30s intervals */
322 	struct list_head	fs_probe_slow;	/* List of afs_server to probe at 5m intervals */
323 	struct hlist_head	fs_proc;	/* procfs servers list */
324 
325 	struct hlist_head	fs_addresses;	/* 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	addr_link;	/* Link in net->fs_addresses6 */
565 	struct hlist_node	proc_link;	/* Link in net->fs_proc */
566 	struct list_head	volumes;	/* RCU list of afs_server_entry objects */
567 	struct afs_server	*gc_next;	/* Next server in manager's list */
568 	time64_t		unuse_time;	/* Time at which last unused */
569 	unsigned long		flags;
570 #define AFS_SERVER_FL_RESPONDING 0		/* The server is responding */
571 #define AFS_SERVER_FL_UPDATING	1
572 #define AFS_SERVER_FL_NEEDS_UPDATE 2		/* Fileserver address list is out of date */
573 #define AFS_SERVER_FL_NOT_READY	4		/* The record is not ready for use */
574 #define AFS_SERVER_FL_NOT_FOUND	5		/* VL server says no such server */
575 #define AFS_SERVER_FL_VL_FAIL	6		/* Failed to access VL server */
576 #define AFS_SERVER_FL_MAY_HAVE_CB 8		/* May have callbacks on this fileserver */
577 #define AFS_SERVER_FL_IS_YFS	16		/* Server is YFS not AFS */
578 #define AFS_SERVER_FL_NO_IBULK	17		/* Fileserver doesn't support FS.InlineBulkStatus */
579 #define AFS_SERVER_FL_NO_RM2	18		/* Fileserver doesn't support YFS.RemoveFile2 */
580 #define AFS_SERVER_FL_HAS_FS64	19		/* Fileserver supports FS.{Fetch,Store}Data64 */
581 	refcount_t		ref;		/* Object refcount */
582 	atomic_t		active;		/* Active user count */
583 	u32			addr_version;	/* Address list version */
584 	u16			service_id;	/* Service ID we're using. */
585 	unsigned int		rtt;		/* Server's current RTT in uS */
586 	unsigned int		debug_id;	/* Debugging ID for traces */
587 
588 	/* file service access */
589 	rwlock_t		fs_lock;	/* access lock */
590 
591 	/* Probe state */
592 	struct afs_endpoint_state __rcu *endpoint_state; /* Latest endpoint/probe state */
593 	unsigned long		probed_at;	/* Time last probe was dispatched (jiffies) */
594 	wait_queue_head_t	probe_wq;
595 	unsigned int		probe_counter;	/* Number of probes issued */
596 	spinlock_t		probe_lock;
597 };
598 
599 enum afs_ro_replicating {
600 	AFS_RO_NOT_REPLICATING,			/* Not doing replication */
601 	AFS_RO_REPLICATING_USE_OLD,		/* Replicating; use old version */
602 	AFS_RO_REPLICATING_USE_NEW,		/* Replicating; switch to new version */
603 } __mode(byte);
604 
605 /*
606  * Replaceable volume server list.
607  */
608 struct afs_server_entry {
609 	struct afs_server	*server;
610 	struct afs_volume	*volume;
611 	struct list_head	slink;		/* Link in server->volumes */
612 	time64_t		cb_expires_at;	/* Time at which volume-level callback expires */
613 	unsigned long		flags;
614 #define AFS_SE_EXCLUDED		0		/* Set if server is to be excluded in rotation */
615 #define AFS_SE_VOLUME_OFFLINE	1		/* Set if volume offline notice given */
616 #define AFS_SE_VOLUME_BUSY	2		/* Set if volume busy notice given */
617 };
618 
619 struct afs_server_list {
620 	struct rcu_head		rcu;
621 	refcount_t		usage;
622 	bool			attached;	/* T if attached to servers */
623 	enum afs_ro_replicating	ro_replicating;	/* RW->RO update (probably) in progress */
624 	unsigned char		nr_servers;
625 	unsigned short		vnovol_mask;	/* Servers to be skipped due to VNOVOL */
626 	unsigned int		seq;		/* Set to ->servers_seq when installed */
627 	rwlock_t		lock;
628 	struct afs_server_entry	servers[];
629 };
630 
631 /*
632  * Live AFS volume management.
633  */
634 struct afs_volume {
635 	struct rcu_head	rcu;
636 	afs_volid_t		vid;		/* The volume ID of this volume */
637 	afs_volid_t		vids[AFS_MAXTYPES]; /* All associated volume IDs */
638 	refcount_t		ref;
639 	time64_t		update_at;	/* Time at which to next update */
640 	struct afs_cell		*cell;		/* Cell to which belongs (pins ref) */
641 	struct rb_node		cell_node;	/* Link in cell->volumes */
642 	struct hlist_node	proc_link;	/* Link in cell->proc_volumes */
643 	struct super_block __rcu *sb;		/* Superblock on which inodes reside */
644 	struct work_struct	destructor;	/* Deferred destructor */
645 	unsigned long		flags;
646 #define AFS_VOLUME_NEEDS_UPDATE	0	/* - T if an update needs performing */
647 #define AFS_VOLUME_UPDATING	1	/* - T if an update is in progress */
648 #define AFS_VOLUME_WAIT		2	/* - T if users must wait for update */
649 #define AFS_VOLUME_DELETED	3	/* - T if volume appears deleted */
650 #define AFS_VOLUME_MAYBE_NO_IBULK 4	/* - T if some servers don't have InlineBulkStatus */
651 #define AFS_VOLUME_RM_TREE	5	/* - Set if volume removed from cell->volumes */
652 #ifdef CONFIG_AFS_FSCACHE
653 	struct fscache_volume	*cache;		/* Caching cookie */
654 #endif
655 	struct afs_server_list __rcu *servers;	/* List of servers on which volume resides */
656 	rwlock_t		servers_lock;	/* Lock for ->servers */
657 	unsigned int		servers_seq;	/* Incremented each time ->servers changes */
658 
659 	/* RO release tracking */
660 	struct mutex		volsync_lock;	/* Time/state evaluation lock */
661 	time64_t		creation_time;	/* Volume creation time (or TIME64_MIN) */
662 	time64_t		update_time;	/* Volume update time (or TIME64_MIN) */
663 
664 	/* Callback management */
665 	struct mutex		cb_check_lock;	/* Lock to control race to check after v_break */
666 	time64_t		cb_expires_at;	/* Earliest volume callback expiry time */
667 	atomic_t		cb_ro_snapshot;	/* RO volume update-from-snapshot counter */
668 	atomic_t		cb_v_break;	/* Volume-break event counter. */
669 	atomic_t		cb_v_check;	/* Volume-break has-been-checked counter. */
670 	atomic_t		cb_scrub;	/* Scrub-all-data event counter. */
671 	rwlock_t		cb_v_break_lock;
672 	struct rw_semaphore	open_mmaps_lock;
673 	struct list_head	open_mmaps;	/* List of vnodes that are mmapped */
674 
675 	afs_voltype_t		type;		/* type of volume */
676 	char			type_force;	/* force volume type (suppress R/O -> R/W) */
677 	u8			name_len;
678 	u8			name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
679 };
680 
681 enum afs_lock_state {
682 	AFS_VNODE_LOCK_NONE,		/* The vnode has no lock on the server */
683 	AFS_VNODE_LOCK_WAITING_FOR_CB,	/* We're waiting for the server to break the callback */
684 	AFS_VNODE_LOCK_SETTING,		/* We're asking the server for a lock */
685 	AFS_VNODE_LOCK_GRANTED,		/* We have a lock on the server */
686 	AFS_VNODE_LOCK_EXTENDING,	/* We're extending a lock on the server */
687 	AFS_VNODE_LOCK_NEED_UNLOCK,	/* We need to unlock on the server */
688 	AFS_VNODE_LOCK_UNLOCKING,	/* We're telling the server to unlock */
689 	AFS_VNODE_LOCK_DELETED,		/* The vnode has been deleted whilst we have a lock */
690 };
691 
692 /*
693  * AFS inode private data.
694  *
695  * Note that afs_alloc_inode() *must* reset anything that could incorrectly
696  * leak from one inode to another.
697  */
698 struct afs_vnode {
699 	struct netfs_inode	netfs;		/* Netfslib context and vfs inode */
700 	struct afs_volume	*volume;	/* volume on which vnode resides */
701 	struct afs_fid		fid;		/* the file identifier for this inode */
702 	struct afs_file_status	status;		/* AFS status info for this file */
703 	afs_dataversion_t	invalid_before;	/* Child dentries are invalid before this */
704 	struct afs_permits __rcu *permit_cache;	/* cache of permits so far obtained */
705 	struct mutex		io_lock;	/* Lock for serialising I/O on this mutex */
706 	struct rw_semaphore	validate_lock;	/* lock for validating this vnode */
707 	struct rw_semaphore	rmdir_lock;	/* Lock for rmdir vs sillyrename */
708 	struct key		*silly_key;	/* Silly rename key */
709 	spinlock_t		wb_lock;	/* lock for wb_keys */
710 	spinlock_t		lock;		/* waitqueue/flags lock */
711 	unsigned long		flags;
712 #define AFS_VNODE_UNSET		1		/* set if vnode attributes not yet set */
713 #define AFS_VNODE_DIR_VALID	2		/* Set if dir contents are valid */
714 #define AFS_VNODE_ZAP_DATA	3		/* set if vnode's data should be invalidated */
715 #define AFS_VNODE_DELETED	4		/* set if vnode deleted on server */
716 #define AFS_VNODE_MOUNTPOINT	5		/* set if vnode is a mountpoint symlink */
717 #define AFS_VNODE_AUTOCELL	6		/* set if Vnode is an auto mount point */
718 #define AFS_VNODE_PSEUDODIR	7 		/* set if Vnode is a pseudo directory */
719 #define AFS_VNODE_NEW_CONTENT	8		/* Set if file has new content (create/trunc-0) */
720 #define AFS_VNODE_SILLY_DELETED	9		/* Set if file has been silly-deleted */
721 #define AFS_VNODE_MODIFYING	10		/* Set if we're performing a modification op */
722 
723 	struct list_head	wb_keys;	/* List of keys available for writeback */
724 	struct list_head	pending_locks;	/* locks waiting to be granted */
725 	struct list_head	granted_locks;	/* locks granted on this file */
726 	struct delayed_work	lock_work;	/* work to be done in locking */
727 	struct key		*lock_key;	/* Key to be used in lock ops */
728 	ktime_t			locked_at;	/* Time at which lock obtained */
729 	enum afs_lock_state	lock_state : 8;
730 	afs_lock_type_t		lock_type : 8;
731 
732 	/* outstanding callback notification on this file */
733 	struct work_struct	cb_work;	/* Work for mmap'd files */
734 	struct list_head	cb_mmap_link;	/* Link in cell->fs_open_mmaps */
735 	void			*cb_server;	/* Server with callback/filelock */
736 	atomic_t		cb_nr_mmap;	/* Number of mmaps */
737 	unsigned int		cb_ro_snapshot;	/* RO volume release counter on ->volume */
738 	unsigned int		cb_scrub;	/* Scrub counter on ->volume */
739 	unsigned int		cb_break;	/* Break counter on vnode */
740 	unsigned int		cb_v_check;	/* Break check counter on ->volume */
741 	seqlock_t		cb_lock;	/* Lock for ->cb_server, ->status, ->cb_*break */
742 
743 	atomic64_t		cb_expires_at;	/* time at which callback expires */
744 #define AFS_NO_CB_PROMISE TIME64_MIN
745 };
746 
afs_vnode_cache(struct afs_vnode * vnode)747 static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
748 {
749 #ifdef CONFIG_AFS_FSCACHE
750 	return netfs_i_cookie(&vnode->netfs);
751 #else
752 	return NULL;
753 #endif
754 }
755 
afs_vnode_set_cache(struct afs_vnode * vnode,struct fscache_cookie * cookie)756 static inline void afs_vnode_set_cache(struct afs_vnode *vnode,
757 				       struct fscache_cookie *cookie)
758 {
759 #ifdef CONFIG_AFS_FSCACHE
760 	vnode->netfs.cache = cookie;
761 	if (cookie)
762 		mapping_set_release_always(vnode->netfs.inode.i_mapping);
763 #endif
764 }
765 
766 /*
767  * cached security record for one user's attempt to access a vnode
768  */
769 struct afs_permit {
770 	struct key		*key;		/* RxRPC ticket holding a security context */
771 	afs_access_t		access;		/* CallerAccess value for this key */
772 };
773 
774 /*
775  * Immutable cache of CallerAccess records from attempts to access vnodes.
776  * These may be shared between multiple vnodes.
777  */
778 struct afs_permits {
779 	struct rcu_head		rcu;
780 	struct hlist_node	hash_node;	/* Link in hash */
781 	unsigned long		h;		/* Hash value for this permit list */
782 	refcount_t		usage;
783 	unsigned short		nr_permits;	/* Number of records */
784 	bool			invalidated;	/* Invalidated due to key change */
785 	struct afs_permit	permits[] __counted_by(nr_permits);	/* List of permits sorted by key pointer */
786 };
787 
788 /*
789  * Error prioritisation and accumulation.
790  */
791 struct afs_error {
792 	s32	abort_code;		/* Cumulative abort code */
793 	short	error;			/* Cumulative error */
794 	bool	responded;		/* T if server responded */
795 	bool	aborted;		/* T if ->error is from an abort */
796 };
797 
798 /*
799  * Cursor for iterating over a set of volume location servers.
800  */
801 struct afs_vl_cursor {
802 	struct afs_cell		*cell;		/* The cell we're querying */
803 	struct afs_vlserver_list *server_list;	/* Current server list (pins ref) */
804 	struct afs_vlserver	*server;	/* Server on which this resides */
805 	struct afs_addr_list	*alist;		/* Current address list (pins ref) */
806 	struct key		*key;		/* Key for the server */
807 	unsigned long		untried_servers; /* Bitmask of untried servers */
808 	unsigned long		addr_tried;	/* Tried addresses */
809 	struct afs_error	cumul_error;	/* Cumulative error */
810 	unsigned int		debug_id;
811 	s32			call_abort_code;
812 	short			call_error;	/* Error from single call */
813 	short			server_index;	/* Current server */
814 	signed char		addr_index;	/* Current address */
815 	unsigned short		flags;
816 #define AFS_VL_CURSOR_STOP	0x0001		/* Set to cease iteration */
817 #define AFS_VL_CURSOR_RETRY	0x0002		/* Set to do a retry */
818 #define AFS_VL_CURSOR_RETRIED	0x0004		/* Set if started a retry */
819 	short			nr_iterations;	/* Number of server iterations */
820 	bool			call_responded;	/* T if the current address responded */
821 };
822 
823 /*
824  * Fileserver state tracking for an operation.  An array of these is kept,
825  * indexed by server index.
826  */
827 struct afs_server_state {
828 	/* Tracking of fileserver probe state.  Other operations may interfere
829 	 * by probing a fileserver when accessing other volumes.
830 	 */
831 	unsigned int		probe_seq;
832 	unsigned long		untried_addrs;	/* Addresses we haven't tried yet */
833 	struct wait_queue_entry	probe_waiter;
834 	struct afs_endpoint_state *endpoint_state; /* Endpoint state being monitored */
835 };
836 
837 /*
838  * Fileserver operation methods.
839  */
840 struct afs_operation_ops {
841 	void (*issue_afs_rpc)(struct afs_operation *op);
842 	void (*issue_yfs_rpc)(struct afs_operation *op);
843 	void (*success)(struct afs_operation *op);
844 	void (*aborted)(struct afs_operation *op);
845 	void (*failed)(struct afs_operation *op);
846 	void (*edit_dir)(struct afs_operation *op);
847 	void (*put)(struct afs_operation *op);
848 };
849 
850 struct afs_vnode_param {
851 	struct afs_vnode	*vnode;
852 	struct afs_fid		fid;		/* Fid to access */
853 	struct afs_status_cb	scb;		/* Returned status and callback promise */
854 	afs_dataversion_t	dv_before;	/* Data version before the call */
855 	unsigned int		cb_break_before; /* cb_break before the call */
856 	u8			dv_delta;	/* Expected change in data version */
857 	bool			put_vnode:1;	/* T if we have a ref on the vnode */
858 	bool			need_io_lock:1;	/* T if we need the I/O lock on this */
859 	bool			update_ctime:1;	/* Need to update the ctime */
860 	bool			set_size:1;	/* Must update i_size */
861 	bool			op_unlinked:1;	/* True if file was unlinked by op */
862 	bool			speculative:1;	/* T if speculative status fetch (no vnode lock) */
863 	bool			modification:1;	/* Set if the content gets modified */
864 };
865 
866 /*
867  * Fileserver operation wrapper, handling server and address rotation
868  * asynchronously.  May make simultaneous calls to multiple servers.
869  */
870 struct afs_operation {
871 	struct afs_net		*net;		/* Network namespace */
872 	struct key		*key;		/* Key for the cell */
873 	const struct afs_call_type *type;	/* Type of call done */
874 	const struct afs_operation_ops *ops;
875 
876 	/* Parameters/results for the operation */
877 	struct afs_volume	*volume;	/* Volume being accessed */
878 	struct afs_vnode_param	file[2];
879 	struct afs_vnode_param	*more_files;
880 	struct afs_volsync	pre_volsync;	/* Volsync before op */
881 	struct afs_volsync	volsync;	/* Volsync returned by op */
882 	struct dentry		*dentry;	/* Dentry to be altered */
883 	struct dentry		*dentry_2;	/* Second dentry to be altered */
884 	struct timespec64	mtime;		/* Modification time to record */
885 	struct timespec64	ctime;		/* Change time to set */
886 	struct afs_error	cumul_error;	/* Cumulative error */
887 	short			nr_files;	/* Number of entries in file[], more_files */
888 	unsigned int		debug_id;
889 
890 	unsigned int		cb_v_break;	/* Volume break counter before op */
891 
892 	union {
893 		struct {
894 			int	which;		/* Which ->file[] to fetch for */
895 		} fetch_status;
896 		struct {
897 			int	reason;		/* enum afs_edit_dir_reason */
898 			mode_t	mode;
899 			const char *symlink;
900 		} create;
901 		struct {
902 			bool	need_rehash;
903 		} unlink;
904 		struct {
905 			struct dentry *rehash;
906 			struct dentry *tmp;
907 			bool	new_negative;
908 		} rename;
909 		struct {
910 			struct afs_read *req;
911 		} fetch;
912 		struct {
913 			afs_lock_type_t type;
914 		} lock;
915 		struct {
916 			struct iov_iter	*write_iter;
917 			loff_t	pos;
918 			loff_t	size;
919 			loff_t	i_size;
920 		} store;
921 		struct {
922 			struct iattr	*attr;
923 			loff_t		old_i_size;
924 		} setattr;
925 		struct afs_acl	*acl;
926 		struct yfs_acl	*yacl;
927 		struct {
928 			struct afs_volume_status vs;
929 			struct kstatfs		*buf;
930 		} volstatus;
931 	};
932 
933 	/* Fileserver iteration state */
934 	struct afs_server_list	*server_list;	/* Current server list (pins ref) */
935 	struct afs_server	*server;	/* Server we're using (ref pinned by server_list) */
936 	struct afs_endpoint_state *estate;	/* Current endpoint state (doesn't pin ref) */
937 	struct afs_server_state	*server_states;	/* States of the servers involved */
938 	struct afs_call		*call;
939 	unsigned long		untried_servers; /* Bitmask of untried servers */
940 	unsigned long		addr_tried;	/* Tried addresses */
941 	s32			call_abort_code; /* Abort code from single call */
942 	short			call_error;	/* Error from single call */
943 	short			server_index;	/* Current server */
944 	short			nr_iterations;	/* Number of server iterations */
945 	signed char		addr_index;	/* Current address */
946 	bool			call_responded;	/* T if the current address responded */
947 
948 	unsigned int		flags;
949 #define AFS_OPERATION_STOP		0x0001	/* Set to cease iteration */
950 #define AFS_OPERATION_VBUSY		0x0002	/* Set if seen VBUSY */
951 #define AFS_OPERATION_VMOVED		0x0004	/* Set if seen VMOVED */
952 #define AFS_OPERATION_VNOVOL		0x0008	/* Set if seen VNOVOL */
953 #define AFS_OPERATION_CUR_ONLY		0x0010	/* Set if current server only (file lock held) */
954 #define AFS_OPERATION_NO_VSLEEP		0x0020	/* Set to prevent sleep on VBUSY, VOFFLINE, ... */
955 #define AFS_OPERATION_UNINTR		0x0040	/* Set if op is uninterruptible */
956 #define AFS_OPERATION_DOWNGRADE		0x0080	/* Set to retry with downgraded opcode */
957 #define AFS_OPERATION_LOCK_0		0x0100	/* Set if have io_lock on file[0] */
958 #define AFS_OPERATION_LOCK_1		0x0200	/* Set if have io_lock on file[1] */
959 #define AFS_OPERATION_TRIED_ALL		0x0400	/* Set if we've tried all the fileservers */
960 #define AFS_OPERATION_RETRY_SERVER	0x0800	/* Set if we should retry the current server */
961 #define AFS_OPERATION_DIR_CONFLICT	0x1000	/* Set if we detected a 3rd-party dir change */
962 };
963 
964 /*
965  * Cache auxiliary data.
966  */
967 struct afs_vnode_cache_aux {
968 	__be64			data_version;
969 } __packed;
970 
afs_set_cache_aux(struct afs_vnode * vnode,struct afs_vnode_cache_aux * aux)971 static inline void afs_set_cache_aux(struct afs_vnode *vnode,
972 				     struct afs_vnode_cache_aux *aux)
973 {
974 	aux->data_version = cpu_to_be64(vnode->status.data_version);
975 }
976 
afs_invalidate_cache(struct afs_vnode * vnode,unsigned int flags)977 static inline void afs_invalidate_cache(struct afs_vnode *vnode, unsigned int flags)
978 {
979 	struct afs_vnode_cache_aux aux;
980 
981 	afs_set_cache_aux(vnode, &aux);
982 	fscache_invalidate(afs_vnode_cache(vnode), &aux,
983 			   i_size_read(&vnode->netfs.inode), flags);
984 }
985 
986 #include <trace/events/afs.h>
987 
988 /*****************************************************************************/
989 /*
990  * addr_list.c
991  */
992 struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist, enum afs_alist_trace reason);
993 extern struct afs_addr_list *afs_alloc_addrlist(unsigned int nr);
994 extern void afs_put_addrlist(struct afs_addr_list *alist, enum afs_alist_trace reason);
995 extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
996 						      const char *, size_t, char,
997 						      unsigned short, unsigned short);
998 bool afs_addr_list_same(const struct afs_addr_list *a,
999 			const struct afs_addr_list *b);
1000 extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
1001 
1002 extern int afs_merge_fs_addr4(struct afs_net *net, struct afs_addr_list *addr,
1003 			      __be32 xdr, u16 port);
1004 extern int afs_merge_fs_addr6(struct afs_net *net, struct afs_addr_list *addr,
1005 			      __be32 *xdr, u16 port);
1006 
1007 /*
1008  * addr_prefs.c
1009  */
1010 int afs_proc_addr_prefs_write(struct file *file, char *buf, size_t size);
1011 void afs_get_address_preferences_rcu(struct afs_net *net, struct afs_addr_list *alist);
1012 void afs_get_address_preferences(struct afs_net *net, struct afs_addr_list *alist);
1013 
1014 /*
1015  * callback.c
1016  */
1017 extern void afs_invalidate_mmap_work(struct work_struct *);
1018 extern void afs_init_callback_state(struct afs_server *);
1019 extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
1020 extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
1021 extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
1022 
afs_calc_vnode_cb_break(struct afs_vnode * vnode)1023 static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
1024 {
1025 	return vnode->cb_break + vnode->cb_ro_snapshot + vnode->cb_scrub;
1026 }
1027 
afs_cb_is_broken(unsigned int cb_break,const struct afs_vnode * vnode)1028 static inline bool afs_cb_is_broken(unsigned int cb_break,
1029 				    const struct afs_vnode *vnode)
1030 {
1031 	return cb_break != (vnode->cb_break +
1032 			    atomic_read(&vnode->volume->cb_ro_snapshot) +
1033 			    atomic_read(&vnode->volume->cb_scrub));
1034 }
1035 
1036 /*
1037  * cell.c
1038  */
1039 extern int afs_cell_init(struct afs_net *, const char *);
1040 extern struct afs_cell *afs_find_cell(struct afs_net *, const char *, unsigned,
1041 				      enum afs_cell_trace);
1042 extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
1043 					const char *, bool);
1044 extern struct afs_cell *afs_use_cell(struct afs_cell *, enum afs_cell_trace);
1045 extern void afs_unuse_cell(struct afs_net *, struct afs_cell *, enum afs_cell_trace);
1046 extern struct afs_cell *afs_get_cell(struct afs_cell *, enum afs_cell_trace);
1047 extern void afs_see_cell(struct afs_cell *, enum afs_cell_trace);
1048 extern void afs_put_cell(struct afs_cell *, enum afs_cell_trace);
1049 extern void afs_queue_cell(struct afs_cell *, enum afs_cell_trace);
1050 extern void afs_manage_cells(struct work_struct *);
1051 extern void afs_cells_timer(struct timer_list *);
1052 extern void __net_exit afs_cell_purge(struct afs_net *);
1053 
1054 /*
1055  * cmservice.c
1056  */
1057 extern bool afs_cm_incoming_call(struct afs_call *);
1058 
1059 /*
1060  * dir.c
1061  */
1062 extern const struct file_operations afs_dir_file_operations;
1063 extern const struct inode_operations afs_dir_inode_operations;
1064 extern const struct address_space_operations afs_dir_aops;
1065 extern const struct dentry_operations afs_fs_dentry_operations;
1066 
1067 extern void afs_d_release(struct dentry *);
1068 extern void afs_check_for_remote_deletion(struct afs_operation *);
1069 
1070 /*
1071  * dir_edit.c
1072  */
1073 extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
1074 			     enum afs_edit_dir_reason);
1075 extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
1076 void afs_edit_dir_update_dotdot(struct afs_vnode *vnode, struct afs_vnode *new_dvnode,
1077 				enum afs_edit_dir_reason why);
1078 
1079 /*
1080  * dir_silly.c
1081  */
1082 extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
1083 			   struct dentry *, struct key *);
1084 extern int afs_silly_iput(struct dentry *, struct inode *);
1085 
1086 /*
1087  * dynroot.c
1088  */
1089 extern const struct inode_operations afs_dynroot_inode_operations;
1090 extern const struct dentry_operations afs_dynroot_dentry_operations;
1091 
1092 extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
1093 extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
1094 extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
1095 extern int afs_dynroot_populate(struct super_block *);
1096 extern void afs_dynroot_depopulate(struct super_block *);
1097 
1098 /*
1099  * file.c
1100  */
1101 extern const struct address_space_operations afs_file_aops;
1102 extern const struct address_space_operations afs_symlink_aops;
1103 extern const struct inode_operations afs_file_inode_operations;
1104 extern const struct file_operations afs_file_operations;
1105 extern const struct netfs_request_ops afs_req_ops;
1106 
1107 extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
1108 extern void afs_put_wb_key(struct afs_wb_key *);
1109 extern int afs_open(struct inode *, struct file *);
1110 extern int afs_release(struct inode *, struct file *);
1111 extern int afs_fetch_data(struct afs_vnode *, struct afs_read *);
1112 extern struct afs_read *afs_alloc_read(gfp_t);
1113 extern void afs_put_read(struct afs_read *);
1114 
afs_get_read(struct afs_read * req)1115 static inline struct afs_read *afs_get_read(struct afs_read *req)
1116 {
1117 	refcount_inc(&req->usage);
1118 	return req;
1119 }
1120 
1121 /*
1122  * flock.c
1123  */
1124 extern struct workqueue_struct *afs_lock_manager;
1125 
1126 extern void afs_lock_op_done(struct afs_call *);
1127 extern void afs_lock_work(struct work_struct *);
1128 extern void afs_lock_may_be_available(struct afs_vnode *);
1129 extern int afs_lock(struct file *, int, struct file_lock *);
1130 extern int afs_flock(struct file *, int, struct file_lock *);
1131 
1132 /*
1133  * fsclient.c
1134  */
1135 extern void afs_fs_fetch_status(struct afs_operation *);
1136 extern void afs_fs_fetch_data(struct afs_operation *);
1137 extern void afs_fs_create_file(struct afs_operation *);
1138 extern void afs_fs_make_dir(struct afs_operation *);
1139 extern void afs_fs_remove_file(struct afs_operation *);
1140 extern void afs_fs_remove_dir(struct afs_operation *);
1141 extern void afs_fs_link(struct afs_operation *);
1142 extern void afs_fs_symlink(struct afs_operation *);
1143 extern void afs_fs_rename(struct afs_operation *);
1144 extern void afs_fs_store_data(struct afs_operation *);
1145 extern void afs_fs_setattr(struct afs_operation *);
1146 extern void afs_fs_get_volume_status(struct afs_operation *);
1147 extern void afs_fs_set_lock(struct afs_operation *);
1148 extern void afs_fs_extend_lock(struct afs_operation *);
1149 extern void afs_fs_release_lock(struct afs_operation *);
1150 int afs_fs_give_up_all_callbacks(struct afs_net *net, struct afs_server *server,
1151 				 struct afs_address *addr, struct key *key);
1152 bool afs_fs_get_capabilities(struct afs_net *net, struct afs_server *server,
1153 			     struct afs_endpoint_state *estate, unsigned int addr_index,
1154 			     struct key *key);
1155 extern void afs_fs_inline_bulk_status(struct afs_operation *);
1156 
1157 struct afs_acl {
1158 	u32	size;
1159 	u8	data[] __counted_by(size);
1160 };
1161 
1162 extern void afs_fs_fetch_acl(struct afs_operation *);
1163 extern void afs_fs_store_acl(struct afs_operation *);
1164 
1165 /*
1166  * fs_operation.c
1167  */
1168 extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1169 extern int afs_put_operation(struct afs_operation *);
1170 extern bool afs_begin_vnode_operation(struct afs_operation *);
1171 extern void afs_wait_for_operation(struct afs_operation *);
1172 extern int afs_do_sync_operation(struct afs_operation *);
1173 
afs_op_set_vnode(struct afs_operation * op,unsigned int n,struct afs_vnode * vnode)1174 static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1175 				    struct afs_vnode *vnode)
1176 {
1177 	op->file[n].vnode = vnode;
1178 	op->file[n].need_io_lock = true;
1179 }
1180 
afs_op_set_fid(struct afs_operation * op,unsigned int n,const struct afs_fid * fid)1181 static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1182 				  const struct afs_fid *fid)
1183 {
1184 	op->file[n].fid = *fid;
1185 }
1186 
1187 /*
1188  * fs_probe.c
1189  */
1190 struct afs_endpoint_state *afs_get_endpoint_state(struct afs_endpoint_state *estate,
1191 						  enum afs_estate_trace where);
1192 void afs_put_endpoint_state(struct afs_endpoint_state *estate, enum afs_estate_trace where);
1193 extern void afs_fileserver_probe_result(struct afs_call *);
1194 void afs_fs_probe_fileserver(struct afs_net *net, struct afs_server *server,
1195 			     struct afs_addr_list *new_addrs, struct key *key);
1196 int afs_wait_for_fs_probes(struct afs_operation *op, struct afs_server_state *states, bool intr);
1197 extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
1198 extern void afs_fs_probe_dispatcher(struct work_struct *);
1199 int afs_wait_for_one_fs_probe(struct afs_server *server, struct afs_endpoint_state *estate,
1200 			      unsigned long exclude, bool is_intr);
1201 extern void afs_fs_probe_cleanup(struct afs_net *);
1202 
1203 /*
1204  * inode.c
1205  */
1206 extern const struct afs_operation_ops afs_fetch_status_operation;
1207 
1208 extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
1209 extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1210 extern int afs_ilookup5_test_by_fid(struct inode *, void *);
1211 extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1212 extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1213 extern struct inode *afs_root_iget(struct super_block *, struct key *);
1214 extern int afs_getattr(struct mnt_idmap *idmap, const struct path *,
1215 		       struct kstat *, u32, unsigned int);
1216 extern int afs_setattr(struct mnt_idmap *idmap, struct dentry *, struct iattr *);
1217 extern void afs_evict_inode(struct inode *);
1218 extern int afs_drop_inode(struct inode *);
1219 
1220 /*
1221  * main.c
1222  */
1223 extern struct workqueue_struct *afs_wq;
1224 extern int afs_net_id;
1225 
afs_net(struct net * net)1226 static inline struct afs_net *afs_net(struct net *net)
1227 {
1228 	return net_generic(net, afs_net_id);
1229 }
1230 
afs_sb2net(struct super_block * sb)1231 static inline struct afs_net *afs_sb2net(struct super_block *sb)
1232 {
1233 	return afs_net(AFS_FS_S(sb)->net_ns);
1234 }
1235 
afs_d2net(struct dentry * dentry)1236 static inline struct afs_net *afs_d2net(struct dentry *dentry)
1237 {
1238 	return afs_sb2net(dentry->d_sb);
1239 }
1240 
afs_i2net(struct inode * inode)1241 static inline struct afs_net *afs_i2net(struct inode *inode)
1242 {
1243 	return afs_sb2net(inode->i_sb);
1244 }
1245 
afs_v2net(struct afs_vnode * vnode)1246 static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1247 {
1248 	return afs_i2net(&vnode->netfs.inode);
1249 }
1250 
afs_sock2net(struct sock * sk)1251 static inline struct afs_net *afs_sock2net(struct sock *sk)
1252 {
1253 	return net_generic(sock_net(sk), afs_net_id);
1254 }
1255 
__afs_stat(atomic_t * s)1256 static inline void __afs_stat(atomic_t *s)
1257 {
1258 	atomic_inc(s);
1259 }
1260 
1261 #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1262 
1263 /*
1264  * misc.c
1265  */
1266 extern int afs_abort_to_error(u32);
1267 extern void afs_prioritise_error(struct afs_error *, int, u32);
1268 
afs_op_nomem(struct afs_operation * op)1269 static inline void afs_op_nomem(struct afs_operation *op)
1270 {
1271 	op->cumul_error.error = -ENOMEM;
1272 }
1273 
afs_op_error(const struct afs_operation * op)1274 static inline int afs_op_error(const struct afs_operation *op)
1275 {
1276 	return op->cumul_error.error;
1277 }
1278 
afs_op_abort_code(const struct afs_operation * op)1279 static inline s32 afs_op_abort_code(const struct afs_operation *op)
1280 {
1281 	return op->cumul_error.abort_code;
1282 }
1283 
afs_op_set_error(struct afs_operation * op,int error)1284 static inline int afs_op_set_error(struct afs_operation *op, int error)
1285 {
1286 	return op->cumul_error.error = error;
1287 }
1288 
afs_op_accumulate_error(struct afs_operation * op,int error,s32 abort_code)1289 static inline void afs_op_accumulate_error(struct afs_operation *op, int error, s32 abort_code)
1290 {
1291 	afs_prioritise_error(&op->cumul_error, error, abort_code);
1292 }
1293 
1294 /*
1295  * mntpt.c
1296  */
1297 extern const struct inode_operations afs_mntpt_inode_operations;
1298 extern const struct inode_operations afs_autocell_inode_operations;
1299 extern const struct file_operations afs_mntpt_file_operations;
1300 
1301 extern struct vfsmount *afs_d_automount(struct path *);
1302 extern void afs_mntpt_kill_timer(void);
1303 
1304 /*
1305  * proc.c
1306  */
1307 #ifdef CONFIG_PROC_FS
1308 extern int __net_init afs_proc_init(struct afs_net *);
1309 extern void __net_exit afs_proc_cleanup(struct afs_net *);
1310 extern int afs_proc_cell_setup(struct afs_cell *);
1311 extern void afs_proc_cell_remove(struct afs_cell *);
1312 extern void afs_put_sysnames(struct afs_sysnames *);
1313 #else
afs_proc_init(struct afs_net * net)1314 static inline int afs_proc_init(struct afs_net *net) { return 0; }
afs_proc_cleanup(struct afs_net * net)1315 static inline void afs_proc_cleanup(struct afs_net *net) {}
afs_proc_cell_setup(struct afs_cell * cell)1316 static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
afs_proc_cell_remove(struct afs_cell * cell)1317 static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
afs_put_sysnames(struct afs_sysnames * sysnames)1318 static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1319 #endif
1320 
1321 /*
1322  * rotate.c
1323  */
1324 void afs_clear_server_states(struct afs_operation *op);
1325 extern bool afs_select_fileserver(struct afs_operation *);
1326 extern void afs_dump_edestaddrreq(const struct afs_operation *);
1327 
1328 /*
1329  * rxrpc.c
1330  */
1331 extern struct workqueue_struct *afs_async_calls;
1332 
1333 extern int __net_init afs_open_socket(struct afs_net *);
1334 extern void __net_exit afs_close_socket(struct afs_net *);
1335 extern void afs_charge_preallocation(struct work_struct *);
1336 extern void afs_put_call(struct afs_call *);
1337 void afs_deferred_put_call(struct afs_call *call);
1338 void afs_make_call(struct afs_call *call, gfp_t gfp);
1339 void afs_wait_for_call_to_complete(struct afs_call *call);
1340 extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1341 					    const struct afs_call_type *,
1342 					    size_t, size_t);
1343 extern void afs_flat_call_destructor(struct afs_call *);
1344 extern void afs_send_empty_reply(struct afs_call *);
1345 extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
1346 extern int afs_extract_data(struct afs_call *, bool);
1347 extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
1348 
afs_make_op_call(struct afs_operation * op,struct afs_call * call,gfp_t gfp)1349 static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1350 				    gfp_t gfp)
1351 {
1352 	struct afs_addr_list *alist = op->estate->addresses;
1353 
1354 	op->call	= call;
1355 	op->type	= call->type;
1356 	call->op	= op;
1357 	call->key	= op->key;
1358 	call->intr	= !(op->flags & AFS_OPERATION_UNINTR);
1359 	call->peer	= rxrpc_kernel_get_peer(alist->addrs[op->addr_index].peer);
1360 	call->service_id = op->server->service_id;
1361 	afs_make_call(call, gfp);
1362 }
1363 
afs_extract_begin(struct afs_call * call,void * buf,size_t size)1364 static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
1365 {
1366 	call->iov_len = size;
1367 	call->kvec[0].iov_base = buf;
1368 	call->kvec[0].iov_len = size;
1369 	iov_iter_kvec(&call->def_iter, ITER_DEST, call->kvec, 1, size);
1370 }
1371 
afs_extract_to_tmp(struct afs_call * call)1372 static inline void afs_extract_to_tmp(struct afs_call *call)
1373 {
1374 	call->iov_len = sizeof(call->tmp);
1375 	afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
1376 }
1377 
afs_extract_to_tmp64(struct afs_call * call)1378 static inline void afs_extract_to_tmp64(struct afs_call *call)
1379 {
1380 	call->iov_len = sizeof(call->tmp64);
1381 	afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
1382 }
1383 
afs_extract_discard(struct afs_call * call,size_t size)1384 static inline void afs_extract_discard(struct afs_call *call, size_t size)
1385 {
1386 	call->iov_len = size;
1387 	iov_iter_discard(&call->def_iter, ITER_DEST, size);
1388 }
1389 
afs_extract_to_buf(struct afs_call * call,size_t size)1390 static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
1391 {
1392 	call->iov_len = size;
1393 	afs_extract_begin(call, call->buffer, size);
1394 }
1395 
afs_transfer_reply(struct afs_call * call)1396 static inline int afs_transfer_reply(struct afs_call *call)
1397 {
1398 	return afs_extract_data(call, false);
1399 }
1400 
afs_check_call_state(struct afs_call * call,enum afs_call_state state)1401 static inline bool afs_check_call_state(struct afs_call *call,
1402 					enum afs_call_state state)
1403 {
1404 	return READ_ONCE(call->state) == state;
1405 }
1406 
afs_set_call_state(struct afs_call * call,enum afs_call_state from,enum afs_call_state to)1407 static inline bool afs_set_call_state(struct afs_call *call,
1408 				      enum afs_call_state from,
1409 				      enum afs_call_state to)
1410 {
1411 	bool ok = false;
1412 
1413 	spin_lock_bh(&call->state_lock);
1414 	if (call->state == from) {
1415 		call->state = to;
1416 		trace_afs_call_state(call, from, to, 0, 0);
1417 		ok = true;
1418 	}
1419 	spin_unlock_bh(&call->state_lock);
1420 	return ok;
1421 }
1422 
afs_set_call_complete(struct afs_call * call,int error,u32 remote_abort)1423 static inline void afs_set_call_complete(struct afs_call *call,
1424 					 int error, u32 remote_abort)
1425 {
1426 	enum afs_call_state state;
1427 	bool ok = false;
1428 
1429 	spin_lock_bh(&call->state_lock);
1430 	state = call->state;
1431 	if (state != AFS_CALL_COMPLETE) {
1432 		call->abort_code = remote_abort;
1433 		call->error = error;
1434 		call->state = AFS_CALL_COMPLETE;
1435 		trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
1436 				     error, remote_abort);
1437 		ok = true;
1438 	}
1439 	spin_unlock_bh(&call->state_lock);
1440 	if (ok) {
1441 		trace_afs_call_done(call);
1442 
1443 		/* Asynchronous calls have two refs to release - one from the alloc and
1444 		 * one queued with the work item - and we can't just deallocate the
1445 		 * call because the work item may be queued again.
1446 		 */
1447 		if (call->drop_ref)
1448 			afs_put_call(call);
1449 	}
1450 }
1451 
1452 /*
1453  * security.c
1454  */
1455 extern void afs_put_permits(struct afs_permits *);
1456 extern void afs_clear_permits(struct afs_vnode *);
1457 extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1458 			     struct afs_status_cb *);
1459 extern struct key *afs_request_key(struct afs_cell *);
1460 extern struct key *afs_request_key_rcu(struct afs_cell *);
1461 extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1462 extern int afs_permission(struct mnt_idmap *, struct inode *, int);
1463 extern void __exit afs_clean_up_permit_cache(void);
1464 
1465 /*
1466  * server.c
1467  */
1468 extern spinlock_t afs_server_peer_lock;
1469 
1470 extern struct afs_server *afs_find_server(struct afs_net *, const struct rxrpc_peer *);
1471 extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
1472 extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
1473 extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
1474 extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1475 extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1476 extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
1477 extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1478 extern void afs_manage_servers(struct work_struct *);
1479 extern void afs_servers_timer(struct timer_list *);
1480 extern void afs_fs_probe_timer(struct timer_list *);
1481 extern void __net_exit afs_purge_servers(struct afs_net *);
1482 bool afs_check_server_record(struct afs_operation *op, struct afs_server *server, struct key *key);
1483 
afs_inc_servers_outstanding(struct afs_net * net)1484 static inline void afs_inc_servers_outstanding(struct afs_net *net)
1485 {
1486 	atomic_inc(&net->servers_outstanding);
1487 }
1488 
afs_dec_servers_outstanding(struct afs_net * net)1489 static inline void afs_dec_servers_outstanding(struct afs_net *net)
1490 {
1491 	if (atomic_dec_and_test(&net->servers_outstanding))
1492 		wake_up_var(&net->servers_outstanding);
1493 }
1494 
afs_is_probing_server(struct afs_server * server)1495 static inline bool afs_is_probing_server(struct afs_server *server)
1496 {
1497 	return list_empty(&server->probe_link);
1498 }
1499 
1500 /*
1501  * server_list.c
1502  */
afs_get_serverlist(struct afs_server_list * slist)1503 static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1504 {
1505 	refcount_inc(&slist->usage);
1506 	return slist;
1507 }
1508 
1509 extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1510 struct afs_server_list *afs_alloc_server_list(struct afs_volume *volume,
1511 					      struct key *key,
1512 					      struct afs_vldb_entry *vldb);
1513 extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
1514 void afs_attach_volume_to_servers(struct afs_volume *volume, struct afs_server_list *slist);
1515 void afs_reattach_volume_to_servers(struct afs_volume *volume, struct afs_server_list *slist,
1516 				    struct afs_server_list *old);
1517 void afs_detach_volume_from_servers(struct afs_volume *volume, struct afs_server_list *slist);
1518 
1519 /*
1520  * super.c
1521  */
1522 extern int __init afs_fs_init(void);
1523 extern void afs_fs_exit(void);
1524 
1525 /*
1526  * validation.c
1527  */
1528 bool afs_check_validity(const struct afs_vnode *vnode);
1529 int afs_update_volume_state(struct afs_operation *op);
1530 int afs_validate(struct afs_vnode *vnode, struct key *key);
1531 
1532 /*
1533  * vlclient.c
1534  */
1535 extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
1536 							 const char *, int);
1537 extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
1538 struct afs_call *afs_vl_get_capabilities(struct afs_net *net,
1539 					 struct afs_addr_list *alist,
1540 					 unsigned int addr_index,
1541 					 struct key *key,
1542 					 struct afs_vlserver *server,
1543 					 unsigned int server_index);
1544 extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1545 extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
1546 
1547 /*
1548  * vl_alias.c
1549  */
1550 extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
1551 
1552 /*
1553  * vl_probe.c
1554  */
1555 extern void afs_vlserver_probe_result(struct afs_call *);
1556 extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
1557 extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
1558 
1559 /*
1560  * vl_rotate.c
1561  */
1562 extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
1563 					 struct afs_cell *, struct key *);
1564 extern bool afs_select_vlserver(struct afs_vl_cursor *);
1565 extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
1566 extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
1567 
1568 /*
1569  * vlserver_list.c
1570  */
afs_get_vlserver(struct afs_vlserver * vlserver)1571 static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
1572 {
1573 	refcount_inc(&vlserver->ref);
1574 	return vlserver;
1575 }
1576 
afs_get_vlserverlist(struct afs_vlserver_list * vllist)1577 static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
1578 {
1579 	if (vllist)
1580 		refcount_inc(&vllist->ref);
1581 	return vllist;
1582 }
1583 
1584 extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
1585 extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
1586 extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
1587 extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
1588 extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
1589 							   const void *, size_t);
1590 
1591 /*
1592  * volume.c
1593  */
1594 extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1595 extern int afs_activate_volume(struct afs_volume *);
1596 extern void afs_deactivate_volume(struct afs_volume *);
1597 bool afs_try_get_volume(struct afs_volume *volume, enum afs_volume_trace reason);
1598 extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1599 void afs_put_volume(struct afs_volume *volume, enum afs_volume_trace reason);
1600 extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
1601 
1602 /*
1603  * write.c
1604  */
1605 void afs_prepare_write(struct netfs_io_subrequest *subreq);
1606 void afs_issue_write(struct netfs_io_subrequest *subreq);
1607 void afs_begin_writeback(struct netfs_io_request *wreq);
1608 void afs_retry_request(struct netfs_io_request *wreq, struct netfs_io_stream *stream);
1609 extern int afs_writepages(struct address_space *, struct writeback_control *);
1610 extern int afs_fsync(struct file *, loff_t, loff_t, int);
1611 extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
1612 extern void afs_prune_wb_keys(struct afs_vnode *);
1613 
1614 /*
1615  * xattr.c
1616  */
1617 extern const struct xattr_handler * const afs_xattr_handlers[];
1618 
1619 /*
1620  * yfsclient.c
1621  */
1622 extern void yfs_fs_fetch_data(struct afs_operation *);
1623 extern void yfs_fs_create_file(struct afs_operation *);
1624 extern void yfs_fs_make_dir(struct afs_operation *);
1625 extern void yfs_fs_remove_file2(struct afs_operation *);
1626 extern void yfs_fs_remove_file(struct afs_operation *);
1627 extern void yfs_fs_remove_dir(struct afs_operation *);
1628 extern void yfs_fs_link(struct afs_operation *);
1629 extern void yfs_fs_symlink(struct afs_operation *);
1630 extern void yfs_fs_rename(struct afs_operation *);
1631 extern void yfs_fs_store_data(struct afs_operation *);
1632 extern void yfs_fs_setattr(struct afs_operation *);
1633 extern void yfs_fs_get_volume_status(struct afs_operation *);
1634 extern void yfs_fs_set_lock(struct afs_operation *);
1635 extern void yfs_fs_extend_lock(struct afs_operation *);
1636 extern void yfs_fs_release_lock(struct afs_operation *);
1637 extern void yfs_fs_fetch_status(struct afs_operation *);
1638 extern void yfs_fs_inline_bulk_status(struct afs_operation *);
1639 
1640 struct yfs_acl {
1641 	struct afs_acl	*acl;		/* Dir/file/symlink ACL */
1642 	struct afs_acl	*vol_acl;	/* Whole volume ACL */
1643 	u32		inherit_flag;	/* True if ACL is inherited from parent dir */
1644 	u32		num_cleaned;	/* Number of ACEs removed due to subject removal */
1645 	unsigned int	flags;
1646 #define YFS_ACL_WANT_ACL	0x01	/* Set if caller wants ->acl */
1647 #define YFS_ACL_WANT_VOL_ACL	0x02	/* Set if caller wants ->vol_acl */
1648 };
1649 
1650 extern void yfs_free_opaque_acl(struct yfs_acl *);
1651 extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1652 extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
1653 
1654 /*
1655  * Miscellaneous inline functions.
1656  */
AFS_FS_I(struct inode * inode)1657 static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1658 {
1659 	return container_of(inode, struct afs_vnode, netfs.inode);
1660 }
1661 
AFS_VNODE_TO_I(struct afs_vnode * vnode)1662 static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1663 {
1664 	return &vnode->netfs.inode;
1665 }
1666 
1667 /*
1668  * Note that a dentry got changed.  We need to set d_fsdata to the data version
1669  * number derived from the result of the operation.  It doesn't matter if
1670  * d_fsdata goes backwards as we'll just revalidate.
1671  */
afs_update_dentry_version(struct afs_operation * op,struct afs_vnode_param * dir_vp,struct dentry * dentry)1672 static inline void afs_update_dentry_version(struct afs_operation *op,
1673 					     struct afs_vnode_param *dir_vp,
1674 					     struct dentry *dentry)
1675 {
1676 	if (!op->cumul_error.error)
1677 		dentry->d_fsdata =
1678 			(void *)(unsigned long)dir_vp->scb.status.data_version;
1679 }
1680 
1681 /*
1682  * Set the file size and block count.  Estimate the number of 512 bytes blocks
1683  * used, rounded up to nearest 1K for consistency with other AFS clients.
1684  */
afs_set_i_size(struct afs_vnode * vnode,u64 size)1685 static inline void afs_set_i_size(struct afs_vnode *vnode, u64 size)
1686 {
1687 	i_size_write(&vnode->netfs.inode, size);
1688 	vnode->netfs.inode.i_blocks = ((size + 1023) >> 10) << 1;
1689 }
1690 
1691 /*
1692  * Check for a conflicting operation on a directory that we just unlinked from.
1693  * If someone managed to sneak a link or an unlink in on the file we just
1694  * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1695  */
afs_check_dir_conflict(struct afs_operation * op,struct afs_vnode_param * dvp)1696 static inline void afs_check_dir_conflict(struct afs_operation *op,
1697 					  struct afs_vnode_param *dvp)
1698 {
1699 	if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1700 		op->flags |= AFS_OPERATION_DIR_CONFLICT;
1701 }
1702 
afs_io_error(struct afs_call * call,enum afs_io_error where)1703 static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1704 {
1705 	trace_afs_io_error(call->debug_id, -EIO, where);
1706 	return -EIO;
1707 }
1708 
afs_bad(struct afs_vnode * vnode,enum afs_file_error where)1709 static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1710 {
1711 	trace_afs_file_error(vnode, -EIO, where);
1712 	return -EIO;
1713 }
1714 
1715 /*****************************************************************************/
1716 /*
1717  * debug tracing
1718  */
1719 extern unsigned afs_debug;
1720 
1721 #define dbgprintk(FMT,...) \
1722 	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
1723 
1724 #define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1725 #define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1726 #define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
1727 
1728 
1729 #if defined(__KDEBUG)
1730 #define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
1731 #define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
1732 #define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
1733 
1734 #elif defined(CONFIG_AFS_DEBUG)
1735 #define AFS_DEBUG_KENTER	0x01
1736 #define AFS_DEBUG_KLEAVE	0x02
1737 #define AFS_DEBUG_KDEBUG	0x04
1738 
1739 #define _enter(FMT,...)					\
1740 do {							\
1741 	if (unlikely(afs_debug & AFS_DEBUG_KENTER))	\
1742 		kenter(FMT,##__VA_ARGS__);		\
1743 } while (0)
1744 
1745 #define _leave(FMT,...)					\
1746 do {							\
1747 	if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))	\
1748 		kleave(FMT,##__VA_ARGS__);		\
1749 } while (0)
1750 
1751 #define _debug(FMT,...)					\
1752 do {							\
1753 	if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))	\
1754 		kdebug(FMT,##__VA_ARGS__);		\
1755 } while (0)
1756 
1757 #else
1758 #define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1759 #define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
1760 #define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
1761 #endif
1762 
1763 /*
1764  * debug assertion checking
1765  */
1766 #if 1 // defined(__KDEBUGALL)
1767 
1768 #define ASSERT(X)						\
1769 do {								\
1770 	if (unlikely(!(X))) {					\
1771 		printk(KERN_ERR "\n");				\
1772 		printk(KERN_ERR "AFS: Assertion failed\n");	\
1773 		BUG();						\
1774 	}							\
1775 } while(0)
1776 
1777 #define ASSERTCMP(X, OP, Y)						\
1778 do {									\
1779 	if (unlikely(!((X) OP (Y)))) {					\
1780 		printk(KERN_ERR "\n");					\
1781 		printk(KERN_ERR "AFS: Assertion failed\n");		\
1782 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
1783 		       (unsigned long)(X), (unsigned long)(Y));		\
1784 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
1785 		       (unsigned long)(X), (unsigned long)(Y));		\
1786 		BUG();							\
1787 	}								\
1788 } while(0)
1789 
1790 #define ASSERTRANGE(L, OP1, N, OP2, H)					\
1791 do {									\
1792 	if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {		\
1793 		printk(KERN_ERR "\n");					\
1794 		printk(KERN_ERR "AFS: Assertion failed\n");		\
1795 		printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n",	\
1796 		       (unsigned long)(L), (unsigned long)(N),		\
1797 		       (unsigned long)(H));				\
1798 		printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1799 		       (unsigned long)(L), (unsigned long)(N),		\
1800 		       (unsigned long)(H));				\
1801 		BUG();							\
1802 	}								\
1803 } while(0)
1804 
1805 #define ASSERTIF(C, X)						\
1806 do {								\
1807 	if (unlikely((C) && !(X))) {				\
1808 		printk(KERN_ERR "\n");				\
1809 		printk(KERN_ERR "AFS: Assertion failed\n");	\
1810 		BUG();						\
1811 	}							\
1812 } while(0)
1813 
1814 #define ASSERTIFCMP(C, X, OP, Y)					\
1815 do {									\
1816 	if (unlikely((C) && !((X) OP (Y)))) {				\
1817 		printk(KERN_ERR "\n");					\
1818 		printk(KERN_ERR "AFS: Assertion failed\n");		\
1819 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
1820 		       (unsigned long)(X), (unsigned long)(Y));		\
1821 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
1822 		       (unsigned long)(X), (unsigned long)(Y));		\
1823 		BUG();							\
1824 	}								\
1825 } while(0)
1826 
1827 #else
1828 
1829 #define ASSERT(X)				\
1830 do {						\
1831 } while(0)
1832 
1833 #define ASSERTCMP(X, OP, Y)			\
1834 do {						\
1835 } while(0)
1836 
1837 #define ASSERTRANGE(L, OP1, N, OP2, H)		\
1838 do {						\
1839 } while(0)
1840 
1841 #define ASSERTIF(C, X)				\
1842 do {						\
1843 } while(0)
1844 
1845 #define ASSERTIFCMP(C, X, OP, Y)		\
1846 do {						\
1847 } while(0)
1848 
1849 #endif /* __KDEBUGALL */
1850