]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man7/sched.7
sched.7: Note error that occurs when writing invalid value to /proc/PID/autogroup
[thirdparty/man-pages.git] / man7 / sched.7
CommitLineData
59c06be3 1.\" Copyright (C) 2014 Michael Kerrisk <mtk.manpages@gmail.com>
7a0d1838
PZ
2.\" and Copyright (C) 2014 Peter Zijlstra <peterz@infradead.org>
3.\" and Copyright (C) 2014 Juri Lelli <juri.lelli@gmail.com>
59c06be3
MK
4.\" Various pieces from the old sched_setscheduler(2) page
5.\" Copyright (C) Tom Bjorkholm, Markus Kuhn & David A. Wheeler 1996-1999
6.\" and Copyright (C) 2007 Carsten Emde <Carsten.Emde@osadl.org>
7.\" and Copyright (C) 2008 Michael Kerrisk <mtk.manpages@gmail.com>
8.\"
9.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
10.\" This is free documentation; you can redistribute it and/or
11.\" modify it under the terms of the GNU General Public License as
12.\" published by the Free Software Foundation; either version 2 of
13.\" the License, or (at your option) any later version.
14.\"
15.\" The GNU General Public License's references to "object code"
16.\" and "executables" are to be interpreted as the output of any
17.\" document formatting or typesetting system, including
18.\" intermediate and printed output.
19.\"
20.\" This manual is distributed in the hope that it will be useful,
21.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
22.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23.\" GNU General Public License for more details.
24.\"
25.\" You should have received a copy of the GNU General Public
26.\" License along with this manual; if not, see
27.\" <http://www.gnu.org/licenses/>.
28.\" %%%LICENSE_END
29.\"
30.\" Worth looking at: http://rt.wiki.kernel.org/index.php
31.\"
b8efb414 32.TH SCHED 7 2016-10-08 "Linux" "Linux Programmer's Manual"
59c06be3 33.SH NAME
cfd62fa2 34sched \- overview of CPU scheduling
59c06be3 35.SH DESCRIPTION
30af6b5d
MK
36Since Linux 2.6.23, the default scheduler is CFS,
37the "Completely Fair Scheduler".
38The CFS scheduler replaced the earlier "O(1)" scheduler.
39.\"
b16695a3 40.SS API summary
bac6ef74
MK
41Linux provides the following system calls for controlling
42the CPU scheduling behavior, policy, and priority of processes
43(or, more precisely, threads).
b16695a3 44.TP
31046c3c
MK
45.BR nice (2)
46Set a new nice value for the calling thread,
47and return the new nice value.
48.TP
49.BR getpriority (2)
50Return the nice value of a thread, a process group,
51or the set of threads owned by a specified user.
52.TP
53.BR setpriority (2)
54Set the nice value of a thread, a process group,
55or the set of threads owned by a specified user.
56.TP
b16695a3
MK
57.BR sched_setscheduler (2)
58Set the scheduling policy and parameters of a specified thread.
59.TP
60.BR sched_getscheduler (2)
61Return the scheduling policy of a specified thread.
62.TP
63.BR sched_setparam (2)
64Set the scheduling parameters of a specified thread.
65.TP
66.BR sched_getparam (2)
67Fetch the scheduling parameters of a specified thread.
68.TP
69.BR sched_get_priority_max (2)
275e3c16 70Return the maximum priority available in a specified scheduling policy.
b16695a3
MK
71.TP
72.BR sched_get_priority_min (2)
275e3c16 73Return the minimum priority available in a specified scheduling policy.
b16695a3 74.TP
5813ff92 75.BR sched_rr_get_interval (2)
b16695a3
MK
76Fetch the quantum used for threads that are scheduled under
77the "round-robin" scheduling policy.
78.TP
79.BR sched_yield (2)
80Cause the caller to relinquish the CPU,
81so that some other thread be executed.
82.TP
83.BR sched_setaffinity (2)
84(Linux-specific)
85Set the CPU affinity of a specified thread.
86.TP
87.BR sched_getaffinity (2)
88(Linux-specific)
91f5e870 89Get the CPU affinity of a specified thread.
b16695a3
MK
90.TP
91.BR sched_setattr (2)
77dab50a
MK
92Set the scheduling policy and parameters of a specified thread.
93This (Linux-specific) system call provides a superset of the functionality of
94.BR sched_setscheduler (2)
95and
96.BR sched_setparam (2).
b16695a3
MK
97.TP
98.BR sched_getattr (2)
77dab50a
MK
99Fetch the scheduling policy and parameters of a specified thread.
100This (Linux-specific) system call provides a superset of the functionality of
101.BR sched_getscheduler (2)
102and
103.BR sched_getparam (2).
b16695a3 104.\"
59c06be3
MK
105.SS Scheduling policies
106The scheduler is the kernel component that decides which runnable thread
107will be executed by the CPU next.
108Each thread has an associated scheduling policy and a \fIstatic\fP
2e868ccc
MK
109scheduling priority,
110.IR sched_priority .
961df2a8 111The scheduler makes its decisions based on knowledge of the scheduling
59c06be3
MK
112policy and static priority of all threads on the system.
113
114For threads scheduled under one of the normal scheduling policies
115(\fBSCHED_OTHER\fP, \fBSCHED_IDLE\fP, \fBSCHED_BATCH\fP),
116\fIsched_priority\fP is not used in scheduling
117decisions (it must be specified as 0).
118
119Processes scheduled under one of the real-time policies
120(\fBSCHED_FIFO\fP, \fBSCHED_RR\fP) have a
121\fIsched_priority\fP value in the range 1 (low) to 99 (high).
122(As the numbers imply, real-time threads always have higher priority
123than normal threads.)
cc401eea 124Note well: POSIX.1 requires an implementation to support only a
59c06be3
MK
125minimum 32 distinct priority levels for the real-time policies,
126and some systems supply just this minimum.
127Portable programs should use
128.BR sched_get_priority_min (2)
129and
130.BR sched_get_priority_max (2)
131to find the range of priorities supported for a particular policy.
132
133Conceptually, the scheduler maintains a list of runnable
134threads for each possible \fIsched_priority\fP value.
135In order to determine which thread runs next, the scheduler looks for
136the nonempty list with the highest static priority and selects the
137thread at the head of this list.
138
139A thread's scheduling policy determines
140where it will be inserted into the list of threads
141with equal static priority and how it will move inside this list.
142
143All scheduling is preemptive: if a thread with a higher static
144priority becomes ready to run, the currently running thread
145will be preempted and
146returned to the wait list for its static priority level.
147The scheduling policy determines the
148ordering only within the list of runnable threads with equal static
149priority.
150.SS SCHED_FIFO: First in-first out scheduling
151\fBSCHED_FIFO\fP can be used only with static priorities higher than
1520, which means that when a \fBSCHED_FIFO\fP threads becomes runnable,
153it will always immediately preempt any currently running
154\fBSCHED_OTHER\fP, \fBSCHED_BATCH\fP, or \fBSCHED_IDLE\fP thread.
155\fBSCHED_FIFO\fP is a simple scheduling
156algorithm without time slicing.
157For threads scheduled under the
158\fBSCHED_FIFO\fP policy, the following rules apply:
159.IP * 3
160A \fBSCHED_FIFO\fP thread that has been preempted by another thread of
161higher priority will stay at the head of the list for its priority and
162will resume execution as soon as all threads of higher priority are
163blocked again.
164.IP *
165When a \fBSCHED_FIFO\fP thread becomes runnable, it
166will be inserted at the end of the list for its priority.
167.IP *
168A call to
4c2eb0c2
MK
169.BR sched_setscheduler (2),
170.BR sched_setparam (2),
59c06be3 171or
4c2eb0c2 172.BR sched_setattr (2)
59c06be3
MK
173will put the
174\fBSCHED_FIFO\fP (or \fBSCHED_RR\fP) thread identified by
175\fIpid\fP at the start of the list if it was runnable.
176As a consequence, it may preempt the currently running thread if
177it has the same priority.
cc401eea 178(POSIX.1 specifies that the thread should go to the end
59c06be3
MK
179of the list.)
180.\" In 2.2.x and 2.4.x, the thread is placed at the front of the queue
181.\" In 2.0.x, the Right Thing happened: the thread went to the back -- MTK
182.IP *
183A thread calling
184.BR sched_yield (2)
185will be put at the end of the list.
186.PP
187No other events will move a thread
188scheduled under the \fBSCHED_FIFO\fP policy in the wait list of
189runnable threads with equal static priority.
190
191A \fBSCHED_FIFO\fP
192thread runs until either it is blocked by an I/O request, it is
193preempted by a higher priority thread, or it calls
194.BR sched_yield (2).
195.SS SCHED_RR: Round-robin scheduling
196\fBSCHED_RR\fP is a simple enhancement of \fBSCHED_FIFO\fP.
197Everything
198described above for \fBSCHED_FIFO\fP also applies to \fBSCHED_RR\fP,
199except that each thread is allowed to run only for a maximum time
200quantum.
201If a \fBSCHED_RR\fP thread has been running for a time
202period equal to or longer than the time quantum, it will be put at the
203end of the list for its priority.
204A \fBSCHED_RR\fP thread that has
205been preempted by a higher priority thread and subsequently resumes
206execution as a running thread will complete the unexpired portion of
207its round-robin time quantum.
208The length of the time quantum can be
209retrieved using
210.BR sched_rr_get_interval (2).
211.\" On Linux 2.4, the length of the RR interval is influenced
212.\" by the process nice value -- MTK
213.\"
7a0d1838 214.SS SCHED_DEADLINE: Sporadic task model deadline scheduling
9cc1fa25
MK
215Since version 3.14, Linux provides a deadline scheduling policy
216.RB ( SCHED_DEADLINE ).
217This policy is currently implemented using
218GEDF (Global Earliest Deadline First)
219in conjunction with CBS (Constant Bandwidth Server).
220To set and fetch this policy and associated attributes,
221one must use the Linux-specific
222.BR sched_setattr (2)
223and
224.BR sched_getattr (2)
225system calls.
7a0d1838
PZ
226
227A sporadic task is one that has a sequence of jobs, where each
91c98da6 228job is activated at most once per period.
9cc1fa25
MK
229Each job also has a
230.IR "relative deadline" ,
91c98da6 231before which it should finish execution, and a
9cc1fa25
MK
232.IR "computation time" ,
233which is the CPU time necessary for executing the job.
234The moment when a task wakes up
235because a new job has to be executed is called the
236.IR "arrival time"
237(also referred to as the request time or release time).
238The
239.IR "start time"
240is the time at which a task starts its execution.
241The
0da5e58a 242.I "absolute deadline"
9cc1fa25 243is thus obtained by adding the relative deadline to the arrival time.
7a0d1838
PZ
244
245The following diagram clarifies these terms:
246
91c98da6 247.in +4n
7a0d1838 248.nf
7bd7f43e
MK
249arrival/wakeup absolute deadline
250 | start time |
251 | | |
252 v v v
253-----x--------xooooooooooooooooo--------x--------x---
0756f58f 254 |<- comp. time ->|
7bd7f43e
MK
255 |<------- relative deadline ------>|
256 |<-------------- period ------------------->|
7a0d1838 257.fi
91c98da6 258.in
7a0d1838 259
9cc1fa25 260When setting a
91c98da6 261.B SCHED_DEADLINE
9cc1fa25
MK
262policy for a thread using
263.BR sched_setattr (2),
264one can specify three parameters:
265.IR Runtime ,
266.IR Deadline ,
267and
268.IR Period .
269These parameters do not necessarily correspond to the aforementioned terms:
270usual practice is to set Runtime to something bigger than the average
271computation time (or worst-case execution time for hard real-time tasks),
272Deadline to the relative deadline, and Period to the period of the task.
273Thus, for
274.BR SCHED_DEADLINE
275scheduling, we have:
7a0d1838 276
91c98da6 277.in +4n
7a0d1838 278.nf
7bd7f43e
MK
279arrival/wakeup absolute deadline
280 | start time |
281 | | |
282 v v v
283-----x--------xooooooooooooooooo--------x--------x---
284 |<-- Runtime ------->|
285 |<----------- Deadline ----------->|
286 |<-------------- Period ------------------->|
7a0d1838 287.fi
91c98da6 288.in
7a0d1838 289
9cc1fa25
MK
290The three deadline-scheduling parameters correspond to the
291.IR sched_runtime ,
292.IR sched_deadline ,
293and
294.IR sched_period
295fields of the
296.I sched_attr
297structure; see
298.BR sched_setattr (2).
a68beb35 299These fields express values in nanoseconds.
9cc1fa25 300.\" FIXME It looks as though specifying sched_period as 0 means
47a2bb17
MK
301.\" "make sched_period the same as sched_deadline".
302.\" This needs to be documented.
9cc1fa25
MK
303If
304.IR sched_period
305is specified as 0, then it is made the same as
306.IR sched_deadline .
307
308The kernel requires that:
309
310 sched_runtime <= sched_deadline <= sched_period
311
312.\" See __checkparam_dl in kernel/sched/core.c
313In addition, under the current implementation,
314all of the parameter values must be at least 1024
315(i.e., just over one microsecond,
7bd7f43e 316which is the resolution of the implementation), and less than 2^63.
9cc1fa25
MK
317If any of these checks fails,
318.BR sched_setattr (2)
319fails with the error
320.BR EINVAL .
7a0d1838
PZ
321
322The CBS guarantees non-interference between tasks, by throttling
9cc1fa25 323threads that attempt to over-run their specified Runtime.
7a0d1838 324
9cc1fa25 325To ensure deadline scheduling guarantees,
0da5e58a 326the kernel must prevent situations where the set of
91c98da6 327.B SCHED_DEADLINE
9cc1fa25
MK
328threads is not feasible (schedulable) within the given constraints.
329The kernel thus performs an admittance test when setting or changing
91c98da6 330.B SCHED_DEADLINE
9cc1fa25
MK
331policy and attributes.
332This admission test calculates whether the change is feasible;
8e8cd193 333if it is not,
91c98da6 334.BR sched_setattr (2)
9cc1fa25
MK
335fails with the error
336.BR EBUSY .
7a0d1838
PZ
337
338For example, it is required (but not necessarily sufficient) for
9cc1fa25
MK
339the total utilization to be less than or equal to the total number of
340CPUs available, where, since each thread can maximally run for
341Runtime per Period, that thread's utilization is its
342Runtime divided by its Period.
7a0d1838 343
88e28f78 344In order to fulfill the guarantees that are made when
9cc1fa25
MK
345a thread is admitted to the
346.BR SCHED_DEADLINE
347policy,
91c98da6 348.BR SCHED_DEADLINE
9cc1fa25
MK
349threads are the highest priority (user controllable) threads in the
350system; if any
91c98da6 351.BR SCHED_DEADLINE
9cc1fa25
MK
352thread is runnable,
353it will preempt any thread scheduled under one of the other policies.
7a0d1838 354
9cc1fa25 355A call to
91c98da6 356.BR fork (2)
9cc1fa25
MK
357by a thread scheduled under the
358.B SCHED_DEADLINE
359policy will fail with the error
360.BR EAGAIN ,
361unless the thread has its reset-on-fork flag set (see below).
7a0d1838 362
91c98da6
MK
363A
364.B SCHED_DEADLINE
9cc1fa25 365thread that calls
91c98da6 366.BR sched_yield (2)
9cc1fa25
MK
367will yield the current job and wait for a new period to begin.
368.\"
369.\" FIXME Calling sched_getparam() on a SCHED_DEADLINE thread
47a2bb17
MK
370.\" fails with EINVAL, but sched_getscheduler() succeeds.
371.\" Is that intended? (Why?)
91c98da6 372.\"
59c06be3 373.SS SCHED_OTHER: Default Linux time-sharing scheduling
b8986eae
MK
374\fBSCHED_OTHER\fP can be used at only static priority 0
375(i.e., threads under real-time policies always have priority over
376.B SCHED_OTHER
377processes).
59c06be3
MK
378\fBSCHED_OTHER\fP is the standard Linux time-sharing scheduler that is
379intended for all threads that do not require the special
380real-time mechanisms.
f677bcfb 381
59c06be3
MK
382The thread to run is chosen from the static
383priority 0 list based on a \fIdynamic\fP priority that is determined only
384inside this list.
2be50a32 385The dynamic priority is based on the nice value (see below)
927d0dfa 386and is increased for each time quantum the thread is ready to run,
59c06be3
MK
387but denied to run by the scheduler.
388This ensures fair progress among all \fBSCHED_OTHER\fP threads.
389.\"
45fcd0e2 390.SS The nice value
bcbb240c 391The nice value is an attribute
d145138e
MK
392that can be used to influence the CPU scheduler to
393favor or disfavor a process in scheduling decisions.
394It affects the scheduling of
395.BR SCHED_OTHER
396and
397.BR SCHED_BATCH
bcbb240c 398(see below) processes.
2be50a32
MK
399The nice value can be modified using
400.BR nice (2),
401.BR setpriority (2),
402or
403.BR sched_setattr (2).
d145138e 404
bcbb240c
MK
405According to POSIX.1, the nice value is a per-process attribute;
406that is, the threads in a process should share a nice value.
407However, on Linux, the nice value is a per-thread attribute:
408different threads in the same process may have different nice values.
409
45fcd0e2
MK
410The range of the nice value
411varies across UNIX systems.
412On modern Linux, the range is \-20 (high priority) to +19 (low priority).
413On some other systems, the range is \-20..20.
414Very early Linux kernels (Before Linux 2.0) had the range \-infinity..15.
415.\" Linux before 1.3.36 had \-infinity..15.
416.\" Since kernel 1.3.43, Linux has the range \-20..19.
417
418The degree to which the nice value affects the relative scheduling of
419.BR SCHED_OTHER
420processes likewise varies across UNIX systems and
421across Linux kernel versions.
422
423With the advent of the CFS scheduler in kernel 2.6.23,
424Linux adopted an algorithm that causes
425relative differences in nice values to have a much stronger effect.
115366c6
MK
426In the current implementation, each unit of difference in the
427nice values of two processes results in a factor of 1.25
428in the degree to which the scheduler favors the higher priority process.
45fcd0e2
MK
429This causes very low nice values (+19) to truly provide little CPU
430to a process whenever there is any other
431higher priority load on the system,
432and makes high nice values (\-20) deliver most of the CPU to applications
433that require it (e.g., some audio applications).
50e12810
MK
434
435On Linux, the
436.BR RLIMIT_NICE
437resource limit can be used to define a limit to which
438an unprivileged process's nice value can be raised; see
439.BR setrlimit (2)
440for details.
45fcd0e2 441.\"
59c06be3
MK
442.SS SCHED_BATCH: Scheduling batch processes
443(Since Linux 2.6.16.)
444\fBSCHED_BATCH\fP can be used only at static priority 0.
445This policy is similar to \fBSCHED_OTHER\fP in that it schedules
446the thread according to its dynamic priority
447(based on the nice value).
448The difference is that this policy
449will cause the scheduler to always assume
450that the thread is CPU-intensive.
451Consequently, the scheduler will apply a small scheduling
a1fa36af 452penalty with respect to wakeup behavior,
59c06be3
MK
453so that this thread is mildly disfavored in scheduling decisions.
454
455.\" The following paragraph is drawn largely from the text that
456.\" accompanied Ingo Molnar's patch for the implementation of
457.\" SCHED_BATCH.
458.\" commit b0a9499c3dd50d333e2aedb7e894873c58da3785
459This policy is useful for workloads that are noninteractive,
460but do not want to lower their nice value,
461and for workloads that want a deterministic scheduling policy without
462interactivity causing extra preemptions (between the workload's tasks).
463.\"
464.SS SCHED_IDLE: Scheduling very low priority jobs
465(Since Linux 2.6.23.)
466\fBSCHED_IDLE\fP can be used only at static priority 0;
467the process nice value has no influence for this policy.
468
469This policy is intended for running jobs at extremely low
470priority (lower even than a +19 nice value with the
471.B SCHED_OTHER
472or
473.B SCHED_BATCH
474policies).
475.\"
476.SS Resetting scheduling policy for child processes
005eaa8f
MK
477Each thread has a reset-on-fork scheduling flag.
478When this flag is set, children created by
479.BR fork (2)
480do not inherit privileged scheduling policies.
481The reset-on-fork flag can be set by either:
482.IP * 3
483ORing the
59c06be3 484.B SCHED_RESET_ON_FORK
005eaa8f 485flag into the
59c06be3 486.I policy
005eaa8f
MK
487argument when calling
488.BR sched_setscheduler (2)
489(since Linux 2.6.32);
490or
491.IP *
492specifying the
493.B SCHED_FLAG_RESET_ON_FORK
494flag in
495.IR attr.sched_flags
59c06be3 496when calling
005eaa8f
MK
497.BR sched_setattr (2).
498.PP
499Note that the constants used with these two APIs have different names.
500The state of the reset-on-fork flag can analogously be retrieved using
501.BR sched_getscheduler (2)
502and
503.BR sched_getattr (2).
504
505The reset-on-fork feature is intended for media-playback applications,
59c06be3
MK
506and can be used to prevent applications evading the
507.BR RLIMIT_RTTIME
508resource limit (see
509.BR getrlimit (2))
510by creating multiple child processes.
511
005eaa8f 512More precisely, if the reset-on-fork flag is set,
59c06be3
MK
513the following rules apply for subsequently created children:
514.IP * 3
515If the calling thread has a scheduling policy of
516.B SCHED_FIFO
517or
518.BR SCHED_RR ,
519the policy is reset to
520.BR SCHED_OTHER
521in child processes.
522.IP *
523If the calling process has a negative nice value,
524the nice value is reset to zero in child processes.
525.PP
005eaa8f 526After the reset-on-fork flag has been enabled,
59c06be3
MK
527it can be reset only if the thread has the
528.BR CAP_SYS_NICE
529capability.
530This flag is disabled in child processes created by
531.BR fork (2).
59c06be3
MK
532.\"
533.SS Privileges and resource limits
534In Linux kernels before 2.6.12, only privileged
535.RB ( CAP_SYS_NICE )
536threads can set a nonzero static priority (i.e., set a real-time
537scheduling policy).
538The only change that an unprivileged thread can make is to set the
539.B SCHED_OTHER
759e1210 540policy, and this can be done only if the effective user ID of the caller
59c06be3
MK
541matches the real or effective user ID of the target thread
542(i.e., the thread specified by
543.IR pid )
544whose policy is being changed.
545
9cc1fa25
MK
546A thread must be privileged
547.RB ( CAP_SYS_NICE )
0da5e58a 548in order to set or modify a
9cc1fa25
MK
549.BR SCHED_DEADLINE
550policy.
551
59c06be3
MK
552Since Linux 2.6.12, the
553.B RLIMIT_RTPRIO
554resource limit defines a ceiling on an unprivileged thread's
555static priority for the
556.B SCHED_RR
557and
558.B SCHED_FIFO
559policies.
560The rules for changing scheduling policy and priority are as follows:
561.IP * 3
562If an unprivileged thread has a nonzero
563.B RLIMIT_RTPRIO
564soft limit, then it can change its scheduling policy and priority,
565subject to the restriction that the priority cannot be set to a
566value higher than the maximum of its current priority and its
567.B RLIMIT_RTPRIO
568soft limit.
569.IP *
570If the
571.B RLIMIT_RTPRIO
572soft limit is 0, then the only permitted changes are to lower the priority,
573or to switch to a non-real-time policy.
574.IP *
575Subject to the same rules,
576another unprivileged thread can also make these changes,
577as long as the effective user ID of the thread making the change
578matches the real or effective user ID of the target thread.
579.IP *
580Special rules apply for the
f7a858b4
MK
581.BR SCHED_IDLE
582policy.
59c06be3
MK
583In Linux kernels before 2.6.39,
584an unprivileged thread operating under this policy cannot
585change its policy, regardless of the value of its
586.BR RLIMIT_RTPRIO
587resource limit.
588In Linux kernels since 2.6.39,
589.\" commit c02aa73b1d18e43cfd79c2f193b225e84ca497c8
590an unprivileged thread can switch to either the
591.BR SCHED_BATCH
592or the
85b6211a 593.BR SCHED_OTHER
59c06be3
MK
594policy so long as its nice value falls within the range permitted by its
595.BR RLIMIT_NICE
596resource limit (see
597.BR getrlimit (2)).
598.PP
599Privileged
600.RB ( CAP_SYS_NICE )
601threads ignore the
602.B RLIMIT_RTPRIO
603limit; as with older kernels,
604they can make arbitrary changes to scheduling policy and priority.
605See
606.BR getrlimit (2)
607for further information on
608.BR RLIMIT_RTPRIO .
0c055c75
MK
609.SS Limiting the CPU usage of real-time and deadline processes
610A nonblocking infinite loop in a thread scheduled under the
611.BR SCHED_FIFO ,
612.BR SCHED_RR ,
613or
614.BR SCHED_DEADLINE
df312a96
MK
615policy can potentially block all other threads from accessing
616the CPU forever.
0c055c75
MK
617Prior to Linux 2.6.25, the only way of preventing a runaway real-time
618process from freezing the system was to run (at the console)
619a shell scheduled under a higher static priority than the tested application.
620This allows an emergency kill of tested
621real-time applications that do not block or terminate as expected.
622
623Since Linux 2.6.25, there are other techniques for dealing with runaway
624real-time and deadline processes.
625One of these is to use the
626.BR RLIMIT_RTTIME
627resource limit to set a ceiling on the CPU time that
628a real-time process may consume.
629See
630.BR getrlimit (2)
631for details.
632
633Since version 2.6.25, Linux also provides two
634.I /proc
635files that can be used to reserve a certain amount of CPU time
636to be used by non-real-time processes.
0b1ce085 637Reserving CPU time in this fashion allows some CPU time to be
0c055c75
MK
638allocated to (say) a root shell that can be used to kill a runaway process.
639Both of these files specify time values in microseconds:
640.TP
641.IR /proc/sys/kernel/sched_rt_period_us
642This file specifies a scheduling period that is equivalent to
643100% CPU bandwidth.
644The value in this file can range from 1 to
645.BR INT_MAX ,
646giving an operating range of 1 microsecond to around 35 minutes.
647The default value in this file is 1,000,000 (1 second).
648.TP
649.IR /proc/sys/kernel/sched_rt_runtime_us
650The value in this file specifies how much of the "period" time
651can be used by all real-time and deadline scheduled processes
652on the system.
653The value in this file can range from \-1 to
654.BR INT_MAX \-1.
655Specifying \-1 makes the runtime the same as the period;
656that is, no CPU time is set aside for non-real-time processes
657(which was the Linux behavior before kernel 2.6.25).
658The default value in this file is 950,000 (0.95 seconds),
659meaning that 5% of the CPU time is reserved for processes that
660don't run under a real-time or deadline scheduling policy.
661.PP
59c06be3 662.SS Response time
1154a064 663A blocked high priority thread waiting for I/O has a certain
59c06be3
MK
664response time before it is scheduled again.
665The device driver writer
666can greatly reduce this response time by using a "slow interrupt"
667interrupt handler.
668.\" as described in
669.\" .BR request_irq (9).
670.SS Miscellaneous
671Child processes inherit the scheduling policy and parameters across a
672.BR fork (2).
673The scheduling policy and parameters are preserved across
674.BR execve (2).
675
676Memory locking is usually needed for real-time processes to avoid
677paging delays; this can be done with
678.BR mlock (2)
679or
680.BR mlockall (2).
ed520068
MK
681.\"
682.SS The autogroup feature
683.\" commit 5091faa449ee0b7d73bc296a93bca9540fc51d0a
684Since Linux 2.6.38,
685the kernel provides a feature known as autogrouping to improve interactive
ee1f3c18 686desktop performance in the face of multiprocess, CPU-intensive
ed520068
MK
687workloads such as building the Linux kernel with large numbers of
688parallel build processes (i.e., the
689.BR make (1)
690.BR \-j
691flag).
692
693This feature operates in conjunction with the
694CFS scheduler and requires a kernel that is configured with
695.BR CONFIG_SCHED_AUTOGROUP .
696On a running system, this feature is enabled or disabled via the file
697.IR /proc/sys/kernel/sched_autogroup_enabled ;
698a value of 0 disables the feature, while a value of 1 enables it.
699The default value in this file is 1, unless the kernel was booted with the
700.IR noautogroup
701parameter.
702
ee1f3c18
MK
703A new autogroup is created created when a new session is created via
704.BR setsid (2);
705this happens, for example, when a new terminal window is started.
706A new process created by
707.BR fork (2)
708inherits its parent's autogroup membership.
709Thus, all of the processes in a session are members of the same autogroup.
710An autogroup is automatically destroyed when the last process
ed520068
MK
711in the group terminates.
712
ee1f3c18
MK
713When autogrouping is enabled, all of the members of an autogroup
714are placed in the same kernel scheduler "task group".
715The CFS scheduler employs an algorithm that equalizes the
716distribution of CPU cycles across task groups.
717The benefits of this for interactive desktop performance
718can be described via the following example.
719
626dca36
MK
720Suppose that there are two autogroups competing for the same CPU
721(i.e., presume either a single CPU system or the use of
722.BR taskset (1)
723to confine all the processes to the same CPU on an SMP system).
ee1f3c18
MK
724The first group contains ten CPU-bound processes from
725a kernel build started with
726.IR "make\ \-j10" .
727The other contains a single CPU-bound process: a video player.
728The effect of autogrouping is that the two groups will
729each receive half of the CPU cycles.
730That is, the video player will receive 50% of the CPU cycles,
c11d0670 731rather than just 9% of the cycles,
ee1f3c18 732which would likely lead to degraded video playback.
626dca36
MK
733The situation on an SMP system is more complex,
734.\" Mike Galbraith, 25 Nov 2016:
735.\" I'd say something more wishy-washy here, like cycles are
736.\" distributed fairly across groups and leave it at that, as your
737.\" detailed example is incorrect due to SMP fairness (which I don't
738.\" like much because [very unlikely] worst case scenario
739.\" renders a box sized group incapable of utilizing more that
740.\" a single CPU total). For example, if a group of NR_CPUS
741.\" size competes with a singleton, load balancing will try to give
742.\" the singleton a full CPU of its very own. If groups intersect for
743.\" whatever reason on say my quad lappy, distribution is 80/20 in
744.\" favor of the singleton.
745but the general effect is the same:
746the scheduler distributes CPU cycles across task groups such that
ee1f3c18 747an autogroup that contains a large number of CPU-bound processes
626dca36 748does not end up hoffing CPU cycles at the expense of the other
ee1f3c18
MK
749jobs on the system.
750
751A process's autogroup (task group) membership can be viewed via the file
ed520068
MK
752.IR /proc/[pid]/autogroup :
753
754.nf
755.in +4n
756$ \fBcat /proc/1/autogroup\fP
757/autogroup-1 nice 0
758.in
759.fi
760
761This file can also be used to modify the CPU bandwidth allocated
ee1f3c18 762to an autogroup.
ed520068 763This is done by writing a number in the "nice" range to the file
ee1f3c18 764to set the autogroup's nice value.
58627ec0
MK
765The allowed range is from +19 (low priority) to \-20 (high priority).
766(Writing values outside of this range causes
767.BR write (2)
768to fail with the error
769.BR EINVAL .)
770The setting has the same effect as modifying the nice level via
ee1f3c18 771.BR getpriority (2).
576b74ee
MK
772(For a discussion of the nice value, see
773.BR getpriority (2).)
ee1f3c18 774.\" FIXME .
576b74ee
MK
775.\" Because of a bug introduced in Linux 4.7
776.\" (commit 2159197d66770ec01f75c93fb11dc66df81fd45b made changes
777.\" that exposed the fact that autogroup didn't call scale_load()),
778.\" it happened that *all* values in this range caused a task group
779.\" to be further disfavored by the scheduler, with \-20 resulting
780.\" in the scheduler mildy disfavoring the task group and +19 greatly
781.\" disfavoring it.
ed520068 782.\"
576b74ee
MK
783.\" A patch was posted on 23 Nov 2016
784.\" ("sched/autogroup: Fix 64bit kernel nice adjustment";
785.\" check later to see in which kernel version it lands.
ee1f3c18
MK
786.\"
787.\" FIXME How do the nice value of a process and the nice value of
788.\" an autogroup interact? Which has priority?
45922aa8
MK
789.\"
790.\" It *appears* that the autogroup nice value is used for CPU distribution
791.\" between task groups, and that the process nice value has no effect there.
792.\" (I.e., suppose two autogroups each contain a CPU-bound process,
793.\" with one process having nice==0 and the other having nice==19.
794.\" It appears that they each get 50% of the CPU.)
795.\" It appears that the process nice value has effect only with respect to
796.\" scheduling relative to other processes in the *same* autogroup.
797.\" Is this correct?
ed520068 798
ed520068
MK
799The use of the
800.BR cgroups (7)
801CPU controller overrides the effect of autogrouping.
ee1f3c18
MK
802
803The autogroup feature does not group processes
804that are scheduled under a real-time and deadline policies.
805Those processes are scheduled according to the rules described earlier.
59c06be3 806.SH NOTES
1f7fb9c0
MK
807The
808.BR cgroups (7)
809CPU controller can be used to limit the CPU consumption of
810groups of processes.
59c06be3
MK
811.PP
812Originally, Standard Linux was intended as a general-purpose operating
813system being able to handle background processes, interactive
814applications, and less demanding real-time applications (applications that
815need to usually meet timing deadlines).
816Although the Linux kernel 2.6
817allowed for kernel preemption and the newly introduced O(1) scheduler
818ensures that the time needed to schedule is fixed and deterministic
819irrespective of the number of active tasks, true real-time computing
820was not possible up to kernel version 2.6.17.
821.SS Real-time features in the mainline Linux kernel
822.\" FIXME . Probably this text will need some minor tweaking
84dd1325 823.\" ask Carsten Emde about this.
6ad8b4d0 824Since kernel version 2.6.18, Linux is gradually
59c06be3
MK
825becoming equipped with real-time capabilities,
826most of which are derived from the former
827.I realtime-preempt
94875d76 828patch set.
59c06be3 829Until the patches have been completely merged into the
84dd1325 830mainline kernel,
59c06be3
MK
831they must be installed to achieve the best real-time performance.
832These patches are named:
833.in +4n
834.nf
835
836patch-\fIkernelversion\fP-rt\fIpatchversion\fP
837.fi
838.in
839.PP
840and can be downloaded from
841.UR http://www.kernel.org\:/pub\:/linux\:/kernel\:/projects\:/rt/
842.UE .
843
844Without the patches and prior to their full inclusion into the mainline
845kernel, the kernel configuration offers only the three preemption classes
846.BR CONFIG_PREEMPT_NONE ,
847.BR CONFIG_PREEMPT_VOLUNTARY ,
848and
849.B CONFIG_PREEMPT_DESKTOP
850which respectively provide no, some, and considerable
851reduction of the worst-case scheduling latency.
852
853With the patches applied or after their full inclusion into the mainline
854kernel, the additional configuration item
855.B CONFIG_PREEMPT_RT
856becomes available.
857If this is selected, Linux is transformed into a regular
858real-time operating system.
759e1210 859The FIFO and RR scheduling policies are then used to run a thread
59c06be3 860with true real-time priority and a minimum worst-case scheduling latency.
59c06be3
MK
861.SH SEE ALSO
862.ad l
863.nh
864.BR chrt (1),
f19db853 865.BR taskset (1),
59c06be3
MK
866.BR getpriority (2),
867.BR mlock (2),
868.BR mlockall (2),
869.BR munlock (2),
870.BR munlockall (2),
871.BR nice (2),
872.BR sched_get_priority_max (2),
873.BR sched_get_priority_min (2),
874.BR sched_getaffinity (2),
875.BR sched_getparam (2),
584c8ee0 876.BR sched_getscheduler (2),
59c06be3
MK
877.BR sched_rr_get_interval (2),
878.BR sched_setaffinity (2),
879.BR sched_setparam (2),
584c8ee0 880.BR sched_setscheduler (2),
59c06be3
MK
881.BR sched_yield (2),
882.BR setpriority (2),
720a5280
MK
883.BR pthread_getaffinity_np (3),
884.BR pthread_setaffinity_np (3),
885.BR sched_getcpu (3),
59c06be3
MK
886.BR capabilities (7),
887.BR cpuset (7)
888.ad
889.PP
890.I Programming for the real world \- POSIX.4
891by Bill O. Gallmeister, O'Reilly & Associates, Inc., ISBN 1-56592-074-0.
892.PP
b963d0e3
MK
893The Linux kernel source files
894.IR Documentation/scheduler/sched-deadline.txt ,
895.IR Documentation/scheduler/sched-rt-group.txt ,
458689ed 896.IR Documentation/scheduler/sched-design-CFS.txt ,
b963d0e3 897and
d630434e 898.IR Documentation/scheduler/sched-nice-design.txt