From a3255f67948817ac1be19766279e970f6fdd5161 Mon Sep 17 00:00:00 2001 From: Mike Larkin Date: Fri, 21 Oct 2016 06:29:11 +0000 Subject: man pages for vmm(4) i386 --- share/man/man4/man4.i386/Makefile | 4 +- share/man/man4/man4.i386/vmm.4 | 82 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 2 deletions(-) create mode 100644 share/man/man4/man4.i386/vmm.4 (limited to 'share') diff --git a/share/man/man4/man4.i386/Makefile b/share/man/man4/man4.i386/Makefile index 7d1bc2f1c83..70efb2f2644 100644 --- a/share/man/man4/man4.i386/Makefile +++ b/share/man/man4/man4.i386/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.75 2016/08/31 12:48:23 tedu Exp $ +# $OpenBSD: Makefile,v 1.76 2016/10/21 06:29:10 mlarkin Exp $ # from: @(#)Makefile 5.1 (Berkeley) 2/12/91 # Id: Makefile,v 1.4 1995/12/14 05:41:38 deraadt Exp $ @@ -7,7 +7,7 @@ MAN= amdpcib.4 amdmsr.4 apm.4 autoconf.4 bios.4 cpu.4 elansc.4 \ ichpcib.4 intro.4 ioapic.4 \ joy.4 le.4 lms.4 mem.4 mms.4 mpbios.4 mtrr.4 npx.4 nvram.4 \ pas.4 pcibios.4 pctr.4 piixpcib.4 sb.4 \ - skgpio.4 tcpcib.4 uha.4 wds.4 wdt.4 + skgpio.4 tcpcib.4 uha.4 vmm.4 wds.4 wdt.4 MANSUBDIR=i386 diff --git a/share/man/man4/man4.i386/vmm.4 b/share/man/man4/man4.i386/vmm.4 new file mode 100644 index 00000000000..b659995b2f6 --- /dev/null +++ b/share/man/man4/man4.i386/vmm.4 @@ -0,0 +1,82 @@ +.\" +.\"Copyright (c) 2015 Mike Larkin +.\" +.\"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: October 21 2016 $ +.Dt VMM 4 i386 +.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 +.Em virtual machines +(VMs). +A VMM runs on the +.Em 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 (e.g. via network communications or +other means). +.Pp +VMs are allocated hardware resources by the VMM during creation, +including: +.Pp +.Bl -bullet -offset indent -compact +.It +Virtual CPUs +.It +Virtual network interfaces +.It +Virtual disk images +.It +Virtual serial ports +.El +.Pp +Although VMs execute independently 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 capabilities in order to provide +VM services. +The +.Nm +driver requires at least one CPU with hardware-assisted virtualization +capabilities and nested or extended paging capabilities to be +present on the host. +For more information, consult the CPU vendor's documentation. +.Sh SEE ALSO +.Xr cpu 4 , +.Xr intro 4 , +.Xr virtio 4 , +.Xr vmctl 8 , +.Xr vmd 8 +.Sh HISTORY +The +.Nm +driver +appeared in +.Ox 5.9 . +.Sh AUTHORS +.An Mike Larkin Aq Mt mlarkin@openbsd.org -- cgit v1.2.3