blob: 3011bc33a5bac0716765fe6f3953f13ae932f28a [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * kallsyms.c: in-kernel printing of symbolic oopses and stack traces.
4 *
5 * Rewritten and vastly simplified by Rusty Russell for in-kernel
6 * module loader:
7 * Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
8 *
9 * ChangeLog:
10 *
11 * (25/Aug/2004) Paulo Marques <pmarques@grupopie.com>
12 * Changed the compression method from stem compression to "table lookup"
13 * compression (see scripts/kallsyms.c for a more complete description)
14 */
15#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/init.h>
17#include <linux/seq_file.h>
18#include <linux/fs.h>
Jason Wessel67fc4e02010-05-20 21:04:21 -050019#include <linux/kdb.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/err.h>
21#include <linux/proc_fs.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080022#include <linux/sched.h> /* for cond_resched */
Adam B. Jerome07354a02006-12-06 20:35:30 -080023#include <linux/ctype.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
Daniel Borkmann74451e662017-02-16 22:24:50 +010025#include <linux/filter.h>
Steven Rostedt (VMware)aba4b5c2017-09-01 08:35:38 -040026#include <linux/ftrace.h>
Adrian Hunterd002b8b2020-05-28 11:00:58 +030027#include <linux/kprobes.h>
Stephen Boyd92945232021-07-07 18:09:20 -070028#include <linux/build_bug.h>
Gideon Israel Dsouza52f5684c2014-04-07 15:39:20 -070029#include <linux/compiler.h>
Stephen Boyd92945232021-07-07 18:09:20 -070030#include <linux/module.h>
31#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Manish Katiyarad6ccfa2009-05-12 13:43:35 -070033/*
34 * These will be re-linked against their real values
35 * during the second link stage.
36 */
Gideon Israel Dsouza52f5684c2014-04-07 15:39:20 -070037extern const unsigned long kallsyms_addresses[] __weak;
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -070038extern const int kallsyms_offsets[] __weak;
Gideon Israel Dsouza52f5684c2014-04-07 15:39:20 -070039extern const u8 kallsyms_names[] __weak;
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Manish Katiyarad6ccfa2009-05-12 13:43:35 -070041/*
42 * Tell the compiler that the count isn't in the small data section if the arch
43 * has one (eg: FRV).
David Howells9e6c1e62007-11-28 16:22:04 -080044 */
Jan Beulich80ffbaa2018-09-03 06:09:34 -060045extern const unsigned int kallsyms_num_syms
Joe Perches33def842020-10-21 19:36:07 -070046__section(".rodata") __attribute__((weak));
David Howells9e6c1e62007-11-28 16:22:04 -080047
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -070048extern const unsigned long kallsyms_relative_base
Joe Perches33def842020-10-21 19:36:07 -070049__section(".rodata") __attribute__((weak));
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -070050
Masahiro Yamadacde26a62020-02-02 14:09:22 +090051extern const char kallsyms_token_table[] __weak;
Gideon Israel Dsouza52f5684c2014-04-07 15:39:20 -070052extern const u16 kallsyms_token_index[] __weak;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Jan Beulich80ffbaa2018-09-03 06:09:34 -060054extern const unsigned int kallsyms_markers[] __weak;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Manish Katiyarad6ccfa2009-05-12 13:43:35 -070056/*
57 * Expand a compressed symbol data into the resulting uncompressed string,
Chen Gange3f26752013-04-15 15:04:43 +093058 * if uncompressed string is too long (>= maxlen), it will be truncated,
Manish Katiyarad6ccfa2009-05-12 13:43:35 -070059 * given the offset to where the symbol is in the compressed stream.
60 */
Chen Gange3f26752013-04-15 15:04:43 +093061static unsigned int kallsyms_expand_symbol(unsigned int off,
62 char *result, size_t maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063{
64 int len, skipped_first = 0;
Masahiro Yamadacde26a62020-02-02 14:09:22 +090065 const char *tptr;
66 const u8 *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Manish Katiyarad6ccfa2009-05-12 13:43:35 -070068 /* Get the compressed symbol length from the first symbol byte. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 data = &kallsyms_names[off];
70 len = *data;
71 data++;
72
Manish Katiyarad6ccfa2009-05-12 13:43:35 -070073 /*
74 * Update the offset to return the offset for the next symbol on
75 * the compressed stream.
76 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 off += len + 1;
78
Manish Katiyarad6ccfa2009-05-12 13:43:35 -070079 /*
80 * For every byte on the compressed symbol data, copy the table
81 * entry for that byte.
82 */
83 while (len) {
84 tptr = &kallsyms_token_table[kallsyms_token_index[*data]];
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 data++;
86 len--;
87
88 while (*tptr) {
Manish Katiyarad6ccfa2009-05-12 13:43:35 -070089 if (skipped_first) {
Chen Gange3f26752013-04-15 15:04:43 +093090 if (maxlen <= 1)
91 goto tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 *result = *tptr;
93 result++;
Chen Gange3f26752013-04-15 15:04:43 +093094 maxlen--;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 } else
96 skipped_first = 1;
97 tptr++;
98 }
99 }
100
Chen Gange3f26752013-04-15 15:04:43 +0930101tail:
102 if (maxlen)
103 *result = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700105 /* Return to offset to the next symbol. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 return off;
107}
108
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700109/*
110 * Get symbol type information. This is encoded as a single char at the
111 * beginning of the symbol name.
112 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113static char kallsyms_get_symbol_type(unsigned int off)
114{
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700115 /*
116 * Get just the first code, look it up in the token table,
117 * and return the first char from this token.
118 */
119 return kallsyms_token_table[kallsyms_token_index[kallsyms_names[off + 1]]];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120}
121
122
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700123/*
124 * Find the offset on the compressed stream given and index in the
125 * kallsyms array.
126 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127static unsigned int get_symbol_offset(unsigned long pos)
128{
Jan Beulichaad09472006-12-08 02:35:57 -0800129 const u8 *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 int i;
131
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700132 /*
133 * Use the closest marker we have. We have markers every 256 positions,
134 * so that should be close enough.
135 */
136 name = &kallsyms_names[kallsyms_markers[pos >> 8]];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700138 /*
139 * Sequentially scan all the symbols up to the point we're searching
140 * for. Every symbol is stored in a [<len>][<len> bytes of data] format,
141 * so we just need to add the len to the current pointer for every
142 * symbol we wish to skip.
143 */
144 for (i = 0; i < (pos & 0xFF); i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 name = name + (*name) + 1;
146
147 return name - kallsyms_names;
148}
149
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700150static unsigned long kallsyms_sym_address(int idx)
151{
152 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
153 return kallsyms_addresses[idx];
154
155 /* values are unsigned offsets if --absolute-percpu is not in effect */
156 if (!IS_ENABLED(CONFIG_KALLSYMS_ABSOLUTE_PERCPU))
157 return kallsyms_relative_base + (u32)kallsyms_offsets[idx];
158
159 /* ...otherwise, positive offsets are absolute values */
160 if (kallsyms_offsets[idx] >= 0)
161 return kallsyms_offsets[idx];
162
163 /* ...and negative offsets are relative to kallsyms_relative_base - 1 */
164 return kallsyms_relative_base - 1 - kallsyms_offsets[idx];
165}
166
Nick Desaulniers6eb4bd92021-10-04 09:29:33 -0700167static bool cleanup_symbol_name(char *s)
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700168{
169 char *res;
170
Nick Desaulniers6eb4bd92021-10-04 09:29:33 -0700171 if (!IS_ENABLED(CONFIG_LTO_CLANG))
172 return false;
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700173
Nick Desaulniers6eb4bd92021-10-04 09:29:33 -0700174 /*
175 * LLVM appends various suffixes for local functions and variables that
176 * must be promoted to global scope as part of LTO. This can break
177 * hooking of static functions with kprobes. '.' is not a valid
178 * character in an identifier in C. Suffixes observed:
179 * - foo.llvm.[0-9a-f]+
180 * - foo.[0-9a-f]+
181 * - foo.[0-9a-f]+.cfi_jt
182 */
183 res = strchr(s, '.');
184 if (res) {
185 *res = '\0';
186 return true;
187 }
188
189 if (!IS_ENABLED(CONFIG_CFI_CLANG) ||
190 !IS_ENABLED(CONFIG_LTO_CLANG_THIN) ||
191 CONFIG_CLANG_VERSION >= 130000)
192 return false;
193
194 /*
195 * Prior to LLVM 13, the following suffixes were observed when thinLTO
196 * and CFI are both enabled:
197 * - foo$[0-9]+
198 */
199 res = strrchr(s, '$');
200 if (res) {
201 *res = '\0';
202 return true;
203 }
204
205 return false;
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700206}
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208/* Lookup the address for this symbol. Returns 0 if not found. */
209unsigned long kallsyms_lookup_name(const char *name)
210{
Tejun Heo9281ace2007-07-17 04:03:51 -0700211 char namebuf[KSYM_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 unsigned long i;
213 unsigned int off;
214
215 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
Chen Gange3f26752013-04-15 15:04:43 +0930216 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218 if (strcmp(namebuf, name) == 0)
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700219 return kallsyms_sym_address(i);
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700220
221 if (cleanup_symbol_name(namebuf) && strcmp(namebuf, name) == 0)
222 return kallsyms_sym_address(i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 }
224 return module_kallsyms_lookup_name(name);
225}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Christoph Hellwig3e355202021-02-02 13:13:27 +0100227#ifdef CONFIG_LIVEPATCH
Christoph Hellwig013c1662021-02-02 13:13:26 +0100228/*
229 * Iterate over all symbols in vmlinux. For symbols from modules use
230 * module_kallsyms_on_each_symbol instead.
231 */
Anders Kaseorg75a66612008-12-05 19:03:58 -0500232int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
233 unsigned long),
234 void *data)
235{
236 char namebuf[KSYM_NAME_LEN];
237 unsigned long i;
238 unsigned int off;
239 int ret;
240
241 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
Chen Gange3f26752013-04-15 15:04:43 +0930242 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700243 ret = fn(data, namebuf, NULL, kallsyms_sym_address(i));
Anders Kaseorg75a66612008-12-05 19:03:58 -0500244 if (ret != 0)
245 return ret;
246 }
Christoph Hellwig013c1662021-02-02 13:13:26 +0100247 return 0;
Anders Kaseorg75a66612008-12-05 19:03:58 -0500248}
Christoph Hellwig3e355202021-02-02 13:13:27 +0100249#endif /* CONFIG_LIVEPATCH */
Anders Kaseorg75a66612008-12-05 19:03:58 -0500250
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700251static unsigned long get_symbol_pos(unsigned long addr,
252 unsigned long *symbolsize,
253 unsigned long *offset)
254{
255 unsigned long symbol_start = 0, symbol_end = 0;
256 unsigned long i, low, high, mid;
257
Sam Ravnborg2ea03892009-01-14 21:38:20 +0100258 /* This kernel should never had been booted. */
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700259 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
260 BUG_ON(!kallsyms_addresses);
261 else
262 BUG_ON(!kallsyms_offsets);
Sam Ravnborg2ea03892009-01-14 21:38:20 +0100263
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700264 /* Do a binary search on the sorted kallsyms_addresses array. */
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700265 low = 0;
266 high = kallsyms_num_syms;
267
268 while (high - low > 1) {
Vegard Nossum2fc9c4e2008-07-25 01:45:34 -0700269 mid = low + (high - low) / 2;
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700270 if (kallsyms_sym_address(mid) <= addr)
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700271 low = mid;
272 else
273 high = mid;
274 }
275
276 /*
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700277 * Search for the first aliased symbol. Aliased
278 * symbols are symbols with the same address.
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700279 */
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700280 while (low && kallsyms_sym_address(low-1) == kallsyms_sym_address(low))
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700281 --low;
282
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700283 symbol_start = kallsyms_sym_address(low);
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700284
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700285 /* Search for next non-aliased symbol. */
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700286 for (i = low + 1; i < kallsyms_num_syms; i++) {
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700287 if (kallsyms_sym_address(i) > symbol_start) {
288 symbol_end = kallsyms_sym_address(i);
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700289 break;
290 }
291 }
292
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700293 /* If we found no next symbol, we use the end of the section. */
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700294 if (!symbol_end) {
295 if (is_kernel_inittext(addr))
296 symbol_end = (unsigned long)_einittext;
Masahiro Yamada63b23e22017-07-10 15:51:20 -0700297 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700298 symbol_end = (unsigned long)_end;
299 else
300 symbol_end = (unsigned long)_etext;
301 }
302
Alexey Dobriyanffb45122007-05-08 00:28:41 -0700303 if (symbolsize)
304 *symbolsize = symbol_end - symbol_start;
305 if (offset)
306 *offset = addr - symbol_start;
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700307
308 return low;
309}
310
311/*
312 * Lookup an address but don't bother to find any names.
313 */
314int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
315 unsigned long *offset)
316{
Rusty Russell6dd06c92008-01-29 17:13:22 -0500317 char namebuf[KSYM_NAME_LEN];
Daniel Borkmann74451e662017-02-16 22:24:50 +0100318
Marc Zyngier2a1a3fa2019-08-24 14:12:31 +0100319 if (is_ksym_addr(addr)) {
320 get_symbol_pos(addr, symbolsize, offset);
321 return 1;
322 }
Stephen Boyd92945232021-07-07 18:09:20 -0700323 return !!module_address_lookup(addr, symbolsize, offset, NULL, NULL, namebuf) ||
Daniel Borkmann74451e662017-02-16 22:24:50 +0100324 !!__bpf_address_lookup(addr, symbolsize, offset, namebuf);
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700325}
326
Stephen Boyd92945232021-07-07 18:09:20 -0700327static const char *kallsyms_lookup_buildid(unsigned long addr,
328 unsigned long *symbolsize,
329 unsigned long *offset, char **modname,
330 const unsigned char **modbuildid, char *namebuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331{
Daniel Borkmann74451e662017-02-16 22:24:50 +0100332 const char *ret;
333
Tejun Heo9281ace2007-07-17 04:03:51 -0700334 namebuf[KSYM_NAME_LEN - 1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 namebuf[0] = 0;
336
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700337 if (is_ksym_addr(addr)) {
338 unsigned long pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700340 pos = get_symbol_pos(addr, symbolsize, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 /* Grab name */
Chen Gange3f26752013-04-15 15:04:43 +0930342 kallsyms_expand_symbol(get_symbol_offset(pos),
343 namebuf, KSYM_NAME_LEN);
Kyle McMartin7a74fc42007-05-30 02:43:16 -0400344 if (modname)
345 *modname = NULL;
Stephen Boyd92945232021-07-07 18:09:20 -0700346 if (modbuildid)
347 *modbuildid = NULL;
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700348
349 ret = namebuf;
350 goto found;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 }
352
Daniel Borkmann74451e662017-02-16 22:24:50 +0100353 /* See if it's in a module or a BPF JITed image. */
354 ret = module_address_lookup(addr, symbolsize, offset,
Stephen Boyd92945232021-07-07 18:09:20 -0700355 modname, modbuildid, namebuf);
Daniel Borkmann74451e662017-02-16 22:24:50 +0100356 if (!ret)
357 ret = bpf_address_lookup(addr, symbolsize,
358 offset, modname, namebuf);
Steven Rostedt (VMware)aba4b5c2017-09-01 08:35:38 -0400359
360 if (!ret)
361 ret = ftrace_mod_address_lookup(addr, symbolsize,
362 offset, modname, namebuf);
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700363
364found:
365 cleanup_symbol_name(namebuf);
Daniel Borkmann74451e662017-02-16 22:24:50 +0100366 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367}
368
Stephen Boyd92945232021-07-07 18:09:20 -0700369/*
370 * Lookup an address
371 * - modname is set to NULL if it's in the kernel.
372 * - We guarantee that the returned name is valid until we reschedule even if.
373 * It resides in a module.
374 * - We also guarantee that modname will be valid until rescheduled.
375 */
376const char *kallsyms_lookup(unsigned long addr,
377 unsigned long *symbolsize,
378 unsigned long *offset,
379 char **modname, char *namebuf)
380{
381 return kallsyms_lookup_buildid(addr, symbolsize, offset, modname,
382 NULL, namebuf);
383}
384
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700385int lookup_symbol_name(unsigned long addr, char *symname)
386{
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700387 int res;
388
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700389 symname[0] = '\0';
Tejun Heo9281ace2007-07-17 04:03:51 -0700390 symname[KSYM_NAME_LEN - 1] = '\0';
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700391
392 if (is_ksym_addr(addr)) {
393 unsigned long pos;
394
395 pos = get_symbol_pos(addr, NULL, NULL);
396 /* Grab name */
Chen Gange3f26752013-04-15 15:04:43 +0930397 kallsyms_expand_symbol(get_symbol_offset(pos),
398 symname, KSYM_NAME_LEN);
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700399 goto found;
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700400 }
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700401 /* See if it's in a module. */
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700402 res = lookup_module_symbol_name(addr, symname);
403 if (res)
404 return res;
405
406found:
407 cleanup_symbol_name(symname);
408 return 0;
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700409}
410
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700411int lookup_symbol_attrs(unsigned long addr, unsigned long *size,
412 unsigned long *offset, char *modname, char *name)
413{
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700414 int res;
415
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700416 name[0] = '\0';
Tejun Heo9281ace2007-07-17 04:03:51 -0700417 name[KSYM_NAME_LEN - 1] = '\0';
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700418
419 if (is_ksym_addr(addr)) {
420 unsigned long pos;
421
422 pos = get_symbol_pos(addr, size, offset);
423 /* Grab name */
Chen Gange3f26752013-04-15 15:04:43 +0930424 kallsyms_expand_symbol(get_symbol_offset(pos),
425 name, KSYM_NAME_LEN);
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700426 modname[0] = '\0';
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700427 goto found;
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700428 }
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700429 /* See if it's in a module. */
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700430 res = lookup_module_symbol_attrs(addr, size, offset, modname, name);
431 if (res)
432 return res;
433
434found:
435 cleanup_symbol_name(name);
436 return 0;
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700437}
438
Robert Peterson42e38082007-04-30 15:09:48 -0700439/* Look up a kernel symbol and return it in a text buffer. */
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900440static int __sprint_symbol(char *buffer, unsigned long address,
Stephen Boyd92945232021-07-07 18:09:20 -0700441 int symbol_offset, int add_offset, int add_buildid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
443 char *modname;
Stephen Boyd92945232021-07-07 18:09:20 -0700444 const unsigned char *buildid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 const char *name;
446 unsigned long offset, size;
Hugh Dickins966c8c12008-11-19 15:36:36 -0800447 int len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900449 address += symbol_offset;
Stephen Boyd92945232021-07-07 18:09:20 -0700450 name = kallsyms_lookup_buildid(address, &size, &offset, &modname, &buildid,
451 buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 if (!name)
Namhyung Kimb86280a2014-08-08 14:19:41 -0700453 return sprintf(buffer, "0x%lx", address - symbol_offset);
Andrew Morton19769b72007-07-15 23:41:24 -0700454
Hugh Dickins966c8c12008-11-19 15:36:36 -0800455 if (name != buffer)
456 strcpy(buffer, name);
457 len = strlen(buffer);
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900458 offset -= symbol_offset;
Hugh Dickins966c8c12008-11-19 15:36:36 -0800459
Stephen Boyd4796dd22012-05-29 15:07:33 -0700460 if (add_offset)
461 len += sprintf(buffer + len, "+%#lx/%#lx", offset, size);
462
Stephen Boyd92945232021-07-07 18:09:20 -0700463 if (modname) {
464 len += sprintf(buffer + len, " [%s", modname);
465#if IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID)
466 if (add_buildid && buildid) {
467 /* build ID should match length of sprintf */
468#if IS_ENABLED(CONFIG_MODULES)
469 static_assert(sizeof(typeof_member(struct module, build_id)) == 20);
470#endif
471 len += sprintf(buffer + len, " %20phN", buildid);
472 }
473#endif
474 len += sprintf(buffer + len, "]");
475 }
Hugh Dickins966c8c12008-11-19 15:36:36 -0800476
477 return len;
Robert Peterson42e38082007-04-30 15:09:48 -0700478}
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900479
480/**
481 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
482 * @buffer: buffer to be stored
483 * @address: address to lookup
484 *
485 * This function looks up a kernel symbol with @address and stores its name,
486 * offset, size and module name to @buffer if possible. If no symbol was found,
487 * just saves its @address as is.
488 *
489 * This function returns the number of bytes stored in @buffer.
490 */
491int sprint_symbol(char *buffer, unsigned long address)
492{
Stephen Boyd92945232021-07-07 18:09:20 -0700493 return __sprint_symbol(buffer, address, 0, 1, 0);
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900494}
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700495EXPORT_SYMBOL_GPL(sprint_symbol);
Robert Peterson42e38082007-04-30 15:09:48 -0700496
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900497/**
Stephen Boyd92945232021-07-07 18:09:20 -0700498 * sprint_symbol_build_id - Look up a kernel symbol and return it in a text buffer
499 * @buffer: buffer to be stored
500 * @address: address to lookup
501 *
502 * This function looks up a kernel symbol with @address and stores its name,
503 * offset, size, module name and module build ID to @buffer if possible. If no
504 * symbol was found, just saves its @address as is.
505 *
506 * This function returns the number of bytes stored in @buffer.
507 */
508int sprint_symbol_build_id(char *buffer, unsigned long address)
509{
510 return __sprint_symbol(buffer, address, 0, 1, 1);
511}
512EXPORT_SYMBOL_GPL(sprint_symbol_build_id);
513
514/**
Stephen Boyd4796dd22012-05-29 15:07:33 -0700515 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
516 * @buffer: buffer to be stored
517 * @address: address to lookup
518 *
519 * This function looks up a kernel symbol with @address and stores its name
520 * and module name to @buffer if possible. If no symbol was found, just saves
521 * its @address as is.
522 *
523 * This function returns the number of bytes stored in @buffer.
524 */
525int sprint_symbol_no_offset(char *buffer, unsigned long address)
526{
Stephen Boyd92945232021-07-07 18:09:20 -0700527 return __sprint_symbol(buffer, address, 0, 0, 0);
Stephen Boyd4796dd22012-05-29 15:07:33 -0700528}
529EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);
530
531/**
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900532 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
533 * @buffer: buffer to be stored
534 * @address: address to lookup
535 *
536 * This function is for stack backtrace and does the same thing as
537 * sprint_symbol() but with modified/decreased @address. If there is a
538 * tail-call to the function marked "noreturn", gcc optimized out code after
539 * the call so that the stack-saved return address could point outside of the
540 * caller. This function ensures that kallsyms will find the original caller
541 * by decreasing @address.
542 *
543 * This function returns the number of bytes stored in @buffer.
544 */
545int sprint_backtrace(char *buffer, unsigned long address)
546{
Stephen Boyd92945232021-07-07 18:09:20 -0700547 return __sprint_symbol(buffer, address, -1, 1, 0);
548}
549
550/**
551 * sprint_backtrace_build_id - Look up a backtrace symbol and return it in a text buffer
552 * @buffer: buffer to be stored
553 * @address: address to lookup
554 *
555 * This function is for stack backtrace and does the same thing as
556 * sprint_symbol() but with modified/decreased @address. If there is a
557 * tail-call to the function marked "noreturn", gcc optimized out code after
558 * the call so that the stack-saved return address could point outside of the
559 * caller. This function ensures that kallsyms will find the original caller
560 * by decreasing @address. This function also appends the module build ID to
561 * the @buffer if @address is within a kernel module.
562 *
563 * This function returns the number of bytes stored in @buffer.
564 */
565int sprint_backtrace_build_id(char *buffer, unsigned long address)
566{
567 return __sprint_symbol(buffer, address, -1, 1, 1);
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900568}
569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570/* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700571struct kallsym_iter {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 loff_t pos;
Alexander Shishkind83212d2018-06-06 15:54:10 +0300573 loff_t pos_arch_end;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100574 loff_t pos_mod_end;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400575 loff_t pos_ftrace_mod_end;
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300576 loff_t pos_bpf_end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 unsigned long value;
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700578 unsigned int nameoff; /* If iterating in core kernel symbols. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 char type;
Tejun Heo9281ace2007-07-17 04:03:51 -0700580 char name[KSYM_NAME_LEN];
581 char module_name[MODULE_NAME_LEN];
Alexey Dobriyanea078902007-05-08 00:28:39 -0700582 int exported;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800583 int show_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584};
585
Alexander Shishkind83212d2018-06-06 15:54:10 +0300586int __weak arch_get_kallsym(unsigned int symnum, unsigned long *value,
587 char *type, char *name)
588{
589 return -EINVAL;
590}
591
592static int get_ksymbol_arch(struct kallsym_iter *iter)
593{
594 int ret = arch_get_kallsym(iter->pos - kallsyms_num_syms,
595 &iter->value, &iter->type,
596 iter->name);
597
598 if (ret < 0) {
599 iter->pos_arch_end = iter->pos;
600 return 0;
601 }
602
603 return 1;
604}
605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606static int get_ksymbol_mod(struct kallsym_iter *iter)
607{
Alexander Shishkind83212d2018-06-06 15:54:10 +0300608 int ret = module_get_kallsym(iter->pos - iter->pos_arch_end,
Daniel Borkmann74451e662017-02-16 22:24:50 +0100609 &iter->value, &iter->type,
610 iter->name, iter->module_name,
611 &iter->exported);
612 if (ret < 0) {
613 iter->pos_mod_end = iter->pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 return 0;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100615 }
616
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 return 1;
618}
619
Adrian Hunterfc0ea792020-05-12 15:19:13 +0300620/*
621 * ftrace_mod_get_kallsym() may also get symbols for pages allocated for ftrace
622 * purposes. In that case "__builtin__ftrace" is used as a module name, even
623 * though "__builtin__ftrace" is not a module.
624 */
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400625static int get_ksymbol_ftrace_mod(struct kallsym_iter *iter)
626{
627 int ret = ftrace_mod_get_kallsym(iter->pos - iter->pos_mod_end,
628 &iter->value, &iter->type,
629 iter->name, iter->module_name,
630 &iter->exported);
631 if (ret < 0) {
632 iter->pos_ftrace_mod_end = iter->pos;
633 return 0;
634 }
635
636 return 1;
637}
638
Daniel Borkmann74451e662017-02-16 22:24:50 +0100639static int get_ksymbol_bpf(struct kallsym_iter *iter)
640{
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300641 int ret;
642
Song Liu69340582019-01-17 08:15:21 -0800643 strlcpy(iter->module_name, "bpf", MODULE_NAME_LEN);
Daniel Borkmann74451e662017-02-16 22:24:50 +0100644 iter->exported = 0;
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300645 ret = bpf_get_kallsym(iter->pos - iter->pos_ftrace_mod_end,
646 &iter->value, &iter->type,
647 iter->name);
648 if (ret < 0) {
649 iter->pos_bpf_end = iter->pos;
650 return 0;
651 }
652
653 return 1;
654}
655
656/*
657 * This uses "__builtin__kprobes" as a module name for symbols for pages
658 * allocated for kprobes' purposes, even though "__builtin__kprobes" is not a
659 * module.
660 */
661static int get_ksymbol_kprobe(struct kallsym_iter *iter)
662{
663 strlcpy(iter->module_name, "__builtin__kprobes", MODULE_NAME_LEN);
664 iter->exported = 0;
665 return kprobe_get_kallsym(iter->pos - iter->pos_bpf_end,
666 &iter->value, &iter->type,
667 iter->name) < 0 ? 0 : 1;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100668}
669
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670/* Returns space to next name. */
671static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
672{
673 unsigned off = iter->nameoff;
674
Alexey Dobriyanea078902007-05-08 00:28:39 -0700675 iter->module_name[0] = '\0';
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700676 iter->value = kallsyms_sym_address(iter->pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
678 iter->type = kallsyms_get_symbol_type(off);
679
Chen Gange3f26752013-04-15 15:04:43 +0930680 off = kallsyms_expand_symbol(off, iter->name, ARRAY_SIZE(iter->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
682 return off - iter->nameoff;
683}
684
685static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
686{
687 iter->name[0] = '\0';
688 iter->nameoff = get_symbol_offset(new_pos);
689 iter->pos = new_pos;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400690 if (new_pos == 0) {
Alexander Shishkind83212d2018-06-06 15:54:10 +0300691 iter->pos_arch_end = 0;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100692 iter->pos_mod_end = 0;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400693 iter->pos_ftrace_mod_end = 0;
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300694 iter->pos_bpf_end = 0;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400695 }
Daniel Borkmann74451e662017-02-16 22:24:50 +0100696}
697
Adrian Hunterb9667942018-06-06 15:54:09 +0300698/*
699 * The end position (last + 1) of each additional kallsyms section is recorded
700 * in iter->pos_..._end as each section is added, and so can be used to
701 * determine which get_ksymbol_...() function to call next.
702 */
Daniel Borkmann74451e662017-02-16 22:24:50 +0100703static int update_iter_mod(struct kallsym_iter *iter, loff_t pos)
704{
705 iter->pos = pos;
706
Alexander Shishkind83212d2018-06-06 15:54:10 +0300707 if ((!iter->pos_arch_end || iter->pos_arch_end > pos) &&
708 get_ksymbol_arch(iter))
709 return 1;
710
Adrian Hunterb9667942018-06-06 15:54:09 +0300711 if ((!iter->pos_mod_end || iter->pos_mod_end > pos) &&
712 get_ksymbol_mod(iter))
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400713 return 1;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400714
Adrian Hunterb9667942018-06-06 15:54:09 +0300715 if ((!iter->pos_ftrace_mod_end || iter->pos_ftrace_mod_end > pos) &&
716 get_ksymbol_ftrace_mod(iter))
717 return 1;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100718
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300719 if ((!iter->pos_bpf_end || iter->pos_bpf_end > pos) &&
720 get_ksymbol_bpf(iter))
721 return 1;
722
723 return get_ksymbol_kprobe(iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724}
725
726/* Returns false if pos at or past end of file. */
727static int update_iter(struct kallsym_iter *iter, loff_t pos)
728{
729 /* Module symbols can be accessed randomly. */
Daniel Borkmann74451e662017-02-16 22:24:50 +0100730 if (pos >= kallsyms_num_syms)
731 return update_iter_mod(iter, pos);
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 /* If we're not on the desired position, reset to new position. */
734 if (pos != iter->pos)
735 reset_iter(iter, pos);
736
737 iter->nameoff += get_ksymbol_core(iter);
738 iter->pos++;
739
740 return 1;
741}
742
743static void *s_next(struct seq_file *m, void *p, loff_t *pos)
744{
745 (*pos)++;
746
747 if (!update_iter(m->private, *pos))
748 return NULL;
749 return p;
750}
751
752static void *s_start(struct seq_file *m, loff_t *pos)
753{
754 if (!update_iter(m->private, *pos))
755 return NULL;
756 return m->private;
757}
758
759static void s_stop(struct seq_file *m, void *p)
760{
761}
762
763static int s_show(struct seq_file *m, void *p)
764{
Linus Torvalds668533d2017-11-29 10:30:13 -0800765 void *value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 struct kallsym_iter *iter = m->private;
767
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700768 /* Some debugging symbols have no name. Ignore them. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 if (!iter->name[0])
770 return 0;
771
Linus Torvalds668533d2017-11-29 10:30:13 -0800772 value = iter->show_value ? (void *)iter->value : NULL;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800773
Alexey Dobriyanea078902007-05-08 00:28:39 -0700774 if (iter->module_name[0]) {
775 char type;
776
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700777 /*
778 * Label it "global" if it is exported,
779 * "local" if not exported.
780 */
Alexey Dobriyanea078902007-05-08 00:28:39 -0700781 type = iter->exported ? toupper(iter->type) :
782 tolower(iter->type);
Linus Torvalds668533d2017-11-29 10:30:13 -0800783 seq_printf(m, "%px %c %s\t[%s]\n", value,
Kees Cook9f36e2c2011-03-22 16:34:22 -0700784 type, iter->name, iter->module_name);
Alexey Dobriyanea078902007-05-08 00:28:39 -0700785 } else
Linus Torvalds668533d2017-11-29 10:30:13 -0800786 seq_printf(m, "%px %c %s\n", value,
Kees Cook9f36e2c2011-03-22 16:34:22 -0700787 iter->type, iter->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 return 0;
789}
790
Helge Deller15ad7cd2006-12-06 20:40:36 -0800791static const struct seq_operations kallsyms_op = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 .start = s_start,
793 .next = s_next,
794 .stop = s_stop,
795 .show = s_show
796};
797
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800798static inline int kallsyms_for_perf(void)
799{
800#ifdef CONFIG_PERF_EVENTS
801 extern int sysctl_perf_event_paranoid;
802 if (sysctl_perf_event_paranoid <= 1)
803 return 1;
804#endif
805 return 0;
806}
807
808/*
809 * We show kallsyms information even to normal users if we've enabled
810 * kernel profiling and are explicitly not paranoid (so kptr_restrict
811 * is clear, and sysctl_perf_event_paranoid isn't set).
812 *
813 * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
814 * block even that).
815 */
Kees Cook16025182020-07-02 11:49:23 -0700816bool kallsyms_show_value(const struct cred *cred)
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800817{
818 switch (kptr_restrict) {
819 case 0:
820 if (kallsyms_for_perf())
Kees Cook16025182020-07-02 11:49:23 -0700821 return true;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500822 fallthrough;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800823 case 1:
Kees Cook16025182020-07-02 11:49:23 -0700824 if (security_capable(cred, &init_user_ns, CAP_SYSLOG,
825 CAP_OPT_NOAUDIT) == 0)
826 return true;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500827 fallthrough;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800828 default:
Kees Cook16025182020-07-02 11:49:23 -0700829 return false;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800830 }
831}
832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833static int kallsyms_open(struct inode *inode, struct file *file)
834{
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700835 /*
836 * We keep iterator in m->private, since normal case is to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 * s_start from where we left off, so we avoid doing
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700838 * using get_symbol_offset for every symbol.
839 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 struct kallsym_iter *iter;
Rob Jones0049f262014-10-13 15:52:10 -0700841 iter = __seq_open_private(file, &kallsyms_op, sizeof(*iter));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 if (!iter)
843 return -ENOMEM;
844 reset_iter(iter, 0);
845
Kees Cook16025182020-07-02 11:49:23 -0700846 /*
847 * Instead of checking this on every s_show() call, cache
848 * the result here at open time.
849 */
850 iter->show_value = kallsyms_show_value(file->f_cred);
Rob Jones0049f262014-10-13 15:52:10 -0700851 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}
853
Jason Wessel67fc4e02010-05-20 21:04:21 -0500854#ifdef CONFIG_KGDB_KDB
855const char *kdb_walk_kallsyms(loff_t *pos)
856{
857 static struct kallsym_iter kdb_walk_kallsyms_iter;
858 if (*pos == 0) {
859 memset(&kdb_walk_kallsyms_iter, 0,
860 sizeof(kdb_walk_kallsyms_iter));
861 reset_iter(&kdb_walk_kallsyms_iter, 0);
862 }
863 while (1) {
864 if (!update_iter(&kdb_walk_kallsyms_iter, *pos))
865 return NULL;
866 ++*pos;
867 /* Some debugging symbols have no name. Ignore them. */
868 if (kdb_walk_kallsyms_iter.name[0])
869 return kdb_walk_kallsyms_iter.name;
870 }
871}
872#endif /* CONFIG_KGDB_KDB */
873
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800874static const struct proc_ops kallsyms_proc_ops = {
875 .proc_open = kallsyms_open,
876 .proc_read = seq_read,
877 .proc_lseek = seq_lseek,
878 .proc_release = seq_release_private,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879};
880
881static int __init kallsyms_init(void)
882{
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800883 proc_create("kallsyms", 0444, NULL, &kallsyms_proc_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 return 0;
885}
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700886device_initcall(kallsyms_init);