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