aboutsummaryrefslogtreecommitdiff
path: root/sys/netgraph/ng_bridge.h
blob: fa4736370e92663875f0fb3f36de7bdc8a11f581 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
 * ng_bridge.h
 */

/*-
 * Copyright (c) 2000 Whistle Communications, Inc.
 * All rights reserved.
 * 
 * Subject to the following obligations and disclaimer of warranty, use and
 * redistribution of this software, in source or object code forms, with or
 * without modifications are expressly permitted by Whistle Communications;
 * provided, however, that:
 * 1. Any and all reproductions of the source or object code must include the
 *    copyright notice above and the following disclaimer of warranties; and
 * 2. No rights are granted, in any manner or form, to use Whistle
 *    Communications, Inc. trademarks, including the mark "WHISTLE
 *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
 *    such appears in the above copyright notice or in the software.
 * 
 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 * Author: Archie Cobbs <archie@freebsd.org>
 *
 * $FreeBSD$
 */

#ifndef _NETGRAPH_NG_BRIDGE_H_
#define _NETGRAPH_NG_BRIDGE_H_

/*
 * Support the older ABI based on fixed size tables.
 * ABI is deprecated, to be removed in releases > 12
 * Please note: There is no API support!
 * You canno create new messages using the old API but messages conforming the
 * old ABI are understood.
 */
#define	NGM_BRIDGE_TABLE_ABI

/* Node type name and magic cookie */
#define NG_BRIDGE_NODE_TYPE		"bridge"
#define NGM_BRIDGE_COOKIE		1569321993

#ifdef NGM_BRIDGE_TABLE_ABI
#define	NGM_BRIDGE_COOKIE_TBL		967239368
#define	NG_BRIDGE_MAX_LINKS		32
#endif /* NGM_BRIDGE_TABLE_ABI */

/* Hook names */
#define NG_BRIDGE_HOOK_LINK_PREFIX	"link"	 /* append decimal integer */
#define NG_BRIDGE_HOOK_LINK_FMT		"link%d" /* for use with printf(3) */

/* Node configuration structure */
struct ng_bridge_config {
	u_char		debugLevel;		/* debug level */
	u_int32_t	loopTimeout;		/* link loopback mute time */
	u_int32_t	maxStaleness;		/* max host age before nuking */
	u_int32_t	minStableAge;		/* min time for a stable host */
};

#ifdef NGM_BRIDGE_TABLE_ABI
struct ng_bridge_config_tbl {
	u_char		ipfw[NG_BRIDGE_MAX_LINKS];
	struct ng_bridge_config cfg;
};
#endif /* NGM_BRIDGE_TABLE_ABI */

/* Keep this in sync with the above structure definition */
#define NG_BRIDGE_CONFIG_TYPE_INFO	{			\
	  { "debugLevel",	&ng_parse_uint8_type	},	\
	  { "loopTimeout",	&ng_parse_uint32_type	},	\
	  { "maxStaleness",	&ng_parse_uint32_type	},	\
	  { "minStableAge",	&ng_parse_uint32_type	},	\
	  { NULL }						\
}

/* Statistics structure (one for each link) */
struct ng_bridge_link_stats {
	u_int64_t	recvOctets;	/* total octets rec'd on link */
	u_int64_t	recvPackets;	/* total pkts rec'd on link */
	u_int64_t	recvMulticasts;	/* multicast pkts rec'd on link */
	u_int64_t	recvBroadcasts;	/* broadcast pkts rec'd on link */
	u_int64_t	recvUnknown;	/* pkts rec'd with unknown dest addr */
	u_int64_t	recvRunts;	/* pkts rec'd less than 14 bytes */
	u_int64_t	recvInvalid;	/* pkts rec'd with bogus source addr */
	u_int64_t	xmitOctets;	/* total octets xmit'd on link */
	u_int64_t	xmitPackets;	/* total pkts xmit'd on link */
	u_int64_t	xmitMulticasts;	/* multicast pkts xmit'd on link */
	u_int64_t	xmitBroadcasts;	/* broadcast pkts xmit'd on link */
	u_int64_t	loopDrops;	/* pkts dropped due to loopback */
	u_int64_t	loopDetects;	/* number of loop detections */
	u_int64_t	memoryFailures;	/* times couldn't get mem or mbuf */
};

/* Keep this in sync with the above structure definition */
#define NG_BRIDGE_STATS_TYPE_INFO	{			\
	  { "recvOctets",	&ng_parse_uint64_type	},	\
	  { "recvPackets",	&ng_parse_uint64_type	},	\
	  { "recvMulticast",	&ng_parse_uint64_type	},	\
	  { "recvBroadcast",	&ng_parse_uint64_type	},	\
	  { "recvUnknown",	&ng_parse_uint64_type	},	\
	  { "recvRunts",	&ng_parse_uint64_type	},	\
	  { "recvInvalid",	&ng_parse_uint64_type	},	\
	  { "xmitOctets",	&ng_parse_uint64_type	},	\
	  { "xmitPackets",	&ng_parse_uint64_type	},	\
	  { "xmitMulticasts",	&ng_parse_uint64_type	},	\
	  { "xmitBroadcasts",	&ng_parse_uint64_type	},	\
	  { "loopDrops",	&ng_parse_uint64_type	},	\
	  { "loopDetects",	&ng_parse_uint64_type	},	\
	  { "memoryFailures",	&ng_parse_uint64_type	},	\
	  { NULL }						\
}

struct ng_bridge_link;
typedef struct ng_bridge_link *link_p;
/* Structure describing a single host */
struct ng_bridge_host {
	u_char		addr[6];	/* ethernet address */
	link_p		link;		/* link where addr can be found */
	u_int16_t	age;		/* seconds ago entry was created */
	u_int16_t	staleness;	/* seconds ago host last heard from */
};

#ifdef NGM_BRIDGE_TABLE_ABI
struct ng_bridge_host_tbl {
	u_char		addr[6];	/* ethernet address */
	u_int16_t	linkNum;	/* link where addr can be found */
	u_int16_t	age;		/* seconds ago entry was created */
	u_int16_t	staleness;	/* seconds ago host last heard from */
};
#endif /* NGM_BRIDGE_TABLE_ABI */

/* external representation of the host */
struct ng_bridge_hostent {
	u_char		addr[6];		/* ethernet address */
	char		hook[NG_HOOKSIZ];	/* link where addr can be found */
	u_int16_t	age;			/* seconds ago entry was created */
	u_int16_t	staleness;		/* seconds ago host last heard from */
};

/* Keep this in sync with the above structure definition */
#define NG_BRIDGE_HOST_TYPE_INFO(entype)	{		\
	  { "addr",		(entype)		},	\
	  { "hook",		&ng_parse_hookbuf_type	},	\
	  { "age",		&ng_parse_uint16_type	},	\
	  { "staleness",	&ng_parse_uint16_type	},	\
	  { NULL }						\
}

/* Structure returned by NGM_BRIDGE_GET_TABLE */
struct ng_bridge_host_ary {
	u_int32_t			numHosts;
	struct ng_bridge_hostent	hosts[];
};

/* Keep this in sync with the above structure definition */
#define NG_BRIDGE_HOST_ARY_TYPE_INFO(harytype)	{		\
	  { "numHosts",		&ng_parse_uint32_type	},	\
	  { "hosts",		(harytype)		},	\
	  { NULL }						\
}

#ifdef NGM_BRIDGE_TABLE_ABI
struct ng_bridge_hostent_tbl {
	u_char		addr[6];		/* ethernet address */
	u_int16_t	linkNum;		/* link where addr can be found */
	u_int16_t	age;			/* seconds ago entry was created */
	u_int16_t	staleness;		/* seconds ago host last heard from */
};
struct ng_bridge_host_tbl_ary {
	u_int32_t			numHosts;
	struct ng_bridge_hostent_tbl	hosts[];
};
#endif /* NGM_BRIDGE_TABLE_ABI */

/* Netgraph control messages */
enum {
	NGM_BRIDGE_SET_CONFIG = 1,	/* set node configuration */
	NGM_BRIDGE_GET_CONFIG,		/* get node configuration */
	NGM_BRIDGE_RESET,		/* reset (forget) all information */
	NGM_BRIDGE_GET_STATS,		/* get link stats */
	NGM_BRIDGE_CLR_STATS,		/* clear link stats */
	NGM_BRIDGE_GETCLR_STATS,	/* atomically get & clear link stats */
	NGM_BRIDGE_GET_TABLE,		/* get link table */
	NGM_BRIDGE_SET_PERSISTENT,	/* set persistent mode */
};

#endif /* _NETGRAPH_NG_BRIDGE_H_ */