2 * Copyright (c) 2000 Whistle Communications, Inc.
5 * Subject to the following obligations and disclaimer of warranty, use and
6 * redistribution of this software, in source or object code forms, with or
7 * without modifications are expressly permitted by Whistle Communications;
8 * provided, however, that:
9 * 1. Any and all reproductions of the source or object code must include the
10 * copyright notice above and the following disclaimer of warranties; and
11 * 2. No rights are granted, in any manner or form, to use Whistle
12 * Communications, Inc. trademarks, including the mark "WHISTLE
13 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
14 * such appears in the above copyright notice or in the software.
16 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
17 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
18 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
19 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
21 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
22 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
23 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
24 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
25 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
26 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
27 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
34 * Author: Archie Cobbs <archie@freebsd.org>
40 * ng_bridge(4) netgraph node type
42 * The node performs standard intelligent Ethernet bridging over
43 * each of its connected hooks, or links. A simple loop detection
44 * algorithm is included which disables a link for priv->conf.loopTimeout
45 * seconds when a host is seen to have jumped from one link to
46 * another within priv->conf.minStableAge seconds.
48 * We keep a hashtable that maps Ethernet addresses to host info,
49 * which is contained in struct ng_bridge_host's. These structures
50 * tell us on which link the host may be found. A host's entry will
51 * expire after priv->conf.maxStaleness seconds.
53 * This node is optimzed for stable networks, where machines jump
54 * from one port to the other only rarely.
57 #include <sys/param.h>
58 #include <sys/systm.h>
59 #include <sys/kernel.h>
61 #include <sys/malloc.h>
63 #include <sys/errno.h>
64 #include <sys/rwlock.h>
65 #include <sys/syslog.h>
66 #include <sys/socket.h>
67 #include <sys/ctype.h>
70 #include <net/if_var.h>
71 #include <net/ethernet.h>
74 #include <netinet/in.h>
75 #if 0 /* not used yet */
76 #include <netinet/ip_fw.h>
78 #include <netgraph/ng_message.h>
79 #include <netgraph/netgraph.h>
80 #include <netgraph/ng_parse.h>
81 #include <netgraph/ng_bridge.h>
83 #ifdef NG_SEPARATE_MALLOC
84 static MALLOC_DEFINE(M_NETGRAPH_BRIDGE, "netgraph_bridge",
85 "netgraph bridge node");
87 #define M_NETGRAPH_BRIDGE M_NETGRAPH
90 /* Per-link private data */
91 struct ng_bridge_link {
92 hook_p hook; /* netgraph hook */
93 u_int16_t loopCount; /* loop ignore timer */
94 struct ng_bridge_link_stats stats; /* link stats */
97 /* Per-node private data */
98 struct ng_bridge_private {
99 struct ng_bridge_bucket *tab; /* hash table bucket array */
100 struct ng_bridge_config conf; /* node configuration */
101 node_p node; /* netgraph node */
102 u_int numHosts; /* num entries in table */
103 u_int numBuckets; /* num buckets in table */
104 u_int hashMask; /* numBuckets - 1 */
105 int numLinks; /* num connected links */
106 int persistent; /* can exist w/o hooks */
107 struct callout timer; /* one second periodic timer */
109 typedef struct ng_bridge_private *priv_p;
111 /* Information about a host, stored in a hash table entry */
112 struct ng_bridge_hent {
113 struct ng_bridge_host host; /* actual host info */
114 SLIST_ENTRY(ng_bridge_hent) next; /* next entry in bucket */
117 /* Hash table bucket declaration */
118 SLIST_HEAD(ng_bridge_bucket, ng_bridge_hent);
120 /* Netgraph node methods */
121 static ng_constructor_t ng_bridge_constructor;
122 static ng_rcvmsg_t ng_bridge_rcvmsg;
123 static ng_shutdown_t ng_bridge_shutdown;
124 static ng_newhook_t ng_bridge_newhook;
125 static ng_rcvdata_t ng_bridge_rcvdata;
126 static ng_disconnect_t ng_bridge_disconnect;
128 /* Other internal functions */
129 static struct ng_bridge_host *ng_bridge_get(priv_p priv, const u_char *addr);
130 static int ng_bridge_put(priv_p priv, const u_char *addr, link_p link);
131 static void ng_bridge_rehash(priv_p priv);
132 static void ng_bridge_remove_hosts(priv_p priv, link_p link);
133 static void ng_bridge_timeout(node_p node, hook_p hook, void *arg1, int arg2);
134 static const char *ng_bridge_nodename(node_p node);
136 /* Ethernet broadcast */
137 static const u_char ng_bridge_bcast_addr[ETHER_ADDR_LEN] =
138 { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
140 /* Compare Ethernet addresses using 32 and 16 bit words instead of bytewise */
141 #define ETHER_EQUAL(a,b) (((const u_int32_t *)(a))[0] \
142 == ((const u_int32_t *)(b))[0] \
143 && ((const u_int16_t *)(a))[2] \
144 == ((const u_int16_t *)(b))[2])
146 /* Minimum and maximum number of hash buckets. Must be a power of two. */
147 #define MIN_BUCKETS (1 << 5) /* 32 */
148 #define MAX_BUCKETS (1 << 14) /* 16384 */
150 /* Configuration default values */
151 #define DEFAULT_LOOP_TIMEOUT 60
152 #define DEFAULT_MAX_STALENESS (15 * 60) /* same as ARP timeout */
153 #define DEFAULT_MIN_STABLE_AGE 1
155 /******************************************************************
157 ******************************************************************/
160 * How to determine the length of the table returned by NGM_BRIDGE_GET_TABLE
163 ng_bridge_getTableLength(const struct ng_parse_type *type,
164 const u_char *start, const u_char *buf)
166 const struct ng_bridge_host_ary *const hary
167 = (const struct ng_bridge_host_ary *)(buf - sizeof(u_int32_t));
169 return hary->numHosts;
172 /* Parse type for struct ng_bridge_host_ary */
173 static const struct ng_parse_struct_field ng_bridge_host_type_fields[]
174 = NG_BRIDGE_HOST_TYPE_INFO(&ng_parse_enaddr_type);
175 static const struct ng_parse_type ng_bridge_host_type = {
176 &ng_parse_struct_type,
177 &ng_bridge_host_type_fields
179 static const struct ng_parse_array_info ng_bridge_hary_type_info = {
180 &ng_bridge_host_type,
181 ng_bridge_getTableLength
183 static const struct ng_parse_type ng_bridge_hary_type = {
184 &ng_parse_array_type,
185 &ng_bridge_hary_type_info
187 static const struct ng_parse_struct_field ng_bridge_host_ary_type_fields[]
188 = NG_BRIDGE_HOST_ARY_TYPE_INFO(&ng_bridge_hary_type);
189 static const struct ng_parse_type ng_bridge_host_ary_type = {
190 &ng_parse_struct_type,
191 &ng_bridge_host_ary_type_fields
194 /* Parse type for struct ng_bridge_config */
195 static const struct ng_parse_struct_field ng_bridge_config_type_fields[]
196 = NG_BRIDGE_CONFIG_TYPE_INFO;
197 static const struct ng_parse_type ng_bridge_config_type = {
198 &ng_parse_struct_type,
199 &ng_bridge_config_type_fields
202 /* Parse type for struct ng_bridge_link_stat */
203 static const struct ng_parse_struct_field ng_bridge_stats_type_fields[]
204 = NG_BRIDGE_STATS_TYPE_INFO;
205 static const struct ng_parse_type ng_bridge_stats_type = {
206 &ng_parse_struct_type,
207 &ng_bridge_stats_type_fields
210 /* List of commands and how to convert arguments to/from ASCII */
211 static const struct ng_cmdlist ng_bridge_cmdlist[] = {
214 NGM_BRIDGE_SET_CONFIG,
216 &ng_bridge_config_type,
221 NGM_BRIDGE_GET_CONFIG,
224 &ng_bridge_config_type
235 NGM_BRIDGE_GET_STATS,
237 &ng_parse_uint32_type,
238 &ng_bridge_stats_type
242 NGM_BRIDGE_CLR_STATS,
244 &ng_parse_uint32_type,
249 NGM_BRIDGE_GETCLR_STATS,
251 &ng_parse_uint32_type,
252 &ng_bridge_stats_type
256 NGM_BRIDGE_GET_TABLE,
259 &ng_bridge_host_ary_type
263 NGM_BRIDGE_SET_PERSISTENT,
271 /* Node type descriptor */
272 static struct ng_type ng_bridge_typestruct = {
273 .version = NG_ABI_VERSION,
274 .name = NG_BRIDGE_NODE_TYPE,
275 .constructor = ng_bridge_constructor,
276 .rcvmsg = ng_bridge_rcvmsg,
277 .shutdown = ng_bridge_shutdown,
278 .newhook = ng_bridge_newhook,
279 .rcvdata = ng_bridge_rcvdata,
280 .disconnect = ng_bridge_disconnect,
281 .cmdlist = ng_bridge_cmdlist,
283 NETGRAPH_INIT(bridge, &ng_bridge_typestruct);
285 /******************************************************************
286 NETGRAPH NODE METHODS
287 ******************************************************************/
293 ng_bridge_constructor(node_p node)
297 /* Allocate and initialize private info */
298 priv = malloc(sizeof(*priv), M_NETGRAPH_BRIDGE, M_WAITOK | M_ZERO);
299 ng_callout_init(&priv->timer);
301 /* Allocate and initialize hash table, etc. */
302 priv->tab = malloc(MIN_BUCKETS * sizeof(*priv->tab),
303 M_NETGRAPH_BRIDGE, M_WAITOK | M_ZERO);
304 priv->numBuckets = MIN_BUCKETS;
305 priv->hashMask = MIN_BUCKETS - 1;
306 priv->conf.debugLevel = 1;
307 priv->conf.loopTimeout = DEFAULT_LOOP_TIMEOUT;
308 priv->conf.maxStaleness = DEFAULT_MAX_STALENESS;
309 priv->conf.minStableAge = DEFAULT_MIN_STABLE_AGE;
312 * This node has all kinds of stuff that could be screwed by SMP.
313 * Until it gets it's own internal protection, we go through in
314 * single file. This could hurt a machine bridging between two
315 * GB ethernets so it should be fixed.
316 * When it's fixed the process SHOULD NOT SLEEP, spinlocks please!
319 NG_NODE_FORCE_WRITER(node);
320 NG_NODE_SET_PRIVATE(node, priv);
323 /* Start timer; timer is always running while node is alive */
324 ng_callout(&priv->timer, node, NULL, hz, ng_bridge_timeout, NULL, 0);
331 * Method for attaching a new hook
334 ng_bridge_newhook(node_p node, hook_p hook, const char *name)
336 const priv_p priv = NG_NODE_PRIVATE(node);
338 /* Check for a link hook */
339 if (strlen(name) > strlen(NG_BRIDGE_HOOK_LINK_PREFIX)) {
340 char linkName[NG_HOOKSIZ];
344 /* primitive parsing */
345 linkNum = strtoul(name + strlen(NG_BRIDGE_HOOK_LINK_PREFIX),
347 /* validation by comparing against the reconstucted name */
348 snprintf(linkName, sizeof(linkName),
349 "%s%u", NG_BRIDGE_HOOK_LINK_PREFIX,
351 if (strcmp(linkName, name) != 0)
354 if(NG_PEER_NODE(hook) == node)
357 link = malloc(sizeof(*link), M_NETGRAPH_BRIDGE,
362 NG_HOOK_SET_PRIVATE(hook, link);
367 /* Unknown hook name */
372 * Receive a control message
375 ng_bridge_reset_link(hook_p hook, void *arg __unused)
377 link_p priv = NG_HOOK_PRIVATE(hook);
380 bzero(&priv->stats, sizeof(priv->stats));
387 ng_bridge_rcvmsg(node_p node, item_p item, hook_p lasthook)
389 const priv_p priv = NG_NODE_PRIVATE(node);
390 struct ng_mesg *resp = NULL;
394 NGI_GET_MSG(item, msg);
395 switch (msg->header.typecookie) {
396 #ifdef NGM_BRIDGE_TABLE_ABI
397 case NGM_BRIDGE_COOKIE_TBL:
398 switch (msg->header.cmd) {
399 case NGM_BRIDGE_GET_CONFIG:
401 struct ng_bridge_config_tbl *conf;
403 NG_MKRESPONSE(resp, msg, sizeof(*conf),
409 conf = (struct ng_bridge_config_tbl *)resp->data;
410 conf->cfg = priv->conf;
413 case NGM_BRIDGE_SET_CONFIG:
415 struct ng_bridge_config_tbl *conf;
417 if (msg->header.arglen != sizeof(*conf)) {
421 conf = (struct ng_bridge_config_tbl *)msg->data;
422 priv->conf = conf->cfg;
425 case NGM_BRIDGE_GET_TABLE:
427 struct ng_bridge_host_tbl_ary *ary;
428 struct ng_bridge_hent *hent;
431 NG_MKRESPONSE(resp, msg, sizeof(*ary) +
432 (priv->numHosts * sizeof(*ary->hosts)), M_NOWAIT);
437 ary = (struct ng_bridge_host_tbl_ary *)resp->data;
438 ary->numHosts = priv->numHosts;
440 for (bucket = 0; bucket < priv->numBuckets; bucket++) {
441 SLIST_FOREACH(hent, &priv->tab[bucket], next) {
442 memcpy(ary->hosts[i].addr,
444 sizeof(ary->hosts[i].addr));
445 ary->hosts[i].age = hent->host.age;
446 ary->hosts[i].staleness =
447 hent->host.staleness;
448 ary->hosts[i].linkNum = strtol(
449 NG_HOOK_NAME(hent->host.link->hook) +
450 strlen(NG_BRIDGE_HOOK_LINK_PREFIX),
458 /* If already handled break, otherwise use new ABI. */
459 if (resp != NULL || error != 0)
461 #endif /* NGM_BRIDGE_TABLE_ABI */
462 case NGM_BRIDGE_COOKIE:
463 switch (msg->header.cmd) {
464 case NGM_BRIDGE_GET_CONFIG:
466 struct ng_bridge_config *conf;
468 NG_MKRESPONSE(resp, msg,
469 sizeof(struct ng_bridge_config), M_NOWAIT);
474 conf = (struct ng_bridge_config *)resp->data;
475 *conf = priv->conf; /* no sanity checking needed */
478 case NGM_BRIDGE_SET_CONFIG:
480 struct ng_bridge_config *conf;
482 if (msg->header.arglen
483 != sizeof(struct ng_bridge_config)) {
487 conf = (struct ng_bridge_config *)msg->data;
491 case NGM_BRIDGE_RESET:
495 /* Flush all entries in the hash table */
496 ng_bridge_remove_hosts(priv, NULL);
498 /* Reset all loop detection counters and stats */
499 NG_NODE_FOREACH_HOOK(node, ng_bridge_reset_link, NULL,
503 case NGM_BRIDGE_GET_STATS:
504 case NGM_BRIDGE_CLR_STATS:
505 case NGM_BRIDGE_GETCLR_STATS:
509 char linkName[NG_HOOKSIZ];
511 /* Get link number */
512 if (msg->header.arglen != sizeof(u_int32_t)) {
516 snprintf(linkName, sizeof(linkName),
517 "%s%u", NG_BRIDGE_HOOK_LINK_PREFIX,
518 *((u_int32_t *)msg->data));
520 if ((hook = ng_findhook(node, linkName)) == NULL) {
524 link = NG_HOOK_PRIVATE(hook);
526 /* Get/clear stats */
527 if (msg->header.cmd != NGM_BRIDGE_CLR_STATS) {
528 NG_MKRESPONSE(resp, msg,
529 sizeof(link->stats), M_NOWAIT);
535 resp->data, sizeof(link->stats));
537 if (msg->header.cmd != NGM_BRIDGE_GET_STATS)
538 bzero(&link->stats, sizeof(link->stats));
541 case NGM_BRIDGE_GET_TABLE:
543 struct ng_bridge_host_ary *ary;
544 struct ng_bridge_hent *hent;
547 NG_MKRESPONSE(resp, msg, sizeof(*ary)
548 + (priv->numHosts * sizeof(*ary->hosts)), M_NOWAIT);
553 ary = (struct ng_bridge_host_ary *)resp->data;
554 ary->numHosts = priv->numHosts;
555 for (bucket = 0; bucket < priv->numBuckets; bucket++) {
556 SLIST_FOREACH(hent, &priv->tab[bucket], next) {
557 memcpy(ary->hosts[i].addr,
559 sizeof(ary->hosts[i].addr));
560 ary->hosts[i].age = hent->host.age;
561 ary->hosts[i].staleness = hent->host.staleness;
562 strncpy(ary->hosts[i].hook,
563 NG_HOOK_NAME(hent->host.link->hook),
564 sizeof(ary->hosts[i].hook));
570 case NGM_BRIDGE_SET_PERSISTENT:
572 priv->persistent = 1;
586 NG_RESPOND_MSG(error, node, item, resp);
592 * Receive data on a hook
594 struct ng_bridge_send_ctx {
595 link_p foundFirst, incoming;
601 ng_bridge_send_ctx(hook_p dst, void *arg)
603 struct ng_bridge_send_ctx *ctx = arg;
604 link_p destLink = NG_HOOK_PRIVATE(dst);
605 struct mbuf *m2 = NULL;
608 /* Skip incoming link */
609 if (destLink == ctx->incoming) {
613 if (ctx->foundFirst == NULL) {
615 * This is the first usable link we have found.
616 * Reserve it for the originals.
617 * If we never find another we save a copy.
619 ctx->foundFirst = destLink;
624 * It's usable link but not the reserved (first) one.
625 * Copy mbuf info for sending.
627 m2 = m_dup(ctx->m, M_NOWAIT); /* XXX m_copypacket() */
629 ctx->incoming->stats.memoryFailures++;
630 ctx->error = ENOBUFS;
631 return (0); /* abort loop */
636 destLink->stats.xmitPackets++;
637 destLink->stats.xmitOctets += m2->m_pkthdr.len;
638 switch (ctx->manycast) {
639 default: /* unknown unicast */
641 case 1: /* multicast */
642 destLink->stats.xmitMulticasts++;
644 case 2: /* broadcast */
645 destLink->stats.xmitBroadcasts++;
650 NG_SEND_DATA_ONLY(error, destLink->hook, m2);
657 ng_bridge_rcvdata(hook_p hook, item_p item)
659 const node_p node = NG_HOOK_NODE(hook);
660 const priv_p priv = NG_NODE_PRIVATE(node);
661 struct ng_bridge_host *host;
662 struct ether_header *eh;
663 struct ng_bridge_send_ctx ctx = { 0 };
666 NGI_GET_M(item, ctx.m);
668 ctx.incoming = NG_HOOK_PRIVATE(hook);
669 /* Sanity check packet and pull up header */
670 if (ctx.m->m_pkthdr.len < ETHER_HDR_LEN) {
671 ctx.incoming->stats.recvRunts++;
676 if (ctx.m->m_len < ETHER_HDR_LEN && !(ctx.m = m_pullup(ctx.m, ETHER_HDR_LEN))) {
677 ctx.incoming->stats.memoryFailures++;
681 eh = mtod(ctx.m, struct ether_header *);
682 if ((eh->ether_shost[0] & 1) != 0) {
683 ctx.incoming->stats.recvInvalid++;
689 /* Is link disabled due to a loopback condition? */
690 if (ctx.incoming->loopCount != 0) {
691 ctx.incoming->stats.loopDrops++;
694 return (ELOOP); /* XXX is this an appropriate error? */
698 ctx.incoming->stats.recvPackets++;
699 ctx.incoming->stats.recvOctets += ctx.m->m_pkthdr.len;
700 if ((ctx.manycast = (eh->ether_dhost[0] & 1)) != 0) {
701 if (ETHER_EQUAL(eh->ether_dhost, ng_bridge_bcast_addr)) {
702 ctx.incoming->stats.recvBroadcasts++;
705 ctx.incoming->stats.recvMulticasts++;
708 /* Look up packet's source Ethernet address in hashtable */
709 if ((host = ng_bridge_get(priv, eh->ether_shost)) != NULL) {
711 /* Update time since last heard from this host */
714 /* Did host jump to a different link? */
715 if (host->link != ctx.incoming) {
718 * If the host's old link was recently established
719 * on the old link and it's already jumped to a new
720 * link, declare a loopback condition.
722 if (host->age < priv->conf.minStableAge) {
724 /* Log the problem */
725 if (priv->conf.debugLevel >= 2) {
726 struct ifnet *ifp = ctx.m->m_pkthdr.rcvif;
730 snprintf(suffix, sizeof(suffix),
731 " (%s)", ifp->if_xname);
734 log(LOG_WARNING, "ng_bridge: %s:"
735 " loopback detected on %s%s\n",
736 ng_bridge_nodename(node),
737 NG_HOOK_NAME(hook), suffix);
740 /* Mark link as linka non grata */
741 ctx.incoming->loopCount = priv->conf.loopTimeout;
742 ctx.incoming->stats.loopDetects++;
744 /* Forget all hosts on this link */
745 ng_bridge_remove_hosts(priv, ctx.incoming);
748 ctx.incoming->stats.loopDrops++;
751 return (ELOOP); /* XXX appropriate? */
754 /* Move host over to new link */
755 host->link = ctx.incoming;
759 if (!ng_bridge_put(priv, eh->ether_shost, ctx.incoming)) {
760 ctx.incoming->stats.memoryFailures++;
767 /* Run packet through ipfw processing, if enabled */
769 if (priv->conf.ipfw[linkNum] && V_fw_enable && V_ip_fw_chk_ptr != NULL) {
770 /* XXX not implemented yet */
775 * If unicast and destination host known, deliver to host's link,
776 * unless it is the same link as the packet came in on.
780 /* Determine packet destination link */
781 if ((host = ng_bridge_get(priv, eh->ether_dhost)) != NULL) {
782 link_p destLink = host->link;
784 /* If destination same as incoming link, do nothing */
785 if (destLink == ctx.incoming) {
791 /* Deliver packet out the destination link */
792 destLink->stats.xmitPackets++;
793 destLink->stats.xmitOctets += ctx.m->m_pkthdr.len;
794 NG_FWD_NEW_DATA(ctx.error, item, destLink->hook, ctx.m);
798 /* Destination host is not known */
799 ctx.incoming->stats.recvUnknown++;
802 /* Distribute unknown, multicast, broadcast pkts to all other links */
803 NG_NODE_FOREACH_HOOK(node, ng_bridge_send_ctx, &ctx, ret);
805 /* If we never saw a good link, leave. */
806 if (ctx.foundFirst == NULL || ctx.error != 0) {
813 * If we've sent all the others, send the original
814 * on the first link we found.
816 NG_FWD_NEW_DATA(ctx.error, item, ctx.foundFirst->hook, ctx.m);
824 ng_bridge_shutdown(node_p node)
826 const priv_p priv = NG_NODE_PRIVATE(node);
829 * Shut down everything including the timer. Even if the
830 * callout has already been dequeued and is about to be
831 * run, ng_bridge_timeout() won't be fired as the node
832 * is already marked NGF_INVALID, so we're safe to free
835 KASSERT(priv->numLinks == 0 && priv->numHosts == 0,
836 ("%s: numLinks=%d numHosts=%d",
837 __func__, priv->numLinks, priv->numHosts));
838 ng_uncallout(&priv->timer, node);
839 NG_NODE_SET_PRIVATE(node, NULL);
841 free(priv->tab, M_NETGRAPH_BRIDGE);
842 free(priv, M_NETGRAPH_BRIDGE);
847 * Hook disconnection.
850 ng_bridge_disconnect(hook_p hook)
852 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
853 link_p link = NG_HOOK_PRIVATE(hook);
855 /* Remove all hosts associated with this link */
856 ng_bridge_remove_hosts(priv, link);
858 /* Free associated link information */
859 free(link, M_NETGRAPH_BRIDGE);
862 /* If no more hooks, go away */
863 if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0)
864 && (NG_NODE_IS_VALID(NG_HOOK_NODE(hook)))
865 && !priv->persistent) {
866 ng_rmnode_self(NG_HOOK_NODE(hook));
871 /******************************************************************
873 ******************************************************************/
878 #define HASH(addr,mask) ( (((const u_int16_t *)(addr))[0] \
879 ^ ((const u_int16_t *)(addr))[1] \
880 ^ ((const u_int16_t *)(addr))[2]) & (mask) )
883 * Find a host entry in the table.
885 static struct ng_bridge_host *
886 ng_bridge_get(priv_p priv, const u_char *addr)
888 const int bucket = HASH(addr, priv->hashMask);
889 struct ng_bridge_hent *hent;
891 SLIST_FOREACH(hent, &priv->tab[bucket], next) {
892 if (ETHER_EQUAL(hent->host.addr, addr))
893 return (&hent->host);
899 * Add a new host entry to the table. This assumes the host doesn't
900 * already exist in the table. Returns 1 on success, 0 if there
901 * was a memory allocation failure.
904 ng_bridge_put(priv_p priv, const u_char *addr, link_p link)
906 const int bucket = HASH(addr, priv->hashMask);
907 struct ng_bridge_hent *hent;
910 /* Assert that entry does not already exist in hashtable */
911 SLIST_FOREACH(hent, &priv->tab[bucket], next) {
912 KASSERT(!ETHER_EQUAL(hent->host.addr, addr),
913 ("%s: entry %6D exists in table", __func__, addr, ":"));
917 /* Allocate and initialize new hashtable entry */
918 hent = malloc(sizeof(*hent), M_NETGRAPH_BRIDGE, M_NOWAIT);
921 bcopy(addr, hent->host.addr, ETHER_ADDR_LEN);
922 hent->host.link = link;
923 hent->host.staleness = 0;
926 /* Add new element to hash bucket */
927 SLIST_INSERT_HEAD(&priv->tab[bucket], hent, next);
930 /* Resize table if necessary */
931 ng_bridge_rehash(priv);
936 * Resize the hash table. We try to maintain the number of buckets
937 * such that the load factor is in the range 0.25 to 1.0.
939 * If we can't get the new memory then we silently fail. This is OK
940 * because things will still work and we'll try again soon anyway.
943 ng_bridge_rehash(priv_p priv)
945 struct ng_bridge_bucket *newTab;
946 int oldBucket, newBucket;
950 /* Is table too full or too empty? */
951 if (priv->numHosts > priv->numBuckets
952 && (priv->numBuckets << 1) <= MAX_BUCKETS)
953 newNumBuckets = priv->numBuckets << 1;
954 else if (priv->numHosts < (priv->numBuckets >> 2)
955 && (priv->numBuckets >> 2) >= MIN_BUCKETS)
956 newNumBuckets = priv->numBuckets >> 2;
959 newMask = newNumBuckets - 1;
961 /* Allocate and initialize new table */
962 newTab = malloc(newNumBuckets * sizeof(*newTab),
963 M_NETGRAPH_BRIDGE, M_NOWAIT | M_ZERO);
967 /* Move all entries from old table to new table */
968 for (oldBucket = 0; oldBucket < priv->numBuckets; oldBucket++) {
969 struct ng_bridge_bucket *const oldList = &priv->tab[oldBucket];
971 while (!SLIST_EMPTY(oldList)) {
972 struct ng_bridge_hent *const hent
973 = SLIST_FIRST(oldList);
975 SLIST_REMOVE_HEAD(oldList, next);
976 newBucket = HASH(hent->host.addr, newMask);
977 SLIST_INSERT_HEAD(&newTab[newBucket], hent, next);
981 /* Replace old table with new one */
982 if (priv->conf.debugLevel >= 3) {
983 log(LOG_INFO, "ng_bridge: %s: table size %d -> %d\n",
984 ng_bridge_nodename(priv->node),
985 priv->numBuckets, newNumBuckets);
987 free(priv->tab, M_NETGRAPH_BRIDGE);
988 priv->numBuckets = newNumBuckets;
989 priv->hashMask = newMask;
994 /******************************************************************
996 ******************************************************************/
1000 * Remove all hosts associated with a specific link from the hashtable.
1001 * If linkNum == -1, then remove all hosts in the table.
1004 ng_bridge_remove_hosts(priv_p priv, link_p link)
1008 for (bucket = 0; bucket < priv->numBuckets; bucket++) {
1009 struct ng_bridge_hent **hptr = &SLIST_FIRST(&priv->tab[bucket]);
1011 while (*hptr != NULL) {
1012 struct ng_bridge_hent *const hent = *hptr;
1014 if (link == NULL || hent->host.link == link) {
1015 *hptr = SLIST_NEXT(hent, next);
1016 free(hent, M_NETGRAPH_BRIDGE);
1019 hptr = &SLIST_NEXT(hent, next);
1025 * Handle our once-per-second timeout event. We do two things:
1026 * we decrement link->loopCount for those links being muted due to
1027 * a detected loopback condition, and we remove any hosts from
1028 * the hashtable whom we haven't heard from in a long while.
1031 ng_bridge_unmute(hook_p hook, void *arg)
1033 link_p link = NG_HOOK_PRIVATE(hook);
1034 node_p node = NG_HOOK_NODE(hook);
1035 priv_p priv = NG_NODE_PRIVATE(node);
1038 if (link->loopCount != 0) {
1040 if (link->loopCount == 0 && priv->conf.debugLevel >= 2) {
1041 log(LOG_INFO, "ng_bridge: %s:"
1042 " restoring looped back %s\n",
1043 ng_bridge_nodename(node), NG_HOOK_NAME(hook));
1051 ng_bridge_timeout(node_p node, hook_p hook, void *arg1, int arg2)
1053 const priv_p priv = NG_NODE_PRIVATE(node);
1058 /* Update host time counters and remove stale entries */
1059 for (bucket = 0; bucket < priv->numBuckets; bucket++) {
1060 struct ng_bridge_hent **hptr = &SLIST_FIRST(&priv->tab[bucket]);
1062 while (*hptr != NULL) {
1063 struct ng_bridge_hent *const hent = *hptr;
1065 /* Remove hosts we haven't heard from in a while */
1066 if (++hent->host.staleness >= priv->conf.maxStaleness) {
1067 *hptr = SLIST_NEXT(hent, next);
1068 free(hent, M_NETGRAPH_BRIDGE);
1071 if (hent->host.age < 0xffff)
1073 hptr = &SLIST_NEXT(hent, next);
1078 KASSERT(priv->numHosts == counter,
1079 ("%s: hosts: %d != %d", __func__, priv->numHosts, counter));
1081 /* Decrease table size if necessary */
1082 ng_bridge_rehash(priv);
1084 /* Decrease loop counter on muted looped back links */
1086 NG_NODE_FOREACH_HOOK(node, ng_bridge_unmute, &counter, ret);
1087 KASSERT(priv->numLinks == counter,
1088 ("%s: links: %d != %d", __func__, priv->numLinks, counter));
1090 /* Register a new timeout, keeping the existing node reference */
1091 ng_callout(&priv->timer, node, NULL, hz, ng_bridge_timeout, NULL, 0);
1095 * Return node's "name", even if it doesn't have one.
1098 ng_bridge_nodename(node_p node)
1100 static char name[NG_NODESIZ];
1102 if (NG_NODE_HAS_NAME(node))
1103 snprintf(name, sizeof(name), "%s", NG_NODE_NAME(node));
1105 snprintf(name, sizeof(name), "[%x]", ng_node2ID(node));