[linux-block.git] / include / target / iscsi / iscsi_transport.h

/* SPDX-License-Identifier: GPL-2.0 */
#include "iscsi_target_core.h" /* struct iscsit_cmd */

struct sockaddr_storage;

struct iscsit_transport {
#define ISCSIT_TRANSPORT_NAME	16
	char name[ISCSIT_TRANSPORT_NAME];
	int transport_type;
	bool rdma_shutdown;
	int priv_size;
	struct module *owner;
	struct list_head t_node;
	int (*iscsit_setup_np)(struct iscsi_np *, struct sockaddr_storage *);
	int (*iscsit_accept_np)(struct iscsi_np *, struct iscsit_conn *);
	void (*iscsit_free_np)(struct iscsi_np *);
	void (*iscsit_wait_conn)(struct iscsit_conn *);
	void (*iscsit_free_conn)(struct iscsit_conn *);
	int (*iscsit_get_login_rx)(struct iscsit_conn *, struct iscsi_login *);
	int (*iscsit_put_login_tx)(struct iscsit_conn *, struct iscsi_login *, u32);
	int (*iscsit_immediate_queue)(struct iscsit_conn *, struct iscsit_cmd *, int);
	int (*iscsit_response_queue)(struct iscsit_conn *, struct iscsit_cmd *, int);
	int (*iscsit_get_dataout)(struct iscsit_conn *, struct iscsit_cmd *, bool);
	int (*iscsit_queue_data_in)(struct iscsit_conn *, struct iscsit_cmd *);
	int (*iscsit_queue_status)(struct iscsit_conn *, struct iscsit_cmd *);
	void (*iscsit_aborted_task)(struct iscsit_conn *, struct iscsit_cmd *);
	int (*iscsit_xmit_pdu)(struct iscsit_conn *, struct iscsit_cmd *,
			       struct iscsi_datain_req *, const void *, u32);
	void (*iscsit_unmap_cmd)(struct iscsit_conn *, struct iscsit_cmd *);
	void (*iscsit_get_rx_pdu)(struct iscsit_conn *);
	int (*iscsit_validate_params)(struct iscsit_conn *);
	void (*iscsit_get_r2t_ttt)(struct iscsit_conn *, struct iscsit_cmd *,
				   struct iscsi_r2t *);
	enum target_prot_op (*iscsit_get_sup_prot_ops)(struct iscsit_conn *);
};

static inline void *iscsit_priv_cmd(struct iscsit_cmd *cmd)
{
	return (void *)(cmd + 1);
}

/*
 * From iscsi_target_transport.c
 */

extern void iscsit_register_transport(struct iscsit_transport *);
extern void iscsit_unregister_transport(struct iscsit_transport *);
extern struct iscsit_transport *iscsit_get_transport(int);
extern void iscsit_put_transport(struct iscsit_transport *);

/*
 * From iscsi_target.c
 */
extern int iscsit_setup_scsi_cmd(struct iscsit_conn *, struct iscsit_cmd *,
				unsigned char *);
extern void iscsit_set_unsolicited_dataout(struct iscsit_cmd *);
extern int iscsit_process_scsi_cmd(struct iscsit_conn *, struct iscsit_cmd *,
				struct iscsi_scsi_req *);
extern int
__iscsit_check_dataout_hdr(struct iscsit_conn *, void *,
			   struct iscsit_cmd *, u32, bool *);
extern int
iscsit_check_dataout_hdr(struct iscsit_conn *conn, void *buf,
			 struct iscsit_cmd **out_cmd);
extern int iscsit_check_dataout_payload(struct iscsit_cmd *, struct iscsi_data *,
				bool);
extern int iscsit_setup_nop_out(struct iscsit_conn *, struct iscsit_cmd *,
				struct iscsi_nopout *);
extern int iscsit_process_nop_out(struct iscsit_conn *, struct iscsit_cmd *,
				struct iscsi_nopout *);
extern int iscsit_handle_logout_cmd(struct iscsit_conn *, struct iscsit_cmd *,
				unsigned char *);
extern int iscsit_handle_task_mgt_cmd(struct iscsit_conn *, struct iscsit_cmd *,
				unsigned char *);
extern int iscsit_setup_text_cmd(struct iscsit_conn *, struct iscsit_cmd *,
				 struct iscsi_text *);
extern int iscsit_process_text_cmd(struct iscsit_conn *, struct iscsit_cmd *,
				   struct iscsi_text *);
extern void iscsit_build_rsp_pdu(struct iscsit_cmd *, struct iscsit_conn *,
				bool, struct iscsi_scsi_rsp *);
extern void iscsit_build_nopin_rsp(struct iscsit_cmd *, struct iscsit_conn *,
				struct iscsi_nopin *, bool);
extern void iscsit_build_task_mgt_rsp(struct iscsit_cmd *, struct iscsit_conn *,
				struct iscsi_tm_rsp *);
extern int iscsit_build_text_rsp(struct iscsit_cmd *, struct iscsit_conn *,
				struct iscsi_text_rsp *,
				enum iscsit_transport_type);
extern void iscsit_build_reject(struct iscsit_cmd *, struct iscsit_conn *,
				struct iscsi_reject *);
extern int iscsit_build_logout_rsp(struct iscsit_cmd *, struct iscsit_conn *,
				struct iscsi_logout_rsp *);
extern int iscsit_logout_post_handler(struct iscsit_cmd *, struct iscsit_conn *);
extern int iscsit_queue_rsp(struct iscsit_conn *, struct iscsit_cmd *);
extern void iscsit_aborted_task(struct iscsit_conn *, struct iscsit_cmd *);
extern int iscsit_add_reject(struct iscsit_conn *, u8, unsigned char *);
extern int iscsit_reject_cmd(struct iscsit_cmd *, u8, unsigned char *);
extern int iscsit_handle_snack(struct iscsit_conn *, unsigned char *);
extern void iscsit_build_datain_pdu(struct iscsit_cmd *, struct iscsit_conn *,
				    struct iscsi_datain *,
				    struct iscsi_data_rsp *, bool);
extern int iscsit_build_r2ts_for_cmd(struct iscsit_conn *, struct iscsit_cmd *,
				     bool);
extern int iscsit_immediate_queue(struct iscsit_conn *, struct iscsit_cmd *, int);
extern int iscsit_response_queue(struct iscsit_conn *, struct iscsit_cmd *, int);
/*
 * From iscsi_target_device.c
 */
extern void iscsit_increment_maxcmdsn(struct iscsit_cmd *, struct iscsit_session *);
/*
 * From iscsi_target_erl0.c
 */
extern void iscsit_cause_connection_reinstatement(struct iscsit_conn *, int);
/*
 * From iscsi_target_erl1.c
 */
extern void iscsit_stop_dataout_timer(struct iscsit_cmd *);

/*
 * From iscsi_target_tmr.c
 */
extern int iscsit_tmr_post_handler(struct iscsit_cmd *, struct iscsit_conn *);

/*
 * From iscsi_target_util.c
 */
extern struct iscsit_cmd *iscsit_allocate_cmd(struct iscsit_conn *, int);
extern int iscsit_sequence_cmd(struct iscsit_conn *, struct iscsit_cmd *,
			       unsigned char *, __be32);
extern void iscsit_release_cmd(struct iscsit_cmd *);
extern void iscsit_free_cmd(struct iscsit_cmd *, bool);
extern void iscsit_add_cmd_to_immediate_queue(struct iscsit_cmd *,
					      struct iscsit_conn *, u8);
extern struct iscsit_cmd *
iscsit_find_cmd_from_itt_or_dump(struct iscsit_conn *conn,
				 itt_t init_task_tag, u32 length);

/*
 * From iscsi_target_nego.c
 */
extern int iscsi_target_check_login_request(struct iscsit_conn *,
					    struct iscsi_login *);

/*
 * From iscsi_target_login.c
 */
extern __printf(2, 3) int iscsi_change_param_sprintf(
	struct iscsit_conn *, const char *, ...);

/*
 * From iscsi_target_parameters.c
 */
extern struct iscsi_param *iscsi_find_param_from_key(
	char *, struct iscsi_param_list *);
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
66cd9d4e	2	#include "iscsi_target_core.h" /* struct iscsit_cmd */
8dcf07be BVA	3
8dcf07be BVA	4	struct sockaddr_storage;
3f993063 NB	5
	6	struct iscsit_transport {
	7	#define ISCSIT_TRANSPORT_NAME 16
	8	char name[ISCSIT_TRANSPORT_NAME];
	9	int transport_type;
bd027d85	10	bool rdma_shutdown;
d703ce2f	11	int priv_size;
3f993063 NB	12	struct module *owner;
3f993063 NB	13	struct list_head t_node;
13a3cf08	14	int (iscsit_setup_np)(struct iscsi_np , struct sockaddr_storage *);
be36d683	15	int (iscsit_accept_np)(struct iscsi_np , struct iscsit_conn *);
3f993063	16	void (iscsit_free_np)(struct iscsi_np );
be36d683 MG	17	void (iscsit_wait_conn)(struct iscsit_conn );
	18	void (iscsit_free_conn)(struct iscsit_conn );
	19	int (iscsit_get_login_rx)(struct iscsit_conn , struct iscsi_login *);
	20	int (iscsit_put_login_tx)(struct iscsit_conn , struct iscsi_login *, u32);
	21	int (iscsit_immediate_queue)(struct iscsit_conn , struct iscsit_cmd *, int);
	22	int (iscsit_response_queue)(struct iscsit_conn , struct iscsit_cmd *, int);
	23	int (iscsit_get_dataout)(struct iscsit_conn , struct iscsit_cmd *, bool);
	24	int (iscsit_queue_data_in)(struct iscsit_conn , struct iscsit_cmd *);
	25	int (iscsit_queue_status)(struct iscsit_conn , struct iscsit_cmd *);
	26	void (iscsit_aborted_task)(struct iscsit_conn , struct iscsit_cmd *);
	27	int (iscsit_xmit_pdu)(struct iscsit_conn , struct iscsit_cmd *,
2854bb23	28	struct iscsi_datain_req , const void , u32);
be36d683 MG	29	void (iscsit_unmap_cmd)(struct iscsit_conn , struct iscsit_cmd *);
	30	void (iscsit_get_rx_pdu)(struct iscsit_conn );
	31	int (iscsit_validate_params)(struct iscsit_conn );
	32	void (iscsit_get_r2t_ttt)(struct iscsit_conn , struct iscsit_cmd *,
8567270d	33	struct iscsi_r2t *);
be36d683	34	enum target_prot_op (iscsit_get_sup_prot_ops)(struct iscsit_conn );
3f993063 NB	35	};
3f993063 NB	36
66cd9d4e	37	static inline void iscsit_priv_cmd(struct iscsit_cmd cmd)
d703ce2f NB	38	{
	39	return (void *)(cmd + 1);
	40	}
	41
3f993063 NB	42	/*
	43	* From iscsi_target_transport.c
	44	*/
	45
a8ac7835	46	extern void iscsit_register_transport(struct iscsit_transport *);
3f993063 NB	47	extern void iscsit_unregister_transport(struct iscsit_transport *);
	48	extern struct iscsit_transport *iscsit_get_transport(int);
	49	extern void iscsit_put_transport(struct iscsit_transport *);
	50
	51	/*
	52	* From iscsi_target.c
	53	*/
be36d683	54	extern int iscsit_setup_scsi_cmd(struct iscsit_conn , struct iscsit_cmd ,
3f993063	55	unsigned char *);
66cd9d4e	56	extern void iscsit_set_unsolicited_dataout(struct iscsit_cmd *);
be36d683	57	extern int iscsit_process_scsi_cmd(struct iscsit_conn , struct iscsit_cmd ,
3f993063	58	struct iscsi_scsi_req *);
9a584bf9	59	extern int
be36d683	60	__iscsit_check_dataout_hdr(struct iscsit_conn , void ,
66cd9d4e	61	struct iscsit_cmd , u32, bool );
9a584bf9	62	extern int
be36d683	63	iscsit_check_dataout_hdr(struct iscsit_conn conn, void buf,
66cd9d4e MG	64	struct iscsit_cmd **out_cmd);
66cd9d4e MG	65	extern int iscsit_check_dataout_payload(struct iscsit_cmd , struct iscsi_data ,
3f993063	66	bool);
be36d683	67	extern int iscsit_setup_nop_out(struct iscsit_conn , struct iscsit_cmd ,
778de368	68	struct iscsi_nopout *);
be36d683	69	extern int iscsit_process_nop_out(struct iscsit_conn , struct iscsit_cmd ,
778de368	70	struct iscsi_nopout *);
be36d683	71	extern int iscsit_handle_logout_cmd(struct iscsit_conn , struct iscsit_cmd ,
3f993063	72	unsigned char *);
be36d683	73	extern int iscsit_handle_task_mgt_cmd(struct iscsit_conn , struct iscsit_cmd ,
3f993063	74	unsigned char *);
be36d683	75	extern int iscsit_setup_text_cmd(struct iscsit_conn , struct iscsit_cmd ,
64534aa7	76	struct iscsi_text *);
be36d683	77	extern int iscsit_process_text_cmd(struct iscsit_conn , struct iscsit_cmd ,
64534aa7	78	struct iscsi_text *);
be36d683	79	extern void iscsit_build_rsp_pdu(struct iscsit_cmd , struct iscsit_conn ,
3f993063	80	bool, struct iscsi_scsi_rsp *);
be36d683	81	extern void iscsit_build_nopin_rsp(struct iscsit_cmd , struct iscsit_conn ,
3f993063	82	struct iscsi_nopin *, bool);
be36d683	83	extern void iscsit_build_task_mgt_rsp(struct iscsit_cmd , struct iscsit_conn ,
3f993063	84	struct iscsi_tm_rsp *);
be36d683	85	extern int iscsit_build_text_rsp(struct iscsit_cmd , struct iscsit_conn ,
22c7aaa5 SG	86	struct iscsi_text_rsp *,
22c7aaa5 SG	87	enum iscsit_transport_type);
be36d683	88	extern void iscsit_build_reject(struct iscsit_cmd , struct iscsit_conn ,
3f993063	89	struct iscsi_reject *);
be36d683	90	extern int iscsit_build_logout_rsp(struct iscsit_cmd , struct iscsit_conn ,
3f993063	91	struct iscsi_logout_rsp *);
be36d683 MG	92	extern int iscsit_logout_post_handler(struct iscsit_cmd , struct iscsit_conn );
	93	extern int iscsit_queue_rsp(struct iscsit_conn , struct iscsit_cmd );
	94	extern void iscsit_aborted_task(struct iscsit_conn , struct iscsit_cmd );
	95	extern int iscsit_add_reject(struct iscsit_conn , u8, unsigned char );
66cd9d4e	96	extern int iscsit_reject_cmd(struct iscsit_cmd , u8, unsigned char );
be36d683 MG	97	extern int iscsit_handle_snack(struct iscsit_conn , unsigned char );
be36d683 MG	98	extern void iscsit_build_datain_pdu(struct iscsit_cmd , struct iscsit_conn ,
d2faaefb VP	99	struct iscsi_datain *,
d2faaefb VP	100	struct iscsi_data_rsp *, bool);
be36d683	101	extern int iscsit_build_r2ts_for_cmd(struct iscsit_conn , struct iscsit_cmd ,
d2faaefb	102	bool);
be36d683 MG	103	extern int iscsit_immediate_queue(struct iscsit_conn , struct iscsit_cmd , int);
be36d683 MG	104	extern int iscsit_response_queue(struct iscsit_conn , struct iscsit_cmd , int);
3f993063 NB	105	/*
	106	* From iscsi_target_device.c
	107	*/
0873fe44	108	extern void iscsit_increment_maxcmdsn(struct iscsit_cmd , struct iscsit_session );
b2cb9649 NB	109	/*
	110	* From iscsi_target_erl0.c
	111	*/
be36d683	112	extern void iscsit_cause_connection_reinstatement(struct iscsit_conn *, int);
3f993063 NB	113	/*
	114	* From iscsi_target_erl1.c
	115	*/
66cd9d4e	116	extern void iscsit_stop_dataout_timer(struct iscsit_cmd *);
3f993063 NB	117
	118	/*
	119	* From iscsi_target_tmr.c
	120	*/
be36d683	121	extern int iscsit_tmr_post_handler(struct iscsit_cmd , struct iscsit_conn );
3f993063 NB	122
	123	/*
	124	* From iscsi_target_util.c
	125	*/
be36d683 MG	126	extern struct iscsit_cmd iscsit_allocate_cmd(struct iscsit_conn , int);
be36d683 MG	127	extern int iscsit_sequence_cmd(struct iscsit_conn , struct iscsit_cmd ,
561bf158	128	unsigned char *, __be32);
66cd9d4e MG	129	extern void iscsit_release_cmd(struct iscsit_cmd *);
	130	extern void iscsit_free_cmd(struct iscsit_cmd *, bool);
	131	extern void iscsit_add_cmd_to_immediate_queue(struct iscsit_cmd *,
be36d683	132	struct iscsit_conn *, u8);
66cd9d4e	133	extern struct iscsit_cmd *
be36d683	134	iscsit_find_cmd_from_itt_or_dump(struct iscsit_conn *conn,
9a584bf9	135	itt_t init_task_tag, u32 length);
d2faaefb VP	136
	137	/*
	138	* From iscsi_target_nego.c
	139	*/
be36d683	140	extern int iscsi_target_check_login_request(struct iscsit_conn *,
d2faaefb VP	141	struct iscsi_login *);
	142
	143	/*
	144	* From iscsi_target_login.c
	145	*/
	146	extern __printf(2, 3) int iscsi_change_param_sprintf(
be36d683	147	struct iscsit_conn , const char , ...);
d2faaefb VP	148
	149	/*
	150	* From iscsi_target_parameters.c
	151	*/
	152	extern struct iscsi_param *iscsi_find_param_from_key(
	153	char , struct iscsi_param_list );