kernel/comstar/port/iscsit/iscsit.h

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