include/target/iscsi/iscsi_target_core.h

   1 #ifndef ISCSI_TARGET_CORE_H
   2 #define ISCSI_TARGET_CORE_H
   3
   4 #include <linux/in.h>
   5 #include <linux/configfs.h>
   6 #include <net/sock.h>
   7 #include <net/tcp.h>
   8 #include <scsi/iscsi_proto.h>
   9 #include <target/target_core_base.h>
  10
  11 #define ISCSIT_VERSION                  "v4.1.0"
  12 #define ISCSI_MAX_DATASN_MISSING_COUNT  16
  13 #define ISCSI_TX_THREAD_TCP_TIMEOUT     2
  14 #define ISCSI_RX_THREAD_TCP_TIMEOUT     2
  15 #define SECONDS_FOR_ASYNC_LOGOUT        10
  16 #define SECONDS_FOR_ASYNC_TEXT          10
  17 #define SECONDS_FOR_LOGOUT_COMP         15
  18 #define WHITE_SPACE                     " \t\v\f\n\r"
  19 #define ISCSIT_MIN_TAGS                 16
  20 #define ISCSIT_EXTRA_TAGS               8
  21 #define ISCSIT_TCP_BACKLOG              256
  22 #define ISCSI_RX_THREAD_NAME            "iscsi_trx"
  23 #define ISCSI_TX_THREAD_NAME            "iscsi_ttx"
  24
  25 /* struct iscsi_node_attrib sanity values */
  26 #define NA_DATAOUT_TIMEOUT              3
  27 #define NA_DATAOUT_TIMEOUT_MAX          60
  28 #define NA_DATAOUT_TIMEOUT_MIX          2
  29 #define NA_DATAOUT_TIMEOUT_RETRIES      5
  30 #define NA_DATAOUT_TIMEOUT_RETRIES_MAX  15
  31 #define NA_DATAOUT_TIMEOUT_RETRIES_MIN  1
  32 #define NA_NOPIN_TIMEOUT                15
  33 #define NA_NOPIN_TIMEOUT_MAX            60
  34 #define NA_NOPIN_TIMEOUT_MIN            3
  35 #define NA_NOPIN_RESPONSE_TIMEOUT       30
  36 #define NA_NOPIN_RESPONSE_TIMEOUT_MAX   60
  37 #define NA_NOPIN_RESPONSE_TIMEOUT_MIN   3
  38 #define NA_RANDOM_DATAIN_PDU_OFFSETS    0
  39 #define NA_RANDOM_DATAIN_SEQ_OFFSETS    0
  40 #define NA_RANDOM_R2T_OFFSETS           0
  41
  42 /* struct iscsi_tpg_attrib sanity values */
  43 #define TA_AUTHENTICATION               1
  44 #define TA_LOGIN_TIMEOUT                15
  45 #define TA_LOGIN_TIMEOUT_MAX            30
  46 #define TA_LOGIN_TIMEOUT_MIN            5
  47 #define TA_NETIF_TIMEOUT                2
  48 #define TA_NETIF_TIMEOUT_MAX            15
  49 #define TA_NETIF_TIMEOUT_MIN            2
  50 #define TA_GENERATE_NODE_ACLS           0
  51 #define TA_DEFAULT_CMDSN_DEPTH          64
  52 #define TA_DEFAULT_CMDSN_DEPTH_MAX      512
  53 #define TA_DEFAULT_CMDSN_DEPTH_MIN      1
  54 #define TA_CACHE_DYNAMIC_ACLS           0
  55 /* Enabled by default in demo mode (generic_node_acls=1) */
  56 #define TA_DEMO_MODE_WRITE_PROTECT      1
  57 /* Disabled by default in production mode w/ explict ACLs */
  58 #define TA_PROD_MODE_WRITE_PROTECT      0
  59 #define TA_DEMO_MODE_DISCOVERY          1
  60 #define TA_DEFAULT_ERL                  0
  61 #define TA_CACHE_CORE_NPS               0
  62 /* T10 protection information disabled by default */
  63 #define TA_DEFAULT_T10_PI               0
  64 #define TA_DEFAULT_FABRIC_PROT_TYPE     0
  65 /* TPG status needs to be enabled to return sendtargets discovery endpoint info */
  66 #define TA_DEFAULT_TPG_ENABLED_SENDTARGETS 1
  67 /*
  68  * Used to control the sending of keys with optional to respond state bit,
  69  * as a workaround for non RFC compliant initiators,that do not propose,
  70  * nor respond to specific keys required for login to complete.
  71  *
  72  * See iscsi_check_proposer_for_optional_reply() for more details.
  73  */
  74 #define TA_DEFAULT_LOGIN_KEYS_WORKAROUND 1
  75
  76 #define ISCSI_IOV_DATA_BUFFER           5
  77
  78 enum iscsit_transport_type {
  79         ISCSI_TCP                               = 0,
  80         ISCSI_SCTP_TCP                          = 1,
  81         ISCSI_SCTP_UDP                          = 2,
  82         ISCSI_IWARP_TCP                         = 3,
  83         ISCSI_IWARP_SCTP                        = 4,
  84         ISCSI_INFINIBAND                        = 5,
  85 };
  86
  87 /* RFC-3720 7.1.4  Standard Connection State Diagram for a Target */
  88 enum target_conn_state_table {
  89         TARG_CONN_STATE_FREE                    = 0x1,
  90         TARG_CONN_STATE_XPT_UP                  = 0x3,
  91         TARG_CONN_STATE_IN_LOGIN                = 0x4,
  92         TARG_CONN_STATE_LOGGED_IN               = 0x5,
  93         TARG_CONN_STATE_IN_LOGOUT               = 0x6,
  94         TARG_CONN_STATE_LOGOUT_REQUESTED        = 0x7,
  95         TARG_CONN_STATE_CLEANUP_WAIT            = 0x8,
  96 };
  97
  98 /* RFC-3720 7.3.2  Session State Diagram for a Target */
  99 enum target_sess_state_table {
 100         TARG_SESS_STATE_FREE                    = 0x1,
 101         TARG_SESS_STATE_ACTIVE                  = 0x2,
 102         TARG_SESS_STATE_LOGGED_IN               = 0x3,
 103         TARG_SESS_STATE_FAILED                  = 0x4,
 104         TARG_SESS_STATE_IN_CONTINUE             = 0x5,
 105 };
 106
 107 /* struct iscsi_data_count->type */
 108 enum data_count_type {
 109         ISCSI_RX_DATA   = 1,
 110         ISCSI_TX_DATA   = 2,
 111 };
 112
 113 /* struct iscsi_datain_req->dr_complete */
 114 enum datain_req_comp_table {
 115         DATAIN_COMPLETE_NORMAL                  = 1,
 116         DATAIN_COMPLETE_WITHIN_COMMAND_RECOVERY = 2,
 117         DATAIN_COMPLETE_CONNECTION_RECOVERY     = 3,
 118 };
 119
 120 /* struct iscsi_datain_req->recovery */
 121 enum datain_req_rec_table {
 122         DATAIN_WITHIN_COMMAND_RECOVERY          = 1,
 123         DATAIN_CONNECTION_RECOVERY              = 2,
 124 };
 125
 126 /* struct iscsi_portal_group->state */
 127 enum tpg_state_table {
 128         TPG_STATE_FREE                          = 0,
 129         TPG_STATE_ACTIVE                        = 1,
 130         TPG_STATE_INACTIVE                      = 2,
 131         TPG_STATE_COLD_RESET                    = 3,
 132 };
 133
 134 /* struct iscsi_tiqn->tiqn_state */
 135 enum tiqn_state_table {
 136         TIQN_STATE_ACTIVE                       = 1,
 137         TIQN_STATE_SHUTDOWN                     = 2,
 138 };
 139
 140 /* struct iscsi_cmd->cmd_flags */
 141 enum cmd_flags_table {
 142         ICF_GOT_LAST_DATAOUT                    = 0x00000001,
 143         ICF_GOT_DATACK_SNACK                    = 0x00000002,
 144         ICF_NON_IMMEDIATE_UNSOLICITED_DATA      = 0x00000004,
 145         ICF_SENT_LAST_R2T                       = 0x00000008,
 146         ICF_WITHIN_COMMAND_RECOVERY             = 0x00000010,
 147         ICF_CONTIG_MEMORY                       = 0x00000020,
 148         ICF_ATTACHED_TO_RQUEUE                  = 0x00000040,
 149         ICF_OOO_CMDSN                           = 0x00000080,
 150         ICF_SENDTARGETS_ALL                     = 0x00000100,
 151         ICF_SENDTARGETS_SINGLE                  = 0x00000200,
 152 };
 153
 154 /* struct iscsi_cmd->i_state */
 155 enum cmd_i_state_table {
 156         ISTATE_NO_STATE                 = 0,
 157         ISTATE_NEW_CMD                  = 1,
 158         ISTATE_DEFERRED_CMD             = 2,
 159         ISTATE_UNSOLICITED_DATA         = 3,
 160         ISTATE_RECEIVE_DATAOUT          = 4,
 161         ISTATE_RECEIVE_DATAOUT_RECOVERY = 5,
 162         ISTATE_RECEIVED_LAST_DATAOUT    = 6,
 163         ISTATE_WITHIN_DATAOUT_RECOVERY  = 7,
 164         ISTATE_IN_CONNECTION_RECOVERY   = 8,
 165         ISTATE_RECEIVED_TASKMGT         = 9,
 166         ISTATE_SEND_ASYNCMSG            = 10,
 167         ISTATE_SENT_ASYNCMSG            = 11,
 168         ISTATE_SEND_DATAIN              = 12,
 169         ISTATE_SEND_LAST_DATAIN         = 13,
 170         ISTATE_SENT_LAST_DATAIN         = 14,
 171         ISTATE_SEND_LOGOUTRSP           = 15,
 172         ISTATE_SENT_LOGOUTRSP           = 16,
 173         ISTATE_SEND_NOPIN               = 17,
 174         ISTATE_SENT_NOPIN               = 18,
 175         ISTATE_SEND_REJECT              = 19,
 176         ISTATE_SENT_REJECT              = 20,
 177         ISTATE_SEND_R2T                 = 21,
 178         ISTATE_SENT_R2T                 = 22,
 179         ISTATE_SEND_R2T_RECOVERY        = 23,
 180         ISTATE_SENT_R2T_RECOVERY        = 24,
 181         ISTATE_SEND_LAST_R2T            = 25,
 182         ISTATE_SENT_LAST_R2T            = 26,
 183         ISTATE_SEND_LAST_R2T_RECOVERY   = 27,
 184         ISTATE_SENT_LAST_R2T_RECOVERY   = 28,
 185         ISTATE_SEND_STATUS              = 29,
 186         ISTATE_SEND_STATUS_BROKEN_PC    = 30,
 187         ISTATE_SENT_STATUS              = 31,
 188         ISTATE_SEND_STATUS_RECOVERY     = 32,
 189         ISTATE_SENT_STATUS_RECOVERY     = 33,
 190         ISTATE_SEND_TASKMGTRSP          = 34,
 191         ISTATE_SENT_TASKMGTRSP          = 35,
 192         ISTATE_SEND_TEXTRSP             = 36,
 193         ISTATE_SENT_TEXTRSP             = 37,
 194         ISTATE_SEND_NOPIN_WANT_RESPONSE = 38,
 195         ISTATE_SENT_NOPIN_WANT_RESPONSE = 39,
 196         ISTATE_SEND_NOPIN_NO_RESPONSE   = 40,
 197         ISTATE_REMOVE                   = 41,
 198         ISTATE_FREE                     = 42,
 199 };
 200
 201 /* Used for iscsi_recover_cmdsn() return values */
 202 enum recover_cmdsn_ret_table {
 203         CMDSN_ERROR_CANNOT_RECOVER      = -1,
 204         CMDSN_NORMAL_OPERATION          = 0,
 205         CMDSN_LOWER_THAN_EXP            = 1,
 206         CMDSN_HIGHER_THAN_EXP           = 2,
 207         CMDSN_MAXCMDSN_OVERRUN          = 3,
 208 };
 209
 210 /* Used for iscsi_handle_immediate_data() return values */
 211 enum immedate_data_ret_table {
 212         IMMEDIATE_DATA_CANNOT_RECOVER   = -1,
 213         IMMEDIATE_DATA_NORMAL_OPERATION = 0,
 214         IMMEDIATE_DATA_ERL1_CRC_FAILURE = 1,
 215 };
 216
 217 /* Used for iscsi_decide_dataout_action() return values */
 218 enum dataout_action_ret_table {
 219         DATAOUT_CANNOT_RECOVER          = -1,
 220         DATAOUT_NORMAL                  = 0,
 221         DATAOUT_SEND_R2T                = 1,
 222         DATAOUT_SEND_TO_TRANSPORT       = 2,
 223         DATAOUT_WITHIN_COMMAND_RECOVERY = 3,
 224 };
 225
 226 /* Used for struct iscsi_node_auth->naf_flags */
 227 enum naf_flags_table {
 228         NAF_USERID_SET                  = 0x01,
 229         NAF_PASSWORD_SET                = 0x02,
 230         NAF_USERID_IN_SET               = 0x04,
 231         NAF_PASSWORD_IN_SET             = 0x08,
 232 };
 233
 234 /* Used by various struct timer_list to manage iSCSI specific state */
 235 enum iscsi_timer_flags_table {
 236         ISCSI_TF_RUNNING                = 0x01,
 237         ISCSI_TF_STOP                   = 0x02,
 238         ISCSI_TF_EXPIRED                = 0x04,
 239 };
 240
 241 /* Used for struct iscsi_np->np_flags */
 242 enum np_flags_table {
 243         NPF_IP_NETWORK          = 0x00,
 244 };
 245
 246 /* Used for struct iscsi_np->np_thread_state */
 247 enum np_thread_state_table {
 248         ISCSI_NP_THREAD_ACTIVE          = 1,
 249         ISCSI_NP_THREAD_INACTIVE        = 2,
 250         ISCSI_NP_THREAD_RESET           = 3,
 251         ISCSI_NP_THREAD_SHUTDOWN        = 4,
 252         ISCSI_NP_THREAD_EXIT            = 5,
 253 };
 254
 255 struct iscsi_conn_ops {
 256         u8      HeaderDigest;                   /* [0,1] == [None,CRC32C] */
 257         u8      DataDigest;                     /* [0,1] == [None,CRC32C] */
 258         u32     MaxRecvDataSegmentLength;       /* [512..2**24-1] */
 259         u32     MaxXmitDataSegmentLength;       /* [512..2**24-1] */
 260         /*
 261          * iSER specific connection parameters
 262          */
 263         u32     InitiatorRecvDataSegmentLength; /* [512..2**24-1] */
 264         u32     TargetRecvDataSegmentLength;    /* [512..2**24-1] */
 265 };
 266
 267 struct iscsi_sess_ops {
 268         char    InitiatorName[224];
 269         char    InitiatorAlias[256];
 270         char    TargetName[224];
 271         char    TargetAlias[256];
 272         char    TargetAddress[256];
 273         u16     TargetPortalGroupTag;           /* [0..65535] */
 274         u16     MaxConnections;                 /* [1..65535] */
 275         u8      InitialR2T;                     /* [0,1] == [No,Yes] */
 276         u8      ImmediateData;                  /* [0,1] == [No,Yes] */
 277         u32     MaxBurstLength;                 /* [512..2**24-1] */
 278         u32     FirstBurstLength;               /* [512..2**24-1] */
 279         u16     DefaultTime2Wait;               /* [0..3600] */
 280         u16     DefaultTime2Retain;             /* [0..3600] */
 281         u16     MaxOutstandingR2T;              /* [1..65535] */
 282         u8      DataPDUInOrder;                 /* [0,1] == [No,Yes] */
 283         u8      DataSequenceInOrder;            /* [0,1] == [No,Yes] */
 284         u8      ErrorRecoveryLevel;             /* [0..2] */
 285         u8      SessionType;                    /* [0,1] == [Normal,Discovery]*/
 286         /*
 287          * iSER specific session parameters
 288          */
 289         u8      RDMAExtensions;                 /* [0,1] == [No,Yes] */
 290 };
 291
 292 struct iscsi_queue_req {
 293         int                     state;
 294         struct iscsi_cmd        *cmd;
 295         struct list_head        qr_list;
 296 };
 297
 298 struct iscsi_data_count {
 299         int                     data_length;
 300         int                     sync_and_steering;
 301         enum data_count_type    type;
 302         u32                     iov_count;
 303         u32                     ss_iov_count;
 304         u32                     ss_marker_count;
 305         struct kvec             *iov;
 306 };
 307
 308 struct iscsi_param_list {
 309         bool                    iser;
 310         struct list_head        param_list;
 311         struct list_head        extra_response_list;
 312 };
 313
 314 struct iscsi_datain_req {
 315         enum datain_req_comp_table dr_complete;
 316         int                     generate_recovery_values;
 317         enum datain_req_rec_table recovery;
 318         u32                     begrun;
 319         u32                     runlength;
 320         u32                     data_length;
 321         u32                     data_offset;
 322         u32                     data_sn;
 323         u32                     next_burst_len;
 324         u32                     read_data_done;
 325         u32                     seq_send_order;
 326         struct list_head        cmd_datain_node;
 327 } ____cacheline_aligned;
 328
 329 struct iscsi_ooo_cmdsn {
 330         u16                     cid;
 331         u32                     batch_count;
 332         u32                     cmdsn;
 333         u32                     exp_cmdsn;
 334         struct iscsi_cmd        *cmd;
 335         struct list_head        ooo_list;
 336 } ____cacheline_aligned;
 337
 338 struct iscsi_datain {
 339         u8                      flags;
 340         u32                     data_sn;
 341         u32                     length;
 342         u32                     offset;
 343 } ____cacheline_aligned;
 344
 345 struct iscsi_r2t {
 346         int                     seq_complete;
 347         int                     recovery_r2t;
 348         int                     sent_r2t;
 349         u32                     r2t_sn;
 350         u32                     offset;
 351         u32                     targ_xfer_tag;
 352         u32                     xfer_len;
 353         struct list_head        r2t_list;
 354 } ____cacheline_aligned;
 355
 356 struct iscsi_cmd {
 357         enum iscsi_timer_flags_table dataout_timer_flags;
 358         /* DataOUT timeout retries */
 359         u8                      dataout_timeout_retries;
 360         /* Within command recovery count */
 361         u8                      error_recovery_count;
 362         /* iSCSI dependent state for out or order CmdSNs */
 363         enum cmd_i_state_table  deferred_i_state;
 364         /* iSCSI dependent state */
 365         enum cmd_i_state_table  i_state;
 366         /* Command is an immediate command (ISCSI_OP_IMMEDIATE set) */
 367         u8                      immediate_cmd;
 368         /* Immediate data present */
 369         u8                      immediate_data;
 370         /* iSCSI Opcode */
 371         u8                      iscsi_opcode;
 372         /* iSCSI Response Code */
 373         u8                      iscsi_response;
 374         /* Logout reason when iscsi_opcode == ISCSI_INIT_LOGOUT_CMND */
 375         u8                      logout_reason;
 376         /* Logout response code when iscsi_opcode == ISCSI_INIT_LOGOUT_CMND */
 377         u8                      logout_response;
 378         /* MaxCmdSN has been incremented */
 379         u8                      maxcmdsn_inc;
 380         /* Immediate Unsolicited Dataout */
 381         u8                      unsolicited_data;
 382         /* Reject reason code */
 383         u8                      reject_reason;
 384         /* CID contained in logout PDU when opcode == ISCSI_INIT_LOGOUT_CMND */
 385         u16                     logout_cid;
 386         /* Command flags */
 387         enum cmd_flags_table    cmd_flags;
 388         /* Initiator Task Tag assigned from Initiator */
 389         itt_t                   init_task_tag;
 390         /* Target Transfer Tag assigned from Target */
 391         u32                     targ_xfer_tag;
 392         /* CmdSN assigned from Initiator */
 393         u32                     cmd_sn;
 394         /* ExpStatSN assigned from Initiator */
 395         u32                     exp_stat_sn;
 396         /* StatSN assigned to this ITT */
 397         u32                     stat_sn;
 398         /* DataSN Counter */
 399         u32                     data_sn;
 400         /* R2TSN Counter */
 401         u32                     r2t_sn;
 402         /* Last DataSN acknowledged via DataAck SNACK */
 403         u32                     acked_data_sn;
 404         /* Used for echoing NOPOUT ping data */
 405         u32                     buf_ptr_size;
 406         /* Used to store DataDigest */
 407         u32                     data_crc;
 408         /* Counter for MaxOutstandingR2T */
 409         u32                     outstanding_r2ts;
 410         /* Next R2T Offset when DataSequenceInOrder=Yes */
 411         u32                     r2t_offset;
 412         /* Iovec current and orig count for iscsi_cmd->iov_data */
 413         u32                     iov_data_count;
 414         u32                     orig_iov_data_count;
 415         /* Number of miscellaneous iovecs used for IP stack calls */
 416         u32                     iov_misc_count;
 417         /* Number of struct iscsi_pdu in struct iscsi_cmd->pdu_list */
 418         u32                     pdu_count;
 419         /* Next struct iscsi_pdu to send in struct iscsi_cmd->pdu_list */
 420         u32                     pdu_send_order;
 421         /* Current struct iscsi_pdu in struct iscsi_cmd->pdu_list */
 422         u32                     pdu_start;
 423         /* Next struct iscsi_seq to send in struct iscsi_cmd->seq_list */
 424         u32                     seq_send_order;
 425         /* Number of struct iscsi_seq in struct iscsi_cmd->seq_list */
 426         u32                     seq_count;
 427         /* Current struct iscsi_seq in struct iscsi_cmd->seq_list */
 428         u32                     seq_no;
 429         /* Lowest offset in current DataOUT sequence */
 430         u32                     seq_start_offset;
 431         /* Highest offset in current DataOUT sequence */
 432         u32                     seq_end_offset;
 433         /* Total size in bytes received so far of READ data */
 434         u32                     read_data_done;
 435         /* Total size in bytes received so far of WRITE data */
 436         u32                     write_data_done;
 437         /* Counter for FirstBurstLength key */
 438         u32                     first_burst_len;
 439         /* Counter for MaxBurstLength key */
 440         u32                     next_burst_len;
 441         /* Transfer size used for IP stack calls */
 442         u32                     tx_size;
 443         /* Buffer used for various purposes */
 444         void                    *buf_ptr;
 445         /* Used by SendTargets=[iqn.,eui.] discovery */
 446         void                    *text_in_ptr;
 447         /* See include/linux/dma-mapping.h */
 448         enum dma_data_direction data_direction;
 449         /* iSCSI PDU Header + CRC */
 450         unsigned char           pdu[ISCSI_HDR_LEN + ISCSI_CRC_LEN];
 451         /* Number of times struct iscsi_cmd is present in immediate queue */
 452         atomic_t                immed_queue_count;
 453         atomic_t                response_queue_count;
 454         spinlock_t              datain_lock;
 455         spinlock_t              dataout_timeout_lock;
 456         /* spinlock for protecting struct iscsi_cmd->i_state */
 457         spinlock_t              istate_lock;
 458         /* spinlock for adding within command recovery entries */
 459         spinlock_t              error_lock;
 460         /* spinlock for adding R2Ts */
 461         spinlock_t              r2t_lock;
 462         /* DataIN List */
 463         struct list_head        datain_list;
 464         /* R2T List */
 465         struct list_head        cmd_r2t_list;
 466         /* Timer for DataOUT */
 467         struct timer_list       dataout_timer;
 468         /* Iovecs for SCSI data payload RX/TX w/ kernel level sockets */
 469         struct kvec             *iov_data;
 470         /* Iovecs for miscellaneous purposes */
 471 #define ISCSI_MISC_IOVECS                       5
 472         struct kvec             iov_misc[ISCSI_MISC_IOVECS];
 473         /* Array of struct iscsi_pdu used for DataPDUInOrder=No */
 474         struct iscsi_pdu        *pdu_list;
 475         /* Current struct iscsi_pdu used for DataPDUInOrder=No */
 476         struct iscsi_pdu        *pdu_ptr;
 477         /* Array of struct iscsi_seq used for DataSequenceInOrder=No */
 478         struct iscsi_seq        *seq_list;
 479         /* Current struct iscsi_seq used for DataSequenceInOrder=No */
 480         struct iscsi_seq        *seq_ptr;
 481         /* TMR Request when iscsi_opcode == ISCSI_OP_SCSI_TMFUNC */
 482         struct iscsi_tmr_req    *tmr_req;
 483         /* Connection this command is alligient to */
 484         struct iscsi_conn       *conn;
 485         /* Pointer to connection recovery entry */
 486         struct iscsi_conn_recovery *cr;
 487         /* Session the command is part of,  used for connection recovery */
 488         struct iscsi_session    *sess;
 489         /* list_head for connection list */
 490         struct list_head        i_conn_node;
 491         /* The TCM I/O descriptor that is accessed via container_of() */
 492         struct se_cmd           se_cmd;
 493         /* Sense buffer that will be mapped into outgoing status */
 494 #define ISCSI_SENSE_BUFFER_LEN          (TRANSPORT_SENSE_BUFFER + 2)
 495         unsigned char           sense_buffer[ISCSI_SENSE_BUFFER_LEN];
 496
 497         u32                     padding;
 498         u8                      pad_bytes[4];
 499
 500         struct scatterlist      *first_data_sg;
 501         u32                     first_data_sg_off;
 502         u32                     kmapped_nents;
 503         sense_reason_t          sense_reason;
 504 }  ____cacheline_aligned;
 505
 506 struct iscsi_tmr_req {
 507         bool                    task_reassign:1;
 508         u32                     exp_data_sn;
 509         struct iscsi_cmd        *ref_cmd;
 510         struct iscsi_conn_recovery *conn_recovery;
 511         struct se_tmr_req       *se_tmr_req;
 512 };
 513
 514 struct iscsi_conn {
 515         wait_queue_head_t       queues_wq;
 516         /* Authentication Successful for this connection */
 517         u8                      auth_complete;
 518         /* State connection is currently in */
 519         u8                      conn_state;
 520         u8                      conn_logout_reason;
 521         u8                      network_transport;
 522         enum iscsi_timer_flags_table nopin_timer_flags;
 523         enum iscsi_timer_flags_table nopin_response_timer_flags;
 524         /* Used to know what thread encountered a transport failure */
 525         u8                      which_thread;
 526         /* connection id assigned by the Initiator */
 527         u16                     cid;
 528         /* Remote TCP Port */
 529         u16                     login_port;
 530         int                     net_size;
 531         int                     login_family;
 532         u32                     auth_id;
 533         u32                     conn_flags;
 534         /* Used for iscsi_tx_login_rsp() */
 535         itt_t                   login_itt;
 536         u32                     exp_statsn;
 537         /* Per connection status sequence number */
 538         u32                     stat_sn;
 539         struct sockaddr_storage login_sockaddr;
 540         struct sockaddr_storage local_sockaddr;
 541         int                     conn_usage_count;
 542         int                     conn_waiting_on_uc;
 543         atomic_t                check_immediate_queue;
 544         atomic_t                conn_logout_remove;
 545         atomic_t                connection_exit;
 546         atomic_t                connection_recovery;
 547         atomic_t                connection_reinstatement;
 548         atomic_t                connection_wait_rcfr;
 549         atomic_t                sleep_on_conn_wait_comp;
 550         atomic_t                transport_failed;
 551         struct completion       conn_post_wait_comp;
 552         struct completion       conn_wait_comp;
 553         struct completion       conn_wait_rcfr_comp;
 554         struct completion       conn_waiting_on_uc_comp;
 555         struct completion       conn_logout_comp;
 556         struct completion       tx_half_close_comp;
 557         struct completion       rx_half_close_comp;
 558         /* socket used by this connection */
 559         struct socket           *sock;
 560         void                    (*orig_data_ready)(struct sock *);
 561         void                    (*orig_state_change)(struct sock *);
 562 #define LOGIN_FLAGS_READ_ACTIVE         1
 563 #define LOGIN_FLAGS_CLOSED              2
 564 #define LOGIN_FLAGS_READY               4
 565 #define LOGIN_FLAGS_INITIAL_PDU         8
 566         unsigned long           login_flags;
 567         struct delayed_work     login_work;
 568         struct delayed_work     login_cleanup_work;
 569         struct iscsi_login      *login;
 570         struct timer_list       nopin_timer;
 571         struct timer_list       nopin_response_timer;
 572         struct timer_list       transport_timer;
 573         struct task_struct      *login_kworker;
 574         /* Spinlock used for add/deleting cmd's from conn_cmd_list */
 575         spinlock_t              cmd_lock;
 576         spinlock_t              conn_usage_lock;
 577         spinlock_t              immed_queue_lock;
 578         spinlock_t              nopin_timer_lock;
 579         spinlock_t              response_queue_lock;
 580         spinlock_t              state_lock;
 581         /* libcrypto RX and TX contexts for crc32c */
 582         struct hash_desc        conn_rx_hash;
 583         struct hash_desc        conn_tx_hash;
 584         /* Used for scheduling TX and RX connection kthreads */
 585         cpumask_var_t           conn_cpumask;
 586         unsigned int            conn_rx_reset_cpumask:1;
 587         unsigned int            conn_tx_reset_cpumask:1;
 588         /* list_head of struct iscsi_cmd for this connection */
 589         struct list_head        conn_cmd_list;
 590         struct list_head        immed_queue_list;
 591         struct list_head        response_queue_list;
 592         struct iscsi_conn_ops   *conn_ops;
 593         struct iscsi_login      *conn_login;
 594         struct iscsit_transport *conn_transport;
 595         struct iscsi_param_list *param_list;
 596         /* Used for per connection auth state machine */
 597         void                    *auth_protocol;
 598         void                    *context;
 599         struct iscsi_login_thread_s *login_thread;
 600         struct iscsi_portal_group *tpg;
 601         struct iscsi_tpg_np     *tpg_np;
 602         /* Pointer to parent session */
 603         struct iscsi_session    *sess;
 604         int                     bitmap_id;
 605         int                     rx_thread_active;
 606         struct task_struct      *rx_thread;
 607         struct completion       rx_login_comp;
 608         int                     tx_thread_active;
 609         struct task_struct      *tx_thread;
 610         /* list_head for session connection list */
 611         struct list_head        conn_list;
 612 } ____cacheline_aligned;
 613
 614 struct iscsi_conn_recovery {
 615         u16                     cid;
 616         u32                     cmd_count;
 617         u32                     maxrecvdatasegmentlength;
 618         u32                     maxxmitdatasegmentlength;
 619         int                     ready_for_reallegiance;
 620         struct list_head        conn_recovery_cmd_list;
 621         spinlock_t              conn_recovery_cmd_lock;
 622         struct timer_list       time2retain_timer;
 623         struct iscsi_session    *sess;
 624         struct list_head        cr_list;
 625 }  ____cacheline_aligned;
 626
 627 struct iscsi_session {
 628         u8                      initiator_vendor;
 629         u8                      isid[6];
 630         enum iscsi_timer_flags_table time2retain_timer_flags;
 631         u8                      version_active;
 632         u16                     cid_called;
 633         u16                     conn_recovery_count;
 634         u16                     tsih;
 635         /* state session is currently in */
 636         u32                     session_state;
 637         /* session wide counter: initiator assigned task tag */
 638         itt_t                   init_task_tag;
 639         /* session wide counter: target assigned task tag */
 640         u32                     targ_xfer_tag;
 641         u32                     cmdsn_window;
 642
 643         /* protects cmdsn values */
 644         struct mutex            cmdsn_mutex;
 645         /* session wide counter: expected command sequence number */
 646         u32                     exp_cmd_sn;
 647         /* session wide counter: maximum allowed command sequence number */
 648         atomic_t                max_cmd_sn;
 649         struct list_head        sess_ooo_cmdsn_list;
 650
 651         /* LIO specific session ID */
 652         u32                     sid;
 653         char                    auth_type[8];
 654         /* unique within the target */
 655         int                     session_index;
 656         /* Used for session reference counting */
 657         int                     session_usage_count;
 658         int                     session_waiting_on_uc;
 659         atomic_long_t           cmd_pdus;
 660         atomic_long_t           rsp_pdus;
 661         atomic_long_t           tx_data_octets;
 662         atomic_long_t           rx_data_octets;
 663         atomic_long_t           conn_digest_errors;
 664         atomic_long_t           conn_timeout_errors;
 665         u64                     creation_time;
 666         /* Number of active connections */
 667         atomic_t                nconn;
 668         atomic_t                session_continuation;
 669         atomic_t                session_fall_back_to_erl0;
 670         atomic_t                session_logout;
 671         atomic_t                session_reinstatement;
 672         atomic_t                session_stop_active;
 673         atomic_t                sleep_on_sess_wait_comp;
 674         /* connection list */
 675         struct list_head        sess_conn_list;
 676         struct list_head        cr_active_list;
 677         struct list_head        cr_inactive_list;
 678         spinlock_t              conn_lock;
 679         spinlock_t              cr_a_lock;
 680         spinlock_t              cr_i_lock;
 681         spinlock_t              session_usage_lock;
 682         spinlock_t              ttt_lock;
 683         struct completion       async_msg_comp;
 684         struct completion       reinstatement_comp;
 685         struct completion       session_wait_comp;
 686         struct completion       session_waiting_on_uc_comp;
 687         struct timer_list       time2retain_timer;
 688         struct iscsi_sess_ops   *sess_ops;
 689         struct se_session       *se_sess;
 690         struct iscsi_portal_group *tpg;
 691 } ____cacheline_aligned;
 692
 693 struct iscsi_login {
 694         u8 auth_complete;
 695         u8 checked_for_existing;
 696         u8 current_stage;
 697         u8 leading_connection;
 698         u8 first_request;
 699         u8 version_min;
 700         u8 version_max;
 701         u8 login_complete;
 702         u8 login_failed;
 703         bool zero_tsih;
 704         char isid[6];
 705         u32 cmd_sn;
 706         itt_t init_task_tag;
 707         u32 initial_exp_statsn;
 708         u32 rsp_length;
 709         u16 cid;
 710         u16 tsih;
 711         char req[ISCSI_HDR_LEN];
 712         char rsp[ISCSI_HDR_LEN];
 713         char *req_buf;
 714         char *rsp_buf;
 715         struct iscsi_conn *conn;
 716         struct iscsi_np *np;
 717 } ____cacheline_aligned;
 718
 719 struct iscsi_node_attrib {
 720         u32                     dataout_timeout;
 721         u32                     dataout_timeout_retries;
 722         u32                     default_erl;
 723         u32                     nopin_timeout;
 724         u32                     nopin_response_timeout;
 725         u32                     random_datain_pdu_offsets;
 726         u32                     random_datain_seq_offsets;
 727         u32                     random_r2t_offsets;
 728         u32                     tmr_cold_reset;
 729         u32                     tmr_warm_reset;
 730         struct iscsi_node_acl *nacl;
 731 };
 732
 733 struct se_dev_entry_s;
 734
 735 struct iscsi_node_auth {
 736         enum naf_flags_table    naf_flags;
 737         int                     authenticate_target;
 738         /* Used for iscsit_global->discovery_auth,
 739          * set to zero (auth disabled) by default */
 740         int                     enforce_discovery_auth;
 741 #define MAX_USER_LEN                            256
 742 #define MAX_PASS_LEN                            256
 743         char                    userid[MAX_USER_LEN];
 744         char                    password[MAX_PASS_LEN];
 745         char                    userid_mutual[MAX_USER_LEN];
 746         char                    password_mutual[MAX_PASS_LEN];
 747 };
 748
 749 #include "iscsi_target_stat.h"
 750
 751 struct iscsi_node_stat_grps {
 752         struct config_group     iscsi_sess_stats_group;
 753         struct config_group     iscsi_conn_stats_group;
 754 };
 755
 756 struct iscsi_node_acl {
 757         struct se_node_acl      se_node_acl;
 758         struct iscsi_node_attrib node_attrib;
 759         struct iscsi_node_auth  node_auth;
 760         struct iscsi_node_stat_grps node_stat_grps;
 761 };
 762
 763 struct iscsi_tpg_attrib {
 764         u32                     authentication;
 765         u32                     login_timeout;
 766         u32                     netif_timeout;
 767         u32                     generate_node_acls;
 768         u32                     cache_dynamic_acls;
 769         u32                     default_cmdsn_depth;
 770         u32                     demo_mode_write_protect;
 771         u32                     prod_mode_write_protect;
 772         u32                     demo_mode_discovery;
 773         u32                     default_erl;
 774         u8                      t10_pi;
 775         u32                     fabric_prot_type;
 776         u32                     tpg_enabled_sendtargets;
 777         u32                     login_keys_workaround;
 778         struct iscsi_portal_group *tpg;
 779 };
 780
 781 struct iscsi_np {
 782         int                     np_network_transport;
 783         int                     np_ip_proto;
 784         int                     np_sock_type;
 785         enum np_thread_state_table np_thread_state;
 786         bool                    enabled;
 787         atomic_t                np_reset_count;
 788         enum iscsi_timer_flags_table np_login_timer_flags;
 789         u32                     np_exports;
 790         enum np_flags_table     np_flags;
 791         spinlock_t              np_thread_lock;
 792         struct completion       np_restart_comp;
 793         struct socket           *np_socket;
 794         struct sockaddr_storage np_sockaddr;
 795         struct task_struct      *np_thread;
 796         struct timer_list       np_login_timer;
 797         void                    *np_context;
 798         struct iscsit_transport *np_transport;
 799         struct list_head        np_list;
 800 } ____cacheline_aligned;
 801
 802 struct iscsi_tpg_np {
 803         struct iscsi_np         *tpg_np;
 804         struct iscsi_portal_group *tpg;
 805         struct iscsi_tpg_np     *tpg_np_parent;
 806         struct list_head        tpg_np_list;
 807         struct list_head        tpg_np_child_list;
 808         struct list_head        tpg_np_parent_list;
 809         struct se_tpg_np        se_tpg_np;
 810         spinlock_t              tpg_np_parent_lock;
 811         struct completion       tpg_np_comp;
 812         struct kref             tpg_np_kref;
 813 };
 814
 815 struct iscsi_portal_group {
 816         unsigned char           tpg_chap_id;
 817         /* TPG State */
 818         enum tpg_state_table    tpg_state;
 819         /* Target Portal Group Tag */
 820         u16                     tpgt;
 821         /* Id assigned to target sessions */
 822         u16                     ntsih;
 823         /* Number of active sessions */
 824         u32                     nsessions;
 825         /* Number of Network Portals available for this TPG */
 826         u32                     num_tpg_nps;
 827         /* Per TPG LIO specific session ID. */
 828         u32                     sid;
 829         /* Spinlock for adding/removing Network Portals */
 830         spinlock_t              tpg_np_lock;
 831         spinlock_t              tpg_state_lock;
 832         struct se_portal_group tpg_se_tpg;
 833         struct mutex            tpg_access_lock;
 834         struct semaphore        np_login_sem;
 835         struct iscsi_tpg_attrib tpg_attrib;
 836         struct iscsi_node_auth  tpg_demo_auth;
 837         /* Pointer to default list of iSCSI parameters for TPG */
 838         struct iscsi_param_list *param_list;
 839         struct iscsi_tiqn       *tpg_tiqn;
 840         struct list_head        tpg_gnp_list;
 841         struct list_head        tpg_list;
 842 } ____cacheline_aligned;
 843
 844 struct iscsi_wwn_stat_grps {
 845         struct config_group     iscsi_stat_group;
 846         struct config_group     iscsi_instance_group;
 847         struct config_group     iscsi_sess_err_group;
 848         struct config_group     iscsi_tgt_attr_group;
 849         struct config_group     iscsi_login_stats_group;
 850         struct config_group     iscsi_logout_stats_group;
 851 };
 852
 853 struct iscsi_tiqn {
 854 #define ISCSI_IQN_LEN                           224
 855         unsigned char           tiqn[ISCSI_IQN_LEN];
 856         enum tiqn_state_table   tiqn_state;
 857         int                     tiqn_access_count;
 858         u32                     tiqn_active_tpgs;
 859         u32                     tiqn_ntpgs;
 860         u32                     tiqn_num_tpg_nps;
 861         u32                     tiqn_nsessions;
 862         struct list_head        tiqn_list;
 863         struct list_head        tiqn_tpg_list;
 864         spinlock_t              tiqn_state_lock;
 865         spinlock_t              tiqn_tpg_lock;
 866         struct se_wwn           tiqn_wwn;
 867         struct iscsi_wwn_stat_grps tiqn_stat_grps;
 868         int                     tiqn_index;
 869         struct iscsi_sess_err_stats  sess_err_stats;
 870         struct iscsi_login_stats     login_stats;
 871         struct iscsi_logout_stats    logout_stats;
 872 } ____cacheline_aligned;
 873
 874 struct iscsit_global {
 875         /* In core shutdown */
 876         u32                     in_shutdown;
 877         u32                     active_ts;
 878         /* Unique identifier used for the authentication daemon */
 879         u32                     auth_id;
 880         u32                     inactive_ts;
 881 #define ISCSIT_BITMAP_BITS      262144
 882         /* Thread Set bitmap pointer */
 883         unsigned long           *ts_bitmap;
 884         spinlock_t              ts_bitmap_lock;
 885         /* Used for iSCSI discovery session authentication */
 886         struct iscsi_node_acl   discovery_acl;
 887         struct iscsi_portal_group       *discovery_tpg;
 888 };
 889
 890 static inline u32 session_get_next_ttt(struct iscsi_session *session)
 891 {
 892         u32 ttt;
 893
 894         spin_lock_bh(&session->ttt_lock);
 895         ttt = session->targ_xfer_tag++;
 896         if (ttt == 0xFFFFFFFF)
 897                 ttt = session->targ_xfer_tag++;
 898         spin_unlock_bh(&session->ttt_lock);
 899
 900         return ttt;
 901 }
 902
 903 extern struct iscsi_cmd *iscsit_find_cmd_from_itt(struct iscsi_conn *, itt_t);
 904 #endif /* ISCSI_TARGET_CORE_H */