2 * iSCSI transport class definitions
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
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.
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.
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.
23 #ifndef SCSI_TRANSPORT_ISCSI_H
24 #define SCSI_TRANSPORT_ISCSI_H
26 #include <linux/device.h>
27 #include <scsi/iscsi_if.h>
29 struct scsi_transport_template;
30 struct iscsi_transport;
33 struct iscsi_cls_conn;
35 struct iscsi_cmd_task;
36 struct iscsi_mgmt_task;
39 * struct iscsi_transport - iSCSI Transport template
41 * @name: transport name
42 * @caps: iSCSI Data-Path capabilities
43 * @create_session: create new iSCSI session object
44 * @destroy_session: destroy existing iSCSI session object
45 * @create_conn: create new iSCSI connection
46 * @bind_conn: associate this connection with existing iSCSI session
47 * and specified transport descriptor
48 * @destroy_conn: destroy inactive iSCSI connection
49 * @set_param: set iSCSI Data-Path operational parameter
50 * @start_conn: set connection to be operational
51 * @stop_conn: suspend/recover/terminate connection
52 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
53 * @session_recovery_timedout: notify LLD a block during recovery timed out
54 * @suspend_conn_recv: susepend the recv side of the connection
55 * @termincate_conn: destroy socket connection. Called with mutex lock.
56 * @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs.
57 * Called from queuecommand with session lock held.
58 * @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs.
59 * Called from iscsi_conn_send_generic with xmitmutex.
60 * @xmit_cmd_task: requests LLD to transfer cmd task
61 * @xmit_mgmt_task: requests LLD to transfer mgmt task
62 * @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex
63 * and session->lock after the connection has been
64 * suspended and terminated during recovery. If called
65 * from abort task then connection is not suspended
66 * or terminated but sk_callback_lock is held
68 * Template API provided by iSCSI Transport
70 struct iscsi_transport {
74 /* LLD sets this to indicate what values it can export to sysfs */
75 unsigned int param_mask;
76 struct scsi_host_template *host_template;
77 /* LLD connection data size */
79 /* LLD session data size */
82 unsigned int max_conn;
83 unsigned int max_cmd_len;
84 struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it,
85 struct scsi_transport_template *t, uint32_t sn, uint32_t *hn);
86 void (*destroy_session) (struct iscsi_cls_session *session);
87 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
89 int (*bind_conn) (struct iscsi_cls_session *session,
90 struct iscsi_cls_conn *cls_conn,
91 uint64_t transport_eph, int is_leading);
92 int (*start_conn) (struct iscsi_cls_conn *conn);
93 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
94 void (*destroy_conn) (struct iscsi_cls_conn *conn);
95 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
97 int (*get_conn_param) (struct iscsi_cls_conn *conn,
98 enum iscsi_param param, uint32_t *value);
99 int (*get_session_param) (struct iscsi_cls_session *session,
100 enum iscsi_param param, uint32_t *value);
101 int (*get_conn_str_param) (struct iscsi_cls_conn *conn,
102 enum iscsi_param param, char *buf);
103 int (*get_session_str_param) (struct iscsi_cls_session *session,
104 enum iscsi_param param, char *buf);
105 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
106 char *data, uint32_t data_size);
107 void (*get_stats) (struct iscsi_cls_conn *conn,
108 struct iscsi_stats *stats);
109 void (*suspend_conn_recv) (struct iscsi_conn *conn);
110 void (*terminate_conn) (struct iscsi_conn *conn);
111 void (*init_cmd_task) (struct iscsi_cmd_task *ctask);
112 void (*init_mgmt_task) (struct iscsi_conn *conn,
113 struct iscsi_mgmt_task *mtask,
114 char *data, uint32_t data_size);
115 int (*xmit_cmd_task) (struct iscsi_conn *conn,
116 struct iscsi_cmd_task *ctask);
117 void (*cleanup_cmd_task) (struct iscsi_conn *conn,
118 struct iscsi_cmd_task *ctask);
119 int (*xmit_mgmt_task) (struct iscsi_conn *conn,
120 struct iscsi_mgmt_task *mtask);
121 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
122 int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking,
123 uint64_t *ep_handle);
124 int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
125 void (*ep_disconnect) (uint64_t ep_handle);
129 * transport registration upcalls
131 extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
132 extern int iscsi_unregister_transport(struct iscsi_transport *tt);
135 * control plane upcalls
137 extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
138 extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
139 char *data, uint32_t data_size);
142 /* Connection's states */
143 #define ISCSI_CONN_INITIAL_STAGE 0
144 #define ISCSI_CONN_STARTED 1
145 #define ISCSI_CONN_STOPPED 2
146 #define ISCSI_CONN_CLEANUP_WAIT 3
148 struct iscsi_cls_conn {
149 struct list_head conn_list; /* item in connlist */
150 void *dd_data; /* LLD private data */
151 struct iscsi_transport *transport;
152 uint32_t cid; /* connection id */
154 /* portal/group values we got during discovery */
155 char *persistent_address;
157 /* portal/group values we are currently using */
161 int active; /* must be accessed with the connlock */
162 struct device dev; /* sysfs transport/container device */
163 struct mempool_zone *z_error;
164 struct mempool_zone *z_pdu;
165 struct list_head freequeue;
168 #define iscsi_dev_to_conn(_dev) \
169 container_of(_dev, struct iscsi_cls_conn, dev)
171 /* Session's states */
172 #define ISCSI_STATE_FREE 1
173 #define ISCSI_STATE_LOGGED_IN 2
174 #define ISCSI_STATE_FAILED 3
175 #define ISCSI_STATE_TERMINATE 4
177 struct iscsi_cls_session {
178 struct list_head sess_list; /* item in session_list */
179 struct list_head host_list;
180 struct iscsi_transport *transport;
182 /* iSCSI values used as unique id by userspace. */
186 /* recovery fields */
188 struct work_struct recovery_work;
193 int sid; /* session id */
194 void *dd_data; /* LLD private data */
195 struct device dev; /* sysfs transport/container device */
198 #define iscsi_dev_to_session(_dev) \
199 container_of(_dev, struct iscsi_cls_session, dev)
201 #define iscsi_session_to_shost(_session) \
202 dev_to_shost(_session->dev.parent)
206 struct list_head sessions;
211 * session and connection functions that can be used by HW iSCSI LLDs
213 extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
214 struct iscsi_transport *t, int channel);
215 extern int iscsi_destroy_session(struct iscsi_cls_session *session);
216 extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
218 extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
219 extern void iscsi_unblock_session(struct iscsi_cls_session *session);
220 extern void iscsi_block_session(struct iscsi_cls_session *session);