[Midnightbsd-cvs] src [11734] trunk/share/man/man4: update more
laffer1 at midnightbsd.org
laffer1 at midnightbsd.org
Mon Jul 9 19:26:57 EDT 2018
Revision: 11734
http://svnweb.midnightbsd.org/src/?rev=11734
Author: laffer1
Date: 2018-07-09 19:26:56 -0400 (Mon, 09 Jul 2018)
Log Message:
-----------
update more
Modified Paths:
--------------
trunk/share/man/man4/da.4
trunk/share/man/man4/dc.4
trunk/share/man/man4/dcons.4
trunk/share/man/man4/dcons_crom.4
trunk/share/man/man4/ddb.4
trunk/share/man/man4/de.4
trunk/share/man/man4/devctl.4
trunk/share/man/man4/digi.4
trunk/share/man/man4/disc.4
trunk/share/man/man4/divert.4
trunk/share/man/man4/dpms.4
trunk/share/man/man4/dpt.4
trunk/share/man/man4/dummynet.4
trunk/share/man/man4/ed.4
trunk/share/man/man4/edsc.4
trunk/share/man/man4/ef.4
trunk/share/man/man4/ehci.4
trunk/share/man/man4/em.4
trunk/share/man/man4/en.4
trunk/share/man/man4/enc.4
trunk/share/man/man4/epair.4
trunk/share/man/man4/esp.4
trunk/share/man/man4/est.4
trunk/share/man/man4/et.4
trunk/share/man/man4/eventtimers.4
trunk/share/man/man4/exca.4
trunk/share/man/man4/faith.4
trunk/share/man/man4/fatm.4
trunk/share/man/man4/fd.4
trunk/share/man/man4/fdc.4
trunk/share/man/man4/fdt.4
trunk/share/man/man4/fdtbus.4
trunk/share/man/man4/filemon.4
trunk/share/man/man4/firewire.4
trunk/share/man/man4/fla.4
trunk/share/man/man4/fpa.4
trunk/share/man/man4/full.4
trunk/share/man/man4/fwe.4
trunk/share/man/man4/fwip.4
trunk/share/man/man4/fwohci.4
trunk/share/man/man4/fxp.4
trunk/share/man/man4/kbdmux.4
trunk/share/man/man4/keyboard.4
trunk/share/man/man4/kld.4
trunk/share/man/man4/ksyms.4
trunk/share/man/man4/ktr.4
trunk/share/man/man4/kue.4
trunk/share/man/man4/natm.4
trunk/share/man/man4/natmip.4
trunk/share/man/man4/ncr.4
trunk/share/man/man4/ncv.4
trunk/share/man/man4/ndis.4
trunk/share/man/man4/net80211.4
trunk/share/man/man4/netgraph.4
trunk/share/man/man4/netintro.4
trunk/share/man/man4/netmap.4
trunk/share/man/man4/nfe.4
trunk/share/man/man4/nfsmb.4
trunk/share/man/man4/ng_UI.4
trunk/share/man/man4/ng_async.4
trunk/share/man/man4/ng_atm.4
trunk/share/man/man4/ng_atmllc.4
trunk/share/man/man4/ng_atmpif.4
trunk/share/man/man4/ng_bluetooth.4
trunk/share/man/man4/ng_bpf.4
trunk/share/man/man4/ng_bridge.4
trunk/share/man/man4/ng_bt3c.4
trunk/share/man/man4/ng_btsocket.4
trunk/share/man/man4/ng_car.4
trunk/share/man/man4/ng_ccatm.4
trunk/share/man/man4/ng_cisco.4
trunk/share/man/man4/ng_deflate.4
trunk/share/man/man4/ng_device.4
trunk/share/man/man4/ng_echo.4
trunk/share/man/man4/ng_eiface.4
trunk/share/man/man4/ng_etf.4
trunk/share/man/man4/ng_ether.4
trunk/share/man/man4/ng_ether_echo.4
trunk/share/man/man4/ng_fec.4
trunk/share/man/man4/ng_frame_relay.4
trunk/share/man/man4/ng_gif.4
trunk/share/man/man4/ng_gif_demux.4
trunk/share/man/man4/ng_h4.4
trunk/share/man/man4/ng_hci.4
trunk/share/man/man4/ng_hole.4
trunk/share/man/man4/ng_hub.4
trunk/share/man/man4/ng_iface.4
trunk/share/man/man4/ng_ip_input.4
trunk/share/man/man4/ng_ipfw.4
trunk/share/man/man4/ng_ksocket.4
trunk/share/man/man4/ng_l2cap.4
trunk/share/man/man4/ng_l2tp.4
trunk/share/man/man4/ng_lmi.4
trunk/share/man/man4/ng_mppc.4
trunk/share/man/man4/ng_nat.4
trunk/share/man/man4/ng_netflow.4
trunk/share/man/man4/ng_one2many.4
trunk/share/man/man4/ng_patch.4
trunk/share/man/man4/ng_ppp.4
trunk/share/man/man4/ng_pppoe.4
trunk/share/man/man4/ng_pptpgre.4
trunk/share/man/man4/ng_pred1.4
trunk/share/man/man4/ng_rfc1490.4
trunk/share/man/man4/ng_socket.4
trunk/share/man/man4/ng_source.4
trunk/share/man/man4/ng_split.4
trunk/share/man/man4/ng_sppp.4
trunk/share/man/man4/ng_sscfu.4
trunk/share/man/man4/ng_sscop.4
trunk/share/man/man4/ng_tag.4
trunk/share/man/man4/ng_tcpmss.4
trunk/share/man/man4/ng_tee.4
trunk/share/man/man4/ng_tty.4
trunk/share/man/man4/ng_ubt.4
trunk/share/man/man4/ng_uni.4
trunk/share/man/man4/ng_vjc.4
trunk/share/man/man4/ng_vlan.4
trunk/share/man/man4/ngatmbase.4
trunk/share/man/man4/nge.4
trunk/share/man/man4/nmdm.4
trunk/share/man/man4/nsp.4
trunk/share/man/man4/null.4
trunk/share/man/man4/nvd.4
trunk/share/man/man4/nve.4
trunk/share/man/man4/nvme.4
trunk/share/man/man4/nvram.4
trunk/share/man/man4/nvram2env.4
trunk/share/man/man4/nxge.4
trunk/share/man/man4/oce.4
trunk/share/man/man4/ohci.4
trunk/share/man/man4/orm.4
Added Paths:
-----------
trunk/share/man/man4/etherswitch.4
trunk/share/man/man4/ffclock.4
trunk/share/man/man4/nand.4
trunk/share/man/man4/nandsim.4
trunk/share/man/man4/netfpga10g_nf10bmac.4
trunk/share/man/man4/ng_checksum.4
trunk/share/man/man4/ntb.4
trunk/share/man/man4/ntb_hw.4
trunk/share/man/man4/ntb_transport.4
Modified: trunk/share/man/man4/da.4
===================================================================
--- trunk/share/man/man4/da.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/da.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996
.\" Julian Elischer <julian at FreeBSD.org>. All rights reserved.
.\"
@@ -23,9 +24,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/da.4 315129 2017-03-12 04:58:57Z ngie $
.\"
-.Dd February 8, 2012
+.Dd October 11, 2015
.Dt DA 4
.Os
.Sh NAME
@@ -133,8 +134,7 @@
.Xr loader 8
tunables:
.Bl -tag -width 12
-.It kern.cam.da.retry_count
-.Pp
+.It Va kern.cam.da.retry_count
This variable determines how many times the
.Nm
driver will retry a READ or WRITE command.
@@ -143,22 +143,39 @@
.Nm
driver dump routine.
This value currently defaults to 4.
-.It kern.cam.da.default_timeout
-.Pp
+.It Va kern.cam.da.default_timeout
This variable determines how long the
.Nm
driver will wait before timing out an outstanding command.
The units for this value are seconds, and the default is currently 60
seconds.
-.It kern.cam.da.%d.minimum_cmd_size
-.Pp
+.It Va kern.cam.sort_io_queue
+.It Va kern.cam.da. Ns Ar X Ns Va .sort_io_queue
+These variables determine whether request queue should be sorted trying
+to optimize head seeks.
+Set to 1 to enable sorting, 0 to disable, -1 to leave it as-is.
+The default is sorting enabled for HDDs and disabled for SSDs.
+.It Va kern.cam.da. Ns Ar X Ns Va .delete_method
+This variable specifies method to handle BIO_DELETE requests:
+.Bl -tag -width "ATA_TRIM"
+.It ATA_TRIM
+ATA TRIM via ATA COMMAND PASS THROUGH command,
+.It UNMAP
+UNMAP command,
+.It WS16
+WRITE SAME(16) command with UNMAP flag,
+.It WS10
+WRITE SAME(10) command with UNMAP flag,
+.It ZERO
+WRITE SAME(10) command without UNMAP flag,
+.It DISABLE
+disable BIO_DELETE support.
+.El
+.It Va kern.cam.da. Ns Ar X Ns Va .minimum_cmd_size
This variable determines what the minimum READ/WRITE CDB size is for a
given
.Nm
unit.
-(The %d above denotes the unit number of the
-.Nm
-driver instance, e.g.\& 1, 2, 4, 8, etc.)
Valid minimum command size values are 6, 10, 12 and 16 bytes.
The default is 6 bytes.
.Pp
@@ -198,8 +215,7 @@
.Xr ada 4 ,
.Xr cam 4 ,
.Xr geom 4 ,
-.Xr bsdlabel 8 ,
-.Xr fdisk 8
+.Xr gpart 8
.Sh HISTORY
The
.Nm
Modified: trunk/share/man/man4/dc.4
===================================================================
--- trunk/share/man/man4/dc.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/dc.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1997, 1998, 1999
.\" Bill Paul <wpaul at ee.columbia.edu>. All rights reserved.
.\"
@@ -28,7 +29,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/dc.4 226704 2011-10-24 21:01:20Z yongari $
.\"
.Dd October 24, 2011
.Dt DC 4
Modified: trunk/share/man/man4/dcons.4
===================================================================
--- trunk/share/man/man4/dcons.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/dcons.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2003 Hidetoshi Shimokawa
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/dcons.4 235317 2012-05-12 03:25:46Z gjb $
.\"
.Dd January 26, 2008
.Dt DCONS 4
Modified: trunk/share/man/man4/dcons_crom.4
===================================================================
--- trunk/share/man/man4/dcons_crom.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/dcons_crom.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2003 Hidetoshi Shimokawa
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/dcons_crom.4 130650 2004-06-17 19:51:17Z ru $
.\"
.Dd June 16, 2003
.Dt DCONS_CROM 4
Modified: trunk/share/man/man4/ddb.4
===================================================================
--- trunk/share/man/man4/ddb.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ddb.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Mach Operating System
.\" Copyright (c) 1991,1990 Carnegie Mellon University
@@ -58,9 +59,9 @@
.\" Created.
.\" [90/08/30 dbg]
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ddb.4 305853 2016-09-16 00:14:26Z hiren $
.\"
-.Dd December 16, 2011
+.Dd July 13, 2016
.Dt DDB 4
.Os
.Sh NAME
@@ -219,6 +220,8 @@
look at by half words (16 bits)
.It Cm l
look at by long words (32 bits)
+.It Cm g
+look at by quad words (64 bits)
.It Cm a
print the location being displayed
.It Cm A
@@ -545,6 +548,11 @@
addresses for the process and not show other information.
.\"
.Pp
+.It Ic show Cm all trace
+.It Ic alltrace
+.Xc
+Show a stack trace for every thread in the system.
+.Pp
.It Ic show Cm all ttys
Show all TTY's within the system.
Output is similar to
@@ -570,8 +578,8 @@
.Pp
.It Ic show Cm allrman
Show information related with resource management, including
-interrupt request lines, DMA request lines, I/O ports and I/O memory
-addresses.
+interrupt request lines, DMA request lines, I/O ports, I/O memory
+addresses, and Resource IDs.
.\"
.Pp
.It Ic show Cm apic
@@ -582,19 +590,35 @@
Show breakpoints set with the "break" command.
.\"
.Pp
-.It Ic show Cm buffer
-Show buffer structure of
+.It Ic show Cm bio Ar addr
+Show information about the bio structure
+.Vt struct bio
+present at
+.Ar addr .
+See the
+.Pa sys/bio.h
+header file and
+.Xr g_bio 9
+for more details on the exact meaning of the structure fields.
+.\"
+.Pp
+.It Ic show Cm buffer Ar addr
+Show information about the buf structure
.Vt struct buf
-type.
-Such a structure is used within the
-.Fx
-kernel for the I/O subsystem
-implementation.
-For an exact interpretation of the output, please see the
+present at
+.Ar addr .
+See the
.Pa sys/buf.h
-header file.
+header file for more details on the exact meaning of the structure fields.
.\"
.Pp
+.It Ic show Cm callout Ar addr
+Show information about the callout structure
+.Vt struct callout
+present at
+.Ar addr .
+.\"
+.Pp
.It Ic show Cm cbstat
Show brief information about the TTY subsystem.
.\"
@@ -823,6 +847,10 @@
complete object is printed.
.\"
.Pp
+.It Ic show Cm panic
+Print the panic message if set.
+.\"
+.Pp
.It Ic show Cm page
Show statistics on VM pages.
.\"
@@ -1173,9 +1201,15 @@
.Sx SCRIPTING
section for more information on the scripting facility.
.Pp
+.It Ic textdump dump
.It Ic textdump set
.It Ic textdump status
.It Ic textdump unset
+Use the
+.Ic textdump dump
+command to immediately perform a textdump.
+More information may be found in
+.Xr textdump 4 .
The
.Ic textdump set
command may be used to force the next kernel core dump to be a textdump
@@ -1184,8 +1218,6 @@
reports whether a textdump has been scheduled.
.Ic textdump unset
cancels a request to perform a textdump as the next kernel core dump.
-More information may be found in
-.Xr textdump 4 .
.El
.Sh VARIABLES
The debugger accesses registers and variables as
@@ -1305,7 +1337,7 @@
Scripts consist of a series of
.Nm
commands separated with the
-.Ic ;
+.Ql \&;
character.
For example:
.Bd -literal -offset indent
Modified: trunk/share/man/man4/de.4
===================================================================
--- trunk/share/man/man4/de.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/de.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1997 David E. O'Brien
.\"
@@ -23,7 +24,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/de.4 213573 2010-10-08 12:40:16Z uqs $
.\"
.Dd July 16, 2005
.Dt DE 4
Modified: trunk/share/man/man4/devctl.4
===================================================================
--- trunk/share/man/man4/devctl.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/devctl.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2002 M. Warner Losh
.\" All rights reserved.
@@ -22,9 +23,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/devctl.4 263963 2014-03-31 02:53:15Z mjg $
.\"
-.Dd February 11, 2003
+.Dd March 26, 2014
.Dt DEVCTL 4
.Os
.Sh NAME
@@ -73,9 +74,9 @@
the rest of the data.
Listening programs are expected to cope.
.Pp
-The sysctl and boot parameter
-.Va hw.bus.devctl_disable
-is used to disable
+The sysctl
+.Va hw.bus.devctl_queue
+can be used to control queue length. It is set to 0 to disable
.Nm
when no
.Xr devd 8
Modified: trunk/share/man/man4/digi.4
===================================================================
--- trunk/share/man/man4/digi.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/digi.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1990, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
@@ -35,9 +36,9 @@
.\" from: @(#)dca.4 5.2 (Berkeley) 3/27/91
.\" from: com.4,v 1.1 1993/08/06 11:19:07 cgd Exp
.\" from: sio.4,v 1.15 1994/12/06 20:14:30 bde Exp
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/digi.4 320923 2017-07-12 22:16:54Z jhb $
.\"
-.Dd December 7, 2003
+.Dd July 8, 2017
.Dt DIGI 4
.Os
.Sh NAME
@@ -84,6 +85,11 @@
\fBI\fPnitial
\fBPPPPP\fPort number
.Ed
+.Sh DEPRECATION NOTICE
+The
+.Nm
+driver will be removed in
+.Fx 12.0 .
.Sh DESCRIPTION
The
.Nm
Modified: trunk/share/man/man4/disc.4
===================================================================
--- trunk/share/man/man4/disc.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/disc.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" From: @(#)lo.4 8.1 (Berkeley) 6/5/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/disc.4 97588 2002-05-30 12:23:21Z ru $
.\"
.Dd May 25, 2002
.Dt DISC 4
Modified: trunk/share/man/man4/divert.4
===================================================================
--- trunk/share/man/man4/divert.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/divert.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,4 +1,5 @@
.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/divert.4 235450 2012-05-14 16:25:17Z joel $
.\"
.Dd December 17, 2004
.Dt DIVERT 4
@@ -21,7 +22,7 @@
.Ed
.Pp
Alternatively, to load
-.Ns Nm
+the driver
as a module at boot time, add the following lines into the
.Xr loader.conf 5
file:
Modified: trunk/share/man/man4/dpms.4
===================================================================
--- trunk/share/man/man4/dpms.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/dpms.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2008 Yahoo!, Inc.
.\" All rights reserved.
.\" Written by: John Baldwin <jhb at FreeBSD.org>
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/dpms.4 233422 2012-03-24 13:37:57Z joel $
.\"
.Dd August 23, 2008
.Dt DPMS 4
@@ -50,7 +51,6 @@
.Sh SEE ALSO
.Xr acpi_video 4
.Sh BUGS
-.Pp
The VESA BIOS DPMS calls do not provide any way to identify a particular
display or adapter to manipulate.
As a result,
Modified: trunk/share/man/man4/dpt.4
===================================================================
--- trunk/share/man/man4/dpt.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/dpt.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1998 Justin T. Gibbs
.\" All rights reserved.
@@ -21,7 +22,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/dpt.4 159734 2006-06-18 14:37:48Z brueffer $
.\"
.Dd June 18, 2006
.Dt DPT 4
Modified: trunk/share/man/man4/dummynet.4
===================================================================
--- trunk/share/man/man4/dummynet.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/dummynet.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,6 +1,7 @@
-.\"
.\" $MidnightBSD$
.\"
+.\" $FreeBSD: stable/10/share/man/man4/dummynet.4 161650 2006-08-26 21:24:22Z marck $
+.\"
.Dd October 28, 2002
.Dt DUMMYNET 4
.Os
Modified: trunk/share/man/man4/ed.4
===================================================================
--- trunk/share/man/man4/ed.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ed.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1994, David Greenman
.\" All rights reserved.
@@ -28,7 +29,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ed.4 233422 2012-03-24 13:37:57Z joel $
.\"
.Dd February 25, 2012
.Dt ED 4
@@ -139,7 +140,7 @@
.It
Allied Telesis SIU-98-D (flags 0x610000) (PC-98)
.It
-AmbiCom 10BaseT card
+AmbiCom 10BaseT card (8002, 8002T, 8010 and 8610)
.It
Bay Networks NETGEAR FA410TXC Fast Ethernet
.It
@@ -147,12 +148,16 @@
.It
Billionton LM5LT-10B Ethernet/Modem PC Card
.It
+Billionton LNT-10TB, LNT-10TN Ethernet PC Card
+.It
Bromax iPort 10/100 Ethernet PC Card
.It
Bromax iPort 10 Ethernet PC Card
.It
-Buffalo LPC2-CLT, LPC3-CLT, LPC3-CLX, LPC4-TX PC Card
+Buffalo LPC2-CLT, LPC3-CLT, LPC3-CLX, LPC4-TX, LPC-CTX PC Card
.It
+Buffalo LPC-CF-CLT CF Card
+.It
CNet BC40 adapter
.It
Compex Net-A adapter
@@ -410,7 +415,6 @@
The Mitsubishi B8895 PC Card uses a DP83902, but its ASIC part is
undocumented.
Neither the NE2000 nor the WD83x0 drivers work with this card.
-.Pp
.Sh BUGS
The
.Nm
Modified: trunk/share/man/man4/edsc.4
===================================================================
--- trunk/share/man/man4/edsc.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/edsc.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" From: @(#)lo.4 8.1 (Berkeley) 6/5/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/edsc.4 175084 2008-01-04 12:57:34Z gabor $
.\"
.Dd March 25, 2007
.Dt EDSC 4
Modified: trunk/share/man/man4/ef.4
===================================================================
--- trunk/share/man/man4/ef.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ef.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1999, Boris Popov
.\" All rights reserved.
@@ -23,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ef.4 208027 2010-05-13 12:07:55Z uqs $
.\"
.Dd June 20, 1999
.Dt EF 4
Modified: trunk/share/man/man4/ehci.4
===================================================================
--- trunk/share/man/man4/ehci.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ehci.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" $NetBSD: ehci.4,v 1.8 2001/11/21 17:22:56 augustss Exp $
.\"
.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
@@ -27,9 +28,9 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ehci.4 232507 2012-03-04 16:59:45Z eadler $
.\"
-.Dd February 24, 2011
+.Dd March 4, 2012
.Dt EHCI 4
.Os
.Sh NAME
Modified: trunk/share/man/man4/em.4
===================================================================
--- trunk/share/man/man4/em.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/em.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2003, Intel Corporation
.\" All rights reserved.
.\"
Modified: trunk/share/man/man4/en.4
===================================================================
--- trunk/share/man/man4/en.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/en.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,4 +1,5 @@
.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/en.4 208027 2010-05-13 12:07:55Z uqs $
.\"
.Dd July 16, 2005
.Dt EN 4
Modified: trunk/share/man/man4/enc.4
===================================================================
--- trunk/share/man/man4/enc.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/enc.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" $OpenBSD: enc.4,v 1.22 2006/05/26 08:51:29 jmc Exp $
.\"
.\" Copyright (c) 1999 Angelos D. Keromytis
@@ -29,7 +30,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/enc.4 211406 2010-08-16 21:26:47Z joel $
.\"
.Dd November 28, 2007
.Dt ENC 4
Modified: trunk/share/man/man4/epair.4
===================================================================
--- trunk/share/man/man4/epair.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/epair.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"-
.\" Copyright (c) 2008 The FreeBSD Foundation
.\" All rights reserved.
@@ -26,9 +27,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/epair.4 281571 2015-04-16 00:27:53Z allanjude $
.\"
-.Dd July 26, 2009
+.Dd March 18, 2015
.Dt EPAIR 4
.Os
.Sh NAME
@@ -89,15 +90,16 @@
To change the default addresses one may use the SIOCSIFADDR ioctl(2) or
ifconfig(8) utility.
.Pp
-The basic intend is to provide connectivity between two virtual
+The basic intent is to provide connectivity between two virtual
network stack instances.
-When connected to a
-.Xr if_bridge 4
+When connected to an
+.Xr if_bridge 4 ,
one end of the interface pair can also be part of another (virtual) LAN.
-As with any other Ethernet interface one can configure
+As with any other Ethernet interface,
+.Nm epair
+can have a
.Xr vlan 4
-support on top of it.
-.Pp
+configured on top of it.
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr altq 4 ,
@@ -104,7 +106,7 @@
.Xr bpf 4 ,
.Xr if_bridge 4 ,
.Xr vlan 4 ,
-.Xr loader.conf 5 ,
+.Xr loader.conf 5 ,
.Xr rc.conf 5 ,
.Xr ifconfig 8
.Sh HISTORY
Modified: trunk/share/man/man4/esp.4
===================================================================
--- trunk/share/man/man4/esp.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/esp.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2011 Marius Strobl <marius at FreeBSD.org>
.\" All rights reserved.
@@ -23,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/esp.4 227282 2011-11-06 21:54:27Z marius $
.\"
.Dd November 1, 2011
.Dt ESP 4
Modified: trunk/share/man/man4/est.4
===================================================================
--- trunk/share/man/man4/est.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/est.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2012 Sean Bruno <sbruno at freebsd.org>
.\" All rights reserved.
@@ -23,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/est.4 241727 2012-10-19 10:38:32Z joel $
.\"
.Dd October 18, 2012
.Dt EST 4
Modified: trunk/share/man/man4/et.4
===================================================================
--- trunk/share/man/man4/et.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/et.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2007 The DragonFly Project. All rights reserved.
.\"
@@ -28,7 +29,7 @@
.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/et.4 228370 2011-12-09 19:17:51Z yongari $
.\"
.Dd December 9, 2011
.Dt ET 4
Added: trunk/share/man/man4/etherswitch.4
===================================================================
--- trunk/share/man/man4/etherswitch.4 (rev 0)
+++ trunk/share/man/man4/etherswitch.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,66 @@
+.\" $MidnightBSD$
+.\" Copyright (c) 2015 Christian Brueffer
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/etherswitch.4 277064 2015-01-12 10:43:40Z brueffer $
+.\"
+.Dd January 5, 2015
+.Dt ETHERSWITCH 4
+.Os
+.Sh NAME
+.Nm etherswitch
+.Nd "Ethernet switch framework"
+.Sh SYNOPSIS
+To compile the framework into the kernel,
+place the following lines in the
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device etherswitch"
+.Cd "device miiproxy"
+.Cd "device iicbus"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver provides a framework for Ethernet switch devices.
+.Sh FILES
+.Bl -tag -width ".Pa /dev/etherswitch?" -compact
+.It Pa /dev/etherswitch?
+.Nm
+device nodes
+.El
+.Sh SEE ALSO
+.Xr arswitch 4 ,
+.Xr iicbus 4 ,
+.Xr ip17x 4 ,
+.Xr rtl8366rb 4 ,
+.Xr ukswitch 4 ,
+.Xr etherswitchcfg 8
+.Sh HISTORY
+The
+.Nm
+framework first appeared in
+.Fx 10.0 .
+.Sh AUTHORS
+.An Stefan Bethke
Property changes on: trunk/share/man/man4/etherswitch.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Modified: trunk/share/man/man4/eventtimers.4
===================================================================
--- trunk/share/man/man4/eventtimers.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/eventtimers.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2010 Alexander Motin <mav at FreeBSD.org>
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/eventtimers.4 247812 2013-03-04 19:10:39Z davide $
.\"
.Dd March 13, 2012
.Dt EVENTTIMERS 4
@@ -143,12 +144,6 @@
If chosen timer is per-CPU
and runs in periodic mode, this option has no effect - all interrupts are
always generating.
-.It Va kern.eventtimer.activetick
-makes each CPU to receive all kinds of timer interrupts when they are busy.
-Disabling it allows to skip some hardclock() calls in some cases.
-By default this options is enabled.
-If chosen timer is per-CPU, this option has no effect - all interrupts are
-always generating, as timer reprogramming is too expensive for that case.
.El
.Sh SEE ALSO
.Xr apic 4 ,
Modified: trunk/share/man/man4/exca.4
===================================================================
--- trunk/share/man/man4/exca.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/exca.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2003 M. Warner Losh
.\" All rights reserved.
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/exca.4 119169 2003-08-20 06:49:57Z imp $
.\"
.Dd February 23, 2003
.Dt EXCA 4
Modified: trunk/share/man/man4/faith.4
===================================================================
--- trunk/share/man/man4/faith.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/faith.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" $KAME: faith.4,v 1.9 2001/04/27 17:26:35 itojun Exp $
.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
@@ -27,7 +28,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/faith.4 231852 2012-02-17 02:39:58Z bz $
.\"
.Dd January 23, 2012
.Dt FAITH 4
Modified: trunk/share/man/man4/fatm.4
===================================================================
--- trunk/share/man/man4/fatm.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fatm.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001-2003
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
@@ -26,7 +27,7 @@
.\"
.\" Author: Hartmut Brandt <harti at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fatm.4 140561 2005-01-21 08:36:40Z ru $
.\"
.\" fatm(4) man page
.\"
Modified: trunk/share/man/man4/fd.4
===================================================================
--- trunk/share/man/man4/fd.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fd.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1990, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)fd.4 8.1 (Berkeley) 6/9/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fd.4 136926 2004-10-24 19:44:23Z rwatson $
.\"
.Dd June 9, 1993
.Dt FD 4
Modified: trunk/share/man/man4/fdc.4
===================================================================
--- trunk/share/man/man4/fdc.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fdc.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1994 Wilko Bulte
.\" Copyright (c) 2001 Joerg Wunsch
@@ -25,7 +26,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fdc.4 233422 2012-03-24 13:37:57Z joel $
.\"
.Dd May 11, 2006
.Dt FDC 4
@@ -173,7 +174,6 @@
per-drive device flags value of
.Ar 0x20
needs to be specified.
-.Pp
.Ss Programming Interface
In addition to the normal read and write functionality, the
.Nm
Modified: trunk/share/man/man4/fdt.4
===================================================================
--- trunk/share/man/man4/fdt.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fdt.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fdt.4 235317 2012-05-12 03:25:46Z gjb $
.\"
.Dd July 12, 2010
.Dt FDT 4
Modified: trunk/share/man/man4/fdtbus.4
===================================================================
--- trunk/share/man/man4/fdtbus.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fdtbus.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2010 The FreeBSD Foundation
.\" All rights reserved.
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fdtbus.4 235317 2012-05-12 03:25:46Z gjb $
.\"
.Dd July 12, 2010
.Dt FDTBUS 4
Added: trunk/share/man/man4/ffclock.4
===================================================================
--- trunk/share/man/man4/ffclock.4 (rev 0)
+++ trunk/share/man/man4/ffclock.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,130 @@
+.\" $MidnightBSD$
+.\" Copyright (c) 2011 The University of Melbourne
+.\" All rights reserved.
+.\"
+.\" This documentation was written by Julien Ridoux at the University of
+.\" Melbourne under sponsorship from the FreeBSD Foundation.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/ffclock.4 228743 2011-12-20 17:44:25Z mav $
+.\"
+.Dd December 1, 2011
+.Dt FFCLOCK 4
+.Os
+.Sh NAME
+.Nm FFCLOCK
+.Nd Feed-forward system clock
+.Sh SYNOPSIS
+.Cd options FFCLOCK
+.Sh DESCRIPTION
+The
+.Xr ntpd 8
+daemon has been the dominant solution for system clock synchronisation for many
+years, which has in turn influenced the design of the system clock.
+The ntpd daemon implements a feedback control algorithm which has been
+demonstrated to perform poorly in common use cases.
+.Pp
+Feed-forward clock synchronisation algorithms implemented by an appropriate
+daemon, in concert with the
+.Nm
+kernel support, have been shown to provide highly robust and accurate clock
+synchronisation.
+In addition to time keeping, the
+.Nm
+kernel mechanism provides new timestamping capabilities and the ability to
+use specialised clocks.
+Feed-forward synchronisation is also very well suited for virtualised
+environments, reducing the overhead of timekeeping in guests and ensuring
+continued smooth operation of the system clock during guest live migration.
+.Pp
+The
+.Nm
+kernel support provides feed-forward timestamping functions within the kernel
+and system calls to support feed-forward synchronisation daemons
+.Po see
+.Xr ffclock 2
+.Pc .
+.Ss Kernel Options
+The following kernel configuration options are related to
+.Nm :
+.Pp
+.Bl -tag -width ".Dv FFCLOCK" -compact
+.It Dv FFCLOCK
+Enable feed-forward clock support.
+.El
+.Ss Configuration
+When feed-forward clock support is compiled into the kernel, multiple system
+clocks become available to choose from.
+System clock configuration is possible via the
+.Va kern.sysclock
+.Xr sysctl 8
+tree which provides the following variables:
+.Bl -tag -width " " -offset indent
+.It Va kern.sysclock.active
+Name of the current active system clock which is serving time.
+Set to one of the names in
+.Va kern.sysclock.available
+in order to change the default active system clock.
+.It Va kern.sysclock.available
+Lists the names of available system clocks
+.Po
+read only
+.Pc .
+.El
+.Pp
+Feed-forward system clock configuration is possible via the
+.Va kern.sysclock.ffclock
+sysctl tree which provides the following variables:
+.Bl -tag -width " " -offset indent
+.It Va kern.sysclock.ffclock.version
+Feed-forward clock kernel version
+.Po
+read only
+.Pc .
+.It Va kern.sysclock.ffclock.ffcounter_bypass
+Use reliable hardware timecounter as the feed-forward counter.
+Will eventually be useful for virtualised environment like
+.Xr xen 4 ,
+but currently does nothing.
+.El
+.Sh SEE ALSO
+.Xr clock_gettime 2 ,
+.Xr ffclock 2 ,
+.Xr bpf 4 ,
+.Xr timecounters 4 ,
+.Xr sysctl 8
+.Sh HISTORY
+Feed-forward clock support first appeared in
+.Fx 10.0 .
+.Sh AUTHORS
+.An -nosplit
+The feed-forward clock support was written by
+.An Julien Ridoux Aq jridoux at unimelb.edu.au
+in collaboration with
+.An Darryl Veitch Aq dveitch at unimelb.edu.au
+at the University of Melbourne under sponsorship from the FreeBSD Foundation.
+.Pp
+This manual page was written by
+.An Julien Ridoux Aq jridoux at unimelb.edu.au
+and
+.An Lawrence Stewart Aq lstewart at FreeBSD.org .
Property changes on: trunk/share/man/man4/ffclock.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Modified: trunk/share/man/man4/filemon.4
===================================================================
--- trunk/share/man/man4/filemon.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/filemon.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2012
.\" David E. O'Brien <obrien at FreeBSD.org>. All rights reserved.
.\"
@@ -10,7 +11,7 @@
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
-.\" must display the following acknowledgement:
+.\" must display the following acknowledgment:
.\" This product includes software developed by David E. O'Brien and
.\" contributors.
.\" 4. Neither the name of the author nor the names of its contributors
@@ -19,7 +20,7 @@
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" IMPLIED WARRANTIES OF MERCHANT ABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
@@ -29,9 +30,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/filemon.4 302070 2016-06-21 20:20:30Z bdrewery $
.\"
-.Dd May 30, 2012
+.Dd June 21, 2016
.Dt FILEMON 4
.Os
.Sh NAME
@@ -49,9 +50,24 @@
.Xr ioctl 2
calls.
.Pp
+.Nm
+is not intended to be a security auditing tool.
+Many system calls are not tracked and binaries of foreign ABI will not be fully
+audited.
+It is intended for auditing of processes for the purpose of determining its
+dependencies in an efficient and easily parsable format.
+An example of this is
+.Xr make 1
+which uses this module with
+.Sy .MAKE.MODE=meta
+to handle incremental builds more smartly.
+.Pp
System calls are denoted using the following single letters:
.Pp
.Bl -tag -width indent -compact
+.It Ql A
+.Xr openat 2 .
+The next log entry may be lacking an absolute path or be inaccurate.
.It Ql C
.Xr chdir 2
.It Ql D
@@ -70,11 +86,13 @@
.Xr rename 2
.It Ql R
.Xr open 2
+or
+.Xr openat 2
for read
-.It Ql S
-.Xr stat 2
.It Ql W
.Xr open 2
+or
+.Xr openat 2
for write
.It Ql X
.Xr _exit 2
@@ -87,12 +105,13 @@
records can represent a single
.Xr open 2
for R/W,
-or two seperate
+or two separate
.Xr open 2
calls, one for
.Ql R
and one for
.Ql W .
+Note that only successful system calls are captured.
.Sh IOCTLS
User mode programs communicate with the
.Nm
@@ -103,6 +122,10 @@
Write the internal tracing buffer to the supplied open file descriptor.
.It Dv FILEMON_SET_PID
Child process ID to trace.
+This should normally be done under the control of a parent in the child after
+.Xr fork 2
+but before anything else.
+See the example below.
.El
.Sh RETURN VALUES
.\" .Rv -std ioctl
@@ -112,6 +135,48 @@
otherwise the value \-1 is returned and the global variable
.Va errno
is set to indicate the error.
+.Sh ERRORS
+The
+.Fn ioctl
+system call
+with
+.Dv FILEMON_SET_FD
+will fail if:
+.Bl -tag -width Er
+.It Bq Er EEXIST
+The
+.Nm
+handle is already associated with a file descriptor.
+.El
+.Pp
+The
+.Fn ioctl
+system call
+with
+.Dv FILEMON_SET_PID
+will fail if:
+.Bl -tag -width Er
+.It Bq Er ESRCH
+No process having the specified process ID exists.
+.It Bq Er EBUSY
+The process ID specified is already being traced and was not the current
+process.
+.El
+.Pp
+The
+.Fn close
+system call on the filemon file descriptor may fail with the errors from
+.Xr write 2
+if any error is encountered while writing the log.
+It may also fail if:
+.Bl -tag -width Er
+.It Bq Er EFAULT
+An invalid address was used for a traced system call argument, resulting in
+no log entry for the system call.
+.It Bq Er ENAMETOOLONG
+An argument for a traced system call was too long, resulting in
+no log entry for the system call.
+.El
.Sh FILES
.Bl -tag -width ".Pa /dev/filemon"
.It Pa /dev/filemon
@@ -125,6 +190,7 @@
#include <dev/filemon/filemon.h>
#include <fcntl.h>
#include <err.h>
+#include <unistd.h>
static void
open_filemon(void)
@@ -132,17 +198,14 @@
pid_t child;
int fm_fd, fm_log;
- if ((fm_fd = open("/dev/filemon", O_RDWR)) == -1)
+ if ((fm_fd = open("/dev/filemon", O_RDWR | O_CLOEXEC)) == -1)
err(1, "open(\e"/dev/filemon\e", O_RDWR)");
if ((fm_log = open("filemon.out",
- O_CREAT | O_WRONLY | O_TRUNC, DEFFILEMODE)) == -1)
+ O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, DEFFILEMODE)) == -1)
err(1, "open(filemon.out)");
if (ioctl(fm_fd, FILEMON_SET_FD, &fm_log) == -1)
err(1, "Cannot set filemon log file descriptor");
- /* Set up these two fd's to close on exec. */
- (void)fcntl(fm_fd, F_SETFD, FD_CLOEXEC);
- (void)fcntl(fm_log, F_SETFD, FD_CLOEXEC);
if ((child = fork()) == 0) {
child = getpid();
@@ -149,12 +212,10 @@
if (ioctl(fm_fd, FILEMON_SET_PID, &child) == -1)
err(1, "Cannot set filemon PID");
/* Do something here. */
- return 0;
} else {
wait(&child);
close(fm_fd);
}
- return 0;
}
.Ed
.Pp
@@ -168,9 +229,14 @@
.Sh SEE ALSO
.Xr dtrace 1 ,
.Xr ktrace 1 ,
-.Xr truss 1
+.Xr script 1 ,
+.Xr truss 1 ,
+.Xr ioctl 2
.Sh HISTORY
A
.Nm
device appeared in
.Fx 9.1 .
+.Sh BUGS
+Unloading the module may panic the system, thus requires using
+.Ic kldunload -f .
Modified: trunk/share/man/man4/firewire.4
===================================================================
--- trunk/share/man/man4/firewire.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/firewire.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
.\" All rights reserved.
.\"
@@ -29,9 +30,9 @@
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/firewire.4 236443 2012-06-02 11:03:14Z joel $
.\"
-.Dd April 1, 2006
+.Dd May 11, 2012
.Dt FIREWIRE 4
.Os
.Sh NAME
@@ -82,12 +83,20 @@
On the
.Nm
bus, every device is identified by an EUI 64 address.
+.Pp
+Debugging over the firewire interace is possible with the
+.Xr dcons 4
+driver.
+Please see
+.Pa http://wiki.freebsd.org/DebugWithDcons
+for details on how to setup debugging with firewire.
.Sh FILES
-.Bl -tag -compact
+.Bl -tag -width "Pa /dev/fwmem0.0" -compact
.It Pa /dev/fw0.0
.It Pa /dev/fwmem0.0
.El
.Sh SEE ALSO
+.Xr dcons 4 ,
.Xr fwe 4 ,
.Xr fwip 4 ,
.Xr fwohci 4 ,
Modified: trunk/share/man/man4/fla.4
===================================================================
--- trunk/share/man/man4/fla.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fla.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2003 David E. O'Brien
.\" All rights reserved.
.\"
Modified: trunk/share/man/man4/fpa.4
===================================================================
--- trunk/share/man/man4/fpa.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fpa.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,8 +1,9 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1995, Matt Thomas
.\" All rights reserved.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fpa.4 208027 2010-05-13 12:07:55Z uqs $
.\"
.Dd March 13, 1995
.Dt FPA 4
Modified: trunk/share/man/man4/full.4
===================================================================
--- trunk/share/man/man4/full.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/full.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2014
.\" Eitan Adler <eadler at FreeBSD.org>. All rights reserved.
.\"
Modified: trunk/share/man/man4/fwe.4
===================================================================
--- trunk/share/man/man4/fwe.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fwe.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2002 Hidetoshi Shimokawa
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fwe.4 151046 2005-10-07 02:32:16Z trhodes $
.\"
.\"
.Dd July 16, 2005
Modified: trunk/share/man/man4/fwip.4
===================================================================
--- trunk/share/man/man4/fwip.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fwip.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2004 Doug Rabson
.\" Copyright (c) 2002 Hidetoshi Shimokawa
.\" All rights reserved.
@@ -23,7 +24,7 @@
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fwip.4 152569 2005-11-18 10:56:28Z ru $
.\"
.Dd July 16, 2005
.Dt FWIP 4
Modified: trunk/share/man/man4/fwohci.4
===================================================================
--- trunk/share/man/man4/fwohci.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fwohci.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1998,1999,2000 Katsushi Kobayashi and Hidetoshi Shimokawa
.\" All rights reserved.
.\"
@@ -29,7 +30,7 @@
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fwohci.4 233422 2012-03-24 13:37:57Z joel $
.\"
.\"
.Dd March 3, 2008
@@ -60,7 +61,6 @@
.Bd -literal -offset indent
hw.firewire.phydma_enable=0
.Ed
-.Pp
.Sh HARDWARE
The
.Nm
Modified: trunk/share/man/man4/fxp.4
===================================================================
--- trunk/share/man/man4/fxp.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/fxp.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1997 David E. O'Brien
.\"
@@ -23,7 +24,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/fxp.4 215907 2010-11-26 21:57:01Z marius $
.\"
.Dd November 26, 2010
.Dt FXP 4
Modified: trunk/share/man/man4/kbdmux.4
===================================================================
--- trunk/share/man/man4/kbdmux.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/kbdmux.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,5 +1,6 @@
-.\" $Id: kbdmux.4,v 1.4 2012-12-29 16:29:12 laffer1 Exp $
.\" $MidnightBSD$
+.\" $Id: kbdmux.4,v 1.1 2005/07/14 20:32:10 max Exp $
+.\" $FreeBSD: stable/10/share/man/man4/kbdmux.4 271095 2014-09-04 13:45:16Z se $
.\"
.Dd July 12, 2005
.Dt KBDMUX 4
@@ -34,7 +35,8 @@
.Xr kbdcontrol 1 ,
.Xr atkbd 4 ,
.Xr syscons 4 ,
-.Xr ukbd 4
+.Xr ukbd 4 ,
+.Xr vt 4
.Sh HISTORY
The
.Nm
Modified: trunk/share/man/man4/keyboard.4
===================================================================
--- trunk/share/man/man4/keyboard.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/keyboard.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,6 +1,7 @@
-.\"
.\" $MidnightBSD$
.\"
+.\" $FreeBSD: stable/10/share/man/man4/keyboard.4 213573 2010-10-08 12:40:16Z uqs $
+.\"
.Dd January 8, 1995
.Dt KEYBOARD 4
.Os
Modified: trunk/share/man/man4/kld.4
===================================================================
--- trunk/share/man/man4/kld.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/kld.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1993 Christopher G. Demetriou
.\" All rights reserved.
.\"
@@ -23,9 +24,9 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/kld.4 260906 2014-01-20 14:37:02Z bapt $
.\"
-.Dd November 8, 1998
+.Dd January 13, 2014
.Dt KLD 4
.Os
.Sh NAME
@@ -166,8 +167,8 @@
fails to execute the entry point.
.Pp
.Xr kldload 8
-returns the cryptic message
-.Sq Li "ENOEXEC (Exec format error)"
+points the user to read
+.Xr dmesg 8
for any error encountered while loading a module.
.Pp
When system internal interfaces change, old modules often cannot
Modified: trunk/share/man/man4/ksyms.4
===================================================================
--- trunk/share/man/man4/ksyms.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ksyms.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2008-2009 Stacey Son <sson at FreeBSD.org>
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -29,7 +30,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ksyms.4 233648 2012-03-29 05:02:12Z eadler $
.\"
.Dd April 5, 2009
.Dt KSYMS 4
@@ -42,15 +43,15 @@
.Sh DESCRIPTION
The
.Pa /dev/ksyms
-character device provides a read-only interface to a snapshot of the kernel
+character device provides a read-only interface to a snapshot of the kernel
symbol table. The in-kernel symbol manager is designed to be able to handle
-many types of symbols tables, however, only
+many types of symbols tables, however, only
.Xr elf 5
symbol tables are supported by this device. The ELF format image contains two
-sections: a symbol table and a corresponding string table.
+sections: a symbol table and a corresponding string table.
.Bl -tag -width indent -offset indent
.It Dv Symbol Table
-The SYMTAB section contains the symbol table entries present in the current
+The SYMTAB section contains the symbol table entries present in the current
running kernel, including the symbol table entries of any loaded modules. The
symbols are ordered by the kernel module load time starting with kernel file
symbols first, followed by the first loaded module's symbols and so on.
@@ -65,10 +66,10 @@
Since
.Pa /dev/ksyms
has no text or data, most of the fields are initialized to NULL.
-The
-.Nm
+The
+.Nm
driver does not block the loading or unloading of modules into the kernel
-while the
+while the
.Pa /dev/ksyms
file is open but may contain stale data.
.Sh IOCTLS
@@ -87,7 +88,7 @@
the kernel symbol table.
.It Dv KIOCGADDR (void *)
Returns the address of the kernel symbol table mapped in
-the process memory.
+the process memory.
.El
.Sh FILES
.Bl -tag -width /dev/ksymsX
@@ -94,22 +95,22 @@
.It Pa /dev/ksyms
.El
.Sh ERRORS
-An
+An
.Xr open 2
of
.Pa /dev/ksyms
-will fail if:
+will fail if:
.Bl -tag -width Er
.It Bq Er EBUSY
-The device is already open. A process must close
+The device is already open. A process must close
.Pa /dev/ksyms
-before it can be opened again.
+before it can be opened again.
.It Bq Er ENOMEM
There is a resource shortage in the kernel.
.It Bq Er ENXIO
The driver was unsuccessful in creating a snapshot of the kernel symbol
table. This may occur if the kernel was in the process of loading or
-unloading a module.
+unloading a module.
.El
.Sh SEE ALSO
.Xr ioctl 2 ,
@@ -128,7 +129,7 @@
.Nm
driver first appeared in
.Fx 8.0
-to support
+to support
.Xr lockstat 1 .
.Sh AUTHORS
The
@@ -137,7 +138,7 @@
.An Stacey Son
.Aq sson at FreeBSD.org .
.Sh BUGS
-Because files can be dynamically linked into the kernel at any time the symbol
+Because files can be dynamically linked into the kernel at any time the symbol
information can vary. When you open the
.Pa /dev/ksyms
file, you have access to an ELF image which represents a snapshot of the state of the kernel symbol information at that instant in time. Keeping the device open does not block the loading or unloading of kernel modules. To get a new snapshot you must close and re-open the device.
@@ -147,12 +148,12 @@
file once at a time. The process must close the
.Pa /dev/ksyms
before it is allowed to open it again.
-.Pp
+.Pp
The
.Nm
-driver uses the calling process' memory address space to store the snapshot.
+driver uses the calling process' memory address space to store the snapshot.
.Xr ioctl 2
can be used to get the memory address where the symbol table is stored to
-save kernel memory.
+save kernel memory.
.Xr mmap 2
-may also be used but it will map it to another address.
+may also be used but it will map it to another address.
Modified: trunk/share/man/man4/ktr.4
===================================================================
--- trunk/share/man/man4/ktr.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ktr.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001 John H. Baldwin <jhb at FreeBSD.org>
.\" All rights reserved.
.\"
@@ -22,9 +23,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ktr.4 243437 2012-11-23 08:44:36Z kevlo $
.\"
-.Dd January 25, 2005
+.Dd October 20, 2012
.Dt KTR 4
.Os
.Sh NAME
@@ -52,9 +53,8 @@
The
.Dv KTR_ENTRIES
option sets the size of the buffer of events.
-It must be a power of two.
The size of the buffer in the currently running kernel can be found via the
-read-only sysctl
+sysctl
.Va debug.ktr.entries .
By default the buffer contains 1024 entries.
.Ss Event Masking
@@ -78,9 +78,7 @@
It can also be examined and set after booting via the
.Va debug.ktr.mask
sysctl.
-By default the run time mask is set to log only
-.Dv KTR_GEN
-events.
+By default the run time mask is set to block any tracing.
The definitions of the event mask bits can be found in
.In sys/ktr.h .
.Pp
@@ -88,6 +86,9 @@
the
.Dv KTR_CPUMASK
option.
+When two or more parameters to
+.Dv KTR_CPUMASK ,
+are used, it is important they are not separated by whitespace.
A CPU must have the bit corresponding to its logical id set in this bitmask
for events that occur on it to be logged.
This mask can be set by the
@@ -98,7 +99,12 @@
It can also be examined and set after booting via the
.Va debug.ktr.cpumask
sysctl.
-By default events on all CPUs are enabled.
+By default, only CPUs specified in
+.Dv KTR_CPUMASK
+will log events.
+See
+.Pa sys/conf/NOTES
+for more information.
.Ss Verbose Mode
By default, events are only logged to the internal buffer for examination
later, but if the verbose flag is set then they are dumped to the kernel
Modified: trunk/share/man/man4/kue.4
===================================================================
--- trunk/share/man/man4/kue.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/kue.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1997, 1998, 1999, 2000
.\" Bill Paul <wpaul at ee.columbia.edu>. All rights reserved.
.\"
@@ -28,9 +29,9 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/kue.4 291844 2015-12-05 07:46:37Z kevlo $
.\"
-.Dd October 7, 2006
+.Dd November 24, 2015
.Dt KUE 4
.Os
.Sh NAME
@@ -44,6 +45,8 @@
.Cd "device uhci"
.Cd "device ohci"
.Cd "device usb"
+.Cd "device miibus"
+.Cd "device uether"
.Cd "device kue"
.Ed
.Pp
Added: trunk/share/man/man4/nand.4
===================================================================
--- trunk/share/man/man4/nand.4 (rev 0)
+++ trunk/share/man/man4/nand.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,141 @@
+.\" $MidnightBSD$
+.\"
+.\" Copyright (c) 2012 The FreeBSD Foundation
+.\" All rights reserved.
+.\"
+.\" This documentation was written by Semihalf under sponsorship from
+.\" the FreeBSD Foundation.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/nand.4 235537 2012-05-17 10:11:18Z gber $
+.\"
+.Dd March 8, 2012
+.Dt NAND 4
+.Os
+.Sh NAME
+.Nm nand
+.Nd NAND Flash framework
+.Sh SYNOPSIS
+.Cd "device nand"
+.Sh DESCRIPTION
+The
+.Fx
+.Nm
+framework consists of a set of interfaces that aim to provide an extensible,
+object oriented environement for NAND controllers and NAND Flash memory chips
+from various hardware vendors, and to allow for uniform and flexible
+management of the NAND devices. It comprises of the following major
+components:
+.Bl -bullet
+.It
+NAND Flash controller (NFC) interface.
+.Pp
+Defines methods which allow to send commands as well as send/receive data
+between the controller and a NAND chip. Back-end drivers for specific NAND
+controllers plug into this interface and implement low-level routines for a
+given NAND controller.
+.Pp
+This layer implements basic functionality of a NAND Flash controller. It
+allows to send command and address to chip, drive CS (chip select line), as
+well as read/write to the selected NAND chip. This layer is independent of
+NAND chip devices actually connected to the controller.
+.It
+NAND chip interface.
+.Pp
+Provides basic operations like read page, program page, erase block. Currently
+three generic classes of drivers are available, which provide support for the
+following chips:
+.Bl -bullet
+.It
+large page
+.It
+small page
+.It
+ONFI-compliant
+.El
+.Pp
+This layer implements basic operations to be performed on a NAND chip, like
+read, program, erase, get status etc. Since these operations use specific
+commands (depending on the vendor), each chip has potentially its own
+implementation of the commands set.
+.Pp
+The framework is extensible so it is also possible to create a custom command
+set for a non standard chip support.
+.It
+NANDbus.
+.Pp
+This layer is responsible for enumerating NAND chips in the system and
+establishing the hierarchy between chips and their supervising controllers.
+.Pp
+Its main purpose is detecting type of NAND chips connected to a given chip
+select (CS line). It also allows manages locking access to the NAND
+controller. NANDbus passes requests from an active chip to the chip
+controller.
+.It
+NAND character / GEOM device.
+.Pp
+For each NAND chip found in a system a character and GEOM devices are created
+which allows to read / write directly to a device, as well as perform other
+specific operations (like via ioctl).
+.Pp
+There are two GEOM devices created for each NAND chip:
+.Bl -bullet
+.It
+raw device
+.It
+normal device
+.El
+.Pp
+Raw device allows to bypass ECC checking when reading/writing to it, while
+normal device always uses ECC algorithm to validate the read data.
+.Pp
+NAND character devices will be created for each NAND chip detected while
+probing the NAND controller.
+.El
+.Sh SEE ALSO
+.Xr libnandfs 3 ,
+.Xr gnand 4 ,
+.Xr nandsim 4 ,
+.Xr nandfs 5 ,
+.Xr makefs 8 ,
+.Xr mount_nandfs 8 ,
+.Xr nandfs 8 ,
+.Xr nandsim 8 ,
+.Xr nandtool 8 ,
+.Xr newfs_nandfs 8 ,
+.Xr umount_nandfs 8
+.Sh STANDARDS
+Open NAND Flash Interface Working Group
+.Pq Vt ONFI .
+.Sh HISTORY
+The
+.Nm
+framework support first appeared in
+.Fx 10.0 .
+.Sh AUTHOR
+The
+.Nm
+framework was designed and developed by
+.An Grzegorz Bernacki .
+This manual page was written by
+.An Rafal Jaworowski .
Property changes on: trunk/share/man/man4/nand.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Added: trunk/share/man/man4/nandsim.4
===================================================================
--- trunk/share/man/man4/nandsim.4 (rev 0)
+++ trunk/share/man/man4/nandsim.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,93 @@
+.\" $MidnightBSD$
+.\"
+.\" Copyright (c) 2012 The FreeBSD Foundation
+.\" All rights reserved.
+.\"
+.\" This documentation was written by Semihalf under sponsorship from
+.\" the FreeBSD Foundation.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/nandsim.4 235545 2012-05-17 11:53:38Z gber $
+.\"
+.Dd March 8, 2012
+.Dt NANDSIM 4
+.Os
+.Sh NAME
+.Nm nandsim
+.Nd NAND Flash simulator driver
+.Sh SYNOPSIS
+.Cd "device nand"
+.Cd "device nandsim"
+.Cd "options ALQ"
+.Sh DESCRIPTION
+The
+.Nm
+is part of the
+.Fx
+NAND framework
+.Xr nand 4
+and can be characterized with the following highlights:
+.Bl -bullet
+.It
+plugs into the
+.Xr nand 4
+framework APIs as if it were a hardware controller (hanging on the nexus bus)
+with real NAND chips connected to it
+.It
+physically part of the kernel code (either statically linked into the kernel
+image or built as a module)
+.It
+controlled with a user space program
+.Xr nandsim 8
+.El
+.Pp
+From the user perspective, the
+.Nm
+allows for imitating ONFI-compliant NAND Flash devices as if they were
+attached to the system via a virtual controller.
+.Pp
+Some
+.Nm
+features rely on the ability to log contents to a file, which is achieved
+through the
+.Xr alq 9
+facility.
+.Sh SEE ALSO
+.Xr nand 4 ,
+.Xr nandsim.conf 5 ,
+.Xr nandsim 8
+.Sh STANDARDS
+Open NAND Flash Interface Working Group
+.Pq Vt ONFI .
+.Sh HISTORY
+The
+.Nm
+support first appeared in
+.Fx 10.0 .
+.Sh AUTHOR
+The
+.Nm
+kernel driver was developed by
+.An Grzegorz Bernacki .
+This manual page was written by
+.An Rafal Jaworowski .
Property changes on: trunk/share/man/man4/nandsim.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Modified: trunk/share/man/man4/natm.4
===================================================================
--- trunk/share/man/man4/natm.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/natm.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,4 +1,5 @@
.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/natm.4 261016 2014-01-22 10:01:13Z glebius $
.\"
.Dd December 29, 1997
.Dt NATM 4
@@ -14,6 +15,7 @@
which provides socket level access to AAL0 and AAL5 virtual circuits.
To enable this protocol layer, add
.Dl options NATM
+.Dl device atm
to your kernel configuration file and re-make the kernel (do not forget
to do
.Dq make clean ) .
@@ -23,11 +25,11 @@
to specify a virtual circuit:
.Bd -literal -offset indent
struct sockaddr_natm {
- u_int8_t snatm_len; /* length */
- u_int8_t snatm_family; /* AF_NATM */
+ uint8_t snatm_len; /* length */
+ uint8_t snatm_family; /* AF_NATM */
char snatm_if[IFNAMSIZ]; /* interface name */
- u_int16_t snatm_vci; /* vci */
- u_int8_t snatm_vpi; /* vpi */
+ uint16_t snatm_vci; /* vci */
+ uint8_t snatm_vpi; /* vpi */
};
.Ed
.Pp
Modified: trunk/share/man/man4/natmip.4
===================================================================
--- trunk/share/man/man4/natmip.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/natmip.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2003
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/natmip.4 131797 2004-07-08 10:31:12Z ru $
.\"
.Dd August 11, 2003
.Dt NATMIP 4
Modified: trunk/share/man/man4/ncr.4
===================================================================
--- trunk/share/man/man4/ncr.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ncr.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 1994 James A. Jegers
.\" All rights reserved.
@@ -21,7 +22,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ncr.4 159719 2006-06-18 09:53:00Z brueffer $
.\"
.Dd August 19, 2004
.Dt NCR 4
Modified: trunk/share/man/man4/ncv.4
===================================================================
--- trunk/share/man/man4/ncv.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ncv.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (C) 2003 The FreeBSD Project. All rights reserved.
.\" Copyright (c) 2003 Noriaki Mitsunaga. All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ncv.4 159719 2006-06-18 09:53:00Z brueffer $
.\"
.Dd August 10, 2004
.Dt NCV 4
Modified: trunk/share/man/man4/ndis.4
===================================================================
--- trunk/share/man/man4/ndis.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ndis.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2003
.\" Bill Paul <wpaul at windriver.com>. All rights reserved.
.\"
@@ -28,7 +29,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ndis.4 205155 2010-03-14 15:49:04Z gavin $
.\"
.Dd March 14, 2010
.Dt NDIS 4
Modified: trunk/share/man/man4/net80211.4
===================================================================
--- trunk/share/man/man4/net80211.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/net80211.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"-
.\" Copyright (c) 2009 Sam Leffler, Errno Consulting
.\" All rights reserved.
@@ -26,7 +27,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGES.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/net80211.4 235317 2012-05-12 03:25:46Z gjb $
.\"
.Dd July 10, 2009
.Dt NET80211 4
@@ -64,7 +65,7 @@
.Bd -literal
struct ieee80211req {
char i_name[IFNAMSIZ]; /* if_name, e.g. "wi0" */
- u_int16_t i_type; /* req type */
+ uint16_t i_type; /* req type */
int16_t i_val; /* Index or simple value */
int16_t i_len; /* Index or simple value */
void *i_data; /* Extra data */
@@ -199,7 +200,7 @@
.It Dv IEEE80211_IOC_BGSCAN
Return whether background scanning is enabled in
.Va i_val .
-When this value is non-zero and operating in station mode
+When this value is non-zero and operating in station mode
the station will periodically leave
the current channel and scan for neighboring stations.
See also
@@ -343,7 +344,7 @@
.Va i_val ,
whether SSID hiding/cloaking is enabled.
SSID hiding is only meaningful when operating as an access point.
-When this is enabled Beacon frames do not include the SSID and
+When this is enabled Beacon frames do not include the SSID and
ProbeRequest frames are not answered unless they include the AP's SSID.
This value will be non-zero when SSID hiding is enabled and otherwise zero.
.It Dv IEEE80211_IOC_HTCOMPAT
@@ -464,7 +465,7 @@
a station will sleep before waking to retrieve packets buffered by
an access point.
.It Dv IEEE80211_IOC_PRIVACY
-Return the current MLME setting for PRIVACY in
+Return the current MLME setting for PRIVACY in
.Va i_val .
When PRIVACY is enabled all data packets must be encrypted.
This value will be zero if PRIVACY is disabled and
@@ -1093,7 +1094,7 @@
.Va i_val .
This request causes a running interface to be reset.
.It Dv IEEE80211_IOC_PRIVACY
-Set the current MLME setting for PRIVACY using the value in
+Set the current MLME setting for PRIVACY using the value in
.Va i_val .
See
.Dv IEEE80211_IOC_PRIVACY
@@ -1205,7 +1206,7 @@
Set the current TDMA slot to the value in
.Va i_val .
Values must be in the range [0-slotcnt].
-Slot 0 identifies the master in the TDMA network; if it running it will
+Slot 0 identifies the master in the TDMA network; if it running it will
immediately start sending Beacon frames.
.It Dv IEEE80211_IOC_TDMA_SLOTCNT
Set the number of slots in the TDMA network to the value in
Added: trunk/share/man/man4/netfpga10g_nf10bmac.4
===================================================================
--- trunk/share/man/man4/netfpga10g_nf10bmac.4 (rev 0)
+++ trunk/share/man/man4/netfpga10g_nf10bmac.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,71 @@
+.\" $MidnightBSD$
+.\"-
+.\" Copyright (c) 2014 Bjoern A. Zeeb
+.\" All rights reserved.
+.\"
+.\" This software was developed by SRI International and the University of
+.\" Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-11-C-0249
+.\" ("MRC2"), as part of the DARPA MRC research programme.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/netfpga10g_nf10bmac.4 270061 2014-08-16 14:30:46Z bz $
+.\"
+.Dd April 17, 2014
+.Dt NETFPGA10G_NF10BMAC 4
+.Os
+.Sh NAME
+.Nm netfpga10g_nf10bmac
+.Nd driver for the NetFPGA-10G Embedded CPU Ethernet Core
+.Sh SYNOPSIS
+.Cd "device netfpga10g_nf10bmac"
+.Sh DESCRIPTION
+The
+.Nm
+device driver provides support for the NetFPGA-10G Embedded CPU Ethernet
+Core.
+.Sh HARDWARE
+The current version of the
+.Nm
+driver works with one PIO mode interface of the
+NetFPGA-10G Embedded CPU Ethernet Core version 1.00a.
+.Sh SEE ALSO
+.Xr netintro 4 ,
+.Xr ifconfig 8
+.Rs
+.%T NetFPGA-10G Wiki
+.%U https://github.com/NetFPGA/NetFPGA-public/wiki
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 11.0 .
+.Sh AUTHORS
+This software and this manual page were
+developed by SRI International and the University of Cambridge Computer
+Laboratory under DARPA/AFRL contract
+.Pq FA8750-11-C-0249
+.Pq Do MRC2 Dc ,
+as part of the DARPA MRC research programme.
+The device driver was written by
+.An Bjoern A. Zeeb .
Property changes on: trunk/share/man/man4/netfpga10g_nf10bmac.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Modified: trunk/share/man/man4/netgraph.4
===================================================================
--- trunk/share/man/man4/netgraph.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/netgraph.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -34,9 +35,9 @@
.\" Archie Cobbs <archie at FreeBSD.org>
.\"
.\" $Whistle: netgraph.4,v 1.7 1999/01/28 23:54:52 julian Exp $
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/netgraph.4 261020 2014-01-22 10:31:56Z glebius $
.\"
-.Dd May 25, 2008
+.Dd November 25, 2013
.Dt NETGRAPH 4
.Os
.Sh NAME
@@ -292,7 +293,7 @@
(See
.Dv NGM_READONLY
in
-.In ng_message.h . )
+.In netgraph/ng_message.h . )
.Pp
While this mode of operation
results in good performance, it has a few implications for node
@@ -840,26 +841,27 @@
.Ss Netgraph Message Structure
Control messages have the following structure:
.Bd -literal
-#define NG_CMDSTRSIZ 32 /* Max command string (including nul) */
+#define NG_CMDSTRSIZ 32 /* Max command string (including null) */
struct ng_mesg {
struct ng_msghdr {
u_char version; /* Must equal NG_VERSION */
- u_char spare; /* Pad to 2 bytes */
- u_short arglen; /* Length of cmd/resp data */
- u_long flags; /* Message status flags */
- u_long token; /* Reply should have the same token */
- u_long typecookie; /* Node type understanding this message */
- u_long cmd; /* Command identifier */
- u_char cmdstr[NG_CMDSTRSIZ]; /* Cmd string (for debug) */
+ u_char spare; /* Pad to 4 bytes */
+ uint16_t spare2;
+ uint32_t arglen; /* Length of cmd/resp data */
+ uint32_t cmd; /* Command identifier */
+ uint32_t flags; /* Message status flags */
+ uint32_t token; /* Reply should have the same token */
+ uint32_t typecookie; /* Node type understanding this message */
+ u_char cmdstr[NG_CMDSTRSIZ]; /* cmd string + \0 */
} header;
- char data[0]; /* Start of cmd/resp data */
+ char data[]; /* placeholder for actual data */
};
-#define NG_ABI_VERSION 5 /* Netgraph kernel ABI version */
-#define NG_VERSION 4 /* Netgraph message version */
-#define NGF_ORIG 0x0000 /* Command */
-#define NGF_RESP 0x0001 /* Response */
+#define NG_ABI_VERSION 12 /* Netgraph kernel ABI version */
+#define NG_VERSION 8 /* Netgraph message version */
+#define NGF_ORIG 0x00000000 /* The msg is the original request */
+#define NGF_RESP 0x00000001 /* The message is a response */
.Ed
.Pp
Control messages have the fixed header shown above, followed by a
@@ -1284,7 +1286,7 @@
There is a full multilink PPP implementation that runs in
.Nm .
The
-.Pa net/mpd
+.Pa net/mpd5
port can use these modules to make a very low latency high
capacity PPP system.
It also supports
@@ -1296,7 +1298,7 @@
either
.Xr ppp 8
or the
-.Pa net/mpd
+.Pa net/mpd5
port.
.It BRIDGE
This node, together with the Ethernet nodes, allows a very flexible
@@ -1423,6 +1425,7 @@
.Xr ng_bridge 4 ,
.Xr ng_bt3c 4 ,
.Xr ng_btsocket 4 ,
+.Xr ng_car 4 ,
.Xr ng_cisco 4 ,
.Xr ng_device 4 ,
.Xr ng_echo 4 ,
@@ -1439,13 +1442,16 @@
.Xr ng_hub 4 ,
.Xr ng_iface 4 ,
.Xr ng_ip_input 4 ,
+.Xr ng_ipfw 4 ,
.Xr ng_ksocket 4 ,
.Xr ng_l2cap 4 ,
.Xr ng_l2tp 4 ,
.Xr ng_lmi 4 ,
.Xr ng_mppc 4 ,
+.Xr ng_nat 4 ,
.Xr ng_netflow 4 ,
.Xr ng_one2many 4 ,
+.Xr ng_patch 4 ,
.Xr ng_ppp 4 ,
.Xr ng_pppoe 4 ,
.Xr ng_pptpgre 4 ,
Modified: trunk/share/man/man4/netintro.4
===================================================================
--- trunk/share/man/man4/netintro.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/netintro.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1983, 1990, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,9 +31,9 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)netintro.4 8.2 (Berkeley) 11/30/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/netintro.4 230577 2012-01-26 10:43:40Z glebius $
.\"
-.Dd April 14, 2010
+.Dd January 26, 2012
.Dt NETINTRO 4
.Os
.Sh NAME
@@ -231,19 +232,6 @@
};
.Ed
.Pp
-Calls which are now deprecated are:
-.Bl -tag -width SIOCGIFBRDADDR
-.It Dv SIOCSIFADDR
-Set interface address for protocol family.
-Following the address assignment, the
-.Dq initialization
-routine for the interface is called.
-.It Dv SIOCSIFDSTADDR
-Set point to point address for protocol family and interface.
-.It Dv SIOCSIFBRDADDR
-Set broadcast address for protocol family and interface.
-.El
-.Pp
.Fn Ioctl
requests to obtain addresses and requests both to set and
retrieve other data are still fully supported
@@ -400,7 +388,7 @@
.El
.Bd -literal
/*
-* Structure used in SIOCAIFCONF request.
+* Structure used in SIOCAIFADDR request.
*/
struct ifaliasreq {
char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
Modified: trunk/share/man/man4/netmap.4
===================================================================
--- trunk/share/man/man4/netmap.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/netmap.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,4 +1,5 @@
-.\" Copyright (c) 2011 Matteo Landi, Luigi Rizzo, Universita` di Pisa
+.\" $MidnightBSD$
+.\" Copyright (c) 2011-2014 Matteo Landi, Luigi Rizzo, Universita` di Pisa
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -25,220 +26,632 @@
.\" This document is derived in part from the enet man page (enet.4)
.\" distributed with 4.3BSD Unix.
.\"
-.\" $MidnightBSD$
-.\" $Id: netmap.4,v 1.1 2012-12-29 16:29:33 laffer1 Exp $: stable/8/share/man/man4/bpf.4 181694 2008-08-13 17:45:06Z ed $
+.\" $FreeBSD: stable/10/share/man/man4/netmap.4 306378 2016-09-27 19:00:22Z pluknet $
.\"
-.Dd November 16, 2011
+.Dd February 13, 2014
.Dt NETMAP 4
.Os
.Sh NAME
.Nm netmap
.Nd a framework for fast packet I/O
+.br
+.Nm VALE
+.Nd a fast VirtuAl Local Ethernet using the netmap API
+.br
+.Nm netmap pipes
+.Nd a shared memory packet transport channel
.Sh SYNOPSIS
.Cd device netmap
.Sh DESCRIPTION
.Nm
-is a framework for fast and safe access to network devices
-(reaching 14.88 Mpps at less than 1 GHz).
+is a framework for extremely fast and efficient packet I/O
+for both userspace and kernel clients.
+It runs on FreeBSD and Linux,
+and includes
+.Nm VALE ,
+a very fast and modular in-kernel software switch/dataplane,
+and
+.Nm netmap pipes ,
+a shared memory packet transport channel.
+All these are accessed interchangeably with the same API.
+.Pp
+.Nm , VALE
+and
+.Nm netmap pipes
+are at least one order of magnitude faster than
+standard OS mechanisms
+(sockets, bpf, tun/tap interfaces, native switches, pipes),
+reaching 14.88 million packets per second (Mpps)
+with much less than one core on a 10 Gbit NIC,
+about 20 Mpps per core for VALE ports,
+and over 100 Mpps for netmap pipes.
+.Pp
+Userspace clients can dynamically switch NICs into
.Nm
-uses memory mapped buffers and metadata
-(buffer indexes and lengths) to communicate with the kernel,
-which is in charge of validating information through
-.Pa ioctl()
+mode and send and receive raw packets through
+memory mapped buffers.
+Similarly,
+.Nm VALE
+switch instances and ports, and
+.Nm netmap pipes
+can be created dynamically,
+providing high speed packet I/O between processes,
+virtual machines, NICs and the host stack.
+.Pp
+.Nm
+suports both non-blocking I/O through
+.Xr ioctls() ,
+synchronization and blocking I/O through a file descriptor
+and standard OS mechanisms such as
+.Xr select 2 ,
+.Xr poll 2 ,
+.Xr epoll 2 ,
+.Xr kqueue 2 .
+.Nm VALE
and
-.Pa select()/poll() .
+.Nm netmap pipes
+are implemented by a single kernel module, which also emulates the
.Nm
-can exploit the parallelism in multiqueue devices and
-multicore systems.
+API over standard drivers for devices without native
+.Nm
+support.
+For best performance,
+.Nm
+requires explicit support in device drivers.
.Pp
+In the rest of this (long) manual page we document
+various aspects of the
+.Nm
+and
+.Nm VALE
+architecture, features and usage.
.Pp
+.Sh ARCHITECTURE
.Nm
-requires explicit support in device drivers.
-For a list of supported devices, see the end of this manual page.
-.Sh OPERATION
+supports raw packet I/O through a
+.Em port ,
+which can be connected to a physical interface
+.Em ( NIC ) ,
+to the host stack,
+or to a
+.Nm VALE
+switch).
+Ports use preallocated circular queues of buffers
+.Em ( rings )
+residing in an mmapped region.
+There is one ring for each transmit/receive queue of a
+NIC or virtual port.
+An additional ring pair connects to the host stack.
+.Pp
+After binding a file descriptor to a port, a
.Nm
-clients must first open the
-.Pa open("/dev/netmap") ,
-and then issue an
-.Pa ioctl(...,NIOCREGIF,...)
-to bind the file descriptor to a network device.
+client can send or receive packets in batches through
+the rings, and possibly implement zero-copy forwarding
+between ports.
.Pp
-When a device is put in
+All NICs operating in
.Nm
-mode, its data path is disconnected from the host stack.
-The processes owning the file descriptor
-can exchange packets with the device, or with the host stack,
-through an mmapped memory region that contains pre-allocated
-buffers and metadata.
+mode use the same memory region,
+accessible to all processes who own
+.Nm /dev/netmap
+file descriptors bound to NICs.
+Independent
+.Nm VALE
+and
+.Nm netmap pipe
+ports
+by default use separate memory regions,
+but can be independently configured to share memory.
.Pp
+.Sh ENTERING AND EXITING NETMAP MODE
+The following section describes the system calls to create
+and control
+.Nm netmap
+ports (including
+.Nm VALE
+and
+.Nm netmap pipe
+ports).
+Simpler, higher level functions are described in section
+.Xr LIBRARIES .
+.Pp
+Ports and rings are created and controlled through a file descriptor,
+created by opening a special device
+.Dl fd = open("/dev/netmap");
+and then bound to a specific port with an
+.Dl ioctl(fd, NIOCREGIF, (struct nmreq *)arg);
+.Pp
+.Nm
+has multiple modes of operation controlled by the
+.Vt struct nmreq
+argument.
+.Va arg.nr_name
+specifies the port name, as follows:
+.Bl -tag -width XXXX
+.It Dv OS network interface name (e.g. 'em0', 'eth1', ... )
+the data path of the NIC is disconnected from the host stack,
+and the file descriptor is bound to the NIC (one or all queues),
+or to the host stack;
+.It Dv valeXXX:YYY (arbitrary XXX and YYY)
+the file descriptor is bound to port YYY of a VALE switch called XXX,
+both dynamically created if necessary.
+The string cannot exceed IFNAMSIZ characters, and YYY cannot
+be the name of any existing OS network interface.
+.El
+.Pp
+On return,
+.Va arg
+indicates the size of the shared memory region,
+and the number, size and location of all the
+.Nm
+data structures, which can be accessed by mmapping the memory
+.Dl char *mem = mmap(0, arg.nr_memsize, fd);
+.Pp
Non blocking I/O is done with special
-.Pa ioctl()'s ,
-whereas the file descriptor can be passed to
-.Pa select()/poll()
-to be notified about incoming packet or available transmit buffers.
-.Ss Data structures
-All data structures for all devices in
+.Xr ioctl 2
+.Xr select 2
+and
+.Xr poll 2
+on the file descriptor permit blocking I/O.
+.Xr epoll 2
+and
+.Xr kqueue 2
+are not supported on
.Nm
-mode are in a memory
-region shared by the kernel and all processes
-who open
-.Pa /dev/netmap
-(NOTE: visibility may be restricted in future implementations).
-All references between the shared data structure
-are relative (offsets or indexes). Some macros help converting
-them into actual pointers.
+file descriptors.
.Pp
-The data structures in shared memory are the following:
+While a NIC is in
+.Nm
+mode, the OS will still believe the interface is up and running.
+OS-generated packets for that NIC end up into a
+.Nm
+ring, and another ring is used to send packets into the OS network stack.
+A
+.Xr close 2
+on the file descriptor removes the binding,
+and returns the NIC to normal mode (reconnecting the data path
+to the host stack), or destroys the virtual port.
.Pp
+.Sh DATA STRUCTURES
+The data structures in the mmapped memory region are detailed in
+.Xr sys/net/netmap.h ,
+which is the ultimate reference for the
+.Nm
+API. The main structures and fields are indicated below:
.Bl -tag -width XXX
.It Dv struct netmap_if (one per interface)
-indicates the number of rings supported by an interface, their
-sizes, and the offsets of the
-.Pa netmap_rings
-associated to the interface.
-The offset of a
-.Pa struct netmap_if
-in the shared memory region is indicated by the
-.Pa nr_offset
-field in the structure returned by the
-.Pa NIOCREGIF
-(see below).
.Bd -literal
struct netmap_if {
- char ni_name[IFNAMSIZ]; /* name of the interface. */
- const u_int ni_num_queues; /* number of hw ring pairs */
- const ssize_t ring_ofs[]; /* offset of tx and rx rings */
+ ...
+ const uint32_t ni_flags; /* properties */
+ ...
+ const uint32_t ni_tx_rings; /* NIC tx rings */
+ const uint32_t ni_rx_rings; /* NIC rx rings */
+ uint32_t ni_bufs_head; /* head of extra bufs list */
+ ...
};
.Ed
+.Pp
+Indicates the number of available rings
+.Pa ( struct netmap_rings )
+and their position in the mmapped region.
+The number of tx and rx rings
+.Pa ( ni_tx_rings , ni_rx_rings )
+normally depends on the hardware.
+NICs also have an extra tx/rx ring pair connected to the host stack.
+.Em NIOCREGIF
+can also request additional unbound buffers in the same memory space,
+to be used as temporary storage for packets.
+.Pa ni_bufs_head
+contains the index of the first of these free rings,
+which are connected in a list (the first uint32_t of each
+buffer being the index of the next buffer in the list).
+A 0 indicates the end of the list.
+.Pp
.It Dv struct netmap_ring (one per ring)
-contains the index of the current read or write slot (cur),
-the number of slots available for reception or transmission (avail),
-and an array of
-.Pa slots
-describing the buffers.
-There is one ring pair for each of the N hardware ring pairs
-supported by the card (numbered 0..N-1), plus
-one ring pair (numbered N) for packets from/to the host stack.
.Bd -literal
struct netmap_ring {
- const ssize_t buf_ofs;
- const uint32_t num_slots; /* number of slots in the ring. */
- uint32_t avail; /* number of usable slots */
- uint32_t cur; /* 'current' index for the user side */
-
- const uint16_t nr_buf_size;
- uint16_t flags;
- struct netmap_slot slot[0]; /* array of slots. */
+ ...
+ const uint32_t num_slots; /* slots in each ring */
+ const uint32_t nr_buf_size; /* size of each buffer */
+ ...
+ uint32_t head; /* (u) first buf owned by user */
+ uint32_t cur; /* (u) wakeup position */
+ const uint32_t tail; /* (k) first buf owned by kernel */
+ ...
+ uint32_t flags;
+ struct timeval ts; /* (k) time of last rxsync() */
+ ...
+ struct netmap_slot slot[0]; /* array of slots */
}
.Ed
-.It Dv struct netmap_slot (one per packet)
-contains the metadata for a packet: a buffer index (buf_idx),
-a buffer length (len), and some flags.
+.Pp
+Implements transmit and receive rings, with read/write
+pointers, metadata and and an array of
+.Pa slots
+describing the buffers.
+.Pp
+.It Dv struct netmap_slot (one per buffer)
.Bd -literal
struct netmap_slot {
- uint32_t buf_idx; /* buffer index */
- uint16_t len; /* packet length */
- uint16_t flags; /* buf changed, etc. */
-#define NS_BUF_CHANGED 0x0001 /* must resync, buffer changed */
-#define NS_REPORT 0x0002 /* tell hw to report results
- * e.g. by generating an interrupt
- */
+ uint32_t buf_idx; /* buffer index */
+ uint16_t len; /* packet length */
+ uint16_t flags; /* buf changed, etc. */
+ uint64_t ptr; /* address for indirect buffers */
};
.Ed
+.Pp
+Describes a packet buffer, which normally is identified by
+an index and resides in the mmapped region.
.It Dv packet buffers
-are fixed size (approximately 2k) buffers allocated by the kernel
-that contain packet data. Buffers addresses are computed through
-macros.
+Fixed size (normally 2 KB) packet buffers allocated by the kernel.
.El
.Pp
-Some macros support the access to objects in the shared memory
-region. In particular:
+The offset of the
+.Pa struct netmap_if
+in the mmapped region is indicated by the
+.Pa nr_offset
+field in the structure returned by
+.Pa NIOCREGIF .
+From there, all other objects are reachable through
+relative references (offsets or indexes).
+Macros and functions in <net/netmap_user.h>
+help converting them into actual pointers:
+.Pp
+.Dl struct netmap_if *nifp = NETMAP_IF(mem, arg.nr_offset);
+.Dl struct netmap_ring *txr = NETMAP_TXRING(nifp, ring_index);
+.Dl struct netmap_ring *rxr = NETMAP_RXRING(nifp, ring_index);
+.Pp
+.Dl char *buf = NETMAP_BUF(ring, buffer_index);
+.Sh RINGS, BUFFERS AND DATA I/O
+.Va Rings
+are circular queues of packets with three indexes/pointers
+.Va ( head , cur , tail ) ;
+one slot is always kept empty.
+The ring size
+.Va ( num_slots )
+should not be assumed to be a power of two.
+.br
+(NOTE: older versions of netmap used head/count format to indicate
+the content of a ring).
+.Pp
+.Va head
+is the first slot available to userspace;
+.br
+.Va cur
+is the wakeup point:
+select/poll will unblock when
+.Va tail
+passes
+.Va cur ;
+.br
+.Va tail
+is the first slot reserved to the kernel.
+.Pp
+Slot indexes MUST only move forward;
+for convenience, the function
+.Dl nm_ring_next(ring, index)
+returns the next index modulo the ring size.
+.Pp
+.Va head
+and
+.Va cur
+are only modified by the user program;
+.Va tail
+is only modified by the kernel.
+The kernel only reads/writes the
+.Vt struct netmap_ring
+slots and buffers
+during the execution of a netmap-related system call.
+The only exception are slots (and buffers) in the range
+.Va tail\ . . . head-1 ,
+that are explicitly assigned to the kernel.
+.Pp
+.Ss TRANSMIT RINGS
+On transmit rings, after a
+.Nm
+system call, slots in the range
+.Va head\ . . . tail-1
+are available for transmission.
+User code should fill the slots sequentially
+and advance
+.Va head
+and
+.Va cur
+past slots ready to transmit.
+.Va cur
+may be moved further ahead if the user code needs
+more slots before further transmissions (see
+.Sx SCATTER GATHER I/O ) .
+.Pp
+At the next NIOCTXSYNC/select()/poll(),
+slots up to
+.Va head-1
+are pushed to the port, and
+.Va tail
+may advance if further slots have become available.
+Below is an example of the evolution of a TX ring:
+.Pp
.Bd -literal
-struct netmap_if *nifp;
-struct netmap_ring *txring = NETMAP_TXRING(nifp, i);
-struct netmap_ring *rxring = NETMAP_RXRING(nifp, i);
-int i = txring->slot[txring->cur].buf_idx;
-char *buf = NETMAP_BUF(txring, i);
+ after the syscall, slots between cur and tail are (a)vailable
+ head=cur tail
+ | |
+ v v
+ TX [.....aaaaaaaaaaa.............]
+
+ user creates new packets to (T)ransmit
+ head=cur tail
+ | |
+ v v
+ TX [.....TTTTTaaaaaa.............]
+
+ NIOCTXSYNC/poll()/select() sends packets and reports new slots
+ head=cur tail
+ | |
+ v v
+ TX [..........aaaaaaaaaaa........]
.Ed
-.Ss IOCTLS
.Pp
+select() and poll() wlll block if there is no space in the ring, i.e.
+.Dl ring->cur == ring->tail
+and return when new slots have become available.
+.Pp
+High speed applications may want to amortize the cost of system calls
+by preparing as many packets as possible before issuing them.
+.Pp
+A transmit ring with pending transmissions has
+.Dl ring->head != ring->tail + 1 (modulo the ring size).
+The function
+.Va int nm_tx_pending(ring)
+implements this test.
+.Pp
+.Ss RECEIVE RINGS
+On receive rings, after a
.Nm
-supports some ioctl() to synchronize the state of the rings
-between the kernel and the user processes, plus some
-to query and configure the interface.
-The former do not require any argument, whereas the latter
-use a
-.Pa struct netmap_req
-defined as follows:
+system call, the slots in the range
+.Va head\& . . . tail-1
+contain received packets.
+User code should process them and advance
+.Va head
+and
+.Va cur
+past slots it wants to return to the kernel.
+.Va cur
+may be moved further ahead if the user code wants to
+wait for more packets
+without returning all the previous slots to the kernel.
+.Pp
+At the next NIOCRXSYNC/select()/poll(),
+slots up to
+.Va head-1
+are returned to the kernel for further receives, and
+.Va tail
+may advance to report new incoming packets.
+.br
+Below is an example of the evolution of an RX ring:
.Bd -literal
+ after the syscall, there are some (h)eld and some (R)eceived slots
+ head cur tail
+ | | |
+ v v v
+ RX [..hhhhhhRRRRRRRR..........]
+
+ user advances head and cur, releasing some slots and holding others
+ head cur tail
+ | | |
+ v v v
+ RX [..*****hhhRRRRRR...........]
+
+ NICRXSYNC/poll()/select() recovers slots and reports new packets
+ head cur tail
+ | | |
+ v v v
+ RX [.......hhhRRRRRRRRRRRR....]
+.Ed
+.Pp
+.Sh SLOTS AND PACKET BUFFERS
+Normally, packets should be stored in the netmap-allocated buffers
+assigned to slots when ports are bound to a file descriptor.
+One packet is fully contained in a single buffer.
+.Pp
+The following flags affect slot and buffer processing:
+.Bl -tag -width XXX
+.It NS_BUF_CHANGED
+it MUST be used when the buf_idx in the slot is changed.
+This can be used to implement
+zero-copy forwarding, see
+.Sx ZERO-COPY FORWARDING .
+.Pp
+.It NS_REPORT
+reports when this buffer has been transmitted.
+Normally,
+.Nm
+notifies transmit completions in batches, hence signals
+can be delayed indefinitely. This flag helps detecting
+when packets have been send and a file descriptor can be closed.
+.It NS_FORWARD
+When a ring is in 'transparent' mode (see
+.Sx TRANSPARENT MODE ) ,
+packets marked with this flags are forwarded to the other endpoint
+at the next system call, thus restoring (in a selective way)
+the connection between a NIC and the host stack.
+.It NS_NO_LEARN
+tells the forwarding code that the SRC MAC address for this
+packet must not be used in the learning bridge code.
+.It NS_INDIRECT
+indicates that the packet's payload is in a user-supplied buffer,
+whose user virtual address is in the 'ptr' field of the slot.
+The size can reach 65535 bytes.
+.br
+This is only supported on the transmit ring of
+.Nm VALE
+ports, and it helps reducing data copies in the interconnection
+of virtual machines.
+.It NS_MOREFRAG
+indicates that the packet continues with subsequent buffers;
+the last buffer in a packet must have the flag clear.
+.El
+.Sh SCATTER GATHER I/O
+Packets can span multiple slots if the
+.Va NS_MOREFRAG
+flag is set in all but the last slot.
+The maximum length of a chain is 64 buffers.
+This is normally used with
+.Nm VALE
+ports when connecting virtual machines, as they generate large
+TSO segments that are not split unless they reach a physical device.
+.Pp
+NOTE: The length field always refers to the individual
+fragment; there is no place with the total length of a packet.
+.Pp
+On receive rings the macro
+.Va NS_RFRAGS(slot)
+indicates the remaining number of slots for this packet,
+including the current one.
+Slots with a value greater than 1 also have NS_MOREFRAG set.
+.Sh IOCTLS
+.Nm
+uses two ioctls (NIOCTXSYNC, NIOCRXSYNC)
+for non-blocking I/O. They take no argument.
+Two more ioctls (NIOCGINFO, NIOCREGIF) are used
+to query and configure ports, with the following argument:
+.Bd -literal
struct nmreq {
- char nr_name[IFNAMSIZ];
- uint32_t nr_offset; /* nifp offset in the shared region */
- uint32_t nr_memsize; /* size of the shared region */
- uint32_t nr_numdescs; /* descriptors per queue */
- uint16_t nr_numqueues;
- uint16_t nr_ringid; /* ring(s) we care about */
-#define NETMAP_HW_RING 0x4000 /* low bits indicate one hw ring */
-#define NETMAP_SW_RING 0x2000 /* we process the sw ring */
-#define NETMAP_NO_TX_POLL 0x1000 /* no gratuitous txsync on poll */
-#define NETMAP_RING_MASK 0xfff /* the actual ring number */
+ char nr_name[IFNAMSIZ]; /* (i) port name */
+ uint32_t nr_version; /* (i) API version */
+ uint32_t nr_offset; /* (o) nifp offset in mmap region */
+ uint32_t nr_memsize; /* (o) size of the mmap region */
+ uint32_t nr_tx_slots; /* (i/o) slots in tx rings */
+ uint32_t nr_rx_slots; /* (i/o) slots in rx rings */
+ uint16_t nr_tx_rings; /* (i/o) number of tx rings */
+ uint16_t nr_rx_rings; /* (i/o) number of tx rings */
+ uint16_t nr_ringid; /* (i/o) ring(s) we care about */
+ uint16_t nr_cmd; /* (i) special command */
+ uint16_t nr_arg1; /* (i/o) extra arguments */
+ uint16_t nr_arg2; /* (i/o) extra arguments */
+ uint32_t nr_arg3; /* (i/o) extra arguments */
+ uint32_t nr_flags /* (i/o) open mode */
+ ...
};
-
.Ed
-A device descriptor obtained through
+.Pp
+A file descriptor obtained through
.Pa /dev/netmap
-also supports the ioctl supported by network devices.
+also supports the ioctl supported by network devices, see
+.Xr netintro 4 .
.Pp
-The netmap-specific
-.Xr ioctl 2
-command codes below are defined in
-.In net/netmap.h
-and are:
.Bl -tag -width XXXX
.It Dv NIOCGINFO
-returns information about the interface named in nr_name.
-On return, nr_memsize indicates the size of the shared netmap
-memory region (this is device-independent),
-nr_numslots indicates how many buffers are in a ring,
-nr_numrings indicates the number of rings supported by the hardware.
+returns EINVAL if the named port does not support netmap.
+Otherwise, it returns 0 and (advisory) information
+about the port.
+Note that all the information below can change before the
+interface is actually put in netmap mode.
.Pp
-If the device does not support netmap, the ioctl returns EINVAL.
+.Bl -tag -width XX
+.It Pa nr_memsize
+indicates the size of the
+.Nm
+memory region. NICs in
+.Nm
+mode all share the same memory region,
+whereas
+.Nm VALE
+ports have independent regions for each port.
+.It Pa nr_tx_slots , nr_rx_slots
+indicate the size of transmit and receive rings.
+.It Pa nr_tx_rings , nr_rx_rings
+indicate the number of transmit
+and receive rings.
+Both ring number and sizes may be configured at runtime
+using interface-specific functions (e.g.
+.Xr ethtool
+).
+.El
.It Dv NIOCREGIF
-puts the interface named in nr_name into netmap mode, disconnecting
-it from the host stack, and/or defines which rings are controlled
-through this file descriptor.
-On return, it gives the same info as NIOCGINFO, and nr_ringid
-indicates the identity of the rings controlled through the file
+binds the port named in
+.Va nr_name
+to the file descriptor. For a physical device this also switches it into
+.Nm
+mode, disconnecting
+it from the host stack.
+Multiple file descriptors can be bound to the same port,
+with proper synchronization left to the user.
+.Pp
+.Dv NIOCREGIF can also bind a file descriptor to one endpoint of a
+.Em netmap pipe ,
+consisting of two netmap ports with a crossover connection.
+A netmap pipe share the same memory space of the parent port,
+and is meant to enable configuration where a master process acts
+as a dispatcher towards slave processes.
+.Pp
+To enable this function, the
+.Pa nr_arg1
+field of the structure can be used as a hint to the kernel to
+indicate how many pipes we expect to use, and reserve extra space
+in the memory region.
+.Pp
+On return, it gives the same info as NIOCGINFO,
+with
+.Pa nr_ringid
+and
+.Pa nr_flags
+indicating the identity of the rings controlled through the file
descriptor.
.Pp
-Possible values for nr_ringid are
+.Va nr_flags
+.Va nr_ringid
+selects which rings are controlled through this file descriptor.
+Possible values of
+.Pa nr_flags
+are indicated below, together with the naming schemes
+that application libraries (such as the
+.Nm nm_open
+indicated below) can use to indicate the specific set of rings.
+In the example below, "netmap:foo" is any valid netmap port name.
+.Pp
.Bl -tag -width XXXXX
-.It 0
-default, all hardware rings
-.It NETMAP_SW_RING
-the ``host rings'' connecting to the host stack
-.It NETMAP_HW_RING + i
-the i-th hardware ring
+.It NR_REG_ALL_NIC "netmap:foo"
+(default) all hardware ring pairs
+.It NR_REG_SW_NIC "netmap:foo^"
+the ``host rings'', connecting to the host stack.
+.It NR_RING_NIC_SW "netmap:foo+"
+all hardware rings and the host rings
+.It NR_REG_ONE_NIC "netmap:foo-i"
+only the i-th hardware ring pair, where the number is in
+.Pa nr_ringid ;
+.It NR_REG_PIPE_MASTER "netmap:foo{i"
+the master side of the netmap pipe whose identifier (i) is in
+.Pa nr_ringid ;
+.It NR_REG_PIPE_SLAVE "netmap:foo}i"
+the slave side of the netmap pipe whose identifier (i) is in
+.Pa nr_ringid .
+.Pp
+The identifier of a pipe must be thought as part of the pipe name,
+and does not need to be sequential. On return the pipe
+will only have a single ring pair with index 0,
+irrespective of the value of i.
.El
+.Pp
By default, a
-.Nm poll
+.Xr poll 2
or
-.Nm select
+.Xr select 2
call pushes out any pending packets on the transmit ring, even if
no write events are specified.
The feature can be disabled by or-ing
-.Nm NETMAP_NO_TX_SYNC
-to nr_ringid.
-But normally you should keep this feature unless you are using
-separate file descriptors for the send and receive rings, because
-otherwise packets are pushed out only if NETMAP_TXSYNC is called,
-or the send queue is full.
+.Va NETMAP_NO_TX_SYNC
+to the value written to
+.Va nr_ringid.
+When this feature is used,
+packets are transmitted only on
+.Va ioctl(NIOCTXSYNC)
+or select()/poll() are called with a write event (POLLOUT/wfdset) or a full ring.
.Pp
-.Pa NIOCREGIF
-can be used multiple times to change the association of a
-file descriptor to a ring pair, always within the same device.
-.It Dv NIOCUNREGIF
-brings an interface back to normal mode.
+When registering a virtual interface that is dynamically created to a
+.Xr vale 4
+switch, we can specify the desired number of rings (1 by default,
+and currently up to 16) on it using nr_tx_rings and nr_rx_rings fields.
.It Dv NIOCTXSYNC
tells the hardware of new packets to transmit, and updates the
number of slots available for transmission.
@@ -246,54 +659,418 @@
tells the hardware of consumed packets, and asks for newly available
packets.
.El
-.Ss SYSTEM CALLS
+.Sh SELECT, POLL, EPOLL, KQUEUE.
+.Xr select 2
+and
+.Xr poll 2
+on a
.Nm
+file descriptor process rings as indicated in
+.Sx TRANSMIT RINGS
+and
+.Sx RECEIVE RINGS ,
+respectively when write (POLLOUT) and read (POLLIN) events are requested.
+Both block if no slots are available in the ring
+.Va ( ring->cur == ring->tail ) .
+Depending on the platform,
+.Xr epoll 2
+and
+.Xr kqueue 2
+are supported too.
+.Pp
+Packets in transmit rings are normally pushed out
+(and buffers reclaimed) even without
+requesting write events. Passing the NETMAP_NO_TX_SYNC flag to
+.Em NIOCREGIF
+disables this feature.
+By default, receive rings are processed only if read
+events are requested. Passing the NETMAP_DO_RX_SYNC flag to
+.Em NIOCREGIF updates receive rings even without read events.
+Note that on epoll and kqueue, NETMAP_NO_TX_SYNC and NETMAP_DO_RX_SYNC
+only have an effect when some event is posted for the file descriptor.
+.Sh LIBRARIES
+The
+.Nm
+API is supposed to be used directly, both because of its simplicity and
+for efficient integration with applications.
+.Pp
+For conveniency, the
+.Va <net/netmap_user.h>
+header provides a few macros and functions to ease creating
+a file descriptor and doing I/O with a
+.Nm
+port. These are loosely modeled after the
+.Xr pcap 3
+API, to ease porting of libpcap-based applications to
+.Nm .
+To use these extra functions, programs should
+.Dl #define NETMAP_WITH_LIBS
+before
+.Dl #include <net/netmap_user.h>
+.Pp
+The following functions are available:
+.Bl -tag -width XXXXX
+.It Va struct nm_desc * nm_open(const char *ifname, const struct nmreq *req, uint64_t flags, const struct nm_desc *arg)
+similar to
+.Xr pcap_open ,
+binds a file descriptor to a port.
+.Bl -tag -width XX
+.It Va ifname
+is a port name, in the form "netmap:XXX" for a NIC and "valeXXX:YYY" for a
+.Nm VALE
+port.
+.It Va req
+provides the initial values for the argument to the NIOCREGIF ioctl.
+The nm_flags and nm_ringid values are overwritten by parsing
+ifname and flags, and other fields can be overridden through
+the other two arguments.
+.It Va arg
+points to a struct nm_desc containing arguments (e.g. from a previously
+open file descriptor) that should override the defaults.
+The fields are used as described below
+.It Va flags
+can be set to a combination of the following flags:
+.Va NETMAP_NO_TX_POLL ,
+.Va NETMAP_DO_RX_POLL
+(copied into nr_ringid);
+.Va NM_OPEN_NO_MMAP (if arg points to the same memory region,
+avoids the mmap and uses the values from it);
+.Va NM_OPEN_IFNAME (ignores ifname and uses the values in arg);
+.Va NM_OPEN_ARG1 ,
+.Va NM_OPEN_ARG2 ,
+.Va NM_OPEN_ARG3 (uses the fields from arg);
+.Va NM_OPEN_RING_CFG (uses the ring number and sizes from arg).
+.El
+.It Va int nm_close(struct nm_desc *d)
+closes the file descriptor, unmaps memory, frees resources.
+.It Va int nm_inject(struct nm_desc *d, const void *buf, size_t size)
+similar to pcap_inject(), pushes a packet to a ring, returns the size
+of the packet is successful, or 0 on error;
+.It Va int nm_dispatch(struct nm_desc *d, int cnt, nm_cb_t cb, u_char *arg)
+similar to pcap_dispatch(), applies a callback to incoming packets
+.It Va u_char * nm_nextpkt(struct nm_desc *d, struct nm_pkthdr *hdr)
+similar to pcap_next(), fetches the next packet
+.Pp
+.El
+.Sh SUPPORTED DEVICES
+.Nm
+natively supports the following devices:
+.Pp
+On FreeBSD:
+.Xr em 4 ,
+.Xr igb 4 ,
+.Xr ixgbe 4 ,
+.Xr lem 4 ,
+.Xr re 4 .
+.Pp
+On Linux
+.Xr e1000 4 ,
+.Xr e1000e 4 ,
+.Xr igb 4 ,
+.Xr ixgbe 4 ,
+.Xr mlx4 4 ,
+.Xr forcedeth 4 ,
+.Xr r8169 4 .
+.Pp
+NICs without native support can still be used in
+.Nm
+mode through emulation. Performance is inferior to native netmap
+mode but still significantly higher than sockets, and approaching
+that of in-kernel solutions such as Linux's
+.Xr pktgen .
+.Pp
+Emulation is also available for devices with native netmap support,
+which can be used for testing or performance comparison.
+The sysctl variable
+.Va dev.netmap.admode
+globally controls how netmap mode is implemented.
+.Sh SYSCTL VARIABLES AND MODULE PARAMETERS
+Some aspect of the operation of
+.Nm
+are controlled through sysctl variables on FreeBSD
+.Em ( dev.netmap.* )
+and module parameters on Linux
+.Em ( /sys/module/netmap_lin/parameters/* ) :
+.Pp
+.Bl -tag -width indent
+.It Va dev.netmap.admode: 0
+Controls the use of native or emulated adapter mode.
+0 uses the best available option, 1 forces native and
+fails if not available, 2 forces emulated hence never fails.
+.It Va dev.netmap.generic_ringsize: 1024
+Ring size used for emulated netmap mode
+.It Va dev.netmap.generic_mit: 100000
+Controls interrupt moderation for emulated mode
+.It Va dev.netmap.mmap_unreg: 0
+.It Va dev.netmap.fwd: 0
+Forces NS_FORWARD mode
+.It Va dev.netmap.flags: 0
+.It Va dev.netmap.txsync_retry: 2
+.It Va dev.netmap.no_pendintr: 1
+Forces recovery of transmit buffers on system calls
+.It Va dev.netmap.mitigate: 1
+Propagates interrupt mitigation to user processes
+.It Va dev.netmap.no_timestamp: 0
+Disables the update of the timestamp in the netmap ring
+.It Va dev.netmap.verbose: 0
+Verbose kernel messages
+.It Va dev.netmap.buf_num: 163840
+.It Va dev.netmap.buf_size: 2048
+.It Va dev.netmap.ring_num: 200
+.It Va dev.netmap.ring_size: 36864
+.It Va dev.netmap.if_num: 100
+.It Va dev.netmap.if_size: 1024
+Sizes and number of objects (netmap_if, netmap_ring, buffers)
+for the global memory region. The only parameter worth modifying is
+.Va dev.netmap.buf_num
+as it impacts the total amount of memory used by netmap.
+.It Va dev.netmap.buf_curr_num: 0
+.It Va dev.netmap.buf_curr_size: 0
+.It Va dev.netmap.ring_curr_num: 0
+.It Va dev.netmap.ring_curr_size: 0
+.It Va dev.netmap.if_curr_num: 0
+.It Va dev.netmap.if_curr_size: 0
+Actual values in use.
+.It Va dev.netmap.bridge_batch: 1024
+Batch size used when moving packets across a
+.Nm VALE
+switch. Values above 64 generally guarantee good
+performance.
+.El
+.Sh SYSTEM CALLS
+.Nm
uses
-.Nm select
+.Xr select 2 ,
+.Xr poll 2 ,
+.Xr epoll
and
-.Nm poll
-to wake up processes when significant events occur.
+.Xr kqueue
+to wake up processes when significant events occur, and
+.Xr mmap 2
+to map memory.
+.Xr ioctl 2
+is used to configure ports and
+.Nm VALE switches .
+.Pp
+Applications may need to create threads and bind them to
+specific cores to improve performance, using standard
+OS primitives, see
+.Xr pthread 3 .
+In particular,
+.Xr pthread_setaffinity_np 3
+may be of use.
+.Sh CAVEATS
+No matter how fast the CPU and OS are,
+achieving line rate on 10G and faster interfaces
+requires hardware with sufficient performance.
+Several NICs are unable to sustain line rate with
+small packet sizes. Insufficient PCIe or memory bandwidth
+can also cause reduced performance.
+.Pp
+Another frequent reason for low performance is the use
+of flow control on the link: a slow receiver can limit
+the transmit speed.
+Be sure to disable flow control when running high
+speed experiments.
+.Pp
+.Ss SPECIAL NIC FEATURES
+.Nm
+is orthogonal to some NIC features such as
+multiqueue, schedulers, packet filters.
+.Pp
+Multiple transmit and receive rings are supported natively
+and can be configured with ordinary OS tools,
+such as
+.Xr ethtool
+or
+device-specific sysctl variables.
+The same goes for Receive Packet Steering (RPS)
+and filtering of incoming traffic.
+.Pp
+.Nm
+.Em does not use
+features such as
+.Em checksum offloading , TCP segmentation offloading ,
+.Em encryption , VLAN encapsulation/decapsulation ,
+etc. .
+When using netmap to exchange packets with the host stack,
+make sure to disable these features.
.Sh EXAMPLES
+.Ss TEST PROGRAMS
+.Nm
+comes with a few programs that can be used for testing or
+simple applications.
+See the
+.Va examples/
+directory in
+.Nm
+distributions, or
+.Va tools/tools/netmap/
+directory in FreeBSD distributions.
+.Pp
+.Xr pkt-gen
+is a general purpose traffic source/sink.
+.Pp
+As an example
+.Dl pkt-gen -i ix0 -f tx -l 60
+can generate an infinite stream of minimum size packets, and
+.Dl pkt-gen -i ix0 -f rx
+is a traffic sink.
+Both print traffic statistics, to help monitor
+how the system performs.
+.Pp
+.Xr pkt-gen
+has many options can be uses to set packet sizes, addresses,
+rates, and use multiple send/receive threads and cores.
+.Pp
+.Xr bridge
+is another test program which interconnects two
+.Nm
+ports. It can be used for transparent forwarding between
+interfaces, as in
+.Dl bridge -i ix0 -i ix1
+or even connect the NIC to the host stack using netmap
+.Dl bridge -i ix0 -i ix0
+.Ss USING THE NATIVE API
The following code implements a traffic generator
.Pp
.Bd -literal -compact
-#include <net/netmap.h>
#include <net/netmap_user.h>
-struct netmap_if *nifp;
-struct netmap_ring *ring;
-struct netmap_request nmr;
+...
+void sender(void)
+{
+ struct netmap_if *nifp;
+ struct netmap_ring *ring;
+ struct nmreq nmr;
+ struct pollfd fds;
-fd = open("/dev/netmap", O_RDWR);
-bzero(&nmr, sizeof(nmr));
-strcpy(nmr.nm_name, "ix0");
-ioctl(fd, NIOCREG, &nmr);
-p = mmap(0, nmr.memsize, fd);
-nifp = NETMAP_IF(p, nmr.offset);
-ring = NETMAP_TXRING(nifp, 0);
-fds.fd = fd;
-fds.events = POLLOUT;
-for (;;) {
- poll(list, 1, -1);
- while (ring->avail-- > 0) {
- i = ring->cur;
- buf = NETMAP_BUF(ring, ring->slot[i].buf_index);
- ... prepare packet in buf ...
- ring->slot[i].len = ... packet length ...
- ring->cur = NETMAP_RING_NEXT(ring, i);
+ fd = open("/dev/netmap", O_RDWR);
+ bzero(&nmr, sizeof(nmr));
+ strcpy(nmr.nr_name, "ix0");
+ nmr.nm_version = NETMAP_API;
+ ioctl(fd, NIOCREGIF, &nmr);
+ p = mmap(0, nmr.nr_memsize, fd);
+ nifp = NETMAP_IF(p, nmr.nr_offset);
+ ring = NETMAP_TXRING(nifp, 0);
+ fds.fd = fd;
+ fds.events = POLLOUT;
+ for (;;) {
+ poll(&fds, 1, -1);
+ while (!nm_ring_empty(ring)) {
+ i = ring->cur;
+ buf = NETMAP_BUF(ring, ring->slot[i].buf_index);
+ ... prepare packet in buf ...
+ ring->slot[i].len = ... packet length ...
+ ring->head = ring->cur = nm_ring_next(ring, i);
+ }
}
}
.Ed
-.Sh SUPPORTED INTERFACES
+.Ss HELPER FUNCTIONS
+A simple receiver can be implemented using the helper functions
+.Bd -literal -compact
+#define NETMAP_WITH_LIBS
+#include <net/netmap_user.h>
+...
+void receiver(void)
+{
+ struct nm_desc *d;
+ struct pollfd fds;
+ u_char *buf;
+ struct nm_pkthdr h;
+ ...
+ d = nm_open("netmap:ix0", NULL, 0, 0);
+ fds.fd = NETMAP_FD(d);
+ fds.events = POLLIN;
+ for (;;) {
+ poll(&fds, 1, -1);
+ while ( (buf = nm_nextpkt(d, &h)) )
+ consume_pkt(buf, h->len);
+ }
+ nm_close(d);
+}
+.Ed
+.Ss ZERO-COPY FORWARDING
+Since physical interfaces share the same memory region,
+it is possible to do packet forwarding between ports
+swapping buffers. The buffer from the transmit ring is used
+to replenish the receive ring:
+.Bd -literal -compact
+ uint32_t tmp;
+ struct netmap_slot *src, *dst;
+ ...
+ src = &src_ring->slot[rxr->cur];
+ dst = &dst_ring->slot[txr->cur];
+ tmp = dst->buf_idx;
+ dst->buf_idx = src->buf_idx;
+ dst->len = src->len;
+ dst->flags = NS_BUF_CHANGED;
+ src->buf_idx = tmp;
+ src->flags = NS_BUF_CHANGED;
+ rxr->head = rxr->cur = nm_ring_next(rxr, rxr->cur);
+ txr->head = txr->cur = nm_ring_next(txr, txr->cur);
+ ...
+.Ed
+.Ss ACCESSING THE HOST STACK
+The host stack is for all practical purposes just a regular ring pair,
+which you can access with the netmap API (e.g. with
+.Dl nm_open("netmap:eth0^", ... ) ;
+All packets that the host would send to an interface in
.Nm
-supports the following interfaces:
-.Xr em 4 ,
-.Xr ixgbe 4 ,
-.Xr re 4 ,
+mode end up into the RX ring, whereas all packets queued to the
+TX ring are send up to the host stack.
+.Ss VALE SWITCH
+A simple way to test the performance of a
+.Nm VALE
+switch is to attach a sender and a receiver to it,
+e.g. running the following in two different terminals:
+.Dl pkt-gen -i vale1:a -f rx # receiver
+.Dl pkt-gen -i vale1:b -f tx # sender
+The same example can be used to test netmap pipes, by simply
+changing port names, e.g.
+.Dl pkt-gen -i vale:x{3 -f rx # receiver on the master side
+.Dl pkt-gen -i vale:x}3 -f tx # sender on the slave side
+.Pp
+The following command attaches an interface and the host stack
+to a switch:
+.Dl vale-ctl -h vale2:em0
+Other
+.Nm
+clients attached to the same switch can now communicate
+with the network card or the host.
+.Pp
+.Sh SEE ALSO
+.Pp
+http://info.iet.unipi.it/~luigi/netmap/
+.Pp
+Luigi Rizzo, Revisiting network I/O APIs: the netmap framework,
+Communications of the ACM, 55 (3), pp.45-51, March 2012
+.Pp
+Luigi Rizzo, netmap: a novel framework for fast packet I/O,
+Usenix ATC'12, June 2012, Boston
+.Pp
+Luigi Rizzo, Giuseppe Lettieri,
+VALE, a switched ethernet for virtual machines,
+ACM CoNEXT'12, December 2012, Nice
+.Pp
+Luigi Rizzo, Giuseppe Lettieri, Vincenzo Maffione,
+Speeding up packet I/O in virtual machines,
+ACM/IEEE ANCS'13, October 2013, San Jose
.Sh AUTHORS
+.An -nosplit
The
.Nm
-framework has been designed and implemented by
-.An Luigi Rizzo
+framework has been originally designed and implemented at the
+Universita` di Pisa in 2011 by
+.An Luigi Rizzo ,
+and further extended with help from
+.An Matteo Landi ,
+.An Gaetano Catalli ,
+.An Giuseppe Lettieri ,
+.An Vincenzo Maffione .
+.Pp
+.Nm
and
-.An Matteo Landi
-in 2011 at the Universita` di Pisa.
+.Nm VALE
+have been funded by the European Commission within FP7 Projects
+CHANGE (257422) and OPENLAB (287581).
Modified: trunk/share/man/man4/nfe.4
===================================================================
--- trunk/share/man/man4/nfe.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nfe.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" $OpenBSD: nfe.4,v 1.7 2006/02/28 08:13:47 jsg Exp $
.\"
.\" Copyright (c) 2006 Jonathan Gray <jsg at openbsd.org>
@@ -14,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nfe.4 217870 2011-01-26 01:07:56Z dougb $
.\"
.Dd January 15, 2011
.Dt NFE 4
Modified: trunk/share/man/man4/nfsmb.4
===================================================================
--- trunk/share/man/man4/nfsmb.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nfsmb.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2005 Christian Brueffer
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nfsmb.4 162871 2006-09-30 15:14:49Z ru $
.\"
.Dd December 31, 2005
.Dt NFSMB 4
Modified: trunk/share/man/man4/ng_UI.4
===================================================================
--- trunk/share/man/man4/ng_UI.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_UI.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_UI.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_UI.8,v 1.4 1999/01/25 02:37:56 archie Exp $
.\"
.Dd January 19, 1999
@@ -65,12 +66,12 @@
hook.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobar
-.It Dv downstream
+.Bl -tag -width ".Va downstream"
+.It Va downstream
Downstream connection.
Packets on this side of the node have a 0x03 as
their first byte.
-.It Dv upstream
+.It Va upstream
Upstream connection.
Packets on this side of the node have the
initial 0x03 byte stripped off.
Modified: trunk/share/man/man4/ng_async.4
===================================================================
--- trunk/share/man/man4/ng_async.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_async.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,10 +33,10 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_async.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_async.8,v 1.6 1999/01/25 23:46:25 archie Exp $
.\"
-.Dd January 19, 1999
+.Dd November 13, 2012
.Dt NG_ASYNC 4
.Os
.Sh NAME
@@ -88,13 +89,13 @@
idle time.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobar
-.It Dv async
+.Bl -tag -width ".Va async"
+.It Va async
Asynchronous connection.
Typically this hook would be connected to a
.Xr ng_tty 4
node, which handles transmission of serial data over a tty device.
-.It Dv sync
+.It Va sync
Synchronous connection.
This hook sends and receives synchronous frames.
For PPP, these frames should contain address, control, and protocol fields,
@@ -106,24 +107,17 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_ASYNC_CMD_GET_STATS
-This command returns a
-.Dv "struct ng_async_stat"
-containing node statistics for packet, octet, and error counts.
-.It Dv NGM_ASYNC_CMD_CLR_STATS
-Clears the node statistics.
-.It Dv NGM_ASYNC_CMD_SET_CONFIG
+.It Dv NGM_ASYNC_CMD_SET_CONFIG Pq Ic setconfig
Sets the node configuration, which is described by a
.Dv "struct ng_async_cfg" :
.Bd -literal -offset 4n
struct ng_async_cfg {
- u_char enabled; /* Turn encoding on/off */
- u_int16_t amru; /* Max receive async frame len */
- u_int16_t smru; /* Max receive sync frame len */
- u_int32_t accm; /* ACCM encoding */
+ u_char enabled; /* Turn encoding on/off */
+ uint16_t amru; /* Max receive async frame length */
+ uint16_t smru; /* Max receive sync frame length */
+ uint32_t accm; /* ACCM encoding */
};
.Ed
-.Pp
The
.Dv enabled
field enables or disables all encoding/decoding functions (default disabled).
@@ -142,8 +136,15 @@
.Dv accm
field is the asynchronous character control map, which controls the escaping
of characters 0x00 thorough 0x1f (default 0xffffffff).
-.It Dv NGM_ASYNC_CMD_GET_CONFIG
+.It Dv NGM_ASYNC_CMD_GET_CONFIG Pq Ic getconfig
This command returns the current configuration structure.
+.It Dv NGM_ASYNC_CMD_GET_STATS Pq Ic getstats
+This command returns a
+.Dv "struct ng_async_stat"
+containing node statistics for packet, octet, and error counts.
+.It Dv NGM_ASYNC_CMD_CLR_STATS Pq Ic clrstats
+Clears the node statistics.
+.Pp
.El
.Sh SHUTDOWN
This node shuts down upon receipt of a
Modified: trunk/share/man/man4/ng_atm.4
===================================================================
--- trunk/share/man/man4/ng_atm.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_atm.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001-2003
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
@@ -26,11 +27,11 @@
.\"
.\" Author: Hartmut Brandt <harti at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_atm.4 242475 2012-11-02 13:54:06Z glebius $
.\"
.\" ng_atm(4) man page
.\"
-.Dd June 24, 2003
+.Dd November 2, 2012
.Dt NG_ATM 4
.Os
.Sh NAME
@@ -151,23 +152,23 @@
.Sh CONTROL MESSAGES
This node type supports the generic messages plus the following:
.Bl -tag -width 4n
-.It Dv NGM_ATM_GET_IFNAME
+.It Dv NGM_ATM_GET_IFNAME Pq Ic getifname
Return the name of the interface as a
.Dv NUL Ns
-terminated string.
This is normally the same name as that of the node.
-.It Dv NGM_ATM_GET_CONFIG
+.It Dv NGM_ATM_GET_CONFIG Pq Ic getconfig
Returns a structure defining the configuration of the interface:
.Bd -literal
-struct ng_atm_config {
+struct ngm_atm_config {
uint32_t pcr; /* peak cell rate */
- uint32_t maxvpi; /* maximum vpi */
- uint32_t maxvci; /* maximum vci */
+ uint32_t vpi_bits; /* number of active VPI bits */
+ uint32_t vci_bits; /* number of active VCI bits */
uint32_t max_vpcs; /* maximum number of VPCs */
uint32_t max_vccs; /* maximum number of VCCs */
};
.Ed
-.It Dv NGM_ATM_GET_VCCS
+.It Dv NGM_ATM_GET_VCCS Pq Ic getvccs
Returns the table of open VCCs from the driver.
This table consists of
a header and a variable sized array of entries, one for each open VCC:
@@ -190,7 +191,7 @@
uint32_t pcr; /* 24bit: Peak Cell Rate */
uint32_t scr; /* 24bit: VBR Sustainable Cell Rate */
uint32_t mbs; /* 24bit: VBR Maximum burst size */
- uint32_t mcr; /* 24bit: MCR */
+ uint32_t mcr; /* 24bit: ABR/VBR/UBR+MCR MCR */
uint32_t icr; /* 24bit: ABR ICR */
uint32_t tbe; /* 24bit: ABR TBE (1...2^24-1) */
uint8_t nrm; /* 3bit: ABR Nrm */
@@ -264,23 +265,23 @@
.It Dv ATMIO_TRAFFIC_ABR
.It Dv ATMIO_TRAFFIC_VBR
.El
-.It Dv NGM_ATM_CPCS_INIT
+.It Dv NGM_ATM_CPCS_INIT Pq Ic cpcsinit
Initialize a VCC for sending and receiving.
The argument is a structure:
.Bd -literal
-struct ng_atm_cpcs_init {
+struct ngm_atm_cpcs_init {
char name[NG_HOOKSIZ];
- uint32_t flags; /* flags. (if_natmio.h) */
+ uint32_t flags; /* flags. (if_atm.h) */
uint16_t vci; /* VCI to open */
uint16_t vpi; /* VPI to open */
uint16_t rmtu; /* receive maximum PDU */
uint16_t tmtu; /* transmit maximum PDU */
- uint8_t aal; /* AAL type (if_natmio.h) */
- uint8_t traffic; /* traffic type (if_natmio.h) */
+ uint8_t aal; /* AAL type (if_atm.h) */
+ uint8_t traffic; /* traffic type (if_atm.h) */
uint32_t pcr; /* Peak cell rate */
- uint32_t scr; /* Sustainable cell rate */
- uint32_t mbs; /* Maximum burst size */
- uint32_t mcr; /* Minimum cell rate */
+ uint32_t scr; /* VBR: Sustainable cell rate */
+ uint32_t mbs; /* VBR: Maximum burst rate */
+ uint32_t mcr; /* UBR+: Minimum cell rate */
uint32_t icr; /* ABR: Initial cell rate */
uint32_t tbe; /* ABR: Transmit buffer exposure */
uint8_t nrm; /* ABR: Nrm */
@@ -316,14 +317,25 @@
field
contains the flags (see above) and the other fields describe the
type of traffic.
-.It Dv NGM_ATM_CPCS_TERM
+.It Dv NGM_ATM_CPCS_TERM Pq Ic cpcsterm
Stop sending and receiving on the indicated hook.
The argument is a
.Bd -literal
-struct ng_atm_cpcs_term {
+struct ngm_atm_cpcs_term {
char name[NG_HOOKSIZ];
};
.Ed
+.It Dv NGM_ATM_GET_STATS Pq Ic getstats
+This command returns a message, containing node statistics. The
+structure of the message is:
+.Bd -literal
+struct ngm_atm_stats {
+ uint64_t in_packets;
+ uint64_t in_errors;
+ uint64_t out_packets;
+ uint64_t out_errors;
+};
+.Ed
.El
.Sh MANAGEMENT MESSAGES
If the
@@ -333,28 +345,7 @@
received by the peer node with a cookie of
.Dv NG_ATM_COOKIE .
.Bl -tag -width 4n
-.It Dv NGM_ATM_CARRIER_CHANGE
-The carrier state of the ATM physical interface has changed.
-The message has the following structure:
-.Bd -literal
-struct ng_atm_carrier_change {
- uint32_t node;
- uint32_t state;
-};
-.Ed
-.Pp
-The
-.Va node
-field
-is the node ID of the ATM node.
-This can be used by the managing entity
-(for example
-.Xr ilmid 8 )
-to manage several interfaces at the same time through the same node.
-The
-.Va state
-field is 1 if the carrier was detected, and 0 if it was lost.
-.It Dv NGM_ATM_VCC_CHANGE
+.It Dv NGM_ATM_VCC_CHANGE Pq Ic vcc_change
A permanent VCC has been added, deleted or changed.
This is used by
.Xr ilmid 8
@@ -361,7 +352,7 @@
to generate the appropriate ILMI traps.
The structure of the message is:
.Bd -literal
-struct ng_atm_vcc_change {
+struct ngm_atm_vcc_change {
uint32_t node;
uint16_t vci;
uint8_t vpi;
Modified: trunk/share/man/man4/ng_atmllc.4
===================================================================
--- trunk/share/man/man4/ng_atmllc.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_atmllc.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2004 Benno Rice <benno at FreeBSD.org>
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_atmllc.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd March 8, 2004
.Dt NG_ATMLLC 4
@@ -60,7 +61,7 @@
hook.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width indent
+.Bl -tag -width ".Va ether"
.It Va atm
ATM connection.
Typically, this hook would be connected to a
Modified: trunk/share/man/man4/ng_atmpif.4
===================================================================
--- trunk/share/man/man4/ng_atmpif.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_atmpif.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001-2003
.\" Harti Brandt.
Modified: trunk/share/man/man4/ng_bluetooth.4
===================================================================
--- trunk/share/man/man4/ng_bluetooth.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_bluetooth.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin at yahoo.com>
.\" All rights reserved.
.\"
@@ -22,8 +23,8 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: ng_bluetooth.4,v 1.2 2012-12-29 16:29:12 laffer1 Exp $
-.\" $MidnightBSD$
+.\" $Id: ng_bluetooth.4,v 1.3 2003/05/21 19:37:35 max Exp $
+.\" $FreeBSD: stable/10/share/man/man4/ng_bluetooth.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd November 9, 2002
.Dt NG_BLUETOOTH 4
@@ -43,7 +44,7 @@
.Ss Bluetooth Variables
Below is the description of default variables.
Each Bluetooth module might add its own variables to the tree.
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Va net.bluetooth.version
A read-only integer variable that shows the current version of the
Bluetooth stack.
Modified: trunk/share/man/man4/ng_bpf.4
===================================================================
--- trunk/share/man/man4/ng_bpf.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_bpf.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,10 +33,10 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_bpf.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_bpf.8,v 1.2 1999/12/03 01:57:12 archie Exp $
.\"
-.Dd May 30, 2007
+.Dd November 13, 2012
.Dt NG_BPF 4
.Os
.Sh NAME
@@ -81,7 +82,7 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_BPF_SET_PROGRAM
+.It Dv NGM_BPF_SET_PROGRAM Pq Ic setprogram
This command sets the filter program that will be applied to incoming
data on a hook.
The following structure must be supplied as an argument:
@@ -90,7 +91,7 @@
char thisHook[NG_HOOKSIZ]; /* name of hook */
char ifMatch[NG_HOOKSIZ]; /* match dest hook */
char ifNotMatch[NG_HOOKSIZ]; /* !match dest hook */
- int32_t bpf_prog_len; /* #isns in program */
+ int32_t bpf_prog_len; /* #insns in program */
struct bpf_insn bpf_prog[]; /* bpf program */
};
.Ed
@@ -112,7 +113,7 @@
program or else
.Er EINVAL
is returned.
-.It Dv NGM_BPF_GET_PROGRAM
+.It Dv NGM_BPF_GET_PROGRAM Pq Ic getprogram
This command takes an
.Tn ASCII
string argument, the hook name, and returns the
@@ -119,18 +120,18 @@
corresponding
.Dv "struct ng_bpf_hookprog"
as shown above.
-.It Dv NGM_BPF_GET_STATS
+.It Dv NGM_BPF_GET_STATS Pq Ic getstats
This command takes an
.Tn ASCII
string argument, the hook name, and returns the
statistics associated with the hook as a
.Dv "struct ng_bpf_hookstat" .
-.It Dv NGM_BPF_CLR_STATS
+.It Dv NGM_BPF_CLR_STATS Pq Ic clrstats
This command takes an
.Tn ASCII
string argument, the hook name, and clears the
statistics associated with the hook.
-.It Dv NGM_BPF_GETCLR_STATS
+.It Dv NGM_BPF_GETCLR_STATS Pq Ic getclrstats
This command is identical to
.Dv NGM_BPF_GET_STATS ,
except that the statistics are also atomically cleared.
Modified: trunk/share/man/man4/ng_bridge.4
===================================================================
--- trunk/share/man/man4/ng_bridge.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_bridge.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2000 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_bridge.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd May 5, 2010
.Dt NG_BRIDGE 4
@@ -98,7 +99,7 @@
This node type supports the generic control messages, plus the
following:
.Bl -tag -width foo
-.It Dv NGM_BRIDGE_SET_CONFIG
+.It Dv NGM_BRIDGE_SET_CONFIG Pq Ic setconfig
Set the node configuration.
This command takes a
.Dv "struct ng_bridge_config"
@@ -108,9 +109,9 @@
struct ng_bridge_config {
u_char ipfw[NG_BRIDGE_MAX_LINKS]; /* enable ipfw */
u_char debugLevel; /* debug level */
- u_int32_t loopTimeout; /* link loopback mute time */
- u_int32_t maxStaleness; /* max host age before nuking */
- u_int32_t minStableAge; /* min time for a stable host */
+ uint32_t loopTimeout; /* link loopback mute time */
+ uint32_t maxStaleness; /* max host age before nuking */
+ uint32_t minStableAge; /* min time for a stable host */
};
.Ed
.Pp
@@ -140,13 +141,13 @@
before we declare a loopback condition.
The default is one second.
.Pp
-.It Dv NGM_BRIDGE_GET_CONFIG
+.It Dv NGM_BRIDGE_GET_CONFIG Pq Ic getconfig
Returns the current configuration as a
.Dv "struct ng_bridge_config" .
-.It Dv NGM_BRIDGE_RESET
+.It Dv NGM_BRIDGE_RESET Pq Ic reset
Causes the node to forget all hosts and unmute all links.
The node configuration is not changed.
-.It Dv NGM_BRIDGE_GET_STATS
+.It Dv NGM_BRIDGE_GET_STATS Pq Ic getstats
This command takes a four byte link number as an argument and
returns a
.Dv "struct ng_bridge_link_stats"
@@ -155,33 +156,33 @@
.Bd -literal -offset 0n
/* Statistics structure (one for each link) */
struct ng_bridge_link_stats {
- u_int64_t recvOctets; /* total octets rec'd on link */
- u_int64_t recvPackets; /* total pkts rec'd on link */
- u_int64_t recvMulticasts; /* multicast pkts rec'd on link */
- u_int64_t recvBroadcasts; /* broadcast pkts rec'd on link */
- u_int64_t recvUnknown; /* pkts rec'd with unknown dest addr */
- u_int64_t recvRunts; /* pkts rec'd less than 14 bytes */
- u_int64_t recvInvalid; /* pkts rec'd with bogus source addr */
- u_int64_t xmitOctets; /* total octets xmit'd on link */
- u_int64_t xmitPackets; /* total pkts xmit'd on link */
- u_int64_t xmitMulticasts; /* multicast pkts xmit'd on link */
- u_int64_t xmitBroadcasts; /* broadcast pkts xmit'd on link */
- u_int64_t loopDrops; /* pkts dropped due to loopback */
- u_int64_t loopDetects; /* number of loop detections */
- u_int64_t memoryFailures; /* times couldn't get mem or mbuf */
+ uint64_t recvOctets; /* total octets rec'd on link */
+ uint64_t recvPackets; /* total pkts rec'd on link */
+ uint64_t recvMulticasts; /* multicast pkts rec'd on link */
+ uint64_t recvBroadcasts; /* broadcast pkts rec'd on link */
+ uint64_t recvUnknown; /* pkts rec'd with unknown dest addr */
+ uint64_t recvRunts; /* pkts rec'd less than 14 bytes */
+ uint64_t recvInvalid; /* pkts rec'd with bogus source addr */
+ uint64_t xmitOctets; /* total octets xmit'd on link */
+ uint64_t xmitPackets; /* total pkts xmit'd on link */
+ uint64_t xmitMulticasts; /* multicast pkts xmit'd on link */
+ uint64_t xmitBroadcasts; /* broadcast pkts xmit'd on link */
+ uint64_t loopDrops; /* pkts dropped due to loopback */
+ uint64_t loopDetects; /* number of loop detections */
+ uint64_t memoryFailures; /* times couldn't get mem or mbuf */
};
.Ed
-.It Dv NGM_BRIDGE_CLR_STATS
+.It Dv NGM_BRIDGE_CLR_STATS Pq Ic clrstats
This command takes a four byte link number as an argument and
clears the statistics for that link.
-.It Dv NGM_BRIDGE_GETCLR_STATS
+.It Dv NGM_BRIDGE_GETCLR_STATS Pq Ic getclrstats
Same as
.Dv NGM_BRIDGE_GET_STATS ,
but also atomically clears the statistics as well.
-.It Dv NGM_BRIDGE_GET_TABLE
+.It Dv NGM_BRIDGE_GET_TABLE Pq Ic gettable
Returns the current host mapping table used to direct packets, in a
.Dv "struct ng_bridge_host_ary" .
-.It Dv NGM_BRIDGE_SET_PERSISTENT
+.It Dv NGM_BRIDGE_SET_PERSISTENT Pq Ic setpersistent
This command sets the persistent flag on the node, and takes no arguments.
.El
.Sh SHUTDOWN
Modified: trunk/share/man/man4/ng_bt3c.4
===================================================================
--- trunk/share/man/man4/ng_bt3c.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_bt3c.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin at yahoo.com>
.\" All rights reserved.
.\"
@@ -22,8 +23,8 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: ng_bt3c.4,v 1.2 2012-12-29 16:29:12 laffer1 Exp $
-.\" $MidnightBSD$
+.\" $Id: ng_bt3c.4,v 1.3 2003/09/14 23:28:51 max Exp $
+.\" $FreeBSD: stable/10/share/man/man4/ng_bt3c.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd December 17, 2004
.Dt NG_BT3C 4
@@ -74,8 +75,8 @@
driver provides support for the 3Com/HP 3CRWB6096-A PCCARD bluetooth adapter.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width indent
-.It Dv hook
+.Bl -tag -width ".Va hook"
+.It Va hook
single HCI frame contained in single
.Vt mbuf
structure.
@@ -82,26 +83,26 @@
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_BT3C_NODE_GET_STATE
+.Bl -tag -width foo
+.It Dv NGM_BT3C_NODE_GET_STATE Pq Ic get_state
Returns the current receiving state for the node.
-.It Dv NGM_BT3C_NODE_GET_DEBUG
-Returns an integer containing the current debug level for the node.
-.It Dv NGM_BT3C_NODE_SET_DEBUG
+.It Dv NGM_BT3C_NODE_SET_DEBUG Pq Ic set_debug
This command takes an integer argument and sets the current debug level
for the node.
-.It Dv NGM_BT3C_NODE_GET_QLEN
+.It Dv NGM_BT3C_NODE_GET_DEBUG Pq Ic get_debug
+Returns an integer containing the current debug level for the node.
+.It Dv NGM_BT3C_NODE_GET_QLEN Pq Ic get_qlen
This command takes a parameter that specifies queue number and returns
the current length of the queue for the node.
-.It Dv NGM_BT3C_NODE_SET_QLEN
+.It Dv NGM_BT3C_NODE_SET_QLEN Pq Ic set_qlen
This command takes two parameters that specify the queue number and
the maximum length of the queue and sets the maximum length of the queue for
the node.
-.It Dv NGM_BT3C_NODE_GET_STAT
+.It Dv NGM_BT3C_NODE_GET_STAT Pq Ic get_stat
Returns various statistic information for the node, such as: number of
bytes (frames) sent, number of bytes (frames) received and number of
input (output) errors.
-.It Dv NGM_BT3C_NODE_RESET_STAT
+.It Dv NGM_BT3C_NODE_RESET_STAT Pq Ic reset_stat
Reset all statistic counters to zero.
.It Dv NGM_BT3C_NODE_DOWNLOAD_FIRMWARE
Download card firmware.
Modified: trunk/share/man/man4/ng_btsocket.4
===================================================================
--- trunk/share/man/man4/ng_btsocket.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_btsocket.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin at yahoo.com>
.\" All rights reserved.
.\"
@@ -22,10 +23,10 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: ng_btsocket.4,v 1.2 2012-12-29 16:29:12 laffer1 Exp $
-.\" $MidnightBSD$
+.\" $Id: ng_btsocket.4,v 1.7 2003/05/21 19:37:35 max Exp $
+.\" $FreeBSD: stable/10/share/man/man4/ng_btsocket.4 242997 2012-11-13 20:41:36Z joel $
.\"
-.Dd July 8, 2002
+.Dd November 13, 2012
.Dt NG_BTSOCKET 4
.Os
.Sh NAME
@@ -65,7 +66,7 @@
struct sockaddr_hci {
u_char hci_len; /* total length */
u_char hci_family; /* address family */
- char hci_node[16]; /* HCI node name */
+ char hci_node[32]; /* address (size == NG_NODESIZ ) */
};
.Ed
.Pp
@@ -72,7 +73,7 @@
Raw HCI sockets support a number of
.Xr ioctl 2
requests such as:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv SIOC_HCI_RAW_NODE_GET_STATE
Returns current state for the HCI node.
.It Dv SIOC_HCI_RAW_NODE_INIT
@@ -154,7 +155,7 @@
struct sockaddr_l2cap {
u_char l2cap_len; /* total length */
u_char l2cap_family; /* address family */
- u_int16_t l2cap_psm; /* Protocol/Service Multiplexor */
+ uint16_t l2cap_psm; /* Protocol/Service Multiplexor */
bdaddr_t l2cap_bdaddr; /* address */
};
.Ed
@@ -174,7 +175,7 @@
Raw L2CAP sockets support number of
.Xr ioctl 2
requests such as:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv SIOC_L2CAP_NODE_GET_FLAGS
Returns current state for the L2CAP node.
.It Dv SIOC_L2CAP_NODE_GET_DEBUG
@@ -243,7 +244,7 @@
.Xr setsockopt 2
and tested with
.Xr getsockopt 2 :
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv SO_L2CAP_IMTU
Get (set) maximum payload size the local socket is capable of accepting.
.It Dv SO_L2CAP_OMTU
@@ -272,7 +273,7 @@
u_char rfcomm_len; /* total length */
u_char rfcomm_family; /* address family */
bdaddr_t rfcomm_bdaddr; /* address */
- u_int8_t rfcomm_channel; /* channel */
+ uint8_t rfcomm_channel; /* channel */
};
.Ed
.Ss Dv SOCK_STREAM Ss RFCOMM sockets
@@ -312,7 +313,7 @@
call, are defined at
.Dv SOL_RFCOMM
level for RFCOMM sockets:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv SO_RFCOMM_MTU
Returns the maximum transfer unit size (in bytes) for the underlying RFCOMM
channel.
Modified: trunk/share/man/man4/ng_car.4
===================================================================
--- trunk/share/man/man4/ng_car.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_car.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2005 Nuno Antunes <nuno.antunes at gmail.com>
.\" Copyright (c) 2007 Alexander Motin <mav at FreeBSD.org>
.\" All rights reserved.
@@ -23,9 +24,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_car.4 299386 2016-05-10 20:12:27Z wblock $
.\"
-.Dd March 11, 2007
+.Dd November 13, 2012
.Dt NG_CAR 4
.Os
.Sh NAME
@@ -50,7 +51,7 @@
.El
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width indent
+.Bl -tag -width ".Va upper"
.It Va upper
Hook leading to upper layer protocols.
.It Va lower
@@ -73,7 +74,7 @@
traffic.
.Sh MODES OF OPERATION
Each hook can operate in one of the following modes:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NG_CAR_SINGLE_RATE
Single rate three color marker as described in RFC 2697.
Committed burst packets are counted as green, extended burst packets are
@@ -114,24 +115,24 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages and the following
specific messages.
-.Bl -tag -width indent
-.It Dv NGM_CAR_SET_CONF Pq Li setconf
+.Bl -tag -width foo
+.It Dv NGM_CAR_SET_CONF Pq Ic setconf
Set node configuration to the specified at
.Vt "struct ng_car_bulkconf"
-.It Dv NGM_CAR_GET_CONF Pq Li getconf
+.It Dv NGM_CAR_GET_CONF Pq Ic getconf
Return current node configuration as
.Vt "struct ng_car_bulkconf"
.Bd -literal
struct ng_car_hookconf {
- u_int64_t cbs; /* Committed burst size */
- u_int64_t ebs; /* Exceeded/Peak burst size */
- u_int64_t cir; /* Committed information rate */
- u_int64_t pir; /* Peak information rate */
- u_int8_t green_action; /* Action for green packets */
- u_int8_t yellow_action; /* Action for yellow packets */
- u_int8_t red_action; /* Action for red packets */
- u_int8_t mode; /* operation mode */
- u_int8_t opt; /* mode options */
+ uint64_t cbs; /* Committed burst size (bytes) */
+ uint64_t ebs; /* Exceeded/Peak burst size (bytes) */
+ uint64_t cir; /* Committed information rate (bits/s) */
+ uint64_t pir; /* Peak information rate (bits/s) */
+ uint8_t green_action; /* Action for green packets */
+ uint8_t yellow_action; /* Action for yellow packets */
+ uint8_t red_action; /* Action for red packets */
+ uint8_t mode; /* single/double rate, ... */
+ uint8_t opt; /* color-aware or color-blind */
};
/* possible actions (..._action) */
@@ -150,23 +151,23 @@
/* mode options (opt) */
#define NG_CAR_COUNT_PACKETS 2
-
+
struct ng_car_bulkconf {
struct ng_car_hookconf upstream;
struct ng_car_hookconf downstream;
};
.Ed
-.It Dv NGM_CAR_GET_STATS Pq Li getstats
+.It Dv NGM_CAR_GET_STATS Pq Ic getstats
Return node statistics as
.Vt "struct ng_car_bulkstats"
.Bd -literal
struct ng_car_hookstats {
- u_int64_t passed_pkts;
- u_int64_t droped_pkts;
- u_int64_t green_pkts;
- u_int64_t yellow_pkts;
- u_int64_t red_pkts;
- u_int64_t errors;
+ uint64_t passed_pkts; /* Counter for passed packets */
+ uint64_t droped_pkts; /* Counter for dropped packets */
+ uint64_t green_pkts; /* Counter for green packets */
+ uint64_t yellow_pkts; /* Counter for yellow packets */
+ uint64_t red_pkts; /* Counter for red packets */
+ uint64_t errors; /* Counter for operation errors */
};
struct ng_car_bulkstats {
@@ -174,9 +175,9 @@
struct ng_car_hookstats downstream;
};
.Ed
-.It Dv NGM_CAR_CLR_STATS Pq Li clrstats
+.It Dv NGM_CAR_CLR_STATS Pq Ic clrstats
Clear node statistics.
-.It Dv NGM_CAR_GETCLR_STATS Pq Li getclrstats
+.It Dv NGM_CAR_GETCLR_STATS Pq Ic getclrstats
Atomically return and clear node statistics.
.El
.Sh SHUTDOWN
Modified: trunk/share/man/man4/ng_ccatm.4
===================================================================
--- trunk/share/man/man4/ng_ccatm.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_ccatm.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001-2004
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
@@ -29,7 +30,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_ccatm.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd March 10, 2005
.Dt NG_CCATM 4
@@ -110,7 +111,7 @@
and uses a structure
.Bd -literal
struct ccatm_op {
- u_int32_t op; /* request code */
+ uint32_t op; /* request code */
u_char data[]; /* optional data */
};
.Ed
@@ -146,7 +147,7 @@
.Pp
These codes correspond directly to the operations specified in the ATM
Forum document with the following exceptions:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv ATMOP_RESP
As discussed in
.Xr ng_uni 4 ,
@@ -191,12 +192,12 @@
.Sh CONTROL MESSAGES
Besides the generic messages the node understands the following special
messages:
-.Bl -tag -width indent
-.It Dv NGM_CCATM_DUMP
+.Bl -tag -width foo
+.It Dv NGM_CCATM_DUMP Pq Ic dump
This causes the internal state of the node to be dumped in ASCII to the
.Va dump
hook.
-.It Dv NGM_CCATM_STOP
+.It Dv NGM_CCATM_STOP Pq Ic stop
This message causes all connections on that port to be aborted (not released!\&)
and all ATM endpoints which are bound to that port to be closed.
It stops processing of all messages from the UNI stack on that port UNI stack.
@@ -207,17 +208,17 @@
};
.Ed
.Pp
-.It Dv NGM_CCATM_START
+.It Dv NGM_CCATM_START Pq Ic start
Start processing on the port.
The argument is a
.Vt ngm_ccatm_port
structure.
-.It Dv NGM_CCATM_CLEAR
+.It Dv NGM_CCATM_CLEAR Pq Ic clear
This message takes a
.Vt ngm_ccatm_port
structure and clears all prefixes and addresses on that port.
If the port number is zero, all ports are cleared.
-.It Dv NGM_CCATM_GET_ADDRESSES
+.It Dv NGM_CCATM_GET_ADDRESSES Pq Ic get_addresses
Get the list of all registered addresses on the given port.
The argument is a
.Vt ngm_ccatm_port
@@ -230,7 +231,7 @@
struct ngm_ccatm_address_req addr[0];
};
struct ngm_ccatm_address_req {
- u_int32_t port;
+ uint32_t port;
struct uni_addr addr;
};
.Ed
@@ -243,7 +244,7 @@
The number of addresses is returned in the
.Va count
field.
-.It Dv NGM_CCATM_ADDRESS_REGISTERED
+.It Dv NGM_CCATM_ADDRESS_REGISTERED Pq Ic address_reg
This message is used by ILMI to inform the
.Nm
node that a previous address registration request was successful.
@@ -251,7 +252,7 @@
The argument to the message is a
.Vt ngm_ccatm_address_req
structure.
-.It Dv NGM_CCATM_ADDRESS_UNREGISTERED
+.It Dv NGM_CCATM_ADDRESS_UNREGISTERED Pq Ic address_unreg
This message is used by ILMI to inform the
.Nm
node that an address has been unregistered.
@@ -259,7 +260,7 @@
The argument is a
.Vt ngm_ccatm_address_req
structure.
-.It Dv NGM_CCATM_SET_PORT_PARAM
+.It Dv NGM_CCATM_SET_PORT_PARAM Pq Ic set_port_param
This request sets the parameters on the given port.
The argument is a
.Bd -literal
@@ -281,13 +282,13 @@
The
.Va num_addr
field is ignored.
-.It Dv NGM_CCATM_GET_PORT_PARAM
+.It Dv NGM_CCATM_GET_PORT_PARAM Pq Ic get_port_param
Retrieve the parameters of the given port.
The argument is a
.Vt ngm_ccatm_port
and the result a
.Vt ngm_ccatm_atm_port .
-.It Dv NGM_CCATM_GET_PORTLIST
+.It Dv NGM_CCATM_GET_PORTLIST Pq Ic get_portlist
Get a list of all available ports on that node.
This is returned as a
.Bd -literal
@@ -296,13 +297,13 @@
uint32_t ports[];
};
.Ed
-.It Dv NGM_CCATM_GETSTATE
+.It Dv NGM_CCATM_GETSTATE Pq Ic getstate
Return the state of a port.
The argument is a
.Vt "struct ngm_ccatm_port"
and the return values as a
.Vt uint32_t .
-.It Dv NGM_CCATM_SETLOG
+.It Dv NGM_CCATM_SETLOG Pq Ic setlog
This requests sets a new logging level and returns the previous one.
The argument is either a
.Vt uint32_t
@@ -309,7 +310,7 @@
in which case it specifies the new logging level, or may be empty
in which case just the old level is returned as a
.Vt uint32_t .
-.It Dv NGM_CCATM_RESET
+.It Dv NGM_CCATM_RESET Pq Ic reset
Reset the node.
This is allowed only if the number of user hooks and connected UNI stacks is
zero.
Added: trunk/share/man/man4/ng_checksum.4
===================================================================
--- trunk/share/man/man4/ng_checksum.4 (rev 0)
+++ trunk/share/man/man4/ng_checksum.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,142 @@
+.\" $MidnightBSD$
+.\" Copyright (c) 2015 Dmitry Vagin <daemon.hammer at ya.ru>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/ng_checksum.4 309388 2016-12-02 05:39:10Z julian $
+.\"
+.Dd October 29, 2015
+.Dt NG_CHECKSUM 4
+.Os
+.Sh NAME
+.Nm ng_checksum
+.Nd IP checksum node type
+.Sh SYNOPSIS
+.In netgraph/ng_checksum.h
+.Sh DESCRIPTION
+The
+.Nm checksum
+node can calculate and prepare for calculation in hardware
+IPv4 header, TCP, UDP checksum.
+.Sh HOOKS
+This node type has two hooks:
+.Bl -tag -width ".Va out"
+.It Va in
+Packets received on this hook are processed according to settings specified
+in config and then forwarded to
+.Ar out
+hook, if it exists and connected. Otherwise they are reflected back to the
+.Ar in
+hook.
+.It Va out
+Packets received on this hook are forwarded to
+.Ar in
+hook without any changes.
+.El
+.Sh CONTROL MESSAGES
+This node type supports the generic control messages, plus the following:
+.Bl -tag -width foo
+.It Dv NGM_CHECKSUM_SETDLT Pq Ic setdlt
+Sets data link type on the
+.Va in
+hook. Currently, supported types are
+.Cm DLT_RAW
+(raw IP datagrams) and
+.Cm DLT_EN10MB
+(Ethernet). DLT_ definitions can be found in
+.In net/bpf.h
+header. Currently used values are
+.Cm DLT_EN10MB
+= 1 and
+.Cm DLT_RAW
+= 12.
+.It Dv NGM_CHECKSUM_GETDLT Pq Ic getdlt
+This control message obtains data link type on the
+.Va in
+hook.
+.It Dv NGM_CHECKSUM_SETCONFIG Pq Ic setconfig
+Sets node configuration. The following
+.Vt "struct ng_checksum_config"
+must be supplied as an argument:
+.Bd -literal -offset 4n
+struct ng_checksum_config {
+ uint64_t csum_flags;
+ uint64_t csum_offload;
+};
+.Ed
+.Pp
+The
+.Va csum_flags
+can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6
+(other values are ignored) for instructing node need calculate the corresponding checksum.
+.Pp
+The
+.Va csum_offload
+can be set to any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6
+(other values are ignored) for instructing node what checksum can calculate in hardware.
+.Pp
+Also processed any combination of CSUM_IP, CSUM_TCP, CSUM_UDP, CSUM_TCP_IPV6 and CSUM_UDP_IPV6 sets before on mbuf.
+.It Dv NGM_CHECKSUM_GETCONFIG Pq Ic getconfig
+This control message obtains current node configuration,
+returned as
+.Vt "struct ng_checksum_config" .
+.It Dv NGM_CHECKSUM_GET_STATS Pq Ic getstats
+Returns node statistics as a
+.Vt "struct ng_checksum_stats" .
+.It Dv NGM_CHECKSUM_CLR_STATS Pq Ic clrstats
+Clear node statistics.
+.It Dv NGM_CHECKSUM_GETCLR_STATS Pq Ic getclrstats
+This command is identical to
+.Dv NGM_CHECKSUM_GET_STATS ,
+except that the statistics are also atomically cleared.
+.El
+.Sh SHUTDOWN
+This node shuts down upon receipt of a
+.Dv NGM_SHUTDOWN
+control message, or when all hooks have been disconnected.
+.Sh EXAMPLES
+.Xr ngctl 8
+script:
+.Bd -literal -offset 4n
+/usr/sbin/ngctl -f- <<-SEQ
+ msg checksum-1: "setdlt 1"
+ ngctl msg checksum-1: "setconfig { csum_flags=0 csum_offload=6 }"
+.Ed
+.Pp
+Set data link type to
+.Cm DLT_EN10MB
+(Ethernet), not set additional checksum flags, set hardware
+can calculate CSUM_IP_UDP|CSUM_IP_TCP.
+.Sh SEE ALSO
+.Xr netgraph 4 ,
+.Xr ng_patch 4 ,
+.Xr ngctl 8
+.Sh HISTORY
+The
+.Nm
+node type was implemented in
+.Fx 10.2
+and first submitted in
+.Fx 12.0 .
+.Sh AUTHORS
+.An "Dmitry Vagin" Aq daemon.hammer at ya.ru .
Property changes on: trunk/share/man/man4/ng_checksum.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Modified: trunk/share/man/man4/ng_cisco.4
===================================================================
--- trunk/share/man/man4/ng_cisco.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_cisco.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_cisco.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_cisco.8,v 1.5 1999/01/25 23:46:26 archie Exp $
.\"
.Dd January 19, 1999
@@ -114,28 +115,28 @@
message.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobarbazio
-.It Dv downstream
+.Bl -tag -width ".Va downstream"
+.It Va downstream
The connection to the synchronous line.
-.It Dv inet
+.It Va inet
IP hook.
-.It Dv inet6
+.It Va inet6
IPv6 hook.
-.It Dv atalk
+.It Va atalk
AppleTalk hook.
-.It Dv ipx
-IPX hook
+.It Va ipx
+IPX hook.
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_CISCO_SET_IPADDR
+.It Dv NGM_CISCO_SET_IPADDR Pq Ic setipaddr
This command takes an array of two
.Dv "struct in_addr"
arguments.
The first is the IP address of the corresponding interface
and the second is the netmask.
-.It Dv NGM_CISCO_GET_IPADDR
+.It Dv NGM_CISCO_GET_IPADDR Pq Ic getipaddr
This command returns the IP configuration in the same format used by
.Dv NGM_CISCO_SET_IPADDR .
This command is also
@@ -143,13 +144,13 @@
by this node type to the
.Dv inet
peer whenever an IP address inquiry packet is received.
-.It Dv NGM_CISCO_GET_STATUS
+.It Dv NGM_CISCO_GET_STATUS Pq Ic getstats
Returns a
.Dv "struct ngciscostat" :
.Bd -literal -offset 4n
struct ngciscostat {
- u_int32_t seq_retries; /* # unack'd retries */
- u_int32_t keepalive_period; /* in seconds */
+ uint32_t seqRetries; /* # unack'd retries */
+ uint32_t keepAlivePeriod; /* in seconds */
};
.Ed
.El
Modified: trunk/share/man/man4/ng_deflate.4
===================================================================
--- trunk/share/man/man4/ng_deflate.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_deflate.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Author: Alexander Motin <mav at alkar.net>
.\"
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_deflate.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd December 23, 2006
.Dt NG_DEFLATE 4
@@ -40,7 +41,7 @@
.Sh DESCRIPTION
The
.Nm deflate
-node type implements the Deflate sub-protocols of the Compression Control
+node type implements the Deflate sub-protocols of the Compression Control
Protocol (CCP).
.Pp
The node has two hooks,
@@ -61,7 +62,7 @@
.Sh HOOKS
This node type supports the following hooks:
.Pp
-.Bl -tag -compact -width decomp
+.Bl -tag -compact -width ".Va decomp"
.It Va comp
Connection to
.Xr ng_ppp 4
@@ -82,7 +83,7 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_DEFLATE_CONFIG Pq Li config
+.It Dv NGM_DEFLATE_CONFIG Pq Ic config
This command resets and configures the node for a session
(i.e., for compression or decompression).
This command takes a
@@ -101,7 +102,7 @@
.Fa windowBits
specify compression windows size as negotiated by the
Compression Control Protocol (CCP) in PPP.
-.It Dv NGM_DEFLATE_RESETREQ Pq Li resetreq
+.It Dv NGM_DEFLATE_RESETREQ Pq Ic resetreq
This message contains no arguments, and is bi-directional.
If an error is detected during decompression, this message is sent by the
node to the originator of the
@@ -111,9 +112,9 @@
.Pp
This message may also be received by this node type when a CCP Reset-Request
or Reset-Ack is received by the local PPP entity.
-The node will respond by flushing its compression state so the sides
+The node will respond by flushing its compression state so the sides
can resynchronize.
-.It Dv NGM_DEFLATE_GET_STATS Pq Li getstats
+.It Dv NGM_DEFLATE_GET_STATS Pq Ic getstats
This control message obtains statistics for a given hook.
The statistics are returned in
.Vt "struct ng_deflate_stats" :
@@ -127,9 +128,9 @@
uint64_t Errors;
};
.Ed
-.It Dv NGM_DEFLATE_CLR_STATS Pq Li clrstats
+.It Dv NGM_DEFLATE_CLR_STATS Pq Ic clrstats
This control message clears statistics for a given hook.
-.It Dv NGM_DEFLATE_GETCLR_STATS Pq Li getclrstats
+.It Dv NGM_DEFLATE_GETCLR_STATS Pq Ic getclrstats
This control message obtains and clears statistics for a given hook.
.El
.Sh SHUTDOWN
@@ -154,5 +155,5 @@
.An Alexander Motin Aq mav at alkar.net
.Sh BUGS
Due to nature of netgraph PPP implementation there are possible race conditions
-between data packet and ResetAck CCP packet in case of packet loss. As result,
+between data packet and ResetAck CCP packet in case of packet loss. As result,
packet loss can produce bigger performance degradation than supposed by protocol.
Modified: trunk/share/man/man4/ng_device.4
===================================================================
--- trunk/share/man/man4/ng_device.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_device.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2002 Mark Santcroos <marks at ripe.net>
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -22,7 +23,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_device.4 140111 2005-01-12 10:14:43Z ru $
.\"
.Dd October 19, 2004
.Dt NG_DEVICE 4
Modified: trunk/share/man/man4/ng_echo.4
===================================================================
--- trunk/share/man/man4/ng_echo.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_echo.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_echo.4 84306 2001-10-01 16:09:29Z ru $
.\" $Whistle: ng_echo.8,v 1.4 1999/01/25 23:46:26 archie Exp $
.\"
.Dd January 19, 1999
Modified: trunk/share/man/man4/ng_eiface.4
===================================================================
--- trunk/share/man/man4/ng_eiface.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_eiface.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2004 Gleb Smirnoff
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_eiface.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd February 3, 2005
.Dt NG_EIFACE 4
@@ -63,8 +64,8 @@
packets received by any real Ethernet interface.
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_EIFACE_SET Pq Li set
+.Bl -tag -width foo
+.It Dv NGM_EIFACE_SET Pq Ic set
Set link-level address of the interface.
Requires
.Vt "struct ether_addr"
@@ -76,7 +77,7 @@
which requires as an argument an
.Tn ASCII
string consisting of 6 colon-separated hex digits.
-.It Dv NGM_EIFACE_GET_IFNAME Pq Li getifname
+.It Dv NGM_EIFACE_GET_IFNAME Pq Ic getifname
Return the name of the associated interface as a
.Dv NUL Ns -terminated
.Tn ASCII
Modified: trunk/share/man/man4/ng_etf.4
===================================================================
--- trunk/share/man/man4/ng_etf.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_etf.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001, FreeBSD Inc.
.\" All rights reserved.
@@ -24,9 +25,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_etf.4 242997 2012-11-13 20:41:36Z joel $
.\"
-.Dd May 16, 2006
+.Dd November 13, 2012
.Dt NG_ETF 4
.Os
.Sh NAME
@@ -66,7 +67,7 @@
hook.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width ".Em downstream"
+.Bl -tag -width ".Aq Em any legal name"
.It Em downstream
Typically this hook would be connected to a
.Xr ng_ether 4
@@ -89,11 +90,11 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width 4n
-.It Dv NGM_ETF_GET_STATUS
+.It Dv NGM_ETF_GET_STATUS Pq Ic getstatus
This command returns a
.Vt "struct ng_etfstat"
containing node statistics for packet counts.
-.It Dv NGM_ETF_SET_FILTER
+.It Dv NGM_ETF_SET_FILTER Pq Ic setfilter
Sets the a new ethertype filter into the node and specifies the hook to and
from which packets of that type should use.
The hook and ethertype
@@ -101,8 +102,8 @@
.Vt "struct ng_etffilter" :
.Bd -literal -offset 4n
struct ng_etffilter {
- char matchhook[NG_HOOKSIZ]; /* hook name */
- u_int16_t ethertype; /* catch these */
+ char matchhook[NG_HOOKSIZ]; /* hook name */
+ uint16_t ethertype; /* this ethertype to this hook */
};
.Ed
.El
Modified: trunk/share/man/man4/ng_ether.4
===================================================================
--- trunk/share/man/man4/ng_ether.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_ether.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2000 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_ether.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd June 23, 2011
.Dt NG_ETHER 4
@@ -124,29 +125,29 @@
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_ETHER_GET_IFNAME Pq Li getifname
+.Bl -tag -width foo
+.It Dv NGM_ETHER_GET_IFNAME Pq Ic getifname
Returns the name of the associated interface as a
.Dv NUL Ns -terminated
.Tn ASCII
string.
Normally this is the same as the name of the node.
-.It Dv NGM_ETHER_GET_IFINDEX Pq Li getifindex
+.It Dv NGM_ETHER_GET_IFINDEX Pq Ic getifindex
Returns the global index of the associated interface as a 32 bit integer.
-.It Dv NGM_ETHER_GET_ENADDR Pq Li getenaddr
+.It Dv NGM_ETHER_GET_ENADDR Pq Ic getenaddr
Returns the device's unique six byte Ethernet address.
-.It Dv NGM_ETHER_SET_ENADDR Pq Li setenaddr
+.It Dv NGM_ETHER_SET_ENADDR Pq Ic setenaddr
Sets the device's unique six byte Ethernet address.
This control message is equivalent to using the
.Dv SIOCSIFLLADDR
.Xr ioctl 2
system call.
-.It Dv NGM_ETHER_SET_PROMISC Pq Li setpromisc
+.It Dv NGM_ETHER_SET_PROMISC Pq Ic setpromisc
Enable or disable promiscuous mode.
This message includes a single 32 bit integer flag that enables or
disables promiscuous mode on the interface.
Any non-zero value enables promiscuous mode.
-.It Dv NGM_ETHER_GET_PROMISC Pq Li getpromisc
+.It Dv NGM_ETHER_GET_PROMISC Pq Ic getpromisc
Get the current value of the node's promiscuous flag.
The returned value is always either one or zero.
Note that this flag reflects the node's own promiscuous setting
@@ -153,7 +154,7 @@
and does not necessarily reflect the promiscuous state of the actual
interface, which can be affected by other means (e.g.,
.Xr bpf 4 ) .
-.It Dv NGM_ETHER_SET_AUTOSRC Pq Li setautosrc
+.It Dv NGM_ETHER_SET_AUTOSRC Pq Ic setautosrc
Sets the automatic source address override flag.
This message includes a single 32 bit integer flag that causes
all outgoing packets to have their source Ethernet
@@ -161,22 +162,22 @@
If this flag is set to zero, the source address in outgoing packets
is not modified.
The default setting for this flag is disabled.
-.It Dv NGM_ETHER_GET_AUTOSRC Pq Li getautosrc
+.It Dv NGM_ETHER_GET_AUTOSRC Pq Ic getautosrc
Get the current value of the node's source address override flag.
The returned value is always either one or zero.
-.It Dv NGM_ETHER_ADD_MULTI Pq Li addmulti
+.It Dv NGM_ETHER_ADD_MULTI Pq Ic addmulti
Join Ethernet multicast group.
This control message is equivalent to using the
.Dv SIOCADDMULTI
.Xr ioctl 2
system call.
-.It Dv NGM_ETHER_DEL_MULTI Pq Li delmulti
+.It Dv NGM_ETHER_DEL_MULTI Pq Ic delmulti
Leave Ethernet multicast group.
This control message is equivalent to using the
.Dv SIOCDELMULTI
.Xr ioctl 2
system call.
-.It Dv NGM_ETHER_DETACH Pq Li detach
+.It Dv NGM_ETHER_DETACH Pq Ic detach
Detach from underlying Ethernet interface and shut down node.
.El
.Sh SHUTDOWN
Modified: trunk/share/man/man4/ng_ether_echo.4
===================================================================
--- trunk/share/man/man4/ng_ether_echo.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_ether_echo.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_ether_echo.4 186486 2008-12-25 07:34:14Z julian $
.\" $Whistle: ng_echo.8,v 1.4 1999/01/25 23:46:26 archie Exp $
.\"
.Dd December 24, 2008
Modified: trunk/share/man/man4/ng_fec.4
===================================================================
--- trunk/share/man/man4/ng_fec.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_fec.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2004 Gleb Smirnoff
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_fec.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd July 22, 2004
.Dt NG_FEC 4
@@ -57,20 +58,20 @@
.Sh CONTROL MESSAGES
Interface membership in the FEC group is configured with the following
control messages:
-.Bl -tag -width indent
-.It Dv NGM_FEC_ADD_IFACE Pq Dq Li add_iface
+.Bl -tag -width foo
+.It Dv NGM_FEC_ADD_IFACE Pq Ic add_iface
Attach interface to the FEC group.
The target interface name is passed as a string argument.
-.It Dv NGM_FEC_DEL_IFACE Pq Dq Li del_iface
+.It Dv NGM_FEC_DEL_IFACE Pq Ic del_iface
Remove interface from the trunk.
The target interface name is passed as a string argument.
.El
.Pp
The following control messages define the forwarding method for a node:
-.Bl -tag -width indent
-.It Dv NGM_FEC_SET_MODE_MAC Pq Dq Li set_mode_mac
+.Bl -tag -width foo
+.It Dv NGM_FEC_SET_MODE_MAC Pq Ic set_mode_mac
Forwarding decisions will be based on the link-layer MAC address of the destination.
-.It Dv NGM_FEC_SET_MODE_INET Pq Dq Li set_mode_inet
+.It Dv NGM_FEC_SET_MODE_INET Pq Ic set_mode_inet
Forwarding decisions will be based on the IP address of the destination.
.El
.Sh SHUTDOWN
Modified: trunk/share/man/man4/ng_frame_relay.4
===================================================================
--- trunk/share/man/man4/ng_frame_relay.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_frame_relay.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_frame_relay.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_frame_relay.8,v 1.4 1999/01/25 23:46:26 archie Exp $
.\"
.Dd January 19, 1999
@@ -63,10 +64,10 @@
are available to connect to each of the DLCI channels.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobar
-.It Dv downstream
+.Bl -tag -width ".Va downstream"
+.It Va downstream
The connection to the synchronous line.
-.It Dv dlciX
+.It Va dlciX
Here X is a decimal number from 0 to 1023.
This hook corresponds
to the DLCI X frame relay virtual channel.
Modified: trunk/share/man/man4/ng_gif.4
===================================================================
--- trunk/share/man/man4/ng_gif.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_gif.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright 2000 The Aerospace Corporation. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -26,7 +27,7 @@
.\"
.\" Author: Brooks Davis <brooks at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_gif.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd September 18, 2001
.Dt NG_GIF 4
@@ -99,10 +100,10 @@
When no hooks are connected, packets flow normally upwards and downwards.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width ".Dv orphans"
-.It Dv lower
+.Bl -tag -width ".Va orphans"
+.It Va lower
Connection to the lower device link layer.
-.It Dv orphans
+.It Va orphans
Like
.Dv lower ,
but only receives unrecognized packets.
Modified: trunk/share/man/man4/ng_gif_demux.4
===================================================================
--- trunk/share/man/man4/ng_gif_demux.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_gif_demux.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright 2000 The Aerospace Corporation. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -26,7 +27,7 @@
.\"
.\" Author: Brooks Davis <brooks at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_gif_demux.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd September 18, 2001
.Dt NG_GIF_DEMUX 4
@@ -70,7 +71,7 @@
.Sh HOOKS
This node type supports the following hooks:
.Bl -tag -width ".Dv inet6"
-.It Dv gif
+.It Va gif
Connection to the
.Dv lower
or
@@ -78,19 +79,19 @@
hook of an
.Xr ng_gif 4
node.
-.It Dv inet
+.It Va inet
Hook for input and output of IP frames.
-.It Dv inet6
+.It Va inet6
Hook for input and output of IPv6 frames.
-.It Dv atalk
+.It Va atalk
Hook for input and output of AppleTalk frames.
-.It Dv ipx
+.It Va ipx
Hook for input and output of IPX frames.
-.It Dv atm
+.It Va atm
Hook for input and output of ATM frames.
-.It Dv natm
+.It Va natm
Hook for input and output of NATM frames.
-.It Dv ns
+.It Va ns
Hook for input and output of NS frames.
.El
.Sh CONTROL MESSAGES
Modified: trunk/share/man/man4/ng_h4.4
===================================================================
--- trunk/share/man/man4/ng_h4.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_h4.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin at yahoo.com>
.\" All rights reserved.
.\"
@@ -22,8 +23,8 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: ng_h4.4,v 1.2 2012-12-29 16:29:12 laffer1 Exp $
-.\" $MidnightBSD$
+.\" $Id: ng_h4.4,v 1.2 2003/05/21 19:37:35 max Exp $
+.\" $FreeBSD: stable/10/share/man/man4/ng_h4.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd June 14, 2002
.Dt NG_H4 4
@@ -71,8 +72,8 @@
control message.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width indent
-.It Dv hook
+.Bl -tag -width ".Va hook"
+.It Va hook
single HCI frame contained in single
.Vt mbuf
structure.
@@ -79,7 +80,7 @@
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NGM_H4_NODE_RESET
Reset the node.
.It Dv NGM_H4_NODE_GET_STATE
Modified: trunk/share/man/man4/ng_hci.4
===================================================================
--- trunk/share/man/man4/ng_hci.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_hci.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin at yahoo.com>
.\" All rights reserved.
.\"
@@ -22,8 +23,8 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: ng_hci.4,v 1.2 2012-12-29 16:29:12 laffer1 Exp $
-.\" $MidnightBSD$
+.\" $Id: ng_hci.4,v 1.3 2003/05/21 19:37:35 max Exp $
+.\" $FreeBSD: stable/10/share/man/man4/ng_hci.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd June 25, 2002
.Dt NG_HCI 4
@@ -133,9 +134,9 @@
.Bd -literal -offset indent
#define NG_HCI_CMD_PKT 0x01
typedef struct {
- u_int8_t type; /* MUST be 0x1 */
- u_int16_t opcode; /* OpCode */
- u_int8_t length; /* parameter(s) length in bytes */
+ uint8_t type; /* MUST be 0x1 */
+ uint16_t opcode; /* OpCode */
+ uint8_t length; /* parameter(s) length in bytes */
} __attribute__ ((packed)) ng_hci_cmd_pkt_t;
.Ed
.Pp
@@ -156,9 +157,9 @@
.Bd -literal -offset indent
#define NG_HCI_EVENT_PKT 0x04
typedef struct {
- u_int8_t type; /* MUST be 0x4 */
- u_int8_t event; /* event */
- u_int8_t length; /* parameter(s) length in bytes */
+ uint8_t type; /* MUST be 0x4 */
+ uint8_t event; /* event */
+ uint8_t length; /* parameter(s) length in bytes */
} __attribute__ ((packed)) ng_hci_event_pkt_t;
.Ed
.Pp
@@ -168,9 +169,9 @@
.Bd -literal -offset indent
#define NG_HCI_ACL_DATA_PKT 0x02
typedef struct {
- u_int8_t type; /* MUST be 0x2 */
- u_int16_t con_handle; /* connection handle + PB + BC flags */
- u_int16_t length; /* payload length in bytes */
+ uint8_t type; /* MUST be 0x2 */
+ uint16_t con_handle; /* connection handle + PB + BC flags */
+ uint16_t length; /* payload length in bytes */
} __attribute__ ((packed)) ng_hci_acldata_pkt_t;
.Ed
.Pp
@@ -180,9 +181,9 @@
.Bd -literal -offset indent
#define NG_HCI_SCO_DATA_PKT 0x03
typedef struct {
- u_int8_t type; /* MUST be 0x3 */
- u_int16_t con_handle; /* connection handle + reserved bits */
- u_int8_t length; /* payload length in bytes */
+ uint8_t type; /* MUST be 0x3 */
+ uint16_t con_handle; /* connection handle + reserved bits */
+ uint8_t length; /* payload length in bytes */
} __attribute__ ((packed)) ng_hci_scodata_pkt_t;
.Ed
.Pp
@@ -191,7 +192,7 @@
.Sh HCI INITIALIZATION
On initialization, HCI control application must issue the following HCI
commands (in any order).
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv Read_BD_ADDR
To obtain BD_ADDR of the Bluetooth unit.
.It Dv Read_Local_Supported_Features
@@ -216,9 +217,9 @@
.Bd -literal -offset indent
#define NGM_HCI_NODE_UP 112 /* HCI -> Upper */
typedef struct {
- u_int16_t pkt_size; /* max. ACL/SCO packet size (w/o hdr) */
- u_int16_t num_pkts; /* ACL/SCO packet queue size */
- u_int16_t reserved; /* place holder */
+ uint16_t pkt_size; /* max. ACL/SCO packet size (w/o hdr) */
+ uint16_t num_pkts; /* ACL/SCO packet queue size */
+ uint16_t reserved; /* place holder */
bdaddr_t bdaddr; /* bdaddr */
} ng_hci_node_up_ep;
.Ed
@@ -244,29 +245,29 @@
.Bd -literal -offset indent
#define NGM_HCI_SYNC_CON_QUEUE 113 /* HCI -> Upper */
typedef struct {
- u_int16_t con_handle; /* connection handle */
- u_int16_t completed; /* number of completed packets */
+ uint16_t con_handle; /* connection handle */
+ uint16_t completed; /* number of completed packets */
} ng_hci_sync_con_queue_ep;
.Ed
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width indent
-.It Dv drv
+.Bl -tag -width ".Va drv"
+.It Va drv
Bluetooth Host Controller Transport Layer hook.
Single HCI packet contained in single
.Vt mbuf
structure.
-.It Dv acl
+.It Va acl
Upper layer protocol/node is connected to the hook.
Single HCI ACL data packet contained in single
.Vt mbuf
structure.
-.It Dv sco
+.It Va sco
Upper layer protocol/node is connected to the hook.
Single HCI SCO data packet contained in single
.Vt mbuf
structure.
-.It Dv raw
+.It Va raw
Raw hook.
Every HCI frame (including HCI command frame) that goes in
or out will be delivered to the hook.
@@ -276,7 +277,7 @@
structure.
.El
.Sh BLUETOOTH UPPER LAYER PROTOCOLS INTERFACE (LP CONTROL MESSAGES)
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NGM_HCI_LP_CON_REQ
Requests the lower protocol to create a connection.
If a physical link
@@ -311,7 +312,7 @@
.El
.Sh NETGRAPH CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NGM_HCI_NODE_GET_STATE
Returns current state for the node.
.It Dv NGM_HCI_NODE_INIT
Modified: trunk/share/man/man4/ng_hole.4
===================================================================
--- trunk/share/man/man4/ng_hole.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_hole.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_hole.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_hole.8,v 1.4 1999/01/25 23:46:26 archie Exp $
.\"
.Dd May 19, 2004
@@ -57,19 +58,19 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the
following:
-.Bl -tag -width indent
-.It Dv NGM_HOLE_GET_STATS
+.Bl -tag -width foo
+.It Dv NGM_HOLE_GET_STATS Pq Ic getstats
This command takes an
.Tn ASCII
string argument, the hook name, and returns the statistics
associated with the hook as a
.Vt "struct ng_hole_hookstat" .
-.It Dv NGM_HOLE_CLR_STATS
+.It Dv NGM_HOLE_CLR_STATS Pq Ic clrstats
This command takes an
.Tn ASCII
string argument, the hook name, and clears the statistics
associated with the hook.
-.It Dv NGM_HOLE_GETCLR_STATS
+.It Dv NGM_HOLE_GETCLR_STATS Pq Ic getclrstats
This command is identical to
.Dv NGM_HOLE_GET_STATS ,
except that the statistics are also atomically cleared.
Modified: trunk/share/man/man4/ng_hub.4
===================================================================
--- trunk/share/man/man4/ng_hub.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_hub.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2004 Ruslan Ermilov
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_hub.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd May 5, 2010
.Dt NG_HUB 4
@@ -48,7 +49,7 @@
This node type supports the generic control messages, plus the
following:
.Bl -tag -width foo
-.It Dv NGM_HUB_SET_PERSISTENT
+.It Dv NGM_HUB_SET_PERSISTENT Pq Ic setpersistent
This command sets the persistent flag on the node, and takes no arguments.
.El
.Sh SHUTDOWN
Modified: trunk/share/man/man4/ng_iface.4
===================================================================
--- trunk/share/man/man4/ng_iface.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_iface.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_iface.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_iface.8,v 1.5 1999/01/25 23:46:26 archie Exp $
.\"
.Dd October 28, 2005
@@ -83,40 +84,40 @@
nodes support the Berkeley Packet Filter (BPF).
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobar
-.It Dv inet
+.Bl -tag -width ".Va inet6"
+.It Va inet
Transmission and reception of IP packets.
-.It Dv inet6
+.It Va inet6
Transmission and reception of IPv6 packets.
-.It Dv atalk
+.It Va atalk
Transmission and reception of AppleTalk packets.
-.It Dv ipx
+.It Va ipx
Transmission and reception of IPX packets.
-.It Dv atm
+.It Va atm
Transmission and reception of ATM packets.
-.It Dv natm
+.It Va natm
Transmission and reception of NATM packets.
-.It Dv ns
+.It Va ns
Transmission and reception of NS packets.
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_IFACE_GET_IFNAME
+.It Dv NGM_IFACE_GET_IFNAME Pq Ic getifname
Returns the name of the associated interface as a
.Dv NUL Ns -terminated
.Tn ASCII
string.
Normally this is the same as the name of the node.
-.It Dv NGM_IFACE_GET_IFINDEX
+.It Dv NGM_IFACE_GET_IFINDEX Pq Ic getifindex
Returns the global index of the associated interface as a 32 bit integer.
-.It Dv NGM_IFACE_POINT2POINT
+.It Dv NGM_IFACE_POINT2POINT Pq Ic point2point
Set the interface to point-to-point mode.
The interface must not currently be up.
-.It Dv NGM_IFACE_BROADCAST
+.It Dv NGM_IFACE_BROADCAST Pq Ic broadcast
Set the interface to broadcast mode.
The interface must not currently be up.
-.It Dv NGM_CISCO_GET_IPADDR
+.It Dv NGM_CISCO_GET_IPADDR Pq Ic getipaddr
This message is defined by the
.Xr ng_cisco 4
node type; see
Modified: trunk/share/man/man4/ng_ip_input.4
===================================================================
--- trunk/share/man/man4/ng_ip_input.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_ip_input.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright 2001 The Aerospace Corporation. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -59,7 +60,7 @@
.\" Author: Brooks Davis <brooks at FreeBSD.org>
.\" Derived from: ng_hole.4
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_ip_input.4 86774 2001-11-22 11:36:29Z ru $
.\"
.Dd September 27, 2001
.Dt NG_IP_INPUT 4
Modified: trunk/share/man/man4/ng_ipfw.4
===================================================================
--- trunk/share/man/man4/ng_ipfw.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_ipfw.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2005 Gleb Smirnoff
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_ipfw.4 204574 2010-03-02 10:43:41Z glebius $
.\"
.Dd March 2, 2010
.Dt NG_IPFW 4
Modified: trunk/share/man/man4/ng_ksocket.4
===================================================================
--- trunk/share/man/man4/ng_ksocket.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_ksocket.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,9 +33,9 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_ksocket.4 242997 2012-11-13 20:41:36Z joel $
.\"
-.Dd January 09, 2012
+.Dd January 9, 2012
.Dt NG_KSOCKET 4
.Os
.Sh NAME
@@ -111,7 +112,7 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_KSOCKET_BIND
+.It Dv NGM_KSOCKET_BIND Pq Ic bind
This functions exactly like the
.Xr bind 2
system call.
@@ -118,7 +119,7 @@
The
.Vt "struct sockaddr"
socket address parameter should be supplied as an argument.
-.It Dv NGM_KSOCKET_LISTEN
+.It Dv NGM_KSOCKET_LISTEN Pq Ic listen
This functions exactly like the
.Xr listen 2
system call.
@@ -125,7 +126,7 @@
The backlog parameter (a single 32 bit
.Dv int )
should be supplied as an argument.
-.It Dv NGM_KSOCKET_CONNECT
+.It Dv NGM_KSOCKET_CONNECT Pq Ic connect
This functions exactly like the
.Xr connect 2
system call.
@@ -132,7 +133,7 @@
The
.Vt "struct sockaddr"
destination address parameter should be supplied as an argument.
-.It Dv NGM_KSOCKET_ACCEPT
+.It Dv NGM_KSOCKET_ACCEPT Pq Ic accept
Equivalent to the
.Xr accept 2
system call on a non-blocking socket.
@@ -148,7 +149,7 @@
A cloned node supports a single hook with an arbitrary name.
If not connected, a node disappears when its parent node is destroyed.
Once connected, it becomes an independent node.
-.It Dv NGM_KSOCKET_GETNAME
+.It Dv NGM_KSOCKET_GETNAME Pq Ic getname
Equivalent to the
.Xr getsockname 2
system call.
@@ -155,7 +156,7 @@
The name is returned as a
.Vt "struct sockaddr"
in the arguments field of the reply.
-.It Dv NGM_KSOCKET_GETPEERNAME
+.It Dv NGM_KSOCKET_GETPEERNAME Pq Ic getpeername
Equivalent to the
.Xr getpeername 2
system call.
@@ -162,12 +163,12 @@
The name is returned as a
.Vt "struct sockaddr"
in the arguments field of the reply.
-.It Dv NGM_KSOCKET_SETOPT
+.It Dv NGM_KSOCKET_SETOPT Pq Ic setopt
Equivalent to the
.Xr setsockopt 2
system call, except that the option name, level, and value are passed in a
.Vt "struct ng_ksocket_sockopt" .
-.It Dv NGM_KSOCKET_GETOPT
+.It Dv NGM_KSOCKET_GETOPT Pq Ic getopt
Equivalent to the
.Xr getsockopt 2
system call, except that the option is passed in a
Modified: trunk/share/man/man4/ng_l2cap.4
===================================================================
--- trunk/share/man/man4/ng_l2cap.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_l2cap.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin at yahoo.com>
.\" All rights reserved.
.\"
@@ -22,8 +23,8 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: ng_l2cap.4,v 1.2 2012-12-29 16:29:12 laffer1 Exp $
-.\" $MidnightBSD$
+.\" $Id: ng_l2cap.4,v 1.4 2003/09/14 23:37:52 max Exp $
+.\" $FreeBSD: stable/10/share/man/man4/ng_l2cap.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd July 4, 2002
.Dt NG_L2CAP 4
@@ -104,7 +105,7 @@
to a single local device, the local device can still uniquely associate each
remote CID with a different device.
.Ss Channel Operational States
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NG_L2CAP_CLOSED
In this state, there is no channel associated with this CID.
This is the only
@@ -209,13 +210,13 @@
.El
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width indent
-.It Dv hci
+.Bl -tag -width ".Va hci"
+.It Va hci
Bluetooth Host Controller Interface downstream hook.
-.It Dv l2c
+.It Va l2c
Upper layer protocol upstream hook.
Usually the Bluetooth L2CAP socket layer is connected to the hook.
-.It Dv ctl
+.It Va ctl
Control hook.
Usually the Bluetooth raw L2CAP sockets layer is connected to the hook.
.El
@@ -242,7 +243,7 @@
flag.
There is no reason for this, because they are just notifications and do
not require acknowledgment.
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NGM_L2CAP_L2CA_CON
Requests the creation of a channel representing a logical connection to a
physical address.
@@ -310,9 +311,9 @@
.Bd -literal -offset indent
/* L2CA data packet header */
typedef struct {
- u_int32_t token; /* token to use in L2CAP_L2CA_WRITE */
- u_int16_t length; /* length of the data */
- u_int16_t lcid; /* local channel ID */
+ uint32_t token; /* token to use in L2CAP_L2CA_WRITE */
+ uint16_t length; /* length of the data */
+ uint16_t lcid; /* local channel ID */
} __attribute__ ((packed)) ng_l2cap_l2ca_hdr_t;
.Ed
.Pp
@@ -380,7 +381,7 @@
.El
.Sh NETGRAPH CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NGM_L2CAP_NODE_GET_FLAGS
Returns current state for the node.
.It Dv NGM_L2CAP_NODE_GET_DEBUG
Modified: trunk/share/man/man4/ng_l2tp.4
===================================================================
--- trunk/share/man/man4/ng_l2tp.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_l2tp.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2002 Packet Design, LLC.
.\" All rights reserved.
.\"
@@ -35,9 +36,9 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_l2tp.4 242997 2012-11-13 20:41:36Z joel $
.\"
-.Dd August 2, 2004
+.Dd November 13, 2012
.Dt NG_L2TP 4
.Os
.Sh NAME
@@ -59,13 +60,12 @@
The
.Nm l2tp
node type supports the following hooks:
-.Pp
-.Bl -tag -compact -offset indent -width ".Dv session_hhhh"
-.It Dv lower
+.Bl -tag -width ".Va session_hhhh"
+.It Va lower
L2TP frames.
-.It Dv ctrl
+.It Va ctrl
Control packets.
-.It Dv session_hhhh
+.It Va session_hhhh
Session 0xhhhh data packets.
.El
.Pp
@@ -104,8 +104,8 @@
.Dv session_abcd .
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_L2TP_SET_CONFIG
+.Bl -tag -width foo
+.It Dv NGM_L2TP_SET_CONFIG Pq Ic setconfig
This command updates the configuration of the node.
It takes a
.Vt "struct ng_l2tp_config"
@@ -115,11 +115,11 @@
struct ng_l2tp_config {
u_char enabled; /* enables traffic flow */
u_char match_id; /* tunnel id must match 'tunnel_id' */
- u_int16_t tunnel_id; /* local tunnel id */
- u_int16_t peer_id; /* peer's tunnel id */
- u_int16_t peer_win; /* peer's max recv window size */
- u_int16_t rexmit_max; /* max retransmits before failure */
- u_int16_t rexmit_max_to; /* max delay between retransmits */
+ uint16_t tunnel_id; /* local tunnel id */
+ uint16_t peer_id; /* peer's tunnel id */
+ uint16_t peer_win; /* peer's max recv window size */
+ uint16_t rexmit_max; /* max retransmits before failure */
+ uint16_t rexmit_max_to; /* max delay between retransmits */
};
.Ed
.Pp
@@ -182,14 +182,14 @@
will cause the
.Nm l2tp
node to send a
-.Dv NGM_L2TP_ACK_FAILURE
+.Dv NGM_L2TP_ACK_FAILURE Pq Ic ackfailure
control message back to the node that sent the last
.Dv NGM_L2TP_SET_CONFIG .
Appropriate action should then be taken to shutdown the control connection.
-.It Dv NGM_L2TP_GET_CONFIG
+.It Dv NGM_L2TP_GET_CONFIG Pq Ic getconfig
Returns the current configuration as a
.Vt "struct ng_l2tp_config" .
-.It Dv NGM_L2TP_SET_SESS_CONFIG
+.It Dv NGM_L2TP_SET_SESS_CONFIG Pq Ic setsessconfig
This control message configures a single data session.
The corresponding hook must already be connected before sending this command.
The argument is a
@@ -197,11 +197,11 @@
.Bd -literal
/* Configuration for a session hook */
struct ng_l2tp_sess_config {
- u_int16_t session_id; /* local session id */
- u_int16_t peer_id; /* peer's session id */
- u_char control_dseq; /* we control data sequencing? */
- u_char enable_dseq; /* enable data sequencing? */
- u_char include_length; /* include length field? */
+ uint16_t session_id; /* local session id */
+ uint16_t peer_id; /* peer's session id */
+ u_char control_dseq; /* whether we control data sequencing */
+ u_char enable_dseq; /* whether to enable data sequencing */
+ u_char include_length; /* whether to include length field */
};
.Ed
.Pp
@@ -256,35 +256,35 @@
field determines whether the L2TP header length field is included
in outgoing L2TP data packets.
For incoming packets, the L2TP length field is always checked when present.
-.It Dv NGM_L2TP_GET_SESS_CONFIG
+.It Dv NGM_L2TP_GET_SESS_CONFIG Pq Ic getsessconfig
This command takes a two byte session ID as an argument and returns
the current configuration for the corresponding data session as a
.Vt "struct ng_l2tp_sess_config" .
The corresponding session hook must be connected.
-.It Dv NGM_L2TP_GET_STATS
+.It Dv NGM_L2TP_GET_STATS Pq Ic getstats
This command returns a
.Vt "struct ng_l2tp_stats"
containing statistics of the L2TP tunnel.
-.It Dv NGM_L2TP_CLR_STATS
+.It Dv NGM_L2TP_CLR_STATS Pq Ic clrstats
This command clears the statistics for the L2TP tunnel.
-.It Dv NGM_L2TP_GETCLR_STATS
+.It Dv NGM_L2TP_GETCLR_STATS Pq Ic getclrstats
Same as
.Dv NGM_L2TP_GET_STATS ,
but also atomically clears the statistics as well.
-.It Dv NGM_L2TP_GET_SESSION_STATS
+.It Dv NGM_L2TP_GET_SESSION_STATS Pq Ic getsessstats
This command takes a two byte session ID as an argument and returns a
.Vt "struct ng_l2tp_session_stats"
containing statistics for the corresponding data session.
The corresponding session hook must be connected.
-.It Dv NGM_L2TP_CLR_SESSION_STATS
+.It Dv NGM_L2TP_CLR_SESSION_STATS Pq Ic clrsessstats
This command takes a two byte session ID as an argument and
clears the statistics for that data session.
The corresponding session hook must be connected.
-.It Dv NGM_L2TP_GETCLR_SESSION_STATS
+.It Dv NGM_L2TP_GETCLR_SESSION_STATS Pq Ic getclrsessstats
Same as
.Dv NGM_L2TP_GET_SESSION_STATS ,
but also atomically clears the statistics as well.
-.It Dv NGM_L2TP_SET_SEQ
+.It Dv NGM_L2TP_SET_SEQ Pq Ic setsequence
This command sets the sequence numbers of a not yet enabled node.
It takes a
.Vt "struct ng_l2tp_seq_config"
Modified: trunk/share/man/man4/ng_lmi.4
===================================================================
--- trunk/share/man/man4/ng_lmi.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_lmi.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,10 +33,10 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_lmi.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_lmi.8,v 1.4 1999/01/25 23:46:27 archie Exp $
.\"
-.Dd January 19, 1999
+.Dd November 13, 2012
.Dt NG_LMI 4
.Os
.Sh NAME
@@ -82,16 +83,16 @@
control message.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobarbaz
-.It Dv annexA
+.Bl -tag -width ".Va auto1023"
+.It Va annexA
ITU Annex A LMI hook.
-.It Dv annexD
+.It Va annexD
ANSI Annex D LMI hook.
-.It Dv group4
+.It Va group4
Group-of-four LMI hook.
-.It Dv auto0
+.It Va auto0
Auto-detection hook for DLCI 0.
-.It Dv auto1023
+.It Va auto1023
Auto-detection hook for DLCI 1023.
.El
.Sh CONTROL MESSAGES
@@ -108,8 +109,8 @@
u_char hook[12]; /* Active hook */
u_char fixed; /* If set to fixed LMI mode */
u_char autod; /* If currently auto-detecting */
- u_char seen[NGM_LMI_STAT_ARYSIZE]; /* bitmap DLCIs seen */
- u_char up[NGM_LMI_STAT_ARYSIZE]; /* bitmap DLCIs up */
+ u_char seen[NGM_LMI_STAT_ARYSIZE]; /* DLCIs ever seen */
+ u_char up[NGM_LMI_STAT_ARYSIZE]; /* DLCIs currently up */
};
.Ed
.It Dv NGM_TEXT_STATUS
Modified: trunk/share/man/man4/ng_mppc.4
===================================================================
--- trunk/share/man/man4/ng_mppc.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_mppc.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-2000 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -33,9 +34,9 @@
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
.\" $Whistle: ng_mppc.8,v 1.1 1999/12/08 20:20:39 archie Exp $
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_mppc.4 302061 2016-06-21 15:47:54Z pfg $
.\"
-.Dd December 8, 1999
+.Dd June 7, 2016
.Dt NG_MPPC 4
.Os
.Sh NAME
@@ -64,9 +65,8 @@
Each direction of traffic flow is independent of the other.
.Sh HOOKS
This node type supports the following hooks:
-.Pp
-.Bl -tag -compact -width vjc_vjuncomp
-.It Dv comp
+.Bl -tag -width ".Va decomp"
+.It Va comp
Connection to
.Xr ng_ppp 4
.Dv "comp"
@@ -73,7 +73,7 @@
hook.
Incoming frames are compressed and/or encrypted, and sent
back out the same hook.
-.It Dv decomp
+.It Va decomp
Connection to
.Xr ng_ppp 4
.Dv "decomp"
@@ -106,7 +106,7 @@
/* Configuration for a session */
struct ng_mppc_config {
u_char enable; /* enable */
- u_int32_t bits; /* config bits */
+ uint32_t bits; /* config bits */
u_char startkey[MPPE_KEY_LEN]; /* start key */
};
@@ -154,12 +154,6 @@
are supplied to selectively compile in either or both capabilities.
At least one of these must be defined, or else this node type is useless.
.Pp
-The MPPC protocol requires proprietary compression code available
-from Hi/Fn (formerly STAC).
-These files must be obtained elsewhere and added to the kernel
-sources before this node type will compile with the
-.Dv NETGRAPH_MPPC_COMPRESSION
-option.
.Sh SEE ALSO
.Xr netgraph 4 ,
.Xr ng_ppp 4 ,
Modified: trunk/share/man/man4/ng_nat.4
===================================================================
--- trunk/share/man/man4/ng_nat.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_nat.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2005 Gleb Smirnoff <glebius at FreeBSD.org>
.\" All rights reserved.
.\"
@@ -22,9 +23,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_nat.4 299386 2016-05-10 20:12:27Z wblock $
.\"
-.Dd March 1, 2008
+.Dd March 21, 2013
.Dt NG_NAT 4
.Os
.Sh NAME
@@ -44,7 +45,7 @@
engine for packet aliasing.
.Sh HOOKS
This node type has two hooks:
-.Bl -tag -width indent
+.Bl -tag -width ".Va out"
.It Va out
Packets received on this hook are considered outgoing and will be
masqueraded to a configured address.
@@ -54,13 +55,13 @@
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_NAT_SET_IPADDR Pq Li setaliasaddr
+.Bl -tag -width foo
+.It Dv NGM_NAT_SET_IPADDR Pq Ic setaliasaddr
Configure aliasing address for a node.
After both hooks have been connected and aliasing address was configured,
a node is ready for aliasing operation.
-.It Dv NGM_NAT_SET_MODE Pq Li setmode
-Set node's operation mode using supplied
+.It Dv NGM_NAT_SET_MODE Pq Ic setmode
+Set node's operation mode using supplied
.Vt "struct ng_nat_mode" .
.Bd -literal
struct ng_nat_mode {
@@ -76,11 +77,11 @@
#define NG_NAT_PROXY_ONLY 0x40
#define NG_NAT_REVERSE 0x80
.Ed
-.It Dv NGM_NAT_SET_TARGET Pq Li settarget
+.It Dv NGM_NAT_SET_TARGET Pq Ic settarget
Configure target address for a node.
-When an incoming packet not associated with any pre-existing aliasing
+When an incoming packet not associated with any pre-existing aliasing
link arrives at the host machine, it will be sent to the specified address.
-.It Dv NGM_NAT_REDIRECT_PORT Pq Li redirectport
+.It Dv NGM_NAT_REDIRECT_PORT Pq Ic redirectport
Redirect incoming connections arriving to given port(s) to
another host and port(s).
The following
@@ -106,7 +107,7 @@
list of static redirects which later can be retrieved by
.Dv NGM_NAT_LIST_REDIRECTS
message.
-.It Dv NGM_NAT_REDIRECT_ADDR Pq Li redirectaddr
+.It Dv NGM_NAT_REDIRECT_ADDR Pq Ic redirectaddr
Redirect traffic for public IP address to a machine on the
local network.
This function is known as
@@ -123,7 +124,7 @@
.Ed
.Pp
Unique ID for this redirection is returned as response to this message.
-.It Dv NGM_NAT_REDIRECT_PROTO Pq Li redirectproto
+.It Dv NGM_NAT_REDIRECT_PROTO Pq Ic redirectproto
Redirect incoming IP packets of protocol
.Va proto
(see
@@ -143,7 +144,7 @@
.Ed
.Pp
Unique ID for this redirection is returned as response to this message.
-.It Dv NGM_NAT_REDIRECT_DYNAMIC Pq Li redirectdynamic
+.It Dv NGM_NAT_REDIRECT_DYNAMIC Pq Ic redirectdynamic
Mark redirection with specified ID as dynamic, i.e., it will serve
for exactly one next connection and then will be automatically
deleted from internal links table.
@@ -152,10 +153,10 @@
user-visible list of static redirects (available through
.Dv NGM_NAT_LIST_REDIRECTS
message).
-.It Dv NGM_NAT_REDIRECT_DELETE Pq Li redirectdelete
+.It Dv NGM_NAT_REDIRECT_DELETE Pq Ic redirectdelete
Delete redirection with specified ID (currently active
connections are not affected).
-.It Dv NGM_NAT_ADD_SERVER Pq Li addserver
+.It Dv NGM_NAT_ADD_SERVER Pq Ic addserver
Add another server to a pool.
This is used to transparently offload network load on a single server
and distribute the load across a pool of servers, also known as
@@ -191,7 +192,7 @@
are also ignored after
.Dv NGM_NAT_ADD_SERVER
was used (they are effectively replaced by server pool).
-.It Dv NGM_NAT_LIST_REDIRECTS Pq Li listredirects
+.It Dv NGM_NAT_LIST_REDIRECTS Pq Ic listredirects
Return list of configured static redirects as
.Vt "struct ng_nat_list_redirects" .
.Bd -literal
@@ -233,12 +234,37 @@
and
.Va local_port
are also meaningless.
-.It Dv NGM_NAT_PROXY_RULE Pq Li proxyrule
+.It Dv NGM_NAT_PROXY_RULE Pq Ic proxyrule
Specify a transparent proxying rule (string must be
supplied as argument).
See
.Xr libalias 3
for details.
+.It Dv NGM_NAT_LIBALIAS_INFO Pq Ic libaliasinfo
+Return internal statistics of
+.Xr libalias 3
+instance as
+.Vt "struct ng_nat_libalias_info" .
+.Bd -literal
+struct ng_nat_libalias_info {
+ uint32_t icmpLinkCount;
+ uint32_t udpLinkCount;
+ uint32_t tcpLinkCount;
+ uint32_t sctpLinkCount;
+ uint32_t pptpLinkCount;
+ uint32_t protoLinkCount;
+ uint32_t fragmentIdLinkCount;
+ uint32_t fragmentPtrLinkCount;
+ uint32_t sockCount;
+};
+.Ed
+In case of
+.Nm
+failed to retrieve a certain counter
+from its
+.Xr libalias
+instance, the corresponding field is returned as
+.Va UINT32_MAX .
.El
.Pp
In all redirection messages
Modified: trunk/share/man/man4/ng_netflow.4
===================================================================
--- trunk/share/man/man4/ng_netflow.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_netflow.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2004-2005 Gleb Smirnoff <glebius at FreeBSD.org>
.\" All rights reserved.
.\"
@@ -22,9 +23,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_netflow.4 244082 2012-12-10 13:08:14Z glebius $
.\"
-.Dd Nov 2, 2012
+.Dd December 10, 2012
.Dt NG_NETFLOW 4
.Os
.Sh NAME
@@ -61,7 +62,6 @@
.Pp
Node supports IPv6 accounting (NetFlow v9 only) and is aware of multiple fibs.
Different fibs are mapped to different domain_id in NetFlow V9 and different engine_id in NetFlow V5.
-.Pp
.Sh HOOKS
This node type supports up to
.Dv NG_NETFLOW_MAXIFACES
@@ -72,9 +72,9 @@
.Va out0 , out1 ,
etc.,
plus two export hooks:
-.Va export
+.Va export
(for NetFlow version 5) and
-.Va export9
+.Va export9
(for NetFlow version 9). Export can be done simultaneously for all supported
export hooks. By default (ingress NetFlow enabled) node does NetFlow accounting of data
received on
@@ -100,7 +100,7 @@
node.
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NGM_NETFLOW_INFO Pq Ic info
Returns some node statistics and the current timeout values in a
.Vt "struct ng_netflow_info" .
@@ -113,7 +113,18 @@
Sets data link type on the
.Va iface Ns Ar N
hook.
-Currently, supported types are raw IP datagrams and Ethernet.
+Currently, supported types are
+.Cm DLT_RAW
+(raw IP datagrams) and
+.Cm DLT_EN10MB
+(Ethernet).
+DLT_ definitions can be found in
+.In net/bpf.h
+header.
+Currently used values are 1 for
+.Cm DLT_EN10MB
+and 12 for
+.Cm DLT_RAW .
This message type uses
.Vt "struct ng_netflow_setdlt"
as an argument:
@@ -181,20 +192,38 @@
#define NG_NETFLOW_CONF_EGRESS 2
#define NG_NETFLOW_CONF_ONCE 4
#define NG_NETFLOW_CONF_THISONCE 8
+#define NG_NETFLOW_CONF_NOSRCLOOKUP 16
+#define NG_NETFLOW_CONF_NODSTLOOKUP 32
};
.Ed
.Pp
Configuration is a bitmask of several options. Option NG_NETFLOW_CONF_INGRESS
enabled by default enables ingress NetFlow generation (for data coming from
-ifaceX hook). Option NG_NETFLOW_CONF_EGRESS enables egress NetFlow (for data
-coming from outX hook). Option NG_NETFLOW_CONF_ONCE defines that packet should
-be accounted only once if it several times passes via netflow node. Option
-NG_NETFLOW_CONF_THISONCE defines that packet should be accounted only once
-if it several times passes via exactly this netflow node. Last two options are
-important to avoid duplicate accounting when both ingress and egress NetFlow
-are enabled.
+ifaceX hook).
+Option
+.Va NG_NETFLOW_CONF_EGRESS
+enables egress NetFlow (for data coming from outX hook).
+Option
+.Va NG_NETFLOW_CONF_ONCE
+defines that packet should be accounted only once if it several times passes
+via netflow node.
+Option
+.Va NG_NETFLOW_CONF_THISONCE
+defines that packet should be accounted only once if it several times passes
+via exactly this netflow node.
+These two options are important to avoid duplicate accounting when both ingress
+and egress NetFlow are enabled.
+Option
+.Va NG_NETFLOW_CONF_NOSRCLOOKUP
+skips radix lookup on flow source address used to fill in network mask.
+Option
+.Va NG_NETFLOW_CONF_NODSTLOOKUP
+skips radix lookup on destination (which fills egress interface id, destination
+mask and gateway).
+If one doesn't need data provided by lookups, he/she can disable them, to reduce
+load on routers.
.It Dv NGM_NETFLOW_SETTEMPLATE Pq Ic settemplate
-Sets various timeouts to announce data flow templates
+Sets various timeouts to announce data flow templates
(NetFlow v9-specific). This message requires
.Vt "struct ng_netflow_settemplate"
as an argument:
@@ -209,7 +238,7 @@
Value of packets field represents maximum packets count between
re-announcing data templates.
.It Dv NGM_NETFLOW_SETMTU Pq Ic setmtu
-Sets export interface MTU to build packets of specified size (NetFlow v9-specific).
+Sets export interface MTU to build packets of specified size (NetFlow v9-specific).
This message requires
.Vt "struct ng_netflow_setmtu"
as an argument:
@@ -226,9 +255,6 @@
.Xr flowctl 8 ,
not directly from
.Xr ngctl 8 .
-See also
-.Sx BUGS
-section.
.It Dv NGM_NETFLOW_V9INFO Pq Ic v9info
Returns some NetFlow v9 related values in a
.Bd -literal -offset 4n
@@ -321,7 +347,6 @@
Cache snapshot obtained via
.Dv NGM_NETFLOW_SHOW
command may lack some percentage of entries under severe load.
-IPv6 flows are not shown.
.Pp
The
.Nm
Modified: trunk/share/man/man4/ng_one2many.4
===================================================================
--- trunk/share/man/man4/ng_one2many.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_one2many.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2000 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,9 +33,9 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_one2many.4 242997 2012-11-13 20:41:36Z joel $
.\"
-.Dd March 1, 2011
+.Dd November 13, 2012
.Dt NG_ONE2MANY 4
.Os
.Sh NAME
@@ -107,7 +108,7 @@
The node distinguishes between active and failed links.
Data is sent only to active links.
The following link failure detection algorithms are available:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NG_ONE2MANY_FAIL_MANUAL
The node is explicitly told which of the links are up via the
.Dv NGM_ONE2MANY_SET_CONFIG
@@ -149,7 +150,7 @@
This node type supports the generic control messages, plus the
following:
.Bl -tag -width foo
-.It Dv NGM_ONE2MANY_SET_CONFIG
+.It Dv NGM_ONE2MANY_SET_CONFIG Pq Ic setconfig
Sets the node configuration using a
.Dv "struct ng_one2many_link_config"
as the control message argument:
@@ -156,8 +157,8 @@
.Bd -literal
/* Node configuration structure */
struct ng_one2many_config {
- u_int32_t xmitAlg; /* how to distribute packets */
- u_int32_t failAlg; /* how to detect link failure */
+ uint32_t xmitAlg; /* how to distribute packets */
+ uint32_t failAlg; /* how to detect link failure */
u_char enabledLinks[NG_ONE2MANY_MAX_LINKS];
};
.Ed
@@ -174,10 +175,10 @@
.Dv NG_ONE2MANY_FAIL_MANUAL
(default) or
.Dv NG_ONE2MANY_FAIL_NOTIFY .
-.It Dv NGM_ONE2MANY_GET_CONFIG
+.It Dv NGM_ONE2MANY_GET_CONFIG Pq Ic getconfig
Returns the current node configuration in a
.Dv "struct ng_one2many_link_config" .
-.It Dv NGM_ONE2MANY_GET_STATS
+.It Dv NGM_ONE2MANY_GET_STATS Pq Ic getstats
This command takes a 32 bit link number as an argument and
returns a
.Dv "struct ng_one2many_link_stats"
@@ -187,10 +188,11 @@
.Bd -literal
/* Statistics structure (one for each link) */
struct ng_one2many_link_stats {
- u_int64_t recvOctets; /* total octets rec'd on link */
- u_int64_t recvPackets; /* total pkts rec'd on link */
- u_int64_t xmitOctets; /* total octets xmit'd on link */
- u_int64_t xmitPackets; /* total pkts xmit'd on link */
+ uint64_t recvOctets; /* total octets rec'd on link */
+ uint64_t recvPackets; /* total pkts rec'd on link */
+ uint64_t xmitOctets; /* total octets xmit'd on link */
+ uint64_t xmitPackets; /* total pkts xmit'd on link */
+ uint64_t memoryFailures; /* times couldn't get mem or mbuf */
};
.Ed
.Pp
@@ -198,10 +200,10 @@
.Dv one
link, use the link number
.Dv -1 .
-.It Dv NGM_ONE2MANY_CLR_STATS
+.It Dv NGM_ONE2MANY_CLR_STATS Pq Ic clrstats
This command takes a 32 bit link number as an argument and
clears the statistics for that link.
-.It Dv NGM_ONE2MANY_GETCLR_STATS
+.It Dv NGM_ONE2MANY_GETCLR_STATS Pq Ic getclrstats
Same as
.Dv NGM_ONE2MANY_GET_STATS ,
but also atomically clears the statistics for the link as well.
Modified: trunk/share/man/man4/ng_patch.4
===================================================================
--- trunk/share/man/man4/ng_patch.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_patch.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2010 Maxim Ignatenko <gelraen.ua at gmail.com>
.\" Copyright (c) 2010 Vadim Goncharov <vadimnuclight at tpu.ru>
.\" All rights reserved.
@@ -23,7 +24,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_patch.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd March 5, 2012
.Dt NG_PATCH 4
@@ -57,7 +58,7 @@
are taken as a single integer in network byte order.
.Sh HOOKS
This node type has two hooks:
-.Bl -tag -width indent
+.Bl -tag -width ".Va out"
.It Va in
Packets received on this hook are modified according to rules specified
in config and then forwarded to
@@ -73,8 +74,8 @@
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_PATCH_SETCONFIG Pq Li setconfig
+.Bl -tag -width foo
+.It Dv NGM_PATCH_SETCONFIG Pq Ic setconfig
This command sets the sequence of modify operations
that will be applied to incoming data on a hook.
The following
@@ -115,16 +116,16 @@
The
.Nm
node does not do any checksum correction by itself.
-.It Dv NGM_PATCH_GETCONFIG Pq Li getconfig
+.It Dv NGM_PATCH_GETCONFIG Pq Ic getconfig
This control message obtains current set of modify operations,
returned as
.Vt "struct ng_patch_config" .
-.It Dv NGM_PATCH_GET_STATS Pq Li getstats
+.It Dv NGM_PATCH_GET_STATS Pq Ic getstats
Returns node statistics as a
.Vt "struct ng_patch_stats" .
-.It Dv NGM_PATCH_CLR_STATS Pq Li clrstats
+.It Dv NGM_PATCH_CLR_STATS Pq Ic clrstats
Clear node statistics.
-.It Dv NGM_PATCH_GETCLR_STATS Pq Li getclrstats
+.It Dv NGM_PATCH_GETCLR_STATS Pq Ic getclrstats
This command is identical to
.Dv NGM_PATCH_GET_STATS ,
except that the statistics are also atomically cleared.
Modified: trunk/share/man/man4/ng_ppp.4
===================================================================
--- trunk/share/man/man4/ng_ppp.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_ppp.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,10 +33,10 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_ppp.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_ppp.8,v 1.3 1999/01/25 23:46:27 archie Exp $
.\"
-.Dd September 24, 2012
+.Dd November 13, 2012
.Dt NG_PPP 4
.Os
.Sh NAME
@@ -132,9 +133,9 @@
.Dv compress
and
.Dv decompress .
-Compression and decompression can be enabled by toggling the
+Compression and decompression can be enabled by toggling the
.Vt enableCompression
-and
+and
.Vt enableDecompression
fields of the node configuration structure.
(See below.)
@@ -143,7 +144,7 @@
is set to
.Dv NG_PPP_COMPRESS_SIMPLE ,
then all outgoing frames are sent to the
-.Dv compress
+.Dv compress
hook and all packets received on this hook are expected to be
compressed, so the COMPD tag is put on them unconditionally.
If
@@ -150,16 +151,16 @@
.Vt enableCompression
is set to
.Dv NG_PPP_COMPRESS_FULL ,
-then packets received on the
-.Dv compress
+then packets received on the
+.Dv compress
hook are resent as is.
The compressor node should put the tag, if the packet was compressed.
-If
+If
.Vt enableDecompression
-is set to
+is set to
.Dv NG_PPP_DECOMPRESS_SIMPLE ,
then the node will sent to the
-.Dv decompress
+.Dv decompress
hook only those frames, that are marked with the COMPD tag.
If
.Vt enableDecompression
@@ -290,48 +291,47 @@
across all of the links.
.Sh HOOKS
This node type supports the following hooks:
-.Pp
-.Bl -tag -compact -width vjc_vjuncomp
-.It Dv link<N>
+.Bl -tag -width ".Va vjc_vjuncomp"
+.It Va link<N>
Individual PPP link number
.Dv <N>
-.It Dv compress
+.It Va compress
Connection to compression engine
-.It Dv decompress
+.It Va decompress
Connection to decompression engine
-.It Dv encrypt
+.It Va encrypt
Connection to encryption engine
-.It Dv decrypt
+.It Va decrypt
Connection to decryption engine
-.It Dv vjc_ip
+.It Va vjc_ip
Connection to
.Xr ng_vjc 4
.Dv ip
hook
-.It Dv vjc_vjcomp
+.It Va vjc_vjcomp
Connection to
.Xr ng_vjc 4
.Dv vjcomp
hook
-.It Dv vjc_vjuncomp
+.It Va vjc_vjuncomp
Connection to
.Xr ng_vjc 4
.Dv vjuncomp
hook
-.It Dv vjc_vjip
+.It Va vjc_vjip
Connection to
.Xr ng_vjc 4
.Dv vjip
hook
-.It Dv inet
+.It Va inet
IP packet data
-.It Dv ipv6
+.It Va ipv6
IPv6 packet data
-.It Dv atalk
+.It Va atalk
AppleTalk packet data
-.It Dv ipx
+.It Va ipx
IPX packet data
-.It Dv bypass
+.It Va bypass
Bypass hook; frames have a four byte header consisting of
a link number and a PPP protocol number.
.El
@@ -338,7 +338,7 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_PPP_SET_CONFIG
+.It Dv NGM_PPP_SET_CONFIG Pq Ic setconfig
This command configures all aspects of the node.
This includes enabling
multi-link PPP, encryption, compression, Van Jacobson compression, and IP,
@@ -357,14 +357,14 @@
u_char enableLink; /* enable this link */
u_char enableProtoComp;/* enable protocol field compression */
u_char enableACFComp; /* enable addr/ctrl field compression */
- u_int16_t mru; /* peer MRU */
- u_int32_t latency; /* link latency (in milliseconds) */
- u_int32_t bandwidth; /* link bandwidth (in bytes/second) */
+ uint16_t mru; /* peer MRU */
+ uint32_t latency; /* link latency (in milliseconds) */
+ uint32_t bandwidth; /* link bandwidth (in bytes/sec/10) */
};
/* Bundle config structure */
struct ng_ppp_bund_conf {
- u_int16_t mrru; /* multilink peer MRRU */
+ uint16_t mrru; /* multilink peer MRRU */
u_char enableMultilink; /* enable multilink */
u_char recvShortSeq; /* recv multilink short seq # */
u_char xmitShortSeq; /* xmit multilink short seq # */
@@ -387,10 +387,10 @@
};
.Ed
.Pp
-.It Dv NGM_PPP_GET_CONFIG
+.It Dv NGM_PPP_GET_CONFIG Pq Ic getconfig
Returns the current configuration as a
.Dv "struct ng_ppp_node_conf" .
-.It Dv NGM_PPP_GET_LINK_STATS
+.It Dv NGM_PPP_GET_LINK_STATS Pq Ic getstats
This command takes a two byte link number as an argument and returns a
.Dv "struct ng_ppp_link_stat"
containing statistics for the corresponding link.
@@ -397,19 +397,19 @@
Here
.Dv NG_PPP_BUNDLE_LINKNUM
is a valid link number corresponding to the multi-link bundle.
-.It Dv NGM_PPP_GET_LINK_STATS64
-Same as NGM_PPP_GET_LINK_STATS but returns
+.It Dv NGM_PPP_GET_LINK_STATS64 Pq Ic getstats64
+Same as NGM_PPP_GET_LINK_STATS but returns
.Dv "struct ng_ppp_link_stat64"
containing 64bit counters.
-.It Dv NGM_PPP_CLR_LINK_STATS
+.It Dv NGM_PPP_CLR_LINK_STATS Pq Ic clrstats
This command takes a two byte link number as an argument and
clears the statistics for that link.
-.It Dv NGM_PPP_GETCLR_LINK_STATS
+.It Dv NGM_PPP_GETCLR_LINK_STATS Pq Ic getclrstats
Same as
.Dv NGM_PPP_GET_LINK_STATS ,
but also atomically clears the statistics as well.
-.It Dv NGM_PPP_GETCLR_LINK_STATS64
-Same as NGM_PPP_GETCLR_LINK_STATS but returns
+.It Dv NGM_PPP_GETCLR_LINK_STATS64 Pq Ic getclrstats64
+Same as NGM_PPP_GETCLR_LINK_STATS but returns
.Dv "struct ng_ppp_link_stat64"
containing 64bit counters.
.El
Modified: trunk/share/man/man4/ng_pppoe.4
===================================================================
--- trunk/share/man/man4/ng_pppoe.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_pppoe.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,10 +33,10 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_pppoe.4 331059 2018-03-16 15:10:13Z eugen $
.\" $Whistle: ng_pppoe.8,v 1.1 1999/01/25 23:46:27 archie Exp $
.\"
-.Dd December 27, 2007
+.Dd February 14, 2018
.Dt NG_PPPOE 4
.Os
.Sh NAME
@@ -67,8 +68,8 @@
control message.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width [unspecified]
-.It Dv ethernet
+.Bl -tag -width ".Va [unspecified]"
+.It Va ethernet
The hook that should normally be connected to an
.Xr ng_ether 4
node.
@@ -77,9 +78,9 @@
will send a message down this hook to determine Ethernet address of
the underlying node.
Obtained address will be stored and then used for outgoing datagrams.
-.It Dv debug
+.It Va debug
Presently no use.
-.It Dv [unspecified]
+.It Va [unspecified]
Any other name is assumed to be a session hook that will be connected to
a PPP client agent, or a PPP server agent.
.El
@@ -98,19 +99,40 @@
.It Dv NGM_TEXT_STATUS
This generic message returns a human-readable version of the node status.
(not yet)
-.It Dv NGM_PPPOE_CONNECT
+.It Dv NGM_PPPOE_CONNECT Pq Ic pppoe_connect
Tell a nominated newly created hook that its session should enter
the state machine as a client.
It must be newly created and a service name can be given as an argument.
It is legal to specify a zero-length service name, this is common
on some DSL setups.
-It is possible to request a connection to a specific
-access concentrator by its name using the "AC-Name\\Service-Name" syntax.
-A session request packet will be broadcasted on the Ethernet.
+It is possible to request a connection to a specific access concentrator,
+and/or set a specific Host-Uniq tag, required by some Internet providers,
+using the
+.Qq Li [AC-Name\\][Host-Uniq|]Service-Name
+syntax.
+To set a binary Host-Uniq, it must be encoded as a hexadecimal lowercase
+string and prefixed with
+.Qq Li 0x ,
+for example
+.Qq Li 0x6d792d746167
+is equivalent to
+.Qq Li my-tag .
+A session request packet will be broadcast on the Ethernet.
This command uses the
.Dv ngpppoe_init_data
structure shown below.
-.It Dv NGM_PPPOE_LISTEN
+For example, this init data argument can be used to
+connect to
+.Qq Li my-isp
+service with
+.Qq Li my-host
+uniq tag, accepting only
+.Qq Li remote-ac
+as access concentrator:
+.Bd -literal -offset indent
+"remote-ac\\my-host|my-isp"
+.Ed
+.It Dv NGM_PPPOE_LISTEN Pq Ic pppoe_listen
Tell a nominated newly created hook that its session should enter
the state machine as a server listener.
The argument
@@ -124,7 +146,7 @@
This command uses the
.Dv ngpppoe_init_data
structure shown below.
-.It Dv NGM_PPPOE_OFFER
+.It Dv NGM_PPPOE_OFFER Pq Ic pppoe_offer
Tell a nominated newly created hook that its session should enter
the state machine as a server.
The argument given is the name of the service to offer.
@@ -148,18 +170,18 @@
.Bd -literal -offset 4n
struct ngpppoe_init_data {
char hook[NG_HOOKSIZ]; /* hook to monitor on */
- u_int16_t data_len; /* service name length */
+ uint16_t data_len; /* length of the service name */
char data[0]; /* init data goes here */
};
.Ed
.Bl -tag -width 3n
-.It Dv NGM_PPPOE_SUCCESS
+.It Dv NGM_PPPOE_SUCCESS Pq Ic pppoe_success
This command is sent to the node that started this session with one of the
above messages, and reports a state change.
This message reports successful Session negotiation.
It uses the structure shown below, and
reports back the hook name corresponding to the successful session.
-.It Dv NGM_PPPOE_FAIL
+.It Dv NGM_PPPOE_FAIL Pq Ic pppoe_fail
This command is sent to the node that started this session with one of the
above messages, and reports a state change.
This message reports failed Session negotiation.
@@ -167,7 +189,7 @@
reports back the hook name corresponding to the failed session.
The hook will probably have been removed immediately after sending this
message.
-.It Dv NGM_PPPOE_CLOSE
+.It Dv NGM_PPPOE_CLOSE Pq Ic pppoe_close
This command is sent to the node that started this session with one of the
above messages, and reports a state change.
This message reports a request to close a session.
@@ -187,11 +209,11 @@
The four commands above use a common data structure:
.Bd -literal -offset 4n
struct ngpppoe_sts {
- char hook[NG_HOOKSIZ]; /* hook associated with event session */
+ char hook[NG_HOOKSIZ];
};
.Ed
.Bl -tag -width 3n
-.It Dv NGM_PPPOE_GETMODE
+.It Dv NGM_PPPOE_GETMODE Pq Ic pppoe_getmode
This command returns the current compatibility mode of the node
as a string.
.Tn ASCII
@@ -221,7 +243,7 @@
SOHO routers as clients, when serving only specific Service-Name.
This compatibility option does not affect client mode.
.El
-.It Dv NGM_PPPOE_SETMODE
+.It Dv NGM_PPPOE_SETMODE Pq Ic pppoe_setmode
Configure node to the specified mode.
The string argument is required.
This command understands the same keywords that are returned by the
@@ -235,7 +257,7 @@
.Bd -literal -offset indent
ngctl msg fxp0:orphans pppoe_setmode '"3Com"'
.Ed
-.It Dv NGM_PPPOE_SETENADDR
+.It Dv NGM_PPPOE_SETENADDR Pq Ic setenaddr
Set the node Ethernet address for outgoing datagrams.
This message is important when a node has failed to obtain an Ethernet
address from its peer on the
@@ -244,7 +266,55 @@
.Tn ASCII
form of this message is
.Qq Li setenaddr .
+.It Dv NGM_PPPOE_SETMAXP Pq Ic setmaxp
+Set the node PPP-Max-Payload value as described in RFC 4638.
+This message applies only to a client configuration.
+.Tn ASCII
+form of this message is
+.Qq Li setmaxp .
+.Pp
+Data structure returned to client is:
+.Bd -literal -offset 4n
+struct ngpppoe_maxp {
+ char hook[NG_HOOKSIZ];
+ uint16_t data;
+};
+.Ed
+.It Dv NGM_PPPOE_SEND_HURL Pq Ic send_hurl
+Tell a nominated hook with an active session to send a PADM message with
+a HURL tag.
+The argument is the URL to be delivered to the client:
+.Bd -literal -offset indent
+ngctl msg fxp0:orphans send_hurl '{ hook="myHook" data="http://example.net/cpe" }'
+.Ed
+.It Dv NGM_PPPOE_SEND_MOTM Pq Ic send_motm
+Tell a nominated hook with an active session to send a PADM message with
+a MOTM tag.
+The argument is the message to be delivered to the client:
+.Bd -literal -offset indent
+ngctl msg fxp0:orphans send_motm '{ hook="myHook" data="Welcome aboard" }'
+.Ed
.El
+.Pp
+The two commands above use the same ngpppoe_init_data structure described
+above.
+.Bl -tag -width 3n
+.It Dv NGM_PPPOE_HURL
+This command is sent to the node that started this session when a PADM
+message with a HURL tag is received, and contains a URL that the host can
+pass to a web browser for presentation to the user.
+.It Dv NGM_PPPOE_MOTM
+This command is sent to the node that started this session when a PADM
+message with a MOTM tag is received, and contains a Message Of The
+Minute that the host can display to the user.
+.El
+.Pp
+The two commands above use a common data structure:
+.Bd -literal -offset 4n
+struct ngpppoe_padm {
+ char msg[PPPOE_PADM_VALUE_SIZE];
+};
+.Ed
.Sh SHUTDOWN
This node shuts down upon receipt of a
.Dv NGM_SHUTDOWN
@@ -345,8 +415,8 @@
* The following is available about the node:
* ninfo->name (string)
* ninfo->type (string)
- * ninfo->id (u_int32_t)
- * ninfo->hooks (u_int32_t) (count of hooks)
+ * ninfo->id (uint32_t)
+ * ninfo->hooks (uint32_t) (count of hooks)
* check it is the correct type. and get it's ID for use
* with mkpeer later.
*/
@@ -366,8 +436,8 @@
* link->peerhook (string)
* peer->name (string)
* peer->type (string)
- * peer->id (u_int32_t)
- * peer->hooks (u_int32_t)
+ * peer->id (uint32_t)
+ * peer->hooks (uint32_t)
*/
link = &hlist->link[k];
peer = &hlist->link[k].nodeinfo;
Modified: trunk/share/man/man4/ng_pptpgre.4
===================================================================
--- trunk/share/man/man4/ng_pptpgre.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_pptpgre.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,10 +33,10 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_pptpgre.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_pptpgre.8,v 1.2 1999/12/08 00:20:53 archie Exp $
.\"
-.Dd March 29, 2008
+.Dd November 13, 2012
.Dt NG_PPTPGRE 4
.Os
.Sh NAME
@@ -72,19 +73,18 @@
node.
.Sh HOOKS
This node type supports the following hooks:
-.Pp
-.Bl -tag -compact -width ".Li session_hhhh"
-.It Li session_hhhh
+.Bl -tag -width ".Va session_hhhh"
+.It Va session_hhhh
Session 0xhhhh data packets to the upper protocol layers
-.It Li upper
+.It Va upper
Same as session_hhhh, but for single session with configurable cid (legacy)
-.It Li lower
+.It Va lower
Connection to the lower protocol layers
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_PPTPGRE_SET_CONFIG
+.Bl -tag -width foo
+.It Dv NGM_PPTPGRE_SET_CONFIG Pq Ic setconfig
This command resets and configures hook for a session. If corresponding
session_hhhh hook is not connected, upper hook will be configured.
This command takes a
@@ -95,12 +95,12 @@
struct ng_pptpgre_conf {
u_char enabled; /* enables traffic flow */
u_char enableDelayedAck; /* enables delayed acks */
- u_char enableAlwaysAck; /* always send ack with data */
+ u_char enableAlwaysAck; /* always include ack with data */
u_char enableWindowing; /* enable windowing algorithm */
- u_int16_t cid; /* my call id */
- u_int16_t peerCid; /* peer call id */
- u_int16_t recvWin; /* peer recv window size */
- u_int16_t peerPpd; /* peer packet processing delay
+ uint16_t cid; /* my call id */
+ uint16_t peerCid; /* peer call id */
+ uint16_t recvWin; /* peer recv window size */
+ uint16_t peerPpd; /* peer packet processing delay
(in 1/10 of a second) */
};
.Ed
@@ -124,16 +124,16 @@
L2TP, the successor to PPTP, removes it.
.Pp
The remaining fields are as supplied by the PPTP virtual call setup process.
-.It Dv NGM_PPTPGRE_GET_CONFIG
+.It Dv NGM_PPTPGRE_GET_CONFIG Pq Ic getconfig
Takes two byte argument as cid and returns the current configuration as a
.Vt "struct ng_pptpgre_conf" .
-.It Dv NGM_PPTPGRE_GET_STATS
+.It Dv NGM_PPTPGRE_GET_STATS Pq Ic getstats
This command returns a
.Vt "struct ng_pptpgre_stats"
containing various node statistics.
-.It Dv NGM_PPTPGRE_CLR_STATS
+.It Dv NGM_PPTPGRE_CLR_STATS Pq Ic clrstats
This command resets the node statistics.
-.It Dv NGM_PPTPGRE_GETCLR_STATS
+.It Dv NGM_PPTPGRE_GETCLR_STATS Pq Ic getclrstats
This command atomically gets and resets the node statistics, returning a
.Vt "struct ng_pptpgre_stats" .
.El
Modified: trunk/share/man/man4/ng_pred1.4
===================================================================
--- trunk/share/man/man4/ng_pred1.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_pred1.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2006, Alexander Motin <mav at alkar.net>
.\" All rights reserved.
@@ -24,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_pred1.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd December 24, 2006
.Dt NG_PRED1 4
@@ -38,7 +39,7 @@
.Sh DESCRIPTION
The
.Nm pred1
-node type implements the Predictor-1 sub-protocols of the Compression Control
+node type implements the Predictor-1 sub-protocols of the Compression Control
Protocol (CCP).
.Pp
The node has two hooks,
@@ -54,7 +55,7 @@
.Sh HOOKS
This node type supports the following hooks:
.Pp
-.Bl -tag -compact -width decomp
+.Bl -tag -compact -width ".Va decomp"
.It Va comp
Connection to
.Xr ng_ppp 4
@@ -74,7 +75,7 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_PRED1_CONFIG Pq Li config
+.It Dv NGM_PRED1_CONFIG Pq Ic config
This command resets and configures the node for a session
(i.e., for compression or decompression).
This command takes a
@@ -88,7 +89,7 @@
The
.Ft enable
field enables traffic flow through the node.
-.It Dv NGM_PRED1_RESETREQ Pq Li resetreq
+.It Dv NGM_PRED1_RESETREQ Pq Ic resetreq
This message contains no arguments, and is bi-directional.
If an error is detected during decompression, this message is sent by the
node to the originator of the
@@ -98,9 +99,9 @@
.Pp
This message may also be received by this node type when a CCP Reset-Request
or Reset-Ack is received by the local PPP entity.
-The node will respond by flushing its compression state so the sides
+The node will respond by flushing its compression state so the sides
can resynchronize.
-.It Dv NGM_PRED1_GET_STATS Pq Li getstats
+.It Dv NGM_PRED1_GET_STATS Pq Ic getstats
This control message obtains statistics for a given hook.
The statistics are returned in
.Vt "struct ng_pred1_stats" :
@@ -114,9 +115,9 @@
uint64_t Errors;
};
.Ed
-.It Dv NGM_PRED1_CLR_STATS Pq Li clrstats
+.It Dv NGM_PRED1_CLR_STATS Pq Ic clrstats
This control message clears statistics for a given hook.
-.It Dv NGM_PRED1_GETCLR_STATS Pq Li getclrstats
+.It Dv NGM_PRED1_GETCLR_STATS Pq Ic getclrstats
This control message obtains and clears statistics for a given hook.
.El
.Sh SHUTDOWN
@@ -141,5 +142,5 @@
.An Alexander Motin Aq mav at alkar.net
.Sh BUGS
Due to nature of netgraph PPP implementation there are possible race conditions
-between data packet and ResetAck CCP packet in case of packet loss. As result,
+between data packet and ResetAck CCP packet in case of packet loss. As result,
packet loss can produce bigger performance degradation than supposed by protocol.
Modified: trunk/share/man/man4/ng_rfc1490.4
===================================================================
--- trunk/share/man/man4/ng_rfc1490.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_rfc1490.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_rfc1490.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_rfc1490.8,v 1.4 1999/01/25 23:46:27 archie Exp $
.\"
.Dd January 19, 1999
@@ -78,20 +79,20 @@
node.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobarbazum
-.It Dv downstream
+.Bl -tag -width ".Va downstream"
+.It Va downstream
Connects to the RFC 1490 peer entity.
-.It Dv ethernet
+.It Va ethernet
Transmits and receives bridged raw Ethernet frames, without a checksum.
-.It Dv inet
+.It Va inet
Transmits and receives raw IP frames.
-.It Dv ppp
+.It Va ppp
Transmits and receives PPP frames.
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_RFC1490_SETENCAP
+.Bl -tag -width foo
+.It Dv NGM_RFC1490_SET_ENCAP Pq Ic setencap
This command sets encapsulation method for the node.
The desired method must be passed as a string message argument,
and must be one of the following supported encapsulation modes:
@@ -105,7 +106,7 @@
IP packets are sent and received using proprietary Cisco encapsulation
method.
.El
-.It Dv NGM_RFC1490_GETENCAP
+.It Dv NGM_RFC1490_GET_ENCAP Pq Ic getencap
This command returns current encapsulation method on the node.
.El
.Sh SHUTDOWN
Modified: trunk/share/man/man4/ng_socket.4
===================================================================
--- trunk/share/man/man4/ng_socket.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_socket.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_socket.4 235317 2012-05-12 03:25:46Z gjb $
.\" $Whistle: ng_socket.8,v 1.5 1999/01/25 23:46:27 archie Exp $
.\"
.Dd January 19, 1999
Modified: trunk/share/man/man4/ng_source.4
===================================================================
--- trunk/share/man/man4/ng_source.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_source.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright 2002-2007 Sandvine Inc.
.\" All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" DAMAGE.
.\"
.\" Author: Dave Chapeskie
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_source.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd March 1, 2007
.Dt NG_SOURCE 4
@@ -111,10 +112,10 @@
which must be sent with the
.Dv NGM_SOURCE_COOKIE
attached.
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NGM_SOURCE_GET_STATS Pq Ic getstats
Returns a structure containing the following fields:
-.Bl -tag -width indent
+.Bl -tag -width ".Va elapsedTime"
.It Va outOctets
The number of octets/bytes sent out the
.Va output
@@ -185,7 +186,7 @@
.Vt "struct timeval" )
should be inserted in the transmitted packets.
This message requires a structure containing the following fields:
-.Bl -tag -width indent
+.Bl -tag -width ".Va offset"
.It Va offset
The offset from the beginning of the packet at which the timestamp is to be
inserted.
@@ -200,7 +201,7 @@
packets.
Up to four counters may be independently configured.
This message requires a structure containing the following fields:
-.Bl -tag -width indent
+.Bl -tag -width ".Va increment"
.It Va offset
The offset from the beginning of the packet at which the counter is to be
inserted.
Modified: trunk/share/man/man4/ng_split.4
===================================================================
--- trunk/share/man/man4/ng_split.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_split.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001 FreeBSD inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Julian Elischer <julian at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_split.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd February 19, 2001
.Dt NG_SPLIT 4
@@ -49,17 +50,17 @@
two separate unidirectional streams of packets.
.Sh HOOKS
This node type supports the following three hooks:
-.Bl -tag -width foobar
-.It Dv in
+.Bl -tag -width ".Va mixed"
+.It Va in
Packets received on
.Em in
are forwarded to
.Em mixed .
-.It Dv out
+.It Va out
Packets received on
.Em out
will be discarded as illegal.
-.It Dv mixed
+.It Va mixed
Packets received on
.Em mixed
are forwarded to
Modified: trunk/share/man/man4/ng_sppp.4
===================================================================
--- trunk/share/man/man4/ng_sppp.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_sppp.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (C) 2003-2004 Cronyx Engineering.
.\" Copyright (C) 2003-2004 Roman Kurakin <rik at cronyx.ru>
.\"
@@ -10,7 +11,7 @@
.\" works or modified versions.
.\"
.\" Cronyx Id: ng_sppp.4,v 1.1.2.3 2004/03/30 14:28:34 rik Exp $
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_sppp.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd February 3, 2005
.Dt NG_SPPP 4
@@ -99,8 +100,8 @@
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_IFACE_GET_IFNAME
+.Bl -tag -width foo
+.It Dv NGM_SPPP_GET_IFNAME Pq Ic getifname
Returns the name of the associated interface as a
.Dv NUL Ns -terminated
.Tn ASCII
Modified: trunk/share/man/man4/ng_sscfu.4
===================================================================
--- trunk/share/man/man4/ng_sscfu.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_sscfu.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001-2003
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
@@ -26,7 +27,7 @@
.\"
.\" Author: Hartmut Brandt <harti at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_sscfu.4 242997 2012-11-13 20:41:36Z joel $
.\"
.\" ng_sscfu(4) man page
.\"
@@ -123,8 +124,8 @@
The
.Nm sscfu
node understands the generic messages plus the following:
-.Bl -tag -width indent
-.It Dv NGM_SSCFU_GETDEFPARAM
+.Bl -tag -width foo
+.It Dv NGM_SSCFU_GETDEFPARAM Pq Ic getdefparam
This message returns a
.Vt sscop_param
structure, which contains the default parameters for the SSCOP at the
@@ -132,22 +133,22 @@
This structure should be used for a
.Dv NGM_SSCOP_SETPARAM
message to the SSCOP node below the SSCF.
-.It Dv NGM_SSCFU_ENABLE
+.It Dv NGM_SSCFU_ENABLE Pq Ic enable
This message creates the actual SSCF instance and initializes it.
Until this is done, parameters may neither be retrieved nor set,
and all messages
received on any hook are discarded.
-.It Dv NGM_SSCFU_DISABLE
+.It Dv NGM_SSCFU_DISABLE Pq Ic disable
Destroy the SSCF instance.
After this, all messages on any hooks are discarded.
-.It Dv NGM_SSCFU_GETDEBUG
+.It Dv NGM_SSCFU_GETDEBUG Pq Ic getdebug
Retrieve the debugging flags in a
.Vt uint32_t .
-.It Dv NGM_SSCFU_SETDEBUG
+.It Dv NGM_SSCFU_SETDEBUG Pq Ic setdebug
Set debugging flags.
The argument must be a
.Vt uint32_t .
-.It Dv NGM_SSCFU_GETSTATE
+.It Dv NGM_SSCFU_GETSTATE Pq Ic getstate
Retrieve the current state of the SSCFU instance in a
.Vt uint32_t .
If the node has not been enabled, 0 is returned.
Modified: trunk/share/man/man4/ng_sscop.4
===================================================================
--- trunk/share/man/man4/ng_sscop.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_sscop.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001-2003
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
@@ -26,7 +27,7 @@
.\"
.\" Author: Hartmut Brandt <harti at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_sscop.4 242997 2012-11-13 20:41:36Z joel $
.\"
.\" ng_sscop(4) man page
.\"
@@ -204,8 +205,8 @@
The
.Nm sscop
node understands the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_SSCOP_SETPARAM
+.Bl -tag -width foo
+.It Dv NGM_SSCOP_SETPARAM Pq Ic setparam
Sets operational parameters of the SSCOP instance and takes the
following structure:
.Bd -literal
@@ -312,28 +313,28 @@
is an
.Xr errno 2
code describing why the parameter could not be set.
-.It Dv NGM_SSCOP_GETPARAM
+.It Dv NGM_SSCOP_GETPARAM Pq Ic getparam
This message returns the current operational parameters of the SSCOP
instance in a
.Vt sscop_param
structure.
-.It Dv NGM_SSCOP_ENABLE
+.It Dv NGM_SSCOP_ENABLE Pq Ic enable
This message creates the actual SSCOP instance and initializes it.
Until this is done, parameters may neither be retrieved nor set, and all
messages received on any hook are discarded.
-.It Dv NGM_SSCOP_DISABLE
+.It Dv NGM_SSCOP_DISABLE Pq Ic disable
Destroy the SSCOP instance.
After this, all messages on any hooks are
discarded.
-.It Dv NGM_SSCOP_SETDEBUG
+.It Dv NGM_SSCOP_SETDEBUG Pq Ic setdebug
Set debugging flags.
The argument is a
.Vt uint32_t .
-.It Dv NGM_SSCOP_GETDEBUG
+.It Dv NGM_SSCOP_GETDEBUG Pq Ic getdebug
Retrieve the actual debugging flags.
Needs no arguments and responds with a
.Vt uint32_t .
-.It Dv NGM_SSCOP_GETSTATE
+.It Dv NGM_SSCOP_GETSTATE Pq Ic getstate
Responds with the current state of the SSCOP instance in a
.Vt uint32_t .
If the node is not enabled, the retrieved state is 0.
@@ -352,7 +353,7 @@
At the upper layer interface, the
.Nm sscop
node handles three types of flow control messages:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv NGM_HIGH_WATER_PASSED
If this message is received, the SSCOP stops moving the receive window.
Each time a data message is handed over to the upper layer, the receive
Modified: trunk/share/man/man4/ng_tag.4
===================================================================
--- trunk/share/man/man4/ng_tag.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_tag.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2006 Vadim Goncharov <vadimnuclight at tpu.ru>
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_tag.4 249373 2013-04-11 18:46:41Z joel $
.\"
.Dd June 10, 2006
.Dt NG_TAG 4
@@ -112,8 +113,8 @@
The safe way is to create all hooks first, then begin to configure them.
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_TAG_SET_HOOKIN
+.Bl -tag -width foo
+.It Dv NGM_TAG_SET_HOOKIN Pq Ic sethookin
This command sets tag values which will be searched in the tag list of
incoming packets on a hook.
The following structure must be supplied as an argument:
@@ -149,7 +150,7 @@
If
.Va strip
flag is non-zero, then found tag is deleted from list of packet tags.
-.It Dv NGM_TAG_GET_HOOKIN
+.It Dv NGM_TAG_GET_HOOKIN Pq Ic gethookin
This command takes an
.Tn ASCII
string argument, the hook name, and returns the
@@ -156,7 +157,7 @@
corresponding
.Vt "struct ng_tag_hookin"
as shown above.
-.It Dv NGM_TAG_SET_HOOKOUT
+.It Dv NGM_TAG_SET_HOOKOUT Pq Ic sethookout
This command sets tags values which will be applied to outgoing
packets.
The following structure must be supplied as an argument:
@@ -175,7 +176,7 @@
Other variables mean basically the same as in
.Vt "struct ng_tag_hookin"
shown above, except used for setting values in a new tag.
-.It Dv NGM_TAG_GET_HOOKOUT
+.It Dv NGM_TAG_GET_HOOKOUT Pq Ic gethookout
This command takes an
.Tn ASCII
string argument, the hook name, and returns the
@@ -182,18 +183,18 @@
corresponding
.Vt "struct ng_tag_hookout"
as shown above.
-.It Dv NGM_TAG_GET_STATS
+.It Dv NGM_TAG_GET_STATS Pq Ic getstats
This command takes an
.Tn ASCII
string argument, the hook name, and returns the
statistics associated with the hook as a
.Vt "struct ng_tag_hookstat" .
-.It Dv NGM_TAG_CLR_STATS
+.It Dv NGM_TAG_CLR_STATS Pq Ic clrstats
This command takes an
.Tn ASCII
string argument, the hook name, and clears the
statistics associated with the hook.
-.It Dv NGM_TAG_GETCLR_STATS
+.It Dv NGM_TAG_GETCLR_STATS Pq Ic getclrstats
This command is identical to
.Dv NGM_TAG_GET_STATS ,
except that the statistics are also atomically cleared.
@@ -284,7 +285,7 @@
tag_id=412 }
.Ed
.Pp
-Don't forget to program
+Do not forget to program
.Xr ng_bpf 4
.Dq Li ipfw
hook with the above expression (see
Modified: trunk/share/man/man4/ng_tcpmss.4
===================================================================
--- trunk/share/man/man4/ng_tcpmss.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_tcpmss.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2005 Gleb Smirnoff
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_tcpmss.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd June 9, 2005
.Dt NG_TCPMSS 4
@@ -45,8 +46,8 @@
control message is used to configure a hook.
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following.
-.Bl -tag -width indent
-.It Dv NGM_TCPMSS_CONFIG Pq Li config
+.Bl -tag -width foo
+.It Dv NGM_TCPMSS_CONFIG Pq Ic config
This control message configures node to do given MSS adjusting on
a particular hook.
It requires the
@@ -69,7 +70,7 @@
.Va maxMSS .
After that, packets would be sent to hook
.Va outHook .
-.It Dv NGM_TCPMSS_GET_STATS Pq Li getstats
+.It Dv NGM_TCPMSS_GET_STATS Pq Ic getstats
This control message obtains statistics for a given hook.
The statistics are returned in
.Vt "struct ng_tcpmss_hookstat" :
@@ -82,9 +83,9 @@
uint64_t FixedPkts; /* changed packets */
};
.Ed
-.It Dv NGM_TCPMSS_CLR_STATS Pq Li clrstats
+.It Dv NGM_TCPMSS_CLR_STATS Pq Ic clrstats
This control message clears statistics for a given hook.
-.It Dv NGM_TCPMSS_GETCLR_STATS Pq Li getclrstats
+.It Dv NGM_TCPMSS_GETCLR_STATS Pq Ic getclrstats
This control message obtains and clears statistics for a given hook.
.El
.Sh EXAMPLES
Modified: trunk/share/man/man4/ng_tee.4
===================================================================
--- trunk/share/man/man4/ng_tee.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_tee.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_tee.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_tee.8,v 1.4 1999/01/25 23:46:27 archie Exp $
.\"
.Dd May 28, 2004
@@ -88,23 +89,23 @@
respectively.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobarbarfoo
-.It Dv right
+.Bl -tag -width ".Va left2right"
+.It Va right
The connection to the node on the right.
-.It Dv left
+.It Va left
The connection to the node on the left.
-.It Dv right2left
+.It Va right2left
Tap for right to left traffic.
-.It Dv left2right
+.It Va left2right
Tap for left to right traffic.
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following.
.Bl -tag -width foo
-.It Dv NGM_TEE_GET_STATS
+.It Dv NGM_TEE_GET_STATS Pq Ic getstats
Get statistics, returned as a
.Dv "struct ng_tee_stats" .
-.It Dv NGM_TEE_CLR_STATS
+.It Dv NGM_TEE_CLR_STATS Pq Ic clrstats
Clear statistics.
.El
.Sh SHUTDOWN
Modified: trunk/share/man/man4/ng_tty.4
===================================================================
--- trunk/share/man/man4/ng_tty.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_tty.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_tty.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_tty.8,v 1.5 1999/01/25 23:46:28 archie Exp $
.\"
.Dd December 25, 2008
@@ -57,7 +58,7 @@
.Dv hook
are transmitted out on the tty device.
No modification to the data is performed in either direction.
-While the hook is installed on a tty, the normal read and write
+While the hook is installed on a tty, the normal read and write
operations are unavailable, returning
.Er EIO .
.Pp
@@ -80,8 +81,8 @@
The hot character has no effect on the transmission of data.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobar
-.It Dv hook
+.Bl -tag -width ".Va hook"
+.It Va hook
.Xr tty 4
serial data contained in
.Dv mbuf
Modified: trunk/share/man/man4/ng_ubt.4
===================================================================
--- trunk/share/man/man4/ng_ubt.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_ubt.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin at yahoo.com>
.\" All rights reserved.
.\"
@@ -22,8 +23,8 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: ng_ubt.4,v 1.2 2012-12-29 16:29:12 laffer1 Exp $
-.\" $MidnightBSD$
+.\" $Id: ng_ubt.4,v 1.3 2003/05/21 19:37:35 max Exp $
+.\" $FreeBSD: stable/10/share/man/man4/ng_ubt.4 244704 2012-12-26 15:10:20Z glebius $
.\"
.Dd December 26, 2012
.Dt NG_UBT 4
@@ -78,8 +79,8 @@
.El
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width indent
-.It Dv hook
+.Bl -tag -width ".Va hook"
+.It Va hook
single HCI frame contained in a single
.Vt mbuf
structure.
@@ -87,22 +88,22 @@
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width indent
-.It Dv NGM_UBT_NODE_GET_DEBUG
+.It Dv NGM_UBT_NODE_GET_DEBUG Pq Ic get_debug
Returns an integer containing the current debug level for the node.
-.It Dv NGM_UBT_NODE_SET_DEBUG
+.It Dv NGM_UBT_NODE_SET_DEBUG Pq Ic set_debug
This command takes an integer argument and sets the current debug level
for the node.
-.It Dv NGM_UBT_NODE_GET_QLEN
+.It Dv NGM_UBT_NODE_GET_QLEN Pq Ic get_qlen
This command takes a parameter that specifies the queue number and returns
the current maximal length of the queue for the node.
-.It Dv NGM_UBT_NODE_SET_QLEN
+.It Dv NGM_UBT_NODE_SET_QLEN Pq Ic set_qlen
This command takes two parameters that specify the queue number and the maximum
length of the queue and sets the maximal length of the queue for the node.
-.It Dv NGM_UBT_NODE_GET_STAT
+.It Dv NGM_UBT_NODE_GET_STAT Pq Ic get_stat
Returns various statistic information for the node, such as: number of
bytes (frames) sent, number of bytes (frames) received and number of
input (output) errors.
-.It Dv NGM_UBT_NODE_RESET_STAT
+.It Dv NGM_UBT_NODE_RESET_STAT Pq Ic reset_stat
Reset all statistic counters to zero.
.El
.Sh SHUTDOWN
Modified: trunk/share/man/man4/ng_uni.4
===================================================================
--- trunk/share/man/man4/ng_uni.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_uni.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2001-2003
.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_uni.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd October 6, 2003
.Dt NG_UNI 4
@@ -212,7 +213,7 @@
.Pp
The meaning of most of the signals can be deduced from the ITU-T SDLs.
A number of signals, however, is unique to this implementation:
-.Bl -tag -width indent
+.Bl -tag -width foo
.It Dv UNIAPI_ERROR
This is the error response, mentioned earlier.
It carries an error code or
@@ -245,8 +246,8 @@
The
.Nm uni
node understands the standard control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_UNI_SETDEBUG
+.Bl -tag -width foo
+.It Dv NGM_UNI_SETDEBUG Pq Ic setdebug
Set debugging facility levels.
The UNI stack defines a number of debugging
facilities, each one associated with a debugging level.
@@ -258,12 +259,12 @@
uint32_t level[UNI_MAXFACILITY];
};
.Ed
-.It Dv NGM_UNI_SETDEBUG
+.It Dv NGM_UNI_GETDEBUG Pq Ic getdebug
Get debugging facility levels.
This returns an
.Vt ngm_uni_debug
structure.
-.It Dv NGM_UNI_GET_CONFIG
+.It Dv NGM_UNI_GET_CONFIG Pq Ic get_config
Retrieve the current configuration of the UNI instance.
This message returns a
.Vt uni_config
@@ -326,7 +327,7 @@
Note, however, that the actual
resolution of the timers depend on system configuration (see
.Xr timeout 9 ) .
-.It Dv NGM_UNI_SET_CONFIG
+.It Dv NGM_UNI_SET_CONFIG Pq Ic set_config
Change the UNI configuration.
This takes a
.Bd -literal
@@ -386,10 +387,10 @@
and
.Vt "enum uni_option"
should be used.
-.It Dv NGM_UNI_ENABLE
+.It Dv NGM_UNI_ENABLE Pq Ic enable
Create the UNI instance and enable processing.
Before the UNI is enabled parameters cannot be retrieved or set.
-.It Dv NGM_UNI_DISABLE
+.It Dv NGM_UNI_DISABLE Pq Ic disable
Destroy the UNI instance and free all resources.
Note, that connections are not released.
.El
Modified: trunk/share/man/man4/ng_vjc.4
===================================================================
--- trunk/share/man/man4/ng_vjc.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_vjc.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1996-1999 Whistle Communications, Inc.
.\" All rights reserved.
.\"
@@ -32,7 +33,7 @@
.\"
.\" Author: Archie Cobbs <archie at FreeBSD.org>
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_vjc.4 242997 2012-11-13 20:41:36Z joel $
.\" $Whistle: ng_vjc.8,v 1.4 1999/01/25 23:46:28 archie Exp $
.\"
.Dd January 19, 1999
@@ -103,20 +104,20 @@
hooks, respectively.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width foobarbazi
-.It Dv ip
+.Bl -tag -width ".Va vjuncomp"
+.It Va ip
Upstream (uncompressed) IP packets.
-.It Dv vjcomp
+.It Va vjcomp
Downstream compressed TCP packets.
-.It Dv vjuncomp
+.It Va vjuncomp
Downstream uncompressed TCP packets.
-.It Dv vjip
+.It Va vjip
Downstream uncompressed IP packets.
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
.Bl -tag -width foo
-.It Dv NGM_VJC_SET_CONFIG
+.It Dv NGM_VJC_SET_CONFIG Pq Ic setconfig
This command resets the compression state and configures it according
to the supplied
.Dv "struct ngm_vjc_config"
@@ -169,12 +170,12 @@
reported to the peer's decompression engine (see
.Dv NGM_VJC_RECV_ERROR
below).
-.It Dv NGM_VJC_GET_STATE
+.It Dv NGM_VJC_GET_STATE Pq Ic getstate
This command returns the node's current state described by the
.Dv "struct slcompress"
structure, which is defined in
.In net/slcompress.h .
-.It Dv NGM_VJC_CLR_STATS
+.It Dv NGM_VJC_CLR_STATS Pq Ic clrstats
Clears the node statistics counters.
Statistics are also cleared whenever the
.Dv enableComp
@@ -183,7 +184,7 @@
fields are changed from zero to one by a
.Dv NGM_VJC_SET_CONFIG
control message.
-.It Dv NGM_VJC_RECV_ERROR
+.It Dv NGM_VJC_RECV_ERROR Pq Ic recverror
When the peer has CID header field compression enabled,
this message must be sent to the local
.Nm vjc
Modified: trunk/share/man/man4/ng_vlan.4
===================================================================
--- trunk/share/man/man4/ng_vlan.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ng_vlan.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2003 Ruslan Ermilov
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ng_vlan.4 242997 2012-11-13 20:41:36Z joel $
.\"
.Dd March 1, 2004
.Dt NG_VLAN 4
@@ -78,7 +79,7 @@
hook.
.Sh HOOKS
This node type supports the following hooks:
-.Bl -tag -width ".Va downstream"
+.Bl -tag -width "Aq Em any valid name"
.It Va downstream
Typically this hook would be connected to a
.Xr ng_ether 4
@@ -102,12 +103,12 @@
.El
.Sh CONTROL MESSAGES
This node type supports the generic control messages, plus the following:
-.Bl -tag -width indent
-.It Dv NGM_VLAN_ADD_FILTER Pq Li addfilter
+.Bl -tag -width foo
+.It Dv NGM_VLAN_ADD_FILTER Pq Ic addfilter
Associates a hook with the tag.
-.It Dv NGM_VLAN_DEL_FILTER Pq Li delfilter
+.It Dv NGM_VLAN_DEL_FILTER Pq Ic delfilter
Disassociates a hook from the tag.
-.It Dv NGM_VLAN_GET_TABLE Pq Li gettable
+.It Dv NGM_VLAN_GET_TABLE Pq Ic gettable
Returns a table of all hook/tag associations.
.El
.Sh EXAMPLES
Modified: trunk/share/man/man4/ngatmbase.4
===================================================================
--- trunk/share/man/man4/ngatmbase.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ngatmbase.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\" Copyright (c) 2004
.\" Hartmut Brandt.
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ngatmbase.4 211397 2010-08-16 15:18:30Z joel $
.\"
.\" ngatmbase(4) man page
.\"
Modified: trunk/share/man/man4/nge.4
===================================================================
--- trunk/share/man/man4/nge.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nge.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001 Wind River Systems
.\" Copyright (c) 1997, 1998, 1999, 2000, 2001
.\" Bill Paul <wpaul at bsdi.com>. All rights reserved.
@@ -29,7 +30,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nge.4 215780 2010-11-23 22:07:10Z marius $
.\"
.Dd November 23, 2010
.Dt NGE 4
Modified: trunk/share/man/man4/nmdm.4
===================================================================
--- trunk/share/man/man4/nmdm.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nmdm.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2001
.\" The FreeBSD Project
.\"
@@ -19,9 +20,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nmdm.4 328921 2018-02-06 07:50:30Z delphij $
.\"
-.Dd January 27, 2005
+.Dd January 23, 2018
.Dt NMDM 4
.Os
.Sh NAME
@@ -28,7 +29,19 @@
.Nm nmdm
.Nd nullmodem terminal driver
.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following line in your
+kernel configuration file:
+.Bd -ragged -offset indent
.Cd "device nmdm"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+nmdm_load="YES"
+.Ed
.Sh DESCRIPTION
The
.Nm
Modified: trunk/share/man/man4/nsp.4
===================================================================
--- trunk/share/man/man4/nsp.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nsp.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2003 Noriaki MITSUNAGA. All rights reserved.
.\" Copyright (c) 2003 Hideyuki KURASHINA. All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nsp.4 159719 2006-06-18 09:53:00Z brueffer $
.\"
.Dd August 8, 2004
.Dt NSP 4
Added: trunk/share/man/man4/ntb.4
===================================================================
--- trunk/share/man/man4/ntb.4 (rev 0)
+++ trunk/share/man/man4/ntb.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,115 @@
+.\" $MidnightBSD$
+.\"
+.\" Copyright (c) 2013 Intel Corporation
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions, and the following disclaimer,
+.\" without modification.
+.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
+.\" substantially similar to the "NO WARRANTY" disclaimer below
+.\" ("Disclaimer") and any redistribution must be conditioned upon
+.\" including a substantially similar Disclaimer requirement for further
+.\" binary redistribution.
+.\"
+.\" NO WARRANTY
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
+.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGES.
+.\"
+.\" ntb driver man page.
+.\"
+.\" Author: Carl Delsey <carl at FreeBSD.org>
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/ntb.4 255270 2013-09-05 22:55:08Z carl $
+.\"
+.Dd Apr 11, 2013
+.Dt NTB 4
+.Os
+.Sh NAME
+.Nm ntb ,
+.Nm ntb_hw ,
+.Nm if_ntb
+.Nd Intel(R) Non-Transparent Bridge driver
+.Sh SYNOPSIS
+To compile this driver into your kernel,
+place the following lines in your kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device ntb_hw"
+.Cd "device if_ntb"
+.Ed
+.Pp
+Or, to load the driver as a module at boot, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+if_ntb_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the Non-Transparent Bridge (NTB) in the Intel S1200,
+Xeon E3 and Xeon E5 processor families.
+.Pp
+The NTB allows you to connect two computer systems using a PCI-e link if they
+have the correct equipment and connectors.
+.Sh CONFIGURATION
+The NTB memory windows need to be configured by the BIOS.
+If your BIOS allows you to set their size, you should set the size of both
+memory windows to 1 MiB.
+This needs to be done on both systems.
+.Pp
+Each system needs to have a different IP address assigned.
+The MAC address is randomly generated.
+Also for maximum performance, the MTU should be set to 16 kiB.
+This can be done by adding the line below to
+.Xr rc.conf 5 :
+.Bd -literal -offset indent
+ifconfig_ntb0="inet 192.168.1.10 netmask 255.255.255.0 mtu 16384"
+.Ed
+.Pp
+And on the second system :
+.Bd -literal -offset indent
+ifconfig_ntb0="inet 192.168.1.11 netmask 255.255.255.0 mtu 16384"
+.Ed
+.Pp
+If you are using the UDP protocol, you may want to increase the
+.Va net.inet.udp.maxdgram
+.Xr sysctl 8
+variable.
+.Sh SEE ALSO
+.Xr rc.conf 5 ,
+.Xr sysctl 8
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was developed by Intel and originally written by
+.An Carl Delsey Aq carl at FreeBSD.org.
+.Sh BUGS
+If the driver is unloaded, it cannot be reloaded without a system reboot.
+.Pp
+The network support is limited.
+It isn't fully configurable yet.
+It also isn't integrated into
+.Xr netgraph 4
+or
+.Xr bpf 4 .
+.Pp
+NTB to Root Port mode is not yet supported.
+.Pp
+There is no way to protect your system from malicious behavior on the other
+system once the link is brought up.
+Anyone with root or kernel access on the other system can read or write to
+any location on your system.
+In other words, only connect two systems that completely trust each other.
Property changes on: trunk/share/man/man4/ntb.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Added: trunk/share/man/man4/ntb_hw.4
===================================================================
--- trunk/share/man/man4/ntb_hw.4 (rev 0)
+++ trunk/share/man/man4/ntb_hw.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,118 @@
+.\" $MidnightBSD$
+.\"
+.\" Copyright (c) 2016 Alexander Motin <mav at FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/ntb_hw.4 304404 2016-08-18 10:59:12Z mav $
+.\"
+.Dd July 28, 2016
+.Dt NTB_HW 4
+.Os
+.Sh NAME
+.Nm ntb ,
+.Nm ntb_hw
+.Nd Intel(R) Non-Transparent Bridge driver
+.Sh SYNOPSIS
+To compile this driver into your kernel,
+place the following lines in your kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device ntb_hw"
+.Ed
+.Pp
+Or, to load the driver as a module at boot, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+ntb_hw_load="YES"
+.Ed
+.Pp
+The following tunables are settable from the
+.Xr loader 8 :
+.Bl -ohang
+.It Va hw.ntb.debug_level
+Driver debug level.
+The default value is 0, higher means more verbose.
+.It Va hint.ntb_hw. Ns Ar X Ns Va .config
+Configures NTB resources split between several consumer devices.
+Configuration of multiple consumer devices separated by commas.
+Each device can be configured as: "<name>[:<mw>[:<spad>[:<db>]]]", where:
+.Va name
+is a name of the driver which should attach the device (empty means any),
+.Va mw
+is a number of memory windows to allocate (empty means all available),
+.Va spad
+is a number of scratchpad registers to allocate (empty means all available),
+.Va db
+is a number of doorbells to allocate (empty means all available).
+The default configuration is empty string, which means single device
+with all available resources allowing any driver attachment.
+.El
+.Sh DESCRIPTION
+The NTB allows you to connect two computer systems using a PCIe link if they
+have the correct equipment and connectors.
+The
+.Nm ntb_hw
+driver provides support for the Non-Transparent Bridge (NTB) in the Intel S1200
+and Xeon E3/E5 processor families.
+The
+.Nm
+driver hides hardware details, exposing memory windows, scratchpads and
+doorbells via hardware independent KPI.
+.Pp
+The hardware provides 2-3 memory windows to the other system's memory,
+16 scratchpad registers and 14/34 doorbells to interrupt the other system.
+On Xeon processors one of memory windows is typically consumed by the driver
+to workaround multiple hardware erratas.
+.Sh CONFIGURATION
+The NTB configuration should be set by BIOS.
+It includes enabling NTB, choosing between NTB-to-NTB or NTB-to-Root Port mode,
+enabling split BAR mode (one of two 64-bit BARs can be split into two 32-bit
+ones) and configuring BAR sizes in bits (from 12 to 29/39) for both NTB sides.
+.Pp
+The recommended configuration is NTB-to-NTB mode, split bar is enabled and
+all BAR sizes are set to 20 (1 MiB).
+This needs to be done on both systems.
+.Sh SEE ALSO
+.Xr ntb_transport 4 ,
+.Xr if_ntb 4
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was developed by Intel and originally written by
+.An Carl Delsey Aq Mt carl at FreeBSD.org .
+Later improvements were done by
+.An Conrad E. Meyer Aq Mt cem at FreeBSD.org
+and
+.An Alexander Motin Aq Mt mav at FreeBSD.org .
+.Sh BUGS
+NTB-to-Root Port mode is not yet supported, but it doesn't look very useful.
+.Pp
+On Xeon v2/v3/v4 processors split BAR mode should be enabled to allow
+SB01BASE_LOCKUP errata workaround to be applied by the driver.
+.Pp
+There is no way to protect your system from malicious behavior on the other
+system once the link is brought up.
+Anyone with root or kernel access on the other system can read or write to
+any location on your system.
+In other words, only connect two systems that completely trust each other.
Property changes on: trunk/share/man/man4/ntb_hw.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Added: trunk/share/man/man4/ntb_transport.4
===================================================================
--- trunk/share/man/man4/ntb_transport.4 (rev 0)
+++ trunk/share/man/man4/ntb_transport.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -0,0 +1,80 @@
+.\" $MidnightBSD$
+.\"
+.\" Copyright (c) 2016 Alexander Motin <mav at FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: stable/10/share/man/man4/ntb_transport.4 304405 2016-08-18 11:00:48Z mav $
+.\"
+.Dd July 29, 2016
+.Dt NTB_TRANSPORT 4
+.Os
+.Sh NAME
+.Nm ntb_transport
+.Nd Packet-oriented transport for Non-Transparent Bridges
+.Sh SYNOPSIS
+To load the driver as a module at boot, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+ntb_transport_load="YES"
+.Ed
+.Pp
+The following tunables are settable from the
+.Xr loader 8 :
+.Bl -ohang
+.It Va hw.ntb_transport.debug_level
+Driver debug level.
+The default value is 0, higher means more verbose.
+.It Va hint.ntb_transport. Ns Ar X Ns Va .config
+Configures queues allocation for consumer devices, separated by commas.
+Each device can be configured as: "<name>[:<queues>]", where:
+.Va name
+is a name of the driver which should attach the device (empty means any),
+.Va queues
+is a number of queues to allocate (empty means automatic),
+The default configuration is empty string, which means single device
+with one queue per memory window allowing any driver attachment.
+.El
+.Sh DESCRIPTION
+The
+.Nm
+driver attaches on top of the
+.Nm ntb
+driver to utilize its resources to create set of bidirectional queues,
+delivering packets between the systems.
+The primary purpose of this is to be used by
+.Nm if_ntb
+network interface, but other consumers may also be developed using KPI.
+.Sh SEE ALSO
+.Xr if_ntb 4 ,
+.Xr ntb_hw 4
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was developed by Intel and originally written by
+.An Carl Delsey Aq Mt carl at FreeBSD.org .
+Later improvements were done by
+.An Conrad E. Meyer Aq Mt cem at FreeBSD.org
+and
+.An Alexander Motin Aq Mt mav at FreeBSD.org .
Property changes on: trunk/share/man/man4/ntb_transport.4
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+text/plain
\ No newline at end of property
Modified: trunk/share/man/man4/null.4
===================================================================
--- trunk/share/man/man4/null.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/null.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
@@ -30,7 +31,7 @@
.\" SUCH DAMAGE.
.\"
.\" @(#)null.4 8.1 (Berkeley) 6/5/93
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/null.4 129238 2004-05-14 20:07:49Z simon $
.\"
.Dd June 5, 1993
.Dt NULL 4
@@ -52,7 +53,6 @@
.It Pa /dev/null
.El
.Sh SEE ALSO
-.Xr full 4
.Xr zero 4
.Sh HISTORY
A
Modified: trunk/share/man/man4/nvd.4
===================================================================
--- trunk/share/man/man4/nvd.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nvd.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,5 +1,6 @@
+.\" $MidnightBSD$
.\"
-.\" Copyright (c) 2012-2013 Intel Corporation
+.\" Copyright (c) 2012-2016 Intel Corporation
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -31,10 +32,9 @@
.\"
.\" Author: Jim Harris <jimharris at FreeBSD.org>
.\"
-.\" $FreeBSD: release/9.2.0/share/man/man4/nvd.4 253365 2013-07-15 15:37:13Z jimharris $
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nvd.4 295705 2016-02-17 15:38:05Z jimharris $
.\"
-.Dd July 9, 2013
+.Dd January 28, 2016
.Dt NVD 4
.Os
.Sh NAME
@@ -63,10 +63,33 @@
.Xr nvme 4
driver for notification of existing NVMe namespaces and submission of NVM
I/O commands.
+.Pp
+Device nodes from the
+.Nm
+driver will have the format /dev/nvdX and are
+.Xr GEOM 4
+disks which can be partitioned by
+.Xr geom 8 .
+Note that device nodes from the
+.Xr nvme 4
+driver are not
+.Xr GEOM 4
+disks and cannot be partitioned.
+.Sh CONFIGURATION
+The
+.Nm
+driver defines a system-wide maximum delete size for NVMe devices. The
+default is 1GB. To select a different value, set the following tunable in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+hw.nvd.delete_max=<delete size in bytes>
+.Ed
.Sh SEE ALSO
+.Xr GEOM 4 ,
.Xr nvme 4 ,
+.Xr geom 8 ,
.Xr nvmecontrol 8 ,
-.Xr disk 9 .
+.Xr disk 9
.Sh HISTORY
The
.Nm
Modified: trunk/share/man/man4/nve.4
===================================================================
--- trunk/share/man/man4/nve.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nve.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2003 Quinton Dolan
.\" All rights reserved.
.\"
@@ -22,11 +23,11 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $Id: nve.4,v 1.2 2012-12-29 16:29:12 laffer1 Exp $
+.\" $Id: nvnet.4,v 1.1 2003/10/09 16:48:01 q Exp $
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nve.4 261972 2014-02-16 11:13:14Z brueffer $
.\"
-.Dd January 16, 2011
+.Dd February 13, 2014
.Dt NVE 4
.Os
.Sh NAME
@@ -33,6 +34,14 @@
.Nm nve
.Nd "NVIDIA nForce MCP Networking Adapter device driver"
.Sh SYNOPSIS
+.Sy Warning:
+This driver is deprecated and will not be available in
+.Fx 11.0
+and later.
+Please consider using the
+.Xr nfe 4
+driver instead.
+.Pp
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
@@ -119,6 +128,7 @@
.Xr arp 4 ,
.Xr miibus 4 ,
.Xr netintro 4 ,
+.Xr nfe 4 ,
.Xr ng_ether 4 ,
.Xr rgephy 4 ,
.Xr ifconfig 8
Modified: trunk/share/man/man4/nvme.4
===================================================================
--- trunk/share/man/man4/nvme.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nvme.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,5 +1,6 @@
+.\" $MidnightBSD$
.\"
-.\" Copyright (c) 2012-2013 Intel Corporation
+.\" Copyright (c) 2012-2016 Intel Corporation
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -31,10 +32,9 @@
.\"
.\" Author: Jim Harris <jimharris at FreeBSD.org>
.\"
-.\" $FreeBSD: release/9.2.0/share/man/man4/nvme.4 253365 2013-07-15 15:37:13Z jimharris $
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nvme.4 293672 2016-01-11 17:32:56Z jimharris $
.\"
-.Dd July 9, 2013
+.Dd January 7, 2016
.Dt NVME 4
.Os
.Sh NAME
@@ -55,7 +55,8 @@
.Pp
Most users will also want to enable
.Xr nvd 4
-to surface NVM Express namespaces as disk devices.
+to surface NVM Express namespaces as disk devices which can be
+partitioned.
Note that in NVM Express terms, a namespace is roughly equivalent to a
SCSI LUN.
.Sh DESCRIPTION
@@ -74,9 +75,15 @@
API for submitting NVM commands to namespaces
.It
Ioctls for controller and namespace configuration and management
+.El
+.Pp
+The
.Nm
-creates controller devices in the format /dev/nvmeX and namespace devices in
-the format /dev/nvmeXnsY.
+driver creates controller device nodes in the format
+.Pa /dev/nvmeX
+and namespace device nodes in
+the format
+.Pa /dev/nvmeXnsY .
Note that the NVM Express specification starts numbering namespaces at 1,
not 0, and this driver follows that convention.
.El
@@ -84,7 +91,10 @@
By default,
.Nm
will create an I/O queue pair for each CPU, provided enough MSI-X vectors
-can be allocated.
+and NVMe queue pairs can be allocated. If not enough vectors or queue
+pairs are available, nvme(4) will use a smaller number of queue pairs and
+assign multiple CPUs per queue pair.
+.Pp
To force a single I/O queue pair shared by all CPUs, set the following
tunable value in
.Xr loader.conf 5 :
@@ -92,6 +102,13 @@
hw.nvme.per_cpu_io_queues=0
.Ed
.Pp
+To assign more than one CPU per I/O queue pair, thereby reducing the number
+of MSI-X vectors consumed by the device, set the following tunable value in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+hw.nvme.min_cpus_per_ioq=X
+.Ed
+.Pp
To force legacy interrupts for all
.Nm
driver instances, set the following tunable value in
@@ -104,8 +121,11 @@
.Sh SYSCTL VARIABLES
The following controller-level sysctls are currently implemented:
.Bl -tag -width indent
+.It Va dev.nvme.0.num_cpus_per_ioq
+(R) Number of CPUs associated with each I/O queue pair.
.It Va dev.nvme.0.int_coal_time
-(R/W) Interrupt coalescing timer period in microseconds. Set to 0 to disable.
+(R/W) Interrupt coalescing timer period in microseconds.
+Set to 0 to disable.
.It Va dev.nvme.0.int_coal_threshold
(R/W) Interrupt coalescing threshold in number of command completions.
Set to 0 to disable.
@@ -147,7 +167,7 @@
.Xr nvd 4 ,
.Xr pci 4 ,
.Xr nvmecontrol 8 ,
-.Xr disk 9 .
+.Xr disk 9
.Sh HISTORY
The
.Nm
Modified: trunk/share/man/man4/nvram.4
===================================================================
--- trunk/share/man/man4/nvram.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nvram.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\"
.\"Copyright (c) 2010 iXsystems, Inc.
.\"All rights reserved.
@@ -24,7 +25,7 @@
.\"OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\"SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nvram.4 203684 2010-02-08 20:53:29Z gavin $
.\"
.Dd February 8, 2010
.Dt NVRAM 4
Modified: trunk/share/man/man4/nvram2env.4
===================================================================
--- trunk/share/man/man4/nvram2env.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nvram2env.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2011 Aleksandr Rybalko
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nvram2env.4 233648 2012-03-29 05:02:12Z eadler $
.\"
.Dd April 3, 2011
.Dt NVRAM2ENV 4
@@ -31,7 +32,7 @@
.Nm nvram2env
.Nd "copy nvram-like data into kernel environment"
.Sh SYNOPSIS
-.Cd "device nvram2env"
+.Cd "device nvram2env"
.Sh DESCRIPTION
.Nm
implements a simple method of reading the NVRAM-like data and information
@@ -101,7 +102,6 @@
.Ed
.Pp
Dynamic, editable form CFE, override values from first
-.Pp
.Bd -literal -offset indent
hint.nvram.1.flags=0x05 # Broadcom + nocheck
hint.nvram.1.base=0x1cff8000
Modified: trunk/share/man/man4/nxge.4
===================================================================
--- trunk/share/man/man4/nxge.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/nxge.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2007, Neterion Inc
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/nxge.4 233648 2012-03-29 05:02:12Z eadler $
.\"
.Dd October 16, 2007
.Dt NXGE 4
Modified: trunk/share/man/man4/oce.4
===================================================================
--- trunk/share/man/man4/oce.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/oce.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (C) 2013 Emulex
.\" All rights reserved.
.\"
@@ -34,7 +35,7 @@
.\" 3333 Susan Street
.\" Costa Mesa, CA 92626
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/oce.4 252869 2013-07-06 08:30:45Z delphij $
.\"
.Dd February 19, 2012
.Dt OCE 4
@@ -90,9 +91,8 @@
.Bl -enum
.It
Copy the below code to a Makefile:
-.Pp
.Bd -literal -offset indent
-\&.KMOD=elxflash
+KMOD=elxflash
FIRMWS=imagename.ufi:elxflash
\&.include <bsd.kmod.mk>
.Ed
Modified: trunk/share/man/man4/ohci.4
===================================================================
--- trunk/share/man/man4/ohci.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/ohci.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 1999
.\" Nick Hibma <n_hibma at FreeBSD.org>. All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/ohci.4 219004 2011-02-24 18:08:23Z hselasky $
.\"
.Dd June 23, 2005
.Dt OHCI 4
Modified: trunk/share/man/man4/orm.4
===================================================================
--- trunk/share/man/man4/orm.4 2018-07-09 23:26:33 UTC (rev 11733)
+++ trunk/share/man/man4/orm.4 2018-07-09 23:26:56 UTC (rev 11734)
@@ -1,3 +1,4 @@
+.\" $MidnightBSD$
.\" Copyright (c) 2000 Nikolai Saoukh
.\" All rights reserved.
.\"
@@ -22,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/orm.4 206622 2010-04-14 19:08:06Z uqs $
.\"
.Dd December 15, 2000
.Dt ORM 4
More information about the Midnightbsd-cvs
mailing list