2 * Copyright (c) 2005-2011 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 | $Id: iscsi.c 752 2009-08-20 11:23:28Z danny $
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include "opt_iscsi_initiator.h"
36 #include <sys/param.h>
37 #include <sys/capsicum.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
42 #include <sys/systm.h>
43 #include <sys/malloc.h>
44 #include <sys/ctype.h>
45 #include <sys/errno.h>
46 #include <sys/sysctl.h>
49 #include <sys/socketvar.h>
50 #include <sys/socket.h>
51 #include <sys/protosw.h>
53 #include <sys/ioccom.h>
54 #include <sys/queue.h>
55 #include <sys/kthread.h>
57 #include <sys/syslog.h>
61 #include <dev/iscsi_initiator/iscsi.h>
62 #include <dev/iscsi_initiator/iscsivar.h>
63 static char *iscsi_driver_version = "2.3.1";
65 static struct isc_softc *isc;
67 MALLOC_DEFINE(M_ISCSI, "iSCSI", "iSCSI driver");
68 MALLOC_DEFINE(M_ISCSIBUF, "iSCbuf", "iSCSI buffers");
69 static MALLOC_DEFINE(M_TMP, "iSCtmp", "iSCSI tmp");
71 #ifdef ISCSI_INITIATOR_DEBUG
72 int iscsi_debug = ISCSI_INITIATOR_DEBUG;
73 SYSCTL_INT(_debug, OID_AUTO, iscsi_initiator, CTLFLAG_RW, &iscsi_debug, 0,
74 "iSCSI driver debug flag");
76 struct mtx iscsi_dbg_mtx;
79 static int max_sessions = MAX_SESSIONS;
80 SYSCTL_INT(_net, OID_AUTO, iscsi_initiator_max_sessions, CTLFLAG_RDTUN,
81 &max_sessions, 0, "Max sessions allowed");
82 static int max_pdus = MAX_PDUS;
83 SYSCTL_INT(_net, OID_AUTO, iscsi_initiator_max_pdus, CTLFLAG_RDTUN,
84 &max_pdus, 0, "Max PDU pool");
86 static char isid[6+1] = {
96 static int i_create_session(struct cdev *dev, int *ndev);
98 static int i_ping(struct cdev *dev);
99 static int i_send(struct cdev *dev, caddr_t arg, struct thread *td);
100 static int i_recv(struct cdev *dev, caddr_t arg, struct thread *td);
101 static int i_setsoc(isc_session_t *sp, int fd, struct thread *td);
102 static int i_fullfeature(struct cdev *dev, int flag);
104 static d_open_t iscsi_open;
105 static d_close_t iscsi_close;
106 static d_ioctl_t iscsi_ioctl;
107 #ifdef ISCSI_INITIATOR_DEBUG
108 static d_read_t iscsi_read;
111 static struct cdevsw iscsi_cdevsw = {
112 .d_version = D_VERSION,
113 .d_open = iscsi_open,
114 .d_close = iscsi_close,
115 .d_ioctl = iscsi_ioctl,
116 #ifdef ISCSI_INITIATOR_DEBUG
117 .d_read = iscsi_read,
123 iscsi_open(struct cdev *dev, int flags, int otype, struct thread *td)
127 debug(7, "dev=%d", dev2unit(dev));
129 if(dev2unit(dev) > max_sessions) {
137 iscsi_close(struct cdev *dev, int flag, int otyp, struct thread *td)
143 debug(3, "session=%d flag=%x", dev2unit(dev), flag);
145 if(dev2unit(dev) == max_sessions) {
150 sdebug(3, "sp->flags=%x", sp->flags );
152 | if still in full phase, this probably means
153 | that something went really bad.
154 | it could be a result from 'shutdown', in which case
155 | we will ignore it (so buffers can be flushed).
156 | the problem is that there is no way of differentiating
157 | between a shutdown procedure and 'iscontrol' dying.
159 if(sp->flags & ISC_FFPHASE)
160 // delay in case this is a shutdown.
161 tsleep(sp, PRIBIO, "isc-cls", 60*hz);
169 iscsi_ioctl(struct cdev *dev, u_long cmd, caddr_t arg, int mode, struct thread *td)
171 struct isc_softc *sc;
179 if(dev2unit(dev) == max_sessions) {
181 | non Session commands
189 error = i_create_session(dev, (int *)arg);
205 sdebug(6, "dev=%d cmd=%d", dev2unit(dev), (int)(cmd & 0xff));
209 error = i_setsoc(sp, *(u_int *)arg, td);
213 opt = (isc_opt_t *)arg;
214 error = i_setopt(sp, opt);
218 error = i_send(dev, arg, td);
222 error = i_recv(dev, arg, td);
230 error = sp->soc == NULL? ENOTCONN: i_fullfeature(dev, 1);
232 sp->proc = td->td_proc;
233 SYSCTL_ADD_INT(&sp->clist, SYSCTL_CHILDREN(sp->oid),
234 OID_AUTO, "pid", CTLFLAG_RD,
235 &sp->proc->p_pid, sizeof(pid_t), "control process id");
240 error = sp->soc == NULL? ENOTCONN: i_fullfeature(dev, 2);
244 error = i_fullfeature(dev, 0);
248 int sig = *(int *)arg;
250 if(sig < 0 || sig > _SIG_MAXSIG)
258 iscsi_cam_t *cp = (iscsi_cam_t *)arg;
260 error = ic_getCamVals(sp, cp);
272 iscsi_read(struct cdev *dev, struct uio *uio, int ioflag)
274 #ifdef ISCSI_INITIATOR_DEBUG
275 struct isc_softc *sc;
282 if(dev2unit(dev) == max_sessions) {
283 sprintf(buf, "/----- Session ------/\n");
284 uiomove(buf, strlen(buf), uio);
287 TAILQ_FOREACH(sp, &sc->isc_sess, sp_link) {
288 if(uio->uio_resid == 0)
290 sprintf(buf, "%03d] '%s' '%s'\n", i++, sp->opt.targetAddress, sp->opt.targetName);
291 uiomove(buf, strlen(buf), uio);
293 sprintf(buf, "free npdu_alloc=%d, npdu_max=%d\n", sc->npdu_alloc, sc->npdu_max);
294 uiomove(buf, strlen(buf), uio);
298 struct socket *so = sp->soc;
299 #define pukeit(i, pq) do {\
300 sprintf(buf, "%03d] %06x %02x %06x %06x %jd\n",\
301 i, ntohl(pq->pdu.ipdu.bhs.CmdSN),\
302 pq->pdu.ipdu.bhs.opcode, ntohl(pq->pdu.ipdu.bhs.itt),\
303 ntohl(pq->pdu.ipdu.bhs.ExpStSN),\
304 (intmax_t)pq->ts.sec);\
307 sprintf(buf, "%d/%d /---- hld -----/\n", sp->stats.nhld, sp->stats.max_hld);
308 uiomove(buf, strlen(buf), uio);
309 TAILQ_FOREACH(pq, &sp->hld, pq_link) {
310 if(uio->uio_resid == 0)
313 uiomove(buf, strlen(buf), uio);
315 sprintf(buf, "%d/%d /---- rsp -----/\n", sp->stats.nrsp, sp->stats.max_rsp);
316 uiomove(buf, strlen(buf), uio);
318 TAILQ_FOREACH(pq, &sp->rsp, pq_link) {
319 if(uio->uio_resid == 0)
322 uiomove(buf, strlen(buf), uio);
324 sprintf(buf, "%d/%d /---- csnd -----/\n", sp->stats.ncsnd, sp->stats.max_csnd);
326 uiomove(buf, strlen(buf), uio);
327 TAILQ_FOREACH(pq, &sp->csnd, pq_link) {
328 if(uio->uio_resid == 0)
331 uiomove(buf, strlen(buf), uio);
333 sprintf(buf, "%d/%d /---- wsnd -----/\n", sp->stats.nwsnd, sp->stats.max_wsnd);
335 uiomove(buf, strlen(buf), uio);
336 TAILQ_FOREACH(pq, &sp->wsnd, pq_link) {
337 if(uio->uio_resid == 0)
340 uiomove(buf, strlen(buf), uio);
342 sprintf(buf, "%d/%d /---- isnd -----/\n", sp->stats.nisnd, sp->stats.max_isnd);
344 uiomove(buf, strlen(buf), uio);
345 TAILQ_FOREACH(pq, &sp->isnd, pq_link) {
346 if(uio->uio_resid == 0)
349 uiomove(buf, strlen(buf), uio);
352 sprintf(buf, "/---- Stats ---/\n");
353 uiomove(buf, strlen(buf), uio);
355 sprintf(buf, "recv=%d sent=%d\n", sp->stats.nrecv, sp->stats.nsent);
356 uiomove(buf, strlen(buf), uio);
358 sprintf(buf, "flags=%x pdus: alloc=%d max=%d\n",
359 sp->flags, sc->npdu_alloc, sc->npdu_max);
360 uiomove(buf, strlen(buf), uio);
362 sprintf(buf, "cws=%d last cmd=%x exp=%x max=%x stat=%x itt=%x\n",
363 sp->cws, sp->sn.cmd, sp->sn.expCmd, sp->sn.maxCmd, sp->sn.stat, sp->sn.itt);
364 uiomove(buf, strlen(buf), uio);
366 sprintf(buf, "/---- socket -----/\nso_count=%d so_state=%x\n", so->so_count, so->so_state);
367 uiomove(buf, strlen(buf), uio);
375 i_ping(struct cdev *dev)
383 i_setsoc(isc_session_t *sp, int fd, struct thread *td)
389 isc_stop_receiver(sp);
391 error = getsock_cap(td, fd, cap_rights_init(&rights, CAP_SOCK_CLIENT),
392 &sp->fp, NULL, NULL);
396 sp->soc = sp->fp->f_data;
398 isc_start_receiver(sp);
404 i_send(struct cdev *dev, caddr_t arg, struct thread *td)
406 isc_session_t *sp = dev->si_drv2;
417 if((pq = pdu_alloc(sp->isc, M_NOWAIT)) == NULL)
420 pq->pdu = *(pdu_t *)arg;
421 if((error = i_prepPDU(sp, pq)) != 0)
425 if((pq->len - sizeof(union ipdu_u)) > 0) {
426 pq->buf = bp = malloc(pq->len - sizeof(union ipdu_u), M_ISCSIBUF, M_NOWAIT);
427 if(pq->buf == NULL) {
433 pq->buf = NULL; // just in case?
435 sdebug(2, "len=%d ahs_len=%d ds_len=%d buf=%zu@%p",
436 pq->len, pp->ahs_len, pp->ds_len, pq->len - sizeof(union ipdu_u), bp);
439 // XXX: never tested, looks suspicious
441 error = copyin(pp->ahs_addr, bp, n);
443 sdebug(3, "copyin ahs: error=%d", error);
446 pp->ahs_addr = (ahs_t *)bp;
451 error = copyin(pp->ds_addr, bp, n);
453 sdebug(3, "copyin ds: error=%d", error);
464 error = isc_qout(sp, pq);
466 wakeup(&sp->flags); // XXX: to 'push' proc_out ...
469 pdu_free(sp->isc, pq);
475 i_recv(struct cdev *dev, caddr_t arg, struct thread *td)
477 isc_session_t *sp = dev->si_drv2;
481 int error, mustfree, cnt;
482 size_t need, have, n;
491 cnt = 6; // XXX: maybe the user can request a time out?
492 mtx_lock(&sp->rsp_mtx);
493 while((pq = TAILQ_FIRST(&sp->rsp)) == NULL) {
494 msleep(&sp->rsp, &sp->rsp_mtx, PRIBIO, "isc_rsp", hz*10);
495 if(cnt-- == 0) break; // XXX: for now, needs work
499 TAILQ_REMOVE(&sp->rsp, pq, pq_link);
501 mtx_unlock(&sp->rsp_mtx);
503 sdebug(6, "cnt=%d", cnt);
507 sdebug(3, "error=%d sp->flags=%x ", error, sp->flags);
531 if(len > pq->mp->m_len) {
533 bp = malloc(len, M_TMP, M_WAITOK);
534 sdebug(4, "need mbufcopy: %d", len);
535 i_mbufcopy(pq->mp, bp, len);
538 bp = mtod(pq->mp, caddr_t);
542 n = MIN(up->ahs_size, need);
543 error = copyout(bp, (caddr_t)up->ahs_addr, n);
547 if(!error && pp->ds_len) {
549 if((have = up->ds_size) == 0) {
550 have = up->ahs_size - n;
551 up->ds_addr = (caddr_t)up->ahs_addr + n;
554 error = copyout(bp, (caddr_t)up->ds_addr, n);
562 sdebug(6, "len=%d ahs_len=%d ds_len=%d", pq->len, pp->ahs_len, pp->ds_len);
564 pdu_free(sp->isc, pq);
570 i_fullfeature(struct cdev *dev, int flag)
572 isc_session_t *sp = dev->si_drv2;
575 sdebug(2, "flag=%d", flag);
580 sp->flags &= ~ISC_FFPHASE;
583 sp->flags |= ISC_FFPHASE;
587 sp->flags |= ISC_FFPHASE;
595 i_create_session(struct cdev *dev, int *ndev)
597 struct isc_softc *sc = dev->si_drv1;
603 sp = malloc(sizeof(isc_session_t), M_ISCSI, M_WAITOK | M_ZERO);
607 sx_xlock(&sc->unit_sx);
608 if((n = alloc_unr(sc->unit)) < 0) {
609 sx_unlock(&sc->unit_sx);
611 xdebug("too many sessions!");
614 sx_unlock(&sc->unit_sx);
616 mtx_lock(&sc->isc_mtx);
617 TAILQ_INSERT_TAIL(&sc->isc_sess, sp, sp_link);
619 mtx_unlock(&sc->isc_mtx);
621 sp->dev = make_dev(&iscsi_cdevsw, n, UID_ROOT, GID_WHEEL, 0600, "iscsi%d", n);
624 sp->dev->si_drv1 = sc;
625 sp->dev->si_drv2 = sp;
627 sp->opt.maxRecvDataSegmentLength = 8192;
628 sp->opt.maxXmitDataSegmentLength = 8192;
629 sp->opt.maxBurstLength = 65536; // 64k
630 sp->opt.maxluns = ISCSI_MAX_LUNS;
632 error = ism_start(sp);
639 iscsi_counters(isc_session_t *sp)
644 #define _puke(i, pq) do {\
645 debug(2, "%03d] %06x %02x %x %ld %jd %x\n",\
646 i, ntohl( pq->pdu.ipdu.bhs.CmdSN), \
647 pq->pdu.ipdu.bhs.opcode, ntohl(pq->pdu.ipdu.bhs.itt),\
648 (long)pq->ts.sec, pq->ts.frac, pq->flags);\
652 TAILQ_FOREACH(pq, &sp->hld, pq_link) {
656 TAILQ_FOREACH(pq, &sp->rsp, pq_link) r++;
657 TAILQ_FOREACH(pq, &sp->csnd, pq_link) s++;
658 TAILQ_FOREACH(pq, &sp->wsnd, pq_link) s++;
659 TAILQ_FOREACH(pq, &sp->isnd, pq_link) s++;
660 debug(2, "hld=%d rsp=%d snd=%d", h, r, s);
665 iscsi_shutdown(void *v)
667 struct isc_softc *sc = v;
673 xdebug("sc is NULL!");
676 #ifdef DO_EVENTHANDLER
678 debug(2, "sc->eh is NULL");
680 EVENTHANDLER_DEREGISTER(shutdown_pre_sync, sc->eh);
681 debug(2, "done n=%d", sc->nsess);
685 TAILQ_FOREACH(sp, &sc->isc_sess, sp_link) {
686 debug(2, "%2d] sp->flags=0x%08x", n, sp->flags);
693 free_pdus(struct isc_softc *sc)
697 if(sc->pdu_zone != NULL) {
698 uma_zdestroy(sc->pdu_zone);
708 isc = malloc(sizeof(struct isc_softc), M_ISCSI, M_ZERO|M_WAITOK);
709 mtx_init(&isc->isc_mtx, "iscsi-isc", NULL, MTX_DEF);
711 TAILQ_INIT(&isc->isc_sess);
713 | now init the free pdu list
715 isc->pdu_zone = uma_zcreate("pdu", sizeof(pduq_t),
716 NULL, NULL, NULL, NULL,
718 uma_zone_set_max(isc->pdu_zone, max_pdus);
719 isc->unit = new_unrhdr(0, max_sessions-1, NULL);
720 sx_init(&isc->unit_sx, "iscsi sx");
722 #ifdef DO_EVENTHANDLER
723 if((isc->eh = EVENTHANDLER_REGISTER(shutdown_pre_sync, iscsi_shutdown,
724 sc, SHUTDOWN_PRI_DEFAULT-1)) == NULL)
725 xdebug("shutdown event registration failed\n");
730 sysctl_ctx_init(&isc->clist);
731 isc->oid = SYSCTL_ADD_NODE(&isc->clist,
732 SYSCTL_STATIC_CHILDREN(_net),
739 SYSCTL_ADD_STRING(&isc->clist,
740 SYSCTL_CHILDREN(isc->oid),
744 iscsi_driver_version,
746 "iscsi driver version");
748 SYSCTL_ADD_STRING(&isc->clist,
749 SYSCTL_CHILDREN(isc->oid),
755 "initiator part of the Session Identifier");
757 SYSCTL_ADD_INT(&isc->clist,
758 SYSCTL_CHILDREN(isc->oid),
764 "number of active session");
766 #ifdef ISCSI_INITIATOR_DEBUG
767 mtx_init(&iscsi_dbg_mtx, "iscsi_dbg", NULL, MTX_DEF);
770 isc->dev = make_dev_credf(MAKEDEV_CHECKNAME, &iscsi_cdevsw, max_sessions,
771 NULL, UID_ROOT, GID_WHEEL, 0600, "iscsi");
772 if (isc->dev == NULL) {
773 xdebug("iscsi_initiator: make_dev_credf failed");
776 isc->dev->si_drv1 = isc;
778 printf("iscsi: version %s\n", iscsi_driver_version);
784 | unload SHOULD fail if there is activity
785 | activity: there is/are active session/s
790 isc_session_t *sp, *sp_tmp;
795 | go through all the sessions
796 | Note: close should have done this ...
798 TAILQ_FOREACH_SAFE(sp, &isc->isc_sess, sp_link, sp_tmp) {
799 //XXX: check for activity ...
802 mtx_destroy(&isc->isc_mtx);
803 sx_destroy(&isc->unit_sx);
808 destroy_dev(isc->dev);
810 if(sysctl_ctx_free(&isc->clist))
811 xdebug("sysctl_ctx_free failed");
813 iscsi_shutdown(isc); // XXX: check EVENTHANDLER_ ...
815 #ifdef ISCSI_INITIATOR_DEBUG
816 mtx_destroy(&iscsi_dbg_mtx);
823 iscsi_modevent(module_t mod, int what, void *arg)
831 error = iscsi_start();
836 xdebug("iscsi module busy(nsess=%d), cannot unload", isc->nsess);
837 log(LOG_ERR, "iscsi module busy, cannot unload");
854 moduledata_t iscsi_mod = {
856 (modeventhand_t) iscsi_modevent,
865 nfs_setup_diskless();
866 if (nfs_diskless_valid)
867 rootdevnames[0] = "nfs:";
869 printf("** iscsi_rootconf **\n");
872 SYSINIT(cpu_rootconf1, SI_SUB_ROOT_CONF, SI_ORDER_FIRST, iscsi_rootconf, NULL)
875 DECLARE_MODULE(iscsi_initiator, iscsi_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE);
876 MODULE_DEPEND(iscsi_initiator, cam, 1, 1, 1);