Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs-2.6
[deliverable/linux.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>
6b6ca86b 15#include <linux/kref.h>
1da177e4
LT
16#include <linux/sunrpc/sched.h>
17#include <linux/sunrpc/xdr.h>
7adae489 18#include <linux/sunrpc/msg_prot.h>
1da177e4 19
96802a09
FM
20#ifdef __KERNEL__
21
1da177e4
LT
22#define RPC_MIN_SLOT_TABLE (2U)
23#define RPC_DEF_SLOT_TABLE (16U)
24#define RPC_MAX_SLOT_TABLE (128U)
25
1da177e4
LT
26/*
27 * This describes a timeout strategy
28 */
29struct rpc_timeout {
30 unsigned long to_initval, /* initial timeout */
31 to_maxval, /* max timeout */
32 to_increment; /* if !exponential */
33 unsigned int to_retries; /* max # of retries */
34 unsigned char to_exponential;
35};
36
edb267a6
CL
37enum rpc_display_format_t {
38 RPC_DISPLAY_ADDR = 0,
39 RPC_DISPLAY_PORT,
40 RPC_DISPLAY_PROTO,
41 RPC_DISPLAY_ALL,
fbfe3cc6
CL
42 RPC_DISPLAY_HEX_ADDR,
43 RPC_DISPLAY_HEX_PORT,
756805e7 44 RPC_DISPLAY_UNIVERSAL_ADDR,
4417c8c4 45 RPC_DISPLAY_NETID,
edb267a6
CL
46 RPC_DISPLAY_MAX,
47};
48
529b33c6
CL
49struct rpc_task;
50struct rpc_xprt;
e99170ff 51struct seq_file;
529b33c6 52
1da177e4
LT
53/*
54 * This describes a complete RPC request
55 */
56struct rpc_rqst {
57 /*
58 * This is the user-visible part
59 */
60 struct rpc_xprt * rq_xprt; /* RPC client */
61 struct xdr_buf rq_snd_buf; /* send buffer */
62 struct xdr_buf rq_rcv_buf; /* recv buffer */
63
64 /*
65 * This is the private part
66 */
67 struct rpc_task * rq_task; /* RPC task data */
d8ed029d 68 __be32 rq_xid; /* request XID */
1da177e4
LT
69 int rq_cong; /* has incremented xprt->cong */
70 int rq_received; /* receive completed */
71 u32 rq_seqno; /* gss seq no. used on req. */
ead5e1c2
BF
72 int rq_enc_pages_num;
73 struct page **rq_enc_pages; /* scratch pages for use by
74 gss privacy code */
75 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
1da177e4
LT
76 struct list_head rq_list;
77
02107148 78 __u32 * rq_buffer; /* XDR encode buffer */
c977a2ef 79 size_t rq_callsize,
2bea90d4 80 rq_rcvsize;
02107148 81
1da177e4
LT
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 */
7c1d71cf
TM
88 unsigned int rq_connect_cookie;
89 /* A cookie used to track the
90 state of the transport
91 connection */
1da177e4
LT
92
93 /*
94 * Partial send handling
95 */
1da177e4
LT
96 u32 rq_bytes_sent; /* Bytes we have sent */
97
98 unsigned long rq_xtime; /* when transmitted */
99 int rq_ntrans;
100};
101#define rq_svec rq_snd_buf.head
102#define rq_slen rq_snd_buf.len
103
a246b010 104struct rpc_xprt_ops {
470056c2 105 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
12a80469 106 int (*reserve_xprt)(struct rpc_task *task);
49e9a890 107 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
bbf7c1dd 108 void (*rpcbind)(struct rpc_task *task);
92200412 109 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
a246b010 110 void (*connect)(struct rpc_task *task);
02107148 111 void * (*buf_alloc)(struct rpc_task *task, size_t size);
c5a4dd8b 112 void (*buf_free)(void *buffer);
a246b010 113 int (*send_request)(struct rpc_task *task);
fe3aca29 114 void (*set_retrans_timeout)(struct rpc_task *task);
46c0ee8b 115 void (*timer)(struct rpc_task *task);
a58dd398 116 void (*release_request)(struct rpc_task *task);
a246b010
CL
117 void (*close)(struct rpc_xprt *xprt);
118 void (*destroy)(struct rpc_xprt *xprt);
262ca07d 119 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
a246b010 120};
1da177e4
LT
121
122struct rpc_xprt {
6b6ca86b 123 struct kref kref; /* Reference count */
a246b010 124 struct rpc_xprt_ops * ops; /* transport methods */
1da177e4 125
ba7392bb 126 const struct rpc_timeout *timeout; /* timeout parms */
c4efcb1d
CL
127 struct sockaddr_storage addr; /* server address */
128 size_t addrlen; /* size of server address */
1da177e4
LT
129 int prot; /* IP protocol */
130
131 unsigned long cong; /* current congestion */
132 unsigned long cwnd; /* congestion window */
133
1da177e4
LT
134 size_t max_payload; /* largest RPC payload size,
135 in bytes */
808012fb
CL
136 unsigned int tsh_size; /* size of transport specific
137 header */
1da177e4 138
4a68179d 139 struct rpc_wait_queue binding; /* requests waiting on rpcbind */
1da177e4
LT
140 struct rpc_wait_queue sending; /* requests waiting to send */
141 struct rpc_wait_queue resend; /* requests waiting to resend */
142 struct rpc_wait_queue pending; /* requests in flight */
143 struct rpc_wait_queue backlog; /* waiting for slot */
144 struct list_head free; /* free slots */
145 struct rpc_rqst * slot; /* slot table storage */
146 unsigned int max_reqs; /* total slots */
2226feb6 147 unsigned long state; /* transport state */
1da177e4 148 unsigned char shutdown : 1, /* being shut down */
43118c29 149 resvport : 1; /* use a reserved port */
a509050b 150 unsigned int bind_index; /* bind function index */
1da177e4 151
1da177e4 152 /*
55aa4f58 153 * Connection of transports
1da177e4 154 */
03bf4b70
CL
155 unsigned long connect_timeout,
156 bind_timeout,
157 reestablish_timeout;
7c1d71cf
TM
158 unsigned int connect_cookie; /* A cookie that gets bumped
159 every time the transport
160 is reconnected */
03bf4b70 161
1da177e4 162 /*
55aa4f58 163 * Disconnection of idle transports
1da177e4
LT
164 */
165 struct work_struct task_cleanup;
166 struct timer_list timer;
03bf4b70
CL
167 unsigned long last_used,
168 idle_timeout;
1da177e4
LT
169
170 /*
171 * Send stuff
172 */
4a0f8c04 173 spinlock_t transport_lock; /* lock transport info */
5dc07727 174 spinlock_t reserve_lock; /* lock slot table */
e744cf2e 175 u32 xid; /* Next XID value to use */
1da177e4 176 struct rpc_task * snd_task; /* Task blocked in send */
1da177e4
LT
177 struct list_head recv;
178
262ca07d
CL
179 struct {
180 unsigned long bind_count, /* total number of binds */
181 connect_count, /* total number of connects */
182 connect_start, /* connect start timestamp */
183 connect_time, /* jiffies waiting for connect */
184 sends, /* how many complete requests */
185 recvs, /* how many complete requests */
186 bad_xids; /* lookup_rqst didn't find XID */
187
188 unsigned long long req_u, /* average requests on the wire */
189 bklog_u; /* backlog queue utilization */
190 } stat;
1da177e4 191
b454ae90 192 const char *address_strings[RPC_DISPLAY_MAX];
1da177e4
LT
193};
194
3c341b0b 195struct xprt_create {
4fa016eb 196 int ident; /* XPRT_TRANSPORT identifier */
d3bc9a1d 197 struct sockaddr * srcaddr; /* optional local address */
96802a09
FM
198 struct sockaddr * dstaddr; /* remote peer address */
199 size_t addrlen;
96802a09 200};
1da177e4 201
81c098af
TT
202struct xprt_class {
203 struct list_head list;
4fa016eb 204 int ident; /* XPRT_TRANSPORT identifier */
3c341b0b 205 struct rpc_xprt * (*setup)(struct xprt_create *);
81c098af
TT
206 struct module *owner;
207 char name[32];
208};
209
55aa4f58
CL
210/*
211 * Generic internal transport functions
212 */
3c341b0b 213struct rpc_xprt *xprt_create_transport(struct xprt_create *args);
55aa4f58
CL
214void xprt_connect(struct rpc_task *task);
215void xprt_reserve(struct rpc_task *task);
12a80469
CL
216int xprt_reserve_xprt(struct rpc_task *task);
217int xprt_reserve_xprt_cong(struct rpc_task *task);
55aa4f58
CL
218int xprt_prepare_transmit(struct rpc_task *task);
219void xprt_transmit(struct rpc_task *task);
e0ab53de 220void xprt_end_transmit(struct rpc_task *task);
1da177e4 221int xprt_adjust_timeout(struct rpc_rqst *req);
49e9a890
CL
222void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
223void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
55aa4f58 224void xprt_release(struct rpc_task *task);
6b6ca86b
TM
225struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
226void xprt_put(struct rpc_xprt *xprt);
55aa4f58 227
d8ed029d 228static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
808012fb
CL
229{
230 return p + xprt->tsh_size;
231}
232
55aa4f58
CL
233/*
234 * Transport switch helper functions
235 */
81c098af
TT
236int xprt_register_transport(struct xprt_class *type);
237int xprt_unregister_transport(struct xprt_class *type);
441e3e24 238int xprt_load_transport(const char *);
fe3aca29
CL
239void xprt_set_retrans_timeout_def(struct rpc_task *task);
240void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
55aa4f58 241void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
b6ddf64f 242void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action);
c7b2cae8 243void xprt_write_space(struct rpc_xprt *xprt);
1570c1e4 244void xprt_update_rtt(struct rpc_task *task);
46c0ee8b 245void xprt_adjust_cwnd(struct rpc_task *task, int result);
d8ed029d 246struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
1570c1e4 247void xprt_complete_rqst(struct rpc_task *task, int copied);
a58dd398 248void xprt_release_rqst_cong(struct rpc_task *task);
62da3b24 249void xprt_disconnect_done(struct rpc_xprt *xprt);
66af1e55 250void xprt_force_disconnect(struct rpc_xprt *xprt);
7c1d71cf 251void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);
55aa4f58 252
2226feb6
CL
253/*
254 * Reserved bit positions in xprt->state
255 */
256#define XPRT_LOCKED (0)
257#define XPRT_CONNECTED (1)
258#define XPRT_CONNECTING (2)
632e3bdc 259#define XPRT_CLOSE_WAIT (3)
ec739ef0 260#define XPRT_BOUND (4)
4a68179d 261#define XPRT_BINDING (5)
3b948ae5 262#define XPRT_CLOSING (6)
7d1e8255 263#define XPRT_CONNECTION_ABORT (7)
2226feb6
CL
264
265static inline void xprt_set_connected(struct rpc_xprt *xprt)
266{
267 set_bit(XPRT_CONNECTED, &xprt->state);
268}
269
270static inline void xprt_clear_connected(struct rpc_xprt *xprt)
271{
272 clear_bit(XPRT_CONNECTED, &xprt->state);
273}
274
275static inline int xprt_connected(struct rpc_xprt *xprt)
276{
277 return test_bit(XPRT_CONNECTED, &xprt->state);
278}
279
280static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
281{
282 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
283}
284
285static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
286{
287 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
288}
289
290static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
291{
292 smp_mb__before_clear_bit();
293 clear_bit(XPRT_CONNECTING, &xprt->state);
294 smp_mb__after_clear_bit();
295}
296
297static inline int xprt_connecting(struct rpc_xprt *xprt)
298{
299 return test_bit(XPRT_CONNECTING, &xprt->state);
300}
301
302static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
303{
304 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
305}
1da177e4 306
ec739ef0
CL
307static inline void xprt_set_bound(struct rpc_xprt *xprt)
308{
309 test_and_set_bit(XPRT_BOUND, &xprt->state);
310}
311
312static inline int xprt_bound(struct rpc_xprt *xprt)
313{
314 return test_bit(XPRT_BOUND, &xprt->state);
315}
316
317static inline void xprt_clear_bound(struct rpc_xprt *xprt)
318{
319 clear_bit(XPRT_BOUND, &xprt->state);
320}
321
4a68179d
CL
322static inline void xprt_clear_binding(struct rpc_xprt *xprt)
323{
324 smp_mb__before_clear_bit();
325 clear_bit(XPRT_BINDING, &xprt->state);
326 smp_mb__after_clear_bit();
327}
328
329static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
330{
331 return test_and_set_bit(XPRT_BINDING, &xprt->state);
332}
333
1da177e4
LT
334#endif /* __KERNEL__*/
335
336#endif /* _LINUX_SUNRPC_XPRT_H */
This page took 0.739786 seconds and 5 git commands to generate.