2 * linux/fs/9p/trans_rdma.c
4 * RDMA transport layer based on the trans_fd.c implementation.
6 * Copyright (C) 2008 by Tom Tucker <tom@opengridcomputing.com>
7 * Copyright (C) 2006 by Russ Cox <rsc@swtch.com>
8 * Copyright (C) 2004-2005 by Latchesar Ionkov <lucho@ionkov.net>
9 * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
10 * Copyright (C) 1997-2002 by Ron Minnich <rminnich@sarnoff.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2
14 * as published by the Free Software Foundation.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to:
23 * Free Software Foundation
24 * 51 Franklin Street, Fifth Floor
25 * Boston, MA 02111-1301 USA
29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/module.h>
33 #include <linux/net.h>
34 #include <linux/ipv6.h>
35 #include <linux/kthread.h>
36 #include <linux/errno.h>
37 #include <linux/kernel.h>
39 #include <linux/uaccess.h>
40 #include <linux/inet.h>
41 #include <linux/idr.h>
42 #include <linux/file.h>
43 #include <linux/parser.h>
44 #include <linux/semaphore.h>
45 #include <linux/slab.h>
46 #include <net/9p/9p.h>
47 #include <net/9p/client.h>
48 #include <net/9p/transport.h>
49 #include <rdma/ib_verbs.h>
50 #include <rdma/rdma_cm.h>
53 #define P9_RDMA_SQ_DEPTH 32
54 #define P9_RDMA_RQ_DEPTH 32
55 #define P9_RDMA_SEND_SGE 4
56 #define P9_RDMA_RECV_SGE 4
59 #define P9_RDMA_TIMEOUT 30000 /* 30 seconds */
60 #define P9_RDMA_MAXSIZE (1024*1024) /* 1MB */
63 * struct p9_trans_rdma - RDMA transport instance
65 * @state: tracks the transport state machine for connection setup and tear down
66 * @cm_id: The RDMA CM ID
67 * @pd: Protection Domain pointer
68 * @qp: Queue Pair pointer
69 * @cq: Completion Queue pointer
70 * @dm_mr: DMA Memory Region pointer
71 * @lkey: The local access only memory region key
72 * @timeout: Number of uSecs to wait for connection management events
73 * @sq_depth: The depth of the Send Queue
74 * @sq_sem: Semaphore for the SQ
75 * @rq_depth: The depth of the Receive Queue.
76 * @rq_sem: Semaphore for the RQ
77 * @addr: The remote peer's address
78 * @req_lock: Protects the active request list
79 * @cm_done: Completion event for connection management tracking
81 struct p9_trans_rdma {
84 P9_RDMA_ADDR_RESOLVED,
85 P9_RDMA_ROUTE_RESOLVED,
91 struct rdma_cm_id *cm_id;
99 struct semaphore sq_sem;
101 struct semaphore rq_sem;
102 struct sockaddr_in addr;
105 struct completion cm_done;
109 * p9_rdma_context - Keeps track of in-process WR
111 * @wc_op: The original WR op for when the CQE completes in error.
112 * @busa: Bus address to unmap when the WR completes
113 * @req: Keeps track of requests (send)
114 * @rc: Keepts track of replies (receive)
117 struct p9_rdma_context {
118 enum ib_wc_opcode wc_op;
121 struct p9_req_t *req;
127 * p9_rdma_opts - Collection of mount options
128 * @port: port of connection
129 * @sq_depth: The requested depth of the SQ. This really doesn't need
130 * to be any deeper than the number of threads used in the client
131 * @rq_depth: The depth of the RQ. Should be greater than or equal to SQ depth
132 * @timeout: Time to wait in msecs for CM events
134 struct p9_rdma_opts {
142 * Option Parsing (code inspired by NFS code)
145 /* Options that take integer arguments */
146 Opt_port, Opt_rq_depth, Opt_sq_depth, Opt_timeout, Opt_err,
149 static match_table_t tokens = {
150 {Opt_port, "port=%u"},
151 {Opt_sq_depth, "sq=%u"},
152 {Opt_rq_depth, "rq=%u"},
153 {Opt_timeout, "timeout=%u"},
158 * parse_opts - parse mount options into rdma options structure
159 * @params: options string passed from mount
160 * @opts: rdma transport-specific structure to parse options into
162 * Returns 0 upon success, -ERRNO upon failure
164 static int parse_opts(char *params, struct p9_rdma_opts *opts)
167 substring_t args[MAX_OPT_ARGS];
169 char *options, *tmp_options;
171 opts->port = P9_PORT;
172 opts->sq_depth = P9_RDMA_SQ_DEPTH;
173 opts->rq_depth = P9_RDMA_RQ_DEPTH;
174 opts->timeout = P9_RDMA_TIMEOUT;
179 tmp_options = kstrdup(params, GFP_KERNEL);
181 p9_debug(P9_DEBUG_ERROR,
182 "failed to allocate copy of option string\n");
185 options = tmp_options;
187 while ((p = strsep(&options, ",")) != NULL) {
192 token = match_token(p, tokens, args);
193 r = match_int(&args[0], &option);
195 p9_debug(P9_DEBUG_ERROR,
196 "integer field, but no integer?\n");
204 opts->sq_depth = option;
207 opts->rq_depth = option;
210 opts->timeout = option;
216 /* RQ must be at least as large as the SQ */
217 opts->rq_depth = max(opts->rq_depth, opts->sq_depth);
223 p9_cm_event_handler(struct rdma_cm_id *id, struct rdma_cm_event *event)
225 struct p9_client *c = id->context;
226 struct p9_trans_rdma *rdma = c->trans;
227 switch (event->event) {
228 case RDMA_CM_EVENT_ADDR_RESOLVED:
229 BUG_ON(rdma->state != P9_RDMA_INIT);
230 rdma->state = P9_RDMA_ADDR_RESOLVED;
233 case RDMA_CM_EVENT_ROUTE_RESOLVED:
234 BUG_ON(rdma->state != P9_RDMA_ADDR_RESOLVED);
235 rdma->state = P9_RDMA_ROUTE_RESOLVED;
238 case RDMA_CM_EVENT_ESTABLISHED:
239 BUG_ON(rdma->state != P9_RDMA_ROUTE_RESOLVED);
240 rdma->state = P9_RDMA_CONNECTED;
243 case RDMA_CM_EVENT_DISCONNECTED:
245 rdma->state = P9_RDMA_CLOSED;
247 c->status = Disconnected;
250 case RDMA_CM_EVENT_TIMEWAIT_EXIT:
253 case RDMA_CM_EVENT_ADDR_CHANGE:
254 case RDMA_CM_EVENT_ROUTE_ERROR:
255 case RDMA_CM_EVENT_DEVICE_REMOVAL:
256 case RDMA_CM_EVENT_MULTICAST_JOIN:
257 case RDMA_CM_EVENT_MULTICAST_ERROR:
258 case RDMA_CM_EVENT_REJECTED:
259 case RDMA_CM_EVENT_CONNECT_REQUEST:
260 case RDMA_CM_EVENT_CONNECT_RESPONSE:
261 case RDMA_CM_EVENT_CONNECT_ERROR:
262 case RDMA_CM_EVENT_ADDR_ERROR:
263 case RDMA_CM_EVENT_UNREACHABLE:
264 c->status = Disconnected;
265 rdma_disconnect(rdma->cm_id);
270 complete(&rdma->cm_done);
275 handle_recv(struct p9_client *client, struct p9_trans_rdma *rdma,
276 struct p9_rdma_context *c, enum ib_wc_status status, u32 byte_len)
278 struct p9_req_t *req;
283 ib_dma_unmap_single(rdma->cm_id->device, c->busa, client->msize,
286 if (status != IB_WC_SUCCESS)
289 err = p9_parse_header(c->rc, NULL, NULL, &tag, 1);
293 req = p9_tag_lookup(client, tag);
297 /* Check that we have not yet received a reply for this request.
299 if (unlikely(req->rc)) {
300 pr_err("Duplicate reply for request %d", tag);
305 req->status = REQ_STATUS_RCVD;
306 p9_client_cb(client, req);
311 p9_debug(P9_DEBUG_ERROR, "req %p err %d status %d\n", req, err, status);
312 rdma->state = P9_RDMA_FLUSHING;
313 client->status = Disconnected;
317 handle_send(struct p9_client *client, struct p9_trans_rdma *rdma,
318 struct p9_rdma_context *c, enum ib_wc_status status, u32 byte_len)
320 ib_dma_unmap_single(rdma->cm_id->device,
321 c->busa, c->req->tc->size,
325 static void qp_event_handler(struct ib_event *event, void *context)
327 p9_debug(P9_DEBUG_ERROR, "QP event %d context %p\n",
328 event->event, context);
331 static void cq_comp_handler(struct ib_cq *cq, void *cq_context)
333 struct p9_client *client = cq_context;
334 struct p9_trans_rdma *rdma = client->trans;
338 ib_req_notify_cq(rdma->cq, IB_CQ_NEXT_COMP);
339 while ((ret = ib_poll_cq(cq, 1, &wc)) > 0) {
340 struct p9_rdma_context *c = (void *) (unsigned long) wc.wr_id;
344 handle_recv(client, rdma, c, wc.status, wc.byte_len);
349 handle_send(client, rdma, c, wc.status, wc.byte_len);
354 pr_err("unexpected completion type, c->wc_op=%d, wc.opcode=%d, status=%d\n",
355 c->wc_op, wc.opcode, wc.status);
362 static void cq_event_handler(struct ib_event *e, void *v)
364 p9_debug(P9_DEBUG_ERROR, "CQ event %d context %p\n", e->event, v);
367 static void rdma_destroy_trans(struct p9_trans_rdma *rdma)
372 if (rdma->dma_mr && !IS_ERR(rdma->dma_mr))
373 ib_dereg_mr(rdma->dma_mr);
375 if (rdma->qp && !IS_ERR(rdma->qp))
376 ib_destroy_qp(rdma->qp);
378 if (rdma->pd && !IS_ERR(rdma->pd))
379 ib_dealloc_pd(rdma->pd);
381 if (rdma->cq && !IS_ERR(rdma->cq))
382 ib_destroy_cq(rdma->cq);
384 if (rdma->cm_id && !IS_ERR(rdma->cm_id))
385 rdma_destroy_id(rdma->cm_id);
391 post_recv(struct p9_client *client, struct p9_rdma_context *c)
393 struct p9_trans_rdma *rdma = client->trans;
394 struct ib_recv_wr wr, *bad_wr;
397 c->busa = ib_dma_map_single(rdma->cm_id->device,
398 c->rc->sdata, client->msize,
400 if (ib_dma_mapping_error(rdma->cm_id->device, c->busa))
404 sge.length = client->msize;
405 sge.lkey = rdma->lkey;
408 c->wc_op = IB_WC_RECV;
409 wr.wr_id = (unsigned long) c;
412 return ib_post_recv(rdma->qp, &wr, &bad_wr);
415 p9_debug(P9_DEBUG_ERROR, "EIO\n");
419 static int rdma_request(struct p9_client *client, struct p9_req_t *req)
421 struct p9_trans_rdma *rdma = client->trans;
422 struct ib_send_wr wr, *bad_wr;
426 struct p9_rdma_context *c = NULL;
427 struct p9_rdma_context *rpl_context = NULL;
429 /* Allocate an fcall for the reply */
430 rpl_context = kmalloc(sizeof *rpl_context, GFP_NOFS);
435 rpl_context->rc = req->rc;
438 * Post a receive buffer for this request. We need to ensure
439 * there is a reply buffer available for every outstanding
440 * request. A flushed request can result in no reply for an
441 * outstanding request, so we must keep a count to avoid
442 * overflowing the RQ.
444 if (down_interruptible(&rdma->rq_sem)) {
449 err = post_recv(client, rpl_context);
451 p9_debug(P9_DEBUG_FCALL, "POST RECV failed\n");
455 /* remove posted receive buffer from request structure */
458 /* Post the request */
459 c = kmalloc(sizeof *c, GFP_NOFS);
466 c->busa = ib_dma_map_single(rdma->cm_id->device,
467 c->req->tc->sdata, c->req->tc->size,
469 if (ib_dma_mapping_error(rdma->cm_id->device, c->busa)) {
475 sge.length = c->req->tc->size;
476 sge.lkey = rdma->lkey;
479 c->wc_op = IB_WC_SEND;
480 wr.wr_id = (unsigned long) c;
481 wr.opcode = IB_WR_SEND;
482 wr.send_flags = IB_SEND_SIGNALED;
486 if (down_interruptible(&rdma->sq_sem)) {
491 err = ib_post_send(rdma->qp, &wr, &bad_wr);
498 /* Handle errors that happened during or while preparing the send: */
501 p9_debug(P9_DEBUG_ERROR, "Error %d in rdma_request()\n", err);
504 /* Handle errors that happened during or while preparing post_recv(): */
507 spin_lock_irqsave(&rdma->req_lock, flags);
508 if (rdma->state < P9_RDMA_CLOSING) {
509 rdma->state = P9_RDMA_CLOSING;
510 spin_unlock_irqrestore(&rdma->req_lock, flags);
511 rdma_disconnect(rdma->cm_id);
513 spin_unlock_irqrestore(&rdma->req_lock, flags);
517 static void rdma_close(struct p9_client *client)
519 struct p9_trans_rdma *rdma;
524 rdma = client->trans;
528 client->status = Disconnected;
529 rdma_disconnect(rdma->cm_id);
530 rdma_destroy_trans(rdma);
534 * alloc_rdma - Allocate and initialize the rdma transport structure
535 * @opts: Mount options structure
537 static struct p9_trans_rdma *alloc_rdma(struct p9_rdma_opts *opts)
539 struct p9_trans_rdma *rdma;
541 rdma = kzalloc(sizeof(struct p9_trans_rdma), GFP_KERNEL);
545 rdma->sq_depth = opts->sq_depth;
546 rdma->rq_depth = opts->rq_depth;
547 rdma->timeout = opts->timeout;
548 spin_lock_init(&rdma->req_lock);
549 init_completion(&rdma->cm_done);
550 sema_init(&rdma->sq_sem, rdma->sq_depth);
551 sema_init(&rdma->rq_sem, rdma->rq_depth);
556 /* its not clear to me we can do anything after send has been posted */
557 static int rdma_cancel(struct p9_client *client, struct p9_req_t *req)
563 * trans_create_rdma - Transport method for creating atransport instance
564 * @client: client instance
565 * @addr: IP address string
566 * @args: Mount options string
569 rdma_create_trans(struct p9_client *client, const char *addr, char *args)
572 struct p9_rdma_opts opts;
573 struct p9_trans_rdma *rdma;
574 struct rdma_conn_param conn_param;
575 struct ib_qp_init_attr qp_attr;
576 struct ib_device_attr devattr;
578 /* Parse the transport specific mount options */
579 err = parse_opts(args, &opts);
583 /* Create and initialize the RDMA transport structure */
584 rdma = alloc_rdma(&opts);
588 /* Create the RDMA CM ID */
589 rdma->cm_id = rdma_create_id(p9_cm_event_handler, client, RDMA_PS_TCP,
591 if (IS_ERR(rdma->cm_id))
594 /* Associate the client with the transport */
595 client->trans = rdma;
597 /* Resolve the server's address */
598 rdma->addr.sin_family = AF_INET;
599 rdma->addr.sin_addr.s_addr = in_aton(addr);
600 rdma->addr.sin_port = htons(opts.port);
601 err = rdma_resolve_addr(rdma->cm_id, NULL,
602 (struct sockaddr *)&rdma->addr,
606 err = wait_for_completion_interruptible(&rdma->cm_done);
607 if (err || (rdma->state != P9_RDMA_ADDR_RESOLVED))
610 /* Resolve the route to the server */
611 err = rdma_resolve_route(rdma->cm_id, rdma->timeout);
614 err = wait_for_completion_interruptible(&rdma->cm_done);
615 if (err || (rdma->state != P9_RDMA_ROUTE_RESOLVED))
618 /* Query the device attributes */
619 err = ib_query_device(rdma->cm_id->device, &devattr);
623 /* Create the Completion Queue */
624 rdma->cq = ib_create_cq(rdma->cm_id->device, cq_comp_handler,
625 cq_event_handler, client,
626 opts.sq_depth + opts.rq_depth + 1, 0);
627 if (IS_ERR(rdma->cq))
629 ib_req_notify_cq(rdma->cq, IB_CQ_NEXT_COMP);
631 /* Create the Protection Domain */
632 rdma->pd = ib_alloc_pd(rdma->cm_id->device);
633 if (IS_ERR(rdma->pd))
636 /* Cache the DMA lkey in the transport */
638 if (devattr.device_cap_flags & IB_DEVICE_LOCAL_DMA_LKEY)
639 rdma->lkey = rdma->cm_id->device->local_dma_lkey;
641 rdma->dma_mr = ib_get_dma_mr(rdma->pd, IB_ACCESS_LOCAL_WRITE);
642 if (IS_ERR(rdma->dma_mr))
644 rdma->lkey = rdma->dma_mr->lkey;
647 /* Create the Queue Pair */
648 memset(&qp_attr, 0, sizeof qp_attr);
649 qp_attr.event_handler = qp_event_handler;
650 qp_attr.qp_context = client;
651 qp_attr.cap.max_send_wr = opts.sq_depth;
652 qp_attr.cap.max_recv_wr = opts.rq_depth;
653 qp_attr.cap.max_send_sge = P9_RDMA_SEND_SGE;
654 qp_attr.cap.max_recv_sge = P9_RDMA_RECV_SGE;
655 qp_attr.sq_sig_type = IB_SIGNAL_REQ_WR;
656 qp_attr.qp_type = IB_QPT_RC;
657 qp_attr.send_cq = rdma->cq;
658 qp_attr.recv_cq = rdma->cq;
659 err = rdma_create_qp(rdma->cm_id, rdma->pd, &qp_attr);
662 rdma->qp = rdma->cm_id->qp;
664 /* Request a connection */
665 memset(&conn_param, 0, sizeof(conn_param));
666 conn_param.private_data = NULL;
667 conn_param.private_data_len = 0;
668 conn_param.responder_resources = P9_RDMA_IRD;
669 conn_param.initiator_depth = P9_RDMA_ORD;
670 err = rdma_connect(rdma->cm_id, &conn_param);
673 err = wait_for_completion_interruptible(&rdma->cm_done);
674 if (err || (rdma->state != P9_RDMA_CONNECTED))
677 client->status = Connected;
682 rdma_destroy_trans(rdma);
686 static struct p9_trans_module p9_rdma_trans = {
688 .maxsize = P9_RDMA_MAXSIZE,
690 .owner = THIS_MODULE,
691 .create = rdma_create_trans,
693 .request = rdma_request,
694 .cancel = rdma_cancel,
698 * p9_trans_rdma_init - Register the 9P RDMA transport driver
700 static int __init p9_trans_rdma_init(void)
702 v9fs_register_trans(&p9_rdma_trans);
706 static void __exit p9_trans_rdma_exit(void)
708 v9fs_unregister_trans(&p9_rdma_trans);
711 module_init(p9_trans_rdma_init);
712 module_exit(p9_trans_rdma_exit);
714 MODULE_AUTHOR("Tom Tucker <tom@opengridcomputing.com>");
715 MODULE_DESCRIPTION("RDMA Transport for 9P");
716 MODULE_LICENSE("Dual BSD/GPL");