xref: /freebsd/sys/netgraph/ng_one2many.h (revision 3047fefe49f57a673de8df152c199de12ec2c6d3)
1 
2 /*
3  * ng_one2many.h
4  *
5  * Copyright (c) 2000 Whistle Communications, Inc.
6  * All rights reserved.
7  *
8  * Subject to the following obligations and disclaimer of warranty, use and
9  * redistribution of this software, in source or object code forms, with or
10  * without modifications are expressly permitted by Whistle Communications;
11  * provided, however, that:
12  * 1. Any and all reproductions of the source or object code must include the
13  *    copyright notice above and the following disclaimer of warranties; and
14  * 2. No rights are granted, in any manner or form, to use Whistle
15  *    Communications, Inc. trademarks, including the mark "WHISTLE
16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17  *    such appears in the above copyright notice or in the software.
18  *
19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
35  * OF SUCH DAMAGE.
36  *
37  * Author: Archie Cobbs <archie@freebsd.org>
38  *
39  * $FreeBSD$
40  */
41 
42 #ifndef _NETGRAPH_NG_ONE2MANY_H_
43 #define _NETGRAPH_NG_ONE2MANY_H_
44 
45 /* Node type name and magic cookie */
46 #define NG_ONE2MANY_NODE_TYPE		"one2many"
47 #define NGM_ONE2MANY_COOKIE		971111383
48 
49 /* Hook names */
50 #define NG_ONE2MANY_HOOK_ONE		"one"
51 #define NG_ONE2MANY_HOOK_MANY_PREFIX	"many"	 /* append decimal integer */
52 #define NG_ONE2MANY_HOOK_MANY_FMT	"many%d" /* for use with printf(3) */
53 
54 /* Maximum number of supported "many" links */
55 #define NG_ONE2MANY_MAX_LINKS		64
56 
57 /* Link number used to indicate the "one" hook */
58 #define NG_ONE2MANY_ONE_LINKNUM		(-1)
59 
60 /* Algorithms for outgoing packet distribution (XXX only one so far) */
61 #define NG_ONE2MANY_XMIT_ROUNDROBIN	1	/* round-robin delivery */
62 #define NG_ONE2MANY_XMIT_ALL		2	/* send packets to all many hooks */
63 
64 /* Algorithms for detecting link failure (XXX only one so far) */
65 #define NG_ONE2MANY_FAIL_MANUAL		1	/* use enabledLinks[] array */
66 
67 /* Node configuration structure */
68 struct ng_one2many_config {
69 	u_int32_t	xmitAlg;		/* how to distribute packets */
70 	u_int32_t	failAlg;		/* how to detect link failure */
71 	u_char		enabledLinks[NG_ONE2MANY_MAX_LINKS];
72 };
73 
74 /* Keep this in sync with the above structure definition */
75 #define NG_ONE2MANY_CONFIG_TYPE_INFO(atype)	{		\
76 	  { "xmitAlg",		&ng_parse_uint32_type	},	\
77 	  { "failAlg",		&ng_parse_uint32_type	},	\
78 	  { "enabledLinks",	(atype)			},	\
79 	  { NULL }						\
80 }
81 
82 /* Statistics structure (one for each link) */
83 struct ng_one2many_link_stats {
84 	u_int64_t	recvOctets;	/* total octets rec'd on link */
85 	u_int64_t	recvPackets;	/* total pkts rec'd on link */
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	memoryFailures;	/* times couldn't get mem or mbuf */
89 };
90 
91 /* Keep this in sync with the above structure definition */
92 #define NG_ONE2MANY_LINK_STATS_TYPE_INFO	{		\
93 	  { "recvOctets",	&ng_parse_uint64_type	},	\
94 	  { "recvPackets",	&ng_parse_uint64_type	},	\
95 	  { "xmitOctets",	&ng_parse_uint64_type	},	\
96 	  { "xmitPackets",	&ng_parse_uint64_type	},	\
97 	  { "memoryFailures",	&ng_parse_uint64_type	},	\
98 	  { NULL }						\
99 }
100 
101 /* Netgraph control messages */
102 enum {
103 	NGM_ONE2MANY_SET_CONFIG,	/* set configuration */
104 	NGM_ONE2MANY_GET_CONFIG,	/* get configuration */
105 	NGM_ONE2MANY_GET_STATS,		/* get link stats */
106 	NGM_ONE2MANY_CLR_STATS,		/* clear link stats */
107 	NGM_ONE2MANY_GETCLR_STATS,	/* atomically get & clear link stats */
108 };
109 
110 #endif /* _NETGRAPH_NG_ONE2MANY_H_ */
111 
112