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