1/*- 2 * Copyright (c) 2006 Shteryana Shopova <syrinx@FreeBSD.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * Bridge MIB implementation for SNMPd. 27 * 28 * $FreeBSD$ 29 */ 30 31#ifndef SNMP_BRIDGE_H 32#define SNMP_BRIDGE_H 33 34#define SNMP_BRIDGE_ID_LEN 8 35 36typedef uint8_t port_id[2]; 37typedef u_char bridge_id[SNMP_BRIDGE_ID_LEN]; 38 39#define SNMP_BRIDGE_MAX_PRIORITY 65535 40 41#define SNMP_BRIDGE_MIN_AGE_TIME 10 42#define SNMP_BRIDGE_MAX_AGE_TIME 1000000 43 44#define SNMP_BRIDGE_MIN_TXHC 1 45#define SNMP_BRIDGE_MAX_TXHC 10 46 47#define SNMP_BRIDGE_MIN_MAGE 600 48#define SNMP_BRIDGE_MAX_MAGE 4000 49 50#define SNMP_BRIDGE_MIN_HTIME 100 51#define SNMP_BRIDGE_MAX_HTIME 1000 52 53#define SNMP_BRIDGE_MIN_FDELAY 400 54#define SNMP_BRIDGE_MAX_FDELAY 3000 55 56#define SNMP_PORT_PATHCOST_OBSOLETE 65535 57#define SNMP_PORT_MIN_PATHCOST 0 58#define SNMP_PORT_MAX_PATHCOST 200000000 59#define SNMP_PORT_PATHCOST_AUTO 0 60 61#define SNMP_BRIDGE_DATA_MAXAGE 10 62#define SNMP_BRIDGE_DATA_MAXAGE_MIN 1 63#define SNMP_BRIDGE_DATA_MAXAGE_MAX 300 64 65/* By default poll kernel data every 5 minutes. */ 66#define SNMP_BRIDGE_POLL_INTERVAL (5 * 60) 67#define SNMP_BRIDGE_POLL_INTERVAL_MIN 1 68#define SNMP_BRIDGE_POLL_INTERVAL_MAX 3600 69 70/* Poll for a topology change once every 30 seconds. */ 71#define SNMP_BRIDGE_TC_POLL_INTERVAL 30 72 73struct bridge_if *bridge_get_default(void); 74 75void bridge_set_default(struct bridge_if *bif); 76 77const char *bridge_get_default_name(void); 78 79int bridge_get_data_maxage(void); 80 81/* 82 * Bridge Addresses Table. 83 */ 84struct tp_entry { 85 uint32_t sysindex; /* The bridge if sysindex. */ 86 int32_t port_no; 87 enum TpFdbStatus status; 88 uint8_t tp_addr[ETHER_ADDR_LEN]; 89 uint8_t flags; 90 TAILQ_ENTRY(tp_entry) tp_e; 91}; 92 93/* 94 * Bridge ports. 95 * The bridge port system interface index is used for a 96 * port number. Transparent bridging statistics and STP 97 * information for a port are also contained here. 98 */ 99struct bridge_port { 100 /* dot1dBase subtree objects. */ 101 uint32_t sysindex; /* The bridge interface sysindex. */ 102 int32_t port_no; /* The bridge member system index. */ 103 int32_t if_idx; /* SNMP ifIndex from mibII. */ 104 int8_t span_enable; /* Span flag set - private MIB. */ 105 struct asn_oid circuit; /* Unused. */ 106 uint32_t dly_ex_drops; /* Drops on output. */ 107 uint32_t dly_mtu_drops; /* MTU exceeded drops. */ 108 int32_t status; /* The entry status. */ 109 enum TruthValue priv_set; /* The private flag. */ 110 111 /* dot1dStp subtree objects. */ 112 int32_t path_cost; 113 int32_t priority; 114 int32_t design_cost; 115 uint32_t fwd_trans; 116 char p_name[IFNAMSIZ]; /* Not in BRIDGE-MIB. */ 117 enum StpPortState state; 118 enum dot1dStpPortEnable enable; 119 port_id design_port; 120 bridge_id design_root; 121 bridge_id design_bridge; 122 123 /* rstpMib extensions. */ 124 int32_t admin_path_cost; 125 enum TruthValue proto_migr; 126 enum TruthValue admin_edge; 127 enum TruthValue oper_edge; 128 enum TruthValue oper_ptp; 129 enum StpPortAdminPointToPointType admin_ptp; 130 131 /* dot1dTp subtree objects. */ 132 int32_t max_info; 133 int32_t in_frames; 134 int32_t out_frames; 135 int32_t in_drops; 136 137 uint8_t flags; 138 TAILQ_ENTRY(bridge_port) b_p; 139}; 140 141/* 142 * A bridge interface. 143 * The system interface index of the bridge is not required neither by the 144 * standard BRIDGE-MIB nor by the private BEGEMOT-BRIDGE-MIB, but is used 145 * as key for looking up the other info for this bridge. 146 */ 147struct bridge_if { 148 /* dot1dBase subtree objects. */ 149 uint32_t sysindex; /* The system interface index. */ 150 int32_t num_ports; /* Number of ports. */ 151 enum BaseType br_type; /* Bridge type. */ 152 enum RowStatus if_status; /* Bridge status. */ 153 char bif_name[IFNAMSIZ]; /* Bridge interface name. */ 154 struct ether_addr br_addr; /* Bridge address. */ 155 struct bridge_port *f_bp; /* This bridge's first entry 156 * in the base ports TAILQ. */ 157 /* dot1dStp subtree objects. */ 158 int32_t priority; 159 int32_t root_cost; 160 int32_t root_port; 161 int32_t max_age; /* Current max age. */ 162 int32_t hello_time; /* Current hello time. */ 163 int32_t fwd_delay; /* Current forward delay. */ 164 int32_t hold_time; 165 int32_t bridge_max_age; /* Configured max age. */ 166 int32_t bridge_hello_time; /* Configured hello time. */ 167 int32_t bridge_fwd_delay; /* Configured forward delay. */ 168 int32_t tx_hold_count; 169 uint32_t top_changes; 170 enum dot1dStpVersion stp_version; 171 enum dot1dStpProtocolSpecification prot_spec; 172 struct timeval last_tc_time; 173 bridge_id design_root; 174 175 /* dot1dTp subtree objects. */ 176 int32_t lrnt_drops; /* Dropped addresses. */ 177 int32_t age_time; /* Address entry timeout. */ 178 int32_t num_addrs; /* Current # of addresses in cache. */ 179 int32_t max_addrs; /* Max # of addresses in cache. */ 180 struct tp_entry *f_tpa; /* This bridge's first entry in 181 * the tp addresses TAILQ. */ 182 183 time_t entry_age; 184 time_t ports_age; 185 time_t addrs_age; 186 TAILQ_ENTRY(bridge_if) b_if; 187}; 188 189void bridge_ifs_fini(void); 190 191struct bridge_if *bridge_if_find_ifs(uint32_t sysindex); 192 193struct bridge_if *bridge_if_find_ifname(const char *b_name); 194 195const char *bridge_if_find_name(uint32_t sysindex); 196 197int bridge_compare_sysidx(uint32_t i1, uint32_t i2); 198 199int bridge_attach_newif(struct mibif *ifp); 200 201struct bridge_if *bridge_first_bif(void); 202 203struct bridge_if *bridge_next_bif(struct bridge_if *b_pr); 204 205void bridge_remove_bif(struct bridge_if *bif); 206 207void bridge_update_all_ports(void); 208 209void bridge_update_all_addrs(void); 210 211void bridge_update_all_ifs(void); 212 213void bridge_update_all(void *arg); 214 215void bridge_update_tc_time(void *arg); 216 217void bridge_ifs_dump(void); 218 219/* Bridge ports. */ 220void bridge_ports_update_listage(void); 221 222void bridge_ports_fini(void); 223 224void bridge_members_free(struct bridge_if *bif); 225 226struct bridge_port *bridge_new_port(struct mibif *mif, struct bridge_if *bif); 227 228void bridge_port_remove(struct bridge_port *bp, struct bridge_if *bif); 229 230struct bridge_port *bridge_port_bif_first(struct bridge_if *bif); 231 232struct bridge_port *bridge_port_bif_next(struct bridge_port *bp); 233 234struct bridge_port *bridge_port_find(int32_t if_idx, struct bridge_if *bif); 235 236void bridge_port_getinfo_mibif(struct mibif *m_if, struct bridge_port *bp); 237 238int bridge_getinfo_bif_ports(struct bridge_if *bif); 239 240int bridge_update_memif(struct bridge_if *bif); 241 242void bridge_ports_dump(struct bridge_if *bif); 243 244/* Bridge addresses. */ 245void bridge_addrs_update_listage(void); 246 247void bridge_addrs_fini(void); 248 249void bridge_addrs_free(struct bridge_if *bif); 250 251struct tp_entry *bridge_new_addrs(uint8_t *mac, struct bridge_if *bif); 252 253void bridge_addrs_remove(struct tp_entry *te, struct bridge_if *bif); 254 255struct tp_entry *bridge_addrs_find(uint8_t *mac, struct bridge_if *bif); 256 257struct tp_entry *bridge_addrs_bif_first(struct bridge_if *bif); 258 259struct tp_entry *bridge_addrs_bif_next(struct tp_entry *te); 260 261int bridge_getinfo_bif_addrs(struct bridge_if *bif); 262 263int bridge_update_addrs(struct bridge_if *bif); 264 265void bridge_addrs_dump(struct bridge_if *bif); 266 267/* Bridge PF. */ 268 269void bridge_pf_dump(void); 270 271/* System specific. */ 272 273/* Open the socket for the ioctls. */ 274int bridge_ioctl_init(void); 275 276/* Load bridge kernel module. */ 277int bridge_kmod_load(void); 278 279/* Get the bridge interface information. */ 280int bridge_getinfo_bif(struct bridge_if *bif); 281 282/* Get the bridge interface STP parameters. */ 283int bridge_get_op_param(struct bridge_if *bif); 284 285/* Set the bridge priority. */ 286int bridge_set_priority(struct bridge_if *bif, int32_t priority); 287 288/* Set the bridge max age. */ 289int bridge_set_maxage(struct bridge_if *bif, int32_t max_age); 290 291/* Set the bridge hello time.*/ 292int bridge_set_hello_time(struct bridge_if *bif, int32_t hello_time); 293 294/* Set the bridge forward delay.*/ 295int bridge_set_forward_delay(struct bridge_if *bif, int32_t fwd_delay); 296 297/* Set the bridge address cache max age. */ 298int bridge_set_aging_time(struct bridge_if *bif, int32_t age_time); 299 300/* Set the max number of entries in the bridge address cache. */ 301int bridge_set_max_cache(struct bridge_if *bif, int32_t max_cache); 302 303/* Set the bridge TX hold count. */ 304int bridge_set_tx_hold_count(struct bridge_if *bif, int32_t tx_hc); 305 306/* Set the bridge STP protocol version. */ 307int bridge_set_stp_version(struct bridge_if *bif, int32_t stp_proto); 308 309/* Set the bridge interface status to up/down. */ 310int bridge_set_if_up(const char* b_name, int8_t up); 311 312/* Create a bridge interface. */ 313int bridge_create(const char *b_name); 314 315/* Destroy a bridge interface. */ 316int bridge_destroy(const char *b_name); 317 318/* Fetch the bridge mac address. */ 319u_char *bridge_get_basemac(const char *bif_name, u_char *mac, size_t mlen); 320 321/* Set a bridge member priority. */ 322int bridge_port_set_priority(const char *bif_name, struct bridge_port *bp, 323 int32_t priority); 324 325/* Set a bridge member STP-enabled flag. */ 326int bridge_port_set_stp_enable(const char *bif_name, struct bridge_port *bp, 327 uint32_t enable); 328 329/* Set a bridge member STP path cost. */ 330int bridge_port_set_path_cost(const char *bif_name, struct bridge_port *bp, 331 int32_t path_cost); 332 333/* Set admin point-to-point link. */ 334int bridge_port_set_admin_ptp(const char *bif_name, struct bridge_port *bp, 335 uint32_t admin_ptp); 336 337/* Set admin edge. */ 338int bridge_port_set_admin_edge(const char *bif_name, struct bridge_port *bp, 339 uint32_t enable); 340 341/* Set 'private' flag. */ 342int bridge_port_set_private(const char *bif_name, struct bridge_port *bp, 343 uint32_t priv_set); 344 345/* Add a bridge member port. */ 346int bridge_port_addm(struct bridge_port *bp, const char *b_name); 347 348/* Delete a bridge member port. */ 349int bridge_port_delm(struct bridge_port *bp, const char *b_name); 350 351/* Get the current value from the module for bridge PF control. */ 352int32_t bridge_get_pfval(uint8_t which); 353 354/* Get/Set a bridge PF control. */ 355int32_t bridge_do_pfctl(int32_t bridge_ctl, enum snmp_op op, int32_t *val); 356 357#endif /* SNMP_BRIDGE_H */ 358