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
28 | iSCSI - Session Manager
29 | $Id: isc_sm.c,v 1.30 2007/04/22 09:53:09 danny Exp danny $
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include "opt_iscsi_initiator.h"
37 #include <sys/param.h>
38 #include <sys/kernel.h>
40 #include <sys/systm.h>
41 #include <sys/malloc.h>
42 #include <sys/ctype.h>
43 #include <sys/errno.h>
44 #include <sys/sysctl.h>
47 #include <sys/socketvar.h>
48 #include <sys/socket.h>
49 #include <sys/protosw.h>
51 #include <sys/ioccom.h>
52 #include <sys/queue.h>
53 #include <sys/kthread.h>
54 #include <sys/syslog.h>
59 #include <cam/cam_ccb.h>
60 #include <cam/cam_sim.h>
61 #include <cam/cam_xpt_sim.h>
62 #include <cam/cam_periph.h>
64 #include <dev/iscsi/initiator/iscsi.h>
65 #include <dev/iscsi/initiator/iscsivar.h>
68 _async(isc_session_t *sp, pduq_t *pq)
74 pdu_free(sp->isc, pq);
78 _reject(isc_session_t *sp, pduq_t *pq)
86 pdu = mtod(pq->mp, pdu_t *);
87 itt = pdu->ipdu.bhs.itt;
88 reject = &pq->pdu.ipdu.reject;
89 sdebug(2, "itt=%x reason=0x%x", ntohl(itt), reject->reason);
90 opq = i_search_hld(sp, itt, 0);
92 iscsi_reject(sp, opq, pq);
94 switch(pq->pdu.ipdu.bhs.opcode) {
95 case ISCSI_LOGOUT_CMD: // XXX: wasabi does this - can't figure out why
96 sdebug(2, "ISCSI_LOGOUT_CMD ...");
99 xdebug("%d] we lost something itt=%x",
100 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
103 pdu_free(sp->isc, pq);
107 _r2t(isc_session_t *sp, pduq_t *pq)
112 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 1);
114 iscsi_r2t(sp, opq, pq);
117 r2t_t *r2t = &pq->pdu.ipdu.r2t;
119 xdebug("%d] we lost something itt=%x r2tSN=%d bo=%x ddtl=%x",
120 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt),
121 ntohl(r2t->r2tSN), ntohl(r2t->bo), ntohl(r2t->ddtl));
123 pdu_free(sp->isc, pq);
127 _scsi_rsp(isc_session_t *sp, pduq_t *pq)
132 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 0);
133 debug(5, "itt=%x pq=%p opq=%p", ntohl(pq->pdu.ipdu.bhs.itt), pq, opq);
135 iscsi_done(sp, opq, pq);
137 xdebug("%d] we lost something itt=%x",
138 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
139 pdu_free(sp->isc, pq);
143 _read_data(isc_session_t *sp, pduq_t *pq)
148 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 1);
150 if(scsi_decap(sp, opq, pq) != 1) {
151 i_remove_hld(sp, opq); // done
152 pdu_free(sp->isc, opq);
156 xdebug("%d] we lost something itt=%x",
157 sp->sid, ntohl(pq->pdu.ipdu.bhs.itt));
158 pdu_free(sp->isc, pq);
162 | the jury is not back with a veredict, user or kernel
165 _nop_out(isc_session_t *sp)
172 sdebug(4, "cws=%d", sp->cws);
175 | only send a nop if window is closed.
177 if((pq = pdu_alloc(sp->isc, M_NOWAIT)) == NULL)
178 // I guess we ran out of resources
180 nop_out = &pq->pdu.ipdu.nop_out;
181 nop_out->opcode = ISCSI_NOP_OUT;
182 nop_out->itt = htonl(sp->sn.itt);
186 if(isc_qout(sp, pq) != 0) {
188 pdu_free(sp->isc, pq);
194 _nop_in(isc_session_t *sp, pduq_t *pq)
196 pdu_t *pp = &pq->pdu;
197 nop_in_t *nop_in = &pp->ipdu.nop_in;
198 bhs_t *bhs = &pp->ipdu.bhs;
202 sdebug(5, "itt=%x ttt=%x", htonl(nop_in->itt), htonl(nop_in->ttt));
203 if(nop_in->itt == -1) {
204 if(pp->ds_len != 0) {
206 | according to RFC 3720 this should be zero
209 xdebug("%d] dslen not zero", sp->sid);
211 if(nop_in->ttt != -1) {
214 | target wants a nop_out
216 bhs->opcode = ISCSI_NOP_OUT;
220 | we are reusing the pdu, so bhs->ttt == nop_in->ttt;
221 | and need to zero out 'Reserved'
224 nop_out = &pp->ipdu.nop_out;
225 nop_out->sn.maxcmd = 0;
226 memset(nop_out->mbz, 0, sizeof(nop_out->mbz));
227 (void)isc_qout(sp, pq); //XXX: should check return?
231 // just making noise?
232 // see 10.9.1: target does not want and answer.
236 if(nop_in->ttt == -1) {
238 | it is an answer to a nop_in from us
240 if(nop_in->itt != -1) {
243 if(sp->flags & ISC_WAIT4PING) {
244 i_nqueue_rsp(sp, pq);
254 pdu_free(sp->isc, pq);
259 i_prepPDU(isc_session_t *sp, pduq_t *pq)
262 pdu_t *pp = &pq->pdu;
263 bhs_t *bhp = &pp->ipdu.bhs;
268 bhp->AHSLength = pp->ahs_len / 4;
275 #if BYTE_ORDER == LITTLE_ENDIAN
276 bhp->DSLength = ((n & 0x00ff0000) >> 16)
278 | ((n & 0x000000ff) << 16);
291 len -= sizeof(bhs_t);
292 if(sp->opt.maxBurstLength && (len > sp->opt.maxBurstLength)) {
293 xdebug("%d] pdu len=%zd > %d",
294 sp->sid, len, sp->opt.maxBurstLength);
295 // XXX: when this happens it used to hang ...
302 isc_qout(isc_session_t *sp, pduq_t *pq)
308 if(pq->len == 0 && (error = i_prepPDU(sp, pq)))
311 if(pq->pdu.ipdu.bhs.I)
312 i_nqueue_isnd(sp, pq);
314 if(pq->pdu.ipdu.data_out.opcode == ISCSI_WRITE_DATA)
315 i_nqueue_wsnd(sp, pq);
317 i_nqueue_csnd(sp, pq);
319 sdebug(5, "enqued: pq=%p", pq);
321 mtx_lock(&sp->io_mtx);
322 sp->flags |= ISC_OQNOTEMPTY;
323 if(sp->flags & ISC_OWAITING)
325 mtx_unlock(&sp->io_mtx);
330 | called when a fullPhase is restarted
333 ism_restart(isc_session_t *sp)
337 sdebug(2, "restart ...");
338 lastcmd = iscsi_requeue(sp);
340 if(lastcmd != sp->sn.cmd) {
341 sdebug(1, "resetting CmdSN to=%d (from %d)", lastcmd, sp->sn.cmd);
342 sp->sn.cmd = lastcmd;
345 mtx_lock(&sp->io_mtx);
346 if(sp->flags & ISC_OWAITING) {
349 mtx_unlock(&sp->io_mtx);
351 sdebug(2, "restarted lastcmd=0x%x", lastcmd);
355 ism_fullfeature(struct cdev *dev, int flag)
357 isc_session_t *sp = (isc_session_t *)dev->si_drv2;
360 sdebug(2, "flag=%d", flag);
365 sp->flags &= ~ISC_FFPHASE;
368 error = ic_fullfeature(dev);
378 ism_recv(isc_session_t *sp, pduq_t *pq)
385 bhs = &pq->pdu.ipdu.bhs;
386 statSN = ntohl(bhs->OpcodeSpecificFields[1]);
390 | this code is only for debugging.
394 if((sp->flags & ISC_STALLED) == 0) {
395 sdebug(4, "window closed: max=0x%x exp=0x%x opcode=0x%x cmd=0x%x cws=%d.",
396 sn->maxCmd, sn->expCmd, bhs->opcode, sn->cmd, sp->cws);
397 sp->flags |= ISC_STALLED;
399 if(sp->flags & ISC_STALLED) {
400 sdebug(4, "window opened: max=0x%x exp=0x%x opcode=0x%x cmd=0x%x cws=%d.",
401 sn->maxCmd, sn->expCmd, bhs->opcode, sn->cmd, sp->cws);
402 sp->flags &= ~ISC_STALLED;
409 if(sp->sn.expCmd != sn->cmd) {
410 sdebug(1, "we lost something ... exp=0x%x cmd=0x%x",
411 sn->expCmd, sn->cmd);
414 sdebug(5, "opcode=0x%x itt=0x%x stat#0x%x maxcmd=0x%0x",
415 bhs->opcode, ntohl(bhs->itt), statSN, sp->sn.maxCmd);
417 switch(bhs->opcode) {
418 case ISCSI_READ_DATA: {
419 data_in_t *cmd = &pq->pdu.ipdu.data_in;
426 if(statSN > (sp->sn.stat + 1)) {
427 sdebug(1, "we lost some rec=0x%x exp=0x%x",
428 statSN, sp->sn.stat);
429 // XXX: must do some error recovery here.
431 sp->sn.stat = statSN;
434 switch(bhs->opcode) {
435 case ISCSI_LOGIN_RSP:
437 case ISCSI_LOGOUT_RSP:
438 i_nqueue_rsp(sp, pq);
440 sdebug(3, "wakeup rsp");
443 case ISCSI_NOP_IN: _nop_in(sp, pq); break;
444 case ISCSI_SCSI_RSP: _scsi_rsp(sp, pq); break;
445 case ISCSI_READ_DATA: _read_data(sp, pq); break;
446 case ISCSI_R2T: _r2t(sp, pq); break;
447 case ISCSI_REJECT: _reject(sp, pq); break;
448 case ISCSI_ASYNC: _async(sp, pq); break;
452 sdebug(1, "opcode=0x%x itt=0x%x not implemented yet",
453 bhs->opcode, ntohl(bhs->itt));
459 | go through the out queues looking for work
460 | if either nothing to do, or window is closed
464 proc_out(isc_session_t *sp)
474 while(sp->flags & ISC_LINK_UP) {
478 | check if there is outstanding work in:
479 | 1- the Immediate queue
481 | 3- the cmd queue, only if the command window allows it.
483 which = BIT(0) | BIT(1);
484 if(SNA_GT(sn->cmd, sn->maxCmd) == 0) // if(sn->maxCmd - sn->smc + 1) > 0
487 sdebug(4, "which=%d sn->maxCmd=%d sn->cmd=%d", which, sn->maxCmd, sn->cmd);
489 if((pq = i_dqueue_snd(sp, which)) == NULL)
491 sdebug(4, "pq=%p", pq);
495 switch(bhs->opcode) {
498 bhs->itt = htonl(sn->itt);
500 case ISCSI_LOGIN_CMD:
502 case ISCSI_LOGOUT_CMD:
506 bhs->CmdSN = htonl(sn->cmd);
510 case ISCSI_WRITE_DATA:
511 bhs->ExpStSN = htonl(sn->stat);
515 // XXX: can this happen?
516 xdebug("bad opcode=0x%x sn(cmd=0x%x expCmd=0x%x maxCmd=0x%x expStat=0x%x itt=0x%x)",
518 sn->cmd, sn->expCmd, sn->maxCmd, sn->expStat, sn->itt);
522 sdebug(4, "opcode=0x%x sn(cmd=0x%x expCmd=0x%x maxCmd=0x%x expStat=0x%x itt=0x%x)",
524 sn->cmd, sn->expCmd, sn->maxCmd, sn->expStat, sn->itt);
527 i_nqueue_hld(sp, pq);
529 if((error = isc_sendPDU(sp, pq)) == 0) {
532 pdu_free(sp->isc, pq);
535 xdebug("error=%d ndone=%d opcode=0x%x ccb=%p itt=%x",
536 error, ndone, bhs->opcode, pq->ccb, ntohl(bhs->itt));
538 i_remove_hld(sp, pq);
541 sp->flags &= ~ISC_LINK_UP;
545 i_rqueue_pdu(sp, pq);
550 xdebug("back to cam");
551 pq->ccb->ccb_h.status |= CAM_REQUEUE_REQ; // some better error?
552 XPT_DONE(sp->isc, pq->ccb);
553 pdu_free(sp->isc, pq);
556 xdebug("we lost it!");
564 | survives link breakdowns.
569 isc_session_t *sp = (isc_session_t *)vp;
574 sp->flags |= ISC_SM_RUNNING;
575 sdebug(3, "started sp->flags=%x", sp->flags);
577 if((sp->flags & ISC_HOLD) == 0) {
578 error = proc_out(sp);
580 sdebug(3, "error=%d", error);
583 mtx_lock(&sp->io_mtx);
584 if((sp->flags & ISC_LINK_UP) == 0) {
588 if(!(sp->flags & ISC_OQNOTEMPTY)) {
589 sp->flags |= ISC_OWAITING;
590 if(msleep(&sp->flags, &sp->io_mtx, PRIBIO, "isc_proc", hz*30) == EWOULDBLOCK) {
591 if(sp->flags & ISC_CON_RUNNING)
594 sp->flags &= ~ISC_OWAITING;
596 sp->flags &= ~ISC_OQNOTEMPTY;
597 mtx_unlock(&sp->io_mtx);
598 } while(sp->flags & ISC_SM_RUN);
600 sp->flags &= ~ISC_SM_RUNNING;
601 sdebug(3, "dropped ISC_SM_RUNNING");
603 #if __FreeBSD_version >= 700000
604 destroy_dev(sp->dev);
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 sprintf(bp, "targetname='%s'", sp->opt.targetName);
625 sprintf(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 snprintf(bp, n, "recv=%d sent=%d", sp->stats.nrecv, sp->stats.nsent);
647 snprintf(bp, n, " flags=0x%08x pdus-alloc=%d pdus-max=%d",
648 sp->flags, sc->npdu_alloc, sc->npdu_max);
651 snprintf(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 snprintf(buf, sizeof(buf), "%s", *cp);
665 error = SYSCTL_OUT(req, buf, strlen(buf));
670 isc_sysctl_targetAddress(SYSCTL_HANDLER_ARGS)
676 snprintf(buf, sizeof(buf), "%s", *cp);
677 error = SYSCTL_OUT(req, buf, strlen(buf));
682 isc_add_sysctls(isc_session_t *sp)
685 sdebug(6, "sid=%d %s", sp->sid, sp->dev->si_name);
687 sysctl_ctx_init(&sp->clist);
688 sp->oid = SYSCTL_ADD_NODE(&sp->clist,
689 SYSCTL_CHILDREN(sp->isc->oid),
691 sp->dev->si_name+5, // iscsi0
695 SYSCTL_ADD_PROC(&sp->clist,
696 SYSCTL_CHILDREN(sp->oid),
700 (void *)&sp->opt.targetName, 0,
701 isc_sysctl_targetName, "A", "target name");
703 SYSCTL_ADD_PROC(&sp->clist,
704 SYSCTL_CHILDREN(sp->oid),
708 (void *)&sp->opt.targetAddress, 0,
709 isc_sysctl_targetAddress, "A", "target address");
711 SYSCTL_ADD_PROC(&sp->clist,
712 SYSCTL_CHILDREN(sp->oid),
717 isc_dump_stats, "A", "statistics");
719 SYSCTL_ADD_INT(&sp->clist,
720 SYSCTL_CHILDREN(sp->oid),
724 &sp->douio, 0, "enable uio on read");
728 ism_stop(isc_session_t *sp)
730 struct isc_softc *sc = sp->isc;
734 sdebug(2, "terminating");
736 | first stop the receiver
738 isc_stop_receiver(sp);
740 | now stop the xmitter
743 sp->flags &= ~ISC_SM_RUN;
744 while(n-- && (sp->flags & ISC_SM_RUNNING)) {
745 sdebug(2, "n=%d", n);
747 tsleep(sp, PRIBIO, "-", 5*hz);
749 sdebug(2, "final n=%d", n);
750 sp->flags &= ~ISC_FFPHASE;
754 (void)i_pdu_flush(sp);
756 ic_lost_target(sp, sp->sid);
759 TAILQ_REMOVE(&sc->isc_sess, sp, sp_link);
761 mtx_unlock(&sc->mtx);
763 #if __FreeBSD_version < 700000
764 destroy_dev(sp->dev);
767 mtx_destroy(&sp->rsp_mtx);
768 mtx_destroy(&sp->rsv_mtx);
769 mtx_destroy(&sp->hld_mtx);
770 mtx_destroy(&sp->snd_mtx);
771 mtx_destroy(&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, "iscsi-rsv", NULL, MTX_DEF);
797 mtx_init(&sp->rsp_mtx, "iscsi-rsp", NULL, MTX_DEF);
798 mtx_init(&sp->snd_mtx, "iscsi-snd", NULL, MTX_DEF);
799 mtx_init(&sp->hld_mtx, "iscsi-hld", NULL, MTX_DEF);
801 mtx_init(&sp->rsv_mtx, "iscsi-rsv", NULL, MTX_SPIN);
802 mtx_init(&sp->rsp_mtx, "iscsi-rsp", NULL, MTX_SPIN);
803 mtx_init(&sp->snd_mtx, "iscsi-snd", NULL, MTX_SPIN);
804 mtx_init(&sp->hld_mtx, "iscsi-hld", NULL, MTX_SPIN);
806 mtx_init(&sp->io_mtx, "iscsi-io", NULL, MTX_DEF);
810 sp->flags |= ISC_SM_RUN;
812 debug(4, "starting ism_proc: sp->sid=%d", sp->sid);
813 return kproc_create(ism_proc, sp, &sp->stp, 0, 0, "ism_%d", sp->sid);