1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/fs/9p/trans_rdma.c
5 * RDMA transport layer based on the trans_fd.c implementation.
7 * Copyright (C) 2008 by Tom Tucker <tom@opengridcomputing.com>
8 * Copyright (C) 2006 by Russ Cox <rsc@swtch.com>
9 * Copyright (C) 2004-2005 by Latchesar Ionkov <lucho@ionkov.net>
10 * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
11 * Copyright (C) 1997-2002 by Ron Minnich <rminnich@sarnoff.com>
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #include <linux/module.h>
18 #include <linux/net.h>
19 #include <linux/ipv6.h>
20 #include <linux/kthread.h>
21 #include <linux/errno.h>
22 #include <linux/kernel.h>
24 #include <linux/uaccess.h>
25 #include <linux/inet.h>
26 #include <linux/idr.h>
27 #include <linux/file.h>
28 #include <linux/parser.h>
29 #include <linux/semaphore.h>
30 #include <linux/slab.h>
31 #include <linux/seq_file.h>
32 #include <net/9p/9p.h>
33 #include <net/9p/client.h>
34 #include <net/9p/transport.h>
35 #include <rdma/ib_verbs.h>
36 #include <rdma/rdma_cm.h>
39 #define P9_RDMA_SQ_DEPTH 32
40 #define P9_RDMA_RQ_DEPTH 32
41 #define P9_RDMA_SEND_SGE 4
42 #define P9_RDMA_RECV_SGE 4
45 #define P9_RDMA_TIMEOUT 30000 /* 30 seconds */
46 #define P9_RDMA_MAXSIZE (1024*1024) /* 1MB */
49 * struct p9_trans_rdma - RDMA transport instance
51 * @state: tracks the transport state machine for connection setup and tear down
52 * @cm_id: The RDMA CM ID
53 * @pd: Protection Domain pointer
54 * @qp: Queue Pair pointer
55 * @cq: Completion Queue pointer
56 * @timeout: Number of uSecs to wait for connection management events
57 * @privport: Whether a privileged port may be used
58 * @port: The port to use
59 * @sq_depth: The depth of the Send Queue
60 * @sq_sem: Semaphore for the SQ
61 * @rq_depth: The depth of the Receive Queue.
62 * @rq_sem: Semaphore for the RQ
63 * @excess_rc : Amount of posted Receive Contexts without a pending request.
65 * @addr: The remote peer's address
66 * @req_lock: Protects the active request list
67 * @cm_done: Completion event for connection management tracking
69 struct p9_trans_rdma {
72 P9_RDMA_ADDR_RESOLVED,
73 P9_RDMA_ROUTE_RESOLVED,
79 struct rdma_cm_id *cm_id;
87 struct semaphore sq_sem;
89 struct semaphore rq_sem;
91 struct sockaddr_in addr;
94 struct completion cm_done;
100 * struct p9_rdma_context - Keeps track of in-process WR
102 * @cqe: completion queue entry
103 * @busa: Bus address to unmap when the WR completes
104 * @req: Keeps track of requests (send)
105 * @rc: Keepts track of replies (receive)
107 struct p9_rdma_context {
111 struct p9_req_t *req;
117 * struct p9_rdma_opts - Collection of mount options
118 * @port: port of connection
119 * @privport: Whether a privileged port may be used
120 * @sq_depth: The requested depth of the SQ. This really doesn't need
121 * to be any deeper than the number of threads used in the client
122 * @rq_depth: The depth of the RQ. Should be greater than or equal to SQ depth
123 * @timeout: Time to wait in msecs for CM events
125 struct p9_rdma_opts {
134 * Option Parsing (code inspired by NFS code)
137 /* Options that take integer arguments */
138 Opt_port, Opt_rq_depth, Opt_sq_depth, Opt_timeout,
139 /* Options that take no argument */
144 static match_table_t tokens = {
145 {Opt_port, "port=%u"},
146 {Opt_sq_depth, "sq=%u"},
147 {Opt_rq_depth, "rq=%u"},
148 {Opt_timeout, "timeout=%u"},
149 {Opt_privport, "privport"},
153 static int p9_rdma_show_options(struct seq_file *m, struct p9_client *clnt)
155 struct p9_trans_rdma *rdma = clnt->trans;
157 if (rdma->port != P9_PORT)
158 seq_printf(m, ",port=%u", rdma->port);
159 if (rdma->sq_depth != P9_RDMA_SQ_DEPTH)
160 seq_printf(m, ",sq=%u", rdma->sq_depth);
161 if (rdma->rq_depth != P9_RDMA_RQ_DEPTH)
162 seq_printf(m, ",rq=%u", rdma->rq_depth);
163 if (rdma->timeout != P9_RDMA_TIMEOUT)
164 seq_printf(m, ",timeout=%lu", rdma->timeout);
166 seq_puts(m, ",privport");
171 * parse_opts - parse mount options into rdma options structure
172 * @params: options string passed from mount
173 * @opts: rdma transport-specific structure to parse options into
175 * Returns 0 upon success, -ERRNO upon failure
177 static int parse_opts(char *params, struct p9_rdma_opts *opts)
180 substring_t args[MAX_OPT_ARGS];
182 char *options, *tmp_options;
184 opts->port = P9_PORT;
185 opts->sq_depth = P9_RDMA_SQ_DEPTH;
186 opts->rq_depth = P9_RDMA_RQ_DEPTH;
187 opts->timeout = P9_RDMA_TIMEOUT;
188 opts->privport = false;
193 tmp_options = kstrdup(params, GFP_KERNEL);
195 p9_debug(P9_DEBUG_ERROR,
196 "failed to allocate copy of option string\n");
199 options = tmp_options;
201 while ((p = strsep(&options, ",")) != NULL) {
206 token = match_token(p, tokens, args);
207 if ((token != Opt_err) && (token != Opt_privport)) {
208 r = match_int(&args[0], &option);
210 p9_debug(P9_DEBUG_ERROR,
211 "integer field, but no integer?\n");
220 opts->sq_depth = option;
223 opts->rq_depth = option;
226 opts->timeout = option;
229 opts->privport = true;
235 /* RQ must be at least as large as the SQ */
236 opts->rq_depth = max(opts->rq_depth, opts->sq_depth);
242 p9_cm_event_handler(struct rdma_cm_id *id, struct rdma_cm_event *event)
244 struct p9_client *c = id->context;
245 struct p9_trans_rdma *rdma = c->trans;
246 switch (event->event) {
247 case RDMA_CM_EVENT_ADDR_RESOLVED:
248 BUG_ON(rdma->state != P9_RDMA_INIT);
249 rdma->state = P9_RDMA_ADDR_RESOLVED;
252 case RDMA_CM_EVENT_ROUTE_RESOLVED:
253 BUG_ON(rdma->state != P9_RDMA_ADDR_RESOLVED);
254 rdma->state = P9_RDMA_ROUTE_RESOLVED;
257 case RDMA_CM_EVENT_ESTABLISHED:
258 BUG_ON(rdma->state != P9_RDMA_ROUTE_RESOLVED);
259 rdma->state = P9_RDMA_CONNECTED;
262 case RDMA_CM_EVENT_DISCONNECTED:
264 rdma->state = P9_RDMA_CLOSED;
265 c->status = Disconnected;
268 case RDMA_CM_EVENT_TIMEWAIT_EXIT:
271 case RDMA_CM_EVENT_ADDR_CHANGE:
272 case RDMA_CM_EVENT_ROUTE_ERROR:
273 case RDMA_CM_EVENT_DEVICE_REMOVAL:
274 case RDMA_CM_EVENT_MULTICAST_JOIN:
275 case RDMA_CM_EVENT_MULTICAST_ERROR:
276 case RDMA_CM_EVENT_REJECTED:
277 case RDMA_CM_EVENT_CONNECT_REQUEST:
278 case RDMA_CM_EVENT_CONNECT_RESPONSE:
279 case RDMA_CM_EVENT_CONNECT_ERROR:
280 case RDMA_CM_EVENT_ADDR_ERROR:
281 case RDMA_CM_EVENT_UNREACHABLE:
282 c->status = Disconnected;
283 rdma_disconnect(rdma->cm_id);
288 complete(&rdma->cm_done);
293 recv_done(struct ib_cq *cq, struct ib_wc *wc)
295 struct p9_client *client = cq->cq_context;
296 struct p9_trans_rdma *rdma = client->trans;
297 struct p9_rdma_context *c =
298 container_of(wc->wr_cqe, struct p9_rdma_context, cqe);
299 struct p9_req_t *req;
304 ib_dma_unmap_single(rdma->cm_id->device, c->busa, client->msize,
307 if (wc->status != IB_WC_SUCCESS)
310 c->rc.size = wc->byte_len;
311 err = p9_parse_header(&c->rc, NULL, NULL, &tag, 1);
315 req = p9_tag_lookup(client, tag);
319 /* Check that we have not yet received a reply for this request.
321 if (unlikely(req->rc.sdata)) {
322 pr_err("Duplicate reply for request %d", tag);
326 req->rc.size = c->rc.size;
327 req->rc.sdata = c->rc.sdata;
328 p9_client_cb(client, req, REQ_STATUS_RCVD);
336 p9_debug(P9_DEBUG_ERROR, "req %p err %d status %d\n",
337 req, err, wc->status);
338 rdma->state = P9_RDMA_FLUSHING;
339 client->status = Disconnected;
344 send_done(struct ib_cq *cq, struct ib_wc *wc)
346 struct p9_client *client = cq->cq_context;
347 struct p9_trans_rdma *rdma = client->trans;
348 struct p9_rdma_context *c =
349 container_of(wc->wr_cqe, struct p9_rdma_context, cqe);
351 ib_dma_unmap_single(rdma->cm_id->device,
352 c->busa, c->req->tc.size,
359 static void qp_event_handler(struct ib_event *event, void *context)
361 p9_debug(P9_DEBUG_ERROR, "QP event %d context %p\n",
362 event->event, context);
365 static void rdma_destroy_trans(struct p9_trans_rdma *rdma)
370 if (rdma->qp && !IS_ERR(rdma->qp))
371 ib_destroy_qp(rdma->qp);
373 if (rdma->pd && !IS_ERR(rdma->pd))
374 ib_dealloc_pd(rdma->pd);
376 if (rdma->cq && !IS_ERR(rdma->cq))
377 ib_free_cq(rdma->cq);
379 if (rdma->cm_id && !IS_ERR(rdma->cm_id))
380 rdma_destroy_id(rdma->cm_id);
386 post_recv(struct p9_client *client, struct p9_rdma_context *c)
388 struct p9_trans_rdma *rdma = client->trans;
389 struct ib_recv_wr wr;
392 c->busa = ib_dma_map_single(rdma->cm_id->device,
393 c->rc.sdata, client->msize,
395 if (ib_dma_mapping_error(rdma->cm_id->device, c->busa))
398 c->cqe.done = recv_done;
401 sge.length = client->msize;
402 sge.lkey = rdma->pd->local_dma_lkey;
408 return ib_post_recv(rdma->qp, &wr, NULL);
411 p9_debug(P9_DEBUG_ERROR, "EIO\n");
415 static int rdma_request(struct p9_client *client, struct p9_req_t *req)
417 struct p9_trans_rdma *rdma = client->trans;
418 struct ib_send_wr wr;
422 struct p9_rdma_context *c = NULL;
423 struct p9_rdma_context *rpl_context = NULL;
425 /* When an error occurs between posting the recv and the send,
426 * there will be a receive context posted without a pending request.
427 * Since there is no way to "un-post" it, we remember it and skip
428 * post_recv() for the next request.
430 * see if we are this `next request' and need to absorb an excess rc.
431 * If yes, then drop and free our own, and do not recv_post().
433 if (unlikely(atomic_read(&rdma->excess_rc) > 0)) {
434 if ((atomic_sub_return(1, &rdma->excess_rc) >= 0)) {
436 p9_fcall_fini(&req->rc);
437 req->rc.sdata = NULL;
438 goto dont_need_post_recv;
440 /* We raced and lost. */
441 atomic_inc(&rdma->excess_rc);
445 /* Allocate an fcall for the reply */
446 rpl_context = kmalloc(sizeof *rpl_context, GFP_NOFS);
451 rpl_context->rc.sdata = req->rc.sdata;
454 * Post a receive buffer for this request. We need to ensure
455 * there is a reply buffer available for every outstanding
456 * request. A flushed request can result in no reply for an
457 * outstanding request, so we must keep a count to avoid
458 * overflowing the RQ.
460 if (down_interruptible(&rdma->rq_sem)) {
465 err = post_recv(client, rpl_context);
467 p9_debug(P9_DEBUG_ERROR, "POST RECV failed: %d\n", err);
470 /* remove posted receive buffer from request structure */
471 req->rc.sdata = NULL;
474 /* Post the request */
475 c = kmalloc(sizeof *c, GFP_NOFS);
482 c->busa = ib_dma_map_single(rdma->cm_id->device,
483 c->req->tc.sdata, c->req->tc.size,
485 if (ib_dma_mapping_error(rdma->cm_id->device, c->busa)) {
490 c->cqe.done = send_done;
493 sge.length = c->req->tc.size;
494 sge.lkey = rdma->pd->local_dma_lkey;
498 wr.opcode = IB_WR_SEND;
499 wr.send_flags = IB_SEND_SIGNALED;
503 if (down_interruptible(&rdma->sq_sem)) {
508 /* Mark request as `sent' *before* we actually send it,
509 * because doing if after could erase the REQ_STATUS_RCVD
510 * status in case of a very fast reply.
512 req->status = REQ_STATUS_SENT;
513 err = ib_post_send(rdma->qp, &wr, NULL);
520 /* Handle errors that happened during or while preparing the send: */
522 req->status = REQ_STATUS_ERROR;
524 p9_debug(P9_DEBUG_ERROR, "Error %d in rdma_request()\n", err);
527 * We did recv_post(), but not send. We have one recv_post in excess.
529 atomic_inc(&rdma->excess_rc);
532 /* Handle errors that happened during or while preparing post_recv(): */
535 spin_lock_irqsave(&rdma->req_lock, flags);
536 if (err != -EINTR && rdma->state < P9_RDMA_CLOSING) {
537 rdma->state = P9_RDMA_CLOSING;
538 spin_unlock_irqrestore(&rdma->req_lock, flags);
539 rdma_disconnect(rdma->cm_id);
541 spin_unlock_irqrestore(&rdma->req_lock, flags);
545 static void rdma_close(struct p9_client *client)
547 struct p9_trans_rdma *rdma;
552 rdma = client->trans;
556 client->status = Disconnected;
557 rdma_disconnect(rdma->cm_id);
558 rdma_destroy_trans(rdma);
562 * alloc_rdma - Allocate and initialize the rdma transport structure
563 * @opts: Mount options structure
565 static struct p9_trans_rdma *alloc_rdma(struct p9_rdma_opts *opts)
567 struct p9_trans_rdma *rdma;
569 rdma = kzalloc(sizeof(struct p9_trans_rdma), GFP_KERNEL);
573 rdma->port = opts->port;
574 rdma->privport = opts->privport;
575 rdma->sq_depth = opts->sq_depth;
576 rdma->rq_depth = opts->rq_depth;
577 rdma->timeout = opts->timeout;
578 spin_lock_init(&rdma->req_lock);
579 init_completion(&rdma->cm_done);
580 sema_init(&rdma->sq_sem, rdma->sq_depth);
581 sema_init(&rdma->rq_sem, rdma->rq_depth);
582 atomic_set(&rdma->excess_rc, 0);
587 static int rdma_cancel(struct p9_client *client, struct p9_req_t *req)
589 /* Nothing to do here.
590 * We will take care of it (if we have to) in rdma_cancelled()
595 /* A request has been fully flushed without a reply.
596 * That means we have posted one buffer in excess.
598 static int rdma_cancelled(struct p9_client *client, struct p9_req_t *req)
600 struct p9_trans_rdma *rdma = client->trans;
601 atomic_inc(&rdma->excess_rc);
605 static int p9_rdma_bind_privport(struct p9_trans_rdma *rdma)
607 struct sockaddr_in cl = {
608 .sin_family = AF_INET,
609 .sin_addr.s_addr = htonl(INADDR_ANY),
611 int port, err = -EINVAL;
613 for (port = P9_DEF_MAX_RESVPORT; port >= P9_DEF_MIN_RESVPORT; port--) {
614 cl.sin_port = htons((ushort)port);
615 err = rdma_bind_addr(rdma->cm_id, (struct sockaddr *)&cl);
616 if (err != -EADDRINUSE)
623 * rdma_create_trans - Transport method for creating a transport instance
624 * @client: client instance
625 * @addr: IP address string
626 * @args: Mount options string
629 rdma_create_trans(struct p9_client *client, const char *addr, char *args)
632 struct p9_rdma_opts opts;
633 struct p9_trans_rdma *rdma;
634 struct rdma_conn_param conn_param;
635 struct ib_qp_init_attr qp_attr;
640 /* Parse the transport specific mount options */
641 err = parse_opts(args, &opts);
645 /* Create and initialize the RDMA transport structure */
646 rdma = alloc_rdma(&opts);
650 /* Create the RDMA CM ID */
651 rdma->cm_id = rdma_create_id(&init_net, p9_cm_event_handler, client,
652 RDMA_PS_TCP, IB_QPT_RC);
653 if (IS_ERR(rdma->cm_id))
656 /* Associate the client with the transport */
657 client->trans = rdma;
659 /* Bind to a privileged port if we need to */
661 err = p9_rdma_bind_privport(rdma);
663 pr_err("%s (%d): problem binding to privport: %d\n",
664 __func__, task_pid_nr(current), -err);
669 /* Resolve the server's address */
670 rdma->addr.sin_family = AF_INET;
671 rdma->addr.sin_addr.s_addr = in_aton(addr);
672 rdma->addr.sin_port = htons(opts.port);
673 err = rdma_resolve_addr(rdma->cm_id, NULL,
674 (struct sockaddr *)&rdma->addr,
678 err = wait_for_completion_interruptible(&rdma->cm_done);
679 if (err || (rdma->state != P9_RDMA_ADDR_RESOLVED))
682 /* Resolve the route to the server */
683 err = rdma_resolve_route(rdma->cm_id, rdma->timeout);
686 err = wait_for_completion_interruptible(&rdma->cm_done);
687 if (err || (rdma->state != P9_RDMA_ROUTE_RESOLVED))
690 /* Create the Completion Queue */
691 rdma->cq = ib_alloc_cq_any(rdma->cm_id->device, client,
692 opts.sq_depth + opts.rq_depth + 1,
694 if (IS_ERR(rdma->cq))
697 /* Create the Protection Domain */
698 rdma->pd = ib_alloc_pd(rdma->cm_id->device, 0);
699 if (IS_ERR(rdma->pd))
702 /* Create the Queue Pair */
703 memset(&qp_attr, 0, sizeof qp_attr);
704 qp_attr.event_handler = qp_event_handler;
705 qp_attr.qp_context = client;
706 qp_attr.cap.max_send_wr = opts.sq_depth;
707 qp_attr.cap.max_recv_wr = opts.rq_depth;
708 qp_attr.cap.max_send_sge = P9_RDMA_SEND_SGE;
709 qp_attr.cap.max_recv_sge = P9_RDMA_RECV_SGE;
710 qp_attr.sq_sig_type = IB_SIGNAL_REQ_WR;
711 qp_attr.qp_type = IB_QPT_RC;
712 qp_attr.send_cq = rdma->cq;
713 qp_attr.recv_cq = rdma->cq;
714 err = rdma_create_qp(rdma->cm_id, rdma->pd, &qp_attr);
717 rdma->qp = rdma->cm_id->qp;
719 /* Request a connection */
720 memset(&conn_param, 0, sizeof(conn_param));
721 conn_param.private_data = NULL;
722 conn_param.private_data_len = 0;
723 conn_param.responder_resources = P9_RDMA_IRD;
724 conn_param.initiator_depth = P9_RDMA_ORD;
725 err = rdma_connect(rdma->cm_id, &conn_param);
728 err = wait_for_completion_interruptible(&rdma->cm_done);
729 if (err || (rdma->state != P9_RDMA_CONNECTED))
732 client->status = Connected;
737 rdma_destroy_trans(rdma);
741 static struct p9_trans_module p9_rdma_trans = {
743 .maxsize = P9_RDMA_MAXSIZE,
745 .owner = THIS_MODULE,
746 .create = rdma_create_trans,
748 .request = rdma_request,
749 .cancel = rdma_cancel,
750 .cancelled = rdma_cancelled,
751 .show_options = p9_rdma_show_options,
755 * p9_trans_rdma_init - Register the 9P RDMA transport driver
757 static int __init p9_trans_rdma_init(void)
759 v9fs_register_trans(&p9_rdma_trans);
763 static void __exit p9_trans_rdma_exit(void)
765 v9fs_unregister_trans(&p9_rdma_trans);
768 module_init(p9_trans_rdma_init);
769 module_exit(p9_trans_rdma_exit);
771 MODULE_AUTHOR("Tom Tucker <tom@opengridcomputing.com>");
772 MODULE_DESCRIPTION("RDMA Transport for 9P");
773 MODULE_LICENSE("Dual BSD/GPL");