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 ISCSI_H
33#define	ISCSI_H
34
35struct iscsi_softc;
36struct icl_conn;
37
38#define	ISCSI_NAME_LEN		224	/* 223 bytes, by RFC 3720, + '\0' */
39#define	ISCSI_ADDR_LEN		47	/* INET6_ADDRSTRLEN + '\0' */
40#define	ISCSI_SECRET_LEN	17	/* 16 + '\0' */
41
42struct iscsi_outstanding {
43	TAILQ_ENTRY(iscsi_outstanding)	io_next;
44	union ccb			*io_ccb;
45	size_t				io_received;
46	uint32_t			io_initiator_task_tag;
47	uint32_t			io_datasn;
48	void				*io_icl_prv;
49};
50
51struct iscsi_session {
52	TAILQ_ENTRY(iscsi_session)	is_next;
53
54	struct icl_conn			*is_conn;
55	struct mtx			is_lock;
56
57	uint32_t			is_statsn;
58	uint32_t			is_cmdsn;
59	uint32_t			is_expcmdsn;
60	uint32_t			is_maxcmdsn;
61	uint32_t			is_initiator_task_tag;
62	int				is_header_digest;
63	int				is_data_digest;
64	int				is_initial_r2t;
65	size_t				is_max_burst_length;
66	size_t				is_first_burst_length;
67	uint8_t				is_isid[6];
68	uint16_t			is_tsih;
69	bool				is_immediate_data;
70	size_t				is_max_data_segment_length;
71	char				is_target_alias[ISCSI_ALIAS_LEN];
72
73	TAILQ_HEAD(, iscsi_outstanding)	is_outstanding;
74	STAILQ_HEAD(, icl_pdu)		is_postponed;
75
76	struct callout			is_callout;
77	unsigned int			is_timeout;
78
79	/*
80	 * XXX: This could be rewritten using a single variable,
81	 * 	but somehow it results in uglier code.
82	 */
83	/*
84	 * We're waiting for iscsid(8); after iscsid_timeout
85	 * expires, kernel will wake up an iscsid(8) to handle
86	 * the session.
87	 */
88	bool				is_waiting_for_iscsid;
89
90	/*
91	 * Some iscsid(8) instance is handling the session;
92	 * after login_timeout expires, kernel will wake up
93	 * another iscsid(8) to handle the session.
94	 */
95	bool				is_login_phase;
96
97	/*
98	 * We're in the process of removing the iSCSI session.
99	 */
100	bool				is_terminating;
101
102	/*
103	 * We're waiting for the maintenance thread to do some
104	 * reconnection tasks.
105	 */
106	bool				is_reconnecting;
107
108	bool				is_connected;
109
110	struct cam_devq			*is_devq;
111	struct cam_sim			*is_sim;
112	struct cam_path			*is_path;
113	struct cv			is_maintenance_cv;
114	struct iscsi_softc		*is_softc;
115	unsigned int			is_id;
116	struct iscsi_session_conf	is_conf;
117	bool				is_simq_frozen;
118
119	char				is_reason[ISCSI_REASON_LEN];
120
121#ifdef ICL_KERNEL_PROXY
122	struct cv			is_login_cv;
123	struct icl_pdu			*is_login_pdu;
124#endif
125};
126
127struct iscsi_softc {
128	device_t			sc_dev;
129	struct sx			sc_lock;
130	struct cdev			*sc_cdev;
131	TAILQ_HEAD(, iscsi_session)	sc_sessions;
132	struct cv			sc_cv;
133	unsigned int			sc_last_session_id;
134	eventhandler_tag		sc_shutdown_pre_eh;
135	eventhandler_tag		sc_shutdown_post_eh;
136};
137
138#endif /* !ISCSI_H */
139