[PATCH 10/11] docs: Document CPU clusters

Signed-off-by: Andrea Bolognani <abologna(a)redhat.com&gt; --- docs/formatcaps.rst | 2 +- docs/formatdomain.rst | 18 ++++++++++-------- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/formatcaps.rst b/docs/formatcaps.rst index 3cccf70882..5c678f0787 100644 --- a/docs/formatcaps.rst +++ b/docs/formatcaps.rst @@ -160,7 +160,7 @@ capabilities enabled in the chip and BIOS you will see: <microcode version='236'/> <signature family='6' model='142' stepping='12'/> <counter name='tsc' frequency='2303997000' scaling='no'/> - <topology sockets='1' dies='1' cores='4' threads='2'/> + <topology sockets='1' dies='1' clusters='1' cores='4' threads='2'/> <maxphysaddr mode='emulate' bits='39'/> <feature name='ds'/> <feature name='acpi'/> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index b883b5b479..b892a98e88 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -1377,7 +1377,7 @@ following collection of elements. :since:`Since 0.7.5` <cpu match='exact'> <model fallback='allow'>core2duo</model> <vendor>Intel</vendor> - <topology sockets='1' dies='1' cores='2' threads='1'/> + <topology sockets='1' dies='1' clusters='1' cores='2' threads='1'/> <cache level='3' mode='emulate'/> <maxphysaddr mode='emulate' bits='42'/> <feature policy='disable' name='lahf_lm'/> @@ -1388,7 +1388,7 @@ following collection of elements. :since:`Since 0.7.5` <cpu mode='host-model'> <model fallback='forbid'/> - <topology sockets='1' dies='1' cores='2' threads='1'/> + <topology sockets='1' dies='1' clusters='1' cores='2' threads='1'/> </cpu> ... @@ -1414,7 +1414,7 @@ In case no restrictions need to be put on CPU model and its features, a simpler ... <cpu> - <topology sockets='1' dies='1' cores='2' threads='1'/> + <topology sockets='1' dies='1' clusters='1' cores='2' threads='1'/> </cpu> ... @@ -1579,12 +1579,14 @@ In case no restrictions need to be put on CPU model and its features, a simpler ``topology`` The ``topology`` element specifies requested topology of virtual CPU provided to the guest. - Four attributes, ``sockets``, ``dies`` (:since:`Since 6.1.0`), ``cores``, and - ``threads``, accept non-zero positive integer values. + Five attributes, ``sockets``, ``dies`` (:since:`Since 6.1.0`), ``clusters`` + (:since:`Since 10.0.0`), ``cores``, and ``threads``, accept non-zero positive + integer values. They refer to the total number of CPU sockets, 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. + number of clusters per die, number of cores per cluster, and number of + threads per core, respectively. + The ``dies`` and ``clusters`` attributes are 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. -- 2.43.0