1 // SPDX-License-Identifier: GPL-2.0-or-later
5 * Copyright (c) 2014 - 2018 ProfitBricks GmbH. All rights reserved.
6 * Copyright (c) 2018 - 2019 1&1 IONOS Cloud GmbH. All rights reserved.
7 * Copyright (c) 2019 - 2020 1&1 IONOS SE. All rights reserved.
11 #define pr_fmt(fmt) KBUILD_MODNAME " L" __stringify(__LINE__) ": " fmt
13 #include <linux/module.h>
14 #include <linux/rculist.h>
15 #include <linux/random.h>
20 #define RTRS_CONNECT_TIMEOUT_MS 30000
22 * Wait a bit before trying to reconnect after a failure
23 * in order to give server time to finish clean up which
24 * leads to "false positives" failed reconnect attempts
26 #define RTRS_RECONNECT_BACKOFF 1000
28 * Wait for additional random time between 0 and 8 seconds
29 * before starting to reconnect to avoid clients reconnecting
30 * all at once in case of a major network outage
32 #define RTRS_RECONNECT_SEED 8
34 #define FIRST_CONN 0x01
36 MODULE_DESCRIPTION("RDMA Transport Client");
37 MODULE_LICENSE("GPL");
39 static const struct rtrs_rdma_dev_pd_ops dev_pd_ops;
40 static struct rtrs_rdma_dev_pd dev_pd = {
44 static struct workqueue_struct *rtrs_wq;
45 static struct class *rtrs_clt_dev_class;
47 static inline bool rtrs_clt_is_connected(const struct rtrs_clt *clt)
49 struct rtrs_clt_sess *sess;
50 bool connected = false;
53 list_for_each_entry_rcu(sess, &clt->paths_list, s.entry)
54 connected |= READ_ONCE(sess->state) == RTRS_CLT_CONNECTED;
60 static struct rtrs_permit *
61 __rtrs_get_permit(struct rtrs_clt *clt, enum rtrs_clt_con_type con_type)
63 size_t max_depth = clt->queue_depth;
64 struct rtrs_permit *permit;
68 * Adapted from null_blk get_tag(). Callers from different cpus may
69 * grab the same bit, since find_first_zero_bit is not atomic.
70 * But then the test_and_set_bit_lock will fail for all the
71 * callers but one, so that they will loop again.
72 * This way an explicit spinlock is not required.
75 bit = find_first_zero_bit(clt->permits_map, max_depth);
76 if (unlikely(bit >= max_depth))
78 } while (unlikely(test_and_set_bit_lock(bit, clt->permits_map)));
80 permit = get_permit(clt, bit);
81 WARN_ON(permit->mem_id != bit);
82 permit->cpu_id = raw_smp_processor_id();
83 permit->con_type = con_type;
88 static inline void __rtrs_put_permit(struct rtrs_clt *clt,
89 struct rtrs_permit *permit)
91 clear_bit_unlock(permit->mem_id, clt->permits_map);
95 * rtrs_clt_get_permit() - allocates permit for future RDMA operation
96 * @clt: Current session
97 * @con_type: Type of connection to use with the permit
98 * @can_wait: Wait type
101 * Allocates permit for the following RDMA operation. Permit is used
102 * to preallocate all resources and to propagate memory pressure
106 * Can sleep if @wait == RTRS_TAG_WAIT
108 struct rtrs_permit *rtrs_clt_get_permit(struct rtrs_clt *clt,
109 enum rtrs_clt_con_type con_type,
112 struct rtrs_permit *permit;
115 permit = __rtrs_get_permit(clt, con_type);
116 if (likely(permit) || !can_wait)
120 prepare_to_wait(&clt->permits_wait, &wait,
121 TASK_UNINTERRUPTIBLE);
122 permit = __rtrs_get_permit(clt, con_type);
129 finish_wait(&clt->permits_wait, &wait);
133 EXPORT_SYMBOL(rtrs_clt_get_permit);
136 * rtrs_clt_put_permit() - puts allocated permit
137 * @clt: Current session
138 * @permit: Permit to be freed
143 void rtrs_clt_put_permit(struct rtrs_clt *clt, struct rtrs_permit *permit)
145 if (WARN_ON(!test_bit(permit->mem_id, clt->permits_map)))
148 __rtrs_put_permit(clt, permit);
151 * rtrs_clt_get_permit() adds itself to the &clt->permits_wait list
152 * before calling schedule(). So if rtrs_clt_get_permit() is sleeping
153 * it must have added itself to &clt->permits_wait before
154 * __rtrs_put_permit() finished.
155 * Hence it is safe to guard wake_up() with a waitqueue_active() test.
157 if (waitqueue_active(&clt->permits_wait))
158 wake_up(&clt->permits_wait);
160 EXPORT_SYMBOL(rtrs_clt_put_permit);
162 void *rtrs_permit_to_pdu(struct rtrs_permit *permit)
166 EXPORT_SYMBOL(rtrs_permit_to_pdu);
169 * rtrs_permit_to_clt_con() - returns RDMA connection pointer by the permit
170 * @sess: client session pointer
171 * @permit: permit for the allocation of the RDMA buffer
173 * IO connection starts from 1.
174 * 0 connection is for user messages.
177 struct rtrs_clt_con *rtrs_permit_to_clt_con(struct rtrs_clt_sess *sess,
178 struct rtrs_permit *permit)
182 if (likely(permit->con_type == RTRS_IO_CON))
183 id = (permit->cpu_id % (sess->s.con_num - 1)) + 1;
185 return to_clt_con(sess->s.con[id]);
189 * __rtrs_clt_change_state() - change the session state through session state
192 * @sess: client session to change the state of.
193 * @new_state: state to change to.
195 * returns true if successful, false if the requested state can not be set.
198 * state_wq lock must be hold.
200 static bool __rtrs_clt_change_state(struct rtrs_clt_sess *sess,
201 enum rtrs_clt_state new_state)
203 enum rtrs_clt_state old_state;
204 bool changed = false;
206 lockdep_assert_held(&sess->state_wq.lock);
208 old_state = sess->state;
210 case RTRS_CLT_CONNECTING:
212 case RTRS_CLT_RECONNECTING:
219 case RTRS_CLT_RECONNECTING:
221 case RTRS_CLT_CONNECTED:
222 case RTRS_CLT_CONNECTING_ERR:
223 case RTRS_CLT_CLOSED:
230 case RTRS_CLT_CONNECTED:
232 case RTRS_CLT_CONNECTING:
239 case RTRS_CLT_CONNECTING_ERR:
241 case RTRS_CLT_CONNECTING:
248 case RTRS_CLT_CLOSING:
250 case RTRS_CLT_CONNECTING:
251 case RTRS_CLT_CONNECTING_ERR:
252 case RTRS_CLT_RECONNECTING:
253 case RTRS_CLT_CONNECTED:
260 case RTRS_CLT_CLOSED:
262 case RTRS_CLT_CLOSING:
271 case RTRS_CLT_CLOSED:
282 sess->state = new_state;
283 wake_up_locked(&sess->state_wq);
289 static bool rtrs_clt_change_state_from_to(struct rtrs_clt_sess *sess,
290 enum rtrs_clt_state old_state,
291 enum rtrs_clt_state new_state)
293 bool changed = false;
295 spin_lock_irq(&sess->state_wq.lock);
296 if (sess->state == old_state)
297 changed = __rtrs_clt_change_state(sess, new_state);
298 spin_unlock_irq(&sess->state_wq.lock);
303 static void rtrs_rdma_error_recovery(struct rtrs_clt_con *con)
305 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
307 if (rtrs_clt_change_state_from_to(sess,
309 RTRS_CLT_RECONNECTING)) {
310 struct rtrs_clt *clt = sess->clt;
311 unsigned int delay_ms;
314 * Normal scenario, reconnect if we were successfully connected
316 delay_ms = clt->reconnect_delay_sec * 1000;
317 queue_delayed_work(rtrs_wq, &sess->reconnect_dwork,
318 msecs_to_jiffies(delay_ms +
319 prandom_u32() % RTRS_RECONNECT_SEED));
322 * Error can happen just on establishing new connection,
323 * so notify waiter with error state, waiter is responsible
324 * for cleaning the rest and reconnect if needed.
326 rtrs_clt_change_state_from_to(sess,
328 RTRS_CLT_CONNECTING_ERR);
332 static void rtrs_clt_fast_reg_done(struct ib_cq *cq, struct ib_wc *wc)
334 struct rtrs_clt_con *con = cq->cq_context;
336 if (unlikely(wc->status != IB_WC_SUCCESS)) {
337 rtrs_err(con->c.sess, "Failed IB_WR_REG_MR: %s\n",
338 ib_wc_status_msg(wc->status));
339 rtrs_rdma_error_recovery(con);
343 static struct ib_cqe fast_reg_cqe = {
344 .done = rtrs_clt_fast_reg_done
347 static void complete_rdma_req(struct rtrs_clt_io_req *req, int errno,
348 bool notify, bool can_wait);
350 static void rtrs_clt_inv_rkey_done(struct ib_cq *cq, struct ib_wc *wc)
352 struct rtrs_clt_io_req *req =
353 container_of(wc->wr_cqe, typeof(*req), inv_cqe);
354 struct rtrs_clt_con *con = cq->cq_context;
356 if (unlikely(wc->status != IB_WC_SUCCESS)) {
357 rtrs_err(con->c.sess, "Failed IB_WR_LOCAL_INV: %s\n",
358 ib_wc_status_msg(wc->status));
359 rtrs_rdma_error_recovery(con);
361 req->need_inv = false;
362 if (likely(req->need_inv_comp))
363 complete(&req->inv_comp);
365 /* Complete request from INV callback */
366 complete_rdma_req(req, req->inv_errno, true, false);
369 static int rtrs_inv_rkey(struct rtrs_clt_io_req *req)
371 struct rtrs_clt_con *con = req->con;
372 struct ib_send_wr wr = {
373 .opcode = IB_WR_LOCAL_INV,
374 .wr_cqe = &req->inv_cqe,
375 .send_flags = IB_SEND_SIGNALED,
376 .ex.invalidate_rkey = req->mr->rkey,
378 req->inv_cqe.done = rtrs_clt_inv_rkey_done;
380 return ib_post_send(con->c.qp, &wr, NULL);
383 static void complete_rdma_req(struct rtrs_clt_io_req *req, int errno,
384 bool notify, bool can_wait)
386 struct rtrs_clt_con *con = req->con;
387 struct rtrs_clt_sess *sess;
390 if (WARN_ON(!req->in_use))
392 if (WARN_ON(!req->con))
394 sess = to_clt_sess(con->c.sess);
397 if (unlikely(req->dir == DMA_FROM_DEVICE && req->need_inv)) {
399 * We are here to invalidate read requests
400 * ourselves. In normal scenario server should
401 * send INV for all read requests, but
402 * we are here, thus two things could happen:
404 * 1. this is failover, when errno != 0
407 * 2. something totally bad happened and
408 * server forgot to send INV, so we
409 * should do that ourselves.
412 if (likely(can_wait)) {
413 req->need_inv_comp = true;
415 /* This should be IO path, so always notify */
417 /* Save errno for INV callback */
418 req->inv_errno = errno;
421 err = rtrs_inv_rkey(req);
423 rtrs_err(con->c.sess, "Send INV WR key=%#x: %d\n",
425 } else if (likely(can_wait)) {
426 wait_for_completion(&req->inv_comp);
429 * Something went wrong, so request will be
430 * completed from INV callback.
437 ib_dma_unmap_sg(sess->s.dev->ib_dev, req->sglist,
438 req->sg_cnt, req->dir);
440 if (sess->clt->mp_policy == MP_POLICY_MIN_INFLIGHT)
441 atomic_dec(&sess->stats->inflight);
447 req->conf(req->priv, errno);
450 static int rtrs_post_send_rdma(struct rtrs_clt_con *con,
451 struct rtrs_clt_io_req *req,
452 struct rtrs_rbuf *rbuf, u32 off,
453 u32 imm, struct ib_send_wr *wr)
455 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
456 enum ib_send_flags flags;
459 if (unlikely(!req->sg_size)) {
460 rtrs_wrn(con->c.sess,
461 "Doing RDMA Write failed, no data supplied\n");
465 /* user data and user message in the first list element */
466 sge.addr = req->iu->dma_addr;
467 sge.length = req->sg_size;
468 sge.lkey = sess->s.dev->ib_pd->local_dma_lkey;
471 * From time to time we have to post signalled sends,
472 * or send queue will fill up and only QP reset can help.
474 flags = atomic_inc_return(&con->io_cnt) % sess->queue_depth ?
475 0 : IB_SEND_SIGNALED;
477 ib_dma_sync_single_for_device(sess->s.dev->ib_dev, req->iu->dma_addr,
478 req->sg_size, DMA_TO_DEVICE);
480 return rtrs_iu_post_rdma_write_imm(&con->c, req->iu, &sge, 1,
481 rbuf->rkey, rbuf->addr + off,
485 static void process_io_rsp(struct rtrs_clt_sess *sess, u32 msg_id,
486 s16 errno, bool w_inval)
488 struct rtrs_clt_io_req *req;
490 if (WARN_ON(msg_id >= sess->queue_depth))
493 req = &sess->reqs[msg_id];
494 /* Drop need_inv if server responded with send with invalidation */
495 req->need_inv &= !w_inval;
496 complete_rdma_req(req, errno, true, false);
499 static void rtrs_clt_recv_done(struct rtrs_clt_con *con, struct ib_wc *wc)
503 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
505 WARN_ON((sess->flags & RTRS_MSG_NEW_RKEY_F) == 0);
506 iu = container_of(wc->wr_cqe, struct rtrs_iu,
508 err = rtrs_iu_post_recv(&con->c, iu);
510 rtrs_err(con->c.sess, "post iu failed %d\n", err);
511 rtrs_rdma_error_recovery(con);
515 static void rtrs_clt_rkey_rsp_done(struct rtrs_clt_con *con, struct ib_wc *wc)
517 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
518 struct rtrs_msg_rkey_rsp *msg;
519 u32 imm_type, imm_payload;
520 bool w_inval = false;
525 WARN_ON((sess->flags & RTRS_MSG_NEW_RKEY_F) == 0);
527 iu = container_of(wc->wr_cqe, struct rtrs_iu, cqe);
529 if (unlikely(wc->byte_len < sizeof(*msg))) {
530 rtrs_err(con->c.sess, "rkey response is malformed: size %d\n",
534 ib_dma_sync_single_for_cpu(sess->s.dev->ib_dev, iu->dma_addr,
535 iu->size, DMA_FROM_DEVICE);
537 if (unlikely(le16_to_cpu(msg->type) != RTRS_MSG_RKEY_RSP)) {
538 rtrs_err(sess->clt, "rkey response is malformed: type %d\n",
539 le16_to_cpu(msg->type));
542 buf_id = le16_to_cpu(msg->buf_id);
543 if (WARN_ON(buf_id >= sess->queue_depth))
546 rtrs_from_imm(be32_to_cpu(wc->ex.imm_data), &imm_type, &imm_payload);
547 if (likely(imm_type == RTRS_IO_RSP_IMM ||
548 imm_type == RTRS_IO_RSP_W_INV_IMM)) {
551 w_inval = (imm_type == RTRS_IO_RSP_W_INV_IMM);
552 rtrs_from_io_rsp_imm(imm_payload, &msg_id, &err);
554 if (WARN_ON(buf_id != msg_id))
556 sess->rbufs[buf_id].rkey = le32_to_cpu(msg->rkey);
557 process_io_rsp(sess, msg_id, err, w_inval);
559 ib_dma_sync_single_for_device(sess->s.dev->ib_dev, iu->dma_addr,
560 iu->size, DMA_FROM_DEVICE);
561 return rtrs_clt_recv_done(con, wc);
563 rtrs_rdma_error_recovery(con);
566 static void rtrs_clt_rdma_done(struct ib_cq *cq, struct ib_wc *wc);
568 static struct ib_cqe io_comp_cqe = {
569 .done = rtrs_clt_rdma_done
573 * Post x2 empty WRs: first is for this RDMA with IMM,
574 * second is for RECV with INV, which happened earlier.
576 static int rtrs_post_recv_empty_x2(struct rtrs_con *con, struct ib_cqe *cqe)
578 struct ib_recv_wr wr_arr[2], *wr;
581 memset(wr_arr, 0, sizeof(wr_arr));
582 for (i = 0; i < ARRAY_SIZE(wr_arr); i++) {
586 /* Chain backwards */
587 wr->next = &wr_arr[i - 1];
590 return ib_post_recv(con->qp, wr, NULL);
593 static void rtrs_clt_rdma_done(struct ib_cq *cq, struct ib_wc *wc)
595 struct rtrs_clt_con *con = cq->cq_context;
596 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
597 u32 imm_type, imm_payload;
598 bool w_inval = false;
601 if (unlikely(wc->status != IB_WC_SUCCESS)) {
602 if (wc->status != IB_WC_WR_FLUSH_ERR) {
603 rtrs_err(sess->clt, "RDMA failed: %s\n",
604 ib_wc_status_msg(wc->status));
605 rtrs_rdma_error_recovery(con);
609 rtrs_clt_update_wc_stats(con);
611 switch (wc->opcode) {
612 case IB_WC_RECV_RDMA_WITH_IMM:
614 * post_recv() RDMA write completions of IO reqs (read/write)
617 if (WARN_ON(wc->wr_cqe->done != rtrs_clt_rdma_done))
619 rtrs_from_imm(be32_to_cpu(wc->ex.imm_data),
620 &imm_type, &imm_payload);
621 if (likely(imm_type == RTRS_IO_RSP_IMM ||
622 imm_type == RTRS_IO_RSP_W_INV_IMM)) {
625 w_inval = (imm_type == RTRS_IO_RSP_W_INV_IMM);
626 rtrs_from_io_rsp_imm(imm_payload, &msg_id, &err);
628 process_io_rsp(sess, msg_id, err, w_inval);
629 } else if (imm_type == RTRS_HB_MSG_IMM) {
631 rtrs_send_hb_ack(&sess->s);
632 if (sess->flags & RTRS_MSG_NEW_RKEY_F)
633 return rtrs_clt_recv_done(con, wc);
634 } else if (imm_type == RTRS_HB_ACK_IMM) {
636 sess->s.hb_missed_cnt = 0;
637 if (sess->flags & RTRS_MSG_NEW_RKEY_F)
638 return rtrs_clt_recv_done(con, wc);
640 rtrs_wrn(con->c.sess, "Unknown IMM type %u\n",
645 * Post x2 empty WRs: first is for this RDMA with IMM,
646 * second is for RECV with INV, which happened earlier.
648 err = rtrs_post_recv_empty_x2(&con->c, &io_comp_cqe);
650 err = rtrs_post_recv_empty(&con->c, &io_comp_cqe);
652 rtrs_err(con->c.sess, "rtrs_post_recv_empty(): %d\n",
654 rtrs_rdma_error_recovery(con);
660 * Key invalidations from server side
662 WARN_ON(!(wc->wc_flags & IB_WC_WITH_INVALIDATE ||
663 wc->wc_flags & IB_WC_WITH_IMM));
664 WARN_ON(wc->wr_cqe->done != rtrs_clt_rdma_done);
665 if (sess->flags & RTRS_MSG_NEW_RKEY_F) {
666 if (wc->wc_flags & IB_WC_WITH_INVALIDATE)
667 return rtrs_clt_recv_done(con, wc);
669 return rtrs_clt_rkey_rsp_done(con, wc);
672 case IB_WC_RDMA_WRITE:
674 * post_send() RDMA write completions of IO reqs (read/write)
679 rtrs_wrn(sess->clt, "Unexpected WC type: %d\n", wc->opcode);
684 static int post_recv_io(struct rtrs_clt_con *con, size_t q_size)
687 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
689 for (i = 0; i < q_size; i++) {
690 if (sess->flags & RTRS_MSG_NEW_RKEY_F) {
691 struct rtrs_iu *iu = &con->rsp_ius[i];
693 err = rtrs_iu_post_recv(&con->c, iu);
695 err = rtrs_post_recv_empty(&con->c, &io_comp_cqe);
704 static int post_recv_sess(struct rtrs_clt_sess *sess)
709 for (cid = 0; cid < sess->s.con_num; cid++) {
711 q_size = SERVICE_CON_QUEUE_DEPTH;
713 q_size = sess->queue_depth;
716 * x2 for RDMA read responses + FR key invalidations,
717 * RDMA writes do not require any FR registrations.
721 err = post_recv_io(to_clt_con(sess->s.con[cid]), q_size);
723 rtrs_err(sess->clt, "post_recv_io(), err: %d\n", err);
733 struct list_head skip_list;
734 struct rtrs_clt *clt;
735 struct rtrs_clt_sess *(*next_path)(struct path_it *it);
739 * list_next_or_null_rr_rcu - get next list element in round-robin fashion.
740 * @head: the head for the list.
741 * @ptr: the list head to take the next element from.
742 * @type: the type of the struct this is embedded in.
743 * @memb: the name of the list_head within the struct.
745 * Next element returned in round-robin fashion, i.e. head will be skipped,
746 * but if list is observed as empty, NULL will be returned.
748 * This primitive may safely run concurrently with the _rcu list-mutation
749 * primitives such as list_add_rcu() as long as it's guarded by rcu_read_lock().
751 #define list_next_or_null_rr_rcu(head, ptr, type, memb) \
753 list_next_or_null_rcu(head, ptr, type, memb) ?: \
754 list_next_or_null_rcu(head, READ_ONCE((ptr)->next), \
759 * get_next_path_rr() - Returns path in round-robin fashion.
760 * @it: the path pointer
762 * Related to @MP_POLICY_RR
765 * rcu_read_lock() must be hold.
767 static struct rtrs_clt_sess *get_next_path_rr(struct path_it *it)
769 struct rtrs_clt_sess __rcu **ppcpu_path;
770 struct rtrs_clt_sess *path;
771 struct rtrs_clt *clt;
776 * Here we use two RCU objects: @paths_list and @pcpu_path
777 * pointer. See rtrs_clt_remove_path_from_arr() for details
778 * how that is handled.
781 ppcpu_path = this_cpu_ptr(clt->pcpu_path);
782 path = rcu_dereference(*ppcpu_path);
784 path = list_first_or_null_rcu(&clt->paths_list,
785 typeof(*path), s.entry);
787 path = list_next_or_null_rr_rcu(&clt->paths_list,
791 rcu_assign_pointer(*ppcpu_path, path);
797 * get_next_path_min_inflight() - Returns path with minimal inflight count.
798 * @it: the path pointer
800 * Related to @MP_POLICY_MIN_INFLIGHT
803 * rcu_read_lock() must be hold.
805 static struct rtrs_clt_sess *get_next_path_min_inflight(struct path_it *it)
807 struct rtrs_clt_sess *min_path = NULL;
808 struct rtrs_clt *clt = it->clt;
809 struct rtrs_clt_sess *sess;
810 int min_inflight = INT_MAX;
813 list_for_each_entry_rcu(sess, &clt->paths_list, s.entry) {
814 if (unlikely(READ_ONCE(sess->state) != RTRS_CLT_CONNECTED))
817 if (unlikely(!list_empty(raw_cpu_ptr(sess->mp_skip_entry))))
820 inflight = atomic_read(&sess->stats->inflight);
822 if (inflight < min_inflight) {
823 min_inflight = inflight;
829 * add the path to the skip list, so that next time we can get
833 list_add(raw_cpu_ptr(min_path->mp_skip_entry), &it->skip_list);
838 static inline void path_it_init(struct path_it *it, struct rtrs_clt *clt)
840 INIT_LIST_HEAD(&it->skip_list);
844 if (clt->mp_policy == MP_POLICY_RR)
845 it->next_path = get_next_path_rr;
847 it->next_path = get_next_path_min_inflight;
850 static inline void path_it_deinit(struct path_it *it)
852 struct list_head *skip, *tmp;
854 * The skip_list is used only for the MIN_INFLIGHT policy.
855 * We need to remove paths from it, so that next IO can insert
856 * paths (->mp_skip_entry) into a skip_list again.
858 list_for_each_safe(skip, tmp, &it->skip_list)
863 * rtrs_clt_init_req() Initialize an rtrs_clt_io_req holding information
864 * about an inflight IO.
865 * The user buffer holding user control message (not data) is copied into
866 * the corresponding buffer of rtrs_iu (req->iu->buf), which later on will
867 * also hold the control message of rtrs.
868 * @req: an io request holding information about IO.
869 * @sess: client session
870 * @conf: conformation callback function to notify upper layer.
871 * @permit: permit for allocation of RDMA remote buffer
872 * @priv: private pointer
873 * @vec: kernel vector containing control message
874 * @usr_len: length of the user message
875 * @sg: scater list for IO data
876 * @sg_cnt: number of scater list entries
877 * @data_len: length of the IO data
878 * @dir: direction of the IO.
880 static void rtrs_clt_init_req(struct rtrs_clt_io_req *req,
881 struct rtrs_clt_sess *sess,
882 void (*conf)(void *priv, int errno),
883 struct rtrs_permit *permit, void *priv,
884 const struct kvec *vec, size_t usr_len,
885 struct scatterlist *sg, size_t sg_cnt,
886 size_t data_len, int dir)
888 struct iov_iter iter;
891 req->permit = permit;
893 req->usr_len = usr_len;
894 req->data_len = data_len;
896 req->sg_cnt = sg_cnt;
899 req->con = rtrs_permit_to_clt_con(sess, permit);
901 req->need_inv = false;
902 req->need_inv_comp = false;
905 iov_iter_kvec(&iter, READ, vec, 1, usr_len);
906 len = _copy_from_iter(req->iu->buf, usr_len, &iter);
907 WARN_ON(len != usr_len);
909 reinit_completion(&req->inv_comp);
912 static struct rtrs_clt_io_req *
913 rtrs_clt_get_req(struct rtrs_clt_sess *sess,
914 void (*conf)(void *priv, int errno),
915 struct rtrs_permit *permit, void *priv,
916 const struct kvec *vec, size_t usr_len,
917 struct scatterlist *sg, size_t sg_cnt,
918 size_t data_len, int dir)
920 struct rtrs_clt_io_req *req;
922 req = &sess->reqs[permit->mem_id];
923 rtrs_clt_init_req(req, sess, conf, permit, priv, vec, usr_len,
924 sg, sg_cnt, data_len, dir);
928 static struct rtrs_clt_io_req *
929 rtrs_clt_get_copy_req(struct rtrs_clt_sess *alive_sess,
930 struct rtrs_clt_io_req *fail_req)
932 struct rtrs_clt_io_req *req;
934 .iov_base = fail_req->iu->buf,
935 .iov_len = fail_req->usr_len
938 req = &alive_sess->reqs[fail_req->permit->mem_id];
939 rtrs_clt_init_req(req, alive_sess, fail_req->conf, fail_req->permit,
940 fail_req->priv, &vec, fail_req->usr_len,
941 fail_req->sglist, fail_req->sg_cnt,
942 fail_req->data_len, fail_req->dir);
946 static int rtrs_post_rdma_write_sg(struct rtrs_clt_con *con,
947 struct rtrs_clt_io_req *req,
948 struct rtrs_rbuf *rbuf,
951 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
952 struct ib_sge *sge = req->sge;
953 enum ib_send_flags flags;
954 struct scatterlist *sg;
958 for_each_sg(req->sglist, sg, req->sg_cnt, i) {
959 sge[i].addr = sg_dma_address(sg);
960 sge[i].length = sg_dma_len(sg);
961 sge[i].lkey = sess->s.dev->ib_pd->local_dma_lkey;
963 sge[i].addr = req->iu->dma_addr;
964 sge[i].length = size;
965 sge[i].lkey = sess->s.dev->ib_pd->local_dma_lkey;
967 num_sge = 1 + req->sg_cnt;
970 * From time to time we have to post signalled sends,
971 * or send queue will fill up and only QP reset can help.
973 flags = atomic_inc_return(&con->io_cnt) % sess->queue_depth ?
974 0 : IB_SEND_SIGNALED;
976 ib_dma_sync_single_for_device(sess->s.dev->ib_dev, req->iu->dma_addr,
977 size, DMA_TO_DEVICE);
979 return rtrs_iu_post_rdma_write_imm(&con->c, req->iu, sge, num_sge,
980 rbuf->rkey, rbuf->addr, imm,
984 static int rtrs_clt_write_req(struct rtrs_clt_io_req *req)
986 struct rtrs_clt_con *con = req->con;
987 struct rtrs_sess *s = con->c.sess;
988 struct rtrs_clt_sess *sess = to_clt_sess(s);
989 struct rtrs_msg_rdma_write *msg;
991 struct rtrs_rbuf *rbuf;
995 const size_t tsize = sizeof(*msg) + req->data_len + req->usr_len;
997 if (unlikely(tsize > sess->chunk_size)) {
998 rtrs_wrn(s, "Write request failed, size too big %zu > %d\n",
999 tsize, sess->chunk_size);
1003 count = ib_dma_map_sg(sess->s.dev->ib_dev, req->sglist,
1004 req->sg_cnt, req->dir);
1005 if (unlikely(!count)) {
1006 rtrs_wrn(s, "Write request failed, map failed\n");
1010 /* put rtrs msg after sg and user message */
1011 msg = req->iu->buf + req->usr_len;
1012 msg->type = cpu_to_le16(RTRS_MSG_WRITE);
1013 msg->usr_len = cpu_to_le16(req->usr_len);
1015 /* rtrs message on server side will be after user data and message */
1016 imm = req->permit->mem_off + req->data_len + req->usr_len;
1017 imm = rtrs_to_io_req_imm(imm);
1018 buf_id = req->permit->mem_id;
1019 req->sg_size = tsize;
1020 rbuf = &sess->rbufs[buf_id];
1023 * Update stats now, after request is successfully sent it is not
1024 * safe anymore to touch it.
1026 rtrs_clt_update_all_stats(req, WRITE);
1028 ret = rtrs_post_rdma_write_sg(req->con, req, rbuf,
1029 req->usr_len + sizeof(*msg),
1031 if (unlikely(ret)) {
1032 rtrs_err(s, "Write request failed: %d\n", ret);
1033 if (sess->clt->mp_policy == MP_POLICY_MIN_INFLIGHT)
1034 atomic_dec(&sess->stats->inflight);
1036 ib_dma_unmap_sg(sess->s.dev->ib_dev, req->sglist,
1037 req->sg_cnt, req->dir);
1043 static int rtrs_map_sg_fr(struct rtrs_clt_io_req *req, size_t count)
1047 /* Align the MR to a 4K page size to match the block virt boundary */
1048 nr = ib_map_mr_sg(req->mr, req->sglist, count, NULL, SZ_4K);
1051 if (unlikely(nr < req->sg_cnt))
1053 ib_update_fast_reg_key(req->mr, ib_inc_rkey(req->mr->rkey));
1058 static int rtrs_clt_read_req(struct rtrs_clt_io_req *req)
1060 struct rtrs_clt_con *con = req->con;
1061 struct rtrs_sess *s = con->c.sess;
1062 struct rtrs_clt_sess *sess = to_clt_sess(s);
1063 struct rtrs_msg_rdma_read *msg;
1064 struct rtrs_ib_dev *dev;
1066 struct ib_reg_wr rwr;
1067 struct ib_send_wr *wr = NULL;
1072 const size_t tsize = sizeof(*msg) + req->data_len + req->usr_len;
1077 if (unlikely(tsize > sess->chunk_size)) {
1079 "Read request failed, message size is %zu, bigger than CHUNK_SIZE %d\n",
1080 tsize, sess->chunk_size);
1085 count = ib_dma_map_sg(dev->ib_dev, req->sglist, req->sg_cnt,
1087 if (unlikely(!count)) {
1089 "Read request failed, dma map failed\n");
1093 /* put our message into req->buf after user message*/
1094 msg = req->iu->buf + req->usr_len;
1095 msg->type = cpu_to_le16(RTRS_MSG_READ);
1096 msg->usr_len = cpu_to_le16(req->usr_len);
1099 ret = rtrs_map_sg_fr(req, count);
1102 "Read request failed, failed to map fast reg. data, err: %d\n",
1104 ib_dma_unmap_sg(dev->ib_dev, req->sglist, req->sg_cnt,
1108 rwr = (struct ib_reg_wr) {
1109 .wr.opcode = IB_WR_REG_MR,
1110 .wr.wr_cqe = &fast_reg_cqe,
1112 .key = req->mr->rkey,
1113 .access = (IB_ACCESS_LOCAL_WRITE |
1114 IB_ACCESS_REMOTE_WRITE),
1118 msg->sg_cnt = cpu_to_le16(1);
1119 msg->flags = cpu_to_le16(RTRS_MSG_NEED_INVAL_F);
1121 msg->desc[0].addr = cpu_to_le64(req->mr->iova);
1122 msg->desc[0].key = cpu_to_le32(req->mr->rkey);
1123 msg->desc[0].len = cpu_to_le32(req->mr->length);
1125 /* Further invalidation is required */
1126 req->need_inv = !!RTRS_MSG_NEED_INVAL_F;
1133 * rtrs message will be after the space reserved for disk data and
1136 imm = req->permit->mem_off + req->data_len + req->usr_len;
1137 imm = rtrs_to_io_req_imm(imm);
1138 buf_id = req->permit->mem_id;
1140 req->sg_size = sizeof(*msg);
1141 req->sg_size += le16_to_cpu(msg->sg_cnt) * sizeof(struct rtrs_sg_desc);
1142 req->sg_size += req->usr_len;
1145 * Update stats now, after request is successfully sent it is not
1146 * safe anymore to touch it.
1148 rtrs_clt_update_all_stats(req, READ);
1150 ret = rtrs_post_send_rdma(req->con, req, &sess->rbufs[buf_id],
1151 req->data_len, imm, wr);
1152 if (unlikely(ret)) {
1153 rtrs_err(s, "Read request failed: %d\n", ret);
1154 if (sess->clt->mp_policy == MP_POLICY_MIN_INFLIGHT)
1155 atomic_dec(&sess->stats->inflight);
1156 req->need_inv = false;
1158 ib_dma_unmap_sg(dev->ib_dev, req->sglist,
1159 req->sg_cnt, req->dir);
1166 * rtrs_clt_failover_req() Try to find an active path for a failed request
1168 * @fail_req: a failed io request.
1170 static int rtrs_clt_failover_req(struct rtrs_clt *clt,
1171 struct rtrs_clt_io_req *fail_req)
1173 struct rtrs_clt_sess *alive_sess;
1174 struct rtrs_clt_io_req *req;
1175 int err = -ECONNABORTED;
1179 for (path_it_init(&it, clt);
1180 (alive_sess = it.next_path(&it)) && it.i < it.clt->paths_num;
1182 if (unlikely(READ_ONCE(alive_sess->state) !=
1183 RTRS_CLT_CONNECTED))
1185 req = rtrs_clt_get_copy_req(alive_sess, fail_req);
1186 if (req->dir == DMA_TO_DEVICE)
1187 err = rtrs_clt_write_req(req);
1189 err = rtrs_clt_read_req(req);
1190 if (unlikely(err)) {
1191 req->in_use = false;
1195 rtrs_clt_inc_failover_cnt(alive_sess->stats);
1198 path_it_deinit(&it);
1204 static void fail_all_outstanding_reqs(struct rtrs_clt_sess *sess)
1206 struct rtrs_clt *clt = sess->clt;
1207 struct rtrs_clt_io_req *req;
1212 for (i = 0; i < sess->queue_depth; ++i) {
1213 req = &sess->reqs[i];
1218 * Safely (without notification) complete failed request.
1219 * After completion this request is still useble and can
1220 * be failovered to another path.
1222 complete_rdma_req(req, -ECONNABORTED, false, true);
1224 err = rtrs_clt_failover_req(clt, req);
1226 /* Failover failed, notify anyway */
1227 req->conf(req->priv, err);
1231 static void free_sess_reqs(struct rtrs_clt_sess *sess)
1233 struct rtrs_clt_io_req *req;
1238 for (i = 0; i < sess->queue_depth; ++i) {
1239 req = &sess->reqs[i];
1241 ib_dereg_mr(req->mr);
1243 rtrs_iu_free(req->iu, sess->s.dev->ib_dev, 1);
1249 static int alloc_sess_reqs(struct rtrs_clt_sess *sess)
1251 struct rtrs_clt_io_req *req;
1252 struct rtrs_clt *clt = sess->clt;
1253 int i, err = -ENOMEM;
1255 sess->reqs = kcalloc(sess->queue_depth, sizeof(*sess->reqs),
1260 for (i = 0; i < sess->queue_depth; ++i) {
1261 req = &sess->reqs[i];
1262 req->iu = rtrs_iu_alloc(1, sess->max_hdr_size, GFP_KERNEL,
1263 sess->s.dev->ib_dev,
1265 rtrs_clt_rdma_done);
1269 req->sge = kmalloc_array(clt->max_segments + 1,
1270 sizeof(*req->sge), GFP_KERNEL);
1274 req->mr = ib_alloc_mr(sess->s.dev->ib_pd, IB_MR_TYPE_MEM_REG,
1275 sess->max_pages_per_mr);
1276 if (IS_ERR(req->mr)) {
1277 err = PTR_ERR(req->mr);
1279 pr_err("Failed to alloc sess->max_pages_per_mr %d\n",
1280 sess->max_pages_per_mr);
1284 init_completion(&req->inv_comp);
1290 free_sess_reqs(sess);
1295 static int alloc_permits(struct rtrs_clt *clt)
1297 unsigned int chunk_bits;
1300 clt->permits_map = kcalloc(BITS_TO_LONGS(clt->queue_depth),
1301 sizeof(long), GFP_KERNEL);
1302 if (!clt->permits_map) {
1306 clt->permits = kcalloc(clt->queue_depth, permit_size(clt), GFP_KERNEL);
1307 if (!clt->permits) {
1311 chunk_bits = ilog2(clt->queue_depth - 1) + 1;
1312 for (i = 0; i < clt->queue_depth; i++) {
1313 struct rtrs_permit *permit;
1315 permit = get_permit(clt, i);
1317 permit->mem_off = i << (MAX_IMM_PAYL_BITS - chunk_bits);
1323 kfree(clt->permits_map);
1324 clt->permits_map = NULL;
1329 static void free_permits(struct rtrs_clt *clt)
1331 if (clt->permits_map) {
1332 size_t sz = clt->queue_depth;
1334 wait_event(clt->permits_wait,
1335 find_first_bit(clt->permits_map, sz) >= sz);
1337 kfree(clt->permits_map);
1338 clt->permits_map = NULL;
1339 kfree(clt->permits);
1340 clt->permits = NULL;
1343 static void query_fast_reg_mode(struct rtrs_clt_sess *sess)
1345 struct ib_device *ib_dev;
1346 u64 max_pages_per_mr;
1349 ib_dev = sess->s.dev->ib_dev;
1352 * Use the smallest page size supported by the HCA, down to a
1353 * minimum of 4096 bytes. We're unlikely to build large sglists
1354 * out of smaller entries.
1356 mr_page_shift = max(12, ffs(ib_dev->attrs.page_size_cap) - 1);
1357 max_pages_per_mr = ib_dev->attrs.max_mr_size;
1358 do_div(max_pages_per_mr, (1ull << mr_page_shift));
1359 sess->max_pages_per_mr =
1360 min3(sess->max_pages_per_mr, (u32)max_pages_per_mr,
1361 ib_dev->attrs.max_fast_reg_page_list_len);
1362 sess->max_send_sge = ib_dev->attrs.max_send_sge;
1365 static bool rtrs_clt_change_state_get_old(struct rtrs_clt_sess *sess,
1366 enum rtrs_clt_state new_state,
1367 enum rtrs_clt_state *old_state)
1371 spin_lock_irq(&sess->state_wq.lock);
1372 *old_state = sess->state;
1373 changed = __rtrs_clt_change_state(sess, new_state);
1374 spin_unlock_irq(&sess->state_wq.lock);
1379 static bool rtrs_clt_change_state(struct rtrs_clt_sess *sess,
1380 enum rtrs_clt_state new_state)
1382 enum rtrs_clt_state old_state;
1384 return rtrs_clt_change_state_get_old(sess, new_state, &old_state);
1387 static void rtrs_clt_hb_err_handler(struct rtrs_con *c)
1389 struct rtrs_clt_con *con = container_of(c, typeof(*con), c);
1391 rtrs_rdma_error_recovery(con);
1394 static void rtrs_clt_init_hb(struct rtrs_clt_sess *sess)
1396 rtrs_init_hb(&sess->s, &io_comp_cqe,
1397 RTRS_HB_INTERVAL_MS,
1399 rtrs_clt_hb_err_handler,
1403 static void rtrs_clt_start_hb(struct rtrs_clt_sess *sess)
1405 rtrs_start_hb(&sess->s);
1408 static void rtrs_clt_stop_hb(struct rtrs_clt_sess *sess)
1410 rtrs_stop_hb(&sess->s);
1413 static void rtrs_clt_reconnect_work(struct work_struct *work);
1414 static void rtrs_clt_close_work(struct work_struct *work);
1416 static struct rtrs_clt_sess *alloc_sess(struct rtrs_clt *clt,
1417 const struct rtrs_addr *path,
1418 size_t con_num, u16 max_segments,
1419 size_t max_segment_size)
1421 struct rtrs_clt_sess *sess;
1425 sess = kzalloc(sizeof(*sess), GFP_KERNEL);
1429 /* Extra connection for user messages */
1432 sess->s.con = kcalloc(con_num, sizeof(*sess->s.con), GFP_KERNEL);
1436 sess->stats = kzalloc(sizeof(*sess->stats), GFP_KERNEL);
1440 mutex_init(&sess->init_mutex);
1441 uuid_gen(&sess->s.uuid);
1442 memcpy(&sess->s.dst_addr, path->dst,
1443 rdma_addr_size((struct sockaddr *)path->dst));
1446 * rdma_resolve_addr() passes src_addr to cma_bind_addr, which
1447 * checks the sa_family to be non-zero. If user passed src_addr=NULL
1448 * the sess->src_addr will contain only zeros, which is then fine.
1451 memcpy(&sess->s.src_addr, path->src,
1452 rdma_addr_size((struct sockaddr *)path->src));
1453 strlcpy(sess->s.sessname, clt->sessname, sizeof(sess->s.sessname));
1454 sess->s.con_num = con_num;
1456 sess->max_pages_per_mr = max_segments * max_segment_size >> 12;
1457 init_waitqueue_head(&sess->state_wq);
1458 sess->state = RTRS_CLT_CONNECTING;
1459 atomic_set(&sess->connected_cnt, 0);
1460 INIT_WORK(&sess->close_work, rtrs_clt_close_work);
1461 INIT_DELAYED_WORK(&sess->reconnect_dwork, rtrs_clt_reconnect_work);
1462 rtrs_clt_init_hb(sess);
1464 sess->mp_skip_entry = alloc_percpu(typeof(*sess->mp_skip_entry));
1465 if (!sess->mp_skip_entry)
1466 goto err_free_stats;
1468 for_each_possible_cpu(cpu)
1469 INIT_LIST_HEAD(per_cpu_ptr(sess->mp_skip_entry, cpu));
1471 err = rtrs_clt_init_stats(sess->stats);
1473 goto err_free_percpu;
1478 free_percpu(sess->mp_skip_entry);
1486 return ERR_PTR(err);
1489 void free_sess(struct rtrs_clt_sess *sess)
1491 free_percpu(sess->mp_skip_entry);
1492 mutex_destroy(&sess->init_mutex);
1498 static int create_con(struct rtrs_clt_sess *sess, unsigned int cid)
1500 struct rtrs_clt_con *con;
1502 con = kzalloc(sizeof(*con), GFP_KERNEL);
1506 /* Map first two connections to the first CPU */
1507 con->cpu = (cid ? cid - 1 : 0) % nr_cpu_ids;
1509 con->c.sess = &sess->s;
1510 atomic_set(&con->io_cnt, 0);
1512 sess->s.con[cid] = &con->c;
1517 static void destroy_con(struct rtrs_clt_con *con)
1519 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
1521 sess->s.con[con->c.cid] = NULL;
1525 static int create_con_cq_qp(struct rtrs_clt_con *con)
1527 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
1528 u32 max_send_wr, max_recv_wr, cq_size;
1530 struct rtrs_msg_rkey_rsp *rsp;
1533 * This function can fail, but still destroy_con_cq_qp() should
1534 * be called, this is because create_con_cq_qp() is called on cm
1535 * event path, thus caller/waiter never knows: have we failed before
1536 * create_con_cq_qp() or after. To solve this dilemma without
1537 * creating any additional flags just allow destroy_con_cq_qp() be
1538 * called many times.
1541 if (con->c.cid == 0) {
1543 * One completion for each receive and two for each send
1544 * (send request + registration)
1545 * + 2 for drain and heartbeat
1546 * in case qp gets into error state
1548 max_send_wr = SERVICE_CON_QUEUE_DEPTH * 2 + 2;
1549 max_recv_wr = SERVICE_CON_QUEUE_DEPTH * 2 + 2;
1550 /* We must be the first here */
1551 if (WARN_ON(sess->s.dev))
1555 * The whole session uses device from user connection.
1556 * Be careful not to close user connection before ib dev
1557 * is gracefully put.
1559 sess->s.dev = rtrs_ib_dev_find_or_add(con->c.cm_id->device,
1563 "rtrs_ib_dev_find_get_or_add(): no memory\n");
1566 sess->s.dev_ref = 1;
1567 query_fast_reg_mode(sess);
1570 * Here we assume that session members are correctly set.
1571 * This is always true if user connection (cid == 0) is
1572 * established first.
1574 if (WARN_ON(!sess->s.dev))
1576 if (WARN_ON(!sess->queue_depth))
1579 /* Shared between connections */
1582 min_t(int, sess->s.dev->ib_dev->attrs.max_qp_wr,
1583 /* QD * (REQ + RSP + FR REGS or INVS) + drain */
1584 sess->queue_depth * 3 + 1);
1586 min_t(int, sess->s.dev->ib_dev->attrs.max_qp_wr,
1587 sess->queue_depth * 3 + 1);
1589 /* alloc iu to recv new rkey reply when server reports flags set */
1590 if (sess->flags & RTRS_MSG_NEW_RKEY_F || con->c.cid == 0) {
1591 con->rsp_ius = rtrs_iu_alloc(max_recv_wr, sizeof(*rsp),
1592 GFP_KERNEL, sess->s.dev->ib_dev,
1594 rtrs_clt_rdma_done);
1597 con->queue_size = max_recv_wr;
1599 cq_size = max_send_wr + max_recv_wr;
1600 cq_vector = con->cpu % sess->s.dev->ib_dev->num_comp_vectors;
1601 err = rtrs_cq_qp_create(&sess->s, &con->c, sess->max_send_sge,
1602 cq_vector, cq_size, max_send_wr,
1603 max_recv_wr, IB_POLL_SOFTIRQ);
1605 * In case of error we do not bother to clean previous allocations,
1606 * since destroy_con_cq_qp() must be called.
1611 static void destroy_con_cq_qp(struct rtrs_clt_con *con)
1613 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
1616 * Be careful here: destroy_con_cq_qp() can be called even
1617 * create_con_cq_qp() failed, see comments there.
1620 rtrs_cq_qp_destroy(&con->c);
1622 rtrs_iu_free(con->rsp_ius, sess->s.dev->ib_dev, con->queue_size);
1623 con->rsp_ius = NULL;
1624 con->queue_size = 0;
1626 if (sess->s.dev_ref && !--sess->s.dev_ref) {
1627 rtrs_ib_dev_put(sess->s.dev);
1632 static void stop_cm(struct rtrs_clt_con *con)
1634 rdma_disconnect(con->c.cm_id);
1636 ib_drain_qp(con->c.qp);
1639 static void destroy_cm(struct rtrs_clt_con *con)
1641 rdma_destroy_id(con->c.cm_id);
1642 con->c.cm_id = NULL;
1645 static int rtrs_rdma_addr_resolved(struct rtrs_clt_con *con)
1647 struct rtrs_sess *s = con->c.sess;
1650 err = create_con_cq_qp(con);
1652 rtrs_err(s, "create_con_cq_qp(), err: %d\n", err);
1655 err = rdma_resolve_route(con->c.cm_id, RTRS_CONNECT_TIMEOUT_MS);
1657 rtrs_err(s, "Resolving route failed, err: %d\n", err);
1662 static int rtrs_rdma_route_resolved(struct rtrs_clt_con *con)
1664 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
1665 struct rtrs_clt *clt = sess->clt;
1666 struct rtrs_msg_conn_req msg;
1667 struct rdma_conn_param param;
1671 param = (struct rdma_conn_param) {
1673 .rnr_retry_count = 7,
1674 .private_data = &msg,
1675 .private_data_len = sizeof(msg),
1678 msg = (struct rtrs_msg_conn_req) {
1679 .magic = cpu_to_le16(RTRS_MAGIC),
1680 .version = cpu_to_le16(RTRS_PROTO_VER),
1681 .cid = cpu_to_le16(con->c.cid),
1682 .cid_num = cpu_to_le16(sess->s.con_num),
1683 .recon_cnt = cpu_to_le16(sess->s.recon_cnt),
1685 msg.first_conn = sess->for_new_clt ? FIRST_CONN : 0;
1686 uuid_copy(&msg.sess_uuid, &sess->s.uuid);
1687 uuid_copy(&msg.paths_uuid, &clt->paths_uuid);
1689 err = rdma_connect_locked(con->c.cm_id, ¶m);
1691 rtrs_err(clt, "rdma_connect_locked(): %d\n", err);
1696 static int rtrs_rdma_conn_established(struct rtrs_clt_con *con,
1697 struct rdma_cm_event *ev)
1699 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
1700 struct rtrs_clt *clt = sess->clt;
1701 const struct rtrs_msg_conn_rsp *msg;
1702 u16 version, queue_depth;
1706 msg = ev->param.conn.private_data;
1707 len = ev->param.conn.private_data_len;
1708 if (len < sizeof(*msg)) {
1709 rtrs_err(clt, "Invalid RTRS connection response\n");
1712 if (le16_to_cpu(msg->magic) != RTRS_MAGIC) {
1713 rtrs_err(clt, "Invalid RTRS magic\n");
1716 version = le16_to_cpu(msg->version);
1717 if (version >> 8 != RTRS_PROTO_VER_MAJOR) {
1718 rtrs_err(clt, "Unsupported major RTRS version: %d, expected %d\n",
1719 version >> 8, RTRS_PROTO_VER_MAJOR);
1722 errno = le16_to_cpu(msg->errno);
1724 rtrs_err(clt, "Invalid RTRS message: errno %d\n",
1728 if (con->c.cid == 0) {
1729 queue_depth = le16_to_cpu(msg->queue_depth);
1731 if (sess->queue_depth > 0 && queue_depth != sess->queue_depth) {
1732 rtrs_err(clt, "Error: queue depth changed\n");
1735 * Stop any more reconnection attempts
1737 sess->reconnect_attempts = -1;
1739 "Disabling auto-reconnect. Trigger a manual reconnect after issue is resolved\n");
1745 sess->rbufs = kcalloc(queue_depth, sizeof(*sess->rbufs),
1750 sess->queue_depth = queue_depth;
1751 sess->max_hdr_size = le32_to_cpu(msg->max_hdr_size);
1752 sess->max_io_size = le32_to_cpu(msg->max_io_size);
1753 sess->flags = le32_to_cpu(msg->flags);
1754 sess->chunk_size = sess->max_io_size + sess->max_hdr_size;
1757 * Global IO size is always a minimum.
1758 * If while a reconnection server sends us a value a bit
1759 * higher - client does not care and uses cached minimum.
1761 * Since we can have several sessions (paths) restablishing
1762 * connections in parallel, use lock.
1764 mutex_lock(&clt->paths_mutex);
1765 clt->queue_depth = sess->queue_depth;
1766 clt->max_io_size = min_not_zero(sess->max_io_size,
1768 mutex_unlock(&clt->paths_mutex);
1771 * Cache the hca_port and hca_name for sysfs
1773 sess->hca_port = con->c.cm_id->port_num;
1774 scnprintf(sess->hca_name, sizeof(sess->hca_name),
1775 sess->s.dev->ib_dev->name);
1776 sess->s.src_addr = con->c.cm_id->route.addr.src_addr;
1777 /* set for_new_clt, to allow future reconnect on any path */
1778 sess->for_new_clt = 1;
1784 static inline void flag_success_on_conn(struct rtrs_clt_con *con)
1786 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
1788 atomic_inc(&sess->connected_cnt);
1792 static int rtrs_rdma_conn_rejected(struct rtrs_clt_con *con,
1793 struct rdma_cm_event *ev)
1795 struct rtrs_sess *s = con->c.sess;
1796 const struct rtrs_msg_conn_rsp *msg;
1797 const char *rej_msg;
1801 status = ev->status;
1802 rej_msg = rdma_reject_msg(con->c.cm_id, status);
1803 msg = rdma_consumer_reject_data(con->c.cm_id, ev, &data_len);
1805 if (msg && data_len >= sizeof(*msg)) {
1806 errno = (int16_t)le16_to_cpu(msg->errno);
1807 if (errno == -EBUSY)
1809 "Previous session is still exists on the server, please reconnect later\n");
1812 "Connect rejected: status %d (%s), rtrs errno %d\n",
1813 status, rej_msg, errno);
1816 "Connect rejected but with malformed message: status %d (%s)\n",
1823 static void rtrs_clt_close_conns(struct rtrs_clt_sess *sess, bool wait)
1825 if (rtrs_clt_change_state(sess, RTRS_CLT_CLOSING))
1826 queue_work(rtrs_wq, &sess->close_work);
1828 flush_work(&sess->close_work);
1831 static inline void flag_error_on_conn(struct rtrs_clt_con *con, int cm_err)
1833 if (con->cm_err == 1) {
1834 struct rtrs_clt_sess *sess;
1836 sess = to_clt_sess(con->c.sess);
1837 if (atomic_dec_and_test(&sess->connected_cnt))
1839 wake_up(&sess->state_wq);
1841 con->cm_err = cm_err;
1844 static int rtrs_clt_rdma_cm_handler(struct rdma_cm_id *cm_id,
1845 struct rdma_cm_event *ev)
1847 struct rtrs_clt_con *con = cm_id->context;
1848 struct rtrs_sess *s = con->c.sess;
1849 struct rtrs_clt_sess *sess = to_clt_sess(s);
1852 switch (ev->event) {
1853 case RDMA_CM_EVENT_ADDR_RESOLVED:
1854 cm_err = rtrs_rdma_addr_resolved(con);
1856 case RDMA_CM_EVENT_ROUTE_RESOLVED:
1857 cm_err = rtrs_rdma_route_resolved(con);
1859 case RDMA_CM_EVENT_ESTABLISHED:
1860 cm_err = rtrs_rdma_conn_established(con, ev);
1861 if (likely(!cm_err)) {
1863 * Report success and wake up. Here we abuse state_wq,
1864 * i.e. wake up without state change, but we set cm_err.
1866 flag_success_on_conn(con);
1867 wake_up(&sess->state_wq);
1871 case RDMA_CM_EVENT_REJECTED:
1872 cm_err = rtrs_rdma_conn_rejected(con, ev);
1874 case RDMA_CM_EVENT_CONNECT_ERROR:
1875 case RDMA_CM_EVENT_UNREACHABLE:
1876 rtrs_wrn(s, "CM error event %d\n", ev->event);
1877 cm_err = -ECONNRESET;
1879 case RDMA_CM_EVENT_ADDR_ERROR:
1880 case RDMA_CM_EVENT_ROUTE_ERROR:
1881 cm_err = -EHOSTUNREACH;
1883 case RDMA_CM_EVENT_DISCONNECTED:
1884 case RDMA_CM_EVENT_ADDR_CHANGE:
1885 case RDMA_CM_EVENT_TIMEWAIT_EXIT:
1886 cm_err = -ECONNRESET;
1888 case RDMA_CM_EVENT_DEVICE_REMOVAL:
1890 * Device removal is a special case. Queue close and return 0.
1892 rtrs_clt_close_conns(sess, false);
1895 rtrs_err(s, "Unexpected RDMA CM event (%d)\n", ev->event);
1896 cm_err = -ECONNRESET;
1902 * cm error makes sense only on connection establishing,
1903 * in other cases we rely on normal procedure of reconnecting.
1905 flag_error_on_conn(con, cm_err);
1906 rtrs_rdma_error_recovery(con);
1912 static int create_cm(struct rtrs_clt_con *con)
1914 struct rtrs_sess *s = con->c.sess;
1915 struct rtrs_clt_sess *sess = to_clt_sess(s);
1916 struct rdma_cm_id *cm_id;
1919 cm_id = rdma_create_id(&init_net, rtrs_clt_rdma_cm_handler, con,
1920 sess->s.dst_addr.ss_family == AF_IB ?
1921 RDMA_PS_IB : RDMA_PS_TCP, IB_QPT_RC);
1922 if (IS_ERR(cm_id)) {
1923 err = PTR_ERR(cm_id);
1924 rtrs_err(s, "Failed to create CM ID, err: %d\n", err);
1928 con->c.cm_id = cm_id;
1930 /* allow the port to be reused */
1931 err = rdma_set_reuseaddr(cm_id, 1);
1933 rtrs_err(s, "Set address reuse failed, err: %d\n", err);
1936 err = rdma_resolve_addr(cm_id, (struct sockaddr *)&sess->s.src_addr,
1937 (struct sockaddr *)&sess->s.dst_addr,
1938 RTRS_CONNECT_TIMEOUT_MS);
1940 rtrs_err(s, "Failed to resolve address, err: %d\n", err);
1944 * Combine connection status and session events. This is needed
1945 * for waiting two possible cases: cm_err has something meaningful
1946 * or session state was really changed to error by device removal.
1948 err = wait_event_interruptible_timeout(
1950 con->cm_err || sess->state != RTRS_CLT_CONNECTING,
1951 msecs_to_jiffies(RTRS_CONNECT_TIMEOUT_MS));
1952 if (err == 0 || err == -ERESTARTSYS) {
1955 /* Timedout or interrupted */
1958 if (con->cm_err < 0) {
1962 if (READ_ONCE(sess->state) != RTRS_CLT_CONNECTING) {
1963 /* Device removal */
1964 err = -ECONNABORTED;
1972 /* Is safe to call destroy if cq_qp is not inited */
1973 destroy_con_cq_qp(con);
1980 static void rtrs_clt_sess_up(struct rtrs_clt_sess *sess)
1982 struct rtrs_clt *clt = sess->clt;
1986 * We can fire RECONNECTED event only when all paths were
1987 * connected on rtrs_clt_open(), then each was disconnected
1988 * and the first one connected again. That's why this nasty
1989 * game with counter value.
1992 mutex_lock(&clt->paths_ev_mutex);
1993 up = ++clt->paths_up;
1995 * Here it is safe to access paths num directly since up counter
1996 * is greater than MAX_PATHS_NUM only while rtrs_clt_open() is
1997 * in progress, thus paths removals are impossible.
1999 if (up > MAX_PATHS_NUM && up == MAX_PATHS_NUM + clt->paths_num)
2000 clt->paths_up = clt->paths_num;
2002 clt->link_ev(clt->priv, RTRS_CLT_LINK_EV_RECONNECTED);
2003 mutex_unlock(&clt->paths_ev_mutex);
2005 /* Mark session as established */
2006 sess->established = true;
2007 sess->reconnect_attempts = 0;
2008 sess->stats->reconnects.successful_cnt++;
2011 static void rtrs_clt_sess_down(struct rtrs_clt_sess *sess)
2013 struct rtrs_clt *clt = sess->clt;
2015 if (!sess->established)
2018 sess->established = false;
2019 mutex_lock(&clt->paths_ev_mutex);
2020 WARN_ON(!clt->paths_up);
2021 if (--clt->paths_up == 0)
2022 clt->link_ev(clt->priv, RTRS_CLT_LINK_EV_DISCONNECTED);
2023 mutex_unlock(&clt->paths_ev_mutex);
2026 static void rtrs_clt_stop_and_destroy_conns(struct rtrs_clt_sess *sess)
2028 struct rtrs_clt_con *con;
2031 WARN_ON(READ_ONCE(sess->state) == RTRS_CLT_CONNECTED);
2034 * Possible race with rtrs_clt_open(), when DEVICE_REMOVAL comes
2035 * exactly in between. Start destroying after it finishes.
2037 mutex_lock(&sess->init_mutex);
2038 mutex_unlock(&sess->init_mutex);
2041 * All IO paths must observe !CONNECTED state before we
2046 rtrs_clt_stop_hb(sess);
2049 * The order it utterly crucial: firstly disconnect and complete all
2050 * rdma requests with error (thus set in_use=false for requests),
2051 * then fail outstanding requests checking in_use for each, and
2052 * eventually notify upper layer about session disconnection.
2055 for (cid = 0; cid < sess->s.con_num; cid++) {
2056 if (!sess->s.con[cid])
2058 con = to_clt_con(sess->s.con[cid]);
2061 fail_all_outstanding_reqs(sess);
2062 free_sess_reqs(sess);
2063 rtrs_clt_sess_down(sess);
2066 * Wait for graceful shutdown, namely when peer side invokes
2067 * rdma_disconnect(). 'connected_cnt' is decremented only on
2068 * CM events, thus if other side had crashed and hb has detected
2069 * something is wrong, here we will stuck for exactly timeout ms,
2070 * since CM does not fire anything. That is fine, we are not in
2073 wait_event_timeout(sess->state_wq, !atomic_read(&sess->connected_cnt),
2074 msecs_to_jiffies(RTRS_CONNECT_TIMEOUT_MS));
2076 for (cid = 0; cid < sess->s.con_num; cid++) {
2077 if (!sess->s.con[cid])
2079 con = to_clt_con(sess->s.con[cid]);
2080 destroy_con_cq_qp(con);
2086 static inline bool xchg_sessions(struct rtrs_clt_sess __rcu **rcu_ppcpu_path,
2087 struct rtrs_clt_sess *sess,
2088 struct rtrs_clt_sess *next)
2090 struct rtrs_clt_sess **ppcpu_path;
2092 /* Call cmpxchg() without sparse warnings */
2093 ppcpu_path = (typeof(ppcpu_path))rcu_ppcpu_path;
2094 return sess == cmpxchg(ppcpu_path, sess, next);
2097 static void rtrs_clt_remove_path_from_arr(struct rtrs_clt_sess *sess)
2099 struct rtrs_clt *clt = sess->clt;
2100 struct rtrs_clt_sess *next;
2101 bool wait_for_grace = false;
2104 mutex_lock(&clt->paths_mutex);
2105 list_del_rcu(&sess->s.entry);
2107 /* Make sure everybody observes path removal. */
2111 * At this point nobody sees @sess in the list, but still we have
2112 * dangling pointer @pcpu_path which _can_ point to @sess. Since
2113 * nobody can observe @sess in the list, we guarantee that IO path
2114 * will not assign @sess to @pcpu_path, i.e. @pcpu_path can be equal
2115 * to @sess, but can never again become @sess.
2119 * Decrement paths number only after grace period, because
2120 * caller of do_each_path() must firstly observe list without
2121 * path and only then decremented paths number.
2123 * Otherwise there can be the following situation:
2124 * o Two paths exist and IO is coming.
2125 * o One path is removed:
2127 * do_each_path(): rtrs_clt_remove_path_from_arr():
2128 * path = get_next_path()
2129 * ^^^ list_del_rcu(path)
2130 * [!CONNECTED path] clt->paths_num--
2132 * load clt->paths_num from 2 to 1
2136 * path is observed as !CONNECTED, but do_each_path() loop
2137 * ends, because expression i < clt->paths_num is false.
2142 * Get @next connection from current @sess which is going to be
2143 * removed. If @sess is the last element, then @next is NULL.
2146 next = list_next_or_null_rr_rcu(&clt->paths_list, &sess->s.entry,
2147 typeof(*next), s.entry);
2151 * @pcpu paths can still point to the path which is going to be
2152 * removed, so change the pointer manually.
2154 for_each_possible_cpu(cpu) {
2155 struct rtrs_clt_sess __rcu **ppcpu_path;
2157 ppcpu_path = per_cpu_ptr(clt->pcpu_path, cpu);
2158 if (rcu_dereference_protected(*ppcpu_path,
2159 lockdep_is_held(&clt->paths_mutex)) != sess)
2161 * synchronize_rcu() was called just after deleting
2162 * entry from the list, thus IO code path cannot
2163 * change pointer back to the pointer which is going
2164 * to be removed, we are safe here.
2169 * We race with IO code path, which also changes pointer,
2170 * thus we have to be careful not to overwrite it.
2172 if (xchg_sessions(ppcpu_path, sess, next))
2174 * @ppcpu_path was successfully replaced with @next,
2175 * that means that someone could also pick up the
2176 * @sess and dereferencing it right now, so wait for
2177 * a grace period is required.
2179 wait_for_grace = true;
2184 mutex_unlock(&clt->paths_mutex);
2187 static void rtrs_clt_add_path_to_arr(struct rtrs_clt_sess *sess,
2188 struct rtrs_addr *addr)
2190 struct rtrs_clt *clt = sess->clt;
2192 mutex_lock(&clt->paths_mutex);
2195 list_add_tail_rcu(&sess->s.entry, &clt->paths_list);
2196 mutex_unlock(&clt->paths_mutex);
2199 static void rtrs_clt_close_work(struct work_struct *work)
2201 struct rtrs_clt_sess *sess;
2203 sess = container_of(work, struct rtrs_clt_sess, close_work);
2205 cancel_delayed_work_sync(&sess->reconnect_dwork);
2206 rtrs_clt_stop_and_destroy_conns(sess);
2207 rtrs_clt_change_state(sess, RTRS_CLT_CLOSED);
2210 static int init_conns(struct rtrs_clt_sess *sess)
2216 * On every new session connections increase reconnect counter
2217 * to avoid clashes with previous sessions not yet closed
2218 * sessions on a server side.
2220 sess->s.recon_cnt++;
2222 /* Establish all RDMA connections */
2223 for (cid = 0; cid < sess->s.con_num; cid++) {
2224 err = create_con(sess, cid);
2228 err = create_cm(to_clt_con(sess->s.con[cid]));
2230 destroy_con(to_clt_con(sess->s.con[cid]));
2234 err = alloc_sess_reqs(sess);
2238 rtrs_clt_start_hb(sess);
2244 struct rtrs_clt_con *con = to_clt_con(sess->s.con[cid]);
2247 destroy_con_cq_qp(con);
2252 * If we've never taken async path and got an error, say,
2253 * doing rdma_resolve_addr(), switch to CONNECTION_ERR state
2254 * manually to keep reconnecting.
2256 rtrs_clt_change_state(sess, RTRS_CLT_CONNECTING_ERR);
2261 static void rtrs_clt_info_req_done(struct ib_cq *cq, struct ib_wc *wc)
2263 struct rtrs_clt_con *con = cq->cq_context;
2264 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
2267 iu = container_of(wc->wr_cqe, struct rtrs_iu, cqe);
2268 rtrs_iu_free(iu, sess->s.dev->ib_dev, 1);
2270 if (unlikely(wc->status != IB_WC_SUCCESS)) {
2271 rtrs_err(sess->clt, "Sess info request send failed: %s\n",
2272 ib_wc_status_msg(wc->status));
2273 rtrs_clt_change_state(sess, RTRS_CLT_CONNECTING_ERR);
2277 rtrs_clt_update_wc_stats(con);
2280 static int process_info_rsp(struct rtrs_clt_sess *sess,
2281 const struct rtrs_msg_info_rsp *msg)
2283 unsigned int sg_cnt, total_len;
2286 sg_cnt = le16_to_cpu(msg->sg_cnt);
2287 if (unlikely(!sg_cnt))
2290 * Check if IB immediate data size is enough to hold the mem_id and
2291 * the offset inside the memory chunk.
2293 if (unlikely((ilog2(sg_cnt - 1) + 1) +
2294 (ilog2(sess->chunk_size - 1) + 1) >
2295 MAX_IMM_PAYL_BITS)) {
2297 "RDMA immediate size (%db) not enough to encode %d buffers of size %dB\n",
2298 MAX_IMM_PAYL_BITS, sg_cnt, sess->chunk_size);
2301 if (unlikely(!sg_cnt || (sess->queue_depth % sg_cnt))) {
2302 rtrs_err(sess->clt, "Incorrect sg_cnt %d, is not multiple\n",
2307 for (sgi = 0, i = 0; sgi < sg_cnt && i < sess->queue_depth; sgi++) {
2308 const struct rtrs_sg_desc *desc = &msg->desc[sgi];
2312 addr = le64_to_cpu(desc->addr);
2313 rkey = le32_to_cpu(desc->key);
2314 len = le32_to_cpu(desc->len);
2318 if (unlikely(!len || (len % sess->chunk_size))) {
2319 rtrs_err(sess->clt, "Incorrect [%d].len %d\n", sgi,
2323 for ( ; len && i < sess->queue_depth; i++) {
2324 sess->rbufs[i].addr = addr;
2325 sess->rbufs[i].rkey = rkey;
2327 len -= sess->chunk_size;
2328 addr += sess->chunk_size;
2332 if (unlikely(sgi != sg_cnt || i != sess->queue_depth)) {
2333 rtrs_err(sess->clt, "Incorrect sg vector, not fully mapped\n");
2336 if (unlikely(total_len != sess->chunk_size * sess->queue_depth)) {
2337 rtrs_err(sess->clt, "Incorrect total_len %d\n", total_len);
2344 static void rtrs_clt_info_rsp_done(struct ib_cq *cq, struct ib_wc *wc)
2346 struct rtrs_clt_con *con = cq->cq_context;
2347 struct rtrs_clt_sess *sess = to_clt_sess(con->c.sess);
2348 struct rtrs_msg_info_rsp *msg;
2349 enum rtrs_clt_state state;
2354 state = RTRS_CLT_CONNECTING_ERR;
2356 WARN_ON(con->c.cid);
2357 iu = container_of(wc->wr_cqe, struct rtrs_iu, cqe);
2358 if (unlikely(wc->status != IB_WC_SUCCESS)) {
2359 rtrs_err(sess->clt, "Sess info response recv failed: %s\n",
2360 ib_wc_status_msg(wc->status));
2363 WARN_ON(wc->opcode != IB_WC_RECV);
2365 if (unlikely(wc->byte_len < sizeof(*msg))) {
2366 rtrs_err(sess->clt, "Sess info response is malformed: size %d\n",
2370 ib_dma_sync_single_for_cpu(sess->s.dev->ib_dev, iu->dma_addr,
2371 iu->size, DMA_FROM_DEVICE);
2373 if (unlikely(le16_to_cpu(msg->type) != RTRS_MSG_INFO_RSP)) {
2374 rtrs_err(sess->clt, "Sess info response is malformed: type %d\n",
2375 le16_to_cpu(msg->type));
2378 rx_sz = sizeof(*msg);
2379 rx_sz += sizeof(msg->desc[0]) * le16_to_cpu(msg->sg_cnt);
2380 if (unlikely(wc->byte_len < rx_sz)) {
2381 rtrs_err(sess->clt, "Sess info response is malformed: size %d\n",
2385 err = process_info_rsp(sess, msg);
2389 err = post_recv_sess(sess);
2393 state = RTRS_CLT_CONNECTED;
2396 rtrs_clt_update_wc_stats(con);
2397 rtrs_iu_free(iu, sess->s.dev->ib_dev, 1);
2398 rtrs_clt_change_state(sess, state);
2401 static int rtrs_send_sess_info(struct rtrs_clt_sess *sess)
2403 struct rtrs_clt_con *usr_con = to_clt_con(sess->s.con[0]);
2404 struct rtrs_msg_info_req *msg;
2405 struct rtrs_iu *tx_iu, *rx_iu;
2409 rx_sz = sizeof(struct rtrs_msg_info_rsp);
2410 rx_sz += sizeof(u64) * MAX_SESS_QUEUE_DEPTH;
2412 tx_iu = rtrs_iu_alloc(1, sizeof(struct rtrs_msg_info_req), GFP_KERNEL,
2413 sess->s.dev->ib_dev, DMA_TO_DEVICE,
2414 rtrs_clt_info_req_done);
2415 rx_iu = rtrs_iu_alloc(1, rx_sz, GFP_KERNEL, sess->s.dev->ib_dev,
2416 DMA_FROM_DEVICE, rtrs_clt_info_rsp_done);
2417 if (unlikely(!tx_iu || !rx_iu)) {
2421 /* Prepare for getting info response */
2422 err = rtrs_iu_post_recv(&usr_con->c, rx_iu);
2423 if (unlikely(err)) {
2424 rtrs_err(sess->clt, "rtrs_iu_post_recv(), err: %d\n", err);
2430 msg->type = cpu_to_le16(RTRS_MSG_INFO_REQ);
2431 memcpy(msg->sessname, sess->s.sessname, sizeof(msg->sessname));
2433 ib_dma_sync_single_for_device(sess->s.dev->ib_dev, tx_iu->dma_addr,
2434 tx_iu->size, DMA_TO_DEVICE);
2436 /* Send info request */
2437 err = rtrs_iu_post_send(&usr_con->c, tx_iu, sizeof(*msg), NULL);
2438 if (unlikely(err)) {
2439 rtrs_err(sess->clt, "rtrs_iu_post_send(), err: %d\n", err);
2444 /* Wait for state change */
2445 wait_event_interruptible_timeout(sess->state_wq,
2446 sess->state != RTRS_CLT_CONNECTING,
2448 RTRS_CONNECT_TIMEOUT_MS));
2449 if (unlikely(READ_ONCE(sess->state) != RTRS_CLT_CONNECTED)) {
2450 if (READ_ONCE(sess->state) == RTRS_CLT_CONNECTING_ERR)
2459 rtrs_iu_free(tx_iu, sess->s.dev->ib_dev, 1);
2461 rtrs_iu_free(rx_iu, sess->s.dev->ib_dev, 1);
2463 /* If we've never taken async path because of malloc problems */
2464 rtrs_clt_change_state(sess, RTRS_CLT_CONNECTING_ERR);
2470 * init_sess() - establishes all session connections and does handshake
2471 * @sess: client session.
2472 * In case of error full close or reconnect procedure should be taken,
2473 * because reconnect or close async works can be started.
2475 static int init_sess(struct rtrs_clt_sess *sess)
2479 mutex_lock(&sess->init_mutex);
2480 err = init_conns(sess);
2482 rtrs_err(sess->clt, "init_conns(), err: %d\n", err);
2485 err = rtrs_send_sess_info(sess);
2487 rtrs_err(sess->clt, "rtrs_send_sess_info(), err: %d\n", err);
2490 rtrs_clt_sess_up(sess);
2492 mutex_unlock(&sess->init_mutex);
2497 static void rtrs_clt_reconnect_work(struct work_struct *work)
2499 struct rtrs_clt_sess *sess;
2500 struct rtrs_clt *clt;
2501 unsigned int delay_ms;
2504 sess = container_of(to_delayed_work(work), struct rtrs_clt_sess,
2508 if (READ_ONCE(sess->state) != RTRS_CLT_RECONNECTING)
2511 if (sess->reconnect_attempts >= clt->max_reconnect_attempts) {
2512 /* Close a session completely if max attempts is reached */
2513 rtrs_clt_close_conns(sess, false);
2516 sess->reconnect_attempts++;
2518 /* Stop everything */
2519 rtrs_clt_stop_and_destroy_conns(sess);
2520 msleep(RTRS_RECONNECT_BACKOFF);
2521 if (rtrs_clt_change_state(sess, RTRS_CLT_CONNECTING)) {
2522 err = init_sess(sess);
2524 goto reconnect_again;
2530 if (rtrs_clt_change_state(sess, RTRS_CLT_RECONNECTING)) {
2531 sess->stats->reconnects.fail_cnt++;
2532 delay_ms = clt->reconnect_delay_sec * 1000;
2533 queue_delayed_work(rtrs_wq, &sess->reconnect_dwork,
2534 msecs_to_jiffies(delay_ms +
2536 RTRS_RECONNECT_SEED));
2540 static void rtrs_clt_dev_release(struct device *dev)
2542 struct rtrs_clt *clt = container_of(dev, struct rtrs_clt, dev);
2544 mutex_destroy(&clt->paths_ev_mutex);
2545 mutex_destroy(&clt->paths_mutex);
2549 static struct rtrs_clt *alloc_clt(const char *sessname, size_t paths_num,
2550 u16 port, size_t pdu_sz, void *priv,
2551 void (*link_ev)(void *priv,
2552 enum rtrs_clt_link_ev ev),
2553 unsigned int max_segments,
2554 size_t max_segment_size,
2555 unsigned int reconnect_delay_sec,
2556 unsigned int max_reconnect_attempts)
2558 struct rtrs_clt *clt;
2561 if (!paths_num || paths_num > MAX_PATHS_NUM)
2562 return ERR_PTR(-EINVAL);
2564 if (strlen(sessname) >= sizeof(clt->sessname))
2565 return ERR_PTR(-EINVAL);
2567 clt = kzalloc(sizeof(*clt), GFP_KERNEL);
2569 return ERR_PTR(-ENOMEM);
2571 clt->pcpu_path = alloc_percpu(typeof(*clt->pcpu_path));
2572 if (!clt->pcpu_path) {
2574 return ERR_PTR(-ENOMEM);
2577 clt->dev.class = rtrs_clt_dev_class;
2578 clt->dev.release = rtrs_clt_dev_release;
2579 uuid_gen(&clt->paths_uuid);
2580 INIT_LIST_HEAD_RCU(&clt->paths_list);
2581 clt->paths_num = paths_num;
2582 clt->paths_up = MAX_PATHS_NUM;
2584 clt->pdu_sz = pdu_sz;
2585 clt->max_segments = max_segments;
2586 clt->max_segment_size = max_segment_size;
2587 clt->reconnect_delay_sec = reconnect_delay_sec;
2588 clt->max_reconnect_attempts = max_reconnect_attempts;
2590 clt->link_ev = link_ev;
2591 clt->mp_policy = MP_POLICY_MIN_INFLIGHT;
2592 strlcpy(clt->sessname, sessname, sizeof(clt->sessname));
2593 init_waitqueue_head(&clt->permits_wait);
2594 mutex_init(&clt->paths_ev_mutex);
2595 mutex_init(&clt->paths_mutex);
2596 device_initialize(&clt->dev);
2598 err = dev_set_name(&clt->dev, "%s", sessname);
2603 * Suppress user space notification until
2604 * sysfs files are created
2606 dev_set_uevent_suppress(&clt->dev, true);
2607 err = device_add(&clt->dev);
2611 clt->kobj_paths = kobject_create_and_add("paths", &clt->dev.kobj);
2612 if (!clt->kobj_paths) {
2616 err = rtrs_clt_create_sysfs_root_files(clt);
2618 kobject_del(clt->kobj_paths);
2619 kobject_put(clt->kobj_paths);
2622 dev_set_uevent_suppress(&clt->dev, false);
2623 kobject_uevent(&clt->dev.kobj, KOBJ_ADD);
2627 device_del(&clt->dev);
2629 free_percpu(clt->pcpu_path);
2630 put_device(&clt->dev);
2631 return ERR_PTR(err);
2634 static void free_clt(struct rtrs_clt *clt)
2636 free_percpu(clt->pcpu_path);
2639 * release callback will free clt and destroy mutexes in last put
2641 device_unregister(&clt->dev);
2645 * rtrs_clt_open() - Open a session to an RTRS server
2646 * @ops: holds the link event callback and the private pointer.
2647 * @sessname: name of the session
2648 * @paths: Paths to be established defined by their src and dst addresses
2649 * @paths_num: Number of elements in the @paths array
2650 * @port: port to be used by the RTRS session
2651 * @pdu_sz: Size of extra payload which can be accessed after permit allocation.
2652 * @reconnect_delay_sec: time between reconnect tries
2653 * @max_segments: Max. number of segments per IO request
2654 * @max_segment_size: Max. size of one segment
2655 * @max_reconnect_attempts: Number of times to reconnect on error before giving
2656 * up, 0 for * disabled, -1 for forever
2658 * Starts session establishment with the rtrs_server. The function can block
2659 * up to ~2000ms before it returns.
2661 * Return a valid pointer on success otherwise PTR_ERR.
2663 struct rtrs_clt *rtrs_clt_open(struct rtrs_clt_ops *ops,
2664 const char *sessname,
2665 const struct rtrs_addr *paths,
2666 size_t paths_num, u16 port,
2667 size_t pdu_sz, u8 reconnect_delay_sec,
2669 size_t max_segment_size,
2670 s16 max_reconnect_attempts)
2672 struct rtrs_clt_sess *sess, *tmp;
2673 struct rtrs_clt *clt;
2676 clt = alloc_clt(sessname, paths_num, port, pdu_sz, ops->priv,
2678 max_segments, max_segment_size, reconnect_delay_sec,
2679 max_reconnect_attempts);
2684 for (i = 0; i < paths_num; i++) {
2685 struct rtrs_clt_sess *sess;
2687 sess = alloc_sess(clt, &paths[i], nr_cpu_ids,
2688 max_segments, max_segment_size);
2690 err = PTR_ERR(sess);
2691 goto close_all_sess;
2694 sess->for_new_clt = 1;
2695 list_add_tail_rcu(&sess->s.entry, &clt->paths_list);
2697 err = init_sess(sess);
2699 list_del_rcu(&sess->s.entry);
2700 rtrs_clt_close_conns(sess, true);
2701 free_percpu(sess->stats->pcpu_stats);
2704 goto close_all_sess;
2707 err = rtrs_clt_create_sess_files(sess);
2709 list_del_rcu(&sess->s.entry);
2710 rtrs_clt_close_conns(sess, true);
2711 free_percpu(sess->stats->pcpu_stats);
2714 goto close_all_sess;
2717 err = alloc_permits(clt);
2719 goto close_all_sess;
2724 list_for_each_entry_safe(sess, tmp, &clt->paths_list, s.entry) {
2725 rtrs_clt_destroy_sess_files(sess, NULL);
2726 rtrs_clt_close_conns(sess, true);
2727 kobject_put(&sess->kobj);
2729 rtrs_clt_destroy_sysfs_root_files(clt);
2730 rtrs_clt_destroy_sysfs_root_folders(clt);
2734 return ERR_PTR(err);
2736 EXPORT_SYMBOL(rtrs_clt_open);
2739 * rtrs_clt_close() - Close a session
2740 * @clt: Session handle. Session is freed upon return.
2742 void rtrs_clt_close(struct rtrs_clt *clt)
2744 struct rtrs_clt_sess *sess, *tmp;
2746 /* Firstly forbid sysfs access */
2747 rtrs_clt_destroy_sysfs_root_files(clt);
2748 rtrs_clt_destroy_sysfs_root_folders(clt);
2750 /* Now it is safe to iterate over all paths without locks */
2751 list_for_each_entry_safe(sess, tmp, &clt->paths_list, s.entry) {
2752 rtrs_clt_close_conns(sess, true);
2753 rtrs_clt_destroy_sess_files(sess, NULL);
2754 kobject_put(&sess->kobj);
2759 EXPORT_SYMBOL(rtrs_clt_close);
2761 int rtrs_clt_reconnect_from_sysfs(struct rtrs_clt_sess *sess)
2763 enum rtrs_clt_state old_state;
2767 changed = rtrs_clt_change_state_get_old(sess, RTRS_CLT_RECONNECTING,
2770 sess->reconnect_attempts = 0;
2771 queue_delayed_work(rtrs_wq, &sess->reconnect_dwork, 0);
2773 if (changed || old_state == RTRS_CLT_RECONNECTING) {
2775 * flush_delayed_work() queues pending work for immediate
2776 * execution, so do the flush if we have queued something
2777 * right now or work is pending.
2779 flush_delayed_work(&sess->reconnect_dwork);
2780 err = (READ_ONCE(sess->state) ==
2781 RTRS_CLT_CONNECTED ? 0 : -ENOTCONN);
2787 int rtrs_clt_disconnect_from_sysfs(struct rtrs_clt_sess *sess)
2789 rtrs_clt_close_conns(sess, true);
2794 int rtrs_clt_remove_path_from_sysfs(struct rtrs_clt_sess *sess,
2795 const struct attribute *sysfs_self)
2797 enum rtrs_clt_state old_state;
2801 * Continue stopping path till state was changed to DEAD or
2802 * state was observed as DEAD:
2803 * 1. State was changed to DEAD - we were fast and nobody
2804 * invoked rtrs_clt_reconnect(), which can again start
2806 * 2. State was observed as DEAD - we have someone in parallel
2807 * removing the path.
2810 rtrs_clt_close_conns(sess, true);
2811 changed = rtrs_clt_change_state_get_old(sess,
2814 } while (!changed && old_state != RTRS_CLT_DEAD);
2816 if (likely(changed)) {
2817 rtrs_clt_remove_path_from_arr(sess);
2818 rtrs_clt_destroy_sess_files(sess, sysfs_self);
2819 kobject_put(&sess->kobj);
2825 void rtrs_clt_set_max_reconnect_attempts(struct rtrs_clt *clt, int value)
2827 clt->max_reconnect_attempts = (unsigned int)value;
2830 int rtrs_clt_get_max_reconnect_attempts(const struct rtrs_clt *clt)
2832 return (int)clt->max_reconnect_attempts;
2836 * rtrs_clt_request() - Request data transfer to/from server via RDMA.
2839 * @ops: callback function to be called as confirmation, and the pointer.
2841 * @permit: Preallocated permit
2842 * @vec: Message that is sent to server together with the request.
2843 * Sum of len of all @vec elements limited to <= IO_MSG_SIZE.
2844 * Since the msg is copied internally it can be allocated on stack.
2845 * @nr: Number of elements in @vec.
2846 * @data_len: length of data sent to/from server
2847 * @sg: Pages to be sent/received to/from server.
2848 * @sg_cnt: Number of elements in the @sg
2854 * On dir=READ rtrs client will request a data transfer from Server to client.
2855 * The data that the server will respond with will be stored in @sg when
2856 * the user receives an %RTRS_CLT_RDMA_EV_RDMA_REQUEST_WRITE_COMPL event.
2857 * On dir=WRITE rtrs client will rdma write data in sg to server side.
2859 int rtrs_clt_request(int dir, struct rtrs_clt_req_ops *ops,
2860 struct rtrs_clt *clt, struct rtrs_permit *permit,
2861 const struct kvec *vec, size_t nr, size_t data_len,
2862 struct scatterlist *sg, unsigned int sg_cnt)
2864 struct rtrs_clt_io_req *req;
2865 struct rtrs_clt_sess *sess;
2867 enum dma_data_direction dma_dir;
2868 int err = -ECONNABORTED, i;
2869 size_t usr_len, hdr_len;
2872 /* Get kvec length */
2873 for (i = 0, usr_len = 0; i < nr; i++)
2874 usr_len += vec[i].iov_len;
2877 hdr_len = sizeof(struct rtrs_msg_rdma_read) +
2878 sg_cnt * sizeof(struct rtrs_sg_desc);
2879 dma_dir = DMA_FROM_DEVICE;
2881 hdr_len = sizeof(struct rtrs_msg_rdma_write);
2882 dma_dir = DMA_TO_DEVICE;
2886 for (path_it_init(&it, clt);
2887 (sess = it.next_path(&it)) && it.i < it.clt->paths_num; it.i++) {
2888 if (unlikely(READ_ONCE(sess->state) != RTRS_CLT_CONNECTED))
2891 if (unlikely(usr_len + hdr_len > sess->max_hdr_size)) {
2892 rtrs_wrn_rl(sess->clt,
2893 "%s request failed, user message size is %zu and header length %zu, but max size is %u\n",
2894 dir == READ ? "Read" : "Write",
2895 usr_len, hdr_len, sess->max_hdr_size);
2899 req = rtrs_clt_get_req(sess, ops->conf_fn, permit, ops->priv,
2900 vec, usr_len, sg, sg_cnt, data_len,
2903 err = rtrs_clt_read_req(req);
2905 err = rtrs_clt_write_req(req);
2906 if (unlikely(err)) {
2907 req->in_use = false;
2913 path_it_deinit(&it);
2918 EXPORT_SYMBOL(rtrs_clt_request);
2921 * rtrs_clt_query() - queries RTRS session attributes
2922 *@clt: session pointer
2923 *@attr: query results for session attributes.
2926 * -ECOMM no connection to the server
2928 int rtrs_clt_query(struct rtrs_clt *clt, struct rtrs_attrs *attr)
2930 if (!rtrs_clt_is_connected(clt))
2933 attr->queue_depth = clt->queue_depth;
2934 attr->max_io_size = clt->max_io_size;
2935 attr->sess_kobj = &clt->dev.kobj;
2936 strlcpy(attr->sessname, clt->sessname, sizeof(attr->sessname));
2940 EXPORT_SYMBOL(rtrs_clt_query);
2942 int rtrs_clt_create_path_from_sysfs(struct rtrs_clt *clt,
2943 struct rtrs_addr *addr)
2945 struct rtrs_clt_sess *sess;
2948 sess = alloc_sess(clt, addr, nr_cpu_ids, clt->max_segments,
2949 clt->max_segment_size);
2951 return PTR_ERR(sess);
2954 * It is totally safe to add path in CONNECTING state: coming
2955 * IO will never grab it. Also it is very important to add
2956 * path before init, since init fires LINK_CONNECTED event.
2958 rtrs_clt_add_path_to_arr(sess, addr);
2960 err = init_sess(sess);
2964 err = rtrs_clt_create_sess_files(sess);
2971 rtrs_clt_remove_path_from_arr(sess);
2972 rtrs_clt_close_conns(sess, true);
2973 free_percpu(sess->stats->pcpu_stats);
2980 static int rtrs_clt_ib_dev_init(struct rtrs_ib_dev *dev)
2982 if (!(dev->ib_dev->attrs.device_cap_flags &
2983 IB_DEVICE_MEM_MGT_EXTENSIONS)) {
2984 pr_err("Memory registrations not supported.\n");
2991 static const struct rtrs_rdma_dev_pd_ops dev_pd_ops = {
2992 .init = rtrs_clt_ib_dev_init
2995 static int __init rtrs_client_init(void)
2997 rtrs_rdma_dev_pd_init(0, &dev_pd);
2999 rtrs_clt_dev_class = class_create(THIS_MODULE, "rtrs-client");
3000 if (IS_ERR(rtrs_clt_dev_class)) {
3001 pr_err("Failed to create rtrs-client dev class\n");
3002 return PTR_ERR(rtrs_clt_dev_class);
3004 rtrs_wq = alloc_workqueue("rtrs_client_wq", 0, 0);
3006 class_destroy(rtrs_clt_dev_class);
3013 static void __exit rtrs_client_exit(void)
3015 destroy_workqueue(rtrs_wq);
3016 class_destroy(rtrs_clt_dev_class);
3017 rtrs_rdma_dev_pd_deinit(&dev_pd);
3020 module_init(rtrs_client_init);
3021 module_exit(rtrs_client_exit);