iscsi_globals.h revision 1.22 1 1.22 mlelstv /* $NetBSD: iscsi_globals.h,v 1.22 2017/02/05 12:05:46 mlelstv Exp $ */
2 1.1 agc
3 1.1 agc /*-
4 1.1 agc * Copyright (c) 2004,2005,2006,2011 The NetBSD Foundation, Inc.
5 1.1 agc * All rights reserved.
6 1.1 agc *
7 1.1 agc * This code is derived from software contributed to The NetBSD Foundation
8 1.1 agc * by Wasabi Systems, Inc.
9 1.1 agc *
10 1.1 agc * Redistribution and use in source and binary forms, with or without
11 1.1 agc * modification, are permitted provided that the following conditions
12 1.1 agc * are met:
13 1.1 agc * 1. Redistributions of source code must retain the above copyright
14 1.1 agc * notice, this list of conditions and the following disclaimer.
15 1.1 agc * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 agc * notice, this list of conditions and the following disclaimer in the
17 1.1 agc * documentation and/or other materials provided with the distribution.
18 1.1 agc *
19 1.1 agc * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1 agc * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1 agc * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1 agc * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1 agc * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1 agc * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1 agc * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1 agc * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1 agc * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1 agc * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1 agc * POSSIBILITY OF SUCH DAMAGE.
30 1.1 agc */
31 1.1 agc #ifndef _ISCSI_GLOBALS_H
32 1.1 agc #define _ISCSI_GLOBALS_H
33 1.1 agc
34 1.1 agc /*#include "opt_ddb.h" */
35 1.1 agc #define DDB 1
36 1.1 agc
37 1.1 agc /* Includes we need in all files */
38 1.1 agc
39 1.1 agc #include <sys/param.h>
40 1.1 agc #include <sys/proc.h>
41 1.1 agc #include <sys/conf.h>
42 1.1 agc #include <sys/errno.h>
43 1.1 agc #include <sys/malloc.h>
44 1.1 agc #include <sys/scsiio.h>
45 1.1 agc #include <sys/kernel.h>
46 1.1 agc #include <sys/kthread.h>
47 1.1 agc #include <sys/systm.h>
48 1.1 agc #include <sys/device.h>
49 1.1 agc
50 1.1 agc #include <dev/scsipi/scsi_all.h>
51 1.19 mlelstv #include <dev/scsipi/scsi_message.h>
52 1.1 agc #include <dev/scsipi/scsipi_all.h>
53 1.1 agc #include <dev/scsipi/scsiconf.h>
54 1.1 agc #include <dev/scsipi/scsipiconf.h>
55 1.1 agc
56 1.1 agc #include "iscsi.h"
57 1.1 agc #include "iscsi_pdu.h"
58 1.1 agc #include "iscsi_ioctl.h"
59 1.1 agc
60 1.1 agc /* ------------------------ Code selection constants ------------------------ */
61 1.1 agc
62 1.14 mlelstv #define ISCSI_DEBUG 0
63 1.1 agc
64 1.1 agc /* ------------------------- Global Constants ----------------------------- */
65 1.1 agc
66 1.1 agc /* Version information */
67 1.1 agc
68 1.1 agc #define INTERFACE_VERSION 2
69 1.1 agc #define VERSION_MAJOR 3
70 1.1 agc #define VERSION_MINOR 1
71 1.1 agc #define VERSION_STRING "NetBSD iSCSI Software Initiator 20110407"
72 1.1 agc
73 1.1 agc /*
74 1.1 agc NOTE: CCBS_PER_SESSION must not exceed 256 due to the way the ITT
75 1.1 agc is constructed (it has the CCB index in its lower 8 bits). If it should ever
76 1.1 agc be necessary to increase the number beyond that (which isn't expected),
77 1.1 agc the corresponding ITT generation and extraction code must be rewritten.
78 1.1 agc */
79 1.21 mlelstv #define CCBS_PER_SESSION 32 /* ToDo: Reasonable number?? */
80 1.21 mlelstv /*
81 1.21 mlelstv NOTE: CCBS_FOR_SCSPI limits the number of outstanding commands for
82 1.21 mlelstv SCSI commands, leaving some CCBs for keepalive and logout attempts,
83 1.21 mlelstv which are needed for each connection.
84 1.21 mlelstv */
85 1.21 mlelstv #define CCBS_FOR_SCSIPI 16 /* ToDo: Reasonable number?? */
86 1.1 agc /*
87 1.1 agc NOTE: PDUS_PER_CONNECTION is a number that could potentially impact
88 1.1 agc performance if set too low, as a single command may use up a lot of PDUs for
89 1.1 agc high values of First/MaxBurstLength and small values of
90 1.1 agc MaxRecvDataSegmentLength of the target.
91 1.1 agc */
92 1.21 mlelstv #define PDUS_PER_CONNECTION 64 /* ToDo: Reasonable number?? */
93 1.1 agc
94 1.1 agc /* max outstanding serial nums before we give up on the connection */
95 1.1 agc #define SERNUM_BUFFER_LENGTH (CCBS_PER_SESSION / 2) /* ToDo: Reasonable?? */
96 1.1 agc
97 1.1 agc /* The RecvDataSegmentLength for Target->Initiator */
98 1.1 agc #define DEFAULT_MaxRecvDataSegmentLength (64*1024)
99 1.1 agc
100 1.1 agc /* Command timeout (reset on received PDU associated with the command's CCB) */
101 1.21 mlelstv #define COMMAND_TIMEOUT (60 * hz) /* ToDo: Reasonable? (60 seconds) */
102 1.1 agc #define MAX_CCB_TIMEOUTS 3 /* Max number of tries to resend or SNACK */
103 1.1 agc #define MAX_CCB_TRIES 9 /* Max number of total tries to recover */
104 1.1 agc
105 1.1 agc /* Connectionn timeout (reset on every valid received PDU) */
106 1.1 agc #define CONNECTION_TIMEOUT (2 * hz) /* ToDo: Reasonable? (2 seconds) */
107 1.1 agc #define CONNECTION_IDLE_TIMEOUT (30 * hz) /* Adjusted to Time2Retain/2 later */
108 1.1 agc #define MAX_CONN_TIMEOUTS 4 /* Max number of tries to ping a target */
109 1.1 agc
110 1.1 agc /* Maximum attempts to recover connection */
111 1.1 agc #define MAX_RECOVERY_ATTEMPTS 2 /* If two attempts don't work, something */
112 1.1 agc /* probably is seriously broken */
113 1.1 agc
114 1.1 agc /* PDU flags */
115 1.1 agc
116 1.1 agc #define PDUF_BUSY 0x01 /* PDU is being sent, don't re-send */
117 1.1 agc #define PDUF_INQUEUE 0x02 /* PDU is in send queue */
118 1.1 agc #define PDUF_PRIORITY 0x04 /* Insert PDU at head of queue */
119 1.1 agc #define PDUF_NOUPDATE 0x10 /* Do not update PDU header/digest (test mode) */
120 1.1 agc
121 1.1 agc /* CCB Flags */
122 1.1 agc
123 1.6 mlelstv #define CCBF_COMPLETE 0x0001 /* received status */
124 1.6 mlelstv #define CCBF_RESENT 0x0002 /* ccb was resent */
125 1.6 mlelstv #define CCBF_SENDTARGET 0x0004 /* SendTargets text request, not negotiation */
126 1.6 mlelstv #define CCBF_GOT_RSP 0x0010 /* Got at least one response to this request */
127 1.6 mlelstv #define CCBF_REASSIGN 0x0020 /* Command can be reassigned */
128 1.6 mlelstv #define CCBF_OTHERCONN 0x0040 /* a logout for a different connection */
129 1.6 mlelstv #define CCBF_WAITQUEUE 0x0080 /* CCB is on waiting queue */
130 1.1 agc
131 1.1 agc /* --------------------------- Global Types ------------------------------- */
132 1.1 agc
133 1.1 agc /* Connection state */
134 1.1 agc
135 1.1 agc typedef enum {
136 1.1 agc /* first three correspond to CSG/NSG coding */
137 1.1 agc ST_SEC_NEG = 0, /* security negotiation phase */
138 1.1 agc ST_OP_NEG = 1, /* operational negotiation phase */
139 1.1 agc ST_FULL_FEATURE = 3, /* full feature phase */
140 1.1 agc /* rest is internal */
141 1.1 agc ST_WINDING_DOWN = 4, /* connection termination initiated, logging out */
142 1.1 agc ST_LOGOUT_SENT = 5, /* logout has been sent */
143 1.1 agc ST_SETTLING = 6, /* waiting for things to settle down */
144 1.1 agc ST_IDLE = 7 /* connection is idle (ready to delete) */
145 1.1 agc } conn_state_t;
146 1.1 agc
147 1.1 agc
148 1.1 agc /* Logout state */
149 1.1 agc
150 1.1 agc typedef enum {
151 1.1 agc NOT_LOGGED_OUT, /* Not logged out */
152 1.1 agc LOGOUT_SENT, /* Logout was sent */
153 1.1 agc LOGOUT_SUCCESS, /* Logout succeeded */
154 1.1 agc LOGOUT_FAILED /* Logout failed */
155 1.1 agc } logout_state_t;
156 1.1 agc
157 1.1 agc
158 1.1 agc /* CCB Disposition */
159 1.1 agc
160 1.1 agc typedef enum {
161 1.1 agc CCBDISP_UNUSED, /* 0 = In free pool */
162 1.1 agc CCBDISP_BUSY, /* This CCB is busy, don't allow rx ops */
163 1.1 agc CCBDISP_NOWAIT, /* Not waiting for anything */
164 1.1 agc CCBDISP_FREE, /* Free this CCB when done */
165 1.1 agc CCBDISP_WAIT, /* Calling thread is waiting for completion */
166 1.1 agc CCBDISP_SCSIPI, /* Call scsipi_done when operation completes */
167 1.1 agc CCBDISP_DEFER /* Defer waiting until all PDUs have been queued */
168 1.1 agc } ccb_disp_t;
169 1.1 agc
170 1.1 agc
171 1.1 agc /* PDU Disposition */
172 1.1 agc
173 1.1 agc typedef enum {
174 1.1 agc PDUDISP_UNUSED, /* 0 = In free pool */
175 1.1 agc PDUDISP_FREE, /* Free this PDU when done */
176 1.1 agc PDUDISP_WAIT /* Waiting for acknowledge */
177 1.1 agc } pdu_disp_t;
178 1.1 agc
179 1.17 mlelstv /* Timeout state */
180 1.17 mlelstv
181 1.17 mlelstv typedef enum {
182 1.17 mlelstv TOUT_NONE, /* Initial */
183 1.17 mlelstv TOUT_ARMED, /* callout is scheduled */
184 1.17 mlelstv TOUT_QUEUED, /* put into timeout queue */
185 1.17 mlelstv TOUT_BUSY /* cleanup thread working */
186 1.17 mlelstv } tout_state_t;
187 1.1 agc
188 1.1 agc typedef struct connection_s connection_t;
189 1.1 agc typedef struct session_s session_t;
190 1.1 agc typedef struct ccb_s ccb_t;
191 1.1 agc typedef struct pdu_s pdu_t;
192 1.1 agc
193 1.1 agc /* the serial number management structure (a circular buffer) */
194 1.1 agc
195 1.1 agc typedef struct {
196 1.1 agc uint32_t ExpSN; /* ExpxxSN (Data or Stat) sent to the target */
197 1.1 agc uint32_t next_sn; /* next_sn (== ExpSN if no ack is pending) */
198 1.1 agc int top; /* top of buffer (newest element) */
199 1.1 agc int bottom; /* bottom of buffer (oldest element) */
200 1.1 agc uint32_t sernum[SERNUM_BUFFER_LENGTH]; /* the serial numbers */
201 1.12 joerg bool ack[SERNUM_BUFFER_LENGTH]; /* acknowledged? */
202 1.1 agc } sernum_buffer_t;
203 1.1 agc
204 1.1 agc
205 1.1 agc /*
206 1.1 agc The per-PDU data structure.
207 1.1 agc */
208 1.1 agc
209 1.1 agc struct pdu_s {
210 1.1 agc TAILQ_ENTRY(pdu_s) chain; /* freelist or wait list (or no list) */
211 1.1 agc TAILQ_ENTRY(pdu_s) send_chain;
212 1.1 agc /* chaining PDUs waiting to be sent */
213 1.1 agc pdu_disp_t disp; /* what to do with this pdu */
214 1.1 agc uint32_t flags; /* various processing flags */
215 1.1 agc pdu_header_t pdu; /* Buffer for PDU associated with cmd */
216 1.1 agc void *temp_data; /* (free after use) */
217 1.1 agc uint32_t temp_data_len; /* size of temp data */
218 1.1 agc
219 1.1 agc struct uio uio; /* UIO structure */
220 1.1 agc struct iovec io_vec[4];
221 1.1 agc /* Header + data + data-digest + padding */
222 1.1 agc
223 1.1 agc struct uio save_uio;
224 1.1 agc /* UIO structure save for retransmits */
225 1.1 agc struct iovec save_iovec[4];
226 1.1 agc /* Header + data + data-digest + padding */
227 1.1 agc uint32_t data_digest;
228 1.1 agc /* holds data digest if enabled */
229 1.1 agc ccb_t *owner;
230 1.1 agc /* the ccb this PDU belongs to (if any) */
231 1.1 agc connection_t *connection;
232 1.1 agc /* the connection this PDU belongs to */
233 1.1 agc };
234 1.1 agc
235 1.1 agc
236 1.1 agc /* the PDU list type */
237 1.1 agc
238 1.1 agc TAILQ_HEAD(pdu_list_s, pdu_s);
239 1.1 agc typedef struct pdu_list_s pdu_list_t;
240 1.1 agc
241 1.1 agc /*
242 1.1 agc The per-command data structure. Calling it ccb in correspondence
243 1.1 agc to other HA drivers.
244 1.1 agc */
245 1.1 agc
246 1.1 agc struct ccb_s {
247 1.1 agc TAILQ_ENTRY(ccb_s) chain;
248 1.1 agc /* either freelist or waiting list (or no list) */
249 1.1 agc
250 1.1 agc uint32_t status; /* Status gets entered here */
251 1.1 agc ccb_disp_t disp; /* what to do with this ccb */
252 1.1 agc
253 1.1 agc struct callout timeout; /* To make sure it isn't lost */
254 1.14 mlelstv TAILQ_ENTRY(ccb_s) tchain;
255 1.17 mlelstv tout_state_t timedout;
256 1.1 agc int num_timeouts;
257 1.1 agc /* How often we've sent out SNACK without answer */
258 1.1 agc int total_tries;
259 1.1 agc /* How often we've tried to recover */
260 1.1 agc
261 1.1 agc uint32_t ITT;
262 1.1 agc /* task tag: ITT counter + sess id + CCB index */
263 1.1 agc sernum_buffer_t DataSN_buf;
264 1.1 agc /* Received Data Seq nums (read ops only) */
265 1.1 agc
266 1.1 agc void *par;
267 1.1 agc /* misc. parameter for this request */
268 1.1 agc struct scsipi_xfer *xs;
269 1.1 agc /* the scsipi_xfer for this cmd */
270 1.1 agc
271 1.1 agc void *temp_data;
272 1.1 agc /* to hold state (mainly during negotiation) */
273 1.1 agc void *text_data;
274 1.1 agc /* holds accumulated text for continued PDUs */
275 1.1 agc uint32_t text_len;
276 1.1 agc /* length of text data so far */
277 1.1 agc
278 1.1 agc uint64_t lun; /* LUN */
279 1.19 mlelstv uint32_t tag; /* Command tag */
280 1.1 agc uint8_t *cmd; /* SCSI command block */
281 1.1 agc uint16_t cmdlen; /* SCSI command block length */
282 1.1 agc bool data_in; /* if this is a read request */
283 1.1 agc uint8_t *data_ptr; /* data pointer for read/write */
284 1.1 agc uint32_t data_len; /* total data length */
285 1.1 agc uint32_t xfer_len; /* data transferred on read */
286 1.1 agc uint32_t residual; /* residual data size */
287 1.1 agc
288 1.1 agc void *sense_ptr; /* sense data pointer */
289 1.1 agc int sense_len_req; /* requested sense data length */
290 1.1 agc int sense_len_got; /* actual sense data length */
291 1.1 agc
292 1.1 agc pdu_t *pdu_waiting; /* PDU waiting to be ack'ed */
293 1.15 mlelstv volatile uint32_t CmdSN; /* CmdSN associated with waiting PDU */
294 1.1 agc
295 1.1 agc int flags;
296 1.1 agc connection_t *connection; /* connection for CCB */
297 1.1 agc session_t *session; /* session for CCB */
298 1.1 agc };
299 1.1 agc
300 1.1 agc
301 1.1 agc /* the CCB list type */
302 1.1 agc
303 1.1 agc TAILQ_HEAD(ccb_list_s, ccb_s);
304 1.1 agc typedef struct ccb_list_s ccb_list_t;
305 1.1 agc
306 1.1 agc
307 1.1 agc /*
308 1.1 agc Per connection data: the connection structure
309 1.1 agc */
310 1.1 agc struct connection_s {
311 1.1 agc TAILQ_ENTRY(connection_s) connections;
312 1.1 agc
313 1.14 mlelstv kmutex_t lock;
314 1.14 mlelstv kcondvar_t conn_cv;
315 1.21 mlelstv kcondvar_t pdu_cv;
316 1.14 mlelstv kcondvar_t ccb_cv;
317 1.14 mlelstv kcondvar_t idle_cv;
318 1.14 mlelstv
319 1.1 agc pdu_list_t pdu_pool; /* the free PDU pool */
320 1.1 agc
321 1.1 agc ccb_list_t ccbs_waiting;
322 1.1 agc /* CCBs waiting for completion */
323 1.1 agc
324 1.1 agc pdu_list_t pdus_to_send;
325 1.1 agc /* the PDUs waiting to be sent */
326 1.1 agc
327 1.1 agc sernum_buffer_t StatSN_buf;
328 1.1 agc /* to keep track of received StatSNs */
329 1.1 agc
330 1.1 agc uint32_t max_transfer;
331 1.1 agc /* min(MaxRecvDataSegmentLength, MaxBurstLength) */
332 1.1 agc uint32_t max_firstimmed;
333 1.1 agc /* 0 if InitialR2T=Yes, else
334 1.1 agc min of (MaxRecvDataSegmentLength, FirstBurstLength) */
335 1.1 agc uint32_t max_firstdata;
336 1.1 agc /* 0 if ImmediateData=No, else min of */
337 1.1 agc /* (MaxRecvDataSegmentLength, FirstBurstLength) */
338 1.1 agc
339 1.1 agc uint32_t MaxRecvDataSegmentLength;
340 1.1 agc /* Target's value */
341 1.1 agc uint32_t Our_MaxRecvDataSegmentLength;
342 1.1 agc /* Our own value */
343 1.1 agc bool HeaderDigest; /* TRUE if doing CRC */
344 1.1 agc bool DataDigest; /* TRUE if doing CRC */
345 1.1 agc uint32_t Time2Wait;
346 1.1 agc /* Negotiated default or logout value */
347 1.1 agc uint32_t Time2Retain;
348 1.1 agc /* Negotiated default or logout value */
349 1.1 agc
350 1.1 agc uint16_t id;
351 1.1 agc /* connection ID (unique within session) */
352 1.1 agc
353 1.1 agc conn_state_t state; /* State of connection */
354 1.1 agc
355 1.8 joerg struct lwp *threadobj;
356 1.1 agc /* proc/thread pointer of socket owner */
357 1.1 agc struct file *sock; /* the connection's socket */
358 1.1 agc session_t *session;
359 1.1 agc /* back pointer to the owning session */
360 1.1 agc
361 1.1 agc struct lwp *rcvproc; /* receive thread */
362 1.1 agc struct lwp *sendproc; /* send thread */
363 1.1 agc
364 1.1 agc uint32_t terminating;
365 1.1 agc /* if closing down: status */
366 1.1 agc int recover; /* recovery count */
367 1.1 agc /* (reset on first successful data transfer) */
368 1.15 mlelstv volatile unsigned usecount; /* number of active CCBs */
369 1.21 mlelstv volatile unsigned pducount; /* number of active PDUs */
370 1.1 agc
371 1.1 agc bool destroy; /* conn will be destroyed */
372 1.1 agc bool in_session;
373 1.1 agc /* if it's linked into the session list */
374 1.1 agc logout_state_t loggedout;
375 1.1 agc /* status of logout (for recovery) */
376 1.1 agc struct callout timeout;
377 1.1 agc /* Timeout for checking if connection is dead */
378 1.14 mlelstv TAILQ_ENTRY(connection_s) tchain;
379 1.17 mlelstv tout_state_t timedout;
380 1.1 agc int num_timeouts;
381 1.1 agc /* How often we've sent out a NOP without answer */
382 1.1 agc uint32_t idle_timeout_val;
383 1.1 agc /* Connection timeout value when idle */
384 1.1 agc
385 1.1 agc iscsi_login_parameters_t *login_par;
386 1.1 agc /* only valid during login */
387 1.1 agc
388 1.1 agc pdu_t pdu[PDUS_PER_CONNECTION]; /* PDUs */
389 1.1 agc };
390 1.1 agc
391 1.1 agc /* the connection list type */
392 1.1 agc
393 1.1 agc TAILQ_HEAD(connection_list_s, connection_s);
394 1.1 agc typedef struct connection_list_s connection_list_t;
395 1.1 agc
396 1.1 agc
397 1.1 agc /*
398 1.1 agc Per session data: the session structure
399 1.1 agc */
400 1.1 agc
401 1.1 agc struct session_s {
402 1.1 agc /* Interface to child drivers.
403 1.1 agc NOTE: sc_adapter MUST be the first field in this structure so we can
404 1.1 agc easily get from adapter to session.
405 1.1 agc */
406 1.1 agc struct scsipi_adapter sc_adapter;
407 1.1 agc struct scsipi_channel sc_channel;
408 1.1 agc
409 1.1 agc device_t child_dev;
410 1.1 agc /* the child we're associated with - (NULL if not mapped) */
411 1.1 agc
412 1.21 mlelstv int refcount; /* session in use by scsipi */
413 1.21 mlelstv
414 1.1 agc /* local stuff */
415 1.1 agc TAILQ_ENTRY(session_s) sessions; /* the list of sessions */
416 1.1 agc
417 1.14 mlelstv kmutex_t lock;
418 1.14 mlelstv kcondvar_t sess_cv;
419 1.14 mlelstv kcondvar_t ccb_cv;
420 1.14 mlelstv
421 1.1 agc ccb_list_t ccb_pool; /* The free CCB pool */
422 1.21 mlelstv
423 1.21 mlelstv int send_window;
424 1.1 agc
425 1.1 agc uint16_t id; /* session ID (unique within driver) */
426 1.1 agc uint16_t TSIH; /* Target assigned session ID */
427 1.1 agc
428 1.1 agc uint32_t CmdSN; /* Current CmdSN */
429 1.1 agc uint32_t ExpCmdSN; /* Current max ExpCmdSN received */
430 1.1 agc uint32_t MaxCmdSN; /* Current MaxCmdSN */
431 1.1 agc
432 1.1 agc /* negotiated values */
433 1.1 agc uint32_t ErrorRecoveryLevel;
434 1.1 agc uint32_t FirstBurstLength;
435 1.1 agc uint32_t MaxBurstLength;
436 1.1 agc bool ImmediateData;
437 1.1 agc bool InitialR2T;
438 1.1 agc uint32_t MaxOutstandingR2T;
439 1.1 agc uint32_t MaxConnections;
440 1.1 agc uint32_t DefaultTime2Wait;
441 1.1 agc uint32_t DefaultTime2Retain;
442 1.1 agc
443 1.1 agc iscsi_login_session_type_t login_type; /* session type */
444 1.1 agc
445 1.1 agc /* for send_targets requests */
446 1.1 agc uint8_t *target_list;
447 1.1 agc uint32_t target_list_len;
448 1.1 agc
449 1.1 agc uint32_t conn_id; /* connection ID counter */
450 1.1 agc
451 1.1 agc uint32_t terminating; /* if closing down: status */
452 1.1 agc
453 1.1 agc uint32_t active_connections;
454 1.1 agc /* currently active connections */
455 1.1 agc uint32_t total_connections;
456 1.1 agc /* connections associated with this session (active or winding down) */
457 1.1 agc connection_list_t conn_list; /* the list of connections */
458 1.1 agc connection_t *mru_connection;
459 1.1 agc /* the most recently used connection */
460 1.1 agc
461 1.1 agc ccb_t ccb[CCBS_PER_SESSION]; /* CCBs */
462 1.1 agc
463 1.1 agc char tgtname[ISCSI_STRING_LENGTH + 1];
464 1.1 agc /* iSCSI target name */
465 1.1 agc };
466 1.1 agc
467 1.1 agc /* the session list type */
468 1.1 agc
469 1.1 agc TAILQ_HEAD(session_list_s, session_s);
470 1.1 agc typedef struct session_list_s session_list_t;
471 1.1 agc
472 1.1 agc
473 1.1 agc /*
474 1.1 agc Event notification structures
475 1.1 agc */
476 1.1 agc
477 1.1 agc typedef struct event_s {
478 1.1 agc TAILQ_ENTRY(event_s) link; /* next event in queue */
479 1.1 agc iscsi_event_t event_kind; /* which event */
480 1.1 agc uint32_t session_id; /* affected session ID */
481 1.1 agc uint32_t connection_id; /* affected connection ID */
482 1.1 agc uint32_t reason; /* event reason */
483 1.1 agc } event_t;
484 1.1 agc
485 1.1 agc /* the event list entry type */
486 1.1 agc
487 1.1 agc TAILQ_HEAD(event_list_s, event_s);
488 1.1 agc typedef struct event_list_s event_list_t;
489 1.1 agc
490 1.1 agc
491 1.1 agc typedef struct event_handler_s {
492 1.1 agc TAILQ_ENTRY(event_handler_s) link; /* next handler */
493 1.1 agc uint32_t id; /* unique ID */
494 1.1 agc event_list_t events; /* list of events pending */
495 1.1 agc iscsi_wait_event_parameters_t *waiter; /* waiting parameter */
496 1.1 agc /* following to detect dead handlers */
497 1.1 agc event_t *first_in_list;
498 1.1 agc } event_handler_t;
499 1.1 agc
500 1.1 agc /* the event list entry type */
501 1.1 agc
502 1.1 agc TAILQ_HEAD(event_handler_list_s, event_handler_s);
503 1.1 agc typedef struct event_handler_list_s event_handler_list_t;
504 1.1 agc
505 1.13 joerg /* /dev/iscsi0 state */
506 1.13 joerg struct iscsifd {
507 1.14 mlelstv TAILQ_ENTRY(iscsifd) link;
508 1.14 mlelstv device_t dev;
509 1.14 mlelstv int unit;
510 1.13 joerg };
511 1.1 agc
512 1.1 agc /* ------------------------- Global Variables ----------------------------- */
513 1.1 agc
514 1.1 agc /* In iscsi_main.c */
515 1.1 agc
516 1.5 mlelstv extern struct cfattach iscsi_ca; /* the device attach structure */
517 1.1 agc
518 1.5 mlelstv extern session_list_t iscsi_sessions; /* the list of sessions */
519 1.5 mlelstv extern bool iscsi_detaching; /* signal to cleanup thread it should exit */
520 1.5 mlelstv extern uint32_t iscsi_num_send_threads; /* the number of active send threads */
521 1.1 agc
522 1.5 mlelstv extern uint8_t iscsi_InitiatorName[ISCSI_STRING_LENGTH];
523 1.5 mlelstv extern uint8_t iscsi_InitiatorAlias[ISCSI_STRING_LENGTH];
524 1.5 mlelstv extern login_isid_t iscsi_InitiatorISID;
525 1.1 agc
526 1.10 joerg /* Debugging stuff */
527 1.1 agc
528 1.1 agc #ifndef DDB
529 1.1 agc #define Debugger() panic("should call debugger here (iscsi.c)")
530 1.1 agc #endif /* ! DDB */
531 1.1 agc
532 1.1 agc #ifdef ISCSI_DEBUG
533 1.1 agc
534 1.5 mlelstv extern int iscsi_debug_level; /* How much debug info to display */
535 1.1 agc
536 1.1 agc #define DEBOUT(x) printf x
537 1.3 mlelstv #define DEB(lev,x) { if (iscsi_debug_level >= lev) printf x ;}
538 1.3 mlelstv #define DEBC(conn,lev,x) { if (iscsi_debug_level >= lev) { printf("S%dC%d: ", \
539 1.3 mlelstv conn ? conn->session->id : -1, \
540 1.3 mlelstv conn ? conn->id : -1); printf x ;}}
541 1.1 agc
542 1.1 agc #define STATIC static
543 1.1 agc
544 1.1 agc #else
545 1.1 agc
546 1.1 agc #define DEBOUT(x)
547 1.1 agc #define DEB(lev,x)
548 1.1 agc #define DEBC(conn,lev,x)
549 1.1 agc
550 1.1 agc #define STATIC static
551 1.1 agc
552 1.1 agc #endif
553 1.1 agc
554 1.1 agc /* Critical section macros */
555 1.1 agc
556 1.1 agc /* misc stuff */
557 1.1 agc #define min(a, b) ((a) < (b)) ? (a) : (b)
558 1.1 agc #define max(a, b) ((a) < (b)) ? (b) : (a)
559 1.1 agc
560 1.1 agc
561 1.1 agc /*
562 1.1 agc Convert unsigned int to 3-byte value (for DataSegmentLength field in PDU)
563 1.1 agc */
564 1.1 agc
565 1.1 agc static __inline void
566 1.1 agc hton3(uint32_t val, uint8_t *bytes)
567 1.1 agc {
568 1.1 agc bytes[0] = (uint8_t) (val >> 16);
569 1.1 agc bytes[1] = (uint8_t) (val >> 8);
570 1.1 agc bytes[2] = (uint8_t) val;
571 1.1 agc }
572 1.1 agc
573 1.1 agc /*
574 1.1 agc Convert 3-byte value to unsigned int (for DataSegmentLength field in PDU)
575 1.1 agc */
576 1.1 agc
577 1.1 agc static __inline uint32_t
578 1.1 agc ntoh3(uint8_t *bytes)
579 1.1 agc {
580 1.1 agc return (bytes[0] << 16) | (bytes[1] << 8) | bytes[2];
581 1.1 agc }
582 1.1 agc
583 1.1 agc
584 1.1 agc /*
585 1.1 agc * Convert uint64 to network byte order (for LUN field in PDU)
586 1.1 agc */
587 1.1 agc static __inline uint64_t
588 1.1 agc htonq(uint64_t x)
589 1.1 agc {
590 1.1 agc #if BYTE_ORDER == LITTLE_ENDIAN
591 1.1 agc uint8_t *s = (uint8_t *) & x;
592 1.1 agc return (uint64_t) ((uint64_t) s[0] << 56 | (uint64_t) s[1] << 48 |
593 1.1 agc (uint64_t) s[2] << 40 | (uint64_t) s[3] << 32 |
594 1.1 agc (uint64_t) s[4] << 24 | (uint64_t) s[5] << 16 |
595 1.1 agc (uint64_t) s[6] << 8 | (uint64_t) s[7]);
596 1.1 agc #else
597 1.1 agc return x;
598 1.1 agc #endif
599 1.1 agc }
600 1.1 agc
601 1.1 agc #define ntohq(x) htonq(x)
602 1.1 agc
603 1.1 agc /*
604 1.1 agc * Serial number buffer empty?
605 1.1 agc */
606 1.1 agc
607 1.1 agc static __inline bool
608 1.1 agc sn_empty(sernum_buffer_t *buf)
609 1.1 agc {
610 1.1 agc return buf->top == buf->bottom;
611 1.1 agc }
612 1.1 agc
613 1.1 agc
614 1.1 agc /*
615 1.1 agc * Serial number compare
616 1.1 agc */
617 1.1 agc
618 1.1 agc static __inline bool
619 1.1 agc sn_a_lt_b(uint32_t a, uint32_t b)
620 1.1 agc {
621 1.1 agc return (a < b && !((b - a) & 0x80000000)) ||
622 1.1 agc (a > b && ((a - b) & 0x80000000));
623 1.1 agc }
624 1.1 agc
625 1.1 agc static __inline bool
626 1.1 agc sn_a_le_b(uint32_t a, uint32_t b)
627 1.1 agc {
628 1.1 agc return (a <= b && !((b - a) & 0x80000000)) ||
629 1.1 agc (a >= b && ((a - b) & 0x80000000));
630 1.1 agc }
631 1.1 agc
632 1.1 agc /* in iscsi_ioctl.c */
633 1.1 agc
634 1.14 mlelstv void iscsi_init_cleanup(void);
635 1.21 mlelstv int iscsi_destroy_cleanup(void);
636 1.14 mlelstv void iscsi_notify_cleanup(void);
637 1.14 mlelstv
638 1.14 mlelstv
639 1.1 agc /* Parameter for logout is reason code in logout PDU, -1 for don't send logout */
640 1.1 agc #define NO_LOGOUT -1
641 1.1 agc #define LOGOUT_SESSION 0
642 1.1 agc #define LOGOUT_CONNECTION 1
643 1.1 agc #define RECOVER_CONNECTION 2
644 1.1 agc
645 1.1 agc void add_event(iscsi_event_t, uint32_t, uint32_t, uint32_t);
646 1.1 agc
647 1.1 agc void kill_connection(connection_t *, uint32_t, int, bool);
648 1.1 agc void kill_session(session_t *, uint32_t, int, bool);
649 1.21 mlelstv int kill_all_sessions(void);
650 1.1 agc void handle_connection_error(connection_t *, uint32_t, int);
651 1.14 mlelstv void add_connection_cleanup(connection_t *);
652 1.1 agc
653 1.1 agc #ifndef ISCSI_MINIMAL
654 1.1 agc uint32_t map_databuf(struct proc *, void **, uint32_t);
655 1.1 agc void unmap_databuf(struct proc *, void *, uint32_t);
656 1.1 agc #endif
657 1.13 joerg int iscsiioctl(struct file *, u_long, void *);
658 1.1 agc
659 1.1 agc session_t *find_session(uint32_t);
660 1.1 agc connection_t *find_connection(session_t *, uint32_t);
661 1.21 mlelstv int ref_session(session_t *);
662 1.21 mlelstv void unref_session(session_t *);
663 1.1 agc
664 1.1 agc /* in iscsi_main.c */
665 1.1 agc
666 1.1 agc /*void iscsiattach(void *); */
667 1.1 agc int iscsidetach(device_t, int);
668 1.1 agc
669 1.1 agc void iscsi_done(ccb_t *);
670 1.14 mlelstv int map_session(session_t *, device_t);
671 1.6 mlelstv int unmap_session(session_t *);
672 1.1 agc
673 1.1 agc /* in iscsi_send.c */
674 1.1 agc
675 1.1 agc void iscsi_send_thread(void *);
676 1.1 agc
677 1.1 agc connection_t *assign_connection(session_t *session, bool waitok);
678 1.1 agc void resend_pdu(ccb_t *);
679 1.1 agc int send_login(connection_t *);
680 1.1 agc int send_logout(connection_t *, connection_t *, int, bool);
681 1.1 agc int send_data_out(connection_t *, pdu_t *, ccb_t *, ccb_disp_t, bool);
682 1.1 agc void send_run_xfer(session_t *, struct scsipi_xfer *);
683 1.1 agc int send_send_targets(session_t *, uint8_t *);
684 1.1 agc int send_task_management(connection_t *, ccb_t *, struct scsipi_xfer *, int);
685 1.1 agc
686 1.1 agc void negotiate_login(connection_t *, pdu_t *, ccb_t *);
687 1.1 agc void acknowledge_text(connection_t *, pdu_t *, ccb_t *);
688 1.1 agc void start_text_negotiation(connection_t *);
689 1.1 agc void negotiate_text(connection_t *, pdu_t *, ccb_t *);
690 1.1 agc int send_nop_out(connection_t *, pdu_t *);
691 1.1 agc void snack_missing(connection_t *, ccb_t *, uint8_t, uint32_t, uint32_t);
692 1.1 agc void send_snack(connection_t *, pdu_t *, ccb_t *, uint8_t);
693 1.1 agc int send_send_targets(session_t *, uint8_t *);
694 1.1 agc
695 1.1 agc void send_command(ccb_t *, ccb_disp_t, bool, bool);
696 1.1 agc #ifndef ISCSI_MINIMAL
697 1.1 agc int send_io_command(session_t *, uint64_t, scsireq_t *, bool, uint32_t);
698 1.1 agc #endif
699 1.1 agc
700 1.14 mlelstv void connection_timeout_co(void *);
701 1.14 mlelstv void ccb_timeout_co(void *);
702 1.14 mlelstv
703 1.14 mlelstv void connection_timeout(connection_t *);
704 1.16 mlelstv void connection_timeout_start(connection_t *, int);
705 1.16 mlelstv void connection_timeout_stop(connection_t *);
706 1.14 mlelstv void ccb_timeout(ccb_t *);
707 1.16 mlelstv void ccb_timeout_start(ccb_t *, int);
708 1.16 mlelstv void ccb_timeout_stop(ccb_t *);
709 1.1 agc
710 1.1 agc /* in iscsi_rcv.c */
711 1.1 agc
712 1.1 agc void iscsi_rcv_thread(void *);
713 1.1 agc
714 1.1 agc /* in iscsi_utils.c */
715 1.1 agc
716 1.1 agc uint32_t gen_digest(void *, int);
717 1.1 agc uint32_t gen_digest_2(void *, int, void *, int);
718 1.1 agc
719 1.1 agc void create_ccbs(session_t *);
720 1.22 mlelstv void destroy_ccbs(session_t *);
721 1.1 agc ccb_t *get_ccb(connection_t *, bool);
722 1.1 agc void free_ccb(ccb_t *);
723 1.6 mlelstv void suspend_ccb(ccb_t *, bool);
724 1.6 mlelstv void wake_ccb(ccb_t *, uint32_t);
725 1.1 agc
726 1.1 agc void create_pdus(connection_t *);
727 1.6 mlelstv pdu_t *get_pdu(connection_t *, bool);
728 1.1 agc void free_pdu(pdu_t *);
729 1.1 agc
730 1.1 agc void init_sernum(sernum_buffer_t *);
731 1.1 agc int add_sernum(sernum_buffer_t *, uint32_t);
732 1.1 agc uint32_t ack_sernum(sernum_buffer_t *, uint32_t);
733 1.1 agc
734 1.21 mlelstv uint32_t get_sernum(session_t *, pdu_t *);
735 1.15 mlelstv int sernum_in_window(session_t *);
736 1.21 mlelstv int window_size(session_t *, int);
737 1.15 mlelstv
738 1.1 agc /* in iscsi_text.c */
739 1.1 agc
740 1.1 agc int assemble_login_parameters(connection_t *, ccb_t *, pdu_t *);
741 1.1 agc int assemble_security_parameters(connection_t *, ccb_t *, pdu_t *, pdu_t *);
742 1.1 agc int assemble_negotiation_parameters(connection_t *, ccb_t *, pdu_t *, pdu_t *);
743 1.1 agc int init_text_parameters(connection_t *, ccb_t *);
744 1.1 agc int assemble_send_targets(pdu_t *, uint8_t *);
745 1.1 agc void set_negotiated_parameters(ccb_t *);
746 1.1 agc
747 1.1 agc #endif /* !_ISCSI_GLOBALS_H */
748