FreeBSD/Linux Kernel Cross Reference
sys/dev/iscsi/iscsi.h
1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2012 The FreeBSD Foundation
5 *
6 * This software was developed by Edward Tomasz Napierala under sponsorship
7 * from the FreeBSD Foundation.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 */
32
33 #ifndef ISCSI_H
34 #define ISCSI_H
35
36 struct iscsi_softc;
37 struct icl_conn;
38
39 #define ISCSI_NAME_LEN 224 /* 223 bytes, by RFC 3720, + '\0' */
40 #define ISCSI_ADDR_LEN 47 /* INET6_ADDRSTRLEN + '\0' */
41 #define ISCSI_SECRET_LEN 17 /* 16 + '\0' */
42
43 struct iscsi_outstanding {
44 TAILQ_ENTRY(iscsi_outstanding) io_next;
45 union ccb *io_ccb;
46 size_t io_received;
47 uint32_t io_datasn;
48 uint32_t io_initiator_task_tag;
49 uint32_t io_referenced_task_tag;
50 void *io_icl_prv;
51 };
52
53 struct iscsi_session {
54 TAILQ_ENTRY(iscsi_session) is_next;
55
56 struct icl_conn *is_conn;
57 struct mtx is_lock;
58
59 uint32_t is_statsn;
60 uint32_t is_cmdsn;
61 uint32_t is_expcmdsn;
62 uint32_t is_maxcmdsn;
63 uint32_t is_initiator_task_tag;
64 int is_protocol_level;
65 int is_initial_r2t;
66 int is_max_burst_length;
67 int is_first_burst_length;
68 uint8_t is_isid[6];
69 uint16_t is_tsih;
70 bool is_immediate_data;
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 int is_ping_timeout;
79 int is_login_timeout;
80
81 /*
82 * XXX: This could be rewritten using a single variable,
83 * but somehow it results in uglier code.
84 */
85 /*
86 * We're waiting for iscsid(8); after iscsid_timeout
87 * expires, kernel will wake up an iscsid(8) to handle
88 * the session.
89 */
90 bool is_waiting_for_iscsid;
91
92 /*
93 * Some iscsid(8) instance is handling the session;
94 * after login_timeout expires, kernel will wake up
95 * another iscsid(8) to handle the session.
96 */
97 bool is_login_phase;
98
99 /*
100 * We're in the process of removing the iSCSI session.
101 */
102 bool is_terminating;
103
104 /*
105 * We're waiting for the maintenance thread to do some
106 * reconnection tasks.
107 */
108 bool is_reconnecting;
109
110 bool is_connected;
111
112 struct cam_devq *is_devq;
113 struct cam_sim *is_sim;
114 struct cam_path *is_path;
115 struct cv is_maintenance_cv;
116 struct iscsi_softc *is_softc;
117 unsigned int is_id;
118 struct iscsi_session_conf is_conf;
119 bool is_simq_frozen;
120
121 char is_reason[ISCSI_REASON_LEN];
122
123 #ifdef ICL_KERNEL_PROXY
124 struct cv is_login_cv;
125 struct icl_pdu *is_login_pdu;
126 #endif
127 };
128
129 struct iscsi_softc {
130 device_t sc_dev;
131 struct sx sc_lock;
132 struct cdev *sc_cdev;
133 TAILQ_HEAD(, iscsi_session) sc_sessions;
134 struct cv sc_cv;
135 unsigned int sc_last_session_id;
136 bool sc_unloading;
137 eventhandler_tag sc_shutdown_pre_eh;
138 eventhandler_tag sc_shutdown_post_eh;
139 };
140
141 #endif /* !ISCSI_H */
Cache object: d89ed7524f7a04a0f89272e6d2ca1dac
|