[mirror_ubuntu-kernels.git] / include / linux / sunrpc / xprt.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  linux/include/linux/sunrpc/xprt.h
 *
 *  Declarations for the RPC transport interface.
 *
 *  Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
 */

#ifndef _LINUX_SUNRPC_XPRT_H
#define _LINUX_SUNRPC_XPRT_H

#include <linux/uio.h>
#include <linux/socket.h>
#include <linux/in.h>
#include <linux/ktime.h>
#include <linux/kref.h>
#include <linux/sunrpc/sched.h>
#include <linux/sunrpc/xdr.h>
#include <linux/sunrpc/msg_prot.h>

#ifdef __KERNEL__

#define RPC_MIN_SLOT_TABLE	(2U)
#define RPC_DEF_SLOT_TABLE	(16U)
#define RPC_MAX_SLOT_TABLE_LIMIT	(65536U)
#define RPC_MAX_SLOT_TABLE	RPC_MAX_SLOT_TABLE_LIMIT

#define RPC_CWNDSHIFT		(8U)
#define RPC_CWNDSCALE		(1U << RPC_CWNDSHIFT)
#define RPC_INITCWND		RPC_CWNDSCALE
#define RPC_MAXCWND(xprt)	((xprt)->max_reqs << RPC_CWNDSHIFT)
#define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd)

/*
 * This describes a timeout strategy
 */
struct rpc_timeout {
	unsigned long		to_initval,		/* initial timeout */
				to_maxval,		/* max timeout */
				to_increment;		/* if !exponential */
	unsigned int		to_retries;		/* max # of retries */
	unsigned char		to_exponential;
};

enum rpc_display_format_t {
	RPC_DISPLAY_ADDR = 0,
	RPC_DISPLAY_PORT,
	RPC_DISPLAY_PROTO,
	RPC_DISPLAY_HEX_ADDR,
	RPC_DISPLAY_HEX_PORT,
	RPC_DISPLAY_NETID,
	RPC_DISPLAY_MAX,
};

struct rpc_task;
struct rpc_xprt;
struct seq_file;
struct svc_serv;
struct net;

/*
 * This describes a complete RPC request
 */
struct rpc_rqst {
	/*
	 * This is the user-visible part
	 */
	struct rpc_xprt *	rq_xprt;		/* RPC client */
	struct xdr_buf		rq_snd_buf;		/* send buffer */
	struct xdr_buf		rq_rcv_buf;		/* recv buffer */

	/*
	 * This is the private part
	 */
	struct rpc_task *	rq_task;	/* RPC task data */
	struct rpc_cred *	rq_cred;	/* Bound cred */
	__be32			rq_xid;		/* request XID */
	int			rq_cong;	/* has incremented xprt->cong */
	u32			rq_seqno;	/* gss seq no. used on req. */
	int			rq_enc_pages_num;
	struct page		**rq_enc_pages;	/* scratch pages for use by
						   gss privacy code */
	void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
	struct list_head	rq_list;

	void			*rq_xprtdata;	/* Per-xprt private data */
	void			*rq_buffer;	/* Call XDR encode buffer */
	size_t			rq_callsize;
	void			*rq_rbuffer;	/* Reply XDR decode buffer */
	size_t			rq_rcvsize;
	size_t			rq_xmit_bytes_sent;	/* total bytes sent */
	size_t			rq_reply_bytes_recvd;	/* total reply bytes */
							/* received */

	struct xdr_buf		rq_private_buf;		/* The receive buffer
							 * used in the softirq.
							 */
	unsigned long		rq_majortimeo;	/* major timeout alarm */
	unsigned long		rq_timeout;	/* Current timeout value */
	ktime_t			rq_rtt;		/* round-trip time */
	unsigned int		rq_retries;	/* # of retries */
	unsigned int		rq_connect_cookie;
						/* A cookie used to track the
						   state of the transport
						   connection */
	
	/*
	 * Partial send handling
	 */
	u32			rq_bytes_sent;	/* Bytes we have sent */

	ktime_t			rq_xtime;	/* transmit time stamp */
	int			rq_ntrans;

#if defined(CONFIG_SUNRPC_BACKCHANNEL)
	struct list_head	rq_bc_list;	/* Callback service list */
	unsigned long		rq_bc_pa_state;	/* Backchannel prealloc state */
	struct list_head	rq_bc_pa_list;	/* Backchannel prealloc list */
#endif /* CONFIG_SUNRPC_BACKCHANEL */
};
#define rq_svec			rq_snd_buf.head
#define rq_slen			rq_snd_buf.len

struct rpc_xprt_ops {
	void		(*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
	int		(*reserve_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
	void		(*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
	void		(*alloc_slot)(struct rpc_xprt *xprt, struct rpc_task *task);
	void		(*rpcbind)(struct rpc_task *task);
	void		(*set_port)(struct rpc_xprt *xprt, unsigned short port);
	void		(*connect)(struct rpc_xprt *xprt, struct rpc_task *task);
	int		(*buf_alloc)(struct rpc_task *task);
	void		(*buf_free)(struct rpc_task *task);
	int		(*send_request)(struct rpc_task *task);
	void		(*set_retrans_timeout)(struct rpc_task *task);
	void		(*timer)(struct rpc_xprt *xprt, struct rpc_task *task);
	void		(*release_request)(struct rpc_task *task);
	void		(*close)(struct rpc_xprt *xprt);
	void		(*destroy)(struct rpc_xprt *xprt);
	void		(*set_connect_timeout)(struct rpc_xprt *xprt,
					unsigned long connect_timeout,
					unsigned long reconnect_timeout);
	void		(*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
	int		(*enable_swap)(struct rpc_xprt *xprt);
	void		(*disable_swap)(struct rpc_xprt *xprt);
	void		(*inject_disconnect)(struct rpc_xprt *xprt);
	int		(*bc_setup)(struct rpc_xprt *xprt,
				    unsigned int min_reqs);
	int		(*bc_up)(struct svc_serv *serv, struct net *net);
	size_t		(*bc_maxpayload)(struct rpc_xprt *xprt);
	void		(*bc_free_rqst)(struct rpc_rqst *rqst);
	void		(*bc_destroy)(struct rpc_xprt *xprt,
				      unsigned int max_reqs);
};

/*
 * RPC transport identifiers
 *
 * To preserve compatibility with the historical use of raw IP protocol
 * id's for transport selection, UDP and TCP identifiers are specified
 * with the previous values. No such restriction exists for new transports,
 * except that they may not collide with these values (17 and 6,
 * respectively).
 */
#define XPRT_TRANSPORT_BC       (1 << 31)
enum xprt_transports {
	XPRT_TRANSPORT_UDP	= IPPROTO_UDP,
	XPRT_TRANSPORT_TCP	= IPPROTO_TCP,
	XPRT_TRANSPORT_BC_TCP	= IPPROTO_TCP | XPRT_TRANSPORT_BC,
	XPRT_TRANSPORT_RDMA	= 256,
	XPRT_TRANSPORT_BC_RDMA	= XPRT_TRANSPORT_RDMA | XPRT_TRANSPORT_BC,
	XPRT_TRANSPORT_LOCAL	= 257,
};

struct rpc_xprt {
	struct kref		kref;		/* Reference count */
	const struct rpc_xprt_ops *ops;		/* transport methods */

	const struct rpc_timeout *timeout;	/* timeout parms */
	struct sockaddr_storage	addr;		/* server address */
	size_t			addrlen;	/* size of server address */
	int			prot;		/* IP protocol */

	unsigned long		cong;		/* current congestion */
	unsigned long		cwnd;		/* congestion window */

	size_t			max_payload;	/* largest RPC payload size,
						   in bytes */
	unsigned int		tsh_size;	/* size of transport specific
						   header */

	struct rpc_wait_queue	binding;	/* requests waiting on rpcbind */
	struct rpc_wait_queue	sending;	/* requests waiting to send */
	struct rpc_wait_queue	pending;	/* requests in flight */
	struct rpc_wait_queue	backlog;	/* waiting for slot */
	struct list_head	free;		/* free slots */
	unsigned int		max_reqs;	/* max number of slots */
	unsigned int		min_reqs;	/* min number of slots */
	atomic_t		num_reqs;	/* total slots */
	unsigned long		state;		/* transport state */
	unsigned char		resvport   : 1; /* use a reserved port */
	atomic_t		swapper;	/* we're swapping over this
						   transport */
	unsigned int		bind_index;	/* bind function index */

	/*
	 * Multipath
	 */
	struct list_head	xprt_switch;

	/*
	 * Connection of transports
	 */
	unsigned long		bind_timeout,
				reestablish_timeout;
	unsigned int		connect_cookie;	/* A cookie that gets bumped
						   every time the transport
						   is reconnected */

	/*
	 * Disconnection of idle transports
	 */
	struct work_struct	task_cleanup;
	struct timer_list	timer;
	unsigned long		last_used,
				idle_timeout,
				connect_timeout,
				max_reconnect_timeout;

	/*
	 * Send stuff
	 */
	spinlock_t		transport_lock;	/* lock transport info */
	spinlock_t		reserve_lock;	/* lock slot table */
	spinlock_t		recv_lock;	/* lock receive list */
	u32			xid;		/* Next XID value to use */
	struct rpc_task *	snd_task;	/* Task blocked in send */
	struct svc_xprt		*bc_xprt;	/* NFSv4.1 backchannel */
#if defined(CONFIG_SUNRPC_BACKCHANNEL)
	struct svc_serv		*bc_serv;       /* The RPC service which will */
						/* process the callback */
	int			bc_alloc_count;	/* Total number of preallocs */
	atomic_t		bc_free_slots;
	spinlock_t		bc_pa_lock;	/* Protects the preallocated
						 * items */
	struct list_head	bc_pa_list;	/* List of preallocated
						 * backchannel rpc_rqst's */
#endif /* CONFIG_SUNRPC_BACKCHANNEL */
	struct list_head	recv;

	struct {
		unsigned long		bind_count,	/* total number of binds */
					connect_count,	/* total number of connects */
					connect_start,	/* connect start timestamp */
					connect_time,	/* jiffies waiting for connect */
					sends,		/* how many complete requests */
					recvs,		/* how many complete requests */
					bad_xids,	/* lookup_rqst didn't find XID */
					max_slots;	/* max rpc_slots used */

		unsigned long long	req_u,		/* average requests on the wire */
					bklog_u,	/* backlog queue utilization */
					sending_u,	/* send q utilization */
					pending_u;	/* pend q utilization */
	} stat;

	struct net		*xprt_net;
	const char		*servername;
	const char		*address_strings[RPC_DISPLAY_MAX];
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
	struct dentry		*debugfs;		/* debugfs directory */
	atomic_t		inject_disconnect;
#endif
	struct rcu_head		rcu;
};

#if defined(CONFIG_SUNRPC_BACKCHANNEL)
/*
 * Backchannel flags
 */
#define	RPC_BC_PA_IN_USE	0x0001		/* Preallocated backchannel */
						/* buffer in use */
#endif /* CONFIG_SUNRPC_BACKCHANNEL */

#if defined(CONFIG_SUNRPC_BACKCHANNEL)
static inline int bc_prealloc(struct rpc_rqst *req)
{
	return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state);
}
#else
static inline int bc_prealloc(struct rpc_rqst *req)
{
	return 0;
}
#endif /* CONFIG_SUNRPC_BACKCHANNEL */

#define XPRT_CREATE_INFINITE_SLOTS	(1U)
#define XPRT_CREATE_NO_IDLE_TIMEOUT	(1U << 1)

struct xprt_create {
	int			ident;		/* XPRT_TRANSPORT identifier */
	struct net *		net;
	struct sockaddr *	srcaddr;	/* optional local address */
	struct sockaddr *	dstaddr;	/* remote peer address */
	size_t			addrlen;
	const char		*servername;
	struct svc_xprt		*bc_xprt;	/* NFSv4.1 backchannel */
	struct rpc_xprt_switch	*bc_xps;
	unsigned int		flags;
};

struct xprt_class {
	struct list_head	list;
	int			ident;		/* XPRT_TRANSPORT identifier */
	struct rpc_xprt *	(*setup)(struct xprt_create *);
	struct module		*owner;
	char			name[32];
};

/*
 * Generic internal transport functions
 */
struct rpc_xprt		*xprt_create_transport(struct xprt_create *args);
void			xprt_connect(struct rpc_task *task);
void			xprt_reserve(struct rpc_task *task);
void			xprt_retry_reserve(struct rpc_task *task);
int			xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
int			xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
void			xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task);
void			xprt_lock_and_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task);
bool			xprt_prepare_transmit(struct rpc_task *task);
void			xprt_transmit(struct rpc_task *task);
void			xprt_end_transmit(struct rpc_task *task);
int			xprt_adjust_timeout(struct rpc_rqst *req);
void			xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
void			xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
void			xprt_release(struct rpc_task *task);
struct rpc_xprt *	xprt_get(struct rpc_xprt *xprt);
void			xprt_put(struct rpc_xprt *xprt);
struct rpc_xprt *	xprt_alloc(struct net *net, size_t size,
				unsigned int num_prealloc,
				unsigned int max_req);
void			xprt_free(struct rpc_xprt *);

static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
{
	return p + xprt->tsh_size;
}

static inline int
xprt_enable_swap(struct rpc_xprt *xprt)
{
	return xprt->ops->enable_swap(xprt);
}

static inline void
xprt_disable_swap(struct rpc_xprt *xprt)
{
	xprt->ops->disable_swap(xprt);
}

/*
 * Transport switch helper functions
 */
int			xprt_register_transport(struct xprt_class *type);
int			xprt_unregister_transport(struct xprt_class *type);
int			xprt_load_transport(const char *);
void			xprt_set_retrans_timeout_def(struct rpc_task *task);
void			xprt_set_retrans_timeout_rtt(struct rpc_task *task);
void			xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
void			xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action);
void			xprt_write_space(struct rpc_xprt *xprt);
void			xprt_adjust_cwnd(struct rpc_xprt *xprt, struct rpc_task *task, int result);
struct rpc_rqst *	xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
void			xprt_complete_rqst(struct rpc_task *task, int copied);
void			xprt_pin_rqst(struct rpc_rqst *req);
void			xprt_unpin_rqst(struct rpc_rqst *req);
void			xprt_release_rqst_cong(struct rpc_task *task);
void			xprt_disconnect_done(struct rpc_xprt *xprt);
void			xprt_force_disconnect(struct rpc_xprt *xprt);
void			xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);

bool			xprt_lock_connect(struct rpc_xprt *, struct rpc_task *, void *);
void			xprt_unlock_connect(struct rpc_xprt *, void *);

/*
 * Reserved bit positions in xprt->state
 */
#define XPRT_LOCKED		(0)
#define XPRT_CONNECTED		(1)
#define XPRT_CONNECTING		(2)
#define XPRT_CLOSE_WAIT		(3)
#define XPRT_BOUND		(4)
#define XPRT_BINDING		(5)
#define XPRT_CLOSING		(6)
#define XPRT_CONGESTED		(9)

static inline void xprt_set_connected(struct rpc_xprt *xprt)
{
	set_bit(XPRT_CONNECTED, &xprt->state);
}

static inline void xprt_clear_connected(struct rpc_xprt *xprt)
{
	clear_bit(XPRT_CONNECTED, &xprt->state);
}

static inline int xprt_connected(struct rpc_xprt *xprt)
{
	return test_bit(XPRT_CONNECTED, &xprt->state);
}

static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
{
	return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
}

static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
{
	return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
}

static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
{
	smp_mb__before_atomic();
	clear_bit(XPRT_CONNECTING, &xprt->state);
	smp_mb__after_atomic();
}

static inline int xprt_connecting(struct rpc_xprt *xprt)
{
	return test_bit(XPRT_CONNECTING, &xprt->state);
}

static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
{
	return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
}

static inline void xprt_set_bound(struct rpc_xprt *xprt)
{
	test_and_set_bit(XPRT_BOUND, &xprt->state);
}

static inline int xprt_bound(struct rpc_xprt *xprt)
{
	return test_bit(XPRT_BOUND, &xprt->state);
}

static inline void xprt_clear_bound(struct rpc_xprt *xprt)
{
	clear_bit(XPRT_BOUND, &xprt->state);
}

static inline void xprt_clear_binding(struct rpc_xprt *xprt)
{
	smp_mb__before_atomic();
	clear_bit(XPRT_BINDING, &xprt->state);
	smp_mb__after_atomic();
}

static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
{
	return test_and_set_bit(XPRT_BINDING, &xprt->state);
}

#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
extern unsigned int rpc_inject_disconnect;
static inline void xprt_inject_disconnect(struct rpc_xprt *xprt)
{
	if (!rpc_inject_disconnect)
		return;
	if (atomic_dec_return(&xprt->inject_disconnect))
		return;
	atomic_set(&xprt->inject_disconnect, rpc_inject_disconnect);
	xprt->ops->inject_disconnect(xprt);
}
#else
static inline void xprt_inject_disconnect(struct rpc_xprt *xprt)
{
}
#endif

#endif /* __KERNEL__*/

#endif /* _LINUX_SUNRPC_XPRT_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4	2	/*
55aa4f58	3	* linux/include/linux/sunrpc/xprt.h
1da177e4 LT	4	*
	5	* Declarations for the RPC transport interface.
	6	*
	7	* Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
	8	*/
	9
	10	#ifndef _LINUX_SUNRPC_XPRT_H
	11	#define _LINUX_SUNRPC_XPRT_H
	12
	13	#include <linux/uio.h>
	14	#include <linux/socket.h>
	15	#include <linux/in.h>
ff839970	16	#include <linux/ktime.h>
30c5116b	17	#include <linux/kref.h>
1da177e4 LT	18	#include <linux/sunrpc/sched.h>
1da177e4 LT	19	#include <linux/sunrpc/xdr.h>
7adae489	20	#include <linux/sunrpc/msg_prot.h>
1da177e4	21
96802a09 FM	22	#ifdef __KERNEL__
96802a09 FM	23
1da177e4 LT	24	#define RPC_MIN_SLOT_TABLE (2U)
1da177e4 LT	25	#define RPC_DEF_SLOT_TABLE (16U)
d9ba131d	26	#define RPC_MAX_SLOT_TABLE_LIMIT (65536U)
88338124	27	#define RPC_MAX_SLOT_TABLE RPC_MAX_SLOT_TABLE_LIMIT
1da177e4	28
4f4cf5ad CL	29	#define RPC_CWNDSHIFT (8U)
	30	#define RPC_CWNDSCALE (1U << RPC_CWNDSHIFT)
	31	#define RPC_INITCWND RPC_CWNDSCALE
	32	#define RPC_MAXCWND(xprt) ((xprt)->max_reqs << RPC_CWNDSHIFT)
	33	#define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd)
	34
1da177e4 LT	35	/*
	36	* This describes a timeout strategy
	37	*/
	38	struct rpc_timeout {
	39	unsigned long to_initval, /* initial timeout */
	40	to_maxval, /* max timeout */
	41	to_increment; /* if !exponential */
	42	unsigned int to_retries; /* max # of retries */
	43	unsigned char to_exponential;
	44	};
	45
edb267a6 CL	46	enum rpc_display_format_t {
	47	RPC_DISPLAY_ADDR = 0,
	48	RPC_DISPLAY_PORT,
	49	RPC_DISPLAY_PROTO,
fbfe3cc6 CL	50	RPC_DISPLAY_HEX_ADDR,
fbfe3cc6 CL	51	RPC_DISPLAY_HEX_PORT,
4417c8c4	52	RPC_DISPLAY_NETID,
edb267a6 CL	53	RPC_DISPLAY_MAX,
	54	};
	55
529b33c6 CL	56	struct rpc_task;
529b33c6 CL	57	struct rpc_xprt;
e99170ff	58	struct seq_file;
76566773 CL	59	struct svc_serv;
76566773 CL	60	struct net;
529b33c6	61
1da177e4 LT	62	/*
	63	* This describes a complete RPC request
	64	*/
	65	struct rpc_rqst {
	66	/*
	67	* This is the user-visible part
	68	*/
	69	struct rpc_xprt * rq_xprt; /* RPC client */
	70	struct xdr_buf rq_snd_buf; /* send buffer */
	71	struct xdr_buf rq_rcv_buf; /* recv buffer */
	72
	73	/*
	74	* This is the private part
	75	*/
	76	struct rpc_task * rq_task; /* RPC task data */
a17c2153	77	struct rpc_cred * rq_cred; /* Bound cred */
d8ed029d	78	__be32 rq_xid; /* request XID */
1da177e4	79	int rq_cong; /* has incremented xprt->cong */
1da177e4	80	u32 rq_seqno; /* gss seq no. used on req. */
ead5e1c2 BF	81	int rq_enc_pages_num;
	82	struct page *rq_enc_pages; / scratch pages for use by
	83	gss privacy code */
	84	void (rq_release_snd_buf)(struct rpc_rqst ); /* release rq_enc_pages */
1da177e4 LT	85	struct list_head rq_list;
1da177e4 LT	86
5a6d1db4	87	void rq_xprtdata; / Per-xprt private data */
b9c5bc03	88	void rq_buffer; / Call XDR encode buffer */
68778945 CL	89	size_t rq_callsize;
	90	void rq_rbuffer; / Reply XDR decode buffer */
	91	size_t rq_rcvsize;
d60dbb20 TM	92	size_t rq_xmit_bytes_sent; /* total bytes sent */
	93	size_t rq_reply_bytes_recvd; /* total reply bytes */
	94	/* received */
02107148	95
1da177e4 LT	96	struct xdr_buf rq_private_buf; /* The receive buffer
	97	* used in the softirq.
	98	*/
	99	unsigned long rq_majortimeo; /* major timeout alarm */
	100	unsigned long rq_timeout; /* Current timeout value */
d60dbb20	101	ktime_t rq_rtt; /* round-trip time */
1da177e4	102	unsigned int rq_retries; /* # of retries */
7c1d71cf TM	103	unsigned int rq_connect_cookie;
	104	/* A cookie used to track the
	105	state of the transport
	106	connection */
1da177e4 LT	107
	108	/*
	109	* Partial send handling
	110	*/
1da177e4 LT	111	u32 rq_bytes_sent; /* Bytes we have sent */
1da177e4 LT	112
ff839970	113	ktime_t rq_xtime; /* transmit time stamp */
1da177e4	114	int rq_ntrans;
56632b5b	115
9e00abc3	116	#if defined(CONFIG_SUNRPC_BACKCHANNEL)
56632b5b RL	117	struct list_head rq_bc_list; /* Callback service list */
	118	unsigned long rq_bc_pa_state; /* Backchannel prealloc state */
	119	struct list_head rq_bc_pa_list; /* Backchannel prealloc list */
9e00abc3	120	#endif /* CONFIG_SUNRPC_BACKCHANEL */
1da177e4 LT	121	};
	122	#define rq_svec rq_snd_buf.head
	123	#define rq_slen rq_snd_buf.len
	124
a246b010	125	struct rpc_xprt_ops {
470056c2	126	void (set_buffer_size)(struct rpc_xprt xprt, size_t sndsize, size_t rcvsize);
43cedbf0	127	int (reserve_xprt)(struct rpc_xprt xprt, struct rpc_task *task);
49e9a890	128	void (release_xprt)(struct rpc_xprt xprt, struct rpc_task *task);
f39c1bfb	129	void (alloc_slot)(struct rpc_xprt xprt, struct rpc_task *task);
bbf7c1dd	130	void (rpcbind)(struct rpc_task task);
92200412	131	void (set_port)(struct rpc_xprt xprt, unsigned short port);
1b092092	132	void (connect)(struct rpc_xprt xprt, struct rpc_task *task);
5fe6eaa1	133	int (buf_alloc)(struct rpc_task task);
3435c74a	134	void (buf_free)(struct rpc_task task);
a246b010	135	int (send_request)(struct rpc_task task);
fe3aca29	136	void (set_retrans_timeout)(struct rpc_task task);
6a24dfb6	137	void (timer)(struct rpc_xprt xprt, struct rpc_task *task);
a58dd398	138	void (release_request)(struct rpc_task task);
a246b010 CL	139	void (close)(struct rpc_xprt xprt);
a246b010 CL	140	void (destroy)(struct rpc_xprt xprt);
7196dbb0 TM	141	void (set_connect_timeout)(struct rpc_xprt xprt,
	142	unsigned long connect_timeout,
	143	unsigned long reconnect_timeout);
262ca07d	144	void (print_stats)(struct rpc_xprt xprt, struct seq_file *seq);
d67fa4d8 JL	145	int (enable_swap)(struct rpc_xprt xprt);
d67fa4d8 JL	146	void (disable_swap)(struct rpc_xprt xprt);
4a068258	147	void (inject_disconnect)(struct rpc_xprt xprt);
42e5c3e2 CL	148	int (bc_setup)(struct rpc_xprt xprt,
42e5c3e2 CL	149	unsigned int min_reqs);
76566773	150	int (bc_up)(struct svc_serv serv, struct net *net);
6b26cc8c	151	size_t (bc_maxpayload)(struct rpc_xprt xprt);
42e5c3e2 CL	152	void (bc_free_rqst)(struct rpc_rqst rqst);
	153	void (bc_destroy)(struct rpc_xprt xprt,
	154	unsigned int max_reqs);
a246b010	155	};
1da177e4	156
f300baba AB	157	/*
	158	* RPC transport identifiers
	159	*
	160	* To preserve compatibility with the historical use of raw IP protocol
	161	* id's for transport selection, UDP and TCP identifiers are specified
	162	* with the previous values. No such restriction exists for new transports,
	163	* except that they may not collide with these values (17 and 6,
	164	* respectively).
	165	*/
	166	#define XPRT_TRANSPORT_BC (1 << 31)
	167	enum xprt_transports {
	168	XPRT_TRANSPORT_UDP = IPPROTO_UDP,
	169	XPRT_TRANSPORT_TCP = IPPROTO_TCP,
	170	XPRT_TRANSPORT_BC_TCP = IPPROTO_TCP \| XPRT_TRANSPORT_BC,
176e21ee	171	XPRT_TRANSPORT_RDMA = 256,
94684319	172	XPRT_TRANSPORT_BC_RDMA = XPRT_TRANSPORT_RDMA \| XPRT_TRANSPORT_BC,
176e21ee	173	XPRT_TRANSPORT_LOCAL = 257,
f300baba AB	174	};
f300baba AB	175
1da177e4	176	struct rpc_xprt {
30c5116b	177	struct kref kref; /* Reference count */
d31ae254	178	const struct rpc_xprt_ops ops; / transport methods */
1da177e4	179
ba7392bb	180	const struct rpc_timeout timeout; / timeout parms */
c4efcb1d CL	181	struct sockaddr_storage addr; /* server address */
c4efcb1d CL	182	size_t addrlen; /* size of server address */
1da177e4 LT	183	int prot; /* IP protocol */
	184
	185	unsigned long cong; /* current congestion */
	186	unsigned long cwnd; /* congestion window */
	187
1da177e4 LT	188	size_t max_payload; /* largest RPC payload size,
1da177e4 LT	189	in bytes */
808012fb CL	190	unsigned int tsh_size; /* size of transport specific
808012fb CL	191	header */
1da177e4	192
4a68179d	193	struct rpc_wait_queue binding; /* requests waiting on rpcbind */
1da177e4	194	struct rpc_wait_queue sending; /* requests waiting to send */
1da177e4 LT	195	struct rpc_wait_queue pending; /* requests in flight */
	196	struct rpc_wait_queue backlog; /* waiting for slot */
	197	struct list_head free; /* free slots */
d9ba131d TM	198	unsigned int max_reqs; /* max number of slots */
	199	unsigned int min_reqs; /* min number of slots */
	200	atomic_t num_reqs; /* total slots */
2226feb6	201	unsigned long state; /* transport state */
d19751e7	202	unsigned char resvport : 1; /* use a reserved port */
8e228133	203	atomic_t swapper; /* we're swapping over this
a564b8f0	204	transport */
a509050b	205	unsigned int bind_index; /* bind function index */
1da177e4	206
80b14d5e TM	207	/*
	208	* Multipath
	209	*/
	210	struct list_head xprt_switch;
	211
1da177e4	212	/*
55aa4f58	213	* Connection of transports
1da177e4	214	*/
a8ce4a8f	215	unsigned long bind_timeout,
03bf4b70	216	reestablish_timeout;
7c1d71cf TM	217	unsigned int connect_cookie; /* A cookie that gets bumped
	218	every time the transport
	219	is reconnected */
03bf4b70	220
1da177e4	221	/*
55aa4f58	222	* Disconnection of idle transports
1da177e4 LT	223	*/
	224	struct work_struct task_cleanup;
	225	struct timer_list timer;
03bf4b70	226	unsigned long last_used,
3851f1cd	227	idle_timeout,
7196dbb0	228	connect_timeout,
3851f1cd	229	max_reconnect_timeout;
1da177e4 LT	230
	231	/*
	232	* Send stuff
	233	*/
4a0f8c04	234	spinlock_t transport_lock; /* lock transport info */
5dc07727	235	spinlock_t reserve_lock; /* lock slot table */
ce7c252a	236	spinlock_t recv_lock; /* lock receive list */
e744cf2e	237	u32 xid; /* Next XID value to use */
1da177e4	238	struct rpc_task * snd_task; /* Task blocked in send */
4cfc7e60	239	struct svc_xprt bc_xprt; / NFSv4.1 backchannel */
9e00abc3	240	#if defined(CONFIG_SUNRPC_BACKCHANNEL)
56632b5b RL	241	struct svc_serv bc_serv; / The RPC service which will */
56632b5b RL	242	/* process the callback */
0d2a970d TM	243	int bc_alloc_count; /* Total number of preallocs */
0d2a970d TM	244	atomic_t bc_free_slots;
56632b5b RL	245	spinlock_t bc_pa_lock; /* Protects the preallocated
	246	* items */
	247	struct list_head bc_pa_list; /* List of preallocated
	248	* backchannel rpc_rqst's */
9e00abc3	249	#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1da177e4 LT	250	struct list_head recv;
1da177e4 LT	251
262ca07d CL	252	struct {
	253	unsigned long bind_count, /* total number of binds */
	254	connect_count, /* total number of connects */
	255	connect_start, /* connect start timestamp */
	256	connect_time, /* jiffies waiting for connect */
	257	sends, /* how many complete requests */
	258	recvs, /* how many complete requests */
15a45206 AA	259	bad_xids, /* lookup_rqst didn't find XID */
15a45206 AA	260	max_slots; /* max rpc_slots used */
262ca07d CL	261
262ca07d CL	262	unsigned long long req_u, /* average requests on the wire */
15a45206 AA	263	bklog_u, /* backlog queue utilization */
	264	sending_u, /* send q utilization */
	265	pending_u; /* pend q utilization */
262ca07d	266	} stat;
1da177e4	267
37aa2133	268	struct net *xprt_net;
4e0038b6	269	const char *servername;
b454ae90	270	const char *address_strings[RPC_DISPLAY_MAX];
388f0c77 JL	271	#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
388f0c77 JL	272	struct dentry debugfs; / debugfs directory */
4a068258	273	atomic_t inject_disconnect;
388f0c77	274	#endif
fda1bfef	275	struct rcu_head rcu;
1da177e4 LT	276	};
1da177e4 LT	277
9e00abc3	278	#if defined(CONFIG_SUNRPC_BACKCHANNEL)
56632b5b RL	279	/*
	280	* Backchannel flags
	281	*/
	282	#define RPC_BC_PA_IN_USE 0x0001 /* Preallocated backchannel */
	283	/* buffer in use */
9e00abc3	284	#endif /* CONFIG_SUNRPC_BACKCHANNEL */
56632b5b	285
9e00abc3	286	#if defined(CONFIG_SUNRPC_BACKCHANNEL)
55ae1aab RL	287	static inline int bc_prealloc(struct rpc_rqst *req)
	288	{
	289	return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state);
	290	}
	291	#else
	292	static inline int bc_prealloc(struct rpc_rqst *req)
	293	{
	294	return 0;
	295	}
9e00abc3	296	#endif /* CONFIG_SUNRPC_BACKCHANNEL */
55ae1aab	297
b7993ceb	298	#define XPRT_CREATE_INFINITE_SLOTS (1U)
33d90ac0	299	#define XPRT_CREATE_NO_IDLE_TIMEOUT (1U << 1)
b7993ceb	300
3c341b0b	301	struct xprt_create {
4fa016eb	302	int ident; /* XPRT_TRANSPORT identifier */
9a23e332	303	struct net * net;
d3bc9a1d	304	struct sockaddr * srcaddr; /* optional local address */
96802a09 FM	305	struct sockaddr * dstaddr; /* remote peer address */
96802a09 FM	306	size_t addrlen;
4e0038b6	307	const char *servername;
f300baba	308	struct svc_xprt bc_xprt; / NFSv4.1 backchannel */
39a9beab	309	struct rpc_xprt_switch *bc_xps;
b7993ceb	310	unsigned int flags;
96802a09	311	};
1da177e4	312
81c098af TT	313	struct xprt_class {
81c098af TT	314	struct list_head list;
4fa016eb	315	int ident; /* XPRT_TRANSPORT identifier */
3c341b0b	316	struct rpc_xprt * (setup)(struct xprt_create );
81c098af TT	317	struct module *owner;
	318	char name[32];
	319	};
	320
55aa4f58 CL	321	/*
	322	* Generic internal transport functions
	323	*/
3c341b0b	324	struct rpc_xprt xprt_create_transport(struct xprt_create args);
55aa4f58 CL	325	void xprt_connect(struct rpc_task *task);
55aa4f58 CL	326	void xprt_reserve(struct rpc_task *task);
ba60eb25	327	void xprt_retry_reserve(struct rpc_task *task);
43cedbf0 TM	328	int xprt_reserve_xprt(struct rpc_xprt xprt, struct rpc_task task);
43cedbf0 TM	329	int xprt_reserve_xprt_cong(struct rpc_xprt xprt, struct rpc_task task);
f39c1bfb TM	330	void xprt_alloc_slot(struct rpc_xprt xprt, struct rpc_task task);
f39c1bfb TM	331	void xprt_lock_and_alloc_slot(struct rpc_xprt xprt, struct rpc_task task);
90051ea7	332	bool xprt_prepare_transmit(struct rpc_task *task);
55aa4f58	333	void xprt_transmit(struct rpc_task *task);
e0ab53de	334	void xprt_end_transmit(struct rpc_task *task);
1da177e4	335	int xprt_adjust_timeout(struct rpc_rqst *req);
49e9a890 CL	336	void xprt_release_xprt(struct rpc_xprt xprt, struct rpc_task task);
49e9a890 CL	337	void xprt_release_xprt_cong(struct rpc_xprt xprt, struct rpc_task task);
55aa4f58	338	void xprt_release(struct rpc_task *task);
30c5116b	339	struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
6b6ca86b	340	void xprt_put(struct rpc_xprt *xprt);
d9ba131d TM	341	struct rpc_xprt * xprt_alloc(struct net *net, size_t size,
	342	unsigned int num_prealloc,
	343	unsigned int max_req);
e204e621	344	void xprt_free(struct rpc_xprt *);
55aa4f58	345
d8ed029d	346	static inline __be32 xprt_skip_transport_header(struct rpc_xprt xprt, __be32 *p)
808012fb CL	347	{
	348	return p + xprt->tsh_size;
	349	}
	350
d67fa4d8 JL	351	static inline int
	352	xprt_enable_swap(struct rpc_xprt *xprt)
	353	{
	354	return xprt->ops->enable_swap(xprt);
	355	}
	356
	357	static inline void
	358	xprt_disable_swap(struct rpc_xprt *xprt)
	359	{
	360	xprt->ops->disable_swap(xprt);
	361	}
	362
55aa4f58 CL	363	/*
	364	* Transport switch helper functions
	365	*/
81c098af TT	366	int xprt_register_transport(struct xprt_class *type);
81c098af TT	367	int xprt_unregister_transport(struct xprt_class *type);
441e3e24	368	int xprt_load_transport(const char *);
fe3aca29 CL	369	void xprt_set_retrans_timeout_def(struct rpc_task *task);
fe3aca29 CL	370	void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
55aa4f58	371	void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
b6ddf64f	372	void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action);
c7b2cae8	373	void xprt_write_space(struct rpc_xprt *xprt);
6a24dfb6	374	void xprt_adjust_cwnd(struct rpc_xprt xprt, struct rpc_task task, int result);
d8ed029d	375	struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
1570c1e4	376	void xprt_complete_rqst(struct rpc_task *task, int copied);
729749bb TM	377	void xprt_pin_rqst(struct rpc_rqst *req);
729749bb TM	378	void xprt_unpin_rqst(struct rpc_rqst *req);
a58dd398	379	void xprt_release_rqst_cong(struct rpc_task *task);
62da3b24	380	void xprt_disconnect_done(struct rpc_xprt *xprt);
66af1e55	381	void xprt_force_disconnect(struct rpc_xprt *xprt);
7c1d71cf	382	void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);
55aa4f58	383
718ba5b8 TM	384	bool xprt_lock_connect(struct rpc_xprt , struct rpc_task , void *);
	385	void xprt_unlock_connect(struct rpc_xprt , void );
	386
2226feb6 CL	387	/*
	388	* Reserved bit positions in xprt->state
	389	*/
	390	#define XPRT_LOCKED (0)
	391	#define XPRT_CONNECTED (1)
	392	#define XPRT_CONNECTING (2)
632e3bdc	393	#define XPRT_CLOSE_WAIT (3)
ec739ef0	394	#define XPRT_BOUND (4)
4a68179d	395	#define XPRT_BINDING (5)
3b948ae5	396	#define XPRT_CLOSING (6)
ba60eb25	397	#define XPRT_CONGESTED (9)
2226feb6 CL	398
	399	static inline void xprt_set_connected(struct rpc_xprt *xprt)
	400	{
	401	set_bit(XPRT_CONNECTED, &xprt->state);
	402	}
	403
	404	static inline void xprt_clear_connected(struct rpc_xprt *xprt)
	405	{
	406	clear_bit(XPRT_CONNECTED, &xprt->state);
	407	}
	408
	409	static inline int xprt_connected(struct rpc_xprt *xprt)
	410	{
	411	return test_bit(XPRT_CONNECTED, &xprt->state);
	412	}
	413
	414	static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
	415	{
	416	return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
	417	}
	418
	419	static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
	420	{
	421	return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
	422	}
	423
	424	static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
	425	{
4e857c58	426	smp_mb__before_atomic();
2226feb6	427	clear_bit(XPRT_CONNECTING, &xprt->state);
4e857c58	428	smp_mb__after_atomic();
2226feb6 CL	429	}
	430
	431	static inline int xprt_connecting(struct rpc_xprt *xprt)
	432	{
	433	return test_bit(XPRT_CONNECTING, &xprt->state);
	434	}
	435
	436	static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
	437	{
	438	return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
	439	}
1da177e4	440
ec739ef0 CL	441	static inline void xprt_set_bound(struct rpc_xprt *xprt)
	442	{
	443	test_and_set_bit(XPRT_BOUND, &xprt->state);
	444	}
	445
	446	static inline int xprt_bound(struct rpc_xprt *xprt)
	447	{
	448	return test_bit(XPRT_BOUND, &xprt->state);
	449	}
	450
	451	static inline void xprt_clear_bound(struct rpc_xprt *xprt)
	452	{
	453	clear_bit(XPRT_BOUND, &xprt->state);
	454	}
	455
4a68179d CL	456	static inline void xprt_clear_binding(struct rpc_xprt *xprt)
4a68179d CL	457	{
4e857c58	458	smp_mb__before_atomic();
4a68179d	459	clear_bit(XPRT_BINDING, &xprt->state);
4e857c58	460	smp_mb__after_atomic();
4a68179d CL	461	}
	462
	463	static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
	464	{
	465	return test_and_set_bit(XPRT_BINDING, &xprt->state);
	466	}
	467
4a068258 CL	468	#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
	469	extern unsigned int rpc_inject_disconnect;
	470	static inline void xprt_inject_disconnect(struct rpc_xprt *xprt)
	471	{
	472	if (!rpc_inject_disconnect)
	473	return;
	474	if (atomic_dec_return(&xprt->inject_disconnect))
	475	return;
	476	atomic_set(&xprt->inject_disconnect, rpc_inject_disconnect);
	477	xprt->ops->inject_disconnect(xprt);
	478	}
	479	#else
	480	static inline void xprt_inject_disconnect(struct rpc_xprt *xprt)
	481	{
	482	}
	483	#endif
	484
1da177e4 LT	485	#endif /* __KERNEL__*/
	486
	487	#endif /* _LINUX_SUNRPC_XPRT_H */