/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.\" $FreeBSD$
26.\"
27.Dd January 22, 2012
28.Dt VIRTIO_BALLOON 4
29.Os
30.Sh NAME
31.Nm virtio_balloon
32.Nd VirtIO Memory Balloon driver
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device virtio_balloon"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45virtio_balloon_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50device driver provides support for VirtIO memory balloon devices.
51.Pp
52The memory balloon allows the guest to, at the request of the
53hypervisor, return memory allocated to the hypervisor so it can
54be made available to other guests.
55The hypervisor can later signal the balloon to return the memory.
56.Sh SEE ALSO
57.Xr virtio 4
58.Sh HISTORY
59The
60.Nm
61driver was written by
62.An Bryan Venteicher Aq bryanv@daemoninthecloset.org .
63It first appeared in
64.Fx 9.0 .