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