xref: /dragonfly/sys/netgraph7/bridge/ng_bridge.h (revision cf89a63b)
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: src/sys/netgraph/ng_bridge.h,v 1.4 2005/10/28 14:41:28 ru Exp $
41  * $DragonFly: src/sys/netgraph7/ng_bridge.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
42  */
43 
44 #ifndef _NETGRAPH_NG_BRIDGE_H_
45 #define _NETGRAPH_NG_BRIDGE_H_
46 
47 /* Node type name and magic cookie */
48 #define NG_BRIDGE_NODE_TYPE		"bridge"
49 #define NGM_BRIDGE_COOKIE		967239368
50 
51 /* Hook names */
52 #define NG_BRIDGE_HOOK_LINK_PREFIX	"link"	 /* append decimal integer */
53 #define NG_BRIDGE_HOOK_LINK_FMT		"link%d" /* for use with printf(3) */
54 
55 /* Maximum number of supported links */
56 #define NG_BRIDGE_MAX_LINKS		32
57 
58 /* Node configuration structure */
59 struct ng_bridge_config {
60 	u_char		ipfw[NG_BRIDGE_MAX_LINKS]; 	/* enable ipfw */
61 	u_char		debugLevel;		/* debug level */
62 	u_int32_t	loopTimeout;		/* link loopback mute time */
63 	u_int32_t	maxStaleness;		/* max host age before nuking */
64 	u_int32_t	minStableAge;		/* min time for a stable host */
65 };
66 
67 /* Keep this in sync with the above structure definition */
68 #define NG_BRIDGE_CONFIG_TYPE_INFO(ainfo)	{		\
69 	  { "ipfw",		(ainfo)			},	\
70 	  { "debugLevel",	&ng_parse_uint8_type	},	\
71 	  { "loopTimeout",	&ng_parse_uint32_type	},	\
72 	  { "maxStaleness",	&ng_parse_uint32_type	},	\
73 	  { "minStableAge",	&ng_parse_uint32_type	},	\
74 	  { NULL }						\
75 }
76 
77 /* Statistics structure (one for each link) */
78 struct ng_bridge_link_stats {
79 	u_int64_t	recvOctets;	/* total octets rec'd on link */
80 	u_int64_t	recvPackets;	/* total pkts rec'd on link */
81 	u_int64_t	recvMulticasts;	/* multicast pkts rec'd on link */
82 	u_int64_t	recvBroadcasts;	/* broadcast pkts rec'd on link */
83 	u_int64_t	recvUnknown;	/* pkts rec'd with unknown dest addr */
84 	u_int64_t	recvRunts;	/* pkts rec'd less than 14 bytes */
85 	u_int64_t	recvInvalid;	/* pkts rec'd with bogus source addr */
86 	u_int64_t	xmitOctets;	/* total octets xmit'd on link */
87 	u_int64_t	xmitPackets;	/* total pkts xmit'd on link */
88 	u_int64_t	xmitMulticasts;	/* multicast pkts xmit'd on link */
89 	u_int64_t	xmitBroadcasts;	/* broadcast pkts xmit'd on link */
90 	u_int64_t	loopDrops;	/* pkts dropped due to loopback */
91 	u_int64_t	loopDetects;	/* number of loop detections */
92 	u_int64_t	memoryFailures;	/* times couldn't get mem or mbuf */
93 };
94 
95 /* Keep this in sync with the above structure definition */
96 #define NG_BRIDGE_STATS_TYPE_INFO	{			\
97 	  { "recvOctets",	&ng_parse_uint64_type	},	\
98 	  { "recvPackets",	&ng_parse_uint64_type	},	\
99 	  { "recvMulticast",	&ng_parse_uint64_type	},	\
100 	  { "recvBroadcast",	&ng_parse_uint64_type	},	\
101 	  { "recvUnknown",	&ng_parse_uint64_type	},	\
102 	  { "recvRunts",	&ng_parse_uint64_type	},	\
103 	  { "recvInvalid",	&ng_parse_uint64_type	},	\
104 	  { "xmitOctets",	&ng_parse_uint64_type	},	\
105 	  { "xmitPackets",	&ng_parse_uint64_type	},	\
106 	  { "xmitMulticasts",	&ng_parse_uint64_type	},	\
107 	  { "xmitBroadcasts",	&ng_parse_uint64_type	},	\
108 	  { "loopDrops",	&ng_parse_uint64_type	},	\
109 	  { "loopDetects",	&ng_parse_uint64_type	},	\
110 	  { "memoryFailures",	&ng_parse_uint64_type	},	\
111 	  { NULL }						\
112 }
113 
114 /* Structure describing a single host */
115 struct ng_bridge_host {
116 	u_char		addr[6];	/* ethernet address */
117 	u_int16_t	linkNum;	/* link where addr can be found */
118 	u_int16_t	age;		/* seconds ago entry was created */
119 	u_int16_t	staleness;	/* seconds ago host last heard from */
120 };
121 
122 /* Keep this in sync with the above structure definition */
123 #define NG_BRIDGE_HOST_TYPE_INFO(entype)	{		\
124 	  { "addr",		(entype)		},	\
125 	  { "linkNum",		&ng_parse_uint16_type	},	\
126 	  { "age",		&ng_parse_uint16_type	},	\
127 	  { "staleness",	&ng_parse_uint16_type	},	\
128 	  { NULL }						\
129 }
130 
131 /* Structure returned by NGM_BRIDGE_GET_TABLE */
132 struct ng_bridge_host_ary {
133 	u_int32_t		numHosts;
134 	struct ng_bridge_host	hosts[];
135 };
136 
137 /* Keep this in sync with the above structure definition */
138 #define NG_BRIDGE_HOST_ARY_TYPE_INFO(harytype)	{		\
139 	  { "numHosts",		&ng_parse_uint32_type	},	\
140 	  { "hosts",		(harytype)		},	\
141 	  { NULL }						\
142 }
143 
144 /* Netgraph control messages */
145 enum {
146 	NGM_BRIDGE_SET_CONFIG = 1,	/* set node configuration */
147 	NGM_BRIDGE_GET_CONFIG,		/* get node configuration */
148 	NGM_BRIDGE_RESET,		/* reset (forget) all information */
149 	NGM_BRIDGE_GET_STATS,		/* get link stats */
150 	NGM_BRIDGE_CLR_STATS,		/* clear link stats */
151 	NGM_BRIDGE_GETCLR_STATS,	/* atomically get & clear link stats */
152 	NGM_BRIDGE_GET_TABLE,		/* get link table */
153 };
154 
155 #endif /* _NETGRAPH_NG_BRIDGE_H_ */
156 
157