Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef TARGET_CORE_FABRIC_H
3#define TARGET_CORE_FABRIC_H
4
5#include <linux/configfs.h>
6#include <linux/types.h>
7#include <target/target_core_base.h>
8
9struct target_core_fabric_ops {
10 struct module *module;
11 /*
12 * XXX: Special case for iscsi/iSCSI...
13 * If non-null, fabric_alias is used for matching target/$fabric
14 * ConfigFS paths. If null, fabric_name is used for this (see below).
15 */
16 const char *fabric_alias;
17 /*
18 * fabric_name is used for matching target/$fabric ConfigFS paths
19 * without a fabric_alias (see above). It's also used for the ALUA state
20 * path and is stored on disk with PR state.
21 */
22 const char *fabric_name;
23 size_t node_acl_size;
24 /*
25 * Limits number of scatterlist entries per SCF_SCSI_DATA_CDB payload.
26 * Setting this value tells target-core to enforce this limit, and
27 * report as INQUIRY EVPD=b0 MAXIMUM TRANSFER LENGTH.
28 *
29 * target-core will currently reset se_cmd->data_length to this
30 * maximum size, and set UNDERFLOW residual count if length exceeds
31 * this limit.
32 *
33 * XXX: Not all initiator hosts honor this block-limit EVPD
34 * XXX: Currently assumes single PAGE_SIZE per scatterlist entry
35 */
36 u32 max_data_sg_nents;
37 char *(*tpg_get_wwn)(struct se_portal_group *);
38 u16 (*tpg_get_tag)(struct se_portal_group *);
39 u32 (*tpg_get_default_depth)(struct se_portal_group *);
40 int (*tpg_check_demo_mode)(struct se_portal_group *);
41 int (*tpg_check_demo_mode_cache)(struct se_portal_group *);
42 int (*tpg_check_demo_mode_write_protect)(struct se_portal_group *);
43 int (*tpg_check_prod_mode_write_protect)(struct se_portal_group *);
44 /*
45 * Optionally used by fabrics to allow demo-mode login, but not
46 * expose any TPG LUNs, and return 'not connected' in standard
47 * inquiry response
48 */
49 int (*tpg_check_demo_mode_login_only)(struct se_portal_group *);
50 /*
51 * Optionally used as a configfs tunable to determine when
52 * target-core should signal the PROTECT=1 feature bit for
53 * backends that don't support T10-PI, so that either fabric
54 * HW offload or target-core emulation performs the associated
55 * WRITE_STRIP and READ_INSERT operations.
56 */
57 int (*tpg_check_prot_fabric_only)(struct se_portal_group *);
58 u32 (*tpg_get_inst_index)(struct se_portal_group *);
59 /*
60 * Optional to release struct se_cmd and fabric dependent allocated
61 * I/O descriptor after command execution has finished.
62 *
63 * Returning 1 will signal a descriptor has been released.
64 * Returning 0 will signal a descriptor has not been released.
65 */
66 int (*check_stop_free)(struct se_cmd *);
67 void (*release_cmd)(struct se_cmd *);
68 void (*close_session)(struct se_session *);
69 u32 (*sess_get_index)(struct se_session *);
70 /*
71 * Used only for SCSI fabrics that contain multi-value TransportIDs
72 * (like iSCSI). All other SCSI fabrics should set this to NULL.
73 */
74 u32 (*sess_get_initiator_sid)(struct se_session *,
75 unsigned char *, u32);
76 int (*write_pending)(struct se_cmd *);
77 void (*set_default_node_attributes)(struct se_node_acl *);
78 int (*get_cmd_state)(struct se_cmd *);
79 int (*queue_data_in)(struct se_cmd *);
80 int (*queue_status)(struct se_cmd *);
81 void (*queue_tm_rsp)(struct se_cmd *);
82 void (*aborted_task)(struct se_cmd *);
83 /*
84 * fabric module calls for target_core_fabric_configfs.c
85 */
86 struct se_wwn *(*fabric_make_wwn)(struct target_fabric_configfs *,
87 struct config_group *, const char *);
88 void (*fabric_drop_wwn)(struct se_wwn *);
89 void (*add_wwn_groups)(struct se_wwn *);
90 struct se_portal_group *(*fabric_make_tpg)(struct se_wwn *,
91 const char *);
92 void (*fabric_drop_tpg)(struct se_portal_group *);
93 int (*fabric_post_link)(struct se_portal_group *,
94 struct se_lun *);
95 void (*fabric_pre_unlink)(struct se_portal_group *,
96 struct se_lun *);
97 struct se_tpg_np *(*fabric_make_np)(struct se_portal_group *,
98 struct config_group *, const char *);
99 void (*fabric_drop_np)(struct se_tpg_np *);
100 int (*fabric_init_nodeacl)(struct se_node_acl *, const char *);
101
102 struct configfs_attribute **tfc_discovery_attrs;
103 struct configfs_attribute **tfc_wwn_attrs;
104 struct configfs_attribute **tfc_tpg_base_attrs;
105 struct configfs_attribute **tfc_tpg_np_base_attrs;
106 struct configfs_attribute **tfc_tpg_attrib_attrs;
107 struct configfs_attribute **tfc_tpg_auth_attrs;
108 struct configfs_attribute **tfc_tpg_param_attrs;
109 struct configfs_attribute **tfc_tpg_nacl_base_attrs;
110 struct configfs_attribute **tfc_tpg_nacl_attrib_attrs;
111 struct configfs_attribute **tfc_tpg_nacl_auth_attrs;
112 struct configfs_attribute **tfc_tpg_nacl_param_attrs;
113
114 /*
115 * Set this member variable to true if the SCSI transport protocol
116 * (e.g. iSCSI) requires that the Data-Out buffer is transferred in
117 * its entirety before a command is aborted.
118 */
119 bool write_pending_must_be_called;
120};
121
122int target_register_template(const struct target_core_fabric_ops *fo);
123void target_unregister_template(const struct target_core_fabric_ops *fo);
124
125int target_depend_item(struct config_item *item);
126void target_undepend_item(struct config_item *item);
127
128struct se_session *target_setup_session(struct se_portal_group *,
129 unsigned int, unsigned int, enum target_prot_op prot_op,
130 const char *, void *,
131 int (*callback)(struct se_portal_group *,
132 struct se_session *, void *));
133void target_remove_session(struct se_session *);
134
135int transport_init_session(struct se_session *se_sess);
136struct se_session *transport_alloc_session(enum target_prot_op);
137int transport_alloc_session_tags(struct se_session *, unsigned int,
138 unsigned int);
139void __transport_register_session(struct se_portal_group *,
140 struct se_node_acl *, struct se_session *, void *);
141void transport_register_session(struct se_portal_group *,
142 struct se_node_acl *, struct se_session *, void *);
143ssize_t target_show_dynamic_sessions(struct se_portal_group *, char *);
144void transport_free_session(struct se_session *);
145void target_spc2_release(struct se_node_acl *nacl);
146void target_put_nacl(struct se_node_acl *);
147void transport_deregister_session_configfs(struct se_session *);
148void transport_deregister_session(struct se_session *);
149
150
151void transport_init_se_cmd(struct se_cmd *,
152 const struct target_core_fabric_ops *,
153 struct se_session *, u32, int, int, unsigned char *, u64);
154sense_reason_t transport_lookup_cmd_lun(struct se_cmd *);
155sense_reason_t target_cmd_init_cdb(struct se_cmd *, unsigned char *);
156sense_reason_t target_cmd_parse_cdb(struct se_cmd *);
157int target_submit_cmd_map_sgls(struct se_cmd *, struct se_session *,
158 unsigned char *, unsigned char *, u64, u32, int, int, int,
159 struct scatterlist *, u32, struct scatterlist *, u32,
160 struct scatterlist *, u32);
161int target_submit_cmd(struct se_cmd *, struct se_session *, unsigned char *,
162 unsigned char *, u64, u32, int, int, int);
163int target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
164 unsigned char *sense, u64 unpacked_lun,
165 void *fabric_tmr_ptr, unsigned char tm_type,
166 gfp_t, u64, int);
167int transport_handle_cdb_direct(struct se_cmd *);
168sense_reason_t transport_generic_new_cmd(struct se_cmd *);
169
170void target_put_cmd_and_wait(struct se_cmd *cmd);
171void target_execute_cmd(struct se_cmd *cmd);
172
173int transport_generic_free_cmd(struct se_cmd *, int);
174
175bool transport_wait_for_tasks(struct se_cmd *);
176int transport_send_check_condition_and_sense(struct se_cmd *,
177 sense_reason_t, int);
178int target_send_busy(struct se_cmd *cmd);
179int target_get_sess_cmd(struct se_cmd *, bool);
180int target_put_sess_cmd(struct se_cmd *);
181void target_sess_cmd_list_set_waiting(struct se_session *);
182void target_wait_for_sess_cmds(struct se_session *);
183void target_show_cmd(const char *pfx, struct se_cmd *cmd);
184
185int core_alua_check_nonop_delay(struct se_cmd *);
186
187int core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
188void core_tmr_release_req(struct se_tmr_req *);
189int transport_generic_handle_tmr(struct se_cmd *);
190void transport_generic_request_failure(struct se_cmd *, sense_reason_t);
191int transport_lookup_tmr_lun(struct se_cmd *);
192void core_allocate_nexus_loss_ua(struct se_node_acl *acl);
193
194struct se_node_acl *core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
195 unsigned char *);
196bool target_tpg_has_node_acl(struct se_portal_group *tpg,
197 const char *);
198struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
199 unsigned char *);
200int core_tpg_set_initiator_node_queue_depth(struct se_node_acl *, u32);
201int core_tpg_set_initiator_node_tag(struct se_portal_group *,
202 struct se_node_acl *, const char *);
203int core_tpg_register(struct se_wwn *, struct se_portal_group *, int);
204int core_tpg_deregister(struct se_portal_group *);
205
206int target_alloc_sgl(struct scatterlist **sgl, unsigned int *nents,
207 u32 length, bool zero_page, bool chainable);
208void target_free_sgl(struct scatterlist *sgl, int nents);
209
210/*
211 * The LIO target core uses DMA_TO_DEVICE to mean that data is going
212 * to the target (eg handling a WRITE) and DMA_FROM_DEVICE to mean
213 * that data is coming from the target (eg handling a READ). However,
214 * this is just the opposite of what we have to tell the DMA mapping
215 * layer -- eg when handling a READ, the HBA will have to DMA the data
216 * out of memory so it can send it to the initiator, which means we
217 * need to use DMA_TO_DEVICE when we map the data.
218 */
219static inline enum dma_data_direction
220target_reverse_dma_direction(struct se_cmd *se_cmd)
221{
222 if (se_cmd->se_cmd_flags & SCF_BIDI)
223 return DMA_BIDIRECTIONAL;
224
225 switch (se_cmd->data_direction) {
226 case DMA_TO_DEVICE:
227 return DMA_FROM_DEVICE;
228 case DMA_FROM_DEVICE:
229 return DMA_TO_DEVICE;
230 case DMA_NONE:
231 default:
232 return DMA_NONE;
233 }
234}
235
236#endif /* TARGET_CORE_FABRICH */
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 size_t node_acl_size;
8 /*
9 * Limits number of scatterlist entries per SCF_SCSI_DATA_CDB payload.
10 * Setting this value tells target-core to enforce this limit, and
11 * report as INQUIRY EVPD=b0 MAXIMUM TRANSFER LENGTH.
12 *
13 * target-core will currently reset se_cmd->data_length to this
14 * maximum size, and set UNDERFLOW residual count if length exceeds
15 * this limit.
16 *
17 * XXX: Not all initiator hosts honor this block-limit EVPD
18 * XXX: Currently assumes single PAGE_SIZE per scatterlist entry
19 */
20 u32 max_data_sg_nents;
21 char *(*get_fabric_name)(void);
22 char *(*tpg_get_wwn)(struct se_portal_group *);
23 u16 (*tpg_get_tag)(struct se_portal_group *);
24 u32 (*tpg_get_default_depth)(struct se_portal_group *);
25 int (*tpg_check_demo_mode)(struct se_portal_group *);
26 int (*tpg_check_demo_mode_cache)(struct se_portal_group *);
27 int (*tpg_check_demo_mode_write_protect)(struct se_portal_group *);
28 int (*tpg_check_prod_mode_write_protect)(struct se_portal_group *);
29 /*
30 * Optionally used by fabrics to allow demo-mode login, but not
31 * expose any TPG LUNs, and return 'not connected' in standard
32 * inquiry response
33 */
34 int (*tpg_check_demo_mode_login_only)(struct se_portal_group *);
35 /*
36 * Optionally used as a configfs tunable to determine when
37 * target-core should signal the PROTECT=1 feature bit for
38 * backends that don't support T10-PI, so that either fabric
39 * HW offload or target-core emulation performs the associated
40 * WRITE_STRIP and READ_INSERT operations.
41 */
42 int (*tpg_check_prot_fabric_only)(struct se_portal_group *);
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 /*
54 * Called with spin_lock_bh(struct se_portal_group->session_lock held.
55 */
56 int (*shutdown_session)(struct se_session *);
57 void (*close_session)(struct se_session *);
58 u32 (*sess_get_index)(struct se_session *);
59 /*
60 * Used only for SCSI fabrics that contain multi-value TransportIDs
61 * (like iSCSI). All other SCSI fabrics should set this to NULL.
62 */
63 u32 (*sess_get_initiator_sid)(struct se_session *,
64 unsigned char *, u32);
65 int (*write_pending)(struct se_cmd *);
66 int (*write_pending_status)(struct se_cmd *);
67 void (*set_default_node_attributes)(struct se_node_acl *);
68 int (*get_cmd_state)(struct se_cmd *);
69 int (*queue_data_in)(struct se_cmd *);
70 int (*queue_status)(struct se_cmd *);
71 void (*queue_tm_rsp)(struct se_cmd *);
72 void (*aborted_task)(struct se_cmd *);
73 /*
74 * fabric module calls for target_core_fabric_configfs.c
75 */
76 struct se_wwn *(*fabric_make_wwn)(struct target_fabric_configfs *,
77 struct config_group *, const char *);
78 void (*fabric_drop_wwn)(struct se_wwn *);
79 void (*add_wwn_groups)(struct se_wwn *);
80 struct se_portal_group *(*fabric_make_tpg)(struct se_wwn *,
81 struct config_group *, const char *);
82 void (*fabric_drop_tpg)(struct se_portal_group *);
83 int (*fabric_post_link)(struct se_portal_group *,
84 struct se_lun *);
85 void (*fabric_pre_unlink)(struct se_portal_group *,
86 struct se_lun *);
87 struct se_tpg_np *(*fabric_make_np)(struct se_portal_group *,
88 struct config_group *, const char *);
89 void (*fabric_drop_np)(struct se_tpg_np *);
90 int (*fabric_init_nodeacl)(struct se_node_acl *, const char *);
91
92 struct configfs_attribute **tfc_discovery_attrs;
93 struct configfs_attribute **tfc_wwn_attrs;
94 struct configfs_attribute **tfc_tpg_base_attrs;
95 struct configfs_attribute **tfc_tpg_np_base_attrs;
96 struct configfs_attribute **tfc_tpg_attrib_attrs;
97 struct configfs_attribute **tfc_tpg_auth_attrs;
98 struct configfs_attribute **tfc_tpg_param_attrs;
99 struct configfs_attribute **tfc_tpg_nacl_base_attrs;
100 struct configfs_attribute **tfc_tpg_nacl_attrib_attrs;
101 struct configfs_attribute **tfc_tpg_nacl_auth_attrs;
102 struct configfs_attribute **tfc_tpg_nacl_param_attrs;
103};
104
105int target_register_template(const struct target_core_fabric_ops *fo);
106void target_unregister_template(const struct target_core_fabric_ops *fo);
107
108int target_depend_item(struct config_item *item);
109void target_undepend_item(struct config_item *item);
110
111struct se_session *target_alloc_session(struct se_portal_group *,
112 unsigned int, unsigned int, enum target_prot_op prot_op,
113 const char *, void *,
114 int (*callback)(struct se_portal_group *,
115 struct se_session *, void *));
116
117struct se_session *transport_init_session(enum target_prot_op);
118int transport_alloc_session_tags(struct se_session *, unsigned int,
119 unsigned int);
120struct se_session *transport_init_session_tags(unsigned int, unsigned int,
121 enum target_prot_op);
122void __transport_register_session(struct se_portal_group *,
123 struct se_node_acl *, struct se_session *, void *);
124void transport_register_session(struct se_portal_group *,
125 struct se_node_acl *, struct se_session *, void *);
126int target_get_session(struct se_session *);
127void target_put_session(struct se_session *);
128ssize_t target_show_dynamic_sessions(struct se_portal_group *, char *);
129void transport_free_session(struct se_session *);
130void target_put_nacl(struct se_node_acl *);
131void transport_deregister_session_configfs(struct se_session *);
132void transport_deregister_session(struct se_session *);
133
134
135void transport_init_se_cmd(struct se_cmd *,
136 const struct target_core_fabric_ops *,
137 struct se_session *, u32, int, int, unsigned char *);
138sense_reason_t transport_lookup_cmd_lun(struct se_cmd *, u64);
139sense_reason_t target_setup_cmd_from_cdb(struct se_cmd *, unsigned char *);
140int target_submit_cmd_map_sgls(struct se_cmd *, struct se_session *,
141 unsigned char *, unsigned char *, u64, u32, int, int, int,
142 struct scatterlist *, u32, struct scatterlist *, u32,
143 struct scatterlist *, u32);
144int target_submit_cmd(struct se_cmd *, struct se_session *, unsigned char *,
145 unsigned char *, u64, u32, int, int, int);
146int target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
147 unsigned char *sense, u64 unpacked_lun,
148 void *fabric_tmr_ptr, unsigned char tm_type,
149 gfp_t, u64, int);
150int transport_handle_cdb_direct(struct se_cmd *);
151sense_reason_t transport_generic_new_cmd(struct se_cmd *);
152
153void target_execute_cmd(struct se_cmd *cmd);
154
155int transport_generic_free_cmd(struct se_cmd *, int);
156
157bool transport_wait_for_tasks(struct se_cmd *);
158int transport_check_aborted_status(struct se_cmd *, int);
159int transport_send_check_condition_and_sense(struct se_cmd *,
160 sense_reason_t, int);
161int target_get_sess_cmd(struct se_cmd *, bool);
162int target_put_sess_cmd(struct se_cmd *);
163void target_sess_cmd_list_set_waiting(struct se_session *);
164void target_wait_for_sess_cmds(struct se_session *);
165
166int core_alua_check_nonop_delay(struct se_cmd *);
167
168int core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
169void core_tmr_release_req(struct se_tmr_req *);
170int transport_generic_handle_tmr(struct se_cmd *);
171void transport_generic_request_failure(struct se_cmd *, sense_reason_t);
172void __target_execute_cmd(struct se_cmd *);
173int transport_lookup_tmr_lun(struct se_cmd *, u64);
174void core_allocate_nexus_loss_ua(struct se_node_acl *acl);
175
176struct se_node_acl *core_tpg_get_initiator_node_acl(struct se_portal_group *tpg,
177 unsigned char *);
178bool target_tpg_has_node_acl(struct se_portal_group *tpg,
179 const char *);
180struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
181 unsigned char *);
182int core_tpg_set_initiator_node_queue_depth(struct se_node_acl *, u32);
183int core_tpg_set_initiator_node_tag(struct se_portal_group *,
184 struct se_node_acl *, const char *);
185int core_tpg_register(struct se_wwn *, struct se_portal_group *, int);
186int core_tpg_deregister(struct se_portal_group *);
187
188/*
189 * The LIO target core uses DMA_TO_DEVICE to mean that data is going
190 * to the target (eg handling a WRITE) and DMA_FROM_DEVICE to mean
191 * that data is coming from the target (eg handling a READ). However,
192 * this is just the opposite of what we have to tell the DMA mapping
193 * layer -- eg when handling a READ, the HBA will have to DMA the data
194 * out of memory so it can send it to the initiator, which means we
195 * need to use DMA_TO_DEVICE when we map the data.
196 */
197static inline enum dma_data_direction
198target_reverse_dma_direction(struct se_cmd *se_cmd)
199{
200 if (se_cmd->se_cmd_flags & SCF_BIDI)
201 return DMA_BIDIRECTIONAL;
202
203 switch (se_cmd->data_direction) {
204 case DMA_TO_DEVICE:
205 return DMA_FROM_DEVICE;
206 case DMA_FROM_DEVICE:
207 return DMA_TO_DEVICE;
208 case DMA_NONE:
209 default:
210 return DMA_NONE;
211 }
212}
213
214#endif /* TARGET_CORE_FABRICH */