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