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