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 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 #ifndef _IDM_IMPL_H_ 26 #define _IDM_IMPL_H_ 27 28 #ifdef __cplusplus 29 extern "C" { 30 #endif 31 32 #include <sys/avl.h> 33 #include <sys/socket_impl.h> 34 35 /* 36 * IDM lock order: 37 * 38 * idm_taskid_table_lock, idm_task_t.idt_mutex 39 */ 40 41 #define CF_LOGIN_READY 0x00000001 42 #define CF_INITIAL_LOGIN 0x00000002 43 #define CF_ERROR 0x80000000 44 45 typedef enum { 46 CONN_TYPE_INI = 1, 47 CONN_TYPE_TGT 48 } idm_conn_type_t; 49 50 /* 51 * Watchdog interval in seconds 52 */ 53 #define IDM_WD_INTERVAL 5 54 55 /* 56 * Timeout period before the client "keepalive" callback is invoked in 57 * seconds if the connection is idle. 58 */ 59 #define IDM_TRANSPORT_KEEPALIVE_IDLE_TIMEOUT 20 60 61 /* 62 * Timeout period before a TRANSPORT_FAIL event is generated in seconds 63 * if the connection is idle. 64 */ 65 #define IDM_TRANSPORT_FAIL_IDLE_TIMEOUT 30 66 67 /* 68 * IDM reference count structure. Audit code is shamelessly adapted 69 * from CIFS server. 70 */ 71 72 #define REFCNT_AUDIT_STACK_DEPTH 16 73 #define REFCNT_AUDIT_BUF_MAX_REC 16 74 75 typedef struct { 76 uint32_t anr_refcnt; 77 int anr_depth; 78 pc_t anr_stack[REFCNT_AUDIT_STACK_DEPTH]; 79 } refcnt_audit_record_t; 80 81 typedef struct { 82 int anb_index; 83 int anb_max_index; 84 refcnt_audit_record_t anb_records[REFCNT_AUDIT_BUF_MAX_REC]; 85 } refcnt_audit_buf_t; 86 87 #define REFCNT_AUDIT(_rf_) { \ 88 refcnt_audit_record_t *anr; \ 89 \ 90 anr = (_rf_)->ir_audit_buf.anb_records; \ 91 anr += (_rf_)->ir_audit_buf.anb_index; \ 92 (_rf_)->ir_audit_buf.anb_index++; \ 93 (_rf_)->ir_audit_buf.anb_index &= \ 94 (_rf_)->ir_audit_buf.anb_max_index; \ 95 anr->anr_refcnt = (_rf_)->ir_refcnt; \ 96 anr->anr_depth = getpcstack(anr->anr_stack, \ 97 REFCNT_AUDIT_STACK_DEPTH); \ 98 } 99 100 struct idm_refcnt_s; 101 102 typedef void (idm_refcnt_cb_t)(void *ref_obj); 103 104 typedef enum { 105 REF_NOWAIT, 106 REF_WAIT_SYNC, 107 REF_WAIT_ASYNC 108 } idm_refcnt_wait_t; 109 110 typedef struct idm_refcnt_s { 111 int ir_refcnt; 112 void *ir_referenced_obj; 113 idm_refcnt_wait_t ir_waiting; 114 kmutex_t ir_mutex; 115 kcondvar_t ir_cv; 116 idm_refcnt_cb_t *ir_cb; 117 refcnt_audit_buf_t ir_audit_buf; 118 } idm_refcnt_t; 119 120 /* 121 * connection parameters - These parameters would be populated at 122 * connection create, or during key-value negotiation at login 123 */ 124 typedef struct idm_conn_params_s { 125 uint32_t max_dataseglen; 126 uint32_t conn_login_max; 127 uint32_t conn_login_interval; 128 boolean_t nonblock_socket; 129 } idm_conn_param_t; 130 131 typedef struct idm_svc_s { 132 list_node_t is_list_node; 133 kmutex_t is_mutex; 134 kcondvar_t is_cv; 135 kmutex_t is_count_mutex; 136 kcondvar_t is_count_cv; 137 idm_refcnt_t is_refcnt; 138 int is_online; 139 /* transport-specific service components */ 140 void *is_so_svc; 141 void *is_iser_svc; 142 idm_svc_req_t is_svc_req; 143 } idm_svc_t; 144 145 #define ISCSI_MAX_TSIH_LEN 6 /* 0x%04x */ 146 #define ISCSI_MAX_ISID_LEN ISCSI_ISID_LEN * 2 147 148 typedef struct idm_conn_s { 149 list_node_t ic_list_node; 150 void *ic_handle; 151 idm_refcnt_t ic_refcnt; 152 idm_svc_t *ic_svc_binding; /* Target conn. only */ 153 idm_sockaddr_t ic_ini_dst_addr; 154 struct sockaddr_storage ic_laddr; /* conn local address */ 155 struct sockaddr_storage ic_raddr; /* conn remote address */ 156 157 /* 158 * the target_name, initiator_name, initiator session 159 * identifier and target session identifying handle 160 * are only used for target connections. 161 */ 162 char ic_target_name[ISCSI_MAX_NAME_LEN + 1]; 163 char ic_initiator_name[ISCSI_MAX_NAME_LEN + 1]; 164 char ic_tsih[ISCSI_MAX_TSIH_LEN + 1]; 165 char ic_isid[ISCSI_MAX_ISID_LEN + 1]; 166 idm_conn_state_t ic_state; 167 idm_conn_state_t ic_last_state; 168 sm_audit_buf_t ic_state_audit; 169 kmutex_t ic_state_mutex; 170 kcondvar_t ic_state_cv; 171 uint32_t ic_state_flags; 172 timeout_id_t ic_state_timeout; 173 struct idm_conn_s *ic_reinstate_conn; /* For conn reinst. */ 174 struct idm_conn_s *ic_logout_conn; /* For other conn logout */ 175 taskq_t *ic_state_taskq; 176 int ic_pdu_events; 177 boolean_t ic_login_info_valid; 178 boolean_t ic_rdma_extensions; 179 uint16_t ic_login_cid; 180 181 kmutex_t ic_mutex; 182 kcondvar_t ic_cv; 183 idm_status_t ic_conn_sm_status; 184 185 boolean_t ic_ffp; 186 boolean_t ic_keepalive; 187 uint32_t ic_internal_cid; 188 189 uint32_t ic_conn_flags; 190 idm_conn_type_t ic_conn_type; 191 idm_conn_ops_t ic_conn_ops; 192 idm_transport_ops_t *ic_transport_ops; 193 idm_transport_type_t ic_transport_type; 194 int ic_transport_hdrlen; 195 void *ic_transport_private; 196 idm_conn_param_t ic_conn_params; 197 /* 198 * Save client callback to interpose idm callback 199 */ 200 idm_pdu_cb_t *ic_client_callback; 201 clock_t ic_timestamp; 202 } idm_conn_t; 203 204 #define IDM_CONN_HEADER_DIGEST 0x00000001 205 #define IDM_CONN_DATA_DIGEST 0x00000002 206 #define IDM_CONN_USE_SCOREBOARD 0x00000004 207 208 #define IDM_CONN_ISINI(ICI_IC) ((ICI_IC)->ic_conn_type == CONN_TYPE_INI) 209 #define IDM_CONN_ISTGT(ICI_IC) ((ICI_IC)->ic_conn_type == CONN_TYPE_TGT) 210 211 /* 212 * An IDM target task can transfer data using multiple buffers. The task 213 * will maintain a list of buffers, and each buffer will contain the relative 214 * offset of the transfer and a pointer to the next buffer in the list. 215 * 216 * Note on client private data: 217 * idt_private is intended to be a pointer to some sort of client- 218 * specific state. 219 * 220 * idt_client_handle is a more generic client-private piece of data that can 221 * be used by the client for the express purpose of task lookup. The driving 222 * use case for this is for the client to store the initiator task tag for 223 * a given task so that it may be more easily retrieved for task management. 224 * 225 * The key take away here is that clients should never call 226 * idm_task_find_by_handle in the performance path. 227 * 228 * An initiator will require only one buffer per task, the offset will be 0. 229 */ 230 231 typedef struct idm_task_s { 232 idm_conn_t *idt_ic; /* Associated connection */ 233 /* connection type is in idt_ic->ic_conn_type */ 234 kmutex_t idt_mutex; 235 void *idt_private; /* Client private data */ 236 uintptr_t idt_client_handle; /* Client private */ 237 uint32_t idt_tt; /* Task tag */ 238 uint32_t idt_r2t_ttt; /* R2T Target Task tag */ 239 idm_task_state_t idt_state; 240 idm_refcnt_t idt_refcnt; 241 242 /* 243 * Statistics 244 */ 245 int idt_tx_to_ini_start; 246 int idt_tx_to_ini_done; 247 int idt_rx_from_ini_start; 248 int idt_rx_from_ini_done; 249 int idt_tx_bytes; /* IDM_CONN_USE_SCOREBOARD */ 250 int idt_rx_bytes; /* IDM_CONN_USE_SCOREBOARD */ 251 252 uint32_t idt_exp_datasn; /* expected datasn */ 253 uint32_t idt_exp_rttsn; /* expected rttsn */ 254 list_t idt_inbufv; /* chunks of IN buffers */ 255 list_t idt_outbufv; /* chunks of OUT buffers */ 256 257 /* 258 * Transport header, which describes this tasks remote tagged buffer 259 */ 260 int idt_transport_hdrlen; 261 void *idt_transport_hdr; 262 } idm_task_t; 263 264 int idm_task_constructor(void *task_void, void *arg, int flags); 265 void idm_task_destructor(void *task_void, void *arg); 266 267 #define IDM_TASKIDS_MAX 16384 268 #define IDM_BUF_MAGIC 0x49425546 /* "IBUF" */ 269 270 /* Protect with task mutex */ 271 typedef struct idm_buf_s { 272 uint32_t idb_magic; /* "IBUF" */ 273 274 /* 275 * Note: idm_tx_link *must* be the second element in the list for 276 * proper TX PDU ordering. 277 */ 278 list_node_t idm_tx_link; /* link in a list of TX objects */ 279 280 list_node_t idb_buflink; /* link in a multi-buffer data xfer */ 281 idm_conn_t *idb_ic; /* Associated connection */ 282 void *idb_buf; /* data */ 283 uint64_t idb_buflen; /* length of buffer */ 284 size_t idb_bufoffset; /* offset in a multi-buffer xfer */ 285 boolean_t idb_bufalloc; /* true if alloc'd in idm_buf_alloc */ 286 /* 287 * DataPDUInOrder=Yes, so to track that the PDUs in a sequence are sent 288 * in continuously increasing address order, check that offsets for a 289 * single buffer xfer are in order. 290 */ 291 uint32_t idb_exp_offset; 292 size_t idb_xfer_len; /* Current requested xfer len */ 293 void *idb_buf_private; /* transport-specific buf handle */ 294 void *idb_reg_private; /* transport-specific reg handle */ 295 void *idb_bufptr; /* transport-specific bcopy pointer */ 296 boolean_t idb_bufbcopy; /* true if bcopy required */ 297 298 idm_buf_cb_t *idb_buf_cb; /* Data Completion Notify, tgt only */ 299 void *idb_cb_arg; /* Client private data */ 300 idm_task_t *idb_task_binding; 301 timespec_t idb_xfer_start; 302 timespec_t idb_xfer_done; 303 boolean_t idb_in_transport; 304 boolean_t idb_tx_thread; /* Sockets only */ 305 iscsi_hdr_t idb_data_hdr_tmpl; /* Sockets only */ 306 idm_status_t idb_status; 307 } idm_buf_t; 308 309 typedef enum { 310 BP_CHECK_QUICK, 311 BP_CHECK_THOROUGH, 312 BP_CHECK_ASSERT 313 } idm_bufpat_check_type_t; 314 315 #define BUFPAT_MATCH(bc_bufpat, bc_idb) \ 316 ((bufpat->bufpat_idb == bc_idb) && \ 317 (bufpat->bufpat_bufmagic == IDM_BUF_MAGIC)) 318 319 typedef struct idm_bufpat_s { 320 void *bufpat_idb; 321 uint32_t bufpat_bufmagic; 322 uint32_t bufpat_offset; 323 } idm_bufpat_t; 324 325 #define PDU_MAX_IOVLEN 12 326 #define IDM_PDU_MAGIC 0x49504455 /* "IPDU" */ 327 328 typedef struct idm_pdu_s { 329 uint32_t isp_magic; /* "IPDU" */ 330 331 /* 332 * Internal - Order is vital. idm_tx_link *must* be the second 333 * element in this structure for proper TX PDU ordering. 334 */ 335 list_node_t idm_tx_link; 336 337 list_node_t isp_client_lnd; 338 339 idm_conn_t *isp_ic; /* Must be set */ 340 iscsi_hdr_t *isp_hdr; 341 uint_t isp_hdrlen; 342 uint8_t *isp_data; 343 uint_t isp_datalen; 344 345 /* Transport header */ 346 void *isp_transport_hdr; 347 uint32_t isp_transport_hdrlen; 348 void *isp_transport_private; 349 350 /* 351 * isp_data is used for sending SCSI status, NOP, text, scsi and 352 * non-scsi data. Data is received using isp_iov and isp_iovlen 353 * to support data over multiple buffers. 354 */ 355 void *isp_private; 356 idm_pdu_cb_t *isp_callback; 357 idm_status_t isp_status; 358 359 /* 360 * The following four elements are only used in 361 * idm_sorecv_scsidata() currently. 362 */ 363 struct iovec isp_iov[PDU_MAX_IOVLEN]; 364 int isp_iovlen; 365 idm_buf_t *isp_sorx_buf; 366 367 /* Implementation data for idm_pdu_alloc and sorx PDU cache */ 368 uint32_t isp_flags; 369 uint_t isp_hdrbuflen; 370 uint_t isp_databuflen; 371 } idm_pdu_t; 372 373 /* 374 * This "generic" object is used when removing an item from the ic_tx_list 375 * in order to determine whether it's an idm_pdu_t or an idm_buf_t 376 */ 377 378 typedef struct { 379 uint32_t idm_tx_obj_magic; 380 /* 381 * idm_tx_link *must* be the second element in this structure. 382 */ 383 list_node_t idm_tx_link; 384 } idm_tx_obj_t; 385 386 387 #define IDM_PDU_OPCODE(PDU) \ 388 ((PDU)->isp_hdr->opcode & ISCSI_OPCODE_MASK) 389 390 #define IDM_PDU_ALLOC 0x00000001 391 #define IDM_PDU_ADDL_HDR 0x00000002 392 #define IDM_PDU_ADDL_DATA 0x00000004 393 #define IDM_PDU_LOGIN_TX 0x00000008 394 395 #define OSD_EXT_CDB_AHSLEN (200 - 15) 396 #define BIDI_AHS_LENGTH 5 397 #define IDM_SORX_CACHE_AHSLEN \ 398 (((OSD_EXT_CDB_AHSLEN + 3) + \ 399 (BIDI_AHS_LENGTH + 3)) / sizeof (uint32_t)) 400 #define IDM_SORX_CACHE_HDRLEN (sizeof (iscsi_hdr_t) + IDM_SORX_CACHE_AHSLEN) 401 402 /* 403 * ID pool 404 */ 405 406 #define IDM_IDPOOL_MAGIC 0x4944504C /* IDPL */ 407 #define IDM_IDPOOL_MIN_SIZE 64 /* Number of IDs to begin with */ 408 #define IDM_IDPOOL_MAX_SIZE 64 * 1024 409 410 typedef struct idm_idpool { 411 uint32_t id_magic; 412 kmutex_t id_mutex; 413 uint8_t *id_pool; 414 uint32_t id_size; 415 uint8_t id_bit; 416 uint8_t id_bit_idx; 417 uint32_t id_idx; 418 uint32_t id_idx_msk; 419 uint32_t id_free_counter; 420 uint32_t id_max_free_counter; 421 } idm_idpool_t; 422 423 /* 424 * Global IDM state structure 425 */ 426 typedef struct { 427 kmutex_t idm_global_mutex; 428 taskq_t *idm_global_taskq; 429 kthread_t *idm_wd_thread; 430 kt_did_t idm_wd_thread_did; 431 boolean_t idm_wd_thread_running; 432 kcondvar_t idm_wd_cv; 433 list_t idm_tgt_svc_list; 434 kcondvar_t idm_tgt_svc_cv; 435 list_t idm_tgt_conn_list; 436 int idm_tgt_conn_count; 437 list_t idm_ini_conn_list; 438 kmem_cache_t *idm_buf_cache; 439 kmem_cache_t *idm_task_cache; 440 krwlock_t idm_taskid_table_lock; 441 idm_task_t **idm_taskid_table; 442 uint32_t idm_taskid_next; 443 uint32_t idm_taskid_max; 444 idm_idpool_t idm_conn_id_pool; 445 kmem_cache_t *idm_sotx_pdu_cache; 446 kmem_cache_t *idm_sorx_pdu_cache; 447 kmem_cache_t *idm_so_128k_buf_cache; 448 } idm_global_t; 449 450 idm_global_t idm; /* Global state */ 451 452 int 453 idm_idpool_create(idm_idpool_t *pool); 454 455 void 456 idm_idpool_destroy(idm_idpool_t *pool); 457 458 int 459 idm_idpool_alloc(idm_idpool_t *pool, uint16_t *id); 460 461 void 462 idm_idpool_free(idm_idpool_t *pool, uint16_t id); 463 464 void 465 idm_pdu_rx(idm_conn_t *ic, idm_pdu_t *pdu); 466 467 void 468 idm_pdu_tx_forward(idm_conn_t *ic, idm_pdu_t *pdu); 469 470 boolean_t 471 idm_pdu_rx_forward_ffp(idm_conn_t *ic, idm_pdu_t *pdu); 472 473 void 474 idm_pdu_rx_forward(idm_conn_t *ic, idm_pdu_t *pdu); 475 476 void 477 idm_pdu_tx_protocol_error(idm_conn_t *ic, idm_pdu_t *pdu); 478 479 void 480 idm_pdu_rx_protocol_error(idm_conn_t *ic, idm_pdu_t *pdu); 481 482 void idm_parse_login_rsp(idm_conn_t *ic, idm_pdu_t *logout_req_pdu, 483 boolean_t rx); 484 485 void idm_parse_logout_req(idm_conn_t *ic, idm_pdu_t *logout_req_pdu, 486 boolean_t rx); 487 488 void idm_parse_logout_rsp(idm_conn_t *ic, idm_pdu_t *login_rsp_pdu, 489 boolean_t rx); 490 491 idm_status_t idm_svc_conn_create(idm_svc_t *is, idm_transport_type_t type, 492 idm_conn_t **ic_result); 493 494 void idm_svc_conn_destroy(idm_conn_t *ic); 495 496 idm_status_t idm_ini_conn_finish(idm_conn_t *ic); 497 498 idm_status_t idm_tgt_conn_finish(idm_conn_t *ic); 499 500 idm_conn_t *idm_conn_create_common(idm_conn_type_t conn_type, 501 idm_transport_type_t tt, idm_conn_ops_t *conn_ops); 502 503 void idm_conn_destroy_common(idm_conn_t *ic); 504 505 void idm_conn_close(idm_conn_t *ic); 506 507 uint32_t idm_cid_alloc(void); 508 509 void idm_cid_free(uint32_t cid); 510 511 uint32_t idm_crc32c(void *address, unsigned long length); 512 513 uint32_t idm_crc32c_continued(void *address, unsigned long length, 514 uint32_t crc); 515 516 void idm_listbuf_insert(list_t *lst, idm_buf_t *buf); 517 518 int idm_task_compare(const void *v1, const void *v2); 519 520 idm_conn_t *idm_lookup_conn(uint8_t *isid, uint16_t tsih, uint16_t cid); 521 522 #ifdef __cplusplus 523 } 524 #endif 525 526 #endif /* _IDM_IMPL_H_ */ 527