[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 configfs_subsystem *tf_subsys;
	char *(*get_fabric_name)(void);
	u8 (*get_fabric_proto_ident)(struct se_portal_group *);
	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 *);
	u32 (*tpg_get_pr_transport_id)(struct se_portal_group *,
				struct se_node_acl *,
				struct t10_pr_registration *, int *,
				unsigned char *);
	u32 (*tpg_get_pr_transport_id_len)(struct se_portal_group *,
				struct se_node_acl *,
				struct t10_pr_registration *, int *);
	char *(*tpg_parse_pr_out_transport_id)(struct se_portal_group *,
				const char *, u32 *, char **);
	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 *);
	struct se_node_acl *(*tpg_alloc_fabric_acl)(
					struct se_portal_group *);
	void (*tpg_release_fabric_acl)(struct se_portal_group *,
					struct se_node_acl *);
	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 *);
	void (*put_session)(struct se_session *);
	/*
	 * 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 *);
	u32 (*get_task_tag)(struct se_cmd *);
	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 *);
	struct se_node_acl *(*fabric_make_nodeacl)(struct se_portal_group *,
				struct config_group *, const char *);
	void (*fabric_drop_nodeacl)(struct se_node_acl *);
};

struct se_session *transport_init_session(void);
int transport_alloc_session_tags(struct se_session *, unsigned int,
		unsigned int);
struct se_session *transport_init_session_tags(unsigned int, unsigned int);
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 *);
void	target_get_session(struct se_session *);
void	target_put_session(struct se_session *);
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 *, struct target_core_fabric_ops *,
		struct se_session *, u32, int, int, unsigned char *);
sense_reason_t transport_lookup_cmd_lun(struct se_cmd *, u32);
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 *, u32, 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 *, u32, u32, int, int, int);
int	target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
		unsigned char *sense, u32 unpacked_lun,
		void *fabric_tmr_ptr, unsigned char tm_type,
		gfp_t, unsigned int, 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_session *, struct se_cmd *, bool);
int	target_put_sess_cmd(struct se_session *, 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 *, u32);

struct se_node_acl *core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
		unsigned char *);
struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
		unsigned char *);
void	core_tpg_clear_object_luns(struct se_portal_group *);
struct se_node_acl *core_tpg_add_initiator_node_acl(struct se_portal_group *,
		struct se_node_acl *, const char *, u32);
int	core_tpg_del_initiator_node_acl(struct se_portal_group *,
		struct se_node_acl *, int);
int	core_tpg_set_initiator_node_queue_depth(struct se_portal_group *,
		unsigned char *, u32, int);
int	core_tpg_set_initiator_node_tag(struct se_portal_group *,
		struct se_node_acl *, const char *);
int	core_tpg_register(struct target_core_fabric_ops *, struct se_wwn *,
		struct se_portal_group *, void *, int);
int	core_tpg_deregister(struct se_portal_group *);

/* SAS helpers */
u8	sas_get_fabric_proto_ident(struct se_portal_group *);
u32	sas_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
		struct t10_pr_registration *, int *, unsigned char *);
u32	sas_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
		struct t10_pr_registration *, int *);
char	*sas_parse_pr_out_transport_id(struct se_portal_group *, const char *,
		u32 *, char **);

/* FC helpers */
u8	fc_get_fabric_proto_ident(struct se_portal_group *);
u32	fc_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
		struct t10_pr_registration *, int *, unsigned char *);
u32	fc_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
		struct t10_pr_registration *, int *);
char	*fc_parse_pr_out_transport_id(struct se_portal_group *, const char *,
		u32 *, char **);

/* iSCSI helpers */
u8	iscsi_get_fabric_proto_ident(struct se_portal_group *);
u32	iscsi_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
		struct t10_pr_registration *, int *, unsigned char *);
u32	iscsi_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
		struct t10_pr_registration *, int *);
char	*iscsi_parse_pr_out_transport_id(struct se_portal_group *, const char *,
		u32 *, char **);

/*
 * 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
	4	struct target_core_fabric_ops {
	5	struct configfs_subsystem *tf_subsys;
c66ac9db NB	6	char (get_fabric_name)(void);
	7	u8 (get_fabric_proto_ident)(struct se_portal_group );
	8	char (tpg_get_wwn)(struct se_portal_group *);
	9	u16 (tpg_get_tag)(struct se_portal_group );
	10	u32 (tpg_get_default_depth)(struct se_portal_group );
	11	u32 (tpg_get_pr_transport_id)(struct se_portal_group ,
	12	struct se_node_acl *,
	13	struct t10_pr_registration , int ,
	14	unsigned char *);
	15	u32 (tpg_get_pr_transport_id_len)(struct se_portal_group ,
	16	struct se_node_acl *,
	17	struct t10_pr_registration , int );
	18	char (tpg_parse_pr_out_transport_id)(struct se_portal_group *,
	19	const char , u32 , char **);
	20	int (tpg_check_demo_mode)(struct se_portal_group );
	21	int (tpg_check_demo_mode_cache)(struct se_portal_group );
	22	int (tpg_check_demo_mode_write_protect)(struct se_portal_group );
	23	int (tpg_check_prod_mode_write_protect)(struct se_portal_group );
052605c6 NB	24	/*
	25	* Optionally used by fabrics to allow demo-mode login, but not
	26	* expose any TPG LUNs, and return 'not connected' in standard
	27	* inquiry response
	28	*/
	29	int (tpg_check_demo_mode_login_only)(struct se_portal_group );
c66ac9db NB	30	struct se_node_acl (tpg_alloc_fabric_acl)(
	31	struct se_portal_group *);
	32	void (tpg_release_fabric_acl)(struct se_portal_group ,
	33	struct se_node_acl *);
	34	u32 (tpg_get_inst_index)(struct se_portal_group );
c66ac9db NB	35	/*
c66ac9db NB	36	* Optional to release struct se_cmd and fabric dependent allocated
88dd9e26 NB	37	* I/O descriptor in transport_cmd_check_stop().
	38	*
	39	* Returning 1 will signal a descriptor has been released.
	40	* Returning 0 will signal a descriptor has not been released.
c66ac9db	41	*/
88dd9e26	42	int (check_stop_free)(struct se_cmd );
35462975	43	void (release_cmd)(struct se_cmd );
4149268e	44	void (put_session)(struct se_session );
c66ac9db NB	45	/*
	46	* Called with spin_lock_bh(struct se_portal_group->session_lock held.
	47	*/
	48	int (shutdown_session)(struct se_session );
	49	void (close_session)(struct se_session );
c66ac9db NB	50	u32 (sess_get_index)(struct se_session );
	51	/*
	52	* Used only for SCSI fabrics that contain multi-value TransportIDs
	53	* (like iSCSI). All other SCSI fabrics should set this to NULL.
	54	*/
	55	u32 (sess_get_initiator_sid)(struct se_session ,
	56	unsigned char *, u32);
	57	int (write_pending)(struct se_cmd );
	58	int (write_pending_status)(struct se_cmd );
	59	void (set_default_node_attributes)(struct se_node_acl );
	60	u32 (get_task_tag)(struct se_cmd );
	61	int (get_cmd_state)(struct se_cmd );
c66ac9db NB	62	int (queue_data_in)(struct se_cmd );
c66ac9db NB	63	int (queue_status)(struct se_cmd );
b79fafac	64	void (queue_tm_rsp)(struct se_cmd );
131e6abc	65	void (aborted_task)(struct se_cmd );
c66ac9db NB	66	/*
	67	* fabric module calls for target_core_fabric_configfs.c
	68	*/
	69	struct se_wwn (fabric_make_wwn)(struct target_fabric_configfs *,
	70	struct config_group , const char );
	71	void (fabric_drop_wwn)(struct se_wwn );
	72	struct se_portal_group (fabric_make_tpg)(struct se_wwn *,
	73	struct config_group , const char );
	74	void (fabric_drop_tpg)(struct se_portal_group );
	75	int (fabric_post_link)(struct se_portal_group ,
	76	struct se_lun *);
	77	void (fabric_pre_unlink)(struct se_portal_group ,
	78	struct se_lun *);
	79	struct se_tpg_np (fabric_make_np)(struct se_portal_group *,
	80	struct config_group , const char );
	81	void (fabric_drop_np)(struct se_tpg_np );
	82	struct se_node_acl (fabric_make_nodeacl)(struct se_portal_group *,
	83	struct config_group , const char );
	84	void (fabric_drop_nodeacl)(struct se_node_acl );
	85	};
c4795fb2 CH	86
c4795fb2 CH	87	struct se_session *transport_init_session(void);
c0add7fd NB	88	int transport_alloc_session_tags(struct se_session *, unsigned int,
	89	unsigned int);
	90	struct se_session *transport_init_session_tags(unsigned int, unsigned int);
c4795fb2 CH	91	void __transport_register_session(struct se_portal_group *,
	92	struct se_node_acl , struct se_session , void *);
	93	void transport_register_session(struct se_portal_group *,
	94	struct se_node_acl , struct se_session , void *);
41ac82b6	95	void target_get_session(struct se_session *);
33933a0e	96	void target_put_session(struct se_session *);
c4795fb2	97	void transport_free_session(struct se_session *);
afb999ff	98	void target_put_nacl(struct se_node_acl *);
c4795fb2 CH	99	void transport_deregister_session_configfs(struct se_session *);
	100	void transport_deregister_session(struct se_session *);
	101
	102
	103	void transport_init_se_cmd(struct se_cmd , struct target_core_fabric_ops ,
	104	struct se_session , u32, int, int, unsigned char );
de103c93 CH	105	sense_reason_t transport_lookup_cmd_lun(struct se_cmd *, u32);
de103c93 CH	106	sense_reason_t target_setup_cmd_from_cdb(struct se_cmd , unsigned char );
a026757f NB	107	int target_submit_cmd_map_sgls(struct se_cmd , struct se_session ,
a026757f NB	108	unsigned char , unsigned char , u32, u32, int, int, int,
def2b339 NB	109	struct scatterlist , u32, struct scatterlist , u32,
def2b339 NB	110	struct scatterlist *, u32);
d6dfc868	111	int target_submit_cmd(struct se_cmd , struct se_session , unsigned char *,
a6360785	112	unsigned char *, u32, u32, int, int, int);
c7042cae	113	int target_submit_tmr(struct se_cmd se_cmd, struct se_session se_sess,
ea98d7f9	114	unsigned char *sense, u32 unpacked_lun,
c0974f89 NB	115	void *fabric_tmr_ptr, unsigned char tm_type,
c0974f89 NB	116	gfp_t, unsigned int, int);
c4795fb2	117	int transport_handle_cdb_direct(struct se_cmd *);
de103c93	118	sense_reason_t transport_generic_new_cmd(struct se_cmd *);
c4795fb2	119
70baf0ab	120	void target_execute_cmd(struct se_cmd *cmd);
c4795fb2	121
d5ddad41	122	int transport_generic_free_cmd(struct se_cmd *, int);
c4795fb2 CH	123
	124	bool transport_wait_for_tasks(struct se_cmd *);
	125	int transport_check_aborted_status(struct se_cmd *, int);
de103c93 CH	126	int transport_send_check_condition_and_sense(struct se_cmd *,
de103c93 CH	127	sense_reason_t, int);
20361e69	128	int target_get_sess_cmd(struct se_session , struct se_cmd , bool);
c4795fb2	129	int target_put_sess_cmd(struct se_session , struct se_cmd );
1c7b13fe	130	void target_sess_cmd_list_set_waiting(struct se_session *);
be646c2d	131	void target_wait_for_sess_cmds(struct se_session *);
c4795fb2 CH	132
	133	int core_alua_check_nonop_delay(struct se_cmd *);
	134
c8e31f26	135	int core_tmr_alloc_req(struct se_cmd , void , u8, gfp_t);
c4795fb2 CH	136	void core_tmr_release_req(struct se_tmr_req *);
c4795fb2 CH	137	int transport_generic_handle_tmr(struct se_cmd *);
de103c93	138	void transport_generic_request_failure(struct se_cmd *, sense_reason_t);
76dde50e	139	void __target_execute_cmd(struct se_cmd *);
c4795fb2 CH	140	int transport_lookup_tmr_lun(struct se_cmd *, u32);
c4795fb2 CH	141
b3fde035 TG	142	struct se_node_acl core_tpg_get_initiator_node_acl(struct se_portal_group tpg,
b3fde035 TG	143	unsigned char *);
c4795fb2 CH	144	struct se_node_acl core_tpg_check_initiator_node_acl(struct se_portal_group ,
	145	unsigned char *);
	146	void core_tpg_clear_object_luns(struct se_portal_group *);
	147	struct se_node_acl core_tpg_add_initiator_node_acl(struct se_portal_group ,
	148	struct se_node_acl , const char , u32);
	149	int core_tpg_del_initiator_node_acl(struct se_portal_group *,
	150	struct se_node_acl *, int);
	151	int core_tpg_set_initiator_node_queue_depth(struct se_portal_group *,
	152	unsigned char *, u32, int);
79e62fc3 AG	153	int core_tpg_set_initiator_node_tag(struct se_portal_group *,
79e62fc3 AG	154	struct se_node_acl , const char );
c4795fb2 CH	155	int core_tpg_register(struct target_core_fabric_ops , struct se_wwn ,
	156	struct se_portal_group , void , int);
	157	int core_tpg_deregister(struct se_portal_group *);
	158
	159	/* SAS helpers */
	160	u8 sas_get_fabric_proto_ident(struct se_portal_group *);
	161	u32 sas_get_pr_transport_id(struct se_portal_group , struct se_node_acl ,
	162	struct t10_pr_registration , int , unsigned char *);
	163	u32 sas_get_pr_transport_id_len(struct se_portal_group , struct se_node_acl ,
	164	struct t10_pr_registration , int );
	165	char sas_parse_pr_out_transport_id(struct se_portal_group , const char *,
	166	u32 , char *);
	167
	168	/* FC helpers */
	169	u8 fc_get_fabric_proto_ident(struct se_portal_group *);
	170	u32 fc_get_pr_transport_id(struct se_portal_group , struct se_node_acl ,
	171	struct t10_pr_registration , int , unsigned char *);
	172	u32 fc_get_pr_transport_id_len(struct se_portal_group , struct se_node_acl ,
	173	struct t10_pr_registration , int );
	174	char fc_parse_pr_out_transport_id(struct se_portal_group , const char *,
	175	u32 , char *);
	176
	177	/* iSCSI helpers */
	178	u8 iscsi_get_fabric_proto_ident(struct se_portal_group *);
	179	u32 iscsi_get_pr_transport_id(struct se_portal_group , struct se_node_acl ,
	180	struct t10_pr_registration , int , unsigned char *);
	181	u32 iscsi_get_pr_transport_id_len(struct se_portal_group , struct se_node_acl ,
	182	struct t10_pr_registration , int );
	183	char iscsi_parse_pr_out_transport_id(struct se_portal_group , const char *,
	184	u32 , char *);
	185
b3faa2e8 NB	186	/*
	187	* The LIO target core uses DMA_TO_DEVICE to mean that data is going
	188	* to the target (eg handling a WRITE) and DMA_FROM_DEVICE to mean
	189	* that data is coming from the target (eg handling a READ). However,
	190	* this is just the opposite of what we have to tell the DMA mapping
	191	* layer -- eg when handling a READ, the HBA will have to DMA the data
	192	* out of memory so it can send it to the initiator, which means we
	193	* need to use DMA_TO_DEVICE when we map the data.
	194	*/
	195	static inline enum dma_data_direction
	196	target_reverse_dma_direction(struct se_cmd *se_cmd)
	197	{
	198	if (se_cmd->se_cmd_flags & SCF_BIDI)
	199	return DMA_BIDIRECTIONAL;
	200
	201	switch (se_cmd->data_direction) {
	202	case DMA_TO_DEVICE:
	203	return DMA_FROM_DEVICE;
	204	case DMA_FROM_DEVICE:
	205	return DMA_TO_DEVICE;
	206	case DMA_NONE:
	207	default:
	208	return DMA_NONE;
	209	}
	210	}
	211
c4795fb2	212	#endif /* TARGET_CORE_FABRICH */