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 /* 23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _IDM_H 28 #define _IDM_H 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 typedef enum { 35 IDM_STATUS_SUCCESS = 0, 36 IDM_STATUS_FAIL, 37 IDM_STATUS_NORESOURCES, 38 IDM_STATUS_REJECT, 39 IDM_STATUS_IO, 40 IDM_STATUS_ABORTED, 41 IDM_STATUS_SUSPENDED, 42 IDM_STATUS_HEADER_DIGEST, 43 IDM_STATUS_DATA_DIGEST, 44 IDM_STATUS_PROTOCOL_ERROR, 45 IDM_STATUS_LOGIN_FAIL 46 } idm_status_t; 47 48 49 typedef enum { 50 CN_CONNECT_ACCEPT = 1, /* Target only */ 51 CN_LOGIN_FAIL, 52 CN_READY_FOR_LOGIN, /* Initiator only */ 53 CN_FFP_ENABLED, 54 CN_FFP_DISABLED, 55 CN_CONNECT_LOST, 56 CN_CONNECT_DESTROY, 57 CN_CONNECT_FAIL, 58 CN_MAX 59 } idm_client_notify_t; 60 61 #ifdef IDM_CN_NOTIFY_STRINGS 62 static const char *idm_cn_strings[CN_MAX + 1] = { 63 "CN_UNDEFINED", 64 "CN_CONNECT_ACCEPT", 65 "CN_LOGIN_FAIL", 66 "CN_READY_FOR_LOGIN", 67 "CN_FFP_ENABLED", 68 "CN_FFP_DISABLED", 69 "CN_CONNECT_LOST", 70 "CN_CONNECT_DESTROY", 71 "CN_CONNECT_FAIL", 72 "CN_MAX" 73 }; 74 #endif 75 76 typedef enum { 77 FD_CONN_FAIL, 78 FD_CONN_LOGOUT, 79 FD_SESS_LOGOUT 80 } idm_ffp_disable_t; 81 82 typedef enum { 83 AT_INTERNAL_SUSPEND, 84 AT_INTERNAL_ABORT, 85 AT_TASK_MGMT_ABORT 86 } idm_abort_type_t; 87 88 typedef enum { 89 TASK_IDLE, 90 TASK_ACTIVE, 91 TASK_SUSPENDING, 92 TASK_SUSPENDED, 93 TASK_ABORTING, 94 TASK_ABORTED, 95 TASK_COMPLETE, 96 TASK_MAX_STATE 97 } idm_task_state_t; 98 99 #ifdef IDM_TASK_SM_STRINGS 100 static const char *idm_ts_name[TASK_MAX_STATE+1] = { 101 "TASK_IDLE", 102 "TASK_ACTIVE", 103 "TASK_SUSPENDING", 104 "TASK_SUSPENDED", 105 "TASK_ABORTING", 106 "TASK_ABORTED", 107 "TASK_COMPLETE", 108 "TASK_MAX_STATE" 109 }; 110 #endif 111 112 typedef enum { 113 KV_HANDLED = 0, 114 KV_HANDLED_NO_TRANSIT, 115 KV_UNHANDLED, 116 KV_TARGET_ONLY, 117 KV_NO_RESOURCES, 118 KV_INTERNAL_ERROR, 119 KV_VALUE_ERROR, 120 KV_MISSING_FIELDS, 121 KV_AUTH_FAILED 122 } kv_status_t; 123 124 /* 125 * Request structures 126 */ 127 128 /* Defined in idm_impl.h */ 129 struct idm_conn_s; 130 struct idm_svc_s; 131 struct idm_buf_s; 132 struct idm_pdu_s; 133 struct idm_task_s; 134 135 typedef idm_status_t (idm_client_notify_cb_t)( 136 struct idm_conn_s *ic, idm_client_notify_t cn, uintptr_t data); 137 138 typedef void (idm_rx_pdu_cb_t)(struct idm_conn_s *ic, struct idm_pdu_s *pdu); 139 140 typedef void (idm_rx_pdu_error_cb_t)(struct idm_conn_s *ic, 141 struct idm_pdu_s *pdu, idm_status_t status); 142 143 typedef void (idm_buf_cb_t)(struct idm_buf_s *idb, idm_status_t status); 144 145 typedef void (idm_pdu_cb_t)(struct idm_pdu_s *pdu, idm_status_t status); 146 147 typedef void (idm_task_cb_t)(struct idm_task_s *task, idm_status_t status); 148 149 typedef void (idm_build_hdr_cb_t)( 150 struct idm_task_s *task, struct idm_pdu_s *pdu, uint8_t opcode); 151 152 typedef void (idm_keepalive_cb_t)(struct idm_conn_s *ic); 153 154 typedef union idm_sockaddr { 155 struct sockaddr sin; 156 struct sockaddr_in sin4; 157 struct sockaddr_in6 sin6; 158 } idm_sockaddr_t; 159 160 #define SIZEOF_SOCKADDR(so) \ 161 ((so)->sa_family == AF_INET ? \ 162 sizeof (struct sockaddr_in) : sizeof (struct sockaddr_in6)) 163 164 typedef struct { 165 idm_rx_pdu_cb_t *icb_rx_scsi_cmd; 166 idm_rx_pdu_cb_t *icb_rx_scsi_rsp; 167 idm_rx_pdu_cb_t *icb_rx_misc; 168 idm_rx_pdu_error_cb_t *icb_rx_error; 169 idm_task_cb_t *icb_task_aborted; 170 idm_client_notify_cb_t *icb_client_notify; 171 idm_build_hdr_cb_t *icb_build_hdr; 172 idm_keepalive_cb_t *icb_keepalive; 173 } idm_conn_ops_t; 174 175 typedef struct { 176 int cr_domain; 177 int cr_type; 178 int cr_protocol; 179 boolean_t cr_bound; 180 idm_sockaddr_t cr_bound_addr; 181 idm_sockaddr_t cr_ini_dst_addr; 182 ldi_ident_t cr_li; 183 idm_conn_ops_t icr_conn_ops; 184 } idm_conn_req_t; 185 186 typedef struct { 187 uint16_t sr_port; 188 ldi_ident_t sr_li; 189 idm_conn_ops_t sr_conn_ops; 190 } idm_svc_req_t; 191 192 193 /* This is not how other networking code handles this */ 194 typedef struct { 195 union { 196 struct in_addr in4; 197 struct in6_addr in6; 198 } i_addr; 199 /* i_insize determines which is valid in the union above */ 200 int i_insize; 201 } idm_ipaddr_t; 202 203 typedef struct { 204 idm_ipaddr_t a_addr; 205 uint32_t a_port, 206 a_oid; 207 } idm_addr_t; 208 209 typedef struct { 210 uint32_t al_vers, /* In */ 211 al_oid; /* In */ 212 uint32_t al_in_cnt; /* In */ 213 uint32_t al_out_cnt; /* Out */ 214 uint32_t al_tpgt; /* Out */ 215 idm_addr_t al_addrs[1]; /* Out */ 216 } idm_addr_list_t; 217 218 /* 219 * State machine auditing 220 */ 221 222 #define SM_AUDIT_BUF_MAX_REC 32 223 224 typedef enum { 225 SAR_UNDEFINED = 0, 226 SAR_STATE_EVENT, 227 SAR_STATE_CHANGE 228 } sm_audit_record_type_t; 229 230 typedef enum { 231 SAS_UNDEFINED = 0, 232 SAS_IDM_CONN, 233 SAS_IDM_TASK, 234 SAS_ISCSIT_TGT, 235 SAS_ISCSIT_SESS, 236 SAS_ISCSIT_LOGIN, 237 SAS_ISCSI_CMD, 238 SAS_ISCSI_SESS, 239 SAS_ISCSI_CONN, 240 SAS_ISCSI_LOGIN 241 } sm_audit_sm_type_t; 242 243 typedef struct { 244 timespec_t sar_timestamp; 245 sm_audit_sm_type_t sar_sm_type; 246 sm_audit_record_type_t sar_type; 247 int sar_state; 248 int sar_new_state; /* Only for SAR_STATE_CHANGE */ 249 int sar_event; /* Only for SAR_STATE_EVENT */ 250 uintptr_t sar_event_info; /* Only for SAR_STATE_EVENT */ 251 } sm_audit_record_t; 252 253 typedef struct { 254 int sab_index; 255 int sab_max_index; 256 sm_audit_record_t sab_records[SM_AUDIT_BUF_MAX_REC]; 257 } sm_audit_buf_t; 258 259 extern boolean_t idm_sm_logging; 260 extern boolean_t idm_conn_logging; 261 extern boolean_t idm_svc_logging; 262 263 #define IDM_SM_LOG if (idm_sm_logging) cmn_err 264 #define IDM_CONN_LOG if (idm_conn_logging) cmn_err 265 #define IDM_SVC_LOG if (idm_svc_logging) cmn_err 266 267 void idm_sm_audit_init(sm_audit_buf_t *audit_buf); 268 269 void idm_sm_audit_event(sm_audit_buf_t *audit_buf, 270 sm_audit_sm_type_t sm_type, 271 int state, int event, uintptr_t event_info); 272 273 void idm_sm_audit_state_change(sm_audit_buf_t *audit_buf, 274 sm_audit_sm_type_t sm_type, int state, int new_state); 275 276 277 #include <sys/iscsi_protocol.h> 278 #include <sys/idm/idm_conn_sm.h> 279 #include <sys/idm/idm_transport.h> 280 #include <sys/idm/idm_impl.h> 281 #include <sys/idm/idm_text.h> 282 #include <sys/idm/idm_so.h> 283 284 /* 285 * iSCSI Initiator Services 286 */ 287 288 idm_status_t 289 idm_ini_conn_create(idm_conn_req_t *cr, idm_conn_t **new_con); 290 291 idm_status_t 292 idm_ini_conn_connect(idm_conn_t *ic); 293 294 void 295 idm_ini_conn_disconnect(idm_conn_t *ic); 296 297 void 298 idm_ini_conn_disconnect_sync(idm_conn_t *ic); 299 300 void 301 idm_ini_conn_destroy(idm_conn_t *ic); 302 303 /* 304 * iSCSI Target Services 305 */ 306 307 idm_status_t 308 idm_tgt_svc_create(idm_svc_req_t *sr, idm_svc_t **new_svc); 309 310 idm_status_t 311 idm_tgt_svc_online(idm_svc_t *is); 312 313 void 314 idm_tgt_svc_offline(idm_svc_t *is); 315 316 void 317 idm_tgt_svc_destroy(idm_svc_t *is); 318 319 void 320 idm_tgt_svc_destroy_if_unref(idm_svc_t *is); 321 322 idm_svc_t * 323 idm_tgt_svc_lookup(uint16_t port); 324 325 void 326 idm_tgt_svc_hold(idm_svc_t *is); 327 328 void 329 idm_tgt_svc_rele_and_destroy(idm_svc_t *is); 330 331 idm_status_t 332 idm_tgt_conn_accept(idm_conn_t *ic); 333 334 void 335 idm_tgt_conn_reject(idm_conn_t *ic); 336 337 void 338 idm_conn_hold(idm_conn_t *ic); 339 340 void 341 idm_conn_rele(idm_conn_t *ic); 342 343 void 344 idm_conn_set_target_name(idm_conn_t *ic, char *target_name); 345 346 void 347 idm_conn_set_initiator_name(idm_conn_t *ic, char *initiator_name); 348 349 void 350 idm_conn_set_isid(idm_conn_t *ic, uint8_t isid[ISCSI_ISID_LEN]); 351 352 /* 353 * Target data transfer services 354 */ 355 idm_status_t 356 idm_buf_tx_to_ini(idm_task_t *idt, idm_buf_t *idb, 357 uint32_t offset, uint32_t xfer_length, 358 idm_buf_cb_t idb_buf_cb, void *cb_arg); 359 360 idm_status_t 361 idm_buf_rx_from_ini(idm_task_t *idt, idm_buf_t *idb, 362 uint32_t offset, uint32_t xfer_length, 363 idm_buf_cb_t idb_buf_cb, void *cb_arg); 364 365 void 366 idm_buf_tx_to_ini_done(idm_task_t *idt, idm_buf_t *idb, idm_status_t status); 367 368 void 369 idm_buf_rx_from_ini_done(idm_task_t *idt, idm_buf_t *idb, idm_status_t status); 370 371 #define XFER_BUF_TX_TO_INI 0 372 #define XFER_BUF_RX_FROM_INI 1 373 /* 374 * Shared Initiator/Target Services 375 */ 376 kv_status_t 377 idm_negotiate_key_values(idm_conn_t *ic, nvlist_t *request_nvl, 378 nvlist_t *response_nvl, nvlist_t *negotiated_nvl); 379 380 void 381 idm_notice_key_values(idm_conn_t *ic, nvlist_t *negotiated_nvl); 382 383 /* 384 * Buffer services 385 */ 386 387 idm_buf_t * 388 idm_buf_alloc(idm_conn_t *ic, void *bufptr, uint64_t buflen); 389 390 void 391 idm_buf_free(idm_buf_t *idb); 392 393 void 394 idm_buf_bind_in(idm_task_t *idt, idm_buf_t *buf); 395 396 void 397 idm_buf_bind_out(idm_task_t *idt, idm_buf_t *buf); 398 399 void 400 idm_buf_unbind_in(idm_task_t *idt, idm_buf_t *buf); 401 402 void 403 idm_buf_unbind_out(idm_task_t *idt, idm_buf_t *buf); 404 405 idm_buf_t * 406 idm_buf_find(void *lbuf, size_t data_offset); 407 408 void 409 idm_bufpat_set(idm_buf_t *idb); 410 411 boolean_t 412 idm_bufpat_check(idm_buf_t *idb, int check_len, idm_bufpat_check_type_t type); 413 414 extern boolean_t idm_pattern_checking; 415 416 #define IDM_BUFPAT_SET(CHK_BUF) \ 417 if (idm_pattern_checking && (CHK_BUF)->idb_bufalloc) { \ 418 idm_bufpat_set(CHK_BUF); \ 419 } 420 421 #define IDM_BUFPAT_CHECK(CHK_BUF, CHK_LEN, CHK_TYPE) \ 422 if (idm_pattern_checking) { \ 423 (void) idm_bufpat_check(CHK_BUF, CHK_LEN, CHK_TYPE); \ 424 } 425 426 /* 427 * Task services 428 */ 429 idm_task_t * 430 idm_task_alloc(idm_conn_t *ic); 431 432 void 433 idm_task_start(idm_task_t *idt, uintptr_t handle); 434 435 void 436 idm_task_abort(idm_conn_t *ic, idm_task_t *idt, idm_abort_type_t abort_type); 437 438 void 439 idm_task_cleanup(idm_task_t *idt); 440 441 void 442 idm_task_done(idm_task_t *idt); 443 444 void 445 idm_task_free(idm_task_t *idt); 446 447 idm_task_t * 448 idm_task_find(idm_conn_t *ic, uint32_t itt, uint32_t ttt); 449 450 idm_task_t * 451 idm_task_find_and_complete(idm_conn_t *ic, uint32_t itt, uint32_t ttt); 452 453 void * 454 idm_task_find_by_handle(idm_conn_t *ic, uintptr_t handle); 455 456 void 457 idm_task_hold(idm_task_t *idt); 458 459 void 460 idm_task_rele(idm_task_t *idt); 461 462 /* 463 * PDU Services 464 */ 465 466 idm_pdu_t * 467 idm_pdu_alloc(uint_t hdrlen, uint_t datalen); 468 469 idm_pdu_t * 470 idm_pdu_alloc_nosleep(uint_t hdrlen, uint_t datalen); 471 472 void 473 idm_pdu_free(idm_pdu_t *pdu); 474 475 void 476 idm_pdu_init(idm_pdu_t *pdu, idm_conn_t *ic, void *private, idm_pdu_cb_t *cb); 477 478 void 479 idm_pdu_init_hdr(idm_pdu_t *pdu, uint8_t *hdr, uint_t hdrlen); 480 481 void 482 idm_pdu_init_data(idm_pdu_t *pdu, uint8_t *data, uint_t datalen); 483 484 void 485 idm_pdu_complete(idm_pdu_t *pdu, idm_status_t status); 486 487 void 488 idm_pdu_tx(idm_pdu_t *pdu); 489 490 /* 491 * Object reference tracking 492 */ 493 494 void 495 idm_refcnt_init(idm_refcnt_t *refcnt, void *referenced_obj); 496 497 void 498 idm_refcnt_destroy(idm_refcnt_t *refcnt); 499 500 void 501 idm_refcnt_reset(idm_refcnt_t *refcnt); 502 503 void 504 idm_refcnt_hold(idm_refcnt_t *refcnt); 505 506 void 507 idm_refcnt_rele(idm_refcnt_t *refcnt); 508 509 void 510 idm_refcnt_rele_and_destroy(idm_refcnt_t *refcnt, idm_refcnt_cb_t *cb_func); 511 512 void 513 idm_refcnt_wait_ref(idm_refcnt_t *refcnt); 514 515 void 516 idm_refcnt_async_wait_ref(idm_refcnt_t *refcnt, idm_refcnt_cb_t *cb_func); 517 518 519 #ifdef __cplusplus 520 } 521 #endif 522 523 #endif /* _IDM_H */ 524