[mirror_ubuntu-hirsute-kernel.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/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;

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

/*
 * 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_LOCAL	= 257,
};

struct rpc_xprt {
	atomic_t		count;		/* 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 */

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

	/*
	 * 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 */
#endif
};

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

/**
 * xprt_get - return a reference to an RPC transport.
 * @xprt: pointer to the transport
 *
 */
static inline struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
{
	if (atomic_inc_not_zero(&xprt->count))
		return xprt;
	return NULL;
}

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);
}

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