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: src/share/man/man4/ng_iface.4,v 1.13.2.1 2001/12/21 09:00:51 ru Exp $ 36.\" $Whistle: ng_iface.8,v 1.5 1999/01/25 23:46:26 archie Exp $ 37.\" 38.Dd January 19, 1999 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/iface/ng_iface.h 46.Sh DESCRIPTION 47An 48.Nm iface 49node is both a netgraph node and a system networking interface. When an 50.Nm iface 51node is created, a new interface appears which is accessible via 52.Xr ifconfig 8 . 53.Nm Iface 54node interfaces are named 55.Dv ng0 , 56.Dv ng1 , 57etc. 58When a node is shutdown, the corresponding interface is removed 59and the interface name becomes available for reuse by future 60.Nm iface 61nodes; new nodes always take the first unused interface. 62The node itself is assigned the same name as its interface, unless the name 63already exists, in which case the node remains unnamed. 64.Pp 65An 66.Nm iface 67node has a single hook corresponding to each supported protocol. 68Packets transmitted via the interface flow out the corresponding 69protocol-specific hook. 70Similarly, packets received on a hook appear on the interface as 71packets received into the corresponding protocol stack. 72The currently supported protocols are IP, IPv6, AppleTalk, IPX, ATM, 73NATM, and NS. 74.Pp 75An 76.Nm iface 77node be configured as a point-to-point interface or a broadcast interface. 78The configuration can only be changed when the interface is down. 79The default mode is point-to-point. 80.Pp 81.Nm Iface 82nodes support the Berkeley Packet Filter (BPF). 83.Sh HOOKS 84This node type supports the following hooks: 85.Bl -tag -width foobar 86.It Dv inet 87Transmission and reception of IP packets. 88.It Dv inet6 89Transmission and reception of IPv6 packets. 90.It Dv atalk 91Transmission and reception of AppleTalk packets. 92.It Dv ipx 93Transmission and reception of IPX packets. 94.It Dv atm 95Transmission and reception of ATM packets. 96.It Dv natm 97Transmission and reception of NATM packets. 98.It Dv ns 99Transmission and reception of NS packets. 100.El 101.Sh CONTROL MESSAGES 102This node type supports the generic control messages, plus the following: 103.Bl -tag -width foo 104.It Dv NGM_IFACE_GET_IFNAME 105Returns the name of the interface corresponding to this node in a 106.Dv "struct ng_iface_ifname" : 107.Bd -literal -offset 4n 108struct ng_iface_ifname { 109 char ngif_name[NG_IFACE_IFACE_NAME_MAX + 1]; 110}; 111.Ed 112.It Dv NGM_IFACE_POINT2POINT 113Set the interface to point-to-point mode. 114The interface must not currently be up. 115.It Dv NGM_IFACE_BROADCAST 116Set the interface to broadcast mode. 117The interface must not currently be up. 118.It Dv NGM_CISCO_GET_IPADDR 119This message is defined by the 120.Xr ng_cisco 4 121node type; see 122.Xr ng_cisco 4 123for a description. 124.El 125.Sh SHUTDOWN 126This node shuts down upon receipt of a 127.Dv NGM_SHUTDOWN 128control message. The associated interface is removed and becomes available 129for use by future 130.Nm iface 131nodes. 132.Pp 133Unlike most other node types, an 134.Nm iface 135node does 136.Em not 137go away when all hooks have been disconnected; rather, and explicit 138.Dv NGM_SHUTDOWN 139control message is required. 140.Sh SEE ALSO 141.Xr bpf 4 , 142.Xr netgraph 4 , 143.Xr ng_cisco 4 , 144.Xr ifconfig 8 , 145.Xr ngctl 8 146.Sh HISTORY 147The 148.Nm iface 149node type was implemented in 150.Fx 4.0 . 151.Sh AUTHORS 152.An Archie Cobbs Aq Mt archie@FreeBSD.org 153