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
;
98 * p9_rdma_context - Keeps track of in-process WR
100 * @busa: Bus address to unmap when the WR completes
101 * @req: Keeps track of requests (send)
102 * @rc: Keepts track of replies (receive)
105 struct p9_rdma_context
{
109 struct p9_req_t
*req
;
115 * p9_rdma_opts - Collection of mount options
116 * @port: port of connection
117 * @sq_depth: The requested depth of the SQ. This really doesn't need
118 * to be any deeper than the number of threads used in the client
119 * @rq_depth: The depth of the RQ. Should be greater than or equal to SQ depth
120 * @timeout: Time to wait in msecs for CM events
122 struct p9_rdma_opts
{
131 * Option Parsing (code inspired by NFS code)
134 /* Options that take integer arguments */
135 Opt_port
, Opt_rq_depth
, Opt_sq_depth
, Opt_timeout
,
136 /* Options that take no argument */
141 static match_table_t tokens
= {
142 {Opt_port
, "port=%u"},
143 {Opt_sq_depth
, "sq=%u"},
144 {Opt_rq_depth
, "rq=%u"},
145 {Opt_timeout
, "timeout=%u"},
146 {Opt_privport
, "privport"},
150 static int p9_rdma_show_options(struct seq_file
*m
, struct p9_client
*clnt
)
152 struct p9_trans_rdma
*rdma
= clnt
->trans
;
154 if (rdma
->port
!= P9_PORT
)
155 seq_printf(m
, ",port=%u", rdma
->port
);
156 if (rdma
->sq_depth
!= P9_RDMA_SQ_DEPTH
)
157 seq_printf(m
, ",sq=%u", rdma
->sq_depth
);
158 if (rdma
->rq_depth
!= P9_RDMA_RQ_DEPTH
)
159 seq_printf(m
, ",rq=%u", rdma
->rq_depth
);
160 if (rdma
->timeout
!= P9_RDMA_TIMEOUT
)
161 seq_printf(m
, ",timeout=%lu", rdma
->timeout
);
163 seq_puts(m
, ",privport");
168 * parse_opts - parse mount options into rdma options structure
169 * @params: options string passed from mount
170 * @opts: rdma transport-specific structure to parse options into
172 * Returns 0 upon success, -ERRNO upon failure
174 static int parse_opts(char *params
, struct p9_rdma_opts
*opts
)
177 substring_t args
[MAX_OPT_ARGS
];
179 char *options
, *tmp_options
;
181 opts
->port
= P9_PORT
;
182 opts
->sq_depth
= P9_RDMA_SQ_DEPTH
;
183 opts
->rq_depth
= P9_RDMA_RQ_DEPTH
;
184 opts
->timeout
= P9_RDMA_TIMEOUT
;
185 opts
->privport
= false;
190 tmp_options
= kstrdup(params
, GFP_KERNEL
);
192 p9_debug(P9_DEBUG_ERROR
,
193 "failed to allocate copy of option string\n");
196 options
= tmp_options
;
198 while ((p
= strsep(&options
, ",")) != NULL
) {
203 token
= match_token(p
, tokens
, args
);
204 if ((token
!= Opt_err
) && (token
!= Opt_privport
)) {
205 r
= match_int(&args
[0], &option
);
207 p9_debug(P9_DEBUG_ERROR
,
208 "integer field, but no integer?\n");
217 opts
->sq_depth
= option
;
220 opts
->rq_depth
= option
;
223 opts
->timeout
= option
;
226 opts
->privport
= true;
232 /* RQ must be at least as large as the SQ */
233 opts
->rq_depth
= max(opts
->rq_depth
, opts
->sq_depth
);
239 p9_cm_event_handler(struct rdma_cm_id
*id
, struct rdma_cm_event
*event
)
241 struct p9_client
*c
= id
->context
;
242 struct p9_trans_rdma
*rdma
= c
->trans
;
243 switch (event
->event
) {
244 case RDMA_CM_EVENT_ADDR_RESOLVED
:
245 BUG_ON(rdma
->state
!= P9_RDMA_INIT
);
246 rdma
->state
= P9_RDMA_ADDR_RESOLVED
;
249 case RDMA_CM_EVENT_ROUTE_RESOLVED
:
250 BUG_ON(rdma
->state
!= P9_RDMA_ADDR_RESOLVED
);
251 rdma
->state
= P9_RDMA_ROUTE_RESOLVED
;
254 case RDMA_CM_EVENT_ESTABLISHED
:
255 BUG_ON(rdma
->state
!= P9_RDMA_ROUTE_RESOLVED
);
256 rdma
->state
= P9_RDMA_CONNECTED
;
259 case RDMA_CM_EVENT_DISCONNECTED
:
261 rdma
->state
= P9_RDMA_CLOSED
;
262 c
->status
= Disconnected
;
265 case RDMA_CM_EVENT_TIMEWAIT_EXIT
:
268 case RDMA_CM_EVENT_ADDR_CHANGE
:
269 case RDMA_CM_EVENT_ROUTE_ERROR
:
270 case RDMA_CM_EVENT_DEVICE_REMOVAL
:
271 case RDMA_CM_EVENT_MULTICAST_JOIN
:
272 case RDMA_CM_EVENT_MULTICAST_ERROR
:
273 case RDMA_CM_EVENT_REJECTED
:
274 case RDMA_CM_EVENT_CONNECT_REQUEST
:
275 case RDMA_CM_EVENT_CONNECT_RESPONSE
:
276 case RDMA_CM_EVENT_CONNECT_ERROR
:
277 case RDMA_CM_EVENT_ADDR_ERROR
:
278 case RDMA_CM_EVENT_UNREACHABLE
:
279 c
->status
= Disconnected
;
280 rdma_disconnect(rdma
->cm_id
);
285 complete(&rdma
->cm_done
);
290 recv_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
292 struct p9_client
*client
= cq
->cq_context
;
293 struct p9_trans_rdma
*rdma
= client
->trans
;
294 struct p9_rdma_context
*c
=
295 container_of(wc
->wr_cqe
, struct p9_rdma_context
, cqe
);
296 struct p9_req_t
*req
;
301 ib_dma_unmap_single(rdma
->cm_id
->device
, c
->busa
, client
->msize
,
304 if (wc
->status
!= IB_WC_SUCCESS
)
307 c
->rc
.size
= wc
->byte_len
;
308 err
= p9_parse_header(&c
->rc
, NULL
, NULL
, &tag
, 1);
312 req
= p9_tag_lookup(client
, tag
);
316 /* Check that we have not yet received a reply for this request.
318 if (unlikely(req
->rc
.sdata
)) {
319 pr_err("Duplicate reply for request %d", tag
);
323 req
->rc
.size
= c
->rc
.size
;
324 req
->rc
.sdata
= c
->rc
.sdata
;
325 p9_client_cb(client
, req
, REQ_STATUS_RCVD
);
333 p9_debug(P9_DEBUG_ERROR
, "req %p err %d status %d\n",
334 req
, err
, wc
->status
);
335 rdma
->state
= P9_RDMA_FLUSHING
;
336 client
->status
= Disconnected
;
341 send_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
343 struct p9_client
*client
= cq
->cq_context
;
344 struct p9_trans_rdma
*rdma
= client
->trans
;
345 struct p9_rdma_context
*c
=
346 container_of(wc
->wr_cqe
, struct p9_rdma_context
, cqe
);
348 ib_dma_unmap_single(rdma
->cm_id
->device
,
349 c
->busa
, c
->req
->tc
.size
,
356 static void qp_event_handler(struct ib_event
*event
, void *context
)
358 p9_debug(P9_DEBUG_ERROR
, "QP event %d context %p\n",
359 event
->event
, context
);
362 static void rdma_destroy_trans(struct p9_trans_rdma
*rdma
)
367 if (rdma
->qp
&& !IS_ERR(rdma
->qp
))
368 ib_destroy_qp(rdma
->qp
);
370 if (rdma
->pd
&& !IS_ERR(rdma
->pd
))
371 ib_dealloc_pd(rdma
->pd
);
373 if (rdma
->cq
&& !IS_ERR(rdma
->cq
))
374 ib_free_cq(rdma
->cq
);
376 if (rdma
->cm_id
&& !IS_ERR(rdma
->cm_id
))
377 rdma_destroy_id(rdma
->cm_id
);
383 post_recv(struct p9_client
*client
, struct p9_rdma_context
*c
)
385 struct p9_trans_rdma
*rdma
= client
->trans
;
386 struct ib_recv_wr wr
;
389 c
->busa
= ib_dma_map_single(rdma
->cm_id
->device
,
390 c
->rc
.sdata
, client
->msize
,
392 if (ib_dma_mapping_error(rdma
->cm_id
->device
, c
->busa
))
395 c
->cqe
.done
= recv_done
;
398 sge
.length
= client
->msize
;
399 sge
.lkey
= rdma
->pd
->local_dma_lkey
;
405 return ib_post_recv(rdma
->qp
, &wr
, NULL
);
408 p9_debug(P9_DEBUG_ERROR
, "EIO\n");
412 static int rdma_request(struct p9_client
*client
, struct p9_req_t
*req
)
414 struct p9_trans_rdma
*rdma
= client
->trans
;
415 struct ib_send_wr wr
;
419 struct p9_rdma_context
*c
= NULL
;
420 struct p9_rdma_context
*rpl_context
= NULL
;
422 /* When an error occurs between posting the recv and the send,
423 * there will be a receive context posted without a pending request.
424 * Since there is no way to "un-post" it, we remember it and skip
425 * post_recv() for the next request.
427 * see if we are this `next request' and need to absorb an excess rc.
428 * If yes, then drop and free our own, and do not recv_post().
430 if (unlikely(atomic_read(&rdma
->excess_rc
) > 0)) {
431 if ((atomic_sub_return(1, &rdma
->excess_rc
) >= 0)) {
433 p9_fcall_fini(&req
->rc
);
434 req
->rc
.sdata
= NULL
;
435 goto dont_need_post_recv
;
437 /* We raced and lost. */
438 atomic_inc(&rdma
->excess_rc
);
442 /* Allocate an fcall for the reply */
443 rpl_context
= kmalloc(sizeof *rpl_context
, GFP_NOFS
);
448 rpl_context
->rc
.sdata
= req
->rc
.sdata
;
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 (down_interruptible(&rdma
->rq_sem
)) {
462 err
= post_recv(client
, rpl_context
);
464 p9_debug(P9_DEBUG_ERROR
, "POST RECV failed: %d\n", err
);
467 /* remove posted receive buffer from request structure */
468 req
->rc
.sdata
= NULL
;
471 /* Post the request */
472 c
= kmalloc(sizeof *c
, GFP_NOFS
);
479 c
->busa
= ib_dma_map_single(rdma
->cm_id
->device
,
480 c
->req
->tc
.sdata
, c
->req
->tc
.size
,
482 if (ib_dma_mapping_error(rdma
->cm_id
->device
, c
->busa
)) {
487 c
->cqe
.done
= send_done
;
490 sge
.length
= c
->req
->tc
.size
;
491 sge
.lkey
= rdma
->pd
->local_dma_lkey
;
495 wr
.opcode
= IB_WR_SEND
;
496 wr
.send_flags
= IB_SEND_SIGNALED
;
500 if (down_interruptible(&rdma
->sq_sem
)) {
505 /* Mark request as `sent' *before* we actually send it,
506 * because doing if after could erase the REQ_STATUS_RCVD
507 * status in case of a very fast reply.
509 req
->status
= REQ_STATUS_SENT
;
510 err
= ib_post_send(rdma
->qp
, &wr
, NULL
);
517 /* Handle errors that happened during or while preparing the send: */
519 req
->status
= REQ_STATUS_ERROR
;
521 p9_debug(P9_DEBUG_ERROR
, "Error %d in rdma_request()\n", err
);
524 * We did recv_post(), but not send. We have one recv_post in excess.
526 atomic_inc(&rdma
->excess_rc
);
529 /* Handle errors that happened during or while preparing post_recv(): */
532 spin_lock_irqsave(&rdma
->req_lock
, flags
);
533 if (err
!= -EINTR
&& rdma
->state
< P9_RDMA_CLOSING
) {
534 rdma
->state
= P9_RDMA_CLOSING
;
535 spin_unlock_irqrestore(&rdma
->req_lock
, flags
);
536 rdma_disconnect(rdma
->cm_id
);
538 spin_unlock_irqrestore(&rdma
->req_lock
, flags
);
542 static void rdma_close(struct p9_client
*client
)
544 struct p9_trans_rdma
*rdma
;
549 rdma
= client
->trans
;
553 client
->status
= Disconnected
;
554 rdma_disconnect(rdma
->cm_id
);
555 rdma_destroy_trans(rdma
);
559 * alloc_rdma - Allocate and initialize the rdma transport structure
560 * @opts: Mount options structure
562 static struct p9_trans_rdma
*alloc_rdma(struct p9_rdma_opts
*opts
)
564 struct p9_trans_rdma
*rdma
;
566 rdma
= kzalloc(sizeof(struct p9_trans_rdma
), GFP_KERNEL
);
570 rdma
->port
= opts
->port
;
571 rdma
->privport
= opts
->privport
;
572 rdma
->sq_depth
= opts
->sq_depth
;
573 rdma
->rq_depth
= opts
->rq_depth
;
574 rdma
->timeout
= opts
->timeout
;
575 spin_lock_init(&rdma
->req_lock
);
576 init_completion(&rdma
->cm_done
);
577 sema_init(&rdma
->sq_sem
, rdma
->sq_depth
);
578 sema_init(&rdma
->rq_sem
, rdma
->rq_depth
);
579 atomic_set(&rdma
->excess_rc
, 0);
584 static int rdma_cancel(struct p9_client
*client
, struct p9_req_t
*req
)
586 /* Nothing to do here.
587 * We will take care of it (if we have to) in rdma_cancelled()
592 /* A request has been fully flushed without a reply.
593 * That means we have posted one buffer in excess.
595 static int rdma_cancelled(struct p9_client
*client
, struct p9_req_t
*req
)
597 struct p9_trans_rdma
*rdma
= client
->trans
;
598 atomic_inc(&rdma
->excess_rc
);
602 static int p9_rdma_bind_privport(struct p9_trans_rdma
*rdma
)
604 struct sockaddr_in cl
= {
605 .sin_family
= AF_INET
,
606 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
608 int port
, err
= -EINVAL
;
610 for (port
= P9_DEF_MAX_RESVPORT
; port
>= P9_DEF_MIN_RESVPORT
; port
--) {
611 cl
.sin_port
= htons((ushort
)port
);
612 err
= rdma_bind_addr(rdma
->cm_id
, (struct sockaddr
*)&cl
);
613 if (err
!= -EADDRINUSE
)
620 * rdma_create_trans - Transport method for creating a transport instance
621 * @client: client instance
622 * @addr: IP address string
623 * @args: Mount options string
626 rdma_create_trans(struct p9_client
*client
, const char *addr
, char *args
)
629 struct p9_rdma_opts opts
;
630 struct p9_trans_rdma
*rdma
;
631 struct rdma_conn_param conn_param
;
632 struct ib_qp_init_attr qp_attr
;
637 /* Parse the transport specific mount options */
638 err
= parse_opts(args
, &opts
);
642 /* Create and initialize the RDMA transport structure */
643 rdma
= alloc_rdma(&opts
);
647 /* Create the RDMA CM ID */
648 rdma
->cm_id
= rdma_create_id(&init_net
, p9_cm_event_handler
, client
,
649 RDMA_PS_TCP
, IB_QPT_RC
);
650 if (IS_ERR(rdma
->cm_id
))
653 /* Associate the client with the transport */
654 client
->trans
= rdma
;
656 /* Bind to a privileged port if we need to */
658 err
= p9_rdma_bind_privport(rdma
);
660 pr_err("%s (%d): problem binding to privport: %d\n",
661 __func__
, task_pid_nr(current
), -err
);
666 /* Resolve the server's address */
667 rdma
->addr
.sin_family
= AF_INET
;
668 rdma
->addr
.sin_addr
.s_addr
= in_aton(addr
);
669 rdma
->addr
.sin_port
= htons(opts
.port
);
670 err
= rdma_resolve_addr(rdma
->cm_id
, NULL
,
671 (struct sockaddr
*)&rdma
->addr
,
675 err
= wait_for_completion_interruptible(&rdma
->cm_done
);
676 if (err
|| (rdma
->state
!= P9_RDMA_ADDR_RESOLVED
))
679 /* Resolve the route to the server */
680 err
= rdma_resolve_route(rdma
->cm_id
, rdma
->timeout
);
683 err
= wait_for_completion_interruptible(&rdma
->cm_done
);
684 if (err
|| (rdma
->state
!= P9_RDMA_ROUTE_RESOLVED
))
687 /* Create the Completion Queue */
688 rdma
->cq
= ib_alloc_cq_any(rdma
->cm_id
->device
, client
,
689 opts
.sq_depth
+ opts
.rq_depth
+ 1,
691 if (IS_ERR(rdma
->cq
))
694 /* Create the Protection Domain */
695 rdma
->pd
= ib_alloc_pd(rdma
->cm_id
->device
, 0);
696 if (IS_ERR(rdma
->pd
))
699 /* Create the Queue Pair */
700 memset(&qp_attr
, 0, sizeof qp_attr
);
701 qp_attr
.event_handler
= qp_event_handler
;
702 qp_attr
.qp_context
= client
;
703 qp_attr
.cap
.max_send_wr
= opts
.sq_depth
;
704 qp_attr
.cap
.max_recv_wr
= opts
.rq_depth
;
705 qp_attr
.cap
.max_send_sge
= P9_RDMA_SEND_SGE
;
706 qp_attr
.cap
.max_recv_sge
= P9_RDMA_RECV_SGE
;
707 qp_attr
.sq_sig_type
= IB_SIGNAL_REQ_WR
;
708 qp_attr
.qp_type
= IB_QPT_RC
;
709 qp_attr
.send_cq
= rdma
->cq
;
710 qp_attr
.recv_cq
= rdma
->cq
;
711 err
= rdma_create_qp(rdma
->cm_id
, rdma
->pd
, &qp_attr
);
714 rdma
->qp
= rdma
->cm_id
->qp
;
716 /* Request a connection */
717 memset(&conn_param
, 0, sizeof(conn_param
));
718 conn_param
.private_data
= NULL
;
719 conn_param
.private_data_len
= 0;
720 conn_param
.responder_resources
= P9_RDMA_IRD
;
721 conn_param
.initiator_depth
= P9_RDMA_ORD
;
722 err
= rdma_connect(rdma
->cm_id
, &conn_param
);
725 err
= wait_for_completion_interruptible(&rdma
->cm_done
);
726 if (err
|| (rdma
->state
!= P9_RDMA_CONNECTED
))
729 client
->status
= Connected
;
734 rdma_destroy_trans(rdma
);
738 static struct p9_trans_module p9_rdma_trans
= {
740 .maxsize
= P9_RDMA_MAXSIZE
,
742 .owner
= THIS_MODULE
,
743 .create
= rdma_create_trans
,
745 .request
= rdma_request
,
746 .cancel
= rdma_cancel
,
747 .cancelled
= rdma_cancelled
,
748 .show_options
= p9_rdma_show_options
,
752 * p9_trans_rdma_init - Register the 9P RDMA transport driver
754 static int __init
p9_trans_rdma_init(void)
756 v9fs_register_trans(&p9_rdma_trans
);
760 static void __exit
p9_trans_rdma_exit(void)
762 v9fs_unregister_trans(&p9_rdma_trans
);
765 module_init(p9_trans_rdma_init
);
766 module_exit(p9_trans_rdma_exit
);
768 MODULE_AUTHOR("Tom Tucker <tom@opengridcomputing.com>");
769 MODULE_DESCRIPTION("RDMA Transport for 9P");
770 MODULE_LICENSE("Dual BSD/GPL");