Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 1 | /* |
| 2 | * iSCSI lib definitions |
| 3 | * |
| 4 | * Copyright (C) 2006 Red Hat, Inc. All rights reserved. |
| 5 | * Copyright (C) 2004 - 2006 Mike Christie |
| 6 | * Copyright (C) 2004 - 2005 Dmitry Yusupov |
| 7 | * Copyright (C) 2004 - 2005 Alex Aizman |
| 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 LIBISCSI_H |
| 24 | #define LIBISCSI_H |
| 25 | |
| 26 | #include <linux/types.h> |
| 27 | #include <linux/mutex.h> |
Al Viro | f6a5703 | 2006-10-18 01:47:25 -0400 | [diff] [blame] | 28 | #include <linux/timer.h> |
| 29 | #include <linux/workqueue.h> |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 30 | #include <scsi/iscsi_proto.h> |
| 31 | #include <scsi/iscsi_if.h> |
| 32 | |
| 33 | struct scsi_transport_template; |
| 34 | struct scsi_device; |
| 35 | struct Scsi_Host; |
| 36 | struct scsi_cmnd; |
| 37 | struct socket; |
| 38 | struct iscsi_transport; |
| 39 | struct iscsi_cls_session; |
| 40 | struct iscsi_cls_conn; |
| 41 | struct iscsi_session; |
| 42 | struct iscsi_nopin; |
| 43 | |
| 44 | /* #define DEBUG_SCSI */ |
| 45 | #ifdef DEBUG_SCSI |
Or Gerlitz | be2df72 | 2006-05-02 19:46:43 -0500 | [diff] [blame] | 46 | #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt) |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 47 | #else |
| 48 | #define debug_scsi(fmt...) |
| 49 | #endif |
| 50 | |
Mike Christie | 1548271 | 2007-05-30 12:57:19 -0500 | [diff] [blame] | 51 | #define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */ |
| 52 | #define ISCSI_MGMT_CMDS_MAX 16 /* must be power of 2 */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 53 | |
| 54 | #define ISCSI_MGMT_ITT_OFFSET 0xa00 |
| 55 | |
| 56 | #define ISCSI_DEF_CMD_PER_LUN 32 |
| 57 | #define ISCSI_MAX_CMD_PER_LUN 128 |
| 58 | |
| 59 | /* Task Mgmt states */ |
| 60 | #define TMABORT_INITIAL 0x0 |
| 61 | #define TMABORT_SUCCESS 0x1 |
| 62 | #define TMABORT_FAILED 0x2 |
| 63 | #define TMABORT_TIMEDOUT 0x3 |
Mike Christie | 7ea8b82 | 2006-07-24 15:47:22 -0500 | [diff] [blame] | 64 | #define TMABORT_NOT_FOUND 0x4 |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 65 | |
| 66 | /* Connection suspend "bit" */ |
| 67 | #define ISCSI_SUSPEND_BIT 1 |
| 68 | |
| 69 | #define ISCSI_ITT_MASK (0xfff) |
| 70 | #define ISCSI_CID_SHIFT 12 |
| 71 | #define ISCSI_CID_MASK (0xffff << ISCSI_CID_SHIFT) |
| 72 | #define ISCSI_AGE_SHIFT 28 |
| 73 | #define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT) |
| 74 | |
Mike Christie | 2223696 | 2007-05-30 12:57:24 -0500 | [diff] [blame] | 75 | #define ISCSI_ADDRESS_BUF_LEN 64 |
| 76 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 77 | struct iscsi_mgmt_task { |
| 78 | /* |
| 79 | * Becuae LLDs allocate their hdr differently, this is a pointer to |
| 80 | * that storage. It must be setup at session creation time. |
| 81 | */ |
| 82 | struct iscsi_hdr *hdr; |
| 83 | char *data; /* mgmt payload */ |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 84 | unsigned data_count; /* counts data to be sent */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 85 | uint32_t itt; /* this ITT */ |
| 86 | void *dd_data; /* driver/transport data */ |
| 87 | struct list_head running; |
| 88 | }; |
| 89 | |
Mike Christie | b6c395e | 2006-07-24 15:47:15 -0500 | [diff] [blame] | 90 | enum { |
| 91 | ISCSI_TASK_COMPLETED, |
| 92 | ISCSI_TASK_PENDING, |
| 93 | ISCSI_TASK_RUNNING, |
Mike Christie | 77a23c2 | 2007-05-30 12:57:18 -0500 | [diff] [blame] | 94 | ISCSI_TASK_ABORTING, |
Mike Christie | b6c395e | 2006-07-24 15:47:15 -0500 | [diff] [blame] | 95 | }; |
| 96 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 97 | struct iscsi_cmd_task { |
| 98 | /* |
| 99 | * Becuae LLDs allocate their hdr differently, this is a pointer to |
| 100 | * that storage. It must be setup at session creation time. |
| 101 | */ |
| 102 | struct iscsi_cmd *hdr; |
| 103 | int itt; /* this ITT */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 104 | |
| 105 | uint32_t unsol_datasn; |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 106 | unsigned imm_count; /* imm-data (bytes) */ |
| 107 | unsigned unsol_count; /* unsolicited (bytes)*/ |
Mike Christie | ffd0436 | 2006-08-31 18:09:24 -0400 | [diff] [blame] | 108 | /* offset in unsolicited stream (bytes); */ |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 109 | unsigned unsol_offset; |
| 110 | unsigned data_count; /* remaining Data-Out */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 111 | struct scsi_cmnd *sc; /* associated SCSI cmd*/ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 112 | struct iscsi_conn *conn; /* used connection */ |
| 113 | struct iscsi_mgmt_task *mtask; /* tmf mtask in progr */ |
| 114 | |
Mike Christie | b6c395e | 2006-07-24 15:47:15 -0500 | [diff] [blame] | 115 | /* state set/tested under session->lock */ |
| 116 | int state; |
Mike Christie | 60ecebf | 2006-08-31 18:09:25 -0400 | [diff] [blame] | 117 | atomic_t refcount; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 118 | struct list_head running; /* running cmd list */ |
| 119 | void *dd_data; /* driver/transport data */ |
| 120 | }; |
| 121 | |
| 122 | struct iscsi_conn { |
| 123 | struct iscsi_cls_conn *cls_conn; /* ptr to class connection */ |
| 124 | void *dd_data; /* iscsi_transport data */ |
| 125 | struct iscsi_session *session; /* parent session */ |
| 126 | /* |
| 127 | * LLDs should set this lock. It protects the transport recv |
| 128 | * code |
| 129 | */ |
| 130 | rwlock_t *recv_lock; |
| 131 | /* |
| 132 | * conn_stop() flag: stop to recover, stop to terminate |
| 133 | */ |
| 134 | int stop_stage; |
| 135 | |
| 136 | /* iSCSI connection-wide sequencing */ |
| 137 | uint32_t exp_statsn; |
| 138 | |
| 139 | /* control data */ |
| 140 | int id; /* CID */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 141 | int c_stage; /* connection state */ |
Mike Christie | c8dc1e5 | 2006-07-24 15:47:39 -0500 | [diff] [blame] | 142 | /* |
| 143 | * Preallocated buffer for pdus that have data but do not |
| 144 | * originate from scsi-ml. We never have two pdus using the |
| 145 | * buffer at the same time. It is only allocated to |
| 146 | * the default max recv size because the pdus we support |
| 147 | * should always fit in this buffer |
| 148 | */ |
| 149 | char *data; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 150 | struct iscsi_mgmt_task *login_mtask; /* mtask used for login/text */ |
| 151 | struct iscsi_mgmt_task *mtask; /* xmit mtask in progress */ |
| 152 | struct iscsi_cmd_task *ctask; /* xmit ctask in progress */ |
| 153 | |
| 154 | /* xmit */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 155 | struct kfifo *mgmtqueue; /* mgmt (control) xmit queue */ |
| 156 | struct list_head mgmt_run_list; /* list of control tasks */ |
Mike Christie | b6c395e | 2006-07-24 15:47:15 -0500 | [diff] [blame] | 157 | struct list_head xmitqueue; /* data-path cmd queue */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 158 | struct list_head run_list; /* list of cmds in progress */ |
| 159 | struct work_struct xmitwork; /* per-conn. xmit workqueue */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 160 | unsigned long suspend_tx; /* suspend Tx */ |
| 161 | unsigned long suspend_rx; /* suspend Rx */ |
| 162 | |
| 163 | /* abort */ |
| 164 | wait_queue_head_t ehwait; /* used in eh_abort() */ |
| 165 | struct iscsi_tm tmhdr; |
| 166 | struct timer_list tmabort_timer; |
| 167 | int tmabort_state; /* see TMABORT_INITIAL, etc.*/ |
| 168 | |
| 169 | /* negotiated params */ |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 170 | unsigned max_recv_dlength; /* initiator_max_recv_dsl*/ |
| 171 | unsigned max_xmit_dlength; /* target_max_recv_dsl */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 172 | int hdrdgst_en; |
| 173 | int datadgst_en; |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 174 | int ifmarker_en; |
| 175 | int ofmarker_en; |
| 176 | /* values userspace uses to id a conn */ |
| 177 | int persistent_port; |
| 178 | char *persistent_address; |
Mike Christie | 2223696 | 2007-05-30 12:57:24 -0500 | [diff] [blame] | 179 | /* remote portal currently connected to */ |
| 180 | int portal_port; |
| 181 | char portal_address[ISCSI_ADDRESS_BUF_LEN]; |
| 182 | /* local address */ |
| 183 | int local_port; |
| 184 | char local_address[ISCSI_ADDRESS_BUF_LEN]; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 185 | |
| 186 | /* MIB-statistics */ |
| 187 | uint64_t txdata_octets; |
| 188 | uint64_t rxdata_octets; |
| 189 | uint32_t scsicmd_pdus_cnt; |
| 190 | uint32_t dataout_pdus_cnt; |
| 191 | uint32_t scsirsp_pdus_cnt; |
| 192 | uint32_t datain_pdus_cnt; |
| 193 | uint32_t r2t_pdus_cnt; |
| 194 | uint32_t tmfcmd_pdus_cnt; |
| 195 | int32_t tmfrsp_pdus_cnt; |
| 196 | |
| 197 | /* custom statistics */ |
| 198 | uint32_t eh_abort_cnt; |
| 199 | }; |
| 200 | |
| 201 | struct iscsi_queue { |
| 202 | struct kfifo *queue; /* FIFO Queue */ |
| 203 | void **pool; /* Pool of elements */ |
| 204 | int max; /* Max number of elements */ |
| 205 | }; |
| 206 | |
| 207 | struct iscsi_session { |
| 208 | /* iSCSI session-wide sequencing */ |
| 209 | uint32_t cmdsn; |
| 210 | uint32_t exp_cmdsn; |
| 211 | uint32_t max_cmdsn; |
| 212 | |
| 213 | /* configuration */ |
| 214 | int initial_r2t_en; |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 215 | unsigned max_r2t; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 216 | int imm_data_en; |
Mike Christie | 857ae0b | 2007-05-30 12:57:15 -0500 | [diff] [blame] | 217 | unsigned first_burst; |
| 218 | unsigned max_burst; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 219 | int time2wait; |
| 220 | int time2retain; |
| 221 | int pdu_inorder_en; |
| 222 | int dataseq_inorder_en; |
| 223 | int erl; |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 224 | int tpgt; |
Mike Christie | b2c6416 | 2007-05-30 12:57:16 -0500 | [diff] [blame] | 225 | char *username; |
| 226 | char *username_in; |
| 227 | char *password; |
| 228 | char *password_in; |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 229 | char *targetname; |
Mike Christie | 8ad5781 | 2007-05-30 12:57:13 -0500 | [diff] [blame] | 230 | char *initiatorname; |
Mike Christie | d8196ed | 2007-05-30 12:57:25 -0500 | [diff] [blame^] | 231 | /* hw address or netdev iscsi connection is bound to */ |
Mike Christie | 0801c24 | 2007-05-30 12:57:12 -0500 | [diff] [blame] | 232 | char *hwaddress; |
Mike Christie | d8196ed | 2007-05-30 12:57:25 -0500 | [diff] [blame^] | 233 | char *netdev; |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 234 | /* control data */ |
| 235 | struct iscsi_transport *tt; |
| 236 | struct Scsi_Host *host; |
| 237 | struct iscsi_conn *leadconn; /* leading connection */ |
| 238 | spinlock_t lock; /* protects session state, * |
| 239 | * sequence numbers, * |
| 240 | * session resources: * |
| 241 | * - cmdpool, * |
| 242 | * - mgmtpool, * |
| 243 | * - r2tpool */ |
| 244 | int state; /* session state */ |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 245 | int age; /* counts session re-opens */ |
| 246 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 247 | int cmds_max; /* size of cmds array */ |
| 248 | struct iscsi_cmd_task **cmds; /* Original Cmds arr */ |
| 249 | struct iscsi_queue cmdpool; /* PDU's pool */ |
| 250 | int mgmtpool_max; /* size of mgmt array */ |
| 251 | struct iscsi_mgmt_task **mgmt_cmds; /* Original mgmt arr */ |
| 252 | struct iscsi_queue mgmtpool; /* Mgmt PDU's pool */ |
| 253 | }; |
| 254 | |
| 255 | /* |
| 256 | * scsi host template |
| 257 | */ |
| 258 | extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth); |
| 259 | extern int iscsi_eh_abort(struct scsi_cmnd *sc); |
| 260 | extern int iscsi_eh_host_reset(struct scsi_cmnd *sc); |
| 261 | extern int iscsi_queuecommand(struct scsi_cmnd *sc, |
| 262 | void (*done)(struct scsi_cmnd *)); |
| 263 | |
Mike Christie | 0801c24 | 2007-05-30 12:57:12 -0500 | [diff] [blame] | 264 | |
| 265 | /* |
| 266 | * iSCSI host helpers. |
| 267 | */ |
| 268 | extern int iscsi_host_set_param(struct Scsi_Host *shost, |
| 269 | enum iscsi_host_param param, char *buf, |
| 270 | int buflen); |
| 271 | extern int iscsi_host_get_param(struct Scsi_Host *shost, |
| 272 | enum iscsi_host_param param, char *buf); |
| 273 | |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 274 | /* |
| 275 | * session management |
| 276 | */ |
| 277 | extern struct iscsi_cls_session * |
| 278 | iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *, |
Mike Christie | 1548271 | 2007-05-30 12:57:19 -0500 | [diff] [blame] | 279 | uint16_t, uint16_t, int, int, uint32_t, uint32_t *); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 280 | extern void iscsi_session_teardown(struct iscsi_cls_session *); |
| 281 | extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 282 | extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *); |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 283 | extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn, |
| 284 | enum iscsi_param param, char *buf, int buflen); |
| 285 | extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session, |
| 286 | enum iscsi_param param, char *buf); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 287 | |
| 288 | #define session_to_cls(_sess) \ |
| 289 | hostdata_session(_sess->host->hostdata) |
| 290 | |
| 291 | /* |
| 292 | * connection management |
| 293 | */ |
| 294 | extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *, |
| 295 | uint32_t); |
| 296 | extern void iscsi_conn_teardown(struct iscsi_cls_conn *); |
| 297 | extern int iscsi_conn_start(struct iscsi_cls_conn *); |
| 298 | extern void iscsi_conn_stop(struct iscsi_cls_conn *, int); |
| 299 | extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *, |
| 300 | int); |
| 301 | extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err); |
Mike Christie | a54a52c | 2006-06-28 12:00:23 -0500 | [diff] [blame] | 302 | extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn, |
| 303 | enum iscsi_param param, char *buf); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 304 | |
| 305 | /* |
| 306 | * pdu and task processing |
| 307 | */ |
Mike Christie | 77a23c2 | 2007-05-30 12:57:18 -0500 | [diff] [blame] | 308 | extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 309 | extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *, |
Mike Christie | ffd0436 | 2006-08-31 18:09:24 -0400 | [diff] [blame] | 310 | struct iscsi_data *hdr); |
Mike Christie | 7996a77 | 2006-04-06 21:13:41 -0500 | [diff] [blame] | 311 | extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *, |
| 312 | char *, uint32_t); |
| 313 | extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *, |
| 314 | char *, int); |
| 315 | extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *, |
| 316 | char *, int); |
| 317 | extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *, |
| 318 | uint32_t *); |
| 319 | |
| 320 | /* |
| 321 | * generic helpers |
| 322 | */ |
| 323 | extern void iscsi_pool_free(struct iscsi_queue *, void **); |
| 324 | extern int iscsi_pool_init(struct iscsi_queue *, int, void ***, int); |
| 325 | |
| 326 | #endif |