1048 lines · 29.4 KB · C
RawDownload
/* SPDX-License-Identifier: GPL-2.0 */#ifndef TARGET_CORE_BASE_H#define TARGET_CORE_BASE_H #include <linux/configfs.h>      /* struct config_group */#include <linux/dma-direction.h> /* enum dma_data_direction */#include <linux/sbitmap.h>#include <linux/percpu-refcount.h>#include <linux/semaphore.h>     /* struct semaphore */#include <linux/completion.h>#include <scsi/scsi_common.h> #define TARGET_CORE_VERSION		"v5.0" /* * Maximum size of a CDB that can be stored in se_cmd without allocating * memory dynamically for the CDB. */#define TCM_MAX_COMMAND_SIZE			32/* * From include/scsi/scsi_cmnd.h:SCSI_SENSE_BUFFERSIZE, currently * defined 96, but the real limit is 252 (or 260 including the header) */#define TRANSPORT_SENSE_BUFFER			96/* Used by transport_send_check_condition_and_sense() */#define SPC_SENSE_KEY_OFFSET			2#define SPC_ADD_SENSE_LEN_OFFSET		7#define SPC_DESC_TYPE_OFFSET			8#define SPC_ADDITIONAL_DESC_LEN_OFFSET		9#define SPC_VALIDITY_OFFSET			10#define SPC_ASC_KEY_OFFSET			12#define SPC_ASCQ_KEY_OFFSET			13#define TRANSPORT_IQN_LEN			224/* Used by target_core_store_alua_lu_gp() and target_core_alua_lu_gp_show_attr_members() */#define LU_GROUP_NAME_BUF			256/* Used by core_alua_store_tg_pt_gp_info() and target_core_alua_tg_pt_gp_show_attr_members() */#define TG_PT_GROUP_NAME_BUF			256/* Used to parse VPD into struct t10_vpd */#define VPD_TMP_BUF_SIZE			254/* Used by transport_generic_cmd_sequencer() */#define READ_BLOCK_LEN          		6#define READ_CAP_LEN            		8#define READ_POSITION_LEN       		20#define INQUIRY_LEN				36/* Used by transport_get_inquiry_vpd_serial() */#define INQUIRY_VPD_SERIAL_LEN			254/* Used by transport_get_inquiry_vpd_device_ident() */#define INQUIRY_VPD_DEVICE_IDENTIFIER_LEN	254 /* Attempts before moving from SHORT to LONG */#define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD	3#define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT	3  /* In milliseconds */#define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG	10 /* In milliseconds */ #define PYX_TRANSPORT_STATUS_INTERVAL		5 /* In seconds */ /* struct se_dev_attrib sanity values *//* Default max_unmap_lba_count */#define DA_MAX_UNMAP_LBA_COUNT			0/* Default max_unmap_block_desc_count */#define DA_MAX_UNMAP_BLOCK_DESC_COUNT		0/* Default unmap_granularity */#define DA_UNMAP_GRANULARITY_DEFAULT		0/* Default unmap_granularity_alignment */#define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT	0/* Default unmap_zeroes_data */#define DA_UNMAP_ZEROES_DATA_DEFAULT		0/* Default max_write_same_len, disabled by default */#define DA_MAX_WRITE_SAME_LEN			0/* Use a model alias based on the configfs backend device name */#define DA_EMULATE_MODEL_ALIAS			0/* Emulation for WriteCache and SYNCHRONIZE_CACHE */#define DA_EMULATE_WRITE_CACHE			0/* Emulation for TASK_ABORTED status (TAS) by default */#define DA_EMULATE_TAS				1/* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */#define DA_EMULATE_TPU				0/* * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using * block/blk-lib.c:blkdev_issue_discard() */#define DA_EMULATE_TPWS				0/* Emulation for CompareAndWrite (AtomicTestandSet) by default */#define DA_EMULATE_CAW				1/* Emulation for 3rd Party Copy (ExtendedCopy) by default */#define DA_EMULATE_3PC				1/* No Emulation for PSCSI by default */#define DA_EMULATE_ALUA				0/* Emulate SCSI2 RESERVE/RELEASE and Persistent Reservations by default */#define DA_EMULATE_PR				1/* Emulation for REPORT SUPPORTED OPERATION CODES */#define DA_EMULATE_RSOC				1/* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */#define DA_ENFORCE_PR_ISIDS			1/* Force SPC-3 PR Activate Persistence across Target Power Loss */#define DA_FORCE_PR_APTPL			0#define DA_STATUS_MAX_SECTORS_MIN		16#define DA_STATUS_MAX_SECTORS_MAX		8192/* By default don't report non-rotating (solid state) medium */#define DA_IS_NONROT				0/* Queue Algorithm Modifier default for restricted reordering in control mode page */#define DA_EMULATE_REST_REORD			0 #define SE_INQUIRY_BUF				1024#define SE_MODE_PAGE_BUF			512#define SE_SENSE_BUF				96 /* Peripheral Device Text Identification Information */#define PD_TEXT_ID_INFO_LEN			256 enum target_compl_type {	/* Use the fabric driver's default completion type */	TARGET_FABRIC_DEFAULT_COMPL,	/* Complete from the backend calling context */	TARGET_DIRECT_COMPL,	/* Defer completion to the LIO workqueue */	TARGET_QUEUE_COMPL,}; enum target_submit_type {	/* Use the fabric driver's default submission type */	TARGET_FABRIC_DEFAULT_SUBMIT,	/* Submit from the calling context */	TARGET_DIRECT_SUBMIT,	/* Defer submission to the LIO workqueue */	TARGET_QUEUE_SUBMIT,}; /* struct se_hba->hba_flags */enum hba_flags_table {	HBA_FLAGS_INTERNAL_USE	= 0x01,	HBA_FLAGS_PSCSI_MODE	= 0x02,}; /* Special transport agnostic struct se_cmd->t_states */enum transport_state_table {	TRANSPORT_NO_STATE	= 0,	TRANSPORT_NEW_CMD	= 1,	TRANSPORT_WRITE_PENDING	= 3,	TRANSPORT_PROCESSING	= 5,	TRANSPORT_COMPLETE	= 6,	TRANSPORT_ISTATE_PROCESSING = 11,	TRANSPORT_COMPLETE_QF_WP = 18,	TRANSPORT_COMPLETE_QF_OK = 19,	TRANSPORT_COMPLETE_QF_ERR = 20,}; /* Used for struct se_cmd->se_cmd_flags */enum se_cmd_flags_table {	SCF_SUPPORTED_SAM_OPCODE		= (1 << 0),	SCF_TRANSPORT_TASK_SENSE		= (1 << 1),	SCF_EMULATED_TASK_SENSE			= (1 << 2),	SCF_SCSI_DATA_CDB			= (1 << 3),	SCF_SCSI_TMR_CDB			= (1 << 4),	SCF_FUA					= (1 << 5),	SCF_SE_LUN_CMD				= (1 << 6),	SCF_BIDI				= (1 << 7),	SCF_SENT_CHECK_CONDITION		= (1 << 8),	SCF_OVERFLOW_BIT			= (1 << 9),	SCF_UNDERFLOW_BIT			= (1 << 10),	SCF_ALUA_NON_OPTIMIZED			= (1 << 11),	SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC	= (1 << 12),	SCF_COMPARE_AND_WRITE			= (1 << 13),	SCF_PASSTHROUGH_PROT_SG_TO_MEM_NOALLOC	= (1 << 14),	SCF_ACK_KREF				= (1 << 15),	SCF_USE_CPUID				= (1 << 16),	SCF_TASK_ATTR_SET			= (1 << 17),	SCF_TREAT_READ_AS_NORMAL		= (1 << 18),	SCF_TASK_ORDERED_SYNC			= (1 << 19),	SCF_ATOMIC				= (1 << 20),}; /* * Used by transport_send_check_condition_and_sense() * to signal which ASC/ASCQ sense payload should be built. */typedef unsigned __bitwise sense_reason_t; enum tcm_sense_reason_table {#define R(x)	(__force sense_reason_t )(x)	TCM_NO_SENSE				= R(0x00),	TCM_NON_EXISTENT_LUN			= R(0x01),	TCM_UNSUPPORTED_SCSI_OPCODE		= R(0x02),	TCM_INCORRECT_AMOUNT_OF_DATA		= R(0x03),	TCM_UNEXPECTED_UNSOLICITED_DATA		= R(0x04),	TCM_SERVICE_CRC_ERROR			= R(0x05),	TCM_SNACK_REJECTED			= R(0x06),	TCM_SECTOR_COUNT_TOO_MANY		= R(0x07),	TCM_INVALID_CDB_FIELD			= R(0x08),	TCM_INVALID_PARAMETER_LIST		= R(0x09),	TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE	= R(0x0a),	TCM_UNKNOWN_MODE_PAGE			= R(0x0b),	TCM_WRITE_PROTECTED			= R(0x0c),	TCM_CHECK_CONDITION_ABORT_CMD		= R(0x0d),	TCM_CHECK_CONDITION_UNIT_ATTENTION	= R(0x0e), 	TCM_RESERVATION_CONFLICT		= R(0x10),	TCM_ADDRESS_OUT_OF_RANGE		= R(0x11),	TCM_OUT_OF_RESOURCES			= R(0x12),	TCM_PARAMETER_LIST_LENGTH_ERROR		= R(0x13),	TCM_MISCOMPARE_VERIFY			= R(0x14),	TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED	= R(0x15),	TCM_LOGICAL_BLOCK_APP_TAG_CHECK_FAILED	= R(0x16),	TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED	= R(0x17),	TCM_COPY_TARGET_DEVICE_NOT_REACHABLE	= R(0x18),	TCM_TOO_MANY_TARGET_DESCS		= R(0x19),	TCM_UNSUPPORTED_TARGET_DESC_TYPE_CODE	= R(0x1a),	TCM_TOO_MANY_SEGMENT_DESCS		= R(0x1b),	TCM_UNSUPPORTED_SEGMENT_DESC_TYPE_CODE	= R(0x1c),	TCM_INSUFFICIENT_REGISTRATION_RESOURCES	= R(0x1d),	TCM_LUN_BUSY				= R(0x1e),	TCM_INVALID_FIELD_IN_COMMAND_IU         = R(0x1f),	TCM_ALUA_TG_PT_STANDBY			= R(0x20),	TCM_ALUA_TG_PT_UNAVAILABLE		= R(0x21),	TCM_ALUA_STATE_TRANSITION		= R(0x22),	TCM_ALUA_OFFLINE			= R(0x23),#undef R}; enum target_sc_flags_table {	TARGET_SCF_BIDI_OP		= 0x01,	TARGET_SCF_ACK_KREF		= 0x02,	TARGET_SCF_UNKNOWN_SIZE		= 0x04,	TARGET_SCF_USE_CPUID		= 0x08,}; /* fabric independent task management function values */enum tcm_tmreq_table {	TMR_ABORT_TASK		= 1,	TMR_ABORT_TASK_SET	= 2,	TMR_CLEAR_ACA		= 3,	TMR_CLEAR_TASK_SET	= 4,	TMR_LUN_RESET		= 5,	TMR_TARGET_WARM_RESET	= 6,	TMR_TARGET_COLD_RESET	= 7,	TMR_LUN_RESET_PRO	= 0x80,	TMR_UNKNOWN		= 0xff,}; /* fabric independent task management response values */enum tcm_tmrsp_table {	TMR_FUNCTION_FAILED		= 0,	TMR_FUNCTION_COMPLETE		= 1,	TMR_TASK_DOES_NOT_EXIST		= 2,	TMR_LUN_DOES_NOT_EXIST		= 3,	TMR_TASK_MGMT_FUNCTION_NOT_SUPPORTED	= 4,	TMR_FUNCTION_REJECTED		= 5,}; /* * Used for target SCSI statistics */typedef enum {	SCSI_INST_INDEX,	SCSI_AUTH_INTR_INDEX,	SCSI_INDEX_TYPE_MAX} scsi_index_t; struct se_cmd; struct t10_alua_lba_map_member {	struct list_head lba_map_mem_list;	int lba_map_mem_alua_state;	int lba_map_mem_alua_pg_id;}; struct t10_alua_lba_map {	u64 lba_map_first_lba;	u64 lba_map_last_lba;	struct list_head lba_map_list;	struct list_head lba_map_mem_list;}; struct t10_alua {	/* ALUA Target Port Group ID */	u16	alua_tg_pt_gps_counter;	u32	alua_tg_pt_gps_count;	/* Referrals support */	spinlock_t lba_map_lock;	u32     lba_map_segment_size;	u32     lba_map_segment_multiplier;	struct list_head lba_map_list;	spinlock_t tg_pt_gps_lock;	struct se_device *t10_dev;	/* Used for default ALUA Target Port Group */	struct t10_alua_tg_pt_gp *default_tg_pt_gp;	/* Used for default ALUA Target Port Group ConfigFS group */	struct config_group alua_tg_pt_gps_group;	struct list_head tg_pt_gps_list;}; struct t10_alua_lu_gp {	u16	lu_gp_id;	int	lu_gp_valid_id;	u32	lu_gp_members;	atomic_t lu_gp_ref_cnt;	spinlock_t lu_gp_lock;	struct config_group lu_gp_group;	struct list_head lu_gp_node;	struct list_head lu_gp_mem_list;}; struct t10_alua_lu_gp_member {	bool lu_gp_assoc;	atomic_t lu_gp_mem_ref_cnt;	spinlock_t lu_gp_mem_lock;	struct t10_alua_lu_gp *lu_gp;	struct se_device *lu_gp_mem_dev;	struct list_head lu_gp_mem_list;}; struct t10_alua_tg_pt_gp {	u16	tg_pt_gp_id;	int	tg_pt_gp_valid_id;	int	tg_pt_gp_alua_supported_states;	int	tg_pt_gp_alua_access_status;	int	tg_pt_gp_alua_access_type;	int	tg_pt_gp_nonop_delay_msecs;	int	tg_pt_gp_trans_delay_msecs;	int	tg_pt_gp_implicit_trans_secs;	int	tg_pt_gp_pref;	int	tg_pt_gp_write_metadata;	u32	tg_pt_gp_members;	int	tg_pt_gp_alua_access_state;	atomic_t tg_pt_gp_ref_cnt;	spinlock_t tg_pt_gp_lock;	struct mutex tg_pt_gp_transition_mutex;	struct se_device *tg_pt_gp_dev;	struct config_group tg_pt_gp_group;	struct list_head tg_pt_gp_list;	struct list_head tg_pt_gp_lun_list;	struct se_lun *tg_pt_gp_alua_lun;	struct se_node_acl *tg_pt_gp_alua_nacl;}; struct t10_vpd {	unsigned char device_identifier[INQUIRY_VPD_DEVICE_IDENTIFIER_LEN];	int protocol_identifier_set;	u32 protocol_identifier;	u32 device_identifier_code_set;	u32 association;	u32 device_identifier_type;	struct list_head vpd_list;}; struct t10_wwn {	/*	 * SCSI left aligned strings may not be null terminated. +1 to ensure a	 * null terminator is always present.	 */	char vendor[INQUIRY_VENDOR_LEN + 1];	char model[INQUIRY_MODEL_LEN + 1];	char revision[INQUIRY_REVISION_LEN + 1];	char unit_serial[INQUIRY_VPD_SERIAL_LEN];	u32 company_id;	spinlock_t t10_vpd_lock;	struct se_device *t10_dev;	struct config_group t10_wwn_group;	struct list_head t10_vpd_list;	char pd_text_id_info[PD_TEXT_ID_INFO_LEN];}; struct t10_pr_registration {	/* Used for fabrics that contain WWN+ISID */#define PR_REG_ISID_LEN				16	/* PR_REG_ISID_LEN + ',i,0x' */#define PR_REG_ISID_ID_LEN			(PR_REG_ISID_LEN + 5)	char pr_reg_isid[PR_REG_ISID_LEN];	/* Used during APTPL metadata reading */#define PR_APTPL_MAX_IPORT_LEN			256	unsigned char pr_iport[PR_APTPL_MAX_IPORT_LEN];	/* Used during APTPL metadata reading */#define PR_APTPL_MAX_TPORT_LEN			256	unsigned char pr_tport[PR_APTPL_MAX_TPORT_LEN];	u16 pr_aptpl_rpti;	u16 pr_reg_tpgt;	/* Reservation effects all target ports */	int pr_reg_all_tg_pt;	/* Activate Persistence across Target Power Loss */	int pr_reg_aptpl;	int pr_res_holder;	int pr_res_type;	int pr_res_scope;	/* Used for fabric initiator WWPNs using a ISID */	bool isid_present_at_reg;	u64 pr_res_mapped_lun;	u64 pr_aptpl_target_lun;	u16 tg_pt_sep_rtpi;	u32 pr_res_generation;	u64 pr_reg_bin_isid;	u64 pr_res_key;	atomic_t pr_res_holders;	struct se_node_acl *pr_reg_nacl;	/* Used by ALL_TG_PT=1 registration with deve->pr_ref taken */	struct se_dev_entry *pr_reg_deve;	struct list_head pr_reg_list;	struct list_head pr_reg_abort_list;	struct list_head pr_reg_aptpl_list;	struct list_head pr_reg_atp_list;	struct list_head pr_reg_atp_mem_list;}; struct t10_reservation {	/* Reservation effects all target ports */	int pr_all_tg_pt;	/* Activate Persistence across Target Power Loss enabled	 * for SCSI device */	int pr_aptpl_active;#define PR_APTPL_BUF_LEN			262144	u32 pr_generation;	spinlock_t registration_lock;	spinlock_t aptpl_reg_lock;	/*	 * This will always be set by one individual I_T Nexus.	 * However with all_tg_pt=1, other I_T Nexus from the	 * same initiator can access PR reg/res info on a different	 * target port.	 *	 * There is also the 'All Registrants' case, where there is	 * a single *pr_res_holder of the reservation, but all	 * registrations are considered reservation holders.	 */	struct se_node_acl *pr_res_holder;	struct list_head registration_list;	struct list_head aptpl_reg_list;}; struct se_tmr_req {	/* Task Management function to be performed */	u8			function;	/* Task Management response to send */	u8			response;	int			call_transport;	/* Reference to ITT that Task Mgmt should be performed */	u64			ref_task_tag;	void 			*fabric_tmr_ptr;	struct se_cmd		*task_cmd;	struct se_device	*tmr_dev;	struct list_head	tmr_list;}; enum target_prot_op {	TARGET_PROT_NORMAL	= 0,	TARGET_PROT_DIN_INSERT	= (1 << 0),	TARGET_PROT_DOUT_INSERT	= (1 << 1),	TARGET_PROT_DIN_STRIP	= (1 << 2),	TARGET_PROT_DOUT_STRIP	= (1 << 3),	TARGET_PROT_DIN_PASS	= (1 << 4),	TARGET_PROT_DOUT_PASS	= (1 << 5),}; #define TARGET_PROT_ALL	TARGET_PROT_DIN_INSERT | TARGET_PROT_DOUT_INSERT | \			TARGET_PROT_DIN_STRIP | TARGET_PROT_DOUT_STRIP | \			TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS enum target_prot_type {	TARGET_DIF_TYPE0_PROT,	TARGET_DIF_TYPE1_PROT,	TARGET_DIF_TYPE2_PROT,	TARGET_DIF_TYPE3_PROT,}; /* Emulation for UNIT ATTENTION Interlock Control */enum target_ua_intlck_ctrl {	TARGET_UA_INTLCK_CTRL_CLEAR = 0,	TARGET_UA_INTLCK_CTRL_NO_CLEAR = 1,	TARGET_UA_INTLCK_CTRL_ESTABLISH_UA = 2,}; enum target_core_dif_check {	TARGET_DIF_CHECK_GUARD  = 0x1 << 0,	TARGET_DIF_CHECK_APPTAG = 0x1 << 1,	TARGET_DIF_CHECK_REFTAG = 0x1 << 2,}; /* for sam_task_attr */#define TCM_SIMPLE_TAG	0x20#define TCM_HEAD_TAG	0x21#define TCM_ORDERED_TAG	0x22#define TCM_ACA_TAG	0x24 struct se_cmd {	/* Used for fail with specific sense codes */	sense_reason_t		sense_reason;	/* SAM response code being sent to initiator */	u8			scsi_status;	u16			scsi_sense_length;	unsigned		unknown_data_length:1;	bool			state_active:1;	u64			tag; /* SAM command identifier aka task tag */	/* Delay for ALUA Active/NonOptimized state access in milliseconds */	int			alua_nonop_delay;	/* See include/linux/dma-mapping.h */	enum dma_data_direction	data_direction;	/* For SAM Task Attribute */	int			sam_task_attr;	/* Used for se_sess->sess_tag_pool */	unsigned int		map_tag;	int			map_cpu;	/* Transport protocol dependent state, see transport_state_table */

Lines 1–500 of 1048.