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