xref: /freebsd/sys/dev/iscsi/icl.h (revision 009ea47eb2d21856af4529aaaca32cd67748daea)
1*009ea47eSEdward Tomasz Napierala /*-
2*009ea47eSEdward Tomasz Napierala  * Copyright (c) 2012 The FreeBSD Foundation
3*009ea47eSEdward Tomasz Napierala  * All rights reserved.
4*009ea47eSEdward Tomasz Napierala  *
5*009ea47eSEdward Tomasz Napierala  * This software was developed by Edward Tomasz Napierala under sponsorship
6*009ea47eSEdward Tomasz Napierala  * from the FreeBSD Foundation.
7*009ea47eSEdward Tomasz Napierala  *
8*009ea47eSEdward Tomasz Napierala  * Redistribution and use in source and binary forms, with or without
9*009ea47eSEdward Tomasz Napierala  * modification, are permitted provided that the following conditions
10*009ea47eSEdward Tomasz Napierala  * are met:
11*009ea47eSEdward Tomasz Napierala  * 1. Redistributions of source code must retain the above copyright
12*009ea47eSEdward Tomasz Napierala  *    notice, this list of conditions and the following disclaimer.
13*009ea47eSEdward Tomasz Napierala  * 2. Redistributions in binary form must reproduce the above copyright
14*009ea47eSEdward Tomasz Napierala  *    notice, this list of conditions and the following disclaimer in the
15*009ea47eSEdward Tomasz Napierala  *    documentation and/or other materials provided with the distribution.
16*009ea47eSEdward Tomasz Napierala  *
17*009ea47eSEdward Tomasz Napierala  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18*009ea47eSEdward Tomasz Napierala  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19*009ea47eSEdward Tomasz Napierala  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20*009ea47eSEdward Tomasz Napierala  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21*009ea47eSEdward Tomasz Napierala  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*009ea47eSEdward Tomasz Napierala  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23*009ea47eSEdward Tomasz Napierala  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24*009ea47eSEdward Tomasz Napierala  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25*009ea47eSEdward Tomasz Napierala  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26*009ea47eSEdward Tomasz Napierala  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27*009ea47eSEdward Tomasz Napierala  * SUCH DAMAGE.
28*009ea47eSEdward Tomasz Napierala  *
29*009ea47eSEdward Tomasz Napierala  * $FreeBSD$
30*009ea47eSEdward Tomasz Napierala  */
31*009ea47eSEdward Tomasz Napierala 
32*009ea47eSEdward Tomasz Napierala #ifndef ICL_H
33*009ea47eSEdward Tomasz Napierala #define	ICL_H
34*009ea47eSEdward Tomasz Napierala 
35*009ea47eSEdward Tomasz Napierala /*
36*009ea47eSEdward Tomasz Napierala  * iSCSI Common Layer.  It's used by both the initiator and target to send
37*009ea47eSEdward Tomasz Napierala  * and receive iSCSI PDUs.
38*009ea47eSEdward Tomasz Napierala  */
39*009ea47eSEdward Tomasz Napierala 
40*009ea47eSEdward Tomasz Napierala struct icl_conn;
41*009ea47eSEdward Tomasz Napierala 
42*009ea47eSEdward Tomasz Napierala struct icl_pdu {
43*009ea47eSEdward Tomasz Napierala 	TAILQ_ENTRY(icl_pdu)	ip_next;
44*009ea47eSEdward Tomasz Napierala 	struct icl_conn		*ip_conn;
45*009ea47eSEdward Tomasz Napierala 	struct iscsi_bhs	*ip_bhs;
46*009ea47eSEdward Tomasz Napierala 	struct mbuf		*ip_bhs_mbuf;
47*009ea47eSEdward Tomasz Napierala 	size_t			ip_ahs_len;
48*009ea47eSEdward Tomasz Napierala 	struct mbuf		*ip_ahs_mbuf;
49*009ea47eSEdward Tomasz Napierala 	size_t			ip_data_len;
50*009ea47eSEdward Tomasz Napierala 	struct mbuf		*ip_data_mbuf;
51*009ea47eSEdward Tomasz Napierala 
52*009ea47eSEdward Tomasz Napierala 	/*
53*009ea47eSEdward Tomasz Napierala 	 * User (initiator or provider) private fields.
54*009ea47eSEdward Tomasz Napierala 	 */
55*009ea47eSEdward Tomasz Napierala 	uint32_t		ip_prv0;
56*009ea47eSEdward Tomasz Napierala 	uint32_t		ip_prv1;
57*009ea47eSEdward Tomasz Napierala 	uint32_t		ip_prv2;
58*009ea47eSEdward Tomasz Napierala };
59*009ea47eSEdward Tomasz Napierala 
60*009ea47eSEdward Tomasz Napierala struct icl_pdu		*icl_pdu_new_bhs(struct icl_conn *ic, int flags);
61*009ea47eSEdward Tomasz Napierala size_t			icl_pdu_data_segment_length(const struct icl_pdu *ip);
62*009ea47eSEdward Tomasz Napierala int			icl_pdu_append_data(struct icl_pdu *ip, const void *addr, size_t len, int flags);
63*009ea47eSEdward Tomasz Napierala void			icl_pdu_get_data(struct icl_pdu *ip, size_t off, void *addr, size_t len);
64*009ea47eSEdward Tomasz Napierala void			icl_pdu_queue(struct icl_pdu *ip);
65*009ea47eSEdward Tomasz Napierala void			icl_pdu_free(struct icl_pdu *ip);
66*009ea47eSEdward Tomasz Napierala 
67*009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_INVALID		0
68*009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_BHS		1
69*009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_AHS		2
70*009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_HEADER_DIGEST	3
71*009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_DATA		4
72*009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_DATA_DIGEST	5
73*009ea47eSEdward Tomasz Napierala 
74*009ea47eSEdward Tomasz Napierala #define	ICL_MAX_DATA_SEGMENT_LENGTH	(128 * 1024)
75*009ea47eSEdward Tomasz Napierala 
76*009ea47eSEdward Tomasz Napierala struct icl_conn {
77*009ea47eSEdward Tomasz Napierala 	struct mtx		ic_lock;
78*009ea47eSEdward Tomasz Napierala 	struct socket		*ic_socket;
79*009ea47eSEdward Tomasz Napierala 	volatile u_int		ic_outstanding_pdus;
80*009ea47eSEdward Tomasz Napierala 	TAILQ_HEAD(, icl_pdu)	ic_to_send;
81*009ea47eSEdward Tomasz Napierala 	size_t			ic_receive_len;
82*009ea47eSEdward Tomasz Napierala 	int			ic_receive_state;
83*009ea47eSEdward Tomasz Napierala 	struct icl_pdu		*ic_receive_pdu;
84*009ea47eSEdward Tomasz Napierala 	struct cv		ic_send_cv;
85*009ea47eSEdward Tomasz Napierala 	struct cv		ic_receive_cv;
86*009ea47eSEdward Tomasz Napierala 	bool			ic_header_crc32c;
87*009ea47eSEdward Tomasz Napierala 	bool			ic_data_crc32c;
88*009ea47eSEdward Tomasz Napierala 	bool			ic_send_running;
89*009ea47eSEdward Tomasz Napierala 	bool			ic_receive_running;
90*009ea47eSEdward Tomasz Napierala 	size_t			ic_max_data_segment_length;
91*009ea47eSEdward Tomasz Napierala 	bool			ic_disconnecting;
92*009ea47eSEdward Tomasz Napierala 	bool			ic_iser;
93*009ea47eSEdward Tomasz Napierala 
94*009ea47eSEdward Tomasz Napierala 	void			(*ic_receive)(struct icl_pdu *);
95*009ea47eSEdward Tomasz Napierala 	void			(*ic_error)(struct icl_conn *);
96*009ea47eSEdward Tomasz Napierala 
97*009ea47eSEdward Tomasz Napierala 	/*
98*009ea47eSEdward Tomasz Napierala 	 * User (initiator or provider) private fields.
99*009ea47eSEdward Tomasz Napierala 	 */
100*009ea47eSEdward Tomasz Napierala 	void			*ic_prv0;
101*009ea47eSEdward Tomasz Napierala };
102*009ea47eSEdward Tomasz Napierala 
103*009ea47eSEdward Tomasz Napierala struct icl_conn		*icl_conn_new(void);
104*009ea47eSEdward Tomasz Napierala void			icl_conn_free(struct icl_conn *ic);
105*009ea47eSEdward Tomasz Napierala int			icl_conn_handoff(struct icl_conn *ic, int fd);
106*009ea47eSEdward Tomasz Napierala void			icl_conn_shutdown(struct icl_conn *ic);
107*009ea47eSEdward Tomasz Napierala void			icl_conn_close(struct icl_conn *ic);
108*009ea47eSEdward Tomasz Napierala bool			icl_conn_connected(struct icl_conn *ic);
109*009ea47eSEdward Tomasz Napierala 
110*009ea47eSEdward Tomasz Napierala #ifdef ICL_KERNEL_PROXY
111*009ea47eSEdward Tomasz Napierala 
112*009ea47eSEdward Tomasz Napierala struct sockaddr;
113*009ea47eSEdward Tomasz Napierala struct icl_listen;
114*009ea47eSEdward Tomasz Napierala 
115*009ea47eSEdward Tomasz Napierala struct icl_listen_sock {
116*009ea47eSEdward Tomasz Napierala 	TAILQ_ENTRY(icl_listen_sock)	ils_next;
117*009ea47eSEdward Tomasz Napierala 	struct icl_listen	*ils_listen;
118*009ea47eSEdward Tomasz Napierala 	struct socket		*ils_socket;
119*009ea47eSEdward Tomasz Napierala 	bool			ils_running;
120*009ea47eSEdward Tomasz Napierala 	bool			ils_disconnecting;
121*009ea47eSEdward Tomasz Napierala };
122*009ea47eSEdward Tomasz Napierala 
123*009ea47eSEdward Tomasz Napierala struct icl_listen	{
124*009ea47eSEdward Tomasz Napierala 	TAILQ_HEAD(, icl_listen_sock)	il_sockets;
125*009ea47eSEdward Tomasz Napierala 	struct sx			il_lock;
126*009ea47eSEdward Tomasz Napierala 	void				(*il_accept)(struct socket *);
127*009ea47eSEdward Tomasz Napierala };
128*009ea47eSEdward Tomasz Napierala 
129*009ea47eSEdward Tomasz Napierala /*
130*009ea47eSEdward Tomasz Napierala  * Initiator part.
131*009ea47eSEdward Tomasz Napierala  */
132*009ea47eSEdward Tomasz Napierala int			icl_conn_connect(struct icl_conn *ic, bool rdma,
133*009ea47eSEdward Tomasz Napierala 			    int domain, int socktype, int protocol,
134*009ea47eSEdward Tomasz Napierala 			    struct sockaddr *from_sa, struct sockaddr *to_sa);
135*009ea47eSEdward Tomasz Napierala /*
136*009ea47eSEdward Tomasz Napierala  * Target part.
137*009ea47eSEdward Tomasz Napierala  */
138*009ea47eSEdward Tomasz Napierala struct icl_listen	*icl_listen_new(void (*accept_cb)(struct socket *));
139*009ea47eSEdward Tomasz Napierala void			icl_listen_free(struct icl_listen *il);
140*009ea47eSEdward Tomasz Napierala int			icl_listen_add(struct icl_listen *il, bool rdma, int domain,
141*009ea47eSEdward Tomasz Napierala     int socktype, int protocol, struct sockaddr *sa);
142*009ea47eSEdward Tomasz Napierala int			icl_listen_remove(struct icl_listen *il, struct sockaddr *sa);
143*009ea47eSEdward Tomasz Napierala 
144*009ea47eSEdward Tomasz Napierala /*
145*009ea47eSEdward Tomasz Napierala  * This one is not a public API; only to be used by icl_proxy.c.
146*009ea47eSEdward Tomasz Napierala  */
147*009ea47eSEdward Tomasz Napierala int			icl_conn_handoff_sock(struct icl_conn *ic, struct socket *so);
148*009ea47eSEdward Tomasz Napierala 
149*009ea47eSEdward Tomasz Napierala #endif /* ICL_KERNEL_PROXY */
150*009ea47eSEdward Tomasz Napierala 
151*009ea47eSEdward Tomasz Napierala #endif /* !ICL_H */
152