a084e9d5642fff040e42fa9300fc15c213ffd2ff
[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         /* Both 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         /* Protected by cmd_list_lock */
142         struct list_head cmd_list; /* in/outcoming pdus */
143
144         atomic_t conn_ref_cnt;
145
146         spinlock_t write_list_lock;
147         /* List of data pdus to be sent, protected by write_list_lock */
148         struct list_head write_list; 
149
150         /* All 2 protected by iscsi_wr_lock */
151         unsigned short wr_state;
152         unsigned short wr_space_ready:1;
153
154         struct list_head wr_list_entry;
155
156 #ifdef EXTRACHECKS
157         struct task_struct *wr_task;
158 #endif
159
160         /* All are unprotected, since accessed only from a single write thread */
161         struct iscsi_cmnd *write_cmnd;
162         struct iovec *write_iop;
163         int write_iop_used;
164         struct iovec write_iov[2];
165         u32 write_size;
166         u32 write_offset;
167         int write_state;
168
169         /* Both don't need any protection */
170         struct file *file;
171         struct socket *sock;
172
173         void (*old_state_change)(struct sock *);
174         void (*old_data_ready)(struct sock *, int);
175         void (*old_write_space)(struct sock *);
176
177         /* Both read only */
178         int hdigest_type;
179         int ddigest_type;
180
181         /* All 4 protected by iscsi_rd_lock */
182         unsigned short rd_state;
183         unsigned short rd_data_ready:1;
184         unsigned short closing:1; /* Let's save some cache footprint by putting it here */
185
186         struct list_head rd_list_entry;
187
188 #ifdef EXTRACHECKS
189         struct task_struct *rd_task;
190 #endif
191
192         /* All are unprotected, since accessed only from a single read thread */
193         struct iscsi_cmnd *read_cmnd;
194         struct msghdr read_msg;
195         u32 read_size;
196         int read_state;
197         struct iovec *read_iov;
198
199         struct iscsi_target *target;
200
201         struct list_head conn_list_entry;       /* list entry in session conn_list */
202
203         /* Doesn't need any protection */
204         u16 cid;
205 };
206
207 struct iscsi_pdu {
208         struct iscsi_hdr bhs;
209         void *ahs;
210         unsigned int ahssize;
211         unsigned int datasize;
212 };
213
214 typedef void (iscsi_show_info_t)(struct seq_file *seq, struct iscsi_target *target);
215
216 /* Command's states */
217 #define ISCSI_CMD_STATE_NEW               0     /* New command and SCST processes it */
218 #define ISCSI_CMD_STATE_RX_CMD            1     /* SCST processes cmd after scst_rx_cmd() */
219 #define ISCSI_CMD_STATE_AFTER_PREPROC     2     /* The command returned from preprocessing_done() */
220 #define ISCSI_CMD_STATE_RESTARTED         3     /* scst_restart_cmd() called and SCST processing it */
221 #define ISCSI_CMD_STATE_PROCESSED         4     /* SCST done processing */
222
223 /* 
224  * Most of the fields don't need any protection, since accessed from only a
225  * single thread, except where noted.
226  */
227 struct iscsi_cmnd {
228         struct iscsi_conn *conn;
229
230         /* Some flags protected by conn->write_list_lock */
231         unsigned int hashed:1;
232         unsigned int should_close_conn:1;
233         unsigned int pending:1;
234         unsigned int own_sg:1;
235         unsigned int on_write_list:1;
236         unsigned int write_processing_started:1;
237         unsigned int data_waiting:1;
238         unsigned int force_cleanup_done:1;
239         unsigned int dec_active_cmnds:1;
240         unsigned int ddigest_checked:1;
241 #ifdef EXTRACHECKS
242         unsigned int on_rx_digest_list:1;
243         unsigned int release_called:1;
244 #endif
245
246         unsigned long tmfabort; /* it's async. with the above flags */
247
248         struct list_head hash_list_entry;
249
250         spinlock_t rsp_cmd_lock; /* BH lock */
251
252         /* Unions are for readability and grepability */
253
254         union {
255                 /* Protected by rsp_cmd_lock */
256                 struct list_head rsp_cmd_list;
257                 struct list_head rsp_cmd_list_entry;
258         };
259
260         union {
261                 struct list_head pending_list_entry;
262                 struct list_head write_list_entry;
263         };
264
265         /*
266          * Unprotected, since could be accessed from only a single 
267          * thread at time
268          */
269         struct list_head rx_ddigest_cmd_list;
270         struct list_head rx_ddigest_cmd_list_entry;
271
272         struct iscsi_cmnd *parent_req;
273         struct iscsi_cmnd *cmd_req;
274
275         struct iscsi_target *target;
276
277         wait_queue_head_t scst_waitQ;
278         int scst_state;
279         struct scst_cmd *scst_cmd;
280         atomic_t ref_cnt;
281 #ifdef NET_PAGE_CALLBACKS_DEFINED
282         atomic_t net_ref_cnt;
283 #endif
284
285         struct iscsi_pdu pdu;
286
287         struct scatterlist *sg;
288         int bufflen;
289         u32 r2t_sn;
290         u32 r2t_length;
291         u32 is_unsolicited_data;
292         u32 target_task_tag;
293         u32 outstanding_r2t;
294
295         u32 hdigest;
296         u32 ddigest;
297
298         int sg_cnt; /* valid only if own_sg is 1 */
299         struct list_head cmd_list_entry;
300 };
301
302 #define ISCSI_OP_SCSI_REJECT    ISCSI_OP_VENDOR1_CMD
303 #define ISCSI_OP_PDU_REJECT     ISCSI_OP_VENDOR2_CMD
304 #define ISCSI_OP_DATA_REJECT    ISCSI_OP_VENDOR3_CMD
305
306 /* Flags for req_cmnd_release_force() */
307 #define ISCSI_FORCE_RELEASE_WRITE       1
308
309 extern struct mutex target_mgmt_mutex;
310
311 extern struct file_operations ctr_fops;
312
313 extern spinlock_t iscsi_rd_lock;
314 extern struct list_head iscsi_rd_list;
315 extern wait_queue_head_t iscsi_rd_waitQ;
316
317 extern spinlock_t iscsi_wr_lock;
318 extern struct list_head iscsi_wr_list;
319 extern wait_queue_head_t iscsi_wr_waitQ;
320
321 /* iscsi.c */
322 extern struct iscsi_cmnd *cmnd_alloc(struct iscsi_conn *,
323         struct iscsi_cmnd *parent);
324 extern int cmnd_rx_start(struct iscsi_cmnd *);
325 extern void cmnd_rx_end(struct iscsi_cmnd *);
326 extern void cmnd_tx_start(struct iscsi_cmnd *);
327 extern void cmnd_tx_end(struct iscsi_cmnd *);
328 extern void req_cmnd_release(struct iscsi_cmnd *req);
329 extern void req_cmnd_release_force(struct iscsi_cmnd *req, int flags);
330 extern void rsp_cmnd_release(struct iscsi_cmnd *);
331 extern void cmnd_done(struct iscsi_cmnd *cmnd);
332 extern void conn_abort(struct iscsi_conn *conn);
333
334 /* conn.c */
335 extern struct iscsi_conn *conn_lookup(struct iscsi_session *, u16);
336 extern int conn_add(struct iscsi_session *, struct conn_info *);
337 extern int conn_del(struct iscsi_session *, struct conn_info *);
338 extern int conn_free(struct iscsi_conn *);
339 extern void mark_conn_closed(struct iscsi_conn *);
340 extern void iscsi_make_conn_wr_active(struct iscsi_conn *);
341 extern void conn_info_show(struct seq_file *, struct iscsi_session *);
342
343 /* nthread.c */
344 extern int iscsi_send(struct iscsi_conn *conn);
345 #ifdef NET_PAGE_CALLBACKS_DEFINED
346 extern void iscsi_get_page_callback(struct page *page);
347 extern void iscsi_put_page_callback(struct page *page);
348 #endif
349 extern int istrd(void *arg);
350 extern int istwr(void *arg);
351
352 /* target.c */
353 struct iscsi_target *target_lookup_by_id(u32);
354 extern int target_add(struct target_info *);
355 extern int target_del(u32 id);
356 extern void target_del_all(void);
357
358 /* config.c */
359 extern int iscsi_procfs_init(void);
360 extern void iscsi_procfs_exit(void);
361 extern int iscsi_info_show(struct seq_file *, iscsi_show_info_t *);
362
363 /* session.c */
364 extern struct file_operations session_seq_fops;
365 extern struct iscsi_session *session_lookup(struct iscsi_target *, u64);
366 extern int session_add(struct iscsi_target *, struct session_info *);
367 extern int session_del(struct iscsi_target *, u64);
368 extern int session_free(struct iscsi_session *session);
369
370 /* params.c */
371 extern int iscsi_param_set(struct iscsi_target *, struct iscsi_param_info *, int);
372
373 /* event.c */
374 extern int event_send(u32, u64, u32, u32, int);
375 extern int event_init(void);
376 extern void event_exit(void);
377
378 #define get_pgcnt(size, offset) ((((size) + ((offset) & ~PAGE_MASK)) + PAGE_SIZE - 1) >> PAGE_SHIFT)
379
380 static inline void iscsi_cmnd_get_length(struct iscsi_pdu *pdu)
381 {
382 #if defined(__BIG_ENDIAN)
383         pdu->ahssize = pdu->bhs.length.ahslength * 4;
384         pdu->datasize = pdu->bhs.length.datalength;
385 #elif defined(__LITTLE_ENDIAN)
386         pdu->ahssize = (pdu->bhs.length & 0xff) * 4;
387         pdu->datasize = be32_to_cpu(pdu->bhs.length & ~0xff);
388 #else
389 #error
390 #endif
391 }
392
393 static inline void iscsi_cmnd_set_length(struct iscsi_pdu *pdu)
394 {
395 #if defined(__BIG_ENDIAN)
396         pdu->bhs.length.ahslength = pdu->ahssize / 4;
397         pdu->bhs.length.datalength = pdu->datasize;
398 #elif defined(__LITTLE_ENDIAN)
399         pdu->bhs.length = cpu_to_be32(pdu->datasize) | (pdu->ahssize / 4);
400 #else
401 #error
402 #endif
403 }
404
405 extern struct scst_tgt_template iscsi_template;
406
407 /*
408  * Skip this command if result is not 0. Must be called under
409  * corresponding lock.
410  */
411 static inline bool cmnd_get_check(struct iscsi_cmnd *cmnd)
412 {
413         int r = atomic_inc_return(&cmnd->ref_cnt);
414         int res;
415         if (unlikely(r == 1)) {
416                 TRACE_DBG("cmnd %p is being destroyed", cmnd);
417                 atomic_dec(&cmnd->ref_cnt);
418                 res = 1;
419                 /* Necessary code is serialized by locks in cmnd_done() */
420         } else {
421                 TRACE_DBG("cmnd %p, new ref_cnt %d", cmnd,
422                         atomic_read(&cmnd->ref_cnt));
423                 res = 0;
424         }
425         return res;
426 }
427
428 static inline void cmnd_get(struct iscsi_cmnd *cmnd)
429 {
430         atomic_inc(&cmnd->ref_cnt);
431         TRACE_DBG("cmnd %p, new cmnd->ref_cnt %d", cmnd,
432                 atomic_read(&cmnd->ref_cnt));
433 }
434
435 static inline void cmnd_get_ordered(struct iscsi_cmnd *cmnd)
436 {
437         cmnd_get(cmnd);
438         smp_mb__after_atomic_inc();
439 }
440
441 static inline void cmnd_put(struct iscsi_cmnd *cmnd)
442 {
443         TRACE_DBG("cmnd %p, new ref_cnt %d", cmnd,
444                 atomic_read(&cmnd->ref_cnt)-1);
445         sBUG_ON(atomic_read(&cmnd->ref_cnt) == 0);
446         if (atomic_dec_and_test(&cmnd->ref_cnt))
447                 cmnd_done(cmnd);
448 }
449
450 /* conn->write_list_lock supposed to be locked */
451 static inline void cmd_add_on_write_list(struct iscsi_conn *conn,
452         struct iscsi_cmnd *cmnd)
453 {
454         TRACE_DBG("%p", cmnd);
455         list_add_tail(&cmnd->write_list_entry, &conn->write_list);
456         cmnd->on_write_list = 1;
457 }
458
459 /* conn->write_list_lock supposed to be locked */
460 static inline void cmd_del_from_write_list(struct iscsi_cmnd *cmnd)
461 {
462         TRACE_DBG("%p", cmnd);
463         list_del(&cmnd->write_list_entry);
464         cmnd->on_write_list = 0;
465 }
466
467 static inline void cmd_add_on_rx_ddigest_list(struct iscsi_cmnd *req,
468         struct iscsi_cmnd *cmnd)
469 {
470         TRACE_DBG("Adding RX ddigest cmd %p to digest list "
471                         "of req %p", cmnd, req);
472         list_add_tail(&cmnd->rx_ddigest_cmd_list_entry,
473                         &req->rx_ddigest_cmd_list);
474 #ifdef EXTRACHECKS
475         cmnd->on_rx_digest_list = 1;
476 #endif
477 }
478
479 static inline void cmd_del_from_rx_ddigest_list(struct iscsi_cmnd *cmnd)
480 {
481         TRACE_DBG("Deleting RX digest cmd %p from digest list", cmnd);
482         list_del(&cmnd->rx_ddigest_cmd_list_entry);
483 #ifdef EXTRACHECKS
484         cmnd->on_rx_digest_list = 0;
485 #endif
486 }
487
488 static inline int test_write_ready(struct iscsi_conn *conn)
489 {
490         /*
491          * No need for write_list protection, in the worst case we will be
492          * restarted again.
493          */
494         return (!list_empty(&conn->write_list) || conn->write_cmnd);
495 }
496
497 static inline void conn_get(struct iscsi_conn *conn)
498 {
499         atomic_inc(&conn->conn_ref_cnt);
500         TRACE_DBG("conn %p, new conn_ref_cnt %d", conn,
501                 atomic_read(&conn->conn_ref_cnt));
502 }
503
504 static inline void conn_get_ordered(struct iscsi_conn *conn)
505 {
506         conn_get(conn);
507         smp_mb__after_atomic_inc();
508 }
509
510 static inline void conn_put(struct iscsi_conn *conn)
511 {
512         TRACE_DBG("conn %p, new conn_ref_cnt %d", conn,
513                 atomic_read(&conn->conn_ref_cnt)-1);
514         sBUG_ON(atomic_read(&conn->conn_ref_cnt) == 0);
515
516         /* 
517          * It always ordered to protect from undesired side effects like
518          * accessing just destroyed object because of this *_dec() reordering.
519          */
520         smp_mb__before_atomic_dec();
521         atomic_dec(&conn->conn_ref_cnt);
522 }
523
524 #ifdef EXTRACHECKS
525 extern void iscsi_extracheck_is_rd_thread(struct iscsi_conn *conn);
526 extern void iscsi_extracheck_is_wr_thread(struct iscsi_conn *conn);
527 #else
528 static inline void iscsi_extracheck_is_rd_thread(struct iscsi_conn *conn) {}
529 static inline void iscsi_extracheck_is_wr_thread(struct iscsi_conn *conn) {}
530 #endif
531
532 #endif  /* __ISCSI_H__ */