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_soc.c,v 1.6 2009/06/25 18:46:30 kib Exp $
30 | $Id: isc_soc.c,v 1.26 2007/05/19 06:09:01 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/queue.h>
50 #include <sys/kthread.h>
51 #include <sys/syslog.h>
55 #include <sys/eventhandler.h>
56 #include <sys/socketops.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>
65 #include <dev/disk/iscsi/initiator/iscsi.h>
66 #include <dev/disk/iscsi/initiator/iscsivar.h>
74 static int ou_refcnt = 0;
77 | function for counting refs on external storage for mbuf
84 debug(3, "ou_refcnt=%d arg=%p b=%p", ou_refcnt, a, a->buf);
85 atomic_add_int(&a->refcnt, 1);
89 | function for freeing external storage for mbuf
96 if (atomic_fetchadd_int(&a->refcnt, -1) == 1)
98 debug(3, "ou_refcnt=%d a=%p b=%p", ou_refcnt, a, a->buf);
99 kfree(a->buf, M_ISCSI);
105 isc_sendPDU(isc_session_t *sp, pduq_t *pq)
107 struct mbuf *mh, **mp;
108 pdu_t *pp = &pq->pdu;
113 | mbuf for the iSCSI header
115 MGETHDR(mh, MB_TRYWAIT, MT_DATA);
116 mh->m_len = mh->m_pkthdr.len = sizeof(union ipdu_u);
117 mh->m_pkthdr.rcvif = NULL;
118 MH_ALIGN(mh, sizeof(union ipdu_u));
119 bcopy(&pp->ipdu, mh->m_data, sizeof(union ipdu_u));
123 pq->pdu.hdr_dig = sp->hdrDigest(&pp->ipdu, sizeof(union ipdu_u), 0);
126 | Add any AHS to the iSCSI hdr mbuf
127 | XXX Assert: (mh->m_pkthdr.len + pp->ahs_len) < MHLEN
129 bcopy(pp->ahs, (mh->m_data + mh->m_len), pp->ahs_len);
130 mh->m_len += pp->ahs_len;
131 mh->m_pkthdr.len += pp->ahs_len;
134 pq->pdu.hdr_dig = sp->hdrDigest(&pp->ahs, pp->ahs_len, pq->pdu.hdr_dig);
137 debug(2, "hdr_dig=%x", pq->pdu.hdr_dig);
139 | Add header digest to the iSCSI hdr mbuf
140 | XXX Assert: (mh->m_pkthdr.len + 4) < MHLEN
142 bcopy(&pp->hdr_dig, (mh->m_data + mh->m_len), sizeof(int));
143 mh->m_len += sizeof(int);
144 mh->m_pkthdr.len += sizeof(int);
152 while(len & 03) // the specs say it must be int alligned
157 MGET(md, MB_TRYWAIT, MT_DATA);
160 l = min(MCLBYTES, len);
161 debug(5, "setting ext_free(arg=%p len/l=%d/%d)", pq->buf, len, l);
162 md->m_ext.ext_buf = pq->buf;
163 md->m_ext.ext_free = ext_free;
164 md->m_ext.ext_ref = ext_ref;
165 md->m_ext.ext_arg = pq;
166 md->m_ext.ext_size = l;
167 md->m_flags |= M_EXT;
168 md->m_data = pp->ds + off;
171 mh->m_pkthdr.len += l;
181 pp->ds_dig = sp->dataDigest(pp->ds, pp->ds_len, 0);
183 MGET(me, MB_TRYWAIT, MT_DATA);
184 me->m_len = sizeof(int);
185 MH_ALIGN(mh, sizeof(int));
186 bcopy(&pp->ds_dig, me->m_data, sizeof(int));
188 mh->m_pkthdr.len += sizeof(int);
191 if((error = sosend(sp->soc, NULL, NULL, mh, 0, 0, curthread)) != 0) {
192 sdebug(3, "error=%d", error);
196 getmicrouptime(&sp->stats.t_sent);
199 #else /* NO_USE_MBUF */
201 isc_sendPDU(isc_session_t *sp, pduq_t *pq)
203 struct uio *uio = &pq->uio;
205 pdu_t *pp = &pq->pdu;
210 bzero(uio, sizeof(struct uio));
211 uio->uio_rw = UIO_WRITE;
212 uio->uio_segflg = UIO_SYSSPACE;
213 uio->uio_td = curthread;
214 uio->uio_iov = iv = pq->iov;
216 iv->iov_base = &pp->ipdu;
217 iv->iov_len = sizeof(union ipdu_u);
218 uio->uio_resid = pq->len;
221 pq->pdu.hdr_dig = sp->hdrDigest(&pp->ipdu, sizeof(union ipdu_u), 0);
223 iv->iov_base = pp->ahs;
224 iv->iov_len = pp->ahs_len;
228 pq->pdu.hdr_dig = sp->hdrDigest(&pp->ahs, pp->ahs_len, pq->pdu.hdr_dig);
231 debug(2, "hdr_dig=%x", pq->pdu.hdr_dig);
232 iv->iov_base = &pp->hdr_dig;
233 iv->iov_len = sizeof(int);
237 iv->iov_base = pp->ds;
238 iv->iov_len = pp->ds_len;
239 while(iv->iov_len & 03) // the specs say it must be int alligned
244 pp->ds_dig = sp->dataDigest(pp->ds, pp->ds_len, 0);
245 iv->iov_base = &pp->ds_dig;
246 iv->iov_len = sizeof(int);
249 uio->uio_iovcnt = iv - pq->iov;
250 sdebug(5, "opcode=%x iovcnt=%d uio_resid=%d itt=%x",
251 pp->ipdu.bhs.opcode, uio->uio_iovcnt, uio->uio_resid,
252 ntohl(pp->ipdu.bhs.itt));
253 sdebug(5, "sp=%p sp->soc=%p uio=%p sp->td=%p",
254 sp, sp->soc, uio, sp->td);
256 len = uio->uio_resid;
257 error = sosend(sp->soc, NULL, uio, 0, 0, 0, curthread);
258 if(uio->uio_resid == 0 || error || len == uio->uio_resid) {
260 sdebug(2, "uio->uio_resid=%d uio->uio_iovcnt=%d error=%d len=%d",
261 uio->uio_resid, uio->uio_iovcnt, error, len);
263 error = EAGAIN; // 35
270 sdebug(1, "uio->uio_resid=%d uio->uio_iovcnt=%d",
271 uio->uio_resid, uio->uio_iovcnt);
273 len -= uio->uio_resid;
274 while(uio->uio_iovcnt > 0) {
275 if(iv->iov_len > len) {
276 caddr_t bp = (caddr_t)iv->iov_base;
279 iv->iov_base = (void *)&bp[len];
287 } while(uio->uio_resid);
291 getmicrouptime(&sp->stats.t_sent);
297 #endif /* USE_MBUF */
300 | wait till a PDU header is received
304 The format of the BHS is:
306 Byte/ 0 | 1 | 2 | 3 |
308 |0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|0 1 2 3 4 5 6 7|
309 +---------------+---------------+---------------+---------------+
310 0|.|I| Opcode |F| Opcode-specific fields |
311 +---------------+---------------+---------------+---------------+
312 4|TotalAHSLength | DataSegmentLength |
313 +---------------+---------------+---------------+---------------+
314 8| LUN or Opcode-specific fields |
317 +---------------+---------------+---------------+---------------+
318 16| Initiator Task Tag |
319 +---------------+---------------+---------------+---------------+
320 20/ Opcode-specific fields /
322 +---------------+---------------+---------------+---------------+
326 so_getbhs(isc_session_t *sp)
328 bhs_t *bhs = &sp->bhs;
329 struct uio *uio = &sp->uio;
330 struct iovec *iov = &sp->iov;
336 iov->iov_len = sizeof(bhs_t);
340 uio->uio_rw = UIO_READ;
341 uio->uio_segflg = UIO_SYSSPACE;
342 uio->uio_td = curthread; // why ...
343 uio->uio_resid = sizeof(bhs_t);
346 error = so_pru_soreceive(sp->soc, NULL, uio, NULL, NULL, &flags);
349 debug(2, "error=%d so_error=%d uio->uio_resid=%zd iov.iov_len=%zd",
351 sp->soc->so_error, uio->uio_resid, iov->iov_len);
352 if(!error && (uio->uio_resid > 0)) {
353 error = EPIPE; // was EAGAIN
354 debug(2, "error=%d so_error=%d uio->uio_resid=%zd iov.iov_len=%zd "
357 sp->soc->so_error, uio->uio_resid, iov->iov_len,
365 | so_recv gets called when there is at least
366 | an iSCSI header in the queue
369 so_recv(isc_session_t *sp, pduq_t *pq)
371 struct socket *so = sp->soc;
373 struct uio *uio = &pq->uio;
383 | now calculate how much data should be in the buffer
384 | NOTE: digest is not verified/calculated - yet
392 pp->ahs_len = bhs->AHSLength * 4;
399 #if BYTE_ORDER == LITTLE_ENDIAN
400 pp->ds_len = ((n & 0x00ff0000) >> 16)
402 | ((n & 0x000000ff) << 16);
413 if((sp->opt.maxRecvDataSegmentLength > 0) && (len > sp->opt.maxRecvDataSegmentLength)) {
415 xdebug("impossible PDU length(%d) opt.maxRecvDataSegmentLength=%d",
416 len, sp->opt.maxRecvDataSegmentLength);
417 // deep trouble here, probably all we can do is
418 // force a disconnect, XXX: check RFC ...
420 "so_recv: impossible PDU length(%ld) from iSCSI %s/%s\n",
421 len, sp->opt.targetAddress, sp->opt.targetName);
424 | XXX: this will really screwup the stream.
425 | should clear up the buffer till a valid header
426 | is found, or just close connection ...
427 | should read the RFC.
436 uio->uio_td = curthread; // why ...
438 // it's more efficient to use mbufs -- why?
439 if(bhs->opcode == ISCSI_READ_DATA) {
442 opq = i_search_hld(sp, pq->pdu.ipdu.bhs.itt, 1);
444 union ccb *ccb = opq->ccb;
445 struct ccb_scsiio *csio = &ccb->csio;
446 pdu_t *opp = &opq->pdu;
447 scsi_req_t *cmd = &opp->ipdu.scsi_req;
448 data_in_t *rcmd = &pq->pdu.ipdu.data_in;
449 bhs_t *bhp = &opp->ipdu.bhs;
452 if(bhp->opcode == ISCSI_SCSI_CMD
454 && (ntohl(cmd->edtlen) >= pq->pdu.ds_len)) {
455 struct iovec *iov = pq->iov;
456 iov->iov_base = csio->data_ptr + ntohl(rcmd->bo);
457 iov->iov_len = pq->pdu.ds_len;
459 uio->uio_rw = UIO_READ;
460 uio->uio_segflg = UIO_SYSSPACE;
463 if(len > pq->pdu.ds_len) {
464 pq->iov[1].iov_base = &r;
465 pq->iov[1].iov_len = len - pq->pdu.ds_len;
469 sdebug(4, "uio_resid=0x%zx itt=0x%x bp=%p bo=%x len=%x/%x",
471 ntohl(pq->pdu.ipdu.bhs.itt),
472 csio->data_ptr, ntohl(rcmd->bo), ntohl(cmd->edtlen), pq->pdu.ds_len);
478 * Here we call so_pru_receive with a sockbuf so we can obtain
479 * the mbuf chain that can be assigned later to the pq->mp,
480 * which is the mbuf wanted.
481 * For the moment, resid will be saved in the uio.
484 error = so_pru_soreceive(so, NULL, NULL, &sbp, NULL, &flags);
486 uio->uio_resid = sbp.sb_climit - sbp.sb_cc;
487 //if(error == EAGAIN)
488 // XXX: this needs work! it hangs iscontrol
489 if(error || uio->uio_resid)
493 sdebug(6, "len=%d] opcode=0x%x ahs_len=0x%x ds_len=0x%x",
494 pq->len, bhs->opcode, pp->ahs_len, pp->ds_len);
496 max = ntohl(bhs->MaxCmdSN);
497 exp = ntohl(bhs->ExpStSN);
500 max > exp - _MAXINCR) {
501 sdebug(2, "bad cmd window size");
502 error = EIO; // XXX: for now;
506 if(SNA_GT(max, sn->maxCmd))
509 if(SNA_GT(exp, sn->expCmd))
512 sp->cws = sn->maxCmd - sn->expCmd + 1;
517 // XXX: need some work here
518 xdebug("have a problem, error=%d", error);
519 pdu_free(sp->isc, pq);
520 if(!error && uio->uio_resid > 0)
526 | wait for something to arrive.
527 | and if the pdu is without errors, process it.
530 so_input(isc_session_t *sp)
537 | first read in the iSCSI header
539 error = so_getbhs(sp);
544 pq = pdu_alloc(sp->isc, M_NOWAIT);
545 if(pq == NULL) { // XXX: might cause a deadlock ...
546 debug(3, "out of pdus, wait");
547 pq = pdu_alloc(sp->isc, M_NOWAIT); // OK to WAIT
549 pq->pdu.ipdu.bhs = sp->bhs;
550 pq->len = sizeof(bhs_t); // so far only the header was read
551 error = so_recv(sp, pq);
553 error += 0x800; // XXX: just to see the error.
555 // XXX: close connection and exit
559 getmicrouptime(&sp->stats.t_recv);
567 | one per active (connected) session.
568 | this thread is responsible for reading
569 | in packets from the target.
574 isc_session_t *sp = (isc_session_t *)vp;
575 struct socket *so = sp->soc;
586 while((sp->flags & (ISC_CON_RUN | ISC_LINK_UP)) == (ISC_CON_RUN | ISC_LINK_UP)) {
588 if(sp->soc == NULL || !(so->so_state & SS_ISCONNECTED)) {
589 debug(2, "sp->soc=%p", sp->soc);
592 error = so_input(sp);
594 iscsi_lock_ex(&sp->io_mtx);
595 if(sp->flags & ISC_OWAITING) {
598 iscsi_unlock_ex(&sp->io_mtx);
599 } else if(error == EPIPE) {
602 else if(error == EAGAIN) {
603 if(so->so_state & SS_ISCONNECTED)
604 // there seems to be a problem in 6.0 ...
605 tsleep(sp, 0, "iscsoc", 2*hz);
608 sdebug(2, "terminated, flags=%x so_state=%x error=%d proc=%p",
609 sp->flags, so ? so->so_state : 0, error, sp->proc);
610 if((sp->proc != NULL) && sp->signal) {
612 ksignal(sp->proc, sp->signal);
613 PROC_UNLOCK(sp->proc);
614 sp->flags |= ISC_SIGNALED;
615 sdebug(2, "pid=%d signaled(%d)", sp->proc->p_pid, sp->signal);
618 // we have to do something ourselves
619 // like closing this session ...
622 | we've been terminated
624 // do we need this mutex ...?
625 //iscsi_lock_ex(&sp->io_mtx);
626 sp->flags &= ~(ISC_CON_RUNNING | ISC_LINK_UP);
628 //iscsi_unlock_ex(&sp->io_mtx);
630 sdebug(2, "dropped ISC_CON_RUNNING");
636 isc_stop_receiver(isc_session_t *sp)
639 debug(3, "sp=%p sp->sid=%d sp->soc=%p", sp, sp ? sp->sid : 0,
640 sp ? sp->soc : NULL);
641 iscsi_lock_ex(&sp->io_mtx);
642 sp->flags &= ~ISC_LINK_UP;
643 if (sp->flags & ISC_CON_RUNNING) {
644 issleep(&sp->soc, &sp->io_mtx, 0, "iscstpc", 5*hz);
646 iscsi_unlock_ex(&sp->io_mtx);
649 soshutdown(sp->soc, SHUT_RD);
651 iscsi_lock_ex(&sp->io_mtx);
652 sdebug(3, "soshutdown");
653 sp->flags &= ~ISC_CON_RUN;
654 while(sp->flags & ISC_CON_RUNNING) {
655 sdebug(3, "waiting flags=%x", sp->flags);
656 issleep(&sp->soc, &sp->io_mtx, 0, "iscstpc", hz);
658 iscsi_unlock_ex(&sp->io_mtx);
660 if (sp->fp != NULL) {
664 /* sofree(sp->soc); fp deals with socket termination */
671 isc_start_receiver(isc_session_t *sp)
675 sp->flags |= ISC_CON_RUN | ISC_LINK_UP;
676 sp->flags |= ISC_CON_RUNNING;
678 kthread_create(isc_soc, sp, &sp->soc_thr, "iscsi%d", sp->sid);