Module Name: src
Committed By: minoura
Date: Sat Nov 26 15:04:45 UTC 2011
Modified Files:
src/share/man/man4: Makefile virtio.4
Added Files:
src/share/man/man4: vioif.4 viomb.4
Log Message:
Add vioif(4) and viomb(4).
To generate a diff of this commit:
cvs rdiff -u -r1.574 -r1.575 src/share/man/man4/Makefile
cvs rdiff -u -r0 -r1.1 src/share/man/man4/vioif.4 src/share/man/man4/viomb.4
cvs rdiff -u -r1.2 -r1.3 src/share/man/man4/virtio.4
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/share/man/man4/Makefile
diff -u src/share/man/man4/Makefile:1.574 src/share/man/man4/Makefile:1.575
--- src/share/man/man4/Makefile:1.574 Sun Nov 13 12:35:40 2011
+++ src/share/man/man4/Makefile Sat Nov 26 15:04:45 2011
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.574 2011/11/13 12:35:40 mbalmer Exp $
+# $NetBSD: Makefile,v 1.575 2011/11/26 15:04:45 minoura Exp $
# @(#)Makefile 8.1 (Berkeley) 6/18/93
MAN= aac.4 ac97.4 acardide.4 aceride.4 acphy.4 \
@@ -61,8 +61,8 @@ MAN= aac.4 ac97.4 acardide.4 aceride.4 a
ti.4 tl.4 tlp.4 tlphy.4 \
tp.4 tr.4 tra.4 trm.4 tty.4 tun.4 tqphy.4 twa.4 twe.4 txp.4 \
uark.4 ubsec.4 udp.4 uep.4 ug.4 uha.4 uk.4 ukphy.4 unix.4 userconf.4 \
- vald.4 veriexec.4 vga.4 vge.4 viaide.4 video.4 virt.4 virtio.4 vlan.4 \
- vmmon.4 vmnet.4 vnd.4 vr.4 vte.4 \
+ vald.4 veriexec.4 vga.4 vge.4 viaide.4 video.4 vioif.4 viomb.4 virt.4 \
+ virtio.4 vlan.4 vmmon.4 vmnet.4 vnd.4 vr.4 vte.4 \
wapbl.4 wb.4 wbsio.4 wd.4 wdc.4 wi.4 wm.4 wpi.4 \
wscons.4 wsdisplay.4 wsfont.4 wskbd.4 wsmouse.4 wsmux.4 \
xbox.4 xge.4 \
Index: src/share/man/man4/virtio.4
diff -u src/share/man/man4/virtio.4:1.2 src/share/man/man4/virtio.4:1.3
--- src/share/man/man4/virtio.4:1.2 Sun Nov 6 17:31:19 2011
+++ src/share/man/man4/virtio.4 Sat Nov 26 15:04:45 2011
@@ -1,4 +1,4 @@
-.\" $NetBSD: virtio.4,v 1.2 2011/11/06 17:31:19 wiz Exp $
+.\" $NetBSD: virtio.4,v 1.3 2011/11/26 15:04:45 minoura Exp $
.\"
.\" Copyright (c) 2011 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -45,7 +45,8 @@ device driver represents an emulated PCI
available to the virtual machine.
.Pp
.Nm
-supports the following devices:
+driver itself provides the core infrastructure to communicate
+with the hypervisor (called virtqueues) and supports the following devices:
.Bl -tag -width xxxxx
.It Nm ld
A Disk device.
@@ -55,7 +56,16 @@ An Ethernet device.
A pseudo-device to release memory back to the hypervisor.
.El
.Sh SEE ALSO
-.Xr ld 4
+.Xr pci 4 ,
+.Xr viomb 4 ,
+.Xr ld 4 ,
+.Xr vioif 4
+.Pp
+.Rs
+.%A Rusty Russell, IBM Corporation
+.%T Virtio PCI Card Specification
+.%O http://ozlabs.org/~rusty/virtio-spec/
+.Re
.Sh HISTORY
The
.Nm
Added files:
Index: src/share/man/man4/vioif.4
diff -u /dev/null src/share/man/man4/vioif.4:1.1
--- /dev/null Sat Nov 26 15:04:45 2011
+++ src/share/man/man4/vioif.4 Sat Nov 26 15:04:45 2011
@@ -0,0 +1,58 @@
+.\" $NetBSD: vioif.4,v 1.1 2011/11/26 15:04:45 minoura Exp $
+.\"
+.\" Copyright (C) 2011 Minoura Makoto.
+.\" 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 ``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 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.
+.\"
+.Dd
+.Dt VIOIF 4
+.Os
+.Sh NAME
+.Nm vioif
+.Nd VirtIO NIC driver
+.Sh SYNOPSIS
+.Cd "virtio* at pci? dev ? function ?"
+.Cd "vioif* at virtio?"
+.Sh DESCRIPTION
+VirtIO
+defines an interface for efficient, standard and extensible I/O between the
+hypervisor and the virtual machine.
+The
+.Nm
+driver supports virtio-compliant virtual network interface cards.
+.Sh SEE ALSO
+.Xr virtio 4 ,
+.Xr netinto 4 ,
+.Xr ifconfig 8
+.Rs
+.%A Rusty Russell, IBM Corporation
+.%T Virtio PCI Card Specification
+.%O http://ozlabs.org/~rusty/virtio-spec/
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver appeared in
+.Nx 6.0 .
+.Sh BUGS
+No offloading support.
Index: src/share/man/man4/viomb.4
diff -u /dev/null src/share/man/man4/viomb.4:1.1
--- /dev/null Sat Nov 26 15:04:45 2011
+++ src/share/man/man4/viomb.4 Sat Nov 26 15:04:45 2011
@@ -0,0 +1,81 @@
+.\" $NetBSD: viomb.4,v 1.1 2011/11/26 15:04:45 minoura Exp $
+.\"
+.\" Copyright (C) 2011 Minoura Makoto.
+.\" 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 ``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 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.
+.\"
+.Dd
+.Dt VIOMB 4
+.Os
+.Sh NAME
+.Nm viomb
+.Nd VirtIO memory ballooning driver
+.Sh SYNOPSIS
+.Cd "virtio* at pci? dev ? function ?"
+.Cd "viomb* at virtio?"
+.Sh DESCRIPTION
+VirtIO defines an interface for efficient, standard and extensible I/O between
+the hypervisor and the virtual machine. The
+.Nm
+driver supports the virtio-compliant memory ballooning device.
+.Pp
+Memory ballooning works as follows:
+.Pp
+.Bl -enum -compact
+.It
+The host operator requests a guest to return some amount of memory to the host
+(via e.g. Qemu monitor balloon command).
+.It
+The hypervisor sends the request via VirtIO memory ballooning device.
+.It
+The guest
+.Nm
+driver requests allocation of that amount of physical memory from the
+.Nx
+memory management system.
+.It
+The
+.Nm
+device tells the hypervisor the guest physical memory address of the
+allocated memory via VirtIO memory ballooning device.
+.El
+.Pp
+The sysctl node hw.viomb.npages shows the requested number of memory pages
+to return to the hypervisor, while hw.viomb.actual shows the actual
+number of memory pages that is already returned to the hypervisor.
+.Sh SEE ALSO
+.Xr virtio 4 ,
+.Xr sysctl 8
+.Pp
+.Rs
+.%A Rusty Russell, IBM Corporation
+.%T Virtio PCI Card Specification
+.%O http://ozlabs.org/~rusty/virtio-spec/
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver appeared in
+.Nx 6.0 .
+.Sh BUG
+The userland interface should be same as the Xen ballooning device.
