Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Detect hard and soft lockups on a system
4 *
5 * started by Don Zickus, Copyright (C) 2010 Red Hat, Inc.
6 *
7 * Note: Most of this code is borrowed heavily from the original softlockup
8 * detector, so thanks to Ingo for the initial implementation.
9 * Some chunks also taken from the old x86-specific nmi watchdog code, thanks
10 * to those contributors as well.
11 */
12
13#define pr_fmt(fmt) "watchdog: " fmt
14
15#include <linux/mm.h>
16#include <linux/cpu.h>
17#include <linux/nmi.h>
18#include <linux/init.h>
19#include <linux/module.h>
20#include <linux/sysctl.h>
21#include <linux/tick.h>
22#include <linux/sched/clock.h>
23#include <linux/sched/debug.h>
24#include <linux/sched/isolation.h>
25#include <linux/stop_machine.h>
26
27#include <asm/irq_regs.h>
28#include <linux/kvm_para.h>
29
30static DEFINE_MUTEX(watchdog_mutex);
31
32#if defined(CONFIG_HARDLOCKUP_DETECTOR) || defined(CONFIG_HAVE_NMI_WATCHDOG)
33# define WATCHDOG_DEFAULT (SOFT_WATCHDOG_ENABLED | NMI_WATCHDOG_ENABLED)
34# define NMI_WATCHDOG_DEFAULT 1
35#else
36# define WATCHDOG_DEFAULT (SOFT_WATCHDOG_ENABLED)
37# define NMI_WATCHDOG_DEFAULT 0
38#endif
39
40unsigned long __read_mostly watchdog_enabled;
41int __read_mostly watchdog_user_enabled = 1;
42int __read_mostly nmi_watchdog_user_enabled = NMI_WATCHDOG_DEFAULT;
43int __read_mostly soft_watchdog_user_enabled = 1;
44int __read_mostly watchdog_thresh = 10;
45static int __read_mostly nmi_watchdog_available;
46
47struct cpumask watchdog_cpumask __read_mostly;
48unsigned long *watchdog_cpumask_bits = cpumask_bits(&watchdog_cpumask);
49
50#ifdef CONFIG_HARDLOCKUP_DETECTOR
51
52# ifdef CONFIG_SMP
53int __read_mostly sysctl_hardlockup_all_cpu_backtrace;
54# endif /* CONFIG_SMP */
55
56/*
57 * Should we panic when a soft-lockup or hard-lockup occurs:
58 */
59unsigned int __read_mostly hardlockup_panic =
60 IS_ENABLED(CONFIG_BOOTPARAM_HARDLOCKUP_PANIC);
61/*
62 * We may not want to enable hard lockup detection by default in all cases,
63 * for example when running the kernel as a guest on a hypervisor. In these
64 * cases this function can be called to disable hard lockup detection. This
65 * function should only be executed once by the boot processor before the
66 * kernel command line parameters are parsed, because otherwise it is not
67 * possible to override this in hardlockup_panic_setup().
68 */
69void __init hardlockup_detector_disable(void)
70{
71 nmi_watchdog_user_enabled = 0;
72}
73
74static int __init hardlockup_panic_setup(char *str)
75{
76 if (!strncmp(str, "panic", 5))
77 hardlockup_panic = 1;
78 else if (!strncmp(str, "nopanic", 7))
79 hardlockup_panic = 0;
80 else if (!strncmp(str, "0", 1))
81 nmi_watchdog_user_enabled = 0;
82 else if (!strncmp(str, "1", 1))
83 nmi_watchdog_user_enabled = 1;
84 return 1;
85}
86__setup("nmi_watchdog=", hardlockup_panic_setup);
87
88#endif /* CONFIG_HARDLOCKUP_DETECTOR */
89
90/*
91 * These functions can be overridden if an architecture implements its
92 * own hardlockup detector.
93 *
94 * watchdog_nmi_enable/disable can be implemented to start and stop when
95 * softlockup watchdog start and stop. The arch must select the
96 * SOFTLOCKUP_DETECTOR Kconfig.
97 */
98int __weak watchdog_nmi_enable(unsigned int cpu)
99{
100 hardlockup_detector_perf_enable();
101 return 0;
102}
103
104void __weak watchdog_nmi_disable(unsigned int cpu)
105{
106 hardlockup_detector_perf_disable();
107}
108
109/* Return 0, if a NMI watchdog is available. Error code otherwise */
110int __weak __init watchdog_nmi_probe(void)
111{
112 return hardlockup_detector_perf_init();
113}
114
115/**
116 * watchdog_nmi_stop - Stop the watchdog for reconfiguration
117 *
118 * The reconfiguration steps are:
119 * watchdog_nmi_stop();
120 * update_variables();
121 * watchdog_nmi_start();
122 */
123void __weak watchdog_nmi_stop(void) { }
124
125/**
126 * watchdog_nmi_start - Start the watchdog after reconfiguration
127 *
128 * Counterpart to watchdog_nmi_stop().
129 *
130 * The following variables have been updated in update_variables() and
131 * contain the currently valid configuration:
132 * - watchdog_enabled
133 * - watchdog_thresh
134 * - watchdog_cpumask
135 */
136void __weak watchdog_nmi_start(void) { }
137
138/**
139 * lockup_detector_update_enable - Update the sysctl enable bit
140 *
141 * Caller needs to make sure that the NMI/perf watchdogs are off, so this
142 * can't race with watchdog_nmi_disable().
143 */
144static void lockup_detector_update_enable(void)
145{
146 watchdog_enabled = 0;
147 if (!watchdog_user_enabled)
148 return;
149 if (nmi_watchdog_available && nmi_watchdog_user_enabled)
150 watchdog_enabled |= NMI_WATCHDOG_ENABLED;
151 if (soft_watchdog_user_enabled)
152 watchdog_enabled |= SOFT_WATCHDOG_ENABLED;
153}
154
155#ifdef CONFIG_SOFTLOCKUP_DETECTOR
156
157/*
158 * Delay the soflockup report when running a known slow code.
159 * It does _not_ affect the timestamp of the last successdul reschedule.
160 */
161#define SOFTLOCKUP_DELAY_REPORT ULONG_MAX
162
163#ifdef CONFIG_SMP
164int __read_mostly sysctl_softlockup_all_cpu_backtrace;
165#endif
166
167static struct cpumask watchdog_allowed_mask __read_mostly;
168
169/* Global variables, exported for sysctl */
170unsigned int __read_mostly softlockup_panic =
171 IS_ENABLED(CONFIG_BOOTPARAM_SOFTLOCKUP_PANIC);
172
173static bool softlockup_initialized __read_mostly;
174static u64 __read_mostly sample_period;
175
176/* Timestamp taken after the last successful reschedule. */
177static DEFINE_PER_CPU(unsigned long, watchdog_touch_ts);
178/* Timestamp of the last softlockup report. */
179static DEFINE_PER_CPU(unsigned long, watchdog_report_ts);
180static DEFINE_PER_CPU(struct hrtimer, watchdog_hrtimer);
181static DEFINE_PER_CPU(bool, softlockup_touch_sync);
182static DEFINE_PER_CPU(unsigned long, hrtimer_interrupts);
183static DEFINE_PER_CPU(unsigned long, hrtimer_interrupts_saved);
184static unsigned long soft_lockup_nmi_warn;
185
186static int __init nowatchdog_setup(char *str)
187{
188 watchdog_user_enabled = 0;
189 return 1;
190}
191__setup("nowatchdog", nowatchdog_setup);
192
193static int __init nosoftlockup_setup(char *str)
194{
195 soft_watchdog_user_enabled = 0;
196 return 1;
197}
198__setup("nosoftlockup", nosoftlockup_setup);
199
200static int __init watchdog_thresh_setup(char *str)
201{
202 get_option(&str, &watchdog_thresh);
203 return 1;
204}
205__setup("watchdog_thresh=", watchdog_thresh_setup);
206
207static void __lockup_detector_cleanup(void);
208
209/*
210 * Hard-lockup warnings should be triggered after just a few seconds. Soft-
211 * lockups can have false positives under extreme conditions. So we generally
212 * want a higher threshold for soft lockups than for hard lockups. So we couple
213 * the thresholds with a factor: we make the soft threshold twice the amount of
214 * time the hard threshold is.
215 */
216static int get_softlockup_thresh(void)
217{
218 return watchdog_thresh * 2;
219}
220
221/*
222 * Returns seconds, approximately. We don't need nanosecond
223 * resolution, and we don't need to waste time with a big divide when
224 * 2^30ns == 1.074s.
225 */
226static unsigned long get_timestamp(void)
227{
228 return running_clock() >> 30LL; /* 2^30 ~= 10^9 */
229}
230
231static void set_sample_period(void)
232{
233 /*
234 * convert watchdog_thresh from seconds to ns
235 * the divide by 5 is to give hrtimer several chances (two
236 * or three with the current relation between the soft
237 * and hard thresholds) to increment before the
238 * hardlockup detector generates a warning
239 */
240 sample_period = get_softlockup_thresh() * ((u64)NSEC_PER_SEC / 5);
241 watchdog_update_hrtimer_threshold(sample_period);
242}
243
244static void update_report_ts(void)
245{
246 __this_cpu_write(watchdog_report_ts, get_timestamp());
247}
248
249/* Commands for resetting the watchdog */
250static void update_touch_ts(void)
251{
252 __this_cpu_write(watchdog_touch_ts, get_timestamp());
253 update_report_ts();
254}
255
256/**
257 * touch_softlockup_watchdog_sched - touch watchdog on scheduler stalls
258 *
259 * Call when the scheduler may have stalled for legitimate reasons
260 * preventing the watchdog task from executing - e.g. the scheduler
261 * entering idle state. This should only be used for scheduler events.
262 * Use touch_softlockup_watchdog() for everything else.
263 */
264notrace void touch_softlockup_watchdog_sched(void)
265{
266 /*
267 * Preemption can be enabled. It doesn't matter which CPU's watchdog
268 * report period gets restarted here, so use the raw_ operation.
269 */
270 raw_cpu_write(watchdog_report_ts, SOFTLOCKUP_DELAY_REPORT);
271}
272
273notrace void touch_softlockup_watchdog(void)
274{
275 touch_softlockup_watchdog_sched();
276 wq_watchdog_touch(raw_smp_processor_id());
277}
278EXPORT_SYMBOL(touch_softlockup_watchdog);
279
280void touch_all_softlockup_watchdogs(void)
281{
282 int cpu;
283
284 /*
285 * watchdog_mutex cannpt be taken here, as this might be called
286 * from (soft)interrupt context, so the access to
287 * watchdog_allowed_cpumask might race with a concurrent update.
288 *
289 * The watchdog time stamp can race against a concurrent real
290 * update as well, the only side effect might be a cycle delay for
291 * the softlockup check.
292 */
293 for_each_cpu(cpu, &watchdog_allowed_mask) {
294 per_cpu(watchdog_report_ts, cpu) = SOFTLOCKUP_DELAY_REPORT;
295 wq_watchdog_touch(cpu);
296 }
297}
298
299void touch_softlockup_watchdog_sync(void)
300{
301 __this_cpu_write(softlockup_touch_sync, true);
302 __this_cpu_write(watchdog_report_ts, SOFTLOCKUP_DELAY_REPORT);
303}
304
305static int is_softlockup(unsigned long touch_ts,
306 unsigned long period_ts,
307 unsigned long now)
308{
309 if ((watchdog_enabled & SOFT_WATCHDOG_ENABLED) && watchdog_thresh){
310 /* Warn about unreasonable delays. */
311 if (time_after(now, period_ts + get_softlockup_thresh()))
312 return now - touch_ts;
313 }
314 return 0;
315}
316
317/* watchdog detector functions */
318bool is_hardlockup(void)
319{
320 unsigned long hrint = __this_cpu_read(hrtimer_interrupts);
321
322 if (__this_cpu_read(hrtimer_interrupts_saved) == hrint)
323 return true;
324
325 __this_cpu_write(hrtimer_interrupts_saved, hrint);
326 return false;
327}
328
329static void watchdog_interrupt_count(void)
330{
331 __this_cpu_inc(hrtimer_interrupts);
332}
333
334static DEFINE_PER_CPU(struct completion, softlockup_completion);
335static DEFINE_PER_CPU(struct cpu_stop_work, softlockup_stop_work);
336
337/*
338 * The watchdog feed function - touches the timestamp.
339 *
340 * It only runs once every sample_period seconds (4 seconds by
341 * default) to reset the softlockup timestamp. If this gets delayed
342 * for more than 2*watchdog_thresh seconds then the debug-printout
343 * triggers in watchdog_timer_fn().
344 */
345static int softlockup_fn(void *data)
346{
347 update_touch_ts();
348 complete(this_cpu_ptr(&softlockup_completion));
349
350 return 0;
351}
352
353/* watchdog kicker functions */
354static enum hrtimer_restart watchdog_timer_fn(struct hrtimer *hrtimer)
355{
356 unsigned long touch_ts, period_ts, now;
357 struct pt_regs *regs = get_irq_regs();
358 int duration;
359 int softlockup_all_cpu_backtrace = sysctl_softlockup_all_cpu_backtrace;
360
361 if (!watchdog_enabled)
362 return HRTIMER_NORESTART;
363
364 /* kick the hardlockup detector */
365 watchdog_interrupt_count();
366
367 /* kick the softlockup detector */
368 if (completion_done(this_cpu_ptr(&softlockup_completion))) {
369 reinit_completion(this_cpu_ptr(&softlockup_completion));
370 stop_one_cpu_nowait(smp_processor_id(),
371 softlockup_fn, NULL,
372 this_cpu_ptr(&softlockup_stop_work));
373 }
374
375 /* .. and repeat */
376 hrtimer_forward_now(hrtimer, ns_to_ktime(sample_period));
377
378 /*
379 * Read the current timestamp first. It might become invalid anytime
380 * when a virtual machine is stopped by the host or when the watchog
381 * is touched from NMI.
382 */
383 now = get_timestamp();
384 /*
385 * If a virtual machine is stopped by the host it can look to
386 * the watchdog like a soft lockup. This function touches the watchdog.
387 */
388 kvm_check_and_clear_guest_paused();
389 /*
390 * The stored timestamp is comparable with @now only when not touched.
391 * It might get touched anytime from NMI. Make sure that is_softlockup()
392 * uses the same (valid) value.
393 */
394 period_ts = READ_ONCE(*this_cpu_ptr(&watchdog_report_ts));
395
396 /* Reset the interval when touched by known problematic code. */
397 if (period_ts == SOFTLOCKUP_DELAY_REPORT) {
398 if (unlikely(__this_cpu_read(softlockup_touch_sync))) {
399 /*
400 * If the time stamp was touched atomically
401 * make sure the scheduler tick is up to date.
402 */
403 __this_cpu_write(softlockup_touch_sync, false);
404 sched_clock_tick();
405 }
406
407 update_report_ts();
408 return HRTIMER_RESTART;
409 }
410
411 /* Check for a softlockup. */
412 touch_ts = __this_cpu_read(watchdog_touch_ts);
413 duration = is_softlockup(touch_ts, period_ts, now);
414 if (unlikely(duration)) {
415 /*
416 * Prevent multiple soft-lockup reports if one cpu is already
417 * engaged in dumping all cpu back traces.
418 */
419 if (softlockup_all_cpu_backtrace) {
420 if (test_and_set_bit_lock(0, &soft_lockup_nmi_warn))
421 return HRTIMER_RESTART;
422 }
423
424 /* Start period for the next softlockup warning. */
425 update_report_ts();
426
427 pr_emerg("BUG: soft lockup - CPU#%d stuck for %us! [%s:%d]\n",
428 smp_processor_id(), duration,
429 current->comm, task_pid_nr(current));
430 print_modules();
431 print_irqtrace_events(current);
432 if (regs)
433 show_regs(regs);
434 else
435 dump_stack();
436
437 if (softlockup_all_cpu_backtrace) {
438 trigger_allbutself_cpu_backtrace();
439 clear_bit_unlock(0, &soft_lockup_nmi_warn);
440 }
441
442 add_taint(TAINT_SOFTLOCKUP, LOCKDEP_STILL_OK);
443 if (softlockup_panic)
444 panic("softlockup: hung tasks");
445 }
446
447 return HRTIMER_RESTART;
448}
449
450static void watchdog_enable(unsigned int cpu)
451{
452 struct hrtimer *hrtimer = this_cpu_ptr(&watchdog_hrtimer);
453 struct completion *done = this_cpu_ptr(&softlockup_completion);
454
455 WARN_ON_ONCE(cpu != smp_processor_id());
456
457 init_completion(done);
458 complete(done);
459
460 /*
461 * Start the timer first to prevent the NMI watchdog triggering
462 * before the timer has a chance to fire.
463 */
464 hrtimer_init(hrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_REL_HARD);
465 hrtimer->function = watchdog_timer_fn;
466 hrtimer_start(hrtimer, ns_to_ktime(sample_period),
467 HRTIMER_MODE_REL_PINNED_HARD);
468
469 /* Initialize timestamp */
470 update_touch_ts();
471 /* Enable the perf event */
472 if (watchdog_enabled & NMI_WATCHDOG_ENABLED)
473 watchdog_nmi_enable(cpu);
474}
475
476static void watchdog_disable(unsigned int cpu)
477{
478 struct hrtimer *hrtimer = this_cpu_ptr(&watchdog_hrtimer);
479
480 WARN_ON_ONCE(cpu != smp_processor_id());
481
482 /*
483 * Disable the perf event first. That prevents that a large delay
484 * between disabling the timer and disabling the perf event causes
485 * the perf NMI to detect a false positive.
486 */
487 watchdog_nmi_disable(cpu);
488 hrtimer_cancel(hrtimer);
489 wait_for_completion(this_cpu_ptr(&softlockup_completion));
490}
491
492static int softlockup_stop_fn(void *data)
493{
494 watchdog_disable(smp_processor_id());
495 return 0;
496}
497
498static void softlockup_stop_all(void)
499{
500 int cpu;
501
502 if (!softlockup_initialized)
503 return;
504
505 for_each_cpu(cpu, &watchdog_allowed_mask)
506 smp_call_on_cpu(cpu, softlockup_stop_fn, NULL, false);
507
508 cpumask_clear(&watchdog_allowed_mask);
509}
510
511static int softlockup_start_fn(void *data)
512{
513 watchdog_enable(smp_processor_id());
514 return 0;
515}
516
517static void softlockup_start_all(void)
518{
519 int cpu;
520
521 cpumask_copy(&watchdog_allowed_mask, &watchdog_cpumask);
522 for_each_cpu(cpu, &watchdog_allowed_mask)
523 smp_call_on_cpu(cpu, softlockup_start_fn, NULL, false);
524}
525
526int lockup_detector_online_cpu(unsigned int cpu)
527{
528 if (cpumask_test_cpu(cpu, &watchdog_allowed_mask))
529 watchdog_enable(cpu);
530 return 0;
531}
532
533int lockup_detector_offline_cpu(unsigned int cpu)
534{
535 if (cpumask_test_cpu(cpu, &watchdog_allowed_mask))
536 watchdog_disable(cpu);
537 return 0;
538}
539
540static void __lockup_detector_reconfigure(void)
541{
542 cpus_read_lock();
543 watchdog_nmi_stop();
544
545 softlockup_stop_all();
546 set_sample_period();
547 lockup_detector_update_enable();
548 if (watchdog_enabled && watchdog_thresh)
549 softlockup_start_all();
550
551 watchdog_nmi_start();
552 cpus_read_unlock();
553 /*
554 * Must be called outside the cpus locked section to prevent
555 * recursive locking in the perf code.
556 */
557 __lockup_detector_cleanup();
558}
559
560void lockup_detector_reconfigure(void)
561{
562 mutex_lock(&watchdog_mutex);
563 __lockup_detector_reconfigure();
564 mutex_unlock(&watchdog_mutex);
565}
566
567/*
568 * Create the watchdog infrastructure and configure the detector(s).
569 */
570static __init void lockup_detector_setup(void)
571{
572 /*
573 * If sysctl is off and watchdog got disabled on the command line,
574 * nothing to do here.
575 */
576 lockup_detector_update_enable();
577
578 if (!IS_ENABLED(CONFIG_SYSCTL) &&
579 !(watchdog_enabled && watchdog_thresh))
580 return;
581
582 mutex_lock(&watchdog_mutex);
583 __lockup_detector_reconfigure();
584 softlockup_initialized = true;
585 mutex_unlock(&watchdog_mutex);
586}
587
588#else /* CONFIG_SOFTLOCKUP_DETECTOR */
589static void __lockup_detector_reconfigure(void)
590{
591 cpus_read_lock();
592 watchdog_nmi_stop();
593 lockup_detector_update_enable();
594 watchdog_nmi_start();
595 cpus_read_unlock();
596}
597void lockup_detector_reconfigure(void)
598{
599 __lockup_detector_reconfigure();
600}
601static inline void lockup_detector_setup(void)
602{
603 __lockup_detector_reconfigure();
604}
605#endif /* !CONFIG_SOFTLOCKUP_DETECTOR */
606
607static void __lockup_detector_cleanup(void)
608{
609 lockdep_assert_held(&watchdog_mutex);
610 hardlockup_detector_perf_cleanup();
611}
612
613/**
614 * lockup_detector_cleanup - Cleanup after cpu hotplug or sysctl changes
615 *
616 * Caller must not hold the cpu hotplug rwsem.
617 */
618void lockup_detector_cleanup(void)
619{
620 mutex_lock(&watchdog_mutex);
621 __lockup_detector_cleanup();
622 mutex_unlock(&watchdog_mutex);
623}
624
625/**
626 * lockup_detector_soft_poweroff - Interface to stop lockup detector(s)
627 *
628 * Special interface for parisc. It prevents lockup detector warnings from
629 * the default pm_poweroff() function which busy loops forever.
630 */
631void lockup_detector_soft_poweroff(void)
632{
633 watchdog_enabled = 0;
634}
635
636#ifdef CONFIG_SYSCTL
637
638/* Propagate any changes to the watchdog infrastructure */
639static void proc_watchdog_update(void)
640{
641 /* Remove impossible cpus to keep sysctl output clean. */
642 cpumask_and(&watchdog_cpumask, &watchdog_cpumask, cpu_possible_mask);
643 __lockup_detector_reconfigure();
644}
645
646/*
647 * common function for watchdog, nmi_watchdog and soft_watchdog parameter
648 *
649 * caller | table->data points to | 'which'
650 * -------------------|----------------------------|--------------------------
651 * proc_watchdog | watchdog_user_enabled | NMI_WATCHDOG_ENABLED |
652 * | | SOFT_WATCHDOG_ENABLED
653 * -------------------|----------------------------|--------------------------
654 * proc_nmi_watchdog | nmi_watchdog_user_enabled | NMI_WATCHDOG_ENABLED
655 * -------------------|----------------------------|--------------------------
656 * proc_soft_watchdog | soft_watchdog_user_enabled | SOFT_WATCHDOG_ENABLED
657 */
658static int proc_watchdog_common(int which, struct ctl_table *table, int write,
659 void *buffer, size_t *lenp, loff_t *ppos)
660{
661 int err, old, *param = table->data;
662
663 mutex_lock(&watchdog_mutex);
664
665 if (!write) {
666 /*
667 * On read synchronize the userspace interface. This is a
668 * racy snapshot.
669 */
670 *param = (watchdog_enabled & which) != 0;
671 err = proc_dointvec_minmax(table, write, buffer, lenp, ppos);
672 } else {
673 old = READ_ONCE(*param);
674 err = proc_dointvec_minmax(table, write, buffer, lenp, ppos);
675 if (!err && old != READ_ONCE(*param))
676 proc_watchdog_update();
677 }
678 mutex_unlock(&watchdog_mutex);
679 return err;
680}
681
682/*
683 * /proc/sys/kernel/watchdog
684 */
685int proc_watchdog(struct ctl_table *table, int write,
686 void *buffer, size_t *lenp, loff_t *ppos)
687{
688 return proc_watchdog_common(NMI_WATCHDOG_ENABLED|SOFT_WATCHDOG_ENABLED,
689 table, write, buffer, lenp, ppos);
690}
691
692/*
693 * /proc/sys/kernel/nmi_watchdog
694 */
695int proc_nmi_watchdog(struct ctl_table *table, int write,
696 void *buffer, size_t *lenp, loff_t *ppos)
697{
698 if (!nmi_watchdog_available && write)
699 return -ENOTSUPP;
700 return proc_watchdog_common(NMI_WATCHDOG_ENABLED,
701 table, write, buffer, lenp, ppos);
702}
703
704/*
705 * /proc/sys/kernel/soft_watchdog
706 */
707int proc_soft_watchdog(struct ctl_table *table, int write,
708 void *buffer, size_t *lenp, loff_t *ppos)
709{
710 return proc_watchdog_common(SOFT_WATCHDOG_ENABLED,
711 table, write, buffer, lenp, ppos);
712}
713
714/*
715 * /proc/sys/kernel/watchdog_thresh
716 */
717int proc_watchdog_thresh(struct ctl_table *table, int write,
718 void *buffer, size_t *lenp, loff_t *ppos)
719{
720 int err, old;
721
722 mutex_lock(&watchdog_mutex);
723
724 old = READ_ONCE(watchdog_thresh);
725 err = proc_dointvec_minmax(table, write, buffer, lenp, ppos);
726
727 if (!err && write && old != READ_ONCE(watchdog_thresh))
728 proc_watchdog_update();
729
730 mutex_unlock(&watchdog_mutex);
731 return err;
732}
733
734/*
735 * The cpumask is the mask of possible cpus that the watchdog can run
736 * on, not the mask of cpus it is actually running on. This allows the
737 * user to specify a mask that will include cpus that have not yet
738 * been brought online, if desired.
739 */
740int proc_watchdog_cpumask(struct ctl_table *table, int write,
741 void *buffer, size_t *lenp, loff_t *ppos)
742{
743 int err;
744
745 mutex_lock(&watchdog_mutex);
746
747 err = proc_do_large_bitmap(table, write, buffer, lenp, ppos);
748 if (!err && write)
749 proc_watchdog_update();
750
751 mutex_unlock(&watchdog_mutex);
752 return err;
753}
754
755static const int sixty = 60;
756
757static struct ctl_table watchdog_sysctls[] = {
758 {
759 .procname = "watchdog",
760 .data = &watchdog_user_enabled,
761 .maxlen = sizeof(int),
762 .mode = 0644,
763 .proc_handler = proc_watchdog,
764 .extra1 = SYSCTL_ZERO,
765 .extra2 = SYSCTL_ONE,
766 },
767 {
768 .procname = "watchdog_thresh",
769 .data = &watchdog_thresh,
770 .maxlen = sizeof(int),
771 .mode = 0644,
772 .proc_handler = proc_watchdog_thresh,
773 .extra1 = SYSCTL_ZERO,
774 .extra2 = (void *)&sixty,
775 },
776 {
777 .procname = "nmi_watchdog",
778 .data = &nmi_watchdog_user_enabled,
779 .maxlen = sizeof(int),
780 .mode = NMI_WATCHDOG_SYSCTL_PERM,
781 .proc_handler = proc_nmi_watchdog,
782 .extra1 = SYSCTL_ZERO,
783 .extra2 = SYSCTL_ONE,
784 },
785 {
786 .procname = "watchdog_cpumask",
787 .data = &watchdog_cpumask_bits,
788 .maxlen = NR_CPUS,
789 .mode = 0644,
790 .proc_handler = proc_watchdog_cpumask,
791 },
792#ifdef CONFIG_SOFTLOCKUP_DETECTOR
793 {
794 .procname = "soft_watchdog",
795 .data = &soft_watchdog_user_enabled,
796 .maxlen = sizeof(int),
797 .mode = 0644,
798 .proc_handler = proc_soft_watchdog,
799 .extra1 = SYSCTL_ZERO,
800 .extra2 = SYSCTL_ONE,
801 },
802 {
803 .procname = "softlockup_panic",
804 .data = &softlockup_panic,
805 .maxlen = sizeof(int),
806 .mode = 0644,
807 .proc_handler = proc_dointvec_minmax,
808 .extra1 = SYSCTL_ZERO,
809 .extra2 = SYSCTL_ONE,
810 },
811#ifdef CONFIG_SMP
812 {
813 .procname = "softlockup_all_cpu_backtrace",
814 .data = &sysctl_softlockup_all_cpu_backtrace,
815 .maxlen = sizeof(int),
816 .mode = 0644,
817 .proc_handler = proc_dointvec_minmax,
818 .extra1 = SYSCTL_ZERO,
819 .extra2 = SYSCTL_ONE,
820 },
821#endif /* CONFIG_SMP */
822#endif
823#ifdef CONFIG_HARDLOCKUP_DETECTOR
824 {
825 .procname = "hardlockup_panic",
826 .data = &hardlockup_panic,
827 .maxlen = sizeof(int),
828 .mode = 0644,
829 .proc_handler = proc_dointvec_minmax,
830 .extra1 = SYSCTL_ZERO,
831 .extra2 = SYSCTL_ONE,
832 },
833#ifdef CONFIG_SMP
834 {
835 .procname = "hardlockup_all_cpu_backtrace",
836 .data = &sysctl_hardlockup_all_cpu_backtrace,
837 .maxlen = sizeof(int),
838 .mode = 0644,
839 .proc_handler = proc_dointvec_minmax,
840 .extra1 = SYSCTL_ZERO,
841 .extra2 = SYSCTL_ONE,
842 },
843#endif /* CONFIG_SMP */
844#endif
845 {}
846};
847
848static void __init watchdog_sysctl_init(void)
849{
850 register_sysctl_init("kernel", watchdog_sysctls);
851}
852#else
853#define watchdog_sysctl_init() do { } while (0)
854#endif /* CONFIG_SYSCTL */
855
856void __init lockup_detector_init(void)
857{
858 if (tick_nohz_full_enabled())
859 pr_info("Disabling watchdog on nohz_full cores by default\n");
860
861 cpumask_copy(&watchdog_cpumask,
862 housekeeping_cpumask(HK_TYPE_TIMER));
863
864 if (!watchdog_nmi_probe())
865 nmi_watchdog_available = true;
866 lockup_detector_setup();
867 watchdog_sysctl_init();
868}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Detect hard and soft lockups on a system
4 *
5 * started by Don Zickus, Copyright (C) 2010 Red Hat, Inc.
6 *
7 * Note: Most of this code is borrowed heavily from the original softlockup
8 * detector, so thanks to Ingo for the initial implementation.
9 * Some chunks also taken from the old x86-specific nmi watchdog code, thanks
10 * to those contributors as well.
11 */
12
13#define pr_fmt(fmt) "watchdog: " fmt
14
15#include <linux/mm.h>
16#include <linux/cpu.h>
17#include <linux/nmi.h>
18#include <linux/init.h>
19#include <linux/module.h>
20#include <linux/sysctl.h>
21#include <linux/smpboot.h>
22#include <linux/sched/rt.h>
23#include <uapi/linux/sched/types.h>
24#include <linux/tick.h>
25#include <linux/workqueue.h>
26#include <linux/sched/clock.h>
27#include <linux/sched/debug.h>
28#include <linux/sched/isolation.h>
29
30#include <asm/irq_regs.h>
31#include <linux/kvm_para.h>
32#include <linux/kthread.h>
33
34static DEFINE_MUTEX(watchdog_mutex);
35
36#if defined(CONFIG_HARDLOCKUP_DETECTOR) || defined(CONFIG_HAVE_NMI_WATCHDOG)
37# define WATCHDOG_DEFAULT (SOFT_WATCHDOG_ENABLED | NMI_WATCHDOG_ENABLED)
38# define NMI_WATCHDOG_DEFAULT 1
39#else
40# define WATCHDOG_DEFAULT (SOFT_WATCHDOG_ENABLED)
41# define NMI_WATCHDOG_DEFAULT 0
42#endif
43
44unsigned long __read_mostly watchdog_enabled;
45int __read_mostly watchdog_user_enabled = 1;
46int __read_mostly nmi_watchdog_user_enabled = NMI_WATCHDOG_DEFAULT;
47int __read_mostly soft_watchdog_user_enabled = 1;
48int __read_mostly watchdog_thresh = 10;
49int __read_mostly nmi_watchdog_available;
50
51struct cpumask watchdog_allowed_mask __read_mostly;
52
53struct cpumask watchdog_cpumask __read_mostly;
54unsigned long *watchdog_cpumask_bits = cpumask_bits(&watchdog_cpumask);
55
56#ifdef CONFIG_HARDLOCKUP_DETECTOR
57/*
58 * Should we panic when a soft-lockup or hard-lockup occurs:
59 */
60unsigned int __read_mostly hardlockup_panic =
61 CONFIG_BOOTPARAM_HARDLOCKUP_PANIC_VALUE;
62/*
63 * We may not want to enable hard lockup detection by default in all cases,
64 * for example when running the kernel as a guest on a hypervisor. In these
65 * cases this function can be called to disable hard lockup detection. This
66 * function should only be executed once by the boot processor before the
67 * kernel command line parameters are parsed, because otherwise it is not
68 * possible to override this in hardlockup_panic_setup().
69 */
70void __init hardlockup_detector_disable(void)
71{
72 nmi_watchdog_user_enabled = 0;
73}
74
75static int __init hardlockup_panic_setup(char *str)
76{
77 if (!strncmp(str, "panic", 5))
78 hardlockup_panic = 1;
79 else if (!strncmp(str, "nopanic", 7))
80 hardlockup_panic = 0;
81 else if (!strncmp(str, "0", 1))
82 nmi_watchdog_user_enabled = 0;
83 else if (!strncmp(str, "1", 1))
84 nmi_watchdog_user_enabled = 1;
85 return 1;
86}
87__setup("nmi_watchdog=", hardlockup_panic_setup);
88
89# ifdef CONFIG_SMP
90int __read_mostly sysctl_hardlockup_all_cpu_backtrace;
91
92static int __init hardlockup_all_cpu_backtrace_setup(char *str)
93{
94 sysctl_hardlockup_all_cpu_backtrace = !!simple_strtol(str, NULL, 0);
95 return 1;
96}
97__setup("hardlockup_all_cpu_backtrace=", hardlockup_all_cpu_backtrace_setup);
98# endif /* CONFIG_SMP */
99#endif /* CONFIG_HARDLOCKUP_DETECTOR */
100
101/*
102 * These functions can be overridden if an architecture implements its
103 * own hardlockup detector.
104 *
105 * watchdog_nmi_enable/disable can be implemented to start and stop when
106 * softlockup watchdog threads start and stop. The arch must select the
107 * SOFTLOCKUP_DETECTOR Kconfig.
108 */
109int __weak watchdog_nmi_enable(unsigned int cpu)
110{
111 hardlockup_detector_perf_enable();
112 return 0;
113}
114
115void __weak watchdog_nmi_disable(unsigned int cpu)
116{
117 hardlockup_detector_perf_disable();
118}
119
120/* Return 0, if a NMI watchdog is available. Error code otherwise */
121int __weak __init watchdog_nmi_probe(void)
122{
123 return hardlockup_detector_perf_init();
124}
125
126/**
127 * watchdog_nmi_stop - Stop the watchdog for reconfiguration
128 *
129 * The reconfiguration steps are:
130 * watchdog_nmi_stop();
131 * update_variables();
132 * watchdog_nmi_start();
133 */
134void __weak watchdog_nmi_stop(void) { }
135
136/**
137 * watchdog_nmi_start - Start the watchdog after reconfiguration
138 *
139 * Counterpart to watchdog_nmi_stop().
140 *
141 * The following variables have been updated in update_variables() and
142 * contain the currently valid configuration:
143 * - watchdog_enabled
144 * - watchdog_thresh
145 * - watchdog_cpumask
146 */
147void __weak watchdog_nmi_start(void) { }
148
149/**
150 * lockup_detector_update_enable - Update the sysctl enable bit
151 *
152 * Caller needs to make sure that the NMI/perf watchdogs are off, so this
153 * can't race with watchdog_nmi_disable().
154 */
155static void lockup_detector_update_enable(void)
156{
157 watchdog_enabled = 0;
158 if (!watchdog_user_enabled)
159 return;
160 if (nmi_watchdog_available && nmi_watchdog_user_enabled)
161 watchdog_enabled |= NMI_WATCHDOG_ENABLED;
162 if (soft_watchdog_user_enabled)
163 watchdog_enabled |= SOFT_WATCHDOG_ENABLED;
164}
165
166#ifdef CONFIG_SOFTLOCKUP_DETECTOR
167
168/* Global variables, exported for sysctl */
169unsigned int __read_mostly softlockup_panic =
170 CONFIG_BOOTPARAM_SOFTLOCKUP_PANIC_VALUE;
171
172static bool softlockup_threads_initialized __read_mostly;
173static u64 __read_mostly sample_period;
174
175static DEFINE_PER_CPU(unsigned long, watchdog_touch_ts);
176static DEFINE_PER_CPU(struct task_struct *, softlockup_watchdog);
177static DEFINE_PER_CPU(struct hrtimer, watchdog_hrtimer);
178static DEFINE_PER_CPU(bool, softlockup_touch_sync);
179static DEFINE_PER_CPU(bool, soft_watchdog_warn);
180static DEFINE_PER_CPU(unsigned long, hrtimer_interrupts);
181static DEFINE_PER_CPU(unsigned long, soft_lockup_hrtimer_cnt);
182static DEFINE_PER_CPU(struct task_struct *, softlockup_task_ptr_saved);
183static DEFINE_PER_CPU(unsigned long, hrtimer_interrupts_saved);
184static unsigned long soft_lockup_nmi_warn;
185
186static int __init softlockup_panic_setup(char *str)
187{
188 softlockup_panic = simple_strtoul(str, NULL, 0);
189 return 1;
190}
191__setup("softlockup_panic=", softlockup_panic_setup);
192
193static int __init nowatchdog_setup(char *str)
194{
195 watchdog_user_enabled = 0;
196 return 1;
197}
198__setup("nowatchdog", nowatchdog_setup);
199
200static int __init nosoftlockup_setup(char *str)
201{
202 soft_watchdog_user_enabled = 0;
203 return 1;
204}
205__setup("nosoftlockup", nosoftlockup_setup);
206
207#ifdef CONFIG_SMP
208int __read_mostly sysctl_softlockup_all_cpu_backtrace;
209
210static int __init softlockup_all_cpu_backtrace_setup(char *str)
211{
212 sysctl_softlockup_all_cpu_backtrace = !!simple_strtol(str, NULL, 0);
213 return 1;
214}
215__setup("softlockup_all_cpu_backtrace=", softlockup_all_cpu_backtrace_setup);
216#endif
217
218static void __lockup_detector_cleanup(void);
219
220/*
221 * Hard-lockup warnings should be triggered after just a few seconds. Soft-
222 * lockups can have false positives under extreme conditions. So we generally
223 * want a higher threshold for soft lockups than for hard lockups. So we couple
224 * the thresholds with a factor: we make the soft threshold twice the amount of
225 * time the hard threshold is.
226 */
227static int get_softlockup_thresh(void)
228{
229 return watchdog_thresh * 2;
230}
231
232/*
233 * Returns seconds, approximately. We don't need nanosecond
234 * resolution, and we don't need to waste time with a big divide when
235 * 2^30ns == 1.074s.
236 */
237static unsigned long get_timestamp(void)
238{
239 return running_clock() >> 30LL; /* 2^30 ~= 10^9 */
240}
241
242static void set_sample_period(void)
243{
244 /*
245 * convert watchdog_thresh from seconds to ns
246 * the divide by 5 is to give hrtimer several chances (two
247 * or three with the current relation between the soft
248 * and hard thresholds) to increment before the
249 * hardlockup detector generates a warning
250 */
251 sample_period = get_softlockup_thresh() * ((u64)NSEC_PER_SEC / 5);
252 watchdog_update_hrtimer_threshold(sample_period);
253}
254
255/* Commands for resetting the watchdog */
256static void __touch_watchdog(void)
257{
258 __this_cpu_write(watchdog_touch_ts, get_timestamp());
259}
260
261/**
262 * touch_softlockup_watchdog_sched - touch watchdog on scheduler stalls
263 *
264 * Call when the scheduler may have stalled for legitimate reasons
265 * preventing the watchdog task from executing - e.g. the scheduler
266 * entering idle state. This should only be used for scheduler events.
267 * Use touch_softlockup_watchdog() for everything else.
268 */
269void touch_softlockup_watchdog_sched(void)
270{
271 /*
272 * Preemption can be enabled. It doesn't matter which CPU's timestamp
273 * gets zeroed here, so use the raw_ operation.
274 */
275 raw_cpu_write(watchdog_touch_ts, 0);
276}
277
278void touch_softlockup_watchdog(void)
279{
280 touch_softlockup_watchdog_sched();
281 wq_watchdog_touch(raw_smp_processor_id());
282}
283EXPORT_SYMBOL(touch_softlockup_watchdog);
284
285void touch_all_softlockup_watchdogs(void)
286{
287 int cpu;
288
289 /*
290 * watchdog_mutex cannpt be taken here, as this might be called
291 * from (soft)interrupt context, so the access to
292 * watchdog_allowed_cpumask might race with a concurrent update.
293 *
294 * The watchdog time stamp can race against a concurrent real
295 * update as well, the only side effect might be a cycle delay for
296 * the softlockup check.
297 */
298 for_each_cpu(cpu, &watchdog_allowed_mask)
299 per_cpu(watchdog_touch_ts, cpu) = 0;
300 wq_watchdog_touch(-1);
301}
302
303void touch_softlockup_watchdog_sync(void)
304{
305 __this_cpu_write(softlockup_touch_sync, true);
306 __this_cpu_write(watchdog_touch_ts, 0);
307}
308
309static int is_softlockup(unsigned long touch_ts)
310{
311 unsigned long now = get_timestamp();
312
313 if ((watchdog_enabled & SOFT_WATCHDOG_ENABLED) && watchdog_thresh){
314 /* Warn about unreasonable delays. */
315 if (time_after(now, touch_ts + get_softlockup_thresh()))
316 return now - touch_ts;
317 }
318 return 0;
319}
320
321/* watchdog detector functions */
322bool is_hardlockup(void)
323{
324 unsigned long hrint = __this_cpu_read(hrtimer_interrupts);
325
326 if (__this_cpu_read(hrtimer_interrupts_saved) == hrint)
327 return true;
328
329 __this_cpu_write(hrtimer_interrupts_saved, hrint);
330 return false;
331}
332
333static void watchdog_interrupt_count(void)
334{
335 __this_cpu_inc(hrtimer_interrupts);
336}
337
338/* watchdog kicker functions */
339static enum hrtimer_restart watchdog_timer_fn(struct hrtimer *hrtimer)
340{
341 unsigned long touch_ts = __this_cpu_read(watchdog_touch_ts);
342 struct pt_regs *regs = get_irq_regs();
343 int duration;
344 int softlockup_all_cpu_backtrace = sysctl_softlockup_all_cpu_backtrace;
345
346 if (!watchdog_enabled)
347 return HRTIMER_NORESTART;
348
349 /* kick the hardlockup detector */
350 watchdog_interrupt_count();
351
352 /* kick the softlockup detector */
353 wake_up_process(__this_cpu_read(softlockup_watchdog));
354
355 /* .. and repeat */
356 hrtimer_forward_now(hrtimer, ns_to_ktime(sample_period));
357
358 if (touch_ts == 0) {
359 if (unlikely(__this_cpu_read(softlockup_touch_sync))) {
360 /*
361 * If the time stamp was touched atomically
362 * make sure the scheduler tick is up to date.
363 */
364 __this_cpu_write(softlockup_touch_sync, false);
365 sched_clock_tick();
366 }
367
368 /* Clear the guest paused flag on watchdog reset */
369 kvm_check_and_clear_guest_paused();
370 __touch_watchdog();
371 return HRTIMER_RESTART;
372 }
373
374 /* check for a softlockup
375 * This is done by making sure a high priority task is
376 * being scheduled. The task touches the watchdog to
377 * indicate it is getting cpu time. If it hasn't then
378 * this is a good indication some task is hogging the cpu
379 */
380 duration = is_softlockup(touch_ts);
381 if (unlikely(duration)) {
382 /*
383 * If a virtual machine is stopped by the host it can look to
384 * the watchdog like a soft lockup, check to see if the host
385 * stopped the vm before we issue the warning
386 */
387 if (kvm_check_and_clear_guest_paused())
388 return HRTIMER_RESTART;
389
390 /* only warn once */
391 if (__this_cpu_read(soft_watchdog_warn) == true) {
392 /*
393 * When multiple processes are causing softlockups the
394 * softlockup detector only warns on the first one
395 * because the code relies on a full quiet cycle to
396 * re-arm. The second process prevents the quiet cycle
397 * and never gets reported. Use task pointers to detect
398 * this.
399 */
400 if (__this_cpu_read(softlockup_task_ptr_saved) !=
401 current) {
402 __this_cpu_write(soft_watchdog_warn, false);
403 __touch_watchdog();
404 }
405 return HRTIMER_RESTART;
406 }
407
408 if (softlockup_all_cpu_backtrace) {
409 /* Prevent multiple soft-lockup reports if one cpu is already
410 * engaged in dumping cpu back traces
411 */
412 if (test_and_set_bit(0, &soft_lockup_nmi_warn)) {
413 /* Someone else will report us. Let's give up */
414 __this_cpu_write(soft_watchdog_warn, true);
415 return HRTIMER_RESTART;
416 }
417 }
418
419 pr_emerg("BUG: soft lockup - CPU#%d stuck for %us! [%s:%d]\n",
420 smp_processor_id(), duration,
421 current->comm, task_pid_nr(current));
422 __this_cpu_write(softlockup_task_ptr_saved, current);
423 print_modules();
424 print_irqtrace_events(current);
425 if (regs)
426 show_regs(regs);
427 else
428 dump_stack();
429
430 if (softlockup_all_cpu_backtrace) {
431 /* Avoid generating two back traces for current
432 * given that one is already made above
433 */
434 trigger_allbutself_cpu_backtrace();
435
436 clear_bit(0, &soft_lockup_nmi_warn);
437 /* Barrier to sync with other cpus */
438 smp_mb__after_atomic();
439 }
440
441 add_taint(TAINT_SOFTLOCKUP, LOCKDEP_STILL_OK);
442 if (softlockup_panic)
443 panic("softlockup: hung tasks");
444 __this_cpu_write(soft_watchdog_warn, true);
445 } else
446 __this_cpu_write(soft_watchdog_warn, false);
447
448 return HRTIMER_RESTART;
449}
450
451static void watchdog_set_prio(unsigned int policy, unsigned int prio)
452{
453 struct sched_param param = { .sched_priority = prio };
454
455 sched_setscheduler(current, policy, ¶m);
456}
457
458static void watchdog_enable(unsigned int cpu)
459{
460 struct hrtimer *hrtimer = this_cpu_ptr(&watchdog_hrtimer);
461
462 /*
463 * Start the timer first to prevent the NMI watchdog triggering
464 * before the timer has a chance to fire.
465 */
466 hrtimer_init(hrtimer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
467 hrtimer->function = watchdog_timer_fn;
468 hrtimer_start(hrtimer, ns_to_ktime(sample_period),
469 HRTIMER_MODE_REL_PINNED);
470
471 /* Initialize timestamp */
472 __touch_watchdog();
473 /* Enable the perf event */
474 if (watchdog_enabled & NMI_WATCHDOG_ENABLED)
475 watchdog_nmi_enable(cpu);
476
477 watchdog_set_prio(SCHED_FIFO, MAX_RT_PRIO - 1);
478}
479
480static void watchdog_disable(unsigned int cpu)
481{
482 struct hrtimer *hrtimer = this_cpu_ptr(&watchdog_hrtimer);
483
484 watchdog_set_prio(SCHED_NORMAL, 0);
485 /*
486 * Disable the perf event first. That prevents that a large delay
487 * between disabling the timer and disabling the perf event causes
488 * the perf NMI to detect a false positive.
489 */
490 watchdog_nmi_disable(cpu);
491 hrtimer_cancel(hrtimer);
492}
493
494static void watchdog_cleanup(unsigned int cpu, bool online)
495{
496 watchdog_disable(cpu);
497}
498
499static int watchdog_should_run(unsigned int cpu)
500{
501 return __this_cpu_read(hrtimer_interrupts) !=
502 __this_cpu_read(soft_lockup_hrtimer_cnt);
503}
504
505/*
506 * The watchdog thread function - touches the timestamp.
507 *
508 * It only runs once every sample_period seconds (4 seconds by
509 * default) to reset the softlockup timestamp. If this gets delayed
510 * for more than 2*watchdog_thresh seconds then the debug-printout
511 * triggers in watchdog_timer_fn().
512 */
513static void watchdog(unsigned int cpu)
514{
515 __this_cpu_write(soft_lockup_hrtimer_cnt,
516 __this_cpu_read(hrtimer_interrupts));
517 __touch_watchdog();
518}
519
520static struct smp_hotplug_thread watchdog_threads = {
521 .store = &softlockup_watchdog,
522 .thread_should_run = watchdog_should_run,
523 .thread_fn = watchdog,
524 .thread_comm = "watchdog/%u",
525 .setup = watchdog_enable,
526 .cleanup = watchdog_cleanup,
527 .park = watchdog_disable,
528 .unpark = watchdog_enable,
529};
530
531static void softlockup_update_smpboot_threads(void)
532{
533 lockdep_assert_held(&watchdog_mutex);
534
535 if (!softlockup_threads_initialized)
536 return;
537
538 smpboot_update_cpumask_percpu_thread(&watchdog_threads,
539 &watchdog_allowed_mask);
540}
541
542/* Temporarily park all watchdog threads */
543static void softlockup_park_all_threads(void)
544{
545 cpumask_clear(&watchdog_allowed_mask);
546 softlockup_update_smpboot_threads();
547}
548
549/* Unpark enabled threads */
550static void softlockup_unpark_threads(void)
551{
552 cpumask_copy(&watchdog_allowed_mask, &watchdog_cpumask);
553 softlockup_update_smpboot_threads();
554}
555
556static void lockup_detector_reconfigure(void)
557{
558 cpus_read_lock();
559 watchdog_nmi_stop();
560 softlockup_park_all_threads();
561 set_sample_period();
562 lockup_detector_update_enable();
563 if (watchdog_enabled && watchdog_thresh)
564 softlockup_unpark_threads();
565 watchdog_nmi_start();
566 cpus_read_unlock();
567 /*
568 * Must be called outside the cpus locked section to prevent
569 * recursive locking in the perf code.
570 */
571 __lockup_detector_cleanup();
572}
573
574/*
575 * Create the watchdog thread infrastructure and configure the detector(s).
576 *
577 * The threads are not unparked as watchdog_allowed_mask is empty. When
578 * the threads are sucessfully initialized, take the proper locks and
579 * unpark the threads in the watchdog_cpumask if the watchdog is enabled.
580 */
581static __init void lockup_detector_setup(void)
582{
583 int ret;
584
585 /*
586 * If sysctl is off and watchdog got disabled on the command line,
587 * nothing to do here.
588 */
589 lockup_detector_update_enable();
590
591 if (!IS_ENABLED(CONFIG_SYSCTL) &&
592 !(watchdog_enabled && watchdog_thresh))
593 return;
594
595 ret = smpboot_register_percpu_thread_cpumask(&watchdog_threads,
596 &watchdog_allowed_mask);
597 if (ret) {
598 pr_err("Failed to initialize soft lockup detector threads\n");
599 return;
600 }
601
602 mutex_lock(&watchdog_mutex);
603 softlockup_threads_initialized = true;
604 lockup_detector_reconfigure();
605 mutex_unlock(&watchdog_mutex);
606}
607
608#else /* CONFIG_SOFTLOCKUP_DETECTOR */
609static inline int watchdog_park_threads(void) { return 0; }
610static inline void watchdog_unpark_threads(void) { }
611static inline int watchdog_enable_all_cpus(void) { return 0; }
612static inline void watchdog_disable_all_cpus(void) { }
613static void lockup_detector_reconfigure(void)
614{
615 cpus_read_lock();
616 watchdog_nmi_stop();
617 lockup_detector_update_enable();
618 watchdog_nmi_start();
619 cpus_read_unlock();
620}
621static inline void lockup_detector_setup(void)
622{
623 lockup_detector_reconfigure();
624}
625#endif /* !CONFIG_SOFTLOCKUP_DETECTOR */
626
627static void __lockup_detector_cleanup(void)
628{
629 lockdep_assert_held(&watchdog_mutex);
630 hardlockup_detector_perf_cleanup();
631}
632
633/**
634 * lockup_detector_cleanup - Cleanup after cpu hotplug or sysctl changes
635 *
636 * Caller must not hold the cpu hotplug rwsem.
637 */
638void lockup_detector_cleanup(void)
639{
640 mutex_lock(&watchdog_mutex);
641 __lockup_detector_cleanup();
642 mutex_unlock(&watchdog_mutex);
643}
644
645/**
646 * lockup_detector_soft_poweroff - Interface to stop lockup detector(s)
647 *
648 * Special interface for parisc. It prevents lockup detector warnings from
649 * the default pm_poweroff() function which busy loops forever.
650 */
651void lockup_detector_soft_poweroff(void)
652{
653 watchdog_enabled = 0;
654}
655
656#ifdef CONFIG_SYSCTL
657
658/* Propagate any changes to the watchdog threads */
659static void proc_watchdog_update(void)
660{
661 /* Remove impossible cpus to keep sysctl output clean. */
662 cpumask_and(&watchdog_cpumask, &watchdog_cpumask, cpu_possible_mask);
663 lockup_detector_reconfigure();
664}
665
666/*
667 * common function for watchdog, nmi_watchdog and soft_watchdog parameter
668 *
669 * caller | table->data points to | 'which'
670 * -------------------|----------------------------|--------------------------
671 * proc_watchdog | watchdog_user_enabled | NMI_WATCHDOG_ENABLED |
672 * | | SOFT_WATCHDOG_ENABLED
673 * -------------------|----------------------------|--------------------------
674 * proc_nmi_watchdog | nmi_watchdog_user_enabled | NMI_WATCHDOG_ENABLED
675 * -------------------|----------------------------|--------------------------
676 * proc_soft_watchdog | soft_watchdog_user_enabled | SOFT_WATCHDOG_ENABLED
677 */
678static int proc_watchdog_common(int which, struct ctl_table *table, int write,
679 void __user *buffer, size_t *lenp, loff_t *ppos)
680{
681 int err, old, *param = table->data;
682
683 mutex_lock(&watchdog_mutex);
684
685 if (!write) {
686 /*
687 * On read synchronize the userspace interface. This is a
688 * racy snapshot.
689 */
690 *param = (watchdog_enabled & which) != 0;
691 err = proc_dointvec_minmax(table, write, buffer, lenp, ppos);
692 } else {
693 old = READ_ONCE(*param);
694 err = proc_dointvec_minmax(table, write, buffer, lenp, ppos);
695 if (!err && old != READ_ONCE(*param))
696 proc_watchdog_update();
697 }
698 mutex_unlock(&watchdog_mutex);
699 return err;
700}
701
702/*
703 * /proc/sys/kernel/watchdog
704 */
705int proc_watchdog(struct ctl_table *table, int write,
706 void __user *buffer, size_t *lenp, loff_t *ppos)
707{
708 return proc_watchdog_common(NMI_WATCHDOG_ENABLED|SOFT_WATCHDOG_ENABLED,
709 table, write, buffer, lenp, ppos);
710}
711
712/*
713 * /proc/sys/kernel/nmi_watchdog
714 */
715int proc_nmi_watchdog(struct ctl_table *table, int write,
716 void __user *buffer, size_t *lenp, loff_t *ppos)
717{
718 if (!nmi_watchdog_available && write)
719 return -ENOTSUPP;
720 return proc_watchdog_common(NMI_WATCHDOG_ENABLED,
721 table, write, buffer, lenp, ppos);
722}
723
724/*
725 * /proc/sys/kernel/soft_watchdog
726 */
727int proc_soft_watchdog(struct ctl_table *table, int write,
728 void __user *buffer, size_t *lenp, loff_t *ppos)
729{
730 return proc_watchdog_common(SOFT_WATCHDOG_ENABLED,
731 table, write, buffer, lenp, ppos);
732}
733
734/*
735 * /proc/sys/kernel/watchdog_thresh
736 */
737int proc_watchdog_thresh(struct ctl_table *table, int write,
738 void __user *buffer, size_t *lenp, loff_t *ppos)
739{
740 int err, old;
741
742 mutex_lock(&watchdog_mutex);
743
744 old = READ_ONCE(watchdog_thresh);
745 err = proc_dointvec_minmax(table, write, buffer, lenp, ppos);
746
747 if (!err && write && old != READ_ONCE(watchdog_thresh))
748 proc_watchdog_update();
749
750 mutex_unlock(&watchdog_mutex);
751 return err;
752}
753
754/*
755 * The cpumask is the mask of possible cpus that the watchdog can run
756 * on, not the mask of cpus it is actually running on. This allows the
757 * user to specify a mask that will include cpus that have not yet
758 * been brought online, if desired.
759 */
760int proc_watchdog_cpumask(struct ctl_table *table, int write,
761 void __user *buffer, size_t *lenp, loff_t *ppos)
762{
763 int err;
764
765 mutex_lock(&watchdog_mutex);
766
767 err = proc_do_large_bitmap(table, write, buffer, lenp, ppos);
768 if (!err && write)
769 proc_watchdog_update();
770
771 mutex_unlock(&watchdog_mutex);
772 return err;
773}
774#endif /* CONFIG_SYSCTL */
775
776void __init lockup_detector_init(void)
777{
778 if (tick_nohz_full_enabled())
779 pr_info("Disabling watchdog on nohz_full cores by default\n");
780
781 cpumask_copy(&watchdog_cpumask,
782 housekeeping_cpumask(HK_FLAG_TIMER));
783
784 if (!watchdog_nmi_probe())
785 nmi_watchdog_available = true;
786 lockup_detector_setup();
787}