- Update to the latest IET r145
[mirror/scst/.git] / iscsi-scst / kernel / iscsi.h
1 /*
2  *  Copyright (C) 2002-2003 Ardis Technolgies <roman@ardistech.com>
3  *  Copyright (C) 2007 Vladislav Bolkhovitin
4  *  Copyright (C) 2007 CMS Distribution Limited
5  * 
6  *  This program is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU General Public License
8  *  as published by the Free Software Foundation, version 2
9  *  of the License.
10  * 
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  *  GNU General Public License for more details.
15  */
16
17 #ifndef __ISCSI_H__
18 #define __ISCSI_H__
19
20 #include <linux/pagemap.h>
21 #include <linux/seq_file.h>
22 #include <linux/mm.h>
23 #include <linux/net.h>
24 #include <net/sock.h>
25
26 #include <scsi_tgt.h>
27
28 #include "iscsi_hdr.h"
29 #include "iscsi_u.h"
30
31 #include "iscsi_dbg.h"
32
33 #define iscsi_sense_crc_error           ABORTED_COMMAND, 0x47, 0x5
34
35 struct iscsi_sess_param {
36         int initial_r2t;
37         int immediate_data;
38         int max_connections;
39         int max_recv_data_length;
40         int max_xmit_data_length;
41         int max_burst_length;
42         int first_burst_length;
43         int default_wait_time;
44         int default_retain_time;
45         int max_outstanding_r2t;
46         int data_pdu_inorder;
47         int data_sequence_inorder;
48         int error_recovery_level;
49         int header_digest;
50         int data_digest;
51         int ofmarker;
52         int ifmarker;
53         int ofmarkint;
54         int ifmarkint;
55 };
56
57 struct iscsi_trgt_param {
58         int queued_cmnds;
59 };
60
61 struct network_thread_info {
62         struct task_struct *task;
63         unsigned int ready;
64 };
65
66 struct iscsi_cmnd;
67
68 struct iscsi_target {
69         struct scst_tgt *scst_tgt;
70
71         struct mutex target_mutex;
72
73         struct list_head session_list; /* protected by target_mutex */
74
75         /* Both protected by target_mutex */
76         struct iscsi_sess_param trgt_sess_param;
77         struct iscsi_trgt_param trgt_param;
78
79         struct list_head target_list_entry;
80         u32 tid;
81         char name[ISCSI_NAME_LEN];
82 };
83
84 #define ISCSI_HASH_ORDER        8
85 #define cmnd_hashfn(itt)        hash_long((itt), ISCSI_HASH_ORDER)
86
87 struct iscsi_session {
88         struct iscsi_target *target;
89         struct scst_session *scst_sess;
90
91         /* Both unprotected, since accessed only from a single read thread */
92         struct list_head pending_list;
93         u32 next_ttt;
94
95         u32 max_queued_cmnds; /* unprotected, since read-only */
96         atomic_t active_cmds;
97
98         spinlock_t sn_lock;
99         u32 exp_cmd_sn; /* protected by sn_lock */
100
101         /* All 3 protected by sn_lock */
102         unsigned int tm_active:1;
103         u32 tm_sn;
104         struct iscsi_cmnd *tm_rsp;
105
106         /* read only, if there are connection(s) */
107         struct iscsi_sess_param sess_param;
108
109         spinlock_t cmnd_hash_lock;
110         struct list_head cmnd_hash[1 << ISCSI_HASH_ORDER];
111
112         struct list_head conn_list; /* protected by target_mutex */
113
114         struct list_head session_list_entry;
115
116         /* Bot don't need any protection */
117         char *initiator_name;
118         u64 sid;
119 };
120
121 #define ISCSI_CONN_IOV_MAX                      (PAGE_SIZE/sizeof(struct iovec))
122
123 #define ISCSI_CONN_RD_STATE_IDLE                0
124 #define ISCSI_CONN_RD_STATE_IN_LIST             1               
125 #define ISCSI_CONN_RD_STATE_PROCESSING          2
126
127 #define ISCSI_CONN_WR_STATE_IDLE                0
128 #define ISCSI_CONN_WR_STATE_IN_LIST             1
129 #define ISCSI_CONN_WR_STATE_SPACE_WAIT          2
130 #define ISCSI_CONN_WR_STATE_PROCESSING          3
131
132 struct iscsi_conn {
133         struct iscsi_session *session; /* owning session */
134
135         /* Both protected by session->sn_lock */
136         u32 stat_sn;
137         u32 exp_stat_sn;        
138
139         spinlock_t cmd_list_lock; /* BH lock */
140
141         /*
142          * IMPORTANT! If you find a cmd in cmd_list and immediately get_cmnd()
143          * it, it still can be destroyed immediately after you drop
144          * cmd_list_lock no matter how big is its ref_cnt!
145          */
146
147         /* Protected by cmd_list_lock */
148         struct list_head cmd_list; /* in/outcoming pdus */
149
150         atomic_t conn_ref_cnt;
151
152         spinlock_t write_list_lock;
153         /* List of data pdus to be sent, protected by write_list_lock */
154         struct list_head write_list; 
155
156         /* All 2 protected by iscsi_wr_lock */
157         unsigned short wr_state;
158         unsigned short wr_space_ready:1;
159
160         struct list_head wr_list_entry;
161
162 #ifdef EXTRACHECKS
163         struct task_struct *wr_task;
164 #endif
165
166         /* All are unprotected, since accessed only from a single write thread */
167         struct iscsi_cmnd *write_cmnd;
168         struct iovec *write_iop;
169         int write_iop_used;
170         struct iovec write_iov[2];
171         u32 write_size;
172         u32 write_offset;
173         int write_state;
174
175         /* Both don't need any protection */
176         struct file *file;
177         struct socket *sock;
178
179         void (*old_state_change)(struct sock *);
180         void (*old_data_ready)(struct sock *, int);
181         void (*old_write_space)(struct sock *);
182
183         /* Both read only */
184         int hdigest_type;
185         int ddigest_type;
186
187         /* All 4 protected by iscsi_rd_lock */
188         unsigned short rd_state;
189         unsigned short rd_data_ready:1;
190         unsigned short closing:1; /* Let's save some cache footprint by putting it here */
191
192         struct list_head rd_list_entry;
193
194 #ifdef EXTRACHECKS
195         struct task_struct *rd_task;
196 #endif
197
198         /* All are unprotected, since accessed only from a single read thread */
199         struct iscsi_cmnd *read_cmnd;
200         struct msghdr read_msg;
201         u32 read_size;
202         int read_state;
203         struct iovec *read_iov;
204
205         struct iscsi_target *target;
206
207         struct list_head conn_list_entry;       /* list entry in session conn_list */
208
209         /* Doesn't need any protection */
210         u16 cid;
211 };
212
213 struct iscsi_pdu {
214         struct iscsi_hdr bhs;
215         void *ahs;
216         unsigned int ahssize;
217         unsigned int datasize;
218 };
219
220 typedef void (iscsi_show_info_t)(struct seq_file *seq, struct iscsi_target *target);
221
222 /* Command's states */
223 #define ISCSI_CMD_STATE_NEW               0     /* New command and SCST processes it */
224 #define ISCSI_CMD_STATE_RX_CMD            1     /* SCST processes cmd after scst_rx_cmd() */
225 #define ISCSI_CMD_STATE_AFTER_PREPROC     2     /* The command returned from preprocessing_done() */
226 #define ISCSI_CMD_STATE_RESTARTED         3     /* scst_restart_cmd() called and SCST processing it */
227 #define ISCSI_CMD_STATE_PROCESSED         4     /* SCST done processing */
228
229 /* 
230  * Most of the fields don't need any protection, since accessed from only a
231  * single thread, except where noted.
232  */
233 struct iscsi_cmnd {
234         struct iscsi_conn *conn;
235
236         /* Some flags protected by conn->write_list_lock */
237         unsigned int hashed:1;
238         unsigned int should_close_conn:1;
239         unsigned int pending:1;
240         unsigned int own_sg:1;
241         unsigned int on_write_list:1;
242         unsigned int write_processing_started:1;
243         unsigned int data_waiting:1;
244         unsigned int force_cleanup_done:1;
245         unsigned int dec_active_cmnds:1;
246 #ifdef EXTRACHECKS
247         unsigned int release_called:1;
248 #endif
249
250         unsigned long tmfabort; /* it's async. with the above flags */
251
252         struct list_head hash_list_entry;
253
254         spinlock_t rsp_cmd_lock; /* BH lock */
255
256         /* Unions are for readability and grepability */
257
258         /*
259          * IMPORTANT! If you find a cmd in rsp_cmd_list and immediately
260          * get_cmnd() it, it still can be destroyed immediately after you drop
261          * rsp_cmd_lock no matter how big is its ref_cnt!
262          */
263
264         union {
265                 /* Protected by rsp_cmd_lock */
266                 struct list_head rsp_cmd_list;
267                 struct list_head rsp_cmd_list_entry;
268         };
269
270         union {
271                 struct list_head pending_list_entry;
272                 struct list_head write_list_entry;
273         };
274
275         /*
276          * Unprotected, since could be accessed from only a single 
277          * thread at time
278          */
279         struct list_head rx_ddigest_cmd_list;
280         struct list_head rx_ddigest_cmd_list_entry;
281
282         struct iscsi_cmnd *parent_req;
283         struct iscsi_cmnd *cmd_req;
284
285         struct iscsi_target *target;
286
287         wait_queue_head_t scst_waitQ;
288         int scst_state;
289         struct scst_cmd *scst_cmd;
290         atomic_t ref_cnt;
291 #ifdef NET_PAGE_CALLBACKS_DEFINED
292         atomic_t net_ref_cnt;
293 #endif
294
295         struct iscsi_pdu pdu;
296
297         struct scatterlist *sg;
298         int bufflen;
299         u32 r2t_sn;
300         u32 r2t_length;
301         u32 is_unsolicited_data;
302         u32 target_task_tag;
303         u32 outstanding_r2t;
304
305         u32 hdigest;
306         u32 ddigest;
307
308         int sg_cnt; /* valid only if own_sg is 1 */
309         struct list_head cmd_list_entry;
310 };
311
312 #define ISCSI_OP_SCSI_REJECT    ISCSI_OP_VENDOR1_CMD
313 #define ISCSI_OP_PDU_REJECT     ISCSI_OP_VENDOR2_CMD
314 #define ISCSI_OP_DATA_REJECT    ISCSI_OP_VENDOR3_CMD
315
316 /* Flags for req_cmnd_release_force() */
317 #define ISCSI_FORCE_RELEASE_WRITE       1
318
319 extern struct mutex target_mgmt_mutex;
320
321 extern struct file_operations ctr_fops;
322
323 extern spinlock_t iscsi_rd_lock;
324 extern struct list_head iscsi_rd_list;
325 extern wait_queue_head_t iscsi_rd_waitQ;
326
327 extern spinlock_t iscsi_wr_lock;
328 extern struct list_head iscsi_wr_list;
329 extern wait_queue_head_t iscsi_wr_waitQ;
330
331 /* iscsi.c */
332 extern struct iscsi_cmnd *cmnd_alloc(struct iscsi_conn *,
333         struct iscsi_cmnd *parent);
334 extern int cmnd_rx_start(struct iscsi_cmnd *);
335 extern void cmnd_rx_end(struct iscsi_cmnd *);
336 extern void cmnd_tx_start(struct iscsi_cmnd *);
337 extern void cmnd_tx_end(struct iscsi_cmnd *);
338 extern void req_cmnd_release(struct iscsi_cmnd *req);
339 extern void req_cmnd_release_force(struct iscsi_cmnd *req, int flags);
340 extern void rsp_cmnd_release(struct iscsi_cmnd *);
341 extern void cmnd_done(struct iscsi_cmnd *cmnd);
342 extern void conn_abort(struct iscsi_conn *conn);
343
344 /* conn.c */
345 extern struct iscsi_conn *conn_lookup(struct iscsi_session *, u16);
346 extern int conn_add(struct iscsi_session *, struct conn_info *);
347 extern int conn_del(struct iscsi_session *, struct conn_info *);
348 extern int conn_free(struct iscsi_conn *);
349 extern void mark_conn_closed(struct iscsi_conn *);
350 extern void iscsi_make_conn_wr_active(struct iscsi_conn *);
351 extern void conn_info_show(struct seq_file *, struct iscsi_session *);
352
353 /* nthread.c */
354 extern int iscsi_send(struct iscsi_conn *conn);
355 #ifdef NET_PAGE_CALLBACKS_DEFINED
356 extern void iscsi_get_page_callback(struct page *page);
357 extern void iscsi_put_page_callback(struct page *page);
358 #endif
359 extern int istrd(void *arg);
360 extern int istwr(void *arg);
361
362 /* target.c */
363 struct iscsi_target *target_lookup_by_id(u32);
364 extern int target_add(struct target_info *);
365 extern int target_del(u32 id);
366 extern void target_del_all(void);
367
368 /* config.c */
369 extern int iscsi_procfs_init(void);
370 extern void iscsi_procfs_exit(void);
371 extern int iscsi_info_show(struct seq_file *, iscsi_show_info_t *);
372
373 /* session.c */
374 extern struct file_operations session_seq_fops;
375 extern struct iscsi_session *session_lookup(struct iscsi_target *, u64);
376 extern int session_add(struct iscsi_target *, struct session_info *);
377 extern int session_del(struct iscsi_target *, u64);
378 extern int session_free(struct iscsi_session *session);
379
380 /* params.c */
381 extern int iscsi_param_set(struct iscsi_target *, struct iscsi_param_info *, int);
382
383 /* event.c */
384 extern int event_send(u32, u64, u32, u32, int);
385 extern int event_init(void);
386 extern void event_exit(void);
387
388 #define get_pgcnt(size, offset) ((((size) + ((offset) & ~PAGE_MASK)) + PAGE_SIZE - 1) >> PAGE_SHIFT)
389
390 static inline void iscsi_cmnd_get_length(struct iscsi_pdu *pdu)
391 {
392 #if defined(__BIG_ENDIAN)
393         pdu->ahssize = pdu->bhs.length.ahslength * 4;
394         pdu->datasize = pdu->bhs.length.datalength;
395 #elif defined(__LITTLE_ENDIAN)
396         pdu->ahssize = (pdu->bhs.length & 0xff) * 4;
397         pdu->datasize = be32_to_cpu(pdu->bhs.length & ~0xff);
398 #else
399 #error
400 #endif
401 }
402
403 static inline void iscsi_cmnd_set_length(struct iscsi_pdu *pdu)
404 {
405 #if defined(__BIG_ENDIAN)
406         pdu->bhs.length.ahslength = pdu->ahssize / 4;
407         pdu->bhs.length.datalength = pdu->datasize;
408 #elif defined(__LITTLE_ENDIAN)
409         pdu->bhs.length = cpu_to_be32(pdu->datasize) | (pdu->ahssize / 4);
410 #else
411 #error
412 #endif
413 }
414
415 extern struct scst_tgt_template iscsi_template;
416
417 static inline void cmnd_get(struct iscsi_cmnd *cmnd)
418 {
419         atomic_inc(&cmnd->ref_cnt);
420         TRACE_DBG("cmnd %p, new cmnd->ref_cnt %d", cmnd,
421                 atomic_read(&cmnd->ref_cnt));
422 }
423
424 static inline void cmnd_get_ordered(struct iscsi_cmnd *cmnd)
425 {
426         cmnd_get(cmnd);
427         smp_mb__after_atomic_inc();
428 }
429
430 static inline void cmnd_put(struct iscsi_cmnd *cmnd)
431 {
432         TRACE_DBG("cmnd %p, new cmnd->ref_cnt %d", cmnd,
433                 atomic_read(&cmnd->ref_cnt)-1);
434         sBUG_ON(atomic_read(&cmnd->ref_cnt) == 0);
435         if (atomic_dec_and_test(&cmnd->ref_cnt))
436                 cmnd_done(cmnd);
437 }
438
439 /* conn->write_list_lock supposed to be locked */
440 static inline void cmd_add_on_write_list(struct iscsi_conn *conn,
441         struct iscsi_cmnd *cmnd)
442 {
443         TRACE_DBG("%p", cmnd);
444         list_add_tail(&cmnd->write_list_entry, &conn->write_list);
445         cmnd->on_write_list = 1;
446 }
447
448 /* conn->write_list_lock supposed to be locked */
449 static inline void cmd_del_from_write_list(struct iscsi_cmnd *cmnd)
450 {
451         TRACE_DBG("%p", cmnd);
452         list_del(&cmnd->write_list_entry);
453         cmnd->on_write_list = 0;
454 }
455
456 static inline int test_write_ready(struct iscsi_conn *conn)
457 {
458         /*
459          * No need for write_list protection, in the worst case we will be
460          * restarted again.
461          */
462         return (!list_empty(&conn->write_list) || conn->write_cmnd);
463 }
464
465 static inline void conn_get(struct iscsi_conn *conn)
466 {
467         atomic_inc(&conn->conn_ref_cnt);
468         TRACE_DBG("conn %p, new conn_ref_cnt %d", conn,
469                 atomic_read(&conn->conn_ref_cnt));
470 }
471
472 static inline void conn_get_ordered(struct iscsi_conn *conn)
473 {
474         conn_get(conn);
475         smp_mb__after_atomic_inc();
476 }
477
478 static inline void conn_put(struct iscsi_conn *conn)
479 {
480         TRACE_DBG("conn %p, new conn_ref_cnt %d", conn,
481                 atomic_read(&conn->conn_ref_cnt)-1);
482         sBUG_ON(atomic_read(&conn->conn_ref_cnt) == 0);
483
484         /* 
485          * It always ordered to protect from undesired side effects like
486          * accessing just destroyed obeject because of this *_dec() reordering.
487          */
488         smp_mb__before_atomic_dec();
489         atomic_dec(&conn->conn_ref_cnt);
490 }
491
492 #ifdef EXTRACHECKS
493 #define iscsi_extracheck_is_rd_thread(conn) sBUG_ON(current != (conn)->rd_task)
494 #define iscsi_extracheck_is_wr_thread(conn) sBUG_ON(current != (conn)->wr_task)
495 #else
496 static inline void iscsi_extracheck_is_rd_thread(struct iscsi_conn *conn) {}
497 static inline void iscsi_extracheck_is_wr_thread(struct iscsi_conn *conn) {}
498 #endif
499
500 #endif  /* __ISCSI_H__ */