xref: /linux/include/target/target_core_fabric.h (revision d97b46a64674a267bc41c9e16132ee2a98c3347d)
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 function pointer for TCM to perform command map
37 	 * from TCM processing thread context, for those struct se_cmd
38 	 * initially allocated in interrupt context.
39 	 */
40 	int (*new_cmd_map)(struct se_cmd *);
41 	/*
42 	 * Optional to release struct se_cmd and fabric dependent allocated
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.
47 	 */
48 	int (*check_stop_free)(struct se_cmd *);
49 	void (*release_cmd)(struct se_cmd *);
50 	/*
51 	 * Called with spin_lock_bh(struct se_portal_group->session_lock held.
52 	 */
53 	int (*shutdown_session)(struct se_session *);
54 	void (*close_session)(struct se_session *);
55 	u32 (*sess_get_index)(struct se_session *);
56 	/*
57 	 * Used only for SCSI fabrics that contain multi-value TransportIDs
58 	 * (like iSCSI).  All other SCSI fabrics should set this to NULL.
59 	 */
60 	u32 (*sess_get_initiator_sid)(struct se_session *,
61 				      unsigned char *, u32);
62 	int (*write_pending)(struct se_cmd *);
63 	int (*write_pending_status)(struct se_cmd *);
64 	void (*set_default_node_attributes)(struct se_node_acl *);
65 	u32 (*get_task_tag)(struct se_cmd *);
66 	int (*get_cmd_state)(struct se_cmd *);
67 	int (*queue_data_in)(struct se_cmd *);
68 	int (*queue_status)(struct se_cmd *);
69 	int (*queue_tm_rsp)(struct se_cmd *);
70 	u16 (*set_fabric_sense_len)(struct se_cmd *, u32);
71 	u16 (*get_fabric_sense_len)(void);
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 *);
88 	struct se_node_acl *(*fabric_make_nodeacl)(struct se_portal_group *,
89 				struct config_group *, const char *);
90 	void (*fabric_drop_nodeacl)(struct se_node_acl *);
91 };
92 
93 struct se_session *transport_init_session(void);
94 void	__transport_register_session(struct se_portal_group *,
95 		struct se_node_acl *, struct se_session *, void *);
96 void	transport_register_session(struct se_portal_group *,
97 		struct se_node_acl *, struct se_session *, void *);
98 void	target_get_session(struct se_session *);
99 void	target_put_session(struct se_session *);
100 void	transport_free_session(struct se_session *);
101 void	target_put_nacl(struct se_node_acl *);
102 void	transport_deregister_session_configfs(struct se_session *);
103 void	transport_deregister_session(struct se_session *);
104 
105 
106 void	transport_init_se_cmd(struct se_cmd *, struct target_core_fabric_ops *,
107 		struct se_session *, u32, int, int, unsigned char *);
108 int	transport_lookup_cmd_lun(struct se_cmd *, u32);
109 int	target_setup_cmd_from_cdb(struct se_cmd *, unsigned char *);
110 void	target_submit_cmd(struct se_cmd *, struct se_session *, unsigned char *,
111 		unsigned char *, u32, u32, int, int, int);
112 int	target_submit_tmr(struct se_cmd *se_cmd, struct se_session *se_sess,
113 		unsigned char *sense, u32 unpacked_lun,
114 		void *fabric_tmr_ptr, unsigned char tm_type,
115 		gfp_t, unsigned int, int);
116 int	transport_handle_cdb_direct(struct se_cmd *);
117 int	transport_generic_handle_cdb_map(struct se_cmd *);
118 int	transport_generic_handle_data(struct se_cmd *);
119 int	transport_generic_map_mem_to_cmd(struct se_cmd *cmd,
120 		struct scatterlist *, u32, struct scatterlist *, u32);
121 int	transport_generic_new_cmd(struct se_cmd *);
122 
123 void	transport_generic_process_write(struct se_cmd *);
124 
125 void	transport_generic_free_cmd(struct se_cmd *, int);
126 
127 bool	transport_wait_for_tasks(struct se_cmd *);
128 int	transport_check_aborted_status(struct se_cmd *, int);
129 int	transport_send_check_condition_and_sense(struct se_cmd *, u8, int);
130 
131 void	target_get_sess_cmd(struct se_session *, struct se_cmd *, bool);
132 int	target_put_sess_cmd(struct se_session *, struct se_cmd *);
133 void	target_splice_sess_cmd_list(struct se_session *);
134 void	target_wait_for_sess_cmds(struct se_session *, int);
135 
136 int	core_alua_check_nonop_delay(struct se_cmd *);
137 
138 int	core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
139 void	core_tmr_release_req(struct se_tmr_req *);
140 int	transport_generic_handle_tmr(struct se_cmd *);
141 void	transport_generic_request_failure(struct se_cmd *);
142 int	transport_lookup_tmr_lun(struct se_cmd *, u32);
143 
144 struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
145 		unsigned char *);
146 void	core_tpg_clear_object_luns(struct se_portal_group *);
147 struct se_node_acl *core_tpg_add_initiator_node_acl(struct se_portal_group *,
148 		struct se_node_acl *, const char *, u32);
149 int	core_tpg_del_initiator_node_acl(struct se_portal_group *,
150 		struct se_node_acl *, int);
151 int	core_tpg_set_initiator_node_queue_depth(struct se_portal_group *,
152 		unsigned char *, u32, int);
153 int	core_tpg_register(struct target_core_fabric_ops *, struct se_wwn *,
154 		struct se_portal_group *, void *, int);
155 int	core_tpg_deregister(struct se_portal_group *);
156 
157 /* SAS helpers */
158 u8	sas_get_fabric_proto_ident(struct se_portal_group *);
159 u32	sas_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
160 		struct t10_pr_registration *, int *, unsigned char *);
161 u32	sas_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
162 		struct t10_pr_registration *, int *);
163 char	*sas_parse_pr_out_transport_id(struct se_portal_group *, const char *,
164 		u32 *, char **);
165 
166 /* FC helpers */
167 u8	fc_get_fabric_proto_ident(struct se_portal_group *);
168 u32	fc_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
169 		struct t10_pr_registration *, int *, unsigned char *);
170 u32	fc_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
171 		struct t10_pr_registration *, int *);
172 char	*fc_parse_pr_out_transport_id(struct se_portal_group *, const char *,
173 		u32 *, char **);
174 
175 /* iSCSI helpers */
176 u8	iscsi_get_fabric_proto_ident(struct se_portal_group *);
177 u32	iscsi_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
178 		struct t10_pr_registration *, int *, unsigned char *);
179 u32	iscsi_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
180 		struct t10_pr_registration *, int *);
181 char	*iscsi_parse_pr_out_transport_id(struct se_portal_group *, const char *,
182 		u32 *, char **);
183 
184 #endif /* TARGET_CORE_FABRICH */
185