include/target/iscsi/iscsi_target_core.h

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