[dragonfly.git] / sys / netgraph7 / one2many / ng_one2many.h

/*
 * ng_one2many.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: src/sys/netgraph/ng_one2many.h,v 1.8 2005/01/07 01:45:39 imp Exp $
 * $DragonFly: src/sys/netgraph7/ng_one2many.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
 */

#ifndef _NETGRAPH_NG_ONE2MANY_H_
#define _NETGRAPH_NG_ONE2MANY_H_

/* Node type name and magic cookie */
#define NG_ONE2MANY_NODE_TYPE		"one2many"
#define NGM_ONE2MANY_COOKIE		1100897444

/* Hook names */
#define NG_ONE2MANY_HOOK_ONE		"one"
#define NG_ONE2MANY_HOOK_MANY_PREFIX	"many"	 /* append decimal integer */
#define NG_ONE2MANY_HOOK_MANY_FMT	"many%d" /* for use with printf(3) */

/* Maximum number of supported "many" links */
#define NG_ONE2MANY_MAX_LINKS		64

/* Link number used to indicate the "one" hook */
#define NG_ONE2MANY_ONE_LINKNUM		(-1)

/* Algorithms for outgoing packet distribution (XXX only one so far) */
#define NG_ONE2MANY_XMIT_ROUNDROBIN	1	/* round-robin delivery */
#define NG_ONE2MANY_XMIT_ALL		2	/* send packets to all many hooks */

/* Algorithms for detecting link failure (XXX only one so far) */
#define NG_ONE2MANY_FAIL_MANUAL		1	/* use enabledLinks[] array */
#define NG_ONE2MANY_FAIL_NOTIFY		2	/* listen to flow control msgs */

/* Node configuration structure */
struct ng_one2many_config {
	u_int32_t	xmitAlg;		/* how to distribute packets */
	u_int32_t	failAlg;		/* how to detect link failure */
	u_char		enabledLinks[NG_ONE2MANY_MAX_LINKS];
};

/* Keep this in sync with the above structure definition */
#define NG_ONE2MANY_CONFIG_TYPE_INFO(atype)	{		\
	  { "xmitAlg",		&ng_parse_uint32_type	},	\
	  { "failAlg",		&ng_parse_uint32_type	},	\
	  { "enabledLinks",	(atype)			},	\
	  { NULL }						\
}

/* Statistics structure (one for each link) */
struct ng_one2many_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	xmitOctets;	/* total octets xmit'd on link */
	u_int64_t	xmitPackets;	/* total pkts xmit'd on link */
	u_int64_t	memoryFailures;	/* times couldn't get mem or mbuf */
};

/* Keep this in sync with the above structure definition */
#define NG_ONE2MANY_LINK_STATS_TYPE_INFO	{		\
	  { "recvOctets",	&ng_parse_uint64_type	},	\
	  { "recvPackets",	&ng_parse_uint64_type	},	\
	  { "xmitOctets",	&ng_parse_uint64_type	},	\
	  { "xmitPackets",	&ng_parse_uint64_type	},	\
	  { "memoryFailures",	&ng_parse_uint64_type	},	\
	  { NULL }						\
}

/* Netgraph control messages */
enum {
	NGM_ONE2MANY_SET_CONFIG,	/* set configuration */
	NGM_ONE2MANY_GET_CONFIG,	/* get configuration */
	NGM_ONE2MANY_GET_STATS,		/* get link stats */
	NGM_ONE2MANY_CLR_STATS,		/* clear link stats */
	NGM_ONE2MANY_GETCLR_STATS,	/* atomically get & clear link stats */
};

#endif /* _NETGRAPH_NG_ONE2MANY_H_ */
Commit	Line	Data
b06ebda0 MD	1	/*
	2	* ng_one2many.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_one2many.h,v 1.8 2005/01/07 01:45:39 imp Exp $
5a975a3d	41	* $DragonFly: src/sys/netgraph7/ng_one2many.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
b06ebda0 MD	42	*/
	43
	44	#ifndef _NETGRAPH_NG_ONE2MANY_H_
	45	#define _NETGRAPH_NG_ONE2MANY_H_
	46
	47	/* Node type name and magic cookie */
	48	#define NG_ONE2MANY_NODE_TYPE "one2many"
	49	#define NGM_ONE2MANY_COOKIE 1100897444
	50
	51	/* Hook names */
	52	#define NG_ONE2MANY_HOOK_ONE "one"
	53	#define NG_ONE2MANY_HOOK_MANY_PREFIX "many" /* append decimal integer */
	54	#define NG_ONE2MANY_HOOK_MANY_FMT "many%d" /* for use with printf(3) */
	55
	56	/* Maximum number of supported "many" links */
	57	#define NG_ONE2MANY_MAX_LINKS 64
	58
	59	/* Link number used to indicate the "one" hook */
	60	#define NG_ONE2MANY_ONE_LINKNUM (-1)
	61
	62	/* Algorithms for outgoing packet distribution (XXX only one so far) */
	63	#define NG_ONE2MANY_XMIT_ROUNDROBIN 1 /* round-robin delivery */
	64	#define NG_ONE2MANY_XMIT_ALL 2 /* send packets to all many hooks */
	65
	66	/* Algorithms for detecting link failure (XXX only one so far) */
	67	#define NG_ONE2MANY_FAIL_MANUAL 1 /* use enabledLinks[] array */
	68	#define NG_ONE2MANY_FAIL_NOTIFY 2 /* listen to flow control msgs */
	69
	70	/* Node configuration structure */
	71	struct ng_one2many_config {
	72	u_int32_t xmitAlg; /* how to distribute packets */
	73	u_int32_t failAlg; /* how to detect link failure */
	74	u_char enabledLinks[NG_ONE2MANY_MAX_LINKS];
	75	};
	76
	77	/* Keep this in sync with the above structure definition */
	78	#define NG_ONE2MANY_CONFIG_TYPE_INFO(atype) { \
	79	{ "xmitAlg", &ng_parse_uint32_type }, \
	80	{ "failAlg", &ng_parse_uint32_type }, \
	81	{ "enabledLinks", (atype) }, \
	82	{ NULL } \
	83	}
	84
	85	/* Statistics structure (one for each link) */
	86	struct ng_one2many_link_stats {
	87	u_int64_t recvOctets; /* total octets rec'd on link */
	88	u_int64_t recvPackets; /* total pkts rec'd on link */
	89	u_int64_t xmitOctets; /* total octets xmit'd on link */
	90	u_int64_t xmitPackets; /* total pkts xmit'd on link */
	91	u_int64_t memoryFailures; /* times couldn't get mem or mbuf */
	92	};
	93
	94	/* Keep this in sync with the above structure definition */
	95	#define NG_ONE2MANY_LINK_STATS_TYPE_INFO { \
	96	{ "recvOctets", &ng_parse_uint64_type }, \
	97	{ "recvPackets", &ng_parse_uint64_type }, \
	98	{ "xmitOctets", &ng_parse_uint64_type }, \
	99	{ "xmitPackets", &ng_parse_uint64_type }, \
	100	{ "memoryFailures", &ng_parse_uint64_type }, \
	101	{ NULL } \
	102	}
	103
	104	/* Netgraph control messages */
	105	enum {
106	NGM_ONE2MANY_SET_CONFIG, /* set configuration */
107	NGM_ONE2MANY_GET_CONFIG, /* get configuration */
108	NGM_ONE2MANY_GET_STATS, /* get link stats */
109	NGM_ONE2MANY_CLR_STATS, /* clear link stats */
110	NGM_ONE2MANY_GETCLR_STATS, /* atomically get & clear link stats */
111	};
112
113	#endif /* _NETGRAPH_NG_ONE2MANY_H_ */
114