Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 1 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2 | * iSCSI transport class definitions |
| 3 | * |
| 4 | * Copyright (C) IBM Corporation, 2004 |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 5 | * Copyright (C) Mike Christie, 2004 - 2006 |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 6 | * Copyright (C) Dmitry Yusupov, 2004 - 2005 |
| 7 | * Copyright (C) Alex Aizman, 2004 - 2005 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 26 | #include <linux/device.h> |
Michael S. Tsirkin | d773c08 | 2007-10-02 14:38:05 -0700 | [diff] [blame] | 27 | #include <linux/list.h> |
| 28 | #include <linux/mutex.h> |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 29 | #include <scsi/iscsi_if.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 31 | struct scsi_transport_template; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 32 | struct iscsi_transport; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 33 | struct Scsi_Host; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 34 | struct iscsi_cls_conn; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 35 | struct iscsi_conn; |
| 36 | struct iscsi_cmd_task; |
| 37 | struct iscsi_mgmt_task; |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 38 | struct sockaddr; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 39 | |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 40 | /** |
| 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 Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 51 | * @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 Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 57 | * @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 Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 60 | * @session_recovery_timedout: notify LLD a block during recovery timed out |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 61 | * @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 Christie | 3219e52 | 2006-05-30 00:37:28 -0500 | [diff] [blame] | 65 | * @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 Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 71 | * @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 Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 76 | * |
| 77 | * Template API provided by iSCSI Transport |
| 78 | */ |
| 79 | struct iscsi_transport { |
| 80 | struct module *owner; |
| 81 | char *name; |
| 82 | unsigned int caps; |
Mike Christie | fd7255f | 2006-04-06 21:13:36 -0500 | [diff] [blame] | 83 | /* LLD sets this to indicate what values it can export to sysfs */ |
Mike Christie | 1819dc8 | 2007-05-30 12:57:08 -0500 | [diff] [blame] | 84 | uint64_t param_mask; |
| 85 | uint64_t host_param_mask; |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 86 | struct scsi_host_template *host_template; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 87 | /* LLD connection data size */ |
| 88 | int conndata_size; |
Mike Christie | b5c7a12 | 2006-04-06 21:13:33 -0500 | [diff] [blame] | 89 | /* LLD session data size */ |
| 90 | int sessiondata_size; |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 91 | int max_lun; |
| 92 | unsigned int max_conn; |
| 93 | unsigned int max_cmd_len; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 94 | struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it, |
Mike Christie | 1548271 | 2007-05-30 12:57:19 -0500 | [diff] [blame] | 95 | struct scsi_transport_template *t, uint16_t, uint16_t, |
| 96 | uint32_t sn, uint32_t *hn); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 97 | void (*destroy_session) (struct iscsi_cls_session *session); |
| 98 | struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess, |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 99 | uint32_t cid); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 100 | int (*bind_conn) (struct iscsi_cls_session *session, |
| 101 | struct iscsi_cls_conn *cls_conn, |
Or Gerlitz | 264faaa | 2006-05-02 19:46:36 -0500 | [diff] [blame] | 102 | uint64_t transport_eph, int is_leading); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 103 | int (*start_conn) (struct iscsi_cls_conn *conn); |
| 104 | void (*stop_conn) (struct iscsi_cls_conn *conn, int flag); |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 105 | void (*destroy_conn) (struct iscsi_cls_conn *conn); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 106 | int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param, |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 107 | char *buf, int buflen); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 108 | int (*get_conn_param) (struct iscsi_cls_conn *conn, |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 109 | enum iscsi_param param, char *buf); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 110 | int (*get_session_param) (struct iscsi_cls_session *session, |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 111 | enum iscsi_param param, char *buf); |
Mike Christie | 1819dc8 | 2007-05-30 12:57:08 -0500 | [diff] [blame] | 112 | int (*get_host_param) (struct Scsi_Host *shost, |
| 113 | enum iscsi_host_param param, char *buf); |
Mike Christie | 1d9bf13 | 2007-05-30 12:57:11 -0500 | [diff] [blame] | 114 | int (*set_host_param) (struct Scsi_Host *shost, |
| 115 | enum iscsi_host_param param, char *buf, |
| 116 | int buflen); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 117 | int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 118 | char *data, uint32_t data_size); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 119 | void (*get_stats) (struct iscsi_cls_conn *conn, |
| 120 | struct iscsi_stats *stats); |
Olaf Kirch | a8ac631 | 2007-12-13 12:43:35 -0600 | [diff] [blame] | 121 | int (*init_cmd_task) (struct iscsi_cmd_task *ctask); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 122 | void (*init_mgmt_task) (struct iscsi_conn *conn, |
Mike Christie | 77a23c2 | 2007-05-30 12:57:18 -0500 | [diff] [blame] | 123 | struct iscsi_mgmt_task *mtask); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 124 | 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 Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 130 | void (*session_recovery_timedout) (struct iscsi_cls_session *session); |
Or Gerlitz | 264faaa | 2006-05-02 19:46:36 -0500 | [diff] [blame] | 131 | 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 Christie | 2174a04 | 2007-05-30 12:57:10 -0500 | [diff] [blame] | 135 | int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type, |
Mike Christie | 01cb225 | 2006-06-28 12:00:22 -0500 | [diff] [blame] | 136 | uint32_t enable, struct sockaddr *dst_addr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 137 | }; |
| 138 | |
| 139 | /* |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 140 | * transport registration upcalls |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | */ |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 142 | extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt); |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 143 | extern int iscsi_unregister_transport(struct iscsi_transport *tt); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | |
| 145 | /* |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 146 | * control plane upcalls |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | */ |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 148 | extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error); |
| 149 | extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 150 | char *data, uint32_t data_size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 152 | |
| 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 Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 159 | struct 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 Christie | b5c7a12 | 2006-04-06 21:13:33 -0500 | [diff] [blame] | 163 | uint32_t cid; /* connection id */ |
Mike Christie | fd7255f | 2006-04-06 21:13:36 -0500 | [diff] [blame] | 164 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 165 | int active; /* must be accessed with the connlock */ |
| 166 | struct device dev; /* sysfs transport/container device */ |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 167 | }; |
| 168 | |
| 169 | #define iscsi_dev_to_conn(_dev) \ |
| 170 | container_of(_dev, struct iscsi_cls_conn, dev) |
| 171 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 172 | /* 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 Christie | 656cffc | 2006-05-18 20:31:42 -0500 | [diff] [blame] | 177 | #define ISCSI_STATE_IN_RECOVERY 5 |
| 178 | #define ISCSI_STATE_RECOVERY_FAILED 6 |
Mike Christie | b3a7ea8 | 2007-12-13 12:43:26 -0600 | [diff] [blame] | 179 | #define ISCSI_STATE_LOGGING_OUT 7 |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 180 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 181 | struct iscsi_cls_session { |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 182 | struct list_head sess_list; /* item in session_list */ |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 183 | struct list_head host_list; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 184 | struct iscsi_transport *transport; |
Mike Christie | fd7255f | 2006-04-06 21:13:36 -0500 | [diff] [blame] | 185 | |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 186 | /* recovery fields */ |
| 187 | int recovery_tmo; |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 188 | struct delayed_work recovery_work; |
Mike Christie | 2697478 | 2007-12-13 12:43:29 -0600 | [diff] [blame] | 189 | struct work_struct unbind_work; |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 190 | |
| 191 | int target_id; |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 192 | |
Mike Christie | b5c7a12 | 2006-04-06 21:13:33 -0500 | [diff] [blame] | 193 | int sid; /* session id */ |
| 194 | void *dd_data; /* LLD private data */ |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 195 | 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 Christie | 8434aa8 | 2006-06-28 12:00:30 -0500 | [diff] [blame] | 204 | #define starget_to_session(_stgt) \ |
| 205 | iscsi_dev_to_session(_stgt->dev.parent) |
| 206 | |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 207 | struct iscsi_host { |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 208 | struct list_head sessions; |
| 209 | struct mutex mutex; |
Mike Christie | 2697478 | 2007-12-13 12:43:29 -0600 | [diff] [blame] | 210 | struct workqueue_struct *unbind_workq; |
| 211 | char unbind_workq_name[KOBJ_NAME_LEN]; |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 212 | }; |
| 213 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 214 | /* |
| 215 | * session and connection functions that can be used by HW iSCSI LLDs |
| 216 | */ |
Mike Christie | 8434aa8 | 2006-06-28 12:00:30 -0500 | [diff] [blame] | 217 | extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost, |
| 218 | struct iscsi_transport *transport); |
Mike Christie | 6a8a0d3 | 2006-06-28 12:00:31 -0500 | [diff] [blame] | 219 | extern int iscsi_add_session(struct iscsi_cls_session *session, |
| 220 | unsigned int target_id); |
Mike Christie | 2697478 | 2007-12-13 12:43:29 -0600 | [diff] [blame] | 221 | extern int iscsi_session_event(struct iscsi_cls_session *session, |
| 222 | enum iscsi_uevent_e event); |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 223 | extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost, |
Mike Christie | 6a8a0d3 | 2006-06-28 12:00:31 -0500 | [diff] [blame] | 224 | struct iscsi_transport *t, |
| 225 | unsigned int target_id); |
Mike Christie | 8434aa8 | 2006-06-28 12:00:30 -0500 | [diff] [blame] | 226 | extern void iscsi_remove_session(struct iscsi_cls_session *session); |
| 227 | extern void iscsi_free_session(struct iscsi_cls_session *session); |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 228 | extern int iscsi_destroy_session(struct iscsi_cls_session *session); |
| 229 | extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess, |
| 230 | uint32_t cid); |
| 231 | extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn); |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 232 | extern void iscsi_unblock_session(struct iscsi_cls_session *session); |
| 233 | extern void iscsi_block_session(struct iscsi_cls_session *session); |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 234 | |
Mike Christie | 53cb8a1 | 2006-06-28 12:00:32 -0500 | [diff] [blame] | 235 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 236 | #endif |