From nobody Mon Feb 9 12:09:02 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1641892635; cv=none; d=zohomail.com; s=zohoarc; b=VNcq09bV41fX5ox7cMR15GH5dXCAcsQ/Cn/lleIXrCWfVF4PwJ26z3FceB020X2UjDq/Gwjl/6CULqJz4o0YzxUK0osaDTDYfIFXXbApJH3zMPltPdRCE7oAx0ChCw0gV8hnEHJdTML9Na7rG3wBAvPG+xWmRKWuAcOJH/5blgM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1641892635; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=w0ffZBAN1hKQfp9/fSsFfN/buNfb2DZOz2UYTufwU0g=; b=UHxcNoySmHaM5Xk2TAZDCu+THdZSyzXAy1gkfvYW9uaD+iKMHHxGGWyfKRMQJckMwlAw0jxMoU7iS1hA8U/mp9IFqygnL62edKJ3H8TJv4sjYv53fOUM12q2cc0cRqmbuiu2llDjXpQ6+eJVfmu+wJI+wrd72iHNoDyCCqK/qqQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1641892635963992.0972630614646; Tue, 11 Jan 2022 01:17:15 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-224-eSXWJZ12N4eeHVbjqyMK4g-1; Tue, 11 Jan 2022 04:10:20 -0500 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 8AF4F86A06D; Tue, 11 Jan 2022 09:10:15 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 64F0D1F300; Tue, 11 Jan 2022 09:10:15 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 0AB1C4BB7C; Tue, 11 Jan 2022 09:10:15 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 20B9ADiH029682 for ; Tue, 11 Jan 2022 04:10:13 -0500 Received: by smtp.corp.redhat.com (Postfix) id 36C5C6F116; Tue, 11 Jan 2022 09:10:13 +0000 (UTC) Received: from kinshicho.usersys.redhat.com (unknown [10.40.195.37]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2F8B36F12A; Tue, 11 Jan 2022 09:10:11 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1641892634; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=w0ffZBAN1hKQfp9/fSsFfN/buNfb2DZOz2UYTufwU0g=; b=HXu/12aWsaU8MjngZei/D6VwvQq3ljdtOXIwYxOClZGpmy4BwlIPwHTF1Hun8dDkiigvoQ 13g733uZYzJohUEK0vx0nl+P+dPnRagKQDtAZ/2qI+/9ymXhWMPo9EkSmtrB4AF4slA4D3 VTE1LZOqOdOlNpP8i5pyFaVSmR9ZZ4I= X-MC-Unique: eSXWJZ12N4eeHVbjqyMK4g-1 From: Andrea Bolognani To: libvir-list@redhat.com Subject: [libvirt PATCH v5 17/20] docs: Note hvf support for domain elements Date: Tue, 11 Jan 2022 10:09:37 +0100 Message-Id: <20220111090940.1315732-18-abologna@redhat.com> In-Reply-To: <20220111090940.1315732-1-abologna@redhat.com> References: <20220111090940.1315732-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com Cc: r.bolshakov@yadro.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1641892637033100001 Content-Type: text/plain; charset="utf-8" From: Roman Bolshakov Many domain elements have "QEMU and KVM only" or "QEMU/KVM since x.y.z" remarks. Most of the elements work for HVF domain, so it makes sense to add respective notices for HVF domain. All the elements have been manually tested. Signed-off-by: Roman Bolshakov Signed-off-by: Andrea Bolognani Tested-by: Brad Laue --- docs/formatdomain.rst | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 3e9de05249..5042115fac 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -21,7 +21,7 @@ Element and attribute overview The root element required for all virtual machines is named ``domain``. It= has two attributes, the ``type`` specifies the hypervisor used for running the domain. The allowed values are driver specific, but include "xen", "kvm", -"hvf" (:since:`since 8.0.0 and QEMU 2.12`), "qemu" +"hvf" (:since:`since 8.1.0 and QEMU 2.12`), "qemu" and "lxc". The second attribute is ``id`` which is a unique integer identi= fier for the running guest machine. Inactive machines have no id value. =20 @@ -1426,7 +1426,8 @@ In case no restrictions need to be put on CPU model a= nd its features, a simpler :since:`Since 7.1.0` with the QEMU driver. =20 Both ``host-model`` and ``host-passthrough`` modes make sense when a do= main - can run directly on the host CPUs (for example, domains with type ``kvm= ``). + can run directly on the host CPUs (for example, domains with type ``kvm= `` + or ``hvf``). The actual host CPU is irrelevant for domains with emulated virtual CPUs (such as domains with type ``qemu``). However, for backward compatibili= ty ``host-model`` may be implemented even for domains running on emulated = CPUs @@ -1750,7 +1751,7 @@ Each of these states allow for the same four possible= actions. The domain will be terminated and then restarted with a new name. (Only supported by the libxl hypervisor driver.) =20 -QEMU/KVM supports the ``on_poweroff`` and ``on_reboot`` events handling the +QEMU/KVM/HVF supports the ``on_poweroff`` and ``on_reboot`` events handlin= g the ``destroy`` and ``restart`` actions, but the combination of ``on_poweroff`= ` set to ``restart`` and ``on_reboot`` set to ``destroy`` is forbidden. =20 @@ -1885,8 +1886,8 @@ are: Physical address extension mode allows 32-bit guests to address more th= an 4 GB of memory. ``acpi`` - ACPI is useful for power management, for example, with KVM guests it is - required for graceful shutdown to work. + ACPI is useful for power management, for example, with KVM or HVF guest= s it + is required for graceful shutdown to work. ``apic`` APIC allows the use of programmable IRQ management. :since:`Since 0.10.2 (QEMU only)` there is an optional attribute ``eoi`` with values ``on`` = and @@ -6195,14 +6196,16 @@ A video device. =20 You can provide the amount of video memory in kibibytes (blocks of 1024 bytes) using ``vram``. This is supported only for guest type of "vz", "= qemu", - "vbox", "vmx" and "xen". If no value is provided the default is used. I= f the + "kvm", "hvf", "vbox", "vmx" and "xen". + If no value is provided the default is used. If the size is not a power of two it will be rounded to closest one. =20 The number of screen can be set using ``heads``. This is supported only= for - guests type of "vz", "kvm", "vbox" and "vmx". + guests type of "vz", "kvm", "hvf", "vbox" and "vmx". =20 - For guest type of "kvm" or "qemu" and model type "qxl" there are option= al - attributes. Attribute ``ram`` ( :since:`since 1.0.2` ) specifies the si= ze of + For guest type of "kvm", "hvf" or "qemu" and model type "qxl" there are + optional attributes. + Attribute ``ram`` ( :since:`since 1.0.2` ) specifies the size of the primary bar, while the attribute ``vram`` specifies the secondary b= ar size. If ``ram`` or ``vram`` are not supplied a default value is used. = The ``ram`` should also be rounded to power of two as ``vram``. There is al= so --=20 2.31.1