2 * Copyright(c) 2016 - 2018 Intel Corporation.
4 * This file is provided under a dual BSD/GPLv2 license. When using or
5 * redistributing this file, you may do so under either license.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
24 * - Redistributions of source code must retain the above copyright
25 * notice, this list of conditions and the following disclaimer.
26 * - Redistributions in binary form must reproduce the above copyright
27 * notice, this list of conditions and the following disclaimer in
28 * the documentation and/or other materials provided with the
30 * - Neither the name of Intel Corporation nor the names of its
31 * contributors may be used to endorse or promote products derived
32 * from this software without specific prior written permission.
34 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
35 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
36 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
37 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
38 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
41 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
42 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
43 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
44 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48 #include <linux/module.h>
49 #include <linux/kernel.h>
50 #include <linux/dma-mapping.h>
55 #define RVT_UVERBS_ABI_VERSION 2
57 MODULE_LICENSE("Dual BSD/GPL");
58 MODULE_DESCRIPTION("RDMA Verbs Transport Library");
60 static int rvt_init(void)
62 int ret = rvt_driver_cq_init();
65 pr_err("Error in driver CQ init.\n");
69 module_init(rvt_init);
71 static void rvt_cleanup(void)
75 module_exit(rvt_cleanup);
78 * rvt_alloc_device - allocate rdi
79 * @size: how big of a structure to allocate
80 * @nports: number of ports to allocate array slots for
82 * Use IB core device alloc to allocate space for the rdi which is assumed to be
83 * inside of the ib_device. Any extra space that drivers require should be
86 * We also allocate a port array based on the number of ports.
88 * Return: pointer to allocated rdi
90 struct rvt_dev_info *rvt_alloc_device(size_t size, int nports)
92 struct rvt_dev_info *rdi;
94 rdi = container_of(_ib_alloc_device(size), struct rvt_dev_info, ibdev);
98 rdi->ports = kcalloc(nports, sizeof(*rdi->ports), GFP_KERNEL);
100 ib_dealloc_device(&rdi->ibdev);
104 EXPORT_SYMBOL(rvt_alloc_device);
107 * rvt_dealloc_device - deallocate rdi
108 * @rdi: structure to free
110 * Free a structure allocated with rvt_alloc_device()
112 void rvt_dealloc_device(struct rvt_dev_info *rdi)
115 ib_dealloc_device(&rdi->ibdev);
117 EXPORT_SYMBOL(rvt_dealloc_device);
119 static int rvt_query_device(struct ib_device *ibdev,
120 struct ib_device_attr *props,
121 struct ib_udata *uhw)
123 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
125 if (uhw->inlen || uhw->outlen)
128 * Return rvt_dev_info.dparms.props contents
130 *props = rdi->dparms.props;
134 static int rvt_modify_device(struct ib_device *device,
135 int device_modify_mask,
136 struct ib_device_modify *device_modify)
139 * There is currently no need to supply this based on qib and hfi1.
140 * Future drivers may need to implement this though.
147 * rvt_query_port: Passes the query port call to the driver
148 * @ibdev: Verbs IB dev
149 * @port_num: port number, 1 based from ib core
150 * @props: structure to hold returned properties
152 * Return: 0 on success
154 static int rvt_query_port(struct ib_device *ibdev, u8 port_num,
155 struct ib_port_attr *props)
157 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
158 struct rvt_ibport *rvp;
159 int port_index = ibport_num_to_idx(ibdev, port_num);
164 rvp = rdi->ports[port_index];
165 /* props being zeroed by the caller, avoid zeroing it here */
166 props->sm_lid = rvp->sm_lid;
167 props->sm_sl = rvp->sm_sl;
168 props->port_cap_flags = rvp->port_cap_flags;
169 props->max_msg_sz = 0x80000000;
170 props->pkey_tbl_len = rvt_get_npkeys(rdi);
171 props->bad_pkey_cntr = rvp->pkey_violations;
172 props->qkey_viol_cntr = rvp->qkey_violations;
173 props->subnet_timeout = rvp->subnet_timeout;
174 props->init_type_reply = 0;
176 /* Populate the remaining ib_port_attr elements */
177 return rdi->driver_f.query_port_state(rdi, port_num, props);
182 * @ibdev: Verbs IB dev
183 * @port_num: Port number, 1 based from ib core
184 * @port_modify_mask: How to change the port
185 * @props: Structure to fill in
187 * Return: 0 on success
189 static int rvt_modify_port(struct ib_device *ibdev, u8 port_num,
190 int port_modify_mask, struct ib_port_modify *props)
192 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
193 struct rvt_ibport *rvp;
195 int port_index = ibport_num_to_idx(ibdev, port_num);
200 rvp = rdi->ports[port_index];
201 if (port_modify_mask & IB_PORT_OPA_MASK_CHG) {
202 rvp->port_cap3_flags |= props->set_port_cap_mask;
203 rvp->port_cap3_flags &= ~props->clr_port_cap_mask;
205 rvp->port_cap_flags |= props->set_port_cap_mask;
206 rvp->port_cap_flags &= ~props->clr_port_cap_mask;
209 if (props->set_port_cap_mask || props->clr_port_cap_mask)
210 rdi->driver_f.cap_mask_chg(rdi, port_num);
211 if (port_modify_mask & IB_PORT_SHUTDOWN)
212 ret = rdi->driver_f.shut_down_port(rdi, port_num);
213 if (port_modify_mask & IB_PORT_RESET_QKEY_CNTR)
214 rvp->qkey_violations = 0;
220 * rvt_query_pkey - Return a pkey from the table at a given index
221 * @ibdev: Verbs IB dev
222 * @port_num: Port number, 1 based from ib core
223 * @index: Index into pkey table
224 * @pkey: returned pkey from the port pkey table
226 * Return: 0 on failure pkey otherwise
228 static int rvt_query_pkey(struct ib_device *ibdev, u8 port_num, u16 index,
232 * Driver will be responsible for keeping rvt_dev_info.pkey_table up to
233 * date. This function will just return that value. There is no need to
234 * lock, if a stale value is read and sent to the user so be it there is
235 * no way to protect against that anyway.
237 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
240 port_index = ibport_num_to_idx(ibdev, port_num);
244 if (index >= rvt_get_npkeys(rdi))
247 *pkey = rvt_get_pkey(rdi, port_index, index);
252 * rvt_query_gid - Return a gid from the table
253 * @ibdev: Verbs IB dev
254 * @port_num: Port number, 1 based from ib core
255 * @guid_index: Index in table
256 * @gid: Gid to return
258 * Return: 0 on success
260 static int rvt_query_gid(struct ib_device *ibdev, u8 port_num,
261 int guid_index, union ib_gid *gid)
263 struct rvt_dev_info *rdi;
264 struct rvt_ibport *rvp;
268 * Driver is responsible for updating the guid table. Which will be used
269 * to craft the return value. This will work similar to how query_pkey()
272 port_index = ibport_num_to_idx(ibdev, port_num);
276 rdi = ib_to_rvt(ibdev);
277 rvp = rdi->ports[port_index];
279 gid->global.subnet_prefix = rvp->gid_prefix;
281 return rdi->driver_f.get_guid_be(rdi, rvp, guid_index,
282 &gid->global.interface_id);
286 * rvt_alloc_ucontext - Allocate a user context
287 * @uctx: Verbs context
288 * @udata: User data allocated
290 static int rvt_alloc_ucontext(struct ib_ucontext *uctx, struct ib_udata *udata)
296 * rvt_dealloc_ucontext - Free a user context
297 * @context - Free this
299 static void rvt_dealloc_ucontext(struct ib_ucontext *context)
304 static int rvt_get_port_immutable(struct ib_device *ibdev, u8 port_num,
305 struct ib_port_immutable *immutable)
307 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
308 struct ib_port_attr attr;
311 port_index = ibport_num_to_idx(ibdev, port_num);
315 immutable->core_cap_flags = rdi->dparms.core_cap_flags;
317 err = ib_query_port(ibdev, port_num, &attr);
321 immutable->pkey_tbl_len = attr.pkey_tbl_len;
322 immutable->gid_tbl_len = attr.gid_tbl_len;
323 immutable->max_mad_size = rdi->dparms.max_mad_size;
373 _VERB_IDX_MAX /* Must always be last! */
376 static const struct ib_device_ops rvt_dev_ops = {
377 .uverbs_abi_ver = RVT_UVERBS_ABI_VERSION,
379 .alloc_mr = rvt_alloc_mr,
380 .alloc_pd = rvt_alloc_pd,
381 .alloc_ucontext = rvt_alloc_ucontext,
382 .attach_mcast = rvt_attach_mcast,
383 .create_ah = rvt_create_ah,
384 .create_cq = rvt_create_cq,
385 .create_qp = rvt_create_qp,
386 .create_srq = rvt_create_srq,
387 .dealloc_pd = rvt_dealloc_pd,
388 .dealloc_ucontext = rvt_dealloc_ucontext,
389 .dereg_mr = rvt_dereg_mr,
390 .destroy_ah = rvt_destroy_ah,
391 .destroy_cq = rvt_destroy_cq,
392 .destroy_qp = rvt_destroy_qp,
393 .destroy_srq = rvt_destroy_srq,
394 .detach_mcast = rvt_detach_mcast,
395 .get_dma_mr = rvt_get_dma_mr,
396 .get_port_immutable = rvt_get_port_immutable,
397 .map_mr_sg = rvt_map_mr_sg,
399 .modify_ah = rvt_modify_ah,
400 .modify_device = rvt_modify_device,
401 .modify_port = rvt_modify_port,
402 .modify_qp = rvt_modify_qp,
403 .modify_srq = rvt_modify_srq,
404 .poll_cq = rvt_poll_cq,
405 .post_recv = rvt_post_recv,
406 .post_send = rvt_post_send,
407 .post_srq_recv = rvt_post_srq_recv,
408 .query_ah = rvt_query_ah,
409 .query_device = rvt_query_device,
410 .query_gid = rvt_query_gid,
411 .query_pkey = rvt_query_pkey,
412 .query_port = rvt_query_port,
413 .query_qp = rvt_query_qp,
414 .query_srq = rvt_query_srq,
415 .reg_user_mr = rvt_reg_user_mr,
416 .req_notify_cq = rvt_req_notify_cq,
417 .resize_cq = rvt_resize_cq,
419 INIT_RDMA_OBJ_SIZE(ib_ah, rvt_ah, ibah),
420 INIT_RDMA_OBJ_SIZE(ib_cq, rvt_cq, ibcq),
421 INIT_RDMA_OBJ_SIZE(ib_pd, rvt_pd, ibpd),
422 INIT_RDMA_OBJ_SIZE(ib_srq, rvt_srq, ibsrq),
423 INIT_RDMA_OBJ_SIZE(ib_ucontext, rvt_ucontext, ibucontext),
426 static noinline int check_support(struct rvt_dev_info *rdi, int verb)
431 * These functions are not part of verbs specifically but are
432 * required for rdmavt to function.
434 if ((!rdi->ibdev.ops.init_port) ||
435 (!rdi->driver_f.get_pci_dev))
441 * rdmavt does not support modify device currently drivers must
444 if (!rdi->ibdev.ops.modify_device)
449 if (!rdi->ibdev.ops.query_port)
450 if (!rdi->driver_f.query_port_state)
455 if (!rdi->ibdev.ops.modify_port)
456 if (!rdi->driver_f.cap_mask_chg ||
457 !rdi->driver_f.shut_down_port)
462 if (!rdi->ibdev.ops.query_gid)
463 if (!rdi->driver_f.get_guid_be)
468 if (!rdi->ibdev.ops.create_qp)
469 if (!rdi->driver_f.qp_priv_alloc ||
470 !rdi->driver_f.qp_priv_free ||
471 !rdi->driver_f.notify_qp_reset ||
472 !rdi->driver_f.flush_qp_waiters ||
473 !rdi->driver_f.stop_send_queue ||
474 !rdi->driver_f.quiesce_qp)
479 if (!rdi->ibdev.ops.modify_qp)
480 if (!rdi->driver_f.notify_qp_reset ||
481 !rdi->driver_f.schedule_send ||
482 !rdi->driver_f.get_pmtu_from_attr ||
483 !rdi->driver_f.flush_qp_waiters ||
484 !rdi->driver_f.stop_send_queue ||
485 !rdi->driver_f.quiesce_qp ||
486 !rdi->driver_f.notify_error_qp ||
487 !rdi->driver_f.mtu_from_qp ||
488 !rdi->driver_f.mtu_to_path_mtu)
493 if (!rdi->ibdev.ops.destroy_qp)
494 if (!rdi->driver_f.qp_priv_free ||
495 !rdi->driver_f.notify_qp_reset ||
496 !rdi->driver_f.flush_qp_waiters ||
497 !rdi->driver_f.stop_send_queue ||
498 !rdi->driver_f.quiesce_qp)
503 if (!rdi->ibdev.ops.post_send)
504 if (!rdi->driver_f.schedule_send ||
505 !rdi->driver_f.do_send ||
516 * rvt_register_device - register a driver
517 * @rdi: main dev structure for all of rdmavt operations
519 * It is up to drivers to allocate the rdi and fill in the appropriate
522 * Return: 0 on success otherwise an errno.
524 int rvt_register_device(struct rvt_dev_info *rdi)
532 * Check to ensure drivers have setup the required helpers for the verbs
533 * they want rdmavt to handle
535 for (i = 0; i < _VERB_IDX_MAX; i++)
536 if (check_support(rdi, i)) {
537 pr_err("Driver support req not met at %d\n", i);
541 ib_set_device_ops(&rdi->ibdev, &rvt_dev_ops);
543 /* Once we get past here we can use rvt_pr macros and tracepoints */
544 trace_rvt_dbg(rdi, "Driver attempting registration");
548 ret = rvt_driver_qp_init(rdi);
550 pr_err("Error in driver QP init.\n");
555 spin_lock_init(&rdi->n_ahs_lock);
556 rdi->n_ahs_allocated = 0;
558 /* Shared Receive Queue */
559 rvt_driver_srq_init(rdi);
562 rvt_driver_mcast_init(rdi);
565 ret = rvt_driver_mr_init(rdi);
567 pr_err("Error in driver MR init.\n");
571 /* Memory Working Set Size */
572 ret = rvt_wss_init(rdi);
574 rvt_pr_err(rdi, "Error in WSS init.\n");
578 /* Completion queues */
579 spin_lock_init(&rdi->n_cqs_lock);
582 rdi->ibdev.dev.dma_ops = rdi->ibdev.dev.dma_ops ? : &dma_virt_ops;
584 /* Protection Domain */
585 spin_lock_init(&rdi->n_pds_lock);
586 rdi->n_pds_allocated = 0;
589 * There are some things which could be set by underlying drivers but
590 * really should be up to rdmavt to set. For instance drivers can't know
591 * exactly which functions rdmavt supports, nor do they know the ABI
592 * version, so we do all of this sort of stuff here.
594 rdi->ibdev.uverbs_cmd_mask =
595 (1ull << IB_USER_VERBS_CMD_GET_CONTEXT) |
596 (1ull << IB_USER_VERBS_CMD_QUERY_DEVICE) |
597 (1ull << IB_USER_VERBS_CMD_QUERY_PORT) |
598 (1ull << IB_USER_VERBS_CMD_ALLOC_PD) |
599 (1ull << IB_USER_VERBS_CMD_DEALLOC_PD) |
600 (1ull << IB_USER_VERBS_CMD_CREATE_AH) |
601 (1ull << IB_USER_VERBS_CMD_MODIFY_AH) |
602 (1ull << IB_USER_VERBS_CMD_QUERY_AH) |
603 (1ull << IB_USER_VERBS_CMD_DESTROY_AH) |
604 (1ull << IB_USER_VERBS_CMD_REG_MR) |
605 (1ull << IB_USER_VERBS_CMD_DEREG_MR) |
606 (1ull << IB_USER_VERBS_CMD_CREATE_COMP_CHANNEL) |
607 (1ull << IB_USER_VERBS_CMD_CREATE_CQ) |
608 (1ull << IB_USER_VERBS_CMD_RESIZE_CQ) |
609 (1ull << IB_USER_VERBS_CMD_DESTROY_CQ) |
610 (1ull << IB_USER_VERBS_CMD_POLL_CQ) |
611 (1ull << IB_USER_VERBS_CMD_REQ_NOTIFY_CQ) |
612 (1ull << IB_USER_VERBS_CMD_CREATE_QP) |
613 (1ull << IB_USER_VERBS_CMD_QUERY_QP) |
614 (1ull << IB_USER_VERBS_CMD_MODIFY_QP) |
615 (1ull << IB_USER_VERBS_CMD_DESTROY_QP) |
616 (1ull << IB_USER_VERBS_CMD_POST_SEND) |
617 (1ull << IB_USER_VERBS_CMD_POST_RECV) |
618 (1ull << IB_USER_VERBS_CMD_ATTACH_MCAST) |
619 (1ull << IB_USER_VERBS_CMD_DETACH_MCAST) |
620 (1ull << IB_USER_VERBS_CMD_CREATE_SRQ) |
621 (1ull << IB_USER_VERBS_CMD_MODIFY_SRQ) |
622 (1ull << IB_USER_VERBS_CMD_QUERY_SRQ) |
623 (1ull << IB_USER_VERBS_CMD_DESTROY_SRQ) |
624 (1ull << IB_USER_VERBS_CMD_POST_SRQ_RECV);
625 rdi->ibdev.node_type = RDMA_NODE_IB_CA;
626 if (!rdi->ibdev.num_comp_vectors)
627 rdi->ibdev.num_comp_vectors = 1;
629 /* We are now good to announce we exist */
630 ret = ib_register_device(&rdi->ibdev, dev_name(&rdi->ibdev.dev));
632 rvt_pr_err(rdi, "Failed to register driver with ib core.\n");
636 rvt_create_mad_agents(rdi);
638 rvt_pr_info(rdi, "Registration with rdmavt done.\n");
651 EXPORT_SYMBOL(rvt_register_device);
654 * rvt_unregister_device - remove a driver
655 * @rdi: rvt dev struct
657 void rvt_unregister_device(struct rvt_dev_info *rdi)
659 trace_rvt_dbg(rdi, "Driver is unregistering.");
663 rvt_free_mad_agents(rdi);
665 ib_unregister_device(&rdi->ibdev);
670 EXPORT_SYMBOL(rvt_unregister_device);
673 * rvt_init_port - init internal data for driver port
674 * @rdi: rvt_dev_info struct
676 * @port_index: 0 based index of ports, different from IB core port num
677 * @pkey_table: pkey_table for @port
679 * Keep track of a list of ports. No need to have a detach port.
680 * They persist until the driver goes away.
684 int rvt_init_port(struct rvt_dev_info *rdi, struct rvt_ibport *port,
685 int port_index, u16 *pkey_table)
688 rdi->ports[port_index] = port;
689 rdi->ports[port_index]->pkey_table = pkey_table;
693 EXPORT_SYMBOL(rvt_init_port);