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 * +--------------------------------------------------------------------+ 232 * | iSCSI Driver Structures | 233 * +--------------------------------------------------------------------+ 234 */ 235 236 /* 237 * iSCSI Auth Information 238 */ 239 typedef struct iscsi_auth { 240 IscsiAuthStringBlock auth_recv_string_block; 241 IscsiAuthStringBlock auth_send_string_block; 242 IscsiAuthLargeBinary auth_recv_binary_block; 243 IscsiAuthLargeBinary auth_send_binary_block; 244 IscsiAuthClient auth_client_block; 245 int num_auth_buffers; 246 IscsiAuthBufferDesc auth_buffers[5]; 247 248 /* 249 * To indicate if bi-directional authentication is enabled. 250 * 0 means uni-directional authentication. 251 * 1 means bi-directional authentication. 252 */ 253 int bidirectional_auth; 254 255 /* Initiator's authentication information. */ 256 char username[iscsiAuthStringMaxLength]; 257 uint8_t password[iscsiAuthStringMaxLength]; 258 int password_length; 259 260 /* Target's authentication information. */ 261 char username_in[iscsiAuthStringMaxLength]; 262 uint8_t password_in[iscsiAuthStringMaxLength]; 263 int password_length_in; 264 } iscsi_auth_t; 265 266 /* 267 * iSCSI Task 268 */ 269 typedef struct iscsi_task { 270 void *t_arg; 271 boolean_t t_blocking; 272 } iscsi_task_t; 273 274 /* 275 * These are all the iscsi_cmd types that we use to track our 276 * commands between queues and actions. 277 */ 278 typedef enum iscsi_cmd_type { 279 ISCSI_CMD_TYPE_SCSI = 1, /* scsi cmd */ 280 ISCSI_CMD_TYPE_R2T, /* r2t */ 281 ISCSI_CMD_TYPE_NOP, /* nop / ping */ 282 ISCSI_CMD_TYPE_ABORT, /* abort */ 283 ISCSI_CMD_TYPE_RESET, /* reset */ 284 ISCSI_CMD_TYPE_LOGOUT, /* logout */ 285 ISCSI_CMD_TYPE_LOGIN, /* login */ 286 ISCSI_CMD_TYPE_TEXT /* text */ 287 } iscsi_cmd_type_t; 288 289 /* 290 * iscsi_cmd_state - (reference iscsi_cmd.c for state diagram) 291 */ 292 typedef enum iscsi_cmd_state { 293 ISCSI_CMD_STATE_FREE, 294 ISCSI_CMD_STATE_PENDING, 295 ISCSI_CMD_STATE_ACTIVE, 296 ISCSI_CMD_STATE_ABORTING, 297 ISCSI_CMD_STATE_COMPLETED 298 } iscsi_cmd_state_t; 299 300 /* 301 * iscsi command events 302 */ 303 typedef enum iscsi_cmd_event { 304 ISCSI_CMD_EVENT_E1, 305 ISCSI_CMD_EVENT_E2, 306 ISCSI_CMD_EVENT_E3, 307 ISCSI_CMD_EVENT_E4, 308 ISCSI_CMD_EVENT_E6, 309 ISCSI_CMD_EVENT_E7, 310 ISCSI_CMD_EVENT_E8 311 } iscsi_cmd_event_t; 312 313 /* 314 * iscsi text command stages - these stages are used by iSCSI text 315 * processing to manage long resonses. 316 */ 317 typedef enum iscsi_cmd_text_stage { 318 ISCSI_CMD_TEXT_INITIAL_REQ, 319 ISCSI_CMD_TEXT_CONTINUATION, 320 ISCSI_CMD_TEXT_FINAL_RSP 321 } iscsi_cmd_text_stage_t; 322 323 /* 324 * iSCSI cmd/pkt Structure 325 */ 326 typedef struct iscsi_cmd { 327 uint32_t cmd_sig; 328 struct iscsi_cmd *cmd_prev; 329 struct iscsi_cmd *cmd_next; 330 struct iscsi_conn *cmd_conn; 331 332 iscsi_cmd_type_t cmd_type; 333 iscsi_cmd_state_t cmd_state; 334 iscsi_cmd_state_t cmd_prev_state; 335 clock_t cmd_lbolt_pending; 336 clock_t cmd_lbolt_active; 337 clock_t cmd_lbolt_aborting; 338 clock_t cmd_lbolt_timeout; 339 boolean_t cmd_internal; 340 boolean_t cmd_free; 341 342 union { 343 /* ISCSI_CMD_TYPE_SCSI */ 344 struct { 345 struct scsi_pkt *pkt; 346 struct buf *bp; 347 int cmdlen; 348 int statuslen; 349 size_t data_transferred; 350 351 uint32_t lun; 352 353 /* 354 * If SCSI_CMD_TYPE is in ABORTING_STATE 355 * then the abort_icmdp field will be a pointer 356 * to the abort command chasing this one. 357 */ 358 struct iscsi_cmd *abort_icmdp; 359 /* 360 * pointer to the r2t associated with this 361 * command (if any) 362 */ 363 struct iscsi_cmd *r2t_icmdp; 364 } scsi; 365 /* ISCSI_CMD_TYPE_ABORT */ 366 struct { 367 /* pointer to original iscsi_cmd, for abort */ 368 struct iscsi_cmd *icmdp; 369 } abort; 370 /* ISCSI_CMD_TYPE_RESET */ 371 struct { 372 int level; 373 } reset; 374 /* ISCSI_CMD_TYPE_NOP */ 375 struct { 376 int rsvd; 377 } nop; 378 /* ISCSI_CMD_TYPE_R2T */ 379 struct { 380 struct iscsi_cmd *icmdp; 381 uint32_t offset; 382 uint32_t length; 383 } r2t; 384 /* ISCSI_CMD_TYPE_LOGIN */ 385 struct { 386 int rvsd; 387 } login; 388 /* ISCSI_CMD_TYPE_LOGOUT */ 389 struct { 390 int rsvd; 391 } logout; 392 /* ISCSI_CMD_TYPE_TEXT */ 393 struct { 394 char *buf; 395 int buf_len; 396 uint32_t offset; 397 uint32_t data_len; 398 uint32_t total_rx_len; 399 uint32_t ttt; 400 uint8_t lun[8]; 401 iscsi_cmd_text_stage_t stage; 402 } text; 403 } cmd_un; 404 405 struct iscsi_lun *cmd_lun; /* associated lun */ 406 407 uint32_t cmd_itt; 408 uint32_t cmd_ttt; 409 410 /* 411 * If a data digest error is seem on a data pdu. This flag 412 * will get set. We don't abort the cmd immediately because 413 * we want to read in all the data to get it out of the 414 * stream. Once the completion for the cmd is received we 415 * we will abort the cmd and state no sense data was available. 416 */ 417 boolean_t cmd_crc_error_seen; 418 419 /* 420 * Used to block and wake up caller until action is completed. 421 * This is for ABORT, RESET, and PASSTHRU cmds. 422 */ 423 int cmd_result; 424 int cmd_completed; 425 kmutex_t cmd_mutex; 426 kcondvar_t cmd_completion; 427 428 } iscsi_cmd_t; 429 430 431 /* 432 * iSCSI LUN Structure 433 */ 434 typedef struct iscsi_lun { 435 uint32_t lun_sig; 436 int lun_state; 437 438 struct iscsi_lun *lun_next; /* next lun on this sess. */ 439 struct iscsi_sess *lun_sess; /* parent sess. for lun */ 440 dev_info_t *lun_dip; 441 mdi_pathinfo_t *lun_pip; 442 443 uint16_t lun_num; /* LUN */ 444 uint8_t lun_addr_type; /* LUN addressing type */ 445 uint32_t lun_oid; /* OID */ 446 char *lun_guid; /* GUID */ 447 int lun_guid_size; /* GUID allocation size */ 448 char *lun_addr; /* sess,lun */ 449 time_t lun_time_online; 450 451 uchar_t lun_cap; /* bitmap of scsi caps */ 452 453 uchar_t lun_vid[ISCSI_INQ_VID_BUF_LEN]; /* Vendor ID */ 454 uchar_t lun_pid[ISCSI_INQ_PID_BUF_LEN]; /* Product ID */ 455 } iscsi_lun_t; 456 457 #define ISCSI_LUN_STATE_OFFLINE 0 458 #define ISCSI_LUN_STATE_ONLINE 1 459 460 #define ISCSI_LUN_CAP_RESET 0x01 461 462 /* 463 * iscsi_conn_state - (reference iscsi_conn.c for state diagram) 464 */ 465 typedef enum iscsi_conn_state { 466 ISCSI_CONN_STATE_FREE, 467 ISCSI_CONN_STATE_IN_LOGIN, 468 ISCSI_CONN_STATE_LOGGED_IN, 469 ISCSI_CONN_STATE_IN_LOGOUT, 470 ISCSI_CONN_STATE_FAILED, 471 ISCSI_CONN_STATE_POLLING 472 } iscsi_conn_state_t; 473 474 #define ISCSI_CONN_STATE_FULL_FEATURE(state) \ 475 ((state == ISCSI_CONN_STATE_LOGGED_IN) || \ 476 (state == ISCSI_CONN_STATE_IN_LOGOUT)) 477 478 /* 479 * iscsi connection events - (reference iscsi_conn.c for state diagram) 480 */ 481 typedef enum iscsi_conn_event { 482 ISCSI_CONN_EVENT_T1, 483 ISCSI_CONN_EVENT_T5, 484 ISCSI_CONN_EVENT_T7, 485 ISCSI_CONN_EVENT_T8, 486 ISCSI_CONN_EVENT_T9, 487 ISCSI_CONN_EVENT_T11, 488 ISCSI_CONN_EVENT_T12, 489 ISCSI_CONN_EVENT_T13, 490 ISCSI_CONN_EVENT_T14, 491 ISCSI_CONN_EVENT_T15, 492 ISCSI_CONN_EVENT_T17, 493 ISCSI_CONN_EVENT_T30 494 } iscsi_conn_event_t; 495 496 /* 497 * 498 * 499 */ 500 typedef struct iscsi_queue { 501 iscsi_cmd_t *head; 502 iscsi_cmd_t *tail; 503 int count; 504 kmutex_t mutex; 505 } iscsi_queue_t; 506 507 #define ISCSI_CONN_DEFAULT_LOGIN_MIN 0 508 #define ISCSI_CONN_DEFAULT_LOGIN_MAX 180 509 #define ISCSI_CONN_DEFAULT_LOGIN_REDIRECT 10 510 511 typedef union iscsi_sockaddr { 512 struct sockaddr sin; 513 struct sockaddr_in sin4; 514 struct sockaddr_in6 sin6; 515 } iscsi_sockaddr_t; 516 517 #define SIZEOF_SOCKADDR(so) ((so)->sa_family == AF_INET ? \ 518 sizeof (struct sockaddr_in) : sizeof (struct sockaddr_in6)) 519 520 /* 521 * iSCSI Connection Structure 522 */ 523 typedef struct iscsi_conn { 524 uint32_t conn_sig; 525 struct iscsi_conn *conn_next; /* next conn on this sess. */ 526 struct iscsi_sess *conn_sess; /* parent sess. for conn. */ 527 528 iscsi_conn_state_t conn_state; /* cur. conn. driver state */ 529 iscsi_conn_state_t conn_prev_state; /* prev. conn. driver state */ 530 clock_t conn_state_lbolt; 531 /* protects the session state and synchronizes the state machine */ 532 kmutex_t conn_state_mutex; 533 kcondvar_t conn_state_change; 534 boolean_t conn_state_destroy; 535 536 struct sonode *conn_socket; /* aka. kernel net. socket */ 537 538 /* base connection information */ 539 iscsi_sockaddr_t conn_base_addr; 540 541 /* current connection information, may have been redirected */ 542 iscsi_sockaddr_t conn_curr_addr; 543 544 /* current connection information, may have been redirected */ 545 boolean_t conn_bound; 546 iscsi_sockaddr_t conn_bound_addr; 547 548 uint32_t conn_cid; /* CID */ 549 uint32_t conn_oid; /* OID */ 550 551 int conn_current_stage; /* iSCSI login stage */ 552 int conn_next_stage; /* iSCSI login stage */ 553 int conn_partial_response; 554 555 /* 556 * The active queue contains iscsi_cmds that have already 557 * been sent on this connection. Any future responses to 558 * these cmds require alligence to this connection. If there 559 * are issues with these cmds the command may need aborted 560 * depending on the command type, and must be put back into 561 * the session's pending queue or aborted. 562 */ 563 iscsi_queue_t conn_queue_active; 564 565 /* lbolt from the last receive, used for nop processing */ 566 clock_t conn_rx_lbolt; 567 clock_t conn_nop_lbolt; 568 569 iscsi_thread_t *conn_rx_thread; 570 iscsi_thread_t *conn_tx_thread; 571 572 /* 573 * The expstatsn is the command status sn that is expected 574 * next from the target. Command status is carried on a number 575 * of iSCSI PDUs (ex. SCSI Cmd Response, SCSI Data IN with 576 * S-Bit set, ...), not all PDUs. If our expstatsn is different 577 * than the received statsn. Something got out of sync we need to 578 * recover. 579 */ 580 uint32_t conn_expstatsn; 581 uint32_t conn_laststatsn; 582 583 /* active login parameters */ 584 iscsi_login_params_t conn_params; 585 586 /* Statistics */ 587 struct { 588 kstat_t *ks; 589 iscsi_conn_stats_t ks_data; 590 } stats; 591 592 /* 593 * login min and max identify the amount of time 594 * in lbolt that iscsi_start_login() should attempt 595 * to log into a target portal. The login will 596 * delay until the min lbolt has been reached and 597 * will end once max time has been reached. These 598 * values are normally set to the default but can 599 * are also altered by async commands received from 600 * the targetlogin. 601 */ 602 clock_t conn_login_min; 603 clock_t conn_login_max; 604 } iscsi_conn_t; 605 606 607 /* 608 * iscsi_conn_state - (reference iscsi_sess.c for state diagram) 609 */ 610 typedef enum iscsi_sess_state { 611 ISCSI_SESS_STATE_FREE, 612 ISCSI_SESS_STATE_LOGGED_IN, 613 ISCSI_SESS_STATE_FAILED, 614 ISCSI_SESS_STATE_IN_FLUSH, 615 ISCSI_SESS_STATE_FLUSHED 616 } iscsi_sess_state_t; 617 618 #define ISCSI_SESS_STATE_FULL_FEATURE(state) \ 619 ((state == ISCSI_SESS_STATE_LOGGED_IN) || \ 620 (state == ISCSI_SESS_STATE_IN_FLUSH)) 621 622 623 typedef enum iscsi_sess_event { 624 ISCSI_SESS_EVENT_N1, 625 ISCSI_SESS_EVENT_N3, 626 ISCSI_SESS_EVENT_N5, 627 ISCSI_SESS_EVENT_N6, 628 ISCSI_SESS_EVENT_N7 629 } iscsi_sess_event_t; 630 631 typedef enum iscsi_sess_type { 632 ISCSI_SESS_TYPE_NORMAL, 633 ISCSI_SESS_TYPE_DISCOVERY 634 } iscsi_sess_type_t; 635 636 #define SESS_ABORT_TASK_MAX_THREADS 1 637 638 /* Sun's initiator session ID */ 639 #define ISCSI_SUN_ISID_0 0x40 /* ISID - EN format */ 640 #define ISCSI_SUN_ISID_1 0x00 /* Sec B */ 641 #define ISCSI_SUN_ISID_2 0x00 /* Sec B */ 642 #define ISCSI_SUN_ISID_3 0x2A /* Sec C - 42 = Sun's EN */ 643 /* 644 * defines 4-5 are the reserved values. These reserved values 645 * are used as the ISID for an initiator-port in MP-API and used 646 * for the send targets discovery sessions. Byte 5 is overridden 647 * for full feature sessions. The default values of byte 5 for a 648 * full feature session is 0. When MS/T is enabled with more than 649 * one session this byte 5 will increment > 0 up to 650 * ISCSI_MAX_CONFIG_SESSIONS. 651 */ 652 #define ISCSI_SUN_ISID_4 0x00 653 #define ISCSI_SUN_ISID_5 0xFF 654 655 #define ISCSI_DEFAULT_SESS_BOUND B_FALSE 656 #define ISCSI_DEFAULT_SESS_NUM 1 657 658 /* 659 * iSCSI Session(Target) Structure 660 */ 661 typedef struct iscsi_sess { 662 uint32_t sess_sig; 663 664 iscsi_sess_state_t sess_state; 665 iscsi_sess_state_t sess_prev_state; 666 clock_t sess_state_lbolt; 667 /* protects the session state and synchronizes the state machine */ 668 kmutex_t sess_state_mutex; 669 670 /* 671 * Associated target OID. 672 */ 673 uint32_t sess_target_oid; 674 675 /* 676 * Session OID. Used by IMA, interfaces and exported as 677 * TARGET_PROP which is checked by the NDI. In addition 678 * this is used in our tran_lun_init function. 679 */ 680 uint32_t sess_oid; 681 682 struct iscsi_sess *sess_next; 683 struct iscsi_hba *sess_hba; 684 685 /* list of all luns relating to session */ 686 struct iscsi_lun *sess_lun_list; 687 krwlock_t sess_lun_list_rwlock; 688 689 /* list of all connections relating to session */ 690 struct iscsi_conn *sess_conn_list; 691 struct iscsi_conn *sess_conn_list_last_ptr; 692 /* pointer to active connection in session */ 693 struct iscsi_conn *sess_conn_act; 694 krwlock_t sess_conn_list_rwlock; 695 696 /* Connection ID for next connection to be added to session */ 697 uint32_t sess_conn_next_cid; 698 699 /* 700 * last time any connection on this session received 701 * data from the target. 702 */ 703 clock_t sess_rx_lbolt; 704 705 clock_t sess_failure_lbolt; 706 707 int sess_storm_delay; 708 709 /* 710 * sess_cmdsn_mutex protects the cmdsn and itt table/values 711 * Cmdsn isn't that big of a problem yet since we only have 712 * one connection but in the future we will need to ensure 713 * this locking is working so keep the sequence numbers in 714 * sync on the wire. 715 * 716 * We also use this lock to protect the ITT table and it's 717 * values. We need to make sure someone doesn't assign 718 * a duplicate ITT value or cell to a command. Also we 719 * need to make sure when someone is looking up an ITT 720 * that the command is still in that correct queue location. 721 */ 722 kmutex_t sess_cmdsn_mutex; 723 724 /* 725 * iSCSI command sequencing / windowing. The next 726 * command to be sent via the pending queue will 727 * get the sess_cmdsn. If the maxcmdsn is less 728 * than the next cmdsn then the iSCSI window is 729 * closed and this command cannot be sent yet. 730 * Most iscsi cmd responses from the target carry 731 * a new maxcmdsn. If this new maxcmdsn is greater 732 * than the sess_maxcmdsn we will update it's value 733 * and set a timer to fire in one tick and reprocess 734 * the pending queue. 735 * 736 * The expcmdsn. Is the value the target expects 737 * to be sent for my next cmdsn. If the expcmdsn 738 * and the cmdsn get out of sync this could denote 739 * a communication problem. 740 */ 741 uint32_t sess_cmdsn; 742 uint32_t sess_expcmdsn; 743 uint32_t sess_maxcmdsn; 744 745 /* Next Initiator Task Tag (ITT) to use */ 746 uint32_t sess_itt; 747 /* 748 * The session iscsi_cmd table is used to a fast performance 749 * lookup of an ITT to a iscsi_cmd when we receive an iSCSI 750 * PDU from the wire. To reserve a location in the sess_cmd_table 751 * we try the sess_itt % ISCSI_CMD_TABLE_SIZE if this cmd table 752 * cell is already full. Then increament the sess_itt and 753 * try to get the cell position again, repeat until an empty 754 * cell is found. Once an empty cell is found place your 755 * scsi_cmd point into the cell to reserve the location. This 756 * selection process should be done while holding the session's 757 * mutex. 758 */ 759 struct iscsi_cmd *sess_cmd_table[ISCSI_CMD_TABLE_SIZE]; 760 int sess_cmd_table_count; 761 762 /* 763 * The pending queue contains all iscsi_cmds that require an 764 * open MaxCmdSn window to be put on the wire and haven't 765 * been placed on the wire. Once placed on the wire they 766 * will be moved to a connections specific active queue. 767 */ 768 iscsi_queue_t sess_queue_pending; 769 770 iscsi_error_t sess_last_err; 771 772 iscsi_queue_t sess_queue_completion; 773 /* configured login parameters */ 774 iscsi_login_params_t sess_params; 775 776 /* general iSCSI protocol/session info */ 777 uchar_t sess_name[ISCSI_MAX_NAME_LEN]; 778 int sess_name_length; 779 char sess_alias[ISCSI_MAX_NAME_LEN]; 780 int sess_alias_length; 781 iSCSIDiscoveryMethod_t sess_discovered_by; 782 iscsi_sockaddr_t sess_discovered_addr; 783 uchar_t sess_isid[ISCSI_ISID_LEN]; /* Session ID */ 784 uint16_t sess_tsid; /* Target ID */ 785 /* 786 * If the target portal group tag(TPGT) is equal to ISCSI_DEFAULT_TPGT 787 * then the initiator will accept a successful login with any TPGT 788 * specified by the target. If a none default TPGT is configured 789 * then we will only successfully accept a login with that matching 790 * TPGT value. 791 */ 792 int sess_tpgt_conf; 793 /* This field records the negotiated TPGT value, preserved for dtrace */ 794 int sess_tpgt_nego; 795 796 /* 797 * Authentication information. 798 * 799 * DCW: Again IMA seems to take a session view at this 800 * information. 801 */ 802 iscsi_auth_t sess_auth; 803 804 /* Statistics */ 805 struct { 806 kstat_t *ks; 807 iscsi_sess_stats_t ks_data; 808 kstat_t *ks_io; 809 kstat_io_t ks_io_data; 810 kmutex_t ks_io_lock; 811 } stats; 812 813 iscsi_thread_t *sess_ic_thread; 814 boolean_t sess_window_open; 815 iscsi_sess_type_t sess_type; 816 817 boolean_t sess_enum_in_progress; 818 819 ddi_taskq_t *sess_taskq; 820 821 iscsi_thread_t *sess_wd_thread; 822 823 } iscsi_sess_t; 824 825 826 /* 827 * iscsi_network 828 */ 829 typedef struct iscsi_network { 830 void* (*socket)(int domain, int, int); 831 int (*bind)(void *, struct sockaddr *, int, int, int); 832 int (*connect)(void *, struct sockaddr *, int, int, int); 833 int (*listen)(void *, int); 834 void* (*accept)(void *, struct sockaddr *, int *); 835 int (*getsockname)(void *); 836 int (*getsockopt)(void *, int, int, void *, int *, int); 837 int (*setsockopt)(void *, int, int, void *, int); 838 int (*shutdown)(void *, int); 839 void (*close)(void *); 840 841 size_t (*poll)(void *, clock_t); 842 size_t (*sendmsg)(void *, struct msghdr *); 843 size_t (*recvmsg)(void *, struct msghdr *, int); 844 845 iscsi_status_t (*sendpdu)(void *, iscsi_hdr_t *, char *, int); 846 iscsi_status_t (*recvdata)(void *, iscsi_hdr_t *, char *, 847 int, int, int); 848 iscsi_status_t (*recvhdr)(void *, iscsi_hdr_t *, int, int, int); 849 850 struct { 851 int sndbuf; 852 int rcvbuf; 853 int nodelay; 854 int conn_notify_threshold; 855 int conn_abort_threshold; 856 int abort_threshold; 857 } tweaks; 858 } iscsi_network_t; 859 860 #define ISCSI_NET_HEADER_DIGEST 0x00000001 861 #define ISCSI_NET_DATA_DIGEST 0x00000002 862 863 extern iscsi_network_t *iscsi_net; 864 865 /* 866 * If we get bus_config requests in less than 5 seconds 867 * apart skip the name services re-discovery and just 868 * complete the requested logins. This protects against 869 * bus_config storms from stale /dev links. 870 */ 871 #define ISCSI_CONFIG_STORM_DELAY_DEFAULT 5 872 873 /* 874 * iSCSI HBA Structure 875 */ 876 typedef struct iscsi_hba { 877 uint32_t hba_sig; 878 dev_info_t *hba_dip; /* dev info ptr */ 879 scsi_hba_tran_t *hba_tran; /* scsi tran ptr */ 880 881 struct iscsi_sess *hba_sess_list; /* sess. list for hba */ 882 krwlock_t hba_sess_list_rwlock; /* protect sess. list */ 883 884 /* lbolt of the last time we received a config request */ 885 clock_t hba_config_lbolt; 886 /* current number of seconds to protect against bus config storms */ 887 int hba_config_storm_delay; 888 889 /* general iSCSI protocol hba/initiator info */ 890 uchar_t hba_name[ISCSI_MAX_NAME_LEN]; 891 int hba_name_length; 892 uchar_t hba_alias[ISCSI_MAX_NAME_LEN]; 893 int hba_alias_length; 894 895 /* Default SessionID for HBA */ 896 uchar_t hba_isid[ISCSI_ISID_LEN]; 897 898 /* Default HBA wide settings */ 899 iscsi_login_params_t hba_params; 900 901 /* 902 * There's only one HBA and it's set to ISCSI_INITIATOR_OID 903 * (value of 1) at the beginning of time. 904 */ 905 uint32_t hba_oid; 906 907 /* 908 * Keep track of which events have been sent. User daemons request 909 * this information so they don't wait for events which they won't 910 * see. 911 */ 912 kmutex_t hba_discovery_events_mutex; 913 iSCSIDiscoveryMethod_t hba_discovery_events; 914 boolean_t hba_discovery_in_progress; 915 916 boolean_t hba_mpxio_enabled; /* mpxio-enabled */ 917 918 /* 919 * Ensures only one SendTargets operation occurs at a time 920 */ 921 ksema_t hba_sendtgts_semaphore; 922 923 /* 924 * Statistics 925 */ 926 struct { 927 kstat_t *ks; 928 iscsi_hba_stats_t ks_data; 929 } stats; 930 } iscsi_hba_t; 931 932 /* 933 * +--------------------------------------------------------------------+ 934 * | iSCSI prototypes | 935 * +--------------------------------------------------------------------+ 936 */ 937 938 /* iscsi_io.c */ 939 int iscsi_sna_lte(uint32_t n1, uint32_t n2); 940 char *iscsi_get_next_text(char *data, int data_length, char *curr_text); 941 942 void iscsi_ic_thread(iscsi_thread_t *thread, void *arg); 943 void iscsi_tx_thread(iscsi_thread_t *thread, void *arg); 944 void iscsi_rx_thread(iscsi_thread_t *thread, void *arg); 945 void iscsi_wd_thread(iscsi_thread_t *thread, void *arg); 946 947 iscsi_status_t iscsi_tx_cmd(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 948 949 void iscsi_handle_abort(void *arg); 950 iscsi_status_t iscsi_handle_reset(iscsi_sess_t *isp, int level, 951 iscsi_lun_t *ilp); 952 iscsi_status_t iscsi_handle_logout(iscsi_conn_t *icp); 953 iscsi_status_t iscsi_handle_passthru(iscsi_sess_t *isp, uint16_t lun, 954 struct uscsi_cmd *ucmdp); 955 iscsi_status_t iscsi_handle_text(iscsi_conn_t *icp, 956 char *buf, uint32_t buf_len, uint32_t data_len, uint32_t *rx_data_len); 957 958 void iscsi_iodone(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 959 960 /* iscsi_crc.c */ 961 uint32_t iscsi_crc32c(void *address, unsigned long length); 962 uint32_t iscsi_crc32c_continued(void *address, unsigned long length, 963 uint32_t crc); 964 965 /* iscsi_queue.c */ 966 void iscsi_init_queue(iscsi_queue_t *queue); 967 void iscsi_destroy_queue(iscsi_queue_t *queue); 968 void iscsi_enqueue_pending_cmd(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 969 void iscsi_dequeue_pending_cmd(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 970 void iscsi_enqueue_active_cmd(iscsi_conn_t *icp, iscsi_cmd_t *icmdp); 971 void iscsi_dequeue_active_cmd(iscsi_conn_t *icp, iscsi_cmd_t *icmdp); 972 void iscsi_enqueue_completed_cmd(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 973 iscsi_status_t iscsi_dequeue_cmd(iscsi_cmd_t **, iscsi_cmd_t **, iscsi_cmd_t *); 974 void iscsi_move_queue(iscsi_queue_t *src_queue, iscsi_queue_t *dst_queue); 975 void iscsi_enqueue_cmd_head(iscsi_cmd_t **, iscsi_cmd_t **, 976 iscsi_cmd_t *); 977 978 /* iscsi_login.c */ 979 iscsi_status_t iscsi_login_start(void *arg); 980 981 /* iscsi_stats.c */ 982 boolean_t iscsi_hba_kstat_init(struct iscsi_hba *ihp); 983 boolean_t iscsi_hba_kstat_term(struct iscsi_hba *ihp); 984 boolean_t iscsi_sess_kstat_init(struct iscsi_sess *isp); 985 boolean_t iscsi_sess_kstat_term(struct iscsi_sess *isp); 986 boolean_t iscsi_conn_kstat_init(struct iscsi_conn *icp); 987 void iscsi_conn_kstat_term(struct iscsi_conn *icp); 988 989 /* iscsi_net.c */ 990 void iscsi_net_init(); 991 void iscsi_net_fini(); 992 993 /* iscsi_sess.c */ 994 iscsi_sess_t *iscsi_sess_create(iscsi_hba_t *ihp, 995 iSCSIDiscoveryMethod_t method, struct sockaddr *addr_dsc, 996 char *target_name, int tpgt, uchar_t isid_lsb, 997 iscsi_sess_type_t type, uint32_t *oid); 998 void iscsi_sess_online(iscsi_sess_t *isp); 999 int iscsi_sess_get(uint32_t oid, iscsi_hba_t *ihp, iscsi_sess_t **ispp); 1000 iscsi_status_t iscsi_sess_destroy(iscsi_sess_t *isp); 1001 void iscsi_sess_state_machine(iscsi_sess_t *isp, iscsi_sess_event_t event); 1002 char *iscsi_sess_state_str(iscsi_sess_state_t state); 1003 boolean_t iscsi_sess_set_auth(iscsi_sess_t *isp); 1004 iscsi_status_t iscsi_sess_reserve_itt(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 1005 void iscsi_sess_release_itt(iscsi_sess_t *isp, iscsi_cmd_t *icmdp); 1006 void iscsi_sess_redrive_io(iscsi_sess_t *isp); 1007 int iscsi_sess_get_by_target(uint32_t target_oid, iscsi_hba_t *ihp, 1008 iscsi_sess_t **ispp); 1009 1010 1011 /* iscsi_conn.c */ 1012 iscsi_status_t iscsi_conn_create(struct sockaddr *addr, iscsi_sess_t *isp, 1013 iscsi_conn_t **icpp); 1014 iscsi_status_t iscsi_conn_offline(iscsi_conn_t *icp); 1015 iscsi_status_t iscsi_conn_destroy(iscsi_conn_t *icp); 1016 iscsi_status_t iscsi_conn_state_machine(iscsi_conn_t *icp, 1017 iscsi_conn_event_t event); 1018 char *iscsi_conn_state_str(iscsi_conn_state_t state); 1019 void iscsi_conn_set_login_min_max(iscsi_conn_t *icp, int min, int max); 1020 iscsi_status_t iscsi_conn_sync_params(iscsi_conn_t *icp); 1021 1022 /* iscsi_lun.c */ 1023 iscsi_status_t iscsi_lun_create(iscsi_sess_t *isp, uint16_t lun_num, 1024 uint8_t lun_addr_type, struct scsi_inquiry *inq, char *guid); 1025 iscsi_status_t iscsi_lun_destroy(iscsi_hba_t *ihp, 1026 iscsi_lun_t *ilp); 1027 void iscsi_lun_online(iscsi_hba_t *ihp, 1028 iscsi_lun_t *ilp); 1029 iscsi_status_t iscsi_lun_offline(iscsi_hba_t *ihp, 1030 iscsi_lun_t *ilp, boolean_t lun_free); 1031 1032 /* iscsi_cmd.c */ 1033 void iscsi_cmd_state_machine(iscsi_cmd_t *icmdp, 1034 iscsi_cmd_event_t event, void *arg); 1035 iscsi_cmd_t *iscsi_cmd_alloc(iscsi_conn_t *icp, int km_flags); 1036 void iscsi_cmd_free(iscsi_cmd_t *icmdp); 1037 1038 /* iscsi_ioctl.c */ 1039 int iscsi_ioctl(dev_t, int, intptr_t, int, cred_t *, int *); 1040 void * iscsi_ioctl_copyin(caddr_t arg, int mode, size_t size); 1041 int iscsi_ioctl_copyout(void *data, size_t size, caddr_t arg, int mode); 1042 iscsi_conn_list_t *iscsi_ioctl_conn_oid_list_get_copyin(caddr_t, int); 1043 int iscsi_ioctl_conn_oid_list_get_copyout(iscsi_conn_list_t *, caddr_t, int); 1044 boolean_t iscsi_ioctl_conn_oid_list_get(iscsi_hba_t *ihp, 1045 iscsi_conn_list_t *cl); 1046 boolean_t iscsi_ioctl_conn_props_get(iscsi_hba_t *ihp, iscsi_conn_props_t *cp); 1047 int iscsi_ioctl_sendtgts_get(iscsi_hba_t *ihp, iscsi_sendtgts_list_t *stl); 1048 int iscsi_target_prop_mod(iscsi_hba_t *, iscsi_property_t *, int cmd); 1049 int iscsi_set_params(iscsi_param_set_t *, iscsi_hba_t *, boolean_t); 1050 int iscsi_get_persisted_param(uchar_t *, iscsi_param_get_t *, 1051 iscsi_login_params_t *); 1052 void iscsi_set_default_login_params(iscsi_login_params_t *params); 1053 int iscsi_ioctl_get_config_sess(iscsi_hba_t *ihp, 1054 iscsi_config_sess_t *ics); 1055 int iscsi_ioctl_set_config_sess(iscsi_hba_t *ihp, 1056 iscsi_config_sess_t *ics); 1057 /* ioctls prototypes */ 1058 int iscsi_get_param(iscsi_login_params_t *params, 1059 boolean_t valid_flag, 1060 iscsi_param_get_t *ipgp); 1061 1062 /* iscsid.c */ 1063 boolean_t iscsid_init(iscsi_hba_t *ihp, boolean_t restart); 1064 void iscsid_fini(); 1065 void iscsid_props(iSCSIDiscoveryProperties_t *props); 1066 boolean_t iscsid_enable_discovery(iscsi_hba_t *ihp, 1067 iSCSIDiscoveryMethod_t idm, boolean_t poke); 1068 boolean_t iscsid_disable_discovery(iscsi_hba_t *ihp, 1069 iSCSIDiscoveryMethod_t idm); 1070 void iscsid_poke_discovery(iscsi_hba_t *ihp, iSCSIDiscoveryMethod_t method); 1071 void iscsid_do_sendtgts(entry_t *discovery_addr); 1072 void iscsid_do_isns_query_one_server( 1073 iscsi_hba_t *ihp, entry_t *isns_addr); 1074 void iscsid_do_isns_query(iscsi_hba_t *ihp); 1075 void iscsid_config_one(iscsi_hba_t *ihp, 1076 char *name, boolean_t protect); 1077 void iscsid_config_all(iscsi_hba_t *ihp, boolean_t protect); 1078 void iscsid_unconfig_one(iscsi_hba_t *ihp, char *name); 1079 void iscsid_unconfig_all(iscsi_hba_t *ihp); 1080 void isns_scn_callback(void *arg); 1081 boolean_t iscsid_del(iscsi_hba_t *ihp, char *target_name, 1082 iSCSIDiscoveryMethod_t method, struct sockaddr *addr_dsc); 1083 boolean_t iscsid_login_tgt(iscsi_hba_t *ihp, char *target_name, 1084 iSCSIDiscoveryMethod_t method, struct sockaddr *addr_dsc); 1085 void iscsid_addr_to_sockaddr(int src_insize, void *src_addr, int src_port, 1086 struct sockaddr *dst_addr); 1087 1088 extern void bcopy(const void *s1, void *s2, size_t n); 1089 extern void bzero(void *s, size_t n); 1090 /* 1091 * Here we need a contract for inet_ntop() and inet_pton() 1092 * in uts/common/inet/ip/inet_ntop.c 1093 */ 1094 extern char *inet_ntop(int af, const void *addr, char *buf, int addrlen); 1095 extern int inet_pton(int af, char *inp, void *outp); 1096 1097 #ifdef __cplusplus 1098 } 1099 #endif 1100 1101 #endif /* _ISCSI_H */ 1102