Commit 120881b9 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Paolo Bonzini

docs: virt: guest-halt-polling.txt convert to ReST

Due to some merge conflict, this file ended being alone under
Documentation/virtual.

The file itself is almost at ReST format. Just minor
adjustments are needed:

- Adjust title markup;
- Adjust a list identation;
- add a literal block markup;
- Add some blank lines.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 033741c6
==================
Guest halt polling Guest halt polling
================== ==================
The cpuidle_haltpoll driver, with the haltpoll governor, allows The cpuidle_haltpoll driver, with the haltpoll governor, allows
the guest vcpus to poll for a specified amount of time before the guest vcpus to poll for a specified amount of time before
halting. halting.
This provides the following benefits to host side polling: This provides the following benefits to host side polling:
1) The POLL flag is set while polling is performed, which allows 1) The POLL flag is set while polling is performed, which allows
...@@ -29,18 +31,21 @@ Module Parameters ...@@ -29,18 +31,21 @@ Module Parameters
The haltpoll governor has 5 tunable module parameters: The haltpoll governor has 5 tunable module parameters:
1) guest_halt_poll_ns: 1) guest_halt_poll_ns:
Maximum amount of time, in nanoseconds, that polling is Maximum amount of time, in nanoseconds, that polling is
performed before halting. performed before halting.
Default: 200000 Default: 200000
2) guest_halt_poll_shrink: 2) guest_halt_poll_shrink:
Division factor used to shrink per-cpu guest_halt_poll_ns when Division factor used to shrink per-cpu guest_halt_poll_ns when
wakeup event occurs after the global guest_halt_poll_ns. wakeup event occurs after the global guest_halt_poll_ns.
Default: 2 Default: 2
3) guest_halt_poll_grow: 3) guest_halt_poll_grow:
Multiplication factor used to grow per-cpu guest_halt_poll_ns Multiplication factor used to grow per-cpu guest_halt_poll_ns
when event occurs after per-cpu guest_halt_poll_ns when event occurs after per-cpu guest_halt_poll_ns
but before global guest_halt_poll_ns. but before global guest_halt_poll_ns.
...@@ -48,6 +53,7 @@ but before global guest_halt_poll_ns. ...@@ -48,6 +53,7 @@ but before global guest_halt_poll_ns.
Default: 2 Default: 2
4) guest_halt_poll_grow_start: 4) guest_halt_poll_grow_start:
The per-cpu guest_halt_poll_ns eventually reaches zero The per-cpu guest_halt_poll_ns eventually reaches zero
in case of an idle system. This value sets the initial in case of an idle system. This value sets the initial
per-cpu guest_halt_poll_ns when growing. This can per-cpu guest_halt_poll_ns when growing. This can
...@@ -66,7 +72,7 @@ high once achieves global guest_halt_poll_ns value). ...@@ -66,7 +72,7 @@ high once achieves global guest_halt_poll_ns value).
Default: Y Default: Y
The module parameters can be set from the debugfs files in: The module parameters can be set from the debugfs files in::
/sys/module/haltpoll/parameters/ /sys/module/haltpoll/parameters/
...@@ -74,5 +80,5 @@ Further Notes ...@@ -74,5 +80,5 @@ Further Notes
============= =============
- Care should be taken when setting the guest_halt_poll_ns parameter as a - Care should be taken when setting the guest_halt_poll_ns parameter as a
large value has the potential to drive the cpu usage to 100% on a machine which large value has the potential to drive the cpu usage to 100% on a machine
would be almost entirely idle otherwise. which would be almost entirely idle otherwise.
...@@ -10,6 +10,7 @@ Linux Virtualization Support ...@@ -10,6 +10,7 @@ Linux Virtualization Support
kvm/index kvm/index
uml/user_mode_linux uml/user_mode_linux
paravirt_ops paravirt_ops
guest-halt-polling
.. only:: html and subproject .. only:: html and subproject
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment