[SCSI] libiscsi: do not block session during logout
[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 <linux/timer.h>
29 #include <linux/workqueue.h>
30 #include <scsi/iscsi_proto.h>
31 #include <scsi/iscsi_if.h>
32
33 struct scsi_transport_template;
34 struct scsi_device;
35 struct Scsi_Host;
36 struct scsi_cmnd;
37 struct socket;
38 struct iscsi_transport;
39 struct iscsi_cls_session;
40 struct iscsi_cls_conn;
41 struct iscsi_session;
42 struct iscsi_nopin;
43
44 /* #define DEBUG_SCSI */
45 #ifdef DEBUG_SCSI
46 #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
47 #else
48 #define debug_scsi(fmt...)
49 #endif
50
51 #define ISCSI_DEF_XMIT_CMDS_MAX 128     /* must be power of 2 */
52 #define ISCSI_MGMT_CMDS_MAX     16      /* must be power of 2 */
53
54 #define ISCSI_MGMT_ITT_OFFSET   0xa00
55
56 #define ISCSI_DEF_CMD_PER_LUN           32
57 #define ISCSI_MAX_CMD_PER_LUN           128
58
59 /* Task Mgmt states */
60 enum {
61         TMF_INITIAL,
62         TMF_QUEUED,
63         TMF_SUCCESS,
64         TMF_FAILED,
65         TMF_TIMEDOUT,
66         TMF_NOT_FOUND,
67 };
68
69 /* Connection suspend "bit" */
70 #define ISCSI_SUSPEND_BIT               1
71
72 #define ISCSI_ITT_MASK                  (0xfff)
73 #define ISCSI_CID_SHIFT                 12
74 #define ISCSI_CID_MASK                  (0xffff << ISCSI_CID_SHIFT)
75 #define ISCSI_AGE_SHIFT                 28
76 #define ISCSI_AGE_MASK                  (0xf << ISCSI_AGE_SHIFT)
77
78 #define ISCSI_ADDRESS_BUF_LEN           64
79
80 enum {
81         /* this is the maximum possible storage for AHSs */
82         ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
83                                 sizeof(struct iscsi_rlength_ahdr),
84         ISCSI_DIGEST_SIZE = sizeof(__u32),
85 };
86
87 struct iscsi_mgmt_task {
88         /*
89          * Becuae LLDs allocate their hdr differently, this is a pointer to
90          * that storage. It must be setup at session creation time.
91          */
92         struct iscsi_hdr        *hdr;
93         char                    *data;          /* mgmt payload */
94         unsigned                data_count;     /* counts data to be sent */
95         uint32_t                itt;            /* this ITT */
96         void                    *dd_data;       /* driver/transport data */
97         struct list_head        running;
98 };
99
100 enum {
101         ISCSI_TASK_COMPLETED,
102         ISCSI_TASK_PENDING,
103         ISCSI_TASK_RUNNING,
104 };
105
106 struct iscsi_cmd_task {
107         /*
108          * Because LLDs allocate their hdr differently, this is a pointer
109          * and length to that storage. It must be setup at session
110          * creation time.
111          */
112         struct iscsi_cmd        *hdr;
113         unsigned short          hdr_max;
114         unsigned short          hdr_len;        /* accumulated size of hdr used */
115         int                     itt;            /* this ITT */
116
117         uint32_t                unsol_datasn;
118         unsigned                imm_count;      /* imm-data (bytes)   */
119         unsigned                unsol_count;    /* unsolicited (bytes)*/
120         /* offset in unsolicited stream (bytes); */
121         unsigned                unsol_offset;
122         unsigned                data_count;     /* remaining Data-Out */
123         struct scsi_cmnd        *sc;            /* associated SCSI cmd*/
124         struct iscsi_conn       *conn;          /* used connection    */
125
126         /* state set/tested under session->lock */
127         int                     state;
128         atomic_t                refcount;
129         struct list_head        running;        /* running cmd list */
130         void                    *dd_data;       /* driver/transport data */
131 };
132
133 static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
134 {
135         return (void*)ctask->hdr + ctask->hdr_len;
136 }
137
138 struct iscsi_conn {
139         struct iscsi_cls_conn   *cls_conn;      /* ptr to class connection */
140         void                    *dd_data;       /* iscsi_transport data */
141         struct iscsi_session    *session;       /* parent session */
142         /*
143          * LLDs should set this lock. It protects the transport recv
144          * code
145          */
146         rwlock_t                *recv_lock;
147         /*
148          * conn_stop() flag: stop to recover, stop to terminate
149          */
150         int                     stop_stage;
151
152         /* iSCSI connection-wide sequencing */
153         uint32_t                exp_statsn;
154
155         /* control data */
156         int                     id;             /* CID */
157         int                     c_stage;        /* connection state */
158         /*
159          * Preallocated buffer for pdus that have data but do not
160          * originate from scsi-ml. We never have two pdus using the
161          * buffer at the same time. It is only allocated to
162          * the default max recv size because the pdus we support
163          * should always fit in this buffer
164          */
165         char                    *data;
166         struct iscsi_mgmt_task  *login_mtask;   /* mtask used for login/text */
167         struct iscsi_mgmt_task  *mtask;         /* xmit mtask in progress */
168         struct iscsi_cmd_task   *ctask;         /* xmit ctask in progress */
169
170         /* xmit */
171         struct list_head        mgmtqueue;      /* mgmt (control) xmit queue */
172         struct list_head        mgmt_run_list;  /* list of control tasks */
173         struct list_head        xmitqueue;      /* data-path cmd queue */
174         struct list_head        run_list;       /* list of cmds in progress */
175         struct list_head        requeue;        /* tasks needing another run */
176         struct work_struct      xmitwork;       /* per-conn. xmit workqueue */
177         unsigned long           suspend_tx;     /* suspend Tx */
178         unsigned long           suspend_rx;     /* suspend Rx */
179
180         /* abort */
181         wait_queue_head_t       ehwait;         /* used in eh_abort() */
182         struct iscsi_tm         tmhdr;
183         struct timer_list       tmf_timer;
184         int                     tmf_state;      /* see TMF_INITIAL, etc.*/
185
186         /* negotiated params */
187         unsigned                max_recv_dlength; /* initiator_max_recv_dsl*/
188         unsigned                max_xmit_dlength; /* target_max_recv_dsl */
189         int                     hdrdgst_en;
190         int                     datadgst_en;
191         int                     ifmarker_en;
192         int                     ofmarker_en;
193         /* values userspace uses to id a conn */
194         int                     persistent_port;
195         char                    *persistent_address;
196         /* remote portal currently connected to */
197         int                     portal_port;
198         char                    portal_address[ISCSI_ADDRESS_BUF_LEN];
199         /* local address */
200         int                     local_port;
201         char                    local_address[ISCSI_ADDRESS_BUF_LEN];
202
203         /* MIB-statistics */
204         uint64_t                txdata_octets;
205         uint64_t                rxdata_octets;
206         uint32_t                scsicmd_pdus_cnt;
207         uint32_t                dataout_pdus_cnt;
208         uint32_t                scsirsp_pdus_cnt;
209         uint32_t                datain_pdus_cnt;
210         uint32_t                r2t_pdus_cnt;
211         uint32_t                tmfcmd_pdus_cnt;
212         int32_t                 tmfrsp_pdus_cnt;
213
214         /* custom statistics */
215         uint32_t                eh_abort_cnt;
216 };
217
218 struct iscsi_pool {
219         struct kfifo            *queue;         /* FIFO Queue */
220         void                    **pool;         /* Pool of elements */
221         int                     max;            /* Max number of elements */
222 };
223
224 struct iscsi_session {
225         /*
226          * Syncs up the scsi eh thread with the iscsi eh thread when sending
227          * task management functions. This must be taken before the session
228          * and recv lock.
229          */
230         struct mutex            eh_mutex;
231
232         /* iSCSI session-wide sequencing */
233         uint32_t                cmdsn;
234         uint32_t                exp_cmdsn;
235         uint32_t                max_cmdsn;
236
237         /* This tracks the reqs queued into the initiator */
238         uint32_t                queued_cmdsn;
239
240         /* configuration */
241         int                     initial_r2t_en;
242         unsigned                max_r2t;
243         int                     imm_data_en;
244         unsigned                first_burst;
245         unsigned                max_burst;
246         int                     time2wait;
247         int                     time2retain;
248         int                     pdu_inorder_en;
249         int                     dataseq_inorder_en;
250         int                     erl;
251         int                     fast_abort;
252         int                     tpgt;
253         char                    *username;
254         char                    *username_in;
255         char                    *password;
256         char                    *password_in;
257         char                    *targetname;
258         char                    *initiatorname;
259         /* hw address or netdev iscsi connection is bound to */
260         char                    *hwaddress;
261         char                    *netdev;
262         /* control data */
263         struct iscsi_transport  *tt;
264         struct Scsi_Host        *host;
265         struct iscsi_conn       *leadconn;      /* leading connection */
266         spinlock_t              lock;           /* protects session state, *
267                                                  * sequence numbers,       *
268                                                  * session resources:      *
269                                                  * - cmdpool,              *
270                                                  * - mgmtpool,             *
271                                                  * - r2tpool               */
272         int                     state;          /* session state           */
273         int                     age;            /* counts session re-opens */
274
275         int                     cmds_max;       /* size of cmds array */
276         struct iscsi_cmd_task   **cmds;         /* Original Cmds arr */
277         struct iscsi_pool       cmdpool;        /* PDU's pool */
278         int                     mgmtpool_max;   /* size of mgmt array */
279         struct iscsi_mgmt_task  **mgmt_cmds;    /* Original mgmt arr */
280         struct iscsi_pool       mgmtpool;       /* Mgmt PDU's pool */
281 };
282
283 /*
284  * scsi host template
285  */
286 extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
287 extern int iscsi_eh_abort(struct scsi_cmnd *sc);
288 extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
289 extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
290 extern int iscsi_queuecommand(struct scsi_cmnd *sc,
291                               void (*done)(struct scsi_cmnd *));
292
293
294 /*
295  * iSCSI host helpers.
296  */
297 extern int iscsi_host_set_param(struct Scsi_Host *shost,
298                                 enum iscsi_host_param param, char *buf,
299                                 int buflen);
300 extern int iscsi_host_get_param(struct Scsi_Host *shost,
301                                 enum iscsi_host_param param, char *buf);
302
303 /*
304  * session management
305  */
306 extern struct iscsi_cls_session *
307 iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
308                     uint16_t, uint16_t, int, int, uint32_t, uint32_t *);
309 extern void iscsi_session_teardown(struct iscsi_cls_session *);
310 extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *);
311 extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
312 extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
313                            enum iscsi_param param, char *buf, int buflen);
314 extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
315                                    enum iscsi_param param, char *buf);
316
317 #define session_to_cls(_sess) \
318         hostdata_session(_sess->host->hostdata)
319
320 /*
321  * connection management
322  */
323 extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
324                                                uint32_t);
325 extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
326 extern int iscsi_conn_start(struct iscsi_cls_conn *);
327 extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
328 extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
329                            int);
330 extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
331 extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
332                                 enum iscsi_param param, char *buf);
333
334 /*
335  * pdu and task processing
336  */
337 extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
338 extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
339                                         struct iscsi_data *hdr);
340 extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
341                                 char *, uint32_t);
342 extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
343                               char *, int);
344 extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
345                                 char *, int);
346 extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
347                             uint32_t *);
348 extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);
349 extern void iscsi_free_mgmt_task(struct iscsi_conn *conn,
350                                  struct iscsi_mgmt_task *mtask);
351
352 /*
353  * generic helpers
354  */
355 extern void iscsi_pool_free(struct iscsi_pool *);
356 extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
357
358 /*
359  * inline functions to deal with padding.
360  */
361 static inline unsigned int
362 iscsi_padded(unsigned int len)
363 {
364         return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
365 }
366
367 static inline unsigned int
368 iscsi_padding(unsigned int len)
369 {
370         len &= (ISCSI_PAD_LEN - 1);
371         if (len)
372                 len = ISCSI_PAD_LEN - len;
373         return len;
374 }
375
376 #endif