man pages for vmm

2 files changed, 84 insertions, 2 deletions

diff --git a/share/man/man4/man4.amd64/Makefile b/share/man/man4/man4.amd64/Makefile
index eda175a7309..9148827dd1f 100644
--- a/share/man/man4/man4.amd64/Makefile
+++ b/share/man/man4/man4.amd64/Makefile
@@ -1,8 +1,8 @@
-#	$OpenBSD: Makefile,v 1.17 2015/08/31 03:48:30 yasuoka Exp $
+#	$OpenBSD: Makefile,v 1.18 2015/11/13 01:12:01 mlarkin Exp $
 
 MAN=	amdpcib.4 apm.4 autoconf.4 bios.4 cpu.4 efifb.4 intro.4 \
 	ioapic.4 mem.4 mpbios.4 mtrr.4 nvram.4 pctr.4 skgpio.4 \
-	tcpcib.4
+	tcpcib.4 vmm.4
 
 MLINKS+= mem.4 kmem.4
 MANSUBDIR=amd64
diff --git a/share/man/man4/man4.amd64/vmm.4 b/share/man/man4/man4.amd64/vmm.4
new file mode 100644
index 00000000000..dff01bbbabf
--- /dev/null
+++ b/share/man/man4/man4.amd64/vmm.4
@@ -0,0 +1,82 @@
+.\"
+.\"Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org>
+.\"
+.\"Permission to use, copy, modify, and distribute this software for any
+.\"purpose with or without fee is hereby granted, provided that the above
+.\"copyright notice and this permission notice appear in all copies.
+.\"
+.\"THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\"WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\"MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\"ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\"WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\"ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\"OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.Dd $Mdocdate: November 13 2015 $
+.Dt VMM 4 amd64
+.Os
+.Sh NAME
+.Nm vmm
+.Nd virtual machine monitor
+.Sh SYNOPSIS
+.Cd "vmm0    at mainbus0"
+.Sh DESCRIPTION
+The
+.Nm
+driver implements a virtual machine monitor (VMM) suitable for executing
+.Ar virtual machines
+(VMs). A VMM runs on the 
+.Ar host
+operating system and provides facilities to execute one or more
+VMs, each of which is provided with a suitable complement of
+virtual hardware.
+.Pp
+These VMs run independently of the host, but may interact with
+it as any other machine would (eg, via network communications or
+other means).
+.Pp
+VMs are allocated hardware resources by the VMM during creation,
+including:
+.Bl -bullet -compact
+.It
+Virtual CPUs
+.It
+Virtual network interfaces
+.It
+Virtual disk images
+.It
+Virtual serial ports
+.It
+etc...
+.El
+.Pp
+Although VMs execute independent of each other and the host, they
+do consume host resources, and as such, the number of VMs (and their
+configurations) should be taken into consideration when planning
+host capacity.
+.Pp
+The
+.Nm
+driver requires suitable host CPU capabilites in order to provide
+VM services. Currently, the
+.Nm
+driver requires at least one CPU with hardware-assisted virtualization
+capabillities. Presently, the
+.Nm
+driver requires nested or extended paging capabilities to be
+supported by the host CPU. For more information, consult your CPU
+vendor's documentation.
+.Sh SEE ALSO
+.Xr cpu 4 ,
+.Xr intro 4 ,
+.Xr vmmctl 8 ,
+.Xr vmd 8 ,
+.Xr virtio 4 ,
+.Sh HISTORY
+The
+.Nm
+driver
+appeared in
+.Ox 5.9 .
+.Sh AUTHORS
+.An Mike Larkin Aq Mt mlarkin@openbsd.org