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_CID_SHIFT 12
74 #define ISCSI_CID_MASK (0xffff << ISCSI_CID_SHIFT)
75 #define ISCSI_AGE_SHIFT 28
76 #define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
78 #define ISCSI_ADDRESS_BUF_LEN 64
81 /* this is the maximum possible storage for AHSs */
82 ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
83 sizeof(struct iscsi_rlength_ahdr),
84 ISCSI_DIGEST_SIZE = sizeof(__u32),
87 struct iscsi_mgmt_task {
89 * Becuae LLDs allocate their hdr differently, this is a pointer to
90 * that storage. It must be setup at session creation time.
92 struct iscsi_hdr *hdr;
93 char *data; /* mgmt payload */
94 unsigned data_count; /* counts data to be sent */
95 uint32_t itt; /* this ITT */
96 void *dd_data; /* driver/transport data */
97 struct list_head running;
101 ISCSI_TASK_COMPLETED,
106 struct iscsi_cmd_task {
108 * Because LLDs allocate their hdr differently, this is a pointer
109 * and length to that storage. It must be setup at session
112 struct iscsi_cmd *hdr;
113 unsigned short hdr_max;
114 unsigned short hdr_len; /* accumulated size of hdr used */
115 int itt; /* this ITT */
117 uint32_t unsol_datasn;
118 unsigned imm_count; /* imm-data (bytes) */
119 unsigned unsol_count; /* unsolicited (bytes)*/
120 /* offset in unsolicited stream (bytes); */
121 unsigned unsol_offset;
122 unsigned data_count; /* remaining Data-Out */
123 struct scsi_cmnd *sc; /* associated SCSI cmd*/
124 struct iscsi_conn *conn; /* used connection */
126 /* state set/tested under session->lock */
129 struct list_head running; /* running cmd list */
130 void *dd_data; /* driver/transport data */
133 static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
135 return (void*)ctask->hdr + ctask->hdr_len;
138 /* Connection's states */
140 ISCSI_CONN_INITIAL_STAGE,
143 ISCSI_CONN_CLEANUP_WAIT,
147 struct iscsi_cls_conn *cls_conn; /* ptr to class connection */
148 void *dd_data; /* iscsi_transport data */
149 struct iscsi_session *session; /* parent session */
151 * LLDs should set this lock. It protects the transport recv
156 * conn_stop() flag: stop to recover, stop to terminate
159 struct timer_list transport_timer;
160 unsigned long last_recv;
161 unsigned long last_ping;
164 struct iscsi_mgmt_task *ping_mtask;
166 /* iSCSI connection-wide sequencing */
171 int c_stage; /* connection state */
173 * Preallocated buffer for pdus that have data but do not
174 * originate from scsi-ml. We never have two pdus using the
175 * buffer at the same time. It is only allocated to
176 * the default max recv size because the pdus we support
177 * should always fit in this buffer
180 struct iscsi_mgmt_task *login_mtask; /* mtask used for login/text */
181 struct iscsi_mgmt_task *mtask; /* xmit mtask in progress */
182 struct iscsi_cmd_task *ctask; /* xmit ctask in progress */
185 struct list_head mgmtqueue; /* mgmt (control) xmit queue */
186 struct list_head mgmt_run_list; /* list of control tasks */
187 struct list_head xmitqueue; /* data-path cmd queue */
188 struct list_head run_list; /* list of cmds in progress */
189 struct list_head requeue; /* tasks needing another run */
190 struct work_struct xmitwork; /* per-conn. xmit workqueue */
191 unsigned long suspend_tx; /* suspend Tx */
192 unsigned long suspend_rx; /* suspend Rx */
195 wait_queue_head_t ehwait; /* used in eh_abort() */
196 struct iscsi_tm tmhdr;
197 struct timer_list tmf_timer;
198 int tmf_state; /* see TMF_INITIAL, etc.*/
200 /* negotiated params */
201 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
202 unsigned max_xmit_dlength; /* target_max_recv_dsl */
207 /* values userspace uses to id a conn */
209 char *persistent_address;
210 /* remote portal currently connected to */
212 char portal_address[ISCSI_ADDRESS_BUF_LEN];
215 char local_address[ISCSI_ADDRESS_BUF_LEN];
218 uint64_t txdata_octets;
219 uint64_t rxdata_octets;
220 uint32_t scsicmd_pdus_cnt;
221 uint32_t dataout_pdus_cnt;
222 uint32_t scsirsp_pdus_cnt;
223 uint32_t datain_pdus_cnt;
224 uint32_t r2t_pdus_cnt;
225 uint32_t tmfcmd_pdus_cnt;
226 int32_t tmfrsp_pdus_cnt;
228 /* custom statistics */
229 uint32_t eh_abort_cnt;
233 struct kfifo *queue; /* FIFO Queue */
234 void **pool; /* Pool of elements */
235 int max; /* Max number of elements */
238 /* Session's states */
240 ISCSI_STATE_FREE = 1,
241 ISCSI_STATE_LOGGED_IN,
243 ISCSI_STATE_TERMINATE,
244 ISCSI_STATE_IN_RECOVERY,
245 ISCSI_STATE_RECOVERY_FAILED,
246 ISCSI_STATE_LOGGING_OUT,
249 struct iscsi_session {
251 * Syncs up the scsi eh thread with the iscsi eh thread when sending
252 * task management functions. This must be taken before the session
255 struct mutex eh_mutex;
257 /* iSCSI session-wide sequencing */
262 /* This tracks the reqs queued into the initiator */
263 uint32_t queued_cmdsn;
267 int lu_reset_timeout;
271 unsigned first_burst;
276 int dataseq_inorder_en;
286 /* hw address or netdev iscsi connection is bound to */
290 struct iscsi_transport *tt;
291 struct Scsi_Host *host;
292 struct iscsi_conn *leadconn; /* leading connection */
293 spinlock_t lock; /* protects session state, *
294 * sequence numbers, *
295 * session resources: *
299 int state; /* session state */
300 int age; /* counts session re-opens */
302 int cmds_max; /* size of cmds array */
303 struct iscsi_cmd_task **cmds; /* Original Cmds arr */
304 struct iscsi_pool cmdpool; /* PDU's pool */
305 int mgmtpool_max; /* size of mgmt array */
306 struct iscsi_mgmt_task **mgmt_cmds; /* Original mgmt arr */
307 struct iscsi_pool mgmtpool; /* Mgmt PDU's pool */
313 extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
314 extern int iscsi_eh_abort(struct scsi_cmnd *sc);
315 extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
316 extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
317 extern int iscsi_queuecommand(struct scsi_cmnd *sc,
318 void (*done)(struct scsi_cmnd *));
322 * iSCSI host helpers.
324 extern int iscsi_host_set_param(struct Scsi_Host *shost,
325 enum iscsi_host_param param, char *buf,
327 extern int iscsi_host_get_param(struct Scsi_Host *shost,
328 enum iscsi_host_param param, char *buf);
333 extern struct iscsi_cls_session *
334 iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
335 uint16_t, uint16_t, int, int, uint32_t, uint32_t *);
336 extern void iscsi_session_teardown(struct iscsi_cls_session *);
337 extern struct iscsi_session *class_to_transport_session(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 session_to_cls(_sess) \
345 hostdata_session(_sess->host->hostdata)
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);
362 * pdu and task processing
364 extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
365 extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
366 struct iscsi_data *hdr);
367 extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
369 extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
371 extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
373 extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);
374 extern void iscsi_free_mgmt_task(struct iscsi_conn *conn,
375 struct iscsi_mgmt_task *mtask);
380 extern void iscsi_pool_free(struct iscsi_pool *);
381 extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
384 * inline functions to deal with padding.
386 static inline unsigned int
387 iscsi_padded(unsigned int len)
389 return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
392 static inline unsigned int
393 iscsi_padding(unsigned int len)
395 len &= (ISCSI_PAD_LEN - 1);
397 len = ISCSI_PAD_LEN - len;