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