]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.resource-control.xml
7daaba5074a7774f411624cda7ff1256cef0f7b8
[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+ -->
5
6 <refentry id="systemd.resource-control">
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 <para>See the <ulink
63 url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface/">New
64 Control Group Interfaces</ulink> for an introduction on how to make
65 use of resource control APIs from programs.</para>
66 </refsect1>
67
68 <refsect1>
69 <title>Implicit Dependencies</title>
70
71 <para>The following dependencies are implicitly added:</para>
72
73 <itemizedlist>
74 <listitem><para>Units with the <varname>Slice=</varname> setting set automatically acquire
75 <varname>Requires=</varname> and <varname>After=</varname> dependencies on the specified
76 slice unit.</para></listitem>
77 </itemizedlist>
78 </refsect1>
79
80 <!-- We don't have any default dependency here. -->
81
82 <refsect1>
83 <title>Unified and Legacy Control Group Hierarchies</title>
84
85 <para>The unified control group hierarchy is the new version of kernel control group interface, see <ulink
86 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>. Depending on the resource type,
87 there are differences in resource control capabilities. Also, because of interface changes, some resource types
88 have separate set of options on the unified hierarchy.</para>
89
90 <para>
91 <variablelist>
92
93 <varlistentry>
94 <term><option>CPU</option></term>
95 <listitem>
96 <para><varname>CPUWeight=</varname> and <varname>StartupCPUWeight=</varname> replace
97 <varname>CPUShares=</varname> and <varname>StartupCPUShares=</varname>, respectively.</para>
98
99 <para>The <literal>cpuacct</literal> controller does not exist separately on the unified hierarchy.</para>
100 </listitem>
101 </varlistentry>
102
103 <varlistentry>
104 <term><option>Memory</option></term>
105 <listitem>
106 <para><varname>MemoryMax=</varname> replaces <varname>MemoryLimit=</varname>. <varname>MemoryLow=</varname>
107 and <varname>MemoryHigh=</varname> are effective only on unified hierarchy.</para>
108 </listitem>
109 </varlistentry>
110
111 <varlistentry>
112 <term><option>IO</option></term>
113 <listitem>
114 <para><varname>IO</varname> prefixed settings are a superset of and replace <varname>BlockIO</varname>
115 prefixed ones. On unified hierarchy, IO resource control also applies to buffered writes.</para>
116 </listitem>
117 </varlistentry>
118
119 </variablelist>
120 </para>
121
122 <para>To ease the transition, there is best-effort translation between the two versions of settings. For each
123 controller, if any of the settings for the unified hierarchy are present, all settings for the legacy hierarchy are
124 ignored. If the resulting settings are for the other type of hierarchy, the configurations are translated before
125 application.</para>
126
127 <para>Legacy control group hierarchy (see <ulink
128 url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>), also called cgroup-v1,
129 doesn't allow safe delegation of controllers to unprivileged processes. If the system uses the legacy control group
130 hierarchy, resource control is disabled for systemd user instance, see
131 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
132 </para>
133 </refsect1>
134
135 <refsect1>
136 <title>Options</title>
137
138 <para>Units of the types listed above can have settings
139 for resource control configuration:</para>
140
141 <variablelist class='unit-directives'>
142
143 <varlistentry>
144 <term><varname>CPUAccounting=</varname></term>
145
146 <listitem>
147 <para>Turn on CPU usage accounting for this unit. Takes a
148 boolean argument. Note that turning on CPU accounting for
149 one unit will also implicitly turn it on for all units
150 contained in the same slice and for all its parent slices
151 and the units contained therein. The system default for this
152 setting may be controlled with
153 <varname>DefaultCPUAccounting=</varname> in
154 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
155 </listitem>
156 </varlistentry>
157
158 <varlistentry>
159 <term><varname>CPUWeight=<replaceable>weight</replaceable></varname></term>
160 <term><varname>StartupCPUWeight=<replaceable>weight</replaceable></varname></term>
161
162 <listitem>
163 <para>Assign the specified CPU time weight to the processes executed, if the unified control group hierarchy
164 is used on the system. These options take an integer value and control the <literal>cpu.weight</literal>
165 control group attribute. The allowed range is 1 to 10000. Defaults to 100. For details about this control
166 group attribute, see <ulink
167 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink> and <ulink
168 url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.
169 The available CPU time is split up among all units within one slice relative to their CPU time weight.</para>
170
171 <para>While <varname>StartupCPUWeight=</varname> only applies to the startup phase of the system,
172 <varname>CPUWeight=</varname> applies to normal runtime of the system, and if the former is not set also to
173 the startup phase. Using <varname>StartupCPUWeight=</varname> allows prioritizing specific services at
174 boot-up differently than during normal runtime.</para>
175
176 <para>These settings replace <varname>CPUShares=</varname> and <varname>StartupCPUShares=</varname>.</para>
177 </listitem>
178 </varlistentry>
179
180 <varlistentry>
181 <term><varname>CPUQuota=</varname></term>
182
183 <listitem>
184 <para>Assign the specified CPU time quota to the processes executed. Takes a percentage value, suffixed with
185 "%". The percentage specifies how much CPU time the unit shall get at maximum, relative to the total CPU time
186 available on one CPU. Use values &gt; 100% for allotting CPU time on more than one CPU. This controls the
187 <literal>cpu.max</literal> attribute on the unified control group hierarchy and
188 <literal>cpu.cfs_quota_us</literal> on legacy. For details about these control group attributes, see <ulink
189 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink> and <ulink
190 url="https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt">sched-bwc.txt</ulink>.</para>
191
192 <para>Example: <varname>CPUQuota=20%</varname> ensures that the executed processes will never get more than
193 20% CPU time on one CPU.</para>
194
195 </listitem>
196 </varlistentry>
197
198 <varlistentry>
199 <term><varname>CPUQuotaPeriodSec=</varname></term>
200
201 <listitem>
202 <para>Assign the duration over which the CPU time quota specified by <varname>CPUQuota=</varname> is measured.
203 Takes a time duration value in seconds, with an optional suffix such as "ms" for milliseconds (or "s" for seconds.)
204 The default setting is 100ms. The period is clamped to the range supported by the kernel, which is [1ms, 1000ms].
205 Additionally, the period is adjusted up so that the quota interval is also at least 1ms.
206 Setting <varname>CPUQuotaPeriodSec=</varname> to an empty value resets it to the default.</para>
207
208 <para>This controls the second field of <literal>cpu.max</literal> attribute on the unified control group hierarchy
209 and <literal>cpu.cfs_period_us</literal> on legacy. For details about these control group attributes, see
210 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink> and
211 <ulink url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.</para>
212
213 <para>Example: <varname>CPUQuotaPeriodSec=10ms</varname> to request that the CPU quota is measured in periods of 10ms.</para>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry>
218 <term><varname>AllowedCPUs=</varname></term>
219
220 <listitem>
221 <para>Restrict processes to be executed on specific CPUs. Takes a list of CPU indices or ranges separated by either
222 whitespace or commas. CPU ranges are specified by the lower and upper CPU indices separated by a dash.</para>
223
224 <para>Setting <varname>AllowedCPUs=</varname> doesn't guarantee that all of the CPUs will be used by the processes
225 as it may be limited by parent units. The effective configuration is reported as <varname>EffectiveCPUs=</varname>.</para>
226
227 <para>This setting is supported only with the unified control group hierarchy.</para>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry>
232 <term><varname>AllowedMemoryNodes=</varname></term>
233
234 <listitem>
235 <para>Restrict processes to be executed on specific memory NUMA nodes. Takes a list of memory NUMA nodes indices
236 or ranges separated by either whitespace or commas. Memory NUMA nodes ranges are specified by the lower and upper
237 CPU indices separated by a dash.</para>
238
239 <para>Setting <varname>AllowedMemoryNodes=</varname> doesn't guarantee that all of the memory NUMA nodes will
240 be used by the processes as it may be limited by parent units. The effective configuration is reported as
241 <varname>EffectiveMemoryNodes=</varname>.</para>
242
243 <para>This setting is supported only with the unified control group hierarchy.</para>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry>
248 <term><varname>MemoryAccounting=</varname></term>
249
250 <listitem>
251 <para>Turn on process and kernel memory accounting for this
252 unit. Takes a boolean argument. Note that turning on memory
253 accounting for one unit will also implicitly turn it on for
254 all units contained in the same slice and for all its parent
255 slices and the units contained therein. The system default
256 for this setting may be controlled with
257 <varname>DefaultMemoryAccounting=</varname> in
258 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry>
263 <term><varname>MemoryMin=<replaceable>bytes</replaceable></varname></term>
264
265 <listitem>
266 <para>Specify the memory usage protection of the executed processes in this unit. If the memory usages of
267 this unit and all its ancestors are below their minimum boundaries, this unit's memory won't be reclaimed.</para>
268
269 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
270 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
271 percentage value may be specified, which is taken relative to the installed physical memory on the
272 system. If assigned the special value <literal>infinity</literal>, all available memory is protected, which may be
273 useful in order to always inherit all of the protection afforded by ancestors.
274 This controls the <literal>memory.min</literal> control group attribute. For details about this
275 control group attribute, see <ulink
276 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
277
278 <para>This setting is supported only if the unified control group hierarchy is used and disables
279 <varname>MemoryLimit=</varname>.</para>
280
281 <para>Units may have their children use a default <literal>memory.min</literal> value by specifying
282 <varname>DefaultMemoryMin=</varname>, which has the same semantics as <varname>MemoryMin=</varname>. This setting
283 does not affect <literal>memory.min</literal> in the unit itself.</para>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry>
288 <term><varname>MemoryLow=<replaceable>bytes</replaceable></varname></term>
289
290 <listitem>
291 <para>Specify the best-effort memory usage protection of the executed processes in this unit. If the memory
292 usages of this unit and all its ancestors are below their low boundaries, this unit's memory won't be
293 reclaimed as long as memory can be reclaimed from unprotected units.</para>
294
295 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
296 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
297 percentage value may be specified, which is taken relative to the installed physical memory on the
298 system. If assigned the special value <literal>infinity</literal>, all available memory is protected, which may be
299 useful in order to always inherit all of the protection afforded by ancestors.
300 This controls the <literal>memory.low</literal> control group attribute. For details about this
301 control group attribute, see <ulink
302 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
303
304 <para>This setting is supported only if the unified control group hierarchy is used and disables
305 <varname>MemoryLimit=</varname>.</para>
306
307 <para>Units may have their children use a default <literal>memory.low</literal> value by specifying
308 <varname>DefaultMemoryLow=</varname>, which has the same semantics as <varname>MemoryLow=</varname>. This setting
309 does not affect <literal>memory.low</literal> in the unit itself.</para>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry>
314 <term><varname>MemoryHigh=<replaceable>bytes</replaceable></varname></term>
315
316 <listitem>
317 <para>Specify the throttling limit on memory usage of the executed processes in this unit. Memory usage may go
318 above the limit if unavoidable, but the processes are heavily slowed down and memory is taken away
319 aggressively in such cases. This is the main mechanism to control memory usage of a unit.</para>
320
321 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
322 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
323 percentage value may be specified, which is taken relative to the installed physical memory on the
324 system. If assigned the
325 special value <literal>infinity</literal>, no memory throttling is applied. This controls the
326 <literal>memory.high</literal> control group attribute. For details about this control group attribute, see
327 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
328
329 <para>This setting is supported only if the unified control group hierarchy is used and disables
330 <varname>MemoryLimit=</varname>.</para>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry>
335 <term><varname>MemoryMax=<replaceable>bytes</replaceable></varname></term>
336
337 <listitem>
338 <para>Specify the absolute limit on memory usage of the executed processes in this unit. If memory usage
339 cannot be contained under the limit, out-of-memory killer is invoked inside the unit. It is recommended to
340 use <varname>MemoryHigh=</varname> as the main control mechanism and use <varname>MemoryMax=</varname> as the
341 last line of defense.</para>
342
343 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
344 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
345 percentage value may be specified, which is taken relative to the installed physical memory on the system. If
346 assigned the special value <literal>infinity</literal>, no memory limit is applied. This controls the
347 <literal>memory.max</literal> control group attribute. For details about this control group attribute, see
348 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
349
350 <para>This setting replaces <varname>MemoryLimit=</varname>.</para>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry>
355 <term><varname>MemorySwapMax=<replaceable>bytes</replaceable></varname></term>
356
357 <listitem>
358 <para>Specify the absolute limit on swap usage of the executed processes in this unit.</para>
359
360 <para>Takes a swap size in bytes. If the value is suffixed with K, M, G or T, the specified swap size is
361 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. If assigned the
362 special value <literal>infinity</literal>, no swap limit is applied. This controls the
363 <literal>memory.swap.max</literal> control group attribute. For details about this control group attribute,
364 see <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
365
366 <para>This setting is supported only if the unified control group hierarchy is used and disables
367 <varname>MemoryLimit=</varname>.</para>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry>
372 <term><varname>TasksAccounting=</varname></term>
373
374 <listitem>
375 <para>Turn on task accounting for this unit. Takes a
376 boolean argument. If enabled, the system manager will keep
377 track of the number of tasks in the unit. The number of
378 tasks accounted this way includes both kernel threads and
379 userspace processes, with each thread counting
380 individually. Note that turning on tasks accounting for one
381 unit will also implicitly turn it on for all units contained
382 in the same slice and for all its parent slices and the
383 units contained therein. The system default for this setting
384 may be controlled with
385 <varname>DefaultTasksAccounting=</varname> in
386 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry>
391 <term><varname>TasksMax=<replaceable>N</replaceable></varname></term>
392
393 <listitem>
394 <para>Specify the maximum number of tasks that may be created in the unit. This ensures that the number of
395 tasks accounted for the unit (see above) stays below a specific limit. This either takes an absolute number
396 of tasks or a percentage value that is taken relative to the configured maximum number of tasks on the
397 system. If assigned the special value <literal>infinity</literal>, no tasks limit is applied. This controls
398 the <literal>pids.max</literal> control group attribute. For details about this control group attribute, see
399 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/pids.txt">pids.txt</ulink>.</para>
400
401 <para>The
402 system default for this setting may be controlled with
403 <varname>DefaultTasksMax=</varname> in
404 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry>
409 <term><varname>IOAccounting=</varname></term>
410
411 <listitem>
412 <para>Turn on Block I/O accounting for this unit, if the unified control group hierarchy is used on the
413 system. Takes a boolean argument. Note that turning on block I/O accounting for one unit will also implicitly
414 turn it on for all units contained in the same slice and all for its parent slices and the units contained
415 therein. The system default for this setting may be controlled with <varname>DefaultIOAccounting=</varname>
416 in
417 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
418
419 <para>This setting replaces <varname>BlockIOAccounting=</varname> and disables settings prefixed with
420 <varname>BlockIO</varname> or <varname>StartupBlockIO</varname>.</para>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry>
425 <term><varname>IOWeight=<replaceable>weight</replaceable></varname></term>
426 <term><varname>StartupIOWeight=<replaceable>weight</replaceable></varname></term>
427
428 <listitem>
429 <para>Set the default overall block I/O weight for the executed processes, if the unified control group
430 hierarchy is used on the system. Takes a single weight value (between 1 and 10000) to set the default block
431 I/O weight. This controls the <literal>io.weight</literal> control group attribute, which defaults to
432 100. For details about this control group attribute, see <ulink
433 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>. The available I/O
434 bandwidth is split up among all units within one slice relative to their block I/O weight.</para>
435
436 <para>While <varname>StartupIOWeight=</varname> only applies
437 to the startup phase of the system,
438 <varname>IOWeight=</varname> applies to the later runtime of
439 the system, and if the former is not set also to the startup
440 phase. This allows prioritizing specific services at boot-up
441 differently than during runtime.</para>
442
443 <para>These settings replace <varname>BlockIOWeight=</varname> and <varname>StartupBlockIOWeight=</varname>
444 and disable settings prefixed with <varname>BlockIO</varname> or <varname>StartupBlockIO</varname>.</para>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry>
449 <term><varname>IODeviceWeight=<replaceable>device</replaceable> <replaceable>weight</replaceable></varname></term>
450
451 <listitem>
452 <para>Set the per-device overall block I/O weight for the executed processes, if the unified control group
453 hierarchy is used on the system. Takes a space-separated pair of a file path and a weight value to specify
454 the device specific weight value, between 1 and 10000. (Example: <literal>/dev/sda 1000</literal>). The file
455 path may be specified as path to a block device node or as any other file, in which case the backing block
456 device of the file system of the file is determined. This controls the <literal>io.weight</literal> control
457 group attribute, which defaults to 100. Use this option multiple times to set weights for multiple devices.
458 For details about this control group attribute, see <ulink
459 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
460
461 <para>This setting replaces <varname>BlockIODeviceWeight=</varname> and disables settings prefixed with
462 <varname>BlockIO</varname> or <varname>StartupBlockIO</varname>.</para>
463 </listitem>
464 </varlistentry>
465
466 <varlistentry>
467 <term><varname>IOReadBandwidthMax=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
468 <term><varname>IOWriteBandwidthMax=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
469
470 <listitem>
471 <para>Set the per-device overall block I/O bandwidth maximum limit for the executed processes, if the unified
472 control group hierarchy is used on the system. This limit is not work-conserving and the executed processes
473 are not allowed to use more even if the device has idle capacity. Takes a space-separated pair of a file
474 path and a bandwidth value (in bytes per second) to specify the device specific bandwidth. The file path may
475 be a path to a block device node, or as any other file in which case the backing block device of the file
476 system of the file is used. If the bandwidth is suffixed with K, M, G, or T, the specified bandwidth is
477 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes, respectively, to the base of 1000. (Example:
478 "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This controls the <literal>io.max</literal> control
479 group attributes. Use this option multiple times to set bandwidth limits for multiple devices. For details
480 about this control group attribute, see <ulink
481 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.
482 </para>
483
484 <para>These settings replace <varname>BlockIOReadBandwidth=</varname> and
485 <varname>BlockIOWriteBandwidth=</varname> and disable settings prefixed with <varname>BlockIO</varname> or
486 <varname>StartupBlockIO</varname>.</para>
487 </listitem>
488 </varlistentry>
489
490 <varlistentry>
491 <term><varname>IOReadIOPSMax=<replaceable>device</replaceable> <replaceable>IOPS</replaceable></varname></term>
492 <term><varname>IOWriteIOPSMax=<replaceable>device</replaceable> <replaceable>IOPS</replaceable></varname></term>
493
494 <listitem>
495 <para>Set the per-device overall block I/O IOs-Per-Second maximum limit for the executed processes, if the
496 unified control group hierarchy is used on the system. This limit is not work-conserving and the executed
497 processes are not allowed to use more even if the device has idle capacity. Takes a space-separated pair of
498 a file path and an IOPS value to specify the device specific IOPS. The file path may be a path to a block
499 device node, or as any other file in which case the backing block device of the file system of the file is
500 used. If the IOPS is suffixed with K, M, G, or T, the specified IOPS is parsed as KiloIOPS, MegaIOPS,
501 GigaIOPS, or TeraIOPS, respectively, to the base of 1000. (Example:
502 "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 1K"). This controls the <literal>io.max</literal> control
503 group attributes. Use this option multiple times to set IOPS limits for multiple devices. For details about
504 this control group attribute, see <ulink
505 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.
506 </para>
507
508 <para>These settings are supported only if the unified control group hierarchy is used and disable settings
509 prefixed with <varname>BlockIO</varname> or <varname>StartupBlockIO</varname>.</para>
510 </listitem>
511 </varlistentry>
512
513 <varlistentry>
514 <term><varname>IODeviceLatencyTargetSec=<replaceable>device</replaceable> <replaceable>target</replaceable></varname></term>
515
516 <listitem>
517 <para>Set the per-device average target I/O latency for the executed processes, if the unified control group
518 hierarchy is used on the system. Takes a file path and a timespan separated by a space to specify
519 the device specific latency target. (Example: "/dev/sda 25ms"). The file path may be specified
520 as path to a block device node or as any other file, in which case the backing block device of the file
521 system of the file is determined. This controls the <literal>io.latency</literal> control group
522 attribute. Use this option multiple times to set latency target for multiple devices. For details about this
523 control group attribute, see <ulink
524 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
525
526 <para>Implies <literal>IOAccounting=yes</literal>.</para>
527
528 <para>These settings are supported only if the unified control group hierarchy is used.</para>
529 </listitem>
530 </varlistentry>
531
532 <varlistentry>
533 <term><varname>IPAccounting=</varname></term>
534
535 <listitem>
536 <para>Takes a boolean argument. If true, turns on IPv4 and IPv6 network traffic accounting for packets sent
537 or received by the unit. When this option is turned on, all IPv4 and IPv6 sockets created by any process of
538 the unit are accounted for.</para>
539
540 <para>When this option is used in socket units, it applies to all IPv4 and IPv6 sockets
541 associated with it (including both listening and connection sockets where this applies). Note that for
542 socket-activated services, this configuration setting and the accounting data of the service unit and the
543 socket unit are kept separate, and displayed separately. No propagation of the setting and the collected
544 statistics is done, in either direction. Moreover, any traffic sent or received on any of the socket unit's
545 sockets is accounted to the socket unit — and never to the service unit it might have activated, even if the
546 socket is used by it.</para>
547
548 <para>The system default for this setting may be controlled with <varname>DefaultIPAccounting=</varname> in
549 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
550 </listitem>
551 </varlistentry>
552
553 <varlistentry>
554 <term><varname>IPAddressAllow=<replaceable>ADDRESS[/PREFIXLENGTH]…</replaceable></varname></term>
555 <term><varname>IPAddressDeny=<replaceable>ADDRESS[/PREFIXLENGTH]…</replaceable></varname></term>
556
557 <listitem>
558 <para>Turn on address range network traffic filtering for IP packets sent and received over
559 <constant>AF_INET</constant> and <constant>AF_INET6</constant> sockets. Both directives take a
560 space separated list of IPv4 or IPv6 addresses, each optionally suffixed with an address prefix
561 length in bits (separated by a <literal>/</literal> character). If the latter is omitted, the
562 address is considered a host address, i.e. the prefix covers the whole address (32 for IPv4, 128
563 for IPv6).</para>
564
565 <para>The access lists configured with this option are applied to all sockets created by processes
566 of this unit (or in the case of socket units, associated with it). The lists are implicitly
567 combined with any lists configured for any of the parent slice units this unit might be a member
568 of. By default all access lists are empty. Both ingress and egress traffic is filtered by these
569 settings. In case of ingress traffic the source IP address is checked against these access lists,
570 in case of egress traffic the destination IP address is checked. When configured the lists are
571 enforced as follows:</para>
572
573 <itemizedlist>
574 <listitem><para>Access will be granted in case an IP packet's destination/source address matches
575 any entry in the <varname>IPAddressAllow=</varname> setting.</para></listitem>
576
577 <listitem><para>Otherwise, access will be denied in case its destination/source address matches
578 any entry in the <varname>IPAddressDeny=</varname> setting.</para></listitem>
579
580 <listitem><para>Otherwise, access will be granted.</para></listitem>
581 </itemizedlist>
582
583 <para>In order to implement a whitelisting IP firewall, it is recommended to use a
584 <varname>IPAddressDeny=</varname><constant>any</constant> setting on an upper-level slice unit (such as the
585 root slice <filename>-.slice</filename> or the slice containing all system services
586 <filename>system.slice</filename> – see
587 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
588 details on these slice units), plus individual per-service <varname>IPAddressAllow=</varname> lines
589 permitting network access to relevant services, and only them.</para>
590
591 <para>Note that for socket-activated services, the IP access list configured on the socket unit applies to
592 all sockets associated with it directly, but not to any sockets created by the ultimately activated services
593 for it. Conversely, the IP access list configured for the service is not applied to any sockets passed into
594 the service via socket activation. Thus, it is usually a good idea, to replicate the IP access lists on both
595 the socket and the service unit, however it often makes sense to maintain one list more open and the other
596 one more restricted, depending on the usecase.</para>
597
598 <para>If these settings are used multiple times in the same unit the specified lists are combined. If an
599 empty string is assigned to these settings the specific access list is reset and all previous settings undone.</para>
600
601 <para>In place of explicit IPv4 or IPv6 address and prefix length specifications a small set of symbolic
602 names may be used. The following names are defined:</para>
603
604 <table>
605 <title>Special address/network names</title>
606
607 <tgroup cols='3'>
608 <colspec colname='name'/>
609 <colspec colname='definition'/>
610 <colspec colname='meaning'/>
611
612 <thead>
613 <row>
614 <entry>Symbolic Name</entry>
615 <entry>Definition</entry>
616 <entry>Meaning</entry>
617 </row>
618 </thead>
619
620 <tbody>
621 <row>
622 <entry><constant>any</constant></entry>
623 <entry>0.0.0.0/0 ::/0</entry>
624 <entry>Any host</entry>
625 </row>
626
627 <row>
628 <entry><constant>localhost</constant></entry>
629 <entry>127.0.0.0/8 ::1/128</entry>
630 <entry>All addresses on the local loopback</entry>
631 </row>
632
633 <row>
634 <entry><constant>link-local</constant></entry>
635 <entry>169.254.0.0/16 fe80::/64</entry>
636 <entry>All link-local IP addresses</entry>
637 </row>
638
639 <row>
640 <entry><constant>multicast</constant></entry>
641 <entry>224.0.0.0/4 ff00::/8</entry>
642 <entry>All IP multicasting addresses</entry>
643 </row>
644 </tbody>
645 </tgroup>
646 </table>
647
648 <para>Note that these settings might not be supported on some systems (for example if eBPF control group
649 support is not enabled in the underlying kernel or container manager). These settings will have no effect in
650 that case. If compatibility with such systems is desired it is hence recommended to not exclusively rely on
651 them for IP security.</para>
652 </listitem>
653 </varlistentry>
654
655 <varlistentry>
656 <term><varname>IPIngressFilterPath=<replaceable>BPF_FS_PROGRAMM_PATH</replaceable></varname></term>
657 <term><varname>IPEgressFilterPath=<replaceable>BPF_FS_PROGRAMM_PATH</replaceable></varname></term>
658
659 <listitem>
660 <para>Add custom network traffic filters implemented as BPF programs, applying to all IP packets
661 sent and received over <constant>AF_INET</constant> and <constant>AF_INET6</constant> sockets.
662 Takes an absolute path to a pinned BPF program in the BPF virtual filesystem (<filename>/sys/fs/bpf/</filename>).
663 </para>
664
665 <para>The filters configured with this option are applied to all sockets created by processes
666 of this unit (or in the case of socket units, associated with it). The filters are loaded in addition
667 to filters any of the parent slice units this unit might be a member of as well as any
668 <varname>IPAddressAllow=</varname> and <varname>IPAddressDeny=</varname> filters in any of these units.
669 By default there are no filters specified.</para>
670
671 <para>If these settings are used multiple times in the same unit all the specified programs are attached. If an
672 empty string is assigned to these settings the program list is reset and all previous specified programs ignored.</para>
673
674 <para>Note that for socket-activated services, the IP filter programs configured on the socket unit apply to
675 all sockets associated with it directly, but not to any sockets created by the ultimately activated services
676 for it. Conversely, the IP filter programs configured for the service are not applied to any sockets passed into
677 the service via socket activation. Thus, it is usually a good idea, to replicate the IP filter programs on both
678 the socket and the service unit, however it often makes sense to maintain one configuration more open and the other
679 one more restricted, depending on the usecase.</para>
680
681 <para>Note that these settings might not be supported on some systems (for example if eBPF control group
682 support is not enabled in the underlying kernel or container manager). These settings will fail the service in
683 that case. If compatibility with such systems is desired it is hence recommended to attach your filter manually
684 (requires <varname>Delegate=</varname><constant>yes</constant>) instead of using this setting.</para>
685 </listitem>
686 </varlistentry>
687
688 <varlistentry>
689 <term><varname>DeviceAllow=</varname></term>
690
691 <listitem>
692 <para>Control access to specific device nodes by the executed processes. Takes two space-separated
693 strings: a device node specifier followed by a combination of <constant>r</constant>,
694 <constant>w</constant>, <constant>m</constant> to control <emphasis>r</emphasis>eading,
695 <emphasis>w</emphasis>riting, or creation of the specific device node(s) by the unit
696 (<emphasis>m</emphasis>knod), respectively. On cgroup-v1 this controls the
697 <literal>devices.allow</literal> control group attribute. For details about this control group
698 attribute, see <ulink
699 url="https://www.kernel.org/doc/Documentation/cgroup-v1/devices.txt">devices.txt</ulink>. On
700 cgroup-v2 this functionality is implemented using eBPF filtering.</para>
701
702 <para>The device node specifier is either a path to a device node in the file system, starting with
703 <filename>/dev/</filename>, or a string starting with either <literal>char-</literal> or
704 <literal>block-</literal> followed by a device group name, as listed in
705 <filename>/proc/devices</filename>. The latter is useful to whitelist all current and future
706 devices belonging to a specific device group at once. The device group is matched according to
707 filename globbing rules, you may hence use the <literal>*</literal> and <literal>?</literal>
708 wildcards. (Note that such globbing wildcards are not available for device node path
709 specifications!) In order to match device nodes by numeric major/minor, use device node paths in
710 the <filename>/dev/char/</filename> and <filename>/dev/block/</filename> directories. However,
711 matching devices by major/minor is generally not recommended as assignments are neither stable nor
712 portable between systems or different kernel versions.</para>
713
714 <para>Examples: <filename>/dev/sda5</filename> is a path to a device node, referring to an ATA or
715 SCSI block device. <literal>char-pts</literal> and <literal>char-alsa</literal> are specifiers for
716 all pseudo TTYs and all ALSA sound devices, respectively. <literal>char-cpu/*</literal> is a
717 specifier matching all CPU related device groups.</para>
718
719 <para>Note that whitelists defined this way should only reference device groups which are
720 resolvable at the time the unit is started. Any device groups not resolvable then are not added to
721 the device whitelist. In order to work around this limitation, consider extending service units
722 with an <command>ExecStartPre=/sbin/modprobe…</command> line that loads the necessary
723 kernel module implementing the device group if missing. Example: <programlisting>…
724 [Service]
725 ExecStartPre=-/sbin/modprobe -abq loop
726 DeviceAllow=block-loop
727 DeviceAllow=/dev/loop-control
728 …</programlisting></para>
729
730 </listitem>
731 </varlistentry>
732
733 <varlistentry>
734 <term><varname>DevicePolicy=auto|closed|strict</varname></term>
735
736 <listitem>
737 <para>
738 Control the policy for allowing device access:
739 </para>
740 <variablelist>
741 <varlistentry>
742 <term><option>strict</option></term>
743 <listitem>
744 <para>means to only allow types of access that are
745 explicitly specified.</para>
746 </listitem>
747 </varlistentry>
748
749 <varlistentry>
750 <term><option>closed</option></term>
751 <listitem>
752 <para>in addition, allows access to standard pseudo
753 devices including
754 <filename>/dev/null</filename>,
755 <filename>/dev/zero</filename>,
756 <filename>/dev/full</filename>,
757 <filename>/dev/random</filename>, and
758 <filename>/dev/urandom</filename>.
759 </para>
760 </listitem>
761 </varlistentry>
762
763 <varlistentry>
764 <term><option>auto</option></term>
765 <listitem>
766 <para>
767 in addition, allows access to all devices if no
768 explicit <varname>DeviceAllow=</varname> is present.
769 This is the default.
770 </para>
771 </listitem>
772 </varlistentry>
773 </variablelist>
774 </listitem>
775 </varlistentry>
776
777 <varlistentry>
778 <term><varname>Slice=</varname></term>
779
780 <listitem>
781 <para>The name of the slice unit to place the unit
782 in. Defaults to <filename>system.slice</filename> for all
783 non-instantiated units of all unit types (except for slice
784 units themselves see below). Instance units are by default
785 placed in a subslice of <filename>system.slice</filename>
786 that is named after the template name.</para>
787
788 <para>This option may be used to arrange systemd units in a
789 hierarchy of slices each of which might have resource
790 settings applied.</para>
791
792 <para>For units of type slice, the only accepted value for
793 this setting is the parent slice. Since the name of a slice
794 unit implies the parent slice, it is hence redundant to ever
795 set this parameter directly for slice units.</para>
796
797 <para>Special care should be taken when relying on the default slice assignment in templated service units
798 that have <varname>DefaultDependencies=no</varname> set, see
799 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, section
800 "Default Dependencies" for details.</para>
801
802 </listitem>
803 </varlistentry>
804
805 <varlistentry>
806 <term><varname>Delegate=</varname></term>
807
808 <listitem>
809 <para>Turns on delegation of further resource control partitioning to processes of the unit. Units where this
810 is enabled may create and manage their own private subhierarchy of control groups below the control group of
811 the unit itself. For unprivileged services (i.e. those using the <varname>User=</varname> setting) the unit's
812 control group will be made accessible to the relevant user. When enabled the service manager will refrain
813 from manipulating control groups or moving processes below the unit's control group, so that a clear concept
814 of ownership is established: the control group tree above the unit's control group (i.e. towards the root
815 control group) is owned and managed by the service manager of the host, while the control group tree below
816 the unit's control group is owned and managed by the unit itself. Takes either a boolean argument or a list
817 of control group controller names. If true, delegation is turned on, and all supported controllers are
818 enabled for the unit, making them available to the unit's processes for management. If false, delegation is
819 turned off entirely (and no additional controllers are enabled). If set to a list of controllers, delegation
820 is turned on, and the specified controllers are enabled for the unit. Note that additional controllers than
821 the ones specified might be made available as well, depending on configuration of the containing slice unit
822 or other units contained in it. Note that assigning the empty string will enable delegation, but reset the
823 list of controllers, all assignments prior to this will have no effect. Defaults to false.</para>
824
825 <para>Note that controller delegation to less privileged code is only safe on the unified control group
826 hierarchy. Accordingly, access to the specified controllers will not be granted to unprivileged services on
827 the legacy hierarchy, even when requested.</para>
828
829 <para>The following controller names may be specified: <option>cpu</option>, <option>cpuacct</option>,
830 <option>io</option>, <option>blkio</option>, <option>memory</option>, <option>devices</option>,
831 <option>pids</option>. Not all of these controllers are available on all kernels however, and some are
832 specific to the unified hierarchy while others are specific to the legacy hierarchy. Also note that the
833 kernel might support further controllers, which aren't covered here yet as delegation is either not supported
834 at all for them or not defined cleanly.</para>
835
836 <para>For further details on the delegation model consult <ulink
837 url="https://systemd.io/CGROUP_DELEGATION">Control Group APIs and Delegation</ulink>.</para>
838 </listitem>
839 </varlistentry>
840
841 <varlistentry>
842 <term><varname>DisableControllers=</varname></term>
843
844 <listitem>
845 <para>Disables controllers from being enabled for a unit's children. If a controller listed is already in use
846 in its subtree, the controller will be removed from the subtree. This can be used to avoid child units being
847 able to implicitly or explicitly enable a controller. Defaults to not disabling any controllers.</para>
848
849 <para>It may not be possible to successfully disable a controller if the unit or any child of the unit in
850 question delegates controllers to its children, as any delegated subtree of the cgroup hierarchy is unmanaged
851 by systemd.</para>
852
853 <para>Multiple controllers may be specified, separated by spaces. You may also pass
854 <varname>DisableControllers=</varname> multiple times, in which case each new instance adds another controller
855 to disable. Passing <varname>DisableControllers=</varname> by itself with no controller name present resets
856 the disabled controller list.</para>
857
858 <para>Valid controllers are <option>cpu</option>, <option>cpuacct</option>, <option>io</option>,
859 <option>blkio</option>, <option>memory</option>, <option>devices</option>, and <option>pids</option>.</para>
860 </listitem>
861 </varlistentry>
862 </variablelist>
863 </refsect1>
864
865 <refsect1>
866 <title>Deprecated Options</title>
867
868 <para>The following options are deprecated. Use the indicated superseding options instead:</para>
869
870 <variablelist class='unit-directives'>
871
872 <varlistentry>
873 <term><varname>CPUShares=<replaceable>weight</replaceable></varname></term>
874 <term><varname>StartupCPUShares=<replaceable>weight</replaceable></varname></term>
875
876 <listitem>
877 <para>Assign the specified CPU time share weight to the processes executed. These options take an integer
878 value and control the <literal>cpu.shares</literal> control group attribute. The allowed range is 2 to
879 262144. Defaults to 1024. For details about this control group attribute, see <ulink
880 url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.
881 The available CPU time is split up among all units within one slice relative to their CPU time share
882 weight.</para>
883
884 <para>While <varname>StartupCPUShares=</varname> only applies to the startup phase of the system,
885 <varname>CPUShares=</varname> applies to normal runtime of the system, and if the former is not set also to
886 the startup phase. Using <varname>StartupCPUShares=</varname> allows prioritizing specific services at
887 boot-up differently than during normal runtime.</para>
888
889 <para>Implies <literal>CPUAccounting=yes</literal>.</para>
890
891 <para>These settings are deprecated. Use <varname>CPUWeight=</varname> and
892 <varname>StartupCPUWeight=</varname> instead.</para>
893 </listitem>
894 </varlistentry>
895
896 <varlistentry>
897 <term><varname>MemoryLimit=<replaceable>bytes</replaceable></varname></term>
898
899 <listitem>
900 <para>Specify the limit on maximum memory usage of the executed processes. The limit specifies how much
901 process and kernel memory can be used by tasks in this unit. Takes a memory size in bytes. If the value is
902 suffixed with K, M, G or T, the specified memory size is parsed as Kilobytes, Megabytes, Gigabytes, or
903 Terabytes (with the base 1024), respectively. Alternatively, a percentage value may be specified, which is
904 taken relative to the installed physical memory on the system. If assigned the special value
905 <literal>infinity</literal>, no memory limit is applied. This controls the
906 <literal>memory.limit_in_bytes</literal> control group attribute. For details about this control group
907 attribute, see <ulink
908 url="https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt">memory.txt</ulink>.</para>
909
910 <para>Implies <literal>MemoryAccounting=yes</literal>.</para>
911
912 <para>This setting is deprecated. Use <varname>MemoryMax=</varname> instead.</para>
913 </listitem>
914 </varlistentry>
915
916 <varlistentry>
917 <term><varname>BlockIOAccounting=</varname></term>
918
919 <listitem>
920 <para>Turn on Block I/O accounting for this unit, if the legacy control group hierarchy is used on the
921 system. Takes a boolean argument. Note that turning on block I/O accounting for one unit will also implicitly
922 turn it on for all units contained in the same slice and all for its parent slices and the units contained
923 therein. The system default for this setting may be controlled with
924 <varname>DefaultBlockIOAccounting=</varname> in
925 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
926
927 <para>This setting is deprecated. Use <varname>IOAccounting=</varname> instead.</para>
928 </listitem>
929 </varlistentry>
930
931 <varlistentry>
932 <term><varname>BlockIOWeight=<replaceable>weight</replaceable></varname></term>
933 <term><varname>StartupBlockIOWeight=<replaceable>weight</replaceable></varname></term>
934
935 <listitem><para>Set the default overall block I/O weight for the executed processes, if the legacy control
936 group hierarchy is used on the system. Takes a single weight value (between 10 and 1000) to set the default
937 block I/O weight. This controls the <literal>blkio.weight</literal> control group attribute, which defaults to
938 500. For details about this control group attribute, see <ulink
939 url="https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt">blkio-controller.txt</ulink>.
940 The available I/O bandwidth is split up among all units within one slice relative to their block I/O
941 weight.</para>
942
943 <para>While <varname>StartupBlockIOWeight=</varname> only
944 applies to the startup phase of the system,
945 <varname>BlockIOWeight=</varname> applies to the later runtime
946 of the system, and if the former is not set also to the
947 startup phase. This allows prioritizing specific services at
948 boot-up differently than during runtime.</para>
949
950 <para>Implies
951 <literal>BlockIOAccounting=yes</literal>.</para>
952
953 <para>These settings are deprecated. Use <varname>IOWeight=</varname> and <varname>StartupIOWeight=</varname>
954 instead.</para>
955
956 </listitem>
957 </varlistentry>
958
959 <varlistentry>
960 <term><varname>BlockIODeviceWeight=<replaceable>device</replaceable> <replaceable>weight</replaceable></varname></term>
961
962 <listitem>
963 <para>Set the per-device overall block I/O weight for the executed processes, if the legacy control group
964 hierarchy is used on the system. Takes a space-separated pair of a file path and a weight value to specify
965 the device specific weight value, between 10 and 1000. (Example: "/dev/sda 500"). The file path may be
966 specified as path to a block device node or as any other file, in which case the backing block device of the
967 file system of the file is determined. This controls the <literal>blkio.weight_device</literal> control group
968 attribute, which defaults to 1000. Use this option multiple times to set weights for multiple devices. For
969 details about this control group attribute, see <ulink
970 url="https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt">blkio-controller.txt</ulink>.</para>
971
972 <para>Implies
973 <literal>BlockIOAccounting=yes</literal>.</para>
974
975 <para>This setting is deprecated. Use <varname>IODeviceWeight=</varname> instead.</para>
976 </listitem>
977 </varlistentry>
978
979 <varlistentry>
980 <term><varname>BlockIOReadBandwidth=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
981 <term><varname>BlockIOWriteBandwidth=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
982
983 <listitem>
984 <para>Set the per-device overall block I/O bandwidth limit for the executed processes, if the legacy control
985 group hierarchy is used on the system. Takes a space-separated pair of a file path and a bandwidth value (in
986 bytes per second) to specify the device specific bandwidth. The file path may be a path to a block device
987 node, or as any other file in which case the backing block device of the file system of the file is used. If
988 the bandwidth is suffixed with K, M, G, or T, the specified bandwidth is parsed as Kilobytes, Megabytes,
989 Gigabytes, or Terabytes, respectively, to the base of 1000. (Example:
990 "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This controls the
991 <literal>blkio.throttle.read_bps_device</literal> and <literal>blkio.throttle.write_bps_device</literal>
992 control group attributes. Use this option multiple times to set bandwidth limits for multiple devices. For
993 details about these control group attributes, see <ulink
994 url="https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt">blkio-controller.txt</ulink>.
995 </para>
996
997 <para>Implies
998 <literal>BlockIOAccounting=yes</literal>.</para>
999
1000 <para>These settings are deprecated. Use <varname>IOReadBandwidthMax=</varname> and
1001 <varname>IOWriteBandwidthMax=</varname> instead.</para>
1002 </listitem>
1003 </varlistentry>
1004
1005 </variablelist>
1006 </refsect1>
1007
1008 <refsect1>
1009 <title>See Also</title>
1010 <para>
1011 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1012 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1013 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1014 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1015 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1016 <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1017 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1018 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1019 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1020 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1021 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1022 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1023 The documentation for control groups and specific controllers in the Linux kernel:
1024 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>,
1025 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/cpuacct.txt">cpuacct.txt</ulink>,
1026 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt">memory.txt</ulink>,
1027 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt">blkio-controller.txt</ulink>.
1028 <ulink url="https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt">sched-bwc.txt</ulink>.
1029 </para>
1030 </refsect1>
1031 </refentry>