xref: /freebsd/tools/tools/netmap/bridge.8 (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1.\" Copyright (c) 2016 Luigi Rizzo, Universita` di Pisa
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.\" $FreeBSD$
25.\"
26.Dd October 28, 2018
27.Dt BRIDGE 8
28.Os
29.Sh NAME
30.Nm bridge
31.Nd netmap client to bridge two netmap ports
32.Sh SYNOPSIS
33.Bk -words
34.Bl -tag -width "bridge"
35.It Nm
36.Op Fl i Ar port
37.Op Fl b Ar batch size
38.Op Fl w Ar wait-link
39.Op Fl v
40.Op Fl c
41.El
42.Ek
43.Sh DESCRIPTION
44.Nm
45is a simple netmap application that bridges packets between two netmap ports.
46If the two netmap ports use the same netmap memory region
47.Nm
48forwards packets without copying the packets payload (zero-copy mode), unless
49explicitly prevented by the
50.Fl c
51flag.
52.Bl -tag -width Ds
53.It Fl i Ar port
54Name of the netmap port.
55It can be supplied up to two times to identify the ports that must be bridged.
56Any netmap port type (physical interface, VALE switch, pipe, monitor port...)
57can be used.
58If the option is supplied only once, then it must be for a physical interface and, in that case,
59.Nm
60will bridge the port and the host stack.
61.It Fl b Ar batch-size
62Maximum number of packets to send in one operation.
63.It Fl w Ar wait-link
64indicates the number of seconds to wait before transmitting.
65It defaults to 2, and may be useful when talking to physical
66ports to let link negotiation complete before starting transmission.
67.It Fl v
68Enable verbose mode
69.It Fl c
70Disable zero-copy mode.
71.El
72.Sh SEE ALSO
73.Xr netmap 4 ,
74.Xr pkt-gen 8 ,
75.Xr lb 8
76.Sh AUTHORS
77.An -nosplit
78.Nm
79has been written by
80.An Luigi Rizzo
81and
82.An Matteo Landi
83at the Universita` di Pisa, Italy.
84