kvm tools, setup: Create private directory
[linux-2.6/next.git] / include / linux / sunrpc / xprt.h
blob81cce3b3ee668195f406988cf35ef43394b8e846
1 /*
2 * linux/include/linux/sunrpc/xprt.h
4 * Declarations for the RPC transport interface.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
7 */
9 #ifndef _LINUX_SUNRPC_XPRT_H
10 #define _LINUX_SUNRPC_XPRT_H
12 #include <linux/uio.h>
13 #include <linux/socket.h>
14 #include <linux/in.h>
15 #include <linux/ktime.h>
16 #include <linux/sunrpc/sched.h>
17 #include <linux/sunrpc/xdr.h>
18 #include <linux/sunrpc/msg_prot.h>
20 #ifdef __KERNEL__
22 #define RPC_MIN_SLOT_TABLE (2U)
23 #define RPC_DEF_SLOT_TABLE (16U)
24 #define RPC_MAX_SLOT_TABLE (128U)
27 * This describes a timeout strategy
29 struct 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;
37 enum rpc_display_format_t {
38 RPC_DISPLAY_ADDR = 0,
39 RPC_DISPLAY_PORT,
40 RPC_DISPLAY_PROTO,
41 RPC_DISPLAY_HEX_ADDR,
42 RPC_DISPLAY_HEX_PORT,
43 RPC_DISPLAY_NETID,
44 RPC_DISPLAY_MAX,
47 struct rpc_task;
48 struct rpc_xprt;
49 struct seq_file;
52 * This describes a complete RPC request
54 struct rpc_rqst {
56 * This is the user-visible part
58 struct rpc_xprt * rq_xprt; /* RPC client */
59 struct xdr_buf rq_snd_buf; /* send buffer */
60 struct xdr_buf rq_rcv_buf; /* recv buffer */
63 * This is the private part
65 struct rpc_task * rq_task; /* RPC task data */
66 struct rpc_cred * rq_cred; /* Bound cred */
67 __be32 rq_xid; /* request XID */
68 int rq_cong; /* has incremented xprt->cong */
69 u32 rq_seqno; /* gss seq no. used on req. */
70 int rq_enc_pages_num;
71 struct page **rq_enc_pages; /* scratch pages for use by
72 gss privacy code */
73 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
74 struct list_head rq_list;
76 __u32 * rq_buffer; /* XDR encode buffer */
77 size_t rq_callsize,
78 rq_rcvsize;
79 size_t rq_xmit_bytes_sent; /* total bytes sent */
80 size_t rq_reply_bytes_recvd; /* total reply bytes */
81 /* received */
83 struct xdr_buf rq_private_buf; /* The receive buffer
84 * used in the softirq.
86 unsigned long rq_majortimeo; /* major timeout alarm */
87 unsigned long rq_timeout; /* Current timeout value */
88 ktime_t rq_rtt; /* round-trip time */
89 unsigned int rq_retries; /* # of retries */
90 unsigned int rq_connect_cookie;
91 /* A cookie used to track the
92 state of the transport
93 connection */
96 * Partial send handling
98 u32 rq_bytes_sent; /* Bytes we have sent */
100 ktime_t rq_xtime; /* transmit time stamp */
101 int rq_ntrans;
103 #if defined(CONFIG_NFS_V4_1)
104 struct list_head rq_bc_list; /* Callback service list */
105 unsigned long rq_bc_pa_state; /* Backchannel prealloc state */
106 struct list_head rq_bc_pa_list; /* Backchannel prealloc list */
107 #endif /* CONFIG_NFS_V4_1 */
109 #define rq_svec rq_snd_buf.head
110 #define rq_slen rq_snd_buf.len
112 struct rpc_xprt_ops {
113 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
114 int (*reserve_xprt)(struct rpc_task *task);
115 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
116 void (*rpcbind)(struct rpc_task *task);
117 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
118 void (*connect)(struct rpc_task *task);
119 void * (*buf_alloc)(struct rpc_task *task, size_t size);
120 void (*buf_free)(void *buffer);
121 int (*send_request)(struct rpc_task *task);
122 void (*set_retrans_timeout)(struct rpc_task *task);
123 void (*timer)(struct rpc_task *task);
124 void (*release_request)(struct rpc_task *task);
125 void (*close)(struct rpc_xprt *xprt);
126 void (*destroy)(struct rpc_xprt *xprt);
127 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
131 * RPC transport identifiers
133 * To preserve compatibility with the historical use of raw IP protocol
134 * id's for transport selection, UDP and TCP identifiers are specified
135 * with the previous values. No such restriction exists for new transports,
136 * except that they may not collide with these values (17 and 6,
137 * respectively).
139 #define XPRT_TRANSPORT_BC (1 << 31)
140 enum xprt_transports {
141 XPRT_TRANSPORT_UDP = IPPROTO_UDP,
142 XPRT_TRANSPORT_TCP = IPPROTO_TCP,
143 XPRT_TRANSPORT_BC_TCP = IPPROTO_TCP | XPRT_TRANSPORT_BC,
144 XPRT_TRANSPORT_RDMA = 256,
145 XPRT_TRANSPORT_LOCAL = 257,
148 struct rpc_xprt {
149 atomic_t count; /* Reference count */
150 struct rpc_xprt_ops * ops; /* transport methods */
152 const struct rpc_timeout *timeout; /* timeout parms */
153 struct sockaddr_storage addr; /* server address */
154 size_t addrlen; /* size of server address */
155 int prot; /* IP protocol */
157 unsigned long cong; /* current congestion */
158 unsigned long cwnd; /* congestion window */
160 size_t max_payload; /* largest RPC payload size,
161 in bytes */
162 unsigned int tsh_size; /* size of transport specific
163 header */
165 struct rpc_wait_queue binding; /* requests waiting on rpcbind */
166 struct rpc_wait_queue sending; /* requests waiting to send */
167 struct rpc_wait_queue resend; /* requests waiting to resend */
168 struct rpc_wait_queue pending; /* requests in flight */
169 struct rpc_wait_queue backlog; /* waiting for slot */
170 struct list_head free; /* free slots */
171 struct rpc_rqst * slot; /* slot table storage */
172 unsigned int max_reqs; /* total slots */
173 unsigned long state; /* transport state */
174 unsigned char shutdown : 1, /* being shut down */
175 resvport : 1; /* use a reserved port */
176 unsigned int bind_index; /* bind function index */
179 * Connection of transports
181 unsigned long bind_timeout,
182 reestablish_timeout;
183 unsigned int connect_cookie; /* A cookie that gets bumped
184 every time the transport
185 is reconnected */
188 * Disconnection of idle transports
190 struct work_struct task_cleanup;
191 struct timer_list timer;
192 unsigned long last_used,
193 idle_timeout;
196 * Send stuff
198 spinlock_t transport_lock; /* lock transport info */
199 spinlock_t reserve_lock; /* lock slot table */
200 u32 xid; /* Next XID value to use */
201 struct rpc_task * snd_task; /* Task blocked in send */
202 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
203 #if defined(CONFIG_NFS_V4_1)
204 struct svc_serv *bc_serv; /* The RPC service which will */
205 /* process the callback */
206 unsigned int bc_alloc_count; /* Total number of preallocs */
207 spinlock_t bc_pa_lock; /* Protects the preallocated
208 * items */
209 struct list_head bc_pa_list; /* List of preallocated
210 * backchannel rpc_rqst's */
211 #endif /* CONFIG_NFS_V4_1 */
212 struct list_head recv;
214 struct {
215 unsigned long bind_count, /* total number of binds */
216 connect_count, /* total number of connects */
217 connect_start, /* connect start timestamp */
218 connect_time, /* jiffies waiting for connect */
219 sends, /* how many complete requests */
220 recvs, /* how many complete requests */
221 bad_xids; /* lookup_rqst didn't find XID */
223 unsigned long long req_u, /* average requests on the wire */
224 bklog_u; /* backlog queue utilization */
225 } stat;
227 struct net *xprt_net;
228 const char *address_strings[RPC_DISPLAY_MAX];
231 #if defined(CONFIG_NFS_V4_1)
233 * Backchannel flags
235 #define RPC_BC_PA_IN_USE 0x0001 /* Preallocated backchannel */
236 /* buffer in use */
237 #endif /* CONFIG_NFS_V4_1 */
239 #if defined(CONFIG_NFS_V4_1)
240 static inline int bc_prealloc(struct rpc_rqst *req)
242 return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state);
244 #else
245 static inline int bc_prealloc(struct rpc_rqst *req)
247 return 0;
249 #endif /* CONFIG_NFS_V4_1 */
251 struct xprt_create {
252 int ident; /* XPRT_TRANSPORT identifier */
253 struct net * net;
254 struct sockaddr * srcaddr; /* optional local address */
255 struct sockaddr * dstaddr; /* remote peer address */
256 size_t addrlen;
257 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
260 struct xprt_class {
261 struct list_head list;
262 int ident; /* XPRT_TRANSPORT identifier */
263 struct rpc_xprt * (*setup)(struct xprt_create *);
264 struct module *owner;
265 char name[32];
269 * Generic internal transport functions
271 struct rpc_xprt *xprt_create_transport(struct xprt_create *args);
272 void xprt_connect(struct rpc_task *task);
273 void xprt_reserve(struct rpc_task *task);
274 int xprt_reserve_xprt(struct rpc_task *task);
275 int xprt_reserve_xprt_cong(struct rpc_task *task);
276 int xprt_prepare_transmit(struct rpc_task *task);
277 void xprt_transmit(struct rpc_task *task);
278 void xprt_end_transmit(struct rpc_task *task);
279 int xprt_adjust_timeout(struct rpc_rqst *req);
280 void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
281 void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
282 void xprt_release(struct rpc_task *task);
283 struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
284 void xprt_put(struct rpc_xprt *xprt);
285 struct rpc_xprt * xprt_alloc(struct net *net, int size, int max_req);
286 void xprt_free(struct rpc_xprt *);
288 static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
290 return p + xprt->tsh_size;
294 * Transport switch helper functions
296 int xprt_register_transport(struct xprt_class *type);
297 int xprt_unregister_transport(struct xprt_class *type);
298 int xprt_load_transport(const char *);
299 void xprt_set_retrans_timeout_def(struct rpc_task *task);
300 void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
301 void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
302 void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action);
303 void xprt_write_space(struct rpc_xprt *xprt);
304 void xprt_adjust_cwnd(struct rpc_task *task, int result);
305 struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
306 void xprt_complete_rqst(struct rpc_task *task, int copied);
307 void xprt_release_rqst_cong(struct rpc_task *task);
308 void xprt_disconnect_done(struct rpc_xprt *xprt);
309 void xprt_force_disconnect(struct rpc_xprt *xprt);
310 void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);
313 * Reserved bit positions in xprt->state
315 #define XPRT_LOCKED (0)
316 #define XPRT_CONNECTED (1)
317 #define XPRT_CONNECTING (2)
318 #define XPRT_CLOSE_WAIT (3)
319 #define XPRT_BOUND (4)
320 #define XPRT_BINDING (5)
321 #define XPRT_CLOSING (6)
322 #define XPRT_CONNECTION_ABORT (7)
323 #define XPRT_CONNECTION_CLOSE (8)
324 #define XPRT_INITIALIZED (9)
326 static inline void xprt_set_connected(struct rpc_xprt *xprt)
328 set_bit(XPRT_CONNECTED, &xprt->state);
331 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
333 clear_bit(XPRT_CONNECTED, &xprt->state);
336 static inline int xprt_connected(struct rpc_xprt *xprt)
338 return test_bit(XPRT_CONNECTED, &xprt->state);
341 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
343 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
346 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
348 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
351 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
353 smp_mb__before_clear_bit();
354 clear_bit(XPRT_CONNECTING, &xprt->state);
355 smp_mb__after_clear_bit();
358 static inline int xprt_connecting(struct rpc_xprt *xprt)
360 return test_bit(XPRT_CONNECTING, &xprt->state);
363 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
365 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
368 static inline void xprt_set_bound(struct rpc_xprt *xprt)
370 test_and_set_bit(XPRT_BOUND, &xprt->state);
373 static inline int xprt_bound(struct rpc_xprt *xprt)
375 return test_bit(XPRT_BOUND, &xprt->state);
378 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
380 clear_bit(XPRT_BOUND, &xprt->state);
383 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
385 smp_mb__before_clear_bit();
386 clear_bit(XPRT_BINDING, &xprt->state);
387 smp_mb__after_clear_bit();
390 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
392 return test_and_set_bit(XPRT_BINDING, &xprt->state);
395 #endif /* __KERNEL__*/
397 #endif /* _LINUX_SUNRPC_XPRT_H */