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/wait.h> 28 #include <linux/mutex.h> 29 #include <linux/timer.h> 30 #include <linux/workqueue.h> 31 #include <scsi/iscsi_proto.h> 32 #include <scsi/iscsi_if.h> 33 #include <scsi/scsi_transport_iscsi.h> 34 35 struct scsi_transport_template; 36 struct scsi_host_template; 37 struct scsi_device; 38 struct Scsi_Host; 39 struct scsi_target; 40 struct scsi_cmnd; 41 struct socket; 42 struct iscsi_transport; 43 struct iscsi_cls_session; 44 struct iscsi_cls_conn; 45 struct iscsi_session; 46 struct iscsi_nopin; 47 struct device; 48 49 #define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */ 50 #define ISCSI_MGMT_CMDS_MAX 15 51 52 #define ISCSI_DEF_CMD_PER_LUN 32 53 54 /* Task Mgmt states */ 55 enum { 56 TMF_INITIAL, 57 TMF_QUEUED, 58 TMF_SUCCESS, 59 TMF_FAILED, 60 TMF_TIMEDOUT, 61 TMF_NOT_FOUND, 62 }; 63 64 /* Connection suspend "bit" */ 65 #define ISCSI_SUSPEND_BIT 1 66 67 #define ISCSI_ITT_MASK 0x1fff 68 #define ISCSI_TOTAL_CMDS_MAX 4096 69 /* this must be a power of two greater than ISCSI_MGMT_CMDS_MAX */ 70 #define ISCSI_TOTAL_CMDS_MIN 16 71 #define ISCSI_AGE_SHIFT 28 72 #define ISCSI_AGE_MASK 0xf 73 74 #define ISCSI_ADDRESS_BUF_LEN 64 75 76 enum { 77 /* this is the maximum possible storage for AHSs */ 78 ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) + 79 sizeof(struct iscsi_rlength_ahdr), 80 ISCSI_DIGEST_SIZE = sizeof(__u32), 81 }; 82 83 84 enum { 85 ISCSI_TASK_FREE, 86 ISCSI_TASK_COMPLETED, 87 ISCSI_TASK_PENDING, 88 ISCSI_TASK_RUNNING, 89 ISCSI_TASK_ABRT_TMF, /* aborted due to TMF */ 90 ISCSI_TASK_ABRT_SESS_RECOV, /* aborted due to session recovery */ 91 }; 92 93 struct iscsi_r2t_info { 94 __be32 ttt; /* copied from R2T */ 95 __be32 exp_statsn; /* copied from R2T */ 96 uint32_t data_length; /* copied from R2T */ 97 uint32_t data_offset; /* copied from R2T */ 98 int data_count; /* DATA-Out payload progress */ 99 int datasn; 100 /* LLDs should set/update these values */ 101 int sent; /* R2T sequence progress */ 102 }; 103 104 struct iscsi_task { 105 /* 106 * Because LLDs allocate their hdr differently, this is a pointer 107 * and length to that storage. It must be setup at session 108 * creation time. 109 */ 110 struct iscsi_hdr *hdr; 111 unsigned short hdr_max; 112 unsigned short hdr_len; /* accumulated size of hdr used */ 113 /* copied values in case we need to send tmfs */ 114 itt_t hdr_itt; 115 __be32 cmdsn; 116 uint8_t lun[8]; 117 118 int itt; /* this ITT */ 119 120 unsigned imm_count; /* imm-data (bytes) */ 121 /* offset in unsolicited stream (bytes); */ 122 struct iscsi_r2t_info unsol_r2t; 123 char *data; /* mgmt payload */ 124 unsigned data_count; 125 struct scsi_cmnd *sc; /* associated SCSI cmd*/ 126 struct iscsi_conn *conn; /* used connection */ 127 128 /* state set/tested under session->lock */ 129 int state; 130 atomic_t refcount; 131 struct list_head running; /* running cmd list */ 132 void *dd_data; /* driver/transport data */ 133 }; 134 135 static inline int iscsi_task_has_unsol_data(struct iscsi_task *task) 136 { 137 return task->unsol_r2t.data_length > task->unsol_r2t.sent; 138 } 139 140 static inline void* iscsi_next_hdr(struct iscsi_task *task) 141 { 142 return (void*)task->hdr + task->hdr_len; 143 } 144 145 /* Connection's states */ 146 enum { 147 ISCSI_CONN_INITIAL_STAGE, 148 ISCSI_CONN_STARTED, 149 ISCSI_CONN_STOPPED, 150 ISCSI_CONN_CLEANUP_WAIT, 151 }; 152 153 struct iscsi_conn { 154 struct iscsi_cls_conn *cls_conn; /* ptr to class connection */ 155 void *dd_data; /* iscsi_transport data */ 156 struct iscsi_session *session; /* parent session */ 157 /* 158 * conn_stop() flag: stop to recover, stop to terminate 159 */ 160 int stop_stage; 161 struct timer_list transport_timer; 162 unsigned long last_recv; 163 unsigned long last_ping; 164 int ping_timeout; 165 int recv_timeout; 166 struct iscsi_task *ping_task; 167 168 /* iSCSI connection-wide sequencing */ 169 uint32_t exp_statsn; 170 171 /* control data */ 172 int id; /* CID */ 173 int c_stage; /* connection state */ 174 /* 175 * Preallocated buffer for pdus that have data but do not 176 * originate from scsi-ml. We never have two pdus using the 177 * buffer at the same time. It is only allocated to 178 * the default max recv size because the pdus we support 179 * should always fit in this buffer 180 */ 181 char *data; 182 struct iscsi_task *login_task; /* mtask used for login/text */ 183 struct iscsi_task *task; /* xmit task in progress */ 184 185 /* xmit */ 186 struct list_head mgmtqueue; /* mgmt (control) xmit queue */ 187 struct list_head cmdqueue; /* data-path cmd queue */ 188 struct list_head requeue; /* tasks needing another run */ 189 struct work_struct xmitwork; /* per-conn. xmit workqueue */ 190 unsigned long suspend_tx; /* suspend Tx */ 191 unsigned long suspend_rx; /* suspend Rx */ 192 193 /* abort */ 194 wait_queue_head_t ehwait; /* used in eh_abort() */ 195 struct iscsi_tm tmhdr; 196 struct timer_list tmf_timer; 197 int tmf_state; /* see TMF_INITIAL, etc.*/ 198 199 /* negotiated params */ 200 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/ 201 unsigned max_xmit_dlength; /* target_max_recv_dsl */ 202 int hdrdgst_en; 203 int datadgst_en; 204 int ifmarker_en; 205 int ofmarker_en; 206 /* values userspace uses to id a conn */ 207 int persistent_port; 208 char *persistent_address; 209 /* remote portal currently connected to */ 210 int portal_port; 211 char portal_address[ISCSI_ADDRESS_BUF_LEN]; 212 213 /* MIB-statistics */ 214 uint64_t txdata_octets; 215 uint64_t rxdata_octets; 216 uint32_t scsicmd_pdus_cnt; 217 uint32_t dataout_pdus_cnt; 218 uint32_t scsirsp_pdus_cnt; 219 uint32_t datain_pdus_cnt; 220 uint32_t r2t_pdus_cnt; 221 uint32_t tmfcmd_pdus_cnt; 222 int32_t tmfrsp_pdus_cnt; 223 224 /* custom statistics */ 225 uint32_t eh_abort_cnt; 226 uint32_t fmr_unalign_cnt; 227 }; 228 229 struct iscsi_pool { 230 struct kfifo *queue; /* FIFO Queue */ 231 void **pool; /* Pool of elements */ 232 int max; /* Max number of elements */ 233 }; 234 235 /* Session's states */ 236 enum { 237 ISCSI_STATE_FREE = 1, 238 ISCSI_STATE_LOGGED_IN, 239 ISCSI_STATE_FAILED, 240 ISCSI_STATE_TERMINATE, 241 ISCSI_STATE_IN_RECOVERY, 242 ISCSI_STATE_RECOVERY_FAILED, 243 ISCSI_STATE_LOGGING_OUT, 244 }; 245 246 struct iscsi_session { 247 struct iscsi_cls_session *cls_session; 248 /* 249 * Syncs up the scsi eh thread with the iscsi eh thread when sending 250 * task management functions. This must be taken before the session 251 * and recv lock. 252 */ 253 struct mutex eh_mutex; 254 255 /* iSCSI session-wide sequencing */ 256 uint32_t cmdsn; 257 uint32_t exp_cmdsn; 258 uint32_t max_cmdsn; 259 260 /* This tracks the reqs queued into the initiator */ 261 uint32_t queued_cmdsn; 262 263 /* configuration */ 264 int abort_timeout; 265 int lu_reset_timeout; 266 int initial_r2t_en; 267 unsigned max_r2t; 268 int imm_data_en; 269 unsigned first_burst; 270 unsigned max_burst; 271 int time2wait; 272 int time2retain; 273 int pdu_inorder_en; 274 int dataseq_inorder_en; 275 int erl; 276 int fast_abort; 277 int tpgt; 278 char *username; 279 char *username_in; 280 char *password; 281 char *password_in; 282 char *targetname; 283 char *ifacename; 284 char *initiatorname; 285 /* control data */ 286 struct iscsi_transport *tt; 287 struct Scsi_Host *host; 288 struct iscsi_conn *leadconn; /* leading connection */ 289 spinlock_t lock; /* protects session state, * 290 * sequence numbers, * 291 * session resources: * 292 * - cmdpool, * 293 * - mgmtpool, * 294 * - r2tpool */ 295 int state; /* session state */ 296 int age; /* counts session re-opens */ 297 298 int scsi_cmds_max; /* max scsi commands */ 299 int cmds_max; /* size of cmds array */ 300 struct iscsi_task **cmds; /* Original Cmds arr */ 301 struct iscsi_pool cmdpool; /* PDU's pool */ 302 }; 303 304 enum { 305 ISCSI_HOST_SETUP, 306 ISCSI_HOST_REMOVED, 307 }; 308 309 struct iscsi_host { 310 char *initiatorname; 311 /* hw address or netdev iscsi connection is bound to */ 312 char *hwaddress; 313 char *netdev; 314 /* local address */ 315 int local_port; 316 char local_address[ISCSI_ADDRESS_BUF_LEN]; 317 318 wait_queue_head_t session_removal_wq; 319 /* protects sessions and state */ 320 spinlock_t lock; 321 int num_sessions; 322 int state; 323 324 struct workqueue_struct *workq; 325 char workq_name[20]; 326 }; 327 328 /* 329 * scsi host template 330 */ 331 extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth); 332 extern int iscsi_eh_abort(struct scsi_cmnd *sc); 333 extern int iscsi_eh_target_reset(struct scsi_cmnd *sc); 334 extern int iscsi_eh_device_reset(struct scsi_cmnd *sc); 335 extern int iscsi_queuecommand(struct scsi_cmnd *sc, 336 void (*done)(struct scsi_cmnd *)); 337 338 /* 339 * iSCSI host helpers. 340 */ 341 #define iscsi_host_priv(_shost) \ 342 (shost_priv(_shost) + sizeof(struct iscsi_host)) 343 344 extern int iscsi_host_set_param(struct Scsi_Host *shost, 345 enum iscsi_host_param param, char *buf, 346 int buflen); 347 extern int iscsi_host_get_param(struct Scsi_Host *shost, 348 enum iscsi_host_param param, char *buf); 349 extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev); 350 extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht, 351 int dd_data_size, 352 bool xmit_can_sleep); 353 extern void iscsi_host_remove(struct Scsi_Host *shost); 354 extern void iscsi_host_free(struct Scsi_Host *shost); 355 extern int iscsi_target_alloc(struct scsi_target *starget); 356 357 /* 358 * session management 359 */ 360 extern struct iscsi_cls_session * 361 iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost, 362 uint16_t, int, uint32_t, unsigned int); 363 extern void iscsi_session_teardown(struct iscsi_cls_session *); 364 extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *); 365 extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn, 366 enum iscsi_param param, char *buf, int buflen); 367 extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session, 368 enum iscsi_param param, char *buf); 369 370 #define iscsi_session_printk(prefix, _sess, fmt, a...) \ 371 iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a) 372 373 /* 374 * connection management 375 */ 376 extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *, 377 int, uint32_t); 378 extern void iscsi_conn_teardown(struct iscsi_cls_conn *); 379 extern int iscsi_conn_start(struct iscsi_cls_conn *); 380 extern void iscsi_conn_stop(struct iscsi_cls_conn *, int); 381 extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *, 382 int); 383 extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err); 384 extern void iscsi_session_failure(struct iscsi_session *session, 385 enum iscsi_err err); 386 extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn, 387 enum iscsi_param param, char *buf); 388 extern void iscsi_suspend_tx(struct iscsi_conn *conn); 389 extern void iscsi_conn_queue_work(struct iscsi_conn *conn); 390 391 #define iscsi_conn_printk(prefix, _c, fmt, a...) \ 392 iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \ 393 fmt, ##a) 394 395 /* 396 * pdu and task processing 397 */ 398 extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *); 399 extern void iscsi_prep_data_out_pdu(struct iscsi_task *task, 400 struct iscsi_r2t_info *r2t, 401 struct iscsi_data *hdr); 402 extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *, 403 char *, uint32_t); 404 extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *, 405 char *, int); 406 extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *, 407 char *, int); 408 extern int iscsi_verify_itt(struct iscsi_conn *, itt_t); 409 extern struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *, itt_t); 410 extern struct iscsi_task *iscsi_itt_to_task(struct iscsi_conn *, itt_t); 411 extern void iscsi_requeue_task(struct iscsi_task *task); 412 extern void iscsi_put_task(struct iscsi_task *task); 413 extern void __iscsi_get_task(struct iscsi_task *task); 414 415 /* 416 * generic helpers 417 */ 418 extern void iscsi_pool_free(struct iscsi_pool *); 419 extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int); 420 421 /* 422 * inline functions to deal with padding. 423 */ 424 static inline unsigned int 425 iscsi_padded(unsigned int len) 426 { 427 return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1); 428 } 429 430 static inline unsigned int 431 iscsi_padding(unsigned int len) 432 { 433 len &= (ISCSI_PAD_LEN - 1); 434 if (len) 435 len = ISCSI_PAD_LEN - len; 436 return len; 437 } 438 439 #endif 440