Skip to content

Commit

Permalink
docs: virt: guest-halt-polling.txt convert to ReST
Browse files Browse the repository at this point in the history
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: Mauro Carvalho Chehab <[email protected]>
Signed-off-by: Paolo Bonzini <[email protected]>
  • Loading branch information
mchehab authored and bonzini committed Feb 12, 2020
1 parent 033741c commit 120881b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
==================
Guest halt polling
==================

The cpuidle_haltpoll driver, with the haltpoll governor, allows
the guest vcpus to poll for a specified amount of time before
halting.

This provides the following benefits to host side polling:

1) The POLL flag is set while polling is performed, which allows
Expand All @@ -29,25 +31,29 @@ Module Parameters
The haltpoll governor has 5 tunable module parameters:

1) guest_halt_poll_ns:

Maximum amount of time, in nanoseconds, that polling is
performed before halting.

Default: 200000

2) guest_halt_poll_shrink:

Division factor used to shrink per-cpu guest_halt_poll_ns when
wakeup event occurs after the global guest_halt_poll_ns.

Default: 2

3) guest_halt_poll_grow:

Multiplication factor used to grow per-cpu guest_halt_poll_ns
when event occurs after per-cpu guest_halt_poll_ns
but before global guest_halt_poll_ns.

Default: 2

4) guest_halt_poll_grow_start:

The per-cpu guest_halt_poll_ns eventually reaches zero
in case of an idle system. This value sets the initial
per-cpu guest_halt_poll_ns when growing. This can
Expand All @@ -66,13 +72,13 @@ high once achieves global guest_halt_poll_ns value).

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/

Further Notes
=============

- 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
would be almost entirely idle otherwise.
large value has the potential to drive the cpu usage to 100% on a machine
which would be almost entirely idle otherwise.
1 change: 1 addition & 0 deletions Documentation/virt/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Linux Virtualization Support
kvm/index
uml/user_mode_linux
paravirt_ops
guest-halt-polling

.. only:: html and subproject

Expand Down

0 comments on commit 120881b

Please sign in to comment.