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> |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 27 | #include <scsi/iscsi_if.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 29 | struct scsi_transport_template; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 30 | struct iscsi_transport; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 31 | struct Scsi_Host; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 32 | struct iscsi_cls_conn; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 33 | struct iscsi_conn; |
| 34 | struct iscsi_cmd_task; |
| 35 | struct iscsi_mgmt_task; |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 36 | struct sockaddr; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 37 | |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 38 | /** |
| 39 | * struct iscsi_transport - iSCSI Transport template |
| 40 | * |
| 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 |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 49 | * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA |
| 50 | * when param is not supported, and a -Exx value on other |
| 51 | * error. |
| 52 | * @get_param get iSCSI parameter. Must return number of bytes |
| 53 | * copied to buffer on success, -ENODATA when param |
| 54 | * is not supported, and a -Exx value on other error |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 55 | * @start_conn: set connection to be operational |
| 56 | * @stop_conn: suspend/recover/terminate connection |
| 57 | * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text. |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 58 | * @session_recovery_timedout: notify LLD a block during recovery timed out |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 59 | * @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs. |
| 60 | * Called from queuecommand with session lock held. |
| 61 | * @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs. |
| 62 | * Called from iscsi_conn_send_generic with xmitmutex. |
Mike Christie | 3219e52 | 2006-05-30 00:37:28 -0500 | [diff] [blame] | 63 | * @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the |
| 64 | * the number of bytes transferred on success, and -Exyz |
| 65 | * value on error. |
| 66 | * @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the |
| 67 | * the number of bytes transferred on success, and -Exyz |
| 68 | * value on error. |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 69 | * @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex |
| 70 | * and session->lock after the connection has been |
| 71 | * suspended and terminated during recovery. If called |
| 72 | * from abort task then connection is not suspended |
| 73 | * or terminated but sk_callback_lock is held |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 74 | * |
| 75 | * Template API provided by iSCSI Transport |
| 76 | */ |
| 77 | struct iscsi_transport { |
| 78 | struct module *owner; |
| 79 | char *name; |
| 80 | unsigned int caps; |
Mike Christie | fd7255f | 2006-04-06 21:13:36 -0500 | [diff] [blame] | 81 | /* LLD sets this to indicate what values it can export to sysfs */ |
Mike Christie | 1819dc8 | 2007-05-30 12:57:08 -0500 | [diff] [blame] | 82 | uint64_t param_mask; |
| 83 | uint64_t host_param_mask; |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 84 | struct scsi_host_template *host_template; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 85 | /* LLD connection data size */ |
| 86 | int conndata_size; |
Mike Christie | b5c7a12 | 2006-04-06 21:13:33 -0500 | [diff] [blame] | 87 | /* LLD session data size */ |
| 88 | int sessiondata_size; |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 89 | int max_lun; |
| 90 | unsigned int max_conn; |
| 91 | unsigned int max_cmd_len; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 92 | struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it, |
Mike Christie | 1548271 | 2007-05-30 12:57:19 -0500 | [diff] [blame] | 93 | struct scsi_transport_template *t, uint16_t, uint16_t, |
| 94 | uint32_t sn, uint32_t *hn); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 95 | void (*destroy_session) (struct iscsi_cls_session *session); |
| 96 | struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess, |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 97 | uint32_t cid); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 98 | int (*bind_conn) (struct iscsi_cls_session *session, |
| 99 | struct iscsi_cls_conn *cls_conn, |
Or Gerlitz | 264faaa | 2006-05-02 19:46:36 -0500 | [diff] [blame] | 100 | uint64_t transport_eph, int is_leading); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 101 | int (*start_conn) (struct iscsi_cls_conn *conn); |
| 102 | void (*stop_conn) (struct iscsi_cls_conn *conn, int flag); |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 103 | void (*destroy_conn) (struct iscsi_cls_conn *conn); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 104 | int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param, |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 105 | char *buf, int buflen); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 106 | int (*get_conn_param) (struct iscsi_cls_conn *conn, |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 107 | enum iscsi_param param, char *buf); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 108 | int (*get_session_param) (struct iscsi_cls_session *session, |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 109 | enum iscsi_param param, char *buf); |
Mike Christie | 1819dc8 | 2007-05-30 12:57:08 -0500 | [diff] [blame] | 110 | int (*get_host_param) (struct Scsi_Host *shost, |
| 111 | enum iscsi_host_param param, char *buf); |
Mike Christie | 1d9bf13 | 2007-05-30 12:57:11 -0500 | [diff] [blame] | 112 | int (*set_host_param) (struct Scsi_Host *shost, |
| 113 | enum iscsi_host_param param, char *buf, |
| 114 | int buflen); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 115 | int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 116 | char *data, uint32_t data_size); |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 117 | void (*get_stats) (struct iscsi_cls_conn *conn, |
| 118 | struct iscsi_stats *stats); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 119 | void (*init_cmd_task) (struct iscsi_cmd_task *ctask); |
| 120 | void (*init_mgmt_task) (struct iscsi_conn *conn, |
Mike Christie | 77a23c2 | 2007-05-30 12:57:18 -0500 | [diff] [blame] | 121 | struct iscsi_mgmt_task *mtask); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 122 | int (*xmit_cmd_task) (struct iscsi_conn *conn, |
| 123 | struct iscsi_cmd_task *ctask); |
| 124 | void (*cleanup_cmd_task) (struct iscsi_conn *conn, |
| 125 | struct iscsi_cmd_task *ctask); |
| 126 | int (*xmit_mgmt_task) (struct iscsi_conn *conn, |
| 127 | struct iscsi_mgmt_task *mtask); |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 128 | void (*session_recovery_timedout) (struct iscsi_cls_session *session); |
Or Gerlitz | 264faaa | 2006-05-02 19:46:36 -0500 | [diff] [blame] | 129 | int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking, |
| 130 | uint64_t *ep_handle); |
| 131 | int (*ep_poll) (uint64_t ep_handle, int timeout_ms); |
| 132 | void (*ep_disconnect) (uint64_t ep_handle); |
Mike Christie | 2174a04 | 2007-05-30 12:57:10 -0500 | [diff] [blame] | 133 | int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type, |
Mike Christie | 01cb225 | 2006-06-28 12:00:22 -0500 | [diff] [blame] | 134 | uint32_t enable, struct sockaddr *dst_addr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 | }; |
| 136 | |
| 137 | /* |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 138 | * transport registration upcalls |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 139 | */ |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 140 | extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt); |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 141 | extern int iscsi_unregister_transport(struct iscsi_transport *tt); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | |
| 143 | /* |
Alex Aizman | 39e8479 | 2005-08-04 19:31:00 -0700 | [diff] [blame] | 144 | * control plane upcalls |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | */ |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 146 | extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error); |
| 147 | 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] | 148 | char *data, uint32_t data_size); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 149 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 150 | |
| 151 | /* Connection's states */ |
| 152 | #define ISCSI_CONN_INITIAL_STAGE 0 |
| 153 | #define ISCSI_CONN_STARTED 1 |
| 154 | #define ISCSI_CONN_STOPPED 2 |
| 155 | #define ISCSI_CONN_CLEANUP_WAIT 3 |
| 156 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 157 | struct iscsi_cls_conn { |
| 158 | struct list_head conn_list; /* item in connlist */ |
| 159 | void *dd_data; /* LLD private data */ |
| 160 | struct iscsi_transport *transport; |
Mike Christie | b5c7a12 | 2006-04-06 21:13:33 -0500 | [diff] [blame] | 161 | uint32_t cid; /* connection id */ |
Mike Christie | fd7255f | 2006-04-06 21:13:36 -0500 | [diff] [blame] | 162 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 163 | int active; /* must be accessed with the connlock */ |
| 164 | struct device dev; /* sysfs transport/container device */ |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 165 | }; |
| 166 | |
| 167 | #define iscsi_dev_to_conn(_dev) \ |
| 168 | container_of(_dev, struct iscsi_cls_conn, dev) |
| 169 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 170 | /* Session's states */ |
| 171 | #define ISCSI_STATE_FREE 1 |
| 172 | #define ISCSI_STATE_LOGGED_IN 2 |
| 173 | #define ISCSI_STATE_FAILED 3 |
| 174 | #define ISCSI_STATE_TERMINATE 4 |
Mike Christie | 656cffc | 2006-05-18 20:31:42 -0500 | [diff] [blame] | 175 | #define ISCSI_STATE_IN_RECOVERY 5 |
| 176 | #define ISCSI_STATE_RECOVERY_FAILED 6 |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 177 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 178 | struct iscsi_cls_session { |
Mike Christie | 7b7232f | 2006-02-01 21:06:49 -0600 | [diff] [blame] | 179 | struct list_head sess_list; /* item in session_list */ |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 180 | struct list_head host_list; |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 181 | struct iscsi_transport *transport; |
Mike Christie | fd7255f | 2006-04-06 21:13:36 -0500 | [diff] [blame] | 182 | |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 183 | /* recovery fields */ |
| 184 | int recovery_tmo; |
David Howells | c402895 | 2006-11-22 14:57:56 +0000 | [diff] [blame] | 185 | struct delayed_work recovery_work; |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 186 | |
| 187 | int target_id; |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 188 | |
Mike Christie | b5c7a12 | 2006-04-06 21:13:33 -0500 | [diff] [blame] | 189 | int sid; /* session id */ |
| 190 | void *dd_data; /* LLD private data */ |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 191 | struct device dev; /* sysfs transport/container device */ |
| 192 | }; |
| 193 | |
| 194 | #define iscsi_dev_to_session(_dev) \ |
| 195 | container_of(_dev, struct iscsi_cls_session, dev) |
| 196 | |
| 197 | #define iscsi_session_to_shost(_session) \ |
| 198 | dev_to_shost(_session->dev.parent) |
| 199 | |
Mike Christie | 8434aa8 | 2006-06-28 12:00:30 -0500 | [diff] [blame] | 200 | #define starget_to_session(_stgt) \ |
| 201 | iscsi_dev_to_session(_stgt->dev.parent) |
| 202 | |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 203 | struct iscsi_host { |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 204 | struct list_head sessions; |
| 205 | struct mutex mutex; |
| 206 | }; |
| 207 | |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 208 | /* |
| 209 | * session and connection functions that can be used by HW iSCSI LLDs |
| 210 | */ |
Mike Christie | 8434aa8 | 2006-06-28 12:00:30 -0500 | [diff] [blame] | 211 | extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost, |
| 212 | struct iscsi_transport *transport); |
Mike Christie | 6a8a0d3 | 2006-06-28 12:00:31 -0500 | [diff] [blame] | 213 | extern int iscsi_add_session(struct iscsi_cls_session *session, |
| 214 | unsigned int target_id); |
Mike Christie | 53cb8a1 | 2006-06-28 12:00:32 -0500 | [diff] [blame] | 215 | extern int iscsi_if_create_session_done(struct iscsi_cls_conn *conn); |
| 216 | extern int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn); |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 217 | extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost, |
Mike Christie | 6a8a0d3 | 2006-06-28 12:00:31 -0500 | [diff] [blame] | 218 | struct iscsi_transport *t, |
| 219 | unsigned int target_id); |
Mike Christie | 8434aa8 | 2006-06-28 12:00:30 -0500 | [diff] [blame] | 220 | extern void iscsi_remove_session(struct iscsi_cls_session *session); |
| 221 | extern void iscsi_free_session(struct iscsi_cls_session *session); |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 222 | extern int iscsi_destroy_session(struct iscsi_cls_session *session); |
| 223 | extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess, |
| 224 | uint32_t cid); |
| 225 | extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn); |
Mike Christie | 30a6c65 | 2006-04-06 21:13:39 -0500 | [diff] [blame] | 226 | extern void iscsi_unblock_session(struct iscsi_cls_session *session); |
| 227 | extern void iscsi_block_session(struct iscsi_cls_session *session); |
Mike Christie | 7b8631b | 2006-01-13 18:05:50 -0600 | [diff] [blame] | 228 | |
Mike Christie | 53cb8a1 | 2006-06-28 12:00:32 -0500 | [diff] [blame] | 229 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 230 | #endif |