SUNRPC: Clean up soft task error handling
[linux-2.6-block.git] / include / linux / sunrpc / xprt.h
CommitLineData
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
18extern unsigned int xprt_udp_slot_table_entries;
19extern 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/*
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 */
35extern unsigned int xprt_min_resvport;
36extern unsigned int xprt_max_resvport;
37
38#define RPC_MIN_RESVPORT (1U)
39#define RPC_MAX_RESVPORT (65535U)
8e037094 40#define RPC_DEF_MIN_RESVPORT (665U)
529b33c6
CL
41#define RPC_DEF_MAX_RESVPORT (1023U)
42
1da177e4
LT
43/*
44 * This describes a timeout strategy
45 */
46struct 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
edb267a6
CL
54enum rpc_display_format_t {
55 RPC_DISPLAY_ADDR = 0,
56 RPC_DISPLAY_PORT,
57 RPC_DISPLAY_PROTO,
58 RPC_DISPLAY_ALL,
59 RPC_DISPLAY_MAX,
60};
61
529b33c6
CL
62struct rpc_task;
63struct rpc_xprt;
e99170ff 64struct seq_file;
529b33c6 65
1da177e4
LT
66/*
67 * This describes a complete RPC request
68 */
69struct rpc_rqst {
70 /*
71 * This is the user-visible part
72 */
73 struct rpc_xprt * rq_xprt; /* RPC client */
74 struct xdr_buf rq_snd_buf; /* send buffer */
75 struct xdr_buf rq_rcv_buf; /* recv buffer */
76
77 /*
78 * This is the private part
79 */
80 struct rpc_task * rq_task; /* RPC task data */
81 __u32 rq_xid; /* request XID */
82 int rq_cong; /* has incremented xprt->cong */
83 int rq_received; /* receive completed */
84 u32 rq_seqno; /* gss seq no. used on req. */
ead5e1c2
BF
85 int rq_enc_pages_num;
86 struct page **rq_enc_pages; /* scratch pages for use by
87 gss privacy code */
88 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
1da177e4
LT
89 struct list_head rq_list;
90
02107148
CL
91 __u32 * rq_buffer; /* XDR encode buffer */
92 size_t rq_bufsize;
93
1da177e4
LT
94 struct xdr_buf rq_private_buf; /* The receive buffer
95 * used in the softirq.
96 */
97 unsigned long rq_majortimeo; /* major timeout alarm */
98 unsigned long rq_timeout; /* Current timeout value */
99 unsigned int rq_retries; /* # of retries */
1da177e4
LT
100
101 /*
102 * Partial send handling
103 */
1da177e4
LT
104 u32 rq_bytes_sent; /* Bytes we have sent */
105
106 unsigned long rq_xtime; /* when transmitted */
107 int rq_ntrans;
108};
109#define rq_svec rq_snd_buf.head
110#define rq_slen rq_snd_buf.len
111
a246b010 112struct rpc_xprt_ops {
470056c2 113 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
edb267a6 114 char * (*print_addr)(struct rpc_xprt *xprt, enum rpc_display_format_t format);
12a80469 115 int (*reserve_xprt)(struct rpc_task *task);
49e9a890 116 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
bbf7c1dd 117 void (*rpcbind)(struct rpc_task *task);
92200412 118 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
a246b010 119 void (*connect)(struct rpc_task *task);
02107148
CL
120 void * (*buf_alloc)(struct rpc_task *task, size_t size);
121 void (*buf_free)(struct rpc_task *task);
a246b010 122 int (*send_request)(struct rpc_task *task);
fe3aca29 123 void (*set_retrans_timeout)(struct rpc_task *task);
46c0ee8b 124 void (*timer)(struct rpc_task *task);
a58dd398 125 void (*release_request)(struct rpc_task *task);
a246b010
CL
126 void (*close)(struct rpc_xprt *xprt);
127 void (*destroy)(struct rpc_xprt *xprt);
262ca07d 128 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
a246b010 129};
1da177e4
LT
130
131struct rpc_xprt {
a246b010 132 struct rpc_xprt_ops * ops; /* transport methods */
1da177e4
LT
133 struct socket * sock; /* BSD socket layer */
134 struct sock * inet; /* INET layer */
135
136 struct rpc_timeout timeout; /* timeout parms */
c4efcb1d
CL
137 struct sockaddr_storage addr; /* server address */
138 size_t addrlen; /* size of server address */
1da177e4
LT
139 int prot; /* IP protocol */
140
141 unsigned long cong; /* current congestion */
142 unsigned long cwnd; /* congestion window */
143
470056c2 144 size_t rcvsize, /* transport rcv buffer size */
55aa4f58 145 sndsize; /* transport send buffer size */
1da177e4
LT
146
147 size_t max_payload; /* largest RPC payload size,
148 in bytes */
808012fb
CL
149 unsigned int tsh_size; /* size of transport specific
150 header */
1da177e4 151
4a68179d 152 struct rpc_wait_queue binding; /* requests waiting on rpcbind */
1da177e4
LT
153 struct rpc_wait_queue sending; /* requests waiting to send */
154 struct rpc_wait_queue resend; /* requests waiting to resend */
155 struct rpc_wait_queue pending; /* requests in flight */
156 struct rpc_wait_queue backlog; /* waiting for slot */
157 struct list_head free; /* free slots */
158 struct rpc_rqst * slot; /* slot table storage */
159 unsigned int max_reqs; /* total slots */
2226feb6 160 unsigned long state; /* transport state */
1da177e4 161 unsigned char shutdown : 1, /* being shut down */
43118c29 162 resvport : 1; /* use a reserved port */
1da177e4
LT
163
164 /*
165 * XID
166 */
167 __u32 xid; /* Next XID value to use */
168
169 /*
170 * State of TCP reply receive stuff
171 */
172 u32 tcp_recm, /* Fragment header */
173 tcp_xid, /* Current XID */
174 tcp_reclen, /* fragment length */
175 tcp_offset; /* fragment offset */
176 unsigned long tcp_copied, /* copied to request */
177 tcp_flags;
178 /*
55aa4f58 179 * Connection of transports
1da177e4 180 */
03bf4b70
CL
181 unsigned long connect_timeout,
182 bind_timeout,
183 reestablish_timeout;
55aa4f58 184 struct work_struct connect_worker;
1da177e4 185 unsigned short port;
03bf4b70 186
1da177e4 187 /*
55aa4f58 188 * Disconnection of idle transports
1da177e4
LT
189 */
190 struct work_struct task_cleanup;
191 struct timer_list timer;
03bf4b70
CL
192 unsigned long last_used,
193 idle_timeout;
1da177e4
LT
194
195 /*
196 * Send stuff
197 */
4a0f8c04 198 spinlock_t transport_lock; /* lock transport info */
5dc07727 199 spinlock_t reserve_lock; /* lock slot table */
1da177e4
LT
200 struct rpc_task * snd_task; /* Task blocked in send */
201
202 struct list_head recv;
203
262ca07d
CL
204 struct {
205 unsigned long bind_count, /* total number of binds */
206 connect_count, /* total number of connects */
207 connect_start, /* connect start timestamp */
208 connect_time, /* jiffies waiting for connect */
209 sends, /* how many complete requests */
210 recvs, /* how many complete requests */
211 bad_xids; /* lookup_rqst didn't find XID */
212
213 unsigned long long req_u, /* average requests on the wire */
214 bklog_u; /* backlog queue utilization */
215 } stat;
1da177e4
LT
216
217 void (*old_data_ready)(struct sock *, int);
218 void (*old_state_change)(struct sock *);
219 void (*old_write_space)(struct sock *);
edb267a6
CL
220
221 char * address_strings[RPC_DISPLAY_MAX];
1da177e4
LT
222};
223
a246b010
CL
224#define XPRT_LAST_FRAG (1 << 0)
225#define XPRT_COPY_RECM (1 << 1)
226#define XPRT_COPY_XID (1 << 2)
227#define XPRT_COPY_DATA (1 << 3)
228
1da177e4
LT
229#ifdef __KERNEL__
230
55aa4f58
CL
231/*
232 * Transport operations used by ULPs
233 */
55aa4f58
CL
234void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
235
236/*
237 * Generic internal transport functions
238 */
c2866763 239struct rpc_xprt * xprt_create_transport(int proto, struct sockaddr *addr, size_t size, struct rpc_timeout *toparms);
55aa4f58
CL
240void xprt_connect(struct rpc_task *task);
241void xprt_reserve(struct rpc_task *task);
12a80469
CL
242int xprt_reserve_xprt(struct rpc_task *task);
243int xprt_reserve_xprt_cong(struct rpc_task *task);
55aa4f58
CL
244int xprt_prepare_transmit(struct rpc_task *task);
245void xprt_transmit(struct rpc_task *task);
e0ab53de 246void xprt_end_transmit(struct rpc_task *task);
1da177e4 247int xprt_adjust_timeout(struct rpc_rqst *req);
49e9a890
CL
248void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
249void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
55aa4f58
CL
250void xprt_release(struct rpc_task *task);
251int xprt_destroy(struct rpc_xprt *xprt);
252
808012fb
CL
253static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p)
254{
255 return p + xprt->tsh_size;
256}
257
55aa4f58
CL
258/*
259 * Transport switch helper functions
260 */
fe3aca29
CL
261void xprt_set_retrans_timeout_def(struct rpc_task *task);
262void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
55aa4f58 263void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
c7b2cae8
CL
264void xprt_wait_for_buffer_space(struct rpc_task *task);
265void xprt_write_space(struct rpc_xprt *xprt);
1570c1e4 266void xprt_update_rtt(struct rpc_task *task);
46c0ee8b 267void xprt_adjust_cwnd(struct rpc_task *task, int result);
55aa4f58 268struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
1570c1e4 269void xprt_complete_rqst(struct rpc_task *task, int copied);
a58dd398 270void xprt_release_rqst_cong(struct rpc_task *task);
55aa4f58
CL
271void xprt_disconnect(struct rpc_xprt *xprt);
272
273/*
274 * Socket transport setup operations
275 */
276int xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
277int xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);
1da177e4 278
2226feb6
CL
279/*
280 * Reserved bit positions in xprt->state
281 */
282#define XPRT_LOCKED (0)
283#define XPRT_CONNECTED (1)
284#define XPRT_CONNECTING (2)
632e3bdc 285#define XPRT_CLOSE_WAIT (3)
ec739ef0 286#define XPRT_BOUND (4)
4a68179d 287#define XPRT_BINDING (5)
2226feb6
CL
288
289static inline void xprt_set_connected(struct rpc_xprt *xprt)
290{
291 set_bit(XPRT_CONNECTED, &xprt->state);
292}
293
294static inline void xprt_clear_connected(struct rpc_xprt *xprt)
295{
296 clear_bit(XPRT_CONNECTED, &xprt->state);
297}
298
299static inline int xprt_connected(struct rpc_xprt *xprt)
300{
301 return test_bit(XPRT_CONNECTED, &xprt->state);
302}
303
304static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
305{
306 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
307}
308
309static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
310{
311 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
312}
313
314static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
315{
316 smp_mb__before_clear_bit();
317 clear_bit(XPRT_CONNECTING, &xprt->state);
318 smp_mb__after_clear_bit();
319}
320
321static inline int xprt_connecting(struct rpc_xprt *xprt)
322{
323 return test_bit(XPRT_CONNECTING, &xprt->state);
324}
325
326static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
327{
328 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
329}
1da177e4 330
ec739ef0
CL
331static inline void xprt_set_bound(struct rpc_xprt *xprt)
332{
333 test_and_set_bit(XPRT_BOUND, &xprt->state);
334}
335
336static inline int xprt_bound(struct rpc_xprt *xprt)
337{
338 return test_bit(XPRT_BOUND, &xprt->state);
339}
340
341static inline void xprt_clear_bound(struct rpc_xprt *xprt)
342{
343 clear_bit(XPRT_BOUND, &xprt->state);
344}
345
4a68179d
CL
346static inline void xprt_clear_binding(struct rpc_xprt *xprt)
347{
348 smp_mb__before_clear_bit();
349 clear_bit(XPRT_BINDING, &xprt->state);
350 smp_mb__after_clear_bit();
351}
352
353static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
354{
355 return test_and_set_bit(XPRT_BINDING, &xprt->state);
356}
357
1da177e4
LT
358#endif /* __KERNEL__*/
359
360#endif /* _LINUX_SUNRPC_XPRT_H */