blob: 8372ab8fc9b58884631bf05471e7070ca4fec667 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/include/linux/sunrpc/xprt.h
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070018extern 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
Chuck Levera246b012005-08-11 16:25:23 -040025/*
26 * RPC call and reply header size as number of 32bit words (verifier
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 * size computed separately)
28 */
29#define RPC_CALLHDRSIZE 6
30#define RPC_REPHDRSIZE 4
31
32/*
Chuck Lever529b33c2005-08-25 16:25:54 -070033 * 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)
Chuck Lever8e037092006-08-22 20:06:15 -040040#define RPC_DEF_MIN_RESVPORT (665U)
Chuck Lever529b33c2005-08-25 16:25:54 -070041#define RPC_DEF_MAX_RESVPORT (1023U)
42
43/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 * 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
Chuck Leveredb267a2006-08-22 20:06:18 -040054enum 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
Chuck Lever529b33c2005-08-25 16:25:54 -070062struct rpc_task;
63struct rpc_xprt;
Trond Myklebuste99170f2006-04-18 13:21:42 -040064struct seq_file;
Chuck Lever529b33c2005-08-25 16:25:54 -070065
Linus Torvalds1da177e2005-04-16 15:20:36 -070066/*
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. */
J. Bruce Fieldsead5e1c2005-10-13 16:54:43 -040085 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 struct list_head rq_list;
90
Chuck Lever02107142006-01-03 09:55:49 +010091 __u32 * rq_buffer; /* XDR encode buffer */
92 size_t rq_bufsize;
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101 /*
102 * Partial send handling
103 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 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
Chuck Levera246b012005-08-11 16:25:23 -0400112struct rpc_xprt_ops {
Chuck Lever470056c2005-08-25 16:25:56 -0700113 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
Chuck Leveredb267a2006-08-22 20:06:18 -0400114 char * (*print_addr)(struct rpc_xprt *xprt, enum rpc_display_format_t format);
Chuck Lever12a80462005-08-25 16:25:51 -0700115 int (*reserve_xprt)(struct rpc_task *task);
Chuck Lever49e9a892005-08-25 16:25:51 -0700116 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
Chuck Leverbbf7c1d2006-08-22 20:06:16 -0400117 void (*rpcbind)(struct rpc_task *task);
Chuck Lever92200412006-01-03 09:55:51 +0100118 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
Chuck Levera246b012005-08-11 16:25:23 -0400119 void (*connect)(struct rpc_task *task);
Chuck Lever02107142006-01-03 09:55:49 +0100120 void * (*buf_alloc)(struct rpc_task *task, size_t size);
121 void (*buf_free)(struct rpc_task *task);
Chuck Levera246b012005-08-11 16:25:23 -0400122 int (*send_request)(struct rpc_task *task);
Chuck Leverfe3aca22005-08-25 16:25:50 -0700123 void (*set_retrans_timeout)(struct rpc_task *task);
Chuck Lever46c0ee82005-08-25 16:25:52 -0700124 void (*timer)(struct rpc_task *task);
Chuck Levera58dd392005-08-25 16:25:53 -0700125 void (*release_request)(struct rpc_task *task);
Chuck Levera246b012005-08-11 16:25:23 -0400126 void (*close)(struct rpc_xprt *xprt);
127 void (*destroy)(struct rpc_xprt *xprt);
Chuck Lever262ca072006-03-20 13:44:16 -0500128 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
Chuck Levera246b012005-08-11 16:25:23 -0400129};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131struct rpc_xprt {
Chuck Levera246b012005-08-11 16:25:23 -0400132 struct rpc_xprt_ops * ops; /* transport methods */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 struct socket * sock; /* BSD socket layer */
134 struct sock * inet; /* INET layer */
135
136 struct rpc_timeout timeout; /* timeout parms */
137 struct sockaddr_in addr; /* server address */
138 int prot; /* IP protocol */
139
140 unsigned long cong; /* current congestion */
141 unsigned long cwnd; /* congestion window */
142
Chuck Lever470056c2005-08-25 16:25:56 -0700143 size_t rcvsize, /* transport rcv buffer size */
Chuck Lever55aa4f52005-08-11 16:25:47 -0400144 sndsize; /* transport send buffer size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146 size_t max_payload; /* largest RPC payload size,
147 in bytes */
Chuck Lever808012f2005-08-25 16:25:49 -0700148 unsigned int tsh_size; /* size of transport specific
149 header */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Chuck Lever4a681792006-08-22 20:06:15 -0400151 struct rpc_wait_queue binding; /* requests waiting on rpcbind */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 struct rpc_wait_queue sending; /* requests waiting to send */
153 struct rpc_wait_queue resend; /* requests waiting to resend */
154 struct rpc_wait_queue pending; /* requests in flight */
155 struct rpc_wait_queue backlog; /* waiting for slot */
156 struct list_head free; /* free slots */
157 struct rpc_rqst * slot; /* slot table storage */
158 unsigned int max_reqs; /* total slots */
Chuck Lever2226feb2005-08-11 16:25:38 -0400159 unsigned long state; /* transport state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 unsigned char shutdown : 1, /* being shut down */
Chuck Lever43118c22005-08-25 16:25:49 -0700161 resvport : 1; /* use a reserved port */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163 /*
164 * XID
165 */
166 __u32 xid; /* Next XID value to use */
167
168 /*
169 * State of TCP reply receive stuff
170 */
171 u32 tcp_recm, /* Fragment header */
172 tcp_xid, /* Current XID */
173 tcp_reclen, /* fragment length */
174 tcp_offset; /* fragment offset */
175 unsigned long tcp_copied, /* copied to request */
176 tcp_flags;
177 /*
Chuck Lever55aa4f52005-08-11 16:25:47 -0400178 * Connection of transports
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 */
Chuck Lever03bf4b72005-08-25 16:25:55 -0700180 unsigned long connect_timeout,
181 bind_timeout,
182 reestablish_timeout;
Chuck Lever55aa4f52005-08-11 16:25:47 -0400183 struct work_struct connect_worker;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 unsigned short port;
Chuck Lever03bf4b72005-08-25 16:25:55 -0700185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 /*
Chuck Lever55aa4f52005-08-11 16:25:47 -0400187 * Disconnection of idle transports
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 */
189 struct work_struct task_cleanup;
190 struct timer_list timer;
Chuck Lever03bf4b72005-08-25 16:25:55 -0700191 unsigned long last_used,
192 idle_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194 /*
195 * Send stuff
196 */
Chuck Lever4a0f8c02005-08-11 16:25:32 -0400197 spinlock_t transport_lock; /* lock transport info */
Chuck Lever5dc07722005-08-11 16:25:35 -0400198 spinlock_t reserve_lock; /* lock slot table */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 struct rpc_task * snd_task; /* Task blocked in send */
200
201 struct list_head recv;
202
Chuck Lever262ca072006-03-20 13:44:16 -0500203 struct {
204 unsigned long bind_count, /* total number of binds */
205 connect_count, /* total number of connects */
206 connect_start, /* connect start timestamp */
207 connect_time, /* jiffies waiting for connect */
208 sends, /* how many complete requests */
209 recvs, /* how many complete requests */
210 bad_xids; /* lookup_rqst didn't find XID */
211
212 unsigned long long req_u, /* average requests on the wire */
213 bklog_u; /* backlog queue utilization */
214 } stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216 void (*old_data_ready)(struct sock *, int);
217 void (*old_state_change)(struct sock *);
218 void (*old_write_space)(struct sock *);
Chuck Leveredb267a2006-08-22 20:06:18 -0400219
220 char * address_strings[RPC_DISPLAY_MAX];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221};
222
Chuck Levera246b012005-08-11 16:25:23 -0400223#define XPRT_LAST_FRAG (1 << 0)
224#define XPRT_COPY_RECM (1 << 1)
225#define XPRT_COPY_XID (1 << 2)
226#define XPRT_COPY_DATA (1 << 3)
227
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228#ifdef __KERNEL__
229
Chuck Lever55aa4f52005-08-11 16:25:47 -0400230/*
231 * Transport operations used by ULPs
232 */
233struct rpc_xprt * xprt_create_proto(int proto, struct sockaddr_in *addr, struct rpc_timeout *to);
234void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
235
236/*
237 * Generic internal transport functions
238 */
239void xprt_connect(struct rpc_task *task);
240void xprt_reserve(struct rpc_task *task);
Chuck Lever12a80462005-08-25 16:25:51 -0700241int xprt_reserve_xprt(struct rpc_task *task);
242int xprt_reserve_xprt_cong(struct rpc_task *task);
Chuck Lever55aa4f52005-08-11 16:25:47 -0400243int xprt_prepare_transmit(struct rpc_task *task);
244void xprt_transmit(struct rpc_task *task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -0400245void xprt_end_transmit(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246int xprt_adjust_timeout(struct rpc_rqst *req);
Chuck Lever49e9a892005-08-25 16:25:51 -0700247void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
248void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
Chuck Lever55aa4f52005-08-11 16:25:47 -0400249void xprt_release(struct rpc_task *task);
250int xprt_destroy(struct rpc_xprt *xprt);
251
Chuck Lever808012f2005-08-25 16:25:49 -0700252static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p)
253{
254 return p + xprt->tsh_size;
255}
256
Chuck Lever55aa4f52005-08-11 16:25:47 -0400257/*
258 * Transport switch helper functions
259 */
Chuck Leverfe3aca22005-08-25 16:25:50 -0700260void xprt_set_retrans_timeout_def(struct rpc_task *task);
261void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
Chuck Lever55aa4f52005-08-11 16:25:47 -0400262void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
Chuck Leverc7b2cae2005-08-11 16:25:50 -0400263void xprt_wait_for_buffer_space(struct rpc_task *task);
264void xprt_write_space(struct rpc_xprt *xprt);
Chuck Lever1570c1e2005-08-25 16:25:52 -0700265void xprt_update_rtt(struct rpc_task *task);
Chuck Lever46c0ee82005-08-25 16:25:52 -0700266void xprt_adjust_cwnd(struct rpc_task *task, int result);
Chuck Lever55aa4f52005-08-11 16:25:47 -0400267struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
Chuck Lever1570c1e2005-08-25 16:25:52 -0700268void xprt_complete_rqst(struct rpc_task *task, int copied);
Chuck Levera58dd392005-08-25 16:25:53 -0700269void xprt_release_rqst_cong(struct rpc_task *task);
Chuck Lever55aa4f52005-08-11 16:25:47 -0400270void xprt_disconnect(struct rpc_xprt *xprt);
271
272/*
273 * Socket transport setup operations
274 */
275int xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
276int xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Chuck Lever2226feb2005-08-11 16:25:38 -0400278/*
279 * Reserved bit positions in xprt->state
280 */
281#define XPRT_LOCKED (0)
282#define XPRT_CONNECTED (1)
283#define XPRT_CONNECTING (2)
Trond Myklebust632e3bd2006-01-03 09:55:55 +0100284#define XPRT_CLOSE_WAIT (3)
Chuck Leverec739ef2006-08-22 20:06:15 -0400285#define XPRT_BOUND (4)
Chuck Lever4a681792006-08-22 20:06:15 -0400286#define XPRT_BINDING (5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
Chuck Lever2226feb2005-08-11 16:25:38 -0400288static inline void xprt_set_connected(struct rpc_xprt *xprt)
289{
290 set_bit(XPRT_CONNECTED, &xprt->state);
291}
292
293static inline void xprt_clear_connected(struct rpc_xprt *xprt)
294{
295 clear_bit(XPRT_CONNECTED, &xprt->state);
296}
297
298static inline int xprt_connected(struct rpc_xprt *xprt)
299{
300 return test_bit(XPRT_CONNECTED, &xprt->state);
301}
302
303static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
304{
305 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
306}
307
308static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
309{
310 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
311}
312
313static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
314{
315 smp_mb__before_clear_bit();
316 clear_bit(XPRT_CONNECTING, &xprt->state);
317 smp_mb__after_clear_bit();
318}
319
320static inline int xprt_connecting(struct rpc_xprt *xprt)
321{
322 return test_bit(XPRT_CONNECTING, &xprt->state);
323}
324
325static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
326{
327 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
328}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
Chuck Leverec739ef2006-08-22 20:06:15 -0400330static inline void xprt_set_bound(struct rpc_xprt *xprt)
331{
332 test_and_set_bit(XPRT_BOUND, &xprt->state);
333}
334
335static inline int xprt_bound(struct rpc_xprt *xprt)
336{
337 return test_bit(XPRT_BOUND, &xprt->state);
338}
339
340static inline void xprt_clear_bound(struct rpc_xprt *xprt)
341{
342 clear_bit(XPRT_BOUND, &xprt->state);
343}
344
Chuck Lever4a681792006-08-22 20:06:15 -0400345static inline void xprt_clear_binding(struct rpc_xprt *xprt)
346{
347 smp_mb__before_clear_bit();
348 clear_bit(XPRT_BINDING, &xprt->state);
349 smp_mb__after_clear_bit();
350}
351
352static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
353{
354 return test_and_set_bit(XPRT_BINDING, &xprt->state);
355}
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357#endif /* __KERNEL__*/
358
359#endif /* _LINUX_SUNRPC_XPRT_H */