share/man/man4/ng_one2many.4

   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 .\"
  37 .Dd November 15, 2000
  38 .Dt NG_ONE2MANY 4
  39 .Os
  40 .Sh NAME
  41 .Nm ng_one2many
  42 .Nd packet multiplexing netgraph node type
  43 .Sh SYNOPSIS
  44 .In netgraph/one2many/ng_one2many.h
  45 .Sh DESCRIPTION
  46 The
  47 .Nm one2many
  48 provides a simple mechanism for routing packets over several links
  49 in a one-to-many (and in the reverse direction, many-to-one) fashion.
  50 There is a single hook named
  51 .Dv one ,
  52 and multiple hooks named
  53 .Dv many0 ,
  54 .Dv many1 ,
  55 etc.
  56 Packets received on any of the
  57 .Dv many
  58 hooks are forwarded out the
  59 .Dv one
  60 hook.
  61 Packets received on the
  62 .Dv one
  63 hook are forwarded out one of the
  64 .Dv many
  65 hooks; which hook is determined by the node's configured
  66 transmit algorithm.
  67 Packets are not altered in any way.
  68 .Pp
  69 Each of the connected many links may be considered to be up or down.
  70 Packets are never delivered out a many hook that is down.
  71 How a link is determined to be up or down depends on the node's
  72 configured link failure detection algorithm.
  73 .Sh TRANSMIT ALGORITHMS
  74 At this time, the only algorithm for determining the outgoing
  75 .Dv many
  76 hook is a simple round-robin delivery algorithm.
  77 Packets are delivered out the many hooks in sequential order.
  78 .Pp
  79 In the future other algorithms may be added as well.
  80 .Sh LINK FAILURE DETECTION
  81 At this time, the only algorithm for determining when a link
  82 has failed, other than the hook being disconnected, is the
  83 ``manual'' algorithm: the node is explicitly told which of
  84 the links are up via the
  85 .Dv NGM_ONE2MANY_SET_CONFIG
  86 control message (see below).
  87 Newly connected links are down until configured otherwise.
  88 .Pp
  89 In the future other algorithms may be added as well.
  90 .Sh HOOKS
  91 This node type supports up to
  92 .Dv NG_ONE2MANY_MAX_LINKS
  93 hooks named
  94 .Dv many0 ,
  95 .Dv many1 ,
  96 etc.,
  97 plus a single hook named
  98 .Dv one .
  99 .Sh CONTROL MESSAGES
 100 This node type supports the generic control messages, plus the
 101 following:
 102 .Bl -tag -width foo
 103 .It Dv NGM_ONE2MANY_SET_CONFIG
 104 Sets the node configuration using a
 105 .Dv "struct ng_one2many_link_config"
 106 as the control message argument:
 107 .Bd -literal -offset 0n
 108 /* Node configuration structure */
 109 struct ng_one2many_config {
 110   u_int32_t   xmitAlg;        /* how to distribute packets */
 111   u_int32_t   failAlg;        /* how to detect link failure */
 112   u_char      enabledLinks[NG_ONE2MANY_MAX_LINKS];
 113 };
 114 .Ed
 115 .Pp
 116 Currently, the only valid setting for the
 117 .Dv xmitAlg
 118 field is
 119 .Dv NG_ONE2MANY_XMIT_ROUNDROBIN ;
 120 this is also the default setting.
 121 The only valid setting for
 122 .Dv failAlg
 123 is
 124 .Dv NG_ONE2MANY_FAIL_MANUAL ;
 125 this is also the default setting.
 126 .It Dv NGM_ONE2MANY_GET_CONFIG
 127 Returns the current node configuration in a
 128 .Dv "struct ng_one2many_link_config" .
 129 .It Dv NGM_ONE2MANY_GET_STATS
 130 This command takes a 32 bit link number as an argument and
 131 returns a
 132 .Dv "struct ng_one2many_link_stats"
 133 containing statistics for the corresponding
 134 .Dv many
 135 link, which may or may not be currently connected:
 136 .Bd -literal -offset 0n
 137 /* Statistics structure (one for each link) */
 138 struct ng_one2many_link_stats {
 139   u_int64_t   recvOctets;     /* total octets rec'd on link */
 140   u_int64_t   recvPackets;    /* total pkts rec'd on link */
 141   u_int64_t   xmitOctets;     /* total octets xmit'd on link */
 142   u_int64_t   xmitPackets;    /* total pkts xmit'd on link */
 143 };
 144 .Ed
 145 .Pp
 146 To access statistics for the
 147 .Dv one
 148 link, use the link number
 149 .Dv -1 .
 150 .It Dv NGM_ONE2MANY_CLR_STATS
 151 This command takes a 32 bit link number as an argument and
 152 clears the statistics for that link.
 153 .It Dv NGM_ONE2MANY_GETCLR_STATS
 154 Same as
 155 .Dv NGM_ONE2MANY_GET_STATS ,
 156 but also atomically clears the statistics for the link as well.
 157 .El
 158 .Sh SHUTDOWN
 159 This node shuts down upon receipt of a
 160 .Dv NGM_SHUTDOWN
 161 control message, or when all hooks have been disconnected.
 162 .Sh EXAMPLES
 163 The following commands will set up Ethernet interfaces
 164 .Dv fxp0
 165 to deliver packets alternating over the physical interfaces
 166 corresponding to networking interfaces
 167 .Dv fxp0
 168 through
 169 .Dv fxp3 :
 170 .Bd -literal -offset 0n
 171   # Plumb nodes together
 172   ngctl mkpeer fxp0: one2many upper one
 173   ngctl connect fxp0: fxp0:upper lower many0
 174   ngctl connect fxp1: fxp0:upper lower many1
 175   ngctl connect fxp2: fxp0:upper lower many2
 176   ngctl connect fxp3: fxp0:upper lower many3
 177   # Allow fxp1 through fxp3 to xmit/recv fxp0 frames
 178   ngctl msg fxp1: setpromisc 1
 179   ngctl msg fxp2: setpromisc 1
 180   ngctl msg fxp3: setpromisc 1
 181   ngctl msg fxp1: setautosrc 0
 182   ngctl msg fxp2: setautosrc 0
 183   ngctl msg fxp3: setautosrc 0
 184   # Configure all four links as up
 185   ngctl msg fxp0:upper \\
 186     setconfig "{ xmitAlg=1 failAlg=1 enabledLinks=[ 1 1 1 1 ] }"
 187   # Bring up interface
 188   ifconfig fxp0 192.168.1.1 netmask 0xfffffffc
 189 .Ed
 190 .Pp
 191 With a similar setup on a peer machine (using the address
 192 192.168.1.2), a point-to-point
 193 Ethernet connection with four times normal bandwidth is
 194 achieved.
 195 .Sh SEE ALSO
 196 .Xr netgraph 4 ,
 197 .Xr ng_bridge 4 ,
 198 .Xr ng_ether 4 ,
 199 .Xr ngctl 8
 200 .Sh HISTORY
 201 The
 202 .Nm
 203 node type was implemented in
 204 .Fx 4.2 .
 205 .Sh AUTHORS
 206 .An Archie Cobbs Aq Mt archie@FreeBSD.org
 207 .Sh BUGS
 208 More transmit and link failure algorithms should be supported.
 209 A good candidate is Cisco's Etherchannel.