xref: /freebsd/sys/cam/ctl/ctl_frontend_iscsi.h (revision 5bd73b51076b5cb5a2c9810f76c1d7ed20c4460e)
1 /*-
2  * Copyright (c) 2012 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Edward Tomasz Napierala under sponsorship
6  * from the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef CTL_FRONTEND_ISCSI_H
33 #define	CTL_FRONTEND_ISCSI_H
34 
35 #define CFISCSI_TARGET_STATE_INVALID	0
36 #define CFISCSI_TARGET_STATE_ACTIVE	1
37 #define CFISCSI_TARGET_STATE_DYING	2
38 
39 struct cfiscsi_target {
40 	TAILQ_ENTRY(cfiscsi_target)	ct_next;
41 	uint32_t			ct_luns[CTL_MAX_LUNS];
42 	struct cfiscsi_softc		*ct_softc;
43 	volatile u_int			ct_refcount;
44 	char				ct_name[CTL_ISCSI_NAME_LEN];
45 	char				ct_alias[CTL_ISCSI_ALIAS_LEN];
46 	int				ct_state;
47 	int				ct_online;
48 	int				ct_target_id;
49 	struct ctl_port			ct_port;
50 };
51 
52 struct cfiscsi_data_wait {
53 	TAILQ_ENTRY(cfiscsi_data_wait)	cdw_next;
54 	union ctl_io			*cdw_ctl_io;
55 	uint32_t			cdw_target_transfer_tag;
56 	uint32_t			cdw_initiator_task_tag;
57 	int				cdw_sg_index;
58 	char				*cdw_sg_addr;
59 	size_t				cdw_sg_len;
60 	uint32_t			cdw_r2t_end;
61 };
62 
63 #define CFISCSI_SESSION_STATE_INVALID		0
64 #define CFISCSI_SESSION_STATE_BHS		1
65 #define CFISCSI_SESSION_STATE_AHS		2
66 #define CFISCSI_SESSION_STATE_HEADER_DIGEST	3
67 #define CFISCSI_SESSION_STATE_DATA		4
68 #define CFISCSI_SESSION_STATE_DATA_DIGEST	5
69 
70 struct cfiscsi_session {
71 	TAILQ_ENTRY(cfiscsi_session)	cs_next;
72 	struct mtx			cs_lock;
73 	struct icl_conn			*cs_conn;
74 	uint32_t			cs_cmdsn;
75 	uint32_t			cs_statsn;
76 	uint32_t			cs_target_transfer_tag;
77 	volatile u_int			cs_outstanding_ctl_pdus;
78 	TAILQ_HEAD(, cfiscsi_data_wait)	cs_waiting_for_data_out;
79 	struct cfiscsi_target		*cs_target;
80 	struct callout			cs_callout;
81 	int				cs_timeout;
82 	int				cs_portal_group_tag;
83 	struct cv			cs_maintenance_cv;
84 	bool				cs_terminating;
85 	bool				cs_tasks_aborted;
86 	size_t				cs_max_data_segment_length;
87 	size_t				cs_max_burst_length;
88 	bool				cs_immediate_data;
89 	char				cs_initiator_name[CTL_ISCSI_NAME_LEN];
90 	char				cs_initiator_addr[CTL_ISCSI_ADDR_LEN];
91 	char				cs_initiator_alias[CTL_ISCSI_ALIAS_LEN];
92 	char				cs_initiator_isid[6];
93 	char				cs_initiator_id[CTL_ISCSI_NAME_LEN + 5 + 6 + 1];
94 	unsigned int			cs_id;
95 	int				cs_ctl_initid;
96 #ifdef ICL_KERNEL_PROXY
97 	struct sockaddr			*cs_initiator_sa;
98 	int				cs_portal_id;
99 	bool				cs_login_phase;
100 	bool				cs_waiting_for_ctld;
101 	struct cv			cs_login_cv;
102 	struct icl_pdu			*cs_login_pdu;
103 #endif
104 };
105 
106 #ifdef ICL_KERNEL_PROXY
107 struct icl_listen;
108 #endif
109 
110 struct cfiscsi_softc {
111 	struct mtx			lock;
112 	char				port_name[32];
113 	int				online;
114 	int				last_target_id;
115 	unsigned int			last_session_id;
116 	TAILQ_HEAD(, cfiscsi_target)	targets;
117 	TAILQ_HEAD(, cfiscsi_session)	sessions;
118 #ifdef ICL_KERNEL_PROXY
119 	struct icl_listen		*listener;
120 	struct cv			accept_cv;
121 #endif
122 };
123 
124 #endif /* !CTL_FRONTEND_ISCSI_H */
125