2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 The FreeBSD Foundation
6 * This software was developed by Edward Tomasz Napierala under sponsorship
7 * from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/condvar.h>
38 #include <sys/endian.h>
39 #include <sys/eventhandler.h>
41 #include <sys/kernel.h>
42 #include <sys/kthread.h>
44 #include <sys/malloc.h>
45 #include <sys/mutex.h>
46 #include <sys/module.h>
47 #include <sys/socket.h>
48 #include <sys/sysctl.h>
49 #include <sys/systm.h>
54 #include <cam/cam_ccb.h>
55 #include <cam/cam_xpt.h>
56 #include <cam/cam_debug.h>
57 #include <cam/cam_sim.h>
58 #include <cam/cam_xpt_sim.h>
59 #include <cam/cam_xpt_periph.h>
60 #include <cam/cam_periph.h>
61 #include <cam/scsi/scsi_all.h>
62 #include <cam/scsi/scsi_message.h>
64 #include <dev/iscsi/icl.h>
65 #include <dev/iscsi/icl_wrappers.h>
66 #include <dev/iscsi/iscsi_ioctl.h>
67 #include <dev/iscsi/iscsi_proto.h>
68 #include <dev/iscsi/iscsi.h>
70 #ifdef ICL_KERNEL_PROXY
71 #include <sys/socketvar.h>
74 #ifdef ICL_KERNEL_PROXY
75 FEATURE(iscsi_kernel_proxy, "iSCSI initiator built with ICL_KERNEL_PROXY");
79 * XXX: This is global so the iscsi_unload() can access it.
80 * Think about how to do this properly.
82 static struct iscsi_softc *sc;
84 SYSCTL_NODE(_kern, OID_AUTO, iscsi, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
87 SYSCTL_INT(_kern_iscsi, OID_AUTO, debug, CTLFLAG_RWTUN,
88 &debug, 0, "Enable debug messages");
89 static int ping_timeout = 5;
90 SYSCTL_INT(_kern_iscsi, OID_AUTO, ping_timeout, CTLFLAG_RWTUN, &ping_timeout,
91 0, "Timeout for ping (NOP-Out) requests, in seconds");
92 static int iscsid_timeout = 60;
93 SYSCTL_INT(_kern_iscsi, OID_AUTO, iscsid_timeout, CTLFLAG_RWTUN, &iscsid_timeout,
94 0, "Time to wait for iscsid(8) to handle reconnection, in seconds");
95 static int login_timeout = 60;
96 SYSCTL_INT(_kern_iscsi, OID_AUTO, login_timeout, CTLFLAG_RWTUN, &login_timeout,
97 0, "Time to wait for iscsid(8) to finish Login Phase, in seconds");
98 static int maxtags = 255;
99 SYSCTL_INT(_kern_iscsi, OID_AUTO, maxtags, CTLFLAG_RWTUN, &maxtags,
100 0, "Max number of IO requests queued");
101 static int fail_on_disconnection = 0;
102 SYSCTL_INT(_kern_iscsi, OID_AUTO, fail_on_disconnection, CTLFLAG_RWTUN,
103 &fail_on_disconnection, 0, "Destroy CAM SIM on connection failure");
104 static int fail_on_shutdown = 1;
105 SYSCTL_INT(_kern_iscsi, OID_AUTO, fail_on_shutdown, CTLFLAG_RWTUN,
106 &fail_on_shutdown, 0, "Fail disconnected sessions on shutdown");
108 static MALLOC_DEFINE(M_ISCSI, "iSCSI", "iSCSI initiator");
109 static uma_zone_t iscsi_outstanding_zone;
111 #define CONN_SESSION(X) ((struct iscsi_session *)X->ic_prv0)
112 #define PDU_SESSION(X) (CONN_SESSION(X->ip_conn))
114 #define ISCSI_DEBUG(X, ...) \
117 printf("%s: " X "\n", __func__, ## __VA_ARGS__);\
120 #define ISCSI_WARN(X, ...) \
123 printf("WARNING: %s: " X "\n", \
124 __func__, ## __VA_ARGS__); \
128 #define ISCSI_SESSION_DEBUG(S, X, ...) \
131 printf("%s: %s (%s): " X "\n", \
132 __func__, S->is_conf.isc_target_addr, \
133 S->is_conf.isc_target, ## __VA_ARGS__); \
137 #define ISCSI_SESSION_WARN(S, X, ...) \
140 printf("WARNING: %s (%s): " X "\n", \
141 S->is_conf.isc_target_addr, \
142 S->is_conf.isc_target, ## __VA_ARGS__); \
146 #define ISCSI_SESSION_LOCK(X) mtx_lock(&X->is_lock)
147 #define ISCSI_SESSION_UNLOCK(X) mtx_unlock(&X->is_lock)
148 #define ISCSI_SESSION_LOCK_ASSERT(X) mtx_assert(&X->is_lock, MA_OWNED)
149 #define ISCSI_SESSION_LOCK_ASSERT_NOT(X) mtx_assert(&X->is_lock, MA_NOTOWNED)
151 static int iscsi_ioctl(struct cdev *dev, u_long cmd, caddr_t arg,
152 int mode, struct thread *td);
154 static struct cdevsw iscsi_cdevsw = {
155 .d_version = D_VERSION,
156 .d_ioctl = iscsi_ioctl,
160 static void iscsi_pdu_queue_locked(struct icl_pdu *request);
161 static void iscsi_pdu_queue(struct icl_pdu *request);
162 static void iscsi_pdu_update_statsn(const struct icl_pdu *response);
163 static void iscsi_pdu_handle_nop_in(struct icl_pdu *response);
164 static void iscsi_pdu_handle_scsi_response(struct icl_pdu *response);
165 static void iscsi_pdu_handle_task_response(struct icl_pdu *response);
166 static void iscsi_pdu_handle_data_in(struct icl_pdu *response);
167 static void iscsi_pdu_handle_logout_response(struct icl_pdu *response);
168 static void iscsi_pdu_handle_r2t(struct icl_pdu *response);
169 static void iscsi_pdu_handle_async_message(struct icl_pdu *response);
170 static void iscsi_pdu_handle_reject(struct icl_pdu *response);
171 static void iscsi_session_reconnect(struct iscsi_session *is);
172 static void iscsi_session_terminate(struct iscsi_session *is);
173 static void iscsi_action(struct cam_sim *sim, union ccb *ccb);
174 static struct iscsi_outstanding *iscsi_outstanding_find(struct iscsi_session *is,
175 uint32_t initiator_task_tag);
176 static struct iscsi_outstanding *iscsi_outstanding_add(struct iscsi_session *is,
177 struct icl_pdu *request, union ccb *ccb,
178 uint32_t *initiator_task_tagp);
179 static void iscsi_outstanding_remove(struct iscsi_session *is,
180 struct iscsi_outstanding *io);
183 iscsi_pdu_prepare(struct icl_pdu *request)
185 struct iscsi_session *is;
186 struct iscsi_bhs_scsi_command *bhssc;
188 is = PDU_SESSION(request);
190 ISCSI_SESSION_LOCK_ASSERT(is);
193 * We're only using fields common for all the request
194 * (initiator -> target) PDUs.
196 bhssc = (struct iscsi_bhs_scsi_command *)request->ip_bhs;
199 * Data-Out PDU does not contain CmdSN.
201 if (bhssc->bhssc_opcode != ISCSI_BHS_OPCODE_SCSI_DATA_OUT) {
202 if (ISCSI_SNGT(is->is_cmdsn, is->is_maxcmdsn) &&
203 (bhssc->bhssc_opcode & ISCSI_BHS_OPCODE_IMMEDIATE) == 0) {
205 * Current MaxCmdSN prevents us from sending any more
206 * SCSI Command PDUs to the target; postpone the PDU.
207 * It will get resent by either iscsi_pdu_queue(),
208 * or by maintenance thread.
211 ISCSI_SESSION_DEBUG(is, "postponing send, CmdSN %u, "
212 "ExpCmdSN %u, MaxCmdSN %u, opcode 0x%x",
213 is->is_cmdsn, is->is_expcmdsn, is->is_maxcmdsn,
214 bhssc->bhssc_opcode);
218 bhssc->bhssc_cmdsn = htonl(is->is_cmdsn);
219 if ((bhssc->bhssc_opcode & ISCSI_BHS_OPCODE_IMMEDIATE) == 0)
222 bhssc->bhssc_expstatsn = htonl(is->is_statsn + 1);
228 iscsi_session_send_postponed(struct iscsi_session *is)
230 struct icl_pdu *request;
233 ISCSI_SESSION_LOCK_ASSERT(is);
235 if (STAILQ_EMPTY(&is->is_postponed))
237 while ((request = STAILQ_FIRST(&is->is_postponed)) != NULL) {
238 postpone = iscsi_pdu_prepare(request);
241 STAILQ_REMOVE_HEAD(&is->is_postponed, ip_next);
242 icl_pdu_queue(request);
244 xpt_release_simq(is->is_sim, 1);
248 iscsi_pdu_queue_locked(struct icl_pdu *request)
250 struct iscsi_session *is;
253 is = PDU_SESSION(request);
254 ISCSI_SESSION_LOCK_ASSERT(is);
255 iscsi_session_send_postponed(is);
256 postpone = iscsi_pdu_prepare(request);
258 if (STAILQ_EMPTY(&is->is_postponed))
259 xpt_freeze_simq(is->is_sim, 1);
260 STAILQ_INSERT_TAIL(&is->is_postponed, request, ip_next);
263 icl_pdu_queue(request);
267 iscsi_pdu_queue(struct icl_pdu *request)
269 struct iscsi_session *is;
271 is = PDU_SESSION(request);
272 ISCSI_SESSION_LOCK(is);
273 iscsi_pdu_queue_locked(request);
274 ISCSI_SESSION_UNLOCK(is);
278 iscsi_session_logout(struct iscsi_session *is)
280 struct icl_pdu *request;
281 struct iscsi_bhs_logout_request *bhslr;
283 request = icl_pdu_new(is->is_conn, M_NOWAIT);
287 bhslr = (struct iscsi_bhs_logout_request *)request->ip_bhs;
288 bhslr->bhslr_opcode = ISCSI_BHS_OPCODE_LOGOUT_REQUEST;
289 bhslr->bhslr_reason = BHSLR_REASON_CLOSE_SESSION;
290 iscsi_pdu_queue_locked(request);
294 iscsi_session_terminate_task(struct iscsi_session *is,
295 struct iscsi_outstanding *io, cam_status status)
298 ISCSI_SESSION_LOCK_ASSERT(is);
300 if (io->io_ccb != NULL) {
301 io->io_ccb->ccb_h.status &= ~(CAM_SIM_QUEUED | CAM_STATUS_MASK);
302 io->io_ccb->ccb_h.status |= status;
303 if ((io->io_ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
304 io->io_ccb->ccb_h.status |= CAM_DEV_QFRZN;
305 xpt_freeze_devq(io->io_ccb->ccb_h.path, 1);
306 ISCSI_SESSION_DEBUG(is, "freezing devq");
308 xpt_done(io->io_ccb);
310 iscsi_outstanding_remove(is, io);
314 iscsi_session_terminate_tasks(struct iscsi_session *is, cam_status status)
316 struct iscsi_outstanding *io, *tmp;
318 ISCSI_SESSION_LOCK_ASSERT(is);
320 TAILQ_FOREACH_SAFE(io, &is->is_outstanding, io_next, tmp) {
321 iscsi_session_terminate_task(is, io, status);
326 iscsi_session_cleanup(struct iscsi_session *is, bool destroy_sim)
330 ISCSI_SESSION_LOCK_ASSERT(is);
333 * Don't queue any new PDUs.
335 if (is->is_sim != NULL && is->is_simq_frozen == false) {
336 ISCSI_SESSION_DEBUG(is, "freezing");
337 xpt_freeze_simq(is->is_sim, 1);
338 is->is_simq_frozen = true;
342 * Remove postponed PDUs.
344 if (!STAILQ_EMPTY(&is->is_postponed))
345 xpt_release_simq(is->is_sim, 1);
346 while ((pdu = STAILQ_FIRST(&is->is_postponed)) != NULL) {
347 STAILQ_REMOVE_HEAD(&is->is_postponed, ip_next);
351 if (destroy_sim == false) {
353 * Terminate SCSI tasks, asking CAM to requeue them.
355 iscsi_session_terminate_tasks(is, CAM_REQUEUE_REQ);
359 iscsi_session_terminate_tasks(is, CAM_DEV_NOT_THERE);
361 if (is->is_sim == NULL)
364 ISCSI_SESSION_DEBUG(is, "deregistering SIM");
365 xpt_async(AC_LOST_DEVICE, is->is_path, NULL);
367 if (is->is_simq_frozen) {
368 is->is_simq_frozen = false;
369 xpt_release_simq(is->is_sim, 1);
372 xpt_free_path(is->is_path);
374 xpt_bus_deregister(cam_sim_path(is->is_sim));
375 cam_sim_free(is->is_sim, TRUE /*free_devq*/);
381 iscsi_maintenance_thread_reconnect(struct iscsi_session *is)
384 icl_conn_close(is->is_conn);
386 ISCSI_SESSION_LOCK(is);
388 is->is_connected = false;
389 is->is_reconnecting = false;
390 is->is_login_phase = false;
392 #ifdef ICL_KERNEL_PROXY
393 if (is->is_login_pdu != NULL) {
394 icl_pdu_free(is->is_login_pdu);
395 is->is_login_pdu = NULL;
397 cv_signal(&is->is_login_cv);
400 if (fail_on_disconnection) {
401 ISCSI_SESSION_DEBUG(is, "connection failed, destroying devices");
402 iscsi_session_cleanup(is, true);
404 iscsi_session_cleanup(is, false);
407 KASSERT(TAILQ_EMPTY(&is->is_outstanding),
408 ("destroying session with active tasks"));
409 KASSERT(STAILQ_EMPTY(&is->is_postponed),
410 ("destroying session with postponed PDUs"));
412 if (is->is_conf.isc_enable == 0 && is->is_conf.isc_discovery == 0) {
413 ISCSI_SESSION_UNLOCK(is);
418 * Request immediate reconnection from iscsid(8).
420 //ISCSI_SESSION_DEBUG(is, "waking up iscsid(8)");
421 is->is_waiting_for_iscsid = true;
422 strlcpy(is->is_reason, "Waiting for iscsid(8)", sizeof(is->is_reason));
424 ISCSI_SESSION_UNLOCK(is);
425 cv_signal(&is->is_softc->sc_cv);
429 iscsi_maintenance_thread_terminate(struct iscsi_session *is)
431 struct iscsi_softc *sc;
434 sx_xlock(&sc->sc_lock);
435 TAILQ_REMOVE(&sc->sc_sessions, is, is_next);
436 sx_xunlock(&sc->sc_lock);
438 icl_conn_close(is->is_conn);
439 callout_drain(&is->is_callout);
441 ISCSI_SESSION_LOCK(is);
443 KASSERT(is->is_terminating, ("is_terminating == false"));
445 #ifdef ICL_KERNEL_PROXY
446 if (is->is_login_pdu != NULL) {
447 icl_pdu_free(is->is_login_pdu);
448 is->is_login_pdu = NULL;
450 cv_signal(&is->is_login_cv);
453 iscsi_session_cleanup(is, true);
455 KASSERT(TAILQ_EMPTY(&is->is_outstanding),
456 ("destroying session with active tasks"));
457 KASSERT(STAILQ_EMPTY(&is->is_postponed),
458 ("destroying session with postponed PDUs"));
460 ISCSI_SESSION_UNLOCK(is);
462 icl_conn_free(is->is_conn);
463 mtx_destroy(&is->is_lock);
464 cv_destroy(&is->is_maintenance_cv);
465 #ifdef ICL_KERNEL_PROXY
466 cv_destroy(&is->is_login_cv);
469 ISCSI_SESSION_DEBUG(is, "terminated");
473 * The iscsi_unload() routine might be waiting.
475 cv_signal(&sc->sc_cv);
479 iscsi_maintenance_thread(void *arg)
481 struct iscsi_session *is = arg;
483 ISCSI_SESSION_LOCK(is);
485 if (is->is_reconnecting == false &&
486 is->is_terminating == false &&
487 (STAILQ_EMPTY(&is->is_postponed) ||
488 ISCSI_SNGT(is->is_cmdsn, is->is_maxcmdsn)))
489 cv_wait(&is->is_maintenance_cv, &is->is_lock);
491 /* Terminate supersedes reconnect. */
492 if (is->is_terminating) {
493 ISCSI_SESSION_UNLOCK(is);
494 iscsi_maintenance_thread_terminate(is);
499 if (is->is_reconnecting) {
500 ISCSI_SESSION_UNLOCK(is);
501 iscsi_maintenance_thread_reconnect(is);
502 ISCSI_SESSION_LOCK(is);
506 iscsi_session_send_postponed(is);
508 ISCSI_SESSION_UNLOCK(is);
512 iscsi_session_reconnect(struct iscsi_session *is)
516 * XXX: We can't use locking here, because
517 * it's being called from various contexts.
518 * Hope it doesn't break anything.
520 if (is->is_reconnecting)
523 is->is_reconnecting = true;
524 cv_signal(&is->is_maintenance_cv);
528 iscsi_session_terminate(struct iscsi_session *is)
531 if (is->is_terminating)
534 is->is_terminating = true;
537 iscsi_session_logout(is);
539 cv_signal(&is->is_maintenance_cv);
543 iscsi_callout(void *context)
545 struct icl_pdu *request;
546 struct iscsi_bhs_nop_out *bhsno;
547 struct iscsi_session *is;
548 bool reconnect_needed = false;
552 ISCSI_SESSION_LOCK(is);
553 if (is->is_terminating) {
554 ISCSI_SESSION_UNLOCK(is);
558 callout_schedule(&is->is_callout, 1 * hz);
560 if (is->is_conf.isc_enable == 0)
565 if (is->is_waiting_for_iscsid) {
566 if (iscsid_timeout > 0 && is->is_timeout > iscsid_timeout) {
567 ISCSI_SESSION_WARN(is, "timed out waiting for iscsid(8) "
568 "for %d seconds; reconnecting",
570 reconnect_needed = true;
575 if (is->is_login_phase) {
576 if (login_timeout > 0 && is->is_timeout > login_timeout) {
577 ISCSI_SESSION_WARN(is, "login timed out after %d seconds; "
578 "reconnecting", is->is_timeout);
579 reconnect_needed = true;
584 if (ping_timeout <= 0) {
586 * Pings are disabled. Don't send NOP-Out in this case.
587 * Reset the timeout, to avoid triggering reconnection,
588 * should the user decide to reenable them.
594 if (is->is_timeout >= ping_timeout) {
595 ISCSI_SESSION_WARN(is, "no ping reply (NOP-In) after %d seconds; "
596 "reconnecting", ping_timeout);
597 reconnect_needed = true;
601 ISCSI_SESSION_UNLOCK(is);
604 * If the ping was reset less than one second ago - which means
605 * that we've received some PDU during the last second - assume
606 * the traffic flows correctly and don't bother sending a NOP-Out.
608 * (It's 2 - one for one second, and one for incrementing is_timeout
609 * earlier in this routine.)
611 if (is->is_timeout < 2)
614 request = icl_pdu_new(is->is_conn, M_NOWAIT);
615 if (request == NULL) {
616 ISCSI_SESSION_WARN(is, "failed to allocate PDU");
619 bhsno = (struct iscsi_bhs_nop_out *)request->ip_bhs;
620 bhsno->bhsno_opcode = ISCSI_BHS_OPCODE_NOP_OUT |
621 ISCSI_BHS_OPCODE_IMMEDIATE;
622 bhsno->bhsno_flags = 0x80;
623 bhsno->bhsno_target_transfer_tag = 0xffffffff;
624 iscsi_pdu_queue(request);
628 if (is->is_terminating) {
629 ISCSI_SESSION_UNLOCK(is);
633 ISCSI_SESSION_UNLOCK(is);
635 if (reconnect_needed)
636 iscsi_session_reconnect(is);
640 iscsi_pdu_update_statsn(const struct icl_pdu *response)
642 const struct iscsi_bhs_data_in *bhsdi;
643 struct iscsi_session *is;
644 uint32_t expcmdsn, maxcmdsn, statsn;
646 is = PDU_SESSION(response);
648 ISCSI_SESSION_LOCK_ASSERT(is);
651 * We're only using fields common for all the response
652 * (target -> initiator) PDUs.
654 bhsdi = (const struct iscsi_bhs_data_in *)response->ip_bhs;
656 * Ok, I lied. In case of Data-In, "The fields StatSN, Status,
657 * and Residual Count only have meaningful content if the S bit
658 * is set to 1", so we also need to check the bit specific for
661 if (bhsdi->bhsdi_opcode != ISCSI_BHS_OPCODE_SCSI_DATA_IN ||
662 (bhsdi->bhsdi_flags & BHSDI_FLAGS_S) != 0) {
663 statsn = ntohl(bhsdi->bhsdi_statsn);
664 if (statsn != is->is_statsn && statsn != (is->is_statsn + 1)) {
665 /* XXX: This is normal situation for MCS */
666 ISCSI_SESSION_WARN(is, "PDU 0x%x StatSN %u != "
667 "session ExpStatSN %u (or + 1); reconnecting",
668 bhsdi->bhsdi_opcode, statsn, is->is_statsn);
669 iscsi_session_reconnect(is);
671 if (ISCSI_SNGT(statsn, is->is_statsn))
672 is->is_statsn = statsn;
675 expcmdsn = ntohl(bhsdi->bhsdi_expcmdsn);
676 maxcmdsn = ntohl(bhsdi->bhsdi_maxcmdsn);
678 if (ISCSI_SNLT(maxcmdsn + 1, expcmdsn)) {
679 ISCSI_SESSION_DEBUG(is,
680 "PDU MaxCmdSN %u + 1 < PDU ExpCmdSN %u; ignoring",
683 if (ISCSI_SNGT(maxcmdsn, is->is_maxcmdsn)) {
684 is->is_maxcmdsn = maxcmdsn;
687 * Command window increased; kick the maintanance thread
688 * to send out postponed commands.
690 if (!STAILQ_EMPTY(&is->is_postponed))
691 cv_signal(&is->is_maintenance_cv);
692 } else if (ISCSI_SNLT(maxcmdsn, is->is_maxcmdsn)) {
693 /* XXX: This is normal situation for MCS */
694 ISCSI_SESSION_DEBUG(is,
695 "PDU MaxCmdSN %u < session MaxCmdSN %u; ignoring",
696 maxcmdsn, is->is_maxcmdsn);
699 if (ISCSI_SNGT(expcmdsn, is->is_expcmdsn)) {
700 is->is_expcmdsn = expcmdsn;
701 } else if (ISCSI_SNLT(expcmdsn, is->is_expcmdsn)) {
702 /* XXX: This is normal situation for MCS */
703 ISCSI_SESSION_DEBUG(is,
704 "PDU ExpCmdSN %u < session ExpCmdSN %u; ignoring",
705 expcmdsn, is->is_expcmdsn);
710 * Every incoming PDU - not just NOP-In - resets the ping timer.
711 * The purpose of the timeout is to reset the connection when it stalls;
712 * we don't want this to happen when NOP-In or NOP-Out ends up delayed
719 iscsi_receive_callback(struct icl_pdu *response)
721 struct iscsi_session *is;
723 is = PDU_SESSION(response);
725 ISCSI_SESSION_LOCK(is);
727 iscsi_pdu_update_statsn(response);
729 #ifdef ICL_KERNEL_PROXY
730 if (is->is_login_phase) {
731 if (is->is_login_pdu == NULL)
732 is->is_login_pdu = response;
734 icl_pdu_free(response);
735 ISCSI_SESSION_UNLOCK(is);
736 cv_signal(&is->is_login_cv);
742 * The handling routine is responsible for freeing the PDU
743 * when it's no longer needed.
745 switch (response->ip_bhs->bhs_opcode) {
746 case ISCSI_BHS_OPCODE_NOP_IN:
747 iscsi_pdu_handle_nop_in(response);
748 ISCSI_SESSION_UNLOCK(is);
750 case ISCSI_BHS_OPCODE_SCSI_RESPONSE:
751 iscsi_pdu_handle_scsi_response(response);
752 /* Session lock dropped inside. */
753 ISCSI_SESSION_LOCK_ASSERT_NOT(is);
755 case ISCSI_BHS_OPCODE_TASK_RESPONSE:
756 iscsi_pdu_handle_task_response(response);
757 ISCSI_SESSION_UNLOCK(is);
759 case ISCSI_BHS_OPCODE_SCSI_DATA_IN:
760 iscsi_pdu_handle_data_in(response);
761 /* Session lock dropped inside. */
762 ISCSI_SESSION_LOCK_ASSERT_NOT(is);
764 case ISCSI_BHS_OPCODE_LOGOUT_RESPONSE:
765 iscsi_pdu_handle_logout_response(response);
766 ISCSI_SESSION_UNLOCK(is);
768 case ISCSI_BHS_OPCODE_R2T:
769 iscsi_pdu_handle_r2t(response);
770 ISCSI_SESSION_UNLOCK(is);
772 case ISCSI_BHS_OPCODE_ASYNC_MESSAGE:
773 iscsi_pdu_handle_async_message(response);
774 ISCSI_SESSION_UNLOCK(is);
776 case ISCSI_BHS_OPCODE_REJECT:
777 iscsi_pdu_handle_reject(response);
778 ISCSI_SESSION_UNLOCK(is);
781 ISCSI_SESSION_WARN(is, "received PDU with unsupported "
782 "opcode 0x%x; reconnecting",
783 response->ip_bhs->bhs_opcode);
784 iscsi_session_reconnect(is);
785 ISCSI_SESSION_UNLOCK(is);
786 icl_pdu_free(response);
791 iscsi_error_callback(struct icl_conn *ic)
793 struct iscsi_session *is;
795 is = CONN_SESSION(ic);
797 ISCSI_SESSION_WARN(is, "connection error; reconnecting");
798 iscsi_session_reconnect(is);
802 iscsi_pdu_handle_nop_in(struct icl_pdu *response)
804 struct iscsi_session *is;
805 struct iscsi_bhs_nop_out *bhsno;
806 struct iscsi_bhs_nop_in *bhsni;
807 struct icl_pdu *request;
812 is = PDU_SESSION(response);
813 bhsni = (struct iscsi_bhs_nop_in *)response->ip_bhs;
815 if (bhsni->bhsni_target_transfer_tag == 0xffffffff) {
817 * Nothing to do; iscsi_pdu_update_statsn() already
818 * zeroed the timeout.
820 icl_pdu_free(response);
824 datasize = icl_pdu_data_segment_length(response);
826 data = malloc(datasize, M_ISCSI, M_NOWAIT | M_ZERO);
828 ISCSI_SESSION_WARN(is, "failed to allocate memory; "
830 icl_pdu_free(response);
831 iscsi_session_reconnect(is);
834 icl_pdu_get_data(response, 0, data, datasize);
837 request = icl_pdu_new(response->ip_conn, M_NOWAIT);
838 if (request == NULL) {
839 ISCSI_SESSION_WARN(is, "failed to allocate memory; "
842 icl_pdu_free(response);
843 iscsi_session_reconnect(is);
846 bhsno = (struct iscsi_bhs_nop_out *)request->ip_bhs;
847 bhsno->bhsno_opcode = ISCSI_BHS_OPCODE_NOP_OUT |
848 ISCSI_BHS_OPCODE_IMMEDIATE;
849 bhsno->bhsno_flags = 0x80;
850 bhsno->bhsno_initiator_task_tag = 0xffffffff;
851 bhsno->bhsno_target_transfer_tag = bhsni->bhsni_target_transfer_tag;
853 error = icl_pdu_append_data(request, data, datasize, M_NOWAIT);
855 ISCSI_SESSION_WARN(is, "failed to allocate memory; "
858 icl_pdu_free(request);
859 icl_pdu_free(response);
860 iscsi_session_reconnect(is);
866 icl_pdu_free(response);
867 iscsi_pdu_queue_locked(request);
871 iscsi_pdu_handle_scsi_response(struct icl_pdu *response)
873 struct iscsi_bhs_scsi_response *bhssr;
874 struct iscsi_outstanding *io;
875 struct iscsi_session *is;
877 struct ccb_scsiio *csio;
878 size_t data_segment_len, received;
882 is = PDU_SESSION(response);
884 bhssr = (struct iscsi_bhs_scsi_response *)response->ip_bhs;
885 io = iscsi_outstanding_find(is, bhssr->bhssr_initiator_task_tag);
886 if (io == NULL || io->io_ccb == NULL) {
887 ISCSI_SESSION_WARN(is, "bad itt 0x%x", bhssr->bhssr_initiator_task_tag);
888 icl_pdu_free(response);
889 iscsi_session_reconnect(is);
890 ISCSI_SESSION_UNLOCK(is);
895 if (bhssr->bhssr_response == BHSSR_RESPONSE_COMMAND_COMPLETED) {
896 if (ntohl(bhssr->bhssr_expdatasn) != io->io_datasn) {
897 ISCSI_SESSION_WARN(is,
898 "ExpDataSN mismatch in SCSI Response (%u vs %u)",
899 ntohl(bhssr->bhssr_expdatasn), io->io_datasn);
902 * XXX: Permit an ExpDataSN of zero for errors.
904 * This doesn't conform to RFC 7143, but some
905 * targets seem to do this.
907 if (bhssr->bhssr_status != 0 &&
908 bhssr->bhssr_expdatasn == htonl(0))
911 icl_pdu_free(response);
912 iscsi_session_reconnect(is);
913 ISCSI_SESSION_UNLOCK(is);
917 if (bhssr->bhssr_expdatasn != htonl(0)) {
918 ISCSI_SESSION_WARN(is,
919 "ExpDataSN mismatch in SCSI Response (%u vs 0)",
920 ntohl(bhssr->bhssr_expdatasn));
921 icl_pdu_free(response);
922 iscsi_session_reconnect(is);
923 ISCSI_SESSION_UNLOCK(is);
930 * With iSER, after getting good response we can be sure
931 * that all the data has been successfully transferred.
933 if (is->is_conn->ic_iser) {
934 resid = ntohl(bhssr->bhssr_residual_count);
935 if (bhssr->bhssr_flags & BHSSR_FLAGS_RESIDUAL_UNDERFLOW) {
936 io->io_received = ccb->csio.dxfer_len - resid;
937 } else if (bhssr->bhssr_flags & BHSSR_FLAGS_RESIDUAL_OVERFLOW) {
938 ISCSI_SESSION_WARN(is, "overflow: target indicates %d", resid);
940 io->io_received = ccb->csio.dxfer_len;
944 received = io->io_received;
945 iscsi_outstanding_remove(is, io);
946 ISCSI_SESSION_UNLOCK(is);
948 if (bhssr->bhssr_response != BHSSR_RESPONSE_COMMAND_COMPLETED) {
949 ISCSI_SESSION_WARN(is, "service response 0x%x", bhssr->bhssr_response);
950 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
951 xpt_freeze_devq(ccb->ccb_h.path, 1);
952 ISCSI_SESSION_DEBUG(is, "freezing devq");
954 ccb->ccb_h.status = CAM_REQ_CMP_ERR | CAM_DEV_QFRZN;
955 } else if (bhssr->bhssr_status == 0) {
956 ccb->ccb_h.status = CAM_REQ_CMP;
958 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
959 xpt_freeze_devq(ccb->ccb_h.path, 1);
960 ISCSI_SESSION_DEBUG(is, "freezing devq");
962 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR | CAM_DEV_QFRZN;
963 ccb->csio.scsi_status = bhssr->bhssr_status;
967 data_segment_len = icl_pdu_data_segment_length(response);
968 if (data_segment_len > 0) {
969 if (data_segment_len < sizeof(sense_len)) {
970 ISCSI_SESSION_WARN(is, "truncated data segment (%zd bytes)",
972 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
973 xpt_freeze_devq(ccb->ccb_h.path, 1);
974 ISCSI_SESSION_DEBUG(is, "freezing devq");
976 ccb->ccb_h.status = CAM_REQ_CMP_ERR | CAM_DEV_QFRZN;
979 icl_pdu_get_data(response, 0, &sense_len, sizeof(sense_len));
980 sense_len = ntohs(sense_len);
982 ISCSI_SESSION_DEBUG(is, "sense_len %d, data len %zd",
983 sense_len, data_segment_len);
985 if (sizeof(sense_len) + sense_len > data_segment_len) {
986 ISCSI_SESSION_WARN(is, "truncated data segment "
987 "(%zd bytes, should be %zd)",
988 data_segment_len, sizeof(sense_len) + sense_len);
989 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
990 xpt_freeze_devq(ccb->ccb_h.path, 1);
991 ISCSI_SESSION_DEBUG(is, "freezing devq");
993 ccb->ccb_h.status = CAM_REQ_CMP_ERR | CAM_DEV_QFRZN;
995 } else if (sizeof(sense_len) + sense_len < data_segment_len)
996 ISCSI_SESSION_WARN(is, "oversize data segment "
997 "(%zd bytes, should be %zd)",
998 data_segment_len, sizeof(sense_len) + sense_len);
999 if (sense_len > csio->sense_len) {
1000 ISCSI_SESSION_DEBUG(is, "truncating sense from %d to %d",
1001 sense_len, csio->sense_len);
1002 sense_len = csio->sense_len;
1004 icl_pdu_get_data(response, sizeof(sense_len), &csio->sense_data, sense_len);
1005 csio->sense_resid = csio->sense_len - sense_len;
1006 ccb->ccb_h.status |= CAM_AUTOSNS_VALID;
1010 if (bhssr->bhssr_flags & BHSSR_FLAGS_RESIDUAL_UNDERFLOW)
1011 csio->resid = ntohl(bhssr->bhssr_residual_count);
1013 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) {
1014 KASSERT(received <= csio->dxfer_len,
1015 ("received > csio->dxfer_len"));
1016 if (received < csio->dxfer_len) {
1017 if (csio->resid != csio->dxfer_len - received) {
1018 ISCSI_SESSION_WARN(is, "underflow mismatch: "
1019 "target indicates %d, we calculated %zd",
1020 csio->resid, csio->dxfer_len - received);
1022 csio->resid = csio->dxfer_len - received;
1027 icl_pdu_free(response);
1031 iscsi_pdu_handle_task_response(struct icl_pdu *response)
1033 struct iscsi_bhs_task_management_response *bhstmr;
1034 struct iscsi_outstanding *io, *aio;
1035 struct iscsi_session *is;
1037 is = PDU_SESSION(response);
1039 bhstmr = (struct iscsi_bhs_task_management_response *)response->ip_bhs;
1040 io = iscsi_outstanding_find(is, bhstmr->bhstmr_initiator_task_tag);
1041 if (io == NULL || io->io_ccb != NULL) {
1042 ISCSI_SESSION_WARN(is, "bad itt 0x%x",
1043 bhstmr->bhstmr_initiator_task_tag);
1044 icl_pdu_free(response);
1045 iscsi_session_reconnect(is);
1049 if (bhstmr->bhstmr_response != BHSTMR_RESPONSE_FUNCTION_COMPLETE) {
1050 ISCSI_SESSION_WARN(is, "task response 0x%x",
1051 bhstmr->bhstmr_response);
1053 aio = iscsi_outstanding_find(is, io->io_referenced_task_tag);
1054 if (aio != NULL && aio->io_ccb != NULL)
1055 iscsi_session_terminate_task(is, aio, CAM_REQ_ABORTED);
1058 iscsi_outstanding_remove(is, io);
1059 icl_pdu_free(response);
1063 iscsi_pdu_handle_data_in(struct icl_pdu *response)
1065 struct iscsi_bhs_data_in *bhsdi;
1066 struct iscsi_outstanding *io;
1067 struct iscsi_session *is;
1069 struct ccb_scsiio *csio;
1070 size_t data_segment_len, received, oreceived;
1072 is = PDU_SESSION(response);
1073 bhsdi = (struct iscsi_bhs_data_in *)response->ip_bhs;
1074 io = iscsi_outstanding_find(is, bhsdi->bhsdi_initiator_task_tag);
1075 if (io == NULL || io->io_ccb == NULL) {
1076 ISCSI_SESSION_WARN(is, "bad itt 0x%x", bhsdi->bhsdi_initiator_task_tag);
1077 icl_pdu_free(response);
1078 iscsi_session_reconnect(is);
1079 ISCSI_SESSION_UNLOCK(is);
1083 if (io->io_datasn != ntohl(bhsdi->bhsdi_datasn)) {
1084 ISCSI_SESSION_WARN(is, "received Data-In PDU with "
1085 "DataSN %u, while expected %u; dropping connection",
1086 ntohl(bhsdi->bhsdi_datasn), io->io_datasn);
1087 icl_pdu_free(response);
1088 iscsi_session_reconnect(is);
1089 ISCSI_SESSION_UNLOCK(is);
1092 io->io_datasn += response->ip_additional_pdus + 1;
1094 data_segment_len = icl_pdu_data_segment_length(response);
1095 if (data_segment_len == 0) {
1097 * "The sending of 0 length data segments should be avoided,
1098 * but initiators and targets MUST be able to properly receive
1099 * 0 length data segments."
1101 ISCSI_SESSION_UNLOCK(is);
1102 icl_pdu_free(response);
1107 * We need to track this for security reasons - without it, malicious target
1108 * could respond to SCSI READ without sending Data-In PDUs, which would result
1109 * in read operation on the initiator side returning random kernel data.
1111 if (ntohl(bhsdi->bhsdi_buffer_offset) != io->io_received) {
1112 ISCSI_SESSION_WARN(is, "data out of order; expected offset %zd, got %zd",
1113 io->io_received, (size_t)ntohl(bhsdi->bhsdi_buffer_offset));
1114 icl_pdu_free(response);
1115 iscsi_session_reconnect(is);
1116 ISCSI_SESSION_UNLOCK(is);
1123 if (io->io_received + data_segment_len > csio->dxfer_len) {
1124 ISCSI_SESSION_WARN(is, "oversize data segment (%zd bytes "
1125 "at offset %zd, buffer is %d)",
1126 data_segment_len, io->io_received, csio->dxfer_len);
1127 icl_pdu_free(response);
1128 iscsi_session_reconnect(is);
1129 ISCSI_SESSION_UNLOCK(is);
1133 oreceived = io->io_received;
1134 io->io_received += data_segment_len;
1135 received = io->io_received;
1136 if ((bhsdi->bhsdi_flags & BHSDI_FLAGS_S) != 0)
1137 iscsi_outstanding_remove(is, io);
1138 ISCSI_SESSION_UNLOCK(is);
1140 icl_pdu_get_data(response, 0, csio->data_ptr + oreceived, data_segment_len);
1145 if ((bhsdi->bhsdi_flags & BHSDI_FLAGS_S) == 0) {
1147 * Nothing more to do.
1149 icl_pdu_free(response);
1153 //ISCSI_SESSION_DEBUG(is, "got S flag; status 0x%x", bhsdi->bhsdi_status);
1154 if (bhsdi->bhsdi_status == 0) {
1155 ccb->ccb_h.status = CAM_REQ_CMP;
1157 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
1158 xpt_freeze_devq(ccb->ccb_h.path, 1);
1159 ISCSI_SESSION_DEBUG(is, "freezing devq");
1161 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR | CAM_DEV_QFRZN;
1162 csio->scsi_status = bhsdi->bhsdi_status;
1165 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) {
1166 KASSERT(received <= csio->dxfer_len,
1167 ("received > csio->dxfer_len"));
1168 if (received < csio->dxfer_len) {
1169 csio->resid = ntohl(bhsdi->bhsdi_residual_count);
1170 if (csio->resid != csio->dxfer_len - received) {
1171 ISCSI_SESSION_WARN(is, "underflow mismatch: "
1172 "target indicates %d, we calculated %zd",
1173 csio->resid, csio->dxfer_len - received);
1175 csio->resid = csio->dxfer_len - received;
1180 icl_pdu_free(response);
1184 iscsi_pdu_handle_logout_response(struct icl_pdu *response)
1187 ISCSI_SESSION_DEBUG(PDU_SESSION(response), "logout response");
1188 icl_pdu_free(response);
1192 iscsi_pdu_handle_r2t(struct icl_pdu *response)
1194 struct icl_pdu *request;
1195 struct iscsi_session *is;
1196 struct iscsi_bhs_r2t *bhsr2t;
1197 struct iscsi_bhs_data_out *bhsdo;
1198 struct iscsi_outstanding *io;
1199 struct ccb_scsiio *csio;
1200 size_t off, len, max_send_data_segment_length, total_len;
1202 uint32_t datasn = 0;
1204 is = PDU_SESSION(response);
1206 bhsr2t = (struct iscsi_bhs_r2t *)response->ip_bhs;
1207 io = iscsi_outstanding_find(is, bhsr2t->bhsr2t_initiator_task_tag);
1208 if (io == NULL || io->io_ccb == NULL) {
1209 ISCSI_SESSION_WARN(is, "bad itt 0x%x; reconnecting",
1210 bhsr2t->bhsr2t_initiator_task_tag);
1211 icl_pdu_free(response);
1212 iscsi_session_reconnect(is);
1216 csio = &io->io_ccb->csio;
1218 if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_OUT) {
1219 ISCSI_SESSION_WARN(is, "received R2T for read command; reconnecting");
1220 icl_pdu_free(response);
1221 iscsi_session_reconnect(is);
1226 * XXX: Verify R2TSN.
1229 off = ntohl(bhsr2t->bhsr2t_buffer_offset);
1230 if (off > csio->dxfer_len) {
1231 ISCSI_SESSION_WARN(is, "target requested invalid offset "
1232 "%zd, buffer is is %d; reconnecting", off, csio->dxfer_len);
1233 icl_pdu_free(response);
1234 iscsi_session_reconnect(is);
1238 total_len = ntohl(bhsr2t->bhsr2t_desired_data_transfer_length);
1239 if (total_len == 0 || total_len > csio->dxfer_len) {
1240 ISCSI_SESSION_WARN(is, "target requested invalid length "
1241 "%zd, buffer is %d; reconnecting", total_len, csio->dxfer_len);
1242 icl_pdu_free(response);
1243 iscsi_session_reconnect(is);
1247 //ISCSI_SESSION_DEBUG(is, "r2t; off %zd, len %zd", off, total_len);
1249 if (is->is_conn->ic_hw_isomax != 0)
1250 max_send_data_segment_length = is->is_conn->ic_hw_isomax;
1252 max_send_data_segment_length =
1253 is->is_conn->ic_max_send_data_segment_length;
1257 if (len > max_send_data_segment_length)
1258 len = max_send_data_segment_length;
1260 if (off + len > csio->dxfer_len) {
1261 ISCSI_SESSION_WARN(is, "target requested invalid "
1262 "length/offset %zd, buffer is %d; reconnecting",
1263 off + len, csio->dxfer_len);
1264 icl_pdu_free(response);
1265 iscsi_session_reconnect(is);
1269 request = icl_pdu_new(response->ip_conn, M_NOWAIT);
1270 if (request == NULL) {
1271 icl_pdu_free(response);
1272 iscsi_session_reconnect(is);
1276 bhsdo = (struct iscsi_bhs_data_out *)request->ip_bhs;
1277 bhsdo->bhsdo_opcode = ISCSI_BHS_OPCODE_SCSI_DATA_OUT;
1278 bhsdo->bhsdo_lun = bhsr2t->bhsr2t_lun;
1279 bhsdo->bhsdo_initiator_task_tag =
1280 bhsr2t->bhsr2t_initiator_task_tag;
1281 bhsdo->bhsdo_target_transfer_tag =
1282 bhsr2t->bhsr2t_target_transfer_tag;
1283 bhsdo->bhsdo_datasn = htonl(datasn);
1284 bhsdo->bhsdo_buffer_offset = htonl(off);
1285 error = icl_pdu_append_data(request, csio->data_ptr + off, len,
1288 ISCSI_SESSION_WARN(is, "failed to allocate memory; "
1290 icl_pdu_free(request);
1291 icl_pdu_free(response);
1292 iscsi_session_reconnect(is);
1296 datasn += howmany(len,
1297 is->is_conn->ic_max_send_data_segment_length);
1301 if (total_len == 0) {
1302 bhsdo->bhsdo_flags |= BHSDO_FLAGS_F;
1303 //ISCSI_SESSION_DEBUG(is, "setting F, off %zd", off);
1305 //ISCSI_SESSION_DEBUG(is, "not finished, off %zd", off);
1308 iscsi_pdu_queue_locked(request);
1314 icl_pdu_free(response);
1318 iscsi_pdu_handle_async_message(struct icl_pdu *response)
1320 struct iscsi_bhs_asynchronous_message *bhsam;
1321 struct iscsi_session *is;
1323 is = PDU_SESSION(response);
1324 bhsam = (struct iscsi_bhs_asynchronous_message *)response->ip_bhs;
1325 switch (bhsam->bhsam_async_event) {
1326 case BHSAM_EVENT_TARGET_REQUESTS_LOGOUT:
1327 ISCSI_SESSION_WARN(is, "target requests logout; removing session");
1328 iscsi_session_logout(is);
1329 iscsi_session_terminate(is);
1331 case BHSAM_EVENT_TARGET_TERMINATES_CONNECTION:
1332 ISCSI_SESSION_WARN(is, "target indicates it will drop the connection");
1334 case BHSAM_EVENT_TARGET_TERMINATES_SESSION:
1335 ISCSI_SESSION_WARN(is, "target indicates it will drop the session");
1339 * XXX: Technically, we're obligated to also handle
1340 * parameter renegotiation.
1342 ISCSI_SESSION_WARN(is, "ignoring AsyncEvent %d", bhsam->bhsam_async_event);
1346 icl_pdu_free(response);
1350 iscsi_pdu_handle_reject(struct icl_pdu *response)
1352 struct iscsi_bhs_reject *bhsr;
1353 struct iscsi_session *is;
1355 is = PDU_SESSION(response);
1356 bhsr = (struct iscsi_bhs_reject *)response->ip_bhs;
1357 ISCSI_SESSION_WARN(is, "received Reject PDU, reason 0x%x; protocol error?",
1360 icl_pdu_free(response);
1364 iscsi_ioctl_daemon_wait(struct iscsi_softc *sc,
1365 struct iscsi_daemon_request *request)
1367 struct iscsi_session *is;
1368 struct icl_drv_limits idl;
1371 sx_slock(&sc->sc_lock);
1373 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1374 ISCSI_SESSION_LOCK(is);
1375 if (is->is_conf.isc_enable == 0 &&
1376 is->is_conf.isc_discovery == 0) {
1377 ISCSI_SESSION_UNLOCK(is);
1380 if (is->is_waiting_for_iscsid)
1382 ISCSI_SESSION_UNLOCK(is);
1386 if (sc->sc_unloading) {
1387 sx_sunlock(&sc->sc_lock);
1392 * No session requires attention from iscsid(8); wait.
1394 error = cv_wait_sig(&sc->sc_cv, &sc->sc_lock);
1396 sx_sunlock(&sc->sc_lock);
1402 is->is_waiting_for_iscsid = false;
1403 is->is_login_phase = true;
1404 is->is_reason[0] = '\0';
1405 ISCSI_SESSION_UNLOCK(is);
1407 request->idr_session_id = is->is_id;
1408 memcpy(&request->idr_isid, &is->is_isid,
1409 sizeof(request->idr_isid));
1410 request->idr_tsih = 0; /* New or reinstated session. */
1411 memcpy(&request->idr_conf, &is->is_conf,
1412 sizeof(request->idr_conf));
1414 error = icl_limits(is->is_conf.isc_offload,
1415 is->is_conf.isc_iser, &idl);
1417 ISCSI_SESSION_WARN(is, "icl_limits for offload \"%s\" "
1418 "failed with error %d", is->is_conf.isc_offload,
1420 sx_sunlock(&sc->sc_lock);
1423 request->idr_limits.isl_max_recv_data_segment_length =
1424 idl.idl_max_recv_data_segment_length;
1425 request->idr_limits.isl_max_send_data_segment_length =
1426 idl.idl_max_send_data_segment_length;
1427 request->idr_limits.isl_max_burst_length =
1428 idl.idl_max_burst_length;
1429 request->idr_limits.isl_first_burst_length =
1430 idl.idl_first_burst_length;
1432 sx_sunlock(&sc->sc_lock);
1438 iscsi_ioctl_daemon_handoff(struct iscsi_softc *sc,
1439 struct iscsi_daemon_handoff *handoff)
1441 struct iscsi_session *is;
1442 struct icl_conn *ic;
1445 sx_slock(&sc->sc_lock);
1448 * Find the session to hand off socket to.
1450 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1451 if (is->is_id == handoff->idh_session_id)
1455 sx_sunlock(&sc->sc_lock);
1458 ISCSI_SESSION_LOCK(is);
1460 if (is->is_conf.isc_discovery || is->is_terminating) {
1461 ISCSI_SESSION_UNLOCK(is);
1462 sx_sunlock(&sc->sc_lock);
1465 if (is->is_connected) {
1467 * This might have happened because another iscsid(8)
1468 * instance handed off the connection in the meantime.
1471 ISCSI_SESSION_WARN(is, "handoff on already connected "
1473 ISCSI_SESSION_UNLOCK(is);
1474 sx_sunlock(&sc->sc_lock);
1478 strlcpy(is->is_target_alias, handoff->idh_target_alias,
1479 sizeof(is->is_target_alias));
1480 is->is_tsih = handoff->idh_tsih;
1481 is->is_statsn = handoff->idh_statsn;
1482 is->is_protocol_level = handoff->idh_protocol_level;
1483 is->is_initial_r2t = handoff->idh_initial_r2t;
1484 is->is_immediate_data = handoff->idh_immediate_data;
1486 ic->ic_max_recv_data_segment_length =
1487 handoff->idh_max_recv_data_segment_length;
1488 ic->ic_max_send_data_segment_length =
1489 handoff->idh_max_send_data_segment_length;
1490 is->is_max_burst_length = handoff->idh_max_burst_length;
1491 is->is_first_burst_length = handoff->idh_first_burst_length;
1493 if (handoff->idh_header_digest == ISCSI_DIGEST_CRC32C)
1494 ic->ic_header_crc32c = true;
1496 ic->ic_header_crc32c = false;
1497 if (handoff->idh_data_digest == ISCSI_DIGEST_CRC32C)
1498 ic->ic_data_crc32c = true;
1500 ic->ic_data_crc32c = false;
1501 ic->ic_maxtags = maxtags;
1504 is->is_expcmdsn = 0;
1505 is->is_maxcmdsn = 0;
1506 is->is_waiting_for_iscsid = false;
1507 is->is_login_phase = false;
1509 is->is_connected = true;
1510 is->is_reason[0] = '\0';
1512 ISCSI_SESSION_UNLOCK(is);
1515 * If we're going through the proxy, the idh_socket will be 0,
1516 * and the ICL module can simply ignore this call. It can also
1517 * use it to determine it's no longer in the Login phase.
1519 error = icl_conn_handoff(ic, handoff->idh_socket);
1521 sx_sunlock(&sc->sc_lock);
1522 iscsi_session_terminate(is);
1526 sx_sunlock(&sc->sc_lock);
1528 if (is->is_sim != NULL) {
1530 * When reconnecting, there already is SIM allocated for the session.
1532 KASSERT(is->is_simq_frozen, ("reconnect without frozen simq"));
1533 ISCSI_SESSION_LOCK(is);
1534 ISCSI_SESSION_DEBUG(is, "releasing");
1535 is->is_simq_frozen = false;
1536 xpt_release_simq(is->is_sim, 1);
1537 ISCSI_SESSION_UNLOCK(is);
1540 ISCSI_SESSION_LOCK(is);
1541 is->is_devq = cam_simq_alloc(ic->ic_maxtags);
1542 if (is->is_devq == NULL) {
1543 ISCSI_SESSION_WARN(is, "failed to allocate simq");
1544 iscsi_session_terminate(is);
1548 is->is_sim = cam_sim_alloc(iscsi_action, NULL, "iscsi",
1549 is, is->is_id /* unit */, &is->is_lock,
1550 1, ic->ic_maxtags, is->is_devq);
1551 if (is->is_sim == NULL) {
1552 ISCSI_SESSION_UNLOCK(is);
1553 ISCSI_SESSION_WARN(is, "failed to allocate SIM");
1554 cam_simq_free(is->is_devq);
1555 iscsi_session_terminate(is);
1559 if (xpt_bus_register(is->is_sim, NULL, 0) != 0) {
1560 ISCSI_SESSION_UNLOCK(is);
1561 ISCSI_SESSION_WARN(is, "failed to register bus");
1562 iscsi_session_terminate(is);
1566 error = xpt_create_path(&is->is_path, /*periph*/NULL,
1567 cam_sim_path(is->is_sim), CAM_TARGET_WILDCARD,
1569 if (error != CAM_REQ_CMP) {
1570 ISCSI_SESSION_UNLOCK(is);
1571 ISCSI_SESSION_WARN(is, "failed to create path");
1572 iscsi_session_terminate(is);
1575 ISCSI_SESSION_UNLOCK(is);
1582 iscsi_ioctl_daemon_fail(struct iscsi_softc *sc,
1583 struct iscsi_daemon_fail *fail)
1585 struct iscsi_session *is;
1587 sx_slock(&sc->sc_lock);
1589 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1590 if (is->is_id == fail->idf_session_id)
1594 sx_sunlock(&sc->sc_lock);
1597 ISCSI_SESSION_LOCK(is);
1598 ISCSI_SESSION_DEBUG(is, "iscsid(8) failed: %s",
1600 strlcpy(is->is_reason, fail->idf_reason, sizeof(is->is_reason));
1601 //is->is_waiting_for_iscsid = false;
1602 //is->is_login_phase = true;
1603 //iscsi_session_reconnect(is);
1604 ISCSI_SESSION_UNLOCK(is);
1605 sx_sunlock(&sc->sc_lock);
1610 #ifdef ICL_KERNEL_PROXY
1612 iscsi_ioctl_daemon_connect(struct iscsi_softc *sc,
1613 struct iscsi_daemon_connect *idc)
1615 struct iscsi_session *is;
1616 struct sockaddr *from_sa, *to_sa;
1619 sx_slock(&sc->sc_lock);
1620 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1621 if (is->is_id == idc->idc_session_id)
1625 sx_sunlock(&sc->sc_lock);
1628 sx_sunlock(&sc->sc_lock);
1630 if (idc->idc_from_addrlen > 0) {
1631 error = getsockaddr(&from_sa, (void *)idc->idc_from_addr, idc->idc_from_addrlen);
1633 ISCSI_SESSION_WARN(is,
1634 "getsockaddr failed with error %d", error);
1640 error = getsockaddr(&to_sa, (void *)idc->idc_to_addr, idc->idc_to_addrlen);
1642 ISCSI_SESSION_WARN(is, "getsockaddr failed with error %d",
1644 free(from_sa, M_SONAME);
1648 ISCSI_SESSION_LOCK(is);
1651 is->is_expcmdsn = 0;
1652 is->is_maxcmdsn = 0;
1653 is->is_waiting_for_iscsid = false;
1654 is->is_login_phase = true;
1656 ISCSI_SESSION_UNLOCK(is);
1658 error = icl_conn_connect(is->is_conn, idc->idc_domain,
1659 idc->idc_socktype, idc->idc_protocol, from_sa, to_sa);
1660 free(from_sa, M_SONAME);
1661 free(to_sa, M_SONAME);
1664 * Digests are always disabled during login phase.
1666 is->is_conn->ic_header_crc32c = false;
1667 is->is_conn->ic_data_crc32c = false;
1673 iscsi_ioctl_daemon_send(struct iscsi_softc *sc,
1674 struct iscsi_daemon_send *ids)
1676 struct iscsi_session *is;
1682 sx_slock(&sc->sc_lock);
1683 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1684 if (is->is_id == ids->ids_session_id)
1688 sx_sunlock(&sc->sc_lock);
1691 sx_sunlock(&sc->sc_lock);
1693 if (is->is_login_phase == false)
1696 if (is->is_terminating || is->is_reconnecting)
1699 datalen = ids->ids_data_segment_len;
1700 if (datalen > is->is_conn->ic_max_send_data_segment_length)
1703 data = malloc(datalen, M_ISCSI, M_WAITOK);
1704 error = copyin(ids->ids_data_segment, data, datalen);
1706 free(data, M_ISCSI);
1711 ip = icl_pdu_new(is->is_conn, M_WAITOK);
1712 memcpy(ip->ip_bhs, ids->ids_bhs, sizeof(*ip->ip_bhs));
1714 error = icl_pdu_append_data(ip, data, datalen, M_WAITOK);
1715 KASSERT(error == 0, ("icl_pdu_append_data(..., M_WAITOK) failed"));
1716 free(data, M_ISCSI);
1718 iscsi_pdu_queue(ip);
1724 iscsi_ioctl_daemon_receive(struct iscsi_softc *sc,
1725 struct iscsi_daemon_receive *idr)
1727 struct iscsi_session *is;
1732 sx_slock(&sc->sc_lock);
1733 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1734 if (is->is_id == idr->idr_session_id)
1738 sx_sunlock(&sc->sc_lock);
1741 sx_sunlock(&sc->sc_lock);
1743 if (is->is_login_phase == false)
1746 ISCSI_SESSION_LOCK(is);
1747 while (is->is_login_pdu == NULL &&
1748 is->is_terminating == false &&
1749 is->is_reconnecting == false) {
1750 error = cv_wait_sig(&is->is_login_cv, &is->is_lock);
1752 ISCSI_SESSION_UNLOCK(is);
1756 if (is->is_terminating || is->is_reconnecting) {
1757 ISCSI_SESSION_UNLOCK(is);
1760 ip = is->is_login_pdu;
1761 is->is_login_pdu = NULL;
1762 ISCSI_SESSION_UNLOCK(is);
1764 if (ip->ip_data_len > idr->idr_data_segment_len) {
1769 copyout(ip->ip_bhs, idr->idr_bhs, sizeof(*ip->ip_bhs));
1770 if (ip->ip_data_len > 0) {
1771 data = malloc(ip->ip_data_len, M_ISCSI, M_WAITOK);
1772 icl_pdu_get_data(ip, 0, data, ip->ip_data_len);
1773 copyout(data, idr->idr_data_segment, ip->ip_data_len);
1774 free(data, M_ISCSI);
1781 #endif /* ICL_KERNEL_PROXY */
1784 iscsi_sanitize_session_conf(struct iscsi_session_conf *isc)
1787 * Just make sure all the fields are null-terminated.
1789 * XXX: This is not particularly secure. We should
1790 * create our own conf and then copy in relevant
1793 isc->isc_initiator[ISCSI_NAME_LEN - 1] = '\0';
1794 isc->isc_initiator_addr[ISCSI_ADDR_LEN - 1] = '\0';
1795 isc->isc_initiator_alias[ISCSI_ALIAS_LEN - 1] = '\0';
1796 isc->isc_target[ISCSI_NAME_LEN - 1] = '\0';
1797 isc->isc_target_addr[ISCSI_ADDR_LEN - 1] = '\0';
1798 isc->isc_user[ISCSI_NAME_LEN - 1] = '\0';
1799 isc->isc_secret[ISCSI_SECRET_LEN - 1] = '\0';
1800 isc->isc_mutual_user[ISCSI_NAME_LEN - 1] = '\0';
1801 isc->isc_mutual_secret[ISCSI_SECRET_LEN - 1] = '\0';
1805 iscsi_valid_session_conf(const struct iscsi_session_conf *isc)
1808 if (isc->isc_initiator[0] == '\0') {
1809 ISCSI_DEBUG("empty isc_initiator");
1813 if (isc->isc_target_addr[0] == '\0') {
1814 ISCSI_DEBUG("empty isc_target_addr");
1818 if (isc->isc_discovery != 0 && isc->isc_target[0] != 0) {
1819 ISCSI_DEBUG("non-empty isc_target for discovery session");
1823 if (isc->isc_discovery == 0 && isc->isc_target[0] == 0) {
1824 ISCSI_DEBUG("empty isc_target for non-discovery session");
1832 iscsi_ioctl_session_add(struct iscsi_softc *sc, struct iscsi_session_add *isa)
1834 struct iscsi_session *is;
1835 const struct iscsi_session *is2;
1838 iscsi_sanitize_session_conf(&isa->isa_conf);
1839 if (iscsi_valid_session_conf(&isa->isa_conf) == false)
1842 is = malloc(sizeof(*is), M_ISCSI, M_ZERO | M_WAITOK);
1843 memcpy(&is->is_conf, &isa->isa_conf, sizeof(is->is_conf));
1845 sx_xlock(&sc->sc_lock);
1848 * Prevent duplicates.
1850 TAILQ_FOREACH(is2, &sc->sc_sessions, is_next) {
1851 if (!!is->is_conf.isc_discovery !=
1852 !!is2->is_conf.isc_discovery)
1855 if (strcmp(is->is_conf.isc_target_addr,
1856 is2->is_conf.isc_target_addr) != 0)
1859 if (is->is_conf.isc_discovery == 0 &&
1860 strcmp(is->is_conf.isc_target,
1861 is2->is_conf.isc_target) != 0)
1864 sx_xunlock(&sc->sc_lock);
1869 is->is_conn = icl_new_conn(is->is_conf.isc_offload,
1870 is->is_conf.isc_iser, "iscsi", &is->is_lock);
1871 if (is->is_conn == NULL) {
1872 sx_xunlock(&sc->sc_lock);
1876 is->is_conn->ic_receive = iscsi_receive_callback;
1877 is->is_conn->ic_error = iscsi_error_callback;
1878 is->is_conn->ic_prv0 = is;
1879 TAILQ_INIT(&is->is_outstanding);
1880 STAILQ_INIT(&is->is_postponed);
1881 mtx_init(&is->is_lock, "iscsi_lock", NULL, MTX_DEF);
1882 cv_init(&is->is_maintenance_cv, "iscsi_mt");
1883 #ifdef ICL_KERNEL_PROXY
1884 cv_init(&is->is_login_cv, "iscsi_login");
1888 * Set some default values, from RFC 3720, section 12.
1890 * These values are updated by the handoff IOCTL, but are
1891 * needed prior to the handoff to support sending the ISER
1894 is->is_conn->ic_max_recv_data_segment_length = 8192;
1895 is->is_conn->ic_max_send_data_segment_length = 8192;
1896 is->is_max_burst_length = 262144;
1897 is->is_first_burst_length = 65536;
1900 sc->sc_last_session_id++;
1901 is->is_id = sc->sc_last_session_id;
1902 is->is_isid[0] = 0x80; /* RFC 3720, 10.12.5: 10b, "Random" ISID. */
1903 arc4rand(&is->is_isid[1], 5, 0);
1905 callout_init(&is->is_callout, 1);
1907 error = kthread_add(iscsi_maintenance_thread, is, NULL, NULL, 0, 0, "iscsimt");
1909 ISCSI_SESSION_WARN(is, "kthread_add(9) failed with error %d", error);
1910 sx_xunlock(&sc->sc_lock);
1914 callout_reset(&is->is_callout, 1 * hz, iscsi_callout, is);
1915 TAILQ_INSERT_TAIL(&sc->sc_sessions, is, is_next);
1917 ISCSI_SESSION_LOCK(is);
1919 * Don't notify iscsid(8) if the session is disabled and it's not
1920 * a discovery session,
1922 if (is->is_conf.isc_enable == 0 && is->is_conf.isc_discovery == 0) {
1923 ISCSI_SESSION_UNLOCK(is);
1924 sx_xunlock(&sc->sc_lock);
1928 is->is_waiting_for_iscsid = true;
1929 strlcpy(is->is_reason, "Waiting for iscsid(8)", sizeof(is->is_reason));
1930 ISCSI_SESSION_UNLOCK(is);
1931 cv_signal(&sc->sc_cv);
1932 sx_xunlock(&sc->sc_lock);
1937 iscsi_session_conf_matches(unsigned int id1, const struct iscsi_session_conf *c1,
1938 unsigned int id2, const struct iscsi_session_conf *c2)
1941 if (id2 != 0 && id2 != id1)
1943 if (c2->isc_target[0] != '\0' &&
1944 strcmp(c1->isc_target, c2->isc_target) != 0)
1946 if (c2->isc_target_addr[0] != '\0' &&
1947 strcmp(c1->isc_target_addr, c2->isc_target_addr) != 0)
1953 iscsi_ioctl_session_remove(struct iscsi_softc *sc,
1954 struct iscsi_session_remove *isr)
1956 struct iscsi_session *is, *tmp;
1959 iscsi_sanitize_session_conf(&isr->isr_conf);
1961 sx_xlock(&sc->sc_lock);
1962 TAILQ_FOREACH_SAFE(is, &sc->sc_sessions, is_next, tmp) {
1963 ISCSI_SESSION_LOCK(is);
1964 if (iscsi_session_conf_matches(is->is_id, &is->is_conf,
1965 isr->isr_session_id, &isr->isr_conf)) {
1967 iscsi_session_logout(is);
1968 iscsi_session_terminate(is);
1970 ISCSI_SESSION_UNLOCK(is);
1972 sx_xunlock(&sc->sc_lock);
1981 iscsi_ioctl_session_list(struct iscsi_softc *sc, struct iscsi_session_list *isl)
1985 struct iscsi_session *is;
1986 struct iscsi_session_state iss;
1988 sx_slock(&sc->sc_lock);
1989 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1990 if (i >= isl->isl_nentries) {
1991 sx_sunlock(&sc->sc_lock);
1994 memset(&iss, 0, sizeof(iss));
1995 memcpy(&iss.iss_conf, &is->is_conf, sizeof(iss.iss_conf));
1996 iss.iss_id = is->is_id;
1997 strlcpy(iss.iss_target_alias, is->is_target_alias, sizeof(iss.iss_target_alias));
1998 strlcpy(iss.iss_reason, is->is_reason, sizeof(iss.iss_reason));
1999 strlcpy(iss.iss_offload, is->is_conn->ic_offload, sizeof(iss.iss_offload));
2001 if (is->is_conn->ic_header_crc32c)
2002 iss.iss_header_digest = ISCSI_DIGEST_CRC32C;
2004 iss.iss_header_digest = ISCSI_DIGEST_NONE;
2006 if (is->is_conn->ic_data_crc32c)
2007 iss.iss_data_digest = ISCSI_DIGEST_CRC32C;
2009 iss.iss_data_digest = ISCSI_DIGEST_NONE;
2011 iss.iss_max_send_data_segment_length =
2012 is->is_conn->ic_max_send_data_segment_length;
2013 iss.iss_max_recv_data_segment_length =
2014 is->is_conn->ic_max_recv_data_segment_length;
2015 iss.iss_max_burst_length = is->is_max_burst_length;
2016 iss.iss_first_burst_length = is->is_first_burst_length;
2017 iss.iss_immediate_data = is->is_immediate_data;
2018 iss.iss_connected = is->is_connected;
2020 error = copyout(&iss, isl->isl_pstates + i, sizeof(iss));
2022 sx_sunlock(&sc->sc_lock);
2027 sx_sunlock(&sc->sc_lock);
2029 isl->isl_nentries = i;
2035 iscsi_ioctl_session_modify(struct iscsi_softc *sc,
2036 struct iscsi_session_modify *ism)
2038 struct iscsi_session *is;
2039 const struct iscsi_session *is2;
2041 iscsi_sanitize_session_conf(&ism->ism_conf);
2042 if (iscsi_valid_session_conf(&ism->ism_conf) == false)
2045 sx_xlock(&sc->sc_lock);
2046 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
2047 ISCSI_SESSION_LOCK(is);
2048 if (is->is_id == ism->ism_session_id) {
2049 /* Note that the session remains locked. */
2052 ISCSI_SESSION_UNLOCK(is);
2055 sx_xunlock(&sc->sc_lock);
2060 * Prevent duplicates.
2062 TAILQ_FOREACH(is2, &sc->sc_sessions, is_next) {
2066 if (!!ism->ism_conf.isc_discovery !=
2067 !!is2->is_conf.isc_discovery)
2070 if (strcmp(ism->ism_conf.isc_target_addr,
2071 is2->is_conf.isc_target_addr) != 0)
2074 if (ism->ism_conf.isc_discovery == 0 &&
2075 strcmp(ism->ism_conf.isc_target,
2076 is2->is_conf.isc_target) != 0)
2079 ISCSI_SESSION_UNLOCK(is);
2080 sx_xunlock(&sc->sc_lock);
2084 sx_xunlock(&sc->sc_lock);
2086 memcpy(&is->is_conf, &ism->ism_conf, sizeof(is->is_conf));
2087 ISCSI_SESSION_UNLOCK(is);
2089 iscsi_session_reconnect(is);
2095 iscsi_ioctl(struct cdev *dev, u_long cmd, caddr_t arg, int mode,
2098 struct iscsi_softc *sc;
2104 return (iscsi_ioctl_daemon_wait(sc,
2105 (struct iscsi_daemon_request *)arg));
2107 return (iscsi_ioctl_daemon_handoff(sc,
2108 (struct iscsi_daemon_handoff *)arg));
2110 return (iscsi_ioctl_daemon_fail(sc,
2111 (struct iscsi_daemon_fail *)arg));
2112 #ifdef ICL_KERNEL_PROXY
2114 return (iscsi_ioctl_daemon_connect(sc,
2115 (struct iscsi_daemon_connect *)arg));
2117 return (iscsi_ioctl_daemon_send(sc,
2118 (struct iscsi_daemon_send *)arg));
2120 return (iscsi_ioctl_daemon_receive(sc,
2121 (struct iscsi_daemon_receive *)arg));
2122 #endif /* ICL_KERNEL_PROXY */
2124 return (iscsi_ioctl_session_add(sc,
2125 (struct iscsi_session_add *)arg));
2127 return (iscsi_ioctl_session_remove(sc,
2128 (struct iscsi_session_remove *)arg));
2130 return (iscsi_ioctl_session_list(sc,
2131 (struct iscsi_session_list *)arg));
2133 return (iscsi_ioctl_session_modify(sc,
2134 (struct iscsi_session_modify *)arg));
2140 static struct iscsi_outstanding *
2141 iscsi_outstanding_find(struct iscsi_session *is, uint32_t initiator_task_tag)
2143 struct iscsi_outstanding *io;
2145 ISCSI_SESSION_LOCK_ASSERT(is);
2147 TAILQ_FOREACH(io, &is->is_outstanding, io_next) {
2148 if (io->io_initiator_task_tag == initiator_task_tag)
2154 static struct iscsi_outstanding *
2155 iscsi_outstanding_find_ccb(struct iscsi_session *is, union ccb *ccb)
2157 struct iscsi_outstanding *io;
2159 ISCSI_SESSION_LOCK_ASSERT(is);
2161 TAILQ_FOREACH(io, &is->is_outstanding, io_next) {
2162 if (io->io_ccb == ccb)
2168 static struct iscsi_outstanding *
2169 iscsi_outstanding_add(struct iscsi_session *is, struct icl_pdu *request,
2170 union ccb *ccb, uint32_t *initiator_task_tagp)
2172 struct iscsi_outstanding *io;
2175 ISCSI_SESSION_LOCK_ASSERT(is);
2177 io = uma_zalloc(iscsi_outstanding_zone, M_NOWAIT | M_ZERO);
2179 ISCSI_SESSION_WARN(is, "failed to allocate %zd bytes",
2184 error = icl_conn_task_setup(is->is_conn, request, &ccb->csio,
2185 initiator_task_tagp, &io->io_icl_prv);
2187 ISCSI_SESSION_WARN(is,
2188 "icl_conn_task_setup() failed with error %d", error);
2189 uma_zfree(iscsi_outstanding_zone, io);
2193 KASSERT(iscsi_outstanding_find(is, *initiator_task_tagp) == NULL,
2194 ("initiator_task_tag 0x%x already added", *initiator_task_tagp));
2196 io->io_initiator_task_tag = *initiator_task_tagp;
2198 TAILQ_INSERT_TAIL(&is->is_outstanding, io, io_next);
2203 iscsi_outstanding_remove(struct iscsi_session *is, struct iscsi_outstanding *io)
2206 ISCSI_SESSION_LOCK_ASSERT(is);
2208 icl_conn_task_done(is->is_conn, io->io_icl_prv);
2209 TAILQ_REMOVE(&is->is_outstanding, io, io_next);
2210 uma_zfree(iscsi_outstanding_zone, io);
2214 iscsi_action_abort(struct iscsi_session *is, union ccb *ccb)
2216 struct icl_pdu *request;
2217 struct iscsi_bhs_task_management_request *bhstmr;
2218 struct ccb_abort *cab = &ccb->cab;
2219 struct iscsi_outstanding *io, *aio;
2220 uint32_t initiator_task_tag;
2222 ISCSI_SESSION_LOCK_ASSERT(is);
2225 KASSERT(is->is_login_phase == false, ("%s called during Login Phase", __func__));
2227 if (is->is_login_phase) {
2228 ccb->ccb_h.status = CAM_REQ_ABORTED;
2234 aio = iscsi_outstanding_find_ccb(is, cab->abort_ccb);
2236 ccb->ccb_h.status = CAM_REQ_CMP;
2241 request = icl_pdu_new(is->is_conn, M_NOWAIT);
2242 if (request == NULL) {
2243 ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
2248 initiator_task_tag = is->is_initiator_task_tag++;
2249 if (initiator_task_tag == 0xffffffff)
2250 initiator_task_tag = is->is_initiator_task_tag++;
2252 io = iscsi_outstanding_add(is, request, NULL, &initiator_task_tag);
2254 icl_pdu_free(request);
2255 ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
2259 io->io_referenced_task_tag = aio->io_initiator_task_tag;
2261 bhstmr = (struct iscsi_bhs_task_management_request *)request->ip_bhs;
2262 bhstmr->bhstmr_opcode = ISCSI_BHS_OPCODE_TASK_REQUEST;
2263 bhstmr->bhstmr_function = 0x80 | BHSTMR_FUNCTION_ABORT_TASK;
2264 bhstmr->bhstmr_lun = htobe64(CAM_EXTLUN_BYTE_SWIZZLE(ccb->ccb_h.target_lun));
2265 bhstmr->bhstmr_initiator_task_tag = initiator_task_tag;
2266 bhstmr->bhstmr_referenced_task_tag = aio->io_initiator_task_tag;
2268 iscsi_pdu_queue_locked(request);
2272 iscsi_action_scsiio(struct iscsi_session *is, union ccb *ccb)
2274 struct icl_pdu *request;
2275 struct iscsi_bhs_scsi_command *bhssc;
2276 struct ccb_scsiio *csio;
2277 struct iscsi_outstanding *io;
2279 uint32_t initiator_task_tag;
2282 ISCSI_SESSION_LOCK_ASSERT(is);
2285 KASSERT(is->is_login_phase == false, ("%s called during Login Phase", __func__));
2287 if (is->is_login_phase) {
2288 ISCSI_SESSION_DEBUG(is, "called during login phase");
2289 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
2290 xpt_freeze_devq(ccb->ccb_h.path, 1);
2291 ISCSI_SESSION_DEBUG(is, "freezing devq");
2293 ccb->ccb_h.status = CAM_REQ_ABORTED | CAM_DEV_QFRZN;
2299 request = icl_pdu_new(is->is_conn, M_NOWAIT);
2300 if (request == NULL) {
2301 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
2302 xpt_freeze_devq(ccb->ccb_h.path, 1);
2303 ISCSI_SESSION_DEBUG(is, "freezing devq");
2305 ccb->ccb_h.status = CAM_RESRC_UNAVAIL | CAM_DEV_QFRZN;
2310 initiator_task_tag = is->is_initiator_task_tag++;
2311 if (initiator_task_tag == 0xffffffff)
2312 initiator_task_tag = is->is_initiator_task_tag++;
2314 io = iscsi_outstanding_add(is, request, ccb, &initiator_task_tag);
2316 icl_pdu_free(request);
2317 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
2318 xpt_freeze_devq(ccb->ccb_h.path, 1);
2319 ISCSI_SESSION_DEBUG(is, "freezing devq");
2321 ccb->ccb_h.status = CAM_RESRC_UNAVAIL | CAM_DEV_QFRZN;
2327 bhssc = (struct iscsi_bhs_scsi_command *)request->ip_bhs;
2328 bhssc->bhssc_opcode = ISCSI_BHS_OPCODE_SCSI_COMMAND;
2329 bhssc->bhssc_flags |= BHSSC_FLAGS_F;
2330 switch (csio->ccb_h.flags & CAM_DIR_MASK) {
2332 bhssc->bhssc_flags |= BHSSC_FLAGS_R;
2335 bhssc->bhssc_flags |= BHSSC_FLAGS_W;
2339 if ((ccb->ccb_h.flags & CAM_TAG_ACTION_VALID) != 0) {
2340 switch (csio->tag_action) {
2341 case MSG_HEAD_OF_Q_TAG:
2342 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_HOQ;
2344 case MSG_ORDERED_Q_TAG:
2345 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_ORDERED;
2348 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_ACA;
2350 case MSG_SIMPLE_Q_TAG:
2352 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_SIMPLE;
2356 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_UNTAGGED;
2358 if (is->is_protocol_level >= 2) {
2359 bhssc->bhssc_pri = (csio->priority << BHSSC_PRI_SHIFT) &
2363 bhssc->bhssc_lun = htobe64(CAM_EXTLUN_BYTE_SWIZZLE(ccb->ccb_h.target_lun));
2364 bhssc->bhssc_initiator_task_tag = initiator_task_tag;
2365 bhssc->bhssc_expected_data_transfer_length = htonl(csio->dxfer_len);
2366 KASSERT(csio->cdb_len <= sizeof(bhssc->bhssc_cdb),
2367 ("unsupported CDB size %zd", (size_t)csio->cdb_len));
2369 if (csio->ccb_h.flags & CAM_CDB_POINTER)
2370 memcpy(&bhssc->bhssc_cdb, csio->cdb_io.cdb_ptr, csio->cdb_len);
2372 memcpy(&bhssc->bhssc_cdb, csio->cdb_io.cdb_bytes, csio->cdb_len);
2374 if (is->is_immediate_data &&
2375 (csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT) {
2376 len = csio->dxfer_len;
2377 //ISCSI_SESSION_DEBUG(is, "adding %zd of immediate data", len);
2378 if (len > is->is_first_burst_length) {
2379 ISCSI_SESSION_DEBUG(is, "len %zd -> %d", len, is->is_first_burst_length);
2380 len = is->is_first_burst_length;
2382 if (len > is->is_conn->ic_max_send_data_segment_length) {
2383 ISCSI_SESSION_DEBUG(is, "len %zd -> %d", len,
2384 is->is_conn->ic_max_send_data_segment_length);
2385 len = is->is_conn->ic_max_send_data_segment_length;
2388 error = icl_pdu_append_data(request, csio->data_ptr, len, M_NOWAIT);
2390 iscsi_outstanding_remove(is, io);
2391 icl_pdu_free(request);
2392 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
2393 xpt_freeze_devq(ccb->ccb_h.path, 1);
2394 ISCSI_SESSION_DEBUG(is, "freezing devq");
2396 ccb->ccb_h.status = CAM_RESRC_UNAVAIL | CAM_DEV_QFRZN;
2401 iscsi_pdu_queue_locked(request);
2405 iscsi_action(struct cam_sim *sim, union ccb *ccb)
2407 struct iscsi_session *is;
2409 is = cam_sim_softc(sim);
2411 ISCSI_SESSION_LOCK_ASSERT(is);
2413 if (is->is_terminating ||
2414 (is->is_connected == false && fail_on_disconnection)) {
2415 ccb->ccb_h.status = CAM_DEV_NOT_THERE;
2421 * Make sure CAM doesn't sneak in a CCB just after freezing the queue.
2423 if (is->is_simq_frozen == true) {
2424 ccb->ccb_h.status &= ~(CAM_SIM_QUEUED | CAM_STATUS_MASK);
2425 ccb->ccb_h.status |= CAM_REQUEUE_REQ;
2426 /* Don't freeze the devq - the SIM queue is already frozen. */
2431 switch (ccb->ccb_h.func_code) {
2434 struct ccb_pathinq *cpi = &ccb->cpi;
2436 cpi->version_num = 1;
2437 cpi->hba_inquiry = PI_TAG_ABLE;
2438 cpi->target_sprt = 0;
2439 cpi->hba_misc = PIM_EXTLUNS;
2441 * XXX: It shouldn't ever be NULL; this could be turned
2442 * into a KASSERT eventually.
2444 if (is->is_conn == NULL)
2445 ISCSI_WARN("NULL conn");
2446 else if (is->is_conn->ic_unmapped)
2447 cpi->hba_misc |= PIM_UNMAPPED;
2448 cpi->hba_eng_cnt = 0;
2449 cpi->max_target = 0;
2451 * Note that the variable below is only relevant for targets
2452 * that don't claim compliance with anything above SPC2, which
2453 * means they don't support REPORT_LUNS.
2456 cpi->initiator_id = ~0;
2457 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2458 strlcpy(cpi->hba_vid, "iSCSI", HBA_IDLEN);
2459 strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2460 cpi->unit_number = cam_sim_unit(sim);
2461 cpi->bus_id = cam_sim_bus(sim);
2462 cpi->base_transfer_speed = 150000; /* XXX */
2463 cpi->transport = XPORT_ISCSI;
2464 cpi->transport_version = 0;
2465 cpi->protocol = PROTO_SCSI;
2466 cpi->protocol_version = SCSI_REV_SPC3;
2467 cpi->maxio = maxphys;
2468 cpi->ccb_h.status = CAM_REQ_CMP;
2471 case XPT_GET_TRAN_SETTINGS:
2473 struct ccb_trans_settings *cts;
2474 struct ccb_trans_settings_scsi *scsi;
2477 scsi = &cts->proto_specific.scsi;
2479 cts->protocol = PROTO_SCSI;
2480 cts->protocol_version = SCSI_REV_SPC3;
2481 cts->transport = XPORT_ISCSI;
2482 cts->transport_version = 0;
2483 scsi->valid = CTS_SCSI_VALID_TQ;
2484 scsi->flags = CTS_SCSI_FLAGS_TAG_ENB;
2485 cts->ccb_h.status = CAM_REQ_CMP;
2488 case XPT_CALC_GEOMETRY:
2489 cam_calc_geometry(&ccb->ccg, /*extended*/1);
2490 ccb->ccb_h.status = CAM_REQ_CMP;
2494 * XXX: What's the point?
2498 ISCSI_SESSION_DEBUG(is, "faking success for reset, abort, or term_io");
2499 ccb->ccb_h.status = CAM_REQ_CMP;
2503 iscsi_action_abort(is, ccb);
2506 iscsi_action_scsiio(is, ccb);
2510 ISCSI_SESSION_DEBUG(is, "got unsupported code 0x%x", ccb->ccb_h.func_code);
2512 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
2519 iscsi_terminate_sessions(struct iscsi_softc *sc)
2521 struct iscsi_session *is;
2523 sx_slock(&sc->sc_lock);
2524 TAILQ_FOREACH(is, &sc->sc_sessions, is_next)
2525 iscsi_session_terminate(is);
2526 while(!TAILQ_EMPTY(&sc->sc_sessions)) {
2527 ISCSI_DEBUG("waiting for sessions to terminate");
2528 cv_wait(&sc->sc_cv, &sc->sc_lock);
2530 ISCSI_DEBUG("all sessions terminated");
2531 sx_sunlock(&sc->sc_lock);
2535 iscsi_shutdown_pre(struct iscsi_softc *sc)
2537 struct iscsi_session *is;
2539 if (!fail_on_shutdown)
2543 * If we have any sessions waiting for reconnection, request
2544 * maintenance thread to fail them immediately instead of waiting
2545 * for reconnect timeout.
2547 * This prevents LUNs with mounted filesystems that are supported
2548 * by disconnected iSCSI sessions from hanging, however it will
2549 * fail all queued BIOs.
2551 ISCSI_DEBUG("forcing failing all disconnected sessions due to shutdown");
2553 fail_on_disconnection = 1;
2555 sx_slock(&sc->sc_lock);
2556 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
2557 ISCSI_SESSION_LOCK(is);
2558 if (!is->is_connected) {
2559 ISCSI_SESSION_DEBUG(is, "force failing disconnected session early");
2560 iscsi_session_reconnect(is);
2562 ISCSI_SESSION_UNLOCK(is);
2564 sx_sunlock(&sc->sc_lock);
2568 iscsi_shutdown_post(struct iscsi_softc *sc)
2571 if (!KERNEL_PANICKED()) {
2572 ISCSI_DEBUG("removing all sessions due to shutdown");
2573 iscsi_terminate_sessions(sc);
2582 sc = malloc(sizeof(*sc), M_ISCSI, M_ZERO | M_WAITOK);
2583 sx_init(&sc->sc_lock, "iscsi");
2584 TAILQ_INIT(&sc->sc_sessions);
2585 cv_init(&sc->sc_cv, "iscsi_cv");
2587 iscsi_outstanding_zone = uma_zcreate("iscsi_outstanding",
2588 sizeof(struct iscsi_outstanding), NULL, NULL, NULL, NULL,
2591 error = make_dev_p(MAKEDEV_CHECKNAME, &sc->sc_cdev, &iscsi_cdevsw,
2592 NULL, UID_ROOT, GID_WHEEL, 0600, "iscsi");
2594 ISCSI_WARN("failed to create device node, error %d", error);
2597 sc->sc_cdev->si_drv1 = sc;
2599 sc->sc_shutdown_pre_eh = EVENTHANDLER_REGISTER(shutdown_pre_sync,
2600 iscsi_shutdown_pre, sc, SHUTDOWN_PRI_FIRST);
2602 * shutdown_post_sync needs to run after filesystem shutdown and before
2603 * CAM shutdown - otherwise when rebooting with an iSCSI session that is
2604 * disconnected but has outstanding requests, dashutdown() will hang on
2605 * cam_periph_runccb().
2607 sc->sc_shutdown_post_eh = EVENTHANDLER_REGISTER(shutdown_post_sync,
2608 iscsi_shutdown_post, sc, SHUTDOWN_PRI_DEFAULT - 1);
2617 /* Awaken any threads asleep in iscsi_ioctl(). */
2618 sx_xlock(&sc->sc_lock);
2619 sc->sc_unloading = true;
2620 cv_signal(&sc->sc_cv);
2621 sx_xunlock(&sc->sc_lock);
2623 if (sc->sc_cdev != NULL) {
2624 ISCSI_DEBUG("removing device node");
2625 destroy_dev(sc->sc_cdev);
2626 ISCSI_DEBUG("device node removed");
2629 if (sc->sc_shutdown_pre_eh != NULL)
2630 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, sc->sc_shutdown_pre_eh);
2631 if (sc->sc_shutdown_post_eh != NULL)
2632 EVENTHANDLER_DEREGISTER(shutdown_post_sync, sc->sc_shutdown_post_eh);
2634 iscsi_terminate_sessions(sc);
2636 uma_zdestroy(iscsi_outstanding_zone);
2637 sx_destroy(&sc->sc_lock);
2638 cv_destroy(&sc->sc_cv);
2646 sx_slock(&sc->sc_lock);
2647 if (!TAILQ_EMPTY(&sc->sc_sessions)) {
2648 sx_sunlock(&sc->sc_lock);
2651 sx_sunlock(&sc->sc_lock);
2656 iscsi_modevent(module_t mod, int what, void *arg)
2662 error = iscsi_load();
2665 error = iscsi_unload();
2668 error = iscsi_quiesce();
2677 moduledata_t iscsi_data = {
2683 DECLARE_MODULE(iscsi, iscsi_data, SI_SUB_DRIVERS, SI_ORDER_MIDDLE);
2684 MODULE_DEPEND(iscsi, cam, 1, 1, 1);
2685 MODULE_DEPEND(iscsi, icl, 1, 1, 1);