[linux-2.6-block.git] / include / target / target_core_fabric.h

#ifndef TARGET_CORE_FABRIC_H
#define TARGET_CORE_FABRIC_H

struct target_core_fabric_ops {
	struct module *module;
	const char *name;
	size_t node_acl_size;
	/*
	 * Limits number of scatterlist entries per SCF_SCSI_DATA_CDB payload.
	 * Setting this value tells target-core to enforce this limit, and
	 * report as INQUIRY EVPD=b0 MAXIMUM TRANSFER LENGTH.
	 *
	 * target-core will currently reset se_cmd->data_length to this
	 * maximum size, and set UNDERFLOW residual count if length exceeds
	 * this limit.
	 *
	 * XXX: Not all initiator hosts honor this block-limit EVPD
	 * XXX: Currently assumes single PAGE_SIZE per scatterlist entry
	 */
	u32 max_data_sg_nents;
	char *(*get_fabric_name)(void);
	char *(*tpg_get_wwn)(struct se_portal_group *);
	u16 (*tpg_get_tag)(struct se_portal_group *);
	u32 (*tpg_get_default_depth)(struct se_portal_group *);
	int (*tpg_check_demo_mode)(struct se_portal_group *);
	int (*tpg_check_demo_mode_cache)(struct se_portal_group *);
	int (*tpg_check_demo_mode_write_protect)(struct se_portal_group *);
	int (*tpg_check_prod_mode_write_protect)(struct se_portal_group *);
	/*
	 * Optionally used by fabrics to allow demo-mode login, but not
	 * expose any TPG LUNs, and return 'not connected' in standard
	 * inquiry response
	 */
	int (*tpg_check_demo_mode_login_only)(struct se_portal_group *);
	/*
	 * Optionally used as a configfs tunable to determine when
	 * target-core should signal the PROTECT=1 feature bit for
	 * backends that don't support T10-PI, so that either fabric
	 * HW offload or target-core emulation performs the associated
	 * WRITE_STRIP and READ_INSERT operations.
	 */
	int (*tpg_check_prot_fabric_only)(struct se_portal_group *);
	u32 (*tpg_get_inst_index)(struct se_portal_group *);
	/*
	 * Optional to release struct se_cmd and fabric dependent allocated
	 * I/O descriptor in transport_cmd_check_stop().
	 *
	 * Returning 1 will signal a descriptor has been released.
	 * Returning 0 will signal a descriptor has not been released.
	 */
	int (*check_stop_free)(struct se_cmd *);
	void (*release_cmd)(struct se_cmd *);
	/*
	 * Called with spin_lock_bh(struct se_portal_group->session_lock held.
	 */
	int (*shutdown_session)(struct se_session *);
	void (*close_session)(struct se_session *);
	u32 (*sess_get_index)(struct se_session *);
	/*
	 * Used only for SCSI fabrics that contain multi-value TransportIDs
	 * (like iSCSI).  All other SCSI fabrics should set this to NULL.
	 */
	u32 (*sess_get_initiator_sid)(struct se_session *,
				      unsigned char *, u32);
	int (*write_pending)(struct se_cmd *);
	int (*write_pending_status)(struct se_cmd *);
	void (*set_default_node_attributes)(struct se_node_acl *);
	int (*get_cmd_state)(struct se_cmd *);
	int (*queue_data_in)(struct se_cmd *);
	int (*queue_status)(struct se_cmd *);
	void (*queue_tm_rsp)(struct se_cmd *);
	void (*aborted_task)(struct se_cmd *);
	/*
	 * fabric module calls for target_core_fabric_configfs.c
	 */
	struct se_wwn *(*fabric_make_wwn)(struct target_fabric_configfs *,
				struct config_group *, const char *);
	void (*fabric_drop_wwn)(struct se_wwn *);
	struct se_portal_group *(*fabric_make_tpg)(struct se_wwn *,
				struct config_group *, const char *);
	void (*fabric_drop_tpg)(struct se_portal_group *);
	int (*fabric_post_link)(struct se_portal_group *,
				struct se_lun *);
	void (*fabric_pre_unlink)(struct se_portal_group *,
				struct se_lun *);
	struct se_tpg_np *(*fabric_make_np)(struct se_portal_group *,
				struct config_group *, const char *);
	void (*fabric_drop_np)(struct se_tpg_np *);
	int (*fabric_init_nodeacl)(struct se_node_acl *, const char *);

	struct configfs_attribute **tfc_discovery_attrs;
	struct configfs_attribute **tfc_wwn_attrs;
	struct configfs_attribute **tfc_tpg_base_attrs;
	struct configfs_attribute **tfc_tpg_np_base_attrs;
	struct configfs_attribute **tfc_tpg_attrib_attrs;
	struct configfs_attribute **tfc_tpg_auth_attrs;
	struct configfs_attribute **tfc_tpg_param_attrs;
	struct configfs_attribute **tfc_tpg_nacl_base_attrs;
	struct configfs_attribute **tfc_tpg_nacl_attrib_attrs;
	struct configfs_attribute **tfc_tpg_nacl_auth_attrs;
	struct configfs_attribute **tfc_tpg_nacl_param_attrs;
};

int target_register_template(const struct target_core_fabric_ops *fo);
void target_unregister_template(const struct target_core_fabric_ops *fo);

int target_depend_item(struct config_item *item);
void target_undepend_item(struct config_item *item);

struct se_session *target_alloc_session(struct se_portal_group *,
		unsigned int, unsigned int, enum target_prot_op prot_op,
		const char *, void *,
		int (*callback)(struct se_portal_group *,
				struct se_session *, void *));

struct se_session *transport_init_session(enum target_prot_op);
int transport_alloc_session_tags(struct se_session *, unsigned int,
		unsigned int);
struct se_session *transport_init_session_tags(unsigned int, unsigned int,
		enum target_prot_op);
void	__transport_register_session(struct se_portal_group *,
		struct se_node_acl *, struct se_session *, void *);
void	transport_register_session(struct se_portal_group *,
		struct se_node_acl *, struct se_session *, void *);
int	target_get_session(struct se_session *);
void	target_put_session(struct se_session *);
ssize_t	target_show_dynamic_sessions(struct se_portal_group *, char *);
void	transport_free_session(struct se_session *);
void	target_put_nacl(struct se_node_acl *);
void	transport_deregister_session_configfs(struct se_session *);
void	transport_deregister_session(struct se_session *);


void	transport_init_se_cmd(struct se_cmd *,
		const struct target_core_fabric_ops *,
		struct se_session *, u32, int, int, unsigned char *);
sense_reason_t transport_lookup_cmd_lun(struct se_cmd *, u64);
sense_reason_t target_setup_cmd_from_cdb(struct se_cmd *, unsigned char *);
int	target_submit_cmd_map_sgls(struct se_cmd *, struct se_session *,
		unsigned char *, unsigned char *, u64, u32, int, int, int,
		struct scatterlist *, u32, struct scatterlist *, u32,
		struct scatterlist *, u32);
int	target_submit_cmd(struct se_cmd *, struct se_session *, unsigned char *,
		unsigned char *, u64, u32, int, int, int);
int	target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
		unsigned char *sense, u64 unpacked_lun,
		void *fabric_tmr_ptr, unsigned char tm_type,
		gfp_t, u64, int);
int	transport_handle_cdb_direct(struct se_cmd *);
sense_reason_t	transport_generic_new_cmd(struct se_cmd *);

void	target_execute_cmd(struct se_cmd *cmd);

int	transport_generic_free_cmd(struct se_cmd *, int);

bool	transport_wait_for_tasks(struct se_cmd *);
int	transport_check_aborted_status(struct se_cmd *, int);
int	transport_send_check_condition_and_sense(struct se_cmd *,
		sense_reason_t, int);
int	target_get_sess_cmd(struct se_cmd *, bool);
int	target_put_sess_cmd(struct se_cmd *);
void	target_sess_cmd_list_set_waiting(struct se_session *);
void	target_wait_for_sess_cmds(struct se_session *);

int	core_alua_check_nonop_delay(struct se_cmd *);

int	core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
void	core_tmr_release_req(struct se_tmr_req *);
int	transport_generic_handle_tmr(struct se_cmd *);
void	transport_generic_request_failure(struct se_cmd *, sense_reason_t);
void	__target_execute_cmd(struct se_cmd *);
int	transport_lookup_tmr_lun(struct se_cmd *, u64);
void	core_allocate_nexus_loss_ua(struct se_node_acl *acl);

struct se_node_acl *core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
		unsigned char *);
bool	target_tpg_has_node_acl(struct se_portal_group *tpg,
		const char *);
struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
		unsigned char *);
int	core_tpg_set_initiator_node_queue_depth(struct se_node_acl *, u32);
int	core_tpg_set_initiator_node_tag(struct se_portal_group *,
		struct se_node_acl *, const char *);
int	core_tpg_register(struct se_wwn *, struct se_portal_group *, int);
int	core_tpg_deregister(struct se_portal_group *);

/*
 * The LIO target core uses DMA_TO_DEVICE to mean that data is going
 * to the target (eg handling a WRITE) and DMA_FROM_DEVICE to mean
 * that data is coming from the target (eg handling a READ).  However,
 * this is just the opposite of what we have to tell the DMA mapping
 * layer -- eg when handling a READ, the HBA will have to DMA the data
 * out of memory so it can send it to the initiator, which means we
 * need to use DMA_TO_DEVICE when we map the data.
 */
static inline enum dma_data_direction
target_reverse_dma_direction(struct se_cmd *se_cmd)
{
	if (se_cmd->se_cmd_flags & SCF_BIDI)
		return DMA_BIDIRECTIONAL;

	switch (se_cmd->data_direction) {
	case DMA_TO_DEVICE:
		return DMA_FROM_DEVICE;
	case DMA_FROM_DEVICE:
		return DMA_TO_DEVICE;
	case DMA_NONE:
	default:
		return DMA_NONE;
	}
}

#endif /* TARGET_CORE_FABRICH */
Commit	Line	Data
c4795fb2 CH	1	#ifndef TARGET_CORE_FABRIC_H
c4795fb2 CH	2	#define TARGET_CORE_FABRIC_H
c66ac9db NB	3
c66ac9db NB	4	struct target_core_fabric_ops {
9ac8928e CH	5	struct module *module;
9ac8928e CH	6	const char *name;
144bc4c2	7	size_t node_acl_size;
8f9b5654 NB	8	/*
	9	* Limits number of scatterlist entries per SCF_SCSI_DATA_CDB payload.
	10	* Setting this value tells target-core to enforce this limit, and
	11	* report as INQUIRY EVPD=b0 MAXIMUM TRANSFER LENGTH.
	12	*
	13	* target-core will currently reset se_cmd->data_length to this
	14	* maximum size, and set UNDERFLOW residual count if length exceeds
	15	* this limit.
	16	*
	17	* XXX: Not all initiator hosts honor this block-limit EVPD
	18	* XXX: Currently assumes single PAGE_SIZE per scatterlist entry
	19	*/
	20	u32 max_data_sg_nents;
c66ac9db	21	char (get_fabric_name)(void);
c66ac9db NB	22	char (tpg_get_wwn)(struct se_portal_group *);
	23	u16 (tpg_get_tag)(struct se_portal_group );
	24	u32 (tpg_get_default_depth)(struct se_portal_group );
c66ac9db NB	25	int (tpg_check_demo_mode)(struct se_portal_group );
	26	int (tpg_check_demo_mode_cache)(struct se_portal_group );
	27	int (tpg_check_demo_mode_write_protect)(struct se_portal_group );
	28	int (tpg_check_prod_mode_write_protect)(struct se_portal_group );
052605c6 NB	29	/*
	30	* Optionally used by fabrics to allow demo-mode login, but not
	31	* expose any TPG LUNs, and return 'not connected' in standard
	32	* inquiry response
	33	*/
	34	int (tpg_check_demo_mode_login_only)(struct se_portal_group );
38b57f82 NB	35	/*
	36	* Optionally used as a configfs tunable to determine when
	37	* target-core should signal the PROTECT=1 feature bit for
	38	* backends that don't support T10-PI, so that either fabric
	39	* HW offload or target-core emulation performs the associated
	40	* WRITE_STRIP and READ_INSERT operations.
	41	*/
	42	int (tpg_check_prot_fabric_only)(struct se_portal_group );
c66ac9db	43	u32 (tpg_get_inst_index)(struct se_portal_group );
c66ac9db NB	44	/*
c66ac9db NB	45	* Optional to release struct se_cmd and fabric dependent allocated
88dd9e26 NB	46	* I/O descriptor in transport_cmd_check_stop().
	47	*
	48	* Returning 1 will signal a descriptor has been released.
	49	* Returning 0 will signal a descriptor has not been released.
c66ac9db	50	*/
88dd9e26	51	int (check_stop_free)(struct se_cmd );
35462975	52	void (release_cmd)(struct se_cmd );
c66ac9db NB	53	/*
	54	* Called with spin_lock_bh(struct se_portal_group->session_lock held.
	55	*/
	56	int (shutdown_session)(struct se_session );
	57	void (close_session)(struct se_session );
c66ac9db NB	58	u32 (sess_get_index)(struct se_session );
	59	/*
	60	* Used only for SCSI fabrics that contain multi-value TransportIDs
	61	* (like iSCSI). All other SCSI fabrics should set this to NULL.
	62	*/
	63	u32 (sess_get_initiator_sid)(struct se_session ,
	64	unsigned char *, u32);
	65	int (write_pending)(struct se_cmd );
	66	int (write_pending_status)(struct se_cmd );
	67	void (set_default_node_attributes)(struct se_node_acl );
c66ac9db	68	int (get_cmd_state)(struct se_cmd );
c66ac9db NB	69	int (queue_data_in)(struct se_cmd );
c66ac9db NB	70	int (queue_status)(struct se_cmd );
b79fafac	71	void (queue_tm_rsp)(struct se_cmd );
131e6abc	72	void (aborted_task)(struct se_cmd );
c66ac9db NB	73	/*
	74	* fabric module calls for target_core_fabric_configfs.c
	75	*/
	76	struct se_wwn (fabric_make_wwn)(struct target_fabric_configfs *,
	77	struct config_group , const char );
	78	void (fabric_drop_wwn)(struct se_wwn );
	79	struct se_portal_group (fabric_make_tpg)(struct se_wwn *,
	80	struct config_group , const char );
	81	void (fabric_drop_tpg)(struct se_portal_group );
	82	int (fabric_post_link)(struct se_portal_group ,
	83	struct se_lun *);
	84	void (fabric_pre_unlink)(struct se_portal_group ,
	85	struct se_lun *);
	86	struct se_tpg_np (fabric_make_np)(struct se_portal_group *,
	87	struct config_group , const char );
	88	void (fabric_drop_np)(struct se_tpg_np );
c7d6a803	89	int (fabric_init_nodeacl)(struct se_node_acl , const char *);
9ac8928e CH	90
	91	struct configfs_attribute **tfc_discovery_attrs;
	92	struct configfs_attribute **tfc_wwn_attrs;
	93	struct configfs_attribute **tfc_tpg_base_attrs;
	94	struct configfs_attribute **tfc_tpg_np_base_attrs;
	95	struct configfs_attribute **tfc_tpg_attrib_attrs;
	96	struct configfs_attribute **tfc_tpg_auth_attrs;
	97	struct configfs_attribute **tfc_tpg_param_attrs;
	98	struct configfs_attribute **tfc_tpg_nacl_base_attrs;
	99	struct configfs_attribute **tfc_tpg_nacl_attrib_attrs;
	100	struct configfs_attribute **tfc_tpg_nacl_auth_attrs;
	101	struct configfs_attribute **tfc_tpg_nacl_param_attrs;
c66ac9db	102	};
c4795fb2	103
9ac8928e CH	104	int target_register_template(const struct target_core_fabric_ops *fo);
	105	void target_unregister_template(const struct target_core_fabric_ops *fo);
	106
d588cf8f CH	107	int target_depend_item(struct config_item *item);
	108	void target_undepend_item(struct config_item *item);
	109
7861728d NB	110	struct se_session target_alloc_session(struct se_portal_group ,
	111	unsigned int, unsigned int, enum target_prot_op prot_op,
	112	const char , void ,
	113	int (callback)(struct se_portal_group ,
	114	struct se_session , void ));
	115
e70beee7	116	struct se_session *transport_init_session(enum target_prot_op);
c0add7fd NB	117	int transport_alloc_session_tags(struct se_session *, unsigned int,
c0add7fd NB	118	unsigned int);
e70beee7 NB	119	struct se_session *transport_init_session_tags(unsigned int, unsigned int,
e70beee7 NB	120	enum target_prot_op);
c4795fb2 CH	121	void __transport_register_session(struct se_portal_group *,
	122	struct se_node_acl , struct se_session , void *);
	123	void transport_register_session(struct se_portal_group *,
	124	struct se_node_acl , struct se_session , void *);
d36ad77f	125	int target_get_session(struct se_session *);
33933a0e	126	void target_put_session(struct se_session *);
f8e471f9	127	ssize_t target_show_dynamic_sessions(struct se_portal_group , char );
c4795fb2	128	void transport_free_session(struct se_session *);
afb999ff	129	void target_put_nacl(struct se_node_acl *);
c4795fb2 CH	130	void transport_deregister_session_configfs(struct se_session *);
	131	void transport_deregister_session(struct se_session *);
	132
	133
9ac8928e CH	134	void transport_init_se_cmd(struct se_cmd *,
9ac8928e CH	135	const struct target_core_fabric_ops *,
c4795fb2	136	struct se_session , u32, int, int, unsigned char );
f2d30680	137	sense_reason_t transport_lookup_cmd_lun(struct se_cmd *, u64);
de103c93	138	sense_reason_t target_setup_cmd_from_cdb(struct se_cmd , unsigned char );
a026757f	139	int target_submit_cmd_map_sgls(struct se_cmd , struct se_session ,
f2d30680	140	unsigned char , unsigned char , u64, u32, int, int, int,
def2b339 NB	141	struct scatterlist , u32, struct scatterlist , u32,
def2b339 NB	142	struct scatterlist *, u32);
d6dfc868	143	int target_submit_cmd(struct se_cmd , struct se_session , unsigned char *,
f2d30680	144	unsigned char *, u64, u32, int, int, int);
c7042cae	145	int target_submit_tmr(struct se_cmd se_cmd, struct se_session se_sess,
f2d30680	146	unsigned char *sense, u64 unpacked_lun,
c0974f89	147	void *fabric_tmr_ptr, unsigned char tm_type,
5261d86c	148	gfp_t, u64, int);
c4795fb2	149	int transport_handle_cdb_direct(struct se_cmd *);
de103c93	150	sense_reason_t transport_generic_new_cmd(struct se_cmd *);
c4795fb2	151
70baf0ab	152	void target_execute_cmd(struct se_cmd *cmd);
c4795fb2	153
d5ddad41	154	int transport_generic_free_cmd(struct se_cmd *, int);
c4795fb2 CH	155
	156	bool transport_wait_for_tasks(struct se_cmd *);
	157	int transport_check_aborted_status(struct se_cmd *, int);
de103c93 CH	158	int transport_send_check_condition_and_sense(struct se_cmd *,
de103c93 CH	159	sense_reason_t, int);
afc16604 BVA	160	int target_get_sess_cmd(struct se_cmd *, bool);
afc16604 BVA	161	int target_put_sess_cmd(struct se_cmd *);
1c7b13fe	162	void target_sess_cmd_list_set_waiting(struct se_session *);
be646c2d	163	void target_wait_for_sess_cmds(struct se_session *);
c4795fb2 CH	164
	165	int core_alua_check_nonop_delay(struct se_cmd *);
	166
c8e31f26	167	int core_tmr_alloc_req(struct se_cmd , void , u8, gfp_t);
c4795fb2 CH	168	void core_tmr_release_req(struct se_tmr_req *);
c4795fb2 CH	169	int transport_generic_handle_tmr(struct se_cmd *);
de103c93	170	void transport_generic_request_failure(struct se_cmd *, sense_reason_t);
76dde50e	171	void __target_execute_cmd(struct se_cmd *);
f2d30680	172	int transport_lookup_tmr_lun(struct se_cmd *, u64);
e986a35a	173	void core_allocate_nexus_loss_ua(struct se_node_acl *acl);
c4795fb2	174
b3fde035 TG	175	struct se_node_acl core_tpg_get_initiator_node_acl(struct se_portal_group tpg,
b3fde035 TG	176	unsigned char *);
21aaa23b NB	177	bool target_tpg_has_node_acl(struct se_portal_group *tpg,
21aaa23b NB	178	const char *);
c4795fb2 CH	179	struct se_node_acl core_tpg_check_initiator_node_acl(struct se_portal_group ,
c4795fb2 CH	180	unsigned char *);
d36ad77f	181	int core_tpg_set_initiator_node_queue_depth(struct se_node_acl *, u32);
79e62fc3 AG	182	int core_tpg_set_initiator_node_tag(struct se_portal_group *,
79e62fc3 AG	183	struct se_node_acl , const char );
bc0c94b1	184	int core_tpg_register(struct se_wwn , struct se_portal_group , int);
c4795fb2 CH	185	int core_tpg_deregister(struct se_portal_group *);
c4795fb2 CH	186
b3faa2e8 NB	187	/*
	188	* The LIO target core uses DMA_TO_DEVICE to mean that data is going
	189	* to the target (eg handling a WRITE) and DMA_FROM_DEVICE to mean
	190	* that data is coming from the target (eg handling a READ). However,
	191	* this is just the opposite of what we have to tell the DMA mapping
	192	* layer -- eg when handling a READ, the HBA will have to DMA the data
	193	* out of memory so it can send it to the initiator, which means we
	194	* need to use DMA_TO_DEVICE when we map the data.
	195	*/
	196	static inline enum dma_data_direction
	197	target_reverse_dma_direction(struct se_cmd *se_cmd)
	198	{
	199	if (se_cmd->se_cmd_flags & SCF_BIDI)
	200	return DMA_BIDIRECTIONAL;
	201
	202	switch (se_cmd->data_direction) {
	203	case DMA_TO_DEVICE:
	204	return DMA_FROM_DEVICE;
	205	case DMA_FROM_DEVICE:
	206	return DMA_TO_DEVICE;
	207	case DMA_NONE:
	208	default:
	209	return DMA_NONE;
	210	}
	211	}
	212
c4795fb2	213	#endif /* TARGET_CORE_FABRICH */