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