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