taint: consolidate documentation
[linux-2.6-block.git] / kernel / panic.c
1 /*
2  *  linux/kernel/panic.c
3  *
4  *  Copyright (C) 1991, 1992  Linus Torvalds
5  */
6
7 /*
8  * This function is used through-out the kernel (including mm and fs)
9  * to indicate a major problem.
10  */
11 #include <linux/debug_locks.h>
12 #include <linux/sched/debug.h>
13 #include <linux/interrupt.h>
14 #include <linux/kmsg_dump.h>
15 #include <linux/kallsyms.h>
16 #include <linux/notifier.h>
17 #include <linux/module.h>
18 #include <linux/random.h>
19 #include <linux/ftrace.h>
20 #include <linux/reboot.h>
21 #include <linux/delay.h>
22 #include <linux/kexec.h>
23 #include <linux/sched.h>
24 #include <linux/sysrq.h>
25 #include <linux/init.h>
26 #include <linux/nmi.h>
27 #include <linux/console.h>
28 #include <linux/bug.h>
29 #include <linux/ratelimit.h>
30 #include <linux/debugfs.h>
31 #include <asm/sections.h>
32
33 #define PANIC_TIMER_STEP 100
34 #define PANIC_BLINK_SPD 18
35
36 int panic_on_oops = CONFIG_PANIC_ON_OOPS_VALUE;
37 static unsigned long tainted_mask;
38 static int pause_on_oops;
39 static int pause_on_oops_flag;
40 static DEFINE_SPINLOCK(pause_on_oops_lock);
41 bool crash_kexec_post_notifiers;
42 int panic_on_warn __read_mostly;
43
44 int panic_timeout = CONFIG_PANIC_TIMEOUT;
45 EXPORT_SYMBOL_GPL(panic_timeout);
46
47 ATOMIC_NOTIFIER_HEAD(panic_notifier_list);
48
49 EXPORT_SYMBOL(panic_notifier_list);
50
51 static long no_blink(int state)
52 {
53         return 0;
54 }
55
56 /* Returns how long it waited in ms */
57 long (*panic_blink)(int state);
58 EXPORT_SYMBOL(panic_blink);
59
60 /*
61  * Stop ourself in panic -- architecture code may override this
62  */
63 void __weak panic_smp_self_stop(void)
64 {
65         while (1)
66                 cpu_relax();
67 }
68
69 /*
70  * Stop ourselves in NMI context if another CPU has already panicked. Arch code
71  * may override this to prepare for crash dumping, e.g. save regs info.
72  */
73 void __weak nmi_panic_self_stop(struct pt_regs *regs)
74 {
75         panic_smp_self_stop();
76 }
77
78 /*
79  * Stop other CPUs in panic.  Architecture dependent code may override this
80  * with more suitable version.  For example, if the architecture supports
81  * crash dump, it should save registers of each stopped CPU and disable
82  * per-CPU features such as virtualization extensions.
83  */
84 void __weak crash_smp_send_stop(void)
85 {
86         static int cpus_stopped;
87
88         /*
89          * This function can be called twice in panic path, but obviously
90          * we execute this only once.
91          */
92         if (cpus_stopped)
93                 return;
94
95         /*
96          * Note smp_send_stop is the usual smp shutdown function, which
97          * unfortunately means it may not be hardened to work in a panic
98          * situation.
99          */
100         smp_send_stop();
101         cpus_stopped = 1;
102 }
103
104 atomic_t panic_cpu = ATOMIC_INIT(PANIC_CPU_INVALID);
105
106 /*
107  * A variant of panic() called from NMI context. We return if we've already
108  * panicked on this CPU. If another CPU already panicked, loop in
109  * nmi_panic_self_stop() which can provide architecture dependent code such
110  * as saving register state for crash dump.
111  */
112 void nmi_panic(struct pt_regs *regs, const char *msg)
113 {
114         int old_cpu, cpu;
115
116         cpu = raw_smp_processor_id();
117         old_cpu = atomic_cmpxchg(&panic_cpu, PANIC_CPU_INVALID, cpu);
118
119         if (old_cpu == PANIC_CPU_INVALID)
120                 panic("%s", msg);
121         else if (old_cpu != cpu)
122                 nmi_panic_self_stop(regs);
123 }
124 EXPORT_SYMBOL(nmi_panic);
125
126 /**
127  *      panic - halt the system
128  *      @fmt: The text string to print
129  *
130  *      Display a message, then perform cleanups.
131  *
132  *      This function never returns.
133  */
134 void panic(const char *fmt, ...)
135 {
136         static char buf[1024];
137         va_list args;
138         long i, i_next = 0;
139         int state = 0;
140         int old_cpu, this_cpu;
141         bool _crash_kexec_post_notifiers = crash_kexec_post_notifiers;
142
143         /*
144          * Disable local interrupts. This will prevent panic_smp_self_stop
145          * from deadlocking the first cpu that invokes the panic, since
146          * there is nothing to prevent an interrupt handler (that runs
147          * after setting panic_cpu) from invoking panic() again.
148          */
149         local_irq_disable();
150
151         /*
152          * It's possible to come here directly from a panic-assertion and
153          * not have preempt disabled. Some functions called from here want
154          * preempt to be disabled. No point enabling it later though...
155          *
156          * Only one CPU is allowed to execute the panic code from here. For
157          * multiple parallel invocations of panic, all other CPUs either
158          * stop themself or will wait until they are stopped by the 1st CPU
159          * with smp_send_stop().
160          *
161          * `old_cpu == PANIC_CPU_INVALID' means this is the 1st CPU which
162          * comes here, so go ahead.
163          * `old_cpu == this_cpu' means we came from nmi_panic() which sets
164          * panic_cpu to this CPU.  In this case, this is also the 1st CPU.
165          */
166         this_cpu = raw_smp_processor_id();
167         old_cpu  = atomic_cmpxchg(&panic_cpu, PANIC_CPU_INVALID, this_cpu);
168
169         if (old_cpu != PANIC_CPU_INVALID && old_cpu != this_cpu)
170                 panic_smp_self_stop();
171
172         console_verbose();
173         bust_spinlocks(1);
174         va_start(args, fmt);
175         vsnprintf(buf, sizeof(buf), fmt, args);
176         va_end(args);
177         pr_emerg("Kernel panic - not syncing: %s\n", buf);
178 #ifdef CONFIG_DEBUG_BUGVERBOSE
179         /*
180          * Avoid nested stack-dumping if a panic occurs during oops processing
181          */
182         if (!test_taint(TAINT_DIE) && oops_in_progress <= 1)
183                 dump_stack();
184 #endif
185
186         /*
187          * If we have crashed and we have a crash kernel loaded let it handle
188          * everything else.
189          * If we want to run this after calling panic_notifiers, pass
190          * the "crash_kexec_post_notifiers" option to the kernel.
191          *
192          * Bypass the panic_cpu check and call __crash_kexec directly.
193          */
194         if (!_crash_kexec_post_notifiers) {
195                 printk_safe_flush_on_panic();
196                 __crash_kexec(NULL);
197
198                 /*
199                  * Note smp_send_stop is the usual smp shutdown function, which
200                  * unfortunately means it may not be hardened to work in a
201                  * panic situation.
202                  */
203                 smp_send_stop();
204         } else {
205                 /*
206                  * If we want to do crash dump after notifier calls and
207                  * kmsg_dump, we will need architecture dependent extra
208                  * works in addition to stopping other CPUs.
209                  */
210                 crash_smp_send_stop();
211         }
212
213         /*
214          * Run any panic handlers, including those that might need to
215          * add information to the kmsg dump output.
216          */
217         atomic_notifier_call_chain(&panic_notifier_list, 0, buf);
218
219         /* Call flush even twice. It tries harder with a single online CPU */
220         printk_safe_flush_on_panic();
221         kmsg_dump(KMSG_DUMP_PANIC);
222
223         /*
224          * If you doubt kdump always works fine in any situation,
225          * "crash_kexec_post_notifiers" offers you a chance to run
226          * panic_notifiers and dumping kmsg before kdump.
227          * Note: since some panic_notifiers can make crashed kernel
228          * more unstable, it can increase risks of the kdump failure too.
229          *
230          * Bypass the panic_cpu check and call __crash_kexec directly.
231          */
232         if (_crash_kexec_post_notifiers)
233                 __crash_kexec(NULL);
234
235         bust_spinlocks(0);
236
237         /*
238          * We may have ended up stopping the CPU holding the lock (in
239          * smp_send_stop()) while still having some valuable data in the console
240          * buffer.  Try to acquire the lock then release it regardless of the
241          * result.  The release will also print the buffers out.  Locks debug
242          * should be disabled to avoid reporting bad unlock balance when
243          * panic() is not being callled from OOPS.
244          */
245         debug_locks_off();
246         console_flush_on_panic();
247
248         if (!panic_blink)
249                 panic_blink = no_blink;
250
251         if (panic_timeout > 0) {
252                 /*
253                  * Delay timeout seconds before rebooting the machine.
254                  * We can't use the "normal" timers since we just panicked.
255                  */
256                 pr_emerg("Rebooting in %d seconds..\n", panic_timeout);
257
258                 for (i = 0; i < panic_timeout * 1000; i += PANIC_TIMER_STEP) {
259                         touch_nmi_watchdog();
260                         if (i >= i_next) {
261                                 i += panic_blink(state ^= 1);
262                                 i_next = i + 3600 / PANIC_BLINK_SPD;
263                         }
264                         mdelay(PANIC_TIMER_STEP);
265                 }
266         }
267         if (panic_timeout != 0) {
268                 /*
269                  * This will not be a clean reboot, with everything
270                  * shutting down.  But if there is a chance of
271                  * rebooting the system it will be rebooted.
272                  */
273                 emergency_restart();
274         }
275 #ifdef __sparc__
276         {
277                 extern int stop_a_enabled;
278                 /* Make sure the user can actually press Stop-A (L1-A) */
279                 stop_a_enabled = 1;
280                 pr_emerg("Press Stop-A (L1-A) from sun keyboard or send break\n"
281                          "twice on console to return to the boot prom\n");
282         }
283 #endif
284 #if defined(CONFIG_S390)
285         {
286                 unsigned long caller;
287
288                 caller = (unsigned long)__builtin_return_address(0);
289                 disabled_wait(caller);
290         }
291 #endif
292         pr_emerg("---[ end Kernel panic - not syncing: %s ]---\n", buf);
293         local_irq_enable();
294         for (i = 0; ; i += PANIC_TIMER_STEP) {
295                 touch_softlockup_watchdog();
296                 if (i >= i_next) {
297                         i += panic_blink(state ^= 1);
298                         i_next = i + 3600 / PANIC_BLINK_SPD;
299                 }
300                 mdelay(PANIC_TIMER_STEP);
301         }
302 }
303
304 EXPORT_SYMBOL(panic);
305
306 /*
307  * TAINT_FORCED_RMMOD could be a per-module flag but the module
308  * is being removed anyway.
309  */
310 const struct taint_flag taint_flags[TAINT_FLAGS_COUNT] = {
311         [ TAINT_PROPRIETARY_MODULE ]    = { 'P', 'G', true },
312         [ TAINT_FORCED_MODULE ]         = { 'F', ' ', true },
313         [ TAINT_CPU_OUT_OF_SPEC ]       = { 'S', ' ', false },
314         [ TAINT_FORCED_RMMOD ]          = { 'R', ' ', false },
315         [ TAINT_MACHINE_CHECK ]         = { 'M', ' ', false },
316         [ TAINT_BAD_PAGE ]              = { 'B', ' ', false },
317         [ TAINT_USER ]                  = { 'U', ' ', false },
318         [ TAINT_DIE ]                   = { 'D', ' ', false },
319         [ TAINT_OVERRIDDEN_ACPI_TABLE ] = { 'A', ' ', false },
320         [ TAINT_WARN ]                  = { 'W', ' ', false },
321         [ TAINT_CRAP ]                  = { 'C', ' ', true },
322         [ TAINT_FIRMWARE_WORKAROUND ]   = { 'I', ' ', false },
323         [ TAINT_OOT_MODULE ]            = { 'O', ' ', true },
324         [ TAINT_UNSIGNED_MODULE ]       = { 'E', ' ', true },
325         [ TAINT_SOFTLOCKUP ]            = { 'L', ' ', false },
326         [ TAINT_LIVEPATCH ]             = { 'K', ' ', true },
327         [ TAINT_AUX ]                   = { 'X', ' ', true },
328 };
329
330 /**
331  * print_tainted - return a string to represent the kernel taint state.
332  *
333  * For individual taint flag meanings, see Documentation/sysctl/kernel.txt
334  *
335  * The string is overwritten by the next call to print_tainted(),
336  * but is always NULL terminated.
337  */
338 const char *print_tainted(void)
339 {
340         static char buf[TAINT_FLAGS_COUNT + sizeof("Tainted: ")];
341
342         BUILD_BUG_ON(ARRAY_SIZE(taint_flags) != TAINT_FLAGS_COUNT);
343
344         if (tainted_mask) {
345                 char *s;
346                 int i;
347
348                 s = buf + sprintf(buf, "Tainted: ");
349                 for (i = 0; i < TAINT_FLAGS_COUNT; i++) {
350                         const struct taint_flag *t = &taint_flags[i];
351                         *s++ = test_bit(i, &tainted_mask) ?
352                                         t->c_true : t->c_false;
353                 }
354                 *s = 0;
355         } else
356                 snprintf(buf, sizeof(buf), "Not tainted");
357
358         return buf;
359 }
360
361 int test_taint(unsigned flag)
362 {
363         return test_bit(flag, &tainted_mask);
364 }
365 EXPORT_SYMBOL(test_taint);
366
367 unsigned long get_taint(void)
368 {
369         return tainted_mask;
370 }
371
372 /**
373  * add_taint: add a taint flag if not already set.
374  * @flag: one of the TAINT_* constants.
375  * @lockdep_ok: whether lock debugging is still OK.
376  *
377  * If something bad has gone wrong, you'll want @lockdebug_ok = false, but for
378  * some notewortht-but-not-corrupting cases, it can be set to true.
379  */
380 void add_taint(unsigned flag, enum lockdep_ok lockdep_ok)
381 {
382         if (lockdep_ok == LOCKDEP_NOW_UNRELIABLE && __debug_locks_off())
383                 pr_warn("Disabling lock debugging due to kernel taint\n");
384
385         set_bit(flag, &tainted_mask);
386 }
387 EXPORT_SYMBOL(add_taint);
388
389 static void spin_msec(int msecs)
390 {
391         int i;
392
393         for (i = 0; i < msecs; i++) {
394                 touch_nmi_watchdog();
395                 mdelay(1);
396         }
397 }
398
399 /*
400  * It just happens that oops_enter() and oops_exit() are identically
401  * implemented...
402  */
403 static void do_oops_enter_exit(void)
404 {
405         unsigned long flags;
406         static int spin_counter;
407
408         if (!pause_on_oops)
409                 return;
410
411         spin_lock_irqsave(&pause_on_oops_lock, flags);
412         if (pause_on_oops_flag == 0) {
413                 /* This CPU may now print the oops message */
414                 pause_on_oops_flag = 1;
415         } else {
416                 /* We need to stall this CPU */
417                 if (!spin_counter) {
418                         /* This CPU gets to do the counting */
419                         spin_counter = pause_on_oops;
420                         do {
421                                 spin_unlock(&pause_on_oops_lock);
422                                 spin_msec(MSEC_PER_SEC);
423                                 spin_lock(&pause_on_oops_lock);
424                         } while (--spin_counter);
425                         pause_on_oops_flag = 0;
426                 } else {
427                         /* This CPU waits for a different one */
428                         while (spin_counter) {
429                                 spin_unlock(&pause_on_oops_lock);
430                                 spin_msec(1);
431                                 spin_lock(&pause_on_oops_lock);
432                         }
433                 }
434         }
435         spin_unlock_irqrestore(&pause_on_oops_lock, flags);
436 }
437
438 /*
439  * Return true if the calling CPU is allowed to print oops-related info.
440  * This is a bit racy..
441  */
442 int oops_may_print(void)
443 {
444         return pause_on_oops_flag == 0;
445 }
446
447 /*
448  * Called when the architecture enters its oops handler, before it prints
449  * anything.  If this is the first CPU to oops, and it's oopsing the first
450  * time then let it proceed.
451  *
452  * This is all enabled by the pause_on_oops kernel boot option.  We do all
453  * this to ensure that oopses don't scroll off the screen.  It has the
454  * side-effect of preventing later-oopsing CPUs from mucking up the display,
455  * too.
456  *
457  * It turns out that the CPU which is allowed to print ends up pausing for
458  * the right duration, whereas all the other CPUs pause for twice as long:
459  * once in oops_enter(), once in oops_exit().
460  */
461 void oops_enter(void)
462 {
463         tracing_off();
464         /* can't trust the integrity of the kernel anymore: */
465         debug_locks_off();
466         do_oops_enter_exit();
467 }
468
469 /*
470  * 64-bit random ID for oopses:
471  */
472 static u64 oops_id;
473
474 static int init_oops_id(void)
475 {
476         if (!oops_id)
477                 get_random_bytes(&oops_id, sizeof(oops_id));
478         else
479                 oops_id++;
480
481         return 0;
482 }
483 late_initcall(init_oops_id);
484
485 void print_oops_end_marker(void)
486 {
487         init_oops_id();
488         pr_warn("---[ end trace %016llx ]---\n", (unsigned long long)oops_id);
489 }
490
491 /*
492  * Called when the architecture exits its oops handler, after printing
493  * everything.
494  */
495 void oops_exit(void)
496 {
497         do_oops_enter_exit();
498         print_oops_end_marker();
499         kmsg_dump(KMSG_DUMP_OOPS);
500 }
501
502 struct warn_args {
503         const char *fmt;
504         va_list args;
505 };
506
507 void __warn(const char *file, int line, void *caller, unsigned taint,
508             struct pt_regs *regs, struct warn_args *args)
509 {
510         disable_trace_on_warning();
511
512         if (args)
513                 pr_warn(CUT_HERE);
514
515         if (file)
516                 pr_warn("WARNING: CPU: %d PID: %d at %s:%d %pS\n",
517                         raw_smp_processor_id(), current->pid, file, line,
518                         caller);
519         else
520                 pr_warn("WARNING: CPU: %d PID: %d at %pS\n",
521                         raw_smp_processor_id(), current->pid, caller);
522
523         if (args)
524                 vprintk(args->fmt, args->args);
525
526         if (panic_on_warn) {
527                 /*
528                  * This thread may hit another WARN() in the panic path.
529                  * Resetting this prevents additional WARN() from panicking the
530                  * system on this thread.  Other threads are blocked by the
531                  * panic_mutex in panic().
532                  */
533                 panic_on_warn = 0;
534                 panic("panic_on_warn set ...\n");
535         }
536
537         print_modules();
538
539         if (regs)
540                 show_regs(regs);
541         else
542                 dump_stack();
543
544         print_irqtrace_events(current);
545
546         print_oops_end_marker();
547
548         /* Just a warning, don't kill lockdep. */
549         add_taint(taint, LOCKDEP_STILL_OK);
550 }
551
552 #ifdef WANT_WARN_ON_SLOWPATH
553 void warn_slowpath_fmt(const char *file, int line, const char *fmt, ...)
554 {
555         struct warn_args args;
556
557         args.fmt = fmt;
558         va_start(args.args, fmt);
559         __warn(file, line, __builtin_return_address(0), TAINT_WARN, NULL,
560                &args);
561         va_end(args.args);
562 }
563 EXPORT_SYMBOL(warn_slowpath_fmt);
564
565 void warn_slowpath_fmt_taint(const char *file, int line,
566                              unsigned taint, const char *fmt, ...)
567 {
568         struct warn_args args;
569
570         args.fmt = fmt;
571         va_start(args.args, fmt);
572         __warn(file, line, __builtin_return_address(0), taint, NULL, &args);
573         va_end(args.args);
574 }
575 EXPORT_SYMBOL(warn_slowpath_fmt_taint);
576
577 void warn_slowpath_null(const char *file, int line)
578 {
579         pr_warn(CUT_HERE);
580         __warn(file, line, __builtin_return_address(0), TAINT_WARN, NULL, NULL);
581 }
582 EXPORT_SYMBOL(warn_slowpath_null);
583 #else
584 void __warn_printk(const char *fmt, ...)
585 {
586         va_list args;
587
588         pr_warn(CUT_HERE);
589
590         va_start(args, fmt);
591         vprintk(fmt, args);
592         va_end(args);
593 }
594 EXPORT_SYMBOL(__warn_printk);
595 #endif
596
597 #ifdef CONFIG_BUG
598
599 /* Support resetting WARN*_ONCE state */
600
601 static int clear_warn_once_set(void *data, u64 val)
602 {
603         generic_bug_clear_once();
604         memset(__start_once, 0, __end_once - __start_once);
605         return 0;
606 }
607
608 DEFINE_SIMPLE_ATTRIBUTE(clear_warn_once_fops,
609                         NULL,
610                         clear_warn_once_set,
611                         "%lld\n");
612
613 static __init int register_warn_debugfs(void)
614 {
615         /* Don't care about failure */
616         debugfs_create_file("clear_warn_once", 0200, NULL,
617                             NULL, &clear_warn_once_fops);
618         return 0;
619 }
620
621 device_initcall(register_warn_debugfs);
622 #endif
623
624 #ifdef CONFIG_CC_STACKPROTECTOR
625
626 /*
627  * Called when gcc's -fstack-protector feature is used, and
628  * gcc detects corruption of the on-stack canary value
629  */
630 __visible void __stack_chk_fail(void)
631 {
632         panic("stack-protector: Kernel stack is corrupted in: %pB\n",
633                 __builtin_return_address(0));
634 }
635 EXPORT_SYMBOL(__stack_chk_fail);
636
637 #endif
638
639 #ifdef CONFIG_ARCH_HAS_REFCOUNT
640 void refcount_error_report(struct pt_regs *regs, const char *err)
641 {
642         WARN_RATELIMIT(1, "refcount_t %s at %pB in %s[%d], uid/euid: %u/%u\n",
643                 err, (void *)instruction_pointer(regs),
644                 current->comm, task_pid_nr(current),
645                 from_kuid_munged(&init_user_ns, current_uid()),
646                 from_kuid_munged(&init_user_ns, current_euid()));
647 }
648 #endif
649
650 core_param(panic, panic_timeout, int, 0644);
651 core_param(pause_on_oops, pause_on_oops, int, 0644);
652 core_param(panic_on_warn, panic_on_warn, int, 0644);
653 core_param(crash_kexec_post_notifiers, crash_kexec_post_notifiers, bool, 0644);
654
655 static int __init oops_setup(char *s)
656 {
657         if (!s)
658                 return -EINVAL;
659         if (!strcmp(s, "panic"))
660                 panic_on_oops = 1;
661         return 0;
662 }
663 early_param("oops", oops_setup);