1 // SPDX-License-Identifier: GPL-2.0
3 * Shared Memory Communications over RDMA (SMC-R) and RoCE
6 * Establish SMC-R as an Infiniband Client to be notified about added and
7 * removed IB devices of type RDMA.
8 * Determine device and port characteristics for these IB devices.
10 * Copyright IBM Corp. 2016
15 #include <linux/random.h>
16 #include <linux/workqueue.h>
17 #include <linux/scatterlist.h>
18 #include <rdma/ib_verbs.h>
26 #define SMC_MAX_CQE 32766 /* max. # of completion queue elements */
28 #define SMC_QP_MIN_RNR_TIMER 5
29 #define SMC_QP_TIMEOUT 15 /* 4096 * 2 ** timeout usec */
30 #define SMC_QP_RETRY_CNT 7 /* 7: infinite */
31 #define SMC_QP_RNR_RETRY 7 /* 7: infinite */
33 struct smc_ib_devices smc_ib_devices = { /* smc-registered ib devices */
34 .lock = __SPIN_LOCK_UNLOCKED(smc_ib_devices.lock),
35 .list = LIST_HEAD_INIT(smc_ib_devices.list),
38 #define SMC_LOCAL_SYSTEMID_RESET "%%%%%%%"
40 u8 local_systemid[SMC_SYSTEMID_LEN] = SMC_LOCAL_SYSTEMID_RESET; /* unique system
44 static int smc_ib_modify_qp_init(struct smc_link *lnk)
46 struct ib_qp_attr qp_attr;
48 memset(&qp_attr, 0, sizeof(qp_attr));
49 qp_attr.qp_state = IB_QPS_INIT;
50 qp_attr.pkey_index = 0;
51 qp_attr.port_num = lnk->ibport;
52 qp_attr.qp_access_flags = IB_ACCESS_LOCAL_WRITE
53 | IB_ACCESS_REMOTE_WRITE;
54 return ib_modify_qp(lnk->roce_qp, &qp_attr,
55 IB_QP_STATE | IB_QP_PKEY_INDEX |
56 IB_QP_ACCESS_FLAGS | IB_QP_PORT);
59 static int smc_ib_modify_qp_rtr(struct smc_link *lnk)
61 enum ib_qp_attr_mask qp_attr_mask =
62 IB_QP_STATE | IB_QP_AV | IB_QP_PATH_MTU | IB_QP_DEST_QPN |
63 IB_QP_RQ_PSN | IB_QP_MAX_DEST_RD_ATOMIC | IB_QP_MIN_RNR_TIMER;
64 struct ib_qp_attr qp_attr;
66 memset(&qp_attr, 0, sizeof(qp_attr));
67 qp_attr.qp_state = IB_QPS_RTR;
68 qp_attr.path_mtu = min(lnk->path_mtu, lnk->peer_mtu);
69 qp_attr.ah_attr.type = RDMA_AH_ATTR_TYPE_ROCE;
70 rdma_ah_set_port_num(&qp_attr.ah_attr, lnk->ibport);
71 rdma_ah_set_grh(&qp_attr.ah_attr, NULL, 0, 0, 1, 0);
72 rdma_ah_set_dgid_raw(&qp_attr.ah_attr, lnk->peer_gid);
73 memcpy(&qp_attr.ah_attr.roce.dmac, lnk->peer_mac,
74 sizeof(lnk->peer_mac));
75 qp_attr.dest_qp_num = lnk->peer_qpn;
76 qp_attr.rq_psn = lnk->peer_psn; /* starting receive packet seq # */
77 qp_attr.max_dest_rd_atomic = 1; /* max # of resources for incoming
80 qp_attr.min_rnr_timer = SMC_QP_MIN_RNR_TIMER;
82 return ib_modify_qp(lnk->roce_qp, &qp_attr, qp_attr_mask);
85 int smc_ib_modify_qp_rts(struct smc_link *lnk)
87 struct ib_qp_attr qp_attr;
89 memset(&qp_attr, 0, sizeof(qp_attr));
90 qp_attr.qp_state = IB_QPS_RTS;
91 qp_attr.timeout = SMC_QP_TIMEOUT; /* local ack timeout */
92 qp_attr.retry_cnt = SMC_QP_RETRY_CNT; /* retry count */
93 qp_attr.rnr_retry = SMC_QP_RNR_RETRY; /* RNR retries, 7=infinite */
94 qp_attr.sq_psn = lnk->psn_initial; /* starting send packet seq # */
95 qp_attr.max_rd_atomic = 1; /* # of outstanding RDMA reads and
98 return ib_modify_qp(lnk->roce_qp, &qp_attr,
99 IB_QP_STATE | IB_QP_TIMEOUT | IB_QP_RETRY_CNT |
100 IB_QP_SQ_PSN | IB_QP_RNR_RETRY |
101 IB_QP_MAX_QP_RD_ATOMIC);
104 int smc_ib_modify_qp_reset(struct smc_link *lnk)
106 struct ib_qp_attr qp_attr;
108 memset(&qp_attr, 0, sizeof(qp_attr));
109 qp_attr.qp_state = IB_QPS_RESET;
110 return ib_modify_qp(lnk->roce_qp, &qp_attr, IB_QP_STATE);
113 int smc_ib_ready_link(struct smc_link *lnk)
115 struct smc_link_group *lgr =
116 container_of(lnk, struct smc_link_group, lnk[0]);
119 rc = smc_ib_modify_qp_init(lnk);
123 rc = smc_ib_modify_qp_rtr(lnk);
126 smc_wr_remember_qp_attr(lnk);
127 rc = ib_req_notify_cq(lnk->smcibdev->roce_cq_recv,
128 IB_CQ_SOLICITED_MASK);
131 rc = smc_wr_rx_post_init(lnk);
134 smc_wr_remember_qp_attr(lnk);
136 if (lgr->role == SMC_SERV) {
137 rc = smc_ib_modify_qp_rts(lnk);
140 smc_wr_remember_qp_attr(lnk);
146 static void smc_ib_port_terminate(struct smc_ib_device *smcibdev, u8 ibport)
148 struct smc_link_group *lgr, *l;
150 list_for_each_entry_safe(lgr, l, &smc_lgr_list.list, list) {
151 if (lgr->lnk[SMC_SINGLE_LINK].smcibdev == smcibdev &&
152 lgr->lnk[SMC_SINGLE_LINK].ibport == ibport)
153 smc_lgr_terminate(lgr);
157 /* process context wrapper for might_sleep smc_ib_remember_port_attr */
158 static void smc_ib_port_event_work(struct work_struct *work)
160 struct smc_ib_device *smcibdev = container_of(
161 work, struct smc_ib_device, port_event_work);
164 for_each_set_bit(port_idx, &smcibdev->port_event_mask, SMC_MAX_PORTS) {
165 smc_ib_remember_port_attr(smcibdev, port_idx + 1);
166 clear_bit(port_idx, &smcibdev->port_event_mask);
167 if (!smc_ib_port_active(smcibdev, port_idx + 1))
168 smc_ib_port_terminate(smcibdev, port_idx + 1);
172 /* can be called in IRQ context */
173 static void smc_ib_global_event_handler(struct ib_event_handler *handler,
174 struct ib_event *ibevent)
176 struct smc_ib_device *smcibdev;
179 smcibdev = container_of(handler, struct smc_ib_device, event_handler);
181 switch (ibevent->event) {
182 case IB_EVENT_PORT_ERR:
183 case IB_EVENT_DEVICE_FATAL:
184 case IB_EVENT_PORT_ACTIVE:
185 port_idx = ibevent->element.port_num - 1;
186 set_bit(port_idx, &smcibdev->port_event_mask);
187 schedule_work(&smcibdev->port_event_work);
194 void smc_ib_dealloc_protection_domain(struct smc_link *lnk)
197 ib_dealloc_pd(lnk->roce_pd);
201 int smc_ib_create_protection_domain(struct smc_link *lnk)
205 lnk->roce_pd = ib_alloc_pd(lnk->smcibdev->ibdev, 0);
206 rc = PTR_ERR_OR_ZERO(lnk->roce_pd);
207 if (IS_ERR(lnk->roce_pd))
212 static void smc_ib_qp_event_handler(struct ib_event *ibevent, void *priv)
214 struct smc_ib_device *smcibdev =
215 (struct smc_ib_device *)ibevent->device;
218 switch (ibevent->event) {
219 case IB_EVENT_DEVICE_FATAL:
220 case IB_EVENT_GID_CHANGE:
221 case IB_EVENT_PORT_ERR:
222 case IB_EVENT_QP_ACCESS_ERR:
223 port_idx = ibevent->element.port_num - 1;
224 set_bit(port_idx, &smcibdev->port_event_mask);
225 schedule_work(&smcibdev->port_event_work);
232 void smc_ib_destroy_queue_pair(struct smc_link *lnk)
235 ib_destroy_qp(lnk->roce_qp);
239 /* create a queue pair within the protection domain for a link */
240 int smc_ib_create_queue_pair(struct smc_link *lnk)
242 struct ib_qp_init_attr qp_attr = {
243 .event_handler = smc_ib_qp_event_handler,
245 .send_cq = lnk->smcibdev->roce_cq_send,
246 .recv_cq = lnk->smcibdev->roce_cq_recv,
249 /* include unsolicited rdma_writes as well,
250 * there are max. 2 RDMA_WRITE per 1 WR_SEND
252 .max_send_wr = SMC_WR_BUF_CNT * 3,
253 .max_recv_wr = SMC_WR_BUF_CNT * 3,
254 .max_send_sge = SMC_IB_MAX_SEND_SGE,
257 .sq_sig_type = IB_SIGNAL_REQ_WR,
258 .qp_type = IB_QPT_RC,
262 lnk->roce_qp = ib_create_qp(lnk->roce_pd, &qp_attr);
263 rc = PTR_ERR_OR_ZERO(lnk->roce_qp);
264 if (IS_ERR(lnk->roce_qp))
267 smc_wr_remember_qp_attr(lnk);
271 void smc_ib_put_memory_region(struct ib_mr *mr)
276 static int smc_ib_map_mr_sg(struct smc_buf_desc *buf_slot)
278 unsigned int offset = 0;
281 /* map the largest prefix of a dma mapped SG list */
282 sg_num = ib_map_mr_sg(buf_slot->mr_rx[SMC_SINGLE_LINK],
283 buf_slot->sgt[SMC_SINGLE_LINK].sgl,
284 buf_slot->sgt[SMC_SINGLE_LINK].orig_nents,
290 /* Allocate a memory region and map the dma mapped SG list of buf_slot */
291 int smc_ib_get_memory_region(struct ib_pd *pd, int access_flags,
292 struct smc_buf_desc *buf_slot)
294 if (buf_slot->mr_rx[SMC_SINGLE_LINK])
295 return 0; /* already done */
297 buf_slot->mr_rx[SMC_SINGLE_LINK] =
298 ib_alloc_mr(pd, IB_MR_TYPE_MEM_REG, 1 << buf_slot->order);
299 if (IS_ERR(buf_slot->mr_rx[SMC_SINGLE_LINK])) {
302 rc = PTR_ERR(buf_slot->mr_rx[SMC_SINGLE_LINK]);
303 buf_slot->mr_rx[SMC_SINGLE_LINK] = NULL;
307 if (smc_ib_map_mr_sg(buf_slot) != 1)
313 /* synchronize buffer usage for cpu access */
314 void smc_ib_sync_sg_for_cpu(struct smc_ib_device *smcibdev,
315 struct smc_buf_desc *buf_slot,
316 enum dma_data_direction data_direction)
318 struct scatterlist *sg;
321 /* for now there is just one DMA address */
322 for_each_sg(buf_slot->sgt[SMC_SINGLE_LINK].sgl, sg,
323 buf_slot->sgt[SMC_SINGLE_LINK].nents, i) {
326 ib_dma_sync_single_for_cpu(smcibdev->ibdev,
333 /* synchronize buffer usage for device access */
334 void smc_ib_sync_sg_for_device(struct smc_ib_device *smcibdev,
335 struct smc_buf_desc *buf_slot,
336 enum dma_data_direction data_direction)
338 struct scatterlist *sg;
341 /* for now there is just one DMA address */
342 for_each_sg(buf_slot->sgt[SMC_SINGLE_LINK].sgl, sg,
343 buf_slot->sgt[SMC_SINGLE_LINK].nents, i) {
346 ib_dma_sync_single_for_device(smcibdev->ibdev,
353 /* Map a new TX or RX buffer SG-table to DMA */
354 int smc_ib_buf_map_sg(struct smc_ib_device *smcibdev,
355 struct smc_buf_desc *buf_slot,
356 enum dma_data_direction data_direction)
360 mapped_nents = ib_dma_map_sg(smcibdev->ibdev,
361 buf_slot->sgt[SMC_SINGLE_LINK].sgl,
362 buf_slot->sgt[SMC_SINGLE_LINK].orig_nents,
370 void smc_ib_buf_unmap_sg(struct smc_ib_device *smcibdev,
371 struct smc_buf_desc *buf_slot,
372 enum dma_data_direction data_direction)
374 if (!buf_slot->sgt[SMC_SINGLE_LINK].sgl->dma_address)
375 return; /* already unmapped */
377 ib_dma_unmap_sg(smcibdev->ibdev,
378 buf_slot->sgt[SMC_SINGLE_LINK].sgl,
379 buf_slot->sgt[SMC_SINGLE_LINK].orig_nents,
381 buf_slot->sgt[SMC_SINGLE_LINK].sgl->dma_address = 0;
384 static int smc_ib_fill_gid_and_mac(struct smc_ib_device *smcibdev, u8 ibport)
386 struct ib_gid_attr gattr;
389 rc = ib_query_gid(smcibdev->ibdev, ibport, 0,
390 &smcibdev->gid[ibport - 1], &gattr);
391 if (rc || !gattr.ndev)
394 memcpy(smcibdev->mac[ibport - 1], gattr.ndev->dev_addr, ETH_ALEN);
399 /* Create an identifier unique for this instance of SMC-R.
400 * The MAC-address of the first active registered IB device
401 * plus a random 2-byte number is used to create this identifier.
402 * This name is delivered to the peer during connection initialization.
404 static inline void smc_ib_define_local_systemid(struct smc_ib_device *smcibdev,
407 memcpy(&local_systemid[2], &smcibdev->mac[ibport - 1],
408 sizeof(smcibdev->mac[ibport - 1]));
409 get_random_bytes(&local_systemid[0], 2);
412 bool smc_ib_port_active(struct smc_ib_device *smcibdev, u8 ibport)
414 return smcibdev->pattr[ibport - 1].state == IB_PORT_ACTIVE;
417 int smc_ib_remember_port_attr(struct smc_ib_device *smcibdev, u8 ibport)
421 memset(&smcibdev->pattr[ibport - 1], 0,
422 sizeof(smcibdev->pattr[ibport - 1]));
423 rc = ib_query_port(smcibdev->ibdev, ibport,
424 &smcibdev->pattr[ibport - 1]);
427 /* the SMC protocol requires specification of the RoCE MAC address */
428 rc = smc_ib_fill_gid_and_mac(smcibdev, ibport);
431 if (!strncmp(local_systemid, SMC_LOCAL_SYSTEMID_RESET,
432 sizeof(local_systemid)) &&
433 smc_ib_port_active(smcibdev, ibport))
434 /* create unique system identifier */
435 smc_ib_define_local_systemid(smcibdev, ibport);
440 long smc_ib_setup_per_ibdev(struct smc_ib_device *smcibdev)
442 struct ib_cq_init_attr cqattr = {
443 .cqe = SMC_MAX_CQE, .comp_vector = 0 };
444 int cqe_size_order, smc_order;
447 /* the calculated number of cq entries fits to mlx5 cq allocation */
448 cqe_size_order = cache_line_size() == 128 ? 7 : 6;
449 smc_order = MAX_ORDER - cqe_size_order - 1;
450 if (SMC_MAX_CQE + 2 > (0x00000001 << smc_order) * PAGE_SIZE)
451 cqattr.cqe = (0x00000001 << smc_order) * PAGE_SIZE - 2;
452 smcibdev->roce_cq_send = ib_create_cq(smcibdev->ibdev,
453 smc_wr_tx_cq_handler, NULL,
455 rc = PTR_ERR_OR_ZERO(smcibdev->roce_cq_send);
456 if (IS_ERR(smcibdev->roce_cq_send)) {
457 smcibdev->roce_cq_send = NULL;
460 smcibdev->roce_cq_recv = ib_create_cq(smcibdev->ibdev,
461 smc_wr_rx_cq_handler, NULL,
463 rc = PTR_ERR_OR_ZERO(smcibdev->roce_cq_recv);
464 if (IS_ERR(smcibdev->roce_cq_recv)) {
465 smcibdev->roce_cq_recv = NULL;
468 INIT_IB_EVENT_HANDLER(&smcibdev->event_handler, smcibdev->ibdev,
469 smc_ib_global_event_handler);
470 ib_register_event_handler(&smcibdev->event_handler);
471 smc_wr_add_dev(smcibdev);
472 smcibdev->initialized = 1;
476 ib_destroy_cq(smcibdev->roce_cq_send);
480 static void smc_ib_cleanup_per_ibdev(struct smc_ib_device *smcibdev)
482 if (!smcibdev->initialized)
484 smcibdev->initialized = 0;
485 smc_wr_remove_dev(smcibdev);
486 ib_unregister_event_handler(&smcibdev->event_handler);
487 ib_destroy_cq(smcibdev->roce_cq_recv);
488 ib_destroy_cq(smcibdev->roce_cq_send);
491 static struct ib_client smc_ib_client;
493 /* callback function for ib_register_client() */
494 static void smc_ib_add_dev(struct ib_device *ibdev)
496 struct smc_ib_device *smcibdev;
498 if (ibdev->node_type != RDMA_NODE_IB_CA)
501 smcibdev = kzalloc(sizeof(*smcibdev), GFP_KERNEL);
505 smcibdev->ibdev = ibdev;
506 INIT_WORK(&smcibdev->port_event_work, smc_ib_port_event_work);
508 spin_lock(&smc_ib_devices.lock);
509 list_add_tail(&smcibdev->list, &smc_ib_devices.list);
510 spin_unlock(&smc_ib_devices.lock);
511 ib_set_client_data(ibdev, &smc_ib_client, smcibdev);
514 /* callback function for ib_register_client() */
515 static void smc_ib_remove_dev(struct ib_device *ibdev, void *client_data)
517 struct smc_ib_device *smcibdev;
519 smcibdev = ib_get_client_data(ibdev, &smc_ib_client);
520 ib_set_client_data(ibdev, &smc_ib_client, NULL);
521 spin_lock(&smc_ib_devices.lock);
522 list_del_init(&smcibdev->list); /* remove from smc_ib_devices */
523 spin_unlock(&smc_ib_devices.lock);
524 smc_pnet_remove_by_ibdev(smcibdev);
525 smc_ib_cleanup_per_ibdev(smcibdev);
529 static struct ib_client smc_ib_client = {
531 .add = smc_ib_add_dev,
532 .remove = smc_ib_remove_dev,
535 int __init smc_ib_register_client(void)
537 return ib_register_client(&smc_ib_client);
540 void smc_ib_unregister_client(void)
542 ib_unregister_client(&smc_ib_client);