xref: /illumos-gate/usr/src/uts/common/io/comstar/port/iscsit/iscsit.h (revision 61dfa509)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
 * Copyright (c) 2017, Joyent, Inc.  All rights reserved.
 */

#ifndef _ISCSIT_H_
#define	_ISCSIT_H_

#include <sys/iscsit/iscsi_if.h>
#include <sys/iscsit/iscsit_common.h>

#include "iscsit_authclient.h"

/*
 * For some reason iscsi_protocol.h lists the max version as "0x02" and the
 * min version as "0x00".  RFC3720 clearly states that the current version
 * number is 0x00 so that is what we will use.
 */
#define	ISCSIT_MIN_VERSION			0x00
#define	ISCSIT_MAX_VERSION			0x00
#define	ISCSIT_MAX_CONNECTIONS			32 /* MC/S support  */
#define	ISCSIT_MAX_RECV_DATA_SEGMENT_LENGTH	(32*1024)
#define	ISCSIT_MAX_BURST_LENGTH			(1024*1024)
#define	ISCSIT_MAX_FIRST_BURST_LENGTH		ISCSI_DEFAULT_FIRST_BURST_LENGTH
#define	ISCSIT_MAX_TIME2WAIT			ISCSI_MAX_TIME2WAIT
#define	ISCSIT_MAX_TIME2RETAIN			ISCSI_DEFAULT_TIME_TO_RETAIN
#define	ISCSIT_MAX_OUTSTANDING_R2T		ISCSI_DEFAULT_MAX_OUT_R2T
#define	ISCSIT_MAX_ERROR_RECOVERY_LEVEL		0
#define	ISCSIT_MAX_OUTSTANDING_UNEXPECTED_PDUS	0

#define	ISCSIT_DEFAULT_TPG	"iscsit-default-tpg"
#define	ISCSIT_DEFAULT_TPGT	1

#define	ISCSI_MAX_TSIH		0xffff
#define	ISCSI_UNSPEC_TSIH	0

#define	ISCSIT_MAX_WINDOW	1024
#define	ISCSIT_RXPDU_QUEUE_LEN	2048

/*
 * MC/S: A timeout is maintained to recover from lost CmdSN (holes in the
 * CmdSN ordering). When the timeout is reached, the ExpCmdSN is advanced
 * past the hole to continue processing the queued commands. This value is
 * system-tunable (volatile rxpdu_queue_threshold) and should be in the
 * range from 5 to 30 seconds.
 */
#define	ISCSIT_RXPDU_QUEUE_THRESHOLD		5	/* 5 seconds */
#define	ISCSIT_RXPDU_QUEUE_MONITOR_INTERVAL	5	/* 5 seconds */

/* Time in seconds to wait between calls to stmf_deregister_local_port */
#define	TGT_DEREG_RETRY_SECONDS	1

#define	ISCSIT_GLOBAL_LOCK(rw) rw_enter(&iscsit_global.global_rwlock, (rw))
#define	ISCSIT_GLOBAL_UNLOCK() rw_exit(&iscsit_global.global_rwlock)

/* Circular buffer to hold the out-of-order PDUs in MC/S */
typedef struct {
	idm_pdu_t	*cb_buffer[ISCSIT_RXPDU_QUEUE_LEN];
	int		cb_num_elems;
} iscsit_cbuf_t;

/*
 * Used for serial number arithmetic (RFC 1982)
 */
#define	ISCSIT_SNA32_CHECK	0x80000000

typedef struct {
	char		tpg_name[MAX_TPG_NAMELEN];
	kmutex_t	tpg_mutex;
	idm_refcnt_t	tpg_refcnt;
	int		tpg_online;
	avl_tree_t	tpg_portal_list;
	avl_node_t	tpg_global_ln;
	list_node_t	tpg_delete_ln;
} iscsit_tpg_t;

#define	IS_DEFAULT_TPGT(TPGT) \
	(((TPGT) != NULL) && \
	    ((TPGT)->tpgt_tpg == iscsit_global.global_default_tpg))

typedef struct {
	iscsit_tpg_t	*tpgt_tpg;
	idm_refcnt_t	tpgt_refcnt;
	avl_node_t	tpgt_tgt_ln;
	list_node_t	tpgt_delete_ln;
	uint16_t	tpgt_tag;
	boolean_t	tpgt_needs_tpg_offline;
} iscsit_tpgt_t;

typedef struct {
	struct sockaddr_storage portal_addr;
	int			portal_online;
	idm_refcnt_t		portal_refcnt;
	avl_node_t		portal_tpg_ln;
	iscsit_tpg_t		*portal_tpg;
	idm_svc_t		*portal_svc;
	boolean_t		portal_default;
	void			*portal_isns;
} iscsit_portal_t;


#define	TGT_STATE_LIST() \
	item(TS_UNDEFINED) \
	item(TS_CREATED) \
	item(TS_ONLINING) \
	item(TS_ONLINE) \
	item(TS_STMF_ONLINE) \
	item(TS_DELETING_NEED_OFFLINE) \
	item(TS_OFFLINING) \
	item(TS_OFFLINE) \
	item(TS_STMF_OFFLINE) \
	item(TS_DELETING_STMF_DEREG) \
	item(TS_DELETING_STMF_DEREG_FAIL) \
	item(TS_DELETING) \
	item(TS_MAX_STATE)

/* Target states and events, update iscsit_ts_name table whenever modified */
typedef enum {
#define	item(a)	a,
	TGT_STATE_LIST()
#undef	item
} iscsit_tgt_state_t;

#ifdef ISCSIT_TGT_SM_STRINGS
static const char *iscsit_ts_name[TS_MAX_STATE + 1] = {
#define	item(a) #a,
	TGT_STATE_LIST()
#undef	item
};
#endif

#define	TGT_EVENT_LIST() \
	item(TE_UNDEFINED) \
	item(TE_STMF_ONLINE_REQ) \
	item(TE_ONLINE_SUCCESS) \
	item(TE_ONLINE_FAIL) \
	item(TE_STMF_ONLINE_COMPLETE_ACK) \
	item(TE_STMF_OFFLINE_REQ) \
	item(TE_OFFLINE_COMPLETE) \
	item(TE_STMF_OFFLINE_COMPLETE_ACK) \
	item(TE_DELETE) \
	item(TE_STMF_DEREG_SUCCESS) \
	item(TE_STMF_DEREG_FAIL) \
	item(TE_STMF_DEREG_RETRY) \
	item(TE_WAIT_REF_COMPLETE) \
	item(TE_MAX_EVENT)

typedef enum {
#define	item(a) a,
	TGT_EVENT_LIST()
#undef	item
} iscsit_tgt_event_t;

#ifdef ISCSIT_TGT_SM_STRINGS
static const char *iscsit_te_name[TE_MAX_EVENT + 1] = {
#define	item(a) #a,
	TGT_EVENT_LIST()
#undef	item
};
#endif

typedef struct {
	char			*target_name;
	nvlist_t		*target_props;
	kmutex_t		target_mutex;
	idm_refcnt_t		target_refcnt;
	idm_refcnt_t		target_sess_refcnt;
	avl_tree_t		target_tpgt_list;
	avl_tree_t		target_sess_list;
	avl_node_t		target_global_ln;
	avl_node_t		target_global_deleted_ln;
	/* STMF lport == iSCSI target */
	scsi_devid_desc_t	*target_devid;
	stmf_local_port_t	*target_stmf_lport;
	uint8_t			target_stmf_lport_registered;

	/* Target state */
	boolean_t		target_sm_busy;
	boolean_t		target_deleting;
	iscsit_tgt_state_t	target_state;
	iscsit_tgt_state_t	target_last_state;
	sm_audit_buf_t		target_state_audit;
	list_t			target_events;
	uint64_t		target_generation;
} iscsit_tgt_t;

typedef struct {
	char			ini_name[MAX_ISCSI_NODENAMELEN];
	nvlist_t		*ini_props;
	avl_node_t		ini_global_ln;
} iscsit_ini_t;

/*
 * iSCSI Auth Information
 */
typedef struct conn_auth {
	char			ca_tgt_chapuser[iscsitAuthStringMaxLength];
	uint8_t			ca_tgt_chapsecret[iscsitAuthStringMaxLength];
	int			ca_tgt_chapsecretlen;

	char			ca_ini_chapuser[iscsitAuthStringMaxLength];
	uint8_t			ca_ini_chapsecret[iscsitAuthStringMaxLength];
	int			ca_ini_chapsecretlen;

	/* RADIUS authentication information	*/
	boolean_t		ca_use_radius;
	struct sockaddr_storage	ca_radius_server;
	uint8_t			ca_radius_secret[iscsitAuthStringMaxLength];
	int			ca_radius_secretlen;

	/* authentication method list */
	iscsit_auth_method_t	ca_method_valid_list[iscsitAuthMethodMaxCount];

	/* Target alias */
	char			ca_tgt_alias[MAX_ISCSI_NODENAMELEN];
} conn_auth_t;

/*
 * We have three state machines (so far) between the IDM connection state
 * machine, the session state machine, and the login state machine.  All
 * of these states have some concept of "full feature mode".  It's going
 * to be obnoxious if we use a mixture of these "ffp" representations
 * since it will be difficult to ensure the three state machines
 * transition at exactly the same time.  We should drive decisions that
 * depend on FFP from the IDM state machine which is actually snooping
 * the iSCSI PDU's and will always transition at the correct time.
 *
 * A consequence of this approach is that there is a window just after
 * login completes where we may get a SCSI request but the session
 * or login state machine has not quite transitioned to "FFP".  Whether
 * this is a problem depends on how we use those state machines.  This
 * is what we should use them for:
 *
 * IDM Connection state machine - Decisions related to command processing
 * including whether a connection is in FFP
 *
 * Session state machine - Summarize the state of all available connections
 * for the purposes of ERL1, ERL2 and MC/S.  A session in LOGGED_IN state
 * should always have at least one FFP connection but there may be a brief
 * window where a session in ACTIVE might have one or more FFP connections
 * even though ACTIVE is not strictly an FFP state according to the RFC.
 *
 * Login state machine -- drive the login process, collect negotiated
 * parameters.  Another side effect of this approach is that we may get
 * the "notify ffp" callback from the IDM connection state machine before
 * the login state machine has actually transitioned to FFP state.
 */

struct iscsit_conn_s;

/* Add new session states above SS_MAX_STATE */
#define	SESSION_STATE_LIST() \
	item(SS_UNDEFINED) \
	item(SS_Q1_FREE) \
	item(SS_Q2_ACTIVE) \
	item(SS_Q3_LOGGED_IN) \
	item(SS_Q4_FAILED) \
	item(SS_Q5_CONTINUE) \
	item(SS_Q6_DONE) \
	item(SS_Q7_ERROR) \
	item(SS_MAX_STATE)

/* Update iscsit_ss_name table whenever session states are modified */
typedef enum {
#define	item(a) a,
	SESSION_STATE_LIST()
#undef	item
} iscsit_session_state_t;

#ifdef ISCSIT_SESS_SM_STRINGS
/* An array of state text values, for use in logging state transitions */
static const char *iscsit_ss_name[SS_MAX_STATE + 1] = {
#define	item(a) #a,
	SESSION_STATE_LIST()
#undef	item
};
#endif

/* Add new events above SE_MAX_EVENT */
#define	SESSION_EVENT_LIST() \
	item(SE_UNDEFINED) \
	item(SE_CONN_IN_LOGIN)	/* From login state machine */ \
	item(SE_CONN_LOGGED_IN)	/* FFP enabled client notification */ \
	item(SE_CONN_FFP_FAIL)	/* FFP disabled client notification */ \
	item(SE_CONN_FFP_DISABLE) /* FFP disabled client notification */ \
	item(SE_CONN_FAIL) /* Conn destroy client notification */ \
	item(SE_SESSION_CLOSE)	/* FFP disabled client notification */ \
	item(SE_SESSION_REINSTATE) /* From login state machine */ \
	item(SE_SESSION_TIMEOUT) /* Internal */ \
	item(SE_SESSION_CONTINUE) /* From login state machine */ \
	item(SE_SESSION_CONTINUE_FAIL) /* From login state machine? */ \
	item(SE_MAX_EVENT)

/* Update iscsit_se_name table whenever session events are modified */
typedef enum {
#define	item(a) a,
	SESSION_EVENT_LIST()
#undef	item
} iscsit_session_event_t;

#ifdef ISCSIT_SESS_SM_STRINGS
/* An array of event text values, for use in logging events */
static const char *iscsit_se_name[SE_MAX_EVENT + 1] = {
#define	item(a) #a,
	SESSION_EVENT_LIST()
#undef	item
};
#endif

/*
 * Set in ist_tgt after iscsit_tgt_unbind_sess to differentiate an unbound
 * session from a discovery session.
 */
#define	SESS_UNBOUND_FROM_TGT	-1

typedef struct {
	stmf_scsi_session_t	*ist_stmf_sess;
	stmf_local_port_t	*ist_lport;
	iscsit_tgt_t		*ist_tgt;
	idm_refcnt_t		ist_refcnt;
	kmem_cache_t		*ist_task_cache;
	kmutex_t		ist_sn_mutex;
	kmutex_t		ist_mutex;
	kcondvar_t		ist_cv;
	iscsit_session_state_t	ist_state;
	iscsit_session_state_t	ist_last_state;
	sm_audit_buf_t		ist_state_audit;
	boolean_t		ist_sm_busy;
	boolean_t		ist_sm_complete;
	boolean_t		ist_admin_close;
	list_t			ist_events;
	int			ist_conn_count;
	int			ist_ffp_conn_count;
	struct iscsit_conn_s	*ist_failed_conn;
	timeout_id_t		ist_state_timeout;
	list_t			ist_conn_list;
	avl_node_t		ist_tgt_ln;
	char			*ist_initiator_name;
	char			*ist_initiator_alias;
	char			*ist_target_name;
	char			*ist_target_alias;
	uint8_t			ist_isid[ISCSI_ISID_LEN];
	uint16_t		ist_tsih;
	uint16_t		ist_tpgt_tag;
	uint32_t		ist_expcmdsn;
	uint32_t		ist_maxcmdsn;
	avl_tree_t		ist_task_list;
	iscsit_cbuf_t		*ist_rxpdu_queue;
} iscsit_sess_t;

/* Add new login states above ILS_MAX_STATE */
#define	LOGIN_STATE_LIST() \
	item(ILS_UNDEFINED) \
	item(ILS_LOGIN_INIT) \
	item(ILS_LOGIN_WAITING)	/* Waiting for more login PDU's */ \
	item(ILS_LOGIN_PROCESSING) /* Processing login request */ \
	item(ILS_LOGIN_RESPONDING) /* Sending login response */ \
	item(ILS_LOGIN_RESPONDED) /* Sent login response (no trans. to FFP) */ \
	item(ILS_LOGIN_FFP) /* Sending last login PDU for final response */ \
	item(ILS_LOGIN_DONE) /* Last login PDU sent (so we can free it) */ \
	item(ILS_LOGIN_ERROR) /* Login error, login failed */ \
	item(ILS_MAX_STATE)

/* Update iscsit_ils_name table whenever login states are modified */
typedef enum {
#define	item(a) a,
	LOGIN_STATE_LIST()
#undef	item
} iscsit_login_state_t;

#ifdef ISCSIT_LOGIN_SM_STRINGS
/* An array of login state text values, for use in logging login progess */
static const char *iscsit_ils_name[ILS_MAX_STATE + 1] = {
#define	item(a) #a,
	LOGIN_STATE_LIST()
#undef	item
};
#endif

/* Add new login events above ILE_MAX_EVENT */
#define	LOGIN_EVENT_LIST() \
	item(ILE_UNDEFINED) \
	item(ILE_LOGIN_RCV) \
	item(ILE_LOGIN_RESP_READY) \
	item(ILE_LOGIN_FFP) \
	item(ILE_LOGIN_RESP_COMPLETE) \
	item(ILE_LOGIN_ERROR) \
	item(ILE_LOGIN_CONN_ERROR) \
	item(ILE_MAX_EVENT)

/* Update iscsit_ile_name table whenever login events are modified */
typedef enum {
#define	item(a) a,
	LOGIN_EVENT_LIST()
#undef	item
} iscsit_login_event_t;

#ifdef ISCSIT_LOGIN_SM_STRINGS
/* An array of login event text values, for use in loggin login events */
static const char *iscsit_ile_name[ILE_MAX_EVENT + 1] = {
#define	item(a) #a,