bridgestp.h revision 160899
1/* $NetBSD: if_bridgevar.h,v 1.4 2003/07/08 07:13:50 itojun 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@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 * $FreeBSD: head/sys/net/bridgestp.h 160899 2006-08-02 02:47:27Z thompsa $ 71 */ 72 73/* 74 * Data structure and control definitions for STP interfaces. 75 */ 76 77#include <sys/callout.h> 78#include <sys/queue.h> 79 80/* STP port states */ 81#define BSTP_IFSTATE_DISABLED 0 82#define BSTP_IFSTATE_LISTENING 1 83#define BSTP_IFSTATE_LEARNING 2 84#define BSTP_IFSTATE_FORWARDING 3 85#define BSTP_IFSTATE_BLOCKING 4 86 87#ifdef _KERNEL 88 89/* 90 * Spanning tree defaults. 91 */ 92#define BSTP_DEFAULT_MAX_AGE (20 * 256) 93#define BSTP_DEFAULT_HELLO_TIME (2 * 256) 94#define BSTP_DEFAULT_FORWARD_DELAY (15 * 256) 95#define BSTP_DEFAULT_HOLD_TIME (1 * 256) 96#define BSTP_DEFAULT_BRIDGE_PRIORITY 0x8000 97#define BSTP_DEFAULT_PORT_PRIORITY 0x80 98#define BSTP_DEFAULT_PATH_COST 55 99 100/* BPDU message types */ 101#define BSTP_MSGTYPE_CFG 0x00 /* Configuration */ 102#define BSTP_MSGTYPE_TCN 0x80 /* Topology chg notification */ 103 104/* BPDU flags */ 105#define BSTP_FLAG_TC 0x01 /* Topology change */ 106#define BSTP_FLAG_TCA 0x80 /* Topology change ack */ 107 108#define BSTP_MESSAGE_AGE_INCR (1 * 256) /* in 256ths of a second */ 109#define BSTP_TICK_VAL (1 * 256) /* in 256ths of a second */ 110#define BSTP_LINK_TIMER (BSTP_TICK_VAL * 30) 111 112/* 113 * * Driver callbacks for STP state changes 114 * */ 115typedef void (*bstp_state_cb_t)(struct ifnet *, int); 116 117/* 118 * Because BPDU's do not make nicely aligned structures, two different 119 * declarations are used: bstp_?bpdu (wire representation, packed) and 120 * bstp_*_unit (internal, nicely aligned version). 121 */ 122 123/* configuration bridge protocol data unit */ 124struct bstp_cbpdu { 125 uint8_t cbu_dsap; /* LLC: destination sap */ 126 uint8_t cbu_ssap; /* LLC: source sap */ 127 uint8_t cbu_ctl; /* LLC: control */ 128 uint16_t cbu_protoid; /* protocol id */ 129 uint8_t cbu_protover; /* protocol version */ 130 uint8_t cbu_bpdutype; /* message type */ 131 uint8_t cbu_flags; /* flags (below) */ 132 133 /* root id */ 134 uint16_t cbu_rootpri; /* root priority */ 135 uint8_t cbu_rootaddr[6]; /* root address */ 136 137 uint32_t cbu_rootpathcost; /* root path cost */ 138 139 /* bridge id */ 140 uint16_t cbu_bridgepri; /* bridge priority */ 141 uint8_t cbu_bridgeaddr[6]; /* bridge address */ 142 143 uint16_t cbu_portid; /* port id */ 144 uint16_t cbu_messageage; /* current message age */ 145 uint16_t cbu_maxage; /* maximum age */ 146 uint16_t cbu_hellotime; /* hello time */ 147 uint16_t cbu_forwarddelay; /* forwarding delay */ 148} __attribute__((__packed__)); 149 150/* topology change notification bridge protocol data unit */ 151struct bstp_tbpdu { 152 uint8_t tbu_dsap; /* LLC: destination sap */ 153 uint8_t tbu_ssap; /* LLC: source sap */ 154 uint8_t tbu_ctl; /* LLC: control */ 155 uint16_t tbu_protoid; /* protocol id */ 156 uint8_t tbu_protover; /* protocol version */ 157 uint8_t tbu_bpdutype; /* message type */ 158} __attribute__((__packed__)); 159 160/* 161 * Timekeeping structure used in spanning tree code. 162 */ 163struct bstp_timer { 164 uint16_t active; 165 uint16_t value; 166}; 167 168struct bstp_config_unit { 169 uint64_t cu_rootid; 170 uint64_t cu_bridge_id; 171 uint32_t cu_root_path_cost; 172 uint16_t cu_message_age; 173 uint16_t cu_max_age; 174 uint16_t cu_hello_time; 175 uint16_t cu_forward_delay; 176 uint16_t cu_port_id; 177 uint8_t cu_message_type; 178 uint8_t cu_topology_change_acknowledgment; 179 uint8_t cu_topology_change; 180}; 181 182struct bstp_tcn_unit { 183 uint8_t tu_message_type; 184}; 185 186/* 187 * Bridge interface list entry. 188 */ 189struct bstp_port { 190 LIST_ENTRY(bstp_port) bp_next; 191 struct ifnet *bp_ifp; /* parent if */ 192 struct bstp_state *bp_bs; 193 int bp_active; 194 uint64_t bp_designated_root; 195 uint64_t bp_designated_bridge; 196 uint32_t bp_path_cost; 197 uint32_t bp_designated_cost; 198 struct bstp_timer bp_hold_timer; 199 struct bstp_timer bp_message_age_timer; 200 struct bstp_timer bp_forward_delay_timer; 201 struct bstp_config_unit bp_config_bpdu; 202 uint16_t bp_port_id; 203 uint16_t bp_designated_port; 204 uint8_t bp_state; 205 uint8_t bp_topology_change_acknowledge; 206 uint8_t bp_config_pending; 207 uint8_t bp_change_detection_enabled; 208 uint8_t bp_priority; 209 uint32_t bp_forward_transitions; 210 struct task bp_statetask; 211}; 212 213/* 214 * Software state for each bridge STP. 215 */ 216struct bstp_state { 217 LIST_ENTRY(bstp_state) bs_list; 218 struct mtx bs_mtx; 219 uint64_t bs_designated_root; 220 uint64_t bs_bridge_id; 221 struct bstp_port *bs_root_port; 222 uint32_t bs_root_path_cost; 223 uint16_t bs_max_age; 224 uint16_t bs_hello_time; 225 uint16_t bs_forward_delay; 226 uint16_t bs_bridge_max_age; 227 uint16_t bs_bridge_hello_time; 228 uint16_t bs_bridge_forward_delay; 229 uint16_t bs_topology_change_time; 230 uint16_t bs_hold_time; 231 uint16_t bs_bridge_priority; 232 uint8_t bs_topology_change_detected; 233 uint8_t bs_topology_change; 234 struct bstp_timer bs_hello_timer; 235 struct bstp_timer bs_topology_change_timer; 236 struct bstp_timer bs_tcn_timer; 237 struct callout bs_bstpcallout; /* STP callout */ 238 struct bstp_timer bs_link_timer; 239 struct timeval bs_last_tc_time; 240 LIST_HEAD(, bstp_port) bs_bplist; 241 bstp_state_cb_t bs_state_cb; 242}; 243 244#define BSTP_LOCK_INIT(_bs) mtx_init(&(_bs)->bs_mtx, "bstp", \ 245 NULL, MTX_DEF) 246#define BSTP_LOCK_DESTROY(_bs) mtx_destroy(&(_bs)->bs_mtx) 247#define BSTP_LOCK(_bs) mtx_lock(&(_bs)->bs_mtx) 248#define BSTP_UNLOCK(_bs) mtx_unlock(&(_bs)->bs_mtx) 249#define BSTP_LOCK_ASSERT(_bs) mtx_assert(&(_bs)->bs_mtx, MA_OWNED) 250 251extern const uint8_t bstp_etheraddr[]; 252 253extern void (*bstp_linkstate_p)(struct ifnet *ifp, int state); 254 255void bstp_attach(struct bstp_state *, bstp_state_cb_t); 256void bstp_detach(struct bstp_state *); 257void bstp_init(struct bstp_state *); 258void bstp_reinit(struct bstp_state *); 259void bstp_stop(struct bstp_state *); 260int bstp_add(struct bstp_state *, struct bstp_port *, struct ifnet *); 261void bstp_delete(struct bstp_port *); 262void bstp_drain(struct bstp_port *); 263void bstp_linkstate(struct ifnet *, int); 264struct mbuf *bstp_input(struct bstp_port *, struct ifnet *, struct mbuf *); 265 266#endif /* _KERNEL */ 267