External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 05:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve documentation for dies and clusters

Browse Source 
I've seen examples in the wild of the cluster attribute having
non-zero value on x86_64.

This is obviously quite confusing, but it's the information that
Linux exposes to userspace and we don't really have a way to tell
apart a valid die/cluster ID from a dummy one.

What ultimately matters is that the underlying assumptions about
topology are respected, which they are: in the x86_64 cases that
I have analyzed, for example, each "cluster" contained exactly
one core, so any program that would use this information to
influence guest topology decisions would be unaffected by the
additional level showing up in the hierarchy.

In an attempt to reduce confusion, remove any reference to any
specific value for the attributes having any special meaning
attached to it.

In fact, since there are plans to make it possible to create
guests with multiple CPU clusters on x86_64, rework the note
into a more generic warning cautioning users that an attribute
showing up here does not imply that the same attribute can be
used when defining a guest CPU topology.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Andrea Bolognani 2024-02-06 18:56:39 +01:00
parent c4e35af08c
commit 3f01ecd830
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/formatcaps.rst
View File

@ -74,14 +74,14 @@ The ``<host/>`` element consists of the following child elements:
``die_id`` ``die_id``
Identifier for the die the CPU is in. Identifier for the die the CPU is in.
Note that not all architectures support CPU dies: if the current Note that, even if this attribute is present, you might not be able to
architecture doesn't, the value will be 0 for all CPUs. define guests with multiple CPU dies.
``cluster_id`` ``cluster_id``
Identifier for the cluster the CPU is in. Identifier for the cluster the CPU is in.
Note that not all architectures support CPU clusters: if the current Note that, even if this attribute is present, you might not be able to
architecture doesn't, the value will be 0 for all CPUs. define guests with multiple CPU clusters.
``core_id`` ``core_id``
Identifier for the core the CPU is in. Identifier for the core the CPU is in.