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 	/*
7 	 * Optional to signal struct se_task->task_sg[] padding entries
8 	 * for scatterlist chaining using transport_do_task_sg_link(),
9 	 * disabled by default
10 	 */
11 	bool task_sg_chaining;
12 	char *(*get_fabric_name)(void);
13 	u8 (*get_fabric_proto_ident)(struct se_portal_group *);
14 	char *(*tpg_get_wwn)(struct se_portal_group *);
15 	u16 (*tpg_get_tag)(struct se_portal_group *);
16 	u32 (*tpg_get_default_depth)(struct se_portal_group *);
17 	u32 (*tpg_get_pr_transport_id)(struct se_portal_group *,
18 				struct se_node_acl *,
19 				struct t10_pr_registration *, int *,
20 				unsigned char *);
21 	u32 (*tpg_get_pr_transport_id_len)(struct se_portal_group *,
22 				struct se_node_acl *,
23 				struct t10_pr_registration *, int *);
24 	char *(*tpg_parse_pr_out_transport_id)(struct se_portal_group *,
25 				const char *, u32 *, char **);
26 	int (*tpg_check_demo_mode)(struct se_portal_group *);
27 	int (*tpg_check_demo_mode_cache)(struct se_portal_group *);
28 	int (*tpg_check_demo_mode_write_protect)(struct se_portal_group *);
29 	int (*tpg_check_prod_mode_write_protect)(struct se_portal_group *);
30 	/*
31 	 * Optionally used by fabrics to allow demo-mode login, but not
32 	 * expose any TPG LUNs, and return 'not connected' in standard
33 	 * inquiry response
34 	 */
35 	int (*tpg_check_demo_mode_login_only)(struct se_portal_group *);
36 	struct se_node_acl *(*tpg_alloc_fabric_acl)(
37 					struct se_portal_group *);
38 	void (*tpg_release_fabric_acl)(struct se_portal_group *,
39 					struct se_node_acl *);
40 	u32 (*tpg_get_inst_index)(struct se_portal_group *);
41 	/*
42 	 * Optional function pointer for TCM to perform command map
43 	 * from TCM processing thread context, for those struct se_cmd
44 	 * initially allocated in interrupt context.
45 	 */
46 	int (*new_cmd_map)(struct se_cmd *);
47 	/*
48 	 * Optional to release struct se_cmd and fabric dependent allocated
49 	 * I/O descriptor in transport_cmd_check_stop().
50 	 *
51 	 * Returning 1 will signal a descriptor has been released.
52 	 * Returning 0 will signal a descriptor has not been released.
53 	 */
54 	int (*check_stop_free)(struct se_cmd *);
55 	void (*release_cmd)(struct se_cmd *);
56 	/*
57 	 * Called with spin_lock_bh(struct se_portal_group->session_lock held.
58 	 */
59 	int (*shutdown_session)(struct se_session *);
60 	void (*close_session)(struct se_session *);
61 	u32 (*sess_get_index)(struct se_session *);
62 	/*
63 	 * Used only for SCSI fabrics that contain multi-value TransportIDs
64 	 * (like iSCSI).  All other SCSI fabrics should set this to NULL.
65 	 */
66 	u32 (*sess_get_initiator_sid)(struct se_session *,
67 				      unsigned char *, u32);
68 	int (*write_pending)(struct se_cmd *);
69 	int (*write_pending_status)(struct se_cmd *);
70 	void (*set_default_node_attributes)(struct se_node_acl *);
71 	u32 (*get_task_tag)(struct se_cmd *);
72 	int (*get_cmd_state)(struct se_cmd *);
73 	int (*queue_data_in)(struct se_cmd *);
74 	int (*queue_status)(struct se_cmd *);
75 	int (*queue_tm_rsp)(struct se_cmd *);
76 	u16 (*set_fabric_sense_len)(struct se_cmd *, u32);
77 	u16 (*get_fabric_sense_len)(void);
78 	/*
79 	 * fabric module calls for target_core_fabric_configfs.c
80 	 */
81 	struct se_wwn *(*fabric_make_wwn)(struct target_fabric_configfs *,
82 				struct config_group *, const char *);
83 	void (*fabric_drop_wwn)(struct se_wwn *);
84 	struct se_portal_group *(*fabric_make_tpg)(struct se_wwn *,
85 				struct config_group *, const char *);
86 	void (*fabric_drop_tpg)(struct se_portal_group *);
87 	int (*fabric_post_link)(struct se_portal_group *,
88 				struct se_lun *);
89 	void (*fabric_pre_unlink)(struct se_portal_group *,
90 				struct se_lun *);
91 	struct se_tpg_np *(*fabric_make_np)(struct se_portal_group *,
92 				struct config_group *, const char *);
93 	void (*fabric_drop_np)(struct se_tpg_np *);
94 	struct se_node_acl *(*fabric_make_nodeacl)(struct se_portal_group *,
95 				struct config_group *, const char *);
96 	void (*fabric_drop_nodeacl)(struct se_node_acl *);
97 };
98 
99 struct se_session *transport_init_session(void);
100 void	__transport_register_session(struct se_portal_group *,
101 		struct se_node_acl *, struct se_session *, void *);
102 void	transport_register_session(struct se_portal_group *,
103 		struct se_node_acl *, struct se_session *, void *);
104 void	target_get_session(struct se_session *);
105 int	target_put_session(struct se_session *);
106 void	transport_free_session(struct se_session *);
107 void	target_put_nacl(struct se_node_acl *);
108 void	transport_deregister_session_configfs(struct se_session *);
109 void	transport_deregister_session(struct se_session *);
110 
111 
112 void	transport_init_se_cmd(struct se_cmd *, struct target_core_fabric_ops *,
113 		struct se_session *, u32, int, int, unsigned char *);
114 int	transport_lookup_cmd_lun(struct se_cmd *, u32);
115 int	transport_generic_allocate_tasks(struct se_cmd *, unsigned char *);
116 void	target_submit_cmd(struct se_cmd *, struct se_session *, unsigned char *,
117 		unsigned char *, u32, u32, int, int, int);
118 int	target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
119 		unsigned char *sense, u32 unpacked_lun,
120 		void *fabric_tmr_ptr, unsigned char tm_type,
121 		gfp_t, unsigned int, int);
122 int	transport_handle_cdb_direct(struct se_cmd *);
123 int	transport_generic_handle_cdb_map(struct se_cmd *);
124 int	transport_generic_handle_data(struct se_cmd *);
125 int	transport_generic_map_mem_to_cmd(struct se_cmd *cmd,
126 		struct scatterlist *, u32, struct scatterlist *, u32);
127 void	transport_do_task_sg_chain(struct se_cmd *);
128 int	transport_generic_new_cmd(struct se_cmd *);
129 
130 void	transport_generic_process_write(struct se_cmd *);
131 
132 void	transport_generic_free_cmd(struct se_cmd *, int);
133 
134 bool	transport_wait_for_tasks(struct se_cmd *);
135 int	transport_check_aborted_status(struct se_cmd *, int);
136 int	transport_send_check_condition_and_sense(struct se_cmd *, u8, int);
137 
138 void	target_get_sess_cmd(struct se_session *, struct se_cmd *, bool);
139 int	target_put_sess_cmd(struct se_session *, struct se_cmd *);
140 void	target_splice_sess_cmd_list(struct se_session *);
141 void	target_wait_for_sess_cmds(struct se_session *, int);
142 
143 int	core_alua_check_nonop_delay(struct se_cmd *);
144 
145 int	core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
146 void	core_tmr_release_req(struct se_tmr_req *);
147 int	transport_generic_handle_tmr(struct se_cmd *);
148 void	transport_generic_request_failure(struct se_cmd *);
149 int	transport_lookup_tmr_lun(struct se_cmd *, u32);
150 
151 struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
152 		unsigned char *);
153 void	core_tpg_clear_object_luns(struct se_portal_group *);
154 struct se_node_acl *core_tpg_add_initiator_node_acl(struct se_portal_group *,
155 		struct se_node_acl *, const char *, u32);
156 int	core_tpg_del_initiator_node_acl(struct se_portal_group *,
157 		struct se_node_acl *, int);
158 int	core_tpg_set_initiator_node_queue_depth(struct se_portal_group *,
159 		unsigned char *, u32, int);
160 int	core_tpg_register(struct target_core_fabric_ops *, struct se_wwn *,
161 		struct se_portal_group *, void *, int);
162 int	core_tpg_deregister(struct se_portal_group *);
163 
164 /* SAS helpers */
165 u8	sas_get_fabric_proto_ident(struct se_portal_group *);
166 u32	sas_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
167 		struct t10_pr_registration *, int *, unsigned char *);
168 u32	sas_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
169 		struct t10_pr_registration *, int *);
170 char	*sas_parse_pr_out_transport_id(struct se_portal_group *, const char *,
171 		u32 *, char **);
172 
173 /* FC helpers */
174 u8	fc_get_fabric_proto_ident(struct se_portal_group *);
175 u32	fc_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
176 		struct t10_pr_registration *, int *, unsigned char *);
177 u32	fc_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
178 		struct t10_pr_registration *, int *);
179 char	*fc_parse_pr_out_transport_id(struct se_portal_group *, const char *,
180 		u32 *, char **);
181 
182 /* iSCSI helpers */
183 u8	iscsi_get_fabric_proto_ident(struct se_portal_group *);
184 u32	iscsi_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
185 		struct t10_pr_registration *, int *, unsigned char *);
186 u32	iscsi_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
187 		struct t10_pr_registration *, int *);
188 char	*iscsi_parse_pr_out_transport_id(struct se_portal_group *, const char *,
189 		u32 *, char **);
190 
191 #endif /* TARGET_CORE_FABRICH */
192