1
2
3
4
5
6
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/kref.h>
16#include <linux/sunrpc/sched.h>
17#include <linux/sunrpc/xdr.h>
18#include <linux/sunrpc/msg_prot.h>
19
20#ifdef __KERNEL__
21
22#define RPC_MIN_SLOT_TABLE (2U)
23#define RPC_DEF_SLOT_TABLE (16U)
24#define RPC_MAX_SLOT_TABLE (128U)
25
26
27
28
29struct rpc_timeout {
30 unsigned long to_initval,
31 to_maxval,
32 to_increment;
33 unsigned int to_retries;
34 unsigned char to_exponential;
35};
36
37enum rpc_display_format_t {
38 RPC_DISPLAY_ADDR = 0,
39 RPC_DISPLAY_PORT,
40 RPC_DISPLAY_PROTO,
41 RPC_DISPLAY_ALL,
42 RPC_DISPLAY_HEX_ADDR,
43 RPC_DISPLAY_HEX_PORT,
44 RPC_DISPLAY_UNIVERSAL_ADDR,
45 RPC_DISPLAY_NETID,
46 RPC_DISPLAY_MAX,
47};
48
49struct rpc_task;
50struct rpc_xprt;
51struct seq_file;
52
53
54
55
56struct rpc_rqst {
57
58
59
60 struct rpc_xprt * rq_xprt;
61 struct xdr_buf rq_snd_buf;
62 struct xdr_buf rq_rcv_buf;
63
64
65
66
67 struct rpc_task * rq_task;
68 __be32 rq_xid;
69 int rq_cong;
70 int rq_received;
71 u32 rq_seqno;
72 int rq_enc_pages_num;
73 struct page **rq_enc_pages;
74
75 void (*rq_release_snd_buf)(struct rpc_rqst *);
76 struct list_head rq_list;
77
78 __u32 * rq_buffer;
79 size_t rq_bufsize,
80 rq_callsize,
81 rq_rcvsize;
82
83 struct xdr_buf rq_private_buf;
84
85
86 unsigned long rq_majortimeo;
87 unsigned long rq_timeout;
88 unsigned int rq_retries;
89
90
91
92
93 u32 rq_bytes_sent;
94
95 unsigned long rq_xtime;
96 int rq_ntrans;
97};
98#define rq_svec rq_snd_buf.head
99#define rq_slen rq_snd_buf.len
100
101struct rpc_xprt_ops {
102 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
103 int (*reserve_xprt)(struct rpc_task *task);
104 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
105 void (*rpcbind)(struct rpc_task *task);
106 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
107 void (*connect)(struct rpc_task *task);
108 void * (*buf_alloc)(struct rpc_task *task, size_t size);
109 void (*buf_free)(void *buffer);
110 int (*send_request)(struct rpc_task *task);
111 void (*set_retrans_timeout)(struct rpc_task *task);
112 void (*timer)(struct rpc_task *task);
113 void (*release_request)(struct rpc_task *task);
114 void (*close)(struct rpc_xprt *xprt);
115 void (*destroy)(struct rpc_xprt *xprt);
116 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
117};
118
119struct rpc_xprt {
120 struct kref kref;
121 struct rpc_xprt_ops * ops;
122
123 struct rpc_timeout timeout;
124 struct sockaddr_storage addr;
125 size_t addrlen;
126 int prot;
127
128 unsigned long cong;
129 unsigned long cwnd;
130
131 size_t max_payload;
132
133 unsigned int tsh_size;
134
135
136 struct rpc_wait_queue binding;
137 struct rpc_wait_queue sending;
138 struct rpc_wait_queue resend;
139 struct rpc_wait_queue pending;
140 struct rpc_wait_queue backlog;
141 struct list_head free;
142 struct rpc_rqst * slot;
143 unsigned int max_reqs;
144 unsigned long state;
145 unsigned char shutdown : 1,
146 resvport : 1;
147 unsigned int bind_index;
148
149
150
151
152 unsigned long connect_timeout,
153 bind_timeout,
154 reestablish_timeout;
155
156
157
158
159 struct work_struct task_cleanup;
160 struct timer_list timer;
161 unsigned long last_used,
162 idle_timeout;
163
164
165
166
167 spinlock_t transport_lock;
168 spinlock_t reserve_lock;
169 u32 xid;
170 struct rpc_task * snd_task;
171 struct list_head recv;
172
173 struct {
174 unsigned long bind_count,
175 connect_count,
176 connect_start,
177 connect_time,
178 sends,
179 recvs,
180 bad_xids;
181
182 unsigned long long req_u,
183 bklog_u;
184 } stat;
185
186 char * address_strings[RPC_DISPLAY_MAX];
187};
188
189struct xprt_create {
190 int ident;
191 struct sockaddr * srcaddr;
192 struct sockaddr * dstaddr;
193 size_t addrlen;
194 struct rpc_timeout * timeout;
195};
196
197struct xprt_class {
198 struct list_head list;
199 int ident;
200 struct rpc_xprt * (*setup)(struct xprt_create *);
201 struct module *owner;
202 char name[32];
203};
204
205
206
207
208void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
209
210
211
212
213struct rpc_xprt *xprt_create_transport(struct xprt_create *args);
214void xprt_connect(struct rpc_task *task);
215void xprt_reserve(struct rpc_task *task);
216int xprt_reserve_xprt(struct rpc_task *task);
217int xprt_reserve_xprt_cong(struct rpc_task *task);
218int xprt_prepare_transmit(struct rpc_task *task);
219void xprt_transmit(struct rpc_task *task);
220void xprt_end_transmit(struct rpc_task *task);
221int xprt_adjust_timeout(struct rpc_rqst *req);
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);
224void xprt_release(struct rpc_task *task);
225struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
226void xprt_put(struct rpc_xprt *xprt);
227
228static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
229{
230 return p + xprt->tsh_size;
231}
232
233
234
235
236int xprt_register_transport(struct xprt_class *type);
237int xprt_unregister_transport(struct xprt_class *type);
238void xprt_set_retrans_timeout_def(struct rpc_task *task);
239void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
240void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
241void xprt_wait_for_buffer_space(struct rpc_task *task);
242void xprt_write_space(struct rpc_xprt *xprt);
243void xprt_update_rtt(struct rpc_task *task);
244void xprt_adjust_cwnd(struct rpc_task *task, int result);
245struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
246void xprt_complete_rqst(struct rpc_task *task, int copied);
247void xprt_release_rqst_cong(struct rpc_task *task);
248void xprt_disconnect(struct rpc_xprt *xprt);
249
250
251
252
253#define XPRT_LOCKED (0)
254#define XPRT_CONNECTED (1)
255#define XPRT_CONNECTING (2)
256#define XPRT_CLOSE_WAIT (3)
257#define XPRT_BOUND (4)
258#define XPRT_BINDING (5)
259
260static inline void xprt_set_connected(struct rpc_xprt *xprt)
261{
262 set_bit(XPRT_CONNECTED, &xprt->state);
263}
264
265static inline void xprt_clear_connected(struct rpc_xprt *xprt)
266{
267 clear_bit(XPRT_CONNECTED, &xprt->state);
268}
269
270static inline int xprt_connected(struct rpc_xprt *xprt)
271{
272 return test_bit(XPRT_CONNECTED, &xprt->state);
273}
274
275static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
276{
277 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
278}
279
280static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
281{
282 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
283}
284
285static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
286{
287 smp_mb__before_clear_bit();
288 clear_bit(XPRT_CONNECTING, &xprt->state);
289 smp_mb__after_clear_bit();
290}
291
292static inline int xprt_connecting(struct rpc_xprt *xprt)
293{
294 return test_bit(XPRT_CONNECTING, &xprt->state);
295}
296
297static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
298{
299 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
300}
301
302static inline void xprt_set_bound(struct rpc_xprt *xprt)
303{
304 test_and_set_bit(XPRT_BOUND, &xprt->state);
305}
306
307static inline int xprt_bound(struct rpc_xprt *xprt)
308{
309 return test_bit(XPRT_BOUND, &xprt->state);
310}
311
312static inline void xprt_clear_bound(struct rpc_xprt *xprt)
313{
314 clear_bit(XPRT_BOUND, &xprt->state);
315}
316
317static inline void xprt_clear_binding(struct rpc_xprt *xprt)
318{
319 smp_mb__before_clear_bit();
320 clear_bit(XPRT_BINDING, &xprt->state);
321 smp_mb__after_clear_bit();
322}
323
324static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
325{
326 return test_and_set_bit(XPRT_BINDING, &xprt->state);
327}
328
329#endif
330
331#endif
332