2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005-2011 Daniel Braniss <danny@cs.huji.ac.il>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 | $Id: iscsi.c 752 2009-08-20 11:23:28Z danny $
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include "opt_iscsi_initiator.h"
38 #include <sys/param.h>
39 #include <sys/capsicum.h>
40 #include <sys/kernel.h>
41 #include <sys/module.h>
44 #include <sys/systm.h>
45 #include <sys/malloc.h>
46 #include <sys/ctype.h>
47 #include <sys/errno.h>
48 #include <sys/sysctl.h>
51 #include <sys/socketvar.h>
52 #include <sys/socket.h>
53 #include <sys/protosw.h>
55 #include <sys/ioccom.h>
56 #include <sys/queue.h>
57 #include <sys/kthread.h>
59 #include <sys/syslog.h>
63 #include <dev/iscsi_initiator/iscsi.h>
64 #include <dev/iscsi_initiator/iscsivar.h>
65 static char *iscsi_driver_version = "2.3.1";
67 static struct isc_softc *isc;
69 MALLOC_DEFINE(M_ISCSI, "iSCSI", "iSCSI driver");
70 MALLOC_DEFINE(M_ISCSIBUF, "iSCbuf", "iSCSI buffers");
71 static MALLOC_DEFINE(M_TMP, "iSCtmp", "iSCSI tmp");
73 #ifdef ISCSI_INITIATOR_DEBUG
74 int iscsi_debug = ISCSI_INITIATOR_DEBUG;
75 SYSCTL_INT(_debug, OID_AUTO, iscsi_initiator, CTLFLAG_RW, &iscsi_debug, 0,
76 "iSCSI driver debug flag");
78 struct mtx iscsi_dbg_mtx;
81 static int max_sessions = MAX_SESSIONS;
82 SYSCTL_INT(_net, OID_AUTO, iscsi_initiator_max_sessions, CTLFLAG_RDTUN,
83 &max_sessions, 0, "Max sessions allowed");
84 static int max_pdus = MAX_PDUS;
85 SYSCTL_INT(_net, OID_AUTO, iscsi_initiator_max_pdus, CTLFLAG_RDTUN,
86 &max_pdus, 0, "Max PDU pool");
88 static char isid[6+1] = {
98 static int i_create_session(struct cdev *dev, int *ndev);
100 static int i_ping(struct cdev *dev);
101 static int i_send(struct cdev *dev, caddr_t arg, struct thread *td);
102 static int i_recv(struct cdev *dev, caddr_t arg, struct thread *td);
103 static int i_setsoc(isc_session_t *sp, int fd, struct thread *td);
104 static int i_fullfeature(struct cdev *dev, int flag);
106 static d_open_t iscsi_open;
107 static d_close_t iscsi_close;
108 static d_ioctl_t iscsi_ioctl;
109 #ifdef ISCSI_INITIATOR_DEBUG
110 static d_read_t iscsi_read;
113 static struct cdevsw iscsi_cdevsw = {
114 .d_version = D_VERSION,
115 .d_open = iscsi_open,
116 .d_close = iscsi_close,
117 .d_ioctl = iscsi_ioctl,
118 #ifdef ISCSI_INITIATOR_DEBUG
119 .d_read = iscsi_read,
125 iscsi_open(struct cdev *dev, int flags, int otype, struct thread *td)
129 debug(7, "dev=%d", dev2unit(dev));
131 if(dev2unit(dev) > max_sessions) {
139 iscsi_close(struct cdev *dev, int flag, int otyp, struct thread *td)
145 debug(3, "session=%d flag=%x", dev2unit(dev), flag);
147 if(dev2unit(dev) == max_sessions) {
152 sdebug(3, "sp->flags=%x", sp->flags );
154 | if still in full phase, this probably means
155 | that something went really bad.
156 | it could be a result from 'shutdown', in which case
157 | we will ignore it (so buffers can be flushed).
158 | the problem is that there is no way of differentiating
159 | between a shutdown procedure and 'iscontrol' dying.
161 if(sp->flags & ISC_FFPHASE)
162 // delay in case this is a shutdown.
163 tsleep(sp, PRIBIO, "isc-cls", 60*hz);
171 iscsi_ioctl(struct cdev *dev, u_long cmd, caddr_t arg, int mode, struct thread *td)
173 struct isc_softc *sc;
181 if(dev2unit(dev) == max_sessions) {
183 | non Session commands
191 error = i_create_session(dev, (int *)arg);
207 sdebug(6, "dev=%d cmd=%d", dev2unit(dev), (int)(cmd & 0xff));
211 error = i_setsoc(sp, *(u_int *)arg, td);
215 opt = (isc_opt_t *)arg;
216 error = i_setopt(sp, opt);
220 error = i_send(dev, arg, td);
224 error = i_recv(dev, arg, td);
232 error = sp->soc == NULL? ENOTCONN: i_fullfeature(dev, 1);
234 sp->proc = td->td_proc;
235 SYSCTL_ADD_INT(&sp->clist, SYSCTL_CHILDREN(sp->oid),
236 OID_AUTO, "pid", CTLFLAG_RD,
237 &sp->proc->p_pid, sizeof(pid_t), "control process id");
242 error = sp->soc == NULL? ENOTCONN: i_fullfeature(dev, 2);
246 error = i_fullfeature(dev, 0);
250 int sig = *(int *)arg;
252 if(sig < 0 || sig > _SIG_MAXSIG)
260 iscsi_cam_t *cp = (iscsi_cam_t *)arg;
262 error = ic_getCamVals(sp, cp);
274 iscsi_read(struct cdev *dev, struct uio *uio, int ioflag)
276 #ifdef ISCSI_INITIATOR_DEBUG
277 struct isc_softc *sc;
284 if(dev2unit(dev) == max_sessions) {
285 sprintf(buf, "/----- Session ------/\n");
286 uiomove(buf, strlen(buf), uio);
289 TAILQ_FOREACH(sp, &sc->isc_sess, sp_link) {
290 if(uio->uio_resid == 0)
292 sprintf(buf, "%03d] '%s' '%s'\n", i++, sp->opt.targetAddress, sp->opt.targetName);
293 uiomove(buf, strlen(buf), uio);
295 sprintf(buf, "free npdu_alloc=%d, npdu_max=%d\n", sc->npdu_alloc, sc->npdu_max);
296 uiomove(buf, strlen(buf), uio);
300 struct socket *so = sp->soc;
301 #define pukeit(i, pq) do {\
302 sprintf(buf, "%03d] %06x %02x %06x %06x %jd\n",\
303 i, ntohl(pq->pdu.ipdu.bhs.CmdSN),\
304 pq->pdu.ipdu.bhs.opcode, ntohl(pq->pdu.ipdu.bhs.itt),\
305 ntohl(pq->pdu.ipdu.bhs.ExpStSN),\
306 (intmax_t)pq->ts.sec);\
309 sprintf(buf, "%d/%d /---- hld -----/\n", sp->stats.nhld, sp->stats.max_hld);
310 uiomove(buf, strlen(buf), uio);
311 TAILQ_FOREACH(pq, &sp->hld, pq_link) {
312 if(uio->uio_resid == 0)
315 uiomove(buf, strlen(buf), uio);
317 sprintf(buf, "%d/%d /---- rsp -----/\n", sp->stats.nrsp, sp->stats.max_rsp);
318 uiomove(buf, strlen(buf), uio);
320 TAILQ_FOREACH(pq, &sp->rsp, pq_link) {
321 if(uio->uio_resid == 0)
324 uiomove(buf, strlen(buf), uio);
326 sprintf(buf, "%d/%d /---- csnd -----/\n", sp->stats.ncsnd, sp->stats.max_csnd);
328 uiomove(buf, strlen(buf), uio);
329 TAILQ_FOREACH(pq, &sp->csnd, pq_link) {
330 if(uio->uio_resid == 0)
333 uiomove(buf, strlen(buf), uio);
335 sprintf(buf, "%d/%d /---- wsnd -----/\n", sp->stats.nwsnd, sp->stats.max_wsnd);
337 uiomove(buf, strlen(buf), uio);
338 TAILQ_FOREACH(pq, &sp->wsnd, pq_link) {
339 if(uio->uio_resid == 0)
342 uiomove(buf, strlen(buf), uio);
344 sprintf(buf, "%d/%d /---- isnd -----/\n", sp->stats.nisnd, sp->stats.max_isnd);
346 uiomove(buf, strlen(buf), uio);
347 TAILQ_FOREACH(pq, &sp->isnd, pq_link) {
348 if(uio->uio_resid == 0)
351 uiomove(buf, strlen(buf), uio);
354 sprintf(buf, "/---- Stats ---/\n");
355 uiomove(buf, strlen(buf), uio);
357 sprintf(buf, "recv=%d sent=%d\n", sp->stats.nrecv, sp->stats.nsent);
358 uiomove(buf, strlen(buf), uio);
360 sprintf(buf, "flags=%x pdus: alloc=%d max=%d\n",
361 sp->flags, sc->npdu_alloc, sc->npdu_max);
362 uiomove(buf, strlen(buf), uio);
364 sprintf(buf, "cws=%d last cmd=%x exp=%x max=%x stat=%x itt=%x\n",
365 sp->cws, sp->sn.cmd, sp->sn.expCmd, sp->sn.maxCmd, sp->sn.stat, sp->sn.itt);
366 uiomove(buf, strlen(buf), uio);
368 sprintf(buf, "/---- socket -----/\nso_count=%d so_state=%x\n", so->so_count, so->so_state);
369 uiomove(buf, strlen(buf), uio);
377 i_ping(struct cdev *dev)
385 i_setsoc(isc_session_t *sp, int fd, struct thread *td)
391 isc_stop_receiver(sp);
393 error = getsock_cap(td, fd, cap_rights_init(&rights, CAP_SOCK_CLIENT),
394 &sp->fp, NULL, NULL);
398 sp->soc = sp->fp->f_data;
400 isc_start_receiver(sp);
406 i_send(struct cdev *dev, caddr_t arg, struct thread *td)
408 isc_session_t *sp = dev->si_drv2;
419 if((pq = pdu_alloc(sp->isc, M_NOWAIT)) == NULL)
422 pq->pdu = *(pdu_t *)arg;
423 if((error = i_prepPDU(sp, pq)) != 0)
427 if((pq->len - sizeof(union ipdu_u)) > 0) {
428 pq->buf = bp = malloc(pq->len - sizeof(union ipdu_u), M_ISCSIBUF, M_NOWAIT);
429 if(pq->buf == NULL) {
435 pq->buf = NULL; // just in case?
437 sdebug(2, "len=%d ahs_len=%d ds_len=%d buf=%zu@%p",
438 pq->len, pp->ahs_len, pp->ds_len, pq->len - sizeof(union ipdu_u), bp);
441 // XXX: never tested, looks suspicious
443 error = copyin(pp->ahs_addr, bp, n);
445 sdebug(3, "copyin ahs: error=%d", error);
448 pp->ahs_addr = (ahs_t *)bp;
453 error = copyin(pp->ds_addr, bp, n);
455 sdebug(3, "copyin ds: error=%d", error);
466 error = isc_qout(sp, pq);
468 wakeup(&sp->flags); // XXX: to 'push' proc_out ...
471 pdu_free(sp->isc, pq);
477 i_recv(struct cdev *dev, caddr_t arg, struct thread *td)
479 isc_session_t *sp = dev->si_drv2;
483 int error, mustfree, cnt;
484 size_t need, have, n;
493 cnt = 6; // XXX: maybe the user can request a time out?
494 mtx_lock(&sp->rsp_mtx);
495 while((pq = TAILQ_FIRST(&sp->rsp)) == NULL) {
496 msleep(&sp->rsp, &sp->rsp_mtx, PRIBIO, "isc_rsp", hz*10);
497 if(cnt-- == 0) break; // XXX: for now, needs work
501 TAILQ_REMOVE(&sp->rsp, pq, pq_link);
503 mtx_unlock(&sp->rsp_mtx);
505 sdebug(6, "cnt=%d", cnt);
509 sdebug(3, "error=%d sp->flags=%x ", error, sp->flags);
533 if(len > pq->mp->m_len) {
535 bp = malloc(len, M_TMP, M_WAITOK);
536 sdebug(4, "need mbufcopy: %d", len);
537 i_mbufcopy(pq->mp, bp, len);
540 bp = mtod(pq->mp, caddr_t);
544 n = MIN(up->ahs_size, need);
545 error = copyout(bp, (caddr_t)up->ahs_addr, n);
549 if(!error && pp->ds_len) {
551 if((have = up->ds_size) == 0) {
552 have = up->ahs_size - n;
553 up->ds_addr = (caddr_t)up->ahs_addr + n;
556 error = copyout(bp, (caddr_t)up->ds_addr, n);
564 sdebug(6, "len=%d ahs_len=%d ds_len=%d", pq->len, pp->ahs_len, pp->ds_len);
566 pdu_free(sp->isc, pq);
572 i_fullfeature(struct cdev *dev, int flag)
574 isc_session_t *sp = dev->si_drv2;
577 sdebug(2, "flag=%d", flag);
582 sp->flags &= ~ISC_FFPHASE;
585 sp->flags |= ISC_FFPHASE;
589 sp->flags |= ISC_FFPHASE;
597 i_create_session(struct cdev *dev, int *ndev)
599 struct isc_softc *sc = dev->si_drv1;
605 sp = malloc(sizeof(isc_session_t), M_ISCSI, M_WAITOK | M_ZERO);
609 sx_xlock(&sc->unit_sx);
610 if((n = alloc_unr(sc->unit)) < 0) {
611 sx_unlock(&sc->unit_sx);
613 xdebug("too many sessions!");
616 sx_unlock(&sc->unit_sx);
618 mtx_lock(&sc->isc_mtx);
619 TAILQ_INSERT_TAIL(&sc->isc_sess, sp, sp_link);
621 mtx_unlock(&sc->isc_mtx);
623 sp->dev = make_dev(&iscsi_cdevsw, n, UID_ROOT, GID_WHEEL, 0600, "iscsi%d", n);
626 sp->dev->si_drv1 = sc;
627 sp->dev->si_drv2 = sp;
629 sp->opt.maxRecvDataSegmentLength = 8192;
630 sp->opt.maxXmitDataSegmentLength = 8192;
631 sp->opt.maxBurstLength = 65536; // 64k
632 sp->opt.maxluns = ISCSI_MAX_LUNS;
634 error = ism_start(sp);
641 iscsi_counters(isc_session_t *sp)
646 #define _puke(i, pq) do {\
647 debug(2, "%03d] %06x %02x %x %ld %jd %x\n",\
648 i, ntohl( pq->pdu.ipdu.bhs.CmdSN), \
649 pq->pdu.ipdu.bhs.opcode, ntohl(pq->pdu.ipdu.bhs.itt),\
650 (long)pq->ts.sec, pq->ts.frac, pq->flags);\
654 TAILQ_FOREACH(pq, &sp->hld, pq_link) {
658 TAILQ_FOREACH(pq, &sp->rsp, pq_link) r++;
659 TAILQ_FOREACH(pq, &sp->csnd, pq_link) s++;
660 TAILQ_FOREACH(pq, &sp->wsnd, pq_link) s++;
661 TAILQ_FOREACH(pq, &sp->isnd, pq_link) s++;
662 debug(2, "hld=%d rsp=%d snd=%d", h, r, s);
667 iscsi_shutdown(void *v)
669 struct isc_softc *sc = v;
675 xdebug("sc is NULL!");
678 #ifdef DO_EVENTHANDLER
680 debug(2, "sc->eh is NULL");
682 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, sc->eh);
683 debug(2, "done n=%d", sc->nsess);
687 TAILQ_FOREACH(sp, &sc->isc_sess, sp_link) {
688 debug(2, "%2d] sp->flags=0x%08x", n, sp->flags);
695 free_pdus(struct isc_softc *sc)
699 if(sc->pdu_zone != NULL) {
700 uma_zdestroy(sc->pdu_zone);
710 isc = malloc(sizeof(struct isc_softc), M_ISCSI, M_ZERO|M_WAITOK);
711 mtx_init(&isc->isc_mtx, "iscsi-isc", NULL, MTX_DEF);
713 TAILQ_INIT(&isc->isc_sess);
715 | now init the free pdu list
717 isc->pdu_zone = uma_zcreate("pdu", sizeof(pduq_t),
718 NULL, NULL, NULL, NULL,
720 uma_zone_set_max(isc->pdu_zone, max_pdus);
721 isc->unit = new_unrhdr(0, max_sessions-1, NULL);
722 sx_init(&isc->unit_sx, "iscsi sx");
724 #ifdef DO_EVENTHANDLER
725 if((isc->eh = EVENTHANDLER_REGISTER(shutdown_pre_sync, iscsi_shutdown,
726 sc, SHUTDOWN_PRI_DEFAULT-1)) == NULL)
727 xdebug("shutdown event registration failed\n");
732 sysctl_ctx_init(&isc->clist);
733 isc->oid = SYSCTL_ADD_NODE(&isc->clist,
734 SYSCTL_STATIC_CHILDREN(_net),
741 SYSCTL_ADD_STRING(&isc->clist,
742 SYSCTL_CHILDREN(isc->oid),
746 iscsi_driver_version,
748 "iscsi driver version");
750 SYSCTL_ADD_STRING(&isc->clist,
751 SYSCTL_CHILDREN(isc->oid),
757 "initiator part of the Session Identifier");
759 SYSCTL_ADD_INT(&isc->clist,
760 SYSCTL_CHILDREN(isc->oid),
766 "number of active session");
768 #ifdef ISCSI_INITIATOR_DEBUG
769 mtx_init(&iscsi_dbg_mtx, "iscsi_dbg", NULL, MTX_DEF);
772 isc->dev = make_dev_credf(MAKEDEV_CHECKNAME, &iscsi_cdevsw, max_sessions,
773 NULL, UID_ROOT, GID_WHEEL, 0600, "iscsi");
774 if (isc->dev == NULL) {
775 xdebug("iscsi_initiator: make_dev_credf failed");
778 isc->dev->si_drv1 = isc;
780 printf("iscsi: version %s\n", iscsi_driver_version);
786 | unload SHOULD fail if there is activity
787 | activity: there is/are active session/s
792 isc_session_t *sp, *sp_tmp;
797 | go through all the sessions
798 | Note: close should have done this ...
800 TAILQ_FOREACH_SAFE(sp, &isc->isc_sess, sp_link, sp_tmp) {
801 //XXX: check for activity ...
804 mtx_destroy(&isc->isc_mtx);
805 sx_destroy(&isc->unit_sx);
810 destroy_dev(isc->dev);
812 if(sysctl_ctx_free(&isc->clist))
813 xdebug("sysctl_ctx_free failed");
815 iscsi_shutdown(isc); // XXX: check EVENTHANDLER_ ...
817 #ifdef ISCSI_INITIATOR_DEBUG
818 mtx_destroy(&iscsi_dbg_mtx);
825 iscsi_modevent(module_t mod, int what, void *arg)
833 error = iscsi_start();
838 xdebug("iscsi module busy(nsess=%d), cannot unload", isc->nsess);
839 log(LOG_ERR, "iscsi module busy, cannot unload");
856 moduledata_t iscsi_mod = {
858 (modeventhand_t) iscsi_modevent,
867 nfs_setup_diskless();
868 if (nfs_diskless_valid)
869 rootdevnames[0] = "nfs:";
871 printf("** iscsi_rootconf **\n");
874 SYSINIT(cpu_rootconf1, SI_SUB_ROOT_CONF, SI_ORDER_FIRST, iscsi_rootconf, NULL)
877 DECLARE_MODULE(iscsi_initiator, iscsi_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE);
878 MODULE_DEPEND(iscsi_initiator, cam, 1, 1, 1);