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
32 | $Id: iscsivar.h 743 2009-08-08 10:54:53Z danny $
35 #include <sys/mutex.h>
37 #define ISCSI_MAX_LUNS 128 // don't touch this
38 #if ISCSI_MAX_LUNS > 8
41 | sysctl kern.cam.cam_srch_hi=1
45 #ifndef ISCSI_INITIATOR_DEBUG
46 #define ISCSI_INITIATOR_DEBUG 1
49 #ifdef ISCSI_INITIATOR_DEBUG
50 extern int iscsi_debug;
51 #define debug(level, fmt, args...) do {if(level <= iscsi_debug)\
52 printf("%s: " fmt "\n", __func__ , ##args);} while(0)
53 #define sdebug(level, fmt, args...) do {if(level <= iscsi_debug)\
54 printf("%d] %s: " fmt "\n", sp->sid, __func__ , ##args);} while(0)
55 #define debug_called(level) do {if(level <= iscsi_debug)\
56 printf("%s: called\n", __func__);} while(0)
58 #define debug(level, fmt, args...)
59 #define debug_called(level)
60 #define sdebug(level, fmt, args...)
61 #endif /* ISCSI_INITIATOR_DEBUG */
63 #define xdebug(fmt, args...) printf(">>> %s: " fmt "\n", __func__ , ##args)
65 #define MAX_SESSIONS ISCSI_MAX_TARGETS
66 #define MAX_PDUS (MAX_SESSIONS*256) // XXX: at the moment this is arbitrary
68 typedef uint32_t digest_t(const void *, int len, uint32_t ocrc);
70 MALLOC_DECLARE(M_ISCSI);
71 MALLOC_DECLARE(M_ISCSIBUF);
73 #define ISOK2DIG(dig, pp) ((dig != NULL) && ((pp->ipdu.bhs.opcode & 0x1f) != ISCSI_LOGIN_CMD))
76 #define BIT(n) (1 <<(n))
79 #define ISC_SM_RUN BIT(0)
80 #define ISC_SM_RUNNING BIT(1)
82 #define ISC_LINK_UP BIT(2)
83 #define ISC_CON_RUN BIT(3)
84 #define ISC_CON_RUNNING BIT(4)
85 #define ISC_KILL BIT(5)
86 #define ISC_OQNOTEMPTY BIT(6)
87 #define ISC_OWAITING BIT(7)
88 #define ISC_FFPHASE BIT(8)
90 #define ISC_CAMDEVS BIT(9)
91 #define ISC_SCANWAIT BIT(10)
93 #define ISC_MEMWAIT BIT(11)
94 #define ISC_SIGNALED BIT(12)
96 #define ISC_HOLD BIT(15)
97 #define ISC_HOLDED BIT(16)
99 #define ISC_SHUTDOWN BIT(31)
105 int npdu; // number of pdus malloc'ed.
106 int nrecv; // unprocessed received pdus
107 int nsent; // sent pdus
116 struct bintime t_sent;
117 struct bintime t_recv;
124 typedef TAILQ_HEAD(, pduq) queue_t;
126 typedef struct isc_session {
127 TAILQ_ENTRY(isc_session) sp_link;
134 struct proc *proc; // the userland process
136 struct proc *soc_proc;
137 struct proc *stp; // the sm thread
139 struct isc_softc *isc;
141 digest_t *hdrDigest; // the digest alg. if any
142 digest_t *dataDigest; // the digest alg. if any
144 int sid; // Session ID
145 sn_t sn; // sequence number stuff;
146 int cws; // current window size
148 int target_nluns; // this and target_lun are
149 // hopefully temporal till I
150 // figure out a better way.
151 int target_lun[ISCSI_MAX_LUNS/(sizeof(int)*8) + 1];
165 isc_opt_t opt; // negotiable values
167 struct i_stats stats;
174 struct cam_sim *cam_sim;
175 struct cam_path *cam_path;
180 struct sysctl_ctx_list clist;
181 struct sysctl_oid *oid;
182 int douio; //XXX: turn on/off uio on read
185 typedef struct pduq {
186 TAILQ_ENTRY(pduq) pq_link;
189 u_int len; // the total length of the pdu
194 struct iovec iov[5]; // XXX: careful ...
203 TAILQ_HEAD(,isc_session) isc_sess;
206 char isid[6]; // Initiator Session ID (48 bits)
210 uma_zone_t pdu_zone; // pool of free pdu's
211 TAILQ_HEAD(,pduq) freepdu;
213 #ifdef ISCSI_INITIATOR_DEBUG
214 int npdu_alloc, npdu_max; // for instrumentation
216 #ifdef DO_EVENTHANDLER
222 struct sysctl_ctx_list clist;
223 struct sysctl_oid *oid;
226 #ifdef ISCSI_INITIATOR_DEBUG
227 extern struct mtx iscsi_dbg_mtx;
230 void isc_start_receiver(isc_session_t *sp);
231 void isc_stop_receiver(isc_session_t *sp);
233 int isc_sendPDU(isc_session_t *sp, pduq_t *pq);
234 int isc_qout(isc_session_t *sp, pduq_t *pq);
235 int i_prepPDU(isc_session_t *sp, pduq_t *pq);
237 int ism_fullfeature(struct cdev *dev, int flag);
239 int i_pdu_flush(isc_session_t *sc);
240 int i_setopt(isc_session_t *sp, isc_opt_t *opt);
241 void i_freeopt(isc_opt_t *opt);
243 int ic_init(isc_session_t *sp);
244 void ic_destroy(isc_session_t *sp);
245 void ic_lost_target(isc_session_t *sp, int target);
246 int ic_getCamVals(isc_session_t *sp, iscsi_cam_t *cp);
248 void ism_recv(isc_session_t *sp, pduq_t *pq);
249 int ism_start(isc_session_t *sp);
250 void ism_restart(isc_session_t *sp);
251 void ism_stop(isc_session_t *sp);
253 int scsi_encap(struct cam_sim *sim, union ccb *ccb);
254 int scsi_decap(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
255 void iscsi_r2t(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
256 void iscsi_done(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
257 void iscsi_reject(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
258 void iscsi_async(isc_session_t *sp, pduq_t *pq);
259 void iscsi_cleanup(isc_session_t *sp);
260 int iscsi_requeue(isc_session_t *sp);
262 // Serial Number Arithmetic
263 #define _MAXINCR 0x7FFFFFFF // 2 ^ 31 - 1
264 #define SNA_GT(i1, i2) ((i1 != i2) && (\
265 (i1 < i2 && i2 - i1 > _MAXINCR) ||\
266 (i1 > i2 && i1 - i2 < _MAXINCR))?1: 0)
271 #ifdef _CAM_CAM_XPT_SIM_H
273 #if __FreeBSD_version < 600000
274 #define CAM_LOCK(arg)
275 #define CAM_ULOCK(arg)
278 XPT_DONE(isc_session_t *sp, union ccb *ccb)
284 #elif __FreeBSD_version >= 700000
285 #define CAM_LOCK(arg) mtx_lock(&arg->cam_mtx)
286 #define CAM_UNLOCK(arg) mtx_unlock(&arg->cam_mtx)
289 XPT_DONE(isc_session_t *sp, union ccb *ccb)
296 //__FreeBSD_version >= 600000
297 #define CAM_LOCK(arg)
298 #define CAM_UNLOCK(arg)
299 #define XPT_DONE(ignore, arg) xpt_done(arg)
302 #endif /* _CAM_CAM_XPT_SIM_H */
304 static __inline pduq_t *
305 pdu_alloc(struct isc_softc *isc, int wait)
309 pq = (pduq_t *)uma_zalloc(isc->pdu_zone, wait /* M_WAITOK or M_NOWAIT*/);
311 debug(7, "out of mem");
314 #ifdef ISCSI_INITIATOR_DEBUG
315 mtx_lock(&iscsi_dbg_mtx);
317 if(isc->npdu_alloc > isc->npdu_max)
318 isc->npdu_max = isc->npdu_alloc;
319 mtx_unlock(&iscsi_dbg_mtx);
321 memset(pq, 0, sizeof(pduq_t));
327 pdu_free(struct isc_softc *isc, pduq_t *pq)
333 free(pq->buf, M_ISCSIBUF);
335 uma_zfree(isc->pdu_zone, pq);
336 #ifdef ISCSI_INITIATOR_DEBUG
337 mtx_lock(&iscsi_dbg_mtx);
339 mtx_unlock(&iscsi_dbg_mtx);
344 i_nqueue_rsp(isc_session_t *sp, pduq_t *pq)
346 mtx_lock(&sp->rsp_mtx);
347 if(++sp->stats.nrsp > sp->stats.max_rsp)
348 sp->stats.max_rsp = sp->stats.nrsp;
349 TAILQ_INSERT_TAIL(&sp->rsp, pq, pq_link);
350 mtx_unlock(&sp->rsp_mtx);
353 static __inline pduq_t *
354 i_dqueue_rsp(isc_session_t *sp)
358 mtx_lock(&sp->rsp_mtx);
359 if((pq = TAILQ_FIRST(&sp->rsp)) != NULL) {
361 TAILQ_REMOVE(&sp->rsp, pq, pq_link);
363 mtx_unlock(&sp->rsp_mtx);
369 i_nqueue_rsv(isc_session_t *sp, pduq_t *pq)
371 mtx_lock(&sp->rsv_mtx);
372 if(++sp->stats.nrsv > sp->stats.max_rsv)
373 sp->stats.max_rsv = sp->stats.nrsv;
374 TAILQ_INSERT_TAIL(&sp->rsv, pq, pq_link);
375 mtx_unlock(&sp->rsv_mtx);
378 static __inline pduq_t *
379 i_dqueue_rsv(isc_session_t *sp)
383 mtx_lock(&sp->rsv_mtx);
384 if((pq = TAILQ_FIRST(&sp->rsv)) != NULL) {
386 TAILQ_REMOVE(&sp->rsv, pq, pq_link);
388 mtx_unlock(&sp->rsv_mtx);
394 i_nqueue_csnd(isc_session_t *sp, pduq_t *pq)
396 mtx_lock(&sp->snd_mtx);
397 if(++sp->stats.ncsnd > sp->stats.max_csnd)
398 sp->stats.max_csnd = sp->stats.ncsnd;
399 TAILQ_INSERT_TAIL(&sp->csnd, pq, pq_link);
400 mtx_unlock(&sp->snd_mtx);
403 static __inline pduq_t *
404 i_dqueue_csnd(isc_session_t *sp)
408 mtx_lock(&sp->snd_mtx);
409 if((pq = TAILQ_FIRST(&sp->csnd)) != NULL) {
411 TAILQ_REMOVE(&sp->csnd, pq, pq_link);
413 mtx_unlock(&sp->snd_mtx);
419 i_nqueue_isnd(isc_session_t *sp, pduq_t *pq)
421 mtx_lock(&sp->snd_mtx);
422 if(++sp->stats.nisnd > sp->stats.max_isnd)
423 sp->stats.max_isnd = sp->stats.nisnd;
424 TAILQ_INSERT_TAIL(&sp->isnd, pq, pq_link);
425 mtx_unlock(&sp->snd_mtx);
428 static __inline pduq_t *
429 i_dqueue_isnd(isc_session_t *sp)
433 mtx_lock(&sp->snd_mtx);
434 if((pq = TAILQ_FIRST(&sp->isnd)) != NULL) {
436 TAILQ_REMOVE(&sp->isnd, pq, pq_link);
438 mtx_unlock(&sp->snd_mtx);
444 i_nqueue_wsnd(isc_session_t *sp, pduq_t *pq)
446 mtx_lock(&sp->snd_mtx);
447 if(++sp->stats.nwsnd > sp->stats.max_wsnd)
448 sp->stats.max_wsnd = sp->stats.nwsnd;
449 TAILQ_INSERT_TAIL(&sp->wsnd, pq, pq_link);
450 mtx_unlock(&sp->snd_mtx);
453 static __inline pduq_t *
454 i_dqueue_wsnd(isc_session_t *sp)
458 mtx_lock(&sp->snd_mtx);
459 if((pq = TAILQ_FIRST(&sp->wsnd)) != NULL) {
461 TAILQ_REMOVE(&sp->wsnd, pq, pq_link);
463 mtx_unlock(&sp->snd_mtx);
468 static __inline pduq_t *
469 i_dqueue_snd(isc_session_t *sp, int which)
474 mtx_lock(&sp->snd_mtx);
475 if((which & BIT(0)) && (pq = TAILQ_FIRST(&sp->isnd)) != NULL) {
477 TAILQ_REMOVE(&sp->isnd, pq, pq_link);
478 pq->pduq = &sp->isnd; // remember where you came from
480 if((which & BIT(1)) && (pq = TAILQ_FIRST(&sp->wsnd)) != NULL) {
482 TAILQ_REMOVE(&sp->wsnd, pq, pq_link);
483 pq->pduq = &sp->wsnd; // remember where you came from
485 if((which & BIT(2)) && (pq = TAILQ_FIRST(&sp->csnd)) != NULL) {
487 TAILQ_REMOVE(&sp->csnd, pq, pq_link);
488 pq->pduq = &sp->csnd; // remember where you came from
490 mtx_unlock(&sp->snd_mtx);
496 i_rqueue_pdu(isc_session_t *sp, pduq_t *pq)
498 mtx_lock(&sp->snd_mtx);
499 KASSERT(pq->pduq != NULL, ("pq->pduq is NULL"));
500 TAILQ_INSERT_TAIL(pq->pduq, pq, pq_link);
501 mtx_unlock(&sp->snd_mtx);
505 | Waiting for ACK (or something :-)
508 i_nqueue_hld(isc_session_t *sp, pduq_t *pq)
511 mtx_lock(&sp->hld_mtx);
512 if(++sp->stats.nhld > sp->stats.max_hld)
513 sp->stats.max_hld = sp->stats.nhld;
514 TAILQ_INSERT_TAIL(&sp->hld, pq, pq_link);
515 mtx_unlock(&sp->hld_mtx);
520 i_remove_hld(isc_session_t *sp, pduq_t *pq)
522 mtx_lock(&sp->hld_mtx);
524 TAILQ_REMOVE(&sp->hld, pq, pq_link);
525 mtx_unlock(&sp->hld_mtx);
528 static __inline pduq_t *
529 i_dqueue_hld(isc_session_t *sp)
533 mtx_lock(&sp->hld_mtx);
534 if((pq = TAILQ_FIRST(&sp->hld)) != NULL) {
536 TAILQ_REMOVE(&sp->hld, pq, pq_link);
538 mtx_unlock(&sp->hld_mtx);
543 static __inline pduq_t *
544 i_search_hld(isc_session_t *sp, int itt, int keep)
550 mtx_lock(&sp->hld_mtx);
551 TAILQ_FOREACH_SAFE(pq, &sp->hld, pq_link, tmp) {
552 if(pq->pdu.ipdu.bhs.itt == itt) {
555 TAILQ_REMOVE(&sp->hld, pq, pq_link);
560 mtx_unlock(&sp->hld_mtx);
566 i_acked_hld(isc_session_t *sp, pdu_t *op)
569 u_int exp = sp->sn.expCmd;
572 mtx_lock(&sp->hld_mtx);
573 TAILQ_FOREACH_SAFE(pq, &sp->hld, pq_link, tmp) {
574 if((op && op->ipdu.bhs.itt == pq->pdu.ipdu.bhs.itt)
576 && (pq->pdu.ipdu.bhs.opcode != ISCSI_WRITE_DATA)
577 && SNA_GT(exp, ntohl(pq->pdu.ipdu.bhs.ExpStSN)))) {
579 TAILQ_REMOVE(&sp->hld, pq, pq_link);
580 pdu_free(sp->isc, pq);
583 mtx_unlock(&sp->hld_mtx);
587 i_mbufcopy(struct mbuf *mp, caddr_t dp, int len)
592 for(m = mp; m != NULL; m = m->m_next) {
593 bp = mtod(m, caddr_t);
595 | the pdu is word (4 octed) aligned
598 memcpy(dp, bp, MIN(len, m->m_len));