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