Attachment 144076 Details for Bug 191320 – remove the old vale.4 page

[patch] remove the old vale.4 page

netmap_1.diff (text/plain), 6.81 KB, created by Franco Fichtner on 2014-06-23 18:12:21 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Franco Fichtner

Created: 2014-06-23 18:12:21 UTC

Size: 6.81 KB

patch

obsolete

>diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
>index ac2cabb..f90e241 100644
>--- a/share/man/man4/Makefile
>+++ b/share/man/man4/Makefile
>@@ -551,7 +551,6 @@ MAN=	aac.4 \
> 	utopia.4 \
> 	uvisor.4 \
> 	uvscom.4 \
>-	vale.4 \
> 	vga.4 \
> 	vge.4 \
> 	viapm.4 \
>@@ -685,6 +684,7 @@ MLINKS+=${_ndis.4} ${_if_ndis.4}
> MLINKS+=netfpga10g_nf10bmac.4 if_nf10bmac.4
> MLINKS+=netintro.4 net.4 \
> 	netintro.4 networking.4
>+MLINKS+=netmap.4 vale.4
> MLINKS+=${_nfe.4} ${_if_nfe.4}
> MLINKS+=nge.4 if_nge.4
> MLINKS+=${_ntb.4} ${_if_ntb.4} \
>diff --git a/share/man/man4/netmap.4 b/share/man/man4/netmap.4
>index 1943ebc..484e20f 100644
>--- a/share/man/man4/netmap.4
>+++ b/share/man/man4/netmap.4
>@@ -54,7 +54,7 @@ and
> a shared memory packet transport channel.
> All these are accessed interchangeably with the same API.
> .Pp
>-.Nm , VALE
>+.Nm VALE
> and
> .Nm netmap pipes
> are at least one order of magnitude faster than
>@@ -62,7 +62,9 @@ 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,
>+about 20 Mpps per core for
>+.Nm VALE
>+ports,
> and over 100 Mpps for netmap pipes.
> .Pp
> Userspace clients can dynamically switch NICs into
>@@ -172,7 +174,9 @@ 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,
>+the file descriptor is bound to port YYY of a
>+.Nm 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.
>@@ -648,7 +652,7 @@ packets are transmitted only on
> or select()/poll() are called with a write event (POLLOUT/wfdset) or a full ring.
> .Pp
> When registering a virtual interface that is dynamically created to a
>-.Xr vale 4
>+.Nm VALE
> 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
>@@ -849,7 +853,8 @@ to wake up processes when significant events occur, and
> to map memory.
> .Xr ioctl 2
> is used to configure ports and
>-.Nm VALE switches .
>+.Nm VALE
>+switches.
> .Pp
> Applications may need to create threads and bind them to
> specific cores to improve performance, using standard
>diff --git a/share/man/man4/vale.4 b/share/man/man4/vale.4
>deleted file mode 100644
>index a52b137..0000000
>--- a/share/man/man4/vale.4
>+++ /dev/null
>@@ -1,132 +0,0 @@
>-.\" Copyright (c) 2012 Luigi Rizzo, Universita` di Pisa
>-.\" 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.
>-.\" 
>-.\" This document is derived in part from the enet man page (enet.4)
>-.\" distributed with 4.3BSD Unix.
>-.\"
>-.\" $FreeBSD$
>-.\" $Id: $
>-.\"
>-.Dd July 27, 2012
>-.Dt VALE 4
>-.Os
>-.Sh NAME
>-.Nm vale
>-.Nd a very fast Virtual Local Ethernet using the netmap API
>-.Sh SYNOPSIS
>-.Cd device netmap
>-.Sh DESCRIPTION
>-.Nm
>-is a feature of the
>-.Xr netmap 4
>-module that implements multiple Virtual switches that can
>-be used to interconnect netmap clients, including traffic
>-sources and sinks, packet forwarders, userspace firewalls,
>-and so on.
>-.Pp
>-.Nm
>-is implemented completely in software, and is extremely fast.
>-On a modern machine it can move almost 20 Million packets per
>-second (Mpps) per core with small frames, and about 70 Gbit/s
>-with 1500 byte frames.
>-.Sh OPERATION
>-.Nm
>-dynamically creates switches and ports as clients connect
>-to it using the
>-.Xr netmap 4
>-API.
>-.Pp
>-.Nm
>-ports are named
>-.Pa vale[bdg:][port]
>-where
>-.Pa vale
>-is the prefix indicating a VALE switch rather than a standard interface,
>-.Pa bdg
>-indicates a specific switch (the colon is a separator),
>-and
>-.Pa port
>-indicates a port within the switch.
>-Bridge and port names are arbitrary strings, the only
>-constraint being that the full name must fit within 16
>-characters.
>-.Pp
>-See
>-.Xr netmap 4
>-for details on the API.
>-.Ss LIMITS
>-.Nm
>-currently supports up to 4 switches, 16 ports per switch, with
>-1024 buffers per port.
>-These hard limits will be
>-changed to sysctl variables in future releases.
>-.Sh SYSCTL VARIABLES
>-.Nm
>-uses the following sysctl variables to control operation:
>-.Bl -tag -width dev.netmap.verbose
>-.It dev.netmap.bridge
>-The maximum number of packets processed internally
>-in each iteration.
>-Defaults to 1024, use lower values to trade latency
>-with throughput.
>-.Pp
>-.It dev.netmap.verbose
>-Set to non-zero values to enable in-kernel diagnostics.
>-.El
>-.Sh EXAMPLES
>-Create one switch, with a traffic generator connected to one
>-port, and a netmap-enabled tcpdump instance on another port:
>-.Bd -literal -offset indent
>-tcpdump -ni vale-a:1 &
>-pkt-gen  -i vale-a:0 -f tx &
>-.Ed
>-.Pp
>-Create two switches,
>-each connected to two qemu machines on different ports.
>-.Bd -literal -offset indent
>-qemu -net nic -net netmap,ifname=vale-1:a ... &
>-qemu -net nic -net netmap,ifname=vale-1:b ... &
>-qemu -net nic -net netmap,ifname=vale-2:c ... &
>-qemu -net nic -net netmap,ifname=vale-2:d ... &
>-.Ed
>-.Sh SEE ALSO
>-.Xr netmap 4
>-.Pp
>-.Xr http://info.iet.unipi.it/~luigi/vale/
>-.Pp
>-Luigi Rizzo, Giuseppe Lettieri: VALE, a switched ethernet for virtual machines,
>-June 2012, http://info.iet.unipi.it/~luigi/vale/
>-.Sh AUTHORS
>-.An -nosplit
>-The
>-.Nm
>-switch was designed and implemented in 2012 by
>-.An Luigi Rizzo
>-and
>-.An Giuseppe Lettieri
>-at the Universita` di Pisa.
>-.Pp
>-.Nm
>-was funded by the European Commission within FP7 Projects
>-CHANGE (257422) and OPENLAB (287581).

Actions: View | Diff

Attachments on bug 191320: 144075 | 144076 | 144077