xref: /openbmc/linux/fs/afs/internal.h (revision a42442dd)
12874c5fdSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
2ec26815aSDavid Howells /* internal AFS stuff
31da177e4SLinus Torvalds  *
408e0e7c8SDavid Howells  * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
51da177e4SLinus Torvalds  * Written by David Howells (dhowells@redhat.com)
61da177e4SLinus Torvalds  */
71da177e4SLinus Torvalds 
81da177e4SLinus Torvalds #include <linux/compiler.h>
91da177e4SLinus Torvalds #include <linux/kernel.h>
108a79790bSTina Ruchandani #include <linux/ktime.h>
111da177e4SLinus Torvalds #include <linux/fs.h>
121da177e4SLinus Torvalds #include <linux/pagemap.h>
1308e0e7c8SDavid Howells #include <linux/rxrpc.h>
1400d3b7a4SDavid Howells #include <linux/key.h>
15e8edc6e0SAlexey Dobriyan #include <linux/workqueue.h>
1600c541eaSAndrew Morton #include <linux/sched.h>
1780e50be4SChristoph Hellwig #include <linux/fscache.h>
18e1da0222SJens Axboe #include <linux/backing-dev.h>
19ff548773SDavid Howells #include <linux/uuid.h>
200722f186SSouptick Joarder #include <linux/mm_types.h>
210a5143f2SDavid Howells #include <linux/dns_resolver.h>
22f044c884SDavid Howells #include <net/net_namespace.h>
235b86d4ffSDavid Howells #include <net/netns/generic.h>
245b86d4ffSDavid Howells #include <net/sock.h>
258324f0bcSDavid Howells #include <net/af_rxrpc.h>
2600c541eaSAndrew Morton 
2708e0e7c8SDavid Howells #include "afs.h"
2808e0e7c8SDavid Howells #include "afs_vl.h"
2908e0e7c8SDavid Howells 
3008e0e7c8SDavid Howells #define AFS_CELL_MAX_ADDRS 15
3108e0e7c8SDavid Howells 
3231143d5dSDavid Howells struct pagevec;
3308e0e7c8SDavid Howells struct afs_call;
34c4508464SDavid Howells struct afs_vnode;
3508e0e7c8SDavid Howells 
366c6c1d63SDavid Howells /*
376c6c1d63SDavid Howells  * Partial file-locking emulation mode.  (The problem being that AFS3 only
386c6c1d63SDavid Howells  * allows whole-file locks and no upgrading/downgrading).
396c6c1d63SDavid Howells  */
406c6c1d63SDavid Howells enum afs_flock_mode {
416c6c1d63SDavid Howells 	afs_flock_mode_unset,
426c6c1d63SDavid Howells 	afs_flock_mode_local,	/* Local locking only */
436c6c1d63SDavid Howells 	afs_flock_mode_openafs,	/* Don't get server lock for a partial lock */
446c6c1d63SDavid Howells 	afs_flock_mode_strict,	/* Always get a server lock for a partial lock */
456c6c1d63SDavid Howells 	afs_flock_mode_write,	/* Get an exclusive server lock for a partial lock */
466c6c1d63SDavid Howells };
476c6c1d63SDavid Howells 
4813fcc683SDavid Howells struct afs_fs_context {
4900d3b7a4SDavid Howells 	bool			force;		/* T to force cell type */
50bec5eb61Swanglei 	bool			autocell;	/* T if set auto mount operation */
514d673da1SDavid Howells 	bool			dyn_root;	/* T if dynamic root */
5213fcc683SDavid Howells 	bool			no_cell;	/* T if the source is "none" (for dynroot) */
536c6c1d63SDavid Howells 	enum afs_flock_mode	flock_mode;	/* Partial file-locking emulation mode */
5400d3b7a4SDavid Howells 	afs_voltype_t		type;		/* type of volume requested */
5513fcc683SDavid Howells 	unsigned int		volnamesz;	/* size of volume name */
5600d3b7a4SDavid Howells 	const char		*volname;	/* name of volume to mount */
575b86d4ffSDavid Howells 	struct afs_net		*net;		/* the AFS net namespace stuff */
5800d3b7a4SDavid Howells 	struct afs_cell		*cell;		/* cell in which to find volume */
5900d3b7a4SDavid Howells 	struct afs_volume	*volume;	/* volume record */
6000d3b7a4SDavid Howells 	struct key		*key;		/* key to use for secure mounting */
6100d3b7a4SDavid Howells };
6200d3b7a4SDavid Howells 
638e8d7f13SDavid Howells enum afs_call_state {
6498bf40cdSDavid Howells 	AFS_CALL_CL_REQUESTING,		/* Client: Request is being sent */
6598bf40cdSDavid Howells 	AFS_CALL_CL_AWAIT_REPLY,	/* Client: Awaiting reply */
6698bf40cdSDavid Howells 	AFS_CALL_CL_PROC_REPLY,		/* Client: rxrpc call complete; processing reply */
6798bf40cdSDavid Howells 	AFS_CALL_SV_AWAIT_OP_ID,	/* Server: Awaiting op ID */
6898bf40cdSDavid Howells 	AFS_CALL_SV_AWAIT_REQUEST,	/* Server: Awaiting request data */
6998bf40cdSDavid Howells 	AFS_CALL_SV_REPLYING,		/* Server: Replying */
7098bf40cdSDavid Howells 	AFS_CALL_SV_AWAIT_ACK,		/* Server: Awaiting final ACK */
718e8d7f13SDavid Howells 	AFS_CALL_COMPLETE,		/* Completed or failed */
728e8d7f13SDavid Howells };
73f044c884SDavid Howells 
7408e0e7c8SDavid Howells /*
758b2a464cSDavid Howells  * List of server addresses.
768b2a464cSDavid Howells  */
778b2a464cSDavid Howells struct afs_addr_list {
78ddd2b85fSJann Horn 	struct rcu_head		rcu;
798b2a464cSDavid Howells 	refcount_t		usage;
80d2ddc776SDavid Howells 	u32			version;	/* Version */
8168eb64c3SDavid Howells 	unsigned char		max_addrs;
8268eb64c3SDavid Howells 	unsigned char		nr_addrs;
833bf0fb6fSDavid Howells 	unsigned char		preferred;	/* Preferred address */
8468eb64c3SDavid Howells 	unsigned char		nr_ipv4;	/* Number of IPv4 addresses */
850a5143f2SDavid Howells 	enum dns_record_source	source:8;
860a5143f2SDavid Howells 	enum dns_lookup_status	status:8;
873bf0fb6fSDavid Howells 	unsigned long		failed;		/* Mask of addrs that failed locally/ICMP */
883bf0fb6fSDavid Howells 	unsigned long		responded;	/* Mask of addrs that responded */
898b2a464cSDavid Howells 	struct sockaddr_rxrpc	addrs[];
9068eb64c3SDavid Howells #define AFS_MAX_ADDRESSES ((unsigned int)(sizeof(unsigned long) * 8))
918b2a464cSDavid Howells };
928b2a464cSDavid Howells 
938b2a464cSDavid Howells /*
9408e0e7c8SDavid Howells  * a record of an in-progress RxRPC call
9508e0e7c8SDavid Howells  */
9608e0e7c8SDavid Howells struct afs_call {
9708e0e7c8SDavid Howells 	const struct afs_call_type *type;	/* type of call */
983bf0fb6fSDavid Howells 	struct afs_addr_list	*alist;		/* Address is alist[addr_ix] */
9908e0e7c8SDavid Howells 	wait_queue_head_t	waitq;		/* processes awaiting completion */
100341f741fSDavid Howells 	struct work_struct	async_work;	/* async I/O processor */
10108e0e7c8SDavid Howells 	struct work_struct	work;		/* actual work processor */
10208e0e7c8SDavid Howells 	struct rxrpc_call	*rxcall;	/* RxRPC call handle */
10308e0e7c8SDavid Howells 	struct key		*key;		/* security for this call */
104f044c884SDavid Howells 	struct afs_net		*net;		/* The network namespace */
105a6853b9cSDavid Howells 	struct afs_server	*server;	/* The fileserver record if fs op (pins ref) */
106a6853b9cSDavid Howells 	struct afs_vlserver	*vlserver;	/* The vlserver record if vl op */
10708e0e7c8SDavid Howells 	void			*request;	/* request data (first part) */
108f105da1aSDavid Howells 	size_t			iov_len;	/* Size of *iter to be used */
109fc276122SDavid Howells 	struct iov_iter		def_iter;	/* Default buffer/data iterator */
110bd80d8a8SDavid Howells 	struct iov_iter		*write_iter;	/* Iterator defining write to be made */
111fc276122SDavid Howells 	struct iov_iter		*iter;		/* Iterator currently in use */
112fc276122SDavid Howells 	union {	/* Convenience for ->def_iter */
11312bdcf33SDavid Howells 		struct kvec	kvec[1];
11412bdcf33SDavid Howells 		struct bio_vec	bvec[1];
11512bdcf33SDavid Howells 	};
11608e0e7c8SDavid Howells 	void			*buffer;	/* reply receive buffer */
117ffba718eSDavid Howells 	union {
118ffba718eSDavid Howells 		long			ret0;	/* Value to reply with instead of 0 */
119ffba718eSDavid Howells 		struct afs_addr_list	*ret_alist;
120ffba718eSDavid Howells 		struct afs_vldb_entry	*ret_vldb;
121c3e9f888SDavid Howells 		char			*ret_str;
122ffba718eSDavid Howells 	};
123e49c7b2fSDavid Howells 	struct afs_operation	*op;
124ffba718eSDavid Howells 	unsigned int		server_index;
125341f741fSDavid Howells 	atomic_t		usage;
1268e8d7f13SDavid Howells 	enum afs_call_state	state;
12798bf40cdSDavid Howells 	spinlock_t		state_lock;
12808e0e7c8SDavid Howells 	int			error;		/* error code */
129d001648eSDavid Howells 	u32			abort_code;	/* Remote abort ID or 0 */
13094f699c9SDavid Howells 	unsigned int		max_lifespan;	/* Maximum lifespan to set if not 0 */
13108e0e7c8SDavid Howells 	unsigned		request_size;	/* size of request data */
13208e0e7c8SDavid Howells 	unsigned		reply_max;	/* maximum size of reply */
133bcd89270SMarc Dionne 	unsigned		count2;		/* count used in unmarshalling */
13408e0e7c8SDavid Howells 	unsigned char		unmarshall;	/* unmarshalling phase */
1353bf0fb6fSDavid Howells 	unsigned char		addr_ix;	/* Address in ->alist */
136dde9f095SDavid Howells 	bool			drop_ref;	/* T if need to drop ref for incoming call */
137d001648eSDavid Howells 	bool			need_attention;	/* T if RxRPC poked us */
13856ff9c83SDavid Howells 	bool			async;		/* T if asynchronous */
139a68f4a27SDavid Howells 	bool			upgrade;	/* T to request service upgrade */
1404571577fSDavid Howells 	bool			have_reply_time; /* T if have got reply_time */
14120b8391fSDavid Howells 	bool			intr;		/* T if interruptible */
14238355eecSDavid Howells 	bool			unmarshalling_error; /* T if an unmarshalling error occurred */
143bf99a53cSDavid Howells 	u16			service_id;	/* Actual service ID (after upgrade) */
144a25e21f0SDavid Howells 	unsigned int		debug_id;	/* Trace ID */
14550a2c953SDavid Howells 	u32			operation_ID;	/* operation ID for an incoming call */
14608e0e7c8SDavid Howells 	u32			count;		/* count for use in unmarshalling */
14712bdcf33SDavid Howells 	union {					/* place to extract temporary data */
14812bdcf33SDavid Howells 		struct {
14912bdcf33SDavid Howells 			__be32	tmp_u;
15012bdcf33SDavid Howells 			__be32	tmp;
15112bdcf33SDavid Howells 		} __attribute__((packed));
15212bdcf33SDavid Howells 		__be64		tmp64;
15312bdcf33SDavid Howells 	};
15412d8e95aSDavid Howells 	ktime_t			reply_time;	/* Time of first reply packet */
15508e0e7c8SDavid Howells };
15608e0e7c8SDavid Howells 
15708e0e7c8SDavid Howells struct afs_call_type {
15800d3b7a4SDavid Howells 	const char *name;
159025db80cSDavid Howells 	unsigned int op; /* Really enum afs_fs_operation */
16000d3b7a4SDavid Howells 
16108e0e7c8SDavid Howells 	/* deliver request or reply data to an call
16208e0e7c8SDavid Howells 	 * - returning an error will cause the call to be aborted
16308e0e7c8SDavid Howells 	 */
164d001648eSDavid Howells 	int (*deliver)(struct afs_call *call);
16508e0e7c8SDavid Howells 
16608e0e7c8SDavid Howells 	/* clean up a call */
16708e0e7c8SDavid Howells 	void (*destructor)(struct afs_call *call);
168341f741fSDavid Howells 
169341f741fSDavid Howells 	/* Work function */
170341f741fSDavid Howells 	void (*work)(struct work_struct *work);
1713bf0fb6fSDavid Howells 
1723bf0fb6fSDavid Howells 	/* Call done function (gets called immediately on success or failure) */
1733bf0fb6fSDavid Howells 	void (*done)(struct afs_call *call);
17408e0e7c8SDavid Howells };
17508e0e7c8SDavid Howells 
17608e0e7c8SDavid Howells /*
1774343d008SDavid Howells  * Key available for writeback on a file.
1784343d008SDavid Howells  */
1794343d008SDavid Howells struct afs_wb_key {
1804343d008SDavid Howells 	refcount_t		usage;
1814343d008SDavid Howells 	struct key		*key;
1824343d008SDavid Howells 	struct list_head	vnode_link;	/* Link in vnode->wb_keys */
1834343d008SDavid Howells };
1844343d008SDavid Howells 
1854343d008SDavid Howells /*
186215804a9SDavid Howells  * AFS open file information record.  Pointed to by file->private_data.
187215804a9SDavid Howells  */
188215804a9SDavid Howells struct afs_file {
189215804a9SDavid Howells 	struct key		*key;		/* The key this file was opened with */
1904343d008SDavid Howells 	struct afs_wb_key	*wb;		/* Writeback key record for this file */
191215804a9SDavid Howells };
192215804a9SDavid Howells 
193215804a9SDavid Howells static inline struct key *afs_file_key(struct file *file)
194215804a9SDavid Howells {
195215804a9SDavid Howells 	struct afs_file *af = file->private_data;
196215804a9SDavid Howells 
197215804a9SDavid Howells 	return af->key;
198215804a9SDavid Howells }
199215804a9SDavid Howells 
200215804a9SDavid Howells /*
201196ee9cdSDavid Howells  * Record of an outstanding read operation on a vnode.
202196ee9cdSDavid Howells  */
203196ee9cdSDavid Howells struct afs_read {
204196ee9cdSDavid Howells 	loff_t			pos;		/* Where to start reading */
205e8e581a8SDavid Howells 	loff_t			len;		/* How much we're asking for */
206196ee9cdSDavid Howells 	loff_t			actual_len;	/* How much we're actually getting */
207f3ddee8dSDavid Howells 	loff_t			file_size;	/* File size returned by server */
208c69bf479SDavid Howells 	struct key		*key;		/* The key to use to reissue the read */
209c4508464SDavid Howells 	struct afs_vnode	*vnode;		/* The file being read into. */
2105cbf0398SDavid Howells 	struct netfs_read_subrequest *subreq;	/* Fscache helper read request this belongs to */
211f3ddee8dSDavid Howells 	afs_dataversion_t	data_version;	/* Version number returned by server */
212f3ddee8dSDavid Howells 	refcount_t		usage;
213c4508464SDavid Howells 	unsigned int		call_debug_id;
214196ee9cdSDavid Howells 	unsigned int		nr_pages;
215c4508464SDavid Howells 	int			error;
216c4508464SDavid Howells 	void (*done)(struct afs_read *);
217c4508464SDavid Howells 	void (*cleanup)(struct afs_read *);
218c4508464SDavid Howells 	struct iov_iter		*iter;		/* Iterator representing the buffer */
219c4508464SDavid Howells 	struct iov_iter		def_iter;	/* Default iterator */
220196ee9cdSDavid Howells };
221196ee9cdSDavid Howells 
222196ee9cdSDavid Howells /*
22308e0e7c8SDavid Howells  * AFS superblock private data
22408e0e7c8SDavid Howells  * - there's one superblock per volume
22508e0e7c8SDavid Howells  */
22608e0e7c8SDavid Howells struct afs_super_info {
2275b86d4ffSDavid Howells 	struct net		*net_ns;	/* Network namespace */
22849566f6fSDavid Howells 	struct afs_cell		*cell;		/* The cell in which the volume resides */
22908e0e7c8SDavid Howells 	struct afs_volume	*volume;	/* volume record */
2306c6c1d63SDavid Howells 	enum afs_flock_mode	flock_mode:8;	/* File locking emulation mode */
2314d673da1SDavid Howells 	bool			dyn_root;	/* True if dynamic root */
23208e0e7c8SDavid Howells };
23308e0e7c8SDavid Howells 
23408e0e7c8SDavid Howells static inline struct afs_super_info *AFS_FS_S(struct super_block *sb)
23508e0e7c8SDavid Howells {
23608e0e7c8SDavid Howells 	return sb->s_fs_info;
23708e0e7c8SDavid Howells }
23808e0e7c8SDavid Howells 
23908e0e7c8SDavid Howells extern struct file_system_type afs_fs_type;
24008e0e7c8SDavid Howells 
24108e0e7c8SDavid Howells /*
2426f8880d8SDavid Howells  * Set of substitutes for @sys.
2436f8880d8SDavid Howells  */
2446f8880d8SDavid Howells struct afs_sysnames {
2456f8880d8SDavid Howells #define AFS_NR_SYSNAME 16
2466f8880d8SDavid Howells 	char			*subs[AFS_NR_SYSNAME];
2476f8880d8SDavid Howells 	refcount_t		usage;
2486f8880d8SDavid Howells 	unsigned short		nr;
2496f8880d8SDavid Howells 	char			blank[1];
2506f8880d8SDavid Howells };
2516f8880d8SDavid Howells 
2526f8880d8SDavid Howells /*
253f044c884SDavid Howells  * AFS network namespace record.
254f044c884SDavid Howells  */
255f044c884SDavid Howells struct afs_net {
2565b86d4ffSDavid Howells 	struct net		*net;		/* Backpointer to the owning net namespace */
257f044c884SDavid Howells 	struct afs_uuid		uuid;
258f044c884SDavid Howells 	bool			live;		/* F if this namespace is being removed */
259f044c884SDavid Howells 
260f044c884SDavid Howells 	/* AF_RXRPC I/O stuff */
261f044c884SDavid Howells 	struct socket		*socket;
262f044c884SDavid Howells 	struct afs_call		*spare_incoming_call;
263f044c884SDavid Howells 	struct work_struct	charge_preallocation_work;
264f044c884SDavid Howells 	struct mutex		socket_mutex;
265f044c884SDavid Howells 	atomic_t		nr_outstanding_calls;
266f044c884SDavid Howells 	atomic_t		nr_superblocks;
267f044c884SDavid Howells 
268f044c884SDavid Howells 	/* Cell database */
269989782dcSDavid Howells 	struct rb_root		cells;
27092e3cc91SDavid Howells 	struct afs_cell		*ws_cell;
271989782dcSDavid Howells 	struct work_struct	cells_manager;
272989782dcSDavid Howells 	struct timer_list	cells_timer;
273989782dcSDavid Howells 	atomic_t		cells_outstanding;
27492e3cc91SDavid Howells 	struct rw_semaphore	cells_lock;
2758a070a96SDavid Howells 	struct mutex		cells_alias_lock;
276f044c884SDavid Howells 
2770da0b7fdSDavid Howells 	struct mutex		proc_cells_lock;
2786b3944e4SDavid Howells 	struct hlist_head	proc_cells;
279f044c884SDavid Howells 
280d2ddc776SDavid Howells 	/* Known servers.  Theoretically each fileserver can only be in one
281d2ddc776SDavid Howells 	 * cell, but in practice, people create aliases and subsets and there's
282d2ddc776SDavid Howells 	 * no easy way to distinguish them.
283d2ddc776SDavid Howells 	 */
284f6cbb368SDavid Howells 	seqlock_t		fs_lock;	/* For fs_servers, fs_probe_*, fs_proc */
285d2ddc776SDavid Howells 	struct rb_root		fs_servers;	/* afs_server (by server UUID or address) */
286f6cbb368SDavid Howells 	struct list_head	fs_probe_fast;	/* List of afs_server to probe at 30s intervals */
287f6cbb368SDavid Howells 	struct list_head	fs_probe_slow;	/* List of afs_server to probe at 5m intervals */
288d2ddc776SDavid Howells 	struct hlist_head	fs_proc;	/* procfs servers list */
289d2ddc776SDavid Howells 
290d2ddc776SDavid Howells 	struct hlist_head	fs_addresses4;	/* afs_server (by lowest IPv4 addr) */
291d2ddc776SDavid Howells 	struct hlist_head	fs_addresses6;	/* afs_server (by lowest IPv6 addr) */
292d2ddc776SDavid Howells 	seqlock_t		fs_addr_lock;	/* For fs_addresses[46] */
293d2ddc776SDavid Howells 
294d2ddc776SDavid Howells 	struct work_struct	fs_manager;
295d2ddc776SDavid Howells 	struct timer_list	fs_timer;
296f6cbb368SDavid Howells 
297f6cbb368SDavid Howells 	struct work_struct	fs_prober;
298f6cbb368SDavid Howells 	struct timer_list	fs_probe_timer;
299d2ddc776SDavid Howells 	atomic_t		servers_outstanding;
300f044c884SDavid Howells 
301f044c884SDavid Howells 	/* File locking renewal management */
302f044c884SDavid Howells 	struct mutex		lock_manager_mutex;
303f044c884SDavid Howells 
304f044c884SDavid Howells 	/* Misc */
3050da0b7fdSDavid Howells 	struct super_block	*dynroot_sb;	/* Dynamic root mount superblock */
306f044c884SDavid Howells 	struct proc_dir_entry	*proc_afs;	/* /proc/net/afs directory */
3076f8880d8SDavid Howells 	struct afs_sysnames	*sysnames;
3086f8880d8SDavid Howells 	rwlock_t		sysnames_lock;
309d55b4da4SDavid Howells 
310d55b4da4SDavid Howells 	/* Statistics counters */
311d55b4da4SDavid Howells 	atomic_t		n_lookup;	/* Number of lookups done */
312d55b4da4SDavid Howells 	atomic_t		n_reval;	/* Number of dentries needing revalidation */
313d55b4da4SDavid Howells 	atomic_t		n_inval;	/* Number of invalidations by the server */
314f3ddee8dSDavid Howells 	atomic_t		n_relpg;	/* Number of invalidations by releasepage */
315d55b4da4SDavid Howells 	atomic_t		n_read_dir;	/* Number of directory pages read */
31663a4681fSDavid Howells 	atomic_t		n_dir_cr;	/* Number of directory entry creation edits */
31763a4681fSDavid Howells 	atomic_t		n_dir_rm;	/* Number of directory entry removal edits */
31876a5cb6fSDavid Howells 	atomic_t		n_stores;	/* Number of store ops */
31976a5cb6fSDavid Howells 	atomic_long_t		n_store_bytes;	/* Number of bytes stored */
32076a5cb6fSDavid Howells 	atomic_long_t		n_fetch_bytes;	/* Number of bytes fetched */
32176a5cb6fSDavid Howells 	atomic_t		n_fetches;	/* Number of data fetch ops */
322f044c884SDavid Howells };
323f044c884SDavid Howells 
3246f8880d8SDavid Howells extern const char afs_init_sysname[];
325f044c884SDavid Howells 
326989782dcSDavid Howells enum afs_cell_state {
327989782dcSDavid Howells 	AFS_CELL_UNSET,
328989782dcSDavid Howells 	AFS_CELL_ACTIVATING,
329989782dcSDavid Howells 	AFS_CELL_ACTIVE,
330989782dcSDavid Howells 	AFS_CELL_DEACTIVATING,
331989782dcSDavid Howells 	AFS_CELL_INACTIVE,
332989782dcSDavid Howells 	AFS_CELL_FAILED,
3331d0e850aSDavid Howells 	AFS_CELL_REMOVED,
334989782dcSDavid Howells };
335989782dcSDavid Howells 
336f044c884SDavid Howells /*
337d2ddc776SDavid Howells  * AFS cell record.
338d2ddc776SDavid Howells  *
339d2ddc776SDavid Howells  * This is a tricky concept to get right as it is possible to create aliases
340d2ddc776SDavid Howells  * simply by pointing AFSDB/SRV records for two names at the same set of VL
341d2ddc776SDavid Howells  * servers; it is also possible to do things like setting up two sets of VL
342d2ddc776SDavid Howells  * servers, one of which provides a superset of the volumes provided by the
343d2ddc776SDavid Howells  * other (for internal/external division, for example).
344d2ddc776SDavid Howells  *
345d2ddc776SDavid Howells  * Cells only exist in the sense that (a) a cell's name maps to a set of VL
346d2ddc776SDavid Howells  * servers and (b) a cell's name is used by the client to select the key to use
347d2ddc776SDavid Howells  * for authentication and encryption.  The cell name is not typically used in
348d2ddc776SDavid Howells  * the protocol.
349d2ddc776SDavid Howells  *
3508a070a96SDavid Howells  * Two cells are determined to be aliases if they have an explicit alias (YFS
3518a070a96SDavid Howells  * only), share any VL servers in common or have at least one volume in common.
3528a070a96SDavid Howells  * "In common" means that the address list of the VL servers or the fileservers
3538a070a96SDavid Howells  * share at least one endpoint.
35408e0e7c8SDavid Howells  */
35508e0e7c8SDavid Howells struct afs_cell {
356989782dcSDavid Howells 	union {
357989782dcSDavid Howells 		struct rcu_head	rcu;
358989782dcSDavid Howells 		struct rb_node	net_node;	/* Node in net->cells */
359989782dcSDavid Howells 	};
360989782dcSDavid Howells 	struct afs_net		*net;
3618a070a96SDavid Howells 	struct afs_cell		*alias_of;	/* The cell this is an alias of */
3628a070a96SDavid Howells 	struct afs_volume	*root_volume;	/* The root.cell volume if there is one */
36300d3b7a4SDavid Howells 	struct key		*anonymous_key;	/* anonymous user key for this cell */
364989782dcSDavid Howells 	struct work_struct	manager;	/* Manager for init/deinit/dns */
3656b3944e4SDavid Howells 	struct hlist_node	proc_link;	/* /proc cell list link */
366989782dcSDavid Howells 	time64_t		dns_expiry;	/* Time AFSDB/SRV record expires */
367989782dcSDavid Howells 	time64_t		last_inactive;	/* Time of last drop of usage count */
36888c853c3SDavid Howells 	atomic_t		ref;		/* Struct refcount */
36988c853c3SDavid Howells 	atomic_t		active;		/* Active usage counter */
370989782dcSDavid Howells 	unsigned long		flags;
371d5c32c89SDavid Howells #define AFS_CELL_FL_NO_GC	0		/* The cell was added manually, don't auto-gc */
372d5c32c89SDavid Howells #define AFS_CELL_FL_DO_LOOKUP	1		/* DNS lookup requested */
3738a070a96SDavid Howells #define AFS_CELL_FL_CHECK_ALIAS	2		/* Need to check for aliases */
374989782dcSDavid Howells 	enum afs_cell_state	state;
375989782dcSDavid Howells 	short			error;
376d5c32c89SDavid Howells 	enum dns_record_source	dns_source:8;	/* Latest source of data from lookup */
377d5c32c89SDavid Howells 	enum dns_lookup_status	dns_status:8;	/* Latest status of data from lookup */
378d5c32c89SDavid Howells 	unsigned int		dns_lookup_count; /* Counter of DNS lookups */
379dca54a7bSDavid Howells 	unsigned int		debug_id;
380989782dcSDavid Howells 
38120325960SDavid Howells 	/* The volumes belonging to this cell */
38220325960SDavid Howells 	struct rb_root		volumes;	/* Tree of volumes on this server */
38320325960SDavid Howells 	struct hlist_head	proc_volumes;	/* procfs volume list */
38420325960SDavid Howells 	seqlock_t		volume_lock;	/* For volumes */
38520325960SDavid Howells 
386d2ddc776SDavid Howells 	/* Active fileserver interaction state. */
38720325960SDavid Howells 	struct rb_root		fs_servers;	/* afs_server (by server UUID) */
38820325960SDavid Howells 	seqlock_t		fs_lock;	/* For fs_servers  */
3896e0e99d5SDavid Howells 	struct rw_semaphore	fs_open_mmaps_lock;
3906e0e99d5SDavid Howells 	struct list_head	fs_open_mmaps;	/* List of vnodes that are mmapped */
3914fe6a946SDavid Howells 	atomic_t		fs_s_break;	/* Counter of CB.InitCallBackState messages */
392989782dcSDavid Howells 
393d2ddc776SDavid Howells 	/* VL server list. */
3940a5143f2SDavid Howells 	rwlock_t		vl_servers_lock; /* Lock on vl_servers */
3950a5143f2SDavid Howells 	struct afs_vlserver_list __rcu *vl_servers;
3960a5143f2SDavid Howells 
397989782dcSDavid Howells 	u8			name_len;	/* Length of name */
398719fdd32SDavid Howells 	char			*name;		/* Cell name, case-flattened and NUL-padded */
39908e0e7c8SDavid Howells };
40008e0e7c8SDavid Howells 
40108e0e7c8SDavid Howells /*
4020a5143f2SDavid Howells  * Volume Location server record.
4030a5143f2SDavid Howells  */
4040a5143f2SDavid Howells struct afs_vlserver {
4050a5143f2SDavid Howells 	struct rcu_head		rcu;
4060a5143f2SDavid Howells 	struct afs_addr_list	__rcu *addresses; /* List of addresses for this VL server */
4070a5143f2SDavid Howells 	unsigned long		flags;
4080a5143f2SDavid Howells #define AFS_VLSERVER_FL_PROBED	0		/* The VL server has been probed */
4090a5143f2SDavid Howells #define AFS_VLSERVER_FL_PROBING	1		/* VL server is being probed */
4103bf0fb6fSDavid Howells #define AFS_VLSERVER_FL_IS_YFS	2		/* Server is YFS not AFS */
411b95b3094SDavid Howells #define AFS_VLSERVER_FL_RESPONDING 3		/* VL server is responding */
4120a5143f2SDavid Howells 	rwlock_t		lock;		/* Lock on addresses */
4130a5143f2SDavid Howells 	atomic_t		usage;
414b95b3094SDavid Howells 	unsigned int		rtt;		/* Server's current RTT in uS */
4153bf0fb6fSDavid Howells 
4163bf0fb6fSDavid Howells 	/* Probe state */
4173bf0fb6fSDavid Howells 	wait_queue_head_t	probe_wq;
4183bf0fb6fSDavid Howells 	atomic_t		probe_outstanding;
4193bf0fb6fSDavid Howells 	spinlock_t		probe_lock;
4203bf0fb6fSDavid Howells 	struct {
421b95b3094SDavid Howells 		unsigned int	rtt;		/* RTT in uS */
4223bf0fb6fSDavid Howells 		u32		abort_code;
4233bf0fb6fSDavid Howells 		short		error;
424fb72cd3dSDavid Howells 		unsigned short	flags;
425fb72cd3dSDavid Howells #define AFS_VLSERVER_PROBE_RESPONDED		0x01 /* At least once response (may be abort) */
426fb72cd3dSDavid Howells #define AFS_VLSERVER_PROBE_IS_YFS		0x02 /* The peer appears to be YFS */
427fb72cd3dSDavid Howells #define AFS_VLSERVER_PROBE_NOT_YFS		0x04 /* The peer appears not to be YFS */
428fb72cd3dSDavid Howells #define AFS_VLSERVER_PROBE_LOCAL_FAILURE	0x08 /* A local failure prevented a probe */
4293bf0fb6fSDavid Howells 	} probe;
4303bf0fb6fSDavid Howells 
4310a5143f2SDavid Howells 	u16			port;
4323bf0fb6fSDavid Howells 	u16			name_len;	/* Length of name */
4330a5143f2SDavid Howells 	char			name[];		/* Server name, case-flattened */
4340a5143f2SDavid Howells };
4350a5143f2SDavid Howells 
4360a5143f2SDavid Howells /*
4370a5143f2SDavid Howells  * Weighted list of Volume Location servers.
4380a5143f2SDavid Howells  */
4390a5143f2SDavid Howells struct afs_vlserver_entry {
4400a5143f2SDavid Howells 	u16			priority;	/* Preference (as SRV) */
4410a5143f2SDavid Howells 	u16			weight;		/* Weight (as SRV) */
4420a5143f2SDavid Howells 	enum dns_record_source	source:8;
4430a5143f2SDavid Howells 	enum dns_lookup_status	status:8;
4440a5143f2SDavid Howells 	struct afs_vlserver	*server;
4450a5143f2SDavid Howells };
4460a5143f2SDavid Howells 
4470a5143f2SDavid Howells struct afs_vlserver_list {
4480a5143f2SDavid Howells 	struct rcu_head		rcu;
4490a5143f2SDavid Howells 	atomic_t		usage;
4500a5143f2SDavid Howells 	u8			nr_servers;
4510a5143f2SDavid Howells 	u8			index;		/* Server currently in use */
4523bf0fb6fSDavid Howells 	u8			preferred;	/* Preferred server */
4530a5143f2SDavid Howells 	enum dns_record_source	source:8;
4540a5143f2SDavid Howells 	enum dns_lookup_status	status:8;
4550a5143f2SDavid Howells 	rwlock_t		lock;
4560a5143f2SDavid Howells 	struct afs_vlserver_entry servers[];
4570a5143f2SDavid Howells };
4580a5143f2SDavid Howells 
4590a5143f2SDavid Howells /*
460d2ddc776SDavid Howells  * Cached VLDB entry.
461d2ddc776SDavid Howells  *
462d2ddc776SDavid Howells  * This is pointed to by cell->vldb_entries, indexed by name.
46308e0e7c8SDavid Howells  */
464d2ddc776SDavid Howells struct afs_vldb_entry {
465d2ddc776SDavid Howells 	afs_volid_t		vid[3];		/* Volume IDs for R/W, R/O and Bak volumes */
46600d3b7a4SDavid Howells 
467d2ddc776SDavid Howells 	unsigned long		flags;
468d2ddc776SDavid Howells #define AFS_VLDB_HAS_RW		0		/* - R/W volume exists */
469d2ddc776SDavid Howells #define AFS_VLDB_HAS_RO		1		/* - R/O volume exists */
470d2ddc776SDavid Howells #define AFS_VLDB_HAS_BAK	2		/* - Backup volume exists */
471d2ddc776SDavid Howells #define AFS_VLDB_QUERY_VALID	3		/* - Record is valid */
472d2ddc776SDavid Howells #define AFS_VLDB_QUERY_ERROR	4		/* - VL server returned error */
473d2ddc776SDavid Howells 
474d2ddc776SDavid Howells 	uuid_t			fs_server[AFS_NMAXNSERVERS];
47581006805SDavid Howells 	u32			addr_version[AFS_NMAXNSERVERS]; /* Registration change counters */
476d2ddc776SDavid Howells 	u8			fs_mask[AFS_NMAXNSERVERS];
47708e0e7c8SDavid Howells #define AFS_VOL_VTM_RW	0x01 /* R/W version of the volume is available (on this server) */
47808e0e7c8SDavid Howells #define AFS_VOL_VTM_RO	0x02 /* R/O version of the volume is available (on this server) */
47908e0e7c8SDavid Howells #define AFS_VOL_VTM_BAK	0x04 /* backup version of the volume is available (on this server) */
480d2ddc776SDavid Howells 	short			error;
481d2ddc776SDavid Howells 	u8			nr_servers;	/* Number of server records */
482d2ddc776SDavid Howells 	u8			name_len;
483d2ddc776SDavid Howells 	u8			name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
48408e0e7c8SDavid Howells };
48508e0e7c8SDavid Howells 
48608e0e7c8SDavid Howells /*
487d2ddc776SDavid Howells  * Record of fileserver with which we're actively communicating.
48808e0e7c8SDavid Howells  */
48908e0e7c8SDavid Howells struct afs_server {
490d2ddc776SDavid Howells 	struct rcu_head		rcu;
491d2ddc776SDavid Howells 	union {
492d2ddc776SDavid Howells 		uuid_t		uuid;		/* Server ID */
493d2ddc776SDavid Howells 		struct afs_uuid	_uuid;
494d2ddc776SDavid Howells 	};
495c435ee34SDavid Howells 
496d2ddc776SDavid Howells 	struct afs_addr_list	__rcu *addresses;
49720325960SDavid Howells 	struct afs_cell		*cell;		/* Cell to which belongs (pins ref) */
4983c4c4075SDavid Howells 	struct rb_node		uuid_rb;	/* Link in net->fs_servers */
4993c4c4075SDavid Howells 	struct afs_server __rcu	*uuid_next;	/* Next server with same UUID */
5003c4c4075SDavid Howells 	struct afs_server	*uuid_prev;	/* Previous server with same UUID */
501f6cbb368SDavid Howells 	struct list_head	probe_link;	/* Link in net->fs_probe_list */
502d2ddc776SDavid Howells 	struct hlist_node	addr4_link;	/* Link in net->fs_addresses4 */
503d2ddc776SDavid Howells 	struct hlist_node	addr6_link;	/* Link in net->fs_addresses6 */
504d2ddc776SDavid Howells 	struct hlist_node	proc_link;	/* Link in net->fs_proc */
5056e0e99d5SDavid Howells 	struct work_struct	initcb_work;	/* Work for CB.InitCallBackState* */
506d2ddc776SDavid Howells 	struct afs_server	*gc_next;	/* Next server in manager's list */
507977e5f8eSDavid Howells 	time64_t		unuse_time;	/* Time at which last unused */
508c435ee34SDavid Howells 	unsigned long		flags;
509f3c130e6SDavid Howells #define AFS_SERVER_FL_RESPONDING 0		/* The server is responding */
51032275d3fSDavid Howells #define AFS_SERVER_FL_UPDATING	1
51132275d3fSDavid Howells #define AFS_SERVER_FL_NEEDS_UPDATE 2		/* Fileserver address list is out of date */
51232275d3fSDavid Howells #define AFS_SERVER_FL_NOT_READY	4		/* The record is not ready for use */
51332275d3fSDavid Howells #define AFS_SERVER_FL_NOT_FOUND	5		/* VL server says no such server */
51432275d3fSDavid Howells #define AFS_SERVER_FL_VL_FAIL	6		/* Failed to access VL server */
515f2686b09SDavid Howells #define AFS_SERVER_FL_MAY_HAVE_CB 8		/* May have callbacks on this fileserver */
51632275d3fSDavid Howells #define AFS_SERVER_FL_IS_YFS	16		/* Server is YFS not AFS */
51732275d3fSDavid Howells #define AFS_SERVER_FL_NO_IBULK	17		/* Fileserver doesn't support FS.InlineBulkStatus */
51832275d3fSDavid Howells #define AFS_SERVER_FL_NO_RM2	18		/* Fileserver doesn't support YFS.RemoveFile2 */
519b537a3c2SDavid Howells #define AFS_SERVER_FL_HAS_FS64	19		/* Fileserver supports FS.{Fetch,Store}Data64 */
520977e5f8eSDavid Howells 	atomic_t		ref;		/* Object refcount */
521977e5f8eSDavid Howells 	atomic_t		active;		/* Active user count */
522d2ddc776SDavid Howells 	u32			addr_version;	/* Address list version */
523f3c130e6SDavid Howells 	unsigned int		rtt;		/* Server's current RTT in uS */
52445218193SDavid Howells 	unsigned int		debug_id;	/* Debugging ID for traces */
52508e0e7c8SDavid Howells 
52608e0e7c8SDavid Howells 	/* file service access */
527d2ddc776SDavid Howells 	rwlock_t		fs_lock;	/* access lock */
52808e0e7c8SDavid Howells 
52908e0e7c8SDavid Howells 	/* callback promise management */
530c435ee34SDavid Howells 	unsigned		cb_s_break;	/* Break-everything counter. */
5313bf0fb6fSDavid Howells 
5323bf0fb6fSDavid Howells 	/* Probe state */
533f6cbb368SDavid Howells 	unsigned long		probed_at;	/* Time last probe was dispatched (jiffies) */
5343bf0fb6fSDavid Howells 	wait_queue_head_t	probe_wq;
5353bf0fb6fSDavid Howells 	atomic_t		probe_outstanding;
5363bf0fb6fSDavid Howells 	spinlock_t		probe_lock;
5373bf0fb6fSDavid Howells 	struct {
538f3c130e6SDavid Howells 		unsigned int	rtt;		/* RTT in uS */
5393bf0fb6fSDavid Howells 		u32		abort_code;
5403bf0fb6fSDavid Howells 		short		error;
5413bf0fb6fSDavid Howells 		bool		responded:1;
5423bf0fb6fSDavid Howells 		bool		is_yfs:1;
5433bf0fb6fSDavid Howells 		bool		not_yfs:1;
5443bf0fb6fSDavid Howells 		bool		local_failure:1;
5453bf0fb6fSDavid Howells 	} probe;
546c435ee34SDavid Howells };
547c435ee34SDavid Howells 
548c435ee34SDavid Howells /*
549194d28cfSDavid Howells  * Replaceable volume server list.
55008e0e7c8SDavid Howells  */
551d2ddc776SDavid Howells struct afs_server_entry {
552d2ddc776SDavid Howells 	struct afs_server	*server;
553d2ddc776SDavid Howells };
554d2ddc776SDavid Howells 
555d2ddc776SDavid Howells struct afs_server_list {
556194d28cfSDavid Howells 	afs_volid_t		vids[AFS_MAXTYPES]; /* Volume IDs */
557d2ddc776SDavid Howells 	refcount_t		usage;
5583bf0fb6fSDavid Howells 	unsigned char		nr_servers;
5593bf0fb6fSDavid Howells 	unsigned char		preferred;	/* Preferred server */
560d2ddc776SDavid Howells 	unsigned short		vnovol_mask;	/* Servers to be skipped due to VNOVOL */
561d2ddc776SDavid Howells 	unsigned int		seq;		/* Set to ->servers_seq when installed */
562d4a96becSDavid Howells 	rwlock_t		lock;
563d2ddc776SDavid Howells 	struct afs_server_entry	servers[];
56408e0e7c8SDavid Howells };
56508e0e7c8SDavid Howells 
56608e0e7c8SDavid Howells /*
567d2ddc776SDavid Howells  * Live AFS volume management.
56808e0e7c8SDavid Howells  */
569d2ddc776SDavid Howells struct afs_volume {
57020325960SDavid Howells 	union {
57120325960SDavid Howells 		struct rcu_head	rcu;
572d2ddc776SDavid Howells 		afs_volid_t	vid;		/* volume ID */
57320325960SDavid Howells 	};
574d2ddc776SDavid Howells 	atomic_t		usage;
575d2ddc776SDavid Howells 	time64_t		update_at;	/* Time at which to next update */
576d2ddc776SDavid Howells 	struct afs_cell		*cell;		/* Cell to which belongs (pins ref) */
57720325960SDavid Howells 	struct rb_node		cell_node;	/* Link in cell->volumes */
57820325960SDavid Howells 	struct hlist_node	proc_link;	/* Link in cell->proc_volumes */
57920325960SDavid Howells 	struct super_block __rcu *sb;		/* Superblock on which inodes reside */
580d2ddc776SDavid Howells 	unsigned long		flags;
581d2ddc776SDavid Howells #define AFS_VOLUME_NEEDS_UPDATE	0	/* - T if an update needs performing */
582d2ddc776SDavid Howells #define AFS_VOLUME_UPDATING	1	/* - T if an update is in progress */
583d2ddc776SDavid Howells #define AFS_VOLUME_WAIT		2	/* - T if users must wait for update */
584d2ddc776SDavid Howells #define AFS_VOLUME_DELETED	3	/* - T if volume appears deleted */
585d2ddc776SDavid Howells #define AFS_VOLUME_OFFLINE	4	/* - T if volume offline notice given */
586d2ddc776SDavid Howells #define AFS_VOLUME_BUSY		5	/* - T if volume busy notice given */
58720325960SDavid Howells #define AFS_VOLUME_MAYBE_NO_IBULK 6	/* - T if some servers don't have InlineBulkStatus */
588d2ddc776SDavid Howells #ifdef CONFIG_AFS_FSCACHE
589523d27cdSDavid Howells 	struct fscache_volume	*cache;		/* Caching cookie */
590d2ddc776SDavid Howells #endif
5918a070a96SDavid Howells 	struct afs_server_list __rcu *servers;	/* List of servers on which volume resides */
592d2ddc776SDavid Howells 	rwlock_t		servers_lock;	/* Lock for ->servers */
593d2ddc776SDavid Howells 	unsigned int		servers_seq;	/* Incremented each time ->servers changes */
594d2ddc776SDavid Howells 
59568251f0aSDavid Howells 	unsigned		cb_v_break;	/* Break-everything counter. */
59690fa9b64SDavid Howells 	rwlock_t		cb_v_break_lock;
59768251f0aSDavid Howells 
598d2ddc776SDavid Howells 	afs_voltype_t		type;		/* type of volume */
599d2ddc776SDavid Howells 	char			type_force;	/* force volume type (suppress R/O -> R/W) */
600d2ddc776SDavid Howells 	u8			name_len;
601d2ddc776SDavid Howells 	u8			name[AFS_MAXVOLNAME + 1]; /* NUL-padded volume name */
60208e0e7c8SDavid Howells };
60308e0e7c8SDavid Howells 
6040fafdc9fSDavid Howells enum afs_lock_state {
6050fafdc9fSDavid Howells 	AFS_VNODE_LOCK_NONE,		/* The vnode has no lock on the server */
6060fafdc9fSDavid Howells 	AFS_VNODE_LOCK_WAITING_FOR_CB,	/* We're waiting for the server to break the callback */
6070fafdc9fSDavid Howells 	AFS_VNODE_LOCK_SETTING,		/* We're asking the server for a lock */
6080fafdc9fSDavid Howells 	AFS_VNODE_LOCK_GRANTED,		/* We have a lock on the server */
6090fafdc9fSDavid Howells 	AFS_VNODE_LOCK_EXTENDING,	/* We're extending a lock on the server */
6100fafdc9fSDavid Howells 	AFS_VNODE_LOCK_NEED_UNLOCK,	/* We need to unlock on the server */
6110fafdc9fSDavid Howells 	AFS_VNODE_LOCK_UNLOCKING,	/* We're telling the server to unlock */
612cdfb26b4SDavid Howells 	AFS_VNODE_LOCK_DELETED,		/* The vnode has been deleted whilst we have a lock */
6130fafdc9fSDavid Howells };
6140fafdc9fSDavid Howells 
61508e0e7c8SDavid Howells /*
616f8de483eSDavid Howells  * AFS inode private data.
617f8de483eSDavid Howells  *
618f8de483eSDavid Howells  * Note that afs_alloc_inode() *must* reset anything that could incorrectly
619f8de483eSDavid Howells  * leak from one inode to another.
62008e0e7c8SDavid Howells  */
62108e0e7c8SDavid Howells struct afs_vnode {
62208e0e7c8SDavid Howells 	struct inode		vfs_inode;	/* the VFS's inode record */
62308e0e7c8SDavid Howells 
62408e0e7c8SDavid Howells 	struct afs_volume	*volume;	/* volume on which vnode resides */
62508e0e7c8SDavid Howells 	struct afs_fid		fid;		/* the file identifier for this inode */
62608e0e7c8SDavid Howells 	struct afs_file_status	status;		/* AFS status info for this file */
627a4ff7401SDavid Howells 	afs_dataversion_t	invalid_before;	/* Child dentries are invalid before this */
6289b3f26c9SDavid Howells #ifdef CONFIG_AFS_FSCACHE
6299b3f26c9SDavid Howells 	struct fscache_cookie	*cache;		/* caching cookie */
63008e0e7c8SDavid Howells #endif
631fe342cf7SDavid Howells 	struct afs_permits __rcu *permit_cache;	/* cache of permits so far obtained */
632d2ddc776SDavid Howells 	struct mutex		io_lock;	/* Lock for serialising I/O on this mutex */
633b61f7dcfSDavid Howells 	struct rw_semaphore	validate_lock;	/* lock for validating this vnode */
63479ddbfa5SDavid Howells 	struct rw_semaphore	rmdir_lock;	/* Lock for rmdir vs sillyrename */
63579ddbfa5SDavid Howells 	struct key		*silly_key;	/* Silly rename key */
6364343d008SDavid Howells 	spinlock_t		wb_lock;	/* lock for wb_keys */
63708e0e7c8SDavid Howells 	spinlock_t		lock;		/* waitqueue/flags lock */
63808e0e7c8SDavid Howells 	unsigned long		flags;
639c435ee34SDavid Howells #define AFS_VNODE_CB_PROMISED	0		/* Set if vnode has a callback promise */
640260a9803SDavid Howells #define AFS_VNODE_UNSET		1		/* set if vnode attributes not yet set */
641f3ddee8dSDavid Howells #define AFS_VNODE_DIR_VALID	2		/* Set if dir contents are valid */
64208e0e7c8SDavid Howells #define AFS_VNODE_ZAP_DATA	3		/* set if vnode's data should be invalidated */
64308e0e7c8SDavid Howells #define AFS_VNODE_DELETED	4		/* set if vnode deleted on server */
64408e0e7c8SDavid Howells #define AFS_VNODE_MOUNTPOINT	5		/* set if vnode is a mountpoint symlink */
6450fafdc9fSDavid Howells #define AFS_VNODE_AUTOCELL	6		/* set if Vnode is an auto mount point */
6460fafdc9fSDavid Howells #define AFS_VNODE_PSEUDODIR	7 		/* set if Vnode is a pseudo directory */
6475a813276SDavid Howells #define AFS_VNODE_NEW_CONTENT	8		/* Set if file has new content (create/trunc-0) */
648b6489a49SDavid Howells #define AFS_VNODE_SILLY_DELETED	9		/* Set if file has been silly-deleted */
64922650f14SDavid Howells #define AFS_VNODE_MODIFYING	10		/* Set if we're performing a modification op */
65008e0e7c8SDavid Howells 
6514343d008SDavid Howells 	struct list_head	wb_keys;	/* List of keys available for writeback */
652e8d6c554SDavid Howells 	struct list_head	pending_locks;	/* locks waiting to be granted */
653e8d6c554SDavid Howells 	struct list_head	granted_locks;	/* locks granted on this file */
654e8d6c554SDavid Howells 	struct delayed_work	lock_work;	/* work to be done in locking */
6550fafdc9fSDavid Howells 	struct key		*lock_key;	/* Key to be used in lock ops */
656a690f60aSDavid Howells 	ktime_t			locked_at;	/* Time at which lock obtained */
6570fafdc9fSDavid Howells 	enum afs_lock_state	lock_state : 8;
6580fafdc9fSDavid Howells 	afs_lock_type_t		lock_type : 8;
65931143d5dSDavid Howells 
66008e0e7c8SDavid Howells 	/* outstanding callback notification on this file */
6616e0e99d5SDavid Howells 	struct work_struct	cb_work;	/* Work for mmap'd files */
6626e0e99d5SDavid Howells 	struct list_head	cb_mmap_link;	/* Link in cell->fs_open_mmaps */
66320325960SDavid Howells 	void			*cb_server;	/* Server with callback/filelock */
6646e0e99d5SDavid Howells 	atomic_t		cb_nr_mmap;	/* Number of mmaps */
6654fe6a946SDavid Howells 	unsigned int		cb_fs_s_break;	/* Mass server break counter (cell->fs_s_break) */
666c435ee34SDavid Howells 	unsigned int		cb_s_break;	/* Mass break counter on ->server */
66768251f0aSDavid Howells 	unsigned int		cb_v_break;	/* Mass break counter on ->volume */
668c435ee34SDavid Howells 	unsigned int		cb_break;	/* Break counter on vnode */
66920325960SDavid Howells 	seqlock_t		cb_lock;	/* Lock for ->cb_server, ->status, ->cb_*break */
670c435ee34SDavid Howells 
671c435ee34SDavid Howells 	time64_t		cb_expires_at;	/* time at which callback expires */
67208e0e7c8SDavid Howells };
67308e0e7c8SDavid Howells 
67412bdcf33SDavid Howells static inline struct fscache_cookie *afs_vnode_cache(struct afs_vnode *vnode)
67512bdcf33SDavid Howells {
67612bdcf33SDavid Howells #ifdef CONFIG_AFS_FSCACHE
67712bdcf33SDavid Howells 	return vnode->cache;
67812bdcf33SDavid Howells #else
67912bdcf33SDavid Howells 	return NULL;
68012bdcf33SDavid Howells #endif
68112bdcf33SDavid Howells }
68212bdcf33SDavid Howells 
68300d3b7a4SDavid Howells /*
68400d3b7a4SDavid Howells  * cached security record for one user's attempt to access a vnode
68500d3b7a4SDavid Howells  */
68600d3b7a4SDavid Howells struct afs_permit {
68700d3b7a4SDavid Howells 	struct key		*key;		/* RxRPC ticket holding a security context */
688be080a6fSDavid Howells 	afs_access_t		access;		/* CallerAccess value for this key */
68900d3b7a4SDavid Howells };
69000d3b7a4SDavid Howells 
69100d3b7a4SDavid Howells /*
692be080a6fSDavid Howells  * Immutable cache of CallerAccess records from attempts to access vnodes.
693be080a6fSDavid Howells  * These may be shared between multiple vnodes.
69400d3b7a4SDavid Howells  */
69500d3b7a4SDavid Howells struct afs_permits {
696be080a6fSDavid Howells 	struct rcu_head		rcu;
697be080a6fSDavid Howells 	struct hlist_node	hash_node;	/* Link in hash */
698be080a6fSDavid Howells 	unsigned long		h;		/* Hash value for this permit list */
699be080a6fSDavid Howells 	refcount_t		usage;
700be080a6fSDavid Howells 	unsigned short		nr_permits;	/* Number of records */
701be080a6fSDavid Howells 	bool			invalidated;	/* Invalidated due to key change */
702be080a6fSDavid Howells 	struct afs_permit	permits[];	/* List of permits sorted by key pointer */
70300d3b7a4SDavid Howells };
70400d3b7a4SDavid Howells 
705b908fe6bSDavid Howells /*
7064584ae96SDavid Howells  * Error prioritisation and accumulation.
7074584ae96SDavid Howells  */
7084584ae96SDavid Howells struct afs_error {
7094584ae96SDavid Howells 	short	error;			/* Accumulated error */
7104584ae96SDavid Howells 	bool	responded;		/* T if server responded */
7114584ae96SDavid Howells };
7124584ae96SDavid Howells 
7134584ae96SDavid Howells /*
7148b2a464cSDavid Howells  * Cursor for iterating over a server's address list.
7158b2a464cSDavid Howells  */
7168b2a464cSDavid Howells struct afs_addr_cursor {
7178b2a464cSDavid Howells 	struct afs_addr_list	*alist;		/* Current address list (pins ref) */
7183bf0fb6fSDavid Howells 	unsigned long		tried;		/* Tried addresses */
7193bf0fb6fSDavid Howells 	signed char		index;		/* Current address */
7208b2a464cSDavid Howells 	bool			responded;	/* T if the current address responded */
721744bcd71SDavid Howells 	unsigned short		nr_iterations;	/* Number of address iterations */
7223bf0fb6fSDavid Howells 	short			error;
7233bf0fb6fSDavid Howells 	u32			abort_code;
7248b2a464cSDavid Howells };
7258b2a464cSDavid Howells 
7268b2a464cSDavid Howells /*
7270a5143f2SDavid Howells  * Cursor for iterating over a set of volume location servers.
7280a5143f2SDavid Howells  */
7290a5143f2SDavid Howells struct afs_vl_cursor {
7300a5143f2SDavid Howells 	struct afs_addr_cursor	ac;
7310a5143f2SDavid Howells 	struct afs_cell		*cell;		/* The cell we're querying */
7320a5143f2SDavid Howells 	struct afs_vlserver_list *server_list;	/* Current server list (pins ref) */
7333bf0fb6fSDavid Howells 	struct afs_vlserver	*server;	/* Server on which this resides */
7340a5143f2SDavid Howells 	struct key		*key;		/* Key for the server */
7353bf0fb6fSDavid Howells 	unsigned long		untried;	/* Bitmask of untried servers */
7363bf0fb6fSDavid Howells 	short			index;		/* Current server */
7370a5143f2SDavid Howells 	short			error;
7380a5143f2SDavid Howells 	unsigned short		flags;
7390a5143f2SDavid Howells #define AFS_VL_CURSOR_STOP	0x0001		/* Set to cease iteration */
7400a5143f2SDavid Howells #define AFS_VL_CURSOR_RETRY	0x0002		/* Set to do a retry */
7410a5143f2SDavid Howells #define AFS_VL_CURSOR_RETRIED	0x0004		/* Set if started a retry */
742744bcd71SDavid Howells 	unsigned short		nr_iterations;	/* Number of server iterations */
7430a5143f2SDavid Howells };
7440a5143f2SDavid Howells 
7450a5143f2SDavid Howells /*
746e49c7b2fSDavid Howells  * Fileserver operation methods.
747e49c7b2fSDavid Howells  */
748e49c7b2fSDavid Howells struct afs_operation_ops {
749e49c7b2fSDavid Howells 	void (*issue_afs_rpc)(struct afs_operation *op);
750e49c7b2fSDavid Howells 	void (*issue_yfs_rpc)(struct afs_operation *op);
751e49c7b2fSDavid Howells 	void (*success)(struct afs_operation *op);
752e49c7b2fSDavid Howells 	void (*aborted)(struct afs_operation *op);
753dc419184SDavid Howells 	void (*failed)(struct afs_operation *op);
754e49c7b2fSDavid Howells 	void (*edit_dir)(struct afs_operation *op);
755e49c7b2fSDavid Howells 	void (*put)(struct afs_operation *op);
756e49c7b2fSDavid Howells };
757e49c7b2fSDavid Howells 
758e49c7b2fSDavid Howells struct afs_vnode_param {
759e49c7b2fSDavid Howells 	struct afs_vnode	*vnode;
760e49c7b2fSDavid Howells 	struct afs_fid		fid;		/* Fid to access */
761e49c7b2fSDavid Howells 	struct afs_status_cb	scb;		/* Returned status and callback promise */
762e49c7b2fSDavid Howells 	afs_dataversion_t	dv_before;	/* Data version before the call */
763e49c7b2fSDavid Howells 	unsigned int		cb_break_before; /* cb_break + cb_s_break before the call */
764e49c7b2fSDavid Howells 	u8			dv_delta;	/* Expected change in data version */
765793fe82eSDavid Howells 	bool			put_vnode:1;	/* T if we have a ref on the vnode */
766793fe82eSDavid Howells 	bool			need_io_lock:1;	/* T if we need the I/O lock on this */
767793fe82eSDavid Howells 	bool			update_ctime:1;	/* Need to update the ctime */
768793fe82eSDavid Howells 	bool			set_size:1;	/* Must update i_size */
769b6489a49SDavid Howells 	bool			op_unlinked:1;	/* True if file was unlinked by op */
770a9e5c87cSDavid Howells 	bool			speculative:1;	/* T if speculative status fetch (no vnode lock) */
77122650f14SDavid Howells 	bool			modification:1;	/* Set if the content gets modified */
772e49c7b2fSDavid Howells };
773e49c7b2fSDavid Howells 
774e49c7b2fSDavid Howells /*
775e49c7b2fSDavid Howells  * Fileserver operation wrapper, handling server and address rotation
776e49c7b2fSDavid Howells  * asynchronously.  May make simultaneous calls to multiple servers.
7778b2a464cSDavid Howells  */
778a310082fSDavid Howells struct afs_operation {
779e49c7b2fSDavid Howells 	struct afs_net		*net;		/* Network namespace */
780e49c7b2fSDavid Howells 	struct key		*key;		/* Key for the cell */
781a58823acSDavid Howells 	const struct afs_call_type *type;	/* Type of call done */
782e49c7b2fSDavid Howells 	const struct afs_operation_ops *ops;
783e49c7b2fSDavid Howells 
784e49c7b2fSDavid Howells 	/* Parameters/results for the operation */
785e49c7b2fSDavid Howells 	struct afs_volume	*volume;	/* Volume being accessed */
786e49c7b2fSDavid Howells 	struct afs_vnode_param	file[2];
787e49c7b2fSDavid Howells 	struct afs_vnode_param	*more_files;
788e49c7b2fSDavid Howells 	struct afs_volsync	volsync;
789e49c7b2fSDavid Howells 	struct dentry		*dentry;	/* Dentry to be altered */
790e49c7b2fSDavid Howells 	struct dentry		*dentry_2;	/* Second dentry to be altered */
791e49c7b2fSDavid Howells 	struct timespec64	mtime;		/* Modification time to record */
792da8d0755SDavid Howells 	struct timespec64	ctime;		/* Change time to set */
793e49c7b2fSDavid Howells 	short			nr_files;	/* Number of entries in file[], more_files */
794e49c7b2fSDavid Howells 	short			error;
795e49c7b2fSDavid Howells 	unsigned int		debug_id;
796e49c7b2fSDavid Howells 
797e49c7b2fSDavid Howells 	unsigned int		cb_v_break;	/* Volume break counter before op */
798e49c7b2fSDavid Howells 	unsigned int		cb_s_break;	/* Server break counter before op */
799e49c7b2fSDavid Howells 
800e49c7b2fSDavid Howells 	union {
801e49c7b2fSDavid Howells 		struct {
802e49c7b2fSDavid Howells 			int	which;		/* Which ->file[] to fetch for */
803e49c7b2fSDavid Howells 		} fetch_status;
804e49c7b2fSDavid Howells 		struct {
805e49c7b2fSDavid Howells 			int	reason;		/* enum afs_edit_dir_reason */
806e49c7b2fSDavid Howells 			mode_t	mode;
807e49c7b2fSDavid Howells 			const char *symlink;
808e49c7b2fSDavid Howells 		} create;
809e49c7b2fSDavid Howells 		struct {
810e49c7b2fSDavid Howells 			bool	need_rehash;
811e49c7b2fSDavid Howells 		} unlink;
812e49c7b2fSDavid Howells 		struct {
813e49c7b2fSDavid Howells 			struct dentry *rehash;
814e49c7b2fSDavid Howells 			struct dentry *tmp;
815e49c7b2fSDavid Howells 			bool	new_negative;
816e49c7b2fSDavid Howells 		} rename;
817e49c7b2fSDavid Howells 		struct {
818e49c7b2fSDavid Howells 			struct afs_read *req;
819e49c7b2fSDavid Howells 		} fetch;
820e49c7b2fSDavid Howells 		struct {
821e49c7b2fSDavid Howells 			afs_lock_type_t type;
822e49c7b2fSDavid Howells 		} lock;
823e49c7b2fSDavid Howells 		struct {
824bd80d8a8SDavid Howells 			struct iov_iter	*write_iter;
825bd80d8a8SDavid Howells 			loff_t	pos;
826bd80d8a8SDavid Howells 			loff_t	size;
827bd80d8a8SDavid Howells 			loff_t	i_size;
828d383e346SDavid Howells 			bool	laundering;	/* Laundering page, PG_writeback not set */
829e49c7b2fSDavid Howells 		} store;
830e49c7b2fSDavid Howells 		struct {
831e49c7b2fSDavid Howells 			struct iattr	*attr;
832ec0fa0b6SDavid Howells 			loff_t		old_i_size;
833e49c7b2fSDavid Howells 		} setattr;
834e49c7b2fSDavid Howells 		struct afs_acl	*acl;
835e49c7b2fSDavid Howells 		struct yfs_acl	*yacl;
836e49c7b2fSDavid Howells 		struct {
837e49c7b2fSDavid Howells 			struct afs_volume_status vs;
838e49c7b2fSDavid Howells 			struct kstatfs		*buf;
839e49c7b2fSDavid Howells 		} volstatus;
840e49c7b2fSDavid Howells 	};
841e49c7b2fSDavid Howells 
842e49c7b2fSDavid Howells 	/* Fileserver iteration state */
8438b2a464cSDavid Howells 	struct afs_addr_cursor	ac;
844d2ddc776SDavid Howells 	struct afs_server_list	*server_list;	/* Current server list (pins ref) */
84520325960SDavid Howells 	struct afs_server	*server;	/* Server we're using (ref pinned by server_list) */
846e49c7b2fSDavid Howells 	struct afs_call		*call;
8473bf0fb6fSDavid Howells 	unsigned long		untried;	/* Bitmask of untried servers */
8483bf0fb6fSDavid Howells 	short			index;		/* Current server */
849e49c7b2fSDavid Howells 	unsigned short		nr_iterations;	/* Number of server iterations */
850e49c7b2fSDavid Howells 
851e49c7b2fSDavid Howells 	unsigned int		flags;
852a310082fSDavid Howells #define AFS_OPERATION_STOP		0x0001	/* Set to cease iteration */
853a310082fSDavid Howells #define AFS_OPERATION_VBUSY		0x0002	/* Set if seen VBUSY */
854a310082fSDavid Howells #define AFS_OPERATION_VMOVED		0x0004	/* Set if seen VMOVED */
855a310082fSDavid Howells #define AFS_OPERATION_VNOVOL		0x0008	/* Set if seen VNOVOL */
856a310082fSDavid Howells #define AFS_OPERATION_CUR_ONLY		0x0010	/* Set if current server only (file lock held) */
857a310082fSDavid Howells #define AFS_OPERATION_NO_VSLEEP		0x0020	/* Set to prevent sleep on VBUSY, VOFFLINE, ... */
858e49c7b2fSDavid Howells #define AFS_OPERATION_UNINTR		0x0040	/* Set if op is uninterruptible */
859e49c7b2fSDavid Howells #define AFS_OPERATION_DOWNGRADE		0x0080	/* Set to retry with downgraded opcode */
860e49c7b2fSDavid Howells #define AFS_OPERATION_LOCK_0		0x0100	/* Set if have io_lock on file[0] */
861e49c7b2fSDavid Howells #define AFS_OPERATION_LOCK_1		0x0200	/* Set if have io_lock on file[1] */
8628409f67bSDavid Howells #define AFS_OPERATION_TRIED_ALL		0x0400	/* Set if we've tried all the fileservers */
8638409f67bSDavid Howells #define AFS_OPERATION_RETRY_SERVER	0x0800	/* Set if we should retry the current server */
864b6489a49SDavid Howells #define AFS_OPERATION_DIR_CONFLICT	0x1000	/* Set if we detected a 3rd-party dir change */
8658b2a464cSDavid Howells };
8668b2a464cSDavid Howells 
867402cb8ddSDavid Howells /*
868402cb8ddSDavid Howells  * Cache auxiliary data.
869402cb8ddSDavid Howells  */
870402cb8ddSDavid Howells struct afs_vnode_cache_aux {
871523d27cdSDavid Howells 	__be64			data_version;
872402cb8ddSDavid Howells } __packed;
873402cb8ddSDavid Howells 
874523d27cdSDavid Howells static inline void afs_set_cache_aux(struct afs_vnode *vnode,
875523d27cdSDavid Howells 				     struct afs_vnode_cache_aux *aux)
876523d27cdSDavid Howells {
877523d27cdSDavid Howells 	aux->data_version = cpu_to_be64(vnode->status.data_version);
878523d27cdSDavid Howells }
879523d27cdSDavid Howells 
880523d27cdSDavid Howells static inline void afs_invalidate_cache(struct afs_vnode *vnode, unsigned int flags)
881523d27cdSDavid Howells {
882523d27cdSDavid Howells 	struct afs_vnode_cache_aux aux;
883523d27cdSDavid Howells 
884523d27cdSDavid Howells 	afs_set_cache_aux(vnode, &aux);
885523d27cdSDavid Howells 	fscache_invalidate(afs_vnode_cache(vnode), &aux,
886523d27cdSDavid Howells 			   i_size_read(&vnode->vfs_inode), flags);
887523d27cdSDavid Howells }
888523d27cdSDavid Howells 
889185f0c70SDavid Howells /*
89078525c74SDavid Howells  * We use folio->private to hold the amount of the folio that we've written to,
891185f0c70SDavid Howells  * splitting the field into two parts.  However, we need to represent a range
89278525c74SDavid Howells  * 0...FOLIO_SIZE, so we reduce the resolution if the size of the folio
8932d9900f2SDavid Howells  * exceeds what we can encode.
894185f0c70SDavid Howells  */
89565dd2d60SDavid Howells #ifdef CONFIG_64BIT
89678525c74SDavid Howells #define __AFS_FOLIO_PRIV_MASK		0x7fffffffUL
89778525c74SDavid Howells #define __AFS_FOLIO_PRIV_SHIFT		32
89878525c74SDavid Howells #define __AFS_FOLIO_PRIV_MMAPPED	0x80000000UL
899185f0c70SDavid Howells #else
90078525c74SDavid Howells #define __AFS_FOLIO_PRIV_MASK		0x7fffUL
90178525c74SDavid Howells #define __AFS_FOLIO_PRIV_SHIFT		16
90278525c74SDavid Howells #define __AFS_FOLIO_PRIV_MMAPPED	0x8000UL
903185f0c70SDavid Howells #endif
904185f0c70SDavid Howells 
90578525c74SDavid Howells static inline unsigned int afs_folio_dirty_resolution(struct folio *folio)
9062d9900f2SDavid Howells {
90778525c74SDavid Howells 	int shift = folio_shift(folio) - (__AFS_FOLIO_PRIV_SHIFT - 1);
9082d9900f2SDavid Howells 	return (shift > 0) ? shift : 0;
9092d9900f2SDavid Howells }
9102d9900f2SDavid Howells 
91178525c74SDavid Howells static inline size_t afs_folio_dirty_from(struct folio *folio, unsigned long priv)
912185f0c70SDavid Howells {
91378525c74SDavid Howells 	unsigned long x = priv & __AFS_FOLIO_PRIV_MASK;
9142d9900f2SDavid Howells 
9152d9900f2SDavid Howells 	/* The lower bound is inclusive */
91678525c74SDavid Howells 	return x << afs_folio_dirty_resolution(folio);
917185f0c70SDavid Howells }
918185f0c70SDavid Howells 
91978525c74SDavid Howells static inline size_t afs_folio_dirty_to(struct folio *folio, unsigned long priv)
920185f0c70SDavid Howells {
92178525c74SDavid Howells 	unsigned long x = (priv >> __AFS_FOLIO_PRIV_SHIFT) & __AFS_FOLIO_PRIV_MASK;
9222d9900f2SDavid Howells 
9232d9900f2SDavid Howells 	/* The upper bound is immediately beyond the region */
92478525c74SDavid Howells 	return (x + 1) << afs_folio_dirty_resolution(folio);
925185f0c70SDavid Howells }
926185f0c70SDavid Howells 
92778525c74SDavid Howells static inline unsigned long afs_folio_dirty(struct folio *folio, size_t from, size_t to)
928185f0c70SDavid Howells {
92978525c74SDavid Howells 	unsigned int res = afs_folio_dirty_resolution(folio);
9302d9900f2SDavid Howells 	from >>= res;
9312d9900f2SDavid Howells 	to = (to - 1) >> res;
93278525c74SDavid Howells 	return (to << __AFS_FOLIO_PRIV_SHIFT) | from;
933185f0c70SDavid Howells }
934185f0c70SDavid Howells 
93578525c74SDavid Howells static inline unsigned long afs_folio_dirty_mmapped(unsigned long priv)
936f86726a6SDavid Howells {
93778525c74SDavid Howells 	return priv | __AFS_FOLIO_PRIV_MMAPPED;
938f86726a6SDavid Howells }
939f86726a6SDavid Howells 
94078525c74SDavid Howells static inline bool afs_is_folio_dirty_mmapped(unsigned long priv)
941f86726a6SDavid Howells {
94278525c74SDavid Howells 	return priv & __AFS_FOLIO_PRIV_MMAPPED;
943f86726a6SDavid Howells }
944f86726a6SDavid Howells 
94598bf40cdSDavid Howells #include <trace/events/afs.h>
94698bf40cdSDavid Howells 
94708e0e7c8SDavid Howells /*****************************************************************************/
94808e0e7c8SDavid Howells /*
9498b2a464cSDavid Howells  * addr_list.c
9508b2a464cSDavid Howells  */
9518b2a464cSDavid Howells static inline struct afs_addr_list *afs_get_addrlist(struct afs_addr_list *alist)
9528b2a464cSDavid Howells {
9538b2a464cSDavid Howells 	if (alist)
9548b2a464cSDavid Howells 		refcount_inc(&alist->usage);
9558b2a464cSDavid Howells 	return alist;
9568b2a464cSDavid Howells }
9578b2a464cSDavid Howells extern struct afs_addr_list *afs_alloc_addrlist(unsigned int,
9588b2a464cSDavid Howells 						unsigned short,
9598b2a464cSDavid Howells 						unsigned short);
9608b2a464cSDavid Howells extern void afs_put_addrlist(struct afs_addr_list *);
9610a5143f2SDavid Howells extern struct afs_vlserver_list *afs_parse_text_addrs(struct afs_net *,
9620a5143f2SDavid Howells 						      const char *, size_t, char,
9638b2a464cSDavid Howells 						      unsigned short, unsigned short);
9640a5143f2SDavid Howells extern struct afs_vlserver_list *afs_dns_query(struct afs_cell *, time64_t *);
9658b2a464cSDavid Howells extern bool afs_iterate_addresses(struct afs_addr_cursor *);
9668b2a464cSDavid Howells extern int afs_end_cursor(struct afs_addr_cursor *);
9678b2a464cSDavid Howells 
968bf99a53cSDavid Howells extern void afs_merge_fs_addr4(struct afs_addr_list *, __be32, u16);
969bf99a53cSDavid Howells extern void afs_merge_fs_addr6(struct afs_addr_list *, __be32 *, u16);
970d2ddc776SDavid Howells 
9718b2a464cSDavid Howells /*
9729b3f26c9SDavid Howells  * cache.c
9739b3f26c9SDavid Howells  */
9749b3f26c9SDavid Howells #ifdef CONFIG_AFS_FSCACHE
9759b3f26c9SDavid Howells extern struct fscache_netfs afs_cache_netfs;
9769b3f26c9SDavid Howells #endif
9779b3f26c9SDavid Howells 
9789b3f26c9SDavid Howells /*
97908e0e7c8SDavid Howells  * callback.c
98008e0e7c8SDavid Howells  */
9816e0e99d5SDavid Howells extern void afs_invalidate_mmap_work(struct work_struct *);
9826e0e99d5SDavid Howells extern void afs_server_init_callback_work(struct work_struct *work);
98308e0e7c8SDavid Howells extern void afs_init_callback_state(struct afs_server *);
984051d2525SDavid Howells extern void __afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
985051d2525SDavid Howells extern void afs_break_callback(struct afs_vnode *, enum afs_cb_break_reason);
9865cf9dd55SDavid Howells extern void afs_break_callbacks(struct afs_server *, size_t, struct afs_callback_break *);
987c435ee34SDavid Howells 
98868251f0aSDavid Howells static inline unsigned int afs_calc_vnode_cb_break(struct afs_vnode *vnode)
98968251f0aSDavid Howells {
990eeba1e9cSDavid Howells 	return vnode->cb_break + vnode->cb_v_break;
99168251f0aSDavid Howells }
99268251f0aSDavid Howells 
99318ac6185SDavid Howells static inline bool afs_cb_is_broken(unsigned int cb_break,
99420325960SDavid Howells 				    const struct afs_vnode *vnode)
99568251f0aSDavid Howells {
99620325960SDavid Howells 	return cb_break != (vnode->cb_break + vnode->volume->cb_v_break);
99768251f0aSDavid Howells }
99868251f0aSDavid Howells 
9991da177e4SLinus Torvalds /*
10001da177e4SLinus Torvalds  * cell.c
10011da177e4SLinus Torvalds  */
1002989782dcSDavid Howells extern int afs_cell_init(struct afs_net *, const char *);
1003dca54a7bSDavid Howells extern struct afs_cell *afs_find_cell(struct afs_net *, const char *, unsigned,
1004dca54a7bSDavid Howells 				      enum afs_cell_trace);
1005989782dcSDavid Howells extern struct afs_cell *afs_lookup_cell(struct afs_net *, const char *, unsigned,
1006989782dcSDavid Howells 					const char *, bool);
1007dca54a7bSDavid Howells extern struct afs_cell *afs_use_cell(struct afs_cell *, enum afs_cell_trace);
1008dca54a7bSDavid Howells extern void afs_unuse_cell(struct afs_net *, struct afs_cell *, enum afs_cell_trace);
1009dca54a7bSDavid Howells extern struct afs_cell *afs_get_cell(struct afs_cell *, enum afs_cell_trace);
1010dca54a7bSDavid Howells extern void afs_see_cell(struct afs_cell *, enum afs_cell_trace);
1011dca54a7bSDavid Howells extern void afs_put_cell(struct afs_cell *, enum afs_cell_trace);
1012dca54a7bSDavid Howells extern void afs_queue_cell(struct afs_cell *, enum afs_cell_trace);
1013989782dcSDavid Howells extern void afs_manage_cells(struct work_struct *);
1014989782dcSDavid Howells extern void afs_cells_timer(struct timer_list *);
1015f044c884SDavid Howells extern void __net_exit afs_cell_purge(struct afs_net *);
101608e0e7c8SDavid Howells 
101708e0e7c8SDavid Howells /*
101808e0e7c8SDavid Howells  * cmservice.c
101908e0e7c8SDavid Howells  */
102008e0e7c8SDavid Howells extern bool afs_cm_incoming_call(struct afs_call *);
102108e0e7c8SDavid Howells 
10221da177e4SLinus Torvalds /*
10231da177e4SLinus Torvalds  * dir.c
10241da177e4SLinus Torvalds  */
10254b6f5d20SArjan van de Ven extern const struct file_operations afs_dir_file_operations;
10264d673da1SDavid Howells extern const struct inode_operations afs_dir_inode_operations;
1027f3ddee8dSDavid Howells extern const struct address_space_operations afs_dir_aops;
10284d673da1SDavid Howells extern const struct dentry_operations afs_fs_dentry_operations;
10294d673da1SDavid Howells 
103066c7e1d3SDavid Howells extern void afs_d_release(struct dentry *);
1031728279a5SDavid Howells extern void afs_check_for_remote_deletion(struct afs_operation *);
103266c7e1d3SDavid Howells 
103366c7e1d3SDavid Howells /*
103463a4681fSDavid Howells  * dir_edit.c
103563a4681fSDavid Howells  */
103663a4681fSDavid Howells extern void afs_edit_dir_add(struct afs_vnode *, struct qstr *, struct afs_fid *,
103763a4681fSDavid Howells 			     enum afs_edit_dir_reason);
103863a4681fSDavid Howells extern void afs_edit_dir_remove(struct afs_vnode *, struct qstr *, enum afs_edit_dir_reason);
103963a4681fSDavid Howells 
104063a4681fSDavid Howells /*
104179ddbfa5SDavid Howells  * dir_silly.c
104279ddbfa5SDavid Howells  */
104379ddbfa5SDavid Howells extern int afs_sillyrename(struct afs_vnode *, struct afs_vnode *,
104479ddbfa5SDavid Howells 			   struct dentry *, struct key *);
104579ddbfa5SDavid Howells extern int afs_silly_iput(struct dentry *, struct inode *);
104679ddbfa5SDavid Howells 
104779ddbfa5SDavid Howells /*
104866c7e1d3SDavid Howells  * dynroot.c
104966c7e1d3SDavid Howells  */
105066c7e1d3SDavid Howells extern const struct inode_operations afs_dynroot_inode_operations;
105166c7e1d3SDavid Howells extern const struct dentry_operations afs_dynroot_dentry_operations;
105266c7e1d3SDavid Howells 
105366c7e1d3SDavid Howells extern struct inode *afs_try_auto_mntpt(struct dentry *, struct inode *);
10540da0b7fdSDavid Howells extern int afs_dynroot_mkdir(struct afs_net *, struct afs_cell *);
10550da0b7fdSDavid Howells extern void afs_dynroot_rmdir(struct afs_net *, struct afs_cell *);
10560da0b7fdSDavid Howells extern int afs_dynroot_populate(struct super_block *);
10570da0b7fdSDavid Howells extern void afs_dynroot_depopulate(struct super_block *);
10581da177e4SLinus Torvalds 
10591da177e4SLinus Torvalds /*
10601da177e4SLinus Torvalds  * file.c
10611da177e4SLinus Torvalds  */
106275bd228dSDavid Howells extern const struct address_space_operations afs_file_aops;
106375bd228dSDavid Howells extern const struct address_space_operations afs_symlink_aops;
1064754661f1SArjan van de Ven extern const struct inode_operations afs_file_inode_operations;
106500d3b7a4SDavid Howells extern const struct file_operations afs_file_operations;
10663003bbd0SDavid Howells extern const struct netfs_read_request_ops afs_req_ops;
106700d3b7a4SDavid Howells 
10684343d008SDavid Howells extern int afs_cache_wb_key(struct afs_vnode *, struct afs_file *);
10694343d008SDavid Howells extern void afs_put_wb_key(struct afs_wb_key *);
107000d3b7a4SDavid Howells extern int afs_open(struct inode *, struct file *);
107100d3b7a4SDavid Howells extern int afs_release(struct inode *, struct file *);
1072c69bf479SDavid Howells extern int afs_fetch_data(struct afs_vnode *, struct afs_read *);
10735cbf0398SDavid Howells extern struct afs_read *afs_alloc_read(gfp_t);
1074196ee9cdSDavid Howells extern void afs_put_read(struct afs_read *);
1075c7f75ef3SDavid Howells extern int afs_write_inode(struct inode *, struct writeback_control *);
10761da177e4SLinus Torvalds 
1077d4438a25SDavid Howells static inline struct afs_read *afs_get_read(struct afs_read *req)
1078d4438a25SDavid Howells {
1079d4438a25SDavid Howells 	refcount_inc(&req->usage);
1080d4438a25SDavid Howells 	return req;
1081d4438a25SDavid Howells }
1082d4438a25SDavid Howells 
10831da177e4SLinus Torvalds /*
1084e8d6c554SDavid Howells  * flock.c
1085e8d6c554SDavid Howells  */
1086f044c884SDavid Howells extern struct workqueue_struct *afs_lock_manager;
1087f044c884SDavid Howells 
1088a690f60aSDavid Howells extern void afs_lock_op_done(struct afs_call *);
1089e8d6c554SDavid Howells extern void afs_lock_work(struct work_struct *);
1090e8d6c554SDavid Howells extern void afs_lock_may_be_available(struct afs_vnode *);
1091e8d6c554SDavid Howells extern int afs_lock(struct file *, int, struct file_lock *);
1092e8d6c554SDavid Howells extern int afs_flock(struct file *, int, struct file_lock *);
1093e8d6c554SDavid Howells 
1094e8d6c554SDavid Howells /*
109508e0e7c8SDavid Howells  * fsclient.c
109608e0e7c8SDavid Howells  */
1097e49c7b2fSDavid Howells extern void afs_fs_fetch_status(struct afs_operation *);
1098e49c7b2fSDavid Howells extern void afs_fs_fetch_data(struct afs_operation *);
1099e49c7b2fSDavid Howells extern void afs_fs_create_file(struct afs_operation *);
1100e49c7b2fSDavid Howells extern void afs_fs_make_dir(struct afs_operation *);
1101e49c7b2fSDavid Howells extern void afs_fs_remove_file(struct afs_operation *);
1102e49c7b2fSDavid Howells extern void afs_fs_remove_dir(struct afs_operation *);
1103e49c7b2fSDavid Howells extern void afs_fs_link(struct afs_operation *);
1104e49c7b2fSDavid Howells extern void afs_fs_symlink(struct afs_operation *);
1105e49c7b2fSDavid Howells extern void afs_fs_rename(struct afs_operation *);
1106e49c7b2fSDavid Howells extern void afs_fs_store_data(struct afs_operation *);
1107e49c7b2fSDavid Howells extern void afs_fs_setattr(struct afs_operation *);
1108e49c7b2fSDavid Howells extern void afs_fs_get_volume_status(struct afs_operation *);
1109e49c7b2fSDavid Howells extern void afs_fs_set_lock(struct afs_operation *);
1110e49c7b2fSDavid Howells extern void afs_fs_extend_lock(struct afs_operation *);
1111e49c7b2fSDavid Howells extern void afs_fs_release_lock(struct afs_operation *);
1112d2ddc776SDavid Howells extern int afs_fs_give_up_all_callbacks(struct afs_net *, struct afs_server *,
1113d2ddc776SDavid Howells 					struct afs_addr_cursor *, struct key *);
1114f6cbb368SDavid Howells extern bool afs_fs_get_capabilities(struct afs_net *, struct afs_server *,
1115f6cbb368SDavid Howells 				    struct afs_addr_cursor *, struct key *);
1116e49c7b2fSDavid Howells extern void afs_fs_inline_bulk_status(struct afs_operation *);
111708e0e7c8SDavid Howells 
1118260f082bSDavid Howells struct afs_acl {
1119260f082bSDavid Howells 	u32	size;
1120260f082bSDavid Howells 	u8	data[];
1121260f082bSDavid Howells };
1122260f082bSDavid Howells 
1123e49c7b2fSDavid Howells extern void afs_fs_fetch_acl(struct afs_operation *);
1124e49c7b2fSDavid Howells extern void afs_fs_store_acl(struct afs_operation *);
1125e49c7b2fSDavid Howells 
1126e49c7b2fSDavid Howells /*
1127e49c7b2fSDavid Howells  * fs_operation.c
1128e49c7b2fSDavid Howells  */
1129e49c7b2fSDavid Howells extern struct afs_operation *afs_alloc_operation(struct key *, struct afs_volume *);
1130e49c7b2fSDavid Howells extern int afs_put_operation(struct afs_operation *);
1131e49c7b2fSDavid Howells extern bool afs_begin_vnode_operation(struct afs_operation *);
1132e49c7b2fSDavid Howells extern void afs_wait_for_operation(struct afs_operation *);
1133e49c7b2fSDavid Howells extern int afs_do_sync_operation(struct afs_operation *);
1134e49c7b2fSDavid Howells 
1135e49c7b2fSDavid Howells static inline void afs_op_nomem(struct afs_operation *op)
1136e49c7b2fSDavid Howells {
1137e49c7b2fSDavid Howells 	op->error = -ENOMEM;
1138e49c7b2fSDavid Howells }
1139e49c7b2fSDavid Howells 
1140e49c7b2fSDavid Howells static inline void afs_op_set_vnode(struct afs_operation *op, unsigned int n,
1141e49c7b2fSDavid Howells 				    struct afs_vnode *vnode)
1142e49c7b2fSDavid Howells {
1143e49c7b2fSDavid Howells 	op->file[n].vnode = vnode;
1144e49c7b2fSDavid Howells 	op->file[n].need_io_lock = true;
1145e49c7b2fSDavid Howells }
1146e49c7b2fSDavid Howells 
1147e49c7b2fSDavid Howells static inline void afs_op_set_fid(struct afs_operation *op, unsigned int n,
1148e49c7b2fSDavid Howells 				  const struct afs_fid *fid)
1149e49c7b2fSDavid Howells {
1150e49c7b2fSDavid Howells 	op->file[n].fid = *fid;
1151e49c7b2fSDavid Howells }
1152260f082bSDavid Howells 
115308e0e7c8SDavid Howells /*
11543bf0fb6fSDavid Howells  * fs_probe.c
11553bf0fb6fSDavid Howells  */
11563bf0fb6fSDavid Howells extern void afs_fileserver_probe_result(struct afs_call *);
1157f6cbb368SDavid Howells extern void afs_fs_probe_fileserver(struct afs_net *, struct afs_server *, struct key *, bool);
11583bf0fb6fSDavid Howells extern int afs_wait_for_fs_probes(struct afs_server_list *, unsigned long);
11598409f67bSDavid Howells extern void afs_probe_fileserver(struct afs_net *, struct afs_server *);
1160f6cbb368SDavid Howells extern void afs_fs_probe_dispatcher(struct work_struct *);
11618409f67bSDavid Howells extern int afs_wait_for_one_fs_probe(struct afs_server *, bool);
11625481fc6eSDavid Howells extern void afs_fs_probe_cleanup(struct afs_net *);
11633bf0fb6fSDavid Howells 
11643bf0fb6fSDavid Howells /*
11651da177e4SLinus Torvalds  * inode.c
11661da177e4SLinus Torvalds  */
1167b6489a49SDavid Howells extern const struct afs_operation_ops afs_fetch_status_operation;
1168b6489a49SDavid Howells 
1169e49c7b2fSDavid Howells extern void afs_vnode_commit_status(struct afs_operation *, struct afs_vnode_param *);
1170a58823acSDavid Howells extern int afs_fetch_status(struct afs_vnode *, struct key *, bool, afs_access_t *);
1171e49c7b2fSDavid Howells extern int afs_ilookup5_test_by_fid(struct inode *, void *);
11724d673da1SDavid Howells extern struct inode *afs_iget_pseudo_dir(struct super_block *, bool);
1173e49c7b2fSDavid Howells extern struct inode *afs_iget(struct afs_operation *, struct afs_vnode_param *);
1174e49c7b2fSDavid Howells extern struct inode *afs_root_iget(struct super_block *, struct key *);
1175c925bd0aSDavid Howells extern bool afs_check_validity(struct afs_vnode *);
1176260a9803SDavid Howells extern int afs_validate(struct afs_vnode *, struct key *);
1177549c7297SChristian Brauner extern int afs_getattr(struct user_namespace *mnt_userns, const struct path *,
1178549c7297SChristian Brauner 		       struct kstat *, u32, unsigned int);
1179549c7297SChristian Brauner extern int afs_setattr(struct user_namespace *mnt_userns, struct dentry *, struct iattr *);
1180b57922d9SAl Viro extern void afs_evict_inode(struct inode *);
1181bec5eb61Swanglei extern int afs_drop_inode(struct inode *);
11821da177e4SLinus Torvalds 
11831da177e4SLinus Torvalds /*
11841da177e4SLinus Torvalds  * main.c
11851da177e4SLinus Torvalds  */
11860ad53eeeSTejun Heo extern struct workqueue_struct *afs_wq;
11875b86d4ffSDavid Howells extern int afs_net_id;
11885b86d4ffSDavid Howells 
11895b86d4ffSDavid Howells static inline struct afs_net *afs_net(struct net *net)
11905b86d4ffSDavid Howells {
11915b86d4ffSDavid Howells 	return net_generic(net, afs_net_id);
11925b86d4ffSDavid Howells }
11935b86d4ffSDavid Howells 
11945b86d4ffSDavid Howells static inline struct afs_net *afs_sb2net(struct super_block *sb)
11955b86d4ffSDavid Howells {
11965b86d4ffSDavid Howells 	return afs_net(AFS_FS_S(sb)->net_ns);
11975b86d4ffSDavid Howells }
1198f044c884SDavid Howells 
1199f044c884SDavid Howells static inline struct afs_net *afs_d2net(struct dentry *dentry)
1200f044c884SDavid Howells {
12015b86d4ffSDavid Howells 	return afs_sb2net(dentry->d_sb);
1202f044c884SDavid Howells }
1203f044c884SDavid Howells 
1204f044c884SDavid Howells static inline struct afs_net *afs_i2net(struct inode *inode)
1205f044c884SDavid Howells {
12065b86d4ffSDavid Howells 	return afs_sb2net(inode->i_sb);
1207f044c884SDavid Howells }
1208f044c884SDavid Howells 
1209f044c884SDavid Howells static inline struct afs_net *afs_v2net(struct afs_vnode *vnode)
1210f044c884SDavid Howells {
12115b86d4ffSDavid Howells 	return afs_i2net(&vnode->vfs_inode);
1212f044c884SDavid Howells }
1213f044c884SDavid Howells 
1214f044c884SDavid Howells static inline struct afs_net *afs_sock2net(struct sock *sk)
1215f044c884SDavid Howells {
12165b86d4ffSDavid Howells 	return net_generic(sock_net(sk), afs_net_id);
1217f044c884SDavid Howells }
12181da177e4SLinus Torvalds 
1219d55b4da4SDavid Howells static inline void __afs_stat(atomic_t *s)
1220d55b4da4SDavid Howells {
1221d55b4da4SDavid Howells 	atomic_inc(s);
1222d55b4da4SDavid Howells }
1223d55b4da4SDavid Howells 
1224d55b4da4SDavid Howells #define afs_stat_v(vnode, n) __afs_stat(&afs_v2net(vnode)->n)
1225d55b4da4SDavid Howells 
12261da177e4SLinus Torvalds /*
122708e0e7c8SDavid Howells  * misc.c
122808e0e7c8SDavid Howells  */
122908e0e7c8SDavid Howells extern int afs_abort_to_error(u32);
12304584ae96SDavid Howells extern void afs_prioritise_error(struct afs_error *, int, u32);
123108e0e7c8SDavid Howells 
123208e0e7c8SDavid Howells /*
12331da177e4SLinus Torvalds  * mntpt.c
12341da177e4SLinus Torvalds  */
1235754661f1SArjan van de Ven extern const struct inode_operations afs_mntpt_inode_operations;
1236bec5eb61Swanglei extern const struct inode_operations afs_autocell_inode_operations;
12374b6f5d20SArjan van de Ven extern const struct file_operations afs_mntpt_file_operations;
12381da177e4SLinus Torvalds 
1239d18610b0SDavid Howells extern struct vfsmount *afs_d_automount(struct path *);
124008e0e7c8SDavid Howells extern void afs_mntpt_kill_timer(void);
12411da177e4SLinus Torvalds 
12421da177e4SLinus Torvalds /*
12431da177e4SLinus Torvalds  * proc.c
12441da177e4SLinus Torvalds  */
1245b6cfbecaSDavid Howells #ifdef CONFIG_PROC_FS
1246f044c884SDavid Howells extern int __net_init afs_proc_init(struct afs_net *);
1247f044c884SDavid Howells extern void __net_exit afs_proc_cleanup(struct afs_net *);
12485b86d4ffSDavid Howells extern int afs_proc_cell_setup(struct afs_cell *);
12495b86d4ffSDavid Howells extern void afs_proc_cell_remove(struct afs_cell *);
12506f8880d8SDavid Howells extern void afs_put_sysnames(struct afs_sysnames *);
1251b6cfbecaSDavid Howells #else
1252b6cfbecaSDavid Howells static inline int afs_proc_init(struct afs_net *net) { return 0; }
1253b6cfbecaSDavid Howells static inline void afs_proc_cleanup(struct afs_net *net) {}
1254b6cfbecaSDavid Howells static inline int afs_proc_cell_setup(struct afs_cell *cell) { return 0; }
1255b6cfbecaSDavid Howells static inline void afs_proc_cell_remove(struct afs_cell *cell) {}
1256b6cfbecaSDavid Howells static inline void afs_put_sysnames(struct afs_sysnames *sysnames) {}
1257b6cfbecaSDavid Howells #endif
12581da177e4SLinus Torvalds 
125908e0e7c8SDavid Howells /*
1260d2ddc776SDavid Howells  * rotate.c
1261d2ddc776SDavid Howells  */
1262a310082fSDavid Howells extern bool afs_select_fileserver(struct afs_operation *);
1263e49c7b2fSDavid Howells extern void afs_dump_edestaddrreq(const struct afs_operation *);
1264d2ddc776SDavid Howells 
1265d2ddc776SDavid Howells /*
126608e0e7c8SDavid Howells  * rxrpc.c
126708e0e7c8SDavid Howells  */
1268f044c884SDavid Howells extern struct workqueue_struct *afs_async_calls;
12698324f0bcSDavid Howells 
1270f044c884SDavid Howells extern int __net_init afs_open_socket(struct afs_net *);
1271f044c884SDavid Howells extern void __net_exit afs_close_socket(struct afs_net *);
1272f044c884SDavid Howells extern void afs_charge_preallocation(struct work_struct *);
1273341f741fSDavid Howells extern void afs_put_call(struct afs_call *);
12740b9bf381SDavid Howells extern void afs_make_call(struct afs_addr_cursor *, struct afs_call *, gfp_t);
12750b9bf381SDavid Howells extern long afs_wait_for_call_to_complete(struct afs_call *, struct afs_addr_cursor *);
1276f044c884SDavid Howells extern struct afs_call *afs_alloc_flat_call(struct afs_net *,
1277f044c884SDavid Howells 					    const struct afs_call_type *,
127808e0e7c8SDavid Howells 					    size_t, size_t);
127908e0e7c8SDavid Howells extern void afs_flat_call_destructor(struct afs_call *);
128008e0e7c8SDavid Howells extern void afs_send_empty_reply(struct afs_call *);
1281b908fe6bSDavid Howells extern void afs_send_simple_reply(struct afs_call *, const void *, size_t);
128212bdcf33SDavid Howells extern int afs_extract_data(struct afs_call *, bool);
12837126ead9SDavid Howells extern int afs_protocol_error(struct afs_call *, enum afs_eproto_cause);
128408e0e7c8SDavid Howells 
1285e49c7b2fSDavid Howells static inline void afs_make_op_call(struct afs_operation *op, struct afs_call *call,
1286e49c7b2fSDavid Howells 				    gfp_t gfp)
128720b8391fSDavid Howells {
1288e49c7b2fSDavid Howells 	op->call = call;
1289a310082fSDavid Howells 	op->type = call->type;
1290e49c7b2fSDavid Howells 	call->op = op;
1291e49c7b2fSDavid Howells 	call->key = op->key;
1292e49c7b2fSDavid Howells 	call->intr = !(op->flags & AFS_OPERATION_UNINTR);
1293e49c7b2fSDavid Howells 	afs_make_call(&op->ac, call, gfp);
129420b8391fSDavid Howells }
129520b8391fSDavid Howells 
129612bdcf33SDavid Howells static inline void afs_extract_begin(struct afs_call *call, void *buf, size_t size)
129712bdcf33SDavid Howells {
1298f105da1aSDavid Howells 	call->iov_len = size;
129912bdcf33SDavid Howells 	call->kvec[0].iov_base = buf;
130012bdcf33SDavid Howells 	call->kvec[0].iov_len = size;
1301fc276122SDavid Howells 	iov_iter_kvec(&call->def_iter, READ, call->kvec, 1, size);
130212bdcf33SDavid Howells }
130312bdcf33SDavid Howells 
130412bdcf33SDavid Howells static inline void afs_extract_to_tmp(struct afs_call *call)
130512bdcf33SDavid Howells {
1306f105da1aSDavid Howells 	call->iov_len = sizeof(call->tmp);
130712bdcf33SDavid Howells 	afs_extract_begin(call, &call->tmp, sizeof(call->tmp));
130812bdcf33SDavid Howells }
130912bdcf33SDavid Howells 
131012bdcf33SDavid Howells static inline void afs_extract_to_tmp64(struct afs_call *call)
131112bdcf33SDavid Howells {
1312f105da1aSDavid Howells 	call->iov_len = sizeof(call->tmp64);
131312bdcf33SDavid Howells 	afs_extract_begin(call, &call->tmp64, sizeof(call->tmp64));
131412bdcf33SDavid Howells }
131512bdcf33SDavid Howells 
131612bdcf33SDavid Howells static inline void afs_extract_discard(struct afs_call *call, size_t size)
131712bdcf33SDavid Howells {
1318f105da1aSDavid Howells 	call->iov_len = size;
1319fc276122SDavid Howells 	iov_iter_discard(&call->def_iter, READ, size);
132012bdcf33SDavid Howells }
132112bdcf33SDavid Howells 
132212bdcf33SDavid Howells static inline void afs_extract_to_buf(struct afs_call *call, size_t size)
132312bdcf33SDavid Howells {
1324f105da1aSDavid Howells 	call->iov_len = size;
132512bdcf33SDavid Howells 	afs_extract_begin(call, call->buffer, size);
132612bdcf33SDavid Howells }
132712bdcf33SDavid Howells 
1328d001648eSDavid Howells static inline int afs_transfer_reply(struct afs_call *call)
1329372ee163SDavid Howells {
133012bdcf33SDavid Howells 	return afs_extract_data(call, false);
1331372ee163SDavid Howells }
1332372ee163SDavid Howells 
133398bf40cdSDavid Howells static inline bool afs_check_call_state(struct afs_call *call,
133498bf40cdSDavid Howells 					enum afs_call_state state)
133598bf40cdSDavid Howells {
133698bf40cdSDavid Howells 	return READ_ONCE(call->state) == state;
133798bf40cdSDavid Howells }
133898bf40cdSDavid Howells 
133998bf40cdSDavid Howells static inline bool afs_set_call_state(struct afs_call *call,
134098bf40cdSDavid Howells 				      enum afs_call_state from,
134198bf40cdSDavid Howells 				      enum afs_call_state to)
134298bf40cdSDavid Howells {
134398bf40cdSDavid Howells 	bool ok = false;
134498bf40cdSDavid Howells 
134598bf40cdSDavid Howells 	spin_lock_bh(&call->state_lock);
134698bf40cdSDavid Howells 	if (call->state == from) {
134798bf40cdSDavid Howells 		call->state = to;
134898bf40cdSDavid Howells 		trace_afs_call_state(call, from, to, 0, 0);
134998bf40cdSDavid Howells 		ok = true;
135098bf40cdSDavid Howells 	}
135198bf40cdSDavid Howells 	spin_unlock_bh(&call->state_lock);
135298bf40cdSDavid Howells 	return ok;
135398bf40cdSDavid Howells }
135498bf40cdSDavid Howells 
135598bf40cdSDavid Howells static inline void afs_set_call_complete(struct afs_call *call,
135698bf40cdSDavid Howells 					 int error, u32 remote_abort)
135798bf40cdSDavid Howells {
135898bf40cdSDavid Howells 	enum afs_call_state state;
135998bf40cdSDavid Howells 	bool ok = false;
136098bf40cdSDavid Howells 
136198bf40cdSDavid Howells 	spin_lock_bh(&call->state_lock);
136298bf40cdSDavid Howells 	state = call->state;
136398bf40cdSDavid Howells 	if (state != AFS_CALL_COMPLETE) {
136498bf40cdSDavid Howells 		call->abort_code = remote_abort;
136598bf40cdSDavid Howells 		call->error = error;
136698bf40cdSDavid Howells 		call->state = AFS_CALL_COMPLETE;
136798bf40cdSDavid Howells 		trace_afs_call_state(call, state, AFS_CALL_COMPLETE,
136898bf40cdSDavid Howells 				     error, remote_abort);
136998bf40cdSDavid Howells 		ok = true;
137098bf40cdSDavid Howells 	}
137198bf40cdSDavid Howells 	spin_unlock_bh(&call->state_lock);
1372dde9f095SDavid Howells 	if (ok) {
137398bf40cdSDavid Howells 		trace_afs_call_done(call);
1374dde9f095SDavid Howells 
1375dde9f095SDavid Howells 		/* Asynchronous calls have two refs to release - one from the alloc and
1376dde9f095SDavid Howells 		 * one queued with the work item - and we can't just deallocate the
1377dde9f095SDavid Howells 		 * call because the work item may be queued again.
1378dde9f095SDavid Howells 		 */
1379dde9f095SDavid Howells 		if (call->drop_ref)
1380dde9f095SDavid Howells 			afs_put_call(call);
1381dde9f095SDavid Howells 	}
138298bf40cdSDavid Howells }
138398bf40cdSDavid Howells 
138408e0e7c8SDavid Howells /*
138500d3b7a4SDavid Howells  * security.c
138600d3b7a4SDavid Howells  */
1387be080a6fSDavid Howells extern void afs_put_permits(struct afs_permits *);
138800d3b7a4SDavid Howells extern void afs_clear_permits(struct afs_vnode *);
1389a58823acSDavid Howells extern void afs_cache_permit(struct afs_vnode *, struct key *, unsigned int,
1390a58823acSDavid Howells 			     struct afs_status_cb *);
1391416351f2SDavid Howells extern void afs_zap_permits(struct rcu_head *);
139200d3b7a4SDavid Howells extern struct key *afs_request_key(struct afs_cell *);
13938b6a666aSDavid Howells extern struct key *afs_request_key_rcu(struct afs_cell *);
13940fafdc9fSDavid Howells extern int afs_check_permit(struct afs_vnode *, struct key *, afs_access_t *);
1395549c7297SChristian Brauner extern int afs_permission(struct user_namespace *, struct inode *, int);
1396be080a6fSDavid Howells extern void __exit afs_clean_up_permit_cache(void);
139700d3b7a4SDavid Howells 
139800d3b7a4SDavid Howells /*
139908e0e7c8SDavid Howells  * server.c
140008e0e7c8SDavid Howells  */
140108e0e7c8SDavid Howells extern spinlock_t afs_server_peer_lock;
140208e0e7c8SDavid Howells 
1403f044c884SDavid Howells extern struct afs_server *afs_find_server(struct afs_net *,
1404f044c884SDavid Howells 					  const struct sockaddr_rxrpc *);
1405d2ddc776SDavid Howells extern struct afs_server *afs_find_server_by_uuid(struct afs_net *, const uuid_t *);
140681006805SDavid Howells extern struct afs_server *afs_lookup_server(struct afs_cell *, struct key *, const uuid_t *, u32);
140745218193SDavid Howells extern struct afs_server *afs_get_server(struct afs_server *, enum afs_server_trace);
1408977e5f8eSDavid Howells extern struct afs_server *afs_use_server(struct afs_server *, enum afs_server_trace);
1409977e5f8eSDavid Howells extern void afs_unuse_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1410977e5f8eSDavid Howells extern void afs_unuse_server_notime(struct afs_net *, struct afs_server *, enum afs_server_trace);
141145218193SDavid Howells extern void afs_put_server(struct afs_net *, struct afs_server *, enum afs_server_trace);
1412d2ddc776SDavid Howells extern void afs_manage_servers(struct work_struct *);
1413d2ddc776SDavid Howells extern void afs_servers_timer(struct timer_list *);
1414f6cbb368SDavid Howells extern void afs_fs_probe_timer(struct timer_list *);
1415f044c884SDavid Howells extern void __net_exit afs_purge_servers(struct afs_net *);
1416a310082fSDavid Howells extern bool afs_check_server_record(struct afs_operation *, struct afs_server *);
1417d2ddc776SDavid Howells 
1418f6cbb368SDavid Howells static inline void afs_inc_servers_outstanding(struct afs_net *net)
1419f6cbb368SDavid Howells {
1420f6cbb368SDavid Howells 	atomic_inc(&net->servers_outstanding);
1421f6cbb368SDavid Howells }
1422f6cbb368SDavid Howells 
1423f6cbb368SDavid Howells static inline void afs_dec_servers_outstanding(struct afs_net *net)
1424f6cbb368SDavid Howells {
1425f6cbb368SDavid Howells 	if (atomic_dec_and_test(&net->servers_outstanding))
1426f6cbb368SDavid Howells 		wake_up_var(&net->servers_outstanding);
1427f6cbb368SDavid Howells }
1428f6cbb368SDavid Howells 
1429f6cbb368SDavid Howells static inline bool afs_is_probing_server(struct afs_server *server)
1430f6cbb368SDavid Howells {
1431f6cbb368SDavid Howells 	return list_empty(&server->probe_link);
1432f6cbb368SDavid Howells }
1433f6cbb368SDavid Howells 
1434d2ddc776SDavid Howells /*
1435d2ddc776SDavid Howells  * server_list.c
1436d2ddc776SDavid Howells  */
1437d2ddc776SDavid Howells static inline struct afs_server_list *afs_get_serverlist(struct afs_server_list *slist)
1438d2ddc776SDavid Howells {
1439d2ddc776SDavid Howells 	refcount_inc(&slist->usage);
1440d2ddc776SDavid Howells 	return slist;
1441d2ddc776SDavid Howells }
1442d2ddc776SDavid Howells 
1443d2ddc776SDavid Howells extern void afs_put_serverlist(struct afs_net *, struct afs_server_list *);
1444d2ddc776SDavid Howells extern struct afs_server_list *afs_alloc_server_list(struct afs_cell *, struct key *,
1445d2ddc776SDavid Howells 						     struct afs_vldb_entry *,
1446d2ddc776SDavid Howells 						     u8);
1447d2ddc776SDavid Howells extern bool afs_annotate_server_list(struct afs_server_list *, struct afs_server_list *);
144808e0e7c8SDavid Howells 
144908e0e7c8SDavid Howells /*
145000d3b7a4SDavid Howells  * super.c
145100d3b7a4SDavid Howells  */
1452f044c884SDavid Howells extern int __init afs_fs_init(void);
14535b86d4ffSDavid Howells extern void afs_fs_exit(void);
145400d3b7a4SDavid Howells 
145500d3b7a4SDavid Howells /*
145608e0e7c8SDavid Howells  * vlclient.c
145708e0e7c8SDavid Howells  */
14580a5143f2SDavid Howells extern struct afs_vldb_entry *afs_vl_get_entry_by_name_u(struct afs_vl_cursor *,
14590a5143f2SDavid Howells 							 const char *, int);
14600a5143f2SDavid Howells extern struct afs_addr_list *afs_vl_get_addrs_u(struct afs_vl_cursor *, const uuid_t *);
14610b9bf381SDavid Howells extern struct afs_call *afs_vl_get_capabilities(struct afs_net *, struct afs_addr_cursor *,
14620b9bf381SDavid Howells 						struct key *, struct afs_vlserver *, unsigned int);
14630a5143f2SDavid Howells extern struct afs_addr_list *afs_yfsvl_get_endpoints(struct afs_vl_cursor *, const uuid_t *);
1464c3e9f888SDavid Howells extern char *afs_yfsvl_get_cell_name(struct afs_vl_cursor *);
14650a5143f2SDavid Howells 
14660a5143f2SDavid Howells /*
14678a070a96SDavid Howells  * vl_alias.c
14688a070a96SDavid Howells  */
14698a070a96SDavid Howells extern int afs_cell_detect_alias(struct afs_cell *, struct key *);
14708a070a96SDavid Howells 
14718a070a96SDavid Howells /*
14723bf0fb6fSDavid Howells  * vl_probe.c
14733bf0fb6fSDavid Howells  */
14743bf0fb6fSDavid Howells extern void afs_vlserver_probe_result(struct afs_call *);
14753bf0fb6fSDavid Howells extern int afs_send_vl_probes(struct afs_net *, struct key *, struct afs_vlserver_list *);
14763bf0fb6fSDavid Howells extern int afs_wait_for_vl_probes(struct afs_vlserver_list *, unsigned long);
14773bf0fb6fSDavid Howells 
14783bf0fb6fSDavid Howells /*
14790a5143f2SDavid Howells  * vl_rotate.c
14800a5143f2SDavid Howells  */
14810a5143f2SDavid Howells extern bool afs_begin_vlserver_operation(struct afs_vl_cursor *,
14820a5143f2SDavid Howells 					 struct afs_cell *, struct key *);
14830a5143f2SDavid Howells extern bool afs_select_vlserver(struct afs_vl_cursor *);
14840a5143f2SDavid Howells extern bool afs_select_current_vlserver(struct afs_vl_cursor *);
14850a5143f2SDavid Howells extern int afs_end_vlserver_operation(struct afs_vl_cursor *);
14860a5143f2SDavid Howells 
14870a5143f2SDavid Howells /*
14880a5143f2SDavid Howells  * vlserver_list.c
14890a5143f2SDavid Howells  */
14900a5143f2SDavid Howells static inline struct afs_vlserver *afs_get_vlserver(struct afs_vlserver *vlserver)
14910a5143f2SDavid Howells {
14920a5143f2SDavid Howells 	atomic_inc(&vlserver->usage);
14930a5143f2SDavid Howells 	return vlserver;
14940a5143f2SDavid Howells }
14950a5143f2SDavid Howells 
14960a5143f2SDavid Howells static inline struct afs_vlserver_list *afs_get_vlserverlist(struct afs_vlserver_list *vllist)
14970a5143f2SDavid Howells {
14980a5143f2SDavid Howells 	if (vllist)
14990a5143f2SDavid Howells 		atomic_inc(&vllist->usage);
15000a5143f2SDavid Howells 	return vllist;
15010a5143f2SDavid Howells }
15020a5143f2SDavid Howells 
15030a5143f2SDavid Howells extern struct afs_vlserver *afs_alloc_vlserver(const char *, size_t, unsigned short);
15040a5143f2SDavid Howells extern void afs_put_vlserver(struct afs_net *, struct afs_vlserver *);
15050a5143f2SDavid Howells extern struct afs_vlserver_list *afs_alloc_vlserver_list(unsigned int);
15060a5143f2SDavid Howells extern void afs_put_vlserverlist(struct afs_net *, struct afs_vlserver_list *);
15070a5143f2SDavid Howells extern struct afs_vlserver_list *afs_extract_vlserver_list(struct afs_cell *,
15080a5143f2SDavid Howells 							   const void *, size_t);
150908e0e7c8SDavid Howells 
151008e0e7c8SDavid Howells /*
151108e0e7c8SDavid Howells  * volume.c
151208e0e7c8SDavid Howells  */
151313fcc683SDavid Howells extern struct afs_volume *afs_create_volume(struct afs_fs_context *);
1514523d27cdSDavid Howells extern int afs_activate_volume(struct afs_volume *);
1515d2ddc776SDavid Howells extern void afs_deactivate_volume(struct afs_volume *);
1516cca37d45SDavid Howells extern struct afs_volume *afs_get_volume(struct afs_volume *, enum afs_volume_trace);
1517cca37d45SDavid Howells extern void afs_put_volume(struct afs_net *, struct afs_volume *, enum afs_volume_trace);
1518a310082fSDavid Howells extern int afs_check_volume_status(struct afs_volume *, struct afs_operation *);
151908e0e7c8SDavid Howells 
152031143d5dSDavid Howells /*
152131143d5dSDavid Howells  * write.c
152231143d5dSDavid Howells  */
1523c7f75ef3SDavid Howells #ifdef CONFIG_AFS_FSCACHE
152431143d5dSDavid Howells extern int afs_set_page_dirty(struct page *);
1525c7f75ef3SDavid Howells #else
1526c7f75ef3SDavid Howells #define afs_set_page_dirty __set_page_dirty_nobuffers
1527c7f75ef3SDavid Howells #endif
152815b4650eSNick Piggin extern int afs_write_begin(struct file *file, struct address_space *mapping,
152915b4650eSNick Piggin 			loff_t pos, unsigned len, unsigned flags,
153015b4650eSNick Piggin 			struct page **pagep, void **fsdata);
153115b4650eSNick Piggin extern int afs_write_end(struct file *file, struct address_space *mapping,
153215b4650eSNick Piggin 			loff_t pos, unsigned len, unsigned copied,
153315b4650eSNick Piggin 			struct page *page, void *fsdata);
153431143d5dSDavid Howells extern int afs_writepage(struct page *, struct writeback_control *);
153531143d5dSDavid Howells extern int afs_writepages(struct address_space *, struct writeback_control *);
153650b5551dSAl Viro extern ssize_t afs_file_write(struct kiocb *, struct iov_iter *);
153702c24a82SJosef Bacik extern int afs_fsync(struct file *, loff_t, loff_t, int);
15380722f186SSouptick Joarder extern vm_fault_t afs_page_mkwrite(struct vm_fault *vmf);
15394343d008SDavid Howells extern void afs_prune_wb_keys(struct afs_vnode *);
1540*a42442ddSMatthew Wilcox (Oracle) int afs_launder_folio(struct folio *);
154131143d5dSDavid Howells 
1542d3e3b7eaSDavid Howells /*
1543d3e3b7eaSDavid Howells  * xattr.c
1544d3e3b7eaSDavid Howells  */
1545d3e3b7eaSDavid Howells extern const struct xattr_handler *afs_xattr_handlers[];
154631143d5dSDavid Howells 
154730062bd1SDavid Howells /*
154830062bd1SDavid Howells  * yfsclient.c
154930062bd1SDavid Howells  */
1550e49c7b2fSDavid Howells extern void yfs_fs_fetch_data(struct afs_operation *);
1551e49c7b2fSDavid Howells extern void yfs_fs_create_file(struct afs_operation *);
1552e49c7b2fSDavid Howells extern void yfs_fs_make_dir(struct afs_operation *);
1553e49c7b2fSDavid Howells extern void yfs_fs_remove_file2(struct afs_operation *);
1554e49c7b2fSDavid Howells extern void yfs_fs_remove_file(struct afs_operation *);
1555e49c7b2fSDavid Howells extern void yfs_fs_remove_dir(struct afs_operation *);
1556e49c7b2fSDavid Howells extern void yfs_fs_link(struct afs_operation *);
1557e49c7b2fSDavid Howells extern void yfs_fs_symlink(struct afs_operation *);
1558e49c7b2fSDavid Howells extern void yfs_fs_rename(struct afs_operation *);
1559e49c7b2fSDavid Howells extern void yfs_fs_store_data(struct afs_operation *);
1560e49c7b2fSDavid Howells extern void yfs_fs_setattr(struct afs_operation *);
1561e49c7b2fSDavid Howells extern void yfs_fs_get_volume_status(struct afs_operation *);
1562e49c7b2fSDavid Howells extern void yfs_fs_set_lock(struct afs_operation *);
1563e49c7b2fSDavid Howells extern void yfs_fs_extend_lock(struct afs_operation *);
1564e49c7b2fSDavid Howells extern void yfs_fs_release_lock(struct afs_operation *);
1565e49c7b2fSDavid Howells extern void yfs_fs_fetch_status(struct afs_operation *);
1566e49c7b2fSDavid Howells extern void yfs_fs_inline_bulk_status(struct afs_operation *);
1567d2ddc776SDavid Howells 
1568ae46578bSDavid Howells struct yfs_acl {
1569ae46578bSDavid Howells 	struct afs_acl	*acl;		/* Dir/file/symlink ACL */
1570ae46578bSDavid Howells 	struct afs_acl	*vol_acl;	/* Whole volume ACL */
1571ae46578bSDavid Howells 	u32		inherit_flag;	/* True if ACL is inherited from parent dir */
1572ae46578bSDavid Howells 	u32		num_cleaned;	/* Number of ACEs removed due to subject removal */
1573ae46578bSDavid Howells 	unsigned int	flags;
1574ae46578bSDavid Howells #define YFS_ACL_WANT_ACL	0x01	/* Set if caller wants ->acl */
1575ae46578bSDavid Howells #define YFS_ACL_WANT_VOL_ACL	0x02	/* Set if caller wants ->vol_acl */
1576ae46578bSDavid Howells };
1577ae46578bSDavid Howells 
1578ae46578bSDavid Howells extern void yfs_free_opaque_acl(struct yfs_acl *);
1579e49c7b2fSDavid Howells extern void yfs_fs_fetch_opaque_acl(struct afs_operation *);
1580e49c7b2fSDavid Howells extern void yfs_fs_store_opaque_acl2(struct afs_operation *);
1581ae46578bSDavid Howells 
1582d2ddc776SDavid Howells /*
1583d2ddc776SDavid Howells  * Miscellaneous inline functions.
1584d2ddc776SDavid Howells  */
1585d2ddc776SDavid Howells static inline struct afs_vnode *AFS_FS_I(struct inode *inode)
1586d2ddc776SDavid Howells {
1587d2ddc776SDavid Howells 	return container_of(inode, struct afs_vnode, vfs_inode);
1588d2ddc776SDavid Howells }
1589d2ddc776SDavid Howells 
1590d2ddc776SDavid Howells static inline struct inode *AFS_VNODE_TO_I(struct afs_vnode *vnode)
1591d2ddc776SDavid Howells {
1592d2ddc776SDavid Howells 	return &vnode->vfs_inode;
1593d2ddc776SDavid Howells }
1594d2ddc776SDavid Howells 
1595e49c7b2fSDavid Howells /*
1596e49c7b2fSDavid Howells  * Note that a dentry got changed.  We need to set d_fsdata to the data version
1597e49c7b2fSDavid Howells  * number derived from the result of the operation.  It doesn't matter if
1598e49c7b2fSDavid Howells  * d_fsdata goes backwards as we'll just revalidate.
1599e49c7b2fSDavid Howells  */
1600e49c7b2fSDavid Howells static inline void afs_update_dentry_version(struct afs_operation *op,
1601e49c7b2fSDavid Howells 					     struct afs_vnode_param *dir_vp,
1602e49c7b2fSDavid Howells 					     struct dentry *dentry)
1603e49c7b2fSDavid Howells {
1604e49c7b2fSDavid Howells 	if (!op->error)
1605e49c7b2fSDavid Howells 		dentry->d_fsdata =
1606e49c7b2fSDavid Howells 			(void *)(unsigned long)dir_vp->scb.status.data_version;
1607e49c7b2fSDavid Howells }
1608e49c7b2fSDavid Howells 
1609b6489a49SDavid Howells /*
16109d37e1caSDavid Howells  * Set the file size and block count.  Estimate the number of 512 bytes blocks
16119d37e1caSDavid Howells  * used, rounded up to nearest 1K for consistency with other AFS clients.
16129d37e1caSDavid Howells  */
16139d37e1caSDavid Howells static inline void afs_set_i_size(struct afs_vnode *vnode, u64 size)
16149d37e1caSDavid Howells {
16159d37e1caSDavid Howells 	i_size_write(&vnode->vfs_inode, size);
16169d37e1caSDavid Howells 	vnode->vfs_inode.i_blocks = ((size + 1023) >> 10) << 1;
16179d37e1caSDavid Howells }
16189d37e1caSDavid Howells 
16199d37e1caSDavid Howells /*
1620b6489a49SDavid Howells  * Check for a conflicting operation on a directory that we just unlinked from.
1621b6489a49SDavid Howells  * If someone managed to sneak a link or an unlink in on the file we just
1622b6489a49SDavid Howells  * unlinked, we won't be able to trust nlink on an AFS file (but not YFS).
1623b6489a49SDavid Howells  */
1624b6489a49SDavid Howells static inline void afs_check_dir_conflict(struct afs_operation *op,
1625b6489a49SDavid Howells 					  struct afs_vnode_param *dvp)
1626b6489a49SDavid Howells {
1627b6489a49SDavid Howells 	if (dvp->dv_before + dvp->dv_delta != dvp->scb.status.data_version)
1628b6489a49SDavid Howells 		op->flags |= AFS_OPERATION_DIR_CONFLICT;
1629b6489a49SDavid Howells }
1630b6489a49SDavid Howells 
1631f51375cdSDavid Howells static inline int afs_io_error(struct afs_call *call, enum afs_io_error where)
1632f51375cdSDavid Howells {
1633f51375cdSDavid Howells 	trace_afs_io_error(call->debug_id, -EIO, where);
1634f51375cdSDavid Howells 	return -EIO;
1635f51375cdSDavid Howells }
1636f51375cdSDavid Howells 
1637f51375cdSDavid Howells static inline int afs_bad(struct afs_vnode *vnode, enum afs_file_error where)
1638f51375cdSDavid Howells {
1639f51375cdSDavid Howells 	trace_afs_file_error(vnode, -EIO, where);
1640f51375cdSDavid Howells 	return -EIO;
1641f51375cdSDavid Howells }
1642d2ddc776SDavid Howells 
164308e0e7c8SDavid Howells /*****************************************************************************/
164408e0e7c8SDavid Howells /*
164508e0e7c8SDavid Howells  * debug tracing
164608e0e7c8SDavid Howells  */
164708e0e7c8SDavid Howells extern unsigned afs_debug;
164808e0e7c8SDavid Howells 
164908e0e7c8SDavid Howells #define dbgprintk(FMT,...) \
1650ad16df84SSven Schnelle 	printk("[%-6.6s] "FMT"\n", current->comm ,##__VA_ARGS__)
165108e0e7c8SDavid Howells 
1652530b6412SHarvey Harrison #define kenter(FMT,...)	dbgprintk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
1653530b6412SHarvey Harrison #define kleave(FMT,...)	dbgprintk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
165408e0e7c8SDavid Howells #define kdebug(FMT,...)	dbgprintk("    "FMT ,##__VA_ARGS__)
165508e0e7c8SDavid Howells 
165608e0e7c8SDavid Howells 
165708e0e7c8SDavid Howells #if defined(__KDEBUG)
165808e0e7c8SDavid Howells #define _enter(FMT,...)	kenter(FMT,##__VA_ARGS__)
165908e0e7c8SDavid Howells #define _leave(FMT,...)	kleave(FMT,##__VA_ARGS__)
166008e0e7c8SDavid Howells #define _debug(FMT,...)	kdebug(FMT,##__VA_ARGS__)
166108e0e7c8SDavid Howells 
166208e0e7c8SDavid Howells #elif defined(CONFIG_AFS_DEBUG)
166308e0e7c8SDavid Howells #define AFS_DEBUG_KENTER	0x01
166408e0e7c8SDavid Howells #define AFS_DEBUG_KLEAVE	0x02
166508e0e7c8SDavid Howells #define AFS_DEBUG_KDEBUG	0x04
166608e0e7c8SDavid Howells 
166708e0e7c8SDavid Howells #define _enter(FMT,...)					\
166808e0e7c8SDavid Howells do {							\
166908e0e7c8SDavid Howells 	if (unlikely(afs_debug & AFS_DEBUG_KENTER))	\
167008e0e7c8SDavid Howells 		kenter(FMT,##__VA_ARGS__);		\
167108e0e7c8SDavid Howells } while (0)
167208e0e7c8SDavid Howells 
167308e0e7c8SDavid Howells #define _leave(FMT,...)					\
167408e0e7c8SDavid Howells do {							\
167508e0e7c8SDavid Howells 	if (unlikely(afs_debug & AFS_DEBUG_KLEAVE))	\
167608e0e7c8SDavid Howells 		kleave(FMT,##__VA_ARGS__);		\
167708e0e7c8SDavid Howells } while (0)
167808e0e7c8SDavid Howells 
167908e0e7c8SDavid Howells #define _debug(FMT,...)					\
168008e0e7c8SDavid Howells do {							\
168108e0e7c8SDavid Howells 	if (unlikely(afs_debug & AFS_DEBUG_KDEBUG))	\
168208e0e7c8SDavid Howells 		kdebug(FMT,##__VA_ARGS__);		\
168308e0e7c8SDavid Howells } while (0)
168408e0e7c8SDavid Howells 
168508e0e7c8SDavid Howells #else
168612fdff3fSDavid Howells #define _enter(FMT,...)	no_printk("==> %s("FMT")",__func__ ,##__VA_ARGS__)
168712fdff3fSDavid Howells #define _leave(FMT,...)	no_printk("<== %s()"FMT"",__func__ ,##__VA_ARGS__)
168812fdff3fSDavid Howells #define _debug(FMT,...)	no_printk("    "FMT ,##__VA_ARGS__)
168908e0e7c8SDavid Howells #endif
169008e0e7c8SDavid Howells 
169108e0e7c8SDavid Howells /*
169208e0e7c8SDavid Howells  * debug assertion checking
169308e0e7c8SDavid Howells  */
169408e0e7c8SDavid Howells #if 1 // defined(__KDEBUGALL)
169508e0e7c8SDavid Howells 
169608e0e7c8SDavid Howells #define ASSERT(X)						\
169708e0e7c8SDavid Howells do {								\
169808e0e7c8SDavid Howells 	if (unlikely(!(X))) {					\
169908e0e7c8SDavid Howells 		printk(KERN_ERR "\n");				\
170008e0e7c8SDavid Howells 		printk(KERN_ERR "AFS: Assertion failed\n");	\
170108e0e7c8SDavid Howells 		BUG();						\
170208e0e7c8SDavid Howells 	}							\
170308e0e7c8SDavid Howells } while(0)
170408e0e7c8SDavid Howells 
170508e0e7c8SDavid Howells #define ASSERTCMP(X, OP, Y)						\
170608e0e7c8SDavid Howells do {									\
170708e0e7c8SDavid Howells 	if (unlikely(!((X) OP (Y)))) {					\
170808e0e7c8SDavid Howells 		printk(KERN_ERR "\n");					\
170908e0e7c8SDavid Howells 		printk(KERN_ERR "AFS: Assertion failed\n");		\
171008e0e7c8SDavid Howells 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
171108e0e7c8SDavid Howells 		       (unsigned long)(X), (unsigned long)(Y));		\
171208e0e7c8SDavid Howells 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
171308e0e7c8SDavid Howells 		       (unsigned long)(X), (unsigned long)(Y));		\
171408e0e7c8SDavid Howells 		BUG();							\
171508e0e7c8SDavid Howells 	}								\
171608e0e7c8SDavid Howells } while(0)
171708e0e7c8SDavid Howells 
1718416351f2SDavid Howells #define ASSERTRANGE(L, OP1, N, OP2, H)					\
1719416351f2SDavid Howells do {									\
1720416351f2SDavid Howells 	if (unlikely(!((L) OP1 (N)) || !((N) OP2 (H)))) {		\
1721416351f2SDavid Howells 		printk(KERN_ERR "\n");					\
1722416351f2SDavid Howells 		printk(KERN_ERR "AFS: Assertion failed\n");		\
1723416351f2SDavid Howells 		printk(KERN_ERR "%lu "#OP1" %lu "#OP2" %lu is false\n",	\
1724416351f2SDavid Howells 		       (unsigned long)(L), (unsigned long)(N),		\
1725416351f2SDavid Howells 		       (unsigned long)(H));				\
1726416351f2SDavid Howells 		printk(KERN_ERR "0x%lx "#OP1" 0x%lx "#OP2" 0x%lx is false\n", \
1727416351f2SDavid Howells 		       (unsigned long)(L), (unsigned long)(N),		\
1728416351f2SDavid Howells 		       (unsigned long)(H));				\
1729416351f2SDavid Howells 		BUG();							\
1730416351f2SDavid Howells 	}								\
1731416351f2SDavid Howells } while(0)
1732416351f2SDavid Howells 
173308e0e7c8SDavid Howells #define ASSERTIF(C, X)						\
173408e0e7c8SDavid Howells do {								\
173508e0e7c8SDavid Howells 	if (unlikely((C) && !(X))) {				\
173608e0e7c8SDavid Howells 		printk(KERN_ERR "\n");				\
173708e0e7c8SDavid Howells 		printk(KERN_ERR "AFS: Assertion failed\n");	\
173808e0e7c8SDavid Howells 		BUG();						\
173908e0e7c8SDavid Howells 	}							\
174008e0e7c8SDavid Howells } while(0)
174108e0e7c8SDavid Howells 
174208e0e7c8SDavid Howells #define ASSERTIFCMP(C, X, OP, Y)					\
174308e0e7c8SDavid Howells do {									\
174408e0e7c8SDavid Howells 	if (unlikely((C) && !((X) OP (Y)))) {				\
174508e0e7c8SDavid Howells 		printk(KERN_ERR "\n");					\
174608e0e7c8SDavid Howells 		printk(KERN_ERR "AFS: Assertion failed\n");		\
174708e0e7c8SDavid Howells 		printk(KERN_ERR "%lu " #OP " %lu is false\n",		\
174808e0e7c8SDavid Howells 		       (unsigned long)(X), (unsigned long)(Y));		\
174908e0e7c8SDavid Howells 		printk(KERN_ERR "0x%lx " #OP " 0x%lx is false\n",	\
175008e0e7c8SDavid Howells 		       (unsigned long)(X), (unsigned long)(Y));		\
175108e0e7c8SDavid Howells 		BUG();							\
175208e0e7c8SDavid Howells 	}								\
175308e0e7c8SDavid Howells } while(0)
175408e0e7c8SDavid Howells 
175508e0e7c8SDavid Howells #else
175608e0e7c8SDavid Howells 
175708e0e7c8SDavid Howells #define ASSERT(X)				\
175808e0e7c8SDavid Howells do {						\
175908e0e7c8SDavid Howells } while(0)
176008e0e7c8SDavid Howells 
176108e0e7c8SDavid Howells #define ASSERTCMP(X, OP, Y)			\
176208e0e7c8SDavid Howells do {						\
176308e0e7c8SDavid Howells } while(0)
176408e0e7c8SDavid Howells 
1765416351f2SDavid Howells #define ASSERTRANGE(L, OP1, N, OP2, H)		\
1766416351f2SDavid Howells do {						\
1767416351f2SDavid Howells } while(0)
1768416351f2SDavid Howells 
176908e0e7c8SDavid Howells #define ASSERTIF(C, X)				\
177008e0e7c8SDavid Howells do {						\
177108e0e7c8SDavid Howells } while(0)
177208e0e7c8SDavid Howells 
177308e0e7c8SDavid Howells #define ASSERTIFCMP(C, X, OP, Y)		\
177408e0e7c8SDavid Howells do {						\
177508e0e7c8SDavid Howells } while(0)
177608e0e7c8SDavid Howells 
177708e0e7c8SDavid Howells #endif /* __KDEBUGALL */
1778