[deliverable/linux.git] / include / linux / sunrpc / xprt.h

/*
 *  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;

	__u32 *			rq_buffer;	/* XDR encode buffer */
	size_t			rq_callsize,
				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);
	void *		(*buf_alloc)(struct rpc_task *task, size_t size);
	void		(*buf_free)(void *buffer);
	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		(*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 */
	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,
				max_reconnect_timeout;

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