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 (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
  25  * Copyright (c) 2017, Joyent, Inc.  All rights reserved.
  26  */
  27 
  28 #ifndef _ISCSIT_H_
  29 #define _ISCSIT_H_
  30 
  31 #include <sys/iscsit/iscsi_if.h>
  32 #include <sys/iscsit/iscsit_common.h>
  33 
  34 #include "iscsit_authclient.h"
  35 
  36 /*
  37  * For some reason iscsi_protocol.h lists the max version as "0x02" and the
  38  * min version as "0x00".  RFC3720 clearly states that the current version
  39  * number is 0x00 so that is what we will use.
  40  */
  41 #define ISCSIT_MIN_VERSION                      0x00
  42 #define ISCSIT_MAX_VERSION                      0x00
  43 #define ISCSIT_MAX_CONNECTIONS                  32 /* MC/S support  */
  44 #define ISCSIT_MAX_RECV_DATA_SEGMENT_LENGTH     (32*1024)
  45 #define ISCSIT_MAX_BURST_LENGTH                 (1024*1024)
  46 #define ISCSIT_MAX_FIRST_BURST_LENGTH           ISCSI_DEFAULT_FIRST_BURST_LENGTH
  47 #define ISCSIT_MAX_TIME2WAIT                    ISCSI_MAX_TIME2WAIT
  48 #define ISCSIT_MAX_TIME2RETAIN                  ISCSI_DEFAULT_TIME_TO_RETAIN
  49 #define ISCSIT_MAX_OUTSTANDING_R2T              ISCSI_DEFAULT_MAX_OUT_R2T
  50 #define ISCSIT_MAX_ERROR_RECOVERY_LEVEL         0
  51 #define ISCSIT_MAX_OUTSTANDING_UNEXPECTED_PDUS  0
  52 
  53 #define ISCSIT_DEFAULT_TPG      "iscsit-default-tpg"
  54 #define ISCSIT_DEFAULT_TPGT     1
  55 
  56 #define ISCSI_MAX_TSIH          0xffff
  57 #define ISCSI_UNSPEC_TSIH       0
  58 
  59 /* Max targets per system */
  60 #define ISCSIT_MAX_TARGETS      1024
  61 
  62 #define ISCSIT_MAX_WINDOW       1024
  63 #define ISCSIT_RXPDU_QUEUE_LEN  2048
  64 
  65 /*
  66  * MC/S: A timeout is maintained to recover from lost CmdSN (holes in the
  67  * CmdSN ordering). When the timeout is reached, the ExpCmdSN is advanced
  68  * past the hole to continue processing the queued commands. This value is
  69  * system-tunable (volatile rxpdu_queue_threshold) and should be in the
  70  * range from 5 to 30 seconds.
  71  */
  72 #define ISCSIT_RXPDU_QUEUE_THRESHOLD            5       /* 5 seconds */
  73 #define ISCSIT_RXPDU_QUEUE_MONITOR_INTERVAL     5       /* 5 seconds */
  74 
  75 /* Time in seconds to wait between calls to stmf_deregister_local_port */
  76 #define TGT_DEREG_RETRY_SECONDS 1
  77 
  78 #define ISCSIT_GLOBAL_LOCK(rw) rw_enter(&iscsit_global.global_rwlock, (rw))
  79 #define ISCSIT_GLOBAL_UNLOCK() rw_exit(&iscsit_global.global_rwlock)
  80 
  81 /* Circular buffer to hold the out-of-order PDUs in MC/S */
  82 typedef struct {
  83         idm_pdu_t       *cb_buffer[ISCSIT_RXPDU_QUEUE_LEN];
  84         int             cb_num_elems;
  85 } iscsit_cbuf_t;
  86 
  87 /*
  88  * Used for serial number arithmetic (RFC 1982)
  89  */
  90 #define ISCSIT_SNA32_CHECK      0x80000000
  91 
  92 typedef struct {
  93         char            tpg_name[MAX_TPG_NAMELEN];
  94         kmutex_t        tpg_mutex;
  95         idm_refcnt_t    tpg_refcnt;
  96         int             tpg_online;
  97         avl_tree_t      tpg_portal_list;
  98         avl_node_t      tpg_global_ln;
  99         list_node_t     tpg_delete_ln;
 100 } iscsit_tpg_t;
 101 
 102 #define IS_DEFAULT_TPGT(TPGT) \
 103         (((TPGT) != NULL) && \
 104             ((TPGT)->tpgt_tpg == iscsit_global.global_default_tpg))
 105 
 106 typedef struct {
 107         iscsit_tpg_t    *tpgt_tpg;
 108         idm_refcnt_t    tpgt_refcnt;
 109         avl_node_t      tpgt_tgt_ln;
 110         list_node_t     tpgt_delete_ln;
 111         uint16_t        tpgt_tag;
 112         boolean_t       tpgt_needs_tpg_offline;
 113 } iscsit_tpgt_t;
 114 
 115 typedef struct {
 116         struct sockaddr_storage portal_addr;
 117         int                     portal_online;
 118         idm_refcnt_t            portal_refcnt;
 119         avl_node_t              portal_tpg_ln;
 120         iscsit_tpg_t            *portal_tpg;
 121         idm_svc_t               *portal_svc;
 122         boolean_t               portal_default;
 123         void                    *portal_isns;
 124 } iscsit_portal_t;
 125 
 126 
 127 /* Target states and events, update iscsit_ts_name table whenever modified */
 128 typedef enum {
 129         TS_UNDEFINED = 0,
 130         TS_CREATED,
 131         TS_ONLINING,
 132         TS_ONLINE,
 133         TS_STMF_ONLINE,
 134         TS_DELETING_NEED_OFFLINE,
 135         TS_OFFLINING,
 136         TS_OFFLINE,
 137         TS_STMF_OFFLINE,
 138         TS_DELETING_STMF_DEREG,
 139         TS_DELETING_STMF_DEREG_FAIL,
 140         TS_DELETING,
 141         TS_MAX_STATE
 142 } iscsit_tgt_state_t;
 143 
 144 #ifdef ISCSIT_TGT_SM_STRINGS
 145 static const char *iscsit_ts_name[TS_MAX_STATE+1] = {
 146         "TS_UNDEFINED",
 147         "TS_CREATED",
 148         "TS_ONLINING",
 149         "TS_ONLINE",
 150         "TS_STMF_ONLINE",
 151         "TS_DELETING_NEED_OFFLINE",
 152         "TS_OFFLINING",
 153         "TS_OFFLINE",
 154         "TS_STMF_OFFLINE",
 155         "TS_DELETING_STMF_DEREG",
 156         "TS_DELETING_STMF_DEREG_FAIL",
 157         "TS_DELETING",
 158         "TS_MAX_STATE"
 159 };
 160 #endif
 161 
 162 typedef enum {
 163         TE_UNDEFINED = 0,
 164         TE_STMF_ONLINE_REQ,
 165         TE_ONLINE_SUCCESS,
 166         TE_ONLINE_FAIL,
 167         TE_STMF_ONLINE_COMPLETE_ACK,
 168         TE_STMF_OFFLINE_REQ,
 169         TE_OFFLINE_COMPLETE,
 170         TE_STMF_OFFLINE_COMPLETE_ACK,
 171         TE_DELETE,
 172         TE_STMF_DEREG_SUCCESS,
 173         TE_STMF_DEREG_FAIL,
 174         TE_STMF_DEREG_RETRY,
 175         TE_WAIT_REF_COMPLETE,
 176         TE_MAX_EVENT
 177 } iscsit_tgt_event_t;
 178 
 179 #ifdef ISCSIT_TGT_SM_STRINGS
 180 static const char *iscsit_te_name[TE_MAX_EVENT+1] = {
 181         "TE_UNDEFINED",
 182         "TE_STMF_ONLINE_REQ",
 183         "TE_ONLINE_SUCCESS",
 184         "TE_ONLINE_FAIL",
 185         "TE_STMF_ONLINE_COMPLETE_ACK",
 186         "TE_STMF_OFFLINE_REQ",
 187         "TE_OFFLINE_COMPLETE",
 188         "TE_STMF_OFFLINE_COMPLETE_ACK",
 189         "TE_DELETE",
 190         "TE_STMF_DEREG_SUCCESS",
 191         "TE_STMF_DEREG_FAIL",
 192         "TE_STMF_DEREG_RETRY",
 193         "TE_WAIT_REF_COMPLETE",
 194         "TE_MAX_EVENT"
 195 };
 196 #endif
 197 
 198 typedef struct {
 199         char                    *target_name;
 200         nvlist_t                *target_props;
 201         kmutex_t                target_mutex;
 202         idm_refcnt_t            target_refcnt;
 203         idm_refcnt_t            target_sess_refcnt;
 204         avl_tree_t              target_tpgt_list;
 205         avl_tree_t              target_sess_list;
 206         avl_node_t              target_global_ln;
 207         avl_node_t              target_global_deleted_ln;
 208         /* STMF lport == iSCSI target */
 209         scsi_devid_desc_t       *target_devid;
 210         stmf_local_port_t       *target_stmf_lport;
 211         uint8_t                 target_stmf_lport_registered;
 212 
 213         /* Target state */
 214         boolean_t               target_sm_busy;
 215         boolean_t               target_deleting;
 216         iscsit_tgt_state_t      target_state;
 217         iscsit_tgt_state_t      target_last_state;
 218         sm_audit_buf_t          target_state_audit;
 219         list_t                  target_events;
 220         uint64_t                target_generation;
 221 } iscsit_tgt_t;
 222 
 223 typedef struct {
 224         char                    ini_name[MAX_ISCSI_NODENAMELEN];
 225         nvlist_t                *ini_props;
 226         avl_node_t              ini_global_ln;
 227 } iscsit_ini_t;
 228 
 229 /*
 230  * iSCSI Auth Information
 231  */
 232 typedef struct conn_auth {
 233         char                    ca_tgt_chapuser[iscsitAuthStringMaxLength];
 234         uint8_t                 ca_tgt_chapsecret[iscsitAuthStringMaxLength];
 235         int                     ca_tgt_chapsecretlen;
 236 
 237         char                    ca_ini_chapuser[iscsitAuthStringMaxLength];
 238         uint8_t                 ca_ini_chapsecret[iscsitAuthStringMaxLength];
 239         int                     ca_ini_chapsecretlen;
 240 
 241         /* RADIUS authentication information    */
 242         boolean_t               ca_use_radius;
 243         struct sockaddr_storage ca_radius_server;
 244         uint8_t                 ca_radius_secret[iscsitAuthStringMaxLength];
 245         int                     ca_radius_secretlen;
 246 
 247         /* authentication method list */
 248         iscsit_auth_method_t    ca_method_valid_list[iscsitAuthMethodMaxCount];
 249 
 250         /* Target alias */
 251         char                    ca_tgt_alias[MAX_ISCSI_NODENAMELEN];
 252 } conn_auth_t;
 253 
 254 /*
 255  * We have three state machines (so far) between the IDM connection state
 256  * machine, the session state machine, and the login state machine.  All
 257  * of these states have some concept of "full feature mode".  It's going
 258  * to be obnoxious if we use a mixture of these "ffp" representations
 259  * since it will be difficult to ensure the three state machines
 260  * transition at exactly the same time.  We should drive decisions that
 261  * depend on FFP from the IDM state machine which is actually snooping
 262  * the iSCSI PDU's and will always transition at the correct time.
 263  *
 264  * A consequence of this approach is that there is a window just after
 265  * login completes where we may get a SCSI request but the session
 266  * or login state machine has not quite transitioned to "FFP".  Whether
 267  * this is a problem depends on how we use those state machines.  This
 268  * is what we should use them for:
 269  *
 270  * IDM Connection state machine - Decisions related to command processing
 271  * including whether a connection is in FFP
 272  *
 273  * Session state machine - Summarize the state of all available connections
 274  * for the purposes of ERL1, ERL2 and MC/S.  A session in LOGGED_IN state
 275  * should always have at least one FFP connection but there may be a brief
 276  * window where a session in ACTIVE might have one or more FFP connections
 277  * even though ACTIVE is not strictly an FFP state according to the RFC.
 278  *
 279  * Login state machine -- drive the login process, collect negotiated
 280  * parameters.  Another side effect of this approach is that we may get
 281  * the "notify ffp" callback from the IDM connection state machine before
 282  * the login state machine has actually transitioned to FFP state.
 283  */
 284 
 285 struct iscsit_conn_s;
 286 
 287 /* Update iscsit_ss_name table whenever session states are modified */
 288 typedef enum {
 289         SS_UNDEFINED = 0,
 290         SS_Q1_FREE,
 291         SS_Q2_ACTIVE,
 292         SS_Q3_LOGGED_IN,
 293         SS_Q4_FAILED,
 294         SS_Q5_CONTINUE,
 295         SS_Q6_DONE,
 296         SS_Q7_ERROR,
 297         /* Add new session states above SS_MAX_STATE */
 298         SS_MAX_STATE
 299 } iscsit_session_state_t;
 300 
 301 #ifdef ISCSIT_SESS_SM_STRINGS
 302 /* An array of state text values, for use in logging state transitions */
 303 static const char *iscsit_ss_name[SS_MAX_STATE+1] = {
 304         "SS_UNDEFINED",
 305         "SS_Q1_FREE",
 306         "SS_Q2_ACTIVE",
 307         "SS_Q3_LOGGED_IN",
 308         "SS_Q4_FAILED",
 309         "SS_Q5_CONTINUE",
 310         "SS_Q6_DONE",
 311         "SS_Q7_ERROR",
 312         "SS_MAX_STATE"
 313 };
 314 #endif
 315 
 316 /* Update iscsit_se_name table whenever session events are modified */
 317 typedef enum {
 318         SE_UNDEFINED = 0,
 319         SE_CONN_IN_LOGIN,       /* From login state machine */
 320         SE_CONN_LOGGED_IN,      /* FFP enabled client notification */
 321         SE_CONN_FFP_FAIL,       /* FFP disabled client notification */
 322         SE_CONN_FFP_DISABLE,    /* FFP disabled client notification */
 323         SE_CONN_FAIL,           /* Conn destroy client notification */
 324         SE_SESSION_CLOSE,       /* FFP disabled client notification */
 325         SE_SESSION_REINSTATE,   /* From login state machine */
 326         SE_SESSION_TIMEOUT,     /* Internal */
 327         SE_SESSION_CONTINUE,    /* From login state machine */
 328         SE_SESSION_CONTINUE_FAIL, /* From login state machine? */
 329         /* Add new events above SE_MAX_EVENT */
 330         SE_MAX_EVENT
 331 } iscsit_session_event_t;
 332 
 333 #ifdef ISCSIT_SESS_SM_STRINGS
 334 /* An array of event text values, for use in logging events */
 335 static const char *iscsit_se_name[SE_MAX_EVENT+1] = {
 336         "SE_UNDEFINED",
 337         "SE_CONN_IN_LOGIN",
 338         "SE_CONN_LOGGED_IN",
 339         "SE_CONN_FFP_FAIL",
 340         "SE_CONN_FFP_DISABLE",
 341         "SE_CONN_FAIL",
 342         "SE_SESSION_CLOSE",
 343         "SE_SESSION_REINSTATE",
 344         "SE_SESSION_TIMEOUT",
 345         "SE_SESSION_CONTINUE",
 346         "SE_SESSION_CONTINUE_FAIL",
 347         "SE_MAX_EVENT"
 348 };
 349 #endif
 350 
 351 /*
 352  * Set in ist_tgt after iscsit_tgt_unbind_sess to differentiate an unbound
 353  * session from a discovery session.
 354  */
 355 #define SESS_UNBOUND_FROM_TGT   -1
 356 
 357 typedef struct {
 358         stmf_scsi_session_t     *ist_stmf_sess;
 359         stmf_local_port_t       *ist_lport;
 360         iscsit_tgt_t            *ist_tgt;
 361         idm_refcnt_t            ist_refcnt;
 362         kmem_cache_t            *ist_task_cache;
 363         kmutex_t                ist_sn_mutex;
 364         kmutex_t                ist_mutex;
 365         kcondvar_t              ist_cv;
 366         iscsit_session_state_t  ist_state;
 367         iscsit_session_state_t  ist_last_state;
 368         sm_audit_buf_t          ist_state_audit;
 369         boolean_t               ist_sm_busy;
 370         boolean_t               ist_sm_complete;
 371         boolean_t               ist_admin_close;
 372         list_t                  ist_events;
 373         int                     ist_conn_count;
 374         int                     ist_ffp_conn_count;
 375         struct iscsit_conn_s    *ist_failed_conn;
 376         timeout_id_t            ist_state_timeout;
 377         list_t                  ist_conn_list;
 378         avl_node_t              ist_tgt_ln;
 379         char                    *ist_initiator_name;
 380         char                    *ist_initiator_alias;
 381         char                    *ist_target_name;
 382         char                    *ist_target_alias;
 383         uint8_t                 ist_isid[ISCSI_ISID_LEN];
 384         uint16_t                ist_tsih;
 385         uint16_t                ist_tpgt_tag;
 386         uint32_t                ist_expcmdsn;
 387         uint32_t                ist_maxcmdsn;
 388         avl_tree_t              ist_task_list;
 389         iscsit_cbuf_t           *ist_rxpdu_queue;
 390 } iscsit_sess_t;
 391 
 392 /* Update iscsit_ils_name table whenever login states are modified */
 393 typedef enum {
 394         ILS_UNDEFINED = 0,
 395         ILS_LOGIN_INIT,
 396         ILS_LOGIN_WAITING,      /* Waiting for more login PDU's */
 397         ILS_LOGIN_PROCESSING,   /* Processing login request */
 398         ILS_LOGIN_RESPONDING,   /* Sending login response */
 399         ILS_LOGIN_RESPONDED,    /* Sent login response (no trans. to FFP) */
 400         ILS_LOGIN_FFP,          /* Sending last login PDU for final response */
 401         ILS_LOGIN_DONE,         /* Last login PDU sent (so we can free it) */
 402         ILS_LOGIN_ERROR,        /* Login error, login failed */
 403         /* Add new login states above ILS_MAX_STATE */
 404         ILS_MAX_STATE
 405 } iscsit_login_state_t;
 406 
 407 #ifdef ISCSIT_LOGIN_SM_STRINGS
 408 /* An array of login state text values, for use in logging login progress */
 409 static const char *iscsit_ils_name[ILS_MAX_STATE+1] = {
 410         "ILS_UNDEFINED",
 411         "ILS_LOGIN_INIT",
 412         "ILS_LOGIN_WAITING",
 413         "ILS_LOGIN_PROCESSING",
 414         "ILS_LOGIN_RESPONDING",
 415         "ILS_LOGIN_RESPONDED",
 416         "ILS_LOGIN_FFP",
 417         "ILS_LOGIN_DONE",
 418         "ILS_LOGIN_ERROR",
 419         "ILS_MAX_STATE"
 420 };
 421 #endif
 422 
 423 /* Update iscsit_ile_name table whenever login events are modified */
 424 typedef enum {
 425         ILE_UNDEFINED = 0,
 426         ILE_LOGIN_RCV,
 427         ILE_LOGIN_RESP_READY,
 428         ILE_LOGIN_FFP,
 429         ILE_LOGIN_RESP_COMPLETE,
 430         ILE_LOGIN_ERROR,
 431         ILE_LOGIN_CONN_ERROR,
 432         /* Add new login events above ILE_MAX_EVENT */
 433         ILE_MAX_EVENT
 434 } iscsit_login_event_t;
 435 
 436 #ifdef ISCSIT_LOGIN_SM_STRINGS
 437 /* An array of login event text values, for use in logging login events */
 438 static const char *iscsit_ile_name[ILE_MAX_EVENT+1] = {
 439         "ILE_UNDEFINED",
 440         "ILE_LOGIN_RCV",
 441         "ILE_LOGIN_RESP_READY",
 442         "ILE_LOGIN_FFP",
 443         "ILE_LOGIN_RESP_COMPLETE",
 444         "ILE_LOGIN_ERROR",
 445         "ILE_LOGIN_CONN_ERROR",
 446         "ILE_MAX_EVENT"
 447 };
 448 #endif
 449 
 450 typedef struct {
 451         uint32_t                op_initial_params_set:1,
 452                                 op_discovery_session:1,
 453                                 op_initial_r2t:1,
 454                                 op_immed_data:1,
 455                                 op_data_pdu_in_order:1,
 456                                 op_data_sequence_in_order:1,
 457                                 op_declarative_params_set:1;
 458         uint64_t                op_max_connections;
 459         uint64_t                op_max_recv_data_segment_length;
 460         uint64_t                op_max_burst_length;
 461         uint64_t                op_first_burst_length;
 462         uint64_t                op_default_time_2_wait;
 463         uint64_t                op_default_time_2_retain;
 464         uint64_t                op_max_outstanding_r2t;
 465         uint64_t                op_error_recovery_level;
 466 } iscsit_op_params_t;
 467 
 468 typedef struct {
 469         iscsit_login_state_t    icl_login_state;
 470         iscsit_login_state_t    icl_login_last_state;
 471         sm_audit_buf_t          icl_state_audit;
 472         boolean_t               icl_busy;
 473         boolean_t               icl_login_complete;
 474         kmutex_t                icl_mutex;
 475         uint32_t                icl_login_itt;
 476         uint8_t                 icl_login_csg;
 477         uint8_t                 icl_login_nsg;
 478         boolean_t               icl_login_transit;
 479         conn_auth_t             icl_auth;
 480         iscsit_auth_client_t    icl_auth_client;
 481         int                     icl_auth_pass;
 482         list_t                  icl_login_events;
 483         list_t                  icl_pdu_list;
 484         uint16_t                icl_tsih;
 485         uint8_t                 icl_isid[ISCSI_ISID_LEN];
 486         uint32_t                icl_cmdsn;
 487         uint16_t                icl_tpgt_tag;
 488         char                    *icl_target_name;
 489         char                    *icl_target_alias;
 490         char                    *icl_initiator_name;
 491         char                    *icl_login_resp_buf;
 492         void                    *icl_login_resp_itb; /* mult-pdu idm buf */
 493         int                     icl_login_resp_len; /* For kmem_free */
 494         int                     icl_login_resp_valid_len;
 495         uint8_t                 icl_login_resp_err_class;
 496         uint8_t                 icl_login_resp_err_detail;
 497         iscsi_login_rsp_hdr_t   *icl_login_resp_tmpl;
 498         nvlist_t                *icl_request_nvlist;
 499         nvlist_t                *icl_response_nvlist;
 500         nvlist_t                *icl_negotiated_values;
 501 } iscsit_conn_login_t;
 502 
 503 #define SET_LOGIN_ERROR(SLE_ICT, SLE_CLASS, SLE_DETAIL) \
 504         (SLE_ICT)->ict_login_sm.icl_login_resp_err_class = (SLE_CLASS); \
 505         (SLE_ICT)->ict_login_sm.icl_login_resp_err_detail = (SLE_DETAIL);
 506 
 507 typedef struct iscsit_conn_s {
 508         idm_conn_t              *ict_ic;
 509         iscsit_sess_t           *ict_sess;
 510         kmutex_t                ict_mutex;
 511         idm_refcnt_t            ict_refcnt;
 512         idm_refcnt_t            ict_dispatch_refcnt;
 513         list_node_t             ict_sess_ln;
 514         iscsit_conn_login_t     ict_login_sm;
 515         iscsit_op_params_t      ict_op;
 516         uint16_t                ict_cid;
 517         uint32_t                ict_statsn;
 518         kmutex_t                ict_statsn_mutex;
 519         uint32_t                ict_keepalive_ttt;
 520         struct iscsit_conn_s    *ict_reinstate_conn;
 521         uint32_t                ict_reinstating:1,
 522                                 ict_lost:1,
 523                                 ict_destroyed:1;
 524         /*
 525          * Parameters for processing text commands
 526          */
 527         char                    *ict_text_rsp_buf;
 528         uint32_t                ict_text_rsp_len;
 529         uint32_t                ict_text_rsp_valid_len;
 530         uint32_t                ict_text_rsp_off;
 531         uint32_t                ict_text_req_itt;       /* from initiator */
 532         uint32_t                ict_text_rsp_ttt;
 533 } iscsit_conn_t;
 534 
 535 #define ICT_FLAGS_DISCOVERY     0x00000001
 536 
 537 typedef struct {
 538         idm_buf_t               *ibuf_idm_buf;
 539         stmf_data_buf_t         *ibuf_stmf_buf;
 540         idm_pdu_t               *ibuf_immed_data_pdu;
 541         boolean_t               ibuf_is_immed;
 542 } iscsit_buf_t;
 543 
 544 typedef struct {
 545         scsi_task_t             *it_stmf_task;
 546         idm_task_t              *it_idm_task;
 547         iscsit_buf_t            *it_immed_data;
 548         iscsit_conn_t           *it_ict;
 549         kmutex_t                it_mutex;
 550         idm_pdu_t               *it_tm_pdu;
 551         uint32_t                it_stmf_abort:1,
 552                                 it_aborted:1,
 553                                 it_active:1,
 554                                 it_tm_task:1,
 555                                 it_tm_responded:1;
 556         uint32_t                it_cmdsn;
 557         uint32_t                it_itt;
 558         uint32_t                it_ttt;
 559         avl_node_t              it_sess_ln;
 560 } iscsit_task_t;
 561 
 562 typedef struct iscsit_isns_cfg {
 563         kmutex_t                isns_mutex;
 564         boolean_t               isns_state;
 565         list_t                  isns_svrs;
 566 } iscsit_isns_cfg_t;
 567 
 568 /*
 569  * State values for the iscsit service
 570  */
 571 typedef enum {
 572         ISE_UNDEFINED = 0,
 573         ISE_DETACHED,
 574         ISE_DISABLED,
 575         ISE_ENABLING,
 576         ISE_ENABLED,
 577         ISE_BUSY,
 578         ISE_DISABLING
 579 } iscsit_service_enabled_t;
 580 
 581 
 582 typedef struct {
 583         iscsit_service_enabled_t        global_svc_state;
 584         dev_info_t                      *global_dip;
 585         ldi_ident_t                     global_li;
 586         nvlist_t                        *global_props;
 587         stmf_port_provider_t            *global_pp;
 588         stmf_dbuf_store_t               *global_dbuf_store;
 589         taskq_t                         *global_dispatch_taskq;
 590         idm_refcnt_t                    global_refcnt;
 591         avl_tree_t                      global_discovery_sessions;
 592         avl_tree_t                      global_target_list;
 593         list_t                          global_deleted_target_list;
 594         avl_tree_t                      global_tpg_list;
 595         avl_tree_t                      global_ini_list;
 596         iscsit_tpg_t                    *global_default_tpg;
 597         vmem_t                          *global_tsih_pool;
 598         iscsit_isns_cfg_t               global_isns_cfg;
 599         iscsi_radius_props_t            global_radius_server;
 600         krwlock_t                       global_rwlock;
 601         kmutex_t                        global_state_mutex;
 602 } iscsit_global_t;
 603 
 604 extern iscsit_global_t iscsit_global;
 605 
 606 void
 607 iscsit_global_hold();
 608 
 609 void
 610 iscsit_global_rele();
 611 
 612 void
 613 iscsit_global_wait_ref();
 614 
 615 idm_status_t
 616 iscsit_login_sm_init(iscsit_conn_t *ict);
 617 
 618 void
 619 iscsit_login_sm_fini(iscsit_conn_t *ict);
 620 
 621 void
 622 iscsit_login_sm_event(iscsit_conn_t *ic, iscsit_login_event_t event,
 623     idm_pdu_t *pdu);
 624 
 625 void
 626 iscsit_login_sm_event_locked(iscsit_conn_t *ic, iscsit_login_event_t event,
 627     idm_pdu_t *pdu);
 628 
 629 int
 630 iscsit_is_v4_mapped(struct sockaddr_storage *sa, struct sockaddr_storage *v4sa);
 631 
 632 void
 633 iscsit_send_async_event(iscsit_conn_t *ict, uint8_t async_event);
 634 
 635 void
 636 iscsit_pdu_tx(idm_pdu_t *pdu);
 637 
 638 void
 639 iscsit_send_reject(iscsit_conn_t *ict, idm_pdu_t *rejected_pdu, uint8_t reason);
 640 
 641 void
 642 iscsit_text_cmd_fini(iscsit_conn_t *ict);
 643 
 644 /*
 645  * IDM conn ops
 646  */
 647 
 648 idm_rx_pdu_cb_t         iscsit_op_scsi_cmd;
 649 idm_rx_pdu_cb_t         iscsit_rx_pdu;
 650 idm_rx_pdu_error_cb_t   iscsit_rx_pdu_error;
 651 idm_rx_pdu_cb_t         iscsit_rx_scsi_rsp;
 652 idm_task_cb_t           iscsit_task_aborted;
 653 idm_client_notify_cb_t  iscsit_client_notify;
 654 idm_build_hdr_cb_t      iscsit_build_hdr;
 655 idm_update_statsn_cb_t  iscsit_update_statsn;
 656 idm_keepalive_cb_t      iscsit_keepalive;
 657 
 658 /*
 659  * lport entry points
 660  */
 661 stmf_status_t
 662 iscsit_xfer_scsi_data(scsi_task_t *task, stmf_data_buf_t *dbuf,
 663     uint32_t ioflags);
 664 
 665 stmf_status_t
 666 iscsit_send_scsi_status(scsi_task_t *task, uint32_t ioflags);
 667 
 668 void
 669 iscsit_lport_task_free(scsi_task_t *task);
 670 
 671 stmf_status_t
 672 iscsit_abort(stmf_local_port_t *lport, int abort_cmd, void *arg,
 673     uint32_t flags);
 674 
 675 void
 676 iscsit_ctl(stmf_local_port_t *lport, int cmd, void *arg);
 677 
 678 /*
 679  * Connection functions
 680  */
 681 idm_status_t
 682 iscsit_conn_reinstate(iscsit_conn_t *existing_ict, iscsit_conn_t *ict);
 683 
 684 void
 685 iscsit_conn_destroy_done(iscsit_conn_t *ict);
 686 
 687 void
 688 iscsit_conn_set_auth(iscsit_conn_t *ict);
 689 
 690 void
 691 iscsit_conn_hold(iscsit_conn_t *ict);
 692 
 693 void
 694 iscsit_conn_rele(iscsit_conn_t *ict);
 695 
 696 void
 697 iscsit_conn_logout(iscsit_conn_t *ict);
 698 
 699 /*
 700  * Session functions
 701  */
 702 int
 703 iscsit_sess_avl_compare(const void *void_sess1, const void *void_sess2);
 704 
 705 iscsit_sess_t *
 706 iscsit_sess_create(iscsit_tgt_t *tgt, iscsit_conn_t *ict,
 707     uint32_t cmdsn, uint8_t *isid, uint16_t tag,
 708     char *initiator_name, char *target_name,
 709     uint8_t *error_class, uint8_t *error_detail);
 710 
 711 void
 712 iscsit_sess_destroy(iscsit_sess_t *ist);
 713 
 714 void
 715 iscsit_sess_hold(iscsit_sess_t *ist);
 716 
 717 idm_status_t
 718 iscsit_sess_check_hold(iscsit_sess_t *ist);
 719 
 720 void
 721 iscsit_sess_rele(iscsit_sess_t *ist);
 722 
 723 iscsit_conn_t *
 724 iscsit_sess_lookup_conn(iscsit_sess_t *ist, uint16_t cid);
 725 
 726 void
 727 iscsit_sess_bind_conn(iscsit_sess_t *ist, iscsit_conn_t *ict);
 728 
 729 void
 730 iscsit_sess_unbind_conn(iscsit_sess_t *ist, iscsit_conn_t *ict);
 731 
 732 void
 733 iscsit_sess_close(iscsit_sess_t *ist);
 734 
 735 iscsit_sess_t *
 736 iscsit_sess_reinstate(iscsit_tgt_t *tgt, iscsit_sess_t *ist, iscsit_conn_t *ict,
 737     uint8_t *error_class, uint8_t *error_detail);
 738 
 739 void
 740 iscsit_sess_sm_event(iscsit_sess_t *ist, iscsit_session_event_t event,
 741     iscsit_conn_t *ict);
 742 
 743 /*
 744  * Target, TPGT, TPGT and portal functions
 745  */
 746 
 747 void
 748 iscsit_tgt_sm_event(iscsit_tgt_t *tgt, iscsit_tgt_event_t event);
 749 
 750 void
 751 tgt_sm_event_locked(iscsit_tgt_t *tgt, iscsit_tgt_event_t event);
 752 
 753 it_cfg_status_t
 754 iscsit_config_merge_tgt(it_config_t *cfg);
 755 
 756 void
 757 iscsit_config_destroy_tgts(list_t *tgt_del_list);
 758 
 759 void
 760 iscsit_config_destroy_tpgts(list_t *tpgt_del_list);
 761 
 762 iscsit_tgt_t *
 763 iscsit_tgt_lookup(char *target_name);
 764 
 765 iscsit_tgt_t *
 766 iscsit_tgt_lookup_locked(char *target_name);
 767 
 768 int
 769 iscsit_tgt_avl_compare(const void *void_tgt1, const void *void_tgt2);
 770 
 771 int
 772 iscsit_tpgt_avl_compare(const void *void_tpgt1, const void *void_tpgt2);
 773 
 774 void
 775 iscsit_tgt_hold(iscsit_tgt_t *tgt);
 776 
 777 void
 778 iscsit_tgt_rele(iscsit_tgt_t *tgt);
 779 
 780 iscsit_tpgt_t *
 781 iscsit_tgt_lookup_tpgt(iscsit_tgt_t *tgt, uint16_t tag);
 782 
 783 void
 784 iscsit_tpgt_hold(iscsit_tpgt_t *tpgt);
 785 
 786 void
 787 iscsit_tpgt_rele(iscsit_tpgt_t *tpgt);
 788 
 789 iscsit_portal_t *
 790 iscsit_tgt_lookup_portal(iscsit_tgt_t *tgt, struct sockaddr_storage *sa,
 791     iscsit_tpgt_t **output_tpgt);
 792 
 793 iscsit_sess_t *
 794 iscsit_tgt_lookup_sess(iscsit_tgt_t *tgt, char *initiator_name,
 795     uint8_t *isid, uint16_t tsih, uint16_t tag);
 796 
 797 void
 798 iscsit_tgt_bind_sess(iscsit_tgt_t *tgt, iscsit_sess_t *sess);
 799 
 800 void
 801 iscsit_tgt_unbind_sess(iscsit_tgt_t *tgt, iscsit_sess_t *sess);
 802 
 803 it_cfg_status_t
 804 iscsit_config_merge_tpg(it_config_t *cfg, list_t *tpg_del_list);
 805 
 806 void
 807 iscsit_config_destroy_tpgs(list_t *tpg_del_list);
 808 
 809 iscsit_tpg_t *
 810 iscsit_tpg_lookup(char *tpg_name);
 811 
 812 int
 813 iscsit_tpg_avl_compare(const void *void_tpg1, const void *void_tpg2);
 814 
 815 void
 816 iscsit_tpg_hold(iscsit_tpg_t *tpg);
 817 
 818 void
 819 iscsit_tpg_rele(iscsit_tpg_t *tpg);
 820 
 821 iscsit_tpg_t *
 822 iscsit_tpg_createdefault();
 823 
 824 void
 825 iscsit_tpg_destroydefault(iscsit_tpg_t *tpg);
 826 
 827 idm_status_t
 828 iscsit_tpg_online(iscsit_tpg_t *tpg);
 829 
 830 void
 831 iscsit_tpg_offline(iscsit_tpg_t *tpg);
 832 
 833 iscsit_portal_t *
 834 iscsit_tpg_portal_lookup(iscsit_tpg_t *tpg, struct sockaddr_storage *sa);
 835 
 836 void
 837 iscsit_portal_hold(iscsit_portal_t *portal);
 838 
 839 void
 840 iscsit_portal_rele(iscsit_portal_t *portal);
 841 
 842 it_cfg_status_t
 843 iscsit_config_merge_ini(it_config_t *cfg);
 844 
 845 int
 846 iscsit_ini_avl_compare(const void *void_ini1, const void *void_ini2);
 847 
 848 iscsit_ini_t *
 849 iscsit_ini_lookup_locked(char *ini_name);
 850 
 851 int
 852 iscsit_portal_avl_compare(const void *void_portal1, const void *void_portal2);
 853 
 854 int
 855 iscsit_verify_chap_resp(iscsit_conn_login_t *lsm,
 856     unsigned int chap_i, uchar_t *chap_c, unsigned int challenge_len,
 857     uchar_t *chap_r, unsigned int resp_len);
 858 
 859 void
 860 iscsit_rxpdu_queue_monitor_start(void);
 861 
 862 void
 863 iscsit_rxpdu_queue_monitor_stop(void);
 864 
 865 #endif /* _ISCSIT_H_ */