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/mutex.h>
28 #include <linux/timer.h>
29 #include <linux/workqueue.h>
30 #include <scsi/iscsi_proto.h>
31 #include <scsi/iscsi_if.h>
33 struct scsi_transport_template;
38 struct iscsi_transport;
39 struct iscsi_cls_session;
40 struct iscsi_cls_conn;
44 /* #define DEBUG_SCSI */
46 #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
48 #define debug_scsi(fmt...)
51 #define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
52 #define ISCSI_MGMT_CMDS_MAX 16 /* must be power of 2 */
54 #define ISCSI_MGMT_ITT_OFFSET 0xa00
56 #define ISCSI_DEF_CMD_PER_LUN 32
57 #define ISCSI_MAX_CMD_PER_LUN 128
59 /* Task Mgmt states */
69 /* Connection suspend "bit" */
70 #define ISCSI_SUSPEND_BIT 1
72 #define ISCSI_ITT_MASK (0xfff)
73 #define ISCSI_AGE_SHIFT 28
74 #define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
76 #define ISCSI_ADDRESS_BUF_LEN 64
79 /* this is the maximum possible storage for AHSs */
80 ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
81 sizeof(struct iscsi_rlength_ahdr),
82 ISCSI_DIGEST_SIZE = sizeof(__u32),
85 struct iscsi_mgmt_task {
87 * Becuae LLDs allocate their hdr differently, this is a pointer to
88 * that storage. It must be setup at session creation time.
90 struct iscsi_hdr *hdr;
91 char *data; /* mgmt payload */
92 unsigned data_count; /* counts data to be sent */
93 uint32_t itt; /* this ITT */
94 void *dd_data; /* driver/transport data */
95 struct list_head running;
104 struct iscsi_cmd_task {
106 * Because LLDs allocate their hdr differently, this is a pointer
107 * and length to that storage. It must be setup at session
110 struct iscsi_cmd *hdr;
111 unsigned short hdr_max;
112 unsigned short hdr_len; /* accumulated size of hdr used */
113 int itt; /* this ITT */
115 uint32_t unsol_datasn;
116 unsigned imm_count; /* imm-data (bytes) */
117 unsigned unsol_count; /* unsolicited (bytes)*/
118 /* offset in unsolicited stream (bytes); */
119 unsigned unsol_offset;
120 unsigned data_count; /* remaining Data-Out */
121 struct scsi_cmnd *sc; /* associated SCSI cmd*/
122 struct iscsi_conn *conn; /* used connection */
124 /* state set/tested under session->lock */
127 struct list_head running; /* running cmd list */
128 void *dd_data; /* driver/transport data */
131 static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
133 return (void*)ctask->hdr + ctask->hdr_len;
136 /* Connection's states */
138 ISCSI_CONN_INITIAL_STAGE,
141 ISCSI_CONN_CLEANUP_WAIT,
145 struct iscsi_cls_conn *cls_conn; /* ptr to class connection */
146 void *dd_data; /* iscsi_transport data */
147 struct iscsi_session *session; /* parent session */
149 * LLDs should set this lock. It protects the transport recv
154 * conn_stop() flag: stop to recover, stop to terminate
157 struct timer_list transport_timer;
158 unsigned long last_recv;
159 unsigned long last_ping;
162 struct iscsi_mgmt_task *ping_mtask;
164 /* iSCSI connection-wide sequencing */
169 int c_stage; /* connection state */
171 * Preallocated buffer for pdus that have data but do not
172 * originate from scsi-ml. We never have two pdus using the
173 * buffer at the same time. It is only allocated to
174 * the default max recv size because the pdus we support
175 * should always fit in this buffer
178 struct iscsi_mgmt_task *login_mtask; /* mtask used for login/text */
179 struct iscsi_mgmt_task *mtask; /* xmit mtask in progress */
180 struct iscsi_cmd_task *ctask; /* xmit ctask in progress */
183 struct list_head mgmtqueue; /* mgmt (control) xmit queue */
184 struct list_head mgmt_run_list; /* list of control tasks */
185 struct list_head xmitqueue; /* data-path cmd queue */
186 struct list_head run_list; /* list of cmds in progress */
187 struct list_head requeue; /* tasks needing another run */
188 struct work_struct xmitwork; /* per-conn. xmit workqueue */
189 unsigned long suspend_tx; /* suspend Tx */
190 unsigned long suspend_rx; /* suspend Rx */
193 wait_queue_head_t ehwait; /* used in eh_abort() */
194 struct iscsi_tm tmhdr;
195 struct timer_list tmf_timer;
196 int tmf_state; /* see TMF_INITIAL, etc.*/
198 /* negotiated params */
199 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
200 unsigned max_xmit_dlength; /* target_max_recv_dsl */
205 /* values userspace uses to id a conn */
207 char *persistent_address;
208 /* remote portal currently connected to */
210 char portal_address[ISCSI_ADDRESS_BUF_LEN];
213 char local_address[ISCSI_ADDRESS_BUF_LEN];
216 uint64_t txdata_octets;
217 uint64_t rxdata_octets;
218 uint32_t scsicmd_pdus_cnt;
219 uint32_t dataout_pdus_cnt;
220 uint32_t scsirsp_pdus_cnt;
221 uint32_t datain_pdus_cnt;
222 uint32_t r2t_pdus_cnt;
223 uint32_t tmfcmd_pdus_cnt;
224 int32_t tmfrsp_pdus_cnt;
226 /* custom statistics */
227 uint32_t eh_abort_cnt;
231 struct kfifo *queue; /* FIFO Queue */
232 void **pool; /* Pool of elements */
233 int max; /* Max number of elements */
236 /* Session's states */
238 ISCSI_STATE_FREE = 1,
239 ISCSI_STATE_LOGGED_IN,
241 ISCSI_STATE_TERMINATE,
242 ISCSI_STATE_IN_RECOVERY,
243 ISCSI_STATE_RECOVERY_FAILED,
244 ISCSI_STATE_LOGGING_OUT,
247 struct iscsi_session {
249 * Syncs up the scsi eh thread with the iscsi eh thread when sending
250 * task management functions. This must be taken before the session
253 struct mutex eh_mutex;
255 /* iSCSI session-wide sequencing */
260 /* This tracks the reqs queued into the initiator */
261 uint32_t queued_cmdsn;
265 int lu_reset_timeout;
269 unsigned first_burst;
274 int dataseq_inorder_en;
284 /* hw address or netdev iscsi connection is bound to */
288 struct iscsi_transport *tt;
289 struct Scsi_Host *host;
290 struct iscsi_conn *leadconn; /* leading connection */
291 spinlock_t lock; /* protects session state, *
292 * sequence numbers, *
293 * session resources: *
297 int state; /* session state */
298 int age; /* counts session re-opens */
300 int cmds_max; /* size of cmds array */
301 struct iscsi_cmd_task **cmds; /* Original Cmds arr */
302 struct iscsi_pool cmdpool; /* PDU's pool */
303 int mgmtpool_max; /* size of mgmt array */
304 struct iscsi_mgmt_task **mgmt_cmds; /* Original mgmt arr */
305 struct iscsi_pool mgmtpool; /* Mgmt PDU's pool */
311 extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
312 extern int iscsi_eh_abort(struct scsi_cmnd *sc);
313 extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
314 extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
315 extern int iscsi_queuecommand(struct scsi_cmnd *sc,
316 void (*done)(struct scsi_cmnd *));
320 * iSCSI host helpers.
322 extern int iscsi_host_set_param(struct Scsi_Host *shost,
323 enum iscsi_host_param param, char *buf,
325 extern int iscsi_host_get_param(struct Scsi_Host *shost,
326 enum iscsi_host_param param, char *buf);
331 extern struct iscsi_cls_session *
332 iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
333 uint16_t, uint16_t, int, int, uint32_t, uint32_t *);
334 extern void iscsi_session_teardown(struct iscsi_cls_session *);
335 extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *);
336 extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
337 extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
338 enum iscsi_param param, char *buf, int buflen);
339 extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
340 enum iscsi_param param, char *buf);
342 #define session_to_cls(_sess) \
343 hostdata_session(_sess->host->hostdata)
345 #define iscsi_session_printk(prefix, _sess, fmt, a...) \
346 iscsi_cls_session_printk(prefix, \
347 (struct iscsi_cls_session *)session_to_cls(_sess), fmt, ##a)
350 * connection management
352 extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
354 extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
355 extern int iscsi_conn_start(struct iscsi_cls_conn *);
356 extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
357 extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
359 extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
360 extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
361 enum iscsi_param param, char *buf);
363 #define iscsi_conn_printk(prefix, _c, fmt, a...) \
364 iscsi_cls_conn_printk(prefix, _c->cls_conn, fmt, ##a)
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_cmd_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 *, struct iscsi_hdr *,
378 extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);
379 extern void iscsi_free_mgmt_task(struct iscsi_conn *conn,
380 struct iscsi_mgmt_task *mtask);
385 extern void iscsi_pool_free(struct iscsi_pool *);
386 extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
389 * inline functions to deal with padding.
391 static inline unsigned int
392 iscsi_padded(unsigned int len)
394 return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
397 static inline unsigned int
398 iscsi_padding(unsigned int len)
400 len &= (ISCSI_PAD_LEN - 1);
402 len = ISCSI_PAD_LEN - len;