SUNRPC: Generalize the RPC buffer release API
[linux-2.6-block.git] / net / sunrpc / xprtrdma / transport.c
CommitLineData
f58851e6
TT
1/*
2 * Copyright (c) 2003-2007 Network Appliance, Inc. All rights reserved.
3 *
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the BSD-type
8 * license below:
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 *
14 * Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 *
17 * Redistributions in binary form must reproduce the above
18 * copyright notice, this list of conditions and the following
19 * disclaimer in the documentation and/or other materials provided
20 * with the distribution.
21 *
22 * Neither the name of the Network Appliance, Inc. nor the names of
23 * its contributors may be used to endorse or promote products
24 * derived from this software without specific prior written
25 * permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 */
39
40/*
41 * transport.c
42 *
43 * This file contains the top-level implementation of an RPC RDMA
44 * transport.
45 *
46 * Naming convention: functions beginning with xprt_ are part of the
47 * transport switch. All others are RPC RDMA internal.
48 */
49
50#include <linux/module.h>
5a0e3ad6 51#include <linux/slab.h>
f58851e6 52#include <linux/seq_file.h>
5976687a 53#include <linux/sunrpc/addr.h>
f58851e6
TT
54
55#include "xprt_rdma.h"
56
f895b252 57#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
f58851e6
TT
58# define RPCDBG_FACILITY RPCDBG_TRANS
59#endif
60
f58851e6
TT
61/*
62 * tunables
63 */
64
65static unsigned int xprt_rdma_slot_table_entries = RPCRDMA_DEF_SLOT_TABLE;
5d252f90 66unsigned int xprt_rdma_max_inline_read = RPCRDMA_DEF_INLINE;
f58851e6
TT
67static unsigned int xprt_rdma_max_inline_write = RPCRDMA_DEF_INLINE;
68static unsigned int xprt_rdma_inline_write_padding;
3197d309 69static unsigned int xprt_rdma_memreg_strategy = RPCRDMA_FRMR;
d5440e27 70 int xprt_rdma_pad_optimize = 1;
f58851e6 71
f895b252 72#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
f58851e6
TT
73
74static unsigned int min_slot_table_size = RPCRDMA_MIN_SLOT_TABLE;
75static unsigned int max_slot_table_size = RPCRDMA_MAX_SLOT_TABLE;
29c55422
CL
76static unsigned int min_inline_size = RPCRDMA_MIN_INLINE;
77static unsigned int max_inline_size = RPCRDMA_MAX_INLINE;
f58851e6
TT
78static unsigned int zero;
79static unsigned int max_padding = PAGE_SIZE;
80static unsigned int min_memreg = RPCRDMA_BOUNCEBUFFERS;
81static unsigned int max_memreg = RPCRDMA_LAST - 1;
82
83static struct ctl_table_header *sunrpc_table_header;
84
fe2c6338 85static struct ctl_table xr_tunables_table[] = {
f58851e6 86 {
f58851e6
TT
87 .procname = "rdma_slot_table_entries",
88 .data = &xprt_rdma_slot_table_entries,
89 .maxlen = sizeof(unsigned int),
90 .mode = 0644,
6d456111 91 .proc_handler = proc_dointvec_minmax,
f58851e6
TT
92 .extra1 = &min_slot_table_size,
93 .extra2 = &max_slot_table_size
94 },
95 {
f58851e6
TT
96 .procname = "rdma_max_inline_read",
97 .data = &xprt_rdma_max_inline_read,
98 .maxlen = sizeof(unsigned int),
99 .mode = 0644,
6d456111 100 .proc_handler = proc_dointvec,
29c55422
CL
101 .extra1 = &min_inline_size,
102 .extra2 = &max_inline_size,
f58851e6
TT
103 },
104 {
f58851e6
TT
105 .procname = "rdma_max_inline_write",
106 .data = &xprt_rdma_max_inline_write,
107 .maxlen = sizeof(unsigned int),
108 .mode = 0644,
6d456111 109 .proc_handler = proc_dointvec,
29c55422
CL
110 .extra1 = &min_inline_size,
111 .extra2 = &max_inline_size,
f58851e6
TT
112 },
113 {
f58851e6
TT
114 .procname = "rdma_inline_write_padding",
115 .data = &xprt_rdma_inline_write_padding,
116 .maxlen = sizeof(unsigned int),
117 .mode = 0644,
6d456111 118 .proc_handler = proc_dointvec_minmax,
f58851e6
TT
119 .extra1 = &zero,
120 .extra2 = &max_padding,
121 },
122 {
f58851e6
TT
123 .procname = "rdma_memreg_strategy",
124 .data = &xprt_rdma_memreg_strategy,
125 .maxlen = sizeof(unsigned int),
126 .mode = 0644,
6d456111 127 .proc_handler = proc_dointvec_minmax,
f58851e6
TT
128 .extra1 = &min_memreg,
129 .extra2 = &max_memreg,
130 },
9191ca3b 131 {
9191ca3b
TT
132 .procname = "rdma_pad_optimize",
133 .data = &xprt_rdma_pad_optimize,
134 .maxlen = sizeof(unsigned int),
135 .mode = 0644,
6d456111 136 .proc_handler = proc_dointvec,
9191ca3b 137 },
f8572d8f 138 { },
f58851e6
TT
139};
140
fe2c6338 141static struct ctl_table sunrpc_table[] = {
f58851e6 142 {
f58851e6
TT
143 .procname = "sunrpc",
144 .mode = 0555,
145 .child = xr_tunables_table
146 },
f8572d8f 147 { },
f58851e6
TT
148};
149
150#endif
151
5d252f90 152static struct rpc_xprt_ops xprt_rdma_procs; /*forward reference */
f58851e6 153
0dd39cae
CL
154static void
155xprt_rdma_format_addresses4(struct rpc_xprt *xprt, struct sockaddr *sap)
156{
157 struct sockaddr_in *sin = (struct sockaddr_in *)sap;
158 char buf[20];
159
160 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
161 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
162
163 xprt->address_strings[RPC_DISPLAY_NETID] = RPCBIND_NETID_RDMA;
164}
165
166static void
167xprt_rdma_format_addresses6(struct rpc_xprt *xprt, struct sockaddr *sap)
168{
169 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
170 char buf[40];
171
172 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
173 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
174
175 xprt->address_strings[RPC_DISPLAY_NETID] = RPCBIND_NETID_RDMA6;
176}
177
5d252f90 178void
5231eb97 179xprt_rdma_format_addresses(struct rpc_xprt *xprt, struct sockaddr *sap)
f58851e6 180{
0dd39cae
CL
181 char buf[128];
182
183 switch (sap->sa_family) {
184 case AF_INET:
185 xprt_rdma_format_addresses4(xprt, sap);
186 break;
187 case AF_INET6:
188 xprt_rdma_format_addresses6(xprt, sap);
189 break;
190 default:
191 pr_err("rpcrdma: Unrecognized address family\n");
192 return;
193 }
f58851e6 194
c877b849
CL
195 (void)rpc_ntop(sap, buf, sizeof(buf));
196 xprt->address_strings[RPC_DISPLAY_ADDR] = kstrdup(buf, GFP_KERNEL);
f58851e6 197
81160e66 198 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
c877b849 199 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
f58851e6 200
81160e66 201 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
c877b849 202 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
f58851e6 203
0dd39cae 204 xprt->address_strings[RPC_DISPLAY_PROTO] = "rdma";
f58851e6
TT
205}
206
5d252f90 207void
f58851e6
TT
208xprt_rdma_free_addresses(struct rpc_xprt *xprt)
209{
33e01dc7
CL
210 unsigned int i;
211
212 for (i = 0; i < RPC_DISPLAY_MAX; i++)
213 switch (i) {
214 case RPC_DISPLAY_PROTO:
215 case RPC_DISPLAY_NETID:
216 continue;
217 default:
218 kfree(xprt->address_strings[i]);
219 }
f58851e6
TT
220}
221
222static void
223xprt_rdma_connect_worker(struct work_struct *work)
224{
5abefb86
CL
225 struct rpcrdma_xprt *r_xprt = container_of(work, struct rpcrdma_xprt,
226 rx_connect_worker.work);
227 struct rpc_xprt *xprt = &r_xprt->rx_xprt;
f58851e6
TT
228 int rc = 0;
229
d19751e7
TM
230 xprt_clear_connected(xprt);
231
232 dprintk("RPC: %s: %sconnect\n", __func__,
233 r_xprt->rx_ep.rep_connected != 0 ? "re" : "");
234 rc = rpcrdma_ep_connect(&r_xprt->rx_ep, &r_xprt->rx_ia);
235 if (rc)
236 xprt_wake_pending_tasks(xprt, rc);
237
f58851e6
TT
238 dprintk("RPC: %s: exit\n", __func__);
239 xprt_clear_connecting(xprt);
240}
241
4a068258
CL
242static void
243xprt_rdma_inject_disconnect(struct rpc_xprt *xprt)
244{
245 struct rpcrdma_xprt *r_xprt = container_of(xprt, struct rpcrdma_xprt,
246 rx_xprt);
247
248 pr_info("rpcrdma: injecting transport disconnect on xprt=%p\n", xprt);
249 rdma_disconnect(r_xprt->rx_ia.ri_id);
250}
251
f58851e6
TT
252/*
253 * xprt_rdma_destroy
254 *
255 * Destroy the xprt.
256 * Free all memory associated with the object, including its own.
257 * NOTE: none of the *destroy methods free memory for their top-level
258 * objects, even though they may have allocated it (they do free
259 * private memory). It's up to the caller to handle it. In this
260 * case (RDMA transport), all structure memory is inlined with the
261 * struct rpcrdma_xprt.
262 */
263static void
264xprt_rdma_destroy(struct rpc_xprt *xprt)
265{
266 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(xprt);
f58851e6
TT
267
268 dprintk("RPC: %s: called\n", __func__);
269
5abefb86 270 cancel_delayed_work_sync(&r_xprt->rx_connect_worker);
f58851e6
TT
271
272 xprt_clear_connected(xprt);
273
7f1d5419 274 rpcrdma_ep_destroy(&r_xprt->rx_ep, &r_xprt->rx_ia);
72c02173 275 rpcrdma_buffer_destroy(&r_xprt->rx_buf);
f58851e6
TT
276 rpcrdma_ia_close(&r_xprt->rx_ia);
277
278 xprt_rdma_free_addresses(xprt);
279
e204e621 280 xprt_free(xprt);
f58851e6
TT
281
282 dprintk("RPC: %s: returning\n", __func__);
283
284 module_put(THIS_MODULE);
285}
286
2881ae74
TM
287static const struct rpc_timeout xprt_rdma_default_timeout = {
288 .to_initval = 60 * HZ,
289 .to_maxval = 60 * HZ,
290};
291
f58851e6
TT
292/**
293 * xprt_setup_rdma - Set up transport to use RDMA
294 *
295 * @args: rpc transport arguments
296 */
297static struct rpc_xprt *
298xprt_setup_rdma(struct xprt_create *args)
299{
300 struct rpcrdma_create_data_internal cdata;
301 struct rpc_xprt *xprt;
302 struct rpcrdma_xprt *new_xprt;
303 struct rpcrdma_ep *new_ep;
5231eb97 304 struct sockaddr *sap;
f58851e6
TT
305 int rc;
306
307 if (args->addrlen > sizeof(xprt->addr)) {
308 dprintk("RPC: %s: address too large\n", __func__);
309 return ERR_PTR(-EBADF);
310 }
311
37aa2133 312 xprt = xprt_alloc(args->net, sizeof(struct rpcrdma_xprt),
d9ba131d 313 xprt_rdma_slot_table_entries,
bd1722d4 314 xprt_rdma_slot_table_entries);
f58851e6
TT
315 if (xprt == NULL) {
316 dprintk("RPC: %s: couldn't allocate rpcrdma_xprt\n",
317 __func__);
318 return ERR_PTR(-ENOMEM);
319 }
320
f58851e6 321 /* 60 second timeout, no retries */
ba7392bb 322 xprt->timeout = &xprt_rdma_default_timeout;
bfaee096
CL
323 xprt->bind_timeout = RPCRDMA_BIND_TO;
324 xprt->reestablish_timeout = RPCRDMA_INIT_REEST_TO;
325 xprt->idle_timeout = RPCRDMA_IDLE_DISC_TO;
f58851e6
TT
326
327 xprt->resvport = 0; /* privileged port not needed */
328 xprt->tsh_size = 0; /* RPC-RDMA handles framing */
f58851e6
TT
329 xprt->ops = &xprt_rdma_procs;
330
331 /*
332 * Set up RDMA-specific connect data.
333 */
334
5231eb97
CL
335 sap = (struct sockaddr *)&cdata.addr;
336 memcpy(sap, args->dstaddr, args->addrlen);
f58851e6
TT
337
338 /* Ensure xprt->addr holds valid server TCP (not RDMA)
339 * address, for any side protocols which peek at it */
340 xprt->prot = IPPROTO_TCP;
341 xprt->addrlen = args->addrlen;
5231eb97 342 memcpy(&xprt->addr, sap, xprt->addrlen);
f58851e6 343
5231eb97 344 if (rpc_get_port(sap))
f58851e6
TT
345 xprt_set_bound(xprt);
346
f58851e6
TT
347 cdata.max_requests = xprt->max_reqs;
348
f58851e6
TT
349 cdata.rsize = RPCRDMA_MAX_SEGS * PAGE_SIZE; /* RDMA write max */
350 cdata.wsize = RPCRDMA_MAX_SEGS * PAGE_SIZE; /* RDMA read max */
351
352 cdata.inline_wsize = xprt_rdma_max_inline_write;
353 if (cdata.inline_wsize > cdata.wsize)
354 cdata.inline_wsize = cdata.wsize;
355
356 cdata.inline_rsize = xprt_rdma_max_inline_read;
357 if (cdata.inline_rsize > cdata.rsize)
358 cdata.inline_rsize = cdata.rsize;
359
360 cdata.padding = xprt_rdma_inline_write_padding;
361
362 /*
363 * Create new transport instance, which includes initialized
364 * o ia
365 * o endpoint
366 * o buffers
367 */
368
369 new_xprt = rpcx_to_rdmax(xprt);
370
5231eb97 371 rc = rpcrdma_ia_open(new_xprt, sap, xprt_rdma_memreg_strategy);
f58851e6
TT
372 if (rc)
373 goto out1;
374
375 /*
376 * initialize and create ep
377 */
378 new_xprt->rx_data = cdata;
379 new_ep = &new_xprt->rx_ep;
380 new_ep->rep_remote_addr = cdata.addr;
381
382 rc = rpcrdma_ep_create(&new_xprt->rx_ep,
383 &new_xprt->rx_ia, &new_xprt->rx_data);
384 if (rc)
385 goto out2;
386
387 /*
388 * Allocate pre-registered send and receive buffers for headers and
389 * any inline data. Also specify any padding which will be provided
390 * from a preregistered zero buffer.
391 */
ac920d04 392 rc = rpcrdma_buffer_create(new_xprt);
f58851e6
TT
393 if (rc)
394 goto out3;
395
396 /*
397 * Register a callback for connection events. This is necessary because
398 * connection loss notification is async. We also catch connection loss
399 * when reaping receives.
400 */
5abefb86
CL
401 INIT_DELAYED_WORK(&new_xprt->rx_connect_worker,
402 xprt_rdma_connect_worker);
f58851e6 403
5231eb97 404 xprt_rdma_format_addresses(xprt, sap);
1c9351ee
CL
405 xprt->max_payload = new_xprt->rx_ia.ri_ops->ro_maxpages(new_xprt);
406 if (xprt->max_payload == 0)
407 goto out4;
408 xprt->max_payload <<= PAGE_SHIFT;
43e95988
CL
409 dprintk("RPC: %s: transport data payload maximum: %zu bytes\n",
410 __func__, xprt->max_payload);
f58851e6
TT
411
412 if (!try_module_get(THIS_MODULE))
413 goto out4;
414
5231eb97
CL
415 dprintk("RPC: %s: %s:%s\n", __func__,
416 xprt->address_strings[RPC_DISPLAY_ADDR],
417 xprt->address_strings[RPC_DISPLAY_PORT]);
f58851e6
TT
418 return xprt;
419
420out4:
421 xprt_rdma_free_addresses(xprt);
422 rc = -EINVAL;
423out3:
7f1d5419 424 rpcrdma_ep_destroy(new_ep, &new_xprt->rx_ia);
f58851e6
TT
425out2:
426 rpcrdma_ia_close(&new_xprt->rx_ia);
427out1:
e204e621 428 xprt_free(xprt);
f58851e6
TT
429 return ERR_PTR(rc);
430}
431
432/*
433 * Close a connection, during shutdown or timeout/reconnect
434 */
435static void
436xprt_rdma_close(struct rpc_xprt *xprt)
437{
438 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(xprt);
439
440 dprintk("RPC: %s: closing\n", __func__);
08ca0dce
TT
441 if (r_xprt->rx_ep.rep_connected > 0)
442 xprt->reestablish_timeout = 0;
62da3b24 443 xprt_disconnect_done(xprt);
282191cb 444 rpcrdma_ep_disconnect(&r_xprt->rx_ep, &r_xprt->rx_ia);
f58851e6
TT
445}
446
447static void
448xprt_rdma_set_port(struct rpc_xprt *xprt, u16 port)
449{
450 struct sockaddr_in *sap;
451
452 sap = (struct sockaddr_in *)&xprt->addr;
453 sap->sin_port = htons(port);
454 sap = (struct sockaddr_in *)&rpcx_to_rdmad(xprt).addr;
455 sap->sin_port = htons(port);
456 dprintk("RPC: %s: %u\n", __func__, port);
457}
458
459static void
1b092092 460xprt_rdma_connect(struct rpc_xprt *xprt, struct rpc_task *task)
f58851e6 461{
f58851e6
TT
462 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(xprt);
463
0b9e7943
TM
464 if (r_xprt->rx_ep.rep_connected != 0) {
465 /* Reconnect */
5abefb86
CL
466 schedule_delayed_work(&r_xprt->rx_connect_worker,
467 xprt->reestablish_timeout);
0b9e7943 468 xprt->reestablish_timeout <<= 1;
bfaee096
CL
469 if (xprt->reestablish_timeout > RPCRDMA_MAX_REEST_TO)
470 xprt->reestablish_timeout = RPCRDMA_MAX_REEST_TO;
471 else if (xprt->reestablish_timeout < RPCRDMA_INIT_REEST_TO)
472 xprt->reestablish_timeout = RPCRDMA_INIT_REEST_TO;
0b9e7943 473 } else {
5abefb86 474 schedule_delayed_work(&r_xprt->rx_connect_worker, 0);
0b9e7943 475 if (!RPC_IS_ASYNC(task))
5abefb86 476 flush_delayed_work(&r_xprt->rx_connect_worker);
f58851e6
TT
477 }
478}
479
5fe6eaa1
CL
480/**
481 * xprt_rdma_allocate - allocate transport resources for an RPC
482 * @task: RPC task
483 *
484 * Return values:
485 * 0: Success; rq_buffer points to RPC buffer to use
486 * ENOMEM: Out of memory, call again later
487 * EIO: A permanent error occurred, do not retry
488 *
f58851e6
TT
489 * The RDMA allocate/free functions need the task structure as a place
490 * to hide the struct rpcrdma_req, which is necessary for the actual send/recv
0ca77dc3
CL
491 * sequence.
492 *
493 * The RPC layer allocates both send and receive buffers in the same call
494 * (rq_send_buf and rq_rcv_buf are both part of a single contiguous buffer).
495 * We may register rq_rcv_buf when using reply chunks.
f58851e6 496 */
5fe6eaa1
CL
497static int
498xprt_rdma_allocate(struct rpc_task *task)
f58851e6 499{
5fe6eaa1
CL
500 struct rpc_rqst *rqst = task->tk_rqstp;
501 size_t size = rqst->rq_callsize + rqst->rq_rcvsize;
502 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(rqst->rq_xprt);
0ca77dc3
CL
503 struct rpcrdma_regbuf *rb;
504 struct rpcrdma_req *req;
505 size_t min_size;
a0a1d50c 506 gfp_t flags;
f58851e6 507
0ca77dc3 508 req = rpcrdma_buffer_get(&r_xprt->rx_buf);
c977dea2 509 if (req == NULL)
5fe6eaa1 510 return -ENOMEM;
f58851e6 511
5d252f90 512 flags = RPCRDMA_DEF_GFP;
a0a1d50c
CL
513 if (RPC_IS_SWAPPER(task))
514 flags = __GFP_MEMALLOC | GFP_NOWAIT | __GFP_NOWARN;
515
85275c87
CL
516 if (req->rl_rdmabuf == NULL)
517 goto out_rdmabuf;
0ca77dc3
CL
518 if (req->rl_sendbuf == NULL)
519 goto out_sendbuf;
520 if (size > req->rl_sendbuf->rg_size)
521 goto out_sendbuf;
522
523out:
f58851e6 524 dprintk("RPC: %s: size %zd, request 0x%p\n", __func__, size, req);
575448bd 525 req->rl_connect_cookie = 0; /* our reserved value */
5fe6eaa1
CL
526 rqst->rq_buffer = req->rl_sendbuf->rg_base;
527 return 0;
0ca77dc3 528
85275c87 529out_rdmabuf:
eb342e9a 530 min_size = r_xprt->rx_data.inline_wsize;
85275c87
CL
531 rb = rpcrdma_alloc_regbuf(&r_xprt->rx_ia, min_size, flags);
532 if (IS_ERR(rb))
533 goto out_fail;
534 req->rl_rdmabuf = rb;
535
0ca77dc3
CL
536out_sendbuf:
537 /* XDR encoding and RPC/RDMA marshaling of this request has not
538 * yet occurred. Thus a lower bound is needed to prevent buffer
539 * overrun during marshaling.
540 *
541 * RPC/RDMA marshaling may choose to send payload bearing ops
542 * inline, if the result is smaller than the inline threshold.
543 * The value of the "size" argument accounts for header
544 * requirements but not for the payload in these cases.
545 *
546 * Likewise, allocate enough space to receive a reply up to the
547 * size of the inline threshold.
548 *
549 * It's unlikely that both the send header and the received
550 * reply will be large, but slush is provided here to allow
551 * flexibility when marshaling.
552 */
eb342e9a
CL
553 min_size = r_xprt->rx_data.inline_rsize;
554 min_size += r_xprt->rx_data.inline_wsize;
0ca77dc3
CL
555 if (size < min_size)
556 size = min_size;
557
558 rb = rpcrdma_alloc_regbuf(&r_xprt->rx_ia, size, flags);
559 if (IS_ERR(rb))
560 goto out_fail;
561 rb->rg_owner = req;
562
563 r_xprt->rx_stats.hardway_register_count += size;
564 rpcrdma_free_regbuf(&r_xprt->rx_ia, req->rl_sendbuf);
565 req->rl_sendbuf = rb;
566 goto out;
567
568out_fail:
f58851e6 569 rpcrdma_buffer_put(req);
5fe6eaa1 570 return -ENOMEM;
f58851e6
TT
571}
572
3435c74a
CL
573/**
574 * xprt_rdma_free - release resources allocated by xprt_rdma_allocate
575 * @task: RPC task
576 *
577 * Caller guarantees rqst->rq_buffer is non-NULL.
f58851e6
TT
578 */
579static void
3435c74a 580xprt_rdma_free(struct rpc_task *task)
f58851e6 581{
3435c74a
CL
582 struct rpc_rqst *rqst = task->tk_rqstp;
583 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(rqst->rq_xprt);
584 struct rpcrdma_req *req = rpcr_to_rdmar(rqst);
f58851e6 585
ffc4d9b1
CL
586 if (req->rl_backchannel)
587 return;
588
0ca77dc3 589 dprintk("RPC: %s: called on 0x%p\n", __func__, req->rl_reply);
f58851e6 590
ead3f26e 591 r_xprt->rx_ia.ri_ops->ro_unmap_safe(r_xprt, req,
3435c74a 592 !RPC_IS_ASYNC(task));
f58851e6
TT
593 rpcrdma_buffer_put(req);
594}
595
7a89f9c6
CL
596/**
597 * xprt_rdma_send_request - marshal and send an RPC request
598 * @task: RPC task with an RPC message in rq_snd_buf
599 *
600 * Return values:
601 * 0: The request has been sent
602 * ENOTCONN: Caller needs to invoke connect logic then call again
603 * ENOBUFS: Call again later to send the request
604 * EIO: A permanent error occurred. The request was not sent,
605 * and don't try it again
606 *
f58851e6 607 * send_request invokes the meat of RPC RDMA. It must do the following:
7a89f9c6 608 *
f58851e6
TT
609 * 1. Marshal the RPC request into an RPC RDMA request, which means
610 * putting a header in front of data, and creating IOVs for RDMA
611 * from those in the request.
612 * 2. In marshaling, detect opportunities for RDMA, and use them.
613 * 3. Post a recv message to set up asynch completion, then send
614 * the request (rpcrdma_ep_post).
615 * 4. No partial sends are possible in the RPC-RDMA protocol (as in UDP).
616 */
f58851e6
TT
617static int
618xprt_rdma_send_request(struct rpc_task *task)
619{
620 struct rpc_rqst *rqst = task->tk_rqstp;
a4f0835c 621 struct rpc_xprt *xprt = rqst->rq_xprt;
f58851e6
TT
622 struct rpcrdma_req *req = rpcr_to_rdmar(rqst);
623 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(xprt);
6ab59945 624 int rc = 0;
f58851e6 625
9d6b0409
CL
626 /* On retransmit, remove any previously registered chunks */
627 r_xprt->rx_ia.ri_ops->ro_unmap_safe(r_xprt, req, false);
628
e2377945 629 rc = rpcrdma_marshal_req(rqst);
6ab59945
CL
630 if (rc < 0)
631 goto failed_marshal;
f58851e6
TT
632
633 if (req->rl_reply == NULL) /* e.g. reconnection */
634 rpcrdma_recv_buffer_get(req);
635
575448bd
TT
636 /* Must suppress retransmit to maintain credits */
637 if (req->rl_connect_cookie == xprt->connect_cookie)
638 goto drop_connection;
639 req->rl_connect_cookie = xprt->connect_cookie;
640
641 if (rpcrdma_ep_post(&r_xprt->rx_ia, &r_xprt->rx_ep, req))
642 goto drop_connection;
f58851e6 643
d60dbb20 644 rqst->rq_xmit_bytes_sent += rqst->rq_snd_buf.len;
f58851e6
TT
645 rqst->rq_bytes_sent = 0;
646 return 0;
575448bd 647
c93c6223 648failed_marshal:
c93c6223
CL
649 dprintk("RPC: %s: rpcrdma_marshal_req failed, status %i\n",
650 __func__, rc);
651 if (rc == -EIO)
7a89f9c6
CL
652 r_xprt->rx_stats.failed_marshal_count++;
653 if (rc != -ENOTCONN)
654 return rc;
575448bd
TT
655drop_connection:
656 xprt_disconnect_done(xprt);
657 return -ENOTCONN; /* implies disconnect */
f58851e6
TT
658}
659
5d252f90 660void xprt_rdma_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
f58851e6
TT
661{
662 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(xprt);
663 long idle_time = 0;
664
665 if (xprt_connected(xprt))
666 idle_time = (long)(jiffies - xprt->last_used) / HZ;
667
763f7e4e
CL
668 seq_puts(seq, "\txprt:\trdma ");
669 seq_printf(seq, "%u %lu %lu %lu %ld %lu %lu %lu %llu %llu ",
670 0, /* need a local port? */
671 xprt->stat.bind_count,
672 xprt->stat.connect_count,
673 xprt->stat.connect_time,
674 idle_time,
675 xprt->stat.sends,
676 xprt->stat.recvs,
677 xprt->stat.bad_xids,
678 xprt->stat.req_u,
679 xprt->stat.bklog_u);
505bbe64 680 seq_printf(seq, "%lu %lu %lu %llu %llu %llu %llu %lu %lu %lu %lu ",
763f7e4e
CL
681 r_xprt->rx_stats.read_chunk_count,
682 r_xprt->rx_stats.write_chunk_count,
683 r_xprt->rx_stats.reply_chunk_count,
684 r_xprt->rx_stats.total_rdma_request,
685 r_xprt->rx_stats.total_rdma_reply,
686 r_xprt->rx_stats.pullup_copy_count,
687 r_xprt->rx_stats.fixup_copy_count,
688 r_xprt->rx_stats.hardway_register_count,
689 r_xprt->rx_stats.failed_marshal_count,
860477d1
CL
690 r_xprt->rx_stats.bad_reply_count,
691 r_xprt->rx_stats.nomsg_call_count);
e2ac236c 692 seq_printf(seq, "%lu %lu %lu\n",
505bbe64 693 r_xprt->rx_stats.mrs_recovered,
e2ac236c
CL
694 r_xprt->rx_stats.mrs_orphaned,
695 r_xprt->rx_stats.mrs_allocated);
f58851e6
TT
696}
697
d67fa4d8
JL
698static int
699xprt_rdma_enable_swap(struct rpc_xprt *xprt)
700{
a0451788 701 return 0;
d67fa4d8
JL
702}
703
704static void
705xprt_rdma_disable_swap(struct rpc_xprt *xprt)
706{
707}
708
f58851e6
TT
709/*
710 * Plumbing for rpc transport switch and kernel module
711 */
712
713static struct rpc_xprt_ops xprt_rdma_procs = {
e7ce710a 714 .reserve_xprt = xprt_reserve_xprt_cong,
f58851e6 715 .release_xprt = xprt_release_xprt_cong, /* sunrpc/xprt.c */
f39c1bfb 716 .alloc_slot = xprt_alloc_slot,
f58851e6
TT
717 .release_request = xprt_release_rqst_cong, /* ditto */
718 .set_retrans_timeout = xprt_set_retrans_timeout_def, /* ditto */
719 .rpcbind = rpcb_getport_async, /* sunrpc/rpcb_clnt.c */
720 .set_port = xprt_rdma_set_port,
721 .connect = xprt_rdma_connect,
722 .buf_alloc = xprt_rdma_allocate,
723 .buf_free = xprt_rdma_free,
724 .send_request = xprt_rdma_send_request,
725 .close = xprt_rdma_close,
726 .destroy = xprt_rdma_destroy,
d67fa4d8
JL
727 .print_stats = xprt_rdma_print_stats,
728 .enable_swap = xprt_rdma_enable_swap,
729 .disable_swap = xprt_rdma_disable_swap,
f531a5db
CL
730 .inject_disconnect = xprt_rdma_inject_disconnect,
731#if defined(CONFIG_SUNRPC_BACKCHANNEL)
732 .bc_setup = xprt_rdma_bc_setup,
76566773 733 .bc_up = xprt_rdma_bc_up,
6b26cc8c 734 .bc_maxpayload = xprt_rdma_bc_maxpayload,
f531a5db
CL
735 .bc_free_rqst = xprt_rdma_bc_free_rqst,
736 .bc_destroy = xprt_rdma_bc_destroy,
737#endif
f58851e6
TT
738};
739
740static struct xprt_class xprt_rdma = {
741 .list = LIST_HEAD_INIT(xprt_rdma.list),
742 .name = "rdma",
743 .owner = THIS_MODULE,
744 .ident = XPRT_TRANSPORT_RDMA,
745 .setup = xprt_setup_rdma,
746};
747
ffe1f0df 748void xprt_rdma_cleanup(void)
f58851e6
TT
749{
750 int rc;
751
3a0799a9 752 dprintk("RPCRDMA Module Removed, deregister RPC RDMA transport\n");
f895b252 753#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
f58851e6
TT
754 if (sunrpc_table_header) {
755 unregister_sysctl_table(sunrpc_table_header);
756 sunrpc_table_header = NULL;
757 }
758#endif
759 rc = xprt_unregister_transport(&xprt_rdma);
760 if (rc)
761 dprintk("RPC: %s: xprt_unregister returned %i\n",
762 __func__, rc);
951e721c 763
fe97b47c 764 rpcrdma_destroy_wq();
5d252f90
CL
765
766 rc = xprt_unregister_transport(&xprt_rdma_bc);
767 if (rc)
768 dprintk("RPC: %s: xprt_unregister(bc) returned %i\n",
769 __func__, rc);
f58851e6
TT
770}
771
ffe1f0df 772int xprt_rdma_init(void)
f58851e6
TT
773{
774 int rc;
775
fe97b47c 776 rc = rpcrdma_alloc_wq();
505bbe64 777 if (rc)
fe97b47c 778 return rc;
fe97b47c 779
951e721c
CL
780 rc = xprt_register_transport(&xprt_rdma);
781 if (rc) {
fe97b47c 782 rpcrdma_destroy_wq();
951e721c
CL
783 return rc;
784 }
785
5d252f90
CL
786 rc = xprt_register_transport(&xprt_rdma_bc);
787 if (rc) {
788 xprt_unregister_transport(&xprt_rdma);
789 rpcrdma_destroy_wq();
5d252f90
CL
790 return rc;
791 }
792
3a0799a9 793 dprintk("RPCRDMA Module Init, register RPC RDMA transport\n");
f58851e6 794
3a0799a9
CL
795 dprintk("Defaults:\n");
796 dprintk("\tSlots %d\n"
f58851e6
TT
797 "\tMaxInlineRead %d\n\tMaxInlineWrite %d\n",
798 xprt_rdma_slot_table_entries,
799 xprt_rdma_max_inline_read, xprt_rdma_max_inline_write);
3a0799a9 800 dprintk("\tPadding %d\n\tMemreg %d\n",
f58851e6
TT
801 xprt_rdma_inline_write_padding, xprt_rdma_memreg_strategy);
802
f895b252 803#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
f58851e6
TT
804 if (!sunrpc_table_header)
805 sunrpc_table_header = register_sysctl_table(sunrpc_table);
806#endif
807 return 0;
808}