[SCSI] iscsi class: add iface representation
[linux-2.6.git] / include / scsi / scsi_transport_iscsi.h
1 /*
2  * iSCSI transport class definitions
3  *
4  * Copyright (C) IBM Corporation, 2004
5  * Copyright (C) Mike Christie, 2004 - 2006
6  * Copyright (C) Dmitry Yusupov, 2004 - 2005
7  * Copyright (C) Alex Aizman, 2004 - 2005
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 SCSI_TRANSPORT_ISCSI_H
24 #define SCSI_TRANSPORT_ISCSI_H
25
26 #include <linux/device.h>
27 #include <linux/list.h>
28 #include <linux/mutex.h>
29 #include <scsi/iscsi_if.h>
30
31 struct scsi_transport_template;
32 struct iscsi_transport;
33 struct iscsi_endpoint;
34 struct Scsi_Host;
35 struct scsi_cmnd;
36 struct iscsi_cls_conn;
37 struct iscsi_conn;
38 struct iscsi_task;
39 struct sockaddr;
40 struct iscsi_iface;
41
42 /**
43  * struct iscsi_transport - iSCSI Transport template
44  *
45  * @name:               transport name
46  * @caps:               iSCSI Data-Path capabilities
47  * @create_session:     create new iSCSI session object
48  * @destroy_session:    destroy existing iSCSI session object
49  * @create_conn:        create new iSCSI connection
50  * @bind_conn:          associate this connection with existing iSCSI session
51  *                      and specified transport descriptor
52  * @destroy_conn:       destroy inactive iSCSI connection
53  * @set_param:          set iSCSI parameter. Return 0 on success, -ENODATA
54  *                      when param is not supported, and a -Exx value on other
55  *                      error.
56  * @get_param           get iSCSI parameter. Must return number of bytes
57  *                      copied to buffer on success, -ENODATA when param
58  *                      is not supported, and a -Exx value on other error
59  * @start_conn:         set connection to be operational
60  * @stop_conn:          suspend/recover/terminate connection
61  * @send_pdu:           send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
62  * @session_recovery_timedout: notify LLD a block during recovery timed out
63  * @init_task:          Initialize a iscsi_task and any internal structs.
64  *                      When offloading the data path, this is called from
65  *                      queuecommand with the session lock, or from the
66  *                      iscsi_conn_send_pdu context with the session lock.
67  *                      When not offloading the data path, this is called
68  *                      from the scsi work queue without the session lock.
69  * @xmit_task           Requests LLD to transfer cmd task. Returns 0 or the
70  *                      the number of bytes transferred on success, and -Exyz
71  *                      value on error. When offloading the data path, this
72  *                      is called from queuecommand with the session lock, or
73  *                      from the iscsi_conn_send_pdu context with the session
74  *                      lock. When not offloading the data path, this is called
75  *                      from the scsi work queue without the session lock.
76  * @cleanup_task:       requests LLD to fail task. Called with session lock
77  *                      and after the connection has been suspended and
78  *                      terminated during recovery. If called
79  *                      from abort task then connection is not suspended
80  *                      or terminated but sk_callback_lock is held
81  *
82  * Template API provided by iSCSI Transport
83  */
84 struct iscsi_transport {
85         struct module *owner;
86         char *name;
87         unsigned int caps;
88         /* LLD sets this to indicate what values it can export to sysfs */
89         uint64_t param_mask;
90         uint64_t host_param_mask;
91         uint64_t iface_param_mask;
92
93         struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
94                                         uint16_t cmds_max, uint16_t qdepth,
95                                         uint32_t sn);
96         void (*destroy_session) (struct iscsi_cls_session *session);
97         struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
98                                 uint32_t cid);
99         int (*bind_conn) (struct iscsi_cls_session *session,
100                           struct iscsi_cls_conn *cls_conn,
101                           uint64_t transport_eph, int is_leading);
102         int (*start_conn) (struct iscsi_cls_conn *conn);
103         void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
104         void (*destroy_conn) (struct iscsi_cls_conn *conn);
105         int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
106                           char *buf, int buflen);
107         int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
108                              char *buf);
109         int (*get_conn_param) (struct iscsi_cls_conn *conn,
110                                enum iscsi_param param, char *buf);
111         int (*get_session_param) (struct iscsi_cls_session *session,
112                                   enum iscsi_param param, char *buf);
113         int (*get_host_param) (struct Scsi_Host *shost,
114                                 enum iscsi_host_param param, char *buf);
115         int (*set_host_param) (struct Scsi_Host *shost,
116                                enum iscsi_host_param param, char *buf,
117                                int buflen);
118         int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
119                          char *data, uint32_t data_size);
120         void (*get_stats) (struct iscsi_cls_conn *conn,
121                            struct iscsi_stats *stats);
122
123         int (*init_task) (struct iscsi_task *task);
124         int (*xmit_task) (struct iscsi_task *task);
125         void (*cleanup_task) (struct iscsi_task *task);
126
127         int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
128         int (*xmit_pdu) (struct iscsi_task *task);
129         int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
130                          unsigned int count);
131         void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
132                                int *index, int *age);
133
134         void (*session_recovery_timedout) (struct iscsi_cls_session *session);
135         struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
136                                               struct sockaddr *dst_addr,
137                                               int non_blocking);
138         int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
139         void (*ep_disconnect) (struct iscsi_endpoint *ep);
140         int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
141                           uint32_t enable, struct sockaddr *dst_addr);
142         int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
143         int (*set_iface_param) (struct Scsi_Host *shost, char *data, int count);
144         int (*get_iface_param) (struct iscsi_iface *iface,
145                                 enum iscsi_param_type param_type,
146                                 int param, char *buf);
147 };
148
149 /*
150  * transport registration upcalls
151  */
152 extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
153 extern int iscsi_unregister_transport(struct iscsi_transport *tt);
154
155 /*
156  * control plane upcalls
157  */
158 extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
159                                    enum iscsi_err error);
160 extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
161                           char *data, uint32_t data_size);
162
163 extern int iscsi_offload_mesg(struct Scsi_Host *shost,
164                               struct iscsi_transport *transport, uint32_t type,
165                               char *data, uint16_t data_size);
166
167 struct iscsi_cls_conn {
168         struct list_head conn_list;     /* item in connlist */
169         void *dd_data;                  /* LLD private data */
170         struct iscsi_transport *transport;
171         uint32_t cid;                   /* connection id */
172         struct mutex ep_mutex;
173         struct iscsi_endpoint *ep;
174
175         struct device dev;              /* sysfs transport/container device */
176 };
177
178 #define iscsi_dev_to_conn(_dev) \
179         container_of(_dev, struct iscsi_cls_conn, dev)
180
181 #define iscsi_conn_to_session(_conn) \
182         iscsi_dev_to_session(_conn->dev.parent)
183
184 /* iscsi class session state */
185 enum {
186         ISCSI_SESSION_LOGGED_IN,
187         ISCSI_SESSION_FAILED,
188         ISCSI_SESSION_FREE,
189 };
190
191 #define ISCSI_MAX_TARGET -1
192
193 struct iscsi_cls_session {
194         struct list_head sess_list;             /* item in session_list */
195         struct iscsi_transport *transport;
196         spinlock_t lock;
197         struct work_struct block_work;
198         struct work_struct unblock_work;
199         struct work_struct scan_work;
200         struct work_struct unbind_work;
201
202         /* recovery fields */
203         int recovery_tmo;
204         struct delayed_work recovery_work;
205
206         unsigned int target_id;
207
208         int state;
209         int sid;                                /* session id */
210         void *dd_data;                          /* LLD private data */
211         struct device dev;      /* sysfs transport/container device */
212 };
213
214 #define iscsi_dev_to_session(_dev) \
215         container_of(_dev, struct iscsi_cls_session, dev)
216
217 #define iscsi_session_to_shost(_session) \
218         dev_to_shost(_session->dev.parent)
219
220 #define starget_to_session(_stgt) \
221         iscsi_dev_to_session(_stgt->dev.parent)
222
223 struct iscsi_cls_host {
224         atomic_t nr_scans;
225         struct mutex mutex;
226 };
227
228 extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
229                                 void (*fn)(struct iscsi_cls_session *));
230
231 struct iscsi_endpoint {
232         void *dd_data;                  /* LLD private data */
233         struct device dev;
234         uint64_t id;
235         struct iscsi_cls_conn *conn;
236 };
237
238 struct iscsi_iface {
239         struct device dev;
240         struct iscsi_transport *transport;
241         uint32_t iface_type;    /* IPv4 or IPv6 */
242         uint32_t iface_num;     /* iface number, 0 - n */
243         void *dd_data;          /* LLD private data */
244 };
245
246 #define iscsi_dev_to_iface(_dev) \
247         container_of(_dev, struct iscsi_iface, dev)
248
249 #define iscsi_iface_to_shost(_iface) \
250         dev_to_shost(_iface->dev.parent)
251
252 /*
253  * session and connection functions that can be used by HW iSCSI LLDs
254  */
255 #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
256         dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
257
258 #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
259         dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
260
261 extern int iscsi_session_chkready(struct iscsi_cls_session *session);
262 extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
263                                 struct iscsi_transport *transport, int dd_size);
264 extern int iscsi_add_session(struct iscsi_cls_session *session,
265                              unsigned int target_id);
266 extern int iscsi_session_event(struct iscsi_cls_session *session,
267                                enum iscsi_uevent_e event);
268 extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
269                                                 struct iscsi_transport *t,
270                                                 int dd_size,
271                                                 unsigned int target_id);
272 extern void iscsi_remove_session(struct iscsi_cls_session *session);
273 extern void iscsi_free_session(struct iscsi_cls_session *session);
274 extern int iscsi_destroy_session(struct iscsi_cls_session *session);
275 extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
276                                                 int dd_size, uint32_t cid);
277 extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
278 extern void iscsi_unblock_session(struct iscsi_cls_session *session);
279 extern void iscsi_block_session(struct iscsi_cls_session *session);
280 extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
281 extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
282 extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
283 extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
284 extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
285 extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
286                                               struct iscsi_transport *t,
287                                               uint32_t iface_type,
288                                               uint32_t iface_num, int dd_size);
289 extern void iscsi_destroy_iface(struct iscsi_iface *iface);
290 extern struct iscsi_iface *iscsi_lookup_iface(int handle);
291
292 #endif