3 * Copyright (c) 2015, Mellanox Technologies, Inc. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 SYSCTL_NODE(_kern, OID_AUTO, iser, CTLFLAG_RW, 0, "iSER module");
31 SYSCTL_INT(_kern_iser, OID_AUTO, debug, CTLFLAG_RWTUN,
32 &iser_debug, 0, "Enable iser debug messages");
34 static MALLOC_DEFINE(M_ICL_ISER, "icl_iser", "iSCSI iser backend");
35 static uma_zone_t icl_pdu_zone;
37 static volatile u_int icl_iser_ncons;
38 struct iser_global ig;
40 static void iser_conn_release(struct icl_conn *ic);
42 static icl_conn_new_pdu_t iser_conn_new_pdu;
43 static icl_conn_pdu_free_t iser_conn_pdu_free;
44 static icl_conn_pdu_data_segment_length_t iser_conn_pdu_data_segment_length;
45 static icl_conn_pdu_append_data_t iser_conn_pdu_append_data;
46 static icl_conn_pdu_queue_t iser_conn_pdu_queue;
47 static icl_conn_handoff_t iser_conn_handoff;
48 static icl_conn_free_t iser_conn_free;
49 static icl_conn_close_t iser_conn_close;
50 static icl_conn_connect_t iser_conn_connect;
51 static icl_conn_task_setup_t iser_conn_task_setup;
52 static icl_conn_task_done_t iser_conn_task_done;
53 static icl_conn_pdu_get_data_t iser_conn_pdu_get_data;
55 static kobj_method_t icl_iser_methods[] = {
56 KOBJMETHOD(icl_conn_new_pdu, iser_conn_new_pdu),
57 KOBJMETHOD(icl_conn_pdu_free, iser_conn_pdu_free),
58 KOBJMETHOD(icl_conn_pdu_data_segment_length, iser_conn_pdu_data_segment_length),
59 KOBJMETHOD(icl_conn_pdu_append_data, iser_conn_pdu_append_data),
60 KOBJMETHOD(icl_conn_pdu_queue, iser_conn_pdu_queue),
61 KOBJMETHOD(icl_conn_handoff, iser_conn_handoff),
62 KOBJMETHOD(icl_conn_free, iser_conn_free),
63 KOBJMETHOD(icl_conn_close, iser_conn_close),
64 KOBJMETHOD(icl_conn_connect, iser_conn_connect),
65 KOBJMETHOD(icl_conn_task_setup, iser_conn_task_setup),
66 KOBJMETHOD(icl_conn_task_done, iser_conn_task_done),
67 KOBJMETHOD(icl_conn_pdu_get_data, iser_conn_pdu_get_data),
71 DEFINE_CLASS(icl_iser, icl_iser_methods, sizeof(struct iser_conn));
74 * iser_initialize_headers() - Initialize task headers
76 * @iser_conn: iser connection
79 * This routine may race with iser teardown flow for scsi
80 * error handling TMFs. So for TMF we should acquire the
81 * state mutex to avoid dereferencing the IB device which
82 * may have already been terminated (racing teardown sequence).
85 iser_initialize_headers(struct icl_iser_pdu *pdu, struct iser_conn *iser_conn)
87 struct iser_tx_desc *tx_desc = &pdu->desc;
88 struct iser_device *device = iser_conn->ib_conn.device;
92 dma_addr = ib_dma_map_single(device->ib_device, (void *)tx_desc,
93 ISER_HEADERS_LEN, DMA_TO_DEVICE);
94 if (ib_dma_mapping_error(device->ib_device, dma_addr)) {
99 tx_desc->mapped = true;
100 tx_desc->dma_addr = dma_addr;
101 tx_desc->tx_sg[0].addr = tx_desc->dma_addr;
102 tx_desc->tx_sg[0].length = ISER_HEADERS_LEN;
103 tx_desc->tx_sg[0].lkey = device->mr->lkey;
111 iser_conn_pdu_append_data(struct icl_conn *ic, struct icl_pdu *request,
112 const void *addr, size_t len, int flags)
114 struct iser_conn *iser_conn = icl_to_iser_conn(ic);
116 if (request->ip_bhs->bhs_opcode & ISCSI_BHS_OPCODE_LOGIN_REQUEST ||
117 request->ip_bhs->bhs_opcode & ISCSI_BHS_OPCODE_TEXT_REQUEST) {
118 ISER_DBG("copy to login buff");
119 memcpy(iser_conn->login_req_buf, addr, len);
120 request->ip_data_len = len;
127 iser_conn_pdu_get_data(struct icl_conn *ic, struct icl_pdu *ip,
128 size_t off, void *addr, size_t len)
130 /* If we have a receive data, copy it to upper layer buffer */
131 if (ip->ip_data_mbuf)
132 memcpy(addr, ip->ip_data_mbuf + off, len);
136 * Allocate icl_pdu with empty BHS to fill up by the caller.
139 iser_new_pdu(struct icl_conn *ic, int flags)
141 struct icl_iser_pdu *iser_pdu;
143 struct iser_conn *iser_conn = icl_to_iser_conn(ic);
145 iser_pdu = uma_zalloc(icl_pdu_zone, flags | M_ZERO);
146 if (iser_pdu == NULL) {
147 ISER_WARN("failed to allocate %zd bytes", sizeof(*iser_pdu));
151 iser_pdu->iser_conn = iser_conn;
152 ip = &iser_pdu->icl_pdu;
154 ip->ip_bhs = &iser_pdu->desc.iscsi_header;
160 iser_conn_new_pdu(struct icl_conn *ic, int flags)
162 return (iser_new_pdu(ic, flags));
166 iser_pdu_free(struct icl_conn *ic, struct icl_pdu *ip)
168 struct icl_iser_pdu *iser_pdu = icl_to_iser_pdu(ip);
170 uma_zfree(icl_pdu_zone, iser_pdu);
174 iser_conn_pdu_data_segment_length(struct icl_conn *ic,
175 const struct icl_pdu *request)
179 len += request->ip_bhs->bhs_data_segment_len[0];
181 len += request->ip_bhs->bhs_data_segment_len[1];
183 len += request->ip_bhs->bhs_data_segment_len[2];
189 iser_conn_pdu_free(struct icl_conn *ic, struct icl_pdu *ip)
191 iser_pdu_free(ic, ip);
195 is_control_opcode(uint8_t opcode)
197 bool is_control = false;
199 switch (opcode & ISCSI_OPCODE_MASK) {
200 case ISCSI_BHS_OPCODE_NOP_OUT:
201 case ISCSI_BHS_OPCODE_LOGIN_REQUEST:
202 case ISCSI_BHS_OPCODE_LOGOUT_REQUEST:
203 case ISCSI_BHS_OPCODE_TEXT_REQUEST:
206 case ISCSI_BHS_OPCODE_SCSI_COMMAND:
210 ISER_ERR("unknown opcode %d", opcode);
217 iser_conn_pdu_queue(struct icl_conn *ic, struct icl_pdu *ip)
219 struct iser_conn *iser_conn = icl_to_iser_conn(ic);
220 struct icl_iser_pdu *iser_pdu = icl_to_iser_pdu(ip);
223 if (iser_conn->state != ISER_CONN_UP)
226 ret = iser_initialize_headers(iser_pdu, iser_conn);
228 ISER_ERR("Failed to map TX descriptor pdu %p", iser_pdu);
232 if (is_control_opcode(ip->ip_bhs->bhs_opcode)) {
233 ret = iser_send_control(iser_conn, iser_pdu);
235 ISER_ERR("Failed to send control pdu %p", iser_pdu);
237 ret = iser_send_command(iser_conn, iser_pdu);
239 ISER_ERR("Failed to send command pdu %p", iser_pdu);
243 static struct icl_conn *
244 iser_new_conn(const char *name, struct mtx *lock)
246 struct iser_conn *iser_conn;
249 refcount_acquire(&icl_iser_ncons);
251 iser_conn = (struct iser_conn *)kobj_create(&icl_iser_class, M_ICL_ISER, M_WAITOK | M_ZERO);
253 ISER_ERR("failed to allocate iser conn");
254 refcount_release(&icl_iser_ncons);
258 cv_init(&iser_conn->up_cv, "iser_cv");
259 sx_init(&iser_conn->state_mutex, "iser_conn_state_mutex");
260 mtx_init(&iser_conn->ib_conn.beacon.flush_lock, "iser_flush_lock", NULL, MTX_DEF);
261 cv_init(&iser_conn->ib_conn.beacon.flush_cv, "flush_cv");
262 mtx_init(&iser_conn->ib_conn.lock, "iser_lock", NULL, MTX_DEF);
264 ic = &iser_conn->icl_conn;
267 ic->ic_offload = strdup("iser", M_TEMP);
269 ic->ic_unmapped = true;
275 iser_conn_free(struct icl_conn *ic)
277 struct iser_conn *iser_conn = icl_to_iser_conn(ic);
279 iser_conn_release(ic);
280 mtx_destroy(&iser_conn->ib_conn.lock);
281 cv_destroy(&iser_conn->ib_conn.beacon.flush_cv);
282 mtx_destroy(&iser_conn->ib_conn.beacon.flush_lock);
283 sx_destroy(&iser_conn->state_mutex);
284 cv_destroy(&iser_conn->up_cv);
285 kobj_delete((struct kobj *)iser_conn, M_ICL_ISER);
286 refcount_release(&icl_iser_ncons);
290 iser_conn_handoff(struct icl_conn *ic, int fd)
292 struct iser_conn *iser_conn = icl_to_iser_conn(ic);
295 sx_xlock(&iser_conn->state_mutex);
296 if (iser_conn->state != ISER_CONN_UP) {
298 ISER_ERR("iser_conn %p state is %d, teardown started\n",
299 iser_conn, iser_conn->state);
303 error = iser_alloc_rx_descriptors(iser_conn, ic->ic_maxtags);
307 error = iser_post_recvm(iser_conn, iser_conn->min_posted_rx);
311 iser_conn->handoff_done = true;
313 sx_xunlock(&iser_conn->state_mutex);
317 iser_free_rx_descriptors(iser_conn);
319 sx_xunlock(&iser_conn->state_mutex);
325 * Frees all conn objects
328 iser_conn_release(struct icl_conn *ic)
330 struct iser_conn *iser_conn = icl_to_iser_conn(ic);
331 struct ib_conn *ib_conn = &iser_conn->ib_conn;
332 struct iser_conn *curr, *tmp;
334 mtx_lock(&ig.connlist_mutex);
336 * Search for iser connection in global list.
337 * It may not be there in case of failure in connection establishment
340 list_for_each_entry_safe(curr, tmp, &ig.connlist, conn_list) {
341 if (iser_conn == curr) {
342 ISER_WARN("found iser_conn %p", iser_conn);
343 list_del(&iser_conn->conn_list);
346 mtx_unlock(&ig.connlist_mutex);
349 * In case we reconnecting or removing session, we need to
350 * release IB resources (which is safe to call more than once).
352 sx_xlock(&iser_conn->state_mutex);
353 iser_free_ib_conn_res(iser_conn, true);
354 sx_xunlock(&iser_conn->state_mutex);
356 if (ib_conn->cma_id != NULL) {
357 rdma_destroy_id(ib_conn->cma_id);
358 ib_conn->cma_id = NULL;
364 iser_conn_close(struct icl_conn *ic)
366 struct iser_conn *iser_conn = icl_to_iser_conn(ic);
368 ISER_INFO("closing conn %p", iser_conn);
370 sx_xlock(&iser_conn->state_mutex);
372 * In case iser connection is waiting on conditional variable
373 * (state PENDING) and we try to close it before connection establishment,
374 * we need to signal it to continue releasing connection properly.
376 if (!iser_conn_terminate(iser_conn) && iser_conn->state == ISER_CONN_PENDING)
377 cv_signal(&iser_conn->up_cv);
378 sx_xunlock(&iser_conn->state_mutex);
383 iser_conn_connect(struct icl_conn *ic, int domain, int socktype,
384 int protocol, struct sockaddr *from_sa, struct sockaddr *to_sa)
386 struct iser_conn *iser_conn = icl_to_iser_conn(ic);
387 struct ib_conn *ib_conn = &iser_conn->ib_conn;
390 iser_conn_release(ic);
392 sx_xlock(&iser_conn->state_mutex);
393 /* the device is known only --after-- address resolution */
394 ib_conn->device = NULL;
395 iser_conn->handoff_done = false;
397 iser_conn->state = ISER_CONN_PENDING;
399 ib_conn->cma_id = rdma_create_id(&init_net, iser_cma_handler, (void *)iser_conn,
400 RDMA_PS_TCP, IB_QPT_RC);
401 if (IS_ERR(ib_conn->cma_id)) {
402 err = -PTR_ERR(ib_conn->cma_id);
403 ISER_ERR("rdma_create_id failed: %d", err);
407 err = rdma_resolve_addr(ib_conn->cma_id, from_sa, to_sa, 1000);
409 ISER_ERR("rdma_resolve_addr failed: %d", err);
415 ISER_DBG("before cv_wait: %p", iser_conn);
416 cv_wait(&iser_conn->up_cv, &iser_conn->state_mutex);
417 ISER_DBG("after cv_wait: %p", iser_conn);
419 if (iser_conn->state != ISER_CONN_UP) {
424 err = iser_alloc_login_buf(iser_conn);
427 sx_xunlock(&iser_conn->state_mutex);
429 mtx_lock(&ig.connlist_mutex);
430 list_add(&iser_conn->conn_list, &ig.connlist);
431 mtx_unlock(&ig.connlist_mutex);
436 ib_conn->cma_id = NULL;
438 sx_xunlock(&iser_conn->state_mutex);
443 iser_conn_task_setup(struct icl_conn *ic, struct icl_pdu *ip,
444 struct ccb_scsiio *csio,
445 uint32_t *task_tagp, void **prvp)
447 struct icl_iser_pdu *iser_pdu = icl_to_iser_pdu(ip);
450 iser_pdu->csio = csio;
456 iser_conn_task_done(struct icl_conn *ic, void *prv)
458 struct icl_pdu *ip = prv;
459 struct icl_iser_pdu *iser_pdu = icl_to_iser_pdu(ip);
460 struct iser_device *device = iser_pdu->iser_conn->ib_conn.device;
461 struct iser_tx_desc *tx_desc = &iser_pdu->desc;
463 if (iser_pdu->dir[ISER_DIR_IN]) {
464 iser_unreg_rdma_mem(iser_pdu, ISER_DIR_IN);
465 iser_dma_unmap_task_data(iser_pdu,
466 &iser_pdu->data[ISER_DIR_IN],
470 if (iser_pdu->dir[ISER_DIR_OUT]) {
471 iser_unreg_rdma_mem(iser_pdu, ISER_DIR_OUT);
472 iser_dma_unmap_task_data(iser_pdu,
473 &iser_pdu->data[ISER_DIR_OUT],
477 if (likely(tx_desc->mapped)) {
478 ib_dma_unmap_single(device->ib_device, tx_desc->dma_addr,
479 ISER_HEADERS_LEN, DMA_TO_DEVICE);
480 tx_desc->mapped = false;
483 iser_pdu_free(ic, ip);
487 iser_limits(struct icl_drv_limits *idl)
490 idl->idl_max_recv_data_segment_length = 128 * 1024;
491 idl->idl_max_send_data_segment_length = 128 * 1024;
492 idl->idl_max_burst_length = 262144;
493 idl->idl_first_burst_length = 65536;
503 ISER_DBG("Starting iSER datamover...");
505 icl_pdu_zone = uma_zcreate("icl_iser_pdu", sizeof(struct icl_iser_pdu),
506 NULL, NULL, NULL, NULL,
508 /* FIXME: Check rc */
510 refcount_init(&icl_iser_ncons, 0);
512 error = icl_register("iser", true, 0, iser_limits, iser_new_conn);
513 KASSERT(error == 0, ("failed to register iser"));
515 memset(&ig, 0, sizeof(struct iser_global));
517 /* device init is called only after the first addr resolution */
518 sx_init(&ig.device_list_mutex, "global_device_lock");
519 INIT_LIST_HEAD(&ig.device_list);
520 mtx_init(&ig.connlist_mutex, "iser_global_conn_lock", NULL, MTX_DEF);
521 INIT_LIST_HEAD(&ig.connlist);
522 sx_init(&ig.close_conns_mutex, "global_close_conns_lock");
528 icl_iser_unload(void)
530 ISER_DBG("Removing iSER datamover...");
532 if (icl_iser_ncons != 0)
535 sx_destroy(&ig.close_conns_mutex);
536 mtx_destroy(&ig.connlist_mutex);
537 sx_destroy(&ig.device_list_mutex);
539 icl_unregister("iser", true);
541 uma_zdestroy(icl_pdu_zone);
547 icl_iser_modevent(module_t mod, int what, void *arg)
551 return (icl_iser_load());
553 return (icl_iser_unload());
559 moduledata_t icl_iser_data = {
561 .evhand = icl_iser_modevent,
565 DECLARE_MODULE(icl_iser, icl_iser_data, SI_SUB_DRIVERS, SI_ORDER_MIDDLE);
566 MODULE_DEPEND(icl_iser, icl, 1, 1, 1);
567 MODULE_DEPEND(icl_iser, ibcore, 1, 1, 1);
568 MODULE_DEPEND(icl_iser, linuxkpi, 1, 1, 1);
569 MODULE_VERSION(icl_iser, 1);