share/man/man4/virtio.4

   1 .\" Copyright (c) 2011 Bryan Venteicher
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd July 4, 2011
  28 .Dt VIRTIO 4
  29 .Os
  30 .Sh NAME
  31 .Nm virtio
  32 .Nd VirtIO Device Support
  33 .Sh SYNOPSIS
  34 To compile VirtIO device support into the kernel, place the following lines
  35 in your kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device virtio"
  38 .Cd "device virtio_pci"
  39 .Ed
  40 .Pp
  41 Alternatively, to load VirtIO support as modules at boot time, place the
  42 following lines in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 virtio_load="YES"
  46 virtio_pci_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 VirtIO is a specification for para-virtualized I/O in a virtual machine (VM).
  50 Traditionally, the hypervisor emulated real devices such as an Ethernet
  51 interface or disk controller to provide the VM with I/O. This emulation is
  52 often inefficient.
  53 .Pp
  54 VirtIO defines an interface for efficient I/O between the hypervisor and VM.
  55 The
  56 .Xr virtio 4
  57 module provides a shared memory transport called a virtqueue.
  58 The
  59 .Xr virtio_pci 4
  60 device driver represents an emulated PCI device that the hypervisor makes
  61 available to the VM. This device provides the probing, configuration, and
  62 interrupt notifications need to interact with the hypervisor.
  63 .Fx
  64 supports the following VirtIO devices:
  65 .Bl -hang -offset indent -width xxxxxxxx
  66 .It Nm Ethernet
  67 An emulated Ethernet device is provided by the
  68 .Xr if_vtnet 4
  69 device driver.
  70 .It Nm Block
  71 An emulated disk controller is provided by the
  72 .Xr virtio_blk 4
  73 device driver.
  74 .It Nm Balloon
  75 A pseudo-device to allow the VM to release memory back to the hypervisor is
  76 provided by the
  77 .Xr virtio_balloon 4
  78 device driver.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr if_vtnet 4 ,
  82 .Xr virtio_blk 4 ,
  83 .Xr virtio_balloon 4
  84 .Sh HISTORY
  85 Support for VirtIO first appeared in
  86 .Fx 9.0 .
  87 .Sh AUTHORS
  88 .An -nosplit
  89 .Fx
  90 support for VirtIO was first added by
  91 .An Bryan Venteicher Aq bryanv@daemoninthecloset.org .