Commit | Line | Data |
---|---|---|
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> | |
40753caa | 27 | #include <linux/wait.h> |
7996a778 | 28 | #include <linux/mutex.h> |
f6a57033 AV |
29 | #include <linux/timer.h> |
30 | #include <linux/workqueue.h> | |
7996a778 MC |
31 | #include <scsi/iscsi_proto.h> |
32 | #include <scsi/iscsi_if.h> | |
262ef636 | 33 | #include <scsi/scsi_transport_iscsi.h> |
7996a778 MC |
34 | |
35 | struct scsi_transport_template; | |
a4804cd6 | 36 | struct scsi_host_template; |
7996a778 MC |
37 | struct scsi_device; |
38 | struct Scsi_Host; | |
6b5d6c44 | 39 | struct scsi_target; |
7996a778 MC |
40 | struct scsi_cmnd; |
41 | struct socket; | |
42 | struct iscsi_transport; | |
43 | struct iscsi_cls_session; | |
44 | struct iscsi_cls_conn; | |
45 | struct iscsi_session; | |
46 | struct iscsi_nopin; | |
a4804cd6 | 47 | struct device; |
7996a778 | 48 | |
1548271e | 49 | #define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */ |
3cf7b233 | 50 | #define ISCSI_MGMT_CMDS_MAX 15 |
7996a778 | 51 | |
e28f3d5b | 52 | #define ISCSI_DEF_CMD_PER_LUN 32 |
7996a778 MC |
53 | |
54 | /* Task Mgmt states */ | |
843c0a8a MC |
55 | enum { |
56 | TMF_INITIAL, | |
57 | TMF_QUEUED, | |
58 | TMF_SUCCESS, | |
59 | TMF_FAILED, | |
60 | TMF_TIMEDOUT, | |
61 | TMF_NOT_FOUND, | |
62 | }; | |
7996a778 MC |
63 | |
64 | /* Connection suspend "bit" */ | |
65 | #define ISCSI_SUSPEND_BIT 1 | |
66 | ||
262ef636 | 67 | #define ISCSI_ITT_MASK 0x1fff |
3cf7b233 MC |
68 | #define ISCSI_TOTAL_CMDS_MAX 4096 |
69 | /* this must be a power of two greater than ISCSI_MGMT_CMDS_MAX */ | |
70 | #define ISCSI_TOTAL_CMDS_MIN 16 | |
7996a778 | 71 | #define ISCSI_AGE_SHIFT 28 |
262ef636 | 72 | #define ISCSI_AGE_MASK 0xf |
7996a778 | 73 | |
22236961 MC |
74 | #define ISCSI_ADDRESS_BUF_LEN 64 |
75 | ||
da32dd68 | 76 | enum { |
004d6530 BH |
77 | /* this is the maximum possible storage for AHSs */ |
78 | ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) + | |
79 | sizeof(struct iscsi_rlength_ahdr), | |
da32dd68 OK |
80 | ISCSI_DIGEST_SIZE = sizeof(__u32), |
81 | }; | |
82 | ||
7996a778 | 83 | |
b6c395ed | 84 | enum { |
3bbaaad9 | 85 | ISCSI_TASK_FREE, |
b6c395ed MC |
86 | ISCSI_TASK_COMPLETED, |
87 | ISCSI_TASK_PENDING, | |
88 | ISCSI_TASK_RUNNING, | |
b3cd5050 MC |
89 | ISCSI_TASK_ABRT_TMF, /* aborted due to TMF */ |
90 | ISCSI_TASK_ABRT_SESS_RECOV, /* aborted due to session recovery */ | |
b6c395ed MC |
91 | }; |
92 | ||
577577da MC |
93 | struct iscsi_r2t_info { |
94 | __be32 ttt; /* copied from R2T */ | |
95 | __be32 exp_statsn; /* copied from R2T */ | |
96 | uint32_t data_length; /* copied from R2T */ | |
97 | uint32_t data_offset; /* copied from R2T */ | |
98 | int data_count; /* DATA-Out payload progress */ | |
99 | int datasn; | |
100 | /* LLDs should set/update these values */ | |
101 | int sent; /* R2T sequence progress */ | |
102 | }; | |
103 | ||
9c19a7d0 | 104 | struct iscsi_task { |
7996a778 | 105 | /* |
004d6530 BH |
106 | * Because LLDs allocate their hdr differently, this is a pointer |
107 | * and length to that storage. It must be setup at session | |
108 | * creation time. | |
7996a778 | 109 | */ |
577577da | 110 | struct iscsi_hdr *hdr; |
004d6530 BH |
111 | unsigned short hdr_max; |
112 | unsigned short hdr_len; /* accumulated size of hdr used */ | |
577577da MC |
113 | /* copied values in case we need to send tmfs */ |
114 | itt_t hdr_itt; | |
115 | __be32 cmdsn; | |
116 | uint8_t lun[8]; | |
117 | ||
7996a778 | 118 | int itt; /* this ITT */ |
7996a778 | 119 | |
857ae0bd | 120 | unsigned imm_count; /* imm-data (bytes) */ |
ffd0436e | 121 | /* offset in unsolicited stream (bytes); */ |
577577da | 122 | struct iscsi_r2t_info unsol_r2t; |
3e5c28ad | 123 | char *data; /* mgmt payload */ |
577577da | 124 | unsigned data_count; |
7996a778 | 125 | struct scsi_cmnd *sc; /* associated SCSI cmd*/ |
7996a778 | 126 | struct iscsi_conn *conn; /* used connection */ |
7996a778 | 127 | |
b6c395ed MC |
128 | /* state set/tested under session->lock */ |
129 | int state; | |
60ecebf5 | 130 | atomic_t refcount; |
7996a778 MC |
131 | struct list_head running; /* running cmd list */ |
132 | void *dd_data; /* driver/transport data */ | |
133 | }; | |
134 | ||
577577da MC |
135 | static inline int iscsi_task_has_unsol_data(struct iscsi_task *task) |
136 | { | |
137 | return task->unsol_r2t.data_length > task->unsol_r2t.sent; | |
138 | } | |
139 | ||
9c19a7d0 | 140 | static inline void* iscsi_next_hdr(struct iscsi_task *task) |
004d6530 | 141 | { |
9c19a7d0 | 142 | return (void*)task->hdr + task->hdr_len; |
004d6530 BH |
143 | } |
144 | ||
6eabafbe MC |
145 | /* Connection's states */ |
146 | enum { | |
147 | ISCSI_CONN_INITIAL_STAGE, | |
148 | ISCSI_CONN_STARTED, | |
149 | ISCSI_CONN_STOPPED, | |
150 | ISCSI_CONN_CLEANUP_WAIT, | |
151 | }; | |
152 | ||
7996a778 MC |
153 | struct iscsi_conn { |
154 | struct iscsi_cls_conn *cls_conn; /* ptr to class connection */ | |
155 | void *dd_data; /* iscsi_transport data */ | |
156 | struct iscsi_session *session; /* parent session */ | |
7996a778 MC |
157 | /* |
158 | * conn_stop() flag: stop to recover, stop to terminate | |
159 | */ | |
160 | int stop_stage; | |
f6d5180c MC |
161 | struct timer_list transport_timer; |
162 | unsigned long last_recv; | |
163 | unsigned long last_ping; | |
164 | int ping_timeout; | |
165 | int recv_timeout; | |
9c19a7d0 | 166 | struct iscsi_task *ping_task; |
7996a778 MC |
167 | |
168 | /* iSCSI connection-wide sequencing */ | |
169 | uint32_t exp_statsn; | |
170 | ||
171 | /* control data */ | |
172 | int id; /* CID */ | |
7996a778 | 173 | int c_stage; /* connection state */ |
c8dc1e52 MC |
174 | /* |
175 | * Preallocated buffer for pdus that have data but do not | |
176 | * originate from scsi-ml. We never have two pdus using the | |
177 | * buffer at the same time. It is only allocated to | |
178 | * the default max recv size because the pdus we support | |
179 | * should always fit in this buffer | |
180 | */ | |
181 | char *data; | |
9c19a7d0 MC |
182 | struct iscsi_task *login_task; /* mtask used for login/text */ |
183 | struct iscsi_task *task; /* xmit task in progress */ | |
7996a778 MC |
184 | |
185 | /* xmit */ | |
843c0a8a | 186 | struct list_head mgmtqueue; /* mgmt (control) xmit queue */ |
3bbaaad9 | 187 | struct list_head cmdqueue; /* data-path cmd queue */ |
843c0a8a | 188 | struct list_head requeue; /* tasks needing another run */ |
7996a778 | 189 | struct work_struct xmitwork; /* per-conn. xmit workqueue */ |
7996a778 MC |
190 | unsigned long suspend_tx; /* suspend Tx */ |
191 | unsigned long suspend_rx; /* suspend Rx */ | |
192 | ||
193 | /* abort */ | |
194 | wait_queue_head_t ehwait; /* used in eh_abort() */ | |
195 | struct iscsi_tm tmhdr; | |
843c0a8a MC |
196 | struct timer_list tmf_timer; |
197 | int tmf_state; /* see TMF_INITIAL, etc.*/ | |
7996a778 MC |
198 | |
199 | /* negotiated params */ | |
857ae0bd MC |
200 | unsigned max_recv_dlength; /* initiator_max_recv_dsl*/ |
201 | unsigned max_xmit_dlength; /* target_max_recv_dsl */ | |
7996a778 MC |
202 | int hdrdgst_en; |
203 | int datadgst_en; | |
a54a52ca MC |
204 | int ifmarker_en; |
205 | int ofmarker_en; | |
206 | /* values userspace uses to id a conn */ | |
207 | int persistent_port; | |
208 | char *persistent_address; | |
22236961 MC |
209 | /* remote portal currently connected to */ |
210 | int portal_port; | |
211 | char portal_address[ISCSI_ADDRESS_BUF_LEN]; | |
7996a778 MC |
212 | |
213 | /* MIB-statistics */ | |
214 | uint64_t txdata_octets; | |
215 | uint64_t rxdata_octets; | |
216 | uint32_t scsicmd_pdus_cnt; | |
217 | uint32_t dataout_pdus_cnt; | |
218 | uint32_t scsirsp_pdus_cnt; | |
219 | uint32_t datain_pdus_cnt; | |
220 | uint32_t r2t_pdus_cnt; | |
221 | uint32_t tmfcmd_pdus_cnt; | |
222 | int32_t tmfrsp_pdus_cnt; | |
223 | ||
224 | /* custom statistics */ | |
225 | uint32_t eh_abort_cnt; | |
87528227 | 226 | uint32_t fmr_unalign_cnt; |
7996a778 MC |
227 | }; |
228 | ||
6320377f | 229 | struct iscsi_pool { |
7996a778 MC |
230 | struct kfifo *queue; /* FIFO Queue */ |
231 | void **pool; /* Pool of elements */ | |
232 | int max; /* Max number of elements */ | |
233 | }; | |
234 | ||
6eabafbe MC |
235 | /* Session's states */ |
236 | enum { | |
237 | ISCSI_STATE_FREE = 1, | |
238 | ISCSI_STATE_LOGGED_IN, | |
239 | ISCSI_STATE_FAILED, | |
240 | ISCSI_STATE_TERMINATE, | |
241 | ISCSI_STATE_IN_RECOVERY, | |
242 | ISCSI_STATE_RECOVERY_FAILED, | |
243 | ISCSI_STATE_LOGGING_OUT, | |
244 | }; | |
245 | ||
7996a778 | 246 | struct iscsi_session { |
75613521 | 247 | struct iscsi_cls_session *cls_session; |
6724add1 MC |
248 | /* |
249 | * Syncs up the scsi eh thread with the iscsi eh thread when sending | |
250 | * task management functions. This must be taken before the session | |
251 | * and recv lock. | |
252 | */ | |
253 | struct mutex eh_mutex; | |
254 | ||
7996a778 MC |
255 | /* iSCSI session-wide sequencing */ |
256 | uint32_t cmdsn; | |
257 | uint32_t exp_cmdsn; | |
258 | uint32_t max_cmdsn; | |
259 | ||
e0726407 MC |
260 | /* This tracks the reqs queued into the initiator */ |
261 | uint32_t queued_cmdsn; | |
262 | ||
7996a778 | 263 | /* configuration */ |
f6d5180c MC |
264 | int abort_timeout; |
265 | int lu_reset_timeout; | |
7996a778 | 266 | int initial_r2t_en; |
857ae0bd | 267 | unsigned max_r2t; |
7996a778 | 268 | int imm_data_en; |
857ae0bd MC |
269 | unsigned first_burst; |
270 | unsigned max_burst; | |
7996a778 MC |
271 | int time2wait; |
272 | int time2retain; | |
273 | int pdu_inorder_en; | |
274 | int dataseq_inorder_en; | |
275 | int erl; | |
843c0a8a | 276 | int fast_abort; |
a54a52ca | 277 | int tpgt; |
b2c64167 MC |
278 | char *username; |
279 | char *username_in; | |
280 | char *password; | |
281 | char *password_in; | |
a54a52ca | 282 | char *targetname; |
88dfd340 MC |
283 | char *ifacename; |
284 | char *initiatorname; | |
7996a778 MC |
285 | /* 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 */ | |
7996a778 MC |
296 | int age; /* counts session re-opens */ |
297 | ||
3e5c28ad | 298 | int scsi_cmds_max; /* max scsi commands */ |
7996a778 | 299 | int cmds_max; /* size of cmds array */ |
9c19a7d0 | 300 | struct iscsi_task **cmds; /* Original Cmds arr */ |
6320377f | 301 | struct iscsi_pool cmdpool; /* PDU's pool */ |
7996a778 MC |
302 | }; |
303 | ||
e5bd7b54 MC |
304 | enum { |
305 | ISCSI_HOST_SETUP, | |
306 | ISCSI_HOST_REMOVED, | |
307 | }; | |
308 | ||
75613521 MC |
309 | struct iscsi_host { |
310 | char *initiatorname; | |
311 | /* hw address or netdev iscsi connection is bound to */ | |
312 | char *hwaddress; | |
313 | char *netdev; | |
314 | /* local address */ | |
315 | int local_port; | |
316 | char local_address[ISCSI_ADDRESS_BUF_LEN]; | |
e5bd7b54 MC |
317 | |
318 | wait_queue_head_t session_removal_wq; | |
319 | /* protects sessions and state */ | |
320 | spinlock_t lock; | |
321 | int num_sessions; | |
322 | int state; | |
32ae763e MC |
323 | |
324 | struct workqueue_struct *workq; | |
325 | char workq_name[20]; | |
75613521 MC |
326 | }; |
327 | ||
7996a778 MC |
328 | /* |
329 | * scsi host template | |
330 | */ | |
331 | extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth); | |
332 | extern int iscsi_eh_abort(struct scsi_cmnd *sc); | |
8e124525 | 333 | extern int iscsi_eh_target_reset(struct scsi_cmnd *sc); |
843c0a8a | 334 | extern int iscsi_eh_device_reset(struct scsi_cmnd *sc); |
7996a778 MC |
335 | extern int iscsi_queuecommand(struct scsi_cmnd *sc, |
336 | void (*done)(struct scsi_cmnd *)); | |
0801c242 | 337 | |
0801c242 MC |
338 | /* |
339 | * iSCSI host helpers. | |
340 | */ | |
5d91e209 MC |
341 | #define iscsi_host_priv(_shost) \ |
342 | (shost_priv(_shost) + sizeof(struct iscsi_host)) | |
343 | ||
0801c242 MC |
344 | extern int iscsi_host_set_param(struct Scsi_Host *shost, |
345 | enum iscsi_host_param param, char *buf, | |
346 | int buflen); | |
347 | extern int iscsi_host_get_param(struct Scsi_Host *shost, | |
348 | enum iscsi_host_param param, char *buf); | |
a4804cd6 MC |
349 | extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev); |
350 | extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht, | |
4d108350 | 351 | int dd_data_size, |
32ae763e | 352 | bool xmit_can_sleep); |
a4804cd6 MC |
353 | extern void iscsi_host_remove(struct Scsi_Host *shost); |
354 | extern void iscsi_host_free(struct Scsi_Host *shost); | |
6b5d6c44 | 355 | extern int iscsi_target_alloc(struct scsi_target *starget); |
7996a778 MC |
356 | |
357 | /* | |
358 | * session management | |
359 | */ | |
360 | extern struct iscsi_cls_session * | |
75613521 | 361 | iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost, |
7970634b | 362 | uint16_t, int, uint32_t, unsigned int); |
7996a778 | 363 | extern void iscsi_session_teardown(struct iscsi_cls_session *); |
7996a778 | 364 | extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *); |
a54a52ca MC |
365 | extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn, |
366 | enum iscsi_param param, char *buf, int buflen); | |
367 | extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session, | |
368 | enum iscsi_param param, char *buf); | |
7996a778 | 369 | |
322d739d | 370 | #define iscsi_session_printk(prefix, _sess, fmt, a...) \ |
75613521 | 371 | iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a) |
322d739d | 372 | |
7996a778 MC |
373 | /* |
374 | * connection management | |
375 | */ | |
376 | extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *, | |
5d91e209 | 377 | int, uint32_t); |
7996a778 MC |
378 | extern void iscsi_conn_teardown(struct iscsi_cls_conn *); |
379 | extern int iscsi_conn_start(struct iscsi_cls_conn *); | |
380 | extern void iscsi_conn_stop(struct iscsi_cls_conn *, int); | |
381 | extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *, | |
382 | int); | |
383 | extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err); | |
40a06e75 | 384 | extern void iscsi_session_failure(struct iscsi_session *session, |
e5bd7b54 | 385 | enum iscsi_err err); |
a54a52ca MC |
386 | extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn, |
387 | enum iscsi_param param, char *buf); | |
5af3e91d | 388 | extern void iscsi_suspend_tx(struct iscsi_conn *conn); |
32ae763e | 389 | extern void iscsi_conn_queue_work(struct iscsi_conn *conn); |
7996a778 | 390 | |
322d739d | 391 | #define iscsi_conn_printk(prefix, _c, fmt, a...) \ |
5af3e91d MC |
392 | iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \ |
393 | fmt, ##a) | |
322d739d | 394 | |
7996a778 MC |
395 | /* |
396 | * pdu and task processing | |
397 | */ | |
77a23c21 | 398 | extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *); |
577577da MC |
399 | extern void iscsi_prep_data_out_pdu(struct iscsi_task *task, |
400 | struct iscsi_r2t_info *r2t, | |
401 | struct iscsi_data *hdr); | |
7996a778 MC |
402 | extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *, |
403 | char *, uint32_t); | |
404 | extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *, | |
405 | char *, int); | |
913e5bf4 MC |
406 | extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *, |
407 | char *, int); | |
0af967f5 | 408 | extern int iscsi_verify_itt(struct iscsi_conn *, itt_t); |
9c19a7d0 | 409 | extern struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *, itt_t); |
8f9256ce | 410 | extern struct iscsi_task *iscsi_itt_to_task(struct iscsi_conn *, itt_t); |
9c19a7d0 MC |
411 | extern void iscsi_requeue_task(struct iscsi_task *task); |
412 | extern void iscsi_put_task(struct iscsi_task *task); | |
913e5bf4 | 413 | extern void __iscsi_get_task(struct iscsi_task *task); |
7996a778 MC |
414 | |
415 | /* | |
416 | * generic helpers | |
417 | */ | |
6320377f OK |
418 | extern void iscsi_pool_free(struct iscsi_pool *); |
419 | extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int); | |
7996a778 | 420 | |
004d6530 BH |
421 | /* |
422 | * inline functions to deal with padding. | |
423 | */ | |
424 | static inline unsigned int | |
425 | iscsi_padded(unsigned int len) | |
426 | { | |
427 | return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1); | |
428 | } | |
429 | ||
430 | static inline unsigned int | |
431 | iscsi_padding(unsigned int len) | |
432 | { | |
433 | len &= (ISCSI_PAD_LEN - 1); | |
434 | if (len) | |
435 | len = ISCSI_PAD_LEN - len; | |
436 | return len; | |
437 | } | |
438 | ||
7996a778 | 439 | #endif |