1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2000 by Cisco Systems, Inc. All rights reserved. 23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _ISCSI_H 28 #define _ISCSI_H 29 30 /* 31 * Block comment which describes the contents of this file. 32 */ 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 #include <sys/scsi/scsi.h> 39 #include <sys/ddi.h> 40 #include <sys/sunddi.h> 41 #include <sys/socket.h> 42 #include <sys/kstat.h> 43 #include <sys/sunddi.h> 44 #include <sys/sunmdi.h> 45 #include <sys/mdi_impldefs.h> 46 #include <sys/time.h> 47 #include <sys/nvpair.h> 48 #include <sys/sdt.h> 49 50 #include <sys/scsi/adapters/iscsi_if.h> 51 #include <sys/scsi/adapters/iscsi_protocol.h> 52 #include <iscsiAuthClient.h> 53 #include <iscsi_stats.h> 54 #include <iscsi_thread.h> 55 #include <nvfile.h> 56 57 #ifndef MIN 58 #define MIN(a, b) ((a) < (b) ? (a) : (b)) 59 #endif 60 61 #ifndef TRUE 62 #define TRUE 1 63 #endif 64 65 #ifndef FALSE 66 #define FALSE 0 67 #endif 68 69 #define LOGIN_PDU_BUFFER_SIZE (16 * 1024) /* move somewhere else */ 70 71 /* 72 * Name Format of the different Task Queues 73 */ 74 #define ISCSI_SESS_IOTH_NAME_FORMAT "io_thrd_%d.%d" 75 #define ISCSI_SESS_WD_NAME_FORMAT "wd_thrd_%d.%d" 76 #define ISCSI_SESS_LOGIN_TASKQ_NAME_FORMAT "login_taskq_%d.%d" 77 #define ISCSI_CONN_RXTH_NAME_FORMAT "rx_thrd_%d.%d.%d" 78 #define ISCSI_CONN_TXTH_NAME_FORMAT "tx_thrd_%d.%d.%d" 79 80 /* 81 * The iSCSI driver will not build scatter/gather lists (iovec) longer 82 * than the value defined here. Asserts have been include in the code 83 * to check. 84 */ 85 #define ISCSI_MAX_IOVEC 5 86 87 #define ISCSI_DEFAULT_MAX_STORM_DELAY 32 88 89 /* 90 * The SNDBUF and RCVBUF size parameters for the sockets are just a 91 * guess for the time being (I think it is the values used by CISCO 92 * or UNH). Testing will have to be done to figure * out the impact 93 * of these values on performance. 94 */ 95 #define ISCSI_SOCKET_SNDBUF_SIZE (256 * 1024) 96 #define ISCSI_SOCKET_RCVBUF_SIZE (256 * 1024) 97 #define ISCSI_TCP_NODELAY_DEFAULT 0 98 #define ISCSI_TCP_CNOTIFY_THRESHOLD_DEFAULT 2000 99 #define ISCSI_TCP_CABORT_THRESHOLD_DEFAULT 10000 100 #define ISCSI_TCP_ABORT_THRESHOLD_DEFAULT (30 * 1000) /* milliseconds */ 101 #define ISNS_TCP_ABORT_THRESHOLD_DEFAULT (3 * 1000) /* milliseconds */ 102 103 /* 104 * timeout value in seconds that we will poll and wait for data to be return 105 * from the device 106 */ 107 #define ISCSI_RX_TIMEOUT_VALUE 60 108 109 /* 110 * Convenient short hand defines 111 */ 112 #define TARGET_PROP "target" 113 #define LUN_PROP "lun" 114 #define MDI_GUID "wwn" 115 #define NDI_GUID "client-guid" 116 117 #define ISCSI_SIG_CMD 0x11111111 118 #define ISCSI_SIG_LUN 0x22222222 119 #define ISCSI_SIG_CONN 0x33333333 120 #define ISCSI_SIG_SESS 0x44444444 121 #define ISCSI_SIG_HBA 0x55555555 122 123 #define SENDTARGETS_DISCOVERY "SENDTARGETS_DISCOVERY" 124 125 #define ISCSI_LUN_MASK_MSB 0x00003f00 126 #define ISCSI_LUN_MASK_LSB 0x000000ff 127 #define ISCSI_LUN_BYTE_COPY(lun, report_lun_data) \ 128 lun[0] = (report_lun_data & ISCSI_LUN_MASK_MSB) >> 8; \ 129 lun[1] = (report_lun_data & ISCSI_LUN_MASK_LSB); 130 /* 131 * Not defined by iSCSI, but used in the login code to 132 * determine when to send the initial Login PDU 133 */ 134 #define ISCSI_INITIAL_LOGIN_STAGE -1 135 136 typedef enum iscsi_status { 137 /* Success */ 138 ISCSI_STATUS_SUCCESS = 0, 139 /* Driver / Kernel / Code error */ 140 ISCSI_STATUS_INTERNAL_ERROR, 141 /* ITT table is already full, unable to reserve slot */ 142 ISCSI_STATUS_ITT_TABLE_FULL, 143 /* Login on connection failed */ 144 ISCSI_STATUS_LOGIN_FAILED, 145 /* No connections are in the LOGGED_IN state */ 146 ISCSI_STATUS_NO_CONN_LOGGED_IN, 147 /* TCP Transfer Error */ 148 ISCSI_STATUS_TCP_TX_ERROR, 149 /* TCP Receive Error */ 150 ISCSI_STATUS_TCP_RX_ERROR, 151 /* iSCSI packet RCV timeout */ 152 ISCSI_STATUS_RX_TIMEOUT, 153 /* iSCSI Header Digest CRC error */ 154 ISCSI_STATUS_HEADER_DIGEST_ERROR, 155 /* iSCSI Data Digest CRC error */ 156 ISCSI_STATUS_DATA_DIGEST_ERROR, 157 /* kmem_alloc failure */ 158 ISCSI_STATUS_ALLOC_FAILURE, 159 /* cmd (tran_abort/reset) failed */ 160 ISCSI_STATUS_CMD_FAILED, 161 /* iSCSI protocol error */ 162 ISCSI_STATUS_PROTOCOL_ERROR, 163 /* iSCSI protocol version mismatch */ 164 ISCSI_STATUS_VERSION_MISMATCH, 165 /* iSCSI login negotiation failed */ 166 ISCSI_STATUS_NEGO_FAIL, 167 /* iSCSI login authentication failed */ 168 ISCSI_STATUS_AUTHENTICATION_FAILED, 169 /* iSCSI login redirection failed */ 170 ISCSI_STATUS_REDIRECTION_FAILED, 171 /* iSCSI uscsi status failure */ 172 ISCSI_STATUS_USCSI_FAILED, 173 /* data received would have overflowed given buffer */ 174 ISCSI_STATUS_DATA_OVERFLOW, 175 /* session/connection needs to shutdown */ 176 ISCSI_STATUS_SHUTDOWN, 177 /* logical unit in use */ 178 ISCSI_STATUS_BUSY 179 } iscsi_status_t; 180 #define ISCSI_SUCCESS(status) (status == ISCSI_STATUS_SUCCESS) 181 182 /* SNA32 check value used on increment of CmdSn values */ 183 #define ISCSI_SNA32_CHECK 2147483648UL /* 2**31 */ 184 185 /* 186 * This is the maximum number of commands that can be outstanding 187 * on a iSCSI session at anyone point in time. 188 */ 189 #define ISCSI_CMD_TABLE_SIZE 1024 190 191 /* Used on connections thread create of receiver thread */ 192 extern pri_t minclsyspri; 193 194 /* 195 * Callers of iscsid_config_one/all must hold this 196 * semaphore across the calls. Otherwise a ndi_devi_enter() 197 * deadlock in the DDI layer may occur. 198 */ 199 extern ksema_t iscsid_config_semaphore; 200 201 extern kmutex_t iscsi_oid_mutex; 202 extern uint32_t iscsi_oid; 203 extern void *iscsi_state; 204 205 /* 206 * NOP delay is used to send a iSCSI NOP (ie. ping) across the 207 * wire to see if the target is still alive. NOPs are only 208 * sent when the RX thread hasn't received anything for the 209 * below amount of time. 210 */ 211 #define ISCSI_DEFAULT_NOP_DELAY 5 /* seconds */ 212 extern int iscsi_nop_delay; 213 /* 214 * If we haven't received anything in a specified period of time 215 * we will stop accepting IO via tran start. This will enable 216 * upper level drivers to see we might be having a problem and 217 * in the case of scsi_vhci will start to route IO down a better 218 * path. 219 */ 220 #define ISCSI_DEFAULT_RX_WINDOW 20 /* seconds */ 221 extern int iscsi_rx_window; 222 /* 223 * If we haven't received anything in a specified period of time 224 * we will stop accepting IO via tran start. This the max limit 225 * when encountered we will start returning a fatal error. 226 */ 227 #define ISCSI_DEFAULT_RX_MAX_WINDOW 180 /* seconds */ 228 extern int iscsi_rx_max_window; 229 230 /* 231 * During iscsi boot, if the boot session has been created, the 232 * initiator hasn't changed the boot lun to be online, we will wait 233 * 180s here for lun online by default. 234 */ 235 #define ISCSI_BOOT_DEFAULT_MAX_DELAY 180 /* seconds */ 236 /* 237 * +--------------------------------------------------------------------+ 238 * | iSCSI Driver Structures | 239 * +--------------------------------------------------------------------+ 240 */ 241 242 /* 243 * iSCSI Auth Information 244 */ 245 typedef struct iscsi_auth { 246 IscsiAuthStringBlock auth_recv_string_block; 247 IscsiAuthStringBlock auth_send_string_block; 248 IscsiAuthLargeBinary auth_recv_binary_block; 249 IscsiAuthLargeBinary auth_send_binary_block; 250 IscsiAuthClient auth_client_block; 251 int num_auth_buffers; 252 IscsiAuthBufferDesc auth_buffers[5]; 253 254 /* 255 * To indicate if bi-directional authentication is enabled. 256 * 0 means uni-directional authentication. 257 * 1 means bi-directional authentication. 258 */ 259 int bidirectional_auth; 260 261 /* Initiator's authentication information. */ 262 char username[iscsiAuthStringMaxLength]; 263 uint8_t password[iscsiAuthStringMaxLength]; 264 int password_length; 265 266 /* Target's authentication information. */ 267 char username_in[iscsiAuthStringMaxLength]; 268 uint8_t password_in[iscsiAuthStringMaxLength]; 269 int password_length_in; 270 } iscsi_auth_t; 271 272 /* 273 * iSCSI Task 274 */ 275 typedef struct iscsi_task { 276 void *t_arg; 277 boolean_t t_blocking; 278 } iscsi_task_t; 279 280 /* 281 * These are all the iscsi_cmd types that we use to track our 282 * commands between queues and actions. 283 */ 284 typedef enum iscsi_cmd_type { 285 ISCSI_CMD_TYPE_SCSI = 1, /* scsi cmd */ 286 ISCSI_CMD_TYPE_R2T, /* r2t */ 287 ISCSI_CMD_TYPE_NOP, /* nop / ping */ 288 ISCSI_CMD_TYPE_ABORT, /* abort */ 289 ISCSI_CMD_TYPE_RESET, /* reset */ 290 ISCSI_CMD_TYPE_LOGOUT, /* logout */ 291 ISCSI_CMD_TYPE_LOGIN, /* login */ 292 ISCSI_CMD_TYPE_TEXT /* text */ 293 } iscsi_cmd_type_t; 294 295 /* 296 * iscsi_cmd_state - (reference iscsi_cmd.c for state diagram) 297 */ 298 typedef enum iscsi_cmd_state { 299 ISCSI_CMD_STATE_FREE, 300 ISCSI_CMD_STATE_PENDING, 301 ISCSI_CMD_STATE_ACTIVE, 302 ISCSI_CMD_STATE_ABORTING, 303 ISCSI_CMD_STATE_COMPLETED 304 } iscsi_cmd_state_t; 305 306 /* 307 * iscsi command events 308 */ 309 typedef enum iscsi_cmd_event { 310 ISCSI_CMD_EVENT_E1, 311 ISCSI_CMD_EVENT_E2, 312 ISCSI_CMD_EVENT_E3, 313 ISCSI_CMD_EVENT_E4, 314 ISCSI_CMD_EVENT_E6, 315 ISCSI_CMD_EVENT_E7, 316 ISCSI_CMD_EVENT_E8 317 } iscsi_cmd_event_t; 318 319 /* 320 * iscsi text command stages - these stages are used by iSCSI text 321 * processing to manage long resonses. 322 */ 323 typedef enum iscsi_cmd_text_stage { 324 ISCSI_CMD_TEXT_INITIAL_REQ, 325 ISCSI_CMD_TEXT_CONTINUATION, 326 ISCSI_CMD_TEXT_FINAL_RSP 327 } iscsi_cmd_text_stage_t; 328 329 /* 330 * iscsi cmd misc flags - bitwise applicable 331 */ 332 #define ISCSI_CMD_MISCFLAG_INTERNAL 0x1 333 #define ISCSI_CMD_MISCFLAG_FREE 0x2 334 #define ISCSI_CMD_MISCFLAG_STUCK 0x4 335 #define ISCSI_CMD_MISCFLAG_XARQ 0x8 336 337 /* 338 * iSCSI cmd/pkt Structure 339 */ 340 typedef struct iscsi_cmd { 341 uint32_t cmd_sig; 342 struct iscsi_cmd *cmd_prev; 343 struct iscsi_cmd *cmd_next; 344 struct iscsi_conn *cmd_conn; 345 346 iscsi_cmd_type_t cmd_type; 347 iscsi_cmd_state_t cmd_state; 348 iscsi_cmd_state_t cmd_prev_state; 349 clock_t cmd_lbolt_pending; 350 clock_t cmd_lbolt_active; 351 clock_t cmd_lbolt_aborting; 352 clock_t cmd_lbolt_timeout; 353 uint8_t cmd_misc_flags; 354 355 union { 356 /* ISCSI_CMD_TYPE_SCSI */ 357 struct { 358 struct scsi_pkt *pkt; 359 struct buf *bp; 360 int cmdlen; 361 int statuslen; 362 size_t data_transferred; 363 364 uint32_t lun; 365 366 /* 367 * If SCSI_CMD_TYPE is in ABORTING_STATE 368 * then the abort_icmdp field will be a pointer 369 * to the abort command chasing this one. 370 */ 371 struct iscsi_cmd *abort_icmdp; 372 /* 373 * pointer to the r2t associated with this 374 * command (if any) 375 */ 376 struct iscsi_cmd *r2t_icmdp; 377 } scsi; 378 /* ISCSI_CMD_TYPE_ABORT */ 379 struct { 380 /* pointer to original iscsi_cmd, for abort */ 381 struct iscsi_cmd *icmdp; 382 } abort; 383 /* ISCSI_CMD_TYPE_RESET */ 384 struct { 385 int level; 386 } reset; 387 /* ISCSI_CMD_TYPE_NOP */ 388 struct { 389 int rsvd; 390 } nop; 391 /* ISCSI_CMD_TYPE_R2T */ 392 struct { 393 struct iscsi_cmd *icmdp; 394 uint32_t offset; 395 uint32_t length; 396 } r2t; 397 /* ISCSI_CMD_TYPE_LOGIN */ 398 struct { 399 int rvsd; 400 } login; 401 /* ISCSI_CMD_TYPE_LOGOUT */ 402 struct { 403 int rsvd; 404 } logout; 405 /* ISCSI_CMD_TYPE_TEXT */ 406 struct { 407 char *buf; 408 int buf_len; 409 uint32_t offset; 410 uint32_t data_len; 411 uint32_t total_rx_len; 412 uint32_t ttt; 413 uint8_t lun[8]; 414 iscsi_cmd_text_stage_t stage; 415 } text; 416 } cmd_un; 417 418 struct iscsi_lun *cmd_lun; /* associated lun */ 419 420 uint32_t cmd_itt; 421 uint32_t cmd_ttt; 422 423 /* 424 * If a data digest error is seem on a data pdu. This flag 425 * will get set. We don't abort the cmd immediately because 426 * we want to read in all the data to get it out of the 427 * stream. Once the completion for the cmd is received we 428 * we will abort the cmd and state no sense data was available. 429 */ 430 boolean_t cmd_crc_error_seen; 431 432 /* 433 * Used to block and wake up caller until action is completed. 434 * This is for ABORT, RESET, and PASSTHRU cmds. 435 */ 436 int cmd_result; 437 int cmd_completed; 438 kmutex_t cmd_mutex; 439 kcondvar_t cmd_completion; 440 441 } iscsi_cmd_t; 442 443 444 /* 445 * iSCSI LUN Structure 446 */ 447 typedef struct iscsi_lun { 448 uint32_t lun_sig; 449 int lun_state; 450 451 struct iscsi_lun *lun_next; /* next lun on this sess. */ 452 struct iscsi_sess *lun_sess; /* parent sess. for lun */ 453 dev_info_t *lun_dip; 454 mdi_pathinfo_t *lun_pip; 455 456 uint16_t lun_num; /* LUN */ 457 uint8_t lun_addr_type; /* LUN addressing type */ 458 uint32_t lun_oid; /* OID */ 459 char *lun_guid; /* GUID */ 460 int lun_guid_size; /* GUID allocation size */ 461 char *lun_addr; /* sess,lun */ 462 time_t lun_time_online; 463 464 uchar_t lun_cap; /* bitmap of scsi caps */ 465 466 uchar_t lun_vid[ISCSI_INQ_VID_BUF_LEN]; /* Vendor ID */ 467 uchar_t lun_pid[ISCSI_INQ_PID_BUF_LEN]; /* Product ID */ 468 } iscsi_lun_t; 469 470 #define ISCSI_LUN_STATE_OFFLINE 0 471 #define ISCSI_LUN_STATE_ONLINE 1 472 473 #define ISCSI_LUN_CAP_RESET 0x01 474 475 /* 476 * iscsi_conn_state - (reference iscsi_conn.c for state diagram) 477 */ 478 typedef enum iscsi_conn_state { 479 ISCSI_CONN_STATE_FREE, 480 ISCSI_CONN_STATE_IN_LOGIN, 481 ISCSI_CONN_STATE_LOGGED_IN, 482 ISCSI_CONN_STATE_IN_LOGOUT, 483 ISCSI_CONN_STATE_FAILED, 484 ISCSI_CONN_STATE_POLLING 485 } iscsi_conn_state_t; 486 487 #define ISCSI_CONN_STATE_FULL_FEATURE(state) \ 488 ((state == ISCSI_CONN_STATE_LOGGED_IN) || \ 489 (state == ISCSI_CONN_STATE_IN_LOGOUT)) 490 491 /* 492 * iscsi connection events - (reference iscsi_conn.c for state diagram) 493 */ 494 typedef enum iscsi_conn_event { 495 ISCSI_CONN_EVENT_T1, 496 ISCSI_CONN_EVENT_T5, 497 ISCSI_CONN_EVENT_T7, 498 ISCSI_CONN_EVENT_T8, 499 ISCSI_CONN_EVENT_T9, 500 ISCSI_CONN_EVENT_T11, 501 ISCSI_CONN_EVENT_T12, 502 ISCSI_CONN_EVENT_T13, 503 ISCSI_CONN_EVENT_T14, 504 ISCSI_CONN_EVENT_T15, 505 ISCSI_CONN_EVENT_T17, 506 ISCSI_CONN_EVENT_T30 507 } iscsi_conn_event_t; 508 509 /* 510 * 511 * 512 */ 513 typedef struct iscsi_queue { 514 iscsi_cmd_t *head; 515 iscsi_cmd_t *tail; 516 int count; 517 kmutex_t mutex; 518 } iscsi_queue_t; 519 520 #define ISCSI_CONN_DEFAULT_LOGIN_MIN 0 521 #define ISCSI_CONN_DEFAULT_LOGIN_MAX 180 522 #define ISCSI_CONN_DEFAULT_LOGIN_REDIRECT 10 523 524 typedef union iscsi_sockaddr { 525 struct sockaddr sin; 526 struct sockaddr_in sin4; 527 struct sockaddr_in6 sin6; 528 } iscsi_sockaddr_t; 529 530 #define SIZEOF_SOCKADDR(so) ((so)->sa_family == AF_INET ? \ 531 sizeof (struct sockaddr_in) : sizeof (struct sockaddr_in6)) 532 533 /* 534 * iSCSI Connection Structure 535 */ 536 typedef struct iscsi_conn { 537 uint32_t conn_sig; 538 struct iscsi_conn *conn_next; /* next conn on this sess. */ 539 struct iscsi_sess *conn_sess; /* parent sess. for conn. */ 540 541 iscsi_conn_state_t conn_state; /* cur. conn. driver state */ 542 iscsi_conn_state_t conn_prev_state; /* prev. conn. driver state */ 543 clock_t conn_state_lbolt; 544 /* protects the session state and synchronizes the state machine */ 545 kmutex_t conn_state_mutex; 546 kcondvar_t conn_state_change; 547 boolean_t conn_state_destroy; 548 549 void *conn_socket; /* kernel socket */ 550 551 /* base connection information */ 552 iscsi_sockaddr_t conn_base_addr; 553 554 /* current connection information, may have been redirected */ 555 iscsi_sockaddr_t conn_curr_addr; 556 557 /* current connection information, may have been redirected */ 558 boolean_t conn_bound; 559 iscsi_sockaddr_t conn_bound_addr; 560 561 uint32_t conn_cid; /* CID */ 562 uint32_t conn_oid; /* OID */ 563 564 int conn_current_stage; /* iSCSI login stage */ 565 int conn_next_stage; /* iSCSI login stage */ 566 int conn_partial_response; 567 568 /* 569 * The active queue contains iscsi_cmds that have already 570 * been sent on this connection. Any future responses to 571 * these cmds require alligence to this connection. If there 572 * are issues with these cmds the command may need aborted 573 * depending on the command type, and must be put back into 574 * the session's pending queue or aborted. 575 */ 576 iscsi_queue_t conn_queue_active; 577 578 /* lbolt from the last receive, used for nop processing */ 579 clock_t conn_rx_lbolt; 580 clock_t conn_nop_lbolt; 581 582 iscsi_thread_t *conn_rx_thread; 583 iscsi_thread_t *conn_tx_thread; 584 585 /* 586 * The expstatsn is the command status sn that is expected 587 * next from the target. Command status is carried on a number 588 * of iSCSI PDUs (ex. SCSI Cmd Response, SCSI Data IN with 589 * S-Bit set, ...), not all PDUs. If our expstatsn is different 590 * than the received statsn. Something got out of sync we need to 591 * recover. 592 */ 593 uint32_t conn_expstatsn; 594 uint32_t conn_laststatsn; 595 596 /* active login parameters */ 597 iscsi_login_params_t conn_params; 598 599 /* Statistics */ 600 struct { 601 kstat_t *ks; 602 iscsi_conn_stats_t ks_data; 603 } stats; 604 605 /* 606 * login min and max identify the amount of time 607 * in lbolt that iscsi_start_login() should attempt 608 * to log into a target portal. The login will 609 * delay until the min lbolt has been reached and 610 * will end once max time has been reached. These 611 * values are normally set to the default but can 612 * are also altered by async commands received from 613 * the targetlogin. 614 */ 615 clock_t conn_login_min; 616 clock_t conn_login_max; 617 } iscsi_conn_t; 618 619 620 /* 621 * iscsi_conn_state - (reference iscsi_sess.c for state diagram) 622 */ 623 typedef enum iscsi_sess_state { 624 ISCSI_SESS_STATE_FREE, 625 ISCSI_SESS_STATE_LOGGED_IN, 626 ISCSI_SESS_STATE_FAILED, 627 ISCSI_SESS_STATE_IN_FLUSH, 628 ISCSI_SESS_STATE_FLUSHED 629 } iscsi_sess_state_t; 630 631 #define ISCSI_SESS_STATE_FULL_FEATURE(state) \ 632 ((state == ISCSI_SESS_STATE_LOGGED_IN) || \ 633 (state == ISCSI_SESS_STATE_IN_FLUSH)) 634 635 636 typedef enum iscsi_sess_event { 637 ISCSI_SESS_EVENT_N1, 638 ISCSI_SESS_EVENT_N3, 639 ISCSI_SESS_EVENT_N5, 640 ISCSI_SESS_EVENT_N6, 641 ISCSI_SESS_EVENT_N7 642 } iscsi_sess_event_t; 643 644 typedef enum iscsi_sess_type { 645 ISCSI_SESS_TYPE_NORMAL, 646 ISCSI_SESS_TYPE_DISCOVERY 647 } iscsi_sess_type_t; 648 649 #define SESS_ABORT_TASK_MAX_THREADS 1 650 651 /* Sun's initiator session ID */ 652 #define ISCSI_SUN_ISID_0 0x40 /* ISID - EN format */ 653 #define ISCSI_SUN_ISID_1 0x00 /* Sec B */ 654 #define ISCSI_SUN_ISID_2 0x00 /* Sec B */ 655 #define ISCSI_SUN_ISID_3 0x2A /* Sec C - 42 = Sun's EN */ 656 /* 657 * defines 4-5 are the reserved values. These reserved values 658 * are used as the ISID for an initiator-port in MP-API and used 659 * for the send targets discovery sessions. Byte 5 is overridden 660 * for full feature sessions. The default values of byte 5 for a 661 * full feature session is 0. When MS/T is enabled with more than 662 * one session this byte 5 will increment > 0 up to 663 * ISCSI_MAX_CONFIG_SESSIONS. 664 */ 665 #define ISCSI_SUN_ISID_4 0x00 666 #define ISCSI_SUN_ISID_5 0xFF 667 668 #define ISCSI_DEFAULT_SESS_BOUND B_FALSE 669 #define ISCSI_DEFAULT_SESS_NUM 1 670 671 /* 672 * iSCSI Session(Target) Structure 673 */ 674 typedef struct iscsi_sess { 675 uint32_t sess_sig; 676 677 iscsi_sess_state_t sess_state; 678 iscsi_sess_state_t sess_prev_state; 679 clock_t sess_state_lbolt; 680 /* protects the session state and synchronizes the state machine */ 681 kmutex_t sess_state_mutex; 682 683 /* 684 * Associated target OID. 685 */ 686 uint32_t sess_target_oid; 687 688 /* 689 * Session OID. Used by IMA, interfaces and exported as 690 * TARGET_PROP which is checked by the NDI. In addition 691 * this is used in our tran_lun_init function. 692 */ 693 uint32_t sess_oid; 694 695 struct iscsi_sess *sess_next; 696 struct iscsi_hba *sess_hba; 697 698 /* list of all luns relating to session */ 699 struct iscsi_lun *sess_lun_list; 700 krwlock_t sess_lun_list_rwlock; 701 702 /* list of all connections relating to session */ 703 struct iscsi_conn *sess_conn_list; 704 struct iscsi_conn *sess_conn_list_last_ptr; 705 /* pointer to active connection in session */ 706 struct iscsi_conn *sess_conn_act; 707 krwlock_t sess_conn_list_rwlock; 708 709 /* Connection ID for next connection to be added to session */ 710 uint32_t sess_conn_next_cid; 711 712 /* 713 * last time any connection on this session received 714 * data from the target. 715 */ 716 clock_t sess_rx_lbolt; 717 718 clock_t sess_failure_lbolt; 719 720 int sess_storm_delay; 721 722 /* 723 * sess_cmdsn_mutex protects the cmdsn and itt table/values 724 * Cmdsn isn't that big of a problem yet since we only have 725 * one connection but in the future we will need to ensure 726 * this locking is working so keep the sequence numbers in 727 * sync on the wire. 728 * 729 * We also use this lock to protect the ITT table and it's 730 * values. We need to make sure someone doesn't assign 731 * a duplicate ITT value or cell to a command. Also we 732 * need to make sure when someone is looking up an ITT 733 * that the command is still in that correct queue location. 734 */ 735 kmutex_t sess_cmdsn_mutex; 736 737 /* 738 * iSCSI command sequencing / windowing. The next 739 * command to be sent via the pending queue will 740 * get the sess_cmdsn. If the maxcmdsn is less 741 * than the next cmdsn then the iSCSI window is 742 * closed and this command cannot be sent yet. 743 * Most iscsi cmd responses from the target carry 744 * a new maxcmdsn. If this new maxcmdsn is greater 745 * than the sess_maxcmdsn we will update it's value 746 * and set a timer to fire in one tick and reprocess 747 * the pending queue. 748 * 749 * The expcmdsn. Is the value the target expects 750 * to be sent for my next cmdsn. If the expcmdsn 751 * and the cmdsn get out of sync this could denote 752 * a communication problem. 753 */ 754 uint32_t sess_cmdsn; 755 uint32_t sess_expcmdsn; 756 uint32_t sess_maxcmdsn; 757 758 /* Next Initiator Task Tag (ITT) to use */ 759 uint32_t sess_itt; 760 /* 761 * The session iscsi_cmd table is used to a fast performance 762 * lookup of an ITT to a iscsi_cmd when we receive an iSCSI 763 * PDU from the wire. To reserve a location in the sess_cmd_table 764 * we try the sess_itt % ISCSI_CMD_TABLE_SIZE if this cmd table 765 * cell is already full. Then increament the sess_itt and 766 * try to get the cell position again, repeat until an empty 767 * cell is found. Once an empty cell is found place your 768 * scsi_cmd point into the cell to reserve the location. This 769 * selection process should be done while holding the session's 770 * mutex. 771 */ 772 struct iscsi_cmd *sess_cmd_table[ISCSI_CMD_TABLE_SIZE]; 773 int sess_cmd_table_count; 774 775 /* 776 * The pending queue contains all iscsi_cmds that require an 777 * open MaxCmdSn window to be put on the wire and haven't 778 * been placed on the wire. Once placed on the wire they 779 * will be moved to a connections specific active queue. 780 */ 781 iscsi_queue_t sess_queue_pending; 782 783 iscsi_error_t sess_last_err; 784 785 iscsi_queue_t sess_queue_completion; 786 /* configured login parameters */ 787 iscsi_login_params_t sess_params; 788 789 /* general iSCSI protocol/session info */ 790 uchar_t sess_name[ISCSI_MAX_NAME_LEN]; 791 int sess_name_length; 792 char sess_alias[ISCSI_MAX_NAME_LEN]; 793 int sess_alias_length; 794 iSCSIDiscoveryMethod_t sess_discovered_by; 795 iscsi_sockaddr_t sess_discovered_addr; 796 uchar_t sess_isid[ISCSI_ISID_LEN]; /* Session ID */ 797 uint16_t sess_tsid; /* Target ID */ 798 /* 799 * If the target portal group tag(TPGT) is equal to ISCSI_DEFAULT_TPGT 800 * then the initiator will accept a successful login with any TPGT 801 * specified by the target. If a none default TPGT is configured 802 * then we will only successfully accept a login with that matching 803 * TPGT value. 804 */ 805 int sess_tpgt_conf; 806 /* This field records the negotiated TPGT value, preserved for dtrace */ 807 int sess_tpgt_nego; 808 809 /* 810 * Authentication information. 811 * 812 * DCW: Again IMA seems to take a session view at this 813 * information. 814 */ 815 iscsi_auth_t sess_auth; 816 817 /* Statistics */ 818 struct { 819 kstat_t *ks; 820 iscsi_sess_stats_t ks_data; 821 kstat_t *ks_io; 822 kstat_io_t ks_io_data; 823 kmutex_t ks_io_lock; 824 } stats; 825 826 iscsi_thread_t *sess_ic_thread; 827 boolean_t sess_window_open; 828 boolean_t sess_boot; 829 iscsi_sess_type_t sess_type; 830 831 boolean_t sess_enum_in_progress; 832 833 ddi_taskq_t *sess_taskq; 834 835 iscsi_thread_t *sess_wd_thread; 836 837 } iscsi_sess_t; 838 839 840 /* 841 * iscsi_network 842 */ 843 typedef struct iscsi_network { 844 void* (*socket)(int domain, int, int); 845 int (*bind)(void *, struct sockaddr *, int, int, int); 846 int (*connect)(void *, struct sockaddr *, int, int, int); 847 int (*listen)(void *, int); 848 void* (*accept)(void *, struct sockaddr *, int *); 849 int (*getsockname)(void *, struct sockaddr *, socklen_t *); 850 int (*getsockopt)(void *, int, int, void *, int *, int); 851 int (*setsockopt)(void *, int, int, void *, int); 852 int (*shutdown)(void *, int); 853 void (*close)(void *); 854 855 size_t (*poll)(void *, clock_t); 856 size_t (*sendmsg)(void *, struct msghdr *); 857 size_t (*recvmsg)(void *, struct msghdr *, int); 858 859 iscsi_status_t (*sendpdu)(void *, iscsi_hdr_t *, char *, int); 860 iscsi_status_t (*recvdata)(void *, iscsi_hdr_t *, char *, 861 int, int, int); 862 iscsi_status_t (*recvhdr)(void *, iscsi_hdr_t *, int, int, int); 863 864 struct { 865 int sndbuf; 866 int rcvbuf; 867 int nodelay; 868 int conn_notify_threshold; 869 int conn_abort_threshold; 870 int abort_threshold; 871 } tweaks; 872 } iscsi_network_t; 873 874 #define ISCSI_NET_HEADER_DIGEST 0x00000001 875 #define ISCSI_NET_DATA_DIGEST 0x00000002 876 877 extern iscsi_network_t *iscsi_net; 878 879 /* 880 * If we get bus_config requests in less than 5 seconds 881 * apart skip the name services re-discovery and just 882 * complete the requested logins. This protects against 883 * bus_config storms from stale /dev links. 884 */ 885 #define ISCSI_CONFIG_STORM_DELAY_DEFAULT 5 886 887 /* 888 * iSCSI HBA Structure 889 */ 890 typedef struct iscsi_hba { 891 uint32_t hba_sig; 892 dev_info_t *hba_dip; /* dev info ptr */ 893 scsi_hba_tran_t *hba_tran; /* scsi tran ptr */ 894 895 struct iscsi_sess *hba_sess_list; /* sess. list for hba */ 896 krwlock_t hba_sess_list_rwlock; /* protect sess. list */ 897 898 /* lbolt of the last time we received a config request */ 899 clock_t hba_config_lbolt; 900 /* current number of seconds to protect against bus config storms */ 901 int hba_config_storm_delay; 902 903 /* general iSCSI protocol hba/initiator info */ 904 uchar_t hba_name[ISCSI_MAX_NAME_LEN]; 905 int hba_name_length; 906 uchar_t hba_alias[ISCSI_MAX_NAME_LEN]; 907 int hba_alias_length; 908 909 /* Default SessionID for HBA */ 910 uchar_t hba_isid[ISCSI_ISID_LEN]; 911 912 /* Default HBA wide settings */ 913 iscsi_login_params_t hba_params; 914 915 /* 916 * There's only one HBA and it's set to ISCSI_INITIATOR_OID 917 * (value of 1) at the beginning of time. 918 */ 919 uint32_t hba_oid; 920 921 /* 922 * Keep track of which events have been sent. User daemons request 923 * this information so they don't wait for events which they won't 924 * see. 925 */ 926 kmutex_t hba_discovery_events_mutex; 927 iSCSIDiscoveryMethod_t hba_discovery_events; 928 boolean_t hba_discovery_in_progress; 929 930 boolean_t hba_mpxio_enabled; /* mpxio-enabled */ 931 boolean_t persistent_loaded; /* persistent_loaded */ 932 933 /* 934 * Ensures only one SendTargets operation occurs at a time 935 */ 936 ksema_t hba_sendtgts_semaphore; 937 938 /* 939 * Statistics 940 */ 941 struct { 942 kstat_t *ks; 943 iscsi_hba_stats_t ks_data; 944 } stats; 945 } iscsi_hba_t; 946 947 /* 948 * +--------------------------------------------------------------------+ 949 * | iSCSI prototypes | 950 * +--------------------------------------------------------------------+ 951 */ 952 953 /* iscsi_io.c */ 954 int iscsi_sna_lte(uint32_t n1, uint32_t n2); 955 char *iscsi_get_next_text(char *data, int data_length, char *curr_text); 956 957 void iscsi_ic_thread(iscsi_thread_t *thread, void *arg); 958 void iscsi_tx_thread(iscsi_thread_t *thread, void *arg); 959 void iscsi_rx_thread(iscsi_thread_t *thread, void *arg); 960 void iscsi_wd_thread(iscsi_thread_t *thread, void *arg); 961 962 iscsi_status_t iscsi_tx_cmd(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 963 964 void iscsi_handle_abort(void *arg); 965 iscsi_status_t iscsi_handle_reset(iscsi_sess_t *isp, int level, 966 iscsi_lun_t *ilp); 967 iscsi_status_t iscsi_handle_logout(iscsi_conn_t *icp); 968 iscsi_status_t iscsi_handle_passthru(iscsi_sess_t *isp, uint16_t lun, 969 struct uscsi_cmd *ucmdp); 970 iscsi_status_t iscsi_handle_text(iscsi_conn_t *icp, 971 char *buf, uint32_t buf_len, uint32_t data_len, uint32_t *rx_data_len); 972 973 void iscsi_iodone(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 974 975 /* iscsi_crc.c */ 976 uint32_t iscsi_crc32c(void *address, unsigned long length); 977 uint32_t iscsi_crc32c_continued(void *address, unsigned long length, 978 uint32_t crc); 979 980 /* iscsi_queue.c */ 981 void iscsi_init_queue(iscsi_queue_t *queue); 982 void iscsi_destroy_queue(iscsi_queue_t *queue); 983 void iscsi_enqueue_pending_cmd(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 984 void iscsi_dequeue_pending_cmd(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 985 void iscsi_enqueue_active_cmd(iscsi_conn_t *icp, iscsi_cmd_t *icmdp); 986 void iscsi_dequeue_active_cmd(iscsi_conn_t *icp, iscsi_cmd_t *icmdp); 987 void iscsi_enqueue_completed_cmd(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 988 iscsi_status_t iscsi_dequeue_cmd(iscsi_cmd_t **, iscsi_cmd_t **, iscsi_cmd_t *); 989 void iscsi_move_queue(iscsi_queue_t *src_queue, iscsi_queue_t *dst_queue); 990 void iscsi_enqueue_cmd_head(iscsi_cmd_t **, iscsi_cmd_t **, 991 iscsi_cmd_t *); 992 993 /* iscsi_login.c */ 994 iscsi_status_t iscsi_login_start(void *arg); 995 996 /* iscsi_stats.c */ 997 boolean_t iscsi_hba_kstat_init(struct iscsi_hba *ihp); 998 boolean_t iscsi_hba_kstat_term(struct iscsi_hba *ihp); 999 boolean_t iscsi_sess_kstat_init(struct iscsi_sess *isp); 1000 boolean_t iscsi_sess_kstat_term(struct iscsi_sess *isp); 1001 boolean_t iscsi_conn_kstat_init(struct iscsi_conn *icp); 1002 void iscsi_conn_kstat_term(struct iscsi_conn *icp); 1003 1004 /* iscsi_net.c */ 1005 void iscsi_net_init(); 1006 void iscsi_net_fini(); 1007 1008 /* iscsi_sess.c */ 1009 iscsi_sess_t *iscsi_sess_create(iscsi_hba_t *ihp, 1010 iSCSIDiscoveryMethod_t method, struct sockaddr *addr_dsc, 1011 char *target_name, int tpgt, uchar_t isid_lsb, 1012 iscsi_sess_type_t type, uint32_t *oid); 1013 void iscsi_sess_online(iscsi_sess_t *isp); 1014 int iscsi_sess_get(uint32_t oid, iscsi_hba_t *ihp, iscsi_sess_t **ispp); 1015 iscsi_status_t iscsi_sess_destroy(iscsi_sess_t *isp); 1016 void iscsi_sess_state_machine(iscsi_sess_t *isp, iscsi_sess_event_t event); 1017 char *iscsi_sess_state_str(iscsi_sess_state_t state); 1018 boolean_t iscsi_sess_set_auth(iscsi_sess_t *isp); 1019 iscsi_status_t iscsi_sess_reserve_itt(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 1020 void iscsi_sess_release_itt(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 1021 void iscsi_sess_redrive_io(iscsi_sess_t *isp); 1022 int iscsi_sess_get_by_target(uint32_t target_oid, iscsi_hba_t *ihp, 1023 iscsi_sess_t **ispp); 1024 1025 1026 /* iscsi_conn.c */ 1027 iscsi_status_t iscsi_conn_create(struct sockaddr *addr, iscsi_sess_t *isp, 1028 iscsi_conn_t **icpp); 1029 iscsi_status_t iscsi_conn_offline(iscsi_conn_t *icp); 1030 iscsi_status_t iscsi_conn_destroy(iscsi_conn_t *icp); 1031 iscsi_status_t iscsi_conn_state_machine(iscsi_conn_t *icp, 1032 iscsi_conn_event_t event); 1033 char *iscsi_conn_state_str(iscsi_conn_state_t state); 1034 void iscsi_conn_set_login_min_max(iscsi_conn_t *icp, int min, int max); 1035 iscsi_status_t iscsi_conn_sync_params(iscsi_conn_t *icp); 1036 1037 /* iscsi_lun.c */ 1038 iscsi_status_t iscsi_lun_create(iscsi_sess_t *isp, uint16_t lun_num, 1039 uint8_t lun_addr_type, struct scsi_inquiry *inq, char *guid); 1040 iscsi_status_t iscsi_lun_destroy(iscsi_hba_t *ihp, 1041 iscsi_lun_t *ilp); 1042 void iscsi_lun_online(iscsi_hba_t *ihp, 1043 iscsi_lun_t *ilp); 1044 iscsi_status_t iscsi_lun_offline(iscsi_hba_t *ihp, 1045 iscsi_lun_t *ilp, boolean_t lun_free); 1046 1047 /* iscsi_cmd.c */ 1048 void iscsi_cmd_state_machine(iscsi_cmd_t *icmdp, 1049 iscsi_cmd_event_t event, void *arg); 1050 iscsi_cmd_t *iscsi_cmd_alloc(iscsi_conn_t *icp, int km_flags); 1051 void iscsi_cmd_free(iscsi_cmd_t *icmdp); 1052 1053 /* iscsi_ioctl.c */ 1054 int iscsi_ioctl(dev_t, int, intptr_t, int, cred_t *, int *); 1055 void * iscsi_ioctl_copyin(caddr_t arg, int mode, size_t size); 1056 int iscsi_ioctl_copyout(void *data, size_t size, caddr_t arg, int mode); 1057 iscsi_conn_list_t *iscsi_ioctl_conn_oid_list_get_copyin(caddr_t, int); 1058 int iscsi_ioctl_conn_oid_list_get_copyout(iscsi_conn_list_t *, caddr_t, int); 1059 boolean_t iscsi_ioctl_conn_oid_list_get(iscsi_hba_t *ihp, 1060 iscsi_conn_list_t *cl); 1061 boolean_t iscsi_ioctl_conn_props_get(iscsi_hba_t *ihp, iscsi_conn_props_t *cp); 1062 int iscsi_ioctl_sendtgts_get(iscsi_hba_t *ihp, iscsi_sendtgts_list_t *stl); 1063 int iscsi_target_prop_mod(iscsi_hba_t *, iscsi_property_t *, int cmd); 1064 int iscsi_set_params(iscsi_param_set_t *, iscsi_hba_t *, boolean_t); 1065 int iscsi_get_persisted_param(uchar_t *, iscsi_param_get_t *, 1066 iscsi_login_params_t *); 1067 void iscsi_set_default_login_params(iscsi_login_params_t *params); 1068 int iscsi_ioctl_get_config_sess(iscsi_hba_t *ihp, 1069 iscsi_config_sess_t *ics); 1070 int iscsi_ioctl_set_config_sess(iscsi_hba_t *ihp, 1071 iscsi_config_sess_t *ics); 1072 /* ioctls prototypes */ 1073 int iscsi_get_param(iscsi_login_params_t *params, 1074 boolean_t valid_flag, 1075 iscsi_param_get_t *ipgp); 1076 1077 /* iscsid.c */ 1078 boolean_t iscsid_init(iscsi_hba_t *ihp, boolean_t restart); 1079 void iscsid_fini(); 1080 void iscsid_props(iSCSIDiscoveryProperties_t *props); 1081 boolean_t iscsid_enable_discovery(iscsi_hba_t *ihp, 1082 iSCSIDiscoveryMethod_t idm, boolean_t poke); 1083 boolean_t iscsid_disable_discovery(iscsi_hba_t *ihp, 1084 iSCSIDiscoveryMethod_t idm); 1085 void iscsid_poke_discovery(iscsi_hba_t *ihp, iSCSIDiscoveryMethod_t method); 1086 void iscsid_do_sendtgts(entry_t *discovery_addr); 1087 void iscsid_do_isns_query_one_server( 1088 iscsi_hba_t *ihp, entry_t *isns_addr); 1089 void iscsid_do_isns_query(iscsi_hba_t *ihp); 1090 void iscsid_config_one(iscsi_hba_t *ihp, 1091 char *name, boolean_t protect); 1092 void iscsid_config_all(iscsi_hba_t *ihp, boolean_t protect); 1093 void iscsid_unconfig_one(iscsi_hba_t *ihp, char *name); 1094 void iscsid_unconfig_all(iscsi_hba_t *ihp); 1095 void isns_scn_callback(void *arg); 1096 boolean_t iscsid_del(iscsi_hba_t *ihp, char *target_name, 1097 iSCSIDiscoveryMethod_t method, struct sockaddr *addr_dsc); 1098 boolean_t iscsid_login_tgt(iscsi_hba_t *ihp, char *target_name, 1099 iSCSIDiscoveryMethod_t method, struct sockaddr *addr_dsc); 1100 void iscsid_addr_to_sockaddr(int src_insize, void *src_addr, int src_port, 1101 struct sockaddr *dst_addr); 1102 boolean_t iscsi_reconfig_boot_sess(iscsi_hba_t *ihp); 1103 boolean_t iscsi_chk_bootlun_mpxio(iscsi_hba_t *ihp); 1104 boolean_t iscsi_cmp_boot_ini_name(char *name); 1105 boolean_t iscsi_cmp_boot_tgt_name(char *name); 1106 1107 extern void bcopy(const void *s1, void *s2, size_t n); 1108 extern void bzero(void *s, size_t n); 1109 /* 1110 * Here we need a contract for inet_ntop() and inet_pton() 1111 * in uts/common/inet/ip/inet_ntop.c 1112 */ 1113 extern char *inet_ntop(int af, const void *addr, char *buf, int addrlen); 1114 extern int inet_pton(int af, char *inp, void *outp); 1115 1116 #ifdef __cplusplus 1117 } 1118 #endif 1119 1120 #endif /* _ISCSI_H */ 1121