diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index ba5bd1e502..6912762f28 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -1924,6 +1924,9 @@ <ioapic driver='qemu'/> <hpt resizing='required'/> <vmcoreinfo state='on'/> + <smm state='on'> + <tseg unit='MiB'>48</tseg> + </smm> </features> ... @@ -2079,10 +2082,55 @@ Since 1.2.16
smm
state
attribute (values on
,
+
+ Depending on the state
attribute (values on
,
off
, default on
) enable or disable
System Management Mode.
Since 2.1.0
+
Optional sub-element tseg
can be used to specify
+ the amount of memory dedicated to SMM's extended TSEG. That offers a
+ fourth option size apart from the existing ones (1 MiB, 2 MiB and 8
+ MiB) that the guest OS (or rather loader) can choose from. The size
+ can be specified as a value of that element, optional attribute
+ unit
can be used to specify the unit of the
+ aforementioned value (defaults to 'MiB'). If set to 0 the extended
+ size is not advertised and only the default ones (see above) are
+ available.
+
+ If the VM is booting you should leave this option alone, unless you + are very certain you know what you are doing. +
+ This value is configurable due to the fact that the calculation cannot
+ be done right with the guarantee that it will work correctly. In
+ QEMU, the user-configurable extended TSEG feature was unavailable up
+ to and including pc-q35-2.9
. Starting with
+ pc-q35-2.10
the feature is available, with default size
+ 16 MiB. That should suffice for up to roughly 272 VCPUs, 5 GiB guest
+ RAM in total, no hotplug memory range, and 32 GiB of 64-bit PCI MMIO
+ aperture. Or for 48 VCPUs, with 1TB of guest RAM, no hotplug DIMM
+ range, and 32GB of 64-bit PCI MMIO aperture. The values may also vary
+ based on the loader the VM is using.
+
+ Additional size might be needed for significantly higher VCPU counts + or increased address space (that can be memory, maxMemory, 64-bit PCI + MMIO aperture size; roughly 8 MiB of TSEG per 1 TiB of address space) + which can also be rounded up. +
+ Due to the nature of this setting being similar to "how much RAM + should the guest have" users are advised to either consult the + documentation of the guest OS or loader (if there is any), or test + this by trial-and-error changing the value until the VM boots + successfully. Yet another guiding value for users might be the fact + that 48 MiB should be enough for pretty large guests (240 VCPUs and + 4TB guest RAM), but it is on purpose not set as default as 48 MiB of + unavailable RAM might be too much for small guests (e.g. with 512 MiB + of RAM). +
+ See Memory Allocation
+ for more details about the unit
attribute.
+ Since 4.5.0 (QEMU only)
+
ioapic