blob: bc3656e944d29bd431d1b0fb8629f0ff090c676d [file] [log] [blame]
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -08001/*
2 Generic support for BUG()
3
4 This respects the following config options:
5
6 CONFIG_BUG - emit BUG traps. Nothing happens without this.
7 CONFIG_GENERIC_BUG - enable this code.
Jan Beulichb93a5312008-12-16 11:40:27 +00008 CONFIG_GENERIC_BUG_RELATIVE_POINTERS - use 32-bit pointers relative to
9 the containing struct bug_entry for bug_addr and file.
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080010 CONFIG_DEBUG_BUGVERBOSE - emit full file+line information for each BUG
11
12 CONFIG_BUG and CONFIG_DEBUG_BUGVERBOSE are potentially user-settable
13 (though they're generally always on).
14
15 CONFIG_GENERIC_BUG is set by each architecture using this code.
16
17 To use this, your architecture must:
18
19 1. Set up the config options:
20 - Enable CONFIG_GENERIC_BUG if CONFIG_BUG
21
22 2. Implement BUG (and optionally BUG_ON, WARN, WARN_ON)
23 - Define HAVE_ARCH_BUG
24 - Implement BUG() to generate a faulting instruction
25 - NOTE: struct bug_entry does not have "file" or "line" entries
26 when CONFIG_DEBUG_BUGVERBOSE is not enabled, so you must generate
27 the values accordingly.
28
29 3. Implement the trap
30 - In the illegal instruction trap handler (typically), verify
31 that the fault was in kernel mode, and call report_bug()
32 - report_bug() will return whether it was a false alarm, a warning,
33 or an actual bug.
34 - You must implement the is_valid_bugaddr(bugaddr) callback which
35 returns true if the eip is a real kernel address, and it points
36 to the expected BUG trap instruction.
37
38 Jeremy Fitzhardinge <jeremy@goop.org> 2006
39 */
Fabian Frederickc56ba702014-06-04 16:11:59 -070040
41#define pr_fmt(fmt) fmt
42
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080043#include <linux/list.h>
44#include <linux/module.h>
Paul Mundtda9eac82008-07-04 09:59:36 -070045#include <linux/kernel.h>
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080046#include <linux/bug.h>
Heiko Carstens608e2612007-07-15 23:41:39 -070047#include <linux/sched.h>
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080048
49extern const struct bug_entry __start___bug_table[], __stop___bug_table[];
50
Jan Beulichb93a5312008-12-16 11:40:27 +000051static inline unsigned long bug_addr(const struct bug_entry *bug)
52{
53#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
54 return bug->bug_addr;
55#else
56 return (unsigned long)bug + bug->bug_addr_disp;
57#endif
58}
59
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080060#ifdef CONFIG_MODULES
Rusty Russell1fb93412013-01-12 13:27:34 +103061/* Updates are protected by module mutex */
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080062static LIST_HEAD(module_bug_list);
63
64static const struct bug_entry *module_find_bug(unsigned long bugaddr)
65{
66 struct module *mod;
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +103067 const struct bug_entry *bug = NULL;
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080068
Peter Zijlstra0be964b2015-05-27 11:09:35 +093069 rcu_read_lock_sched();
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +103070 list_for_each_entry_rcu(mod, &module_bug_list, bug_list) {
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080071 unsigned i;
72
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +103073 bug = mod->bug_table;
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080074 for (i = 0; i < mod->num_bugs; ++i, ++bug)
Jan Beulichb93a5312008-12-16 11:40:27 +000075 if (bugaddr == bug_addr(bug))
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +103076 goto out;
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080077 }
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +103078 bug = NULL;
79out:
Peter Zijlstra0be964b2015-05-27 11:09:35 +093080 rcu_read_unlock_sched();
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +103081
82 return bug;
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080083}
84
Linus Torvalds53363772010-10-05 11:29:27 -070085void module_bug_finalize(const Elf_Ehdr *hdr, const Elf_Shdr *sechdrs,
86 struct module *mod)
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080087{
88 char *secstrings;
89 unsigned int i;
90
Peter Zijlstra0be964b2015-05-27 11:09:35 +093091 lockdep_assert_held(&module_mutex);
92
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -080093 mod->bug_table = NULL;
94 mod->num_bugs = 0;
95
96 /* Find the __bug_table section, if present */
97 secstrings = (char *)hdr + sechdrs[hdr->e_shstrndx].sh_offset;
98 for (i = 1; i < hdr->e_shnum; i++) {
99 if (strcmp(secstrings+sechdrs[i].sh_name, "__bug_table"))
100 continue;
101 mod->bug_table = (void *) sechdrs[i].sh_addr;
102 mod->num_bugs = sechdrs[i].sh_size / sizeof(struct bug_entry);
103 break;
104 }
105
106 /*
107 * Strictly speaking this should have a spinlock to protect against
108 * traversals, but since we only traverse on BUG()s, a spinlock
109 * could potentially lead to deadlock and thus be counter-productive.
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +1030110 * Thus, this uses RCU to safely manipulate the bug list, since BUG
111 * must run in non-interruptive state.
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800112 */
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +1030113 list_add_rcu(&mod->bug_list, &module_bug_list);
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800114}
115
116void module_bug_cleanup(struct module *mod)
117{
Peter Zijlstra0be964b2015-05-27 11:09:35 +0930118 lockdep_assert_held(&module_mutex);
Masami Hiramatsu0286b5e2014-11-10 09:28:29 +1030119 list_del_rcu(&mod->bug_list);
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800120}
121
122#else
123
124static inline const struct bug_entry *module_find_bug(unsigned long bugaddr)
125{
126 return NULL;
127}
128#endif
129
130const struct bug_entry *find_bug(unsigned long bugaddr)
131{
132 const struct bug_entry *bug;
133
134 for (bug = __start___bug_table; bug < __stop___bug_table; ++bug)
Jan Beulichb93a5312008-12-16 11:40:27 +0000135 if (bugaddr == bug_addr(bug))
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800136 return bug;
137
138 return module_find_bug(bugaddr);
139}
140
Heiko Carstens608e2612007-07-15 23:41:39 -0700141enum bug_trap_type report_bug(unsigned long bugaddr, struct pt_regs *regs)
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800142{
143 const struct bug_entry *bug;
144 const char *file;
145 unsigned line, warning;
146
147 if (!is_valid_bugaddr(bugaddr))
148 return BUG_TRAP_TYPE_NONE;
149
150 bug = find_bug(bugaddr);
151
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800152 file = NULL;
153 line = 0;
154 warning = 0;
155
156 if (bug) {
157#ifdef CONFIG_DEBUG_BUGVERBOSE
Jan Beulichb93a5312008-12-16 11:40:27 +0000158#ifndef CONFIG_GENERIC_BUG_RELATIVE_POINTERS
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800159 file = bug->file;
Jan Beulichb93a5312008-12-16 11:40:27 +0000160#else
161 file = (const char *)bug + bug->file_disp;
162#endif
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800163 line = bug->line;
164#endif
165 warning = (bug->flags & BUGFLAG_WARNING) != 0;
166 }
167
168 if (warning) {
169 /* this is a WARN_ON rather than BUG/BUG_ON */
Josh Poimboeuf2553b672016-03-17 14:23:04 -0700170 __warn(file, line, (void *)bugaddr, BUG_GET_TAINT(bug), regs,
171 NULL);
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800172 return BUG_TRAP_TYPE_WARN;
173 }
174
Prarit Bhargavab0f4c4b2012-01-26 08:55:34 -0500175 printk(KERN_DEFAULT "------------[ cut here ]------------\n");
Anton Blancharde2e7e092010-08-10 18:03:29 -0700176
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800177 if (file)
Fabian Frederickc56ba702014-06-04 16:11:59 -0700178 pr_crit("kernel BUG at %s:%u!\n", file, line);
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800179 else
Fabian Frederickc56ba702014-06-04 16:11:59 -0700180 pr_crit("Kernel BUG at %p [verbose debug info unavailable]\n",
181 (void *)bugaddr);
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800182
183 return BUG_TRAP_TYPE_BUG;
184}