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