[SCSI] add refcouting around ctask usage in main IO patch
[linux-2.6.git] / include / scsi / libiscsi.h
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>
27 #include <linux/mutex.h>
28 #include <scsi/iscsi_proto.h>
29 #include <scsi/iscsi_if.h>
30
31 struct scsi_transport_template;
32 struct scsi_device;
33 struct Scsi_Host;
34 struct scsi_cmnd;
35 struct socket;
36 struct iscsi_transport;
37 struct iscsi_cls_session;
38 struct iscsi_cls_conn;
39 struct iscsi_session;
40 struct iscsi_nopin;
41
42 /* #define DEBUG_SCSI */
43 #ifdef DEBUG_SCSI
44 #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
45 #else
46 #define debug_scsi(fmt...)
47 #endif
48
49 #define ISCSI_XMIT_CMDS_MAX     128     /* must be power of 2 */
50 #define ISCSI_MGMT_CMDS_MAX     32      /* must be power of 2 */
51 #define ISCSI_CONN_MAX                  1
52
53 #define ISCSI_MGMT_ITT_OFFSET   0xa00
54
55 #define ISCSI_DEF_CMD_PER_LUN           32
56 #define ISCSI_MAX_CMD_PER_LUN           128
57
58 /* Task Mgmt states */
59 #define TMABORT_INITIAL                 0x0
60 #define TMABORT_SUCCESS                 0x1
61 #define TMABORT_FAILED                  0x2
62 #define TMABORT_TIMEDOUT                0x3
63 #define TMABORT_NOT_FOUND               0x4
64
65 /* Connection suspend "bit" */
66 #define ISCSI_SUSPEND_BIT               1
67
68 #define ISCSI_ITT_MASK                  (0xfff)
69 #define ISCSI_CID_SHIFT                 12
70 #define ISCSI_CID_MASK                  (0xffff << ISCSI_CID_SHIFT)
71 #define ISCSI_AGE_SHIFT                 28
72 #define ISCSI_AGE_MASK                  (0xf << ISCSI_AGE_SHIFT)
73
74 struct iscsi_mgmt_task {
75         /*
76          * Becuae LLDs allocate their hdr differently, this is a pointer to
77          * that storage. It must be setup at session creation time.
78          */
79         struct iscsi_hdr        *hdr;
80         char                    *data;          /* mgmt payload */
81         int                     data_count;     /* counts data to be sent */
82         uint32_t                itt;            /* this ITT */
83         void                    *dd_data;       /* driver/transport data */
84         struct list_head        running;
85 };
86
87 enum {
88         ISCSI_TASK_COMPLETED,
89         ISCSI_TASK_PENDING,
90         ISCSI_TASK_RUNNING,
91 };
92
93 struct iscsi_cmd_task {
94         /*
95          * Becuae LLDs allocate their hdr differently, this is a pointer to
96          * that storage. It must be setup at session creation time.
97          */
98         struct iscsi_cmd        *hdr;
99         int                     itt;            /* this ITT */
100         int                     datasn;         /* DataSN */
101
102         uint32_t                unsol_datasn;
103         int                     imm_count;      /* imm-data (bytes)   */
104         int                     unsol_count;    /* unsolicited (bytes)*/
105         /* offset in unsolicited stream (bytes); */
106         int                     unsol_offset;
107         int                     data_count;     /* remaining Data-Out */
108         struct scsi_cmnd        *sc;            /* associated SCSI cmd*/
109         int                     total_length;
110         struct iscsi_conn       *conn;          /* used connection    */
111         struct iscsi_mgmt_task  *mtask;         /* tmf mtask in progr */
112
113         /* state set/tested under session->lock */
114         int                     state;
115         atomic_t                refcount;
116         struct list_head        running;        /* running cmd list */
117         void                    *dd_data;       /* driver/transport data */
118 };
119
120 struct iscsi_conn {
121         struct iscsi_cls_conn   *cls_conn;      /* ptr to class connection */
122         void                    *dd_data;       /* iscsi_transport data */
123         struct iscsi_session    *session;       /* parent session */
124         /*
125          * LLDs should set this lock. It protects the transport recv
126          * code
127          */
128         rwlock_t                *recv_lock;
129         /*
130          * conn_stop() flag: stop to recover, stop to terminate
131          */
132         int                     stop_stage;
133
134         /* iSCSI connection-wide sequencing */
135         uint32_t                exp_statsn;
136
137         /* control data */
138         int                     id;             /* CID */
139         struct list_head        item;           /* maintains list of conns */
140         int                     c_stage;        /* connection state */
141         /*
142          * Preallocated buffer for pdus that have data but do not
143          * originate from scsi-ml. We never have two pdus using the
144          * buffer at the same time. It is only allocated to
145          * the default max recv size because the pdus we support
146          * should always fit in this buffer
147          */
148         char                    *data;
149         struct iscsi_mgmt_task  *login_mtask;   /* mtask used for login/text */
150         struct iscsi_mgmt_task  *mtask;         /* xmit mtask in progress */
151         struct iscsi_cmd_task   *ctask;         /* xmit ctask in progress */
152
153         /* xmit */
154         struct kfifo            *immqueue;      /* immediate xmit queue */
155         struct kfifo            *mgmtqueue;     /* mgmt (control) xmit queue */
156         struct list_head        mgmt_run_list;  /* list of control tasks */
157         struct list_head        xmitqueue;      /* data-path cmd queue */
158         struct list_head        run_list;       /* list of cmds in progress */
159         struct work_struct      xmitwork;       /* per-conn. xmit workqueue */
160         /*
161          * serializes connection xmit, access to kfifos:
162          * xmitqueue, immqueue, mgmtqueue
163          */
164         struct mutex            xmitmutex;
165
166         unsigned long           suspend_tx;     /* suspend Tx */
167         unsigned long           suspend_rx;     /* suspend Rx */
168
169         /* abort */
170         wait_queue_head_t       ehwait;         /* used in eh_abort() */
171         struct iscsi_tm         tmhdr;
172         struct timer_list       tmabort_timer;
173         int                     tmabort_state;  /* see TMABORT_INITIAL, etc.*/
174
175         /* negotiated params */
176         int                     max_recv_dlength; /* initiator_max_recv_dsl*/
177         int                     max_xmit_dlength; /* target_max_recv_dsl */
178         int                     hdrdgst_en;
179         int                     datadgst_en;
180         int                     ifmarker_en;
181         int                     ofmarker_en;
182         /* values userspace uses to id a conn */
183         int                     persistent_port;
184         char                    *persistent_address;
185
186         /* MIB-statistics */
187         uint64_t                txdata_octets;
188         uint64_t                rxdata_octets;
189         uint32_t                scsicmd_pdus_cnt;
190         uint32_t                dataout_pdus_cnt;
191         uint32_t                scsirsp_pdus_cnt;
192         uint32_t                datain_pdus_cnt;
193         uint32_t                r2t_pdus_cnt;
194         uint32_t                tmfcmd_pdus_cnt;
195         int32_t                 tmfrsp_pdus_cnt;
196
197         /* custom statistics */
198         uint32_t                eh_abort_cnt;
199 };
200
201 struct iscsi_queue {
202         struct kfifo            *queue;         /* FIFO Queue */
203         void                    **pool;         /* Pool of elements */
204         int                     max;            /* Max number of elements */
205 };
206
207 struct iscsi_session {
208         /* iSCSI session-wide sequencing */
209         uint32_t                cmdsn;
210         uint32_t                exp_cmdsn;
211         uint32_t                max_cmdsn;
212
213         /* configuration */
214         int                     initial_r2t_en;
215         int                     max_r2t;
216         int                     imm_data_en;
217         int                     first_burst;
218         int                     max_burst;
219         int                     time2wait;
220         int                     time2retain;
221         int                     pdu_inorder_en;
222         int                     dataseq_inorder_en;
223         int                     erl;
224         int                     tpgt;
225         char                    *targetname;
226
227         /* control data */
228         struct iscsi_transport  *tt;
229         struct Scsi_Host        *host;
230         struct iscsi_conn       *leadconn;      /* leading connection */
231         spinlock_t              lock;           /* protects session state, *
232                                                  * sequence numbers,       *
233                                                  * session resources:      *
234                                                  * - cmdpool,              *
235                                                  * - mgmtpool,             *
236                                                  * - r2tpool               */
237         int                     state;          /* session state           */
238         struct list_head        item;
239         int                     age;            /* counts session re-opens */
240
241         struct list_head        connections;    /* list of connections */
242         int                     cmds_max;       /* size of cmds array */
243         struct iscsi_cmd_task   **cmds;         /* Original Cmds arr */
244         struct iscsi_queue      cmdpool;        /* PDU's pool */
245         int                     mgmtpool_max;   /* size of mgmt array */
246         struct iscsi_mgmt_task  **mgmt_cmds;    /* Original mgmt arr */
247         struct iscsi_queue      mgmtpool;       /* Mgmt PDU's pool */
248 };
249
250 /*
251  * scsi host template
252  */
253 extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
254 extern int iscsi_eh_abort(struct scsi_cmnd *sc);
255 extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
256 extern int iscsi_queuecommand(struct scsi_cmnd *sc,
257                               void (*done)(struct scsi_cmnd *));
258
259 /*
260  * session management
261  */
262 extern struct iscsi_cls_session *
263 iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
264                     int, int, uint32_t, uint32_t *);
265 extern void iscsi_session_teardown(struct iscsi_cls_session *);
266 extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *);
267 extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
268 extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
269                            enum iscsi_param param, char *buf, int buflen);
270 extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
271                                    enum iscsi_param param, char *buf);
272
273 #define session_to_cls(_sess) \
274         hostdata_session(_sess->host->hostdata)
275
276 /*
277  * connection management
278  */
279 extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
280                                                uint32_t);
281 extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
282 extern int iscsi_conn_start(struct iscsi_cls_conn *);
283 extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
284 extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
285                            int);
286 extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
287 extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
288                                 enum iscsi_param param, char *buf);
289
290 /*
291  * pdu and task processing
292  */
293 extern int iscsi_check_assign_cmdsn(struct iscsi_session *,
294                                     struct iscsi_nopin *);
295 extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
296                                         struct iscsi_data *hdr);
297 extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
298                                 char *, uint32_t);
299 extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
300                               char *, int);
301 extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
302                                 char *, int);
303 extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
304                             uint32_t *);
305
306 /*
307  * generic helpers
308  */
309 extern void iscsi_pool_free(struct iscsi_queue *, void **);
310 extern int iscsi_pool_init(struct iscsi_queue *, int, void ***, int);
311
312 #endif