2 * Copyright (c) 2005-2008 Daniel Braniss <danny@cs.huji.ac.il>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/dev/iscsi/initiator/isc_sm.c,v 1.3 2008/11/25 07:17:11 scottl Exp $
29 | iSCSI - Session Manager
30 | $Id: isc_sm.c,v 1.30 2007/04/22 09:53:09 danny Exp danny $
33 #include "opt_iscsi_initiator.h"
35 #include <sys/param.h>
36 #include <sys/kernel.h>
38 #include <sys/systm.h>
39 #include <sys/malloc.h>
40 #include <sys/ctype.h>
41 #include <sys/errno.h>
42 #include <sys/sysctl.h>
45 #include <sys/socketvar.h>
46 #include <sys/socket.h>
47 #include <sys/protosw.h>
49 #include <sys/ioccom.h>
50 #include <sys/queue.h>
51 #include <sys/kthread.h>
52 #include <sys/syslog.h>
55 #include <sys/eventhandler.h>
56 #include <sys/mutex.h>
58 #include <sys/thread2.h>
59 #include <sys/mutex2.h>
60 #include <sys/mplock2.h>
62 #include <bus/cam/cam.h>
63 #include <bus/cam/cam_ccb.h>
64 #include <bus/cam/cam_sim.h>
65 #include <bus/cam/cam_xpt_sim.h>
66 #include <bus/cam/cam_periph.h>
68 #include <dev/disk/iscsi/initiator/iscsi.h>
69 #include <dev/disk/iscsi/initiator/iscsivar.h>
72 _async(isc_session_t *sp, pduq_t *pq)
78 pdu_free(sp->isc, pq);
82 _reject(isc_session_t *sp, pduq_t *pq)
90 pdu = mtod(pq->mp, pdu_t *);
91 itt = pdu->ipdu.bhs.itt;
92 reject = &pq->pdu.ipdu.reject;
93 sdebug(2, "itt=%x reason=0x%x", ntohl(itt), reject->reason);
94 opq = i_search_hld(sp, itt, 0);
96 iscsi_reject(sp, opq, pq);
98 switch(pq->pdu.ipdu.bhs.opcode) {
99 case ISCSI_LOGOUT_CMD: // XXX: wasabi does this - can't figure out why
100 sdebug(2, "ISCSI_LOGOUT_CMD ...");
103 xdebug("%d] we lost something itt=%x",
104 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
107 pdu_free(sp->isc, pq);
111 _r2t(isc_session_t *sp, pduq_t *pq)
116 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 1);
118 iscsi_r2t(sp, opq, pq);
121 r2t_t *r2t = &pq->pdu.ipdu.r2t;
123 xdebug("%d] we lost something itt=%x r2tSN=%d bo=%x ddtl=%x",
124 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt),
125 ntohl(r2t->r2tSN), ntohl(r2t->bo), ntohl(r2t->ddtl));
127 pdu_free(sp->isc, pq);
131 _scsi_rsp(isc_session_t *sp, pduq_t *pq)
136 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 0);
137 debug(5, "itt=%x pq=%p opq=%p", ntohl(pq->pdu.ipdu.bhs.itt), pq, opq);
139 iscsi_done(sp, opq, pq);
141 xdebug("%d] we lost something itt=%x",
142 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
143 pdu_free(sp->isc, pq);
147 _read_data(isc_session_t *sp, pduq_t *pq)
152 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 1);
154 if(scsi_decap(sp, opq, pq) != 1) {
155 i_remove_hld(sp, opq); // done
156 pdu_free(sp->isc, opq);
160 xdebug("%d] we lost something itt=%x",
161 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
162 pdu_free(sp->isc, pq);
166 | the jury is not back with a veredict, user or kernel
169 _nop_out(isc_session_t *sp)
176 sdebug(4, "cws=%d", sp->cws);
179 | only send a nop if window is closed.
181 if((pq = pdu_alloc(sp->isc, M_NOWAIT)) == NULL)
182 // I guess we ran out of resources
184 nop_out = &pq->pdu.ipdu.nop_out;
185 nop_out->opcode = ISCSI_NOP_OUT;
186 nop_out->itt = htonl(sp->sn.itt);
190 if(isc_qout(sp, pq) != 0) {
192 pdu_free(sp->isc, pq);
198 _nop_in(isc_session_t *sp, pduq_t *pq)
200 pdu_t *pp = &pq->pdu;
201 nop_in_t *nop_in = &pp->ipdu.nop_in;
202 bhs_t *bhs = &pp->ipdu.bhs;
206 sdebug(5, "itt=%x ttt=%x", htonl(nop_in->itt), htonl(nop_in->ttt));
207 if(nop_in->itt == -1) {
208 if(pp->ds_len != 0) {
210 | according to RFC 3720 this should be zero
213 xdebug("%d] dslen not zero", sp->sid);
215 if(nop_in->ttt != -1) {
218 | target wants a nop_out
220 bhs->opcode = ISCSI_NOP_OUT;
224 | we are reusing the pdu, so bhs->ttt == nop_in->ttt;
225 | and need to zero out 'Reserved'
228 nop_out = &pp->ipdu.nop_out;
229 nop_out->sn.maxcmd = 0;
230 memset(nop_out->mbz, 0, sizeof(nop_out->mbz));
231 (void)isc_qout(sp, pq); //XXX: should check return?
235 // just making noise?
236 // see 10.9.1: target does not want and answer.
240 if(nop_in->ttt == -1) {
242 | it is an answer to a nop_in from us
244 if(nop_in->itt != -1) {
247 if(sp->flags & ISC_WAIT4PING) {
248 i_nqueue_rsp(sp, pq);
258 pdu_free(sp->isc, pq);
263 i_prepPDU(isc_session_t *sp, pduq_t *pq)
266 pdu_t *pp = &pq->pdu;
267 bhs_t *bhp = &pp->ipdu.bhs;
272 bhp->AHSLength = pp->ahs_len / 4;
279 #if BYTE_ORDER == LITTLE_ENDIAN
280 bhp->DSLength = ((n & 0x00ff0000) >> 16)
282 | ((n & 0x000000ff) << 16);
295 len -= sizeof(bhs_t);
296 if(sp->opt.maxBurstLength && (len > sp->opt.maxBurstLength)) {
297 xdebug("%d] pdu len=%zd > %d",
298 sp->sid, len, sp->opt.maxBurstLength);
299 // XXX: when this happens it used to hang ...
306 isc_qout(isc_session_t *sp, pduq_t *pq)
312 if(pq->len == 0 && (error = i_prepPDU(sp, pq)))
315 if(pq->pdu.ipdu.bhs.I)
316 i_nqueue_isnd(sp, pq);
318 if(pq->pdu.ipdu.data_out.opcode == ISCSI_WRITE_DATA)
319 i_nqueue_wsnd(sp, pq);
321 i_nqueue_csnd(sp, pq);
323 sdebug(5, "enqued: pq=%p", pq);
325 iscsi_lock_ex(&sp->io_mtx);
326 sp->flags |= ISC_OQNOTEMPTY;
327 if(sp->flags & ISC_OWAITING)
329 iscsi_unlock_ex(&sp->io_mtx);
334 | called when a fullPhase is restarted
337 ism_restart(isc_session_t *sp)
341 sdebug(2, "restart ...");
342 lastcmd = iscsi_requeue(sp);
344 if(lastcmd != sp->sn.cmd) {
345 sdebug(1, "resetting CmdSN to=%d (from %d)", lastcmd, sp->sn.cmd);
346 sp->sn.cmd = lastcmd;
349 iscsi_lock_ex(&sp->io_mtx);
350 if(sp->flags & ISC_OWAITING) {
353 iscsi_unlock_ex(&sp->io_mtx);
355 sdebug(2, "restarted lastcmd=0x%x", lastcmd);
359 ism_fullfeature(struct cdev *dev, int flag)
361 isc_session_t *sp = (isc_session_t *)dev->si_drv2;
364 sdebug(2, "flag=%d", flag);
369 sp->flags &= ~ISC_FFPHASE;
372 error = ic_fullfeature(dev);
382 ism_recv(isc_session_t *sp, pduq_t *pq)
389 bhs = &pq->pdu.ipdu.bhs;
390 statSN = ntohl(bhs->OpcodeSpecificFields[1]);
394 | this code is only for debugging.
398 if((sp->flags & ISC_STALLED) == 0) {
399 sdebug(4, "window closed: max=0x%x exp=0x%x opcode=0x%x cmd=0x%x cws=%d.",
400 sn->maxCmd, sn->expCmd, bhs->opcode, sn->cmd, sp->cws);
401 sp->flags |= ISC_STALLED;
403 if(sp->flags & ISC_STALLED) {
404 sdebug(4, "window opened: max=0x%x exp=0x%x opcode=0x%x cmd=0x%x cws=%d.",
405 sn->maxCmd, sn->expCmd, bhs->opcode, sn->cmd, sp->cws);
406 sp->flags &= ~ISC_STALLED;;
413 if(sp->sn.expCmd != sn->cmd) {
414 sdebug(1, "we lost something ... exp=0x%x cmd=0x%x",
415 sn->expCmd, sn->cmd);
418 sdebug(5, "opcode=0x%x itt=0x%x stat#0x%x maxcmd=0x%0x",
419 bhs->opcode, ntohl(bhs->itt), statSN, sp->sn.maxCmd);
421 switch(bhs->opcode) {
422 case ISCSI_READ_DATA: {
423 data_in_t *cmd = &pq->pdu.ipdu.data_in;
430 if(statSN > (sp->sn.stat + 1)) {
431 sdebug(1, "we lost some rec=0x%x exp=0x%x",
432 statSN, sp->sn.stat);
433 // XXX: must do some error recovery here.
435 sp->sn.stat = statSN;
438 switch(bhs->opcode) {
439 case ISCSI_LOGIN_RSP:
441 case ISCSI_LOGOUT_RSP:
442 i_nqueue_rsp(sp, pq);
444 sdebug(3, "wakeup rsp");
447 case ISCSI_NOP_IN: _nop_in(sp, pq); break;
448 case ISCSI_SCSI_RSP: _scsi_rsp(sp, pq); break;
449 case ISCSI_READ_DATA: _read_data(sp, pq); break;
450 case ISCSI_R2T: _r2t(sp, pq); break;
451 case ISCSI_REJECT: _reject(sp, pq); break;
452 case ISCSI_ASYNC: _async(sp, pq); break;
456 sdebug(1, "opcode=0x%x itt=0x%x not implemented yet",
457 bhs->opcode, ntohl(bhs->itt));
463 | go through the out queues looking for work
464 | if either nothing to do, or window is closed
468 proc_out(isc_session_t *sp)
478 while(sp->flags & ISC_LINK_UP) {
482 | check if there is outstanding work in:
483 | 1- the Immediate queue
485 | 3- the cmd queue, only if the command window allows it.
487 which = BIT(0) | BIT(1);
488 if(SNA_GT(sn->cmd, sn->maxCmd) == 0) // if(sn->maxCmd - sn->smc + 1) > 0
491 sdebug(4, "which=%d sn->maxCmd=%d sn->cmd=%d", which, sn->maxCmd, sn->cmd);
493 if((pq = i_dqueue_snd(sp, which)) == NULL)
495 sdebug(4, "pq=%p", pq);
499 switch(bhs->opcode) {
502 bhs->itt = htonl(sn->itt);
504 case ISCSI_LOGIN_CMD:
506 case ISCSI_LOGOUT_CMD:
510 bhs->CmdSN = htonl(sn->cmd);
514 case ISCSI_WRITE_DATA:
515 bhs->ExpStSN = htonl(sn->stat);
519 // XXX: can this happen?
520 xdebug("bad opcode=0x%x sn(cmd=0x%x expCmd=0x%x maxCmd=0x%x expStat=0x%x itt=0x%x)",
522 sn->cmd, sn->expCmd, sn->maxCmd, sn->expStat, sn->itt);
526 sdebug(4, "opcode=0x%x sn(cmd=0x%x expCmd=0x%x maxCmd=0x%x expStat=0x%x itt=0x%x)",
528 sn->cmd, sn->expCmd, sn->maxCmd, sn->expStat, sn->itt);
531 i_nqueue_hld(sp, pq);
533 if((error = isc_sendPDU(sp, pq)) == 0) {
536 pdu_free(sp->isc, pq);
539 xdebug("error=%d ndone=%d opcode=0x%x ccb=%p itt=%x",
540 error, ndone, bhs->opcode, pq->ccb, ntohl(bhs->itt));
542 i_remove_hld(sp, pq);
545 sp->flags &= ~ISC_LINK_UP;
549 i_rqueue_pdu(sp, pq);
554 xdebug("back to cam");
555 pq->ccb->ccb_h.status |= CAM_REQUEUE_REQ; // some better error?
556 XPT_DONE(sp->isc, pq->ccb);
557 pdu_free(sp->isc, pq);
560 xdebug("we lost it!");
568 | survives link breakdowns.
573 isc_session_t *sp = (isc_session_t *)vp;
579 sdebug(3, "started sp->flags=%x", sp->flags);
581 if((sp->flags & ISC_HOLD) == 0) {
582 error = proc_out(sp);
584 sdebug(3, "error=%d", error);
587 iscsi_lock_ex(&sp->io_mtx);
588 if((sp->flags & ISC_LINK_UP) == 0) {
592 if((sp->flags & (ISC_OQNOTEMPTY | ISC_SM_RUN)) == ISC_SM_RUN) {
593 sp->flags |= ISC_OWAITING;
594 if(issleep(&sp->flags, &sp->io_mtx, 0, "iscproc", hz*30) == EWOULDBLOCK) {
595 if(sp->flags & ISC_CON_RUNNING)
598 sp->flags &= ~ISC_OWAITING;
600 sp->flags &= ~ISC_OQNOTEMPTY;
601 iscsi_unlock_ex(&sp->io_mtx);
602 } while(sp->flags & ISC_SM_RUN);
604 sp->flags &= ~ISC_SM_RUNNING;
605 sdebug(3, "dropped ISC_SM_RUNNING");
609 debug(3, "terminated sp=%p sp->sid=%d", sp, sp->sid);
616 isc_dump_options(SYSCTL_HANDLER_ARGS)
622 sp = (isc_session_t *)arg1;
624 ksprintf(bp, "targetname='%s'", sp->opt.targetName);
626 ksprintf(bp, " targetname='%s'", sp->opt.targetAddress);
627 error = SYSCTL_OUT(req, buf, strlen(buf));
633 isc_dump_stats(SYSCTL_HANDLER_ARGS)
636 struct isc_softc *sc;
640 sp = (isc_session_t *)arg1;
645 ksnprintf(bp, n, "recv=%d sent=%d", sp->stats.nrecv, sp->stats.nsent);
648 ksnprintf(bp, n, " flags=0x%08x pdus-alloc=%d pdus-max=%d",
649 sp->flags, sc->npdu_alloc, sc->npdu_max);
652 ksnprintf(bp, n, " cws=%d cmd=%x exp=%x max=%x stat=%x itt=%x",
653 sp->cws, sp->sn.cmd, sp->sn.expCmd, sp->sn.maxCmd, sp->sn.stat, sp->sn.itt);
654 error = SYSCTL_OUT(req, buf, strlen(buf));
659 isc_sysctl_targetName(SYSCTL_HANDLER_ARGS)
665 ksnprintf(buf, sizeof(buf), "%s", *cp);
666 error = SYSCTL_OUT(req, buf, strlen(buf));
670 isc_sysctl_targetAddress(SYSCTL_HANDLER_ARGS)
676 ksnprintf(buf, sizeof(buf), "%s", *cp);
677 error = SYSCTL_OUT(req, buf, strlen(buf));
681 isc_add_sysctls(isc_session_t *sp)
684 sdebug(6, "sid=%d %s", sp->sid, sp->dev->si_name);
686 sysctl_ctx_init(&sp->clist);
687 sp->oid = SYSCTL_ADD_NODE(&sp->clist,
688 SYSCTL_CHILDREN(sp->isc->oid),
690 sp->dev->si_name+5, // iscsi0
694 SYSCTL_ADD_PROC(&sp->clist,
695 SYSCTL_CHILDREN(sp->oid),
699 (void *)&sp->opt.targetName, 0,
700 isc_sysctl_targetName, "A", "target name");
702 SYSCTL_ADD_PROC(&sp->clist,
703 SYSCTL_CHILDREN(sp->oid),
707 (void *)&sp->opt.targetAddress, 0,
708 isc_sysctl_targetAddress, "A", "target address");
710 SYSCTL_ADD_PROC(&sp->clist,
711 SYSCTL_CHILDREN(sp->oid),
716 isc_dump_stats, "A", "statistics");
718 SYSCTL_ADD_INT(&sp->clist,
719 SYSCTL_CHILDREN(sp->oid),
723 &sp->douio, 0, "enable uio on read");
727 ism_stop(isc_session_t *sp)
729 struct isc_softc *sc = sp->isc;
733 sdebug(2, "terminating");
735 | first stop the receiver
737 isc_stop_receiver(sp);
740 | now stop the xmitter
742 sp->flags &= ~ISC_SM_RUN;
743 while(sp->flags & ISC_SM_RUNNING) {
744 sdebug(2, "waiting for ism to stop");
746 tsleep(sp, 0, "-", hz);
748 sdebug(2, "ism stopped");
749 sp->flags &= ~ISC_FFPHASE;
753 (void)i_pdu_flush(sp);
755 ic_lost_target(sp, sp->sid);
757 lockmgr(&sc->lock, LK_EXCLUSIVE);
758 TAILQ_REMOVE(&sc->isc_sess, sp, sp_link);
760 lockmgr(&sc->lock, LK_RELEASE);
768 mtx_uninit(&sp->rsp_mtx);
769 mtx_uninit(&sp->rsv_mtx);
770 mtx_uninit(&sp->hld_mtx);
771 mtx_uninit(&sp->snd_mtx);
772 mtx_uninit(&sp->io_mtx);
775 sc->sessions[sp->sid] = NULL;
777 if(sysctl_ctx_free(&sp->clist))
778 xdebug("sysctl_ctx_free failed");
784 ism_start(isc_session_t *sp)
788 | now is a good time to do some initialization
790 TAILQ_INIT(&sp->rsp);
791 TAILQ_INIT(&sp->rsv);
792 TAILQ_INIT(&sp->csnd);
793 TAILQ_INIT(&sp->isnd);
794 TAILQ_INIT(&sp->wsnd);
795 TAILQ_INIT(&sp->hld);
797 mtx_init(&sp->rsv_mtx);
798 mtx_init(&sp->rsp_mtx);
799 mtx_init(&sp->snd_mtx);
800 mtx_init(&sp->hld_mtx);
802 mtx_init(&sp->io_mtx);
806 sp->flags |= ISC_SM_RUN;
807 sp->flags |= ISC_SM_RUNNING;
809 debug(4, "starting ism_proc: sp->sid=%d", sp->sid);
810 return kthread_create(ism_proc, sp, &sp->stp, "ism_%d", sp->sid);