Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/vxlan.4
Show All 18 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" 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 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd December 31, 2017 | .Dd XXX | ||||
.Dt VXLAN 4 | .Dt VXLAN 4 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm vxlan | .Nm vxlan | ||||
.Nd "Virtual eXtensible LAN interface" | .Nd "Virtual eXtensible LAN interface" | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
To compile this driver into the kernel, | To compile this driver into the kernel, | ||||
place the following line in your | place the following line in your | ||||
▲ Show 20 Lines • Show All 141 Lines • ▼ Show 20 Lines | |||||
to use jumbo frames to accommodate the encapsulated frame size. | to use jumbo frames to accommodate the encapsulated frame size. | ||||
Alternatively, the | Alternatively, the | ||||
.Xr ifconfig 8 | .Xr ifconfig 8 | ||||
.Cm mtu | .Cm mtu | ||||
command may be used to reduce the MTU size on the | command may be used to reduce the MTU size on the | ||||
.Nm | .Nm | ||||
interface to allow the encapsulated frame to fit in the | interface to allow the encapsulated frame to fit in the | ||||
current MTU of the physical network. | current MTU of the physical network. | ||||
.Sh HARDWARE | |||||
The | |||||
.Nm | |||||
driver supports hardware checksum offload (receive and transmit) and TSO on the | |||||
encapsulated traffic over physical interfaces that support these features. | |||||
The | |||||
.Nm | |||||
interface examines the | |||||
.Cm vxlandev | |||||
interface, if one is specified, or the interface hosting the | |||||
.Cm vxlanlocal | |||||
address, and configures its capabilities based on the hardware offload | |||||
capabilities of that physical interface. | |||||
If multiple physical interfaces will transmit or receive traffic for the | |||||
.Nm | |||||
then they all must have the same hardware capabilities. | |||||
The transmit routine of a | |||||
.Nm | |||||
interface may fail with | |||||
kib: .Er ENXIO | |||||
.Er ENXIO | |||||
if an outbound physical interface does not support | |||||
an offload that the | |||||
.Nm | |||||
interface is requesting. | |||||
This can happen if there are multiple physical interfaces involved, with | |||||
different hardware capabilities, or an interface capability was disabled after | |||||
the | |||||
.Nm | |||||
interface had already started. | |||||
.Pp | |||||
At present, these devices are capable of generating checksums and performing TSO | |||||
on the inner frames in hardware: | |||||
.Xr cxgbe 4 . | |||||
.Sh EXAMPLES | .Sh EXAMPLES | ||||
Create a | Create a | ||||
.Nm | .Nm | ||||
interface in unicast mode | interface in unicast mode | ||||
with the | with the | ||||
.Cm vxlanlocal | .Cm vxlanlocal | ||||
tunnel address of 192.168.100.1, | tunnel address of 192.168.100.1, | ||||
and the | and the | ||||
▲ Show 20 Lines • Show All 46 Lines • ▼ Show 20 Lines | |||||
.%O "RFC 7348" | .%O "RFC 7348" | ||||
.Re | .Re | ||||
.Sh AUTHORS | .Sh AUTHORS | ||||
.An -nosplit | .An -nosplit | ||||
The | The | ||||
.Nm | .Nm | ||||
driver was written by | driver was written by | ||||
.An Bryan Venteicher Aq bryanv@freebsd.org . | .An Bryan Venteicher Aq bryanv@freebsd.org . | ||||
Support for stateless hardware offloads was added by | |||||
.An Navdeep Parhar Aq np@freebsd.org | |||||
in | |||||
.Fx 13.0 . |
.Er ENXIO