shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2025-01-08 21:17:47 +03:00
Code

docs: update docs with StartupAllowedCPUs and StartupAllowedMemoryNodes details

Browse Source 
Signed-off-by: Peter Morrow <pemorrow@linux.microsoft.com>
This commit is contained in:
Peter Morrow 2021-09-14 17:28:46 +01:00
parent 31d3a52029
commit c93a7d4ad3
3 changed files with 92 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/TRANSIENT-SETTINGS.md
View File

@ -238,7 +238,9 @@ All cgroup/resource control settings are available for transient units
✓ CPUQuota=
✓ CPUQuotaPeriodSec=
✓ AllowedCPUs=
✓ StartupAllowedCPUs=
✓ AllowedMemoryNodes=
✓ StartupAllowedMemoryNodes=
✓ MemoryAccounting=
✓ DefaultMemoryMin=
✓ MemoryMin=

72
man/org.freedesktop.systemd1.xml
View File

@ -2445,8 +2445,12 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice {
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly b IOAccounting = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t IOWeight = ...;
@ -2988,8 +2992,12 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice {
<!--property AllowedCPUs is not documented!-->
<!--property StartupAllowedCPUs is not documented!-->
<!--property AllowedMemoryNodes is not documented!-->
<!--property StartupAllowedMemoryNodes is not documented!-->
<!--property IOAccounting is not documented!-->
<!--property IOWeight is not documented!-->
@ -3558,8 +3566,12 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice {
<variablelist class="dbus-property" generated="True" extra-ref="AllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="AllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOWeight"/>
@ -4263,8 +4275,12 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket {
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly b IOAccounting = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t IOWeight = ...;
@ -4834,8 +4850,12 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket {
<!--property AllowedCPUs is not documented!-->
<!--property StartupAllowedCPUs is not documented!-->
<!--property AllowedMemoryNodes is not documented!-->
<!--property StartupAllowedMemoryNodes is not documented!-->
<!--property IOAccounting is not documented!-->
<!--property IOWeight is not documented!-->
@ -5402,8 +5422,12 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket {
<variablelist class="dbus-property" generated="True" extra-ref="AllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="AllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOWeight"/>
@ -6004,8 +6028,12 @@ node /org/freedesktop/systemd1/unit/home_2emount {
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly b IOAccounting = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t IOWeight = ...;
@ -6503,8 +6531,12 @@ node /org/freedesktop/systemd1/unit/home_2emount {
<!--property AllowedCPUs is not documented!-->
<!--property StartupAllowedCPUs is not documented!-->
<!--property AllowedMemoryNodes is not documented!-->
<!--property StartupAllowedMemoryNodes is not documented!-->
<!--property IOAccounting is not documented!-->
<!--property IOWeight is not documented!-->
@ -6989,8 +7021,12 @@ node /org/freedesktop/systemd1/unit/home_2emount {
<variablelist class="dbus-property" generated="True" extra-ref="AllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="AllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOWeight"/>
@ -7712,8 +7748,12 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap {
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly b IOAccounting = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t IOWeight = ...;
@ -8197,8 +8237,12 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap {
<!--property AllowedCPUs is not documented!-->
<!--property StartupAllowedCPUs is not documented!-->
<!--property AllowedMemoryNodes is not documented!-->
<!--property StartupAllowedMemoryNodes is not documented!-->
<!--property IOAccounting is not documented!-->
<!--property IOWeight is not documented!-->
@ -8669,8 +8713,12 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap {
<variablelist class="dbus-property" generated="True" extra-ref="AllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="AllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOWeight"/>
@ -9245,8 +9293,12 @@ node /org/freedesktop/systemd1/unit/system_2eslice {
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly b IOAccounting = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t IOWeight = ...;
@ -9390,8 +9442,12 @@ node /org/freedesktop/systemd1/unit/system_2eslice {
<!--property AllowedCPUs is not documented!-->
<!--property StartupAllowedCPUs is not documented!-->
<!--property AllowedMemoryNodes is not documented!-->
<!--property StartupAllowedMemoryNodes is not documented!-->
<!--property IOAccounting is not documented!-->
<!--property IOWeight is not documented!-->
@ -9542,8 +9598,12 @@ node /org/freedesktop/systemd1/unit/system_2eslice {
<variablelist class="dbus-property" generated="True" extra-ref="AllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="AllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOWeight"/>
@ -9714,8 +9774,12 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope {
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedCPUs = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay AllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly ay StartupAllowedMemoryNodes = [...];
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly b IOAccounting = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly t IOWeight = ...;
@ -9875,8 +9939,12 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope {
<!--property AllowedCPUs is not documented!-->
<!--property StartupAllowedCPUs is not documented!-->
<!--property AllowedMemoryNodes is not documented!-->
<!--property StartupAllowedMemoryNodes is not documented!-->
<!--property IOAccounting is not documented!-->
<!--property IOWeight is not documented!-->
@ -10053,8 +10121,12 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope {
<variablelist class="dbus-property" generated="True" extra-ref="AllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedCPUs"/>
<variablelist class="dbus-property" generated="True" extra-ref="AllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="StartupAllowedMemoryNodes"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOAccounting"/>
<variablelist class="dbus-property" generated="True" extra-ref="IOWeight"/>

23
man/systemd.resource-control.xml
View File

@ -237,13 +237,20 @@
<varlistentry>
<term><varname>AllowedCPUs=</varname></term>
<term><varname>StartupAllowedCPUs=</varname></term>
<listitem>
<para>Restrict processes to be executed on specific CPUs. Takes a list of CPU indices or ranges separated by either
whitespace or commas. CPU ranges are specified by the lower and upper CPU indices separated by a dash.</para>
<para>Setting <varname>AllowedCPUs=</varname> doesn't guarantee that all of the CPUs will be used by the processes
as it may be limited by parent units. The effective configuration is reported as <varname>EffectiveCPUs=</varname>.</para>
<para>Setting <varname>AllowedCPUs=</varname> or <varname>StartupAllowedCPUs=</varname> doesn't guarantee that all
of the CPUs will be used by the processes as it may be limited by parent units. The effective configuration is
reported as <varname>EffectiveCPUs=</varname>.</para>
<para>While <varname>StartupAllowedCPUs=</varname> only applies to the startup phase of the system,
<varname>AllowedCPUs=</varname> applies to normal runtime of the system, and if the former is not set also to
the startup phase. Using <varname>StartupAllowedCPUs=</varname> allows prioritizing specific services at
boot-up differently than during normal runtime.</para>
<para>This setting is supported only with the unified control group hierarchy.</para>
</listitem>
@ -251,15 +258,21 @@
<varlistentry>
<term><varname>AllowedMemoryNodes=</varname></term>
<term><varname>StartupAllowedMemoryNodes=</varname></term>
<listitem>
<para>Restrict processes to be executed on specific memory NUMA nodes. Takes a list of memory NUMA nodes indices
or ranges separated by either whitespace or commas. Memory NUMA nodes ranges are specified by the lower and upper
NUMA nodes indices separated by a dash.</para>
<para>Setting <varname>AllowedMemoryNodes=</varname> doesn't guarantee that all of the memory NUMA nodes will
be used by the processes as it may be limited by parent units. The effective configuration is reported as
<varname>EffectiveMemoryNodes=</varname>.</para>
<para>Setting <varname>AllowedMemoryNodes=</varname> or <varname>StartupAllowedMemoryNodes=</varname> doesn't
guarantee that all of the memory NUMA nodes will be used by the processes as it may be limited by parent units.
The effective configuration is reported as <varname>EffectiveMemoryNodes=</varname>.</para>
<para>While <varname>StartupAllowedMemoryNodes=</varname> only applies to the startup phase of the system,
<varname>AllowedMemoryNodes=</varname> applies to normal runtime of the system, and if the former is not set also to
the startup phase. Using <varname>StartupAllowedMemoryNodes=</varname> allows prioritizing specific services at
boot-up differently than during normal runtime.</para>
<para>This setting is supported only with the unified control group hierarchy.</para>
</listitem>