blob: 404f11d331d6e767711a86e860013e63f88b8611 [file] [log] [blame]
Alex Aizman39e84792005-08-04 19:31:00 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * iSCSI transport class definitions
3 *
4 * Copyright (C) IBM Corporation, 2004
Mike Christie7996a772006-04-06 21:13:41 -05005 * Copyright (C) Mike Christie, 2004 - 2006
Alex Aizman39e84792005-08-04 19:31:00 -07006 * Copyright (C) Dmitry Yusupov, 2004 - 2005
7 * Copyright (C) Alex Aizman, 2004 - 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
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
Mike Christie7b8631b2006-01-13 18:05:50 -060026#include <linux/device.h>
Michael S. Tsirkind773c082007-10-02 14:38:05 -070027#include <linux/list.h>
28#include <linux/mutex.h>
Alex Aizman39e84792005-08-04 19:31:00 -070029#include <scsi/iscsi_if.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Mike Christie7b8631b2006-01-13 18:05:50 -060031struct scsi_transport_template;
Mike Christie7996a772006-04-06 21:13:41 -050032struct iscsi_transport;
Mike Christie7b8631b2006-01-13 18:05:50 -060033struct Scsi_Host;
Mike Christie7b8631b2006-01-13 18:05:50 -060034struct iscsi_cls_conn;
Mike Christie7996a772006-04-06 21:13:41 -050035struct iscsi_conn;
36struct iscsi_cmd_task;
37struct iscsi_mgmt_task;
Mike Christiea54a52c2006-06-28 12:00:23 -050038struct sockaddr;
Mike Christie7b8631b2006-01-13 18:05:50 -060039
Alex Aizman39e84792005-08-04 19:31:00 -070040/**
41 * struct iscsi_transport - iSCSI Transport template
42 *
43 * @name: transport name
44 * @caps: iSCSI Data-Path capabilities
45 * @create_session: create new iSCSI session object
46 * @destroy_session: destroy existing iSCSI session object
47 * @create_conn: create new iSCSI connection
48 * @bind_conn: associate this connection with existing iSCSI session
49 * and specified transport descriptor
50 * @destroy_conn: destroy inactive iSCSI connection
Mike Christiea54a52c2006-06-28 12:00:23 -050051 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
52 * when param is not supported, and a -Exx value on other
53 * error.
54 * @get_param get iSCSI parameter. Must return number of bytes
55 * copied to buffer on success, -ENODATA when param
56 * is not supported, and a -Exx value on other error
Alex Aizman39e84792005-08-04 19:31:00 -070057 * @start_conn: set connection to be operational
58 * @stop_conn: suspend/recover/terminate connection
59 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
Mike Christie7996a772006-04-06 21:13:41 -050060 * @session_recovery_timedout: notify LLD a block during recovery timed out
Mike Christie7996a772006-04-06 21:13:41 -050061 * @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs.
62 * Called from queuecommand with session lock held.
63 * @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs.
64 * Called from iscsi_conn_send_generic with xmitmutex.
Mike Christie3219e522006-05-30 00:37:28 -050065 * @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the
66 * the number of bytes transferred on success, and -Exyz
67 * value on error.
68 * @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the
69 * the number of bytes transferred on success, and -Exyz
70 * value on error.
Mike Christie7996a772006-04-06 21:13:41 -050071 * @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex
72 * and session->lock after the connection has been
73 * suspended and terminated during recovery. If called
74 * from abort task then connection is not suspended
75 * or terminated but sk_callback_lock is held
Alex Aizman39e84792005-08-04 19:31:00 -070076 *
77 * Template API provided by iSCSI Transport
78 */
79struct iscsi_transport {
80 struct module *owner;
81 char *name;
82 unsigned int caps;
Mike Christiefd7255f2006-04-06 21:13:36 -050083 /* LLD sets this to indicate what values it can export to sysfs */
Mike Christie1819dc82007-05-30 12:57:08 -050084 uint64_t param_mask;
85 uint64_t host_param_mask;
Alex Aizman39e84792005-08-04 19:31:00 -070086 struct scsi_host_template *host_template;
Mike Christie7b8631b2006-01-13 18:05:50 -060087 /* LLD connection data size */
88 int conndata_size;
Mike Christieb5c7a122006-04-06 21:13:33 -050089 /* LLD session data size */
90 int sessiondata_size;
Alex Aizman39e84792005-08-04 19:31:00 -070091 int max_lun;
92 unsigned int max_conn;
93 unsigned int max_cmd_len;
Mike Christie7996a772006-04-06 21:13:41 -050094 struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it,
Mike Christie15482712007-05-30 12:57:19 -050095 struct scsi_transport_template *t, uint16_t, uint16_t,
96 uint32_t sn, uint32_t *hn);
Mike Christie7b7232f2006-02-01 21:06:49 -060097 void (*destroy_session) (struct iscsi_cls_session *session);
98 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
Mike Christie7b8631b2006-01-13 18:05:50 -060099 uint32_t cid);
Mike Christie7b7232f2006-02-01 21:06:49 -0600100 int (*bind_conn) (struct iscsi_cls_session *session,
101 struct iscsi_cls_conn *cls_conn,
Or Gerlitz264faaa2006-05-02 19:46:36 -0500102 uint64_t transport_eph, int is_leading);
Mike Christie7b7232f2006-02-01 21:06:49 -0600103 int (*start_conn) (struct iscsi_cls_conn *conn);
104 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
Mike Christie7b8631b2006-01-13 18:05:50 -0600105 void (*destroy_conn) (struct iscsi_cls_conn *conn);
Mike Christie7b7232f2006-02-01 21:06:49 -0600106 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
Mike Christiea54a52c2006-06-28 12:00:23 -0500107 char *buf, int buflen);
Mike Christie7b7232f2006-02-01 21:06:49 -0600108 int (*get_conn_param) (struct iscsi_cls_conn *conn,
Mike Christiea54a52c2006-06-28 12:00:23 -0500109 enum iscsi_param param, char *buf);
Mike Christie7b7232f2006-02-01 21:06:49 -0600110 int (*get_session_param) (struct iscsi_cls_session *session,
Mike Christiea54a52c2006-06-28 12:00:23 -0500111 enum iscsi_param param, char *buf);
Mike Christie1819dc82007-05-30 12:57:08 -0500112 int (*get_host_param) (struct Scsi_Host *shost,
113 enum iscsi_host_param param, char *buf);
Mike Christie1d9bf132007-05-30 12:57:11 -0500114 int (*set_host_param) (struct Scsi_Host *shost,
115 enum iscsi_host_param param, char *buf,
116 int buflen);
Mike Christie7b7232f2006-02-01 21:06:49 -0600117 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
Alex Aizman39e84792005-08-04 19:31:00 -0700118 char *data, uint32_t data_size);
Mike Christie7b7232f2006-02-01 21:06:49 -0600119 void (*get_stats) (struct iscsi_cls_conn *conn,
120 struct iscsi_stats *stats);
Olaf Kircha8ac6312007-12-13 12:43:35 -0600121 int (*init_cmd_task) (struct iscsi_cmd_task *ctask);
Mike Christie7996a772006-04-06 21:13:41 -0500122 void (*init_mgmt_task) (struct iscsi_conn *conn,
Mike Christie77a23c22007-05-30 12:57:18 -0500123 struct iscsi_mgmt_task *mtask);
Mike Christie7996a772006-04-06 21:13:41 -0500124 int (*xmit_cmd_task) (struct iscsi_conn *conn,
125 struct iscsi_cmd_task *ctask);
126 void (*cleanup_cmd_task) (struct iscsi_conn *conn,
127 struct iscsi_cmd_task *ctask);
128 int (*xmit_mgmt_task) (struct iscsi_conn *conn,
129 struct iscsi_mgmt_task *mtask);
Mike Christie30a6c652006-04-06 21:13:39 -0500130 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
Or Gerlitz264faaa2006-05-02 19:46:36 -0500131 int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking,
132 uint64_t *ep_handle);
133 int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
134 void (*ep_disconnect) (uint64_t ep_handle);
Mike Christie2174a042007-05-30 12:57:10 -0500135 int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
Mike Christie01cb2252006-06-28 12:00:22 -0500136 uint32_t enable, struct sockaddr *dst_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137};
138
139/*
Alex Aizman39e84792005-08-04 19:31:00 -0700140 * transport registration upcalls
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 */
Mike Christie7b8631b2006-01-13 18:05:50 -0600142extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
Alex Aizman39e84792005-08-04 19:31:00 -0700143extern int iscsi_unregister_transport(struct iscsi_transport *tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145/*
Alex Aizman39e84792005-08-04 19:31:00 -0700146 * control plane upcalls
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 */
Mike Christie7b7232f2006-02-01 21:06:49 -0600148extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
149extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
Alex Aizman39e84792005-08-04 19:31:00 -0700150 char *data, uint32_t data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Mike Christie7996a772006-04-06 21:13:41 -0500152
153/* Connection's states */
154#define ISCSI_CONN_INITIAL_STAGE 0
155#define ISCSI_CONN_STARTED 1
156#define ISCSI_CONN_STOPPED 2
157#define ISCSI_CONN_CLEANUP_WAIT 3
158
Mike Christie7b8631b2006-01-13 18:05:50 -0600159struct iscsi_cls_conn {
160 struct list_head conn_list; /* item in connlist */
161 void *dd_data; /* LLD private data */
162 struct iscsi_transport *transport;
Mike Christieb5c7a122006-04-06 21:13:33 -0500163 uint32_t cid; /* connection id */
Mike Christiefd7255f2006-04-06 21:13:36 -0500164
Mike Christie7b8631b2006-01-13 18:05:50 -0600165 int active; /* must be accessed with the connlock */
166 struct device dev; /* sysfs transport/container device */
Mike Christie7b8631b2006-01-13 18:05:50 -0600167};
168
169#define iscsi_dev_to_conn(_dev) \
170 container_of(_dev, struct iscsi_cls_conn, dev)
171
Mike Christie7996a772006-04-06 21:13:41 -0500172/* Session's states */
173#define ISCSI_STATE_FREE 1
174#define ISCSI_STATE_LOGGED_IN 2
175#define ISCSI_STATE_FAILED 3
176#define ISCSI_STATE_TERMINATE 4
Mike Christie656cffc2006-05-18 20:31:42 -0500177#define ISCSI_STATE_IN_RECOVERY 5
178#define ISCSI_STATE_RECOVERY_FAILED 6
Mike Christieb3a7ea82007-12-13 12:43:26 -0600179#define ISCSI_STATE_LOGGING_OUT 7
Mike Christie7996a772006-04-06 21:13:41 -0500180
Mike Christie7b8631b2006-01-13 18:05:50 -0600181struct iscsi_cls_session {
Mike Christie7b7232f2006-02-01 21:06:49 -0600182 struct list_head sess_list; /* item in session_list */
Mike Christie30a6c652006-04-06 21:13:39 -0500183 struct list_head host_list;
Mike Christie7b8631b2006-01-13 18:05:50 -0600184 struct iscsi_transport *transport;
Mike Christiefd7255f2006-04-06 21:13:36 -0500185
Mike Christie30a6c652006-04-06 21:13:39 -0500186 /* recovery fields */
187 int recovery_tmo;
David Howellsc4028952006-11-22 14:57:56 +0000188 struct delayed_work recovery_work;
Mike Christie26974782007-12-13 12:43:29 -0600189 struct work_struct unbind_work;
Mike Christie30a6c652006-04-06 21:13:39 -0500190
191 int target_id;
Mike Christie30a6c652006-04-06 21:13:39 -0500192
Mike Christieb5c7a122006-04-06 21:13:33 -0500193 int sid; /* session id */
194 void *dd_data; /* LLD private data */
Mike Christie7b8631b2006-01-13 18:05:50 -0600195 struct device dev; /* sysfs transport/container device */
196};
197
198#define iscsi_dev_to_session(_dev) \
199 container_of(_dev, struct iscsi_cls_session, dev)
200
201#define iscsi_session_to_shost(_session) \
202 dev_to_shost(_session->dev.parent)
203
Mike Christie8434aa82006-06-28 12:00:30 -0500204#define starget_to_session(_stgt) \
205 iscsi_dev_to_session(_stgt->dev.parent)
206
Mike Christie30a6c652006-04-06 21:13:39 -0500207struct iscsi_host {
Mike Christie30a6c652006-04-06 21:13:39 -0500208 struct list_head sessions;
209 struct mutex mutex;
Mike Christie26974782007-12-13 12:43:29 -0600210 struct workqueue_struct *unbind_workq;
211 char unbind_workq_name[KOBJ_NAME_LEN];
Mike Christie30a6c652006-04-06 21:13:39 -0500212};
213
Mike Christie7b8631b2006-01-13 18:05:50 -0600214/*
215 * session and connection functions that can be used by HW iSCSI LLDs
216 */
Mike Christie8434aa82006-06-28 12:00:30 -0500217extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
218 struct iscsi_transport *transport);
Mike Christie6a8a0d32006-06-28 12:00:31 -0500219extern int iscsi_add_session(struct iscsi_cls_session *session,
220 unsigned int target_id);
Mike Christie26974782007-12-13 12:43:29 -0600221extern int iscsi_session_event(struct iscsi_cls_session *session,
222 enum iscsi_uevent_e event);
Mike Christie7b8631b2006-01-13 18:05:50 -0600223extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
Mike Christie6a8a0d32006-06-28 12:00:31 -0500224 struct iscsi_transport *t,
225 unsigned int target_id);
Mike Christie8434aa82006-06-28 12:00:30 -0500226extern void iscsi_remove_session(struct iscsi_cls_session *session);
227extern void iscsi_free_session(struct iscsi_cls_session *session);
Mike Christie7b8631b2006-01-13 18:05:50 -0600228extern int iscsi_destroy_session(struct iscsi_cls_session *session);
229extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
230 uint32_t cid);
231extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
Mike Christie30a6c652006-04-06 21:13:39 -0500232extern void iscsi_unblock_session(struct iscsi_cls_session *session);
233extern void iscsi_block_session(struct iscsi_cls_session *session);
Mike Christie7b8631b2006-01-13 18:05:50 -0600234
Mike Christie53cb8a12006-06-28 12:00:32 -0500235
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236#endif