[linux-2.6-block.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/sunrpc/sched.h>
#include <linux/sunrpc/xdr.h>

extern unsigned int xprt_udp_slot_table_entries;
extern unsigned int xprt_tcp_slot_table_entries;

#define RPC_MIN_SLOT_TABLE	(2U)
#define RPC_DEF_SLOT_TABLE	(16U)
#define RPC_MAX_SLOT_TABLE	(128U)

/*
 * RPC call and reply header size as number of 32bit words (verifier
 * size computed separately)
 */
#define RPC_CALLHDRSIZE		6
#define RPC_REPHDRSIZE		4

/*
 * Parameters for choosing a free port
 */
extern unsigned int xprt_min_resvport;
extern unsigned int xprt_max_resvport;

#define RPC_MIN_RESVPORT	(1U)
#define RPC_MAX_RESVPORT	(65535U)
#define RPC_DEF_MIN_RESVPORT	(650U)
#define RPC_DEF_MAX_RESVPORT	(1023U)

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

struct rpc_task;
struct rpc_xprt;

/*
 * 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 */
	__u32			rq_xid;		/* request XID */
	int			rq_cong;	/* has incremented xprt->cong */
	int			rq_received;	/* receive completed */
	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;

	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 */
	unsigned int		rq_retries;	/* # of retries */
	/*
	 * For authentication (e.g. auth_des)
	 */
	u32			rq_creddata[2];
	
	/*
	 * Partial send handling
	 */
	
	u32			rq_bytes_sent;	/* Bytes we have sent */

	unsigned long		rq_xtime;	/* when transmitted */
	int			rq_ntrans;
};
#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_task *task);
	void		(*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
	void		(*connect)(struct rpc_task *task);
	int		(*send_request)(struct rpc_task *task);
	void		(*set_retrans_timeout)(struct rpc_task *task);
	void		(*timer)(struct rpc_task *task);
	void		(*release_request)(struct rpc_task *task);
	void		(*close)(struct rpc_xprt *xprt);
	void		(*destroy)(struct rpc_xprt *xprt);
};

struct rpc_xprt {
	struct rpc_xprt_ops *	ops;		/* transport methods */
	struct socket *		sock;		/* BSD socket layer */
	struct sock *		inet;		/* INET layer */

	struct rpc_timeout	timeout;	/* timeout parms */
	struct sockaddr_in	addr;		/* server address */
	int			prot;		/* IP protocol */

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

	size_t			rcvsize,	/* transport rcv buffer size */
				sndsize;	/* transport send buffer size */

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

	struct rpc_wait_queue	sending;	/* requests waiting to send */
	struct rpc_wait_queue	resend;		/* requests waiting to resend */
	struct rpc_wait_queue	pending;	/* requests in flight */
	struct rpc_wait_queue	backlog;	/* waiting for slot */
	struct list_head	free;		/* free slots */
	struct rpc_rqst *	slot;		/* slot table storage */
	unsigned int		max_reqs;	/* total slots */
	unsigned long		state;		/* transport state */
	unsigned char		shutdown   : 1,	/* being shut down */
				resvport   : 1; /* use a reserved port */

	/*
	 * XID
	 */
	__u32			xid;		/* Next XID value to use */

	/*
	 * State of TCP reply receive stuff
	 */
	u32			tcp_recm,	/* Fragment header */
				tcp_xid,	/* Current XID */
				tcp_reclen,	/* fragment length */
				tcp_offset;	/* fragment offset */
	unsigned long		tcp_copied,	/* copied to request */
				tcp_flags;
	/*
	 * Connection of transports
	 */
	unsigned long		connect_timeout,
				bind_timeout,
				reestablish_timeout;
	struct work_struct	connect_worker;
	unsigned short		port;

	/*
	 * 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 */
	struct rpc_task *	snd_task;	/* Task blocked in send */

	struct list_head	recv;


	void			(*old_data_ready)(struct sock *, int);
	void			(*old_state_change)(struct sock *);
	void			(*old_write_space)(struct sock *);
};

#define XPRT_LAST_FRAG		(1 << 0)
#define XPRT_COPY_RECM		(1 << 1)
#define XPRT_COPY_XID		(1 << 2)
#define XPRT_COPY_DATA		(1 << 3)

#ifdef __KERNEL__

/*
 * Transport operations used by ULPs
 */
struct rpc_xprt *	xprt_create_proto(int proto, struct sockaddr_in *addr, struct rpc_timeout *to);
void			xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);

/*
 * Generic internal transport functions
 */
void			xprt_connect(struct rpc_task *task);
void			xprt_reserve(struct rpc_task *task);
int			xprt_reserve_xprt(struct rpc_task *task);
int			xprt_reserve_xprt_cong(struct rpc_task *task);
int			xprt_prepare_transmit(struct rpc_task *task);
void			xprt_transmit(struct rpc_task *task);
void			xprt_abort_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);
int			xprt_destroy(struct rpc_xprt *xprt);

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

/*
 * Transport switch helper functions
 */
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);
void			xprt_write_space(struct rpc_xprt *xprt);
void			xprt_update_rtt(struct rpc_task *task);
void			xprt_adjust_cwnd(struct rpc_task *task, int result);
struct rpc_rqst *	xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
void			xprt_complete_rqst(struct rpc_task *task, int copied);
void			xprt_release_rqst_cong(struct rpc_task *task);
void			xprt_disconnect(struct rpc_xprt *xprt);

/*
 * Socket transport setup operations
 */
int			xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
int			xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);

/*
 * Reserved bit positions in xprt->state
 */
#define XPRT_LOCKED		(0)
#define XPRT_CONNECTED		(1)
#define XPRT_CONNECTING		(2)

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_clear_bit();
	clear_bit(XPRT_CONNECTING, &xprt->state);
	smp_mb__after_clear_bit();
}

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

#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>
	15	#include <linux/sunrpc/sched.h>
	16	#include <linux/sunrpc/xdr.h>
	17
1da177e4 LT	18	extern unsigned int xprt_udp_slot_table_entries;
	19	extern unsigned int xprt_tcp_slot_table_entries;
	20
	21	#define RPC_MIN_SLOT_TABLE (2U)
	22	#define RPC_DEF_SLOT_TABLE (16U)
	23	#define RPC_MAX_SLOT_TABLE (128U)
	24
a246b010 CL	25	/*
a246b010 CL	26	* RPC call and reply header size as number of 32bit words (verifier
1da177e4 LT	27	* size computed separately)
	28	*/
	29	#define RPC_CALLHDRSIZE 6
	30	#define RPC_REPHDRSIZE 4
	31
529b33c6 CL	32	/*
	33	* Parameters for choosing a free port
	34	*/
	35	extern unsigned int xprt_min_resvport;
	36	extern unsigned int xprt_max_resvport;
	37
	38	#define RPC_MIN_RESVPORT (1U)
	39	#define RPC_MAX_RESVPORT (65535U)
	40	#define RPC_DEF_MIN_RESVPORT (650U)
	41	#define RPC_DEF_MAX_RESVPORT (1023U)
	42
1da177e4 LT	43	/*
	44	* This describes a timeout strategy
	45	*/
	46	struct rpc_timeout {
	47	unsigned long to_initval, /* initial timeout */
	48	to_maxval, /* max timeout */
	49	to_increment; /* if !exponential */
	50	unsigned int to_retries; /* max # of retries */
	51	unsigned char to_exponential;
	52	};
	53
529b33c6 CL	54	struct rpc_task;
	55	struct rpc_xprt;
	56
1da177e4 LT	57	/*
	58	* This describes a complete RPC request
	59	*/
	60	struct rpc_rqst {
	61	/*
	62	* This is the user-visible part
	63	*/
	64	struct rpc_xprt * rq_xprt; /* RPC client */
	65	struct xdr_buf rq_snd_buf; /* send buffer */
	66	struct xdr_buf rq_rcv_buf; /* recv buffer */
	67
	68	/*
	69	* This is the private part
	70	*/
	71	struct rpc_task * rq_task; /* RPC task data */
	72	__u32 rq_xid; /* request XID */
	73	int rq_cong; /* has incremented xprt->cong */
	74	int rq_received; /* receive completed */
	75	u32 rq_seqno; /* gss seq no. used on req. */
ead5e1c2 BF	76	int rq_enc_pages_num;
	77	struct page *rq_enc_pages; / scratch pages for use by
	78	gss privacy code */
	79	void (rq_release_snd_buf)(struct rpc_rqst ); /* release rq_enc_pages */
1da177e4 LT	80	struct list_head rq_list;
	81
	82	struct xdr_buf rq_private_buf; /* The receive buffer
	83	* used in the softirq.
	84	*/
	85	unsigned long rq_majortimeo; /* major timeout alarm */
	86	unsigned long rq_timeout; /* Current timeout value */
	87	unsigned int rq_retries; /* # of retries */
	88	/*
	89	* For authentication (e.g. auth_des)
	90	*/
	91	u32 rq_creddata[2];
	92
	93	/*
	94	* Partial send handling
	95	*/
	96
	97	u32 rq_bytes_sent; /* Bytes we have sent */
	98
	99	unsigned long rq_xtime; /* when transmitted */
	100	int rq_ntrans;
	101	};
	102	#define rq_svec rq_snd_buf.head
	103	#define rq_slen rq_snd_buf.len
	104
a246b010	105	struct rpc_xprt_ops {
470056c2	106	void (set_buffer_size)(struct rpc_xprt xprt, size_t sndsize, size_t rcvsize);
12a80469	107	int (reserve_xprt)(struct rpc_task task);
49e9a890	108	void (release_xprt)(struct rpc_xprt xprt, struct rpc_task *task);
a246b010 CL	109	void (connect)(struct rpc_task task);
a246b010 CL	110	int (send_request)(struct rpc_task task);
fe3aca29	111	void (set_retrans_timeout)(struct rpc_task task);
46c0ee8b	112	void (timer)(struct rpc_task task);
a58dd398	113	void (release_request)(struct rpc_task task);
a246b010 CL	114	void (close)(struct rpc_xprt xprt);
	115	void (destroy)(struct rpc_xprt xprt);
	116	};
1da177e4 LT	117
1da177e4 LT	118	struct rpc_xprt {
a246b010	119	struct rpc_xprt_ops * ops; /* transport methods */
1da177e4 LT	120	struct socket * sock; /* BSD socket layer */
	121	struct sock * inet; /* INET layer */
	122
	123	struct rpc_timeout timeout; /* timeout parms */
	124	struct sockaddr_in addr; /* server address */
	125	int prot; /* IP protocol */
	126
	127	unsigned long cong; /* current congestion */
	128	unsigned long cwnd; /* congestion window */
	129
470056c2	130	size_t rcvsize, /* transport rcv buffer size */
55aa4f58	131	sndsize; /* transport send buffer size */
1da177e4 LT	132
	133	size_t max_payload; /* largest RPC payload size,
	134	in bytes */
808012fb CL	135	unsigned int tsh_size; /* size of transport specific
808012fb CL	136	header */
1da177e4 LT	137
	138	struct rpc_wait_queue sending; /* requests waiting to send */
	139	struct rpc_wait_queue resend; /* requests waiting to resend */
	140	struct rpc_wait_queue pending; /* requests in flight */
	141	struct rpc_wait_queue backlog; /* waiting for slot */
	142	struct list_head free; /* free slots */
	143	struct rpc_rqst * slot; /* slot table storage */
	144	unsigned int max_reqs; /* total slots */
2226feb6	145	unsigned long state; /* transport state */
1da177e4	146	unsigned char shutdown : 1, /* being shut down */
43118c29	147	resvport : 1; /* use a reserved port */
1da177e4 LT	148
	149	/*
	150	* XID
	151	*/
	152	__u32 xid; /* Next XID value to use */
	153
	154	/*
	155	* State of TCP reply receive stuff
	156	*/
	157	u32 tcp_recm, /* Fragment header */
	158	tcp_xid, /* Current XID */
	159	tcp_reclen, /* fragment length */
	160	tcp_offset; /* fragment offset */
	161	unsigned long tcp_copied, /* copied to request */
	162	tcp_flags;
	163	/*
55aa4f58	164	* Connection of transports
1da177e4	165	*/
03bf4b70 CL	166	unsigned long connect_timeout,
	167	bind_timeout,
	168	reestablish_timeout;
55aa4f58	169	struct work_struct connect_worker;
1da177e4	170	unsigned short port;
03bf4b70	171
1da177e4	172	/*
55aa4f58	173	* Disconnection of idle transports
1da177e4 LT	174	*/
	175	struct work_struct task_cleanup;
	176	struct timer_list timer;
03bf4b70 CL	177	unsigned long last_used,
03bf4b70 CL	178	idle_timeout;
1da177e4 LT	179
	180	/*
	181	* Send stuff
	182	*/
4a0f8c04	183	spinlock_t transport_lock; /* lock transport info */
5dc07727	184	spinlock_t reserve_lock; /* lock slot table */
1da177e4 LT	185	struct rpc_task * snd_task; /* Task blocked in send */
	186
	187	struct list_head recv;
	188
	189
	190	void (old_data_ready)(struct sock , int);
	191	void (old_state_change)(struct sock );
	192	void (old_write_space)(struct sock );
1da177e4 LT	193	};
1da177e4 LT	194
a246b010 CL	195	#define XPRT_LAST_FRAG (1 << 0)
	196	#define XPRT_COPY_RECM (1 << 1)
	197	#define XPRT_COPY_XID (1 << 2)
	198	#define XPRT_COPY_DATA (1 << 3)
	199
1da177e4 LT	200	#ifdef __KERNEL__
1da177e4 LT	201
55aa4f58 CL	202	/*
	203	* Transport operations used by ULPs
	204	*/
	205	struct rpc_xprt * xprt_create_proto(int proto, struct sockaddr_in addr, struct rpc_timeout to);
	206	void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
	207
	208	/*
	209	* Generic internal transport functions
	210	*/
	211	void xprt_connect(struct rpc_task *task);
	212	void xprt_reserve(struct rpc_task *task);
12a80469 CL	213	int xprt_reserve_xprt(struct rpc_task *task);
12a80469 CL	214	int xprt_reserve_xprt_cong(struct rpc_task *task);
55aa4f58 CL	215	int xprt_prepare_transmit(struct rpc_task *task);
55aa4f58 CL	216	void xprt_transmit(struct rpc_task *task);
5e5ce5be	217	void xprt_abort_transmit(struct rpc_task *task);
1da177e4	218	int xprt_adjust_timeout(struct rpc_rqst *req);
49e9a890 CL	219	void xprt_release_xprt(struct rpc_xprt xprt, struct rpc_task task);
49e9a890 CL	220	void xprt_release_xprt_cong(struct rpc_xprt xprt, struct rpc_task task);
55aa4f58 CL	221	void xprt_release(struct rpc_task *task);
	222	int xprt_destroy(struct rpc_xprt *xprt);
	223
808012fb CL	224	static inline u32 xprt_skip_transport_header(struct rpc_xprt xprt, u32 *p)
	225	{
	226	return p + xprt->tsh_size;
	227	}
	228
55aa4f58 CL	229	/*
	230	* Transport switch helper functions
	231	*/
fe3aca29 CL	232	void xprt_set_retrans_timeout_def(struct rpc_task *task);
fe3aca29 CL	233	void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
55aa4f58	234	void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
c7b2cae8 CL	235	void xprt_wait_for_buffer_space(struct rpc_task *task);
c7b2cae8 CL	236	void xprt_write_space(struct rpc_xprt *xprt);
1570c1e4	237	void xprt_update_rtt(struct rpc_task *task);
46c0ee8b	238	void xprt_adjust_cwnd(struct rpc_task *task, int result);
55aa4f58	239	struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
1570c1e4	240	void xprt_complete_rqst(struct rpc_task *task, int copied);
a58dd398	241	void xprt_release_rqst_cong(struct rpc_task *task);
55aa4f58 CL	242	void xprt_disconnect(struct rpc_xprt *xprt);
	243
	244	/*
	245	* Socket transport setup operations
	246	*/
	247	int xs_setup_udp(struct rpc_xprt xprt, struct rpc_timeout to);
	248	int xs_setup_tcp(struct rpc_xprt xprt, struct rpc_timeout to);
1da177e4	249
2226feb6 CL	250	/*
	251	* Reserved bit positions in xprt->state
	252	*/
	253	#define XPRT_LOCKED (0)
	254	#define XPRT_CONNECTED (1)
	255	#define XPRT_CONNECTING (2)
	256
	257	static inline void xprt_set_connected(struct rpc_xprt *xprt)
	258	{
	259	set_bit(XPRT_CONNECTED, &xprt->state);
	260	}
	261
	262	static inline void xprt_clear_connected(struct rpc_xprt *xprt)
	263	{
	264	clear_bit(XPRT_CONNECTED, &xprt->state);
	265	}
	266
	267	static inline int xprt_connected(struct rpc_xprt *xprt)
	268	{
	269	return test_bit(XPRT_CONNECTED, &xprt->state);
	270	}
	271
	272	static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
	273	{
	274	return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
	275	}
	276
	277	static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
	278	{
	279	return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
	280	}
	281
	282	static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
	283	{
	284	smp_mb__before_clear_bit();
	285	clear_bit(XPRT_CONNECTING, &xprt->state);
	286	smp_mb__after_clear_bit();
	287	}
	288
	289	static inline int xprt_connecting(struct rpc_xprt *xprt)
	290	{
	291	return test_bit(XPRT_CONNECTING, &xprt->state);
	292	}
	293
	294	static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
	295	{
	296	return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
	297	}
1da177e4 LT	298
	299	#endif /* __KERNEL__*/
	300
	301	#endif /* _LINUX_SUNRPC_XPRT_H */