1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef TARGET_CORE_BASE_H 3 #define TARGET_CORE_BASE_H 4 5 #include <linux/configfs.h> /* struct config_group */ 6 #include <linux/dma-direction.h> /* enum dma_data_direction */ 7 #include <linux/sbitmap.h> 8 #include <linux/percpu-refcount.h> 9 #include <linux/semaphore.h> /* struct semaphore */ 10 #include <linux/completion.h> 11 12 #define TARGET_CORE_VERSION "v5.0" 13 14 /* 15 * Maximum size of a CDB that can be stored in se_cmd without allocating 16 * memory dynamically for the CDB. 17 */ 18 #define TCM_MAX_COMMAND_SIZE 32 19 /* 20 * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently 21 * defined 96, but the real limit is 252 (or 260 including the header) 22 */ 23 #define TRANSPORT_SENSE_BUFFER 96 24 /* Used by transport_send_check_condition_and_sense() */ 25 #define SPC_SENSE_KEY_OFFSET 2 26 #define SPC_ADD_SENSE_LEN_OFFSET 7 27 #define SPC_DESC_TYPE_OFFSET 8 28 #define SPC_ADDITIONAL_DESC_LEN_OFFSET 9 29 #define SPC_VALIDITY_OFFSET 10 30 #define SPC_ASC_KEY_OFFSET 12 31 #define SPC_ASCQ_KEY_OFFSET 13 32 #define TRANSPORT_IQN_LEN 224 33 /* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */ 34 #define LU_GROUP_NAME_BUF 256 35 /* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */ 36 #define TG_PT_GROUP_NAME_BUF 256 37 /* Used to parse VPD into struct t10_vpd */ 38 #define VPD_TMP_BUF_SIZE 254 39 /* Used by transport_generic_cmd_sequencer() */ 40 #define READ_BLOCK_LEN 6 41 #define READ_CAP_LEN 8 42 #define READ_POSITION_LEN 20 43 #define INQUIRY_LEN 36 44 /* Used by transport_get_inquiry_vpd_serial() */ 45 #define INQUIRY_VPD_SERIAL_LEN 254 46 /* Used by transport_get_inquiry_vpd_device_ident() */ 47 #define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN 254 48 49 #define INQUIRY_VENDOR_LEN 8 50 #define INQUIRY_MODEL_LEN 16 51 #define INQUIRY_REVISION_LEN 4 52 53 /* Attempts before moving from SHORT to LONG */ 54 #define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD 3 55 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT 3 /* In milliseconds */ 56 #define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG 10 /* In milliseconds */ 57 58 #define PYX_TRANSPORT_STATUS_INTERVAL 5 /* In seconds */ 59 60 /* struct se_dev_attrib sanity values */ 61 /* Default max_unmap_lba_count */ 62 #define DA_MAX_UNMAP_LBA_COUNT 0 63 /* Default max_unmap_block_desc_count */ 64 #define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0 65 /* Default unmap_granularity */ 66 #define DA_UNMAP_GRANULARITY_DEFAULT 0 67 /* Default unmap_granularity_alignment */ 68 #define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0 69 /* Default unmap_zeroes_data */ 70 #define DA_UNMAP_ZEROES_DATA_DEFAULT 0 71 /* Default max_write_same_len, disabled by default */ 72 #define DA_MAX_WRITE_SAME_LEN 0 73 /* Use a model alias based on the configfs backend device name */ 74 #define DA_EMULATE_MODEL_ALIAS 0 75 /* Emulation for WriteCache and SYNCHRONIZE_CACHE */ 76 #define DA_EMULATE_WRITE_CACHE 0 77 /* Emulation for TASK_ABORTED status (TAS) by default */ 78 #define DA_EMULATE_TAS 1 79 /* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */ 80 #define DA_EMULATE_TPU 0 81 /* 82 * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using 83 * block/blk-lib.c:blkdev_issue_discard() 84 */ 85 #define DA_EMULATE_TPWS 0 86 /* Emulation for CompareAndWrite (AtomicTestandSet) by default */ 87 #define DA_EMULATE_CAW 1 88 /* Emulation for 3rd Party Copy (ExtendedCopy) by default */ 89 #define DA_EMULATE_3PC 1 90 /* No Emulation for PSCSI by default */ 91 #define DA_EMULATE_ALUA 0 92 /* Emulate SCSI2 RESERVE/RELEASE and Persistent Reservations by default */ 93 #define DA_EMULATE_PR 1 94 /* Emulation for REPORT SUPPORTED OPERATION CODES */ 95 #define DA_EMULATE_RSOC 1 96 /* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */ 97 #define DA_ENFORCE_PR_ISIDS 1 98 /* Force SPC-3 PR Activate Persistence across Target Power Loss */ 99 #define DA_FORCE_PR_APTPL 0 100 #define DA_STATUS_MAX_SECTORS_MIN 16 101 #define DA_STATUS_MAX_SECTORS_MAX 8192 102 /* By default don't report non-rotating (solid state) medium */ 103 #define DA_IS_NONROT 0 104 /* Queue Algorithm Modifier default for restricted reordering in control mode page */ 105 #define DA_EMULATE_REST_REORD 0 106 107 #define SE_INQUIRY_BUF 1024 108 #define SE_MODE_PAGE_BUF 512 109 #define SE_SENSE_BUF 96 110 111 enum target_submit_type { 112 /* Use the fabric driver's default submission type */ 113 TARGET_FABRIC_DEFAULT_SUBMIT, 114 /* Submit from the calling context */ 115 TARGET_DIRECT_SUBMIT, 116 /* Defer submission to the LIO workqueue */ 117 TARGET_QUEUE_SUBMIT, 118 }; 119 120 /* struct se_hba->hba_flags */ 121 enum hba_flags_table { 122 HBA_FLAGS_INTERNAL_USE = 0x01, 123 HBA_FLAGS_PSCSI_MODE = 0x02, 124 }; 125 126 /* Special transport agnostic struct se_cmd->t_states */ 127 enum transport_state_table { 128 TRANSPORT_NO_STATE = 0, 129 TRANSPORT_NEW_CMD = 1, 130 TRANSPORT_WRITE_PENDING = 3, 131 TRANSPORT_PROCESSING = 5, 132 TRANSPORT_COMPLETE = 6, 133 TRANSPORT_ISTATE_PROCESSING = 11, 134 TRANSPORT_COMPLETE_QF_WP = 18, 135 TRANSPORT_COMPLETE_QF_OK = 19, 136 TRANSPORT_COMPLETE_QF_ERR = 20, 137 }; 138 139 /* Used for struct se_cmd->se_cmd_flags */ 140 enum se_cmd_flags_table { 141 SCF_SUPPORTED_SAM_OPCODE = (1 << 0), 142 SCF_TRANSPORT_TASK_SENSE = (1 << 1), 143 SCF_EMULATED_TASK_SENSE = (1 << 2), 144 SCF_SCSI_DATA_CDB = (1 << 3), 145 SCF_SCSI_TMR_CDB = (1 << 4), 146 SCF_FUA = (1 << 5), 147 SCF_SE_LUN_CMD = (1 << 6), 148 SCF_BIDI = (1 << 7), 149 SCF_SENT_CHECK_CONDITION = (1 << 8), 150 SCF_OVERFLOW_BIT = (1 << 9), 151 SCF_UNDERFLOW_BIT = (1 << 10), 152 SCF_ALUA_NON_OPTIMIZED = (1 << 11), 153 SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = (1 << 12), 154 SCF_COMPARE_AND_WRITE = (1 << 13), 155 SCF_PASSTHROUGH_PROT_SG_TO_MEM_NOALLOC = (1 << 14), 156 SCF_ACK_KREF = (1 << 15), 157 SCF_USE_CPUID = (1 << 16), 158 SCF_TASK_ATTR_SET = (1 << 17), 159 SCF_TREAT_READ_AS_NORMAL = (1 << 18), 160 SCF_TASK_ORDERED_SYNC = (1 << 19), 161 }; 162 163 /* 164 * Used by transport_send_check_condition_and_sense() 165 * to signal which ASC/ASCQ sense payload should be built. 166 */ 167 typedef unsigned __bitwise sense_reason_t; 168 169 enum tcm_sense_reason_table { 170 #define R(x) (__force sense_reason_t )(x) 171 TCM_NO_SENSE = R(0x00), 172 TCM_NON_EXISTENT_LUN = R(0x01), 173 TCM_UNSUPPORTED_SCSI_OPCODE = R(0x02), 174 TCM_INCORRECT_AMOUNT_OF_DATA = R(0x03), 175 TCM_UNEXPECTED_UNSOLICITED_DATA = R(0x04), 176 TCM_SERVICE_CRC_ERROR = R(0x05), 177 TCM_SNACK_REJECTED = R(0x06), 178 TCM_SECTOR_COUNT_TOO_MANY = R(0x07), 179 TCM_INVALID_CDB_FIELD = R(0x08), 180 TCM_INVALID_PARAMETER_LIST = R(0x09), 181 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE = R(0x0a), 182 TCM_UNKNOWN_MODE_PAGE = R(0x0b), 183 TCM_WRITE_PROTECTED = R(0x0c), 184 TCM_CHECK_CONDITION_ABORT_CMD = R(0x0d), 185 TCM_CHECK_CONDITION_UNIT_ATTENTION = R(0x0e), 186 187 TCM_RESERVATION_CONFLICT = R(0x10), 188 TCM_ADDRESS_OUT_OF_RANGE = R(0x11), 189 TCM_OUT_OF_RESOURCES = R(0x12), 190 TCM_PARAMETER_LIST_LENGTH_ERROR = R(0x13), 191 TCM_MISCOMPARE_VERIFY = R(0x14), 192 TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED = R(0x15), 193 TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED = R(0x16), 194 TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED = R(0x17), 195 TCM_COPY_TARGET_DEVICE_NOT_REACHABLE = R(0x18), 196 TCM_TOO_MANY_TARGET_DESCS = R(0x19), 197 TCM_UNSUPPORTED_TARGET_DESC_TYPE_CODE = R(0x1a), 198 TCM_TOO_MANY_SEGMENT_DESCS = R(0x1b), 199 TCM_UNSUPPORTED_SEGMENT_DESC_TYPE_CODE = R(0x1c), 200 TCM_INSUFFICIENT_REGISTRATION_RESOURCES = R(0x1d), 201 TCM_LUN_BUSY = R(0x1e), 202 TCM_INVALID_FIELD_IN_COMMAND_IU = R(0x1f), 203 TCM_ALUA_TG_PT_STANDBY = R(0x20), 204 TCM_ALUA_TG_PT_UNAVAILABLE = R(0x21), 205 TCM_ALUA_STATE_TRANSITION = R(0x22), 206 TCM_ALUA_OFFLINE = R(0x23), 207 #undef R 208 }; 209 210 enum target_sc_flags_table { 211 TARGET_SCF_BIDI_OP = 0x01, 212 TARGET_SCF_ACK_KREF = 0x02, 213 TARGET_SCF_UNKNOWN_SIZE = 0x04, 214 TARGET_SCF_USE_CPUID = 0x08, 215 }; 216 217 /* fabric independent task management function values */ 218 enum tcm_tmreq_table { 219 TMR_ABORT_TASK = 1, 220 TMR_ABORT_TASK_SET = 2, 221 TMR_CLEAR_ACA = 3, 222 TMR_CLEAR_TASK_SET = 4, 223 TMR_LUN_RESET = 5, 224 TMR_TARGET_WARM_RESET = 6, 225 TMR_TARGET_COLD_RESET = 7, 226 TMR_LUN_RESET_PRO = 0x80, 227 TMR_UNKNOWN = 0xff, 228 }; 229 230 /* fabric independent task management response values */ 231 enum tcm_tmrsp_table { 232 TMR_FUNCTION_FAILED = 0, 233 TMR_FUNCTION_COMPLETE = 1, 234 TMR_TASK_DOES_NOT_EXIST = 2, 235 TMR_LUN_DOES_NOT_EXIST = 3, 236 TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED = 4, 237 TMR_FUNCTION_REJECTED = 5, 238 }; 239 240 /* 241 * Used for target SCSI statistics 242 */ 243 typedef enum { 244 SCSI_INST_INDEX, 245 SCSI_AUTH_INTR_INDEX, 246 SCSI_INDEX_TYPE_MAX 247 } scsi_index_t; 248 249 struct se_cmd; 250 251 struct t10_alua_lba_map_member { 252 struct list_head lba_map_mem_list; 253 int lba_map_mem_alua_state; 254 int lba_map_mem_alua_pg_id; 255 }; 256 257 struct t10_alua_lba_map { 258 u64 lba_map_first_lba; 259 u64 lba_map_last_lba; 260 struct list_head lba_map_list; 261 struct list_head lba_map_mem_list; 262 }; 263 264 struct t10_alua { 265 /* ALUA Target Port Group ID */ 266 u16 alua_tg_pt_gps_counter; 267 u32 alua_tg_pt_gps_count; 268 /* Referrals support */ 269 spinlock_t lba_map_lock; 270 u32 lba_map_segment_size; 271 u32 lba_map_segment_multiplier; 272 struct list_head lba_map_list; 273 spinlock_t tg_pt_gps_lock; 274 struct se_device *t10_dev; 275 /* Used for default ALUA Target Port Group */ 276 struct t10_alua_tg_pt_gp *default_tg_pt_gp; 277 /* Used for default ALUA Target Port Group ConfigFS group */ 278 struct config_group alua_tg_pt_gps_group; 279 struct list_head tg_pt_gps_list; 280 }; 281 282 struct t10_alua_lu_gp { 283 u16 lu_gp_id; 284 int lu_gp_valid_id; 285 u32 lu_gp_members; 286 atomic_t lu_gp_ref_cnt; 287 spinlock_t lu_gp_lock; 288 struct config_group lu_gp_group; 289 struct list_head lu_gp_node; 290 struct list_head lu_gp_mem_list; 291 }; 292 293 struct t10_alua_lu_gp_member { 294 bool lu_gp_assoc; 295 atomic_t lu_gp_mem_ref_cnt; 296 spinlock_t lu_gp_mem_lock; 297 struct t10_alua_lu_gp *lu_gp; 298 struct se_device *lu_gp_mem_dev; 299 struct list_head lu_gp_mem_list; 300 }; 301 302 struct t10_alua_tg_pt_gp { 303 u16 tg_pt_gp_id; 304 int tg_pt_gp_valid_id; 305 int tg_pt_gp_alua_supported_states; 306 int tg_pt_gp_alua_access_status; 307 int tg_pt_gp_alua_access_type; 308 int tg_pt_gp_nonop_delay_msecs; 309 int tg_pt_gp_trans_delay_msecs; 310 int tg_pt_gp_implicit_trans_secs; 311 int tg_pt_gp_pref; 312 int tg_pt_gp_write_metadata; 313 u32 tg_pt_gp_members; 314 int tg_pt_gp_alua_access_state; 315 atomic_t tg_pt_gp_ref_cnt; 316 spinlock_t tg_pt_gp_lock; 317 struct mutex tg_pt_gp_transition_mutex; 318 struct se_device *tg_pt_gp_dev; 319 struct config_group tg_pt_gp_group; 320 struct list_head tg_pt_gp_list; 321 struct list_head tg_pt_gp_lun_list; 322 struct se_lun *tg_pt_gp_alua_lun; 323 struct se_node_acl *tg_pt_gp_alua_nacl; 324 }; 325 326 struct t10_vpd { 327 unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN]; 328 int protocol_identifier_set; 329 u32 protocol_identifier; 330 u32 device_identifier_code_set; 331 u32 association; 332 u32 device_identifier_type; 333 struct list_head vpd_list; 334 }; 335 336 struct t10_wwn { 337 /* 338 * SCSI left aligned strings may not be null terminated. +1 to ensure a 339 * null terminator is always present. 340 */ 341 char vendor[INQUIRY_VENDOR_LEN + 1]; 342 char model[INQUIRY_MODEL_LEN + 1]; 343 char revision[INQUIRY_REVISION_LEN + 1]; 344 char unit_serial[INQUIRY_VPD_SERIAL_LEN]; 345 u32 company_id; 346 spinlock_t t10_vpd_lock; 347 struct se_device *t10_dev; 348 struct config_group t10_wwn_group; 349 struct list_head t10_vpd_list; 350 }; 351 352 struct t10_pr_registration { 353 /* Used for fabrics that contain WWN+ISID */ 354 #define PR_REG_ISID_LEN 16 355 /* PR_REG_ISID_LEN + ',i,0x' */ 356 #define PR_REG_ISID_ID_LEN (PR_REG_ISID_LEN + 5) 357 char pr_reg_isid[PR_REG_ISID_LEN]; 358 /* Used during APTPL metadata reading */ 359 #define PR_APTPL_MAX_IPORT_LEN 256 360 unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN]; 361 /* Used during APTPL metadata reading */ 362 #define PR_APTPL_MAX_TPORT_LEN 256 363 unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN]; 364 u16 pr_aptpl_rpti; 365 u16 pr_reg_tpgt; 366 /* Reservation effects all target ports */ 367 int pr_reg_all_tg_pt; 368 /* Activate Persistence across Target Power Loss */ 369 int pr_reg_aptpl; 370 int pr_res_holder; 371 int pr_res_type; 372 int pr_res_scope; 373 /* Used for fabric initiator WWPNs using a ISID */ 374 bool isid_present_at_reg; 375 u64 pr_res_mapped_lun; 376 u64 pr_aptpl_target_lun; 377 u16 tg_pt_sep_rtpi; 378 u32 pr_res_generation; 379 u64 pr_reg_bin_isid; 380 u64 pr_res_key; 381 atomic_t pr_res_holders; 382 struct se_node_acl *pr_reg_nacl; 383 /* Used by ALL_TG_PT=1 registration with deve->pr_ref taken */ 384 struct se_dev_entry *pr_reg_deve; 385 struct list_head pr_reg_list; 386 struct list_head pr_reg_abort_list; 387 struct list_head pr_reg_aptpl_list; 388 struct list_head pr_reg_atp_list; 389 struct list_head pr_reg_atp_mem_list; 390 }; 391 392 struct t10_reservation { 393 /* Reservation effects all target ports */ 394 int pr_all_tg_pt; 395 /* Activate Persistence across Target Power Loss enabled 396 * for SCSI device */ 397 int pr_aptpl_active; 398 #define PR_APTPL_BUF_LEN 262144 399 u32 pr_generation; 400 spinlock_t registration_lock; 401 spinlock_t aptpl_reg_lock; 402 /* 403 * This will always be set by one individual I_T Nexus. 404 * However with all_tg_pt=1, other I_T Nexus from the 405 * same initiator can access PR reg/res info on a different 406 * target port. 407 * 408 * There is also the 'All Registrants' case, where there is 409 * a single *pr_res_holder of the reservation, but all 410 * registrations are considered reservation holders. 411 */ 412 struct se_node_acl *pr_res_holder; 413 struct list_head registration_list; 414 struct list_head aptpl_reg_list; 415 }; 416 417 struct se_tmr_req { 418 /* Task Management function to be performed */ 419 u8 function; 420 /* Task Management response to send */ 421 u8 response; 422 int call_transport; 423 /* Reference to ITT that Task Mgmt should be performed */ 424 u64 ref_task_tag; 425 void *fabric_tmr_ptr; 426 struct se_cmd *task_cmd; 427 struct se_device *tmr_dev; 428 struct list_head tmr_list; 429 }; 430 431 enum target_prot_op { 432 TARGET_PROT_NORMAL = 0, 433 TARGET_PROT_DIN_INSERT = (1 << 0), 434 TARGET_PROT_DOUT_INSERT = (1 << 1), 435 TARGET_PROT_DIN_STRIP = (1 << 2), 436 TARGET_PROT_DOUT_STRIP = (1 << 3), 437 TARGET_PROT_DIN_PASS = (1 << 4), 438 TARGET_PROT_DOUT_PASS = (1 << 5), 439 }; 440 441 #define TARGET_PROT_ALL TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \ 442 TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \ 443 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS 444 445 enum target_prot_type { 446 TARGET_DIF_TYPE0_PROT, 447 TARGET_DIF_TYPE1_PROT, 448 TARGET_DIF_TYPE2_PROT, 449 TARGET_DIF_TYPE3_PROT, 450 }; 451 452 /* Emulation for UNIT ATTENTION Interlock Control */ 453 enum target_ua_intlck_ctrl { 454 TARGET_UA_INTLCK_CTRL_CLEAR = 0, 455 TARGET_UA_INTLCK_CTRL_NO_CLEAR = 1, 456 TARGET_UA_INTLCK_CTRL_ESTABLISH_UA = 2, 457 }; 458 459 enum target_core_dif_check { 460 TARGET_DIF_CHECK_GUARD = 0x1 << 0, 461 TARGET_DIF_CHECK_APPTAG = 0x1 << 1, 462 TARGET_DIF_CHECK_REFTAG = 0x1 << 2, 463 }; 464 465 /* for sam_task_attr */ 466 #define TCM_SIMPLE_TAG 0x20 467 #define TCM_HEAD_TAG 0x21 468 #define TCM_ORDERED_TAG 0x22 469 #define TCM_ACA_TAG 0x24 470 471 struct se_cmd { 472 /* Used for fail with specific sense codes */ 473 sense_reason_t sense_reason; 474 /* SAM response code being sent to initiator */ 475 u8 scsi_status; 476 u16 scsi_sense_length; 477 unsigned unknown_data_length:1; 478 bool state_active:1; 479 u64 tag; /* SAM command identifier aka task tag */ 480 /* Delay for ALUA Active/NonOptimized state access in milliseconds */ 481 int alua_nonop_delay; 482 /* See include/linux/dma-mapping.h */ 483 enum dma_data_direction data_direction; 484 /* For SAM Task Attribute */ 485 int sam_task_attr; 486 /* Used for se_sess->sess_tag_pool */ 487 unsigned int map_tag; 488 int map_cpu; 489 /* Transport protocol dependent state, see transport_state_table */ 490 enum transport_state_table t_state; 491 /* See se_cmd_flags_table */ 492 u32 se_cmd_flags; 493 /* Total size in bytes associated with command */ 494 u32 data_length; 495 u32 residual_count; 496 u64 orig_fe_lun; 497 /* Persistent Reservation key */ 498 u64 pr_res_key; 499 /* Used for sense data */ 500 void *sense_buffer; 501 struct list_head se_delayed_node; 502 struct list_head se_qf_node; 503 struct se_device *se_dev; 504 struct se_lun *se_lun; 505 /* Only used for internal passthrough and legacy TCM fabric modules */ 506 struct se_session *se_sess; 507 struct target_cmd_counter *cmd_cnt; 508 struct se_tmr_req *se_tmr_req; 509 struct llist_node se_cmd_list; 510 struct completion *free_compl; 511 struct completion *abrt_compl; 512 const struct target_core_fabric_ops *se_tfo; 513 sense_reason_t (*execute_cmd)(struct se_cmd *); 514 sense_reason_t (*transport_complete_callback)(struct se_cmd *, bool, int *); 515 void *protocol_data; 516 517 unsigned char *t_task_cdb; 518 unsigned char __t_task_cdb[TCM_MAX_COMMAND_SIZE]; 519 unsigned long long t_task_lba; 520 unsigned int t_task_nolb; 521 unsigned int transport_state; 522 #define CMD_T_ABORTED (1 << 0) 523 #define CMD_T_ACTIVE (1 << 1) 524 #define CMD_T_COMPLETE (1 << 2) 525 #define CMD_T_SENT (1 << 4) 526 #define CMD_T_STOP (1 << 5) 527 #define CMD_T_TAS (1 << 10) 528 #define CMD_T_FABRIC_STOP (1 << 11) 529 spinlock_t t_state_lock; 530 struct kref cmd_kref; 531 struct completion t_transport_stop_comp; 532 533 struct work_struct work; 534 535 struct scatterlist *t_data_sg; 536 struct scatterlist *t_data_sg_orig; 537 unsigned int t_data_nents; 538 unsigned int t_data_nents_orig; 539 void *t_data_vmap; 540 struct scatterlist *t_bidi_data_sg; 541 unsigned int t_bidi_data_nents; 542 543 /* Used for lun->lun_ref counting */ 544 int lun_ref_active; 545 546 struct list_head state_list; 547 548 /* backend private data */ 549 void *priv; 550 551 /* DIF related members */ 552 enum target_prot_op prot_op; 553 enum target_prot_type prot_type; 554 u8 prot_checks; 555 bool prot_pto; 556 u32 prot_length; 557 u32 reftag_seed; 558 struct scatterlist *t_prot_sg; 559 unsigned int t_prot_nents; 560 sense_reason_t pi_err; 561 u64 sense_info; 562 /* 563 * CPU LIO will execute the cmd on. Defaults to the CPU the cmd is 564 * initialized on. Drivers can override. 565 */ 566 int cpuid; 567 }; 568 569 struct se_ua { 570 u8 ua_asc; 571 u8 ua_ascq; 572 struct list_head ua_nacl_list; 573 }; 574 575 struct se_node_acl { 576 char initiatorname[TRANSPORT_IQN_LEN]; 577 /* Used to signal demo mode created ACL, disabled by default */ 578 bool dynamic_node_acl; 579 bool dynamic_stop; 580 u32 queue_depth; 581 u32 acl_index; 582 enum target_prot_type saved_prot_type; 583 #define MAX_ACL_TAG_SIZE 64 584 char acl_tag[MAX_ACL_TAG_SIZE]; 585 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */ 586 atomic_t acl_pr_ref_count; 587 struct hlist_head lun_entry_hlist; 588 struct se_session *nacl_sess; 589 struct se_portal_group *se_tpg; 590 struct mutex lun_entry_mutex; 591 spinlock_t nacl_sess_lock; 592 struct config_group acl_group; 593 struct config_group acl_attrib_group; 594 struct config_group acl_auth_group; 595 struct config_group acl_param_group; 596 struct config_group acl_fabric_stat_group; 597 struct list_head acl_list; 598 struct list_head acl_sess_list; 599 struct completion acl_free_comp; 600 struct kref acl_kref; 601 }; 602 603 static inline struct se_node_acl *acl_to_nacl(struct config_item *item) 604 { 605 return container_of(to_config_group(item), struct se_node_acl, 606 acl_group); 607 } 608 609 static inline struct se_node_acl *attrib_to_nacl(struct config_item *item) 610 { 611 return container_of(to_config_group(item), struct se_node_acl, 612 acl_attrib_group); 613 } 614 615 static inline struct se_node_acl *auth_to_nacl(struct config_item *item) 616 { 617 return container_of(to_config_group(item), struct se_node_acl, 618 acl_auth_group); 619 } 620 621 static inline struct se_node_acl *param_to_nacl(struct config_item *item) 622 { 623 return container_of(to_config_group(item), struct se_node_acl, 624 acl_param_group); 625 } 626 627 static inline struct se_node_acl *fabric_stat_to_nacl(struct config_item *item) 628 { 629 return container_of(to_config_group(item), struct se_node_acl, 630 acl_fabric_stat_group); 631 } 632 633 struct target_cmd_counter { 634 struct percpu_ref refcnt; 635 wait_queue_head_t refcnt_wq; 636 struct completion stop_done; 637 atomic_t stopped; 638 }; 639 640 struct se_session { 641 u64 sess_bin_isid; 642 enum target_prot_op sup_prot_ops; 643 enum target_prot_type sess_prot_type; 644 struct se_node_acl *se_node_acl; 645 struct se_portal_group *se_tpg; 646 void *fabric_sess_ptr; 647 struct list_head sess_list; 648 struct list_head sess_acl_list; 649 spinlock_t sess_cmd_lock; 650 void *sess_cmd_map; 651 struct sbitmap_queue sess_tag_pool; 652 struct target_cmd_counter *cmd_cnt; 653 }; 654 655 struct se_device; 656 struct se_transform_info; 657 struct scatterlist; 658 659 struct se_ml_stat_grps { 660 struct config_group stat_group; 661 struct config_group scsi_auth_intr_group; 662 struct config_group scsi_att_intr_port_group; 663 }; 664 665 struct se_lun_acl { 666 u64 mapped_lun; 667 struct se_node_acl *se_lun_nacl; 668 struct se_lun *se_lun; 669 struct config_group se_lun_group; 670 struct se_ml_stat_grps ml_stat_grps; 671 }; 672 673 struct se_dev_entry_io_stats { 674 u32 total_cmds; 675 u32 read_bytes; 676 u32 write_bytes; 677 }; 678 679 struct se_dev_entry { 680 u64 mapped_lun; 681 u64 pr_res_key; 682 u64 creation_time; 683 bool lun_access_ro; 684 u32 attach_count; 685 struct se_dev_entry_io_stats __percpu *stats; 686 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */ 687 struct kref pr_kref; 688 struct completion pr_comp; 689 struct se_lun_acl *se_lun_acl; 690 spinlock_t ua_lock; 691 struct se_lun *se_lun; 692 #define DEF_PR_REG_ACTIVE 1 693 unsigned long deve_flags; 694 struct list_head alua_port_list; 695 struct list_head lun_link; 696 struct list_head ua_list; 697 struct hlist_node link; 698 struct rcu_head rcu_head; 699 }; 700 701 struct se_dev_attrib { 702 bool emulate_model_alias; 703 bool emulate_dpo; /* deprecated */ 704 bool emulate_fua_write; 705 bool emulate_fua_read; /* deprecated */ 706 bool emulate_write_cache; 707 enum target_ua_intlck_ctrl emulate_ua_intlck_ctrl; 708 bool emulate_tas; 709 bool emulate_tpu; 710 bool emulate_tpws; 711 bool emulate_caw; 712 bool emulate_3pc; 713 bool emulate_pr; 714 bool emulate_rsoc; 715 enum target_prot_type pi_prot_type; 716 enum target_prot_type hw_pi_prot_type; 717 bool pi_prot_verify; 718 bool enforce_pr_isids; 719 bool force_pr_aptpl; 720 bool is_nonrot; 721 bool emulate_rest_reord; 722 bool unmap_zeroes_data; 723 u32 hw_block_size; 724 u32 block_size; 725 u32 hw_max_sectors; 726 u32 optimal_sectors; 727 u32 hw_queue_depth; 728 u32 queue_depth; 729 u32 max_unmap_lba_count; 730 u32 max_unmap_block_desc_count; 731 u32 unmap_granularity; 732 u32 unmap_granularity_alignment; 733 u32 max_write_same_len; 734 u8 submit_type; 735 struct se_device *da_dev; 736 struct config_group da_group; 737 }; 738 739 struct se_port_stat_grps { 740 struct config_group stat_group; 741 struct config_group scsi_port_group; 742 struct config_group scsi_tgt_port_group; 743 struct config_group scsi_transport_group; 744 }; 745 746 struct scsi_port_stats { 747 atomic_long_t cmd_pdus; 748 atomic_long_t tx_data_octets; 749 atomic_long_t rx_data_octets; 750 }; 751 752 struct se_lun { 753 u64 unpacked_lun; 754 bool lun_shutdown; 755 bool lun_access_ro; 756 u32 lun_index; 757 758 atomic_t lun_acl_count; 759 struct se_device __rcu *lun_se_dev; 760 761 struct list_head lun_deve_list; 762 spinlock_t lun_deve_lock; 763 764 /* ALUA state */ 765 int lun_tg_pt_secondary_stat; 766 int lun_tg_pt_secondary_write_md; 767 atomic_t lun_tg_pt_secondary_offline; 768 struct mutex lun_tg_pt_md_mutex; 769 770 /* ALUA target port group linkage */ 771 struct list_head lun_tg_pt_gp_link; 772 struct t10_alua_tg_pt_gp __rcu *lun_tg_pt_gp; 773 spinlock_t lun_tg_pt_gp_lock; 774 775 struct se_portal_group *lun_tpg; 776 struct scsi_port_stats lun_stats; 777 struct config_group lun_group; 778 struct se_port_stat_grps port_stat_grps; 779 struct completion lun_shutdown_comp; 780 struct percpu_ref lun_ref; 781 struct list_head lun_dev_link; 782 struct hlist_node link; 783 struct rcu_head rcu_head; 784 }; 785 786 struct se_dev_stat_grps { 787 struct config_group stat_group; 788 struct config_group scsi_dev_group; 789 struct config_group scsi_tgt_dev_group; 790 struct config_group scsi_lu_group; 791 }; 792 793 struct se_cmd_queue { 794 struct llist_head cmd_list; 795 struct work_struct work; 796 }; 797 798 struct se_dev_plug { 799 struct se_device *se_dev; 800 }; 801 802 struct se_device_queue { 803 struct list_head state_list; 804 spinlock_t lock; 805 struct se_cmd_queue sq; 806 }; 807 808 struct se_dev_io_stats { 809 u32 total_cmds; 810 u32 read_bytes; 811 u32 write_bytes; 812 }; 813 814 struct se_device { 815 /* Used for SAM Task Attribute ordering */ 816 u32 dev_cur_ordered_id; 817 u32 dev_flags; 818 #define DF_CONFIGURED 0x00000001 819 #define DF_FIRMWARE_VPD_UNIT_SERIAL 0x00000002 820 #define DF_EMULATED_VPD_UNIT_SERIAL 0x00000004 821 #define DF_USING_UDEV_PATH 0x00000008 822 #define DF_USING_ALIAS 0x00000010 823 #define DF_READ_ONLY 0x00000020 824 u8 transport_flags; 825 /* Physical device queue depth */ 826 u32 queue_depth; 827 /* Used for SPC-2 reservations enforce of ISIDs */ 828 u64 dev_res_bin_isid; 829 /* Pointer to transport specific device structure */ 830 u32 dev_index; 831 u64 creation_time; 832 atomic_long_t num_resets; 833 atomic_long_t aborts_complete; 834 atomic_long_t aborts_no_task; 835 struct se_dev_io_stats __percpu *stats; 836 /* Active commands on this virtual SE device */ 837 struct percpu_ref non_ordered; 838 bool ordered_sync_in_progress; 839 atomic_t dev_qf_count; 840 u32 export_count; 841 spinlock_t delayed_cmd_lock; 842 spinlock_t dev_reservation_lock; 843 unsigned int dev_reservation_flags; 844 #define DRF_SPC2_RESERVATIONS 0x00000001 845 #define DRF_SPC2_RESERVATIONS_WITH_ISID 0x00000002 846 spinlock_t se_port_lock; 847 spinlock_t se_tmr_lock; 848 spinlock_t qf_cmd_lock; 849 struct semaphore caw_sem; 850 /* Used for legacy SPC-2 reservations */ 851 struct se_session *reservation_holder; 852 /* Used for ALUA Logical Unit Group membership */ 853 struct t10_alua_lu_gp_member *dev_alua_lu_gp_mem; 854 /* Used for SPC-3 Persistent Reservations */ 855 struct t10_pr_registration *dev_pr_res_holder; 856 struct list_head dev_sep_list; 857 struct list_head dev_tmr_list; 858 struct work_struct qf_work_queue; 859 struct work_struct delayed_cmd_work; 860 struct list_head delayed_cmd_list; 861 struct list_head qf_cmd_list; 862 /* Pointer to associated SE HBA */ 863 struct se_hba *se_hba; 864 /* T10 Inquiry and VPD WWN Information */ 865 struct t10_wwn t10_wwn; 866 /* T10 Asymmetric Logical Unit Assignment for Target Ports */ 867 struct t10_alua t10_alua; 868 /* T10 SPC-2 + SPC-3 Reservations */ 869 struct t10_reservation t10_pr; 870 struct se_dev_attrib dev_attrib; 871 struct config_group dev_action_group; 872 struct config_group dev_group; 873 struct config_group dev_pr_group; 874 struct se_dev_stat_grps dev_stat_grps; 875 #define SE_DEV_ALIAS_LEN 512 /* must be less than PAGE_SIZE */ 876 unsigned char dev_alias[SE_DEV_ALIAS_LEN]; 877 #define SE_UDEV_PATH_LEN 512 /* must be less than PAGE_SIZE */ 878 unsigned char udev_path[SE_UDEV_PATH_LEN]; 879 /* Pointer to template of function pointers for transport */ 880 const struct target_backend_ops *transport; 881 struct se_lun xcopy_lun; 882 /* Protection Information */ 883 int prot_length; 884 /* For se_lun->lun_se_dev RCU read-side critical access */ 885 u32 hba_index; 886 struct rcu_head rcu_head; 887 int queue_cnt; 888 struct se_device_queue *queues; 889 struct mutex lun_reset_mutex; 890 }; 891 892 struct target_opcode_descriptor { 893 u8 support:3; 894 u8 serv_action_valid:1; 895 u8 opcode; 896 u16 service_action; 897 u32 cdb_size; 898 u8 specific_timeout; 899 u16 nominal_timeout; 900 u16 recommended_timeout; 901 bool (*enabled)(const struct target_opcode_descriptor *descr, 902 struct se_cmd *cmd); 903 void (*update_usage_bits)(u8 *usage_bits, 904 struct se_device *dev); 905 u8 usage_bits[]; 906 }; 907 908 struct se_hba { 909 u16 hba_tpgt; 910 u32 hba_id; 911 /* See hba_flags_table */ 912 u32 hba_flags; 913 /* Virtual iSCSI devices attached. */ 914 u32 dev_count; 915 u32 hba_index; 916 /* Pointer to transport specific host structure. */ 917 void *hba_ptr; 918 struct list_head hba_node; 919 spinlock_t device_lock; 920 struct config_group hba_group; 921 struct mutex hba_access_mutex; 922 struct target_backend *backend; 923 }; 924 925 struct se_tpg_np { 926 struct se_portal_group *tpg_np_parent; 927 struct config_group tpg_np_group; 928 }; 929 930 static inline struct se_tpg_np *to_tpg_np(struct config_item *item) 931 { 932 return container_of(to_config_group(item), struct se_tpg_np, 933 tpg_np_group); 934 } 935 936 struct se_portal_group { 937 /* 938 * PROTOCOL IDENTIFIER value per SPC4, 7.5.1. 939 * 940 * Negative values can be used by fabric drivers for internal use TPGs. 941 */ 942 int proto_id; 943 bool enabled; 944 /* RELATIVE TARGET PORT IDENTIFIER */ 945 u16 tpg_rtpi; 946 bool rtpi_manual; 947 /* Used for PR SPEC_I_PT=1 and REGISTER_AND_MOVE */ 948 atomic_t tpg_pr_ref_count; 949 /* Spinlock for adding/removing ACLed Nodes */ 950 struct mutex acl_node_mutex; 951 /* Spinlock for adding/removing sessions */ 952 spinlock_t session_lock; 953 struct mutex tpg_lun_mutex; 954 /* linked list for initiator ACL list */ 955 struct list_head acl_node_list; 956 struct hlist_head tpg_lun_hlist; 957 struct se_lun *tpg_virt_lun0; 958 /* List of TCM sessions associated wth this TPG */ 959 struct list_head tpg_sess_list; 960 /* Pointer to $FABRIC_MOD dependent code */ 961 const struct target_core_fabric_ops *se_tpg_tfo; 962 struct se_wwn *se_tpg_wwn; 963 struct config_group tpg_group; 964 struct config_group tpg_lun_group; 965 struct config_group tpg_np_group; 966 struct config_group tpg_acl_group; 967 struct config_group tpg_attrib_group; 968 struct config_group tpg_auth_group; 969 struct config_group tpg_param_group; 970 }; 971 972 static inline struct se_portal_group *to_tpg(struct config_item *item) 973 { 974 return container_of(to_config_group(item), struct se_portal_group, 975 tpg_group); 976 } 977 978 static inline struct se_portal_group *attrib_to_tpg(struct config_item *item) 979 { 980 return container_of(to_config_group(item), struct se_portal_group, 981 tpg_attrib_group); 982 } 983 984 static inline struct se_portal_group *auth_to_tpg(struct config_item *item) 985 { 986 return container_of(to_config_group(item), struct se_portal_group, 987 tpg_auth_group); 988 } 989 990 static inline struct se_portal_group *param_to_tpg(struct config_item *item) 991 { 992 return container_of(to_config_group(item), struct se_portal_group, 993 tpg_param_group); 994 } 995 996 enum { 997 /* Use se_cmd's cpuid for completion */ 998 SE_COMPL_AFFINITY_CPUID = -1, 999 /* Complete on current CPU */ 1000 SE_COMPL_AFFINITY_CURR_CPU = -2, 1001 }; 1002 1003 struct se_wwn { 1004 struct target_fabric_configfs *wwn_tf; 1005 void *priv; 1006 struct config_group wwn_group; 1007 struct config_group fabric_stat_group; 1008 struct config_group param_group; 1009 int cmd_compl_affinity; 1010 }; 1011 1012 static inline void atomic_inc_mb(atomic_t *v) 1013 { 1014 smp_mb__before_atomic(); 1015 atomic_inc(v); 1016 smp_mb__after_atomic(); 1017 } 1018 1019 static inline void atomic_dec_mb(atomic_t *v) 1020 { 1021 smp_mb__before_atomic(); 1022 atomic_dec(v); 1023 smp_mb__after_atomic(); 1024 } 1025 1026 static inline void target_free_tag(struct se_session *sess, struct se_cmd *cmd) 1027 { 1028 sbitmap_queue_clear(&sess->sess_tag_pool, cmd->map_tag, cmd->map_cpu); 1029 } 1030 1031 #endif /* TARGET_CORE_BASE_H */ 1032