1 #ifndef TARGET_CORE_FABRIC_H
2 #define TARGET_CORE_FABRIC_H
3 
4 struct target_core_fabric_ops {
5 	struct configfs_subsystem *tf_subsys;
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 *);
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 *);
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 *);
35 	/*
36 	 * Optional to release struct se_cmd and fabric dependent allocated
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.
41 	 */
42 	int (*check_stop_free)(struct se_cmd *);
43 	void (*release_cmd)(struct se_cmd *);
44 	void (*put_session)(struct se_session *);
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 *);
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 *);
62 	int (*queue_data_in)(struct se_cmd *);
63 	int (*queue_status)(struct se_cmd *);
64 	void (*queue_tm_rsp)(struct se_cmd *);
65 	void (*aborted_task)(struct se_cmd *);
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 };
86 
87 struct se_session *transport_init_session(enum target_prot_op);
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,
91 		enum target_prot_op);
92 void	__transport_register_session(struct se_portal_group *,
93 		struct se_node_acl *, struct se_session *, void *);
94 void	transport_register_session(struct se_portal_group *,
95 		struct se_node_acl *, struct se_session *, void *);
96 void	target_get_session(struct se_session *);
97 void	target_put_session(struct se_session *);
98 void	transport_free_session(struct se_session *);
99 void	target_put_nacl(struct se_node_acl *);
100 void	transport_deregister_session_configfs(struct se_session *);
101 void	transport_deregister_session(struct se_session *);
102 
103 
104 void	transport_init_se_cmd(struct se_cmd *, struct target_core_fabric_ops *,
105 		struct se_session *, u32, int, int, unsigned char *);
106 sense_reason_t transport_lookup_cmd_lun(struct se_cmd *, u32);
107 sense_reason_t target_setup_cmd_from_cdb(struct se_cmd *, unsigned char *);
108 int	target_submit_cmd_map_sgls(struct se_cmd *, struct se_session *,
109 		unsigned char *, unsigned char *, u32, u32, int, int, int,
110 		struct scatterlist *, u32, struct scatterlist *, u32,
111 		struct scatterlist *, u32);
112 int	target_submit_cmd(struct se_cmd *, struct se_session *, unsigned char *,
113 		unsigned char *, u32, u32, int, int, int);
114 int	target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
115 		unsigned char *sense, u32 unpacked_lun,
116 		void *fabric_tmr_ptr, unsigned char tm_type,
117 		gfp_t, unsigned int, int);
118 int	transport_handle_cdb_direct(struct se_cmd *);
119 sense_reason_t	transport_generic_new_cmd(struct se_cmd *);
120 
121 void	target_execute_cmd(struct se_cmd *cmd);
122 
123 int	transport_generic_free_cmd(struct se_cmd *, int);
124 
125 bool	transport_wait_for_tasks(struct se_cmd *);
126 int	transport_check_aborted_status(struct se_cmd *, int);
127 int	transport_send_check_condition_and_sense(struct se_cmd *,
128 		sense_reason_t, int);
129 int	target_get_sess_cmd(struct se_session *, struct se_cmd *, bool);
130 int	target_put_sess_cmd(struct se_session *, struct se_cmd *);
131 void	target_sess_cmd_list_set_waiting(struct se_session *);
132 void	target_wait_for_sess_cmds(struct se_session *);
133 
134 int	core_alua_check_nonop_delay(struct se_cmd *);
135 
136 int	core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
137 void	core_tmr_release_req(struct se_tmr_req *);
138 int	transport_generic_handle_tmr(struct se_cmd *);
139 void	transport_generic_request_failure(struct se_cmd *, sense_reason_t);
140 void	__target_execute_cmd(struct se_cmd *);
141 int	transport_lookup_tmr_lun(struct se_cmd *, u32);
142 
143 struct se_node_acl *core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
144 		unsigned char *);
145 struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
146 		unsigned char *);
147 void	core_tpg_clear_object_luns(struct se_portal_group *);
148 struct se_node_acl *core_tpg_add_initiator_node_acl(struct se_portal_group *,
149 		struct se_node_acl *, const char *, u32);
150 int	core_tpg_del_initiator_node_acl(struct se_portal_group *,
151 		struct se_node_acl *, int);
152 int	core_tpg_set_initiator_node_queue_depth(struct se_portal_group *,
153 		unsigned char *, u32, int);
154 int	core_tpg_set_initiator_node_tag(struct se_portal_group *,
155 		struct se_node_acl *, const char *);
156 int	core_tpg_register(struct target_core_fabric_ops *, struct se_wwn *,
157 		struct se_portal_group *, void *, int);
158 int	core_tpg_deregister(struct se_portal_group *);
159 
160 /* SAS helpers */
161 u8	sas_get_fabric_proto_ident(struct se_portal_group *);
162 u32	sas_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
163 		struct t10_pr_registration *, int *, unsigned char *);
164 u32	sas_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
165 		struct t10_pr_registration *, int *);
166 char	*sas_parse_pr_out_transport_id(struct se_portal_group *, const char *,
167 		u32 *, char **);
168 
169 /* FC helpers */
170 u8	fc_get_fabric_proto_ident(struct se_portal_group *);
171 u32	fc_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
172 		struct t10_pr_registration *, int *, unsigned char *);
173 u32	fc_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
174 		struct t10_pr_registration *, int *);
175 char	*fc_parse_pr_out_transport_id(struct se_portal_group *, const char *,
176 		u32 *, char **);
177 
178 /* iSCSI helpers */
179 u8	iscsi_get_fabric_proto_ident(struct se_portal_group *);
180 u32	iscsi_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
181 		struct t10_pr_registration *, int *, unsigned char *);
182 u32	iscsi_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
183 		struct t10_pr_registration *, int *);
184 char	*iscsi_parse_pr_out_transport_id(struct se_portal_group *, const char *,
185 		u32 *, char **);
186 
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 
213 #endif /* TARGET_CORE_FABRICH */
214