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>
57 #include <sys/thread2.h>
58 #include <sys/mutex2.h>
59 #include <sys/mplock2.h>
61 #include <bus/cam/cam.h>
62 #include <bus/cam/cam_ccb.h>
63 #include <bus/cam/cam_sim.h>
64 #include <bus/cam/cam_xpt_sim.h>
65 #include <bus/cam/cam_periph.h>
67 #include <dev/disk/iscsi/initiator/iscsi.h>
68 #include <dev/disk/iscsi/initiator/iscsivar.h>
71 _async(isc_session_t *sp, pduq_t *pq)
77 pdu_free(sp->isc, pq);
81 _reject(isc_session_t *sp, pduq_t *pq)
89 pdu = mtod(pq->mp, pdu_t *);
90 itt = pdu->ipdu.bhs.itt;
91 reject = &pq->pdu.ipdu.reject;
92 sdebug(2, "itt=%x reason=0x%x", ntohl(itt), reject->reason);
93 opq = i_search_hld(sp, itt, 0);
95 iscsi_reject(sp, opq, pq);
97 switch(pq->pdu.ipdu.bhs.opcode) {
98 case ISCSI_LOGOUT_CMD: // XXX: wasabi does this - can't figure out why
99 sdebug(2, "ISCSI_LOGOUT_CMD ...");
102 xdebug("%d] we lost something itt=%x",
103 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
106 pdu_free(sp->isc, pq);
110 _r2t(isc_session_t *sp, pduq_t *pq)
115 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 1);
117 iscsi_r2t(sp, opq, pq);
120 r2t_t *r2t = &pq->pdu.ipdu.r2t;
122 xdebug("%d] we lost something itt=%x r2tSN=%d bo=%x ddtl=%x",
123 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt),
124 ntohl(r2t->r2tSN), ntohl(r2t->bo), ntohl(r2t->ddtl));
126 pdu_free(sp->isc, pq);
130 _scsi_rsp(isc_session_t *sp, pduq_t *pq)
135 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 0);
136 debug(5, "itt=%x pq=%p opq=%p", ntohl(pq->pdu.ipdu.bhs.itt), pq, opq);
138 iscsi_done(sp, opq, pq);
140 xdebug("%d] we lost something itt=%x",
141 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
142 pdu_free(sp->isc, pq);
146 _read_data(isc_session_t *sp, pduq_t *pq)
151 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 1);
153 if(scsi_decap(sp, opq, pq) != 1) {
154 i_remove_hld(sp, opq); // done
155 pdu_free(sp->isc, opq);
159 xdebug("%d] we lost something itt=%x",
160 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
161 pdu_free(sp->isc, pq);
165 | the jury is not back with a veredict, user or kernel
168 _nop_out(isc_session_t *sp)
175 sdebug(4, "cws=%d", sp->cws);
178 | only send a nop if window is closed.
180 if((pq = pdu_alloc(sp->isc, M_NOWAIT)) == NULL)
181 // I guess we ran out of resources
183 nop_out = &pq->pdu.ipdu.nop_out;
184 nop_out->opcode = ISCSI_NOP_OUT;
185 nop_out->itt = htonl(sp->sn.itt);
189 if(isc_qout(sp, pq) != 0) {
191 pdu_free(sp->isc, pq);
197 _nop_in(isc_session_t *sp, pduq_t *pq)
199 pdu_t *pp = &pq->pdu;
200 nop_in_t *nop_in = &pp->ipdu.nop_in;
201 bhs_t *bhs = &pp->ipdu.bhs;
205 sdebug(5, "itt=%x ttt=%x", htonl(nop_in->itt), htonl(nop_in->ttt));
206 if(nop_in->itt == -1) {
207 if(pp->ds_len != 0) {
209 | according to RFC 3720 this should be zero
212 xdebug("%d] dslen not zero", sp->sid);
214 if(nop_in->ttt != -1) {
217 | target wants a nop_out
219 bhs->opcode = ISCSI_NOP_OUT;
223 | we are reusing the pdu, so bhs->ttt == nop_in->ttt;
224 | and need to zero out 'Reserved'
227 nop_out = &pp->ipdu.nop_out;
228 nop_out->sn.maxcmd = 0;
229 memset(nop_out->mbz, 0, sizeof(nop_out->mbz));
230 (void)isc_qout(sp, pq); //XXX: should check return?
234 // just making noise?
235 // see 10.9.1: target does not want and answer.
239 if(nop_in->ttt == -1) {
241 | it is an answer to a nop_in from us
243 if(nop_in->itt != -1) {
246 if(sp->flags & ISC_WAIT4PING) {
247 i_nqueue_rsp(sp, pq);
257 pdu_free(sp->isc, pq);
262 i_prepPDU(isc_session_t *sp, pduq_t *pq)
265 pdu_t *pp = &pq->pdu;
266 bhs_t *bhp = &pp->ipdu.bhs;
271 bhp->AHSLength = pp->ahs_len / 4;
278 #if BYTE_ORDER == LITTLE_ENDIAN
279 bhp->DSLength = ((n & 0x00ff0000) >> 16)
281 | ((n & 0x000000ff) << 16);
294 len -= sizeof(bhs_t);
295 if(sp->opt.maxBurstLength && (len > sp->opt.maxBurstLength)) {
296 xdebug("%d] pdu len=%zd > %d",
297 sp->sid, len, sp->opt.maxBurstLength);
298 // XXX: when this happens it used to hang ...
305 isc_qout(isc_session_t *sp, pduq_t *pq)
311 if(pq->len == 0 && (error = i_prepPDU(sp, pq)))
314 if(pq->pdu.ipdu.bhs.I)
315 i_nqueue_isnd(sp, pq);
317 if(pq->pdu.ipdu.data_out.opcode == ISCSI_WRITE_DATA)
318 i_nqueue_wsnd(sp, pq);
320 i_nqueue_csnd(sp, pq);
322 sdebug(5, "enqued: pq=%p", pq);
324 iscsi_lock_ex(&sp->io_mtx);
325 sp->flags |= ISC_OQNOTEMPTY;
326 if(sp->flags & ISC_OWAITING)
328 iscsi_unlock_ex(&sp->io_mtx);
333 | called when a fullPhase is restarted
336 ism_restart(isc_session_t *sp)
340 sdebug(2, "restart ...");
341 lastcmd = iscsi_requeue(sp);
343 if(lastcmd != sp->sn.cmd) {
344 sdebug(1, "resetting CmdSN to=%d (from %d)", lastcmd, sp->sn.cmd);
345 sp->sn.cmd = lastcmd;
348 iscsi_lock_ex(&sp->io_mtx);
349 if(sp->flags & ISC_OWAITING) {
352 iscsi_unlock_ex(&sp->io_mtx);
354 sdebug(2, "restarted lastcmd=0x%x", lastcmd);
358 ism_fullfeature(struct cdev *dev, int flag)
360 isc_session_t *sp = (isc_session_t *)dev->si_drv2;
363 sdebug(2, "flag=%d", flag);
368 sp->flags &= ~ISC_FFPHASE;
371 error = ic_fullfeature(dev);
381 ism_recv(isc_session_t *sp, pduq_t *pq)
388 bhs = &pq->pdu.ipdu.bhs;
389 statSN = ntohl(bhs->OpcodeSpecificFields[1]);
393 | this code is only for debugging.
397 if((sp->flags & ISC_STALLED) == 0) {
398 sdebug(4, "window closed: max=0x%x exp=0x%x opcode=0x%x cmd=0x%x cws=%d.",
399 sn->maxCmd, sn->expCmd, bhs->opcode, sn->cmd, sp->cws);
400 sp->flags |= ISC_STALLED;
402 if(sp->flags & ISC_STALLED) {
403 sdebug(4, "window opened: max=0x%x exp=0x%x opcode=0x%x cmd=0x%x cws=%d.",
404 sn->maxCmd, sn->expCmd, bhs->opcode, sn->cmd, sp->cws);
405 sp->flags &= ~ISC_STALLED;;
412 if(sp->sn.expCmd != sn->cmd) {
413 sdebug(1, "we lost something ... exp=0x%x cmd=0x%x",
414 sn->expCmd, sn->cmd);
417 sdebug(5, "opcode=0x%x itt=0x%x stat#0x%x maxcmd=0x%0x",
418 bhs->opcode, ntohl(bhs->itt), statSN, sp->sn.maxCmd);
420 switch(bhs->opcode) {
421 case ISCSI_READ_DATA: {
422 data_in_t *cmd = &pq->pdu.ipdu.data_in;
429 if(statSN > (sp->sn.stat + 1)) {
430 sdebug(1, "we lost some rec=0x%x exp=0x%x",
431 statSN, sp->sn.stat);
432 // XXX: must do some error recovery here.
434 sp->sn.stat = statSN;
437 switch(bhs->opcode) {
438 case ISCSI_LOGIN_RSP:
440 case ISCSI_LOGOUT_RSP:
441 i_nqueue_rsp(sp, pq);
443 sdebug(3, "wakeup rsp");
446 case ISCSI_NOP_IN: _nop_in(sp, pq); break;
447 case ISCSI_SCSI_RSP: _scsi_rsp(sp, pq); break;
448 case ISCSI_READ_DATA: _read_data(sp, pq); break;
449 case ISCSI_R2T: _r2t(sp, pq); break;
450 case ISCSI_REJECT: _reject(sp, pq); break;
451 case ISCSI_ASYNC: _async(sp, pq); break;
455 sdebug(1, "opcode=0x%x itt=0x%x not implemented yet",
456 bhs->opcode, ntohl(bhs->itt));
462 | go through the out queues looking for work
463 | if either nothing to do, or window is closed
467 proc_out(isc_session_t *sp)
477 while(sp->flags & ISC_LINK_UP) {
481 | check if there is outstanding work in:
482 | 1- the Immediate queue
484 | 3- the cmd queue, only if the command window allows it.
486 which = BIT(0) | BIT(1);
487 if(SNA_GT(sn->cmd, sn->maxCmd) == 0) // if(sn->maxCmd - sn->smc + 1) > 0
490 sdebug(4, "which=%d sn->maxCmd=%d sn->cmd=%d", which, sn->maxCmd, sn->cmd);
492 if((pq = i_dqueue_snd(sp, which)) == NULL)
494 sdebug(4, "pq=%p", pq);
498 switch(bhs->opcode) {
501 bhs->itt = htonl(sn->itt);
503 case ISCSI_LOGIN_CMD:
505 case ISCSI_LOGOUT_CMD:
509 bhs->CmdSN = htonl(sn->cmd);
513 case ISCSI_WRITE_DATA:
514 bhs->ExpStSN = htonl(sn->stat);
518 // XXX: can this happen?
519 xdebug("bad opcode=0x%x sn(cmd=0x%x expCmd=0x%x maxCmd=0x%x expStat=0x%x itt=0x%x)",
521 sn->cmd, sn->expCmd, sn->maxCmd, sn->expStat, sn->itt);
525 sdebug(4, "opcode=0x%x sn(cmd=0x%x expCmd=0x%x maxCmd=0x%x expStat=0x%x itt=0x%x)",
527 sn->cmd, sn->expCmd, sn->maxCmd, sn->expStat, sn->itt);
530 i_nqueue_hld(sp, pq);
532 if((error = isc_sendPDU(sp, pq)) == 0) {
535 pdu_free(sp->isc, pq);
538 xdebug("error=%d ndone=%d opcode=0x%x ccb=%p itt=%x",
539 error, ndone, bhs->opcode, pq->ccb, ntohl(bhs->itt));
541 i_remove_hld(sp, pq);
544 sp->flags &= ~ISC_LINK_UP;
548 i_rqueue_pdu(sp, pq);
553 xdebug("back to cam");
554 pq->ccb->ccb_h.status |= CAM_REQUEUE_REQ; // some better error?
555 XPT_DONE(sp->isc, pq->ccb);
556 pdu_free(sp->isc, pq);
559 xdebug("we lost it!");
567 | survives link breakdowns.
572 isc_session_t *sp = (isc_session_t *)vp;
578 sdebug(3, "started sp->flags=%x", sp->flags);
580 if((sp->flags & ISC_HOLD) == 0) {
581 error = proc_out(sp);
583 sdebug(3, "error=%d", error);
586 iscsi_lock_ex(&sp->io_mtx);
587 if((sp->flags & ISC_LINK_UP) == 0) {
591 if((sp->flags & (ISC_OQNOTEMPTY | ISC_SM_RUN)) == ISC_SM_RUN) {
592 sp->flags |= ISC_OWAITING;
593 if(issleep(&sp->flags, &sp->io_mtx, 0, "iscproc", hz*30) == EWOULDBLOCK) {
594 if(sp->flags & ISC_CON_RUNNING)
597 sp->flags &= ~ISC_OWAITING;
599 sp->flags &= ~ISC_OQNOTEMPTY;
600 iscsi_unlock_ex(&sp->io_mtx);
601 } while(sp->flags & ISC_SM_RUN);
603 sp->flags &= ~ISC_SM_RUNNING;
604 sdebug(3, "dropped ISC_SM_RUNNING");
608 debug(3, "terminated sp=%p sp->sid=%d", sp, sp->sid);
615 isc_dump_options(SYSCTL_HANDLER_ARGS)
621 sp = (isc_session_t *)arg1;
623 ksprintf(bp, "targetname='%s'", sp->opt.targetName);
625 ksprintf(bp, " targetname='%s'", sp->opt.targetAddress);
626 error = SYSCTL_OUT(req, buf, strlen(buf));
632 isc_dump_stats(SYSCTL_HANDLER_ARGS)
635 struct isc_softc *sc;
639 sp = (isc_session_t *)arg1;
644 ksnprintf(bp, n, "recv=%d sent=%d", sp->stats.nrecv, sp->stats.nsent);
647 ksnprintf(bp, n, " flags=0x%08x pdus-alloc=%d pdus-max=%d",
648 sp->flags, sc->npdu_alloc, sc->npdu_max);
651 ksnprintf(bp, n, " cws=%d cmd=%x exp=%x max=%x stat=%x itt=%x",
652 sp->cws, sp->sn.cmd, sp->sn.expCmd, sp->sn.maxCmd, sp->sn.stat, sp->sn.itt);
653 error = SYSCTL_OUT(req, buf, strlen(buf));
658 isc_sysctl_targetName(SYSCTL_HANDLER_ARGS)
664 ksnprintf(buf, sizeof(buf), "%s", *cp);
665 error = SYSCTL_OUT(req, buf, strlen(buf));
669 isc_sysctl_targetAddress(SYSCTL_HANDLER_ARGS)
675 ksnprintf(buf, sizeof(buf), "%s", *cp);
676 error = SYSCTL_OUT(req, buf, strlen(buf));
680 isc_add_sysctls(isc_session_t *sp)
683 sdebug(6, "sid=%d %s", sp->sid, sp->dev->si_name);
685 sysctl_ctx_init(&sp->clist);
686 sp->oid = SYSCTL_ADD_NODE(&sp->clist,
687 SYSCTL_CHILDREN(sp->isc->oid),
689 sp->dev->si_name+5, // iscsi0
693 SYSCTL_ADD_PROC(&sp->clist,
694 SYSCTL_CHILDREN(sp->oid),
698 (void *)&sp->opt.targetName, 0,
699 isc_sysctl_targetName, "A", "target name");
701 SYSCTL_ADD_PROC(&sp->clist,
702 SYSCTL_CHILDREN(sp->oid),
706 (void *)&sp->opt.targetAddress, 0,
707 isc_sysctl_targetAddress, "A", "target address");
709 SYSCTL_ADD_PROC(&sp->clist,
710 SYSCTL_CHILDREN(sp->oid),
715 isc_dump_stats, "A", "statistics");
717 SYSCTL_ADD_INT(&sp->clist,
718 SYSCTL_CHILDREN(sp->oid),
722 &sp->douio, 0, "enable uio on read");
726 ism_stop(isc_session_t *sp)
728 struct isc_softc *sc = sp->isc;
732 sdebug(2, "terminating");
734 | first stop the receiver
736 isc_stop_receiver(sp);
739 | now stop the xmitter
741 sp->flags &= ~ISC_SM_RUN;
742 while(sp->flags & ISC_SM_RUNNING) {
743 sdebug(2, "waiting for ism to stop");
745 tsleep(sp, 0, "-", hz);
747 sdebug(2, "ism stopped");
748 sp->flags &= ~ISC_FFPHASE;
752 (void)i_pdu_flush(sp);
754 ic_lost_target(sp, sp->sid);
756 lockmgr(&sc->lock, LK_EXCLUSIVE);
757 TAILQ_REMOVE(&sc->isc_sess, sp, sp_link);
759 lockmgr(&sc->lock, LK_RELEASE);
767 mtx_uninit(&sp->rsp_mtx);
768 mtx_uninit(&sp->rsv_mtx);
769 mtx_uninit(&sp->hld_mtx);
770 mtx_uninit(&sp->snd_mtx);
771 mtx_uninit(&sp->io_mtx);
774 sc->sessions[sp->sid] = NULL;
776 if(sysctl_ctx_free(&sp->clist))
777 xdebug("sysctl_ctx_free failed");
783 ism_start(isc_session_t *sp)
787 | now is a good time to do some initialization
789 TAILQ_INIT(&sp->rsp);
790 TAILQ_INIT(&sp->rsv);
791 TAILQ_INIT(&sp->csnd);
792 TAILQ_INIT(&sp->isnd);
793 TAILQ_INIT(&sp->wsnd);
794 TAILQ_INIT(&sp->hld);
796 mtx_init(&sp->rsv_mtx);
797 mtx_init(&sp->rsp_mtx);
798 mtx_init(&sp->snd_mtx);
799 mtx_init(&sp->hld_mtx);
801 mtx_init(&sp->io_mtx);
805 sp->flags |= ISC_SM_RUN;
806 sp->flags |= ISC_SM_RUNNING;
808 debug(4, "starting ism_proc: sp->sid=%d", sp->sid);
809 return kthread_create(ism_proc, sp, &sp->stp, "ism_%d", sp->sid);