[libvirt PATCH v7 15/18] docs: Add hvf on QEMU driver page

From: Roman Bolshakov <r.bolshakov(a)yadro.com&gt; 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&gt; Signed-off-by: Andrea Bolognani <abologna(a)redhat.com&gt; Tested-by: Brad Laue <brad(a)brad-x.com&gt; Tested-by: Christophe Fergeau <cfergeau(a)redhat.com&gt; Reviewed-by: Daniel P. Berrangé <berrange(a)redhat.com&gt; --- docs/drvqemu.rst | 48 +++++++++++++++++++++++++++++++++++++++++++--- docs/index.html.in | 1 + 2 files changed, 46 insertions(+), 3 deletions(-) diff --git a/docs/drvqemu.rst b/docs/drvqemu.rst index e18075d865..9d7dd2656b 100644 --- a/docs/drvqemu.rst +++ b/docs/drvqemu.rst @@ -1,13 +1,18 @@ .. role:: since .. role:: removed -========================== -KVM/QEMU hypervisor driver -========================== +============================== +QEMU/KVM/HVF hypervisor driver +============================== The libvirt KVM/QEMU driver can manage any QEMU emulator from version 2.11.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 (:since:`since 8.1.0`). + .. contents:: Project Links @@ -15,6 +20,7 @@ Project Links - The `KVM <https://www.linux-kvm.org/>`__ Linux hypervisor - The `QEMU <https://wiki.qemu.org/Index.html>`__ emulator +- `Hypervisor.framework`<https://developer.apple.com/documentation/hypervisor>__` reference Deployment pre-requisites ------------------------- @@ -27,6 +33,9 @@ Deployment pre-requisites - **KVM hypervisor**: The driver will probe ``/usr/bin`` for the presence of ``qemu-kvm`` and ``/dev/kvm`` device node. If both are found, then KVM fully virtualized, hardware accelerated guests will be available. +- **Hypervisor.framework (HVF)**: The driver will probe ``sysctl`` for the + presence of ``Hypervisor.framework``. If it is found and QEMU is newer than + 2.12, then it will be possible to create hardware accelerated guests. Connections to QEMU driver -------------------------- @@ -634,3 +643,36 @@ KVM hardware accelerated guest on i686 <graphics type='vnc' port='-1' keymap='de'/> </devices> </domain> + +HVF hardware accelerated guest on x86_64 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:: + + <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> diff --git a/docs/index.html.in b/docs/index.html.in index bf164edb58..2c4aa7c6d0 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -21,6 +21,7 @@ <li>is accessible from C, Python, Perl, Go 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.34.1