2018-07-02 21:15:39 +00:00
<?xml version='1.0'?>
2019-03-14 13:40:58 +00:00
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2020-11-09 04:23:58 +00:00
<!-- SPDX - License - Identifier: LGPL - 2.1 - or - later -->
2013-07-10 05:25:02 +00:00
2020-03-05 01:31:36 +00:00
<refentry id= "systemd.resource-control" xmlns:xi= "http://www.w3.org/2001/XInclude" >
2013-07-10 05:25:02 +00:00
<refentryinfo >
2013-09-26 22:05:07 +00:00
<title > systemd.resource-control</title>
2013-07-10 05:25:02 +00:00
<productname > systemd</productname>
</refentryinfo>
<refmeta >
2013-09-26 22:05:07 +00:00
<refentrytitle > systemd.resource-control</refentrytitle>
2013-07-10 05:25:02 +00:00
<manvolnum > 5</manvolnum>
</refmeta>
<refnamediv >
2013-09-26 22:05:07 +00:00
<refname > systemd.resource-control</refname>
<refpurpose > Resource control unit settings</refpurpose>
2013-07-10 05:25:02 +00:00
</refnamediv>
<refsynopsisdiv >
<para >
<filename > <replaceable > slice</replaceable> .slice</filename> ,
<filename > <replaceable > scope</replaceable> .scope</filename> ,
<filename > <replaceable > service</replaceable> .service</filename> ,
<filename > <replaceable > socket</replaceable> .socket</filename> ,
<filename > <replaceable > mount</replaceable> .mount</filename> ,
<filename > <replaceable > swap</replaceable> .swap</filename>
</para>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
2016-10-17 13:50:26 +00:00
<para > Unit configuration files for services, slices, scopes, sockets, mount points, and swap devices share a subset
of configuration options for resource control of spawned processes. Internally, this relies on the Linux Control
Groups (cgroups) kernel concept for organizing processes in a hierarchical tree of named groups for the purpose of
resource management.</para>
2013-07-19 17:04:17 +00:00
2013-07-10 05:25:02 +00:00
<para > This man page lists the configuration options shared by
those six unit types. See
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for the common options of all unit configuration files, and
<citerefentry > <refentrytitle > systemd.slice</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.scope</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.service</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.socket</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.mount</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
and
<citerefentry > <refentrytitle > systemd.swap</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for more information on the specific unit configuration files. The
2013-09-26 22:05:07 +00:00
resource control configuration options are configured in the
2013-07-10 05:25:02 +00:00
[Slice], [Scope], [Service], [Socket], [Mount], or [Swap]
sections, depending on the unit type.</para>
2013-09-30 16:54:05 +00:00
2016-10-15 18:17:05 +00:00
<para > In addition, options which control resources available to programs
<emphasis > executed</emphasis> by systemd are listed in
<citerefentry > <refentrytitle > systemd.exec</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
Those options complement options listed here.</para>
2013-09-30 16:54:05 +00:00
<para > See the <ulink
2017-02-21 15:28:04 +00:00
url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface/">New
2013-10-15 06:58:51 +00:00
Control Group Interfaces</ulink> for an introduction on how to make
2013-09-30 16:54:05 +00:00
use of resource control APIs from programs.</para>
2021-02-25 13:54:54 +00:00
<refsect2 >
<title > Setting resource controls for a group of related units</title>
<para > As described in
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> , the
settings listed here may be set through the main file of a unit and drop-in snippets in
<filename index= "false" > *.d/</filename> directories. The list of directories searched for drop-ins
includes names formed by repeatedly truncating the unit name after all dashes. This is particularly
convenient to set resource limits for a group of units with similar names.</para>
<para > For example, every user gets their own slice
<filename > user-<replaceable > nnn</replaceable> .slice</filename> . Drop-ins with local configuration that
affect user 1000 may be placed in
<filename index= "false" > /etc/systemd/system/user-1000.slice</filename> ,
<filename index= "false" > /etc/systemd/system/user-1000.slice.d/*.conf</filename> , but also
<filename index= "false" > /etc/systemd/system/user-.slice.d/*.conf</filename> . This last directory
applies to all user slices.</para>
</refsect2>
2013-07-10 05:25:02 +00:00
</refsect1>
2015-11-11 19:47:07 +00:00
<refsect1 >
2017-09-12 04:02:27 +00:00
<title > Implicit Dependencies</title>
2015-11-11 19:47:07 +00:00
2017-09-12 04:02:27 +00:00
<para > The following dependencies are implicitly added:</para>
<itemizedlist >
<listitem > <para > Units with the <varname > Slice=</varname> setting set automatically acquire
<varname > Requires=</varname> and <varname > After=</varname> dependencies on the specified
slice unit.</para> </listitem>
</itemizedlist>
2015-11-11 19:47:07 +00:00
</refsect1>
2017-09-12 04:02:27 +00:00
<!-- We don't have any default dependency here. -->
2016-05-19 00:35:12 +00:00
<refsect1 >
<title > Unified and Legacy Control Group Hierarchies</title>
2020-01-09 09:37:52 +00:00
<para > The unified control group hierarchy is the new version of kernel control group interface, see
<ulink url= "https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html" > Control Groups v2</ulink> .
Depending on the resource type, there are differences in resource control capabilities. Also, because of
interface changes, some resource types have separate set of options on the unified hierarchy.</para>
2016-05-19 00:35:12 +00:00
<para >
<variablelist >
2016-08-07 13:45:39 +00:00
2016-05-19 00:35:12 +00:00
<varlistentry >
2019-11-21 19:33:26 +00:00
<term > CPU</term>
2016-05-19 00:35:12 +00:00
<listitem >
2016-08-07 13:45:39 +00:00
<para > <varname > CPUWeight=</varname> and <varname > StartupCPUWeight=</varname> replace
<varname > CPUShares=</varname> and <varname > StartupCPUShares=</varname> , respectively.</para>
<para > The <literal > cpuacct</literal> controller does not exist separately on the unified hierarchy.</para>
2016-05-19 00:35:12 +00:00
</listitem>
</varlistentry>
2016-08-07 13:45:39 +00:00
2016-05-27 16:10:18 +00:00
<varlistentry >
2019-11-21 19:33:26 +00:00
<term > Memory</term>
2016-05-27 16:10:18 +00:00
<listitem >
2016-06-08 17:37:42 +00:00
<para > <varname > MemoryMax=</varname> replaces <varname > MemoryLimit=</varname> . <varname > MemoryLow=</varname>
and <varname > MemoryHigh=</varname> are effective only on unified hierarchy.</para>
2016-05-27 16:10:18 +00:00
</listitem>
</varlistentry>
2016-08-07 13:45:39 +00:00
<varlistentry >
2019-11-21 19:33:26 +00:00
<term > IO</term>
2016-08-07 13:45:39 +00:00
<listitem >
2019-11-21 19:33:26 +00:00
<para > <literal > IO</literal> -prefixed settings are a superset of and replace
<literal > BlockIO</literal> -prefixed ones. On unified hierarchy, IO resource control also applies
to buffered writes.</para>
2016-08-07 13:45:39 +00:00
</listitem>
</varlistentry>
2016-05-19 00:35:12 +00:00
</variablelist>
</para>
2016-10-15 01:07:16 +00:00
<para > To ease the transition, there is best-effort translation between the two versions of settings. For each
controller, if any of the settings for the unified hierarchy are present, all settings for the legacy hierarchy are
ignored. If the resulting settings are for the other type of hierarchy, the configurations are translated before
application.</para>
2016-07-31 12:43:23 +00:00
<para > Legacy control group hierarchy (see <ulink
2020-01-09 09:37:52 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/">Control Groups version 1</ulink> ),
also called cgroup-v1, doesn't allow safe delegation of controllers to unprivileged processes. If the
system uses the legacy control group hierarchy, resource control is disabled for the systemd user
instance, see
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> .</para>
2016-05-19 00:35:12 +00:00
</refsect1>
2013-07-10 05:25:02 +00:00
<refsect1 >
<title > Options</title>
<para > Units of the types listed above can have settings
2013-09-26 22:05:07 +00:00
for resource control configuration:</para>
2013-07-10 05:25:02 +00:00
<variablelist class= 'unit-directives' >
<varlistentry >
2013-07-19 02:10:06 +00:00
<term > <varname > CPUAccounting=</varname> </term>
2013-07-10 05:25:02 +00:00
<listitem >
2013-07-19 02:10:06 +00:00
<para > Turn on CPU usage accounting for this unit. Takes a
boolean argument. Note that turning on CPU accounting for
2015-09-10 10:32:16 +00:00
one unit will also implicitly turn it on for all units
2014-02-24 22:50:10 +00:00
contained in the same slice and for all its parent slices
and the units contained therein. The system default for this
2015-09-10 10:32:16 +00:00
setting may be controlled with
2014-02-24 22:50:10 +00:00
<varname > DefaultCPUAccounting=</varname> in
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
2013-07-10 05:25:02 +00:00
</listitem>
</varlistentry>
2016-08-07 13:45:39 +00:00
<varlistentry >
<term > <varname > CPUWeight=<replaceable > weight</replaceable> </varname> </term>
<term > <varname > StartupCPUWeight=<replaceable > weight</replaceable> </varname> </term>
<listitem >
2021-05-26 09:23:06 +00:00
<para > Assign the specified CPU time weight to the processes executed, if the unified control group
hierarchy is used on the system. These options take an integer value and control the
<literal > cpu.weight</literal> control group attribute. The allowed range is 1 to 10000. Defaults to
100. For details about this control group attribute, see <ulink
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html">Control Groups v2</ulink>
and <ulink url= "https://www.kernel.org/doc/html/latest/scheduler/sched-design-CFS.html" > CFS
Scheduler</ulink> . The available CPU time is split up among all units within one slice relative to
their CPU time weight. A higher weight means more CPU time, a lower weight means less.</para>
2016-08-07 13:45:39 +00:00
<para > While <varname > StartupCPUWeight=</varname> only applies to the startup phase of the system,
<varname > CPUWeight=</varname> applies to normal runtime of the system, and if the former is not set also to
the startup phase. Using <varname > StartupCPUWeight=</varname> allows prioritizing specific services at
boot-up differently than during normal runtime.</para>
2016-10-15 01:07:16 +00:00
<para > These settings replace <varname > CPUShares=</varname> and <varname > StartupCPUShares=</varname> .</para>
2014-04-25 11:27:25 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > CPUQuota=</varname> </term>
<listitem >
2016-08-07 13:45:39 +00:00
<para > Assign the specified CPU time quota to the processes executed. Takes a percentage value, suffixed with
"%". The percentage specifies how much CPU time the unit shall get at maximum, relative to the total CPU time
available on one CPU. Use values > 100% for allotting CPU time on more than one CPU. This controls the
<literal > cpu.max</literal> attribute on the unified control group hierarchy and
<literal > cpu.cfs_quota_us</literal> on legacy. For details about these control group attributes, see <ulink
2020-01-09 09:37:52 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html">Control Groups v2</ulink> and <ulink
2018-07-18 08:33:29 +00:00
url="https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt">sched-bwc.txt</ulink> .</para>
2014-04-25 11:27:25 +00:00
2016-08-07 13:45:39 +00:00
<para > Example: <varname > CPUQuota=20%</varname> ensures that the executed processes will never get more than
20% CPU time on one CPU.</para>
2014-04-25 11:27:25 +00:00
</listitem>
</varlistentry>
2018-11-02 16:21:57 +00:00
<varlistentry >
<term > <varname > CPUQuotaPeriodSec=</varname> </term>
<listitem >
<para > Assign the duration over which the CPU time quota specified by <varname > CPUQuota=</varname> is measured.
Takes a time duration value in seconds, with an optional suffix such as "ms" for milliseconds (or "s" for seconds.)
The default setting is 100ms. The period is clamped to the range supported by the kernel, which is [1ms, 1000ms].
Additionally, the period is adjusted up so that the quota interval is also at least 1ms.
Setting <varname > CPUQuotaPeriodSec=</varname> to an empty value resets it to the default.</para>
<para > This controls the second field of <literal > cpu.max</literal> attribute on the unified control group hierarchy
and <literal > cpu.cfs_period_us</literal> on legacy. For details about these control group attributes, see
2020-01-09 09:37:52 +00:00
<ulink url= "https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html" > Control Groups v2</ulink> and
<ulink url= "https://www.kernel.org/doc/html/latest/scheduler/sched-design-CFS.html" > CFS Scheduler</ulink> .</para>
2018-11-02 16:21:57 +00:00
<para > Example: <varname > CPUQuotaPeriodSec=10ms</varname> to request that the CPU quota is measured in periods of 10ms.</para>
</listitem>
</varlistentry>
2019-07-29 15:50:05 +00:00
<varlistentry >
<term > <varname > AllowedCPUs=</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 > This setting is supported only with the unified control group hierarchy.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > AllowedMemoryNodes=</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
2021-01-30 17:03:40 +00:00
NUMA nodes indices separated by a dash.</para>
2019-07-29 15:50:05 +00:00
<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 > This setting is supported only with the unified control group hierarchy.</para>
</listitem>
</varlistentry>
2018-11-02 16:21:57 +00:00
2013-07-19 02:10:06 +00:00
<varlistentry >
<term > <varname > MemoryAccounting=</varname> </term>
<listitem >
<para > Turn on process and kernel memory accounting for this
unit. Takes a boolean argument. Note that turning on memory
2015-09-10 10:32:16 +00:00
accounting for one unit will also implicitly turn it on for
all units contained in the same slice and for all its parent
slices and the units contained therein. The system default
for this setting may be controlled with
2014-02-24 22:50:10 +00:00
<varname > DefaultMemoryAccounting=</varname> in
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
2013-07-19 02:10:06 +00:00
</listitem>
</varlistentry>
2018-06-09 00:33:14 +00:00
<varlistentry >
2020-07-24 11:17:23 +00:00
<term > <varname > MemoryMin=<replaceable > bytes</replaceable> </varname> , <varname > MemoryLow=<replaceable > bytes</replaceable> </varname> </term>
2018-06-09 00:33:14 +00:00
<listitem >
2020-07-24 11:17:23 +00:00
<para > Specify the memory usage protection of the executed processes in this unit.
When reclaiming memory, the unit is treated as if it was using less memory resulting in memory
to be preferentially reclaimed from unprotected units.
Using <varname > MemoryLow=</varname> results in a weaker protection where memory may still
be reclaimed to avoid invoking the OOM killer in case there is no other reclaimable memory.</para>
<para >
For a protection to be effective, it is generally required to set a corresponding
allocation on all ancestors, which is then distributed between children
(with the exception of the root slice).
Any <varname > MemoryMin=</varname> or <varname > MemoryLow=</varname> allocation that is not
explicitly distributed to specific children is used to create a shared protection for all children.
As this is a shared protection, the children will freely compete for the memory.</para>
2018-06-09 00:33:14 +00:00
<para > Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
percentage value may be specified, which is taken relative to the installed physical memory on the
2019-09-30 13:23:32 +00:00
system. If assigned the special value <literal > infinity</literal> , all available memory is protected, which may be
useful in order to always inherit all of the protection afforded by ancestors.
2020-07-24 11:17:23 +00:00
This controls the <literal > memory.min</literal> or <literal > memory.low</literal> control group attribute.
For details about this control group attribute, see <ulink
2020-01-09 10:00:44 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink> .</para>
2018-06-09 00:33:14 +00:00
<para > This setting is supported only if the unified control group hierarchy is used and disables
<varname > MemoryLimit=</varname> .</para>
2019-04-30 18:22:04 +00:00
2020-07-24 11:17:23 +00:00
<para > Units may have their children use a default <literal > memory.min</literal> or
<literal > memory.low</literal> value by specifying <varname > DefaultMemoryMin=</varname> or
<varname > DefaultMemoryLow=</varname> , which has the same semantics as
2020-08-20 11:11:20 +00:00
<varname > MemoryMin=</varname> and <varname > MemoryLow=</varname> .
2020-07-24 11:17:23 +00:00
This setting does not affect <literal > memory.min</literal> or <literal > memory.low</literal>
in the unit itself.
Using it to set a default child allocation is only useful on kernels older than 5.7,
which do not support the <literal > memory_recursiveprot</literal> cgroup2 mount option.</para>
2016-05-27 16:10:18 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MemoryHigh=<replaceable > bytes</replaceable> </varname> </term>
<listitem >
2019-09-30 13:25:14 +00:00
<para > Specify the throttling limit on memory usage of the executed processes in this unit. Memory usage may go
2016-05-27 16:10:18 +00:00
above the limit if unavoidable, but the processes are heavily slowed down and memory is taken away
aggressively in such cases. This is the main mechanism to control memory usage of a unit.</para>
<para > Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
2016-06-08 17:36:09 +00:00
parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
percentage value may be specified, which is taken relative to the installed physical memory on the
system. If assigned the
2019-09-30 13:25:14 +00:00
special value <literal > infinity</literal> , no memory throttling is applied. This controls the
2016-05-27 16:10:18 +00:00
<literal > memory.high</literal> control group attribute. For details about this control group attribute, see
2020-01-09 10:00:44 +00:00
<ulink url= "https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#memory-interface-files" > Memory Interface Files</ulink> .</para>
2016-05-27 16:10:18 +00:00
2016-10-15 01:07:16 +00:00
<para > This setting is supported only if the unified control group hierarchy is used and disables
<varname > MemoryLimit=</varname> .</para>
2016-05-27 16:10:18 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MemoryMax=<replaceable > bytes</replaceable> </varname> </term>
<listitem >
<para > Specify the absolute limit on memory usage of the executed processes in this unit. If memory usage
cannot be contained under the limit, out-of-memory killer is invoked inside the unit. It is recommended to
use <varname > MemoryHigh=</varname> as the main control mechanism and use <varname > MemoryMax=</varname> as the
last line of defense.</para>
<para > Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
2016-06-08 17:36:09 +00:00
parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
percentage value may be specified, which is taken relative to the installed physical memory on the system. If
assigned the special value <literal > infinity</literal> , no memory limit is applied. This controls the
2016-05-27 16:10:18 +00:00
<literal > memory.max</literal> control group attribute. For details about this control group attribute, see
2020-01-09 10:00:44 +00:00
<ulink url= "https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#memory-interface-files" > Memory Interface Files</ulink> .</para>
2016-05-27 16:10:18 +00:00
2016-10-15 01:07:16 +00:00
<para > This setting replaces <varname > MemoryLimit=</varname> .</para>
2016-05-27 16:10:18 +00:00
</listitem>
</varlistentry>
2016-07-04 07:03:54 +00:00
<varlistentry >
<term > <varname > MemorySwapMax=<replaceable > bytes</replaceable> </varname> </term>
<listitem >
<para > Specify the absolute limit on swap usage of the executed processes in this unit.</para>
<para > Takes a swap size in bytes. If the value is suffixed with K, M, G or T, the specified swap size is
parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. If assigned the
special value <literal > infinity</literal> , no swap limit is applied. This controls the
<literal > memory.swap.max</literal> control group attribute. For details about this control group attribute,
2020-01-09 10:00:44 +00:00
see <ulink url= "https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#memory-interface-files" > Memory Interface Files</ulink> .</para>
2016-07-04 07:03:54 +00:00
2016-10-15 01:07:16 +00:00
<para > This setting is supported only if the unified control group hierarchy is used and disables
<varname > MemoryLimit=</varname> .</para>
2013-07-10 05:25:02 +00:00
</listitem>
</varlistentry>
2015-09-10 10:32:16 +00:00
<varlistentry >
<term > <varname > TasksAccounting=</varname> </term>
<listitem >
<para > Turn on task accounting for this unit. Takes a
boolean argument. If enabled, the system manager will keep
track of the number of tasks in the unit. The number of
tasks accounted this way includes both kernel threads and
userspace processes, with each thread counting
individually. Note that turning on tasks accounting for one
unit will also implicitly turn it on for all units contained
in the same slice and for all its parent slices and the
units contained therein. The system default for this setting
may be controlled with
<varname > DefaultTasksAccounting=</varname> in
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > TasksMax=<replaceable > N</replaceable> </varname> </term>
<listitem >
2016-07-19 13:58:49 +00:00
<para > Specify the maximum number of tasks that may be created in the unit. This ensures that the number of
tasks accounted for the unit (see above) stays below a specific limit. This either takes an absolute number
of tasks or a percentage value that is taken relative to the configured maximum number of tasks on the
system. If assigned the special value <literal > infinity</literal> , no tasks limit is applied. This controls
the <literal > pids.max</literal> control group attribute. For details about this control group attribute, see
2020-01-09 09:37:52 +00:00
<ulink url= "https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/pids.html" > Process Number Controller</ulink> .
</para>
2015-09-10 10:32:16 +00:00
2020-01-09 09:37:52 +00:00
<para > The system default for this setting may be controlled with
2015-11-13 16:13:55 +00:00
<varname > DefaultTasksMax=</varname> in
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
2015-09-10 10:32:16 +00:00
</listitem>
</varlistentry>
2016-05-05 20:42:55 +00:00
<varlistentry >
<term > <varname > IOAccounting=</varname> </term>
<listitem >
2016-05-16 20:48:45 +00:00
<para > Turn on Block I/O accounting for this unit, if the unified control group hierarchy is used on the
system. Takes a boolean argument. Note that turning on block I/O accounting for one unit will also implicitly
turn it on for all units contained in the same slice and all for its parent slices and the units contained
therein. The system default for this setting may be controlled with <varname > DefaultIOAccounting=</varname>
in
2016-05-05 20:42:55 +00:00
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
2016-05-16 20:48:45 +00:00
2016-10-15 01:07:16 +00:00
<para > This setting replaces <varname > BlockIOAccounting=</varname> and disables settings prefixed with
<varname > BlockIO</varname> or <varname > StartupBlockIO</varname> .</para>
2016-05-05 20:42:55 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > IOWeight=<replaceable > weight</replaceable> </varname> </term>
<term > <varname > StartupIOWeight=<replaceable > weight</replaceable> </varname> </term>
<listitem >
2021-05-26 09:23:06 +00:00
<para > Set the default overall block I/O weight for the executed processes, if the unified control
group hierarchy is used on the system. Takes a single weight value (between 1 and 10000) to set the
default block I/O weight. This controls the <literal > io.weight</literal> control group attribute,
which defaults to 100. For details about this control group attribute, see <ulink
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#io-interface-files">IO
Interface Files</ulink> . The available I/O bandwidth is split up among all units within one slice
relative to their block I/O weight. A higher weight means more I/O bandwidth, a lower weight means
less.</para>
2016-05-05 20:42:55 +00:00
<para > While <varname > StartupIOWeight=</varname> only applies
to the startup phase of the system,
<varname > IOWeight=</varname> applies to the later runtime of
the system, and if the former is not set also to the startup
phase. This allows prioritizing specific services at boot-up
differently than during runtime.</para>
2016-10-15 01:07:16 +00:00
<para > These settings replace <varname > BlockIOWeight=</varname> and <varname > StartupBlockIOWeight=</varname>
and disable settings prefixed with <varname > BlockIO</varname> or <varname > StartupBlockIO</varname> .</para>
2016-05-05 20:42:55 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > IODeviceWeight=<replaceable > device</replaceable> <replaceable > weight</replaceable> </varname> </term>
<listitem >
2016-05-16 20:48:45 +00:00
<para > Set the per-device overall block I/O weight for the executed processes, if the unified control group
hierarchy is used on the system. Takes a space-separated pair of a file path and a weight value to specify
2018-06-13 21:16:35 +00:00
the device specific weight value, between 1 and 10000. (Example: <literal > /dev/sda 1000</literal> ). The file
path may be specified as path to a block device node or as any other file, in which case the backing block
device of the file system of the file is determined. This controls the <literal > io.weight</literal> control
group attribute, which defaults to 100. Use this option multiple times to set weights for multiple devices.
For details about this control group attribute, see <ulink
2020-01-09 10:00:44 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink> .</para>
2016-05-05 20:42:55 +00:00
2016-10-15 01:07:16 +00:00
<para > This setting replaces <varname > BlockIODeviceWeight=</varname> and disables settings prefixed with
<varname > BlockIO</varname> or <varname > StartupBlockIO</varname> .</para>
2020-01-16 15:29:01 +00:00
<para > The specified device node should reference a block device that has an I/O scheduler
associated, i.e. should not refer to partition or loopback block devices, but to the originating,
physical device. When a path to a regular file or directory is specified it is attempted to
discover the correct originating device backing the file system of the specified path. This works
correctly only for simpler cases, where the file system is directly placed on a partition or
physical block device, or where simple 1:1 encryption using dm-crypt/LUKS is used. This discovery
does not cover complex storage and in particular RAID and volume management storage devices.</para>
2016-05-05 20:42:55 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > IOReadBandwidthMax=<replaceable > device</replaceable> <replaceable > bytes</replaceable> </varname> </term>
<term > <varname > IOWriteBandwidthMax=<replaceable > device</replaceable> <replaceable > bytes</replaceable> </varname> </term>
<listitem >
2016-05-16 20:48:45 +00:00
<para > Set the per-device overall block I/O bandwidth maximum limit for the executed processes, if the unified
control group hierarchy is used on the system. This limit is not work-conserving and the executed processes
are not allowed to use more even if the device has idle capacity. Takes a space-separated pair of a file
path and a bandwidth value (in bytes per second) to specify the device specific bandwidth. The file path may
be a path to a block device node, or as any other file in which case the backing block device of the file
system of the file is used. If the bandwidth is suffixed with K, M, G, or T, the specified bandwidth is
parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes, respectively, to the base of 1000. (Example:
"/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This controls the <literal > io.max</literal> control
group attributes. Use this option multiple times to set bandwidth limits for multiple devices. For details
about this control group attribute, see <ulink
2020-01-09 10:00:44 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink> .
2016-05-05 20:42:55 +00:00
</para>
2016-10-15 01:07:16 +00:00
<para > These settings replace <varname > BlockIOReadBandwidth=</varname> and
<varname > BlockIOWriteBandwidth=</varname> and disable settings prefixed with <varname > BlockIO</varname> or
<varname > StartupBlockIO</varname> .</para>
2020-01-16 15:29:01 +00:00
<para > Similar restrictions on block device discovery as for <varname > IODeviceWeight=</varname> apply, see above.</para>
2016-05-05 20:42:55 +00:00
</listitem>
</varlistentry>
2016-05-18 20:50:56 +00:00
<varlistentry >
<term > <varname > IOReadIOPSMax=<replaceable > device</replaceable> <replaceable > IOPS</replaceable> </varname> </term>
<term > <varname > IOWriteIOPSMax=<replaceable > device</replaceable> <replaceable > IOPS</replaceable> </varname> </term>
<listitem >
<para > Set the per-device overall block I/O IOs-Per-Second maximum limit for the executed processes, if the
unified control group hierarchy is used on the system. This limit is not work-conserving and the executed
processes are not allowed to use more even if the device has idle capacity. Takes a space-separated pair of
a file path and an IOPS value to specify the device specific IOPS. The file path may be a path to a block
device node, or as any other file in which case the backing block device of the file system of the file is
used. If the IOPS is suffixed with K, M, G, or T, the specified IOPS is parsed as KiloIOPS, MegaIOPS,
GigaIOPS, or TeraIOPS, respectively, to the base of 1000. (Example:
"/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 1K"). This controls the <literal > io.max</literal> control
group attributes. Use this option multiple times to set IOPS limits for multiple devices. For details about
this control group attribute, see <ulink
2020-01-09 10:00:44 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink> .
2016-05-18 20:50:56 +00:00
</para>
2016-10-15 01:07:16 +00:00
<para > These settings are supported only if the unified control group hierarchy is used and disable settings
prefixed with <varname > BlockIO</varname> or <varname > StartupBlockIO</varname> .</para>
2020-01-16 15:29:01 +00:00
<para > Similar restrictions on block device discovery as for <varname > IODeviceWeight=</varname> apply, see above.</para>
2013-07-10 05:25:02 +00:00
</listitem>
2018-06-13 21:16:35 +00:00
</varlistentry>
<varlistentry >
<term > <varname > IODeviceLatencyTargetSec=<replaceable > device</replaceable> <replaceable > target</replaceable> </varname> </term>
<listitem >
<para > Set the per-device average target I/O latency for the executed processes, if the unified control group
hierarchy is used on the system. Takes a file path and a timespan separated by a space to specify
the device specific latency target. (Example: "/dev/sda 25ms"). The file path may be specified
as path to a block device node or as any other file, in which case the backing block device of the file
system of the file is determined. This controls the <literal > io.latency</literal> control group
attribute. Use this option multiple times to set latency target for multiple devices. For details about this
control group attribute, see <ulink
2020-01-09 10:00:44 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink> .</para>
2018-06-13 21:16:35 +00:00
2018-09-25 10:40:35 +00:00
<para > Implies <literal > IOAccounting=yes</literal> .</para>
2018-06-13 21:16:35 +00:00
<para > These settings are supported only if the unified control group hierarchy is used.</para>
2020-01-16 15:29:01 +00:00
<para > Similar restrictions on block device discovery as for <varname > IODeviceWeight=</varname> apply, see above.</para>
2018-06-13 21:16:35 +00:00
</listitem>
2013-07-10 05:25:02 +00:00
</varlistentry>
2016-11-12 12:38:38 +00:00
<varlistentry >
<term > <varname > IPAccounting=</varname> </term>
<listitem >
<para > Takes a boolean argument. If true, turns on IPv4 and IPv6 network traffic accounting for packets sent
or received by the unit. When this option is turned on, all IPv4 and IPv6 sockets created by any process of
2018-02-22 11:53:15 +00:00
the unit are accounted for.</para>
<para > When this option is used in socket units, it applies to all IPv4 and IPv6 sockets
2016-11-12 12:38:38 +00:00
associated with it (including both listening and connection sockets where this applies). Note that for
socket-activated services, this configuration setting and the accounting data of the service unit and the
socket unit are kept separate, and displayed separately. No propagation of the setting and the collected
statistics is done, in either direction. Moreover, any traffic sent or received on any of the socket unit's
sockets is accounted to the socket unit — and never to the service unit it might have activated, even if the
2018-02-22 11:53:15 +00:00
socket is used by it.</para>
<para > The system default for this setting may be controlled with <varname > DefaultIPAccounting=</varname> in
2016-11-12 12:38:38 +00:00
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
</listitem>
</varlistentry>
<varlistentry >
2017-10-10 19:59:03 +00:00
<term > <varname > IPAddressAllow=<replaceable > ADDRESS[/PREFIXLENGTH]…</replaceable> </varname> </term>
2016-11-12 12:38:38 +00:00
<term > <varname > IPAddressDeny=<replaceable > ADDRESS[/PREFIXLENGTH]…</replaceable> </varname> </term>
<listitem >
2020-05-26 09:13:06 +00:00
<para > Turn on network traffic filtering for IP packets sent and received over
<constant > AF_INET</constant> and <constant > AF_INET6</constant> sockets. Both directives take a
2019-03-28 16:14:39 +00:00
space separated list of IPv4 or IPv6 addresses, each optionally suffixed with an address prefix
2020-05-26 09:13:06 +00:00
length in bits after a <literal > /</literal> character. If the suffix is omitted, the address is
considered a host address, i.e. the filter covers the whole address (32 bits for IPv4, 128 bits for
IPv6).</para>
2019-03-28 16:14:39 +00:00
<para > The access lists configured with this option are applied to all sockets created by processes
of this unit (or in the case of socket units, associated with it). The lists are implicitly
combined with any lists configured for any of the parent slice units this unit might be a member
2020-05-26 09:13:06 +00:00
of. By default both access lists are empty. Both ingress and egress traffic is filtered by these
2019-03-28 16:14:39 +00:00
settings. In case of ingress traffic the source IP address is checked against these access lists,
2020-05-26 09:13:06 +00:00
in case of egress traffic the destination IP address is checked. The following rules are applied in
turn:</para>
2016-11-12 12:38:38 +00:00
<itemizedlist >
2020-05-26 09:13:06 +00:00
<listitem > <para > Access is granted when the checked IP address matches an entry in the
<varname > IPAddressAllow=</varname> list.</para> </listitem>
2016-11-12 12:38:38 +00:00
2020-05-26 09:13:06 +00:00
<listitem > <para > Otherwise, access is denied when the checked IP address matches an entry in the
<varname > IPAddressDeny=</varname> list.</para> </listitem>
2016-11-12 12:38:38 +00:00
2020-05-26 09:13:06 +00:00
<listitem > <para > Otherwise, access is granted.</para> </listitem>
2016-11-12 12:38:38 +00:00
</itemizedlist>
2020-06-23 06:31:16 +00:00
<para > In order to implement an allow-listing IP firewall, it is recommended to use a
<varname > IPAddressDeny=</varname> <constant > any</constant> setting on an upper-level slice unit
(such as the root slice <filename > -.slice</filename> or the slice containing all system services
2016-11-12 12:38:38 +00:00
<filename > system.slice</filename> – see
2020-06-23 06:31:16 +00:00
<citerefentry > <refentrytitle > systemd.special</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
for details on these slice units), plus individual per-service <varname > IPAddressAllow=</varname>
lines permitting network access to relevant services, and only them.</para>
2016-11-12 12:38:38 +00:00
2020-05-26 09:13:06 +00:00
<para > Note that for socket-activated services, the IP access list configured on the socket unit
applies to all sockets associated with it directly, but not to any sockets created by the
ultimately activated services for it. Conversely, the IP access list configured for the service is
not applied to any sockets passed into the service via socket activation. Thus, it is usually a
good idea to replicate the IP access lists on both the socket and the service unit. Nevertheless,
it may make sense to maintain one list more open and the other one more restricted, depending on
the usecase.</para>
2016-11-12 12:38:38 +00:00
<para > If these settings are used multiple times in the same unit the specified lists are combined. If an
empty string is assigned to these settings the specific access list is reset and all previous settings undone.</para>
<para > In place of explicit IPv4 or IPv6 address and prefix length specifications a small set of symbolic
names may be used. The following names are defined:</para>
<table >
<title > Special address/network names</title>
<tgroup cols= '3' >
<colspec colname= 'name' />
<colspec colname= 'definition' />
<colspec colname= 'meaning' />
<thead >
<row >
<entry > Symbolic Name</entry>
<entry > Definition</entry>
<entry > Meaning</entry>
</row>
</thead>
<tbody >
<row >
<entry > <constant > any</constant> </entry>
<entry > 0.0.0.0/0 ::/0</entry>
<entry > Any host</entry>
</row>
<row >
<entry > <constant > localhost</constant> </entry>
<entry > 127.0.0.0/8 ::1/128</entry>
<entry > All addresses on the local loopback</entry>
</row>
<row >
<entry > <constant > link-local</constant> </entry>
<entry > 169.254.0.0/16 fe80::/64</entry>
<entry > All link-local IP addresses</entry>
</row>
<row >
<entry > <constant > multicast</constant> </entry>
<entry > 224.0.0.0/4 ff00::/8</entry>
<entry > All IP multicasting addresses</entry>
</row>
</tbody>
</tgroup>
</table>
<para > Note that these settings might not be supported on some systems (for example if eBPF control group
support is not enabled in the underlying kernel or container manager). These settings will have no effect in
that case. If compatibility with such systems is desired it is hence recommended to not exclusively rely on
them for IP security.</para>
</listitem>
</varlistentry>
2019-04-23 10:14:20 +00:00
<varlistentry >
2020-06-23 15:06:42 +00:00
<term > <varname > IPIngressFilterPath=<replaceable > BPF_FS_PROGRAM_PATH</replaceable> </varname> </term>
<term > <varname > IPEgressFilterPath=<replaceable > BPF_FS_PROGRAM_PATH</replaceable> </varname> </term>
2019-04-23 10:14:20 +00:00
<listitem >
<para > Add custom network traffic filters implemented as BPF programs, applying to all IP packets
sent and received over <constant > AF_INET</constant> and <constant > AF_INET6</constant> sockets.
Takes an absolute path to a pinned BPF program in the BPF virtual filesystem (<filename > /sys/fs/bpf/</filename> ).
</para>
<para > The filters configured with this option are applied to all sockets created by processes
of this unit (or in the case of socket units, associated with it). The filters are loaded in addition
to filters any of the parent slice units this unit might be a member of as well as any
<varname > IPAddressAllow=</varname> and <varname > IPAddressDeny=</varname> filters in any of these units.
By default there are no filters specified.</para>
<para > If these settings are used multiple times in the same unit all the specified programs are attached. If an
empty string is assigned to these settings the program list is reset and all previous specified programs ignored.</para>
2020-12-09 06:06:56 +00:00
<para > If the path <replaceable > BPF_FS_PROGRAM_PATH</replaceable> in <varname > IPIngressFilterPath=</varname> assignment
is already being handled by <varname > BPFProgram=</varname> ingress hook, e.g.
<varname > BPFProgram=</varname> <constant > ingress</constant> :<replaceable > BPF_FS_PROGRAM_PATH</replaceable> ,
the assignment will be still considered valid and the program will be attached to a cgroup. Same for
<varname > IPEgressFilterPath=</varname> path and <constant > egress</constant> hook.</para>
2019-04-23 10:14:20 +00:00
<para > Note that for socket-activated services, the IP filter programs configured on the socket unit apply to
all sockets associated with it directly, but not to any sockets created by the ultimately activated services
for it. Conversely, the IP filter programs configured for the service are not applied to any sockets passed into
the service via socket activation. Thus, it is usually a good idea, to replicate the IP filter programs on both
the socket and the service unit, however it often makes sense to maintain one configuration more open and the other
one more restricted, depending on the usecase.</para>
<para > Note that these settings might not be supported on some systems (for example if eBPF control group
support is not enabled in the underlying kernel or container manager). These settings will fail the service in
that case. If compatibility with such systems is desired it is hence recommended to attach your filter manually
(requires <varname > Delegate=</varname> <constant > yes</constant> ) instead of using this setting.</para>
</listitem>
</varlistentry>
2020-12-09 06:06:56 +00:00
<varlistentry >
<term > <varname > BPFProgram=<replaceable > type</replaceable> <constant > :</constant> <replaceable > program-path</replaceable> </varname> </term>
<listitem >
<para > Add a custom cgroup BPF program.</para>
<para > <varname > BPFProgram=</varname> allows attaching BPF hooks to the cgroup of a systemd unit.
(This generalizes the functionality exposed via <varname > IPEgressFilterPath=</varname> for egress and
<varname > IPIngressFilterPath=</varname> for ingress.)
Cgroup-bpf hooks in the form of BPF programs loaded to the BPF filesystem are attached with cgroup-bpf attach
flags determined by the unit. For details about attachment types and flags see <ulink
url="https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/include/uapi/linux/bpf.h"/>.
For general BPF documentation please refer to <ulink url= "https://www.kernel.org/doc/html/latest/bpf/index.html" /> .</para>
<para > The specification of BPF program consists of a <replaceable > type</replaceable> followed by a
<replaceable > program-path</replaceable> with <literal > :</literal> as the separator:
<replaceable > type</replaceable> <constant > :</constant> <replaceable > program-path</replaceable> .</para>
<para > <replaceable > type</replaceable> is the string name of BPF attach type also used in
<command > bpftool</command> . <replaceable > type</replaceable> can be one of <constant > egress</constant> ,
<constant > ingress</constant> , <constant > sock_create</constant> , <constant > sock_ops</constant> ,
<constant > device</constant> , <constant > bind4</constant> , <constant > bind6</constant> ,
<constant > connect4</constant> , <constant > connect6</constant> , <constant > post_bind4</constant> ,
<constant > post_bind6</constant> , <constant > sendmsg4</constant> , <constant > sendmsg6</constant> ,
<constant > sysctl</constant> , <constant > recvmsg4</constant> , <constant > recvmsg6</constant> ,
<constant > getsockopt</constant> , <constant > setsockopt</constant> .</para>
<para > Setting <varname > BPFProgram=</varname> to an empty value makes previous assignments ineffective.</para>
<para > Multiple assignments of the same <replaceable > type</replaceable> :<replaceable > program-path</replaceable>
value have the same effect as a single assignment: the program with the path <replaceable > program-path</replaceable>
will be attached to cgroup hook <replaceable > type</replaceable> just once.</para>
<para > If BPF <constant > egress</constant> pinned to <replaceable > program-path</replaceable> path is already being
handled by <varname > IPEgressFilterPath=</varname> , <varname > BPFProgram=</varname>
assignment will be considered valid and <varname > BPFProgram=</varname> will be attached to a cgroup.
Similarly for <constant > ingress</constant> hook and <varname > IPIngressFilterPath=</varname> assignment.</para>
<para > BPF programs passed with <varname > BPFProgram=</varname> are attached to the cgroup of a unit with BPF
attach flag <constant > multi</constant> , that allows further attachments of the same
<replaceable > type</replaceable> within cgroup hierarchy topped by the unit cgroup.</para>
<para > Examples:<programlisting >
BPFProgram=egress:/sys/fs/bpf/egress-hook
BPFProgram=bind6:/sys/fs/bpf/sock-addr-hook
</programlisting> </para>
</listitem>
</varlistentry>
2020-11-18 08:32:14 +00:00
<varlistentry >
<term > <varname > SocketBindAllow=<replaceable > bind-rule</replaceable> </varname> </term>
<term > <varname > SocketBindDeny=<replaceable > bind-rule</replaceable> </varname> </term>
<listitem >
<para > Allow or deny binding a socket address to a socket by matching it with the <replaceable > bind-rule</replaceable> and
applying a corresponding action if there is a match.</para>
2021-06-24 19:16:51 +00:00
<para > <replaceable > bind-rule</replaceable> describes socket properties such as <replaceable > address-family</replaceable> ,
<replaceable > transport-protocol</replaceable> and <replaceable > ip-ports</replaceable> .</para>
2020-11-18 08:32:14 +00:00
2021-06-24 19:16:51 +00:00
<para > <replaceable > bind-rule</replaceable> :=
{ [<replaceable > address-family</replaceable> <constant > :</constant> ][<replaceable > transport-protocol</replaceable> <constant > :</constant> ][<replaceable > ip-ports</replaceable> ] | <constant > any</constant> }</para>
2020-11-18 08:32:14 +00:00
2021-05-10 14:33:24 +00:00
<para > <replaceable > address-family</replaceable> := { <constant > ipv4</constant> | <constant > ipv6</constant> }</para>
2020-11-18 08:32:14 +00:00
2021-06-24 19:16:51 +00:00
<para > <replaceable > transport-protocol</replaceable> := { <constant > tcp</constant> | <constant > udp</constant> }</para>
2020-11-18 08:32:14 +00:00
2021-06-24 19:16:51 +00:00
<para > <replaceable > ip-ports</replaceable> := { <replaceable > ip-port</replaceable> | <replaceable > ip-port-range</replaceable> }</para>
<para > An optional <replaceable > address-family</replaceable> expects <constant > ipv4</constant> or <constant > ipv6</constant> values.
If not specified, a rule will be matched for both IPv4 and IPv6 addresses and applied depending on other socket fields, e.g. <replaceable > transport-protocol</replaceable> ,
2020-11-18 08:32:14 +00:00
<replaceable > ip-port</replaceable> .</para>
2021-06-24 19:16:51 +00:00
<para > An optional <replaceable > transport-protocol</replaceable> expects <constant > tcp</constant> or <constant > udp</constant> transport protocol names.
If not specified, a rule will be matched for any transport protocol.</para>
<para > An optional <replaceable > ip-port</replaceable> value must lie within 1…65535 interval inclusively, i.e.
2020-11-18 08:32:14 +00:00
dynamic port <constant > 0</constant> is not allowed. A range of sequential ports is described by
<replaceable > ip-port-range</replaceable> := <replaceable > ip-port-low</replaceable> <constant > -</constant> <replaceable > ip-port-high</replaceable> ,
where <replaceable > ip-port-low</replaceable> is smaller than or equal to <replaceable > ip-port-high</replaceable>
2021-06-24 19:16:51 +00:00
and both are within 1…65535 inclusively.</para>
<para > A special value <constant > any</constant> can be used to apply a rule to any address family, transport protocol and any port with a positive value.</para>
2020-11-18 08:32:14 +00:00
<para > To allow multiple rules assign <varname > SocketBindAllow=</varname> or <varname > SocketBindDeny=</varname> multiple times.
To clear the existing assignments pass an empty <varname > SocketBindAllow=</varname> or <varname > SocketBindDeny=</varname>
assignment.</para>
<para > For each of <varname > SocketBindAllow=</varname> and <varname > SocketBindDeny=</varname> , maximum allowed number of assignments is
<constant > 128</constant> .</para>
<itemizedlist >
<listitem > <para > Binding to a socket is allowed when a socket address matches an entry in the
<varname > SocketBindAllow=</varname> list.</para> </listitem>
<listitem > <para > Otherwise, binding is denied when the socket address matches an entry in the
<varname > SocketBindDeny=</varname> list.</para> </listitem>
<listitem > <para > Otherwise, binding is allowed.</para> </listitem>
</itemizedlist>
<para > The feature is implemented with <constant > cgroup/bind4</constant> and <constant > cgroup/bind6</constant> cgroup-bpf hooks.</para>
<para > Examples:<programlisting > …
# Allow binding IPv6 socket addresses with a port greater than or equal to 10000.
[Service]
2021-05-10 14:33:24 +00:00
SocketBindAllow=ipv6:10000-65535
2020-11-18 08:32:14 +00:00
SocketBindDeny=any
…
# Allow binding IPv4 and IPv6 socket addresses with 1234 and 4321 ports.
[Service]
SocketBindAllow=1234
SocketBindAllow=4321
SocketBindDeny=any
…
# Deny binding IPv6 socket addresses.
[Service]
2021-06-24 19:16:51 +00:00
SocketBindDeny=ipv6
2020-11-18 08:32:14 +00:00
…
# Deny binding IPv4 and IPv6 socket addresses.
[Service]
SocketBindDeny=any
2021-06-24 19:16:51 +00:00
…
# Allow binding only over TCP
[Service]
SocketBindAllow=tcp
SocketBindDeny=any
…
# Allow binding only over IPv6/TCP
[Service]
SocketBindAllow=ipv6:tcp
SocketBindDeny=any
…
# Allow binding ports within 10000-65535 range over IPv4/UDP.
[Service]
SocketBindAllow=ipv4:udp:10000-65535
SocketBindDeny=any
2020-11-18 08:32:14 +00:00
…</programlisting> </para>
</listitem>
</varlistentry>
2021-01-21 20:36:13 +00:00
<varlistentry >
<term > <varname > RestrictNetworkInterfaces=</varname> </term>
<listitem >
<para > Takes a list of space-separated network interface names. This option restricts the network
interfaces that processes of this unit can use. By default processes can only use the network interfaces
listed (allow-list). If the first character of the rule is <literal > ~</literal> , the effect is inverted:
the processes can only use network interfaces not listed (deny-list).
</para>
<para > This option can appear multiple times, in which case the network interface names are merged. If the
2021-08-22 06:42:51 +00:00
empty string is assigned the set is reset, all prior assignments will have not effect.
2021-01-21 20:36:13 +00:00
</para>
<para > If you specify both types of this option (i.e. allow-listing and deny-listing), the first encountered
will take precedence and will dictate the default action (allow vs deny). Then the next occurrences of this
option will add or delete the listed network interface names from the set, depending of its type and the
default action.
</para>
<para > The loopback interface ("lo") is not treated in any special way, you have to configure it explicitly
in the unit file.
</para>
<para > Example 1: allow-list
<programlisting >
RestrictNetworkInterfaces=eth1
RestrictNetworkInterfaces=eth2</programlisting>
Programs in the unit will be only able to use the eth1 and eth2 network
interfaces.
</para>
<para > Example 2: deny-list
<programlisting >
RestrictNetworkInterfaces=~eth1 eth2</programlisting>
Programs in the unit will be able to use any network interface but eth1 and eth2.
</para>
<para > Example 3: mixed
<programlisting >
RestrictNetworkInterfaces=eth1 eth2
RestrictNetworkInterfaces=~eth1</programlisting>
Programs in the unit will be only able to use the eth2 network interface.
</para>
</listitem>
</varlistentry>
2013-07-10 05:25:02 +00:00
<varlistentry >
<term > <varname > DeviceAllow=</varname> </term>
<listitem >
2019-07-31 08:20:16 +00:00
<para > Control access to specific device nodes by the executed processes. Takes two space-separated
strings: a device node specifier followed by a combination of <constant > r</constant> ,
<constant > w</constant> , <constant > m</constant> to control <emphasis > r</emphasis> eading,
<emphasis > w</emphasis> riting, or creation of the specific device node(s) by the unit
(<emphasis > m</emphasis> knod), respectively. On cgroup-v1 this controls the
<literal > devices.allow</literal> control group attribute. For details about this control group
attribute, see <ulink
2020-01-09 09:37:52 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/devices.html">Device Whitelist Controller</ulink> .
In the unified cgroup hierarchy this functionality is implemented using eBPF filtering.</para>
2019-07-31 08:20:16 +00:00
<para > The device node specifier is either a path to a device node in the file system, starting with
<filename > /dev/</filename> , or a string starting with either <literal > char-</literal> or
<literal > block-</literal> followed by a device group name, as listed in
2020-06-23 06:31:16 +00:00
<filename > /proc/devices</filename> . The latter is useful to allow-list all current and future
2019-07-31 08:20:16 +00:00
devices belonging to a specific device group at once. The device group is matched according to
filename globbing rules, you may hence use the <literal > *</literal> and <literal > ?</literal>
wildcards. (Note that such globbing wildcards are not available for device node path
specifications!) In order to match device nodes by numeric major/minor, use device node paths in
the <filename > /dev/char/</filename> and <filename > /dev/block/</filename> directories. However,
matching devices by major/minor is generally not recommended as assignments are neither stable nor
portable between systems or different kernel versions.</para>
<para > Examples: <filename > /dev/sda5</filename> is a path to a device node, referring to an ATA or
SCSI block device. <literal > char-pts</literal> and <literal > char-alsa</literal> are specifiers for
all pseudo TTYs and all ALSA sound devices, respectively. <literal > char-cpu/*</literal> is a
specifier matching all CPU related device groups.</para>
2019-07-23 11:28:44 +00:00
2020-06-23 06:31:16 +00:00
<para > Note that allow lists defined this way should only reference device groups which are
2019-07-23 11:28:44 +00:00
resolvable at the time the unit is started. Any device groups not resolvable then are not added to
2020-06-23 06:31:16 +00:00
the device allow list. In order to work around this limitation, consider extending service units
2020-01-07 18:00:56 +00:00
with a pair of <command > After=modprobe@xyz.service</command> and
<command > Wants=modprobe@xyz.service</command> lines that load the necessary kernel module
implementing the device group if missing.
Example: <programlisting > …
[Unit]
Wants=modprobe@loop.service
After=modprobe@loop.service
2019-07-23 11:28:44 +00:00
[Service]
DeviceAllow=block-loop
DeviceAllow=/dev/loop-control
…</programlisting> </para>
2013-07-10 05:25:02 +00:00
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > DevicePolicy=auto|closed|strict</varname> </term>
<listitem >
<para >
Control the policy for allowing device access:
</para>
<variablelist >
<varlistentry >
<term > <option > strict</option> </term>
<listitem >
<para > means to only allow types of access that are
explicitly specified.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <option > closed</option> </term>
<listitem >
2013-07-13 08:51:35 +00:00
<para > in addition, allows access to standard pseudo
2013-07-10 05:25:02 +00:00
devices including
<filename > /dev/null</filename> ,
<filename > /dev/zero</filename> ,
<filename > /dev/full</filename> ,
<filename > /dev/random</filename> , and
<filename > /dev/urandom</filename> .
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <option > auto</option> </term>
<listitem >
<para >
2013-07-13 08:51:35 +00:00
in addition, allows access to all devices if no
2013-07-10 05:25:02 +00:00
explicit <varname > DeviceAllow=</varname> is present.
This is the default.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
2013-07-19 02:10:06 +00:00
<varlistentry >
<term > <varname > Slice=</varname> </term>
<listitem >
<para > The name of the slice unit to place the unit
in. Defaults to <filename > system.slice</filename> for all
2013-07-19 15:23:10 +00:00
non-instantiated units of all unit types (except for slice
units themselves see below). Instance units are by default
placed in a subslice of <filename > system.slice</filename>
that is named after the template name.</para>
<para > This option may be used to arrange systemd units in a
hierarchy of slices each of which might have resource
settings applied.</para>
2013-07-19 02:10:06 +00:00
2013-07-21 04:53:14 +00:00
<para > For units of type slice, the only accepted value for
2013-07-19 02:10:06 +00:00
this setting is the parent slice. Since the name of a slice
2013-07-21 04:53:14 +00:00
unit implies the parent slice, it is hence redundant to ever
2013-07-19 02:10:06 +00:00
set this parameter directly for slice units.</para>
2016-01-29 15:26:55 +00:00
<para > Special care should be taken when relying on the default slice assignment in templated service units
that have <varname > DefaultDependencies=no</varname> set, see
<citerefentry > <refentrytitle > systemd.service</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> , section
2017-09-12 04:02:27 +00:00
"Default Dependencies" for details.</para>
2016-01-29 15:26:55 +00:00
2013-07-19 02:10:06 +00:00
</listitem>
</varlistentry>
2014-11-05 16:57:23 +00:00
<varlistentry >
<term > <varname > Delegate=</varname> </term>
<listitem >
2017-11-09 14:31:37 +00:00
<para > Turns on delegation of further resource control partitioning to processes of the unit. Units where this
is enabled may create and manage their own private subhierarchy of control groups below the control group of
the unit itself. For unprivileged services (i.e. those using the <varname > User=</varname> setting) the unit's
control group will be made accessible to the relevant user. When enabled the service manager will refrain
from manipulating control groups or moving processes below the unit's control group, so that a clear concept
of ownership is established: the control group tree above the unit's control group (i.e. towards the root
control group) is owned and managed by the service manager of the host, while the control group tree below
the unit's control group is owned and managed by the unit itself. Takes either a boolean argument or a list
of control group controller names. If true, delegation is turned on, and all supported controllers are
enabled for the unit, making them available to the unit's processes for management. If false, delegation is
turned off entirely (and no additional controllers are enabled). If set to a list of controllers, delegation
2017-11-20 11:40:08 +00:00
is turned on, and the specified controllers are enabled for the unit. Note that additional controllers than
the ones specified might be made available as well, depending on configuration of the containing slice unit
or other units contained in it. Note that assigning the empty string will enable delegation, but reset the
list of controllers, all assignments prior to this will have no effect. Defaults to false.</para>
2017-11-09 14:31:37 +00:00
<para > Note that controller delegation to less privileged code is only safe on the unified control group
hierarchy. Accordingly, access to the specified controllers will not be granted to unprivileged services on
the legacy hierarchy, even when requested.</para>
2020-03-05 01:31:36 +00:00
<xi:include href= "supported-controllers.xml" xpointer= "controllers-text" />
<para > Not all of these controllers are available on all kernels however, and some are
2017-11-09 14:31:37 +00:00
specific to the unified hierarchy while others are specific to the legacy hierarchy. Also note that the
kernel might support further controllers, which aren't covered here yet as delegation is either not supported
at all for them or not defined cleanly.</para>
2018-11-16 19:29:02 +00:00
<para > For further details on the delegation model consult <ulink
url="https://systemd.io/CGROUP_DELEGATION">Control Group APIs and Delegation</ulink> .</para>
2014-11-05 16:57:23 +00:00
</listitem>
</varlistentry>
cgroup: Add DisableControllers= directive to disable controller in subtree
Some controllers (like the CPU controller) have a performance cost that
is non-trivial on certain workloads. While this can be mitigated and
improved to an extent, there will for some controllers always be some
overheads associated with the benefits gained from the controller.
Inside Facebook, the fix applied has been to disable the CPU controller
forcibly with `cgroup_disable=cpu` on the kernel command line.
This presents a problem: to disable or reenable the controller, a reboot
is required, but this is quite cumbersome and slow to do for many
thousands of machines, especially machines where disabling/enabling a
stateful service on a machine is a matter of several minutes.
Currently systemd provides some configuration knobs for these in the
form of `[Default]CPUAccounting`, `[Default]MemoryAccounting`, and the
like. The limitation of these is that Default*Accounting is overrideable
by individual services, of which any one could decide to reenable a
controller within the hierarchy at any point just by using a controller
feature implicitly (eg. `CPUWeight`), even if the use of that CPU
feature could just be opportunistic. Since many services are provided by
the distribution, or by upstream teams at a particular organisation,
it's not a sustainable solution to simply try to find and remove
offending directives from these units.
This commit presents a more direct solution -- a DisableControllers=
directive that forcibly disallows a controller from being enabled within
a subtree.
2018-12-03 14:38:06 +00:00
<varlistentry >
<term > <varname > DisableControllers=</varname> </term>
<listitem >
<para > Disables controllers from being enabled for a unit's children. If a controller listed is already in use
in its subtree, the controller will be removed from the subtree. This can be used to avoid child units being
able to implicitly or explicitly enable a controller. Defaults to not disabling any controllers.</para>
<para > It may not be possible to successfully disable a controller if the unit or any child of the unit in
question delegates controllers to its children, as any delegated subtree of the cgroup hierarchy is unmanaged
by systemd.</para>
<para > Multiple controllers may be specified, separated by spaces. You may also pass
<varname > DisableControllers=</varname> multiple times, in which case each new instance adds another controller
to disable. Passing <varname > DisableControllers=</varname> by itself with no controller name present resets
the disabled controller list.</para>
2020-03-05 01:31:36 +00:00
<xi:include href= "supported-controllers.xml" xpointer= "controllers-text" />
cgroup: Add DisableControllers= directive to disable controller in subtree
Some controllers (like the CPU controller) have a performance cost that
is non-trivial on certain workloads. While this can be mitigated and
improved to an extent, there will for some controllers always be some
overheads associated with the benefits gained from the controller.
Inside Facebook, the fix applied has been to disable the CPU controller
forcibly with `cgroup_disable=cpu` on the kernel command line.
This presents a problem: to disable or reenable the controller, a reboot
is required, but this is quite cumbersome and slow to do for many
thousands of machines, especially machines where disabling/enabling a
stateful service on a machine is a matter of several minutes.
Currently systemd provides some configuration knobs for these in the
form of `[Default]CPUAccounting`, `[Default]MemoryAccounting`, and the
like. The limitation of these is that Default*Accounting is overrideable
by individual services, of which any one could decide to reenable a
controller within the hierarchy at any point just by using a controller
feature implicitly (eg. `CPUWeight`), even if the use of that CPU
feature could just be opportunistic. Since many services are provided by
the distribution, or by upstream teams at a particular organisation,
it's not a sustainable solution to simply try to find and remove
offending directives from these units.
This commit presents a more direct solution -- a DisableControllers=
directive that forcibly disallows a controller from being enabled within
a subtree.
2018-12-03 14:38:06 +00:00
</listitem>
</varlistentry>
2020-09-09 08:04:36 +00:00
<varlistentry >
<term > <varname > ManagedOOMSwap=auto|kill</varname> </term>
<term > <varname > ManagedOOMMemoryPressure=auto|kill</varname> </term>
<listitem >
<para > Specifies how
<citerefentry > <refentrytitle > systemd-oomd.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
will act on this unit's cgroups. Defaults to <option > auto</option> .</para>
<para > When set to <option > kill</option> , <command > systemd-oomd</command> will actively monitor this unit's
cgroup metrics to decide whether it needs to act. If the cgroup passes the limits set by
<citerefentry > <refentrytitle > oomd.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> or its
overrides, <command > systemd-oomd</command> will send a <constant > SIGKILL</constant> to all of the processes
under the chosen candidate cgroup. Note that only descendant cgroups can be eligible candidates for killing;
the unit that set its property to <option > kill</option> is not a candidate (unless one of its ancestors set
their property to <option > kill</option> ). You can find more details on candidates and kill behavior at
<citerefentry > <refentrytitle > systemd-oomd.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
and <citerefentry > <refentrytitle > oomd.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> . Setting
either of these properties to <option > kill</option> will also automatically acquire
<varname > After=</varname> and <varname > Wants=</varname> dependencies on
<filename > systemd-oomd.service</filename> unless <varname > DefaultDependencies=no</varname> .
</para>
<para > When set to <option > auto</option> , <command > systemd-oomd</command> will not actively use this cgroup's
data for monitoring and detection. However, if an ancestor cgroup has one of these properties set to
<option > kill</option> , a unit with <option > auto</option> can still be an eligible candidate for
<command > systemd-oomd</command> to act on.</para>
</listitem>
</varlistentry>
<varlistentry >
2021-02-02 22:16:03 +00:00
<term > <varname > ManagedOOMMemoryPressureLimit=</varname> </term>
2020-09-09 08:04:36 +00:00
<listitem >
<para > Overrides the default memory pressure limit set by
2021-01-28 19:38:27 +00:00
<citerefentry > <refentrytitle > oomd.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> for
this unit (cgroup). Takes a percentage value between 0% and 100%, inclusive. This property is
ignored unless <varname > ManagedOOMMemoryPressure=</varname> <option > kill</option> . Defaults to 0%,
which means to use the default set by
<citerefentry > <refentrytitle > oomd.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
2020-09-09 08:04:36 +00:00
</para>
</listitem>
</varlistentry>
2021-01-29 01:35:17 +00:00
<varlistentry >
<term > <varname > ManagedOOMPreference=none|avoid|omit</varname> </term>
<listitem >
2021-02-25 12:25:35 +00:00
<para > Allows deprioritizing or omitting this unit's cgroup as a candidate when
<command > systemd-oomd</command> needs to act. Requires support for extended attributes (see
2021-01-29 01:35:17 +00:00
<citerefentry project= 'man-pages' > <refentrytitle > xattr</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> )
2021-02-25 12:25:35 +00:00
in order to use <option > avoid</option> or <option > omit</option> . Additionally,
<command > systemd-oomd</command> will ignore these extended attributes if the unit's cgroup is not
owned by the root user.</para>
2021-01-29 01:35:17 +00:00
2021-02-25 20:13:47 +00:00
<para > If this property is set to <option > avoid</option> , the service manager will convey this to
<command > systemd-oomd</command> , which will only select this cgroup if there are no other viable
candidates.</para>
<para > If this property is set to <option > omit</option> , the service manager will convey this to
<command > systemd-oomd</command> , which will ignore this cgroup as a candidate and will not perform
any actions on it.</para>
2021-02-25 12:25:35 +00:00
<para > It is recommended to use <option > avoid</option> and <option > omit</option> sparingly, as it
can adversely affect <command > systemd-oomd</command> 's kill behavior. Also note that these extended
attributes are not applied recursively to cgroups under this unit's cgroup.</para>
2021-02-25 20:13:47 +00:00
<para > Defaults to <option > none</option> which means <command > systemd-oomd</command> will rank this
unit's cgroup as defined in
2021-01-29 01:35:17 +00:00
<citerefentry > <refentrytitle > systemd-oomd.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
2021-02-25 20:13:47 +00:00
and <citerefentry > <refentrytitle > oomd.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
</para>
2021-01-29 01:35:17 +00:00
</listitem>
</varlistentry>
2013-07-10 05:25:02 +00:00
</variablelist>
</refsect1>
2016-10-15 01:07:16 +00:00
<refsect1 >
<title > Deprecated Options</title>
<para > The following options are deprecated. Use the indicated superseding options instead:</para>
<variablelist class= 'unit-directives' >
<varlistentry >
<term > <varname > CPUShares=<replaceable > weight</replaceable> </varname> </term>
<term > <varname > StartupCPUShares=<replaceable > weight</replaceable> </varname> </term>
<listitem >
<para > Assign the specified CPU time share weight to the processes executed. These options take an integer
value and control the <literal > cpu.shares</literal> control group attribute. The allowed range is 2 to
262144. Defaults to 1024. For details about this control group attribute, see <ulink
2020-01-09 09:37:52 +00:00
url="https://www.kernel.org/doc/html/latest/scheduler/sched-design-CFS.html">CFS Scheduler</ulink> .
2016-10-15 01:07:16 +00:00
The available CPU time is split up among all units within one slice relative to their CPU time share
weight.</para>
<para > While <varname > StartupCPUShares=</varname> only applies to the startup phase of the system,
<varname > CPUShares=</varname> applies to normal runtime of the system, and if the former is not set also to
the startup phase. Using <varname > StartupCPUShares=</varname> allows prioritizing specific services at
boot-up differently than during normal runtime.</para>
2018-09-25 10:40:35 +00:00
<para > Implies <literal > CPUAccounting=yes</literal> .</para>
2016-10-15 01:07:16 +00:00
<para > These settings are deprecated. Use <varname > CPUWeight=</varname> and
<varname > StartupCPUWeight=</varname> instead.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > MemoryLimit=<replaceable > bytes</replaceable> </varname> </term>
<listitem >
<para > Specify the limit on maximum memory usage of the executed processes. The limit specifies how much
process and kernel memory can be used by tasks in this unit. Takes a memory size in bytes. If the value is
suffixed with K, M, G or T, the specified memory size is parsed as Kilobytes, Megabytes, Gigabytes, or
Terabytes (with the base 1024), respectively. Alternatively, a percentage value may be specified, which is
taken relative to the installed physical memory on the system. If assigned the special value
<literal > infinity</literal> , no memory limit is applied. This controls the
<literal > memory.limit_in_bytes</literal> control group attribute. For details about this control group
attribute, see <ulink
2020-01-09 09:37:52 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/memory.html">Memory Resource Controller</ulink> .</para>
2016-10-15 01:07:16 +00:00
2018-09-25 10:40:35 +00:00
<para > Implies <literal > MemoryAccounting=yes</literal> .</para>
2016-10-15 01:07:16 +00:00
<para > This setting is deprecated. Use <varname > MemoryMax=</varname> instead.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > BlockIOAccounting=</varname> </term>
<listitem >
<para > Turn on Block I/O accounting for this unit, if the legacy control group hierarchy is used on the
system. Takes a boolean argument. Note that turning on block I/O accounting for one unit will also implicitly
turn it on for all units contained in the same slice and all for its parent slices and the units contained
therein. The system default for this setting may be controlled with
<varname > DefaultBlockIOAccounting=</varname> in
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
<para > This setting is deprecated. Use <varname > IOAccounting=</varname> instead.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > BlockIOWeight=<replaceable > weight</replaceable> </varname> </term>
<term > <varname > StartupBlockIOWeight=<replaceable > weight</replaceable> </varname> </term>
<listitem > <para > Set the default overall block I/O weight for the executed processes, if the legacy control
group hierarchy is used on the system. Takes a single weight value (between 10 and 1000) to set the default
block I/O weight. This controls the <literal > blkio.weight</literal> control group attribute, which defaults to
500. For details about this control group attribute, see <ulink
2020-01-09 09:37:52 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/blkio-controller.html">Block IO Controller</ulink> .
2016-10-15 01:07:16 +00:00
The available I/O bandwidth is split up among all units within one slice relative to their block I/O
weight.</para>
<para > While <varname > StartupBlockIOWeight=</varname> only
applies to the startup phase of the system,
<varname > BlockIOWeight=</varname> applies to the later runtime
of the system, and if the former is not set also to the
startup phase. This allows prioritizing specific services at
boot-up differently than during runtime.</para>
<para > Implies
2018-09-25 10:40:35 +00:00
<literal > BlockIOAccounting=yes</literal> .</para>
2016-10-15 01:07:16 +00:00
<para > These settings are deprecated. Use <varname > IOWeight=</varname> and <varname > StartupIOWeight=</varname>
instead.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > BlockIODeviceWeight=<replaceable > device</replaceable> <replaceable > weight</replaceable> </varname> </term>
<listitem >
<para > Set the per-device overall block I/O weight for the executed processes, if the legacy control group
hierarchy is used on the system. Takes a space-separated pair of a file path and a weight value to specify
the device specific weight value, between 10 and 1000. (Example: "/dev/sda 500"). The file path may be
specified as path to a block device node or as any other file, in which case the backing block device of the
file system of the file is determined. This controls the <literal > blkio.weight_device</literal> control group
attribute, which defaults to 1000. Use this option multiple times to set weights for multiple devices. For
details about this control group attribute, see <ulink
2020-01-09 09:37:52 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/blkio-controller.html">Block IO Controller</ulink> .</para>
2016-10-15 01:07:16 +00:00
<para > Implies
2018-09-25 10:40:35 +00:00
<literal > BlockIOAccounting=yes</literal> .</para>
2016-10-15 01:07:16 +00:00
<para > This setting is deprecated. Use <varname > IODeviceWeight=</varname> instead.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <varname > BlockIOReadBandwidth=<replaceable > device</replaceable> <replaceable > bytes</replaceable> </varname> </term>
<term > <varname > BlockIOWriteBandwidth=<replaceable > device</replaceable> <replaceable > bytes</replaceable> </varname> </term>
<listitem >
<para > Set the per-device overall block I/O bandwidth limit for the executed processes, if the legacy control
group hierarchy is used on the system. Takes a space-separated pair of a file path and a bandwidth value (in
bytes per second) to specify the device specific bandwidth. The file path may be a path to a block device
node, or as any other file in which case the backing block device of the file system of the file is used. If
the bandwidth is suffixed with K, M, G, or T, the specified bandwidth is parsed as Kilobytes, Megabytes,
Gigabytes, or Terabytes, respectively, to the base of 1000. (Example:
"/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This controls the
<literal > blkio.throttle.read_bps_device</literal> and <literal > blkio.throttle.write_bps_device</literal>
control group attributes. Use this option multiple times to set bandwidth limits for multiple devices. For
details about these control group attributes, see <ulink
2020-01-09 09:37:52 +00:00
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/blkio-controller.html">Block IO Controller</ulink> .
2016-10-15 01:07:16 +00:00
</para>
<para > Implies
2018-09-25 10:40:35 +00:00
<literal > BlockIOAccounting=yes</literal> .</para>
2016-10-15 01:07:16 +00:00
<para > These settings are deprecated. Use <varname > IOReadBandwidthMax=</varname> and
<varname > IOWriteBandwidthMax=</varname> instead.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
2013-07-10 05:25:02 +00:00
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2019-02-01 11:31:51 +00:00
<citerefentry > <refentrytitle > systemd-system.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2013-07-10 05:25:02 +00:00
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.service</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.slice</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.scope</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.socket</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.mount</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.swap</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2016-10-15 18:17:05 +00:00
<citerefentry > <refentrytitle > systemd.exec</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2013-07-10 05:25:02 +00:00
<citerefentry > <refentrytitle > systemd.directives</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> ,
2013-07-19 02:10:06 +00:00
<citerefentry > <refentrytitle > systemd.special</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry> ,
2020-09-09 08:04:36 +00:00
<citerefentry > <refentrytitle > systemd-oomd.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
2013-07-10 05:25:02 +00:00
The documentation for control groups and specific controllers in the Linux kernel:
2020-01-09 09:37:52 +00:00
<ulink url= "https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html" > Control Groups v2</ulink> .
2013-07-10 05:25:02 +00:00
</para>
</refsect1>
</refentry>