Merge tag 'vfio-v4.21-rc1' of git://github.com/awilliam/linux-vfio
[sfrench/cifs-2.6.git] / Documentation / RCU / stallwarn.txt
1 Using RCU's CPU Stall Detector
2
3 This document first discusses what sorts of issues RCU's CPU stall
4 detector can locate, and then discusses kernel parameters and Kconfig
5 options that can be used to fine-tune the detector's operation.  Finally,
6 this document explains the stall detector's "splat" format.
7
8
9 What Causes RCU CPU Stall Warnings?
10
11 So your kernel printed an RCU CPU stall warning.  The next question is
12 "What caused it?"  The following problems can result in RCU CPU stall
13 warnings:
14
15 o       A CPU looping in an RCU read-side critical section.
16
17 o       A CPU looping with interrupts disabled.
18
19 o       A CPU looping with preemption disabled.
20
21 o       A CPU looping with bottom halves disabled.
22
23 o       For !CONFIG_PREEMPT kernels, a CPU looping anywhere in the kernel
24         without invoking schedule().  If the looping in the kernel is
25         really expected and desirable behavior, you might need to add
26         some calls to cond_resched().
27
28 o       Booting Linux using a console connection that is too slow to
29         keep up with the boot-time console-message rate.  For example,
30         a 115Kbaud serial console can be -way- too slow to keep up
31         with boot-time message rates, and will frequently result in
32         RCU CPU stall warning messages.  Especially if you have added
33         debug printk()s.
34
35 o       Anything that prevents RCU's grace-period kthreads from running.
36         This can result in the "All QSes seen" console-log message.
37         This message will include information on when the kthread last
38         ran and how often it should be expected to run.  It can also
39         result in the "rcu_.*kthread starved for" console-log message,
40         which will include additional debugging information.
41
42 o       A CPU-bound real-time task in a CONFIG_PREEMPT kernel, which might
43         happen to preempt a low-priority task in the middle of an RCU
44         read-side critical section.   This is especially damaging if
45         that low-priority task is not permitted to run on any other CPU,
46         in which case the next RCU grace period can never complete, which
47         will eventually cause the system to run out of memory and hang.
48         While the system is in the process of running itself out of
49         memory, you might see stall-warning messages.
50
51 o       A CPU-bound real-time task in a CONFIG_PREEMPT_RT kernel that
52         is running at a higher priority than the RCU softirq threads.
53         This will prevent RCU callbacks from ever being invoked,
54         and in a CONFIG_PREEMPT_RCU kernel will further prevent
55         RCU grace periods from ever completing.  Either way, the
56         system will eventually run out of memory and hang.  In the
57         CONFIG_PREEMPT_RCU case, you might see stall-warning
58         messages.
59
60 o       A periodic interrupt whose handler takes longer than the time
61         interval between successive pairs of interrupts.  This can
62         prevent RCU's kthreads and softirq handlers from running.
63         Note that certain high-overhead debugging options, for example
64         the function_graph tracer, can result in interrupt handler taking
65         considerably longer than normal, which can in turn result in
66         RCU CPU stall warnings.
67
68 o       Testing a workload on a fast system, tuning the stall-warning
69         timeout down to just barely avoid RCU CPU stall warnings, and then
70         running the same workload with the same stall-warning timeout on a
71         slow system.  Note that thermal throttling and on-demand governors
72         can cause a single system to be sometimes fast and sometimes slow!
73
74 o       A hardware or software issue shuts off the scheduler-clock
75         interrupt on a CPU that is not in dyntick-idle mode.  This
76         problem really has happened, and seems to be most likely to
77         result in RCU CPU stall warnings for CONFIG_NO_HZ_COMMON=n kernels.
78
79 o       A bug in the RCU implementation.
80
81 o       A hardware failure.  This is quite unlikely, but has occurred
82         at least once in real life.  A CPU failed in a running system,
83         becoming unresponsive, but not causing an immediate crash.
84         This resulted in a series of RCU CPU stall warnings, eventually
85         leading the realization that the CPU had failed.
86
87 The RCU, RCU-sched, and RCU-tasks implementations have CPU stall warning.
88 Note that SRCU does -not- have CPU stall warnings.  Please note that
89 RCU only detects CPU stalls when there is a grace period in progress.
90 No grace period, no CPU stall warnings.
91
92 To diagnose the cause of the stall, inspect the stack traces.
93 The offending function will usually be near the top of the stack.
94 If you have a series of stall warnings from a single extended stall,
95 comparing the stack traces can often help determine where the stall
96 is occurring, which will usually be in the function nearest the top of
97 that portion of the stack which remains the same from trace to trace.
98 If you can reliably trigger the stall, ftrace can be quite helpful.
99
100 RCU bugs can often be debugged with the help of CONFIG_RCU_TRACE
101 and with RCU's event tracing.  For information on RCU's event tracing,
102 see include/trace/events/rcu.h.
103
104
105 Fine-Tuning the RCU CPU Stall Detector
106
107 The rcuupdate.rcu_cpu_stall_suppress module parameter disables RCU's
108 CPU stall detector, which detects conditions that unduly delay RCU grace
109 periods.  This module parameter enables CPU stall detection by default,
110 but may be overridden via boot-time parameter or at runtime via sysfs.
111 The stall detector's idea of what constitutes "unduly delayed" is
112 controlled by a set of kernel configuration variables and cpp macros:
113
114 CONFIG_RCU_CPU_STALL_TIMEOUT
115
116         This kernel configuration parameter defines the period of time
117         that RCU will wait from the beginning of a grace period until it
118         issues an RCU CPU stall warning.  This time period is normally
119         21 seconds.
120
121         This configuration parameter may be changed at runtime via the
122         /sys/module/rcupdate/parameters/rcu_cpu_stall_timeout, however
123         this parameter is checked only at the beginning of a cycle.
124         So if you are 10 seconds into a 40-second stall, setting this
125         sysfs parameter to (say) five will shorten the timeout for the
126         -next- stall, or the following warning for the current stall
127         (assuming the stall lasts long enough).  It will not affect the
128         timing of the next warning for the current stall.
129
130         Stall-warning messages may be enabled and disabled completely via
131         /sys/module/rcupdate/parameters/rcu_cpu_stall_suppress.
132
133 RCU_STALL_DELAY_DELTA
134
135         Although the lockdep facility is extremely useful, it does add
136         some overhead.  Therefore, under CONFIG_PROVE_RCU, the
137         RCU_STALL_DELAY_DELTA macro allows five extra seconds before
138         giving an RCU CPU stall warning message.  (This is a cpp
139         macro, not a kernel configuration parameter.)
140
141 RCU_STALL_RAT_DELAY
142
143         The CPU stall detector tries to make the offending CPU print its
144         own warnings, as this often gives better-quality stack traces.
145         However, if the offending CPU does not detect its own stall in
146         the number of jiffies specified by RCU_STALL_RAT_DELAY, then
147         some other CPU will complain.  This delay is normally set to
148         two jiffies.  (This is a cpp macro, not a kernel configuration
149         parameter.)
150
151 rcupdate.rcu_task_stall_timeout
152
153         This boot/sysfs parameter controls the RCU-tasks stall warning
154         interval.  A value of zero or less suppresses RCU-tasks stall
155         warnings.  A positive value sets the stall-warning interval
156         in jiffies.  An RCU-tasks stall warning starts with the line:
157
158                 INFO: rcu_tasks detected stalls on tasks:
159
160         And continues with the output of sched_show_task() for each
161         task stalling the current RCU-tasks grace period.
162
163
164 Interpreting RCU's CPU Stall-Detector "Splats"
165
166 For non-RCU-tasks flavors of RCU, when a CPU detects that it is stalling,
167 it will print a message similar to the following:
168
169         INFO: rcu_sched detected stalls on CPUs/tasks:
170         2-...: (3 GPs behind) idle=06c/0/0 softirq=1453/1455 fqs=0
171         16-...: (0 ticks this GP) idle=81c/0/0 softirq=764/764 fqs=0
172         (detected by 32, t=2603 jiffies, g=7075, q=625)
173
174 This message indicates that CPU 32 detected that CPUs 2 and 16 were both
175 causing stalls, and that the stall was affecting RCU-sched.  This message
176 will normally be followed by stack dumps for each CPU.  Please note that
177 PREEMPT_RCU builds can be stalled by tasks as well as by CPUs, and that
178 the tasks will be indicated by PID, for example, "P3421".  It is even
179 possible for an rcu_state stall to be caused by both CPUs -and- tasks,
180 in which case the offending CPUs and tasks will all be called out in the list.
181
182 CPU 2's "(3 GPs behind)" indicates that this CPU has not interacted with
183 the RCU core for the past three grace periods.  In contrast, CPU 16's "(0
184 ticks this GP)" indicates that this CPU has not taken any scheduling-clock
185 interrupts during the current stalled grace period.
186
187 The "idle=" portion of the message prints the dyntick-idle state.
188 The hex number before the first "/" is the low-order 12 bits of the
189 dynticks counter, which will have an even-numbered value if the CPU
190 is in dyntick-idle mode and an odd-numbered value otherwise.  The hex
191 number between the two "/"s is the value of the nesting, which will be
192 a small non-negative number if in the idle loop (as shown above) and a
193 very large positive number otherwise.
194
195 The "softirq=" portion of the message tracks the number of RCU softirq
196 handlers that the stalled CPU has executed.  The number before the "/"
197 is the number that had executed since boot at the time that this CPU
198 last noted the beginning of a grace period, which might be the current
199 (stalled) grace period, or it might be some earlier grace period (for
200 example, if the CPU might have been in dyntick-idle mode for an extended
201 time period.  The number after the "/" is the number that have executed
202 since boot until the current time.  If this latter number stays constant
203 across repeated stall-warning messages, it is possible that RCU's softirq
204 handlers are no longer able to execute on this CPU.  This can happen if
205 the stalled CPU is spinning with interrupts are disabled, or, in -rt
206 kernels, if a high-priority process is starving RCU's softirq handler.
207
208 The "fqs=" shows the number of force-quiescent-state idle/offline
209 detection passes that the grace-period kthread has made across this
210 CPU since the last time that this CPU noted the beginning of a grace
211 period.
212
213 The "detected by" line indicates which CPU detected the stall (in this
214 case, CPU 32), how many jiffies have elapsed since the start of the grace
215 period (in this case 2603), the grace-period sequence number (7075), and
216 an estimate of the total number of RCU callbacks queued across all CPUs
217 (625 in this case).
218
219 In kernels with CONFIG_RCU_FAST_NO_HZ, more information is printed
220 for each CPU:
221
222         0: (64628 ticks this GP) idle=dd5/3fffffffffffffff/0 softirq=82/543 last_accelerate: a345/d342 nonlazy_posted: 25 .D
223
224 The "last_accelerate:" prints the low-order 16 bits (in hex) of the
225 jiffies counter when this CPU last invoked rcu_try_advance_all_cbs()
226 from rcu_needs_cpu() or last invoked rcu_accelerate_cbs() from
227 rcu_prepare_for_idle().  The "nonlazy_posted:" prints the number
228 of non-lazy callbacks posted since the last call to rcu_needs_cpu().
229 Finally, an "L" indicates that there are currently no non-lazy callbacks
230 ("." is printed otherwise, as shown above) and "D" indicates that
231 dyntick-idle processing is enabled ("." is printed otherwise, for example,
232 if disabled via the "nohz=" kernel boot parameter).
233
234 If the grace period ends just as the stall warning starts printing,
235 there will be a spurious stall-warning message, which will include
236 the following:
237
238         INFO: Stall ended before state dump start
239
240 This is rare, but does happen from time to time in real life.  It is also
241 possible for a zero-jiffy stall to be flagged in this case, depending
242 on how the stall warning and the grace-period initialization happen to
243 interact.  Please note that it is not possible to entirely eliminate this
244 sort of false positive without resorting to things like stop_machine(),
245 which is overkill for this sort of problem.
246
247 If all CPUs and tasks have passed through quiescent states, but the
248 grace period has nevertheless failed to end, the stall-warning splat
249 will include something like the following:
250
251         All QSes seen, last rcu_preempt kthread activity 23807 (4297905177-4297881370), jiffies_till_next_fqs=3, root ->qsmask 0x0
252
253 The "23807" indicates that it has been more than 23 thousand jiffies
254 since the grace-period kthread ran.  The "jiffies_till_next_fqs"
255 indicates how frequently that kthread should run, giving the number
256 of jiffies between force-quiescent-state scans, in this case three,
257 which is way less than 23807.  Finally, the root rcu_node structure's
258 ->qsmask field is printed, which will normally be zero.
259
260 If the relevant grace-period kthread has been unable to run prior to
261 the stall warning, as was the case in the "All QSes seen" line above,
262 the following additional line is printed:
263
264         kthread starved for 23807 jiffies! g7075 f0x0 RCU_GP_WAIT_FQS(3) ->state=0x1 ->cpu=5
265
266 Starving the grace-period kthreads of CPU time can of course result
267 in RCU CPU stall warnings even when all CPUs and tasks have passed
268 through the required quiescent states.  The "g" number shows the current
269 grace-period sequence number, the "f" precedes the ->gp_flags command
270 to the grace-period kthread, the "RCU_GP_WAIT_FQS" indicates that the
271 kthread is waiting for a short timeout, the "state" precedes value of the
272 task_struct ->state field, and the "cpu" indicates that the grace-period
273 kthread last ran on CPU 5.
274
275
276 Multiple Warnings From One Stall
277
278 If a stall lasts long enough, multiple stall-warning messages will be
279 printed for it.  The second and subsequent messages are printed at
280 longer intervals, so that the time between (say) the first and second
281 message will be about three times the interval between the beginning
282 of the stall and the first message.
283
284
285 Stall Warnings for Expedited Grace Periods
286
287 If an expedited grace period detects a stall, it will place a message
288 like the following in dmesg:
289
290         INFO: rcu_sched detected expedited stalls on CPUs/tasks: { 7-... } 21119 jiffies s: 73 root: 0x2/.
291
292 This indicates that CPU 7 has failed to respond to a reschedule IPI.
293 The three periods (".") following the CPU number indicate that the CPU
294 is online (otherwise the first period would instead have been "O"),
295 that the CPU was online at the beginning of the expedited grace period
296 (otherwise the second period would have instead been "o"), and that
297 the CPU has been online at least once since boot (otherwise, the third
298 period would instead have been "N").  The number before the "jiffies"
299 indicates that the expedited grace period has been going on for 21,119
300 jiffies.  The number following the "s:" indicates that the expedited
301 grace-period sequence counter is 73.  The fact that this last value is
302 odd indicates that an expedited grace period is in flight.  The number
303 following "root:" is a bitmask that indicates which children of the root
304 rcu_node structure correspond to CPUs and/or tasks that are blocking the
305 current expedited grace period.  If the tree had more than one level,
306 additional hex numbers would be printed for the states of the other
307 rcu_node structures in the tree.
308
309 As with normal grace periods, PREEMPT_RCU builds can be stalled by
310 tasks as well as by CPUs, and that the tasks will be indicated by PID,
311 for example, "P3421".
312
313 It is entirely possible to see stall warnings from normal and from
314 expedited grace periods at about the same time during the same run.