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