if_bridgevar.h revision 1.1 1 /* $NetBSD: if_bridgevar.h,v 1.1 2001/08/17 21:37:28 thorpej Exp $ */
2
3 /*
4 * Copyright 2001 Wasabi Systems, Inc.
5 * All rights reserved.
6 *
7 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
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 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed for the NetBSD Project by
20 * Wasabi Systems, Inc.
21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 * or promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 /*
39 * Copyright (c) 1999, 2000 Jason L. Wright (jason (at) thought.net)
40 * All rights reserved.
41 *
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
44 * are met:
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
50 * 3. All advertising materials mentioning features or use of this software
51 * must display the following acknowledgement:
52 * This product includes software developed by Jason L. Wright
53 * 4. The name of the author may not be used to endorse or promote products
54 * derived from this software without specific prior written permission.
55 *
56 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
57 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
58 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
59 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
60 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
61 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
62 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
63 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
64 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
65 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
66 * POSSIBILITY OF SUCH DAMAGE.
67 *
68 * OpenBSD: if_bridge.h,v 1.14 2001/03/22 03:48:29 jason Exp
69 */
70
71 /*
72 * Data structure and control definitions for bridge interfaces.
73 */
74
75 #include <sys/callout.h>
76 #include <sys/queue.h>
77
78 /*
79 * Commands used in the SIOCSDRVSPEC ioctl. Note the lookup of the
80 * bridge interface itself is keyed off the ifdrv structure.
81 */
82 #define BRDGADD 0 /* add bridge member (ifbreq) */
83 #define BRDGDEL 1 /* delete bridge member (ifbreq) */
84 #define BRDGGIFFLGS 2 /* get member if flags (ifbreq) */
85 #define BRDGSIFFLGS 3 /* set member if flags (ifbreq) */
86 #define BRDGSCACHE 4 /* set cache size (ifbrparam) */
87 #define BRDGGCACHE 5 /* get cache size (ifbrparam) */
88 #define BRDGGIFS 6 /* get member list (ifbifconf) */
89 #define BRDGRTS 7 /* get address list (ifbaconf) */
90 #define BRDGSADDR 8 /* set static address (ifbareq) */
91 #define BRDGSTO 9 /* set cache timeout (ifbrparam) */
92 #define BRDGGTO 10 /* get cache timeout (ifbrparam) */
93 #define BRDGDADDR 11 /* delete address (ifbareq) */
94 #define BRDGFLUSH 12 /* flush address cache (ifbreq) */
95
96 #define BRDGGPRI 13 /* get priority (ifbrparam) */
97 #define BRDGSPRI 14 /* set priority (ifbrparam) */
98 #define BRDGGHT 15 /* get hello time (ifbrparam) */
99 #define BRDGSHT 16 /* set hello time (ifbrparam) */
100 #define BRDGGFD 17 /* get forward delay (ifbrparam) */
101 #define BRDGSFD 18 /* set forward delay (ifbrparam) */
102 #define BRDGGMA 19 /* get max age (ifbrparam) */
103 #define BRDGSMA 20 /* set max age (ifbrparam) */
104 #define BRDGSIFPRIO 21 /* set if priority (ifbreq) */
105
106 /*
107 * Generic bridge control request.
108 */
109 struct ifbreq {
110 char ifbr_ifsname[IFNAMSIZ]; /* member if name */
111 uint32_t ifbr_ifsflags; /* member if flags */
112 uint8_t ifbr_state; /* member if STP state */
113 uint8_t ifbr_priority; /* member if STP priority */
114 uint8_t ifbr_portno; /* member if port number */
115 };
116
117 /* BRDGGIFFLAGS, BRDGSIFFLAGS */
118 #define IFBIF_LEARNING 0x01 /* if can learn */
119 #define IFBIF_DISCOVER 0x02 /* if sends packets w/ unknown dest. */
120 #define IFBIF_STP 0x04 /* if participates in spanning tree */
121
122 #define IFBIFBITS "\020\1LEARNING\2DISCOVER\3STP"
123
124 /* BRDGFLUSH */
125 #define IFBF_FLUSHDYN 0x00 /* flush learned addresses only */
126 #define IFBF_FLUSHALL 0x01 /* flush all addresses */
127
128 /* STP port states */
129 #define BSTP_IFSTATE_DISABLED 0
130 #define BSTP_IFSTATE_LISTENING 1
131 #define BSTP_IFSTATE_LEARNING 2
132 #define BSTP_IFSTATE_FORWARDING 3
133 #define BSTP_IFSTATE_BLOCKING 4
134
135 /*
136 * Interface list structure.
137 */
138 struct ifbifconf {
139 uint32_t ifbic_len; /* buffer size */
140 union {
141 caddr_t ifbicu_buf;
142 struct ifbreq *ifbicu_req;
143 } ifbic_ifbicu;
144 #define ifbic_buf ifbic_ifbicu.ifbicu_buf
145 #define ifbic_req ifbic_ifbicu.ifbicu_req
146 };
147
148 /*
149 * Bridge address request.
150 */
151 struct ifbareq {
152 char ifba_ifsname[IFNAMSIZ]; /* member if name */
153 unsigned long ifba_expire; /* address expire time */
154 uint8_t ifba_flags; /* address flags */
155 uint8_t ifba_dst[ETHER_ADDR_LEN];/* destination address */
156 };
157
158 #define IFBAF_TYPEMASK 0x03 /* address type mask */
159 #define IFBAF_DYNAMIC 0x00 /* dynamically learned address */
160 #define IFBAF_STATIC 0x01 /* static address */
161
162 #define IFBAFBITS "\020\1STATIC"
163
164 /*
165 * Address list structure.
166 */
167 struct ifbaconf {
168 uint32_t ifbac_len; /* buffer size */
169 union {
170 caddr_t ifbacu_buf;
171 struct ifbareq *ifbacu_req;
172 } ifbac_ifbacu;
173 #define ifbac_buf ifbac_ifbacu.ifbacu_buf
174 #define ifbac_req ifbac_ifbacu.ifbacu_req
175 };
176
177 /*
178 * Bridge parameter structure.
179 */
180 struct ifbrparam {
181 union {
182 uint32_t ifbrpu_int32;
183 uint16_t ifbrpu_int16;
184 uint8_t ifbrpu_int8;
185 } ifbrp_ifbrpu;
186 };
187 #define ifbrp_csize ifbrp_ifbrpu.ifbrpu_int32 /* cache size */
188 #define ifbrp_ctime ifbrp_ifbrpu.ifbrpu_int32 /* cache time (sec) */
189 #define ifbrp_prio ifbrp_ifbrpu.ifbrpu_int16 /* bridge priority */
190 #define ifbrp_hellotime ifbrp_ifbrpu.ifbrpu_int8 /* hello time (sec) */
191 #define ifbrp_fwddelay ifbrp_ifbrpu.ifbrpu_int8 /* fwd time (sec) */
192 #define ifbrp_maxage ifbrp_ifbrpu.ifbrpu_int8 /* max age (sec) */
193
194 #ifdef _KERNEL
195 /*
196 * Timekeeping structure used in spanning tree code.
197 */
198 struct bridge_timer {
199 uint16_t active;
200 uint16_t value;
201 };
202
203 struct bstp_config_unit {
204 uint64_t cu_rootid;
205 uint64_t cu_bridge_id;
206 uint32_t cu_root_path_cost;
207 uint16_t cu_message_age;
208 uint16_t cu_max_age;
209 uint16_t cu_hello_time;
210 uint16_t cu_forward_delay;
211 uint16_t cu_port_id;
212 uint8_t cu_message_type;
213 uint8_t cu_topology_change_acknowledgment;
214 uint8_t cu_topology_change;
215 };
216
217 struct bstp_tcn_unit {
218 uint8_t tu_message_type;
219 };
220
221 /*
222 * Bridge interface list entry.
223 */
224 struct bridge_iflist {
225 LIST_ENTRY(bridge_iflist) bif_next;
226 uint64_t bif_designated_root;
227 uint64_t bif_designated_bridge;
228 uint32_t bif_path_cost;
229 uint32_t bif_designated_cost;
230 struct bridge_timer bif_hold_timer;
231 struct bridge_timer bif_message_age_timer;
232 struct bridge_timer bif_forward_delay_timer;
233 struct bstp_config_unit bif_config_bpdu;
234 uint16_t bif_port_id;
235 uint16_t bif_designated_port;
236 uint8_t bif_state;
237 uint8_t bif_topology_change_acknowledge;
238 uint8_t bif_config_pending;
239 uint8_t bif_change_detection_enabled;
240 uint8_t bif_priority;
241 struct ifnet *bif_ifp; /* member if */
242 uint32_t bif_flags; /* member if flags */
243 };
244
245 /*
246 * Bridge route node.
247 */
248 struct bridge_rtnode {
249 LIST_ENTRY(bridge_rtnode) brt_hash; /* hash table linkage */
250 LIST_ENTRY(bridge_rtnode) brt_list; /* list linkage */
251 struct ifnet *brt_ifp; /* destination if */
252 unsigned long brt_expire; /* expiration time */
253 uint8_t brt_flags; /* address flags */
254 uint8_t brt_addr[ETHER_ADDR_LEN];
255 };
256
257 /*
258 * Software state for each bridge.
259 */
260 struct bridge_softc {
261 struct ifnet sc_if;
262 LIST_ENTRY(bridge_softc) sc_list;
263 uint64_t sc_designated_root;
264 uint64_t sc_bridge_id;
265 struct bridge_iflist *sc_root_port;
266 uint32_t sc_root_path_cost;
267 uint16_t sc_max_age;
268 uint16_t sc_hello_time;
269 uint16_t sc_forward_delay;
270 uint16_t sc_bridge_max_age;
271 uint16_t sc_bridge_hello_time;
272 uint16_t sc_bridge_forward_delay;
273 uint16_t sc_topology_change_time;
274 uint16_t sc_hold_time;
275 uint16_t sc_bridge_priority;
276 uint8_t sc_topology_change_detected;
277 uint8_t sc_topology_change;
278 struct bridge_timer sc_hello_timer;
279 struct bridge_timer sc_topology_change_timer;
280 struct bridge_timer sc_tcn_timer;
281 uint32_t sc_brtmax; /* max # of addresses */
282 uint32_t sc_brtcnt; /* cur. # of addresses */
283 uint32_t sc_brttimeout; /* rt timeout in seconds */
284 struct callout sc_brcallout; /* bridge callout */
285 struct callout sc_bstpcallout; /* STP callout */
286 LIST_HEAD(, bridge_iflist) sc_iflist; /* member interface list */
287 LIST_HEAD(, bridge_rtnode) *sc_rthash; /* our forwarding table */
288 LIST_HEAD(, bridge_rtnode) sc_rtlist; /* list version of above */
289 uint32_t sc_rthash_key; /* key for hash */
290 };
291
292 extern const uint8_t bstp_etheraddr[];
293
294 void bridge_ifdetach(struct ifnet *ifp);
295
296 int bridge_output(struct ifnet *ifp, struct mbuf *, struct sockaddr *,
297 struct rtentry *);
298 struct mbuf *bridge_input(struct ifnet *, struct mbuf *);
299
300 void bstp_initialization(struct bridge_softc *);
301 void bstp_stop(struct bridge_softc *);
302 struct mbuf *bstp_input(struct ifnet *, struct mbuf *);
303
304 void bridge_enqueue(struct bridge_softc *, struct ifnet *, struct mbuf *);
305
306 #endif /* _KERNEL */
307