share/man/man4/virtio_balloon.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 .Dd October 26, 2018
  26 .Dt VIRTIO_BALLOON 4
  27 .Os
  28 .Sh NAME
  29 .Nm virtio_balloon
  30 .Nd VirtIO Memory Balloon driver
  31 .Sh SYNOPSIS
  32 To compile this driver into the kernel,
  33 place the following lines in your
  34 kernel configuration file:
  35 .Bd -ragged -offset indent
  36 .Cd "device virtio_balloon"
  37 .Ed
  38 .Pp
  39 Alternatively, to load the driver as a
  40 module at boot time, place the following line in
  41 .Xr loader.conf 5 :
  42 .Bd -literal -offset indent
  43 virtio_balloon_load="YES"
  44 .Ed
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 device driver provides support for VirtIO memory balloon devices.
  49 .Pp
  50 The memory balloon allows the guest to, at the request of the
  51 hypervisor, return memory allocated to the hypervisor so it can
  52 be made available to other guests.
  53 The hypervisor can later signal the balloon to return the memory.
  54 .Sh EXAMPLE:
  55 .Bd -literal
  56 (vmguest) # kldload virtio_balloon
  57 (vmguest) # sysctl dev.vtballoon.desired
  58 dev.vtballoon.0.desired: 0
  59 (vmguest) # sysctl dev.vtballoon.current
  60 dev.vtballoon.0.current: 0
  61
  62 (vmhost) # virsh qemu-monitor-command --domain <vmguest> --hmp 'balloon 2000'
  63
  64 (vmguest) # sysctl dev.vtballoon.desired
  65 dev.vtballoon.0.desired: 536576
  66 (vmguest) # sysctl dev.vtballoon.current
  67 dev.vtballoon.0.current: 536576
  68 .Ed
  69 .Sh SEE ALSO
  70 .Xr virtio 4
  71 .Sh HISTORY
  72 The
  73 .Nm
  74 driver was written by
  75 .An Bryan Venteicher Aq Mt bryanv@FreeBSD.org .
  76 It first appeared in
  77 .Fx 9.0 .