2 * iSCSI lib definitions
4 * Copyright (C) 2006 Red Hat, Inc. All rights reserved.
5 * Copyright (C) 2004 - 2006 Mike Christie
6 * Copyright (C) 2004 - 2005 Dmitry Yusupov
7 * Copyright (C) 2004 - 2005 Alex Aizman
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <linux/types.h>
27 #include <linux/wait.h>
28 #include <linux/mutex.h>
29 #include <linux/timer.h>
30 #include <linux/workqueue.h>
31 #include <scsi/iscsi_proto.h>
32 #include <scsi/iscsi_if.h>
34 struct scsi_transport_template
;
35 struct scsi_host_template
;
40 struct iscsi_transport
;
41 struct iscsi_cls_session
;
42 struct iscsi_cls_conn
;
47 /* #define DEBUG_SCSI */
49 #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
51 #define debug_scsi(fmt...)
54 #define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
55 #define ISCSI_MGMT_CMDS_MAX 16 /* must be power of 2 */
57 #define ISCSI_MGMT_ITT_OFFSET 0xa00
59 #define ISCSI_DEF_CMD_PER_LUN 32
60 #define ISCSI_MAX_CMD_PER_LUN 128
62 /* Task Mgmt states */
72 /* Connection suspend "bit" */
73 #define ISCSI_SUSPEND_BIT 1
75 #define ISCSI_ITT_MASK (0xfff)
76 #define ISCSI_AGE_SHIFT 28
77 #define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
79 #define ISCSI_ADDRESS_BUF_LEN 64
82 /* this is the maximum possible storage for AHSs */
83 ISCSI_MAX_AHS_SIZE
= sizeof(struct iscsi_ecdb_ahdr
) +
84 sizeof(struct iscsi_rlength_ahdr
),
85 ISCSI_DIGEST_SIZE
= sizeof(__u32
),
97 * Because LLDs allocate their hdr differently, this is a pointer
98 * and length to that storage. It must be setup at session
101 struct iscsi_cmd
*hdr
;
102 unsigned short hdr_max
;
103 unsigned short hdr_len
; /* accumulated size of hdr used */
104 int itt
; /* this ITT */
106 uint32_t unsol_datasn
;
107 unsigned imm_count
; /* imm-data (bytes) */
108 unsigned unsol_count
; /* unsolicited (bytes)*/
109 /* offset in unsolicited stream (bytes); */
110 unsigned unsol_offset
;
111 unsigned data_count
; /* remaining Data-Out */
112 char *data
; /* mgmt payload */
113 struct scsi_cmnd
*sc
; /* associated SCSI cmd*/
114 struct iscsi_conn
*conn
; /* used connection */
116 /* state set/tested under session->lock */
119 struct list_head running
; /* running cmd list */
120 void *dd_data
; /* driver/transport data */
123 static inline void* iscsi_next_hdr(struct iscsi_task
*task
)
125 return (void*)task
->hdr
+ task
->hdr_len
;
128 /* Connection's states */
130 ISCSI_CONN_INITIAL_STAGE
,
133 ISCSI_CONN_CLEANUP_WAIT
,
137 struct iscsi_cls_conn
*cls_conn
; /* ptr to class connection */
138 void *dd_data
; /* iscsi_transport data */
139 struct iscsi_session
*session
; /* parent session */
141 * LLDs should set this lock. It protects the transport recv
146 * conn_stop() flag: stop to recover, stop to terminate
149 struct timer_list transport_timer
;
150 unsigned long last_recv
;
151 unsigned long last_ping
;
154 struct iscsi_task
*ping_task
;
156 /* iSCSI connection-wide sequencing */
161 int c_stage
; /* connection state */
163 * Preallocated buffer for pdus that have data but do not
164 * originate from scsi-ml. We never have two pdus using the
165 * buffer at the same time. It is only allocated to
166 * the default max recv size because the pdus we support
167 * should always fit in this buffer
170 struct iscsi_task
*login_task
; /* mtask used for login/text */
171 struct iscsi_task
*task
; /* xmit task in progress */
174 struct list_head mgmtqueue
; /* mgmt (control) xmit queue */
175 struct list_head mgmt_run_list
; /* list of control tasks */
176 struct list_head xmitqueue
; /* data-path cmd queue */
177 struct list_head run_list
; /* list of cmds in progress */
178 struct list_head requeue
; /* tasks needing another run */
179 struct work_struct xmitwork
; /* per-conn. xmit workqueue */
180 unsigned long suspend_tx
; /* suspend Tx */
181 unsigned long suspend_rx
; /* suspend Rx */
184 wait_queue_head_t ehwait
; /* used in eh_abort() */
185 struct iscsi_tm tmhdr
;
186 struct timer_list tmf_timer
;
187 int tmf_state
; /* see TMF_INITIAL, etc.*/
189 /* negotiated params */
190 unsigned max_recv_dlength
; /* initiator_max_recv_dsl*/
191 unsigned max_xmit_dlength
; /* target_max_recv_dsl */
196 /* values userspace uses to id a conn */
198 char *persistent_address
;
199 /* remote portal currently connected to */
201 char portal_address
[ISCSI_ADDRESS_BUF_LEN
];
204 uint64_t txdata_octets
;
205 uint64_t rxdata_octets
;
206 uint32_t scsicmd_pdus_cnt
;
207 uint32_t dataout_pdus_cnt
;
208 uint32_t scsirsp_pdus_cnt
;
209 uint32_t datain_pdus_cnt
;
210 uint32_t r2t_pdus_cnt
;
211 uint32_t tmfcmd_pdus_cnt
;
212 int32_t tmfrsp_pdus_cnt
;
214 /* custom statistics */
215 uint32_t eh_abort_cnt
;
216 uint32_t fmr_unalign_cnt
;
220 struct kfifo
*queue
; /* FIFO Queue */
221 void **pool
; /* Pool of elements */
222 int max
; /* Max number of elements */
225 /* Session's states */
227 ISCSI_STATE_FREE
= 1,
228 ISCSI_STATE_LOGGED_IN
,
230 ISCSI_STATE_TERMINATE
,
231 ISCSI_STATE_IN_RECOVERY
,
232 ISCSI_STATE_RECOVERY_FAILED
,
233 ISCSI_STATE_LOGGING_OUT
,
236 struct iscsi_session
{
237 struct iscsi_cls_session
*cls_session
;
239 * Syncs up the scsi eh thread with the iscsi eh thread when sending
240 * task management functions. This must be taken before the session
243 struct mutex eh_mutex
;
245 /* iSCSI session-wide sequencing */
250 /* This tracks the reqs queued into the initiator */
251 uint32_t queued_cmdsn
;
255 int lu_reset_timeout
;
259 unsigned first_burst
;
264 int dataseq_inorder_en
;
276 struct iscsi_transport
*tt
;
277 struct Scsi_Host
*host
;
278 struct iscsi_conn
*leadconn
; /* leading connection */
279 spinlock_t lock
; /* protects session state, *
280 * sequence numbers, *
281 * session resources: *
285 int state
; /* session state */
286 int age
; /* counts session re-opens */
288 int scsi_cmds_max
; /* max scsi commands */
289 int cmds_max
; /* size of cmds array */
290 struct iscsi_task
**cmds
; /* Original Cmds arr */
291 struct iscsi_pool cmdpool
; /* PDU's pool */
296 /* hw address or netdev iscsi connection is bound to */
301 char local_address
[ISCSI_ADDRESS_BUF_LEN
];
307 extern int iscsi_change_queue_depth(struct scsi_device
*sdev
, int depth
);
308 extern int iscsi_eh_abort(struct scsi_cmnd
*sc
);
309 extern int iscsi_eh_host_reset(struct scsi_cmnd
*sc
);
310 extern int iscsi_eh_device_reset(struct scsi_cmnd
*sc
);
311 extern int iscsi_queuecommand(struct scsi_cmnd
*sc
,
312 void (*done
)(struct scsi_cmnd
*));
315 * iSCSI host helpers.
317 #define iscsi_host_priv(_shost) \
318 (shost_priv(_shost) + sizeof(struct iscsi_host))
320 extern int iscsi_host_set_param(struct Scsi_Host
*shost
,
321 enum iscsi_host_param param
, char *buf
,
323 extern int iscsi_host_get_param(struct Scsi_Host
*shost
,
324 enum iscsi_host_param param
, char *buf
);
325 extern int iscsi_host_add(struct Scsi_Host
*shost
, struct device
*pdev
);
326 extern struct Scsi_Host
*iscsi_host_alloc(struct scsi_host_template
*sht
,
327 int dd_data_size
, uint16_t qdepth
);
328 extern void iscsi_host_remove(struct Scsi_Host
*shost
);
329 extern void iscsi_host_free(struct Scsi_Host
*shost
);
334 extern struct iscsi_cls_session
*
335 iscsi_session_setup(struct iscsi_transport
*, struct Scsi_Host
*shost
,
336 uint16_t, int, uint32_t, unsigned int);
337 extern void iscsi_session_teardown(struct iscsi_cls_session
*);
338 extern void iscsi_session_recovery_timedout(struct iscsi_cls_session
*);
339 extern int iscsi_set_param(struct iscsi_cls_conn
*cls_conn
,
340 enum iscsi_param param
, char *buf
, int buflen
);
341 extern int iscsi_session_get_param(struct iscsi_cls_session
*cls_session
,
342 enum iscsi_param param
, char *buf
);
344 #define iscsi_session_printk(prefix, _sess, fmt, a...) \
345 iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
348 * connection management
350 extern struct iscsi_cls_conn
*iscsi_conn_setup(struct iscsi_cls_session
*,
352 extern void iscsi_conn_teardown(struct iscsi_cls_conn
*);
353 extern int iscsi_conn_start(struct iscsi_cls_conn
*);
354 extern void iscsi_conn_stop(struct iscsi_cls_conn
*, int);
355 extern int iscsi_conn_bind(struct iscsi_cls_session
*, struct iscsi_cls_conn
*,
357 extern void iscsi_conn_failure(struct iscsi_conn
*conn
, enum iscsi_err err
);
358 extern int iscsi_conn_get_param(struct iscsi_cls_conn
*cls_conn
,
359 enum iscsi_param param
, char *buf
);
360 extern void iscsi_suspend_tx(struct iscsi_conn
*conn
);
362 #define iscsi_conn_printk(prefix, _c, fmt, a...) \
363 iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \
367 * pdu and task processing
369 extern void iscsi_update_cmdsn(struct iscsi_session
*, struct iscsi_nopin
*);
370 extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_task
*,
371 struct iscsi_data
*hdr
);
372 extern int iscsi_conn_send_pdu(struct iscsi_cls_conn
*, struct iscsi_hdr
*,
374 extern int iscsi_complete_pdu(struct iscsi_conn
*, struct iscsi_hdr
*,
376 extern int iscsi_verify_itt(struct iscsi_conn
*, itt_t
);
377 extern struct iscsi_task
*iscsi_itt_to_ctask(struct iscsi_conn
*, itt_t
);
378 extern void iscsi_requeue_task(struct iscsi_task
*task
);
379 extern void iscsi_put_task(struct iscsi_task
*task
);
384 extern void iscsi_pool_free(struct iscsi_pool
*);
385 extern int iscsi_pool_init(struct iscsi_pool
*, int, void ***, int);
388 * inline functions to deal with padding.
390 static inline unsigned int
391 iscsi_padded(unsigned int len
)
393 return (len
+ ISCSI_PAD_LEN
- 1) & ~(ISCSI_PAD_LEN
- 1);
396 static inline unsigned int
397 iscsi_padding(unsigned int len
)
399 len
&= (ISCSI_PAD_LEN
- 1);
401 len
= ISCSI_PAD_LEN
- len
;