Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6/linux-mips/linux-dm7025.git] / Documentation / sched-rt-group.txt
blob1c6332f4543c350889eae9ba2b4c766270c1b65e
3 Real-Time group scheduling.
5 The problem space:
7 In order to schedule multiple groups of realtime tasks each group must
8 be assigned a fixed portion of the CPU time available. Without a minimum
9 guarantee a realtime group can obviously fall short. A fuzzy upper limit
10 is of no use since it cannot be relied upon. Which leaves us with just
11 the single fixed portion.
13 CPU time is divided by means of specifying how much time can be spent
14 running in a given period. Say a frame fixed realtime renderer must
15 deliver 25 frames a second, which yields a period of 0.04s. Now say
16 it will also have to play some music and respond to input, leaving it
17 with around 80% for the graphics. We can then give this group a runtime
18 of 0.8 * 0.04s = 0.032s.
20 This way the graphics group will have a 0.04s period with a 0.032s runtime
21 limit.
23 Now if the audio thread needs to refill the DMA buffer every 0.005s, but
24 needs only about 3% CPU time to do so, it can do with a 0.03 * 0.005s
25 = 0.00015s.
28 The Interface:
30 system wide:
32 /proc/sys/kernel/sched_rt_period_ms
33 /proc/sys/kernel/sched_rt_runtime_us
35 CONFIG_FAIR_USER_SCHED
37 /sys/kernel/uids/<uid>/cpu_rt_runtime_us
41 CONFIG_FAIR_CGROUP_SCHED
43 /cgroup/<cgroup>/cpu.rt_runtime_us
45 [ time is specified in us because the interface is s32; this gives an
46   operating range of ~35m to 1us ]
48 The period takes values in [ 1, INT_MAX ], runtime in [ -1, INT_MAX - 1 ].
50 A runtime of -1 specifies runtime == period, ie. no limit.
52 New groups get the period from /proc/sys/kernel/sched_rt_period_us and
53 a runtime of 0.
55 Settings are constrained to:
57    \Sum_{i} runtime_{i} / global_period <= global_runtime / global_period
59 in order to keep the configuration schedulable.