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