]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/scsi/libiscsi.h
[SCSI] iscsi tcp: fix iscsi xmit state machine
[mirror_ubuntu-zesty-kernel.git] / include / scsi / libiscsi.h
CommitLineData
7996a778
MC
1/*
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>
27#include <linux/mutex.h>
f6a57033
AV
28#include <linux/timer.h>
29#include <linux/workqueue.h>
7996a778
MC
30#include <scsi/iscsi_proto.h>
31#include <scsi/iscsi_if.h>
32
33struct scsi_transport_template;
34struct scsi_device;
35struct Scsi_Host;
36struct scsi_cmnd;
37struct socket;
38struct iscsi_transport;
39struct iscsi_cls_session;
40struct iscsi_cls_conn;
41struct iscsi_session;
42struct iscsi_nopin;
43
44/* #define DEBUG_SCSI */
45#ifdef DEBUG_SCSI
be2df72e 46#define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
7996a778
MC
47#else
48#define debug_scsi(fmt...)
49#endif
50
51#define ISCSI_XMIT_CMDS_MAX 128 /* must be power of 2 */
52#define ISCSI_MGMT_CMDS_MAX 32 /* must be power of 2 */
53#define ISCSI_CONN_MAX 1
54
55#define ISCSI_MGMT_ITT_OFFSET 0xa00
56
57#define ISCSI_DEF_CMD_PER_LUN 32
58#define ISCSI_MAX_CMD_PER_LUN 128
59
60/* Task Mgmt states */
61#define TMABORT_INITIAL 0x0
62#define TMABORT_SUCCESS 0x1
63#define TMABORT_FAILED 0x2
64#define TMABORT_TIMEDOUT 0x3
7ea8b828 65#define TMABORT_NOT_FOUND 0x4
7996a778
MC
66
67/* Connection suspend "bit" */
68#define ISCSI_SUSPEND_BIT 1
69
70#define ISCSI_ITT_MASK (0xfff)
71#define ISCSI_CID_SHIFT 12
72#define ISCSI_CID_MASK (0xffff << ISCSI_CID_SHIFT)
73#define ISCSI_AGE_SHIFT 28
74#define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
75
76struct iscsi_mgmt_task {
77 /*
78 * Becuae LLDs allocate their hdr differently, this is a pointer to
79 * that storage. It must be setup at session creation time.
80 */
81 struct iscsi_hdr *hdr;
82 char *data; /* mgmt payload */
857ae0bd 83 unsigned data_count; /* counts data to be sent */
7996a778
MC
84 uint32_t itt; /* this ITT */
85 void *dd_data; /* driver/transport data */
86 struct list_head running;
87};
88
b6c395ed
MC
89enum {
90 ISCSI_TASK_COMPLETED,
91 ISCSI_TASK_PENDING,
92 ISCSI_TASK_RUNNING,
93};
94
7996a778
MC
95struct iscsi_cmd_task {
96 /*
97 * Becuae LLDs allocate their hdr differently, this is a pointer to
98 * that storage. It must be setup at session creation time.
99 */
100 struct iscsi_cmd *hdr;
101 int itt; /* this ITT */
7996a778
MC
102
103 uint32_t unsol_datasn;
857ae0bd
MC
104 unsigned imm_count; /* imm-data (bytes) */
105 unsigned unsol_count; /* unsolicited (bytes)*/
ffd0436e 106 /* offset in unsolicited stream (bytes); */
857ae0bd
MC
107 unsigned unsol_offset;
108 unsigned data_count; /* remaining Data-Out */
7996a778 109 struct scsi_cmnd *sc; /* associated SCSI cmd*/
7996a778
MC
110 struct iscsi_conn *conn; /* used connection */
111 struct iscsi_mgmt_task *mtask; /* tmf mtask in progr */
112
b6c395ed
MC
113 /* state set/tested under session->lock */
114 int state;
60ecebf5 115 atomic_t refcount;
7996a778
MC
116 struct list_head running; /* running cmd list */
117 void *dd_data; /* driver/transport data */
118};
119
120struct iscsi_conn {
121 struct iscsi_cls_conn *cls_conn; /* ptr to class connection */
122 void *dd_data; /* iscsi_transport data */
123 struct iscsi_session *session; /* parent session */
124 /*
125 * LLDs should set this lock. It protects the transport recv
126 * code
127 */
128 rwlock_t *recv_lock;
129 /*
130 * conn_stop() flag: stop to recover, stop to terminate
131 */
132 int stop_stage;
133
134 /* iSCSI connection-wide sequencing */
135 uint32_t exp_statsn;
136
137 /* control data */
138 int id; /* CID */
7996a778 139 int c_stage; /* connection state */
c8dc1e52
MC
140 /*
141 * Preallocated buffer for pdus that have data but do not
142 * originate from scsi-ml. We never have two pdus using the
143 * buffer at the same time. It is only allocated to
144 * the default max recv size because the pdus we support
145 * should always fit in this buffer
146 */
147 char *data;
7996a778
MC
148 struct iscsi_mgmt_task *login_mtask; /* mtask used for login/text */
149 struct iscsi_mgmt_task *mtask; /* xmit mtask in progress */
150 struct iscsi_cmd_task *ctask; /* xmit ctask in progress */
151
152 /* xmit */
153 struct kfifo *immqueue; /* immediate xmit queue */
154 struct kfifo *mgmtqueue; /* mgmt (control) xmit queue */
155 struct list_head mgmt_run_list; /* list of control tasks */
b6c395ed 156 struct list_head xmitqueue; /* data-path cmd queue */
7996a778
MC
157 struct list_head run_list; /* list of cmds in progress */
158 struct work_struct xmitwork; /* per-conn. xmit workqueue */
159 /*
160 * serializes connection xmit, access to kfifos:
161 * xmitqueue, immqueue, mgmtqueue
162 */
163 struct mutex xmitmutex;
164
165 unsigned long suspend_tx; /* suspend Tx */
166 unsigned long suspend_rx; /* suspend Rx */
167
168 /* abort */
169 wait_queue_head_t ehwait; /* used in eh_abort() */
170 struct iscsi_tm tmhdr;
171 struct timer_list tmabort_timer;
172 int tmabort_state; /* see TMABORT_INITIAL, etc.*/
173
174 /* negotiated params */
857ae0bd
MC
175 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
176 unsigned max_xmit_dlength; /* target_max_recv_dsl */
7996a778
MC
177 int hdrdgst_en;
178 int datadgst_en;
a54a52ca
MC
179 int ifmarker_en;
180 int ofmarker_en;
181 /* values userspace uses to id a conn */
182 int persistent_port;
183 char *persistent_address;
7996a778
MC
184
185 /* MIB-statistics */
186 uint64_t txdata_octets;
187 uint64_t rxdata_octets;
188 uint32_t scsicmd_pdus_cnt;
189 uint32_t dataout_pdus_cnt;
190 uint32_t scsirsp_pdus_cnt;
191 uint32_t datain_pdus_cnt;
192 uint32_t r2t_pdus_cnt;
193 uint32_t tmfcmd_pdus_cnt;
194 int32_t tmfrsp_pdus_cnt;
195
196 /* custom statistics */
197 uint32_t eh_abort_cnt;
198};
199
200struct iscsi_queue {
201 struct kfifo *queue; /* FIFO Queue */
202 void **pool; /* Pool of elements */
203 int max; /* Max number of elements */
204};
205
206struct iscsi_session {
207 /* iSCSI session-wide sequencing */
208 uint32_t cmdsn;
209 uint32_t exp_cmdsn;
210 uint32_t max_cmdsn;
211
212 /* configuration */
213 int initial_r2t_en;
857ae0bd 214 unsigned max_r2t;
7996a778 215 int imm_data_en;
857ae0bd
MC
216 unsigned first_burst;
217 unsigned max_burst;
7996a778
MC
218 int time2wait;
219 int time2retain;
220 int pdu_inorder_en;
221 int dataseq_inorder_en;
222 int erl;
a54a52ca 223 int tpgt;
b2c64167
MC
224 char *username;
225 char *username_in;
226 char *password;
227 char *password_in;
a54a52ca 228 char *targetname;
8ad5781a 229 char *initiatorname;
0801c242
MC
230 /* hw address being used for iscsi connection */
231 char *hwaddress;
7996a778
MC
232 /* control data */
233 struct iscsi_transport *tt;
234 struct Scsi_Host *host;
235 struct iscsi_conn *leadconn; /* leading connection */
236 spinlock_t lock; /* protects session state, *
237 * sequence numbers, *
238 * session resources: *
239 * - cmdpool, *
240 * - mgmtpool, *
241 * - r2tpool */
242 int state; /* session state */
7996a778
MC
243 int age; /* counts session re-opens */
244
7996a778
MC
245 int cmds_max; /* size of cmds array */
246 struct iscsi_cmd_task **cmds; /* Original Cmds arr */
247 struct iscsi_queue cmdpool; /* PDU's pool */
248 int mgmtpool_max; /* size of mgmt array */
249 struct iscsi_mgmt_task **mgmt_cmds; /* Original mgmt arr */
250 struct iscsi_queue mgmtpool; /* Mgmt PDU's pool */
251};
252
253/*
254 * scsi host template
255 */
256extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
257extern int iscsi_eh_abort(struct scsi_cmnd *sc);
258extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
259extern int iscsi_queuecommand(struct scsi_cmnd *sc,
260 void (*done)(struct scsi_cmnd *));
0801c242
MC
261
262
263/*
264 * iSCSI host helpers.
265 */
266extern int iscsi_host_set_param(struct Scsi_Host *shost,
267 enum iscsi_host_param param, char *buf,
268 int buflen);
269extern int iscsi_host_get_param(struct Scsi_Host *shost,
270 enum iscsi_host_param param, char *buf);
7996a778
MC
271
272/*
273 * session management
274 */
275extern struct iscsi_cls_session *
276iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
277 int, int, uint32_t, uint32_t *);
278extern void iscsi_session_teardown(struct iscsi_cls_session *);
279extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *);
7996a778 280extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
a54a52ca
MC
281extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
282 enum iscsi_param param, char *buf, int buflen);
283extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
284 enum iscsi_param param, char *buf);
7996a778
MC
285
286#define session_to_cls(_sess) \
287 hostdata_session(_sess->host->hostdata)
288
289/*
290 * connection management
291 */
292extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
293 uint32_t);
294extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
295extern int iscsi_conn_start(struct iscsi_cls_conn *);
296extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
297extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
298 int);
299extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
a54a52ca
MC
300extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
301 enum iscsi_param param, char *buf);
7996a778
MC
302
303/*
304 * pdu and task processing
305 */
306extern int iscsi_check_assign_cmdsn(struct iscsi_session *,
307 struct iscsi_nopin *);
308extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
ffd0436e 309 struct iscsi_data *hdr);
7996a778
MC
310extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
311 char *, uint32_t);
312extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
313 char *, int);
314extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
315 char *, int);
316extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
317 uint32_t *);
318
319/*
320 * generic helpers
321 */
322extern void iscsi_pool_free(struct iscsi_queue *, void **);
323extern int iscsi_pool_init(struct iscsi_queue *, int, void ***, int);
324
325#endif