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