#ifndef ISCSI_TARGET_CORE_H
#define ISCSI_TARGET_CORE_H
#include <linux/in.h>
#include <linux/configfs.h>
#include <net/sock.h>
#include <net/tcp.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/iscsi_proto.h>
#include <target/target_core_base.h>
#define ISCSIT_VERSION "v4.1.0"
#define ISCSI_MAX_DATASN_MISSING_COUNT 16
#define ISCSI_TX_THREAD_TCP_TIMEOUT 2
#define ISCSI_RX_THREAD_TCP_TIMEOUT 2
#define SECONDS_FOR_ASYNC_LOGOUT 10
#define SECONDS_FOR_ASYNC_TEXT 10
#define SECONDS_FOR_LOGOUT_COMP 15
#define WHITE_SPACE " \t\v\f\n\r"
#define ISCSIT_MIN_TAGS 16
#define ISCSIT_EXTRA_TAGS 8
#define ISCSIT_TCP_BACKLOG 256
/* struct iscsi_node_attrib sanity values */
#define NA_DATAOUT_TIMEOUT 3
#define NA_DATAOUT_TIMEOUT_MAX 60
#define NA_DATAOUT_TIMEOUT_MIX 2
#define NA_DATAOUT_TIMEOUT_RETRIES 5
#define NA_DATAOUT_TIMEOUT_RETRIES_MAX 15
#define NA_DATAOUT_TIMEOUT_RETRIES_MIN 1
#define NA_NOPIN_TIMEOUT 15
#define NA_NOPIN_TIMEOUT_MAX 60
#define NA_NOPIN_TIMEOUT_MIN 3
#define NA_NOPIN_RESPONSE_TIMEOUT 30
#define NA_NOPIN_RESPONSE_TIMEOUT_MAX 60
#define NA_NOPIN_RESPONSE_TIMEOUT_MIN 3
#define NA_RANDOM_DATAIN_PDU_OFFSETS 0
#define NA_RANDOM_DATAIN_SEQ_OFFSETS 0
#define NA_RANDOM_R2T_OFFSETS 0
/* struct iscsi_tpg_attrib sanity values */
#define TA_AUTHENTICATION 1
#define TA_LOGIN_TIMEOUT 15
#define TA_LOGIN_TIMEOUT_MAX 30
#define TA_LOGIN_TIMEOUT_MIN 5
#define TA_NETIF_TIMEOUT 2
#define TA_NETIF_TIMEOUT_MAX 15
#define TA_NETIF_TIMEOUT_MIN 2
#define TA_GENERATE_NODE_ACLS 0
#define TA_DEFAULT_CMDSN_DEPTH 64
#define TA_DEFAULT_CMDSN_DEPTH_MAX 512
#define TA_DEFAULT_CMDSN_DEPTH_MIN 1
#define TA_CACHE_DYNAMIC_ACLS 0
/* Enabled by default in demo mode (generic_node_acls=1) */
#define TA_DEMO_MODE_WRITE_PROTECT 1
/* Disabled by default in production mode w/ explict ACLs */
#define TA_PROD_MODE_WRITE_PROTECT 0
#define TA_DEMO_MODE_DISCOVERY 1
#define TA_DEFAULT_ERL 0
#define TA_CACHE_CORE_NPS 0
#define ISCSI_IOV_DATA_BUFFER 5
enum iscsit_transport_type {
ISCSI_TCP = 0,
ISCSI_SCTP_TCP = 1,
ISCSI_SCTP_UDP = 2,
ISCSI_IWARP_TCP = 3,
ISCSI_IWARP_SCTP = 4,
ISCSI_INFINIBAND = 5,
};
/* RFC-3720 7.1.4 Standard Connection State Diagram for a Target */
enum target_conn_state_table {
TARG_CONN_STATE_FREE = 0x1,
TARG_CONN_STATE_XPT_UP = 0x3,
TARG_CONN_STATE_IN_LOGIN = 0x4,
TARG_CONN_STATE_LOGGED_IN = 0x5,
TARG_CONN_STATE_IN_LOGOUT = 0x6,
TARG_CONN_STATE_LOGOUT_REQUESTED = 0x7,
TARG_CONN_STATE_CLEANUP_WAIT = 0x8,
};
/* RFC-3720 7.3.2 Session State Diagram for a Target */
enum target_sess_state_table {
TARG_SESS_STATE_FREE = 0x1,
TARG_SESS_STATE_ACTIVE = 0x2,
TARG_SESS_STATE_LOGGED_IN = 0x3,
TARG_SESS_STATE_FAILED = 0x4,
TARG_SESS_STATE_IN_CONTINUE = 0x5,
};
/* struct iscsi_data_count->type */
enum data_count_type {
ISCSI_RX_DATA = 1,
ISCSI_TX_DATA = 2,
};
/* struct iscsi_datain_req->dr_complete */
enum datain_req_comp_table {
DATAIN_COMPLETE_NORMAL = 1,
DATAIN_COMPLETE_WITHIN_COMMAND_RECOVERY = 2,
DATAIN_COMPLETE_CONNECTION_RECOVERY = 3,
};
/* struct iscsi_datain_req->recovery */
enum datain_req_rec_table {
DATAIN_WITHIN_COMMAND_RECOVERY = 1,
DATAIN_CONNECTION_RECOVERY = 2,
};
/* struct iscsi_portal_group->state */
enum tpg_state_table {
TPG_STATE_FREE = 0,
TPG_STATE_ACTIVE = 1,
TPG_STATE_INACTIVE = 2,
TPG_STATE_COLD_RESET = 3,
};
/* struct iscsi_tiqn->tiqn_state */
enum tiqn_state_table {
TIQN_STATE_ACTIVE = 1,
TIQN_STATE_SHUTDOWN = 2,
};
/* struct iscsi_cmd->cmd_flags */
enum cmd_flags_table {
ICF_GOT_LAST_DATAOUT = 0x00000001,
ICF_GOT_DATACK_SNACK = 0x00000002,
ICF_NON_IMMEDIATE_UNSOLICITED_DATA = 0x00000004,
ICF_SENT_LAST_R2T = 0x00000008,
ICF_WITHIN_COMMAND_RECOVERY = 0x00000010,
ICF_CONTIG_MEMORY = 0x00000020,
ICF_ATTACHED_TO_RQUEUE = 0x00000040,
ICF_OOO_CMDSN = 0x00000080,
IFC_SENDTARGETS_ALL = 0x00000100,
IFC_SENDTARGETS_SINGLE = 0x00000200,
};
/* struct iscsi_cmd->i_state */
enum cmd_i_state_table {
ISTATE_NO_STATE = 0,
ISTATE_NEW_CMD = 1,
ISTATE_DEFERRED_CMD = 2,
ISTATE_UNSOLICITED_DATA = 3,
ISTATE_RECEIVE_DATAOUT = 4,
ISTATE_RECEIVE_DATAOUT_RECOVERY = 5,
ISTATE_RECEIVED_LAST_DATAOUT = 6,
ISTATE_WITHIN_DATAOUT_RECOVERY = 7,
ISTATE_IN_CONNECTION_RECOVERY = 8,
ISTATE_RECEIVED_TASKMGT = 9,
ISTATE_SEND_ASYNCMSG = 10,
ISTATE_SENT_ASYNCMSG = 11,
ISTATE_SEND_DATAIN = 12,
ISTATE_SEND_LAST_DATAIN = 13,
ISTATE_SENT_LAST_DATAIN = 14,
ISTATE_SEND_LOGOUTRSP = 15,
ISTATE_SENT_LOGOUTRSP = 16,
ISTATE_SEND_NOPIN = 17,
ISTATE_SENT_NOPIN = 18,
ISTATE_SEND_REJECT = 19,
ISTATE_SENT_REJECT = 20,
ISTATE_SEND_R2T = 21,
ISTATE_SENT_R2T = 22,
ISTATE_SEND_R2T_RECOVERY = 23,
ISTATE_SENT_R2T_RECOVERY = 24,
ISTATE_SEND_LAST_R2T = 25,
ISTATE_SENT_LAST_R2T = 26,
ISTATE_SEND_LAST_R2T_RECOVERY = 27,
ISTATE_SENT_LAST_R2T_RECOVERY = 28,
ISTATE_SEND_STATUS = 29,
ISTATE_SEND_STATUS_BROKEN_PC = 30,
ISTATE_SENT_STATUS = 31,
ISTATE_SEND_STATUS_RECOVERY = 32,
ISTATE_SENT_STATUS_RECOVERY = 33,
ISTATE_SEND_TASKMGTRSP = 34,
ISTATE_SENT_TASKMGTRSP = 35,
ISTATE_SEND_TEXTRSP = 36,
ISTATE_SENT_TEXTRSP = 37,
ISTATE_SEND_NOPIN_WANT_RESPONSE = 38,
ISTATE_SENT_NOPIN_WANT_RESPONSE = 39,
ISTATE_SEND_NOPIN_NO_RESPONSE = 40,
ISTATE_REMOVE = 41,
ISTATE_FREE = 42,
};
/* Used for iscsi_recover_cmdsn() return values */
enum recover_cmdsn_ret_table {
CMDSN_ERROR_CANNOT_RECOVER = -1,
CMDSN_NORMAL_OPERATION = 0,
CMDSN_LOWER_THAN_EXP = 1,
CMDSN_HIGHER_THAN_EXP = 2,
CMDSN_MAXCMDSN_OVERRUN = 3,
};
/* Used for iscsi_handle_immediate_data() return values */
enum immedate_data_ret_table {
IMMEDIATE_DATA_CANNOT_RECOVER = -1,
IMMEDIATE_DATA_NORMAL_OPERATION = 0,
IMMEDIATE_DATA_ERL1_CRC_FAILURE = 1,
};
/* Used for iscsi_decide_dataout_action() return values */
enum dataout_action_ret_table {
DATAOUT_CANNOT_RECOVER = -1,
DATAOUT_NORMAL = 0,
DATAOUT_SEND_R2T = 1,
DATAOUT_SEND_TO_TRANSPORT = 2,
DATAOUT_WITHIN_COMMAND_RECOVERY = 3,
};
/* Used for struct iscsi_node_auth->naf_flags */
enum naf_flags_table {
NAF_USERID_SET = 0x01,
NAF_PASSWORD_SET = 0x02,
NAF_USERID_IN_SET = 0x04,
NAF_PASSWORD_IN_SET = 0x08,
};
/* Used by various struct timer_list to manage iSCSI specific state */
enum iscsi_timer_flags_table {
ISCSI_TF_RUNNING = 0x01,
ISCSI_TF_STOP = 0x02,
ISCSI_TF_EXPIRED = 0x04,
};
/* Used for struct iscsi_np->np_flags */
enum np_flags_table {
NPF_IP_NETWORK = 0x00,
};
/* Used for struct iscsi_np->np_thread_state */
enum np_thread_state_table {
ISCSI_NP_THREAD_ACTIVE = 1,
ISCSI_NP_THREAD_INACTIVE = 2,
ISCSI_NP_THREAD_RESET = 3,
ISCSI_NP_THREAD_SHUTDOWN = 4,
ISCSI_NP_THREAD_EXIT = 5,
};
struct iscsi_conn_ops {
u8 HeaderDigest; /* [0,1] == [None,CRC32C] */
u8 DataDigest; /* [0,1] == [None,CRC32C] */
u32 MaxRecvDataSegmentLength; /* [512..2**24-1] */
u32 MaxXmitDataSegmentLength; /* [512..2**24-1] */
u8 OFMarker; /* [0,1] == [No,Yes] */
u8 IFMarker; /* [0,1] == [No,Yes] */
u32 OFMarkInt; /* [1..65535] */
u32 IFMarkInt; /* [1..65535] */
/*
* iSER specific connection parameters
*/
u32 InitiatorRecvDataSegmentLength; /* [512..2**24-1] */
u32 TargetRecvDataSegmentLength; /* [512..2**24-1] */
};
struct iscsi_sess_ops {
char InitiatorName[224];
char InitiatorAlias[256];
char TargetName[224];
char TargetAlias[256];
char TargetAddress[256];
u16 TargetPortalGroupTag; /* [0..65535] */
u16 MaxConnections; /* [1..65535] */
u8 InitialR2T; /* [0,1] == [No,Yes] */
u8 ImmediateData; /* [0,1] == [No,Yes] */
u32 MaxBurstLength; /* [512..2**24-1] */
u32 FirstBurstLength; /* [512..2**24-1] */
u16 DefaultTime2Wait; /* [0..3600] */
u16 DefaultTime2Retain; /* [0..3600] */
u16 MaxOutstandingR2T; /* [1..65535] */
u8 DataPDUInOrder; /* [0,1] == [No,Yes] */
u8 DataSequenceInOrder; /* [0,1] == [No,Yes] */
u8 ErrorRecoveryLevel; /* [0..2] */
u8 SessionType; /* [0,1] == [Normal,Discovery]*/
/*
* iSER specific session parameters