1 // SPDX-License-Identifier: GPL-2.0
3 * Shared Memory Communications over RDMA (SMC-R) and RoCE
5 * Basic Transport Functions exploiting Infiniband API
7 * Copyright IBM Corp. 2016
9 * Author(s): Ursula Braun <ubraun@linux.vnet.ibm.com>
12 #include <linux/socket.h>
13 #include <linux/if_vlan.h>
14 #include <linux/random.h>
15 #include <linux/workqueue.h>
16 #include <linux/wait.h>
17 #include <linux/reboot.h>
20 #include <rdma/ib_verbs.h>
21 #include <rdma/ib_cache.h>
30 #include "smc_close.h"
33 #define SMC_LGR_NUM_INCR 256
34 #define SMC_LGR_FREE_DELAY_SERV (600 * HZ)
35 #define SMC_LGR_FREE_DELAY_CLNT (SMC_LGR_FREE_DELAY_SERV + 10 * HZ)
36 #define SMC_LGR_FREE_DELAY_FAST (8 * HZ)
38 static struct smc_lgr_list smc_lgr_list = { /* established link groups */
39 .lock = __SPIN_LOCK_UNLOCKED(smc_lgr_list.lock),
40 .list = LIST_HEAD_INIT(smc_lgr_list.list),
44 static atomic_t lgr_cnt = ATOMIC_INIT(0); /* number of existing link groups */
45 static DECLARE_WAIT_QUEUE_HEAD(lgrs_deleted);
47 static void smc_buf_free(struct smc_link_group *lgr, bool is_rmb,
48 struct smc_buf_desc *buf_desc);
49 static void __smc_lgr_terminate(struct smc_link_group *lgr, bool soft);
51 /* return head of link group list and its lock for a given link group */
52 static inline struct list_head *smc_lgr_list_head(struct smc_link_group *lgr,
53 spinlock_t **lgr_lock)
56 *lgr_lock = &lgr->smcd->lgr_lock;
57 return &lgr->smcd->lgr_list;
60 *lgr_lock = &smc_lgr_list.lock;
61 return &smc_lgr_list.list;
64 static void smc_lgr_schedule_free_work(struct smc_link_group *lgr)
66 /* client link group creation always follows the server link group
67 * creation. For client use a somewhat higher removal delay time,
68 * otherwise there is a risk of out-of-sync link groups.
70 if (!lgr->freeing && !lgr->freefast) {
71 mod_delayed_work(system_wq, &lgr->free_work,
72 (!lgr->is_smcd && lgr->role == SMC_CLNT) ?
73 SMC_LGR_FREE_DELAY_CLNT :
74 SMC_LGR_FREE_DELAY_SERV);
78 void smc_lgr_schedule_free_work_fast(struct smc_link_group *lgr)
80 if (!lgr->freeing && !lgr->freefast) {
82 mod_delayed_work(system_wq, &lgr->free_work,
83 SMC_LGR_FREE_DELAY_FAST);
87 /* Register connection's alert token in our lookup structure.
88 * To use rbtrees we have to implement our own insert core.
89 * Requires @conns_lock
90 * @smc connection to register
91 * Returns 0 on success, != otherwise.
93 static void smc_lgr_add_alert_token(struct smc_connection *conn)
95 struct rb_node **link, *parent = NULL;
96 u32 token = conn->alert_token_local;
98 link = &conn->lgr->conns_all.rb_node;
100 struct smc_connection *cur = rb_entry(*link,
101 struct smc_connection, alert_node);
104 if (cur->alert_token_local > token)
105 link = &parent->rb_left;
107 link = &parent->rb_right;
109 /* Put the new node there */
110 rb_link_node(&conn->alert_node, parent, link);
111 rb_insert_color(&conn->alert_node, &conn->lgr->conns_all);
114 /* Register connection in link group by assigning an alert token
115 * registered in a search tree.
116 * Requires @conns_lock
117 * Note that '0' is a reserved value and not assigned.
119 static int smc_lgr_register_conn(struct smc_connection *conn)
121 struct smc_sock *smc = container_of(conn, struct smc_sock, conn);
122 static atomic_t nexttoken = ATOMIC_INIT(0);
124 /* find a new alert_token_local value not yet used by some connection
127 sock_hold(&smc->sk); /* sock_put in smc_lgr_unregister_conn() */
128 while (!conn->alert_token_local) {
129 conn->alert_token_local = atomic_inc_return(&nexttoken);
130 if (smc_lgr_find_conn(conn->alert_token_local, conn->lgr))
131 conn->alert_token_local = 0;
133 smc_lgr_add_alert_token(conn);
135 /* assign the new connection to a link */
136 if (!conn->lgr->is_smcd) {
137 struct smc_link *lnk;
140 /* tbd - link balancing */
141 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
142 lnk = &conn->lgr->lnk[i];
143 if (lnk->state == SMC_LNK_ACTIVATING ||
144 lnk->state == SMC_LNK_ACTIVE)
148 return SMC_CLC_DECL_NOACTLINK;
150 conn->lgr->conns_num++;
154 /* Unregister connection and reset the alert token of the given connection<
156 static void __smc_lgr_unregister_conn(struct smc_connection *conn)
158 struct smc_sock *smc = container_of(conn, struct smc_sock, conn);
159 struct smc_link_group *lgr = conn->lgr;
161 rb_erase(&conn->alert_node, &lgr->conns_all);
163 conn->alert_token_local = 0;
164 sock_put(&smc->sk); /* sock_hold in smc_lgr_register_conn() */
167 /* Unregister connection from lgr
169 static void smc_lgr_unregister_conn(struct smc_connection *conn)
171 struct smc_link_group *lgr = conn->lgr;
175 write_lock_bh(&lgr->conns_lock);
176 if (conn->alert_token_local) {
177 __smc_lgr_unregister_conn(conn);
179 write_unlock_bh(&lgr->conns_lock);
183 void smc_lgr_cleanup_early(struct smc_connection *conn)
185 struct smc_link_group *lgr = conn->lgr;
192 smc_lgr_schedule_free_work_fast(lgr);
195 /* Send delete link, either as client to request the initiation
196 * of the DELETE LINK sequence from server; or as server to
197 * initiate the delete processing. See smc_llc_rx_delete_link().
199 static int smcr_link_send_delete(struct smc_link *lnk, bool orderly)
201 if (lnk->state == SMC_LNK_ACTIVE &&
202 !smc_llc_send_delete_link(lnk, SMC_LLC_REQ, orderly)) {
203 smc_llc_link_deleting(lnk);
209 static void smc_lgr_free(struct smc_link_group *lgr);
211 static void smc_lgr_free_work(struct work_struct *work)
213 struct smc_link_group *lgr = container_of(to_delayed_work(work),
214 struct smc_link_group,
216 spinlock_t *lgr_lock;
220 smc_lgr_list_head(lgr, &lgr_lock);
221 spin_lock_bh(lgr_lock);
223 spin_unlock_bh(lgr_lock);
226 read_lock_bh(&lgr->conns_lock);
227 conns = RB_EMPTY_ROOT(&lgr->conns_all);
228 read_unlock_bh(&lgr->conns_lock);
229 if (!conns) { /* number of lgr connections is no longer zero */
230 spin_unlock_bh(lgr_lock);
233 list_del_init(&lgr->list); /* remove from smc_lgr_list */
235 if (!lgr->is_smcd && !lgr->terminating) {
236 bool do_wait = false;
238 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
239 struct smc_link *lnk = &lgr->lnk[i];
240 /* try to send del link msg, on err free immediately */
241 if (lnk->state == SMC_LNK_ACTIVE &&
242 !smcr_link_send_delete(lnk, true)) {
243 /* reschedule in case we never receive a resp */
244 smc_lgr_schedule_free_work(lgr);
249 spin_unlock_bh(lgr_lock);
250 return; /* wait for resp, see smc_llc_rx_delete_link */
253 lgr->freeing = 1; /* this instance does the freeing, no new schedule */
254 spin_unlock_bh(lgr_lock);
255 cancel_delayed_work(&lgr->free_work);
257 if (lgr->is_smcd && !lgr->terminating)
258 smc_ism_signal_shutdown(lgr);
260 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
261 struct smc_link *lnk = &lgr->lnk[i];
263 if (smc_link_usable(lnk))
264 lnk->state = SMC_LNK_INACTIVE;
270 static void smc_lgr_terminate_work(struct work_struct *work)
272 struct smc_link_group *lgr = container_of(work, struct smc_link_group,
275 __smc_lgr_terminate(lgr, true);
278 /* return next unique link id for the lgr */
279 static u8 smcr_next_link_id(struct smc_link_group *lgr)
285 link_id = ++lgr->next_link_id;
286 if (!link_id) /* skip zero as link_id */
287 link_id = ++lgr->next_link_id;
288 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
289 if (smc_link_usable(&lgr->lnk[i]) &&
290 lgr->lnk[i].link_id == link_id)
298 static int smcr_link_init(struct smc_link_group *lgr, struct smc_link *lnk,
299 u8 link_idx, struct smc_init_info *ini)
304 get_device(&ini->ib_dev->ibdev->dev);
305 atomic_inc(&ini->ib_dev->lnk_cnt);
306 lnk->state = SMC_LNK_ACTIVATING;
307 lnk->link_id = smcr_next_link_id(lgr);
309 lnk->link_idx = link_idx;
310 lnk->smcibdev = ini->ib_dev;
311 lnk->ibport = ini->ib_port;
312 lnk->path_mtu = ini->ib_dev->pattr[ini->ib_port - 1].active_mtu;
313 if (!ini->ib_dev->initialized) {
314 rc = (int)smc_ib_setup_per_ibdev(ini->ib_dev);
318 get_random_bytes(rndvec, sizeof(rndvec));
319 lnk->psn_initial = rndvec[0] + (rndvec[1] << 8) +
321 rc = smc_ib_determine_gid(lnk->smcibdev, lnk->ibport,
322 ini->vlan_id, lnk->gid, &lnk->sgid_index);
325 rc = smc_llc_link_init(lnk);
328 rc = smc_wr_alloc_link_mem(lnk);
331 rc = smc_ib_create_protection_domain(lnk);
334 rc = smc_ib_create_queue_pair(lnk);
337 rc = smc_wr_create_link(lnk);
343 smc_ib_destroy_queue_pair(lnk);
345 smc_ib_dealloc_protection_domain(lnk);
347 smc_wr_free_link_mem(lnk);
349 smc_llc_link_clear(lnk);
351 put_device(&ini->ib_dev->ibdev->dev);
352 memset(lnk, 0, sizeof(struct smc_link));
353 lnk->state = SMC_LNK_UNUSED;
354 if (!atomic_dec_return(&ini->ib_dev->lnk_cnt))
355 wake_up(&ini->ib_dev->lnks_deleted);
359 /* create a new SMC link group */
360 static int smc_lgr_create(struct smc_sock *smc, struct smc_init_info *ini)
362 struct smc_link_group *lgr;
363 struct list_head *lgr_list;
364 struct smc_link *lnk;
365 spinlock_t *lgr_lock;
370 if (ini->is_smcd && ini->vlan_id) {
371 if (smc_ism_get_vlan(ini->ism_dev, ini->vlan_id)) {
372 rc = SMC_CLC_DECL_ISMVLANERR;
377 lgr = kzalloc(sizeof(*lgr), GFP_KERNEL);
379 rc = SMC_CLC_DECL_MEM;
382 lgr->is_smcd = ini->is_smcd;
384 lgr->terminating = 0;
387 lgr->vlan_id = ini->vlan_id;
388 mutex_init(&lgr->sndbufs_lock);
389 mutex_init(&lgr->rmbs_lock);
390 rwlock_init(&lgr->conns_lock);
391 for (i = 0; i < SMC_RMBE_SIZES; i++) {
392 INIT_LIST_HEAD(&lgr->sndbufs[i]);
393 INIT_LIST_HEAD(&lgr->rmbs[i]);
395 lgr->next_link_id = 0;
396 smc_lgr_list.num += SMC_LGR_NUM_INCR;
397 memcpy(&lgr->id, (u8 *)&smc_lgr_list.num, SMC_LGR_ID_SIZE);
398 INIT_DELAYED_WORK(&lgr->free_work, smc_lgr_free_work);
399 INIT_WORK(&lgr->terminate_work, smc_lgr_terminate_work);
400 lgr->conns_all = RB_ROOT;
402 /* SMC-D specific settings */
403 get_device(&ini->ism_dev->dev);
404 lgr->peer_gid = ini->ism_gid;
405 lgr->smcd = ini->ism_dev;
406 lgr_list = &ini->ism_dev->lgr_list;
407 lgr_lock = &lgr->smcd->lgr_lock;
408 lgr->peer_shutdown = 0;
409 atomic_inc(&ini->ism_dev->lgr_cnt);
411 /* SMC-R specific settings */
412 lgr->role = smc->listen_smc ? SMC_SERV : SMC_CLNT;
413 memcpy(lgr->peer_systemid, ini->ib_lcl->id_for_peer,
415 smc_llc_lgr_init(lgr, smc);
417 link_idx = SMC_SINGLE_LINK;
418 lnk = &lgr->lnk[link_idx];
419 rc = smcr_link_init(lgr, lnk, link_idx, ini);
422 lgr_list = &smc_lgr_list.list;
423 lgr_lock = &smc_lgr_list.lock;
424 atomic_inc(&lgr_cnt);
427 spin_lock_bh(lgr_lock);
428 list_add(&lgr->list, lgr_list);
429 spin_unlock_bh(lgr_lock);
435 if (ini->is_smcd && ini->vlan_id)
436 smc_ism_put_vlan(ini->ism_dev, ini->vlan_id);
440 rc = SMC_CLC_DECL_MEM;
442 rc = SMC_CLC_DECL_INTERR;
447 static void smcr_buf_unuse(struct smc_buf_desc *rmb_desc,
448 struct smc_link *lnk)
450 struct smc_link_group *lgr = lnk->lgr;
452 if (rmb_desc->is_conf_rkey && !list_empty(&lgr->list)) {
453 /* unregister rmb with peer */
454 smc_llc_do_delete_rkey(lnk, rmb_desc);
455 rmb_desc->is_conf_rkey = false;
457 if (rmb_desc->is_reg_err) {
458 /* buf registration failed, reuse not possible */
459 mutex_lock(&lgr->rmbs_lock);
460 list_del(&rmb_desc->list);
461 mutex_unlock(&lgr->rmbs_lock);
463 smc_buf_free(lgr, true, rmb_desc);
469 static void smc_buf_unuse(struct smc_connection *conn,
470 struct smc_link_group *lgr)
472 if (conn->sndbuf_desc)
473 conn->sndbuf_desc->used = 0;
474 if (conn->rmb_desc && lgr->is_smcd)
475 conn->rmb_desc->used = 0;
476 else if (conn->rmb_desc)
477 smcr_buf_unuse(conn->rmb_desc, conn->lnk);
480 /* remove a finished connection from its link group */
481 void smc_conn_free(struct smc_connection *conn)
483 struct smc_link_group *lgr = conn->lgr;
488 if (!list_empty(&lgr->list))
489 smc_ism_unset_conn(conn);
490 tasklet_kill(&conn->rx_tsklet);
492 smc_cdc_tx_dismiss_slots(conn);
494 if (!list_empty(&lgr->list)) {
495 smc_lgr_unregister_conn(conn);
496 smc_buf_unuse(conn, lgr); /* allow buffer reuse */
500 smc_lgr_schedule_free_work(lgr);
503 static void smcr_link_clear(struct smc_link *lnk)
505 struct smc_ib_device *smcibdev;
507 if (lnk->peer_qpn == 0)
510 smc_llc_link_clear(lnk);
511 smc_ib_modify_qp_reset(lnk);
512 smc_wr_free_link(lnk);
513 smc_ib_destroy_queue_pair(lnk);
514 smc_ib_dealloc_protection_domain(lnk);
515 smc_wr_free_link_mem(lnk);
516 put_device(&lnk->smcibdev->ibdev->dev);
517 smcibdev = lnk->smcibdev;
518 memset(lnk, 0, sizeof(struct smc_link));
519 lnk->state = SMC_LNK_UNUSED;
520 if (!atomic_dec_return(&smcibdev->lnk_cnt))
521 wake_up(&smcibdev->lnks_deleted);
524 static void smcr_buf_free(struct smc_link_group *lgr, bool is_rmb,
525 struct smc_buf_desc *buf_desc)
527 struct smc_link *lnk;
530 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
532 if (!buf_desc->is_map_ib[lnk->link_idx])
535 if (buf_desc->mr_rx[lnk->link_idx])
536 smc_ib_put_memory_region(
537 buf_desc->mr_rx[lnk->link_idx]);
538 smc_ib_buf_unmap_sg(lnk, buf_desc, DMA_FROM_DEVICE);
540 smc_ib_buf_unmap_sg(lnk, buf_desc, DMA_TO_DEVICE);
542 sg_free_table(&buf_desc->sgt[lnk->link_idx]);
546 __free_pages(buf_desc->pages, buf_desc->order);
550 static void smcd_buf_free(struct smc_link_group *lgr, bool is_dmb,
551 struct smc_buf_desc *buf_desc)
554 /* restore original buf len */
555 buf_desc->len += sizeof(struct smcd_cdc_msg);
556 smc_ism_unregister_dmb(lgr->smcd, buf_desc);
558 kfree(buf_desc->cpu_addr);
563 static void smc_buf_free(struct smc_link_group *lgr, bool is_rmb,
564 struct smc_buf_desc *buf_desc)
567 smcd_buf_free(lgr, is_rmb, buf_desc);
569 smcr_buf_free(lgr, is_rmb, buf_desc);
572 static void __smc_lgr_free_bufs(struct smc_link_group *lgr, bool is_rmb)
574 struct smc_buf_desc *buf_desc, *bf_desc;
575 struct list_head *buf_list;
578 for (i = 0; i < SMC_RMBE_SIZES; i++) {
580 buf_list = &lgr->rmbs[i];
582 buf_list = &lgr->sndbufs[i];
583 list_for_each_entry_safe(buf_desc, bf_desc, buf_list,
585 list_del(&buf_desc->list);
586 smc_buf_free(lgr, is_rmb, buf_desc);
591 static void smc_lgr_free_bufs(struct smc_link_group *lgr)
593 /* free send buffers */
594 __smc_lgr_free_bufs(lgr, false);
596 __smc_lgr_free_bufs(lgr, true);
599 /* remove a link group */
600 static void smc_lgr_free(struct smc_link_group *lgr)
604 smc_lgr_free_bufs(lgr);
606 if (!lgr->terminating) {
607 smc_ism_put_vlan(lgr->smcd, lgr->vlan_id);
608 put_device(&lgr->smcd->dev);
610 if (!atomic_dec_return(&lgr->smcd->lgr_cnt))
611 wake_up(&lgr->smcd->lgrs_deleted);
613 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
614 if (lgr->lnk[i].state != SMC_LNK_UNUSED)
615 smcr_link_clear(&lgr->lnk[i]);
617 smc_llc_lgr_clear(lgr);
618 if (!atomic_dec_return(&lgr_cnt))
619 wake_up(&lgrs_deleted);
624 void smc_lgr_forget(struct smc_link_group *lgr)
626 struct list_head *lgr_list;
627 spinlock_t *lgr_lock;
629 lgr_list = smc_lgr_list_head(lgr, &lgr_lock);
630 spin_lock_bh(lgr_lock);
631 /* do not use this link group for new connections */
632 if (!list_empty(lgr_list))
633 list_del_init(lgr_list);
634 spin_unlock_bh(lgr_lock);
637 static void smcd_unregister_all_dmbs(struct smc_link_group *lgr)
641 for (i = 0; i < SMC_RMBE_SIZES; i++) {
642 struct smc_buf_desc *buf_desc;
644 list_for_each_entry(buf_desc, &lgr->rmbs[i], list) {
645 buf_desc->len += sizeof(struct smcd_cdc_msg);
646 smc_ism_unregister_dmb(lgr->smcd, buf_desc);
651 static void smc_sk_wake_ups(struct smc_sock *smc)
653 smc->sk.sk_write_space(&smc->sk);
654 smc->sk.sk_data_ready(&smc->sk);
655 smc->sk.sk_state_change(&smc->sk);
658 /* kill a connection */
659 static void smc_conn_kill(struct smc_connection *conn, bool soft)
661 struct smc_sock *smc = container_of(conn, struct smc_sock, conn);
663 if (conn->lgr->is_smcd && conn->lgr->peer_shutdown)
664 conn->local_tx_ctrl.conn_state_flags.peer_conn_abort = 1;
666 smc_close_abort(conn);
668 smc->sk.sk_err = ECONNABORTED;
669 smc_sk_wake_ups(smc);
670 if (conn->lgr->is_smcd) {
671 smc_ism_unset_conn(conn);
673 tasklet_kill(&conn->rx_tsklet);
675 tasklet_unlock_wait(&conn->rx_tsklet);
677 smc_cdc_tx_dismiss_slots(conn);
679 smc_lgr_unregister_conn(conn);
680 smc_close_active_abort(smc);
683 static void smc_lgr_cleanup(struct smc_link_group *lgr)
688 smc_ism_signal_shutdown(lgr);
689 smcd_unregister_all_dmbs(lgr);
690 smc_ism_put_vlan(lgr->smcd, lgr->vlan_id);
691 put_device(&lgr->smcd->dev);
693 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
694 struct smc_link *lnk = &lgr->lnk[i];
696 if (smc_link_usable(lnk))
697 lnk->state = SMC_LNK_INACTIVE;
702 /* terminate link group
703 * @soft: true if link group shutdown can take its time
704 * false if immediate link group shutdown is required
706 static void __smc_lgr_terminate(struct smc_link_group *lgr, bool soft)
708 struct smc_connection *conn;
709 struct smc_sock *smc;
710 struct rb_node *node;
712 if (lgr->terminating)
713 return; /* lgr already terminating */
715 cancel_delayed_work_sync(&lgr->free_work);
716 lgr->terminating = 1;
718 /* kill remaining link group connections */
719 read_lock_bh(&lgr->conns_lock);
720 node = rb_first(&lgr->conns_all);
722 read_unlock_bh(&lgr->conns_lock);
723 conn = rb_entry(node, struct smc_connection, alert_node);
724 smc = container_of(conn, struct smc_sock, conn);
725 sock_hold(&smc->sk); /* sock_put below */
727 smc_conn_kill(conn, soft);
728 release_sock(&smc->sk);
729 sock_put(&smc->sk); /* sock_hold above */
730 read_lock_bh(&lgr->conns_lock);
731 node = rb_first(&lgr->conns_all);
733 read_unlock_bh(&lgr->conns_lock);
734 smc_lgr_cleanup(lgr);
736 smc_lgr_schedule_free_work_fast(lgr);
741 /* unlink link group and schedule termination */
742 void smc_lgr_terminate_sched(struct smc_link_group *lgr)
744 spinlock_t *lgr_lock;
746 smc_lgr_list_head(lgr, &lgr_lock);
747 spin_lock_bh(lgr_lock);
748 if (list_empty(&lgr->list) || lgr->terminating || lgr->freeing) {
749 spin_unlock_bh(lgr_lock);
750 return; /* lgr already terminating */
752 list_del_init(&lgr->list);
753 spin_unlock_bh(lgr_lock);
754 schedule_work(&lgr->terminate_work);
757 /* Called when IB port is terminated */
758 void smc_port_terminate(struct smc_ib_device *smcibdev, u8 ibport)
760 struct smc_link_group *lgr, *l;
761 LIST_HEAD(lgr_free_list);
764 spin_lock_bh(&smc_lgr_list.lock);
765 list_for_each_entry_safe(lgr, l, &smc_lgr_list.list, list) {
768 /* tbd - terminate only when no more links are active */
769 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
770 if (!smc_link_usable(&lgr->lnk[i]) ||
771 lgr->lnk[i].state == SMC_LNK_DELETING)
773 if (lgr->lnk[i].smcibdev == smcibdev &&
774 lgr->lnk[i].ibport == ibport) {
775 list_move(&lgr->list, &lgr_free_list);
780 spin_unlock_bh(&smc_lgr_list.lock);
782 list_for_each_entry_safe(lgr, l, &lgr_free_list, list) {
783 list_del_init(&lgr->list);
784 __smc_lgr_terminate(lgr, false);
788 /* Called when peer lgr shutdown (regularly or abnormally) is received */
789 void smc_smcd_terminate(struct smcd_dev *dev, u64 peer_gid, unsigned short vlan)
791 struct smc_link_group *lgr, *l;
792 LIST_HEAD(lgr_free_list);
794 /* run common cleanup function and build free list */
795 spin_lock_bh(&dev->lgr_lock);
796 list_for_each_entry_safe(lgr, l, &dev->lgr_list, list) {
797 if ((!peer_gid || lgr->peer_gid == peer_gid) &&
798 (vlan == VLAN_VID_MASK || lgr->vlan_id == vlan)) {
799 if (peer_gid) /* peer triggered termination */
800 lgr->peer_shutdown = 1;
801 list_move(&lgr->list, &lgr_free_list);
804 spin_unlock_bh(&dev->lgr_lock);
806 /* cancel the regular free workers and actually free lgrs */
807 list_for_each_entry_safe(lgr, l, &lgr_free_list, list) {
808 list_del_init(&lgr->list);
809 schedule_work(&lgr->terminate_work);
813 /* Called when an SMCD device is removed or the smc module is unloaded */
814 void smc_smcd_terminate_all(struct smcd_dev *smcd)
816 struct smc_link_group *lgr, *lg;
817 LIST_HEAD(lgr_free_list);
819 spin_lock_bh(&smcd->lgr_lock);
820 list_splice_init(&smcd->lgr_list, &lgr_free_list);
821 list_for_each_entry(lgr, &lgr_free_list, list)
823 spin_unlock_bh(&smcd->lgr_lock);
825 list_for_each_entry_safe(lgr, lg, &lgr_free_list, list) {
826 list_del_init(&lgr->list);
827 __smc_lgr_terminate(lgr, false);
830 if (atomic_read(&smcd->lgr_cnt))
831 wait_event(smcd->lgrs_deleted, !atomic_read(&smcd->lgr_cnt));
834 /* Called when an SMCR device is removed or the smc module is unloaded.
835 * If smcibdev is given, all SMCR link groups using this device are terminated.
836 * If smcibdev is NULL, all SMCR link groups are terminated.
838 void smc_smcr_terminate_all(struct smc_ib_device *smcibdev)
840 struct smc_link_group *lgr, *lg;
841 LIST_HEAD(lgr_free_list);
844 spin_lock_bh(&smc_lgr_list.lock);
846 list_splice_init(&smc_lgr_list.list, &lgr_free_list);
847 list_for_each_entry(lgr, &lgr_free_list, list)
850 list_for_each_entry_safe(lgr, lg, &smc_lgr_list.list, list) {
851 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
852 if (lgr->lnk[i].smcibdev == smcibdev) {
853 list_move(&lgr->list, &lgr_free_list);
860 spin_unlock_bh(&smc_lgr_list.lock);
862 list_for_each_entry_safe(lgr, lg, &lgr_free_list, list) {
863 list_del_init(&lgr->list);
864 __smc_lgr_terminate(lgr, false);
868 if (atomic_read(&smcibdev->lnk_cnt))
869 wait_event(smcibdev->lnks_deleted,
870 !atomic_read(&smcibdev->lnk_cnt));
872 if (atomic_read(&lgr_cnt))
873 wait_event(lgrs_deleted, !atomic_read(&lgr_cnt));
877 /* Determine vlan of internal TCP socket.
878 * @vlan_id: address to store the determined vlan id into
880 int smc_vlan_by_tcpsk(struct socket *clcsock, struct smc_init_info *ini)
882 struct dst_entry *dst = sk_dst_get(clcsock->sk);
883 struct net_device *ndev;
884 int i, nest_lvl, rc = 0;
897 if (is_vlan_dev(ndev)) {
898 ini->vlan_id = vlan_dev_vlan_id(ndev);
903 nest_lvl = ndev->lower_level;
904 for (i = 0; i < nest_lvl; i++) {
905 struct list_head *lower = &ndev->adj_list.lower;
907 if (list_empty(lower))
910 ndev = (struct net_device *)netdev_lower_get_next(ndev, &lower);
911 if (is_vlan_dev(ndev)) {
912 ini->vlan_id = vlan_dev_vlan_id(ndev);
924 static bool smcr_lgr_match(struct smc_link_group *lgr,
925 struct smc_clc_msg_local *lcl,
926 enum smc_lgr_role role, u32 clcqpn)
930 if (memcmp(lgr->peer_systemid, lcl->id_for_peer, SMC_SYSTEMID_LEN) ||
934 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
935 if (lgr->lnk[i].state != SMC_LNK_ACTIVE)
937 if ((lgr->role == SMC_SERV || lgr->lnk[i].peer_qpn == clcqpn) &&
938 !memcmp(lgr->lnk[i].peer_gid, &lcl->gid, SMC_GID_SIZE) &&
939 !memcmp(lgr->lnk[i].peer_mac, lcl->mac, sizeof(lcl->mac)))
945 static bool smcd_lgr_match(struct smc_link_group *lgr,
946 struct smcd_dev *smcismdev, u64 peer_gid)
948 return lgr->peer_gid == peer_gid && lgr->smcd == smcismdev;
951 /* create a new SMC connection (and a new link group if necessary) */
952 int smc_conn_create(struct smc_sock *smc, struct smc_init_info *ini)
954 struct smc_connection *conn = &smc->conn;
955 struct list_head *lgr_list;
956 struct smc_link_group *lgr;
957 enum smc_lgr_role role;
958 spinlock_t *lgr_lock;
961 lgr_list = ini->is_smcd ? &ini->ism_dev->lgr_list : &smc_lgr_list.list;
962 lgr_lock = ini->is_smcd ? &ini->ism_dev->lgr_lock : &smc_lgr_list.lock;
963 ini->cln_first_contact = SMC_FIRST_CONTACT;
964 role = smc->listen_smc ? SMC_SERV : SMC_CLNT;
965 if (role == SMC_CLNT && ini->srv_first_contact)
966 /* create new link group as well */
969 /* determine if an existing link group can be reused */
970 spin_lock_bh(lgr_lock);
971 list_for_each_entry(lgr, lgr_list, list) {
972 write_lock_bh(&lgr->conns_lock);
974 smcd_lgr_match(lgr, ini->ism_dev, ini->ism_gid) :
975 smcr_lgr_match(lgr, ini->ib_lcl, role, ini->ib_clcqpn)) &&
977 lgr->vlan_id == ini->vlan_id &&
979 lgr->conns_num < SMC_RMBS_PER_LGR_MAX)) {
980 /* link group found */
981 ini->cln_first_contact = SMC_REUSE_CONTACT;
983 rc = smc_lgr_register_conn(conn); /* add conn to lgr */
984 write_unlock_bh(&lgr->conns_lock);
985 if (!rc && delayed_work_pending(&lgr->free_work))
986 cancel_delayed_work(&lgr->free_work);
989 write_unlock_bh(&lgr->conns_lock);
991 spin_unlock_bh(lgr_lock);
995 if (role == SMC_CLNT && !ini->srv_first_contact &&
996 ini->cln_first_contact == SMC_FIRST_CONTACT) {
997 /* Server reuses a link group, but Client wants to start
999 * send out_of_sync decline, reason synchr. error
1001 return SMC_CLC_DECL_SYNCERR;
1005 if (ini->cln_first_contact == SMC_FIRST_CONTACT) {
1006 rc = smc_lgr_create(smc, ini);
1010 write_lock_bh(&lgr->conns_lock);
1011 rc = smc_lgr_register_conn(conn); /* add smc conn to lgr */
1012 write_unlock_bh(&lgr->conns_lock);
1016 conn->local_tx_ctrl.common.type = SMC_CDC_MSG_TYPE;
1017 conn->local_tx_ctrl.len = SMC_WR_TX_SIZE;
1018 conn->urg_state = SMC_URG_READ;
1020 conn->rx_off = sizeof(struct smcd_cdc_msg);
1021 smcd_cdc_rx_init(conn); /* init tasklet for this conn */
1023 #ifndef KERNEL_HAS_ATOMIC64
1024 spin_lock_init(&conn->acurs_lock);
1031 /* convert the RMB size into the compressed notation - minimum 16K.
1032 * In contrast to plain ilog2, this rounds towards the next power of 2,
1033 * so the socket application gets at least its desired sndbuf / rcvbuf size.
1035 static u8 smc_compress_bufsize(int size)
1039 if (size <= SMC_BUF_MIN_SIZE)
1042 size = (size - 1) >> 14;
1043 compressed = ilog2(size) + 1;
1044 if (compressed >= SMC_RMBE_SIZES)
1045 compressed = SMC_RMBE_SIZES - 1;
1049 /* convert the RMB size from compressed notation into integer */
1050 int smc_uncompress_bufsize(u8 compressed)
1054 size = 0x00000001 << (((int)compressed) + 14);
1058 /* try to reuse a sndbuf or rmb description slot for a certain
1059 * buffer size; if not available, return NULL
1061 static struct smc_buf_desc *smc_buf_get_slot(int compressed_bufsize,
1063 struct list_head *buf_list)
1065 struct smc_buf_desc *buf_slot;
1068 list_for_each_entry(buf_slot, buf_list, list) {
1069 if (cmpxchg(&buf_slot->used, 0, 1) == 0) {
1078 /* one of the conditions for announcing a receiver's current window size is
1079 * that it "results in a minimum increase in the window size of 10% of the
1080 * receive buffer space" [RFC7609]
1082 static inline int smc_rmb_wnd_update_limit(int rmbe_size)
1084 return min_t(int, rmbe_size / 10, SOCK_MIN_SNDBUF / 2);
1087 /* map an rmb buf to a link */
1088 static int smcr_buf_map_link(struct smc_buf_desc *buf_desc, bool is_rmb,
1089 struct smc_link *lnk)
1093 if (buf_desc->is_map_ib[lnk->link_idx])
1096 rc = sg_alloc_table(&buf_desc->sgt[lnk->link_idx], 1, GFP_KERNEL);
1099 sg_set_buf(buf_desc->sgt[lnk->link_idx].sgl,
1100 buf_desc->cpu_addr, buf_desc->len);
1102 /* map sg table to DMA address */
1103 rc = smc_ib_buf_map_sg(lnk, buf_desc,
1104 is_rmb ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1105 /* SMC protocol depends on mapping to one DMA address only */
1111 /* create a new memory region for the RMB */
1113 rc = smc_ib_get_memory_region(lnk->roce_pd,
1114 IB_ACCESS_REMOTE_WRITE |
1115 IB_ACCESS_LOCAL_WRITE,
1116 buf_desc, lnk->link_idx);
1119 smc_ib_sync_sg_for_device(lnk, buf_desc, DMA_FROM_DEVICE);
1121 buf_desc->is_map_ib[lnk->link_idx] = true;
1125 smc_ib_buf_unmap_sg(lnk, buf_desc,
1126 is_rmb ? DMA_FROM_DEVICE : DMA_TO_DEVICE);
1128 sg_free_table(&buf_desc->sgt[lnk->link_idx]);
1132 static struct smc_buf_desc *smcr_new_buf_create(struct smc_link_group *lgr,
1133 bool is_rmb, int bufsize)
1135 struct smc_buf_desc *buf_desc;
1137 /* try to alloc a new buffer */
1138 buf_desc = kzalloc(sizeof(*buf_desc), GFP_KERNEL);
1140 return ERR_PTR(-ENOMEM);
1142 buf_desc->order = get_order(bufsize);
1143 buf_desc->pages = alloc_pages(GFP_KERNEL | __GFP_NOWARN |
1144 __GFP_NOMEMALLOC | __GFP_COMP |
1145 __GFP_NORETRY | __GFP_ZERO,
1147 if (!buf_desc->pages) {
1149 return ERR_PTR(-EAGAIN);
1151 buf_desc->cpu_addr = (void *)page_address(buf_desc->pages);
1152 buf_desc->len = bufsize;
1156 /* map buf_desc on all usable links,
1157 * unused buffers stay mapped as long as the link is up
1159 static int smcr_buf_map_usable_links(struct smc_link_group *lgr,
1160 struct smc_buf_desc *buf_desc, bool is_rmb)
1164 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
1165 struct smc_link *lnk = &lgr->lnk[i];
1167 if (!smc_link_usable(lnk))
1169 if (smcr_buf_map_link(buf_desc, is_rmb, lnk)) {
1170 smcr_buf_unuse(buf_desc, lnk);
1179 #define SMCD_DMBE_SIZES 7 /* 0 -> 16KB, 1 -> 32KB, .. 6 -> 1MB */
1181 static struct smc_buf_desc *smcd_new_buf_create(struct smc_link_group *lgr,
1182 bool is_dmb, int bufsize)
1184 struct smc_buf_desc *buf_desc;
1187 if (smc_compress_bufsize(bufsize) > SMCD_DMBE_SIZES)
1188 return ERR_PTR(-EAGAIN);
1190 /* try to alloc a new DMB */
1191 buf_desc = kzalloc(sizeof(*buf_desc), GFP_KERNEL);
1193 return ERR_PTR(-ENOMEM);
1195 rc = smc_ism_register_dmb(lgr, bufsize, buf_desc);
1198 return ERR_PTR(-EAGAIN);
1200 buf_desc->pages = virt_to_page(buf_desc->cpu_addr);
1201 /* CDC header stored in buf. So, pretend it was smaller */
1202 buf_desc->len = bufsize - sizeof(struct smcd_cdc_msg);
1204 buf_desc->cpu_addr = kzalloc(bufsize, GFP_KERNEL |
1205 __GFP_NOWARN | __GFP_NORETRY |
1207 if (!buf_desc->cpu_addr) {
1209 return ERR_PTR(-EAGAIN);
1211 buf_desc->len = bufsize;
1216 static int __smc_buf_create(struct smc_sock *smc, bool is_smcd, bool is_rmb)
1218 struct smc_buf_desc *buf_desc = ERR_PTR(-ENOMEM);
1219 struct smc_connection *conn = &smc->conn;
1220 struct smc_link_group *lgr = conn->lgr;
1221 struct list_head *buf_list;
1222 int bufsize, bufsize_short;
1223 struct mutex *lock; /* lock buffer list */
1227 /* use socket recv buffer size (w/o overhead) as start value */
1228 sk_buf_size = smc->sk.sk_rcvbuf / 2;
1230 /* use socket send buffer size (w/o overhead) as start value */
1231 sk_buf_size = smc->sk.sk_sndbuf / 2;
1233 for (bufsize_short = smc_compress_bufsize(sk_buf_size);
1234 bufsize_short >= 0; bufsize_short--) {
1237 lock = &lgr->rmbs_lock;
1238 buf_list = &lgr->rmbs[bufsize_short];
1240 lock = &lgr->sndbufs_lock;
1241 buf_list = &lgr->sndbufs[bufsize_short];
1243 bufsize = smc_uncompress_bufsize(bufsize_short);
1244 if ((1 << get_order(bufsize)) > SG_MAX_SINGLE_ALLOC)
1247 /* check for reusable slot in the link group */
1248 buf_desc = smc_buf_get_slot(bufsize_short, lock, buf_list);
1250 memset(buf_desc->cpu_addr, 0, bufsize);
1251 break; /* found reusable slot */
1255 buf_desc = smcd_new_buf_create(lgr, is_rmb, bufsize);
1257 buf_desc = smcr_new_buf_create(lgr, is_rmb, bufsize);
1259 if (PTR_ERR(buf_desc) == -ENOMEM)
1261 if (IS_ERR(buf_desc))
1266 list_add(&buf_desc->list, buf_list);
1271 if (IS_ERR(buf_desc))
1275 if (smcr_buf_map_usable_links(lgr, buf_desc, is_rmb)) {
1281 conn->rmb_desc = buf_desc;
1282 conn->rmbe_size_short = bufsize_short;
1283 smc->sk.sk_rcvbuf = bufsize * 2;
1284 atomic_set(&conn->bytes_to_rcv, 0);
1285 conn->rmbe_update_limit =
1286 smc_rmb_wnd_update_limit(buf_desc->len);
1288 smc_ism_set_conn(conn); /* map RMB/smcd_dev to conn */
1290 conn->sndbuf_desc = buf_desc;
1291 smc->sk.sk_sndbuf = bufsize * 2;
1292 atomic_set(&conn->sndbuf_space, bufsize);
1297 void smc_sndbuf_sync_sg_for_cpu(struct smc_connection *conn)
1299 if (!conn->lgr || conn->lgr->is_smcd || !smc_link_usable(conn->lnk))
1301 smc_ib_sync_sg_for_cpu(conn->lnk, conn->sndbuf_desc, DMA_TO_DEVICE);
1304 void smc_sndbuf_sync_sg_for_device(struct smc_connection *conn)
1306 if (!conn->lgr || conn->lgr->is_smcd || !smc_link_usable(conn->lnk))
1308 smc_ib_sync_sg_for_device(conn->lnk, conn->sndbuf_desc, DMA_TO_DEVICE);
1311 void smc_rmb_sync_sg_for_cpu(struct smc_connection *conn)
1315 if (!conn->lgr || conn->lgr->is_smcd)
1317 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
1318 if (!smc_link_usable(&conn->lgr->lnk[i]))
1320 smc_ib_sync_sg_for_cpu(&conn->lgr->lnk[i], conn->rmb_desc,
1325 void smc_rmb_sync_sg_for_device(struct smc_connection *conn)
1329 if (!conn->lgr || conn->lgr->is_smcd)
1331 for (i = 0; i < SMC_LINKS_PER_LGR_MAX; i++) {
1332 if (!smc_link_usable(&conn->lgr->lnk[i]))
1334 smc_ib_sync_sg_for_device(&conn->lgr->lnk[i], conn->rmb_desc,
1339 /* create the send and receive buffer for an SMC socket;
1340 * receive buffers are called RMBs;
1341 * (even though the SMC protocol allows more than one RMB-element per RMB,
1342 * the Linux implementation uses just one RMB-element per RMB, i.e. uses an
1343 * extra RMB for every connection in a link group
1345 int smc_buf_create(struct smc_sock *smc, bool is_smcd)
1349 /* create send buffer */
1350 rc = __smc_buf_create(smc, is_smcd, false);
1354 rc = __smc_buf_create(smc, is_smcd, true);
1356 smc_buf_free(smc->conn.lgr, false, smc->conn.sndbuf_desc);
1360 static inline int smc_rmb_reserve_rtoken_idx(struct smc_link_group *lgr)
1364 for_each_clear_bit(i, lgr->rtokens_used_mask, SMC_RMBS_PER_LGR_MAX) {
1365 if (!test_and_set_bit(i, lgr->rtokens_used_mask))
1371 /* add a new rtoken from peer */
1372 int smc_rtoken_add(struct smc_link *lnk, __be64 nw_vaddr, __be32 nw_rkey)
1374 struct smc_link_group *lgr = smc_get_lgr(lnk);
1375 u64 dma_addr = be64_to_cpu(nw_vaddr);
1376 u32 rkey = ntohl(nw_rkey);
1379 for (i = 0; i < SMC_RMBS_PER_LGR_MAX; i++) {
1380 if (lgr->rtokens[i][lnk->link_idx].rkey == rkey &&
1381 lgr->rtokens[i][lnk->link_idx].dma_addr == dma_addr &&
1382 test_bit(i, lgr->rtokens_used_mask)) {
1383 /* already in list */
1387 i = smc_rmb_reserve_rtoken_idx(lgr);
1390 lgr->rtokens[i][lnk->link_idx].rkey = rkey;
1391 lgr->rtokens[i][lnk->link_idx].dma_addr = dma_addr;
1395 /* delete an rtoken from all links */
1396 int smc_rtoken_delete(struct smc_link *lnk, __be32 nw_rkey)
1398 struct smc_link_group *lgr = smc_get_lgr(lnk);
1399 u32 rkey = ntohl(nw_rkey);
1402 for (i = 0; i < SMC_RMBS_PER_LGR_MAX; i++) {
1403 if (lgr->rtokens[i][lnk->link_idx].rkey == rkey &&
1404 test_bit(i, lgr->rtokens_used_mask)) {
1405 for (j = 0; j < SMC_LINKS_PER_LGR_MAX; j++) {
1406 lgr->rtokens[i][j].rkey = 0;
1407 lgr->rtokens[i][j].dma_addr = 0;
1409 clear_bit(i, lgr->rtokens_used_mask);
1416 /* save rkey and dma_addr received from peer during clc handshake */
1417 int smc_rmb_rtoken_handling(struct smc_connection *conn,
1418 struct smc_link *lnk,
1419 struct smc_clc_msg_accept_confirm *clc)
1421 conn->rtoken_idx = smc_rtoken_add(lnk, clc->rmb_dma_addr,
1423 if (conn->rtoken_idx < 0)
1424 return conn->rtoken_idx;
1428 static void smc_core_going_away(void)
1430 struct smc_ib_device *smcibdev;
1431 struct smcd_dev *smcd;
1433 spin_lock(&smc_ib_devices.lock);
1434 list_for_each_entry(smcibdev, &smc_ib_devices.list, list) {
1437 for (i = 0; i < SMC_MAX_PORTS; i++)
1438 set_bit(i, smcibdev->ports_going_away);
1440 spin_unlock(&smc_ib_devices.lock);
1442 spin_lock(&smcd_dev_list.lock);
1443 list_for_each_entry(smcd, &smcd_dev_list.list, list) {
1444 smcd->going_away = 1;
1446 spin_unlock(&smcd_dev_list.lock);
1449 /* Clean up all SMC link groups */
1450 static void smc_lgrs_shutdown(void)
1452 struct smcd_dev *smcd;
1454 smc_core_going_away();
1456 smc_smcr_terminate_all(NULL);
1458 spin_lock(&smcd_dev_list.lock);
1459 list_for_each_entry(smcd, &smcd_dev_list.list, list)
1460 smc_smcd_terminate_all(smcd);
1461 spin_unlock(&smcd_dev_list.lock);
1464 static int smc_core_reboot_event(struct notifier_block *this,
1465 unsigned long event, void *ptr)
1467 smc_lgrs_shutdown();
1468 smc_ib_unregister_client();
1472 static struct notifier_block smc_reboot_notifier = {
1473 .notifier_call = smc_core_reboot_event,
1476 int __init smc_core_init(void)
1478 return register_reboot_notifier(&smc_reboot_notifier);
1481 /* Called (from smc_exit) when module is removed */
1482 void smc_core_exit(void)
1484 unregister_reboot_notifier(&smc_reboot_notifier);
1485 smc_lgrs_shutdown();