1/*-
2 * Copyright (c) 2005-2010 Daniel Braniss <danny@cs.huji.ac.il>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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
--- 7 unchanged lines hidden (view full) ---
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
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/dev/iscsi/initiator/iscsivar.h 211095 2010-08-09 12:36:36Z des $
27 */
28
29/*
30 | $Id: iscsivar.h 743 2009-08-08 10:54:53Z danny $
31 */
32#define ISCSI_MAX_LUNS 128 // don't touch this
33#if ISCSI_MAX_LUNS > 8
34/*
35 | for this to work
36 | sysctl kern.cam.cam_srch_hi=1
37 */
38#endif
39
40#ifndef ISCSI_INITIATOR_DEBUG
41#define ISCSI_INITIATOR_DEBUG 1
42#endif
43
44#ifdef ISCSI_INITIATOR_DEBUG
45extern int iscsi_debug;
46#define debug(level, fmt, args...) do {if(level <= iscsi_debug)\
47 printf("%s: " fmt "\n", __func__ , ##args);} while(0)
--- 4 unchanged lines hidden (view full) ---
52#else
53#define debug(level, fmt, args...)
54#define debug_called(level)
55#define sdebug(level, fmt, args...)
56#endif /* ISCSI_INITIATOR_DEBUG */
57
58#define xdebug(fmt, args...) printf(">>> %s: " fmt "\n", __func__ , ##args)
59
60#define MAX_SESSIONS ISCSI_MAX_TARGETS
61#define MAX_PDUS (MAX_SESSIONS*256) // XXX: at the moment this is arbitrary
62
63typedef uint32_t digest_t(const void *, int len, uint32_t ocrc);
64
65MALLOC_DECLARE(M_ISCSI);
66MALLOC_DECLARE(M_ISCSIBUF);
67MALLOC_DECLARE(M_PDU);
68
69#define ISOK2DIG(dig, pp) ((dig != NULL) && ((pp->ipdu.bhs.opcode & 0x1f) != ISCSI_LOGIN_CMD))
70
71#ifndef BIT
72#define BIT(n) (1 <<(n))
73#endif
74
75#define ISC_SM_RUN BIT(0)
76#define ISC_SM_RUNNING BIT(1)
77
78#define ISC_LINK_UP BIT(2)
79#define ISC_CON_RUN BIT(3)
80#define ISC_CON_RUNNING BIT(4)
81#define ISC_KILL BIT(5)
82#define ISC_OQNOTEMPTY BIT(6)
83#define ISC_OWAITING BIT(7)
84#define ISC_FFPHASE BIT(8)
85
86#define ISC_CAMDEVS BIT(9)
87#define ISC_SCANWAIT BIT(10)
88
89#define ISC_MEMWAIT BIT(11)
90#define ISC_SIGNALED BIT(12)
91
92#define ISC_HOLD BIT(15)
93#define ISC_HOLDED BIT(16)
94
95#define ISC_SHUTDOWN BIT(31)
96
97/*
98 | some stats
99 */
100struct i_stats {
101 int npdu; // number of pdus malloc'ed.
102 int nrecv; // unprocessed received pdus
--- 21 unchanged lines hidden (view full) ---
124 int flags;
125 struct cdev *dev;
126 struct socket *soc;
127 struct file *fp;
128 struct thread *td;
129
130 struct proc *proc; // the userland process
131 int signal;
132 struct proc *soc_proc;
133 struct proc *stp; // the sm thread
134
135 struct isc_softc *isc;
136
137 digest_t *hdrDigest; // the digest alg. if any
138 digest_t *dataDigest; // the digest alg. if any
139
140 int sid; // Session ID
141 sn_t sn; // sequence number stuff;
142 int cws; // current window size
143
144 int target_nluns; // this and target_lun are
145 // hopefully temporal till I
146 // figure out a better way.
147 int target_lun[ISCSI_MAX_LUNS/(sizeof(int)*8) + 1];
148
149 struct mtx rsp_mtx;
150 struct mtx rsv_mtx;
151 struct mtx snd_mtx;
152 struct mtx hld_mtx;
153 struct mtx io_mtx;
154 queue_t rsp;
155 queue_t rsv;
156 queue_t csnd;
157 queue_t isnd;
158 queue_t wsnd;
159 queue_t hld;
160
161 isc_opt_t opt; // negotiable values
162
163 struct i_stats stats;
164 bhs_t bhs;
165 struct uio uio;
166 struct iovec iov;
167 /*
168 | cam stuff
169 */
170 struct cam_sim *cam_sim;
171 struct cam_path *cam_path;
172 struct mtx cam_mtx;
173 /*
174 | sysctl stuff
175 */
176 struct sysctl_ctx_list clist;
177 struct sysctl_oid *oid;
178 int douio; //XXX: turn on/off uio on read
179} isc_session_t;
180
181typedef struct pduq {
182 TAILQ_ENTRY(pduq) pq_link;
183
184 caddr_t buf;
185 u_int len; // the total length of the pdu
186 pdu_t pdu;
187 union ccb *ccb;
188
189 struct uio uio;
190 struct iovec iov[5]; // XXX: careful ...
191 struct mbuf *mp;
192 struct bintime ts;
193 queue_t *pduq;
194} pduq_t;
195/*
196 */
197struct isc_softc {
198 struct mtx isc_mtx;
199 TAILQ_HEAD(,isc_session) isc_sess;
200 int nsess;
201 struct cdev *dev;
202 char isid[6]; // Initiator Session ID (48 bits)
203 struct unrhdr *unit;
204 struct sx unit_sx;
205
206 struct mtx pdu_mtx;
207 uma_zone_t pdu_zone; // pool of free pdu's
208 TAILQ_HEAD(,pduq) freepdu;
209
210#ifdef ISCSI_INITIATOR_DEBUG
211 int npdu_alloc, npdu_max; // for instrumentation
212#endif
213#ifdef DO_EVENTHANDLER
214 eventhandler_tag eh;
215#endif
216 /*
217 | sysctl stuff
218 */
219 struct sysctl_ctx_list clist;
220 struct sysctl_oid *oid;
221};
222
223#ifdef ISCSI_INITIATOR_DEBUG
224extern struct mtx iscsi_dbg_mtx;
--- 7 unchanged lines hidden (view full) ---
232int i_prepPDU(isc_session_t *sp, pduq_t *pq);
233
234int ism_fullfeature(struct cdev *dev, int flag);
235
236int i_pdu_flush(isc_session_t *sc);
237int i_setopt(isc_session_t *sp, isc_opt_t *opt);
238void i_freeopt(isc_opt_t *opt);
239
240int ic_init(isc_session_t *sp);
241void ic_destroy(isc_session_t *sp);
242void ic_lost_target(isc_session_t *sp, int target);
243int ic_getCamVals(isc_session_t *sp, iscsi_cam_t *cp);
244
245void ism_recv(isc_session_t *sp, pduq_t *pq);
246int ism_start(isc_session_t *sp);
247void ism_restart(isc_session_t *sp);
248void ism_stop(isc_session_t *sp);
249
250int scsi_encap(struct cam_sim *sim, union ccb *ccb);
251int scsi_decap(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
252void iscsi_r2t(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
253void iscsi_done(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
254void iscsi_reject(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
255void iscsi_async(isc_session_t *sp, pduq_t *pq);
256void iscsi_cleanup(isc_session_t *sp);
257int iscsi_requeue(isc_session_t *sp);
258
259// Serial Number Arithmetic
260#define _MAXINCR 0x7FFFFFFF // 2 ^ 31 - 1
261#define SNA_GT(i1, i2) ((i1 != i2) && (\
262 (i1 < i2 && i2 - i1 > _MAXINCR) ||\
263 (i1 > i2 && i1 - i2 < _MAXINCR))?1: 0)
264
265/*
266 | inlines
267 */
268#ifdef _CAM_CAM_XPT_SIM_H
269
270#if __FreeBSD_version < 600000
271#define CAM_LOCK(arg)
272#define CAM_ULOCK(arg)
273
274static __inline void
275XPT_DONE(isc_session_t *sp, union ccb *ccb)
276{
277 mtx_lock(&Giant);
278 xpt_done(ccb);
279 mtx_unlock(&Giant);
280}
281#elif __FreeBSD_version >= 700000
282#define CAM_LOCK(arg) mtx_lock(&arg->cam_mtx)
283#define CAM_UNLOCK(arg) mtx_unlock(&arg->cam_mtx)
284
285static __inline void
286XPT_DONE(isc_session_t *sp, union ccb *ccb)
287{
288 CAM_LOCK(sp);
289 xpt_done(ccb);
290 CAM_UNLOCK(sp);
291}
292#else
293//__FreeBSD_version >= 600000
294#define CAM_LOCK(arg)
295#define CAM_UNLOCK(arg)
296#define XPT_DONE(ignore, arg) xpt_done(arg)
297#endif
298
--- 31 unchanged lines hidden (view full) ---
330
331static __inline void
332pdu_free(struct isc_softc *isc, pduq_t *pq)
333{
334 if(pq->mp)
335 m_freem(pq->mp);
336#ifdef NO_USE_MBUF
337 if(pq->buf != NULL)
338 free(pq->buf, M_ISCSIBUF);
339#endif
340 mtx_lock(&isc->pdu_mtx);
341 TAILQ_INSERT_TAIL(&isc->freepdu, pq, pq_link);
342#ifdef ISCSI_INITIATOR_DEBUG
343 isc->npdu_alloc--;
344#endif
345 mtx_unlock(&isc->pdu_mtx);
346}
--- 216 unchanged lines hidden (view full) ---
563 }
564 }
565 mtx_unlock(&sp->hld_mtx);
566
567 return pq;
568}
569
570static __inline void
571i_acked_hld(isc_session_t *sp, pdu_t *op)
572{
573 pduq_t *pq, *tmp;
574 u_int exp = sp->sn.expCmd;
575
576 pq = NULL;
577 mtx_lock(&sp->hld_mtx);
578 TAILQ_FOREACH_SAFE(pq, &sp->hld, pq_link, tmp) {
579 if((op && op->ipdu.bhs.itt == pq->pdu.ipdu.bhs.itt)
580 || (pq->ccb == NULL
581 && (pq->pdu.ipdu.bhs.opcode != ISCSI_WRITE_DATA)
582 && SNA_GT(exp, ntohl(pq->pdu.ipdu.bhs.ExpStSN)))) {
583 sp->stats.nhld--;
584 TAILQ_REMOVE(&sp->hld, pq, pq_link);
585 pdu_free(sp->isc, pq);
586 }
587 }
588 mtx_unlock(&sp->hld_mtx);
589}
590
591static __inline void
592i_mbufcopy(struct mbuf *mp, caddr_t dp, int len)
593{
594 struct mbuf *m;
595 caddr_t bp;
596
597 for(m = mp; m != NULL; m = m->m_next) {
598 bp = mtod(m, caddr_t);
599 /*
600 | the pdu is word (4 octed) aligned
601 | so len <= packet
602 */
603 memcpy(dp, bp, MIN(len, m->m_len));
604 dp += m->m_len;
605 len -= m->m_len;
606 if(len <= 0)
607 break;
608 }
609}
2 * Copyright (c) 2005-2010 Daniel Braniss <danny@cs.huji.ac.il>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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
--- 7 unchanged lines hidden (view full) ---
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
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/dev/iscsi/initiator/iscsivar.h 211095 2010-08-09 12:36:36Z des $
27 */
28
29/*
30 | $Id: iscsivar.h 743 2009-08-08 10:54:53Z danny $
31 */
32#define ISCSI_MAX_LUNS 128 // don't touch this
33#if ISCSI_MAX_LUNS > 8
34/*
35 | for this to work
36 | sysctl kern.cam.cam_srch_hi=1
37 */
38#endif
39
40#ifndef ISCSI_INITIATOR_DEBUG
41#define ISCSI_INITIATOR_DEBUG 1
42#endif
43
44#ifdef ISCSI_INITIATOR_DEBUG
45extern int iscsi_debug;
46#define debug(level, fmt, args...) do {if(level <= iscsi_debug)\
47 printf("%s: " fmt "\n", __func__ , ##args);} while(0)
--- 4 unchanged lines hidden (view full) ---
52#else
53#define debug(level, fmt, args...)
54#define debug_called(level)
55#define sdebug(level, fmt, args...)
56#endif /* ISCSI_INITIATOR_DEBUG */
57
58#define xdebug(fmt, args...) printf(">>> %s: " fmt "\n", __func__ , ##args)
59
60#define MAX_SESSIONS ISCSI_MAX_TARGETS
61#define MAX_PDUS (MAX_SESSIONS*256) // XXX: at the moment this is arbitrary
62
63typedef uint32_t digest_t(const void *, int len, uint32_t ocrc);
64
65MALLOC_DECLARE(M_ISCSI);
66MALLOC_DECLARE(M_ISCSIBUF);
67MALLOC_DECLARE(M_PDU);
68
69#define ISOK2DIG(dig, pp) ((dig != NULL) && ((pp->ipdu.bhs.opcode & 0x1f) != ISCSI_LOGIN_CMD))
70
71#ifndef BIT
72#define BIT(n) (1 <<(n))
73#endif
74
75#define ISC_SM_RUN BIT(0)
76#define ISC_SM_RUNNING BIT(1)
77
78#define ISC_LINK_UP BIT(2)
79#define ISC_CON_RUN BIT(3)
80#define ISC_CON_RUNNING BIT(4)
81#define ISC_KILL BIT(5)
82#define ISC_OQNOTEMPTY BIT(6)
83#define ISC_OWAITING BIT(7)
84#define ISC_FFPHASE BIT(8)
85
86#define ISC_CAMDEVS BIT(9)
87#define ISC_SCANWAIT BIT(10)
88
89#define ISC_MEMWAIT BIT(11)
90#define ISC_SIGNALED BIT(12)
91
92#define ISC_HOLD BIT(15)
93#define ISC_HOLDED BIT(16)
94
95#define ISC_SHUTDOWN BIT(31)
96
97/*
98 | some stats
99 */
100struct i_stats {
101 int npdu; // number of pdus malloc'ed.
102 int nrecv; // unprocessed received pdus
--- 21 unchanged lines hidden (view full) ---
124 int flags;
125 struct cdev *dev;
126 struct socket *soc;
127 struct file *fp;
128 struct thread *td;
129
130 struct proc *proc; // the userland process
131 int signal;
132 struct proc *soc_proc;
133 struct proc *stp; // the sm thread
134
135 struct isc_softc *isc;
136
137 digest_t *hdrDigest; // the digest alg. if any
138 digest_t *dataDigest; // the digest alg. if any
139
140 int sid; // Session ID
141 sn_t sn; // sequence number stuff;
142 int cws; // current window size
143
144 int target_nluns; // this and target_lun are
145 // hopefully temporal till I
146 // figure out a better way.
147 int target_lun[ISCSI_MAX_LUNS/(sizeof(int)*8) + 1];
148
149 struct mtx rsp_mtx;
150 struct mtx rsv_mtx;
151 struct mtx snd_mtx;
152 struct mtx hld_mtx;
153 struct mtx io_mtx;
154 queue_t rsp;
155 queue_t rsv;
156 queue_t csnd;
157 queue_t isnd;
158 queue_t wsnd;
159 queue_t hld;
160
161 isc_opt_t opt; // negotiable values
162
163 struct i_stats stats;
164 bhs_t bhs;
165 struct uio uio;
166 struct iovec iov;
167 /*
168 | cam stuff
169 */
170 struct cam_sim *cam_sim;
171 struct cam_path *cam_path;
172 struct mtx cam_mtx;
173 /*
174 | sysctl stuff
175 */
176 struct sysctl_ctx_list clist;
177 struct sysctl_oid *oid;
178 int douio; //XXX: turn on/off uio on read
179} isc_session_t;
180
181typedef struct pduq {
182 TAILQ_ENTRY(pduq) pq_link;
183
184 caddr_t buf;
185 u_int len; // the total length of the pdu
186 pdu_t pdu;
187 union ccb *ccb;
188
189 struct uio uio;
190 struct iovec iov[5]; // XXX: careful ...
191 struct mbuf *mp;
192 struct bintime ts;
193 queue_t *pduq;
194} pduq_t;
195/*
196 */
197struct isc_softc {
198 struct mtx isc_mtx;
199 TAILQ_HEAD(,isc_session) isc_sess;
200 int nsess;
201 struct cdev *dev;
202 char isid[6]; // Initiator Session ID (48 bits)
203 struct unrhdr *unit;
204 struct sx unit_sx;
205
206 struct mtx pdu_mtx;
207 uma_zone_t pdu_zone; // pool of free pdu's
208 TAILQ_HEAD(,pduq) freepdu;
209
210#ifdef ISCSI_INITIATOR_DEBUG
211 int npdu_alloc, npdu_max; // for instrumentation
212#endif
213#ifdef DO_EVENTHANDLER
214 eventhandler_tag eh;
215#endif
216 /*
217 | sysctl stuff
218 */
219 struct sysctl_ctx_list clist;
220 struct sysctl_oid *oid;
221};
222
223#ifdef ISCSI_INITIATOR_DEBUG
224extern struct mtx iscsi_dbg_mtx;
--- 7 unchanged lines hidden (view full) ---
232int i_prepPDU(isc_session_t *sp, pduq_t *pq);
233
234int ism_fullfeature(struct cdev *dev, int flag);
235
236int i_pdu_flush(isc_session_t *sc);
237int i_setopt(isc_session_t *sp, isc_opt_t *opt);
238void i_freeopt(isc_opt_t *opt);
239
240int ic_init(isc_session_t *sp);
241void ic_destroy(isc_session_t *sp);
242void ic_lost_target(isc_session_t *sp, int target);
243int ic_getCamVals(isc_session_t *sp, iscsi_cam_t *cp);
244
245void ism_recv(isc_session_t *sp, pduq_t *pq);
246int ism_start(isc_session_t *sp);
247void ism_restart(isc_session_t *sp);
248void ism_stop(isc_session_t *sp);
249
250int scsi_encap(struct cam_sim *sim, union ccb *ccb);
251int scsi_decap(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
252void iscsi_r2t(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
253void iscsi_done(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
254void iscsi_reject(isc_session_t *sp, pduq_t *opq, pduq_t *pq);
255void iscsi_async(isc_session_t *sp, pduq_t *pq);
256void iscsi_cleanup(isc_session_t *sp);
257int iscsi_requeue(isc_session_t *sp);
258
259// Serial Number Arithmetic
260#define _MAXINCR 0x7FFFFFFF // 2 ^ 31 - 1
261#define SNA_GT(i1, i2) ((i1 != i2) && (\
262 (i1 < i2 && i2 - i1 > _MAXINCR) ||\
263 (i1 > i2 && i1 - i2 < _MAXINCR))?1: 0)
264
265/*
266 | inlines
267 */
268#ifdef _CAM_CAM_XPT_SIM_H
269
270#if __FreeBSD_version < 600000
271#define CAM_LOCK(arg)
272#define CAM_ULOCK(arg)
273
274static __inline void
275XPT_DONE(isc_session_t *sp, union ccb *ccb)
276{
277 mtx_lock(&Giant);
278 xpt_done(ccb);
279 mtx_unlock(&Giant);
280}
281#elif __FreeBSD_version >= 700000
282#define CAM_LOCK(arg) mtx_lock(&arg->cam_mtx)
283#define CAM_UNLOCK(arg) mtx_unlock(&arg->cam_mtx)
284
285static __inline void
286XPT_DONE(isc_session_t *sp, union ccb *ccb)
287{
288 CAM_LOCK(sp);
289 xpt_done(ccb);
290 CAM_UNLOCK(sp);
291}
292#else
293//__FreeBSD_version >= 600000
294#define CAM_LOCK(arg)
295#define CAM_UNLOCK(arg)
296#define XPT_DONE(ignore, arg) xpt_done(arg)
297#endif
298
--- 31 unchanged lines hidden (view full) ---
330
331static __inline void
332pdu_free(struct isc_softc *isc, pduq_t *pq)
333{
334 if(pq->mp)
335 m_freem(pq->mp);
336#ifdef NO_USE_MBUF
337 if(pq->buf != NULL)
338 free(pq->buf, M_ISCSIBUF);
339#endif
340 mtx_lock(&isc->pdu_mtx);
341 TAILQ_INSERT_TAIL(&isc->freepdu, pq, pq_link);
342#ifdef ISCSI_INITIATOR_DEBUG
343 isc->npdu_alloc--;
344#endif
345 mtx_unlock(&isc->pdu_mtx);
346}
--- 216 unchanged lines hidden (view full) ---
563 }
564 }
565 mtx_unlock(&sp->hld_mtx);
566
567 return pq;
568}
569
570static __inline void
571i_acked_hld(isc_session_t *sp, pdu_t *op)
572{
573 pduq_t *pq, *tmp;
574 u_int exp = sp->sn.expCmd;
575
576 pq = NULL;
577 mtx_lock(&sp->hld_mtx);
578 TAILQ_FOREACH_SAFE(pq, &sp->hld, pq_link, tmp) {
579 if((op && op->ipdu.bhs.itt == pq->pdu.ipdu.bhs.itt)
580 || (pq->ccb == NULL
581 && (pq->pdu.ipdu.bhs.opcode != ISCSI_WRITE_DATA)
582 && SNA_GT(exp, ntohl(pq->pdu.ipdu.bhs.ExpStSN)))) {
583 sp->stats.nhld--;
584 TAILQ_REMOVE(&sp->hld, pq, pq_link);
585 pdu_free(sp->isc, pq);
586 }
587 }
588 mtx_unlock(&sp->hld_mtx);
589}
590
591static __inline void
592i_mbufcopy(struct mbuf *mp, caddr_t dp, int len)
593{
594 struct mbuf *m;
595 caddr_t bp;
596
597 for(m = mp; m != NULL; m = m->m_next) {
598 bp = mtod(m, caddr_t);
599 /*
600 | the pdu is word (4 octed) aligned
601 | so len <= packet
602 */
603 memcpy(dp, bp, MIN(len, m->m_len));
604 dp += m->m_len;
605 len -= m->m_len;
606 if(len <= 0)
607 break;
608 }
609}