]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.resource-control.xml
Merge pull request #29218 from DaanDeMeyer/kernel-modules
[thirdparty/systemd.git] / man / systemd.resource-control.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5
6 <refentry id="systemd.resource-control" xmlns:xi="http://www.w3.org/2001/XInclude">
7 <refentryinfo>
8 <title>systemd.resource-control</title>
9 <productname>systemd</productname>
10 </refentryinfo>
11
12 <refmeta>
13 <refentrytitle>systemd.resource-control</refentrytitle>
14 <manvolnum>5</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>systemd.resource-control</refname>
19 <refpurpose>Resource control unit settings</refpurpose>
20 </refnamediv>
21
22 <refsynopsisdiv>
23 <para>
24 <filename><replaceable>slice</replaceable>.slice</filename>,
25 <filename><replaceable>scope</replaceable>.scope</filename>,
26 <filename><replaceable>service</replaceable>.service</filename>,
27 <filename><replaceable>socket</replaceable>.socket</filename>,
28 <filename><replaceable>mount</replaceable>.mount</filename>,
29 <filename><replaceable>swap</replaceable>.swap</filename>
30 </para>
31 </refsynopsisdiv>
32
33 <refsect1>
34 <title>Description</title>
35
36 <para>Unit configuration files for services, slices, scopes, sockets, mount points, and swap devices share a subset
37 of configuration options for resource control of spawned processes. Internally, this relies on the Linux Control
38 Groups (cgroups) kernel concept for organizing processes in a hierarchical tree of named groups for the purpose of
39 resource management.</para>
40
41 <para>This man page lists the configuration options shared by
42 those six unit types. See
43 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
44 for the common options of all unit configuration files, and
45 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
46 <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
47 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
48 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
49 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
50 and
51 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
52 for more information on the specific unit configuration files. The
53 resource control configuration options are configured in the
54 [Slice], [Scope], [Service], [Socket], [Mount], or [Swap]
55 sections, depending on the unit type.</para>
56
57 <para>In addition, options which control resources available to programs
58 <emphasis>executed</emphasis> by systemd are listed in
59 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
60 Those options complement options listed here.</para>
61
62 <refsect2>
63 <title>Enabling and disabling controllers</title>
64
65 <para>Controllers in the cgroup hierarchy are hierarchical, and resource control is realized by
66 distributing resource assignments between siblings in branches of the cgroup hierarchy. There is no
67 need to explicitly <emphasis>enable</emphasis> a cgroup controller for a unit.
68 <command>systemd</command> will instruct the kernel to enable a controller for a given unit when this
69 unit has configuration for a given controller. For example, when <varname>CPUWeight=</varname> is set,
70 the <option>cpu</option> controller will be enabled, and when <varname>TasksMax=</varname> are set, the
71 <option>pids</option> controller will be enabled. In addition, various controllers may be also be
72 enabled explicitly via the
73 <varname>MemoryAccounting=</varname>/<varname>TasksAccounting=</varname>/<varname>IOAccounting=</varname>
74 settings. Because of how the cgroup hierarchy works, controllers will be automatically enabled for all
75 parent units and for any sibling units starting with the lowest level at which a controller is enabled.
76 Units for which a controller is enabled may be subject to resource control even if they don't have any
77 explicit configuration.</para>
78
79 <para>Setting <varname>Delegate=</varname> enables any delegated controllers for that unit (see below).
80 The delegatee may then enable controllers for its children as appropriate. In particular, if the
81 delegatee is <command>systemd</command> (in the <filename>user@.service</filename> unit), it will
82 repeat the same logic as the system instance and enable controllers for user units which have resource
83 limits configured, and their siblings and parents and parents' siblings.</para>
84
85 <para>Controllers may be <emphasis>disabled</emphasis> for parts of the cgroup hierarchy with
86 <varname>DisableControllers=</varname> (see below).</para>
87
88 <example>
89 <title>Enabling and disabling controllers</title>
90
91 <programlisting>
92 -.slice
93 / \
94 /-----/ \--------------\
95 / \
96 system.slice user.slice
97 / \ / \
98 / \ / \
99 / \ user@42.service user@1000.service
100 / \ Delegate= Delegate=yes
101 a.service b.slice / \
102 CPUWeight=20 DisableControllers=cpu / \
103 / \ app.slice session.slice
104 / \ CPUWeight=100 CPUWeight=100
105 / \
106 b1.service b2.service
107 CPUWeight=1000
108 </programlisting>
109
110 <para>In this hierarchy, the <option>cpu</option> controller is enabled for all units shown except
111 <filename>b1.service</filename> and <filename>b2.service</filename>. Because there is no explicit
112 configuration for <filename>system.slice</filename> and <filename>user.slice</filename>, CPU
113 resources will be split equally between them. Similarly, resources are allocated equally between
114 children of <filename>user.slice</filename> and between the child slices beneath
115 <filename>user@1000.service</filename>. Assuming that there is no further configuration of resources
116 or delegation below slices <filename>app.slice</filename> or <filename>session.slice</filename>, the
117 <option>cpu</option> controller would not be enabled for units in those slices and CPU resources
118 would be further allocated using other mechanisms, e.g. based on nice levels. The manager for user
119 42 has delegation enabled without any controllers, i.e. it can manipulate its subtree of the cgroup
120 hierarchy, but without resource control.</para>
121
122 <para>In the slice <filename>system.slice</filename>, CPU resources are split 1:6 for service
123 <filename>a.service</filename>, and 5:6 for slice <filename>b.slice</filename>, because slice
124 <filename>b.slice</filename> gets the default value of 100 for <filename>cpu.weight</filename> when
125 <varname>CPUWeight=</varname> is not set.</para>
126
127 <para><varname>CPUWeight=</varname> setting in service <filename>b2.service</filename> is neutralized
128 by <varname>DisableControllers=</varname> in slice <filename>b.slice</filename>, so the
129 <option>cpu</option> controller would not be enabled for services <filename>b1.service</filename> and
130 <filename>b2.service</filename>, and CPU resources would be further allocated using other mechanisms,
131 e.g. based on nice levels.</para>
132 </example>
133 </refsect2>
134
135 <refsect2>
136 <title>Setting resource controls for a group of related units</title>
137
138 <para>As described in
139 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, the
140 settings listed here may be set through the main file of a unit and drop-in snippets in
141 <filename index="false">*.d/</filename> directories. The list of directories searched for drop-ins
142 includes names formed by repeatedly truncating the unit name after all dashes. This is particularly
143 convenient to set resource limits for a group of units with similar names.</para>
144
145 <para>For example, every user gets their own slice
146 <filename>user-<replaceable>nnn</replaceable>.slice</filename>. Drop-ins with local configuration that
147 affect user 1000 may be placed in
148 <filename index="false">/etc/systemd/system/user-1000.slice</filename>,
149 <filename index="false">/etc/systemd/system/user-1000.slice.d/*.conf</filename>, but also
150 <filename index="false">/etc/systemd/system/user-.slice.d/*.conf</filename>. This last directory
151 applies to all user slices.</para>
152 </refsect2>
153
154 <para>See the <ulink
155 url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New
156 Control Group Interfaces</ulink> for an introduction on how to make
157 use of resource control APIs from programs.</para>
158 </refsect1>
159
160 <refsect1>
161 <title>Implicit Dependencies</title>
162
163 <para>The following dependencies are implicitly added:</para>
164
165 <itemizedlist>
166 <listitem><para>Units with the <varname>Slice=</varname> setting set automatically acquire
167 <varname>Requires=</varname> and <varname>After=</varname> dependencies on the specified
168 slice unit.</para></listitem>
169 </itemizedlist>
170 </refsect1>
171
172 <!-- We don't have any default dependency here. -->
173
174 <refsect1>
175 <title>Options</title>
176
177 <para>Units of the types listed above can have settings for resource control configuration:</para>
178
179 <refsect2><title>CPU Accounting and Control</title>
180
181 <variablelist class='unit-directives'>
182
183 <varlistentry>
184 <term><varname>CPUAccounting=</varname></term>
185
186 <listitem>
187 <para>Turn on CPU usage accounting for this unit. Takes a
188 boolean argument. Note that turning on CPU accounting for
189 one unit will also implicitly turn it on for all units
190 contained in the same slice and for all its parent slices
191 and the units contained therein. The system default for this
192 setting may be controlled with
193 <varname>DefaultCPUAccounting=</varname> in
194 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
195
196 <para>Under the unified cgroup hierarchy, CPU accounting is available for all units and this
197 setting has no effect.</para>
198
199 <xi:include href="version-info.xml" xpointer="v208"/>
200 </listitem>
201 </varlistentry>
202
203 <varlistentry>
204 <term><varname>CPUWeight=<replaceable>weight</replaceable></varname></term>
205 <term><varname>StartupCPUWeight=<replaceable>weight</replaceable></varname></term>
206
207 <listitem>
208 <para>These settings control the <option>cpu</option> controller in the unified hierarchy.</para>
209
210 <para>These options accept an integer value or a the special string "idle":</para>
211 <itemizedlist>
212 <listitem>
213 <para>If set to an integer value, assign the specified CPU time weight to the processes
214 executed, if the unified control group hierarchy is used on the system. These options control
215 the <literal>cpu.weight</literal> control group attribute. The allowed range is 1 to 10000.
216 Defaults to unset, but the kernel default is 100. For details about this control group
217 attribute, see <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html">Control Groups
218 v2</ulink> and <ulink url="https://docs.kernel.org/scheduler/sched-design-CFS.html">CFS
219 Scheduler</ulink>. The available CPU time is split up among all units within one slice
220 relative to their CPU time weight. A higher weight means more CPU time, a lower weight means
221 less.</para>
222 </listitem>
223 <listitem>
224 <para>If set to the special string "idle", mark the cgroup for "idle scheduling", which means
225 that it will get CPU resources only when there are no processes not marked in this way to execute in this
226 cgroup or its siblings. This setting corresponds to the <literal>cpu.idle</literal> cgroup attribute.</para>
227
228 <para>Note that this value only has an effect on cgroup-v2, for cgroup-v1 it is equivalent to the minimum weight.</para>
229 </listitem>
230 </itemizedlist>
231
232 <para>While <varname>StartupCPUWeight=</varname> applies to the startup and shutdown phases of the system,
233 <varname>CPUWeight=</varname> applies to normal runtime of the system, and if the former is not set also to
234 the startup and shutdown phases. Using <varname>StartupCPUWeight=</varname> allows prioritizing specific services at
235 boot-up and shutdown differently than during normal runtime.</para>
236
237 <para>In addition to the resource allocation performed by the <option>cpu</option> controller, the
238 kernel may automatically divide resources based on session-id grouping, see "The autogroup feature"
239 in <citerefentry
240 project='man-pages'><refentrytitle>sched</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
241 The effect of this feature is similar to the <option>cpu</option> controller with no explicit
242 configuration, so users should be careful to not mistake one for the other.</para>
243
244 <xi:include href="version-info.xml" xpointer="v232"/>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry>
249 <term><varname>CPUQuota=</varname></term>
250
251 <listitem>
252 <para>This setting controls the <option>cpu</option> controller in the unified hierarchy.</para>
253
254 <para>Assign the specified CPU time quota to the processes executed. Takes a percentage value, suffixed with
255 "%". The percentage specifies how much CPU time the unit shall get at maximum, relative to the total CPU time
256 available on one CPU. Use values &gt; 100% for allotting CPU time on more than one CPU. This controls the
257 <literal>cpu.max</literal> attribute on the unified control group hierarchy and
258 <literal>cpu.cfs_quota_us</literal> on legacy. For details about these control group attributes, see <ulink
259 url="https://docs.kernel.org/admin-guide/cgroup-v2.html">Control Groups v2</ulink> and <ulink
260 url="https://docs.kernel.org/scheduler/sched-bwc.html">CFS Bandwidth Control</ulink>.
261 Setting <varname>CPUQuota=</varname> to an empty value unsets the quota.</para>
262
263 <para>Example: <varname>CPUQuota=20%</varname> ensures that the executed processes will never get more than
264 20% CPU time on one CPU.</para>
265
266 <xi:include href="version-info.xml" xpointer="v213"/>
267
268 </listitem>
269 </varlistentry>
270
271 <varlistentry>
272 <term><varname>CPUQuotaPeriodSec=</varname></term>
273
274 <listitem>
275 <para>This setting controls the <option>cpu</option> controller in the unified hierarchy.</para>
276
277 <para>Assign the duration over which the CPU time quota specified by <varname>CPUQuota=</varname> is measured.
278 Takes a time duration value in seconds, with an optional suffix such as "ms" for milliseconds (or "s" for seconds.)
279 The default setting is 100ms. The period is clamped to the range supported by the kernel, which is [1ms, 1000ms].
280 Additionally, the period is adjusted up so that the quota interval is also at least 1ms.
281 Setting <varname>CPUQuotaPeriodSec=</varname> to an empty value resets it to the default.</para>
282
283 <para>This controls the second field of <literal>cpu.max</literal> attribute on the unified control group hierarchy
284 and <literal>cpu.cfs_period_us</literal> on legacy. For details about these control group attributes, see
285 <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html">Control Groups v2</ulink> and
286 <ulink url="https://docs.kernel.org/scheduler/sched-design-CFS.html">CFS Scheduler</ulink>.</para>
287
288 <para>Example: <varname>CPUQuotaPeriodSec=10ms</varname> to request that the CPU quota is measured in periods of 10ms.</para>
289
290 <xi:include href="version-info.xml" xpointer="v242"/>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry>
295 <term><varname>AllowedCPUs=</varname></term>
296 <term><varname>StartupAllowedCPUs=</varname></term>
297
298 <listitem>
299 <para>This setting controls the <option>cpuset</option> controller in the unified hierarchy.</para>
300
301 <para>Restrict processes to be executed on specific CPUs. Takes a list of CPU indices or ranges separated by either
302 whitespace or commas. CPU ranges are specified by the lower and upper CPU indices separated by a dash.</para>
303
304 <para>Setting <varname>AllowedCPUs=</varname> or <varname>StartupAllowedCPUs=</varname> doesn't guarantee that all
305 of the CPUs will be used by the processes as it may be limited by parent units. The effective configuration is
306 reported as <varname>EffectiveCPUs=</varname>.</para>
307
308 <para>While <varname>StartupAllowedCPUs=</varname> applies to the startup and shutdown phases of the system,
309 <varname>AllowedCPUs=</varname> applies to normal runtime of the system, and if the former is not set also to
310 the startup and shutdown phases. Using <varname>StartupAllowedCPUs=</varname> allows prioritizing specific services at
311 boot-up and shutdown differently than during normal runtime.</para>
312
313 <para>This setting is supported only with the unified control group hierarchy.</para>
314
315 <xi:include href="version-info.xml" xpointer="v244"/>
316 </listitem>
317 </varlistentry>
318
319 </variablelist>
320
321 </refsect2><refsect2><title>Memory Accounting and Control</title>
322
323 <variablelist class='unit-directives'>
324
325 <varlistentry>
326 <term><varname>MemoryAccounting=</varname></term>
327
328 <listitem>
329 <para>This setting controls the <option>memory</option> controller in the unified hierarchy.</para>
330
331 <para>Turn on process and kernel memory accounting for this
332 unit. Takes a boolean argument. Note that turning on memory
333 accounting for one unit will also implicitly turn it on for
334 all units contained in the same slice and for all its parent
335 slices and the units contained therein. The system default
336 for this setting may be controlled with
337 <varname>DefaultMemoryAccounting=</varname> in
338 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
339
340 <xi:include href="version-info.xml" xpointer="v208"/>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry>
345 <term><varname>MemoryMin=<replaceable>bytes</replaceable></varname>, <varname>MemoryLow=<replaceable>bytes</replaceable></varname></term>
346 <term><varname>StartupMemoryLow=<replaceable>bytes</replaceable></varname>, <varname>DefaultStartupMemoryLow=<replaceable>bytes</replaceable></varname></term>
347
348 <listitem>
349 <para>These settings control the <option>memory</option> controller in the unified hierarchy.</para>
350
351 <para>Specify the memory usage protection of the executed processes in this unit.
352 When reclaiming memory, the unit is treated as if it was using less memory resulting in memory
353 to be preferentially reclaimed from unprotected units.
354 Using <varname>MemoryLow=</varname> results in a weaker protection where memory may still
355 be reclaimed to avoid invoking the OOM killer in case there is no other reclaimable memory.</para>
356 <para>
357 For a protection to be effective, it is generally required to set a corresponding
358 allocation on all ancestors, which is then distributed between children
359 (with the exception of the root slice).
360 Any <varname>MemoryMin=</varname> or <varname>MemoryLow=</varname> allocation that is not
361 explicitly distributed to specific children is used to create a shared protection for all children.
362 As this is a shared protection, the children will freely compete for the memory.</para>
363
364 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
365 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
366 percentage value may be specified, which is taken relative to the installed physical memory on the
367 system. If assigned the special value <literal>infinity</literal>, all available memory is protected, which may be
368 useful in order to always inherit all of the protection afforded by ancestors.
369 This controls the <literal>memory.min</literal> or <literal>memory.low</literal> control group attribute.
370 For details about this control group attribute, see <ulink
371 url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>.</para>
372
373 <para>Units may have their children use a default <literal>memory.min</literal> or
374 <literal>memory.low</literal> value by specifying <varname>DefaultMemoryMin=</varname> or
375 <varname>DefaultMemoryLow=</varname>, which has the same semantics as
376 <varname>MemoryMin=</varname> and <varname>MemoryLow=</varname>, or <varname>DefaultStartupMemoryLow=</varname>
377 which has the same semantics as <varname>StartupMemoryLow=</varname>.
378 This setting does not affect <literal>memory.min</literal> or <literal>memory.low</literal>
379 in the unit itself.
380 Using it to set a default child allocation is only useful on kernels older than 5.7,
381 which do not support the <literal>memory_recursiveprot</literal> cgroup2 mount option.</para>
382
383 <para>While <varname>StartupMemoryLow=</varname> applies to the startup and shutdown phases of the system,
384 <varname>MemoryMin=</varname> applies to normal runtime of the system, and if the former is not set also to
385 the startup and shutdown phases. Using <varname>StartupMemoryLow=</varname> allows prioritizing specific services at
386 boot-up and shutdown differently than during normal runtime.</para>
387
388 <xi:include href="version-info.xml" xpointer="v240"/>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry>
393 <term><varname>MemoryHigh=<replaceable>bytes</replaceable></varname></term>
394 <term><varname>StartupMemoryHigh=<replaceable>bytes</replaceable></varname></term>
395
396 <listitem>
397 <para>These settings control the <option>memory</option> controller in the unified hierarchy.</para>
398
399 <para>Specify the throttling limit on memory usage of the executed processes in this unit. Memory usage may go
400 above the limit if unavoidable, but the processes are heavily slowed down and memory is taken away
401 aggressively in such cases. This is the main mechanism to control memory usage of a unit.</para>
402
403 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
404 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
405 percentage value may be specified, which is taken relative to the installed physical memory on the
406 system. If assigned the
407 special value <literal>infinity</literal>, no memory throttling is applied. This controls the
408 <literal>memory.high</literal> control group attribute. For details about this control group attribute, see
409 <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>.</para>
410
411 <para>While <varname>StartupMemoryHigh=</varname> applies to the startup and shutdown phases of the system,
412 <varname>MemoryHigh=</varname> applies to normal runtime of the system, and if the former is not set also to
413 the startup and shutdown phases. Using <varname>StartupMemoryHigh=</varname> allows prioritizing specific services at
414 boot-up and shutdown differently than during normal runtime.</para>
415
416 <xi:include href="version-info.xml" xpointer="v231"/>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry>
421 <term><varname>MemoryMax=<replaceable>bytes</replaceable></varname></term>
422 <term><varname>StartupMemoryMax=<replaceable>bytes</replaceable></varname></term>
423
424 <listitem>
425 <para>These settings control the <option>memory</option> controller in the unified hierarchy.</para>
426
427 <para>Specify the absolute limit on memory usage of the executed processes in this unit. If memory usage
428 cannot be contained under the limit, out-of-memory killer is invoked inside the unit. It is recommended to
429 use <varname>MemoryHigh=</varname> as the main control mechanism and use <varname>MemoryMax=</varname> as the
430 last line of defense.</para>
431
432 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
433 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
434 percentage value may be specified, which is taken relative to the installed physical memory on the system. If
435 assigned the special value <literal>infinity</literal>, no memory limit is applied. This controls the
436 <literal>memory.max</literal> control group attribute. For details about this control group attribute, see
437 <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>.</para>
438
439 <para>While <varname>StartupMemoryMax=</varname> applies to the startup and shutdown phases of the system,
440 <varname>MemoryMax=</varname> applies to normal runtime of the system, and if the former is not set also to
441 the startup and shutdown phases. Using <varname>StartupMemoryMax=</varname> allows prioritizing specific services at
442 boot-up and shutdown differently than during normal runtime.</para>
443
444 <xi:include href="version-info.xml" xpointer="v231"/>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry>
449 <term><varname>MemorySwapMax=<replaceable>bytes</replaceable></varname></term>
450 <term><varname>StartupMemorySwapMax=<replaceable>bytes</replaceable></varname></term>
451
452 <listitem>
453 <para>These settings control the <option>memory</option> controller in the unified hierarchy.</para>
454
455 <para>Specify the absolute limit on swap usage of the executed processes in this unit.</para>
456
457 <para>Takes a swap size in bytes. If the value is suffixed with K, M, G or T, the specified swap size is
458 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. If assigned the
459 special value <literal>infinity</literal>, no swap limit is applied. These settings control the
460 <literal>memory.swap.max</literal> control group attribute. For details about this control group attribute,
461 see <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>.</para>
462
463 <para>While <varname>StartupMemorySwapMax=</varname> applies to the startup and shutdown phases of the system,
464 <varname>MemorySwapMax=</varname> applies to normal runtime of the system, and if the former is not set also to
465 the startup and shutdown phases. Using <varname>StartupMemorySwapMax=</varname> allows prioritizing specific services at
466 boot-up and shutdown differently than during normal runtime.</para>
467
468 <xi:include href="version-info.xml" xpointer="v232"/>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry>
473 <term><varname>MemoryZSwapMax=<replaceable>bytes</replaceable></varname></term>
474 <term><varname>StartupMemoryZSwapMax=<replaceable>bytes</replaceable></varname></term>
475
476 <listitem>
477 <para>These settings control the <option>memory</option> controller in the unified hierarchy.</para>
478
479 <para>Specify the absolute limit on zswap usage of the processes in this unit. Zswap is a lightweight compressed
480 cache for swap pages. It takes pages that are in the process of being swapped out and attempts to compress them into a
481 dynamically allocated RAM-based memory pool. If the limit specified is hit, no entries from this unit will be
482 stored in the pool until existing entries are faulted back or written out to disk. See the kernel's
483 <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/mm/zswap.html">Zswap</ulink> documentation for more details.</para>
484
485 <para>Takes a size in bytes. If the value is suffixed with K, M, G or T, the specified size is
486 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. If assigned the
487 special value <literal>infinity</literal>, no limit is applied. These settings control the
488 <literal>memory.zswap.max</literal> control group attribute. For details about this control group attribute,
489 see <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>.</para>
490
491 <para>While <varname>StartupMemoryZSwapMax=</varname> applies to the startup and shutdown phases of the system,
492 <varname>MemoryZSwapMax=</varname> applies to normal runtime of the system, and if the former is not set also to
493 the startup and shutdown phases. Using <varname>StartupMemoryZSwapMax=</varname> allows prioritizing specific services at
494 boot-up and shutdown differently than during normal runtime.</para>
495
496 <xi:include href="version-info.xml" xpointer="v253"/>
497 </listitem>
498 </varlistentry>
499
500 <varlistentry>
501 <term><varname>AllowedMemoryNodes=</varname></term>
502 <term><varname>StartupAllowedMemoryNodes=</varname></term>
503
504 <listitem>
505 <para>These settings control the <option>cpuset</option> controller in the unified hierarchy.</para>
506
507 <para>Restrict processes to be executed on specific memory NUMA nodes. Takes a list of memory NUMA nodes indices
508 or ranges separated by either whitespace or commas. Memory NUMA nodes ranges are specified by the lower and upper
509 NUMA nodes indices separated by a dash.</para>
510
511 <para>Setting <varname>AllowedMemoryNodes=</varname> or <varname>StartupAllowedMemoryNodes=</varname> doesn't
512 guarantee that all of the memory NUMA nodes will be used by the processes as it may be limited by parent units.
513 The effective configuration is reported as <varname>EffectiveMemoryNodes=</varname>.</para>
514
515 <para>While <varname>StartupAllowedMemoryNodes=</varname> applies to the startup and shutdown phases of the system,
516 <varname>AllowedMemoryNodes=</varname> applies to normal runtime of the system, and if the former is not set also to
517 the startup and shutdown phases. Using <varname>StartupAllowedMemoryNodes=</varname> allows prioritizing specific services at
518 boot-up and shutdown differently than during normal runtime.</para>
519
520 <para>This setting is supported only with the unified control group hierarchy.</para>
521
522 <xi:include href="version-info.xml" xpointer="v244"/>
523 </listitem>
524 </varlistentry>
525
526 </variablelist>
527
528 </refsect2><refsect2><title>Process Accounting and Control</title>
529
530 <variablelist class='unit-directives'>
531
532 <varlistentry>
533 <term><varname>TasksAccounting=</varname></term>
534
535 <listitem>
536 <para>This setting controls the <option>pids</option> controller in the unified hierarchy.</para>
537
538 <para>Turn on task accounting for this unit. Takes a boolean argument. If enabled, the kernel will
539 keep track of the total number of tasks in the unit and its children. This number includes both
540 kernel threads and userspace processes, with each thread counted individually. Note that turning on
541 tasks accounting for one unit will also implicitly turn it on for all units contained in the same
542 slice and for all its parent slices and the units contained therein. The system default for this
543 setting may be controlled with <varname>DefaultTasksAccounting=</varname> in
544 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
545
546 <xi:include href="version-info.xml" xpointer="v227"/>
547 </listitem>
548 </varlistentry>
549
550 <varlistentry>
551 <term><varname>TasksMax=<replaceable>N</replaceable></varname></term>
552
553 <listitem>
554 <para>This setting controls the <option>pids</option> controller in the unified hierarchy.</para>
555
556 <para>Specify the maximum number of tasks that may be created in the unit. This ensures that the
557 number of tasks accounted for the unit (see above) stays below a specific limit. This either takes
558 an absolute number of tasks or a percentage value that is taken relative to the configured maximum
559 number of tasks on the system. If assigned the special value <literal>infinity</literal>, no tasks
560 limit is applied. This controls the <literal>pids.max</literal> control group attribute. For
561 details about this control group attribute, the
562 <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#pid">pids controller
563 </ulink>.</para>
564
565 <para>The system default for this setting may be controlled with
566 <varname>DefaultTasksMax=</varname> in
567 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
568
569 <xi:include href="version-info.xml" xpointer="v227"/>
570 </listitem>
571 </varlistentry>
572
573 </variablelist>
574
575 </refsect2><refsect2><title>IO Accounting and Control</title>
576
577 <variablelist class='unit-directives'>
578
579 <varlistentry>
580 <term><varname>IOAccounting=</varname></term>
581
582 <listitem>
583 <para>This setting controls the <option>io</option> controller in the unified hierarchy.</para>
584
585 <para>Turn on Block I/O accounting for this unit, if the unified control group hierarchy is used on the
586 system. Takes a boolean argument. Note that turning on block I/O accounting for one unit will also implicitly
587 turn it on for all units contained in the same slice and all for its parent slices and the units contained
588 therein. The system default for this setting may be controlled with <varname>DefaultIOAccounting=</varname>
589 in
590 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
591
592 <xi:include href="version-info.xml" xpointer="v230"/>
593 </listitem>
594 </varlistentry>
595
596 <varlistentry>
597 <term><varname>IOWeight=<replaceable>weight</replaceable></varname></term>
598 <term><varname>StartupIOWeight=<replaceable>weight</replaceable></varname></term>
599
600 <listitem>
601 <para>These settings control the <option>io</option> controller in the unified hierarchy.</para>
602
603 <para>Set the default overall block I/O weight for the executed processes, if the unified control
604 group hierarchy is used on the system. Takes a single weight value (between 1 and 10000) to set the
605 default block I/O weight. This controls the <literal>io.weight</literal> control group attribute,
606 which defaults to 100. For details about this control group attribute, see <ulink
607 url="https://docs.kernel.org/admin-guide/cgroup-v2.html#io-interface-files">IO
608 Interface Files</ulink>. The available I/O bandwidth is split up among all units within one slice
609 relative to their block I/O weight. A higher weight means more I/O bandwidth, a lower weight means
610 less.</para>
611
612 <para>While <varname>StartupIOWeight=</varname> applies
613 to the startup and shutdown phases of the system,
614 <varname>IOWeight=</varname> applies to the later runtime of
615 the system, and if the former is not set also to the startup
616 and shutdown phases. This allows prioritizing specific services at boot-up
617 and shutdown differently than during runtime.</para>
618
619 <xi:include href="version-info.xml" xpointer="v230"/>
620 </listitem>
621 </varlistentry>
622
623 <varlistentry>
624 <term><varname>IODeviceWeight=<replaceable>device</replaceable> <replaceable>weight</replaceable></varname></term>
625
626 <listitem>
627 <para>This setting controls the <option>io</option> controller in the unified hierarchy.</para>
628
629 <para>Set the per-device overall block I/O weight for the executed processes, if the unified control group
630 hierarchy is used on the system. Takes a space-separated pair of a file path and a weight value to specify
631 the device specific weight value, between 1 and 10000. (Example: <literal>/dev/sda 1000</literal>). The file
632 path may be specified as path to a block device node or as any other file, in which case the backing block
633 device of the file system of the file is determined. This controls the <literal>io.weight</literal> control
634 group attribute, which defaults to 100. Use this option multiple times to set weights for multiple devices.
635 For details about this control group attribute, see <ulink
636 url="https://docs.kernel.org/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink>.</para>
637
638 <para>The specified device node should reference a block device that has an I/O scheduler
639 associated, i.e. should not refer to partition or loopback block devices, but to the originating,
640 physical device. When a path to a regular file or directory is specified it is attempted to
641 discover the correct originating device backing the file system of the specified path. This works
642 correctly only for simpler cases, where the file system is directly placed on a partition or
643 physical block device, or where simple 1:1 encryption using dm-crypt/LUKS is used. This discovery
644 does not cover complex storage and in particular RAID and volume management storage devices.</para>
645
646 <xi:include href="version-info.xml" xpointer="v230"/>
647 </listitem>
648 </varlistentry>
649
650 <varlistentry>
651 <term><varname>IOReadBandwidthMax=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
652 <term><varname>IOWriteBandwidthMax=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
653
654 <listitem>
655 <para>These settings control the <option>io</option> controller in the unified hierarchy.</para>
656
657 <para>Set the per-device overall block I/O bandwidth maximum limit for the executed processes, if the unified
658 control group hierarchy is used on the system. This limit is not work-conserving and the executed processes
659 are not allowed to use more even if the device has idle capacity. Takes a space-separated pair of a file
660 path and a bandwidth value (in bytes per second) to specify the device specific bandwidth. The file path may
661 be a path to a block device node, or as any other file in which case the backing block device of the file
662 system of the file is used. If the bandwidth is suffixed with K, M, G, or T, the specified bandwidth is
663 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes, respectively, to the base of 1000. (Example:
664 "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This controls the <literal>io.max</literal> control
665 group attributes. Use this option multiple times to set bandwidth limits for multiple devices. For details
666 about this control group attribute, see <ulink
667 url="https://docs.kernel.org/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink>.
668 </para>
669
670 <para>Similar restrictions on block device discovery as for <varname>IODeviceWeight=</varname> apply, see above.</para>
671
672 <xi:include href="version-info.xml" xpointer="v230"/>
673 </listitem>
674 </varlistentry>
675
676 <varlistentry>
677 <term><varname>IOReadIOPSMax=<replaceable>device</replaceable> <replaceable>IOPS</replaceable></varname></term>
678 <term><varname>IOWriteIOPSMax=<replaceable>device</replaceable> <replaceable>IOPS</replaceable></varname></term>
679
680 <listitem>
681 <para>These settings control the <option>io</option> controller in the unified hierarchy.</para>
682
683 <para>Set the per-device overall block I/O IOs-Per-Second maximum limit for the executed processes, if the
684 unified control group hierarchy is used on the system. This limit is not work-conserving and the executed
685 processes are not allowed to use more even if the device has idle capacity. Takes a space-separated pair of
686 a file path and an IOPS value to specify the device specific IOPS. The file path may be a path to a block
687 device node, or as any other file in which case the backing block device of the file system of the file is
688 used. If the IOPS is suffixed with K, M, G, or T, the specified IOPS is parsed as KiloIOPS, MegaIOPS,
689 GigaIOPS, or TeraIOPS, respectively, to the base of 1000. (Example:
690 "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 1K"). This controls the <literal>io.max</literal> control
691 group attributes. Use this option multiple times to set IOPS limits for multiple devices. For details about
692 this control group attribute, see <ulink
693 url="https://docs.kernel.org/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink>.
694 </para>
695
696 <para>Similar restrictions on block device discovery as for <varname>IODeviceWeight=</varname> apply, see above.</para>
697
698 <xi:include href="version-info.xml" xpointer="v230"/>
699 </listitem>
700 </varlistentry>
701
702 <varlistentry>
703 <term><varname>IODeviceLatencyTargetSec=<replaceable>device</replaceable> <replaceable>target</replaceable></varname></term>
704
705 <listitem>
706 <para>This setting controls the <option>io</option> controller in the unified hierarchy.</para>
707
708 <para>Set the per-device average target I/O latency for the executed processes, if the unified control group
709 hierarchy is used on the system. Takes a file path and a timespan separated by a space to specify
710 the device specific latency target. (Example: "/dev/sda 25ms"). The file path may be specified
711 as path to a block device node or as any other file, in which case the backing block device of the file
712 system of the file is determined. This controls the <literal>io.latency</literal> control group
713 attribute. Use this option multiple times to set latency target for multiple devices. For details about this
714 control group attribute, see <ulink
715 url="https://docs.kernel.org/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink>.</para>
716
717 <para>Implies <literal>IOAccounting=yes</literal>.</para>
718
719 <para>These settings are supported only if the unified control group hierarchy is used.</para>
720
721 <para>Similar restrictions on block device discovery as for <varname>IODeviceWeight=</varname> apply, see above.</para>
722
723 <xi:include href="version-info.xml" xpointer="v240"/>
724 </listitem>
725 </varlistentry>
726
727 </variablelist>
728
729 </refsect2><refsect2><title>Network Accounting and Control</title>
730
731 <variablelist class='unit-directives'>
732
733 <varlistentry>
734 <term><varname>IPAccounting=</varname></term>
735
736 <listitem>
737 <para>Takes a boolean argument. If true, turns on IPv4 and IPv6 network traffic accounting for packets sent
738 or received by the unit. When this option is turned on, all IPv4 and IPv6 sockets created by any process of
739 the unit are accounted for.</para>
740
741 <para>When this option is used in socket units, it applies to all IPv4 and IPv6 sockets
742 associated with it (including both listening and connection sockets where this applies). Note that for
743 socket-activated services, this configuration setting and the accounting data of the service unit and the
744 socket unit are kept separate, and displayed separately. No propagation of the setting and the collected
745 statistics is done, in either direction. Moreover, any traffic sent or received on any of the socket unit's
746 sockets is accounted to the socket unit — and never to the service unit it might have activated, even if the
747 socket is used by it.</para>
748
749 <para>The system default for this setting may be controlled with <varname>DefaultIPAccounting=</varname> in
750 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
751
752 <xi:include href="version-info.xml" xpointer="v235"/>
753 </listitem>
754 </varlistentry>
755
756 <varlistentry>
757 <term><varname>IPAddressAllow=<replaceable>ADDRESS[/PREFIXLENGTH]…</replaceable></varname></term>
758 <term><varname>IPAddressDeny=<replaceable>ADDRESS[/PREFIXLENGTH]…</replaceable></varname></term>
759
760 <listitem>
761 <para>Turn on network traffic filtering for IP packets sent and received over
762 <constant>AF_INET</constant> and <constant>AF_INET6</constant> sockets. Both directives take a
763 space separated list of IPv4 or IPv6 addresses, each optionally suffixed with an address prefix
764 length in bits after a <literal>/</literal> character. If the suffix is omitted, the address is
765 considered a host address, i.e. the filter covers the whole address (32 bits for IPv4, 128 bits for
766 IPv6).</para>
767
768 <para>The access lists configured with this option are applied to all sockets created by processes
769 of this unit (or in the case of socket units, associated with it). The lists are implicitly
770 combined with any lists configured for any of the parent slice units this unit might be a member
771 of. By default both access lists are empty. Both ingress and egress traffic is filtered by these
772 settings. In case of ingress traffic the source IP address is checked against these access lists,
773 in case of egress traffic the destination IP address is checked. The following rules are applied in
774 turn:</para>
775
776 <itemizedlist>
777 <listitem><para>Access is granted when the checked IP address matches an entry in the
778 <varname>IPAddressAllow=</varname> list.</para></listitem>
779
780 <listitem><para>Otherwise, access is denied when the checked IP address matches an entry in the
781 <varname>IPAddressDeny=</varname> list.</para></listitem>
782
783 <listitem><para>Otherwise, access is granted.</para></listitem>
784 </itemizedlist>
785
786 <para>In order to implement an allow-listing IP firewall, it is recommended to use a
787 <varname>IPAddressDeny=</varname><constant>any</constant> setting on an upper-level slice unit
788 (such as the root slice <filename>-.slice</filename> or the slice containing all system services
789 <filename>system.slice</filename> – see
790 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
791 for details on these slice units), plus individual per-service <varname>IPAddressAllow=</varname>
792 lines permitting network access to relevant services, and only them.</para>
793
794 <para>Note that for socket-activated services, the IP access list configured on the socket unit
795 applies to all sockets associated with it directly, but not to any sockets created by the
796 ultimately activated services for it. Conversely, the IP access list configured for the service is
797 not applied to any sockets passed into the service via socket activation. Thus, it is usually a
798 good idea to replicate the IP access lists on both the socket and the service unit. Nevertheless,
799 it may make sense to maintain one list more open and the other one more restricted, depending on
800 the use case.</para>
801
802 <para>If these settings are used multiple times in the same unit the specified lists are combined. If an
803 empty string is assigned to these settings the specific access list is reset and all previous settings undone.</para>
804
805 <para>In place of explicit IPv4 or IPv6 address and prefix length specifications a small set of symbolic
806 names may be used. The following names are defined:</para>
807
808 <table>
809 <title>Special address/network names</title>
810
811 <tgroup cols='3'>
812 <colspec colname='name'/>
813 <colspec colname='definition'/>
814 <colspec colname='meaning'/>
815
816 <thead>
817 <row>
818 <entry>Symbolic Name</entry>
819 <entry>Definition</entry>
820 <entry>Meaning</entry>
821 </row>
822 </thead>
823
824 <tbody>
825 <row>
826 <entry><constant>any</constant></entry>
827 <entry>0.0.0.0/0 ::/0</entry>
828 <entry>Any host</entry>
829 </row>
830
831 <row>
832 <entry><constant>localhost</constant></entry>
833 <entry>127.0.0.0/8 ::1/128</entry>
834 <entry>All addresses on the local loopback</entry>
835 </row>
836
837 <row>
838 <entry><constant>link-local</constant></entry>
839 <entry>169.254.0.0/16 fe80::/64</entry>
840 <entry>All link-local IP addresses</entry>
841 </row>
842
843 <row>
844 <entry><constant>multicast</constant></entry>
845 <entry>224.0.0.0/4 ff00::/8</entry>
846 <entry>All IP multicasting addresses</entry>
847 </row>
848 </tbody>
849 </tgroup>
850 </table>
851
852 <para>Note that these settings might not be supported on some systems (for example if eBPF control group
853 support is not enabled in the underlying kernel or container manager). These settings will have no effect in
854 that case. If compatibility with such systems is desired it is hence recommended to not exclusively rely on
855 them for IP security.</para>
856
857 <xi:include href="cgroup-sandboxing.xml" xpointer="singular"/>
858
859 <xi:include href="version-info.xml" xpointer="v235"/>
860 </listitem>
861 </varlistentry>
862
863 <varlistentry>
864 <term><varname>SocketBindAllow=<replaceable>bind-rule</replaceable></varname></term>
865 <term><varname>SocketBindDeny=<replaceable>bind-rule</replaceable></varname></term>
866
867 <listitem>
868 <para>Allow or deny binding a socket address to a socket by matching it with the <replaceable>bind-rule</replaceable> and
869 applying a corresponding action if there is a match.</para>
870
871 <para><replaceable>bind-rule</replaceable> describes socket properties such as <replaceable>address-family</replaceable>,
872 <replaceable>transport-protocol</replaceable> and <replaceable>ip-ports</replaceable>.</para>
873
874 <para><replaceable>bind-rule</replaceable> :=
875 { [<replaceable>address-family</replaceable><constant>:</constant>][<replaceable>transport-protocol</replaceable><constant>:</constant>][<replaceable>ip-ports</replaceable>] | <constant>any</constant> }</para>
876
877 <para><replaceable>address-family</replaceable> := { <constant>ipv4</constant> | <constant>ipv6</constant> }</para>
878
879 <para><replaceable>transport-protocol</replaceable> := { <constant>tcp</constant> | <constant>udp</constant> }</para>
880
881 <para><replaceable>ip-ports</replaceable> := { <replaceable>ip-port</replaceable> | <replaceable>ip-port-range</replaceable> }</para>
882
883 <para>An optional <replaceable>address-family</replaceable> expects <constant>ipv4</constant> or <constant>ipv6</constant> values.
884 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>,
885 <replaceable>ip-port</replaceable>.</para>
886
887 <para>An optional <replaceable>transport-protocol</replaceable> expects <constant>tcp</constant> or <constant>udp</constant> transport protocol names.
888 If not specified, a rule will be matched for any transport protocol.</para>
889
890 <para>An optional <replaceable>ip-port</replaceable> value must lie within 165535 interval inclusively, i.e.
891 dynamic port <constant>0</constant> is not allowed. A range of sequential ports is described by
892 <replaceable>ip-port-range</replaceable> := <replaceable>ip-port-low</replaceable><constant>-</constant><replaceable>ip-port-high</replaceable>,
893 where <replaceable>ip-port-low</replaceable> is smaller than or equal to <replaceable>ip-port-high</replaceable>
894 and both are within 165535 inclusively.</para>
895
896 <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>
897
898 <para>To allow multiple rules assign <varname>SocketBindAllow=</varname> or <varname>SocketBindDeny=</varname> multiple times.
899 To clear the existing assignments pass an empty <varname>SocketBindAllow=</varname> or <varname>SocketBindDeny=</varname>
900 assignment.</para>
901
902 <para>For each of <varname>SocketBindAllow=</varname> and <varname>SocketBindDeny=</varname>, maximum allowed number of assignments is
903 <constant>128</constant>.</para>
904
905 <itemizedlist>
906 <listitem><para>Binding to a socket is allowed when a socket address matches an entry in the
907 <varname>SocketBindAllow=</varname> list.</para></listitem>
908
909 <listitem><para>Otherwise, binding is denied when the socket address matches an entry in the
910 <varname>SocketBindDeny=</varname> list.</para></listitem>
911
912 <listitem><para>Otherwise, binding is allowed.</para></listitem>
913 </itemizedlist>
914
915 <para>The feature is implemented with <constant>cgroup/bind4</constant> and <constant>cgroup/bind6</constant> cgroup-bpf hooks.</para>
916 <para>Examples:<programlisting>
917 # Allow binding IPv6 socket addresses with a port greater than or equal to 10000.
918 [Service]
919 SocketBindAllow=ipv6:10000-65535
920 SocketBindDeny=any
921
922 # Allow binding IPv4 and IPv6 socket addresses with 1234 and 4321 ports.
923 [Service]
924 SocketBindAllow=1234
925 SocketBindAllow=4321
926 SocketBindDeny=any
927
928 # Deny binding IPv6 socket addresses.
929 [Service]
930 SocketBindDeny=ipv6
931
932 # Deny binding IPv4 and IPv6 socket addresses.
933 [Service]
934 SocketBindDeny=any
935
936 # Allow binding only over TCP
937 [Service]
938 SocketBindAllow=tcp
939 SocketBindDeny=any
940
941 # Allow binding only over IPv6/TCP
942 [Service]
943 SocketBindAllow=ipv6:tcp
944 SocketBindDeny=any
945
946 # Allow binding ports within 10000-65535 range over IPv4/UDP.
947 [Service]
948 SocketBindAllow=ipv4:udp:10000-65535
949 SocketBindDeny=any
950</programlisting></para>
951
952 <xi:include href="cgroup-sandboxing.xml" xpointer="singular"/>
953
954 <xi:include href="version-info.xml" xpointer="v249"/>
955 </listitem>
956 </varlistentry>
957
958 <varlistentry>
959 <term><varname>RestrictNetworkInterfaces=</varname></term>
960
961 <listitem>
962 <para>Takes a list of space-separated network interface names. This option restricts the network
963 interfaces that processes of this unit can use. By default processes can only use the network interfaces
964 listed (allow-list). If the first character of the rule is <literal>~</literal>, the effect is inverted:
965 the processes can only use network interfaces not listed (deny-list).
966 </para>
967
968 <para>This option can appear multiple times, in which case the network interface names are merged. If the
969 empty string is assigned the set is reset, all prior assignments will have not effect.
970 </para>
971
972 <para>If you specify both types of this option (i.e. allow-listing and deny-listing), the first encountered
973 will take precedence and will dictate the default action (allow vs deny). Then the next occurrences of this
974 option will add or delete the listed network interface names from the set, depending of its type and the
975 default action.
976 </para>
977
978 <para>The loopback interface ("lo") is not treated in any special way, you have to configure it explicitly
979 in the unit file.
980 </para>
981 <para>Example 1: allow-list
982 <programlisting>
983 RestrictNetworkInterfaces=eth1
984 RestrictNetworkInterfaces=eth2</programlisting>
985 Programs in the unit will be only able to use the eth1 and eth2 network
986 interfaces.
987 </para>
988
989 <para>Example 2: deny-list
990 <programlisting>
991 RestrictNetworkInterfaces=~eth1 eth2</programlisting>
992 Programs in the unit will be able to use any network interface but eth1 and eth2.
993 </para>
994
995 <para>Example 3: mixed
996 <programlisting>
997 RestrictNetworkInterfaces=eth1 eth2
998 RestrictNetworkInterfaces=~eth1</programlisting>
999 Programs in the unit will be only able to use the eth2 network interface.
1000 </para>
1001
1002 <xi:include href="cgroup-sandboxing.xml" xpointer="singular"/>
1003
1004 <xi:include href="version-info.xml" xpointer="v250"/>
1005 </listitem>
1006 </varlistentry>
1007
1008 </variablelist>
1009
1010 </refsect2><refsect2><title>BPF Programs</title>
1011
1012 <variablelist class='unit-directives'>
1013
1014 <varlistentry>
1015 <term><varname>IPIngressFilterPath=<replaceable>BPF_FS_PROGRAM_PATH</replaceable></varname></term>
1016 <term><varname>IPEgressFilterPath=<replaceable>BPF_FS_PROGRAM_PATH</replaceable></varname></term>
1017
1018 <listitem>
1019 <para>Add custom network traffic filters implemented as BPF programs, applying to all IP packets
1020 sent and received over <constant>AF_INET</constant> and <constant>AF_INET6</constant> sockets.
1021 Takes an absolute path to a pinned BPF program in the BPF virtual filesystem (<filename>/sys/fs/bpf/</filename>).
1022 </para>
1023
1024 <para>The filters configured with this option are applied to all sockets created by processes
1025 of this unit (or in the case of socket units, associated with it). The filters are loaded in addition
1026 to filters any of the parent slice units this unit might be a member of as well as any
1027 <varname>IPAddressAllow=</varname> and <varname>IPAddressDeny=</varname> filters in any of these units.
1028 By default there are no filters specified.</para>
1029
1030 <para>If these settings are used multiple times in the same unit all the specified programs are attached. If an
1031 empty string is assigned to these settings the program list is reset and all previous specified programs ignored.</para>
1032
1033 <para>If the path <replaceable>BPF_FS_PROGRAM_PATH</replaceable> in <varname>IPIngressFilterPath=</varname> assignment
1034 is already being handled by <varname>BPFProgram=</varname> ingress hook, e.g.
1035 <varname>BPFProgram=</varname><constant>ingress</constant>:<replaceable>BPF_FS_PROGRAM_PATH</replaceable>,
1036 the assignment will be still considered valid and the program will be attached to a cgroup. Same for
1037 <varname>IPEgressFilterPath=</varname> path and <constant>egress</constant> hook.</para>
1038
1039 <para>Note that for socket-activated services, the IP filter programs configured on the socket unit apply to
1040 all sockets associated with it directly, but not to any sockets created by the ultimately activated services
1041 for it. Conversely, the IP filter programs configured for the service are not applied to any sockets passed into
1042 the service via socket activation. Thus, it is usually a good idea, to replicate the IP filter programs on both
1043 the socket and the service unit, however it often makes sense to maintain one configuration more open and the other
1044 one more restricted, depending on the use case.</para>
1045
1046 <para>Note that these settings might not be supported on some systems (for example if eBPF control group
1047 support is not enabled in the underlying kernel or container manager). These settings will fail the service in
1048 that case. If compatibility with such systems is desired it is hence recommended to attach your filter manually
1049 (requires <varname>Delegate=</varname><constant>yes</constant>) instead of using this setting.</para>
1050
1051 <xi:include href="version-info.xml" xpointer="v243"/>
1052 </listitem>
1053 </varlistentry>
1054
1055 <varlistentry>
1056 <term><varname>BPFProgram=<replaceable>type</replaceable>:<replaceable>program-path</replaceable></varname></term>
1057 <listitem>
1058 <para><varname>BPFProgram=</varname> allows attaching custom BPF programs to the cgroup of a
1059 unit. (This generalizes the functionality exposed via <varname>IPEgressFilterPath=</varname> and
1060 and <varname>IPIngressFilterPath=</varname> for other hooks.) Cgroup-bpf hooks in the form of BPF
1061 programs loaded to the BPF filesystem are attached with cgroup-bpf attach flags determined by the
1062 unit. For details about attachment types and flags see <ulink
1063 url="https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/include/uapi/linux/bpf.h"><filename>bpf.h</filename></ulink>. Also
1064 refer to the general <ulink url="https://docs.kernel.org/bpf/">BPF documentation</ulink>.</para>
1065
1066 <para>The specification of BPF program consists of a pair of BPF program type and program path in
1067 the file system, with <literal>:</literal> as the separator:
1068 <replaceable>type</replaceable>:<replaceable>program-path</replaceable>.</para>
1069
1070 <para>The BPF program type is equivalent to the BPF attach type used in
1071 <command>bpftool</command>. It may be one of <constant>egress</constant>,
1072 <constant>ingress</constant>, <constant>sock_create</constant>, <constant>sock_ops</constant>,
1073 <constant>device</constant>, <constant>bind4</constant>, <constant>bind6</constant>,
1074 <constant>connect4</constant>, <constant>connect6</constant>, <constant>post_bind4</constant>,
1075 <constant>post_bind6</constant>, <constant>sendmsg4</constant>, <constant>sendmsg6</constant>,
1076 <constant>sysctl</constant>, <constant>recvmsg4</constant>, <constant>recvmsg6</constant>,
1077 <constant>getsockopt</constant>, <constant>setsockopt</constant>.</para>
1078
1079 <para>The specified program path must be an absolute path referencing a BPF program inode in the
1080 bpffs file system (which generally means it must begin with <filename>/sys/fs/bpf/</filename>). If
1081 a specified program does not exist (i.e. has not been uploaded to the BPF subsystem of the kernel
1082 yet), it will not be installed but unit activation will continue (a warning will be printed to the
1083 logs).</para>
1084
1085 <para>Setting <varname>BPFProgram=</varname> to an empty value makes previous assignments
1086 ineffective.</para>
1087
1088 <para>Multiple assignments of the same program type/path pair have the same effect as a single
1089 assignment: the program will be attached just once.</para>
1090
1091 <para>If BPF <constant>egress</constant> pinned to <replaceable>program-path</replaceable> path is already being
1092 handled by <varname>IPEgressFilterPath=</varname>, <varname>BPFProgram=</varname>
1093 assignment will be considered valid and <varname>BPFProgram=</varname> will be attached to a cgroup.
1094 Similarly for <constant>ingress</constant> hook and <varname>IPIngressFilterPath=</varname> assignment.</para>
1095
1096 <para>BPF programs passed with <varname>BPFProgram=</varname> are attached to the cgroup of a unit
1097 with BPF attach flag <constant>multi</constant>, that allows further attachments of the same
1098 <replaceable>type</replaceable> within cgroup hierarchy topped by the unit cgroup.</para>
1099
1100 <para>Examples:<programlisting>BPFProgram=egress:/sys/fs/bpf/egress-hook
1101 BPFProgram=bind6:/sys/fs/bpf/sock-addr-hook
1102 </programlisting></para>
1103
1104 <xi:include href="version-info.xml" xpointer="v249"/>
1105 </listitem>
1106 </varlistentry>
1107
1108 </variablelist>
1109
1110 </refsect2><refsect2><title>Device Access</title>
1111
1112 <variablelist class='unit-directives'>
1113
1114 <varlistentry>
1115 <term><varname>DeviceAllow=</varname></term>
1116
1117 <listitem>
1118 <para>Control access to specific device nodes by the executed processes. Takes two space-separated
1119 strings: a device node specifier followed by a combination of <constant>r</constant>,
1120 <constant>w</constant>, <constant>m</constant> to control <emphasis>r</emphasis>eading,
1121 <emphasis>w</emphasis>riting, or creation of the specific device nodes by the unit
1122 (<emphasis>m</emphasis>knod), respectively. This functionality is implemented using eBPF
1123 filtering.</para>
1124
1125 <para>When access to <emphasis>all</emphasis> physical devices should be disallowed,
1126 <varname>PrivateDevices=</varname> may be used instead. See
1127 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1128 </para>
1129
1130 <para>The device node specifier is either a path to a device node in the file system, starting with
1131 <filename>/dev/</filename>, or a string starting with either <literal>char-</literal> or
1132 <literal>block-</literal> followed by a device group name, as listed in
1133 <filename>/proc/devices</filename>. The latter is useful to allow-list all current and future
1134 devices belonging to a specific device group at once. The device group is matched according to
1135 filename globbing rules, you may hence use the <literal>*</literal> and <literal>?</literal>
1136 wildcards. (Note that such globbing wildcards are not available for device node path
1137 specifications!) In order to match device nodes by numeric major/minor, use device node paths in
1138 the <filename>/dev/char/</filename> and <filename>/dev/block/</filename> directories. However,
1139 matching devices by major/minor is generally not recommended as assignments are neither stable nor
1140 portable between systems or different kernel versions.</para>
1141
1142 <para>Examples: <filename>/dev/sda5</filename> is a path to a device node, referring to an ATA or
1143 SCSI block device. <literal>char-pts</literal> and <literal>char-alsa</literal> are specifiers for
1144 all pseudo TTYs and all ALSA sound devices, respectively. <literal>char-cpu/*</literal> is a
1145 specifier matching all CPU related device groups.</para>
1146
1147 <para>Note that allow lists defined this way should only reference device groups which are
1148 resolvable at the time the unit is started. Any device groups not resolvable then are not added to
1149 the device allow list. In order to work around this limitation, consider extending service units
1150 with a pair of <command>After=modprobe@xyz.service</command> and
1151 <command>Wants=modprobe@xyz.service</command> lines that load the necessary kernel module
1152 implementing the device group if missing.
1153 Example: <programlisting>
1154 [Unit]
1155 Wants=modprobe@loop.service
1156 After=modprobe@loop.service
1157
1158 [Service]
1159 DeviceAllow=block-loop
1160 DeviceAllow=/dev/loop-control
1161</programlisting></para>
1162
1163 <xi:include href="cgroup-sandboxing.xml" xpointer="singular"/>
1164
1165 <xi:include href="version-info.xml" xpointer="v208"/>
1166 </listitem>
1167 </varlistentry>
1168
1169 <varlistentry>
1170 <term><varname>DevicePolicy=auto|closed|strict</varname></term>
1171
1172 <listitem>
1173 <para>
1174 Control the policy for allowing device access:
1175 </para>
1176 <variablelist>
1177 <varlistentry>
1178 <term><option>strict</option></term>
1179 <listitem>
1180 <para>means to only allow types of access that are
1181 explicitly specified.</para>
1182
1183 <xi:include href="version-info.xml" xpointer="v208"/>
1184 </listitem>
1185 </varlistentry>
1186
1187 <varlistentry>
1188 <term><option>closed</option></term>
1189 <listitem>
1190 <para>in addition, allows access to standard pseudo
1191 devices including
1192 <filename>/dev/null</filename>,
1193 <filename>/dev/zero</filename>,
1194 <filename>/dev/full</filename>,
1195 <filename>/dev/random</filename>, and
1196 <filename>/dev/urandom</filename>.
1197 </para>
1198
1199 <xi:include href="version-info.xml" xpointer="v208"/>
1200 </listitem>
1201 </varlistentry>
1202
1203 <varlistentry>
1204 <term><option>auto</option></term>
1205 <listitem>
1206 <para>
1207 in addition, allows access to all devices if no
1208 explicit <varname>DeviceAllow=</varname> is present.
1209 This is the default.
1210 </para>
1211
1212 <xi:include href="version-info.xml" xpointer="v208"/>
1213 </listitem>
1214 </varlistentry>
1215 </variablelist>
1216
1217 <xi:include href="cgroup-sandboxing.xml" xpointer="singular"/>
1218
1219 <xi:include href="version-info.xml" xpointer="v208"/>
1220 </listitem>
1221 </varlistentry>
1222
1223 </variablelist>
1224
1225 </refsect2><refsect2><title>Control Group Management</title>
1226
1227 <variablelist class='unit-directives'>
1228
1229 <varlistentry>
1230 <term><varname>Slice=</varname></term>
1231
1232 <listitem>
1233 <para>The name of the slice unit to place the unit
1234 in. Defaults to <filename>system.slice</filename> for all
1235 non-instantiated units of all unit types (except for slice
1236 units themselves see below). Instance units are by default
1237 placed in a subslice of <filename>system.slice</filename>
1238 that is named after the template name.</para>
1239
1240 <para>This option may be used to arrange systemd units in a
1241 hierarchy of slices each of which might have resource
1242 settings applied.</para>
1243
1244 <para>For units of type slice, the only accepted value for
1245 this setting is the parent slice. Since the name of a slice
1246 unit implies the parent slice, it is hence redundant to ever
1247 set this parameter directly for slice units.</para>
1248
1249 <para>Special care should be taken when relying on the default slice assignment in templated service units
1250 that have <varname>DefaultDependencies=no</varname> set, see
1251 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, section
1252 "Default Dependencies" for details.</para>
1253
1254 <xi:include href="version-info.xml" xpointer="v208"/>
1255
1256 </listitem>
1257 </varlistentry>
1258
1259 <varlistentry>
1260 <term><varname>Delegate=</varname></term>
1261
1262 <listitem>
1263 <para>Turns on delegation of further resource control partitioning to processes of the unit. Units
1264 where this is enabled may create and manage their own private subhierarchy of control groups below
1265 the control group of the unit itself. For unprivileged services (i.e. those using the
1266 <varname>User=</varname> setting) the unit's control group will be made accessible to the relevant
1267 user.</para>
1268
1269 <para>When enabled the service manager will refrain from manipulating control groups or moving
1270 processes below the unit's control group, so that a clear concept of ownership is established: the
1271 control group tree at the level of the unit's control group and above (i.e. towards the root
1272 control group) is owned and managed by the service manager of the host, while the control group
1273 tree below the unit's control group is owned and managed by the unit itself.</para>
1274
1275 <para>Takes either a boolean argument or a (possibly empty) list of control group controller names.
1276 If true, delegation is turned on, and all supported controllers are enabled for the unit, making
1277 them available to the unit's processes for management. If false, delegation is turned off entirely
1278 (and no additional controllers are enabled). If set to a list of controllers, delegation is turned
1279 on, and the specified controllers are enabled for the unit. Assigning the empty string will enable
1280 delegation, but reset the list of controllers, and all assignments prior to this will have no
1281 effect. Note that additional controllers other than the ones specified might be made available as
1282 well, depending on configuration of the containing slice unit or other units contained in it.
1283 Defaults to false.</para>
1284
1285 <para>Note that controller delegation to less privileged code is only safe on the unified control
1286 group hierarchy. Accordingly, access to the specified controllers will not be granted to
1287 unprivileged services on the legacy hierarchy, even when requested.</para>
1288
1289 <xi:include href="supported-controllers.xml" xpointer="controllers-text" />
1290
1291 <para>Not all of these controllers are available on all kernels however, and some are specific to
1292 the unified hierarchy while others are specific to the legacy hierarchy. Also note that the kernel
1293 might support further controllers, which aren't covered here yet as delegation is either not
1294 supported at all for them or not defined cleanly.</para>
1295
1296 <para>Note that because of the hierarchical nature of cgroup hierarchy, any controllers that are
1297 delegated will be enabled for the parent and sibling units of the unit with delegation.</para>
1298
1299 <para>For further details on the delegation model consult <ulink
1300 url="https://systemd.io/CGROUP_DELEGATION">Control Group APIs and Delegation</ulink>.</para>
1301
1302 <xi:include href="version-info.xml" xpointer="v218"/>
1303 </listitem>
1304 </varlistentry>
1305
1306 <varlistentry>
1307 <term><varname>DelegateSubgroup=</varname></term>
1308
1309 <listitem>
1310 <para>Place unit processes in the specified subgroup of the unit's control group. Takes a valid
1311 control group name (not a path!) as parameter, or an empty string to turn this feature
1312 off. Defaults to off. The control group name must be usable as filename and avoid conflicts with
1313 the kernel's control group attribute files (i.e. <filename>cgroup.procs</filename> is not an
1314 acceptable name, since the kernel exposes a native control group attribute file by that name). This
1315 option has no effect unless control group delegation is turned on via <varname>Delegate=</varname>,
1316 see above. Note that this setting only applies to "main" processes of a unit, i.e. for services to
1317 <varname>ExecStart=</varname>, but not for <varname>ExecReload=</varname> and similar. If
1318 delegation is enabled, the latter are always placed inside a subgroup named
1319 <filename>.control</filename>. The specified subgroup is automatically created (and potentially
1320 ownership is passed to the unit's configured user/group) when a process is started in it.</para>
1321
1322 <para>This option is useful to avoid manually moving the invoked process into a subgroup after it
1323 has been started. Since no processes should live in inner nodes of the control group tree it's
1324 almost always necessary to run the main ("supervising") process of a unit that has delegation
1325 turned on in a subgroup.</para>
1326
1327 <xi:include href="version-info.xml" xpointer="v254"/>
1328 </listitem>
1329 </varlistentry>
1330
1331 <varlistentry>
1332 <term><varname>DisableControllers=</varname></term>
1333
1334 <listitem>
1335 <para>Disables controllers from being enabled for a unit's children. If a controller listed is
1336 already in use in its subtree, the controller will be removed from the subtree. This can be used to
1337 avoid configuration in child units from being able to implicitly or explicitly enable a controller.
1338 Defaults to empty.</para>
1339
1340 <para>Multiple controllers may be specified, separated by spaces. You may also pass
1341 <varname>DisableControllers=</varname> multiple times, in which case each new instance adds another controller
1342 to disable. Passing <varname>DisableControllers=</varname> by itself with no controller name present resets
1343 the disabled controller list.</para>
1344
1345 <para>It may not be possible to disable a controller after units have been started, if the unit or
1346 any child of the unit in question delegates controllers to its children, as any delegated subtree
1347 of the cgroup hierarchy is unmanaged by systemd.</para>
1348
1349 <xi:include href="supported-controllers.xml" xpointer="controllers-text" />
1350
1351 <xi:include href="version-info.xml" xpointer="v240"/>
1352 </listitem>
1353 </varlistentry>
1354
1355 </variablelist>
1356
1357 </refsect2><refsect2><title>Memory Pressure Control</title>
1358
1359 <variablelist class='unit-directives'>
1360
1361 <varlistentry>
1362 <term><varname>ManagedOOMSwap=auto|kill</varname></term>
1363 <term><varname>ManagedOOMMemoryPressure=auto|kill</varname></term>
1364
1365 <listitem>
1366 <para>Specifies how
1367 <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1368 will act on this unit's cgroups. Defaults to <option>auto</option>.</para>
1369
1370 <para>When set to <option>kill</option>, the unit becomes a candidate for monitoring by
1371 <command>systemd-oomd</command>. If the cgroup passes the limits set by
1372 <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> or
1373 the unit configuration, <command>systemd-oomd</command> will select a descendant cgroup and send
1374 <constant>SIGKILL</constant> to all of the processes under it. You can find more details on
1375 candidates and kill behavior at
1376 <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1377 and
1378 <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1379
1380 <para>Setting either of these properties to <option>kill</option> will also result in
1381 <varname>After=</varname> and <varname>Wants=</varname> dependencies on
1382 <filename>systemd-oomd.service</filename> unless <varname>DefaultDependencies=no</varname>.</para>
1383
1384 <para>When set to <option>auto</option>, <command>systemd-oomd</command> will not actively use this
1385 cgroup's data for monitoring and detection. However, if an ancestor cgroup has one of these
1386 properties set to <option>kill</option>, a unit with <option>auto</option> can still be a candidate
1387 for <command>systemd-oomd</command> to terminate.</para>
1388
1389 <xi:include href="version-info.xml" xpointer="v247"/>
1390 </listitem>
1391 </varlistentry>
1392
1393 <varlistentry>
1394 <term><varname>ManagedOOMMemoryPressureLimit=</varname></term>
1395
1396 <listitem>
1397 <para>Overrides the default memory pressure limit set by
1398 <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1399 this unit (cgroup). Takes a percentage value between 0% and 100%, inclusive. This property is
1400 ignored unless <varname>ManagedOOMMemoryPressure=</varname><option>kill</option>. Defaults to 0%,
1401 which means to use the default set by
1402 <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1403 </para>
1404
1405 <xi:include href="version-info.xml" xpointer="v247"/>
1406 </listitem>
1407 </varlistentry>
1408
1409 <varlistentry>
1410 <term><varname>ManagedOOMPreference=none|avoid|omit</varname></term>
1411
1412 <listitem>
1413 <para>Allows deprioritizing or omitting this unit's cgroup as a candidate when
1414 <command>systemd-oomd</command> needs to act. Requires support for extended attributes (see
1415 <citerefentry project='man-pages'><refentrytitle>xattr</refentrytitle><manvolnum>7</manvolnum></citerefentry>)
1416 in order to use <option>avoid</option> or <option>omit</option>.</para>
1417
1418 <para>When calculating candidates to relieve swap usage, <command>systemd-oomd</command> will
1419 only respect these extended attributes if the unit's cgroup is owned by root.</para>
1420
1421 <para>When calculating candidates to relieve memory pressure, <command>systemd-oomd</command>
1422 will only respect these extended attributes if the unit's cgroup is owned by root, or if the
1423 unit's cgroup owner, and the owner of the monitored ancestor cgroup are the same. For example,
1424 if <command>systemd-oomd</command> is calculating candidates for <filename>-.slice</filename>,
1425 then extended attributes set on descendants of <filename>/user.slice/user-1000.slice/user@1000.service/</filename>
1426 will be ignored because the descendants are owned by UID 1000, and <filename>-.slice</filename>
1427 is owned by UID 0. But, if calculating candidates for
1428 <filename>/user.slice/user-1000.slice/user@1000.service/</filename>, then extended attributes set
1429 on the descendants would be respected.</para>
1430
1431 <para>If this property is set to <option>avoid</option>, the service manager will convey this to
1432 <command>systemd-oomd</command>, which will only select this cgroup if there are no other viable
1433 candidates.</para>
1434
1435 <para>If this property is set to <option>omit</option>, the service manager will convey this to
1436 <command>systemd-oomd</command>, which will ignore this cgroup as a candidate and will not perform
1437 any actions on it.</para>
1438
1439 <para>It is recommended to use <option>avoid</option> and <option>omit</option> sparingly, as it
1440 can adversely affect <command>systemd-oomd</command>'s kill behavior. Also note that these extended
1441 attributes are not applied recursively to cgroups under this unit's cgroup.</para>
1442
1443 <para>Defaults to <option>none</option> which means <command>systemd-oomd</command> will rank this
1444 unit's cgroup as defined in
1445 <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1446 and <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1447 </para>
1448
1449 <xi:include href="version-info.xml" xpointer="v248"/>
1450 </listitem>
1451 </varlistentry>
1452
1453 <varlistentry>
1454 <term><varname>MemoryPressureWatch=</varname></term>
1455
1456 <listitem><para>Controls memory pressure monitoring for invoked processes. Takes one of
1457 <literal>off</literal>, <literal>on</literal>, <literal>auto</literal> or <literal>skip</literal>. If
1458 <literal>off</literal> tells the service not to watch for memory pressure events, by setting the
1459 <varname>$MEMORY_PRESSURE_WATCH</varname> environment variable to the literal string
1460 <filename>/dev/null</filename>. If <literal>on</literal> tells the service to watch for memory
1461 pressure events. This enables memory accounting for the service, and ensures the
1462 <filename>memory.pressure</filename> cgroup attribute files is accessible for read and write to the
1463 service's user. It then sets the <varname>$MEMORY_PRESSURE_WATCH</varname> environment variable for
1464 processes invoked by the unit to the file system path to this file. The threshold information
1465 configured with <varname>MemoryPressureThresholdSec=</varname> is encoded in the
1466 <varname>$MEMORY_PRESSURE_WRITE</varname> environment variable. If the <literal>auto</literal> value
1467 is set the protocol is enabled if memory accounting is anyway enabled for the unit, and disabled
1468 otherwise. If set to <literal>skip</literal> the logic is neither enabled, nor disabled and the two
1469 environment variables are not set.</para>
1470
1471 <para>Note that services are free to use the two environment variables, but it's unproblematic if
1472 they ignore them. Memory pressure handling must be implemented individually in each service, and
1473 usually means different things for different software. For further details on memory pressure
1474 handling see <ulink url="https://systemd.io/MEMORY_PRESSURE">Memory Pressure Handling in
1475 systemd</ulink>.</para>
1476
1477 <para>Services implemented using
1478 <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry> may use
1479 <citerefentry><refentrytitle>sd_event_add_memory_pressure</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1480 to watch for and handle memory pressure events.</para>
1481
1482 <para>If not explicit set, defaults to the <varname>DefaultMemoryPressureWatch=</varname> setting in
1483 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1484
1485 <xi:include href="version-info.xml" xpointer="v254"/></listitem>
1486 </varlistentry>
1487
1488 <varlistentry>
1489 <term><varname>MemoryPressureThresholdSec=</varname></term>
1490
1491 <listitem><para>Sets the memory pressure threshold time for memory pressure monitor as configured via
1492 <varname>MemoryPressureWatch=</varname>. Specifies the maximum allocation latency before a memory
1493 pressure event is signalled to the service, per 2s window. If not specified defaults to the
1494 <varname>DefaultMemoryPressureThresholdSec=</varname> setting in
1495 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1496 (which in turn defaults to 200ms). The specified value expects a time unit such as
1497 <literal>ms</literal> or <literal>μs</literal>, see
1498 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
1499 details on the permitted syntax.</para>
1500
1501 <xi:include href="version-info.xml" xpointer="v254"/></listitem>
1502 </varlistentry>
1503 </variablelist>
1504 </refsect2>
1505 </refsect1>
1506
1507 <refsect1>
1508 <title>History</title>
1509
1510 <variablelist>
1511 <varlistentry>
1512 <term>systemd 252</term>
1513 <listitem><para> Options for controlling the Legacy Control Group Hierarchy (<ulink
1514 url="https://docs.kernel.org/admin-guide/cgroup-v1/index.html">Control Groups version 1</ulink>)
1515 are now fully deprecated:
1516 <varname>CPUShares=<replaceable>weight</replaceable></varname>,
1517 <varname>StartupCPUShares=<replaceable>weight</replaceable></varname>,
1518 <varname>MemoryLimit=<replaceable>bytes</replaceable></varname>,
1519 <varname>BlockIOAccounting=</varname>,
1520 <varname>BlockIOWeight=<replaceable>weight</replaceable></varname>,
1521 <varname>StartupBlockIOWeight=<replaceable>weight</replaceable></varname>,
1522 <varname>BlockIODeviceWeight=<replaceable>device</replaceable>
1523 <replaceable>weight</replaceable></varname>,
1524 <varname>BlockIOReadBandwidth=<replaceable>device</replaceable>
1525 <replaceable>bytes</replaceable></varname>,
1526 <varname>BlockIOWriteBandwidth=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname>.
1527 Please switch to the unified cgroup hierarchy.</para>
1528
1529 <xi:include href="version-info.xml" xpointer="v252"/></listitem>
1530 </varlistentry>
1531 </variablelist>
1532 </refsect1>
1533
1534 <refsect1>
1535 <title>See Also</title>
1536 <para>
1537 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1538 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1539 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1540 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1541 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1542 <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1543 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1544 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1545 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1546 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1547 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1548 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1549 <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
1550 The documentation for control groups and specific controllers in the Linux kernel:
1551 <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html">Control Groups v2</ulink>.
1552 </para>
1553 </refsect1>
1554 </refentry>