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