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