/share/man/man4/virtio_balloon.4

https://bitbucket.org/freebsd/freebsd-head/ · Forth · 64 lines · 64 code · 0 blank · 0 comment · 1 complexity · 574ef9529af08eee3d89be774cca684e MD5 · raw file 

    

  1. .\" Copyright (c) 2011 Bryan Venteicher
    2. 

  2. .\" All rights reserved.
    3. 

  3. .\"
    4. 

  4. .\" Redistribution and use in source and binary forms, with or without
    5. 

  5. .\" modification, are permitted provided that the following conditions
    6. 

  6. .\" are met:
    7. 

  7. .\" 1. Redistributions of source code must retain the above copyright
    8. 

  8. .\"    notice, this list of conditions and the following disclaimer.
    9. 

  9. .\" 2. Redistributions in binary form must reproduce the above copyright
    10. 

  10. .\"    notice, this list of conditions and the following disclaimer in the
    11. 

  11. .\"    documentation and/or other materials provided with the distribution.
    12. 

  12. .\"
    13. 

  13. .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    14. 

  14. .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    15. 

  15. .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    16. 

  16. .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    17. 

  17. .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    18. 

  18. .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    19. 

  19. .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    20. 

  20. .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    21. 

  21. .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    22. 

  22. .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    23. 

  23. .\" SUCH DAMAGE.
    24. 

  24. .\"
    25. 

  25. .\" $FreeBSD$
    26. 

  26. .\"
    27. 

  27. .Dd January 22, 2012
    28. 

  28. .Dt VIRTIO_BALLOON 4
    29. 

  29. .Os
    30. 

  30. .Sh NAME
    31. 

  31. .Nm virtio_balloon
    32. 

  32. .Nd VirtIO Memory Balloon driver
    33. 

  33. .Sh SYNOPSIS
    34. 

  34. To compile this driver into the kernel,
    35. 

  35. place the following lines in your
    36. 

  36. kernel configuration file:
    37. 

  37. .Bd -ragged -offset indent
    38. 

  38. .Cd "device virtio_balloon"
    39. 

  39. .Ed
    40. 

  40. .Pp
    41. 

  41. Alternatively, to load the driver as a
    42. 

  42. module at boot time, place the following line in
    43. 

  43. .Xr loader.conf 5 :
    44. 

  44. .Bd -literal -offset indent
    45. 

  45. virtio_balloon_load="YES"
    46. 

  46. .Ed
    47. 

  47. .Sh DESCRIPTION
    48. 

  48. The
    49. 

  49. .Nm
    50. 

  50. device driver provides support for VirtIO memory balloon devices.
    51. 

  51. .Pp
    52. 

  52. The memory balloon allows the guest to, at the request of the
    53. 

  53. hypervisor, return memory allocated to the hypervisor so it can
    54. 

  54. be made available to other guests.
    55. 

  55. The hypervisor can later signal the balloon to return the memory.
    56. 

  56. .Sh SEE ALSO
    57. 

  57. .Xr virtio 4
    58. 

  58. .Sh HISTORY
    59. 

  59. The
    60. 

  60. .Nm
    61. 

  61. driver was written by
    62. 

  62. .An Bryan Venteicher Aq bryanv@daemoninthecloset.org .
    63. 

  63. It first appeared in
    64. 

  64. .Fx 9.0 .
    65.