1#ifndef TARGET_CORE_FABRIC_H
2#define TARGET_CORE_FABRIC_H
3
4struct target_core_fabric_ops {
5	struct module *module;
6	const char *name;
7	char *(*get_fabric_name)(void);
8	u8 (*get_fabric_proto_ident)(struct se_portal_group *);
9	char *(*tpg_get_wwn)(struct se_portal_group *);
10	u16 (*tpg_get_tag)(struct se_portal_group *);
11	u32 (*tpg_get_default_depth)(struct se_portal_group *);
12	u32 (*tpg_get_pr_transport_id)(struct se_portal_group *,
13				struct se_node_acl *,
14				struct t10_pr_registration *, int *,
15				unsigned char *);
16	u32 (*tpg_get_pr_transport_id_len)(struct se_portal_group *,
17				struct se_node_acl *,
18				struct t10_pr_registration *, int *);
19	char *(*tpg_parse_pr_out_transport_id)(struct se_portal_group *,
20				const char *, u32 *, char **);
21	int (*tpg_check_demo_mode)(struct se_portal_group *);
22	int (*tpg_check_demo_mode_cache)(struct se_portal_group *);
23	int (*tpg_check_demo_mode_write_protect)(struct se_portal_group *);
24	int (*tpg_check_prod_mode_write_protect)(struct se_portal_group *);
25	/*
26	 * Optionally used by fabrics to allow demo-mode login, but not
27	 * expose any TPG LUNs, and return 'not connected' in standard
28	 * inquiry response
29	 */
30	int (*tpg_check_demo_mode_login_only)(struct se_portal_group *);
31	/*
32	 * Optionally used as a configfs tunable to determine when
33	 * target-core should signal the PROTECT=1 feature bit for
34	 * backends that don't support T10-PI, so that either fabric
35	 * HW offload or target-core emulation performs the associated
36	 * WRITE_STRIP and READ_INSERT operations.
37	 */
38	int (*tpg_check_prot_fabric_only)(struct se_portal_group *);
39	struct se_node_acl *(*tpg_alloc_fabric_acl)(
40					struct se_portal_group *);
41	void (*tpg_release_fabric_acl)(struct se_portal_group *,
42					struct se_node_acl *);
43	u32 (*tpg_get_inst_index)(struct se_portal_group *);
44	/*
45	 * Optional to release struct se_cmd and fabric dependent allocated
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.
50	 */
51	int (*check_stop_free)(struct se_cmd *);
52	void (*release_cmd)(struct se_cmd *);
53	void (*put_session)(struct se_session *);
54	/*
55	 * Called with spin_lock_bh(struct se_portal_group->session_lock held.
56	 */
57	int (*shutdown_session)(struct se_session *);
58	void (*close_session)(struct se_session *);
59	u32 (*sess_get_index)(struct se_session *);
60	/*
61	 * Used only for SCSI fabrics that contain multi-value TransportIDs
62	 * (like iSCSI).  All other SCSI fabrics should set this to NULL.
63	 */
64	u32 (*sess_get_initiator_sid)(struct se_session *,
65				      unsigned char *, u32);
66	int (*write_pending)(struct se_cmd *);
67	int (*write_pending_status)(struct se_cmd *);
68	void (*set_default_node_attributes)(struct se_node_acl *);
69	u32 (*get_task_tag)(struct se_cmd *);
70	int (*get_cmd_state)(struct se_cmd *);
71	int (*queue_data_in)(struct se_cmd *);
72	int (*queue_status)(struct se_cmd *);
73	void (*queue_tm_rsp)(struct se_cmd *);
74	void (*aborted_task)(struct se_cmd *);
75	/*
76	 * fabric module calls for target_core_fabric_configfs.c
77	 */
78	struct se_wwn *(*fabric_make_wwn)(struct target_fabric_configfs *,
79				struct config_group *, const char *);
80	void (*fabric_drop_wwn)(struct se_wwn *);
81	struct se_portal_group *(*fabric_make_tpg)(struct se_wwn *,
82				struct config_group *, const char *);
83	void (*fabric_drop_tpg)(struct se_portal_group *);
84	int (*fabric_post_link)(struct se_portal_group *,
85				struct se_lun *);
86	void (*fabric_pre_unlink)(struct se_portal_group *,
87				struct se_lun *);
88	struct se_tpg_np *(*fabric_make_np)(struct se_portal_group *,
89				struct config_group *, const char *);
90	void (*fabric_drop_np)(struct se_tpg_np *);
91	struct se_node_acl *(*fabric_make_nodeacl)(struct se_portal_group *,
92				struct config_group *, const char *);
93	void (*fabric_drop_nodeacl)(struct se_node_acl *);
94
95	struct configfs_attribute **tfc_discovery_attrs;
96	struct configfs_attribute **tfc_wwn_attrs;
97	struct configfs_attribute **tfc_tpg_base_attrs;
98	struct configfs_attribute **tfc_tpg_np_base_attrs;
99	struct configfs_attribute **tfc_tpg_attrib_attrs;
100	struct configfs_attribute **tfc_tpg_auth_attrs;
101	struct configfs_attribute **tfc_tpg_param_attrs;
102	struct configfs_attribute **tfc_tpg_nacl_base_attrs;
103	struct configfs_attribute **tfc_tpg_nacl_attrib_attrs;
104	struct configfs_attribute **tfc_tpg_nacl_auth_attrs;
105	struct configfs_attribute **tfc_tpg_nacl_param_attrs;
106};
107
108int target_register_template(const struct target_core_fabric_ops *fo);
109void target_unregister_template(const struct target_core_fabric_ops *fo);
110
111int target_depend_item(struct config_item *item);
112void target_undepend_item(struct config_item *item);
113
114struct se_session *transport_init_session(enum target_prot_op);
115int transport_alloc_session_tags(struct se_session *, unsigned int,
116		unsigned int);
117struct se_session *transport_init_session_tags(unsigned int, unsigned int,
118		enum target_prot_op);
119void	__transport_register_session(struct se_portal_group *,
120		struct se_node_acl *, struct se_session *, void *);
121void	transport_register_session(struct se_portal_group *,
122		struct se_node_acl *, struct se_session *, void *);
123void	target_get_session(struct se_session *);
124void	target_put_session(struct se_session *);
125ssize_t	target_show_dynamic_sessions(struct se_portal_group *, char *);
126void	transport_free_session(struct se_session *);
127void	target_put_nacl(struct se_node_acl *);
128void	transport_deregister_session_configfs(struct se_session *);
129void	transport_deregister_session(struct se_session *);
130
131
132void	transport_init_se_cmd(struct se_cmd *,
133		const struct target_core_fabric_ops *,
134		struct se_session *, u32, int, int, unsigned char *);
135sense_reason_t transport_lookup_cmd_lun(struct se_cmd *, u32);
136sense_reason_t target_setup_cmd_from_cdb(struct se_cmd *, unsigned char *);
137int	target_submit_cmd_map_sgls(struct se_cmd *, struct se_session *,
138		unsigned char *, unsigned char *, u32, u32, int, int, int,
139		struct scatterlist *, u32, struct scatterlist *, u32,
140		struct scatterlist *, u32);
141int	target_submit_cmd(struct se_cmd *, struct se_session *, unsigned char *,
142		unsigned char *, u32, u32, int, int, int);
143int	target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
144		unsigned char *sense, u32 unpacked_lun,
145		void *fabric_tmr_ptr, unsigned char tm_type,
146		gfp_t, unsigned int, int);
147int	transport_handle_cdb_direct(struct se_cmd *);
148sense_reason_t	transport_generic_new_cmd(struct se_cmd *);
149
150void	target_execute_cmd(struct se_cmd *cmd);
151
152int	transport_generic_free_cmd(struct se_cmd *, int);
153
154bool	transport_wait_for_tasks(struct se_cmd *);
155int	transport_check_aborted_status(struct se_cmd *, int);
156int	transport_send_check_condition_and_sense(struct se_cmd *,
157		sense_reason_t, int);
158int	target_get_sess_cmd(struct se_cmd *, bool);
159int	target_put_sess_cmd(struct se_cmd *);
160void	target_sess_cmd_list_set_waiting(struct se_session *);
161void	target_wait_for_sess_cmds(struct se_session *);
162
163int	core_alua_check_nonop_delay(struct se_cmd *);
164
165int	core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
166void	core_tmr_release_req(struct se_tmr_req *);
167int	transport_generic_handle_tmr(struct se_cmd *);
168void	transport_generic_request_failure(struct se_cmd *, sense_reason_t);
169void	__target_execute_cmd(struct se_cmd *);
170int	transport_lookup_tmr_lun(struct se_cmd *, u32);
171
172struct se_node_acl *core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
173		unsigned char *);
174struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
175		unsigned char *);
176void	core_tpg_clear_object_luns(struct se_portal_group *);
177struct se_node_acl *core_tpg_add_initiator_node_acl(struct se_portal_group *,
178		struct se_node_acl *, const char *, u32);
179int	core_tpg_del_initiator_node_acl(struct se_portal_group *,
180		struct se_node_acl *, int);
181int	core_tpg_set_initiator_node_queue_depth(struct se_portal_group *,
182		unsigned char *, u32, int);
183int	core_tpg_set_initiator_node_tag(struct se_portal_group *,
184		struct se_node_acl *, const char *);
185int	core_tpg_register(const struct target_core_fabric_ops *,
186		struct se_wwn *, struct se_portal_group *, void *, int);
187int	core_tpg_deregister(struct se_portal_group *);
188
189/* SAS helpers */
190u8	sas_get_fabric_proto_ident(struct se_portal_group *);
191u32	sas_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
192		struct t10_pr_registration *, int *, unsigned char *);
193u32	sas_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
194		struct t10_pr_registration *, int *);
195char	*sas_parse_pr_out_transport_id(struct se_portal_group *, const char *,
196		u32 *, char **);
197
198/* FC helpers */
199u8	fc_get_fabric_proto_ident(struct se_portal_group *);
200u32	fc_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
201		struct t10_pr_registration *, int *, unsigned char *);
202u32	fc_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
203		struct t10_pr_registration *, int *);
204char	*fc_parse_pr_out_transport_id(struct se_portal_group *, const char *,
205		u32 *, char **);
206
207/* iSCSI helpers */
208u8	iscsi_get_fabric_proto_ident(struct se_portal_group *);
209u32	iscsi_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
210		struct t10_pr_registration *, int *, unsigned char *);
211u32	iscsi_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
212		struct t10_pr_registration *, int *);
213char	*iscsi_parse_pr_out_transport_id(struct se_portal_group *, const char *,
214		u32 *, char **);
215
216/*
217 * The LIO target core uses DMA_TO_DEVICE to mean that data is going
218 * to the target (eg handling a WRITE) and DMA_FROM_DEVICE to mean
219 * that data is coming from the target (eg handling a READ).  However,
220 * this is just the opposite of what we have to tell the DMA mapping
221 * layer -- eg when handling a READ, the HBA will have to DMA the data
222 * out of memory so it can send it to the initiator, which means we
223 * need to use DMA_TO_DEVICE when we map the data.
224 */
225static inline enum dma_data_direction
226target_reverse_dma_direction(struct se_cmd *se_cmd)
227{
228	if (se_cmd->se_cmd_flags & SCF_BIDI)
229		return DMA_BIDIRECTIONAL;
230
231	switch (se_cmd->data_direction) {
232	case DMA_TO_DEVICE:
233		return DMA_FROM_DEVICE;
234	case DMA_FROM_DEVICE:
235		return DMA_TO_DEVICE;
236	case DMA_NONE:
237	default:
238		return DMA_NONE;
239	}
240}
241
242#endif /* TARGET_CORE_FABRICH */
243