xref: /netbsd-src/share/man/man4/virt.4 (revision ba65fde2d7fefa7d39838fa5fa855e62bd606b5e)
1.\"	$NetBSD: virt.4,v 1.2 2010/11/17 18:03:49 wiz Exp $
2.\"
3.\" Copyright (c) 2010 Antti Kantee
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd November 15, 2010
27.Dt VIRT 4
28.Os
29.Sh NAME
30.Nm virt
31.Nd rump virtual network interface
32.Sh SYNOPSIS
33.In rump/rump.h
34.Ft int
35.Fo rump_pub_virtif_create
36.Fa "int num"
37.Fc
38.Sh DESCRIPTION
39The
40.Nm
41interface acts as a link between a rump virtual kernel and a host
42.Xr tap 4
43interface.
44Interface number <n> always corresponds with the host tap interface tap<n>.
45All data sent by
46.Nm
47is written into
48.Pa /dev/tap<n>
49and all data read from
50.Pa /dev/tap<n>
51is passed as Ethernet input to the rump virtual kernel.
52.Pp
53A
54.Nm
55interface can be created in two ways:
56.Bl -bullet
57.It
58Programmatically by calling
59.Fn rump_pub_virtif_create .
60.It
61Dynamically at runtime with
62.Xr ifconfig 8
63or equivalent using the
64.Em create
65command.
66.El
67.Pp
68Destroying a
69.Nm
70interface is possible only through
71.Xr ifconfig 8
72.Em destroy .
73.Pp
74The host's
75.Xr tap 4
76interface can be further bridged with hardware interfaces to provide
77full Internet access to a rump kernel.
78.Sh SEE ALSO
79.Xr rump 3 ,
80.Xr bridge 4 ,
81.Xr tap 4 ,
82.Xr brconfig 8 ,
83.Xr ifconfig 8
84