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;
39 struct iscsi_transport;
40 struct iscsi_cls_session;
41 struct iscsi_cls_conn;
45 /* #define DEBUG_SCSI */
47 #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
49 #define debug_scsi(fmt...)
52 #define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
53 #define ISCSI_MGMT_CMDS_MAX 16 /* must be power of 2 */
55 #define ISCSI_MGMT_ITT_OFFSET 0xa00
57 #define ISCSI_DEF_CMD_PER_LUN 32
58 #define ISCSI_MAX_CMD_PER_LUN 128
60 /* Task Mgmt states */
70 /* Connection suspend "bit" */
71 #define ISCSI_SUSPEND_BIT 1
73 #define ISCSI_ITT_MASK (0xfff)
74 #define ISCSI_AGE_SHIFT 28
75 #define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
77 #define ISCSI_ADDRESS_BUF_LEN 64
80 /* this is the maximum possible storage for AHSs */
81 ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
82 sizeof(struct iscsi_rlength_ahdr),
83 ISCSI_DIGEST_SIZE = sizeof(__u32),
86 struct iscsi_mgmt_task {
88 * Becuae LLDs allocate their hdr differently, this is a pointer to
89 * that storage. It must be setup at session creation time.
91 struct iscsi_hdr *hdr;
92 char *data; /* mgmt payload */
93 unsigned data_count; /* counts data to be sent */
94 uint32_t itt; /* this ITT */
95 void *dd_data; /* driver/transport data */
96 struct list_head running;
100 ISCSI_TASK_COMPLETED,
105 struct iscsi_cmd_task {
107 * Because LLDs allocate their hdr differently, this is a pointer
108 * and length to that storage. It must be setup at session
111 struct iscsi_cmd *hdr;
112 unsigned short hdr_max;
113 unsigned short hdr_len; /* accumulated size of hdr used */
114 int itt; /* this ITT */
116 uint32_t unsol_datasn;
117 unsigned imm_count; /* imm-data (bytes) */
118 unsigned unsol_count; /* unsolicited (bytes)*/
119 /* offset in unsolicited stream (bytes); */
120 unsigned unsol_offset;
121 unsigned data_count; /* remaining Data-Out */
122 struct scsi_cmnd *sc; /* associated SCSI cmd*/
123 struct iscsi_conn *conn; /* used connection */
125 /* state set/tested under session->lock */
128 struct list_head running; /* running cmd list */
129 void *dd_data; /* driver/transport data */
132 static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
134 return (void*)ctask->hdr + ctask->hdr_len;
137 /* Connection's states */
139 ISCSI_CONN_INITIAL_STAGE,
142 ISCSI_CONN_CLEANUP_WAIT,
146 struct iscsi_cls_conn *cls_conn; /* ptr to class connection */
147 void *dd_data; /* iscsi_transport data */
148 struct iscsi_session *session; /* parent session */
150 * LLDs should set this lock. It protects the transport recv
155 * conn_stop() flag: stop to recover, stop to terminate
158 struct timer_list transport_timer;
159 unsigned long last_recv;
160 unsigned long last_ping;
163 struct iscsi_mgmt_task *ping_mtask;
165 /* iSCSI connection-wide sequencing */
170 int c_stage; /* connection state */
172 * Preallocated buffer for pdus that have data but do not
173 * originate from scsi-ml. We never have two pdus using the
174 * buffer at the same time. It is only allocated to
175 * the default max recv size because the pdus we support
176 * should always fit in this buffer
179 struct iscsi_mgmt_task *login_mtask; /* mtask used for login/text */
180 struct iscsi_mgmt_task *mtask; /* xmit mtask in progress */
181 struct iscsi_cmd_task *ctask; /* xmit ctask in progress */
184 struct list_head mgmtqueue; /* mgmt (control) xmit queue */
185 struct list_head mgmt_run_list; /* list of control tasks */
186 struct list_head xmitqueue; /* data-path cmd queue */
187 struct list_head run_list; /* list of cmds in progress */
188 struct list_head requeue; /* tasks needing another run */
189 struct work_struct xmitwork; /* per-conn. xmit workqueue */
190 unsigned long suspend_tx; /* suspend Tx */
191 unsigned long suspend_rx; /* suspend Rx */
194 wait_queue_head_t ehwait; /* used in eh_abort() */
195 struct iscsi_tm tmhdr;
196 struct timer_list tmf_timer;
197 int tmf_state; /* see TMF_INITIAL, etc.*/
199 /* negotiated params */
200 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
201 unsigned max_xmit_dlength; /* target_max_recv_dsl */
206 /* values userspace uses to id a conn */
208 char *persistent_address;
209 /* remote portal currently connected to */
211 char portal_address[ISCSI_ADDRESS_BUF_LEN];
214 uint64_t txdata_octets;
215 uint64_t rxdata_octets;
216 uint32_t scsicmd_pdus_cnt;
217 uint32_t dataout_pdus_cnt;
218 uint32_t scsirsp_pdus_cnt;
219 uint32_t datain_pdus_cnt;
220 uint32_t r2t_pdus_cnt;
221 uint32_t tmfcmd_pdus_cnt;
222 int32_t tmfrsp_pdus_cnt;
224 /* custom statistics */
225 uint32_t eh_abort_cnt;
226 uint32_t fmr_unalign_cnt;
230 struct kfifo *queue; /* FIFO Queue */
231 void **pool; /* Pool of elements */
232 int max; /* Max number of elements */
235 /* Session's states */
237 ISCSI_STATE_FREE = 1,
238 ISCSI_STATE_LOGGED_IN,
240 ISCSI_STATE_TERMINATE,
241 ISCSI_STATE_IN_RECOVERY,
242 ISCSI_STATE_RECOVERY_FAILED,
243 ISCSI_STATE_LOGGING_OUT,
246 struct iscsi_session {
247 struct iscsi_cls_session *cls_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 struct iscsi_transport *tt;
285 struct Scsi_Host *host;
286 struct iscsi_conn *leadconn; /* leading connection */
287 spinlock_t lock; /* protects session state, *
288 * sequence numbers, *
289 * session resources: *
293 int state; /* session state */
294 int age; /* counts session re-opens */
296 int cmds_max; /* size of cmds array */
297 struct iscsi_cmd_task **cmds; /* Original Cmds arr */
298 struct iscsi_pool cmdpool; /* PDU's pool */
299 int mgmtpool_max; /* size of mgmt array */
300 struct iscsi_mgmt_task **mgmt_cmds; /* Original mgmt arr */
301 struct iscsi_pool mgmtpool; /* Mgmt PDU's pool */
306 /* hw address or netdev iscsi connection is bound to */
311 char local_address[ISCSI_ADDRESS_BUF_LEN];
317 extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
318 extern int iscsi_eh_abort(struct scsi_cmnd *sc);
319 extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
320 extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
321 extern int iscsi_queuecommand(struct scsi_cmnd *sc,
322 void (*done)(struct scsi_cmnd *));
326 * iSCSI host helpers.
328 extern int iscsi_host_set_param(struct Scsi_Host *shost,
329 enum iscsi_host_param param, char *buf,
331 extern int iscsi_host_get_param(struct Scsi_Host *shost,
332 enum iscsi_host_param param, char *buf);
333 extern void iscsi_host_setup(struct Scsi_Host *shost, uint16_t qdepth);
334 extern void iscsi_host_teardown(struct Scsi_Host *shost);
339 extern struct iscsi_cls_session *
340 iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost,
341 uint16_t, int, int, uint32_t);
342 extern void iscsi_session_teardown(struct iscsi_cls_session *);
343 extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
344 extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
345 enum iscsi_param param, char *buf, int buflen);
346 extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
347 enum iscsi_param param, char *buf);
349 #define iscsi_session_printk(prefix, _sess, fmt, a...) \
350 iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
353 * connection management
355 extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
357 extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
358 extern int iscsi_conn_start(struct iscsi_cls_conn *);
359 extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
360 extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
362 extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
363 extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
364 enum iscsi_param param, char *buf);
366 #define iscsi_conn_printk(prefix, _c, fmt, a...) \
367 iscsi_cls_conn_printk(prefix, _c->cls_conn, fmt, ##a)
370 * pdu and task processing
372 extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
373 extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
374 struct iscsi_data *hdr);
375 extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
377 extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
379 extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
381 extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);
382 extern void iscsi_free_mgmt_task(struct iscsi_conn *conn,
383 struct iscsi_mgmt_task *mtask);
388 extern void iscsi_pool_free(struct iscsi_pool *);
389 extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
392 * inline functions to deal with padding.
394 static inline unsigned int
395 iscsi_padded(unsigned int len)
397 return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
400 static inline unsigned int
401 iscsi_padding(unsigned int len)
403 len &= (ISCSI_PAD_LEN - 1);
405 len = ISCSI_PAD_LEN - len;