1
2
3
4
5
6
7
8
9
10#ifndef _LINUX_SUNRPC_XPRT_H
11#define _LINUX_SUNRPC_XPRT_H
12
13#include <linux/uio.h>
14#include <linux/socket.h>
15#include <linux/in.h>
16#include <linux/ktime.h>
17#include <linux/kref.h>
18#include <linux/sunrpc/sched.h>
19#include <linux/sunrpc/xdr.h>
20#include <linux/sunrpc/msg_prot.h>
21
22#define RPC_MIN_SLOT_TABLE (2U)
23#define RPC_DEF_SLOT_TABLE (16U)
24#define RPC_MAX_SLOT_TABLE_LIMIT (65536U)
25#define RPC_MAX_SLOT_TABLE RPC_MAX_SLOT_TABLE_LIMIT
26
27#define RPC_CWNDSHIFT (8U)
28#define RPC_CWNDSCALE (1U << RPC_CWNDSHIFT)
29#define RPC_INITCWND RPC_CWNDSCALE
30#define RPC_MAXCWND(xprt) ((xprt)->max_reqs << RPC_CWNDSHIFT)
31#define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd)
32
33
34
35
36struct rpc_timeout {
37 unsigned long to_initval,
38 to_maxval,
39 to_increment;
40 unsigned int to_retries;
41 unsigned char to_exponential;
42};
43
44enum rpc_display_format_t {
45 RPC_DISPLAY_ADDR = 0,
46 RPC_DISPLAY_PORT,
47 RPC_DISPLAY_PROTO,
48 RPC_DISPLAY_HEX_ADDR,
49 RPC_DISPLAY_HEX_PORT,
50 RPC_DISPLAY_NETID,
51 RPC_DISPLAY_MAX,
52};
53
54struct rpc_task;
55struct rpc_xprt;
56struct xprt_class;
57struct seq_file;
58struct svc_serv;
59struct net;
60
61
62
63
64struct rpc_rqst {
65
66
67
68 struct rpc_xprt * rq_xprt;
69 struct xdr_buf rq_snd_buf;
70 struct xdr_buf rq_rcv_buf;
71
72
73
74
75 struct rpc_task * rq_task;
76 struct rpc_cred * rq_cred;
77 __be32 rq_xid;
78 int rq_cong;
79 u32 rq_seqno;
80 int rq_enc_pages_num;
81 struct page **rq_enc_pages;
82
83 void (*rq_release_snd_buf)(struct rpc_rqst *);
84
85 union {
86 struct list_head rq_list;
87 struct rb_node rq_recv;
88 };
89
90 struct list_head rq_xmit;
91 struct list_head rq_xmit2;
92
93 void *rq_buffer;
94 size_t rq_callsize;
95 void *rq_rbuffer;
96 size_t rq_rcvsize;
97 size_t rq_xmit_bytes_sent;
98 size_t rq_reply_bytes_recvd;
99
100
101 struct xdr_buf rq_private_buf;
102
103
104 unsigned long rq_majortimeo;
105 unsigned long rq_minortimeo;
106 unsigned long rq_timeout;
107 ktime_t rq_rtt;
108 unsigned int rq_retries;
109 unsigned int rq_connect_cookie;
110
111
112
113 atomic_t rq_pin;
114
115
116
117
118 u32 rq_bytes_sent;
119
120 ktime_t rq_xtime;
121 int rq_ntrans;
122
123#if defined(CONFIG_SUNRPC_BACKCHANNEL)
124 struct list_head rq_bc_list;
125 unsigned long rq_bc_pa_state;
126 struct list_head rq_bc_pa_list;
127#endif
128};
129#define rq_svec rq_snd_buf.head
130#define rq_slen rq_snd_buf.len
131
132struct rpc_xprt_ops {
133 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
134 int (*reserve_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
135 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
136 void (*alloc_slot)(struct rpc_xprt *xprt, struct rpc_task *task);
137 void (*free_slot)(struct rpc_xprt *xprt,
138 struct rpc_rqst *req);
139 void (*rpcbind)(struct rpc_task *task);
140 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
141 void (*connect)(struct rpc_xprt *xprt, struct rpc_task *task);
142 int (*buf_alloc)(struct rpc_task *task);
143 void (*buf_free)(struct rpc_task *task);
144 void (*prepare_request)(struct rpc_rqst *req);
145 int (*send_request)(struct rpc_rqst *req);
146 void (*wait_for_reply_request)(struct rpc_task *task);
147 void (*timer)(struct rpc_xprt *xprt, struct rpc_task *task);
148 void (*release_request)(struct rpc_task *task);
149 void (*close)(struct rpc_xprt *xprt);
150 void (*destroy)(struct rpc_xprt *xprt);
151 void (*set_connect_timeout)(struct rpc_xprt *xprt,
152 unsigned long connect_timeout,
153 unsigned long reconnect_timeout);
154 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
155 int (*enable_swap)(struct rpc_xprt *xprt);
156 void (*disable_swap)(struct rpc_xprt *xprt);
157 void (*inject_disconnect)(struct rpc_xprt *xprt);
158 int (*bc_setup)(struct rpc_xprt *xprt,
159 unsigned int min_reqs);
160 size_t (*bc_maxpayload)(struct rpc_xprt *xprt);
161 unsigned int (*bc_num_slots)(struct rpc_xprt *xprt);
162 void (*bc_free_rqst)(struct rpc_rqst *rqst);
163 void (*bc_destroy)(struct rpc_xprt *xprt,
164 unsigned int max_reqs);
165};
166
167
168
169
170
171
172
173
174
175
176#define XPRT_TRANSPORT_BC (1 << 31)
177enum xprt_transports {
178 XPRT_TRANSPORT_UDP = IPPROTO_UDP,
179 XPRT_TRANSPORT_TCP = IPPROTO_TCP,
180 XPRT_TRANSPORT_BC_TCP = IPPROTO_TCP | XPRT_TRANSPORT_BC,
181 XPRT_TRANSPORT_RDMA = 256,
182 XPRT_TRANSPORT_BC_RDMA = XPRT_TRANSPORT_RDMA | XPRT_TRANSPORT_BC,
183 XPRT_TRANSPORT_LOCAL = 257,
184};
185
186struct rpc_sysfs_xprt;
187struct rpc_xprt {
188 struct kref kref;
189 const struct rpc_xprt_ops *ops;
190 unsigned int id;
191
192 const struct rpc_timeout *timeout;
193 struct sockaddr_storage addr;
194 size_t addrlen;
195 int prot;
196
197 unsigned long cong;
198 unsigned long cwnd;
199
200 size_t max_payload;
201
202
203 struct rpc_wait_queue binding;
204 struct rpc_wait_queue sending;
205 struct rpc_wait_queue pending;
206 struct rpc_wait_queue backlog;
207 struct list_head free;
208 unsigned int max_reqs;
209 unsigned int min_reqs;
210 unsigned int num_reqs;
211 unsigned long state;
212 unsigned char resvport : 1,
213 reuseport : 1;
214 atomic_t swapper;
215
216 unsigned int bind_index;
217
218
219
220
221 struct list_head xprt_switch;
222
223
224
225
226 unsigned long bind_timeout,
227 reestablish_timeout;
228 unsigned int connect_cookie;
229
230
231
232
233
234
235 struct work_struct task_cleanup;
236 struct timer_list timer;
237 unsigned long last_used,
238 idle_timeout,
239 connect_timeout,
240 max_reconnect_timeout;
241
242
243
244
245 atomic_long_t queuelen;
246 spinlock_t transport_lock;
247 spinlock_t reserve_lock;
248 spinlock_t queue_lock;
249 u32 xid;
250 struct rpc_task * snd_task;
251
252 struct list_head xmit_queue;
253 atomic_long_t xmit_queuelen;
254
255 struct svc_xprt *bc_xprt;
256#if defined(CONFIG_SUNRPC_BACKCHANNEL)
257 struct svc_serv *bc_serv;
258
259 unsigned int bc_alloc_max;
260 unsigned int bc_alloc_count;
261 atomic_t bc_slot_count;
262 spinlock_t bc_pa_lock;
263
264 struct list_head bc_pa_list;
265
266#endif
267
268 struct rb_root recv_queue;
269
270 struct {
271 unsigned long bind_count,
272 connect_count,
273 connect_start,
274 connect_time,
275 sends,
276 recvs,
277 bad_xids,
278 max_slots;
279
280 unsigned long long req_u,
281 bklog_u,
282 sending_u,
283 pending_u;
284 } stat;
285
286 struct net *xprt_net;
287 const char *servername;
288 const char *address_strings[RPC_DISPLAY_MAX];
289#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
290 struct dentry *debugfs;
291 atomic_t inject_disconnect;
292#endif
293 struct rcu_head rcu;
294 const struct xprt_class *xprt_class;
295 struct rpc_sysfs_xprt *xprt_sysfs;
296 bool main;
297};
298
299#if defined(CONFIG_SUNRPC_BACKCHANNEL)
300
301
302
303#define RPC_BC_PA_IN_USE 0x0001
304
305#endif
306
307#if defined(CONFIG_SUNRPC_BACKCHANNEL)
308static inline int bc_prealloc(struct rpc_rqst *req)
309{
310 return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state);
311}
312#else
313static inline int bc_prealloc(struct rpc_rqst *req)
314{
315 return 0;
316}
317#endif
318
319#define XPRT_CREATE_INFINITE_SLOTS (1U)
320#define XPRT_CREATE_NO_IDLE_TIMEOUT (1U << 1)
321
322struct xprt_create {
323 int ident;
324 struct net * net;
325 struct sockaddr * srcaddr;
326 struct sockaddr * dstaddr;
327 size_t addrlen;
328 const char *servername;
329 struct svc_xprt *bc_xprt;
330 struct rpc_xprt_switch *bc_xps;
331 unsigned int flags;
332};
333
334struct xprt_class {
335 struct list_head list;
336 int ident;
337 struct rpc_xprt * (*setup)(struct xprt_create *);
338 struct module *owner;
339 char name[32];
340 const char * netid[];
341};
342
343
344
345
346struct rpc_xprt *xprt_create_transport(struct xprt_create *args);
347void xprt_connect(struct rpc_task *task);
348unsigned long xprt_reconnect_delay(const struct rpc_xprt *xprt);
349void xprt_reconnect_backoff(struct rpc_xprt *xprt,
350 unsigned long init_to);
351void xprt_reserve(struct rpc_task *task);
352void xprt_retry_reserve(struct rpc_task *task);
353int xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
354int xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
355void xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task);
356void xprt_free_slot(struct rpc_xprt *xprt,
357 struct rpc_rqst *req);
358void xprt_request_prepare(struct rpc_rqst *req);
359bool xprt_prepare_transmit(struct rpc_task *task);
360void xprt_request_enqueue_transmit(struct rpc_task *task);
361void xprt_request_enqueue_receive(struct rpc_task *task);
362void xprt_request_wait_receive(struct rpc_task *task);
363void xprt_request_dequeue_xprt(struct rpc_task *task);
364bool xprt_request_need_retransmit(struct rpc_task *task);
365void xprt_transmit(struct rpc_task *task);
366void xprt_end_transmit(struct rpc_task *task);
367int xprt_adjust_timeout(struct rpc_rqst *req);
368void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
369void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
370void xprt_release(struct rpc_task *task);
371struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
372void xprt_put(struct rpc_xprt *xprt);
373struct rpc_xprt * xprt_alloc(struct net *net, size_t size,
374 unsigned int num_prealloc,
375 unsigned int max_req);
376void xprt_free(struct rpc_xprt *);
377void xprt_add_backlog(struct rpc_xprt *xprt, struct rpc_task *task);
378bool xprt_wake_up_backlog(struct rpc_xprt *xprt, struct rpc_rqst *req);
379void xprt_cleanup_ids(void);
380
381static inline int
382xprt_enable_swap(struct rpc_xprt *xprt)
383{
384 return xprt->ops->enable_swap(xprt);
385}
386
387static inline void
388xprt_disable_swap(struct rpc_xprt *xprt)
389{
390 xprt->ops->disable_swap(xprt);
391}
392
393
394
395
396int xprt_register_transport(struct xprt_class *type);
397int xprt_unregister_transport(struct xprt_class *type);
398int xprt_find_transport_ident(const char *);
399void xprt_wait_for_reply_request_def(struct rpc_task *task);
400void xprt_wait_for_reply_request_rtt(struct rpc_task *task);
401void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
402void xprt_wait_for_buffer_space(struct rpc_xprt *xprt);
403bool xprt_write_space(struct rpc_xprt *xprt);
404void xprt_adjust_cwnd(struct rpc_xprt *xprt, struct rpc_task *task, int result);
405struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
406void xprt_update_rtt(struct rpc_task *task);
407void xprt_complete_rqst(struct rpc_task *task, int copied);
408void xprt_pin_rqst(struct rpc_rqst *req);
409void xprt_unpin_rqst(struct rpc_rqst *req);
410void xprt_release_rqst_cong(struct rpc_task *task);
411bool xprt_request_get_cong(struct rpc_xprt *xprt, struct rpc_rqst *req);
412void xprt_disconnect_done(struct rpc_xprt *xprt);
413void xprt_force_disconnect(struct rpc_xprt *xprt);
414void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);
415
416bool xprt_lock_connect(struct rpc_xprt *, struct rpc_task *, void *);
417void xprt_unlock_connect(struct rpc_xprt *, void *);
418void xprt_release_write(struct rpc_xprt *, struct rpc_task *);
419
420
421
422
423#define XPRT_LOCKED (0)
424#define XPRT_CONNECTED (1)
425#define XPRT_CONNECTING (2)
426#define XPRT_CLOSE_WAIT (3)
427#define XPRT_BOUND (4)
428#define XPRT_BINDING (5)
429#define XPRT_CLOSING (6)
430#define XPRT_OFFLINE (7)
431#define XPRT_REMOVE (8)
432#define XPRT_CONGESTED (9)
433#define XPRT_CWND_WAIT (10)
434#define XPRT_WRITE_SPACE (11)
435
436static inline void xprt_set_connected(struct rpc_xprt *xprt)
437{
438 set_bit(XPRT_CONNECTED, &xprt->state);
439}
440
441static inline void xprt_clear_connected(struct rpc_xprt *xprt)
442{
443 clear_bit(XPRT_CONNECTED, &xprt->state);
444}
445
446static inline int xprt_connected(struct rpc_xprt *xprt)
447{
448 return test_bit(XPRT_CONNECTED, &xprt->state);
449}
450
451static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
452{
453 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
454}
455
456static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
457{
458 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
459}
460
461static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
462{
463 smp_mb__before_atomic();
464 clear_bit(XPRT_CONNECTING, &xprt->state);
465 smp_mb__after_atomic();
466}
467
468static inline int xprt_connecting(struct rpc_xprt *xprt)
469{
470 return test_bit(XPRT_CONNECTING, &xprt->state);
471}
472
473static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
474{
475 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
476}
477
478static inline void xprt_set_bound(struct rpc_xprt *xprt)
479{
480 test_and_set_bit(XPRT_BOUND, &xprt->state);
481}
482
483static inline int xprt_bound(struct rpc_xprt *xprt)
484{
485 return test_bit(XPRT_BOUND, &xprt->state);
486}
487
488static inline void xprt_clear_bound(struct rpc_xprt *xprt)
489{
490 clear_bit(XPRT_BOUND, &xprt->state);
491}
492
493static inline void xprt_clear_binding(struct rpc_xprt *xprt)
494{
495 smp_mb__before_atomic();
496 clear_bit(XPRT_BINDING, &xprt->state);
497 smp_mb__after_atomic();
498}
499
500static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
501{
502 return test_and_set_bit(XPRT_BINDING, &xprt->state);
503}
504
505#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
506extern unsigned int rpc_inject_disconnect;
507static inline void xprt_inject_disconnect(struct rpc_xprt *xprt)
508{
509 if (!rpc_inject_disconnect)
510 return;
511 if (atomic_dec_return(&xprt->inject_disconnect))
512 return;
513 atomic_set(&xprt->inject_disconnect, rpc_inject_disconnect);
514 xprt->ops->inject_disconnect(xprt);
515}
516#else
517static inline void xprt_inject_disconnect(struct rpc_xprt *xprt)
518{
519}
520#endif
521
522#endif
523