blob: 9a26d715a9532ad3837652e234a4decb029f36fd [file] [log] [blame]
Mike Christie7996a772006-04-06 21:13:41 -05001/*
2 * iSCSI lib definitions
3 *
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
8 *
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.
13 *
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.
18 *
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.
22 */
23#ifndef LIBISCSI_H
24#define LIBISCSI_H
25
26#include <linux/types.h>
Mike Christie40753ca2008-05-21 15:53:56 -050027#include <linux/wait.h>
Mike Christie7996a772006-04-06 21:13:41 -050028#include <linux/mutex.h>
Al Virof6a57032006-10-18 01:47:25 -040029#include <linux/timer.h>
30#include <linux/workqueue.h>
Mike Christie7996a772006-04-06 21:13:41 -050031#include <scsi/iscsi_proto.h>
32#include <scsi/iscsi_if.h>
33
34struct scsi_transport_template;
Mike Christiea4804cd2008-05-21 15:54:00 -050035struct scsi_host_template;
Mike Christie7996a772006-04-06 21:13:41 -050036struct scsi_device;
37struct Scsi_Host;
38struct scsi_cmnd;
39struct socket;
40struct iscsi_transport;
41struct iscsi_cls_session;
42struct iscsi_cls_conn;
43struct iscsi_session;
44struct iscsi_nopin;
Mike Christiea4804cd2008-05-21 15:54:00 -050045struct device;
Mike Christie7996a772006-04-06 21:13:41 -050046
47/* #define DEBUG_SCSI */
48#ifdef DEBUG_SCSI
Or Gerlitzbe2df722006-05-02 19:46:43 -050049#define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
Mike Christie7996a772006-04-06 21:13:41 -050050#else
51#define debug_scsi(fmt...)
52#endif
53
Mike Christie15482712007-05-30 12:57:19 -050054#define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
55#define ISCSI_MGMT_CMDS_MAX 16 /* must be power of 2 */
Mike Christie7996a772006-04-06 21:13:41 -050056
57#define ISCSI_MGMT_ITT_OFFSET 0xa00
58
59#define ISCSI_DEF_CMD_PER_LUN 32
60#define ISCSI_MAX_CMD_PER_LUN 128
61
62/* Task Mgmt states */
Mike Christie843c0a82007-12-13 12:43:20 -060063enum {
64 TMF_INITIAL,
65 TMF_QUEUED,
66 TMF_SUCCESS,
67 TMF_FAILED,
68 TMF_TIMEDOUT,
69 TMF_NOT_FOUND,
70};
Mike Christie7996a772006-04-06 21:13:41 -050071
72/* Connection suspend "bit" */
73#define ISCSI_SUSPEND_BIT 1
74
75#define ISCSI_ITT_MASK (0xfff)
Mike Christie7996a772006-04-06 21:13:41 -050076#define ISCSI_AGE_SHIFT 28
77#define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
78
Mike Christie22236962007-05-30 12:57:24 -050079#define ISCSI_ADDRESS_BUF_LEN 64
80
Olaf Kirchda32dd62007-12-13 12:43:21 -060081enum {
Boaz Harrosh004d6532007-12-13 12:43:23 -060082 /* this is the maximum possible storage for AHSs */
83 ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
84 sizeof(struct iscsi_rlength_ahdr),
Olaf Kirchda32dd62007-12-13 12:43:21 -060085 ISCSI_DIGEST_SIZE = sizeof(__u32),
86};
87
Mike Christie7996a772006-04-06 21:13:41 -050088struct iscsi_mgmt_task {
89 /*
90 * Becuae LLDs allocate their hdr differently, this is a pointer to
91 * that storage. It must be setup at session creation time.
92 */
93 struct iscsi_hdr *hdr;
94 char *data; /* mgmt payload */
Mike Christie857ae0b2007-05-30 12:57:15 -050095 unsigned data_count; /* counts data to be sent */
Mike Christie7996a772006-04-06 21:13:41 -050096 uint32_t itt; /* this ITT */
97 void *dd_data; /* driver/transport data */
98 struct list_head running;
99};
100
Mike Christieb6c395ed2006-07-24 15:47:15 -0500101enum {
102 ISCSI_TASK_COMPLETED,
103 ISCSI_TASK_PENDING,
104 ISCSI_TASK_RUNNING,
105};
106
Mike Christie7996a772006-04-06 21:13:41 -0500107struct iscsi_cmd_task {
108 /*
Boaz Harrosh004d6532007-12-13 12:43:23 -0600109 * Because LLDs allocate their hdr differently, this is a pointer
110 * and length to that storage. It must be setup at session
111 * creation time.
Mike Christie7996a772006-04-06 21:13:41 -0500112 */
113 struct iscsi_cmd *hdr;
Boaz Harrosh004d6532007-12-13 12:43:23 -0600114 unsigned short hdr_max;
115 unsigned short hdr_len; /* accumulated size of hdr used */
Mike Christie7996a772006-04-06 21:13:41 -0500116 int itt; /* this ITT */
Mike Christie7996a772006-04-06 21:13:41 -0500117
118 uint32_t unsol_datasn;
Mike Christie857ae0b2007-05-30 12:57:15 -0500119 unsigned imm_count; /* imm-data (bytes) */
120 unsigned unsol_count; /* unsolicited (bytes)*/
Mike Christieffd04362006-08-31 18:09:24 -0400121 /* offset in unsolicited stream (bytes); */
Mike Christie857ae0b2007-05-30 12:57:15 -0500122 unsigned unsol_offset;
123 unsigned data_count; /* remaining Data-Out */
Mike Christie7996a772006-04-06 21:13:41 -0500124 struct scsi_cmnd *sc; /* associated SCSI cmd*/
Mike Christie7996a772006-04-06 21:13:41 -0500125 struct iscsi_conn *conn; /* used connection */
Mike Christie7996a772006-04-06 21:13:41 -0500126
Mike Christieb6c395ed2006-07-24 15:47:15 -0500127 /* state set/tested under session->lock */
128 int state;
Mike Christie60ecebf2006-08-31 18:09:25 -0400129 atomic_t refcount;
Mike Christie7996a772006-04-06 21:13:41 -0500130 struct list_head running; /* running cmd list */
131 void *dd_data; /* driver/transport data */
132};
133
Boaz Harrosh004d6532007-12-13 12:43:23 -0600134static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
135{
136 return (void*)ctask->hdr + ctask->hdr_len;
137}
138
Mike Christie6eabafb2008-01-31 13:36:43 -0600139/* Connection's states */
140enum {
141 ISCSI_CONN_INITIAL_STAGE,
142 ISCSI_CONN_STARTED,
143 ISCSI_CONN_STOPPED,
144 ISCSI_CONN_CLEANUP_WAIT,
145};
146
Mike Christie7996a772006-04-06 21:13:41 -0500147struct iscsi_conn {
148 struct iscsi_cls_conn *cls_conn; /* ptr to class connection */
149 void *dd_data; /* iscsi_transport data */
150 struct iscsi_session *session; /* parent session */
151 /*
152 * LLDs should set this lock. It protects the transport recv
153 * code
154 */
155 rwlock_t *recv_lock;
156 /*
157 * conn_stop() flag: stop to recover, stop to terminate
158 */
159 int stop_stage;
Mike Christief6d5180c72007-12-13 12:43:30 -0600160 struct timer_list transport_timer;
161 unsigned long last_recv;
162 unsigned long last_ping;
163 int ping_timeout;
164 int recv_timeout;
165 struct iscsi_mgmt_task *ping_mtask;
Mike Christie7996a772006-04-06 21:13:41 -0500166
167 /* iSCSI connection-wide sequencing */
168 uint32_t exp_statsn;
169
170 /* control data */
171 int id; /* CID */
Mike Christie7996a772006-04-06 21:13:41 -0500172 int c_stage; /* connection state */
Mike Christiec8dc1e52006-07-24 15:47:39 -0500173 /*
174 * Preallocated buffer for pdus that have data but do not
175 * originate from scsi-ml. We never have two pdus using the
176 * buffer at the same time. It is only allocated to
177 * the default max recv size because the pdus we support
178 * should always fit in this buffer
179 */
180 char *data;
Mike Christie7996a772006-04-06 21:13:41 -0500181 struct iscsi_mgmt_task *login_mtask; /* mtask used for login/text */
182 struct iscsi_mgmt_task *mtask; /* xmit mtask in progress */
183 struct iscsi_cmd_task *ctask; /* xmit ctask in progress */
184
185 /* xmit */
Mike Christie843c0a82007-12-13 12:43:20 -0600186 struct list_head mgmtqueue; /* mgmt (control) xmit queue */
Mike Christie7996a772006-04-06 21:13:41 -0500187 struct list_head mgmt_run_list; /* list of control tasks */
Mike Christieb6c395ed2006-07-24 15:47:15 -0500188 struct list_head xmitqueue; /* data-path cmd queue */
Mike Christie7996a772006-04-06 21:13:41 -0500189 struct list_head run_list; /* list of cmds in progress */
Mike Christie843c0a82007-12-13 12:43:20 -0600190 struct list_head requeue; /* tasks needing another run */
Mike Christie7996a772006-04-06 21:13:41 -0500191 struct work_struct xmitwork; /* per-conn. xmit workqueue */
Mike Christie7996a772006-04-06 21:13:41 -0500192 unsigned long suspend_tx; /* suspend Tx */
193 unsigned long suspend_rx; /* suspend Rx */
194
195 /* abort */
196 wait_queue_head_t ehwait; /* used in eh_abort() */
197 struct iscsi_tm tmhdr;
Mike Christie843c0a82007-12-13 12:43:20 -0600198 struct timer_list tmf_timer;
199 int tmf_state; /* see TMF_INITIAL, etc.*/
Mike Christie7996a772006-04-06 21:13:41 -0500200
201 /* negotiated params */
Mike Christie857ae0b2007-05-30 12:57:15 -0500202 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
203 unsigned max_xmit_dlength; /* target_max_recv_dsl */
Mike Christie7996a772006-04-06 21:13:41 -0500204 int hdrdgst_en;
205 int datadgst_en;
Mike Christiea54a52c2006-06-28 12:00:23 -0500206 int ifmarker_en;
207 int ofmarker_en;
208 /* values userspace uses to id a conn */
209 int persistent_port;
210 char *persistent_address;
Mike Christie22236962007-05-30 12:57:24 -0500211 /* remote portal currently connected to */
212 int portal_port;
213 char portal_address[ISCSI_ADDRESS_BUF_LEN];
Mike Christie7996a772006-04-06 21:13:41 -0500214
215 /* MIB-statistics */
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;
225
226 /* custom statistics */
227 uint32_t eh_abort_cnt;
Eli Dorfman87528222008-04-29 13:46:52 -0700228 uint32_t fmr_unalign_cnt;
Mike Christie7996a772006-04-06 21:13:41 -0500229};
230
Olaf Kirch63203772007-12-13 12:43:25 -0600231struct iscsi_pool {
Mike Christie7996a772006-04-06 21:13:41 -0500232 struct kfifo *queue; /* FIFO Queue */
233 void **pool; /* Pool of elements */
234 int max; /* Max number of elements */
235};
236
Mike Christie6eabafb2008-01-31 13:36:43 -0600237/* Session's states */
238enum {
239 ISCSI_STATE_FREE = 1,
240 ISCSI_STATE_LOGGED_IN,
241 ISCSI_STATE_FAILED,
242 ISCSI_STATE_TERMINATE,
243 ISCSI_STATE_IN_RECOVERY,
244 ISCSI_STATE_RECOVERY_FAILED,
245 ISCSI_STATE_LOGGING_OUT,
246};
247
Mike Christie7996a772006-04-06 21:13:41 -0500248struct iscsi_session {
Mike Christie75613522008-05-21 15:53:59 -0500249 struct iscsi_cls_session *cls_session;
Mike Christie6724add2007-08-15 01:38:30 -0500250 /*
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
253 * and recv lock.
254 */
255 struct mutex eh_mutex;
256
Mike Christie7996a772006-04-06 21:13:41 -0500257 /* iSCSI session-wide sequencing */
258 uint32_t cmdsn;
259 uint32_t exp_cmdsn;
260 uint32_t max_cmdsn;
261
Mike Christiee0726402007-07-26 12:46:48 -0500262 /* This tracks the reqs queued into the initiator */
263 uint32_t queued_cmdsn;
264
Mike Christie7996a772006-04-06 21:13:41 -0500265 /* configuration */
Mike Christief6d5180c72007-12-13 12:43:30 -0600266 int abort_timeout;
267 int lu_reset_timeout;
Mike Christie7996a772006-04-06 21:13:41 -0500268 int initial_r2t_en;
Mike Christie857ae0b2007-05-30 12:57:15 -0500269 unsigned max_r2t;
Mike Christie7996a772006-04-06 21:13:41 -0500270 int imm_data_en;
Mike Christie857ae0b2007-05-30 12:57:15 -0500271 unsigned first_burst;
272 unsigned max_burst;
Mike Christie7996a772006-04-06 21:13:41 -0500273 int time2wait;
274 int time2retain;
275 int pdu_inorder_en;
276 int dataseq_inorder_en;
277 int erl;
Mike Christie843c0a82007-12-13 12:43:20 -0600278 int fast_abort;
Mike Christiea54a52c2006-06-28 12:00:23 -0500279 int tpgt;
Mike Christieb2c64162007-05-30 12:57:16 -0500280 char *username;
281 char *username_in;
282 char *password;
283 char *password_in;
Mike Christiea54a52c2006-06-28 12:00:23 -0500284 char *targetname;
Mike Christie7996a772006-04-06 21:13:41 -0500285 /* control data */
286 struct iscsi_transport *tt;
287 struct Scsi_Host *host;
288 struct iscsi_conn *leadconn; /* leading connection */
289 spinlock_t lock; /* protects session state, *
290 * sequence numbers, *
291 * session resources: *
292 * - cmdpool, *
293 * - mgmtpool, *
294 * - r2tpool */
295 int state; /* session state */
Mike Christie7996a772006-04-06 21:13:41 -0500296 int age; /* counts session re-opens */
297
Mike Christie7996a772006-04-06 21:13:41 -0500298 int cmds_max; /* size of cmds array */
299 struct iscsi_cmd_task **cmds; /* Original Cmds arr */
Olaf Kirch63203772007-12-13 12:43:25 -0600300 struct iscsi_pool cmdpool; /* PDU's pool */
Mike Christie7996a772006-04-06 21:13:41 -0500301 int mgmtpool_max; /* size of mgmt array */
302 struct iscsi_mgmt_task **mgmt_cmds; /* Original mgmt arr */
Olaf Kirch63203772007-12-13 12:43:25 -0600303 struct iscsi_pool mgmtpool; /* Mgmt PDU's pool */
Mike Christie7996a772006-04-06 21:13:41 -0500304};
305
Mike Christie75613522008-05-21 15:53:59 -0500306struct iscsi_host {
307 char *initiatorname;
308 /* hw address or netdev iscsi connection is bound to */
309 char *hwaddress;
310 char *netdev;
311 /* local address */
312 int local_port;
313 char local_address[ISCSI_ADDRESS_BUF_LEN];
314};
315
Mike Christiea4804cd2008-05-21 15:54:00 -0500316#define iscsi_host_priv(_shost) \
317 (shost_priv(_shost) + sizeof(struct iscsi_host))
Mike Christie7996a772006-04-06 21:13:41 -0500318/*
319 * scsi host template
320 */
321extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
322extern int iscsi_eh_abort(struct scsi_cmnd *sc);
323extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
Mike Christie843c0a82007-12-13 12:43:20 -0600324extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
Mike Christie7996a772006-04-06 21:13:41 -0500325extern int iscsi_queuecommand(struct scsi_cmnd *sc,
326 void (*done)(struct scsi_cmnd *));
327
Mike Christie0801c242007-05-30 12:57:12 -0500328
329/*
330 * iSCSI host helpers.
331 */
332extern int iscsi_host_set_param(struct Scsi_Host *shost,
333 enum iscsi_host_param param, char *buf,
334 int buflen);
335extern int iscsi_host_get_param(struct Scsi_Host *shost,
336 enum iscsi_host_param param, char *buf);
Mike Christiea4804cd2008-05-21 15:54:00 -0500337extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev);
338extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht,
339 int dd_data_size, uint16_t qdepth);
340extern void iscsi_host_remove(struct Scsi_Host *shost);
341extern void iscsi_host_free(struct Scsi_Host *shost);
Mike Christie0801c242007-05-30 12:57:12 -0500342
Mike Christie7996a772006-04-06 21:13:41 -0500343/*
344 * session management
345 */
346extern struct iscsi_cls_session *
Mike Christie75613522008-05-21 15:53:59 -0500347iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost,
348 uint16_t, int, int, uint32_t);
Mike Christie7996a772006-04-06 21:13:41 -0500349extern void iscsi_session_teardown(struct iscsi_cls_session *);
Mike Christie7996a772006-04-06 21:13:41 -0500350extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
Mike Christiea54a52c2006-06-28 12:00:23 -0500351extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
352 enum iscsi_param param, char *buf, int buflen);
353extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
354 enum iscsi_param param, char *buf);
Mike Christie7996a772006-04-06 21:13:41 -0500355
Mike Christie322d7392008-01-31 13:36:52 -0600356#define iscsi_session_printk(prefix, _sess, fmt, a...) \
Mike Christie75613522008-05-21 15:53:59 -0500357 iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
Mike Christie322d7392008-01-31 13:36:52 -0600358
Mike Christie7996a772006-04-06 21:13:41 -0500359/*
360 * connection management
361 */
362extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
363 uint32_t);
364extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
365extern int iscsi_conn_start(struct iscsi_cls_conn *);
366extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
367extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
368 int);
369extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
Mike Christiea54a52c2006-06-28 12:00:23 -0500370extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
371 enum iscsi_param param, char *buf);
Mike Christie7996a772006-04-06 21:13:41 -0500372
Mike Christie322d7392008-01-31 13:36:52 -0600373#define iscsi_conn_printk(prefix, _c, fmt, a...) \
374 iscsi_cls_conn_printk(prefix, _c->cls_conn, fmt, ##a)
375
Mike Christie7996a772006-04-06 21:13:41 -0500376/*
377 * pdu and task processing
378 */
Mike Christie77a23c22007-05-30 12:57:18 -0500379extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
Mike Christie7996a772006-04-06 21:13:41 -0500380extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
Mike Christieffd04362006-08-31 18:09:24 -0400381 struct iscsi_data *hdr);
Mike Christie7996a772006-04-06 21:13:41 -0500382extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
383 char *, uint32_t);
384extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
385 char *, int);
Mike Christie7996a772006-04-06 21:13:41 -0500386extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
387 uint32_t *);
Mike Christie843c0a82007-12-13 12:43:20 -0600388extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);
Mike Christieb3a7ea82007-12-13 12:43:26 -0600389extern void iscsi_free_mgmt_task(struct iscsi_conn *conn,
390 struct iscsi_mgmt_task *mtask);
Mike Christie7996a772006-04-06 21:13:41 -0500391
392/*
393 * generic helpers
394 */
Olaf Kirch63203772007-12-13 12:43:25 -0600395extern void iscsi_pool_free(struct iscsi_pool *);
396extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
Mike Christie7996a772006-04-06 21:13:41 -0500397
Boaz Harrosh004d6532007-12-13 12:43:23 -0600398/*
399 * inline functions to deal with padding.
400 */
401static inline unsigned int
402iscsi_padded(unsigned int len)
403{
404 return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
405}
406
407static inline unsigned int
408iscsi_padding(unsigned int len)
409{
410 len &= (ISCSI_PAD_LEN - 1);
411 if (len)
412 len = ISCSI_PAD_LEN - len;
413 return len;
414}
415
Mike Christie7996a772006-04-06 21:13:41 -0500416#endif