share/man/man4/ng_iface.4

   1 .\" Copyright (c) 1996-1999 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$
  36 .\" $Whistle: ng_iface.8,v 1.5 1999/01/25 23:46:26 archie Exp $
  37 .\"
  38 .Dd October 28, 2005
  39 .Dt NG_IFACE 4
  40 .Os
  41 .Sh NAME
  42 .Nm ng_iface
  43 .Nd interface netgraph node type
  44 .Sh SYNOPSIS
  45 .In netgraph/ng_iface.h
  46 .Sh DESCRIPTION
  47 An
  48 .Nm iface
  49 node is both a netgraph node and a system networking interface.
  50 When an
  51 .Nm iface
  52 node is created, a new interface appears which is accessible via
  53 .Xr ifconfig 8 .
  54 .Nm Iface
  55 node interfaces are named
  56 .Dv ng0 ,
  57 .Dv ng1 ,
  58 etc.
  59 When a node is shutdown, the corresponding interface is removed
  60 and the interface name becomes available for reuse by future
  61 .Nm iface
  62 nodes; new nodes always take the first unused interface.
  63 The node itself is assigned the same name as its interface, unless the name
  64 already exists, in which case the node remains unnamed.
  65 .Pp
  66 An
  67 .Nm iface
  68 node has a single hook corresponding to each supported protocol.
  69 Packets transmitted via the interface flow out the corresponding
  70 protocol-specific hook.
  71 Similarly, packets received on a hook appear on the interface as
  72 packets received into the corresponding protocol stack.
  73 The currently supported protocols are IP, IPv6, AppleTalk, IPX, ATM,
  74 NATM, and NS.
  75 .Pp
  76 An
  77 .Nm iface
  78 node can be configured as a point-to-point interface or a broadcast interface.
  79 The configuration can only be changed when the interface is down.
  80 The default mode is point-to-point.
  81 .Pp
  82 .Nm Iface
  83 nodes support the Berkeley Packet Filter (BPF).
  84 .Sh HOOKS
  85 This node type supports the following hooks:
  86 .Bl -tag -width foobar
  87 .It Dv inet
  88 Transmission and reception of IP packets.
  89 .It Dv inet6
  90 Transmission and reception of IPv6 packets.
  91 .It Dv atalk
  92 Transmission and reception of AppleTalk packets.
  93 .It Dv ipx
  94 Transmission and reception of IPX packets.
  95 .It Dv atm
  96 Transmission and reception of ATM packets.
  97 .It Dv natm
  98 Transmission and reception of NATM packets.
  99 .It Dv ns
 100 Transmission and reception of NS packets.
 101 .El
 102 .Sh CONTROL MESSAGES
 103 This node type supports the generic control messages, plus the following:
 104 .Bl -tag -width foo
 105 .It Dv NGM_IFACE_GET_IFNAME
 106 Returns the name of the associated interface as a
 107 .Dv NUL Ns -terminated
 108 .Tn ASCII
 109 string.
 110 Normally this is the same as the name of the node.
 111 .It Dv NGM_IFACE_GET_IFINDEX
 112 Returns the global index of the associated interface as a 32 bit integer.
 113 .It Dv NGM_IFACE_POINT2POINT
 114 Set the interface to point-to-point mode.
 115 The interface must not currently be up.
 116 .It Dv NGM_IFACE_BROADCAST
 117 Set the interface to broadcast mode.
 118 The interface must not currently be up.
 119 .It Dv NGM_CISCO_GET_IPADDR
 120 This message is defined by the
 121 .Xr ng_cisco 4
 122 node type; see
 123 .Xr ng_cisco 4
 124 for a description.
 125 .El
 126 .Sh SHUTDOWN
 127 This node shuts down upon receipt of a
 128 .Dv NGM_SHUTDOWN
 129 control message.
 130 The associated interface is removed and becomes available
 131 for use by future
 132 .Nm iface
 133 nodes.
 134 .Pp
 135 Unlike most other node types, an
 136 .Nm iface
 137 node does
 138 .Em not
 139 go away when all hooks have been disconnected; rather, and explicit
 140 .Dv NGM_SHUTDOWN
 141 control message is required.
 142 .Sh ALTQ Support
 143 The
 144 .Nm
 145 interface supports ALTQ bandwidth management feature.
 146 However,
 147 .Nm
 148 is a special case, since it is not a physical interface with limited bandwidth.
 149 One should not turn ALTQ on
 150 .Nm
 151 if the latter corresponds to some tunneled connection, e.g.\& PPPoE or PPTP.
 152 In this case, ALTQ should be configured on the interface that is used to
 153 transmit the encapsulated packets.
 154 In case when your graph ends up with some kind of serial line, either
 155 synchronous or modem, the
 156 .Nm
 157 is the right place to turn ALTQ on.
 158 .Sh SEE ALSO
 159 .Xr altq 4 ,
 160 .Xr bpf 4 ,
 161 .Xr netgraph 4 ,
 162 .Xr ng_cisco 4 ,
 163 .Xr ifconfig 8 ,
 164 .Xr ngctl 8
 165 .Sh HISTORY
 166 The
 167 .Nm iface
 168 node type was implemented in
 169 .Fx 4.0 .
 170 .Sh AUTHORS
 171 .An Archie Cobbs Aq archie@FreeBSD.org