xprt.h 9.01 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
/*
2
 *  linux/include/linux/sunrpc/xprt.h
Linus Torvalds's avatar
Linus Torvalds committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *
 *  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)

25
26
/*
 * RPC call and reply header size as number of 32bit words (verifier
Linus Torvalds's avatar
Linus Torvalds committed
27
28
29
30
31
 * size computed separately)
 */
#define RPC_CALLHDRSIZE		6
#define RPC_REPHDRSIZE		4

32
33
34
35
36
37
38
39
40
41
42
/*
 * 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)

Linus Torvalds's avatar
Linus Torvalds committed
43
44
45
46
47
48
49
50
51
52
53
/*
 * 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;
};

54
55
struct rpc_task;
struct rpc_xprt;
56
struct seq_file;
57

Linus Torvalds's avatar
Linus Torvalds committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
 * 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. */
77
78
79
80
	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 */
Linus Torvalds's avatar
Linus Torvalds committed
81
82
	struct list_head	rq_list;

83
84
85
	__u32 *			rq_buffer;	/* XDR encode buffer */
	size_t			rq_bufsize;

Linus Torvalds's avatar
Linus Torvalds committed
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
	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 */
	
	/*
	 * 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

104
struct rpc_xprt_ops {
105
	void		(*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
106
	int		(*reserve_xprt)(struct rpc_task *task);
107
	void		(*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
108
	void		(*set_port)(struct rpc_xprt *xprt, unsigned short port);
109
	void		(*connect)(struct rpc_task *task);
110
111
	void *		(*buf_alloc)(struct rpc_task *task, size_t size);
	void		(*buf_free)(struct rpc_task *task);
112
	int		(*send_request)(struct rpc_task *task);
113
	void		(*set_retrans_timeout)(struct rpc_task *task);
114
	void		(*timer)(struct rpc_task *task);
115
	void		(*release_request)(struct rpc_task *task);
116
117
	void		(*close)(struct rpc_xprt *xprt);
	void		(*destroy)(struct rpc_xprt *xprt);
118
	void		(*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
119
};
Linus Torvalds's avatar
Linus Torvalds committed
120
121

struct rpc_xprt {
122
	struct rpc_xprt_ops *	ops;		/* transport methods */
Linus Torvalds's avatar
Linus Torvalds committed
123
124
125
126
127
128
129
130
131
132
	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 */

133
	size_t			rcvsize,	/* transport rcv buffer size */
134
				sndsize;	/* transport send buffer size */
Linus Torvalds's avatar
Linus Torvalds committed
135
136
137

	size_t			max_payload;	/* largest RPC payload size,
						   in bytes */
138
139
	unsigned int		tsh_size;	/* size of transport specific
						   header */
Linus Torvalds's avatar
Linus Torvalds committed
140
141
142
143
144
145
146
147

	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 */
148
	unsigned long		state;		/* transport state */
Linus Torvalds's avatar
Linus Torvalds committed
149
	unsigned char		shutdown   : 1,	/* being shut down */
150
				resvport   : 1; /* use a reserved port */
Linus Torvalds's avatar
Linus Torvalds committed
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

	/*
	 * 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;
	/*
167
	 * Connection of transports
Linus Torvalds's avatar
Linus Torvalds committed
168
	 */
169
170
171
	unsigned long		connect_timeout,
				bind_timeout,
				reestablish_timeout;
172
	struct work_struct	connect_worker;
Linus Torvalds's avatar
Linus Torvalds committed
173
	unsigned short		port;
174

Linus Torvalds's avatar
Linus Torvalds committed
175
	/*
176
	 * Disconnection of idle transports
Linus Torvalds's avatar
Linus Torvalds committed
177
178
179
	 */
	struct work_struct	task_cleanup;
	struct timer_list	timer;
180
181
	unsigned long		last_used,
				idle_timeout;
Linus Torvalds's avatar
Linus Torvalds committed
182
183
184
185

	/*
	 * Send stuff
	 */
Chuck Lever's avatar
Chuck Lever committed
186
	spinlock_t		transport_lock;	/* lock transport info */
Chuck Lever's avatar
Chuck Lever committed
187
	spinlock_t		reserve_lock;	/* lock slot table */
Linus Torvalds's avatar
Linus Torvalds committed
188
189
190
191
	struct rpc_task *	snd_task;	/* Task blocked in send */

	struct list_head	recv;

192
193
194
195
196
197
198
199
200
201
202
203
	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 */

		unsigned long long	req_u,		/* average requests on the wire */
					bklog_u;	/* backlog queue utilization */
	} stat;
Linus Torvalds's avatar
Linus Torvalds committed
204
205
206
207
208
209

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

210
211
212
213
214
#define XPRT_LAST_FRAG		(1 << 0)
#define XPRT_COPY_RECM		(1 << 1)
#define XPRT_COPY_XID		(1 << 2)
#define XPRT_COPY_DATA		(1 << 3)

Linus Torvalds's avatar
Linus Torvalds committed
215
216
#ifdef __KERNEL__

217
218
219
220
221
222
223
224
225
226
227
/*
 * 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);
228
229
int			xprt_reserve_xprt(struct rpc_task *task);
int			xprt_reserve_xprt_cong(struct rpc_task *task);
230
231
int			xprt_prepare_transmit(struct rpc_task *task);
void			xprt_transmit(struct rpc_task *task);
232
void			xprt_abort_transmit(struct rpc_task *task);
Linus Torvalds's avatar
Linus Torvalds committed
233
int			xprt_adjust_timeout(struct rpc_rqst *req);
234
235
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);
236
237
238
void			xprt_release(struct rpc_task *task);
int			xprt_destroy(struct rpc_xprt *xprt);

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

244
245
246
/*
 * Transport switch helper functions
 */
247
248
void			xprt_set_retrans_timeout_def(struct rpc_task *task);
void			xprt_set_retrans_timeout_rtt(struct rpc_task *task);
249
void			xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
250
251
void			xprt_wait_for_buffer_space(struct rpc_task *task);
void			xprt_write_space(struct rpc_xprt *xprt);
252
void			xprt_update_rtt(struct rpc_task *task);
253
void			xprt_adjust_cwnd(struct rpc_task *task, int result);
254
struct rpc_rqst *	xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
255
void			xprt_complete_rqst(struct rpc_task *task, int copied);
256
void			xprt_release_rqst_cong(struct rpc_task *task);
257
258
259
260
261
262
263
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);
Linus Torvalds's avatar
Linus Torvalds committed
264

265
266
267
268
269
270
/*
 * Reserved bit positions in xprt->state
 */
#define XPRT_LOCKED		(0)
#define XPRT_CONNECTED		(1)
#define XPRT_CONNECTING		(2)
271
#define XPRT_CLOSE_WAIT		(3)
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313

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);
}
Linus Torvalds's avatar
Linus Torvalds committed
314
315
316
317

#endif /* __KERNEL__*/

#endif /* _LINUX_SUNRPC_XPRT_H */