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
30 #include <linux/module.h>
31 #include <linux/net.h>
32 #include <linux/ipv6.h>
33 #include <linux/kthread.h>
34 #include <linux/errno.h>
35 #include <linux/kernel.h>
37 #include <linux/uaccess.h>
38 #include <linux/inet.h>
39 #include <linux/idr.h>
40 #include <linux/file.h>
41 #include <linux/parser.h>
42 #include <linux/semaphore.h>
43 #include <net/9p/9p.h>
44 #include <net/9p/client.h>
45 #include <net/9p/transport.h>
46 #include <rdma/ib_verbs.h>
47 #include <rdma/rdma_cm.h>
48 #include <rdma/ib_verbs.h>
51 #define P9_RDMA_SQ_DEPTH 32
52 #define P9_RDMA_RQ_DEPTH 32
53 #define P9_RDMA_SEND_SGE 4
54 #define P9_RDMA_RECV_SGE 4
57 #define P9_RDMA_TIMEOUT 30000 /* 30 seconds */
58 #define P9_RDMA_MAXSIZE (4*4096) /* Min SGE is 4, so we can
59 * safely advertise a maxsize
62 #define P9_RDMA_MAX_SGE (P9_RDMA_MAXSIZE >> PAGE_SHIFT)
64 * struct p9_trans_rdma - RDMA transport instance
66 * @state: tracks the transport state machine for connection setup and tear down
67 * @cm_id: The RDMA CM ID
68 * @pd: Protection Domain pointer
69 * @qp: Queue Pair pointer
70 * @cq: Completion Queue 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 * @addr: The remote peer's address
77 * @req_lock: Protects the active request list
78 * @send_wait: Wait list when the SQ fills up
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
;
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_options - parse mount options into session structure
159 * @options: options string passed from mount
160 * @opts: 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
];
172 opts
->port
= P9_PORT
;
173 opts
->sq_depth
= P9_RDMA_SQ_DEPTH
;
174 opts
->rq_depth
= P9_RDMA_RQ_DEPTH
;
175 opts
->timeout
= P9_RDMA_TIMEOUT
;
180 options
= kstrdup(params
, GFP_KERNEL
);
182 P9_DPRINTK(P9_DEBUG_ERROR
,
183 "failed to allocate copy of option string\n");
187 while ((p
= strsep(&options
, ",")) != NULL
) {
192 token
= match_token(p
, tokens
, args
);
193 r
= match_int(&args
[0], &option
);
195 P9_DPRINTK(P9_DEBUG_ERROR
,
196 "integer field, but no integer?\n");
205 opts
->sq_depth
= option
;
208 opts
->rq_depth
= option
;
211 opts
->timeout
= option
;
217 /* RQ must be at least as large as the SQ */
218 opts
->rq_depth
= max(opts
->rq_depth
, opts
->sq_depth
);
224 p9_cm_event_handler(struct rdma_cm_id
*id
, struct rdma_cm_event
*event
)
226 struct p9_client
*c
= id
->context
;
227 struct p9_trans_rdma
*rdma
= c
->trans
;
228 switch (event
->event
) {
229 case RDMA_CM_EVENT_ADDR_RESOLVED
:
230 BUG_ON(rdma
->state
!= P9_RDMA_INIT
);
231 rdma
->state
= P9_RDMA_ADDR_RESOLVED
;
234 case RDMA_CM_EVENT_ROUTE_RESOLVED
:
235 BUG_ON(rdma
->state
!= P9_RDMA_ADDR_RESOLVED
);
236 rdma
->state
= P9_RDMA_ROUTE_RESOLVED
;
239 case RDMA_CM_EVENT_ESTABLISHED
:
240 BUG_ON(rdma
->state
!= P9_RDMA_ROUTE_RESOLVED
);
241 rdma
->state
= P9_RDMA_CONNECTED
;
244 case RDMA_CM_EVENT_DISCONNECTED
:
246 rdma
->state
= P9_RDMA_CLOSED
;
248 c
->status
= Disconnected
;
251 case RDMA_CM_EVENT_TIMEWAIT_EXIT
:
254 case RDMA_CM_EVENT_ADDR_CHANGE
:
255 case RDMA_CM_EVENT_ROUTE_ERROR
:
256 case RDMA_CM_EVENT_DEVICE_REMOVAL
:
257 case RDMA_CM_EVENT_MULTICAST_JOIN
:
258 case RDMA_CM_EVENT_MULTICAST_ERROR
:
259 case RDMA_CM_EVENT_REJECTED
:
260 case RDMA_CM_EVENT_CONNECT_REQUEST
:
261 case RDMA_CM_EVENT_CONNECT_RESPONSE
:
262 case RDMA_CM_EVENT_CONNECT_ERROR
:
263 case RDMA_CM_EVENT_ADDR_ERROR
:
264 case RDMA_CM_EVENT_UNREACHABLE
:
265 c
->status
= Disconnected
;
266 rdma_disconnect(rdma
->cm_id
);
271 complete(&rdma
->cm_done
);
276 handle_recv(struct p9_client
*client
, struct p9_trans_rdma
*rdma
,
277 struct p9_rdma_context
*c
, enum ib_wc_status status
, u32 byte_len
)
279 struct p9_req_t
*req
;
284 ib_dma_unmap_single(rdma
->cm_id
->device
, c
->busa
, client
->msize
,
287 if (status
!= IB_WC_SUCCESS
)
290 err
= p9_parse_header(c
->rc
, NULL
, NULL
, &tag
, 1);
294 req
= p9_tag_lookup(client
, tag
);
299 p9_client_cb(client
, req
);
304 P9_DPRINTK(P9_DEBUG_ERROR
, "req %p err %d status %d\n",
306 rdma
->state
= P9_RDMA_FLUSHING
;
307 client
->status
= Disconnected
;
312 handle_send(struct p9_client
*client
, struct p9_trans_rdma
*rdma
,
313 struct p9_rdma_context
*c
, enum ib_wc_status status
, u32 byte_len
)
315 ib_dma_unmap_single(rdma
->cm_id
->device
,
316 c
->busa
, c
->req
->tc
->size
,
320 static void qp_event_handler(struct ib_event
*event
, void *context
)
322 P9_DPRINTK(P9_DEBUG_ERROR
, "QP event %d context %p\n", event
->event
,
326 static void cq_comp_handler(struct ib_cq
*cq
, void *cq_context
)
328 struct p9_client
*client
= cq_context
;
329 struct p9_trans_rdma
*rdma
= client
->trans
;
333 ib_req_notify_cq(rdma
->cq
, IB_CQ_NEXT_COMP
);
334 while ((ret
= ib_poll_cq(cq
, 1, &wc
)) > 0) {
335 struct p9_rdma_context
*c
= (void *) (unsigned long) wc
.wr_id
;
339 atomic_dec(&rdma
->rq_count
);
340 handle_recv(client
, rdma
, c
, wc
.status
, wc
.byte_len
);
344 handle_send(client
, rdma
, c
, wc
.status
, wc
.byte_len
);
349 printk(KERN_ERR
"9prdma: unexpected completion type, "
350 "c->wc_op=%d, wc.opcode=%d, status=%d\n",
351 c
->wc_op
, wc
.opcode
, wc
.status
);
358 static void cq_event_handler(struct ib_event
*e
, void *v
)
360 P9_DPRINTK(P9_DEBUG_ERROR
, "CQ event %d context %p\n", e
->event
, v
);
363 static void rdma_destroy_trans(struct p9_trans_rdma
*rdma
)
368 if (rdma
->dma_mr
&& !IS_ERR(rdma
->dma_mr
))
369 ib_dereg_mr(rdma
->dma_mr
);
371 if (rdma
->qp
&& !IS_ERR(rdma
->qp
))
372 ib_destroy_qp(rdma
->qp
);
374 if (rdma
->pd
&& !IS_ERR(rdma
->pd
))
375 ib_dealloc_pd(rdma
->pd
);
377 if (rdma
->cq
&& !IS_ERR(rdma
->cq
))
378 ib_destroy_cq(rdma
->cq
);
380 if (rdma
->cm_id
&& !IS_ERR(rdma
->cm_id
))
381 rdma_destroy_id(rdma
->cm_id
);
387 post_recv(struct p9_client
*client
, struct p9_rdma_context
*c
)
389 struct p9_trans_rdma
*rdma
= client
->trans
;
390 struct ib_recv_wr wr
, *bad_wr
;
393 c
->busa
= ib_dma_map_single(rdma
->cm_id
->device
,
394 c
->rc
->sdata
, client
->msize
,
396 if (ib_dma_mapping_error(rdma
->cm_id
->device
, c
->busa
))
400 sge
.length
= client
->msize
;
401 sge
.lkey
= rdma
->lkey
;
404 c
->wc_op
= IB_WC_RECV
;
405 wr
.wr_id
= (unsigned long) c
;
408 return ib_post_recv(rdma
->qp
, &wr
, &bad_wr
);
411 P9_DPRINTK(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
, *bad_wr
;
422 struct p9_rdma_context
*c
= NULL
;
423 struct p9_rdma_context
*rpl_context
= NULL
;
425 /* Allocate an fcall for the reply */
426 rpl_context
= kmalloc(sizeof *rpl_context
, GFP_KERNEL
);
431 * If the request has a buffer, steal it, otherwise
432 * allocate a new one. Typically, requests should already
433 * have receive buffers allocated and just swap them around
436 req
->rc
= kmalloc(sizeof(struct p9_fcall
)+client
->msize
,
439 req
->rc
->sdata
= (char *) req
->rc
+
440 sizeof(struct p9_fcall
);
441 req
->rc
->capacity
= client
->msize
;
444 rpl_context
->rc
= req
->rc
;
445 if (!rpl_context
->rc
) {
451 * Post a receive buffer for this request. We need to ensure
452 * there is a reply buffer available for every outstanding
453 * request. A flushed request can result in no reply for an
454 * outstanding request, so we must keep a count to avoid
455 * overflowing the RQ.
457 if (atomic_inc_return(&rdma
->rq_count
) <= rdma
->rq_depth
) {
458 err
= post_recv(client
, rpl_context
);
460 kfree(rpl_context
->rc
);
465 atomic_dec(&rdma
->rq_count
);
467 /* remove posted receive buffer from request structure */
470 /* Post the request */
471 c
= kmalloc(sizeof *c
, GFP_KERNEL
);
476 c
->busa
= ib_dma_map_single(rdma
->cm_id
->device
,
477 c
->req
->tc
->sdata
, c
->req
->tc
->size
,
479 if (ib_dma_mapping_error(rdma
->cm_id
->device
, c
->busa
))
483 sge
.length
= c
->req
->tc
->size
;
484 sge
.lkey
= rdma
->lkey
;
487 c
->wc_op
= IB_WC_SEND
;
488 wr
.wr_id
= (unsigned long) c
;
489 wr
.opcode
= IB_WR_SEND
;
490 wr
.send_flags
= IB_SEND_SIGNALED
;
494 if (down_interruptible(&rdma
->sq_sem
))
497 return ib_post_send(rdma
->qp
, &wr
, &bad_wr
);
500 P9_DPRINTK(P9_DEBUG_ERROR
, "EIO\n");
504 spin_lock_irqsave(&rdma
->req_lock
, flags
);
505 if (rdma
->state
< P9_RDMA_CLOSING
) {
506 rdma
->state
= P9_RDMA_CLOSING
;
507 spin_unlock_irqrestore(&rdma
->req_lock
, flags
);
508 rdma_disconnect(rdma
->cm_id
);
510 spin_unlock_irqrestore(&rdma
->req_lock
, flags
);
514 static void rdma_close(struct p9_client
*client
)
516 struct p9_trans_rdma
*rdma
;
521 rdma
= client
->trans
;
525 client
->status
= Disconnected
;
526 rdma_disconnect(rdma
->cm_id
);
527 rdma_destroy_trans(rdma
);
531 * alloc_rdma - Allocate and initialize the rdma transport structure
533 * @dotu: Extension attribute
534 * @opts: Mount options structure
536 static struct p9_trans_rdma
*alloc_rdma(struct p9_rdma_opts
*opts
)
538 struct p9_trans_rdma
*rdma
;
540 rdma
= kzalloc(sizeof(struct p9_trans_rdma
), GFP_KERNEL
);
544 rdma
->sq_depth
= opts
->sq_depth
;
545 rdma
->rq_depth
= opts
->rq_depth
;
546 rdma
->timeout
= opts
->timeout
;
547 spin_lock_init(&rdma
->req_lock
);
548 init_completion(&rdma
->cm_done
);
549 sema_init(&rdma
->sq_sem
, rdma
->sq_depth
);
550 atomic_set(&rdma
->rq_count
, 0);
555 /* its not clear to me we can do anything after send has been posted */
556 static int rdma_cancel(struct p9_client
*client
, struct p9_req_t
*req
)
562 * trans_create_rdma - Transport method for creating atransport instance
563 * @client: client instance
564 * @addr: IP address string
565 * @args: Mount options string
568 rdma_create_trans(struct p9_client
*client
, const char *addr
, char *args
)
571 struct p9_rdma_opts opts
;
572 struct p9_trans_rdma
*rdma
;
573 struct rdma_conn_param conn_param
;
574 struct ib_qp_init_attr qp_attr
;
575 struct ib_device_attr devattr
;
577 /* Parse the transport specific mount options */
578 err
= parse_opts(args
, &opts
);
582 /* Create and initialize the RDMA transport structure */
583 rdma
= alloc_rdma(&opts
);
587 /* Create the RDMA CM ID */
588 rdma
->cm_id
= rdma_create_id(p9_cm_event_handler
, client
, RDMA_PS_TCP
);
589 if (IS_ERR(rdma
->cm_id
))
592 /* Resolve the server's address */
593 rdma
->addr
.sin_family
= AF_INET
;
594 rdma
->addr
.sin_addr
.s_addr
= in_aton(addr
);
595 rdma
->addr
.sin_port
= htons(opts
.port
);
596 err
= rdma_resolve_addr(rdma
->cm_id
, NULL
,
597 (struct sockaddr
*)&rdma
->addr
,
601 err
= wait_for_completion_interruptible(&rdma
->cm_done
);
602 if (err
|| (rdma
->state
!= P9_RDMA_ADDR_RESOLVED
))
605 /* Resolve the route to the server */
606 err
= rdma_resolve_route(rdma
->cm_id
, rdma
->timeout
);
609 err
= wait_for_completion_interruptible(&rdma
->cm_done
);
610 if (err
|| (rdma
->state
!= P9_RDMA_ROUTE_RESOLVED
))
613 /* Query the device attributes */
614 err
= ib_query_device(rdma
->cm_id
->device
, &devattr
);
618 /* Create the Completion Queue */
619 rdma
->cq
= ib_create_cq(rdma
->cm_id
->device
, cq_comp_handler
,
620 cq_event_handler
, client
,
621 opts
.sq_depth
+ opts
.rq_depth
+ 1, 0);
622 if (IS_ERR(rdma
->cq
))
624 ib_req_notify_cq(rdma
->cq
, IB_CQ_NEXT_COMP
);
626 /* Create the Protection Domain */
627 rdma
->pd
= ib_alloc_pd(rdma
->cm_id
->device
);
628 if (IS_ERR(rdma
->pd
))
631 /* Cache the DMA lkey in the transport */
633 if (devattr
.device_cap_flags
& IB_DEVICE_LOCAL_DMA_LKEY
)
634 rdma
->lkey
= rdma
->cm_id
->device
->local_dma_lkey
;
636 rdma
->dma_mr
= ib_get_dma_mr(rdma
->pd
, IB_ACCESS_LOCAL_WRITE
);
637 if (IS_ERR(rdma
->dma_mr
))
639 rdma
->lkey
= rdma
->dma_mr
->lkey
;
642 /* Create the Queue Pair */
643 memset(&qp_attr
, 0, sizeof qp_attr
);
644 qp_attr
.event_handler
= qp_event_handler
;
645 qp_attr
.qp_context
= client
;
646 qp_attr
.cap
.max_send_wr
= opts
.sq_depth
;
647 qp_attr
.cap
.max_recv_wr
= opts
.rq_depth
;
648 qp_attr
.cap
.max_send_sge
= P9_RDMA_SEND_SGE
;
649 qp_attr
.cap
.max_recv_sge
= P9_RDMA_RECV_SGE
;
650 qp_attr
.sq_sig_type
= IB_SIGNAL_REQ_WR
;
651 qp_attr
.qp_type
= IB_QPT_RC
;
652 qp_attr
.send_cq
= rdma
->cq
;
653 qp_attr
.recv_cq
= rdma
->cq
;
654 err
= rdma_create_qp(rdma
->cm_id
, rdma
->pd
, &qp_attr
);
657 rdma
->qp
= rdma
->cm_id
->qp
;
659 /* Request a connection */
660 memset(&conn_param
, 0, sizeof(conn_param
));
661 conn_param
.private_data
= NULL
;
662 conn_param
.private_data_len
= 0;
663 conn_param
.responder_resources
= P9_RDMA_IRD
;
664 conn_param
.initiator_depth
= P9_RDMA_ORD
;
665 err
= rdma_connect(rdma
->cm_id
, &conn_param
);
668 err
= wait_for_completion_interruptible(&rdma
->cm_done
);
669 if (err
|| (rdma
->state
!= P9_RDMA_CONNECTED
))
672 client
->trans
= rdma
;
673 client
->status
= Connected
;
678 rdma_destroy_trans(rdma
);
682 static struct p9_trans_module p9_rdma_trans
= {
684 .maxsize
= P9_RDMA_MAXSIZE
,
686 .owner
= THIS_MODULE
,
687 .create
= rdma_create_trans
,
689 .request
= rdma_request
,
690 .cancel
= rdma_cancel
,
694 * p9_trans_rdma_init - Register the 9P RDMA transport driver
696 static int __init
p9_trans_rdma_init(void)
698 v9fs_register_trans(&p9_rdma_trans
);
702 static void __exit
p9_trans_rdma_exit(void)
704 v9fs_unregister_trans(&p9_rdma_trans
);
707 module_init(p9_trans_rdma_init
);
708 module_exit(p9_trans_rdma_exit
);
710 MODULE_AUTHOR("Tom Tucker <tom@opengridcomputing.com>");
711 MODULE_DESCRIPTION("RDMA Transport for 9P");
712 MODULE_LICENSE("Dual BSD/GPL");