[libvirt] [PATCHv2 14/16] docs: Add hvf on QEMU driver page
It's worth to make the domain type a little bit more visible than a row
in news. An example of hvf domain is available on QEMU driver page.
While at it, mention Hypervisor.framework on index page.
Signed-off-by: Roman Bolshakov <r.bolshakov(a)yadro.com>
---
docs/drvqemu.html.in | 49 +++++++++++++++++++++++++++++++++++++++++---
docs/index.html.in | 1 +
2 files changed, 47 insertions(+), 3 deletions(-)
diff --git a/docs/drvqemu.html.in b/docs/drvqemu.html.in
index 0d14027646..7c511ce3b6 100644
--- a/docs/drvqemu.html.in
+++ b/docs/drvqemu.html.in
@@ -2,13 +2,16 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<body>
- <h1>KVM/QEMU hypervisor driver</h1>
+ <h1>QEMU/KVM/HVF hypervisor driver</h1>
<ul id="toc"></ul>
<p>
- The libvirt KVM/QEMU driver can manage any QEMU emulator from
- version 1.5.0 or later.
+ The libvirt QEMU driver can manage any QEMU emulator from
+ version 1.5.0 or later. It supports multiple QEMU accelerators: software
+ emulation also known as TCG, hardware-assisted virtualization on Linux
+ with KVM and hardware-assisted virtualization on macOS with
+ Hypervisor.framework (<span class="since">since
4.10.0</span>).
</p>
<h2><a id="project">Project Links</a></h2>
@@ -21,6 +24,9 @@
<li>
The <a href="https://wiki.qemu.org/Index.html">QEMU</a>
emulator
</li>
+ <li>
+ <a
href="https://developer.apple.com/documentation/hypervisor">...
reference
+ </li>
</ul>
<h2><a id="prereq">Deployment
pre-requisites</a></h2>
@@ -41,6 +47,13 @@
node. If both are found, then KVM fullyvirtualized, hardware accelerated
guests will be available.
</li>
+ <li>
+ <strong>Hypervisor.framework (HVF)</strong>: The driver will probe
+ <code>sysctl</code> for the presence of
+ <code>Hypervisor.framework</code>. If it is found and QEMU is newer
+ than 2.12, then it will be possible to create hardware accelerated
+ guests.
+ </li>
</ul>
<h2><a id="uris">Connections to QEMU
driver</a></h2>
@@ -640,5 +653,35 @@ $ virsh domxml-to-native qemu-argv demo.xml
</devices>
</domain></pre>
+ <h3>HVF hardware accelerated guest on x86_64</h3>
+
+ <pre><domain type='hvf'>
+ <name>hvf-demo</name>
+ <uuid>4dea24b3-1d52-d8f3-2516-782e98a23fa0</uuid>
+ <memory>131072</memory>
+ <vcpu>1</vcpu>
+ <os>
+ <type arch="x86_64">hvm</type>
+ </os>
+ <features>
+ <acpi/>
+ </features>
+ <clock sync="localtime"/>
+ <devices>
+ <emulator>/usr/local/bin/qemu-system-x86_64</emulator>
+ <controller type='scsi' index='0'
model='virtio-scsi'/>
+ <disk type='volume' device='disk'>
+ <driver name='qemu' type='qcow2'/>
+ <source pool='default' volume='myos'/>
+ <target bus='scsi' dev='sda'/>
+ </disk>
+ <interface type='user'>
+ <mac address='24:42:53:21:52:45'/>
+ <model type='virtio'/>
+ </interface>
+ <graphics type='vnc' port='-1'/>
+ </devices>
+</domain></pre>
+
</body>
</html>
diff --git a/docs/index.html.in b/docs/index.html.in
index 1f9f448399..b02802fdd9 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -32,6 +32,7 @@
<li>is accessible from C, Python, Perl, Java and more</li>
<li>is licensed under open source licenses</li>
<li>supports <a href="drvqemu.html">KVM</a>,
+ <a href="drvqemu.html">Hypervisor.framework</a>,
<a href="drvqemu.html">QEMU</a>, <a
href="drvxen.html">Xen</a>,
<a href="drvvirtuozzo.html">Virtuozzo</a>,
<a href="drvesx.html">VMWare ESX</a>,
--
2.19.1