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