1 /* 2 * ng_bridge.h 3 */ 4 5 /*- 6 * Copyright (c) 2000 Whistle Communications, Inc. 7 * All rights reserved. 8 * 9 * Subject to the following obligations and disclaimer of warranty, use and 10 * redistribution of this software, in source or object code forms, with or 11 * without modifications are expressly permitted by Whistle Communications; 12 * provided, however, that: 13 * 1. Any and all reproductions of the source or object code must include the 14 * copyright notice above and the following disclaimer of warranties; and 15 * 2. No rights are granted, in any manner or form, to use Whistle 16 * Communications, Inc. trademarks, including the mark "WHISTLE 17 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as 18 * such appears in the above copyright notice or in the software. 19 * 20 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 21 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 22 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 23 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 25 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 26 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 27 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 28 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 29 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 30 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 31 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 32 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 35 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 36 * OF SUCH DAMAGE. 37 * 38 * Author: Archie Cobbs <archie@freebsd.org> 39 * 40 * $FreeBSD$ 41 */ 42 43 #ifndef _NETGRAPH_NG_BRIDGE_H_ 44 #define _NETGRAPH_NG_BRIDGE_H_ 45 46 /* 47 * Support the older ABI based on fixed size tables. 48 * ABI is deprecated, to be removed in releases > 12 49 * Please note: There is no API support! 50 * You canno create new messages using the old API but messages conforming the 51 * old ABI are understood. 52 */ 53 #define NGM_BRIDGE_TABLE_ABI 54 55 /* Node type name and magic cookie */ 56 #define NG_BRIDGE_NODE_TYPE "bridge" 57 #define NGM_BRIDGE_COOKIE 1569321993 58 59 #ifdef NGM_BRIDGE_TABLE_ABI 60 #define NGM_BRIDGE_COOKIE_TBL 967239368 61 #define NG_BRIDGE_MAX_LINKS 32 62 #endif /* NGM_BRIDGE_TABLE_ABI */ 63 64 /* Hook names */ 65 #define NG_BRIDGE_HOOK_LINK_PREFIX "link" /* append decimal integer */ 66 #define NG_BRIDGE_HOOK_LINK_FMT "link%d" /* for use with printf(3) */ 67 68 /* Node configuration structure */ 69 struct ng_bridge_config { 70 u_char debugLevel; /* debug level */ 71 u_int32_t loopTimeout; /* link loopback mute time */ 72 u_int32_t maxStaleness; /* max host age before nuking */ 73 u_int32_t minStableAge; /* min time for a stable host */ 74 }; 75 76 #ifdef NGM_BRIDGE_TABLE_ABI 77 struct ng_bridge_config_tbl { 78 u_char ipfw[NG_BRIDGE_MAX_LINKS]; 79 struct ng_bridge_config cfg; 80 }; 81 #endif /* NGM_BRIDGE_TABLE_ABI */ 82 83 /* Keep this in sync with the above structure definition */ 84 #define NG_BRIDGE_CONFIG_TYPE_INFO { \ 85 { "debugLevel", &ng_parse_uint8_type }, \ 86 { "loopTimeout", &ng_parse_uint32_type }, \ 87 { "maxStaleness", &ng_parse_uint32_type }, \ 88 { "minStableAge", &ng_parse_uint32_type }, \ 89 { NULL } \ 90 } 91 92 /* Statistics structure (one for each link) */ 93 struct ng_bridge_link_stats { 94 u_int64_t recvOctets; /* total octets rec'd on link */ 95 u_int64_t recvPackets; /* total pkts rec'd on link */ 96 u_int64_t recvMulticasts; /* multicast pkts rec'd on link */ 97 u_int64_t recvBroadcasts; /* broadcast pkts rec'd on link */ 98 u_int64_t recvUnknown; /* pkts rec'd with unknown dest addr */ 99 u_int64_t recvRunts; /* pkts rec'd less than 14 bytes */ 100 u_int64_t recvInvalid; /* pkts rec'd with bogus source addr */ 101 u_int64_t xmitOctets; /* total octets xmit'd on link */ 102 u_int64_t xmitPackets; /* total pkts xmit'd on link */ 103 u_int64_t xmitMulticasts; /* multicast pkts xmit'd on link */ 104 u_int64_t xmitBroadcasts; /* broadcast pkts xmit'd on link */ 105 u_int64_t loopDrops; /* pkts dropped due to loopback */ 106 u_int64_t loopDetects; /* number of loop detections */ 107 u_int64_t memoryFailures; /* times couldn't get mem or mbuf */ 108 }; 109 110 /* Keep this in sync with the above structure definition */ 111 #define NG_BRIDGE_STATS_TYPE_INFO { \ 112 { "recvOctets", &ng_parse_uint64_type }, \ 113 { "recvPackets", &ng_parse_uint64_type }, \ 114 { "recvMulticast", &ng_parse_uint64_type }, \ 115 { "recvBroadcast", &ng_parse_uint64_type }, \ 116 { "recvUnknown", &ng_parse_uint64_type }, \ 117 { "recvRunts", &ng_parse_uint64_type }, \ 118 { "recvInvalid", &ng_parse_uint64_type }, \ 119 { "xmitOctets", &ng_parse_uint64_type }, \ 120 { "xmitPackets", &ng_parse_uint64_type }, \ 121 { "xmitMulticasts", &ng_parse_uint64_type }, \ 122 { "xmitBroadcasts", &ng_parse_uint64_type }, \ 123 { "loopDrops", &ng_parse_uint64_type }, \ 124 { "loopDetects", &ng_parse_uint64_type }, \ 125 { "memoryFailures", &ng_parse_uint64_type }, \ 126 { NULL } \ 127 } 128 129 struct ng_bridge_link; 130 typedef struct ng_bridge_link *link_p; 131 /* Structure describing a single host */ 132 struct ng_bridge_host { 133 u_char addr[6]; /* ethernet address */ 134 link_p link; /* link where addr can be found */ 135 u_int16_t age; /* seconds ago entry was created */ 136 u_int16_t staleness; /* seconds ago host last heard from */ 137 }; 138 139 #ifdef NGM_BRIDGE_TABLE_ABI 140 struct ng_bridge_host_tbl { 141 u_char addr[6]; /* ethernet address */ 142 u_int16_t linkNum; /* link where addr can be found */ 143 u_int16_t age; /* seconds ago entry was created */ 144 u_int16_t staleness; /* seconds ago host last heard from */ 145 }; 146 #endif /* NGM_BRIDGE_TABLE_ABI */ 147 148 /* external representation of the host */ 149 struct ng_bridge_hostent { 150 u_char addr[6]; /* ethernet address */ 151 char hook[NG_HOOKSIZ]; /* link where addr can be found */ 152 u_int16_t age; /* seconds ago entry was created */ 153 u_int16_t staleness; /* seconds ago host last heard from */ 154 }; 155 156 /* Keep this in sync with the above structure definition */ 157 #define NG_BRIDGE_HOST_TYPE_INFO(entype) { \ 158 { "addr", (entype) }, \ 159 { "hook", &ng_parse_hookbuf_type }, \ 160 { "age", &ng_parse_uint16_type }, \ 161 { "staleness", &ng_parse_uint16_type }, \ 162 { NULL } \ 163 } 164 165 /* Structure returned by NGM_BRIDGE_GET_TABLE */ 166 struct ng_bridge_host_ary { 167 u_int32_t numHosts; 168 struct ng_bridge_hostent hosts[]; 169 }; 170 171 /* Keep this in sync with the above structure definition */ 172 #define NG_BRIDGE_HOST_ARY_TYPE_INFO(harytype) { \ 173 { "numHosts", &ng_parse_uint32_type }, \ 174 { "hosts", (harytype) }, \ 175 { NULL } \ 176 } 177 178 #ifdef NGM_BRIDGE_TABLE_ABI 179 struct ng_bridge_hostent_tbl { 180 u_char addr[6]; /* ethernet address */ 181 u_int16_t linkNum; /* link where addr can be found */ 182 u_int16_t age; /* seconds ago entry was created */ 183 u_int16_t staleness; /* seconds ago host last heard from */ 184 }; 185 struct ng_bridge_host_tbl_ary { 186 u_int32_t numHosts; 187 struct ng_bridge_hostent_tbl hosts[]; 188 }; 189 #endif /* NGM_BRIDGE_TABLE_ABI */ 190 191 /* Netgraph control messages */ 192 enum { 193 NGM_BRIDGE_SET_CONFIG = 1, /* set node configuration */ 194 NGM_BRIDGE_GET_CONFIG, /* get node configuration */ 195 NGM_BRIDGE_RESET, /* reset (forget) all information */ 196 NGM_BRIDGE_GET_STATS, /* get link stats */ 197 NGM_BRIDGE_CLR_STATS, /* clear link stats */ 198 NGM_BRIDGE_GETCLR_STATS, /* atomically get & clear link stats */ 199 NGM_BRIDGE_GET_TABLE, /* get link table */ 200 NGM_BRIDGE_SET_PERSISTENT, /* set persistent mode */ 201 }; 202 203 #endif /* _NETGRAPH_NG_BRIDGE_H_ */ 204 205