LXR linux/include/target/iscsi/iscsi_target

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