1.\" Copyright (c) 2000 Whistle Communications, Inc. 2.\" All rights reserved. 3.\" 4.\" Subject to the following obligations and disclaimer of warranty, use and 5.\" redistribution of this software, in source or object code forms, with or 6.\" without modifications are expressly permitted by Whistle Communications; 7.\" provided, however, that: 8.\" 1. Any and all reproductions of the source or object code must include the 9.\" copyright notice above and the following disclaimer of warranties; and 10.\" 2. No rights are granted, in any manner or form, to use Whistle 11.\" Communications, Inc. trademarks, including the mark "WHISTLE 12.\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as 13.\" such appears in the above copyright notice or in the software. 14.\" 15.\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 16.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 17.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 18.\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 19.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 20.\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 21.\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 22.\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 23.\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 24.\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 25.\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 26.\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 27.\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 28.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30.\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 31.\" OF SUCH DAMAGE. 32.\" 33.\" Author: Archie Cobbs <archie@FreeBSD.org> 34.\" 35.\" $FreeBSD: src/share/man/man4/ng_one2many.4,v 1.1.2.9 2003/01/06 23:32:22 trhodes Exp $ 36.\" $DragonFly: src/share/man/man4/ng_one2many.4,v 1.2 2003/06/17 04:36:59 dillon Exp $ 37.\" 38.Dd November 15, 2000 39.Dt NG_ONE2MANY 4 40.Os 41.Sh NAME 42.Nm ng_one2many 43.Nd packet multiplexing netgraph node type 44.Sh SYNOPSIS 45.In netgraph/ng_one2many.h 46.Sh DESCRIPTION 47The 48.Nm one2many 49provides a simple mechanism for routing packets over several links 50in a one-to-many (and in the reverse direction, many-to-one) fashion. 51There is a single hook named 52.Dv one , 53and multiple hooks named 54.Dv many0 , 55.Dv many1 , 56etc. 57Packets received on any of the 58.Dv many 59hooks are forwarded out the 60.Dv one 61hook. 62Packets received on the 63.Dv one 64hook are forwarded out one of the 65.Dv many 66hooks; which hook is determined by the node's configured 67transmit algorithm. 68Packets are not altered in any way. 69.Pp 70Each of the connected many links may be considered to be up or down. 71Packets are never delivered out a many hook that is down. 72How a link is determined to be up or down depends on the node's 73configured link failure detection algorithm. 74.Sh TRANSMIT ALGORITHMS 75At this time, the only algorithm for determing the outgoing 76.Dv many 77hook is a simple round-robin delivery algorithm. 78Packets are delivered out the many hooks in sequential order. 79.Pp 80In the future other algorithms may be added as well. 81.Sh LINK FAILURE DETECTION 82At this time, the only algorithm for determining when a link 83has failed, other than the hook being disconnected, is the 84``manual'' algorithm: the node is explicitly told which of 85the links are up via the 86.Dv NGM_ONE2MANY_SET_CONFIG 87control message (see below). 88Newly connected links are down until configured otherwise. 89.Pp 90In the future other algorithms may be added as well. 91.Sh HOOKS 92This node type supports up to 93.Dv NG_ONE2MANY_MAX_LINKS 94hooks named 95.Dv many0 , 96.Dv many1 , 97etc., 98plus a single hook named 99.Dv one . 100.Sh CONTROL MESSAGES 101This node type supports the generic control messages, plus the 102following: 103.Bl -tag -width foo 104.It Dv NGM_ONE2MANY_SET_CONFIG 105Sets the node configuration using a 106.Dv "struct ng_one2many_link_config" 107as the control message argument: 108.Bd -literal -offset 0n 109/* Node configuration structure */ 110struct ng_one2many_config { 111 u_int32_t xmitAlg; /* how to distribute packets */ 112 u_int32_t failAlg; /* how to detect link failure */ 113 u_char enabledLinks[NG_ONE2MANY_MAX_LINKS]; 114}; 115.Ed 116.Pp 117Currently, the only valid setting for the 118.Dv xmitAlg 119field is 120.Dv NG_ONE2MANY_XMIT_ROUNDROBIN ; 121this is also the default setting. 122The only valid setting for 123.Dv failAlg 124is 125.Dv NG_ONE2MANY_FAIL_MANUAL ; 126this is also the default setting. 127.It Dv NGM_ONE2MANY_GET_CONFIG 128Returns the current node configuration in a 129.Dv "struct ng_one2many_link_config" . 130.It Dv NGM_ONE2MANY_GET_STATS 131This command takes a 32 bit link number as an argument and 132returns a 133.Dv "struct ng_one2many_link_stats" 134containing statistics for the corresponding 135.Dv many 136link, which may or may not be currently connected: 137.Bd -literal -offset 0n 138/* Statistics structure (one for each link) */ 139struct ng_one2many_link_stats { 140 u_int64_t recvOctets; /* total octets rec'd on link */ 141 u_int64_t recvPackets; /* total pkts rec'd on link */ 142 u_int64_t xmitOctets; /* total octets xmit'd on link */ 143 u_int64_t xmitPackets; /* total pkts xmit'd on link */ 144}; 145.Ed 146.Pp 147To access statistics for the 148.Dv one 149link, use the link number 150.Dv -1 . 151.It Dv NGM_ONE2MANY_CLR_STATS 152This command takes a 32 bit link number as an argument and 153clears the statistics for that link. 154.It Dv NGM_ONE2MANY_GETCLR_STATS 155Same as 156.Dv NGM_ONE2MANY_GET_STATS , 157but also atomically clears the statistics for the link as well. 158.El 159.Sh SHUTDOWN 160This node shuts down upon receipt of a 161.Dv NGM_SHUTDOWN 162control message, or when all hooks have been disconnected. 163.Sh EXAMPLES 164The following commands will set up Ethernet interfaces 165.Dv fxp0 166to deliver packets alternating over the physical interfaces 167corresponding to networking interfaces 168.Dv fxp0 169through 170.Dv fxp3 : 171.Bd -literal -offset 0n 172 # Plumb nodes together 173 ngctl mkpeer fxp0: one2many upper one 174 ngctl connect fxp0: fxp0:upper lower many0 175 ngctl connect fxp1: fxp0:upper lower many1 176 ngctl connect fxp2: fxp0:upper lower many2 177 ngctl connect fxp3: fxp0:upper lower many3 178 # Allow fxp1 through fxp3 to xmit/recv fxp0 frames 179 ngctl msg fxp1: setpromisc 1 180 ngctl msg fxp2: setpromisc 1 181 ngctl msg fxp3: setpromisc 1 182 ngctl msg fxp1: setautosrc 0 183 ngctl msg fxp2: setautosrc 0 184 ngctl msg fxp3: setautosrc 0 185 # Configure all four links as up 186 ngctl msg fxp0:upper \\ 187 setconfig "{ xmitAlg=1 failAlg=1 enabledLinks=[ 1 1 1 1 ] }" 188 # Bring up interface 189 ifconfig fxp0 192.168.1.1 netmask 0xfffffffc 190.Ed 191.Pp 192With a similar setup on a peer machine (using the address 193192.168.1.2), a point-to-point 194Ethernet connection with four times normal bandwidth is 195achieved. 196.Sh BUGS 197More transmit and link failure algorithms should be supported. 198A good candidate is Cisco's Etherchannel. 199.Sh SEE ALSO 200.Xr netgraph 4 , 201.Xr ng_bridge 4 , 202.Xr ng_ether 4 , 203.Xr ngctl 8 204.Sh HISTORY 205The 206.Nm 207node type was implemented in 208.Fx 4.2 . 209.Sh AUTHORS 210.An Archie Cobbs Aq archie@FreeBSD.org 211