1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23#ifndef LIBISCSI_H
24#define LIBISCSI_H
25
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 <linux/kfifo.h>
32#include <scsi/iscsi_proto.h>
33#include <scsi/iscsi_if.h>
34#include <scsi/scsi_transport_iscsi.h>
35
36struct scsi_transport_template;
37struct scsi_host_template;
38struct scsi_device;
39struct Scsi_Host;
40struct scsi_target;
41struct scsi_cmnd;
42struct socket;
43struct iscsi_transport;
44struct iscsi_cls_session;
45struct iscsi_cls_conn;
46struct iscsi_session;
47struct iscsi_nopin;
48struct device;
49
50#define ISCSI_DEF_XMIT_CMDS_MAX 128
51#define ISCSI_MGMT_CMDS_MAX 15
52
53#define ISCSI_DEF_CMD_PER_LUN 32
54
55
56enum {
57 TMF_INITIAL,
58 TMF_QUEUED,
59 TMF_SUCCESS,
60 TMF_FAILED,
61 TMF_TIMEDOUT,
62 TMF_NOT_FOUND,
63};
64
65
66#define ISCSI_SUSPEND_BIT 1
67
68#define ISCSI_ITT_MASK 0x1fff
69#define ISCSI_TOTAL_CMDS_MAX 4096
70
71#define ISCSI_TOTAL_CMDS_MIN 16
72#define ISCSI_AGE_SHIFT 28
73#define ISCSI_AGE_MASK 0xf
74
75#define ISCSI_ADDRESS_BUF_LEN 64
76
77enum {
78
79 ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
80 sizeof(struct iscsi_rlength_ahdr),
81 ISCSI_DIGEST_SIZE = sizeof(__u32),
82};
83
84
85enum {
86 ISCSI_TASK_FREE,
87 ISCSI_TASK_COMPLETED,
88 ISCSI_TASK_PENDING,
89 ISCSI_TASK_RUNNING,
90 ISCSI_TASK_ABRT_TMF,
91 ISCSI_TASK_ABRT_SESS_RECOV,
92 ISCSI_TASK_REQUEUE_SCSIQ,
93};
94
95struct iscsi_r2t_info {
96 __be32 ttt;
97 __be32 exp_statsn;
98 uint32_t data_length;
99 uint32_t data_offset;
100 int data_count;
101 int datasn;
102
103 int sent;
104};
105
106struct iscsi_task {
107
108
109
110
111
112 struct iscsi_hdr *hdr;
113 unsigned short hdr_max;
114 unsigned short hdr_len;
115
116 itt_t hdr_itt;
117 __be32 cmdsn;
118 struct scsi_lun lun;
119
120 int itt;
121
122 unsigned imm_count;
123
124 struct iscsi_r2t_info unsol_r2t;
125 char *data;
126 unsigned data_count;
127 struct scsi_cmnd *sc;
128 struct iscsi_conn *conn;
129
130
131 unsigned long last_xfer;
132 unsigned long last_timeout;
133 bool have_checked_conn;
134
135 int state;
136 atomic_t refcount;
137 struct list_head running;
138 void *dd_data;
139};
140
141static inline int iscsi_task_has_unsol_data(struct iscsi_task *task)
142{
143 return task->unsol_r2t.data_length > task->unsol_r2t.sent;
144}
145
146static inline void* iscsi_next_hdr(struct iscsi_task *task)
147{
148 return (void*)task->hdr + task->hdr_len;
149}
150
151
152enum {
153 ISCSI_CONN_INITIAL_STAGE,
154 ISCSI_CONN_STARTED,
155 ISCSI_CONN_STOPPED,
156 ISCSI_CONN_CLEANUP_WAIT,
157};
158
159struct iscsi_conn {
160 struct iscsi_cls_conn *cls_conn;
161 void *dd_data;
162 struct iscsi_session *session;
163
164
165
166 int stop_stage;
167 struct timer_list transport_timer;
168 unsigned long last_recv;
169 unsigned long last_ping;
170 int ping_timeout;
171 int recv_timeout;
172 struct iscsi_task *ping_task;
173
174
175 uint32_t exp_statsn;
176
177
178 int id;
179 int c_stage;
180
181
182
183
184
185
186
187 char *data;
188 struct iscsi_task *login_task;
189 struct iscsi_task *task;
190
191
192 struct list_head mgmtqueue;
193 struct list_head cmdqueue;
194 struct list_head requeue;
195 struct work_struct xmitwork;
196 unsigned long suspend_tx;
197 unsigned long suspend_rx;
198
199
200 wait_queue_head_t ehwait;
201 struct iscsi_tm tmhdr;
202 struct timer_list tmf_timer;
203 int tmf_state;
204
205
206 unsigned max_recv_dlength;
207 unsigned max_xmit_dlength;
208 int hdrdgst_en;
209 int datadgst_en;
210 int ifmarker_en;
211 int ofmarker_en;
212
213 int persistent_port;
214 char *persistent_address;
215
216
217 uint64_t txdata_octets;
218 uint64_t rxdata_octets;
219 uint32_t scsicmd_pdus_cnt;
220 uint32_t dataout_pdus_cnt;
221 uint32_t scsirsp_pdus_cnt;
222 uint32_t datain_pdus_cnt;
223 uint32_t r2t_pdus_cnt;
224 uint32_t tmfcmd_pdus_cnt;
225 int32_t tmfrsp_pdus_cnt;
226
227
228 uint32_t eh_abort_cnt;
229 uint32_t fmr_unalign_cnt;
230};
231
232struct iscsi_pool {
233 struct kfifo queue;
234 void **pool;
235 int max;
236};
237
238
239enum {
240 ISCSI_STATE_FREE = 1,
241 ISCSI_STATE_LOGGED_IN,
242 ISCSI_STATE_FAILED,
243 ISCSI_STATE_TERMINATE,
244 ISCSI_STATE_IN_RECOVERY,
245 ISCSI_STATE_RECOVERY_FAILED,
246 ISCSI_STATE_LOGGING_OUT,
247};
248
249struct iscsi_session {
250 struct iscsi_cls_session *cls_session;
251
252
253
254
255
256 struct mutex eh_mutex;
257
258
259 uint32_t cmdsn;
260 uint32_t exp_cmdsn;
261 uint32_t max_cmdsn;
262
263
264 uint32_t queued_cmdsn;
265
266
267 int abort_timeout;
268 int lu_reset_timeout;
269 int tgt_reset_timeout;
270 int initial_r2t_en;
271 unsigned short max_r2t;
272 int imm_data_en;
273 unsigned first_burst;
274 unsigned max_burst;
275 int time2wait;
276 int time2retain;
277 int pdu_inorder_en;
278 int dataseq_inorder_en;
279 int erl;
280 int fast_abort;
281 int tpgt;
282 char *username;
283 char *username_in;
284 char *password;
285 char *password_in;
286 char *targetname;
287 char *targetalias;
288 char *ifacename;
289 char *initiatorname;
290
291 struct iscsi_transport *tt;
292 struct Scsi_Host *host;
293 struct iscsi_conn *leadconn;
294 spinlock_t lock;
295
296
297
298
299
300 int state;
301 int age;
302
303 int scsi_cmds_max;
304 int cmds_max;
305 struct iscsi_task **cmds;
306 struct iscsi_pool cmdpool;
307 void *dd_data;
308};
309
310enum {
311 ISCSI_HOST_SETUP,
312 ISCSI_HOST_REMOVED,
313};
314
315struct iscsi_host {
316 char *initiatorname;
317
318 char *hwaddress;
319 char *netdev;
320
321 wait_queue_head_t session_removal_wq;
322
323 spinlock_t lock;
324 int num_sessions;
325 int state;
326
327 struct workqueue_struct *workq;
328 char workq_name[20];
329};
330
331
332
333
334extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth,
335 int reason);
336extern int iscsi_eh_abort(struct scsi_cmnd *sc);
337extern int iscsi_eh_recover_target(struct scsi_cmnd *sc);
338extern int iscsi_eh_session_reset(struct scsi_cmnd *sc);
339extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
340extern int iscsi_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *sc);
341
342
343
344
345#define iscsi_host_priv(_shost) \
346 (shost_priv(_shost) + sizeof(struct iscsi_host))
347
348extern int iscsi_host_set_param(struct Scsi_Host *shost,
349 enum iscsi_host_param param, char *buf,
350 int buflen);
351extern int iscsi_host_get_param(struct Scsi_Host *shost,
352 enum iscsi_host_param param, char *buf);
353extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev);
354extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht,
355 int dd_data_size,
356 bool xmit_can_sleep);
357extern void iscsi_host_remove(struct Scsi_Host *shost);
358extern void iscsi_host_free(struct Scsi_Host *shost);
359extern int iscsi_target_alloc(struct scsi_target *starget);
360
361
362
363
364extern struct iscsi_cls_session *
365iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost,
366 uint16_t, int, int, uint32_t, unsigned int);
367extern void iscsi_session_teardown(struct iscsi_cls_session *);
368extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
369extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
370 enum iscsi_param param, char *buf, int buflen);
371extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
372 enum iscsi_param param, char *buf);
373
374#define iscsi_session_printk(prefix, _sess, fmt, a...) \
375 iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
376
377
378
379
380extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
381 int, uint32_t);
382extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
383extern int iscsi_conn_start(struct iscsi_cls_conn *);
384extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
385extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
386 int);
387extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
388extern void iscsi_session_failure(struct iscsi_session *session,
389 enum iscsi_err err);
390extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
391 enum iscsi_param param, char *buf);
392extern int iscsi_conn_get_addr_param(struct sockaddr_storage *addr,
393 enum iscsi_param param, char *buf);
394extern void iscsi_suspend_tx(struct iscsi_conn *conn);
395extern void iscsi_suspend_queue(struct iscsi_conn *conn);
396extern void iscsi_conn_queue_work(struct iscsi_conn *conn);
397
398#define iscsi_conn_printk(prefix, _c, fmt, a...) \
399 iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \
400 fmt, ##a)
401
402
403
404
405extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
406extern void iscsi_prep_data_out_pdu(struct iscsi_task *task,
407 struct iscsi_r2t_info *r2t,
408 struct iscsi_data *hdr);
409extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
410 char *, uint32_t);
411extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
412 char *, int);
413extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
414 char *, int);
415extern int iscsi_verify_itt(struct iscsi_conn *, itt_t);
416extern struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *, itt_t);
417extern struct iscsi_task *iscsi_itt_to_task(struct iscsi_conn *, itt_t);
418extern void iscsi_requeue_task(struct iscsi_task *task);
419extern void iscsi_put_task(struct iscsi_task *task);
420extern void __iscsi_put_task(struct iscsi_task *task);
421extern void __iscsi_get_task(struct iscsi_task *task);
422extern void iscsi_complete_scsi_task(struct iscsi_task *task,
423 uint32_t exp_cmdsn, uint32_t max_cmdsn);
424
425
426
427
428extern void iscsi_pool_free(struct iscsi_pool *);
429extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
430
431
432
433
434static inline unsigned int
435iscsi_padded(unsigned int len)
436{
437 return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
438}
439
440static inline unsigned int
441iscsi_padding(unsigned int len)
442{
443 len &= (ISCSI_PAD_LEN - 1);
444 if (len)
445 len = ISCSI_PAD_LEN - len;
446 return len;
447}
448
449#endif
450