From nobody Wed May 15 10:53:25 2024 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; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=none dis=none) header.from=movementarian.org 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 164857551219032.53994281386838; Tue, 29 Mar 2022 10:38:32 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-49-gVFW7825OramD_rXaWzSqQ-1; Tue, 29 Mar 2022 13:38:29 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 255CD899ED5; Tue, 29 Mar 2022 17:38:24 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0431840CF8ED; Tue, 29 Mar 2022 17:38:21 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 474991940345; Tue, 29 Mar 2022 17:38:20 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 60FE31940342 for ; Tue, 29 Mar 2022 17:38:18 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 23913141DEDB; Tue, 29 Mar 2022 17:38:18 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast08.extmail.prod.ext.rdu2.redhat.com [10.11.55.24]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 20083142B94F for ; Tue, 29 Mar 2022 17:38:18 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E5DD7382220D for ; Tue, 29 Mar 2022 17:38:17 +0000 (UTC) Received: from sent.movementarian.org (88-98-93-30.dsl.in-addr.zen.co.uk [88.98.93.30]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-508-XfwlrhrjN1W5hUpD403Q8Q-1; Tue, 29 Mar 2022 13:38:14 -0400 Received: from jlevon by sent.movementarian.org with local (Exim 4.94.2) (envelope-from ) id 1nZFnH-006z1z-4C; Tue, 29 Mar 2022 18:38:11 +0100 X-MC-Unique: gVFW7825OramD_rXaWzSqQ-1 X-Original-To: libvir-list@listman.corp.redhat.com X-MC-Unique: XfwlrhrjN1W5hUpD403Q8Q-1 From: John Levon To: libvir-list@redhat.com Subject: [libvirt PATCH] fix documentation for sockets topology Date: Tue, 29 Mar 2022 18:38:11 +0100 Message-Id: <20220329173811.1664524-1-levon@movementarian.org> MIME-Version: 1.0 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Mimecast-Spam-Signature: yes X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: mprivozn@redhat.com, danielhb413@gmail.com, John Levon Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 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-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZM-MESSAGEID: 1648575513792100001 From: John Levon In 0895a0e, it was noted that the "sockets" value in the topology section of capabilities reflects not the number of sockets per NUMA node, not the total number. Unfortunately, the fix was applied to the wrong place: the domain XML format documentation, not that for the capabilities output. And, in fact, the domain XML interprets "sockets" as the total number, not a per-node value. Back out this change in favour of a note in the capabilities documentation instead. Fixes: 0895a0e75d13874254218e16dc66dcad673671d3 Suggested-by: Daniel P. Berrang=C3=A9 Signed-off-by: John Levon Reviewed-by: Daniel P. Berrang=C3=A9 --- docs/formatcaps.html.in | 5 ++++- docs/formatdomain.rst | 12 ++++++------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/formatcaps.html.in b/docs/formatcaps.html.in index 09662f78c8..a4abad5d20 100644 --- a/docs/formatcaps.html.in +++ b/docs/formatcaps.html.in @@ -51,7 +51,10 @@
topology
This element embodies the host internal topology. Management applications may want to learn this information when orchestrating n= ew - guests - e.g. due to reduce inter-NUMA node transfers.
+ guests - e.g. due to reduce inter-NUMA node transfers. Note that the + sockets value reported here is per-NUMA-node; this is in + contrast to the value given in domain definitions, which is interpre= ted + as a total number of sockets for the domain. =20
secmodel
To find out default security labels for different security model= s you diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index e492532004..9652e97eec 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -1489,12 +1489,12 @@ In case no restrictions need to be put on CPU model= and its features, a simpler The ``topology`` element specifies requested topology of virtual CPU pr= ovided to the guest. Four attributes, ``sockets``, ``dies``, ``cores``, and ``threads``, accept non-zero positive integer values. They refer to the - number of CPU sockets per NUMA node, number of dies per socket, number = of - cores per die, and number of threads per core, respectively. The ``dies= `` - attribute is optional and will default to 1 if omitted, while the other - attributes are all mandatory. Hypervisors may require that the maximum = number - of vCPUs specified by the ``cpus`` element equals to the number of vcpus - resulting from the topology. + total number of CPU sockets, number of dies per socket, number of cores= per + die, and number of threads per core, respectively. The ``dies`` attribu= te is + optional and will default to 1 if omitted, while the other attributes a= re all + mandatory. Hypervisors may require that the maximum number of vCPUs spe= cified + by the ``cpus`` element equals to the number of vcpus resulting from the + topology. ``feature`` The ``cpu`` element can contain zero or more ``feature`` elements used = to fine-tune features provided by the selected CPU model. The list of known --=20 2.32.0