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 (ntohl(bhssr->bhssr_expdatasn) != io->io_datasn) {
896 ISCSI_SESSION_WARN(is,
897 "ExpDataSN mismatch in SCSI Response (%u vs %u)",
898 ntohl(bhssr->bhssr_expdatasn), io->io_datasn);
899 icl_pdu_free(response);
900 iscsi_session_reconnect(is);
901 ISCSI_SESSION_UNLOCK(is);
906 * With iSER, after getting good response we can be sure
907 * that all the data has been successfully transferred.
909 if (is->is_conn->ic_iser) {
910 resid = ntohl(bhssr->bhssr_residual_count);
911 if (bhssr->bhssr_flags & BHSSR_FLAGS_RESIDUAL_UNDERFLOW) {
912 io->io_received = ccb->csio.dxfer_len - resid;
913 } else if (bhssr->bhssr_flags & BHSSR_FLAGS_RESIDUAL_OVERFLOW) {
914 ISCSI_SESSION_WARN(is, "overflow: target indicates %d", resid);
916 io->io_received = ccb->csio.dxfer_len;
920 received = io->io_received;
921 iscsi_outstanding_remove(is, io);
922 ISCSI_SESSION_UNLOCK(is);
924 if (bhssr->bhssr_response != BHSSR_RESPONSE_COMMAND_COMPLETED) {
925 ISCSI_SESSION_WARN(is, "service response 0x%x", bhssr->bhssr_response);
926 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
927 xpt_freeze_devq(ccb->ccb_h.path, 1);
928 ISCSI_SESSION_DEBUG(is, "freezing devq");
930 ccb->ccb_h.status = CAM_REQ_CMP_ERR | CAM_DEV_QFRZN;
931 } else if (bhssr->bhssr_status == 0) {
932 ccb->ccb_h.status = CAM_REQ_CMP;
934 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
935 xpt_freeze_devq(ccb->ccb_h.path, 1);
936 ISCSI_SESSION_DEBUG(is, "freezing devq");
938 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR | CAM_DEV_QFRZN;
939 ccb->csio.scsi_status = bhssr->bhssr_status;
943 data_segment_len = icl_pdu_data_segment_length(response);
944 if (data_segment_len > 0) {
945 if (data_segment_len < sizeof(sense_len)) {
946 ISCSI_SESSION_WARN(is, "truncated data segment (%zd bytes)",
948 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
949 xpt_freeze_devq(ccb->ccb_h.path, 1);
950 ISCSI_SESSION_DEBUG(is, "freezing devq");
952 ccb->ccb_h.status = CAM_REQ_CMP_ERR | CAM_DEV_QFRZN;
955 icl_pdu_get_data(response, 0, &sense_len, sizeof(sense_len));
956 sense_len = ntohs(sense_len);
958 ISCSI_SESSION_DEBUG(is, "sense_len %d, data len %zd",
959 sense_len, data_segment_len);
961 if (sizeof(sense_len) + sense_len > data_segment_len) {
962 ISCSI_SESSION_WARN(is, "truncated data segment "
963 "(%zd bytes, should be %zd)",
964 data_segment_len, sizeof(sense_len) + sense_len);
965 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
966 xpt_freeze_devq(ccb->ccb_h.path, 1);
967 ISCSI_SESSION_DEBUG(is, "freezing devq");
969 ccb->ccb_h.status = CAM_REQ_CMP_ERR | CAM_DEV_QFRZN;
971 } else if (sizeof(sense_len) + sense_len < data_segment_len)
972 ISCSI_SESSION_WARN(is, "oversize data segment "
973 "(%zd bytes, should be %zd)",
974 data_segment_len, sizeof(sense_len) + sense_len);
975 if (sense_len > csio->sense_len) {
976 ISCSI_SESSION_DEBUG(is, "truncating sense from %d to %d",
977 sense_len, csio->sense_len);
978 sense_len = csio->sense_len;
980 icl_pdu_get_data(response, sizeof(sense_len), &csio->sense_data, sense_len);
981 csio->sense_resid = csio->sense_len - sense_len;
982 ccb->ccb_h.status |= CAM_AUTOSNS_VALID;
986 if (bhssr->bhssr_flags & BHSSR_FLAGS_RESIDUAL_UNDERFLOW)
987 csio->resid = ntohl(bhssr->bhssr_residual_count);
989 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) {
990 KASSERT(received <= csio->dxfer_len,
991 ("received > csio->dxfer_len"));
992 if (received < csio->dxfer_len) {
993 if (csio->resid != csio->dxfer_len - received) {
994 ISCSI_SESSION_WARN(is, "underflow mismatch: "
995 "target indicates %d, we calculated %zd",
996 csio->resid, csio->dxfer_len - received);
998 csio->resid = csio->dxfer_len - received;
1003 icl_pdu_free(response);
1007 iscsi_pdu_handle_task_response(struct icl_pdu *response)
1009 struct iscsi_bhs_task_management_response *bhstmr;
1010 struct iscsi_outstanding *io, *aio;
1011 struct iscsi_session *is;
1013 is = PDU_SESSION(response);
1015 bhstmr = (struct iscsi_bhs_task_management_response *)response->ip_bhs;
1016 io = iscsi_outstanding_find(is, bhstmr->bhstmr_initiator_task_tag);
1017 if (io == NULL || io->io_ccb != NULL) {
1018 ISCSI_SESSION_WARN(is, "bad itt 0x%x",
1019 bhstmr->bhstmr_initiator_task_tag);
1020 icl_pdu_free(response);
1021 iscsi_session_reconnect(is);
1025 if (bhstmr->bhstmr_response != BHSTMR_RESPONSE_FUNCTION_COMPLETE) {
1026 ISCSI_SESSION_WARN(is, "task response 0x%x",
1027 bhstmr->bhstmr_response);
1029 aio = iscsi_outstanding_find(is, io->io_referenced_task_tag);
1030 if (aio != NULL && aio->io_ccb != NULL)
1031 iscsi_session_terminate_task(is, aio, CAM_REQ_ABORTED);
1034 iscsi_outstanding_remove(is, io);
1035 icl_pdu_free(response);
1039 iscsi_pdu_handle_data_in(struct icl_pdu *response)
1041 struct iscsi_bhs_data_in *bhsdi;
1042 struct iscsi_outstanding *io;
1043 struct iscsi_session *is;
1045 struct ccb_scsiio *csio;
1046 size_t data_segment_len, received, oreceived;
1048 is = PDU_SESSION(response);
1049 bhsdi = (struct iscsi_bhs_data_in *)response->ip_bhs;
1050 io = iscsi_outstanding_find(is, bhsdi->bhsdi_initiator_task_tag);
1051 if (io == NULL || io->io_ccb == NULL) {
1052 ISCSI_SESSION_WARN(is, "bad itt 0x%x", bhsdi->bhsdi_initiator_task_tag);
1053 icl_pdu_free(response);
1054 iscsi_session_reconnect(is);
1055 ISCSI_SESSION_UNLOCK(is);
1059 if (io->io_datasn != ntohl(bhsdi->bhsdi_datasn)) {
1060 ISCSI_SESSION_WARN(is, "received Data-In PDU with "
1061 "DataSN %u, while expected %u; dropping connection",
1062 ntohl(bhsdi->bhsdi_datasn), io->io_datasn);
1063 icl_pdu_free(response);
1064 iscsi_session_reconnect(is);
1065 ISCSI_SESSION_UNLOCK(is);
1068 io->io_datasn += response->ip_additional_pdus + 1;
1070 data_segment_len = icl_pdu_data_segment_length(response);
1071 if (data_segment_len == 0) {
1073 * "The sending of 0 length data segments should be avoided,
1074 * but initiators and targets MUST be able to properly receive
1075 * 0 length data segments."
1077 ISCSI_SESSION_UNLOCK(is);
1078 icl_pdu_free(response);
1083 * We need to track this for security reasons - without it, malicious target
1084 * could respond to SCSI READ without sending Data-In PDUs, which would result
1085 * in read operation on the initiator side returning random kernel data.
1087 if (ntohl(bhsdi->bhsdi_buffer_offset) != io->io_received) {
1088 ISCSI_SESSION_WARN(is, "data out of order; expected offset %zd, got %zd",
1089 io->io_received, (size_t)ntohl(bhsdi->bhsdi_buffer_offset));
1090 icl_pdu_free(response);
1091 iscsi_session_reconnect(is);
1092 ISCSI_SESSION_UNLOCK(is);
1099 if (io->io_received + data_segment_len > csio->dxfer_len) {
1100 ISCSI_SESSION_WARN(is, "oversize data segment (%zd bytes "
1101 "at offset %zd, buffer is %d)",
1102 data_segment_len, io->io_received, csio->dxfer_len);
1103 icl_pdu_free(response);
1104 iscsi_session_reconnect(is);
1105 ISCSI_SESSION_UNLOCK(is);
1109 oreceived = io->io_received;
1110 io->io_received += data_segment_len;
1111 received = io->io_received;
1112 if ((bhsdi->bhsdi_flags & BHSDI_FLAGS_S) != 0)
1113 iscsi_outstanding_remove(is, io);
1114 ISCSI_SESSION_UNLOCK(is);
1116 icl_pdu_get_data(response, 0, csio->data_ptr + oreceived, data_segment_len);
1121 if ((bhsdi->bhsdi_flags & BHSDI_FLAGS_S) == 0) {
1123 * Nothing more to do.
1125 icl_pdu_free(response);
1129 //ISCSI_SESSION_DEBUG(is, "got S flag; status 0x%x", bhsdi->bhsdi_status);
1130 if (bhsdi->bhsdi_status == 0) {
1131 ccb->ccb_h.status = CAM_REQ_CMP;
1133 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
1134 xpt_freeze_devq(ccb->ccb_h.path, 1);
1135 ISCSI_SESSION_DEBUG(is, "freezing devq");
1137 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR | CAM_DEV_QFRZN;
1138 csio->scsi_status = bhsdi->bhsdi_status;
1141 if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) {
1142 KASSERT(received <= csio->dxfer_len,
1143 ("received > csio->dxfer_len"));
1144 if (received < csio->dxfer_len) {
1145 csio->resid = ntohl(bhsdi->bhsdi_residual_count);
1146 if (csio->resid != csio->dxfer_len - received) {
1147 ISCSI_SESSION_WARN(is, "underflow mismatch: "
1148 "target indicates %d, we calculated %zd",
1149 csio->resid, csio->dxfer_len - received);
1151 csio->resid = csio->dxfer_len - received;
1156 icl_pdu_free(response);
1160 iscsi_pdu_handle_logout_response(struct icl_pdu *response)
1163 ISCSI_SESSION_DEBUG(PDU_SESSION(response), "logout response");
1164 icl_pdu_free(response);
1168 iscsi_pdu_handle_r2t(struct icl_pdu *response)
1170 struct icl_pdu *request;
1171 struct iscsi_session *is;
1172 struct iscsi_bhs_r2t *bhsr2t;
1173 struct iscsi_bhs_data_out *bhsdo;
1174 struct iscsi_outstanding *io;
1175 struct ccb_scsiio *csio;
1176 size_t off, len, max_send_data_segment_length, total_len;
1178 uint32_t datasn = 0;
1180 is = PDU_SESSION(response);
1182 bhsr2t = (struct iscsi_bhs_r2t *)response->ip_bhs;
1183 io = iscsi_outstanding_find(is, bhsr2t->bhsr2t_initiator_task_tag);
1184 if (io == NULL || io->io_ccb == NULL) {
1185 ISCSI_SESSION_WARN(is, "bad itt 0x%x; reconnecting",
1186 bhsr2t->bhsr2t_initiator_task_tag);
1187 icl_pdu_free(response);
1188 iscsi_session_reconnect(is);
1192 csio = &io->io_ccb->csio;
1194 if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_OUT) {
1195 ISCSI_SESSION_WARN(is, "received R2T for read command; reconnecting");
1196 icl_pdu_free(response);
1197 iscsi_session_reconnect(is);
1202 * XXX: Verify R2TSN.
1205 off = ntohl(bhsr2t->bhsr2t_buffer_offset);
1206 if (off > csio->dxfer_len) {
1207 ISCSI_SESSION_WARN(is, "target requested invalid offset "
1208 "%zd, buffer is is %d; reconnecting", off, csio->dxfer_len);
1209 icl_pdu_free(response);
1210 iscsi_session_reconnect(is);
1214 total_len = ntohl(bhsr2t->bhsr2t_desired_data_transfer_length);
1215 if (total_len == 0 || total_len > csio->dxfer_len) {
1216 ISCSI_SESSION_WARN(is, "target requested invalid length "
1217 "%zd, buffer is %d; reconnecting", total_len, csio->dxfer_len);
1218 icl_pdu_free(response);
1219 iscsi_session_reconnect(is);
1223 //ISCSI_SESSION_DEBUG(is, "r2t; off %zd, len %zd", off, total_len);
1225 if (is->is_conn->ic_hw_isomax != 0)
1226 max_send_data_segment_length = is->is_conn->ic_hw_isomax;
1228 max_send_data_segment_length =
1229 is->is_conn->ic_max_send_data_segment_length;
1233 if (len > max_send_data_segment_length)
1234 len = max_send_data_segment_length;
1236 if (off + len > csio->dxfer_len) {
1237 ISCSI_SESSION_WARN(is, "target requested invalid "
1238 "length/offset %zd, buffer is %d; reconnecting",
1239 off + len, csio->dxfer_len);
1240 icl_pdu_free(response);
1241 iscsi_session_reconnect(is);
1245 request = icl_pdu_new(response->ip_conn, M_NOWAIT);
1246 if (request == NULL) {
1247 icl_pdu_free(response);
1248 iscsi_session_reconnect(is);
1252 bhsdo = (struct iscsi_bhs_data_out *)request->ip_bhs;
1253 bhsdo->bhsdo_opcode = ISCSI_BHS_OPCODE_SCSI_DATA_OUT;
1254 bhsdo->bhsdo_lun = bhsr2t->bhsr2t_lun;
1255 bhsdo->bhsdo_initiator_task_tag =
1256 bhsr2t->bhsr2t_initiator_task_tag;
1257 bhsdo->bhsdo_target_transfer_tag =
1258 bhsr2t->bhsr2t_target_transfer_tag;
1259 bhsdo->bhsdo_datasn = htonl(datasn);
1260 bhsdo->bhsdo_buffer_offset = htonl(off);
1261 error = icl_pdu_append_data(request, csio->data_ptr + off, len,
1264 ISCSI_SESSION_WARN(is, "failed to allocate memory; "
1266 icl_pdu_free(request);
1267 icl_pdu_free(response);
1268 iscsi_session_reconnect(is);
1272 datasn += howmany(len,
1273 is->is_conn->ic_max_send_data_segment_length);
1277 if (total_len == 0) {
1278 bhsdo->bhsdo_flags |= BHSDO_FLAGS_F;
1279 //ISCSI_SESSION_DEBUG(is, "setting F, off %zd", off);
1281 //ISCSI_SESSION_DEBUG(is, "not finished, off %zd", off);
1284 iscsi_pdu_queue_locked(request);
1290 icl_pdu_free(response);
1294 iscsi_pdu_handle_async_message(struct icl_pdu *response)
1296 struct iscsi_bhs_asynchronous_message *bhsam;
1297 struct iscsi_session *is;
1299 is = PDU_SESSION(response);
1300 bhsam = (struct iscsi_bhs_asynchronous_message *)response->ip_bhs;
1301 switch (bhsam->bhsam_async_event) {
1302 case BHSAM_EVENT_TARGET_REQUESTS_LOGOUT:
1303 ISCSI_SESSION_WARN(is, "target requests logout; removing session");
1304 iscsi_session_logout(is);
1305 iscsi_session_terminate(is);
1307 case BHSAM_EVENT_TARGET_TERMINATES_CONNECTION:
1308 ISCSI_SESSION_WARN(is, "target indicates it will drop the connection");
1310 case BHSAM_EVENT_TARGET_TERMINATES_SESSION:
1311 ISCSI_SESSION_WARN(is, "target indicates it will drop the session");
1315 * XXX: Technically, we're obligated to also handle
1316 * parameter renegotiation.
1318 ISCSI_SESSION_WARN(is, "ignoring AsyncEvent %d", bhsam->bhsam_async_event);
1322 icl_pdu_free(response);
1326 iscsi_pdu_handle_reject(struct icl_pdu *response)
1328 struct iscsi_bhs_reject *bhsr;
1329 struct iscsi_session *is;
1331 is = PDU_SESSION(response);
1332 bhsr = (struct iscsi_bhs_reject *)response->ip_bhs;
1333 ISCSI_SESSION_WARN(is, "received Reject PDU, reason 0x%x; protocol error?",
1336 icl_pdu_free(response);
1340 iscsi_ioctl_daemon_wait(struct iscsi_softc *sc,
1341 struct iscsi_daemon_request *request)
1343 struct iscsi_session *is;
1344 struct icl_drv_limits idl;
1347 sx_slock(&sc->sc_lock);
1349 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1350 ISCSI_SESSION_LOCK(is);
1351 if (is->is_conf.isc_enable == 0 &&
1352 is->is_conf.isc_discovery == 0) {
1353 ISCSI_SESSION_UNLOCK(is);
1356 if (is->is_waiting_for_iscsid)
1358 ISCSI_SESSION_UNLOCK(is);
1362 if (sc->sc_unloading) {
1363 sx_sunlock(&sc->sc_lock);
1368 * No session requires attention from iscsid(8); wait.
1370 error = cv_wait_sig(&sc->sc_cv, &sc->sc_lock);
1372 sx_sunlock(&sc->sc_lock);
1378 is->is_waiting_for_iscsid = false;
1379 is->is_login_phase = true;
1380 is->is_reason[0] = '\0';
1381 ISCSI_SESSION_UNLOCK(is);
1383 request->idr_session_id = is->is_id;
1384 memcpy(&request->idr_isid, &is->is_isid,
1385 sizeof(request->idr_isid));
1386 request->idr_tsih = 0; /* New or reinstated session. */
1387 memcpy(&request->idr_conf, &is->is_conf,
1388 sizeof(request->idr_conf));
1390 error = icl_limits(is->is_conf.isc_offload,
1391 is->is_conf.isc_iser, &idl);
1393 ISCSI_SESSION_WARN(is, "icl_limits for offload \"%s\" "
1394 "failed with error %d", is->is_conf.isc_offload,
1396 sx_sunlock(&sc->sc_lock);
1399 request->idr_limits.isl_max_recv_data_segment_length =
1400 idl.idl_max_recv_data_segment_length;
1401 request->idr_limits.isl_max_send_data_segment_length =
1402 idl.idl_max_send_data_segment_length;
1403 request->idr_limits.isl_max_burst_length =
1404 idl.idl_max_burst_length;
1405 request->idr_limits.isl_first_burst_length =
1406 idl.idl_first_burst_length;
1408 sx_sunlock(&sc->sc_lock);
1414 iscsi_ioctl_daemon_handoff(struct iscsi_softc *sc,
1415 struct iscsi_daemon_handoff *handoff)
1417 struct iscsi_session *is;
1418 struct icl_conn *ic;
1421 sx_slock(&sc->sc_lock);
1424 * Find the session to hand off socket to.
1426 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1427 if (is->is_id == handoff->idh_session_id)
1431 sx_sunlock(&sc->sc_lock);
1434 ISCSI_SESSION_LOCK(is);
1436 if (is->is_conf.isc_discovery || is->is_terminating) {
1437 ISCSI_SESSION_UNLOCK(is);
1438 sx_sunlock(&sc->sc_lock);
1441 if (is->is_connected) {
1443 * This might have happened because another iscsid(8)
1444 * instance handed off the connection in the meantime.
1447 ISCSI_SESSION_WARN(is, "handoff on already connected "
1449 ISCSI_SESSION_UNLOCK(is);
1450 sx_sunlock(&sc->sc_lock);
1454 strlcpy(is->is_target_alias, handoff->idh_target_alias,
1455 sizeof(is->is_target_alias));
1456 is->is_tsih = handoff->idh_tsih;
1457 is->is_statsn = handoff->idh_statsn;
1458 is->is_protocol_level = handoff->idh_protocol_level;
1459 is->is_initial_r2t = handoff->idh_initial_r2t;
1460 is->is_immediate_data = handoff->idh_immediate_data;
1462 ic->ic_max_recv_data_segment_length =
1463 handoff->idh_max_recv_data_segment_length;
1464 ic->ic_max_send_data_segment_length =
1465 handoff->idh_max_send_data_segment_length;
1466 is->is_max_burst_length = handoff->idh_max_burst_length;
1467 is->is_first_burst_length = handoff->idh_first_burst_length;
1469 if (handoff->idh_header_digest == ISCSI_DIGEST_CRC32C)
1470 ic->ic_header_crc32c = true;
1472 ic->ic_header_crc32c = false;
1473 if (handoff->idh_data_digest == ISCSI_DIGEST_CRC32C)
1474 ic->ic_data_crc32c = true;
1476 ic->ic_data_crc32c = false;
1477 ic->ic_maxtags = maxtags;
1480 is->is_expcmdsn = 0;
1481 is->is_maxcmdsn = 0;
1482 is->is_waiting_for_iscsid = false;
1483 is->is_login_phase = false;
1485 is->is_connected = true;
1486 is->is_reason[0] = '\0';
1488 ISCSI_SESSION_UNLOCK(is);
1491 * If we're going through the proxy, the idh_socket will be 0,
1492 * and the ICL module can simply ignore this call. It can also
1493 * use it to determine it's no longer in the Login phase.
1495 error = icl_conn_handoff(ic, handoff->idh_socket);
1497 sx_sunlock(&sc->sc_lock);
1498 iscsi_session_terminate(is);
1502 sx_sunlock(&sc->sc_lock);
1504 if (is->is_sim != NULL) {
1506 * When reconnecting, there already is SIM allocated for the session.
1508 KASSERT(is->is_simq_frozen, ("reconnect without frozen simq"));
1509 ISCSI_SESSION_LOCK(is);
1510 ISCSI_SESSION_DEBUG(is, "releasing");
1511 is->is_simq_frozen = false;
1512 xpt_release_simq(is->is_sim, 1);
1513 ISCSI_SESSION_UNLOCK(is);
1516 ISCSI_SESSION_LOCK(is);
1517 is->is_devq = cam_simq_alloc(ic->ic_maxtags);
1518 if (is->is_devq == NULL) {
1519 ISCSI_SESSION_WARN(is, "failed to allocate simq");
1520 iscsi_session_terminate(is);
1524 is->is_sim = cam_sim_alloc(iscsi_action, NULL, "iscsi",
1525 is, is->is_id /* unit */, &is->is_lock,
1526 1, ic->ic_maxtags, is->is_devq);
1527 if (is->is_sim == NULL) {
1528 ISCSI_SESSION_UNLOCK(is);
1529 ISCSI_SESSION_WARN(is, "failed to allocate SIM");
1530 cam_simq_free(is->is_devq);
1531 iscsi_session_terminate(is);
1535 if (xpt_bus_register(is->is_sim, NULL, 0) != 0) {
1536 ISCSI_SESSION_UNLOCK(is);
1537 ISCSI_SESSION_WARN(is, "failed to register bus");
1538 iscsi_session_terminate(is);
1542 error = xpt_create_path(&is->is_path, /*periph*/NULL,
1543 cam_sim_path(is->is_sim), CAM_TARGET_WILDCARD,
1545 if (error != CAM_REQ_CMP) {
1546 ISCSI_SESSION_UNLOCK(is);
1547 ISCSI_SESSION_WARN(is, "failed to create path");
1548 iscsi_session_terminate(is);
1551 ISCSI_SESSION_UNLOCK(is);
1558 iscsi_ioctl_daemon_fail(struct iscsi_softc *sc,
1559 struct iscsi_daemon_fail *fail)
1561 struct iscsi_session *is;
1563 sx_slock(&sc->sc_lock);
1565 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1566 if (is->is_id == fail->idf_session_id)
1570 sx_sunlock(&sc->sc_lock);
1573 ISCSI_SESSION_LOCK(is);
1574 ISCSI_SESSION_DEBUG(is, "iscsid(8) failed: %s",
1576 strlcpy(is->is_reason, fail->idf_reason, sizeof(is->is_reason));
1577 //is->is_waiting_for_iscsid = false;
1578 //is->is_login_phase = true;
1579 //iscsi_session_reconnect(is);
1580 ISCSI_SESSION_UNLOCK(is);
1581 sx_sunlock(&sc->sc_lock);
1586 #ifdef ICL_KERNEL_PROXY
1588 iscsi_ioctl_daemon_connect(struct iscsi_softc *sc,
1589 struct iscsi_daemon_connect *idc)
1591 struct iscsi_session *is;
1592 struct sockaddr *from_sa, *to_sa;
1595 sx_slock(&sc->sc_lock);
1596 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1597 if (is->is_id == idc->idc_session_id)
1601 sx_sunlock(&sc->sc_lock);
1604 sx_sunlock(&sc->sc_lock);
1606 if (idc->idc_from_addrlen > 0) {
1607 error = getsockaddr(&from_sa, (void *)idc->idc_from_addr, idc->idc_from_addrlen);
1609 ISCSI_SESSION_WARN(is,
1610 "getsockaddr failed with error %d", error);
1616 error = getsockaddr(&to_sa, (void *)idc->idc_to_addr, idc->idc_to_addrlen);
1618 ISCSI_SESSION_WARN(is, "getsockaddr failed with error %d",
1620 free(from_sa, M_SONAME);
1624 ISCSI_SESSION_LOCK(is);
1627 is->is_expcmdsn = 0;
1628 is->is_maxcmdsn = 0;
1629 is->is_waiting_for_iscsid = false;
1630 is->is_login_phase = true;
1632 ISCSI_SESSION_UNLOCK(is);
1634 error = icl_conn_connect(is->is_conn, idc->idc_domain,
1635 idc->idc_socktype, idc->idc_protocol, from_sa, to_sa);
1636 free(from_sa, M_SONAME);
1637 free(to_sa, M_SONAME);
1640 * Digests are always disabled during login phase.
1642 is->is_conn->ic_header_crc32c = false;
1643 is->is_conn->ic_data_crc32c = false;
1649 iscsi_ioctl_daemon_send(struct iscsi_softc *sc,
1650 struct iscsi_daemon_send *ids)
1652 struct iscsi_session *is;
1658 sx_slock(&sc->sc_lock);
1659 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1660 if (is->is_id == ids->ids_session_id)
1664 sx_sunlock(&sc->sc_lock);
1667 sx_sunlock(&sc->sc_lock);
1669 if (is->is_login_phase == false)
1672 if (is->is_terminating || is->is_reconnecting)
1675 datalen = ids->ids_data_segment_len;
1676 if (datalen > is->is_conn->ic_max_send_data_segment_length)
1679 data = malloc(datalen, M_ISCSI, M_WAITOK);
1680 error = copyin(ids->ids_data_segment, data, datalen);
1682 free(data, M_ISCSI);
1687 ip = icl_pdu_new(is->is_conn, M_WAITOK);
1688 memcpy(ip->ip_bhs, ids->ids_bhs, sizeof(*ip->ip_bhs));
1690 error = icl_pdu_append_data(ip, data, datalen, M_WAITOK);
1691 KASSERT(error == 0, ("icl_pdu_append_data(..., M_WAITOK) failed"));
1692 free(data, M_ISCSI);
1694 iscsi_pdu_queue(ip);
1700 iscsi_ioctl_daemon_receive(struct iscsi_softc *sc,
1701 struct iscsi_daemon_receive *idr)
1703 struct iscsi_session *is;
1708 sx_slock(&sc->sc_lock);
1709 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1710 if (is->is_id == idr->idr_session_id)
1714 sx_sunlock(&sc->sc_lock);
1717 sx_sunlock(&sc->sc_lock);
1719 if (is->is_login_phase == false)
1722 ISCSI_SESSION_LOCK(is);
1723 while (is->is_login_pdu == NULL &&
1724 is->is_terminating == false &&
1725 is->is_reconnecting == false) {
1726 error = cv_wait_sig(&is->is_login_cv, &is->is_lock);
1728 ISCSI_SESSION_UNLOCK(is);
1732 if (is->is_terminating || is->is_reconnecting) {
1733 ISCSI_SESSION_UNLOCK(is);
1736 ip = is->is_login_pdu;
1737 is->is_login_pdu = NULL;
1738 ISCSI_SESSION_UNLOCK(is);
1740 if (ip->ip_data_len > idr->idr_data_segment_len) {
1745 copyout(ip->ip_bhs, idr->idr_bhs, sizeof(*ip->ip_bhs));
1746 if (ip->ip_data_len > 0) {
1747 data = malloc(ip->ip_data_len, M_ISCSI, M_WAITOK);
1748 icl_pdu_get_data(ip, 0, data, ip->ip_data_len);
1749 copyout(data, idr->idr_data_segment, ip->ip_data_len);
1750 free(data, M_ISCSI);
1757 #endif /* ICL_KERNEL_PROXY */
1760 iscsi_sanitize_session_conf(struct iscsi_session_conf *isc)
1763 * Just make sure all the fields are null-terminated.
1765 * XXX: This is not particularly secure. We should
1766 * create our own conf and then copy in relevant
1769 isc->isc_initiator[ISCSI_NAME_LEN - 1] = '\0';
1770 isc->isc_initiator_addr[ISCSI_ADDR_LEN - 1] = '\0';
1771 isc->isc_initiator_alias[ISCSI_ALIAS_LEN - 1] = '\0';
1772 isc->isc_target[ISCSI_NAME_LEN - 1] = '\0';
1773 isc->isc_target_addr[ISCSI_ADDR_LEN - 1] = '\0';
1774 isc->isc_user[ISCSI_NAME_LEN - 1] = '\0';
1775 isc->isc_secret[ISCSI_SECRET_LEN - 1] = '\0';
1776 isc->isc_mutual_user[ISCSI_NAME_LEN - 1] = '\0';
1777 isc->isc_mutual_secret[ISCSI_SECRET_LEN - 1] = '\0';
1781 iscsi_valid_session_conf(const struct iscsi_session_conf *isc)
1784 if (isc->isc_initiator[0] == '\0') {
1785 ISCSI_DEBUG("empty isc_initiator");
1789 if (isc->isc_target_addr[0] == '\0') {
1790 ISCSI_DEBUG("empty isc_target_addr");
1794 if (isc->isc_discovery != 0 && isc->isc_target[0] != 0) {
1795 ISCSI_DEBUG("non-empty isc_target for discovery session");
1799 if (isc->isc_discovery == 0 && isc->isc_target[0] == 0) {
1800 ISCSI_DEBUG("empty isc_target for non-discovery session");
1808 iscsi_ioctl_session_add(struct iscsi_softc *sc, struct iscsi_session_add *isa)
1810 struct iscsi_session *is;
1811 const struct iscsi_session *is2;
1814 iscsi_sanitize_session_conf(&isa->isa_conf);
1815 if (iscsi_valid_session_conf(&isa->isa_conf) == false)
1818 is = malloc(sizeof(*is), M_ISCSI, M_ZERO | M_WAITOK);
1819 memcpy(&is->is_conf, &isa->isa_conf, sizeof(is->is_conf));
1821 sx_xlock(&sc->sc_lock);
1824 * Prevent duplicates.
1826 TAILQ_FOREACH(is2, &sc->sc_sessions, is_next) {
1827 if (!!is->is_conf.isc_discovery !=
1828 !!is2->is_conf.isc_discovery)
1831 if (strcmp(is->is_conf.isc_target_addr,
1832 is2->is_conf.isc_target_addr) != 0)
1835 if (is->is_conf.isc_discovery == 0 &&
1836 strcmp(is->is_conf.isc_target,
1837 is2->is_conf.isc_target) != 0)
1840 sx_xunlock(&sc->sc_lock);
1845 is->is_conn = icl_new_conn(is->is_conf.isc_offload,
1846 is->is_conf.isc_iser, "iscsi", &is->is_lock);
1847 if (is->is_conn == NULL) {
1848 sx_xunlock(&sc->sc_lock);
1852 is->is_conn->ic_receive = iscsi_receive_callback;
1853 is->is_conn->ic_error = iscsi_error_callback;
1854 is->is_conn->ic_prv0 = is;
1855 TAILQ_INIT(&is->is_outstanding);
1856 STAILQ_INIT(&is->is_postponed);
1857 mtx_init(&is->is_lock, "iscsi_lock", NULL, MTX_DEF);
1858 cv_init(&is->is_maintenance_cv, "iscsi_mt");
1859 #ifdef ICL_KERNEL_PROXY
1860 cv_init(&is->is_login_cv, "iscsi_login");
1864 * Set some default values, from RFC 3720, section 12.
1866 * These values are updated by the handoff IOCTL, but are
1867 * needed prior to the handoff to support sending the ISER
1870 is->is_conn->ic_max_recv_data_segment_length = 8192;
1871 is->is_conn->ic_max_send_data_segment_length = 8192;
1872 is->is_max_burst_length = 262144;
1873 is->is_first_burst_length = 65536;
1876 sc->sc_last_session_id++;
1877 is->is_id = sc->sc_last_session_id;
1878 is->is_isid[0] = 0x80; /* RFC 3720, 10.12.5: 10b, "Random" ISID. */
1879 arc4rand(&is->is_isid[1], 5, 0);
1881 callout_init(&is->is_callout, 1);
1883 error = kthread_add(iscsi_maintenance_thread, is, NULL, NULL, 0, 0, "iscsimt");
1885 ISCSI_SESSION_WARN(is, "kthread_add(9) failed with error %d", error);
1886 sx_xunlock(&sc->sc_lock);
1890 callout_reset(&is->is_callout, 1 * hz, iscsi_callout, is);
1891 TAILQ_INSERT_TAIL(&sc->sc_sessions, is, is_next);
1893 ISCSI_SESSION_LOCK(is);
1895 * Don't notify iscsid(8) if the session is disabled and it's not
1896 * a discovery session,
1898 if (is->is_conf.isc_enable == 0 && is->is_conf.isc_discovery == 0) {
1899 ISCSI_SESSION_UNLOCK(is);
1900 sx_xunlock(&sc->sc_lock);
1904 is->is_waiting_for_iscsid = true;
1905 strlcpy(is->is_reason, "Waiting for iscsid(8)", sizeof(is->is_reason));
1906 ISCSI_SESSION_UNLOCK(is);
1907 cv_signal(&sc->sc_cv);
1908 sx_xunlock(&sc->sc_lock);
1913 iscsi_session_conf_matches(unsigned int id1, const struct iscsi_session_conf *c1,
1914 unsigned int id2, const struct iscsi_session_conf *c2)
1917 if (id2 != 0 && id2 != id1)
1919 if (c2->isc_target[0] != '\0' &&
1920 strcmp(c1->isc_target, c2->isc_target) != 0)
1922 if (c2->isc_target_addr[0] != '\0' &&
1923 strcmp(c1->isc_target_addr, c2->isc_target_addr) != 0)
1929 iscsi_ioctl_session_remove(struct iscsi_softc *sc,
1930 struct iscsi_session_remove *isr)
1932 struct iscsi_session *is, *tmp;
1935 iscsi_sanitize_session_conf(&isr->isr_conf);
1937 sx_xlock(&sc->sc_lock);
1938 TAILQ_FOREACH_SAFE(is, &sc->sc_sessions, is_next, tmp) {
1939 ISCSI_SESSION_LOCK(is);
1940 if (iscsi_session_conf_matches(is->is_id, &is->is_conf,
1941 isr->isr_session_id, &isr->isr_conf)) {
1943 iscsi_session_logout(is);
1944 iscsi_session_terminate(is);
1946 ISCSI_SESSION_UNLOCK(is);
1948 sx_xunlock(&sc->sc_lock);
1957 iscsi_ioctl_session_list(struct iscsi_softc *sc, struct iscsi_session_list *isl)
1961 struct iscsi_session *is;
1962 struct iscsi_session_state iss;
1964 sx_slock(&sc->sc_lock);
1965 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
1966 if (i >= isl->isl_nentries) {
1967 sx_sunlock(&sc->sc_lock);
1970 memset(&iss, 0, sizeof(iss));
1971 memcpy(&iss.iss_conf, &is->is_conf, sizeof(iss.iss_conf));
1972 iss.iss_id = is->is_id;
1973 strlcpy(iss.iss_target_alias, is->is_target_alias, sizeof(iss.iss_target_alias));
1974 strlcpy(iss.iss_reason, is->is_reason, sizeof(iss.iss_reason));
1975 strlcpy(iss.iss_offload, is->is_conn->ic_offload, sizeof(iss.iss_offload));
1977 if (is->is_conn->ic_header_crc32c)
1978 iss.iss_header_digest = ISCSI_DIGEST_CRC32C;
1980 iss.iss_header_digest = ISCSI_DIGEST_NONE;
1982 if (is->is_conn->ic_data_crc32c)
1983 iss.iss_data_digest = ISCSI_DIGEST_CRC32C;
1985 iss.iss_data_digest = ISCSI_DIGEST_NONE;
1987 iss.iss_max_send_data_segment_length =
1988 is->is_conn->ic_max_send_data_segment_length;
1989 iss.iss_max_recv_data_segment_length =
1990 is->is_conn->ic_max_recv_data_segment_length;
1991 iss.iss_max_burst_length = is->is_max_burst_length;
1992 iss.iss_first_burst_length = is->is_first_burst_length;
1993 iss.iss_immediate_data = is->is_immediate_data;
1994 iss.iss_connected = is->is_connected;
1996 error = copyout(&iss, isl->isl_pstates + i, sizeof(iss));
1998 sx_sunlock(&sc->sc_lock);
2003 sx_sunlock(&sc->sc_lock);
2005 isl->isl_nentries = i;
2011 iscsi_ioctl_session_modify(struct iscsi_softc *sc,
2012 struct iscsi_session_modify *ism)
2014 struct iscsi_session *is;
2015 const struct iscsi_session *is2;
2017 iscsi_sanitize_session_conf(&ism->ism_conf);
2018 if (iscsi_valid_session_conf(&ism->ism_conf) == false)
2021 sx_xlock(&sc->sc_lock);
2022 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
2023 ISCSI_SESSION_LOCK(is);
2024 if (is->is_id == ism->ism_session_id) {
2025 /* Note that the session remains locked. */
2028 ISCSI_SESSION_UNLOCK(is);
2031 sx_xunlock(&sc->sc_lock);
2036 * Prevent duplicates.
2038 TAILQ_FOREACH(is2, &sc->sc_sessions, is_next) {
2042 if (!!ism->ism_conf.isc_discovery !=
2043 !!is2->is_conf.isc_discovery)
2046 if (strcmp(ism->ism_conf.isc_target_addr,
2047 is2->is_conf.isc_target_addr) != 0)
2050 if (ism->ism_conf.isc_discovery == 0 &&
2051 strcmp(ism->ism_conf.isc_target,
2052 is2->is_conf.isc_target) != 0)
2055 ISCSI_SESSION_UNLOCK(is);
2056 sx_xunlock(&sc->sc_lock);
2060 sx_xunlock(&sc->sc_lock);
2062 memcpy(&is->is_conf, &ism->ism_conf, sizeof(is->is_conf));
2063 ISCSI_SESSION_UNLOCK(is);
2065 iscsi_session_reconnect(is);
2071 iscsi_ioctl(struct cdev *dev, u_long cmd, caddr_t arg, int mode,
2074 struct iscsi_softc *sc;
2080 return (iscsi_ioctl_daemon_wait(sc,
2081 (struct iscsi_daemon_request *)arg));
2083 return (iscsi_ioctl_daemon_handoff(sc,
2084 (struct iscsi_daemon_handoff *)arg));
2086 return (iscsi_ioctl_daemon_fail(sc,
2087 (struct iscsi_daemon_fail *)arg));
2088 #ifdef ICL_KERNEL_PROXY
2090 return (iscsi_ioctl_daemon_connect(sc,
2091 (struct iscsi_daemon_connect *)arg));
2093 return (iscsi_ioctl_daemon_send(sc,
2094 (struct iscsi_daemon_send *)arg));
2096 return (iscsi_ioctl_daemon_receive(sc,
2097 (struct iscsi_daemon_receive *)arg));
2098 #endif /* ICL_KERNEL_PROXY */
2100 return (iscsi_ioctl_session_add(sc,
2101 (struct iscsi_session_add *)arg));
2103 return (iscsi_ioctl_session_remove(sc,
2104 (struct iscsi_session_remove *)arg));
2106 return (iscsi_ioctl_session_list(sc,
2107 (struct iscsi_session_list *)arg));
2109 return (iscsi_ioctl_session_modify(sc,
2110 (struct iscsi_session_modify *)arg));
2116 static struct iscsi_outstanding *
2117 iscsi_outstanding_find(struct iscsi_session *is, uint32_t initiator_task_tag)
2119 struct iscsi_outstanding *io;
2121 ISCSI_SESSION_LOCK_ASSERT(is);
2123 TAILQ_FOREACH(io, &is->is_outstanding, io_next) {
2124 if (io->io_initiator_task_tag == initiator_task_tag)
2130 static struct iscsi_outstanding *
2131 iscsi_outstanding_find_ccb(struct iscsi_session *is, union ccb *ccb)
2133 struct iscsi_outstanding *io;
2135 ISCSI_SESSION_LOCK_ASSERT(is);
2137 TAILQ_FOREACH(io, &is->is_outstanding, io_next) {
2138 if (io->io_ccb == ccb)
2144 static struct iscsi_outstanding *
2145 iscsi_outstanding_add(struct iscsi_session *is, struct icl_pdu *request,
2146 union ccb *ccb, uint32_t *initiator_task_tagp)
2148 struct iscsi_outstanding *io;
2151 ISCSI_SESSION_LOCK_ASSERT(is);
2153 io = uma_zalloc(iscsi_outstanding_zone, M_NOWAIT | M_ZERO);
2155 ISCSI_SESSION_WARN(is, "failed to allocate %zd bytes",
2160 error = icl_conn_task_setup(is->is_conn, request, &ccb->csio,
2161 initiator_task_tagp, &io->io_icl_prv);
2163 ISCSI_SESSION_WARN(is,
2164 "icl_conn_task_setup() failed with error %d", error);
2165 uma_zfree(iscsi_outstanding_zone, io);
2169 KASSERT(iscsi_outstanding_find(is, *initiator_task_tagp) == NULL,
2170 ("initiator_task_tag 0x%x already added", *initiator_task_tagp));
2172 io->io_initiator_task_tag = *initiator_task_tagp;
2174 TAILQ_INSERT_TAIL(&is->is_outstanding, io, io_next);
2179 iscsi_outstanding_remove(struct iscsi_session *is, struct iscsi_outstanding *io)
2182 ISCSI_SESSION_LOCK_ASSERT(is);
2184 icl_conn_task_done(is->is_conn, io->io_icl_prv);
2185 TAILQ_REMOVE(&is->is_outstanding, io, io_next);
2186 uma_zfree(iscsi_outstanding_zone, io);
2190 iscsi_action_abort(struct iscsi_session *is, union ccb *ccb)
2192 struct icl_pdu *request;
2193 struct iscsi_bhs_task_management_request *bhstmr;
2194 struct ccb_abort *cab = &ccb->cab;
2195 struct iscsi_outstanding *io, *aio;
2196 uint32_t initiator_task_tag;
2198 ISCSI_SESSION_LOCK_ASSERT(is);
2201 KASSERT(is->is_login_phase == false, ("%s called during Login Phase", __func__));
2203 if (is->is_login_phase) {
2204 ccb->ccb_h.status = CAM_REQ_ABORTED;
2210 aio = iscsi_outstanding_find_ccb(is, cab->abort_ccb);
2212 ccb->ccb_h.status = CAM_REQ_CMP;
2217 request = icl_pdu_new(is->is_conn, M_NOWAIT);
2218 if (request == NULL) {
2219 ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
2224 initiator_task_tag = is->is_initiator_task_tag++;
2225 if (initiator_task_tag == 0xffffffff)
2226 initiator_task_tag = is->is_initiator_task_tag++;
2228 io = iscsi_outstanding_add(is, request, NULL, &initiator_task_tag);
2230 icl_pdu_free(request);
2231 ccb->ccb_h.status = CAM_RESRC_UNAVAIL;
2235 io->io_referenced_task_tag = aio->io_initiator_task_tag;
2237 bhstmr = (struct iscsi_bhs_task_management_request *)request->ip_bhs;
2238 bhstmr->bhstmr_opcode = ISCSI_BHS_OPCODE_TASK_REQUEST;
2239 bhstmr->bhstmr_function = 0x80 | BHSTMR_FUNCTION_ABORT_TASK;
2240 bhstmr->bhstmr_lun = htobe64(CAM_EXTLUN_BYTE_SWIZZLE(ccb->ccb_h.target_lun));
2241 bhstmr->bhstmr_initiator_task_tag = initiator_task_tag;
2242 bhstmr->bhstmr_referenced_task_tag = aio->io_initiator_task_tag;
2244 iscsi_pdu_queue_locked(request);
2248 iscsi_action_scsiio(struct iscsi_session *is, union ccb *ccb)
2250 struct icl_pdu *request;
2251 struct iscsi_bhs_scsi_command *bhssc;
2252 struct ccb_scsiio *csio;
2253 struct iscsi_outstanding *io;
2255 uint32_t initiator_task_tag;
2258 ISCSI_SESSION_LOCK_ASSERT(is);
2261 KASSERT(is->is_login_phase == false, ("%s called during Login Phase", __func__));
2263 if (is->is_login_phase) {
2264 ISCSI_SESSION_DEBUG(is, "called during login phase");
2265 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
2266 xpt_freeze_devq(ccb->ccb_h.path, 1);
2267 ISCSI_SESSION_DEBUG(is, "freezing devq");
2269 ccb->ccb_h.status = CAM_REQ_ABORTED | CAM_DEV_QFRZN;
2275 request = icl_pdu_new(is->is_conn, M_NOWAIT);
2276 if (request == NULL) {
2277 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
2278 xpt_freeze_devq(ccb->ccb_h.path, 1);
2279 ISCSI_SESSION_DEBUG(is, "freezing devq");
2281 ccb->ccb_h.status = CAM_RESRC_UNAVAIL | CAM_DEV_QFRZN;
2286 initiator_task_tag = is->is_initiator_task_tag++;
2287 if (initiator_task_tag == 0xffffffff)
2288 initiator_task_tag = is->is_initiator_task_tag++;
2290 io = iscsi_outstanding_add(is, request, ccb, &initiator_task_tag);
2292 icl_pdu_free(request);
2293 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
2294 xpt_freeze_devq(ccb->ccb_h.path, 1);
2295 ISCSI_SESSION_DEBUG(is, "freezing devq");
2297 ccb->ccb_h.status = CAM_RESRC_UNAVAIL | CAM_DEV_QFRZN;
2303 bhssc = (struct iscsi_bhs_scsi_command *)request->ip_bhs;
2304 bhssc->bhssc_opcode = ISCSI_BHS_OPCODE_SCSI_COMMAND;
2305 bhssc->bhssc_flags |= BHSSC_FLAGS_F;
2306 switch (csio->ccb_h.flags & CAM_DIR_MASK) {
2308 bhssc->bhssc_flags |= BHSSC_FLAGS_R;
2311 bhssc->bhssc_flags |= BHSSC_FLAGS_W;
2315 if ((ccb->ccb_h.flags & CAM_TAG_ACTION_VALID) != 0) {
2316 switch (csio->tag_action) {
2317 case MSG_HEAD_OF_Q_TAG:
2318 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_HOQ;
2320 case MSG_ORDERED_Q_TAG:
2321 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_ORDERED;
2324 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_ACA;
2326 case MSG_SIMPLE_Q_TAG:
2328 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_SIMPLE;
2332 bhssc->bhssc_flags |= BHSSC_FLAGS_ATTR_UNTAGGED;
2334 if (is->is_protocol_level >= 2) {
2335 bhssc->bhssc_pri = (csio->priority << BHSSC_PRI_SHIFT) &
2339 bhssc->bhssc_lun = htobe64(CAM_EXTLUN_BYTE_SWIZZLE(ccb->ccb_h.target_lun));
2340 bhssc->bhssc_initiator_task_tag = initiator_task_tag;
2341 bhssc->bhssc_expected_data_transfer_length = htonl(csio->dxfer_len);
2342 KASSERT(csio->cdb_len <= sizeof(bhssc->bhssc_cdb),
2343 ("unsupported CDB size %zd", (size_t)csio->cdb_len));
2345 if (csio->ccb_h.flags & CAM_CDB_POINTER)
2346 memcpy(&bhssc->bhssc_cdb, csio->cdb_io.cdb_ptr, csio->cdb_len);
2348 memcpy(&bhssc->bhssc_cdb, csio->cdb_io.cdb_bytes, csio->cdb_len);
2350 if (is->is_immediate_data &&
2351 (csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT) {
2352 len = csio->dxfer_len;
2353 //ISCSI_SESSION_DEBUG(is, "adding %zd of immediate data", len);
2354 if (len > is->is_first_burst_length) {
2355 ISCSI_SESSION_DEBUG(is, "len %zd -> %d", len, is->is_first_burst_length);
2356 len = is->is_first_burst_length;
2358 if (len > is->is_conn->ic_max_send_data_segment_length) {
2359 ISCSI_SESSION_DEBUG(is, "len %zd -> %d", len,
2360 is->is_conn->ic_max_send_data_segment_length);
2361 len = is->is_conn->ic_max_send_data_segment_length;
2364 error = icl_pdu_append_data(request, csio->data_ptr, len, M_NOWAIT);
2366 iscsi_outstanding_remove(is, io);
2367 icl_pdu_free(request);
2368 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
2369 xpt_freeze_devq(ccb->ccb_h.path, 1);
2370 ISCSI_SESSION_DEBUG(is, "freezing devq");
2372 ccb->ccb_h.status = CAM_RESRC_UNAVAIL | CAM_DEV_QFRZN;
2377 iscsi_pdu_queue_locked(request);
2381 iscsi_action(struct cam_sim *sim, union ccb *ccb)
2383 struct iscsi_session *is;
2385 is = cam_sim_softc(sim);
2387 ISCSI_SESSION_LOCK_ASSERT(is);
2389 if (is->is_terminating ||
2390 (is->is_connected == false && fail_on_disconnection)) {
2391 ccb->ccb_h.status = CAM_DEV_NOT_THERE;
2397 * Make sure CAM doesn't sneak in a CCB just after freezing the queue.
2399 if (is->is_simq_frozen == true) {
2400 ccb->ccb_h.status &= ~(CAM_SIM_QUEUED | CAM_STATUS_MASK);
2401 ccb->ccb_h.status |= CAM_REQUEUE_REQ;
2402 /* Don't freeze the devq - the SIM queue is already frozen. */
2407 switch (ccb->ccb_h.func_code) {
2410 struct ccb_pathinq *cpi = &ccb->cpi;
2412 cpi->version_num = 1;
2413 cpi->hba_inquiry = PI_TAG_ABLE;
2414 cpi->target_sprt = 0;
2415 cpi->hba_misc = PIM_EXTLUNS;
2417 * XXX: It shouldn't ever be NULL; this could be turned
2418 * into a KASSERT eventually.
2420 if (is->is_conn == NULL)
2421 ISCSI_WARN("NULL conn");
2422 else if (is->is_conn->ic_unmapped)
2423 cpi->hba_misc |= PIM_UNMAPPED;
2424 cpi->hba_eng_cnt = 0;
2425 cpi->max_target = 0;
2427 * Note that the variable below is only relevant for targets
2428 * that don't claim compliance with anything above SPC2, which
2429 * means they don't support REPORT_LUNS.
2432 cpi->initiator_id = ~0;
2433 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2434 strlcpy(cpi->hba_vid, "iSCSI", HBA_IDLEN);
2435 strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2436 cpi->unit_number = cam_sim_unit(sim);
2437 cpi->bus_id = cam_sim_bus(sim);
2438 cpi->base_transfer_speed = 150000; /* XXX */
2439 cpi->transport = XPORT_ISCSI;
2440 cpi->transport_version = 0;
2441 cpi->protocol = PROTO_SCSI;
2442 cpi->protocol_version = SCSI_REV_SPC3;
2443 cpi->maxio = maxphys;
2444 cpi->ccb_h.status = CAM_REQ_CMP;
2447 case XPT_GET_TRAN_SETTINGS:
2449 struct ccb_trans_settings *cts;
2450 struct ccb_trans_settings_scsi *scsi;
2453 scsi = &cts->proto_specific.scsi;
2455 cts->protocol = PROTO_SCSI;
2456 cts->protocol_version = SCSI_REV_SPC3;
2457 cts->transport = XPORT_ISCSI;
2458 cts->transport_version = 0;
2459 scsi->valid = CTS_SCSI_VALID_TQ;
2460 scsi->flags = CTS_SCSI_FLAGS_TAG_ENB;
2461 cts->ccb_h.status = CAM_REQ_CMP;
2464 case XPT_CALC_GEOMETRY:
2465 cam_calc_geometry(&ccb->ccg, /*extended*/1);
2466 ccb->ccb_h.status = CAM_REQ_CMP;
2470 * XXX: What's the point?
2474 ISCSI_SESSION_DEBUG(is, "faking success for reset, abort, or term_io");
2475 ccb->ccb_h.status = CAM_REQ_CMP;
2479 iscsi_action_abort(is, ccb);
2482 iscsi_action_scsiio(is, ccb);
2486 ISCSI_SESSION_DEBUG(is, "got unsupported code 0x%x", ccb->ccb_h.func_code);
2488 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
2495 iscsi_terminate_sessions(struct iscsi_softc *sc)
2497 struct iscsi_session *is;
2499 sx_slock(&sc->sc_lock);
2500 TAILQ_FOREACH(is, &sc->sc_sessions, is_next)
2501 iscsi_session_terminate(is);
2502 while(!TAILQ_EMPTY(&sc->sc_sessions)) {
2503 ISCSI_DEBUG("waiting for sessions to terminate");
2504 cv_wait(&sc->sc_cv, &sc->sc_lock);
2506 ISCSI_DEBUG("all sessions terminated");
2507 sx_sunlock(&sc->sc_lock);
2511 iscsi_shutdown_pre(struct iscsi_softc *sc)
2513 struct iscsi_session *is;
2515 if (!fail_on_shutdown)
2519 * If we have any sessions waiting for reconnection, request
2520 * maintenance thread to fail them immediately instead of waiting
2521 * for reconnect timeout.
2523 * This prevents LUNs with mounted filesystems that are supported
2524 * by disconnected iSCSI sessions from hanging, however it will
2525 * fail all queued BIOs.
2527 ISCSI_DEBUG("forcing failing all disconnected sessions due to shutdown");
2529 fail_on_disconnection = 1;
2531 sx_slock(&sc->sc_lock);
2532 TAILQ_FOREACH(is, &sc->sc_sessions, is_next) {
2533 ISCSI_SESSION_LOCK(is);
2534 if (!is->is_connected) {
2535 ISCSI_SESSION_DEBUG(is, "force failing disconnected session early");
2536 iscsi_session_reconnect(is);
2538 ISCSI_SESSION_UNLOCK(is);
2540 sx_sunlock(&sc->sc_lock);
2544 iscsi_shutdown_post(struct iscsi_softc *sc)
2547 if (!KERNEL_PANICKED()) {
2548 ISCSI_DEBUG("removing all sessions due to shutdown");
2549 iscsi_terminate_sessions(sc);
2558 sc = malloc(sizeof(*sc), M_ISCSI, M_ZERO | M_WAITOK);
2559 sx_init(&sc->sc_lock, "iscsi");
2560 TAILQ_INIT(&sc->sc_sessions);
2561 cv_init(&sc->sc_cv, "iscsi_cv");
2563 iscsi_outstanding_zone = uma_zcreate("iscsi_outstanding",
2564 sizeof(struct iscsi_outstanding), NULL, NULL, NULL, NULL,
2567 error = make_dev_p(MAKEDEV_CHECKNAME, &sc->sc_cdev, &iscsi_cdevsw,
2568 NULL, UID_ROOT, GID_WHEEL, 0600, "iscsi");
2570 ISCSI_WARN("failed to create device node, error %d", error);
2573 sc->sc_cdev->si_drv1 = sc;
2575 sc->sc_shutdown_pre_eh = EVENTHANDLER_REGISTER(shutdown_pre_sync,
2576 iscsi_shutdown_pre, sc, SHUTDOWN_PRI_FIRST);
2578 * shutdown_post_sync needs to run after filesystem shutdown and before
2579 * CAM shutdown - otherwise when rebooting with an iSCSI session that is
2580 * disconnected but has outstanding requests, dashutdown() will hang on
2581 * cam_periph_runccb().
2583 sc->sc_shutdown_post_eh = EVENTHANDLER_REGISTER(shutdown_post_sync,
2584 iscsi_shutdown_post, sc, SHUTDOWN_PRI_DEFAULT - 1);
2593 /* Awaken any threads asleep in iscsi_ioctl(). */
2594 sx_xlock(&sc->sc_lock);
2595 sc->sc_unloading = true;
2596 cv_signal(&sc->sc_cv);
2597 sx_xunlock(&sc->sc_lock);
2599 if (sc->sc_cdev != NULL) {
2600 ISCSI_DEBUG("removing device node");
2601 destroy_dev(sc->sc_cdev);
2602 ISCSI_DEBUG("device node removed");
2605 if (sc->sc_shutdown_pre_eh != NULL)
2606 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, sc->sc_shutdown_pre_eh);
2607 if (sc->sc_shutdown_post_eh != NULL)
2608 EVENTHANDLER_DEREGISTER(shutdown_post_sync, sc->sc_shutdown_post_eh);
2610 iscsi_terminate_sessions(sc);
2612 uma_zdestroy(iscsi_outstanding_zone);
2613 sx_destroy(&sc->sc_lock);
2614 cv_destroy(&sc->sc_cv);
2622 sx_slock(&sc->sc_lock);
2623 if (!TAILQ_EMPTY(&sc->sc_sessions)) {
2624 sx_sunlock(&sc->sc_lock);
2627 sx_sunlock(&sc->sc_lock);
2632 iscsi_modevent(module_t mod, int what, void *arg)
2638 error = iscsi_load();
2641 error = iscsi_unload();
2644 error = iscsi_quiesce();
2653 moduledata_t iscsi_data = {
2659 DECLARE_MODULE(iscsi, iscsi_data, SI_SUB_DRIVERS, SI_ORDER_MIDDLE);
2660 MODULE_DEPEND(iscsi, cam, 1, 1, 1);
2661 MODULE_DEPEND(iscsi, icl, 1, 1, 1);