830 lines · 24.3 KB · C
RawDownload
#ifndef TARGET_CORE_BASE_H#define TARGET_CORE_BASE_H #include <linux/in.h>#include <linux/configfs.h>#include <linux/dma-mapping.h>#include <linux/blkdev.h>#include <linux/percpu_ida.h>#include <scsi/scsi_cmnd.h>#include <net/sock.h>#include <net/tcp.h> #define TARGET_CORE_MOD_VERSION		"v4.1.0"#define TARGET_CORE_VERSION		TARGET_CORE_MOD_VERSION /* Maximum Number of LUNs per Target Portal Group *//* Don't raise above 511 or REPORT_LUNS needs to handle >1 page */#define TRANSPORT_MAX_LUNS_PER_TPG		256/* * By default we use 32-byte CDBs in TCM Core and subsystem plugin code. * * Note that both include/scsi/scsi_cmnd.h:MAX_COMMAND_SIZE and * include/linux/blkdev.h:BLOCK_MAX_CDB as of v2.6.36-rc4 still use * 16-byte CDBs by default and require an extra allocation for * 32-byte CDBs to because of legacy issues. * * Within TCM Core there are no such legacy limitiations, so we go ahead * use 32-byte CDBs by default and use include/scsi/scsi.h:scsi_command_size() * within all TCM Core and subsystem plugin code. */#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			SCSI_SENSE_BUFFERSIZE/* Used by transport_send_check_condition_and_sense() */#define SPC_SENSE_KEY_OFFSET			2#define SPC_ADD_SENSE_LEN_OFFSET		7#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 max_write_same_len, disabled by default */#define DA_MAX_WRITE_SAME_LEN			0/* Default max transfer length */#define DA_FABRIC_MAX_SECTORS			8192/* Use a model alias based on the configfs backend device name */#define DA_EMULATE_MODEL_ALIAS			0/* Emulation for Direct Page Out */#define DA_EMULATE_DPO				0/* Emulation for Forced Unit Access WRITEs */#define DA_EMULATE_FUA_WRITE			1/* Emulation for Forced Unit Access READs */#define DA_EMULATE_FUA_READ			0/* Emulation for WriteCache and SYNCHRONIZE_CACHE */#define DA_EMULATE_WRITE_CACHE			0/* Emulation for UNIT ATTENTION Interlock Control */#define DA_EMULATE_UA_INTLLCK_CTRL		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/* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */#define DA_ENFORCE_PR_ISIDS			1#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				512#define SE_MODE_PAGE_BUF			512#define SE_SENSE_BUF				96 /* struct se_hba->hba_flags */enum hba_flags_table {	HBA_FLAGS_INTERNAL_USE	= 0x01,	HBA_FLAGS_PSCSI_MODE	= 0x02,}; /* struct se_lun->lun_status */enum transport_lun_status_table {	TRANSPORT_LUN_STATUS_FREE = 0,	TRANSPORT_LUN_STATUS_ACTIVE = 1,}; /* struct se_portal_group->se_tpg_type */enum transport_tpg_type_table {	TRANSPORT_TPG_TYPE_NORMAL = 0,	TRANSPORT_TPG_TYPE_DISCOVERY = 1,}; /* 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,}; /* Used for struct se_cmd->se_cmd_flags */enum se_cmd_flags_table {	SCF_SUPPORTED_SAM_OPCODE	= 0x00000001,	SCF_TRANSPORT_TASK_SENSE	= 0x00000002,	SCF_EMULATED_TASK_SENSE		= 0x00000004,	SCF_SCSI_DATA_CDB		= 0x00000008,	SCF_SCSI_TMR_CDB		= 0x00000010,	SCF_FUA				= 0x00000080,	SCF_SE_LUN_CMD			= 0x00000100,	SCF_BIDI			= 0x00000400,	SCF_SENT_CHECK_CONDITION	= 0x00000800,	SCF_OVERFLOW_BIT		= 0x00001000,	SCF_UNDERFLOW_BIT		= 0x00002000,	SCF_SENT_DELAYED_TAS		= 0x00004000,	SCF_ALUA_NON_OPTIMIZED		= 0x00008000,	SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC = 0x00020000,	SCF_ACK_KREF			= 0x00040000,	SCF_COMPARE_AND_WRITE		= 0x00080000,	SCF_COMPARE_AND_WRITE_POST	= 0x00100000,	SCF_CMD_XCOPY_PASSTHROUGH	= 0x00200000,}; /* struct se_dev_entry->lun_flags and struct se_lun->lun_access */enum transport_lunflags_table {	TRANSPORT_LUNFLAGS_NO_ACCESS		= 0x00,	TRANSPORT_LUNFLAGS_INITIATOR_ACCESS	= 0x01,	TRANSPORT_LUNFLAGS_READ_ONLY		= 0x02,	TRANSPORT_LUNFLAGS_READ_WRITE		= 0x04,}; /* * 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_CHECK_CONDITION_NOT_READY		= R(0x0f),	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),#undef R}; enum target_sc_flags_table {	TARGET_SCF_BIDI_OP		= 0x01,	TARGET_SCF_ACK_KREF		= 0x02,	TARGET_SCF_UNKNOWN_SIZE		= 0x04,}; /* 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,}; /* 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_DEVICE_INDEX,	SCSI_AUTH_INTR_INDEX,	SCSI_INDEX_TYPE_MAX} scsi_index_t; struct se_cmd; struct t10_alua {	/* ALUA Target Port Group ID */	u16	alua_tg_pt_gps_counter;	u32	alua_tg_pt_gps_count;	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;	/* Used by struct t10_alua_tg_pt_gp->tg_pt_gp_md_buf_len */#define ALUA_MD_BUF_LEN				1024	u32	tg_pt_gp_md_buf_len;	u32	tg_pt_gp_members;	atomic_t tg_pt_gp_alua_access_state;	atomic_t tg_pt_gp_ref_cnt;	spinlock_t tg_pt_gp_lock;	struct mutex tg_pt_gp_md_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_mem_list;}; struct t10_alua_tg_pt_gp_member {	bool tg_pt_gp_assoc;	atomic_t tg_pt_gp_mem_ref_cnt;	spinlock_t tg_pt_gp_mem_lock;	struct t10_alua_tg_pt_gp *tg_pt_gp;	struct se_port *tg_pt;	struct list_head tg_pt_gp_mem_list;}; 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 {	char vendor[8];	char model[16];	char revision[4];	char unit_serial[INQUIRY_VPD_SERIAL_LEN];	spinlock_t t10_vpd_lock;	struct se_device *t10_dev;	struct config_group t10_wwn_group;	struct list_head t10_vpd_list;}; 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;	u32 pr_res_mapped_lun;	u32 pr_aptpl_target_lun;	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;	struct se_dev_entry *pr_reg_deve;	struct se_lun *pr_reg_tg_pt_lun;	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			8192	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 */	u32			ref_task_tag;	void 			*fabric_tmr_ptr;	struct se_cmd		*task_cmd;	struct se_device	*tmr_dev;	struct se_lun		*tmr_lun;	struct list_head	tmr_list;}; struct se_cmd {	/* SAM response code being sent to initiator */	u8			scsi_status;	u8			scsi_asc;	u8			scsi_ascq;	u16			scsi_sense_length;	/* 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;	/* Transport protocol dependent state, see transport_state_table */	enum transport_state_table t_state;	unsigned		cmd_wait_set:1;	unsigned		unknown_data_length:1;	/* See se_cmd_flags_table */	u32			se_cmd_flags;	u32			se_ordered_id;	/* Total size in bytes associated with command */	u32			data_length;	u32			residual_count;	u32			orig_fe_lun;	/* Persistent Reservation key */	u64			pr_res_key;	/* Used for sense data */	void			*sense_buffer;	struct list_head	se_delayed_node;	struct list_head	se_qf_node;	struct se_device      *se_dev;	struct se_dev_entry   *se_deve;	struct se_lun		*se_lun;	/* Only used for internal passthrough and legacy TCM fabric modules */	struct se_session	*se_sess;	struct se_tmr_req	*se_tmr_req;	struct list_head	se_cmd_list;	struct completion	cmd_wait_comp;	struct kref		cmd_kref;	struct target_core_fabric_ops *se_tfo;	sense_reason_t		(*execute_cmd)(struct se_cmd *);	sense_reason_t		(*execute_rw)(struct se_cmd *, struct scatterlist *,					      u32, enum dma_data_direction);	sense_reason_t (*transport_complete_callback)(struct se_cmd *); 	unsigned char		*t_task_cdb;	unsigned char		__t_task_cdb[TCM_MAX_COMMAND_SIZE];	unsigned long long	t_task_lba;	unsigned int		t_task_nolb;	unsigned int		transport_state;#define CMD_T_ABORTED		(1 << 0)#define CMD_T_ACTIVE		(1 << 1)#define CMD_T_COMPLETE		(1 << 2)#define CMD_T_SENT		(1 << 4)#define CMD_T_STOP		(1 << 5)#define CMD_T_FAILED		(1 << 6)#define CMD_T_DEV_ACTIVE	(1 << 7)#define CMD_T_REQUEST_STOP	(1 << 8)#define CMD_T_BUSY		(1 << 9)	spinlock_t		t_state_lock;	struct completion	t_transport_stop_comp; 	struct work_struct	work; 	struct scatterlist	*t_data_sg;	struct scatterlist	*t_data_sg_orig;	unsigned int		t_data_nents;	unsigned int		t_data_nents_orig;	void			*t_data_vmap;	struct scatterlist	*t_bidi_data_sg;	unsigned int		t_bidi_data_nents; 	struct list_head	state_list;	bool			state_active; 	/* old task stop completion, consider merging with some of the above */	struct completion	task_stop_comp; 	/* backend private data */	void			*priv; 	/* Used for lun->lun_ref counting */	bool			lun_ref_active;

Lines 1–500 of 830.