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