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