share/man/man4/ng_eiface.4

   1 .\" Copyright (c) 2004 Gleb Smirnoff
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man4/ng_eiface.4,v 1.3.2.1 2005/02/03 13:49:18 ru Exp $
  26 .\" $DragonFly: src/share/man/man4/ng_eiface.4,v 1.1 2007/06/17 20:33:14 swildner Exp $
  27 .\"
  28 .Dd February 3, 2005
  29 .Dt NG_EIFACE 4
  30 .Os
  31 .Sh NAME
  32 .Nm ng_eiface
  33 .Nd "generic Ethernet interface netgraph node type"
  34 .Sh SYNOPSIS
  35 .In netgraph/ng_eiface.h
  36 .Sh DESCRIPTION
  37 The
  38 .Vt eiface
  39 netgraph node implements the generic Ethernet interface.
  40 When
  41 .Vt eiface
  42 node is created, a new interface appears which is accessible via
  43 .Xr ifconfig 8 .
  44 These interfaces are named
  45 .Dq Li ngeth0 ,
  46 .Dq Li ngeth1 ,
  47 etc.
  48 When a node is shut down, the corresponding interface is removed,
  49 and the interface name becomes available for reuse by future
  50 .Vt eiface
  51 nodes.
  52 New nodes always take the first unused interface.
  53 .Sh HOOKS
  54 An
  55 .Vt eiface
  56 node has a single hook named
  57 .Va ether ,
  58 which should be connected to the
  59 Ethernet downstream, for example, to the
  60 .Xr ng_vlan 4
  61 node.
  62 Packets transmitted via the interface flow out this hook.
  63 Similarly, packets received on the hook go to the protocol stack as
  64 packets received by any real Ethernet interface.
  65 .Sh CONTROL MESSAGES
  66 This node type supports the generic control messages, plus the following:
  67 .Bl -tag -width indent
  68 .It Dv NGM_EIFACE_SET Pq Li set
  69 Set link-level address of the interface.
  70 Requires
  71 .Vt "struct ether_addr"
  72 as an argument.
  73 This message also has an
  74 .Tn ASCII
  75 version, called
  76 .Dq Li set ,
  77 which requires as an argument an
  78 .Tn ASCII
  79 string consisting of 6 colon-separated hex digits.
  80 .It Dv NGM_EIFACE_GET_IFNAME Pq Li getifname
  81 Return the name of the associated interface as a
  82 .Dv NUL Ns -terminated
  83 .Tn ASCII
  84 string.
  85 .It Dv NGM_EIFACE_GET_IFADDRS
  86 Return the list of link-level addresses associated with the node.
  87 .El
  88 .Sh SHUTDOWN
  89 This node shuts down upon receipt of a
  90 .Dv NGM_SHUTDOWN
  91 control message.
  92 The associated interface is removed and its name becomes
  93 available for reuse by future
  94 .Vt eiface
  95 nodes.
  96 .Pp
  97 Unlike most other node types, an
  98 .Vt eiface
  99 node does
 100 .Em not
 101 go away when all hooks have been disconnected; rather, and explicit
 102 .Dv NGM_SHUTDOWN
 103 control message is required.
 104 .Sh SEE ALSO
 105 .Xr netgraph 4 ,
 106 .Xr ng_ether 4 ,
 107 .Xr ng_iface 4 ,
 108 .Xr ng_vlan 4 ,
 109 .Xr ifconfig 8 ,
 110 .Xr ngctl 8
 111 .Sh HISTORY
 112 The
 113 .Vt eiface
 114 node type was implemented in
 115 .Fx 4.6 .
 116 .Sh AUTHORS
 117 .An -nosplit
 118 The
 119 .Vt eiface
 120 node type was written by
 121 .An Vitaly V Belekhov .
 122 This manual page was written by
 123 .An Gleb Smirnoff .