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$ 41 */ 42 43#ifndef _NETGRAPH_NG_ONE2MANY_H_ 44#define _NETGRAPH_NG_ONE2MANY_H_ 45 46/* Node type name and magic cookie */ 47#define NG_ONE2MANY_NODE_TYPE "one2many" 48#define NGM_ONE2MANY_COOKIE 1100897444 49 50/* Hook names */ 51#define NG_ONE2MANY_HOOK_ONE "one" 52#define NG_ONE2MANY_HOOK_MANY_PREFIX "many" /* append decimal integer */ 53#define NG_ONE2MANY_HOOK_MANY_FMT "many%d" /* for use with printf(3) */ 54 55/* Maximum number of supported "many" links */ 56#define NG_ONE2MANY_MAX_LINKS 64 57 58/* Link number used to indicate the "one" hook */ 59#define NG_ONE2MANY_ONE_LINKNUM (-1) 60 61/* Algorithms for outgoing packet distribution (XXX only one so far) */ 62#define NG_ONE2MANY_XMIT_ROUNDROBIN 1 /* round-robin delivery */ 63#define NG_ONE2MANY_XMIT_ALL 2 /* send packets to all many hooks */ 64#define NG_ONE2MANY_XMIT_FAILOVER 3 /* send packets to first active "many" */ 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 */ 71struct 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) */ 86struct 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 */ 105enum { 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