blob: 0ba87982d017fc4acc1b58e6ed798fa769b00887 [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
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700167#if defined(CONFIG_CFI_CLANG) && defined(CONFIG_LTO_CLANG_THIN)
168/*
169 * LLVM appends a hash to static function names when ThinLTO and CFI are
170 * both enabled, i.e. foo() becomes foo$707af9a22804d33c81801f27dcfe489b.
171 * This causes confusion and potentially breaks user space tools, so we
172 * strip the suffix from expanded symbol names.
173 */
174static inline bool cleanup_symbol_name(char *s)
175{
176 char *res;
177
178 res = strrchr(s, '$');
179 if (res)
180 *res = '\0';
181
182 return res != NULL;
183}
184#else
185static inline bool cleanup_symbol_name(char *s) { return false; }
186#endif
187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188/* Lookup the address for this symbol. Returns 0 if not found. */
189unsigned long kallsyms_lookup_name(const char *name)
190{
Tejun Heo9281ace2007-07-17 04:03:51 -0700191 char namebuf[KSYM_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 unsigned long i;
193 unsigned int off;
194
195 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
Chen Gange3f26752013-04-15 15:04:43 +0930196 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198 if (strcmp(namebuf, name) == 0)
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700199 return kallsyms_sym_address(i);
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700200
201 if (cleanup_symbol_name(namebuf) && strcmp(namebuf, name) == 0)
202 return kallsyms_sym_address(i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 }
204 return module_kallsyms_lookup_name(name);
205}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Christoph Hellwig3e355202021-02-02 13:13:27 +0100207#ifdef CONFIG_LIVEPATCH
Christoph Hellwig013c1662021-02-02 13:13:26 +0100208/*
209 * Iterate over all symbols in vmlinux. For symbols from modules use
210 * module_kallsyms_on_each_symbol instead.
211 */
Anders Kaseorg75a66612008-12-05 19:03:58 -0500212int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
213 unsigned long),
214 void *data)
215{
216 char namebuf[KSYM_NAME_LEN];
217 unsigned long i;
218 unsigned int off;
219 int ret;
220
221 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
Chen Gange3f26752013-04-15 15:04:43 +0930222 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700223 ret = fn(data, namebuf, NULL, kallsyms_sym_address(i));
Anders Kaseorg75a66612008-12-05 19:03:58 -0500224 if (ret != 0)
225 return ret;
226 }
Christoph Hellwig013c1662021-02-02 13:13:26 +0100227 return 0;
Anders Kaseorg75a66612008-12-05 19:03:58 -0500228}
Christoph Hellwig3e355202021-02-02 13:13:27 +0100229#endif /* CONFIG_LIVEPATCH */
Anders Kaseorg75a66612008-12-05 19:03:58 -0500230
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700231static unsigned long get_symbol_pos(unsigned long addr,
232 unsigned long *symbolsize,
233 unsigned long *offset)
234{
235 unsigned long symbol_start = 0, symbol_end = 0;
236 unsigned long i, low, high, mid;
237
Sam Ravnborg2ea03892009-01-14 21:38:20 +0100238 /* This kernel should never had been booted. */
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700239 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
240 BUG_ON(!kallsyms_addresses);
241 else
242 BUG_ON(!kallsyms_offsets);
Sam Ravnborg2ea03892009-01-14 21:38:20 +0100243
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700244 /* Do a binary search on the sorted kallsyms_addresses array. */
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700245 low = 0;
246 high = kallsyms_num_syms;
247
248 while (high - low > 1) {
Vegard Nossum2fc9c4e2008-07-25 01:45:34 -0700249 mid = low + (high - low) / 2;
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700250 if (kallsyms_sym_address(mid) <= addr)
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700251 low = mid;
252 else
253 high = mid;
254 }
255
256 /*
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700257 * Search for the first aliased symbol. Aliased
258 * symbols are symbols with the same address.
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700259 */
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700260 while (low && kallsyms_sym_address(low-1) == kallsyms_sym_address(low))
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700261 --low;
262
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700263 symbol_start = kallsyms_sym_address(low);
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700264
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700265 /* Search for next non-aliased symbol. */
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700266 for (i = low + 1; i < kallsyms_num_syms; i++) {
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700267 if (kallsyms_sym_address(i) > symbol_start) {
268 symbol_end = kallsyms_sym_address(i);
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700269 break;
270 }
271 }
272
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700273 /* If we found no next symbol, we use the end of the section. */
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700274 if (!symbol_end) {
275 if (is_kernel_inittext(addr))
276 symbol_end = (unsigned long)_einittext;
Masahiro Yamada63b23e22017-07-10 15:51:20 -0700277 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700278 symbol_end = (unsigned long)_end;
279 else
280 symbol_end = (unsigned long)_etext;
281 }
282
Alexey Dobriyanffb45122007-05-08 00:28:41 -0700283 if (symbolsize)
284 *symbolsize = symbol_end - symbol_start;
285 if (offset)
286 *offset = addr - symbol_start;
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700287
288 return low;
289}
290
291/*
292 * Lookup an address but don't bother to find any names.
293 */
294int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
295 unsigned long *offset)
296{
Rusty Russell6dd06c92008-01-29 17:13:22 -0500297 char namebuf[KSYM_NAME_LEN];
Daniel Borkmann74451e662017-02-16 22:24:50 +0100298
Marc Zyngier2a1a3fa2019-08-24 14:12:31 +0100299 if (is_ksym_addr(addr)) {
300 get_symbol_pos(addr, symbolsize, offset);
301 return 1;
302 }
Stephen Boyd92945232021-07-07 18:09:20 -0700303 return !!module_address_lookup(addr, symbolsize, offset, NULL, NULL, namebuf) ||
Daniel Borkmann74451e662017-02-16 22:24:50 +0100304 !!__bpf_address_lookup(addr, symbolsize, offset, namebuf);
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700305}
306
Stephen Boyd92945232021-07-07 18:09:20 -0700307static const char *kallsyms_lookup_buildid(unsigned long addr,
308 unsigned long *symbolsize,
309 unsigned long *offset, char **modname,
310 const unsigned char **modbuildid, char *namebuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311{
Daniel Borkmann74451e662017-02-16 22:24:50 +0100312 const char *ret;
313
Tejun Heo9281ace2007-07-17 04:03:51 -0700314 namebuf[KSYM_NAME_LEN - 1] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 namebuf[0] = 0;
316
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700317 if (is_ksym_addr(addr)) {
318 unsigned long pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
Franck Bui-Huuffc50892006-10-03 01:13:48 -0700320 pos = get_symbol_pos(addr, symbolsize, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 /* Grab name */
Chen Gange3f26752013-04-15 15:04:43 +0930322 kallsyms_expand_symbol(get_symbol_offset(pos),
323 namebuf, KSYM_NAME_LEN);
Kyle McMartin7a74fc42007-05-30 02:43:16 -0400324 if (modname)
325 *modname = NULL;
Stephen Boyd92945232021-07-07 18:09:20 -0700326 if (modbuildid)
327 *modbuildid = NULL;
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700328
329 ret = namebuf;
330 goto found;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 }
332
Daniel Borkmann74451e662017-02-16 22:24:50 +0100333 /* See if it's in a module or a BPF JITed image. */
334 ret = module_address_lookup(addr, symbolsize, offset,
Stephen Boyd92945232021-07-07 18:09:20 -0700335 modname, modbuildid, namebuf);
Daniel Borkmann74451e662017-02-16 22:24:50 +0100336 if (!ret)
337 ret = bpf_address_lookup(addr, symbolsize,
338 offset, modname, namebuf);
Steven Rostedt (VMware)aba4b5c2017-09-01 08:35:38 -0400339
340 if (!ret)
341 ret = ftrace_mod_address_lookup(addr, symbolsize,
342 offset, modname, namebuf);
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700343
344found:
345 cleanup_symbol_name(namebuf);
Daniel Borkmann74451e662017-02-16 22:24:50 +0100346 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347}
348
Stephen Boyd92945232021-07-07 18:09:20 -0700349/*
350 * Lookup an address
351 * - modname is set to NULL if it's in the kernel.
352 * - We guarantee that the returned name is valid until we reschedule even if.
353 * It resides in a module.
354 * - We also guarantee that modname will be valid until rescheduled.
355 */
356const char *kallsyms_lookup(unsigned long addr,
357 unsigned long *symbolsize,
358 unsigned long *offset,
359 char **modname, char *namebuf)
360{
361 return kallsyms_lookup_buildid(addr, symbolsize, offset, modname,
362 NULL, namebuf);
363}
364
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700365int lookup_symbol_name(unsigned long addr, char *symname)
366{
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700367 int res;
368
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700369 symname[0] = '\0';
Tejun Heo9281ace2007-07-17 04:03:51 -0700370 symname[KSYM_NAME_LEN - 1] = '\0';
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700371
372 if (is_ksym_addr(addr)) {
373 unsigned long pos;
374
375 pos = get_symbol_pos(addr, NULL, NULL);
376 /* Grab name */
Chen Gange3f26752013-04-15 15:04:43 +0930377 kallsyms_expand_symbol(get_symbol_offset(pos),
378 symname, KSYM_NAME_LEN);
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700379 goto found;
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700380 }
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700381 /* See if it's in a module. */
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700382 res = lookup_module_symbol_name(addr, symname);
383 if (res)
384 return res;
385
386found:
387 cleanup_symbol_name(symname);
388 return 0;
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700389}
390
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700391int lookup_symbol_attrs(unsigned long addr, unsigned long *size,
392 unsigned long *offset, char *modname, char *name)
393{
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700394 int res;
395
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700396 name[0] = '\0';
Tejun Heo9281ace2007-07-17 04:03:51 -0700397 name[KSYM_NAME_LEN - 1] = '\0';
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700398
399 if (is_ksym_addr(addr)) {
400 unsigned long pos;
401
402 pos = get_symbol_pos(addr, size, offset);
403 /* Grab name */
Chen Gange3f26752013-04-15 15:04:43 +0930404 kallsyms_expand_symbol(get_symbol_offset(pos),
405 name, KSYM_NAME_LEN);
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700406 modname[0] = '\0';
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700407 goto found;
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700408 }
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700409 /* See if it's in a module. */
Sami Tolvanen8b8e6b52021-04-08 11:28:32 -0700410 res = lookup_module_symbol_attrs(addr, size, offset, modname, name);
411 if (res)
412 return res;
413
414found:
415 cleanup_symbol_name(name);
416 return 0;
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700417}
418
Robert Peterson42e38082007-04-30 15:09:48 -0700419/* Look up a kernel symbol and return it in a text buffer. */
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900420static int __sprint_symbol(char *buffer, unsigned long address,
Stephen Boyd92945232021-07-07 18:09:20 -0700421 int symbol_offset, int add_offset, int add_buildid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422{
423 char *modname;
Stephen Boyd92945232021-07-07 18:09:20 -0700424 const unsigned char *buildid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 const char *name;
426 unsigned long offset, size;
Hugh Dickins966c8c12008-11-19 15:36:36 -0800427 int len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900429 address += symbol_offset;
Stephen Boyd92945232021-07-07 18:09:20 -0700430 name = kallsyms_lookup_buildid(address, &size, &offset, &modname, &buildid,
431 buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 if (!name)
Namhyung Kimb86280a2014-08-08 14:19:41 -0700433 return sprintf(buffer, "0x%lx", address - symbol_offset);
Andrew Morton19769b72007-07-15 23:41:24 -0700434
Hugh Dickins966c8c12008-11-19 15:36:36 -0800435 if (name != buffer)
436 strcpy(buffer, name);
437 len = strlen(buffer);
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900438 offset -= symbol_offset;
Hugh Dickins966c8c12008-11-19 15:36:36 -0800439
Stephen Boyd4796dd22012-05-29 15:07:33 -0700440 if (add_offset)
441 len += sprintf(buffer + len, "+%#lx/%#lx", offset, size);
442
Stephen Boyd92945232021-07-07 18:09:20 -0700443 if (modname) {
444 len += sprintf(buffer + len, " [%s", modname);
445#if IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID)
446 if (add_buildid && buildid) {
447 /* build ID should match length of sprintf */
448#if IS_ENABLED(CONFIG_MODULES)
449 static_assert(sizeof(typeof_member(struct module, build_id)) == 20);
450#endif
451 len += sprintf(buffer + len, " %20phN", buildid);
452 }
453#endif
454 len += sprintf(buffer + len, "]");
455 }
Hugh Dickins966c8c12008-11-19 15:36:36 -0800456
457 return len;
Robert Peterson42e38082007-04-30 15:09:48 -0700458}
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900459
460/**
461 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
462 * @buffer: buffer to be stored
463 * @address: address to lookup
464 *
465 * This function looks up a kernel symbol with @address and stores its name,
466 * offset, size and module name to @buffer if possible. If no symbol was found,
467 * just saves its @address as is.
468 *
469 * This function returns the number of bytes stored in @buffer.
470 */
471int sprint_symbol(char *buffer, unsigned long address)
472{
Stephen Boyd92945232021-07-07 18:09:20 -0700473 return __sprint_symbol(buffer, address, 0, 1, 0);
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900474}
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700475EXPORT_SYMBOL_GPL(sprint_symbol);
Robert Peterson42e38082007-04-30 15:09:48 -0700476
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900477/**
Stephen Boyd92945232021-07-07 18:09:20 -0700478 * sprint_symbol_build_id - Look up a kernel symbol and return it in a text buffer
479 * @buffer: buffer to be stored
480 * @address: address to lookup
481 *
482 * This function looks up a kernel symbol with @address and stores its name,
483 * offset, size, module name and module build ID to @buffer if possible. If no
484 * symbol was found, just saves its @address as is.
485 *
486 * This function returns the number of bytes stored in @buffer.
487 */
488int sprint_symbol_build_id(char *buffer, unsigned long address)
489{
490 return __sprint_symbol(buffer, address, 0, 1, 1);
491}
492EXPORT_SYMBOL_GPL(sprint_symbol_build_id);
493
494/**
Stephen Boyd4796dd22012-05-29 15:07:33 -0700495 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
496 * @buffer: buffer to be stored
497 * @address: address to lookup
498 *
499 * This function looks up a kernel symbol with @address and stores its name
500 * and module name to @buffer if possible. If no symbol was found, just saves
501 * its @address as is.
502 *
503 * This function returns the number of bytes stored in @buffer.
504 */
505int sprint_symbol_no_offset(char *buffer, unsigned long address)
506{
Stephen Boyd92945232021-07-07 18:09:20 -0700507 return __sprint_symbol(buffer, address, 0, 0, 0);
Stephen Boyd4796dd22012-05-29 15:07:33 -0700508}
509EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);
510
511/**
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900512 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
513 * @buffer: buffer to be stored
514 * @address: address to lookup
515 *
516 * This function is for stack backtrace and does the same thing as
517 * sprint_symbol() but with modified/decreased @address. If there is a
518 * tail-call to the function marked "noreturn", gcc optimized out code after
519 * the call so that the stack-saved return address could point outside of the
520 * caller. This function ensures that kallsyms will find the original caller
521 * by decreasing @address.
522 *
523 * This function returns the number of bytes stored in @buffer.
524 */
525int sprint_backtrace(char *buffer, unsigned long address)
526{
Stephen Boyd92945232021-07-07 18:09:20 -0700527 return __sprint_symbol(buffer, address, -1, 1, 0);
528}
529
530/**
531 * sprint_backtrace_build_id - Look up a backtrace symbol and return it in a text buffer
532 * @buffer: buffer to be stored
533 * @address: address to lookup
534 *
535 * This function is for stack backtrace and does the same thing as
536 * sprint_symbol() but with modified/decreased @address. If there is a
537 * tail-call to the function marked "noreturn", gcc optimized out code after
538 * the call so that the stack-saved return address could point outside of the
539 * caller. This function ensures that kallsyms will find the original caller
540 * by decreasing @address. This function also appends the module build ID to
541 * the @buffer if @address is within a kernel module.
542 *
543 * This function returns the number of bytes stored in @buffer.
544 */
545int sprint_backtrace_build_id(char *buffer, unsigned long address)
546{
547 return __sprint_symbol(buffer, address, -1, 1, 1);
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900548}
549
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550/* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700551struct kallsym_iter {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 loff_t pos;
Alexander Shishkind83212d2018-06-06 15:54:10 +0300553 loff_t pos_arch_end;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100554 loff_t pos_mod_end;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400555 loff_t pos_ftrace_mod_end;
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300556 loff_t pos_bpf_end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 unsigned long value;
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700558 unsigned int nameoff; /* If iterating in core kernel symbols. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 char type;
Tejun Heo9281ace2007-07-17 04:03:51 -0700560 char name[KSYM_NAME_LEN];
561 char module_name[MODULE_NAME_LEN];
Alexey Dobriyanea078902007-05-08 00:28:39 -0700562 int exported;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800563 int show_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564};
565
Alexander Shishkind83212d2018-06-06 15:54:10 +0300566int __weak arch_get_kallsym(unsigned int symnum, unsigned long *value,
567 char *type, char *name)
568{
569 return -EINVAL;
570}
571
572static int get_ksymbol_arch(struct kallsym_iter *iter)
573{
574 int ret = arch_get_kallsym(iter->pos - kallsyms_num_syms,
575 &iter->value, &iter->type,
576 iter->name);
577
578 if (ret < 0) {
579 iter->pos_arch_end = iter->pos;
580 return 0;
581 }
582
583 return 1;
584}
585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586static int get_ksymbol_mod(struct kallsym_iter *iter)
587{
Alexander Shishkind83212d2018-06-06 15:54:10 +0300588 int ret = module_get_kallsym(iter->pos - iter->pos_arch_end,
Daniel Borkmann74451e662017-02-16 22:24:50 +0100589 &iter->value, &iter->type,
590 iter->name, iter->module_name,
591 &iter->exported);
592 if (ret < 0) {
593 iter->pos_mod_end = iter->pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 return 0;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100595 }
596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 return 1;
598}
599
Adrian Hunterfc0ea792020-05-12 15:19:13 +0300600/*
601 * ftrace_mod_get_kallsym() may also get symbols for pages allocated for ftrace
602 * purposes. In that case "__builtin__ftrace" is used as a module name, even
603 * though "__builtin__ftrace" is not a module.
604 */
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400605static int get_ksymbol_ftrace_mod(struct kallsym_iter *iter)
606{
607 int ret = ftrace_mod_get_kallsym(iter->pos - iter->pos_mod_end,
608 &iter->value, &iter->type,
609 iter->name, iter->module_name,
610 &iter->exported);
611 if (ret < 0) {
612 iter->pos_ftrace_mod_end = iter->pos;
613 return 0;
614 }
615
616 return 1;
617}
618
Daniel Borkmann74451e662017-02-16 22:24:50 +0100619static int get_ksymbol_bpf(struct kallsym_iter *iter)
620{
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300621 int ret;
622
Song Liu69340582019-01-17 08:15:21 -0800623 strlcpy(iter->module_name, "bpf", MODULE_NAME_LEN);
Daniel Borkmann74451e662017-02-16 22:24:50 +0100624 iter->exported = 0;
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300625 ret = bpf_get_kallsym(iter->pos - iter->pos_ftrace_mod_end,
626 &iter->value, &iter->type,
627 iter->name);
628 if (ret < 0) {
629 iter->pos_bpf_end = iter->pos;
630 return 0;
631 }
632
633 return 1;
634}
635
636/*
637 * This uses "__builtin__kprobes" as a module name for symbols for pages
638 * allocated for kprobes' purposes, even though "__builtin__kprobes" is not a
639 * module.
640 */
641static int get_ksymbol_kprobe(struct kallsym_iter *iter)
642{
643 strlcpy(iter->module_name, "__builtin__kprobes", MODULE_NAME_LEN);
644 iter->exported = 0;
645 return kprobe_get_kallsym(iter->pos - iter->pos_bpf_end,
646 &iter->value, &iter->type,
647 iter->name) < 0 ? 0 : 1;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100648}
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650/* Returns space to next name. */
651static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
652{
653 unsigned off = iter->nameoff;
654
Alexey Dobriyanea078902007-05-08 00:28:39 -0700655 iter->module_name[0] = '\0';
Ard Biesheuvel2213e9a2016-03-15 14:58:19 -0700656 iter->value = kallsyms_sym_address(iter->pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
658 iter->type = kallsyms_get_symbol_type(off);
659
Chen Gange3f26752013-04-15 15:04:43 +0930660 off = kallsyms_expand_symbol(off, iter->name, ARRAY_SIZE(iter->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
662 return off - iter->nameoff;
663}
664
665static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
666{
667 iter->name[0] = '\0';
668 iter->nameoff = get_symbol_offset(new_pos);
669 iter->pos = new_pos;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400670 if (new_pos == 0) {
Alexander Shishkind83212d2018-06-06 15:54:10 +0300671 iter->pos_arch_end = 0;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100672 iter->pos_mod_end = 0;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400673 iter->pos_ftrace_mod_end = 0;
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300674 iter->pos_bpf_end = 0;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400675 }
Daniel Borkmann74451e662017-02-16 22:24:50 +0100676}
677
Adrian Hunterb9667942018-06-06 15:54:09 +0300678/*
679 * The end position (last + 1) of each additional kallsyms section is recorded
680 * in iter->pos_..._end as each section is added, and so can be used to
681 * determine which get_ksymbol_...() function to call next.
682 */
Daniel Borkmann74451e662017-02-16 22:24:50 +0100683static int update_iter_mod(struct kallsym_iter *iter, loff_t pos)
684{
685 iter->pos = pos;
686
Alexander Shishkind83212d2018-06-06 15:54:10 +0300687 if ((!iter->pos_arch_end || iter->pos_arch_end > pos) &&
688 get_ksymbol_arch(iter))
689 return 1;
690
Adrian Hunterb9667942018-06-06 15:54:09 +0300691 if ((!iter->pos_mod_end || iter->pos_mod_end > pos) &&
692 get_ksymbol_mod(iter))
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400693 return 1;
Steven Rostedt (VMware)6171a032017-09-06 08:40:41 -0400694
Adrian Hunterb9667942018-06-06 15:54:09 +0300695 if ((!iter->pos_ftrace_mod_end || iter->pos_ftrace_mod_end > pos) &&
696 get_ksymbol_ftrace_mod(iter))
697 return 1;
Daniel Borkmann74451e662017-02-16 22:24:50 +0100698
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300699 if ((!iter->pos_bpf_end || iter->pos_bpf_end > pos) &&
700 get_ksymbol_bpf(iter))
701 return 1;
702
703 return get_ksymbol_kprobe(iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704}
705
706/* Returns false if pos at or past end of file. */
707static int update_iter(struct kallsym_iter *iter, loff_t pos)
708{
709 /* Module symbols can be accessed randomly. */
Daniel Borkmann74451e662017-02-16 22:24:50 +0100710 if (pos >= kallsyms_num_syms)
711 return update_iter_mod(iter, pos);
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700712
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 /* If we're not on the desired position, reset to new position. */
714 if (pos != iter->pos)
715 reset_iter(iter, pos);
716
717 iter->nameoff += get_ksymbol_core(iter);
718 iter->pos++;
719
720 return 1;
721}
722
723static void *s_next(struct seq_file *m, void *p, loff_t *pos)
724{
725 (*pos)++;
726
727 if (!update_iter(m->private, *pos))
728 return NULL;
729 return p;
730}
731
732static void *s_start(struct seq_file *m, loff_t *pos)
733{
734 if (!update_iter(m->private, *pos))
735 return NULL;
736 return m->private;
737}
738
739static void s_stop(struct seq_file *m, void *p)
740{
741}
742
743static int s_show(struct seq_file *m, void *p)
744{
Linus Torvalds668533d2017-11-29 10:30:13 -0800745 void *value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 struct kallsym_iter *iter = m->private;
747
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700748 /* Some debugging symbols have no name. Ignore them. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 if (!iter->name[0])
750 return 0;
751
Linus Torvalds668533d2017-11-29 10:30:13 -0800752 value = iter->show_value ? (void *)iter->value : NULL;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800753
Alexey Dobriyanea078902007-05-08 00:28:39 -0700754 if (iter->module_name[0]) {
755 char type;
756
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700757 /*
758 * Label it "global" if it is exported,
759 * "local" if not exported.
760 */
Alexey Dobriyanea078902007-05-08 00:28:39 -0700761 type = iter->exported ? toupper(iter->type) :
762 tolower(iter->type);
Linus Torvalds668533d2017-11-29 10:30:13 -0800763 seq_printf(m, "%px %c %s\t[%s]\n", value,
Kees Cook9f36e2c2011-03-22 16:34:22 -0700764 type, iter->name, iter->module_name);
Alexey Dobriyanea078902007-05-08 00:28:39 -0700765 } else
Linus Torvalds668533d2017-11-29 10:30:13 -0800766 seq_printf(m, "%px %c %s\n", value,
Kees Cook9f36e2c2011-03-22 16:34:22 -0700767 iter->type, iter->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 return 0;
769}
770
Helge Deller15ad7cd2006-12-06 20:40:36 -0800771static const struct seq_operations kallsyms_op = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 .start = s_start,
773 .next = s_next,
774 .stop = s_stop,
775 .show = s_show
776};
777
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800778static inline int kallsyms_for_perf(void)
779{
780#ifdef CONFIG_PERF_EVENTS
781 extern int sysctl_perf_event_paranoid;
782 if (sysctl_perf_event_paranoid <= 1)
783 return 1;
784#endif
785 return 0;
786}
787
788/*
789 * We show kallsyms information even to normal users if we've enabled
790 * kernel profiling and are explicitly not paranoid (so kptr_restrict
791 * is clear, and sysctl_perf_event_paranoid isn't set).
792 *
793 * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
794 * block even that).
795 */
Kees Cook16025182020-07-02 11:49:23 -0700796bool kallsyms_show_value(const struct cred *cred)
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800797{
798 switch (kptr_restrict) {
799 case 0:
800 if (kallsyms_for_perf())
Kees Cook16025182020-07-02 11:49:23 -0700801 return true;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500802 fallthrough;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800803 case 1:
Kees Cook16025182020-07-02 11:49:23 -0700804 if (security_capable(cred, &init_user_ns, CAP_SYSLOG,
805 CAP_OPT_NOAUDIT) == 0)
806 return true;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500807 fallthrough;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800808 default:
Kees Cook16025182020-07-02 11:49:23 -0700809 return false;
Linus Torvaldsc0f3ea12017-11-08 12:51:04 -0800810 }
811}
812
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813static int kallsyms_open(struct inode *inode, struct file *file)
814{
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700815 /*
816 * We keep iterator in m->private, since normal case is to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 * s_start from where we left off, so we avoid doing
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700818 * using get_symbol_offset for every symbol.
819 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 struct kallsym_iter *iter;
Rob Jones0049f262014-10-13 15:52:10 -0700821 iter = __seq_open_private(file, &kallsyms_op, sizeof(*iter));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 if (!iter)
823 return -ENOMEM;
824 reset_iter(iter, 0);
825
Kees Cook16025182020-07-02 11:49:23 -0700826 /*
827 * Instead of checking this on every s_show() call, cache
828 * the result here at open time.
829 */
830 iter->show_value = kallsyms_show_value(file->f_cred);
Rob Jones0049f262014-10-13 15:52:10 -0700831 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832}
833
Jason Wessel67fc4e02010-05-20 21:04:21 -0500834#ifdef CONFIG_KGDB_KDB
835const char *kdb_walk_kallsyms(loff_t *pos)
836{
837 static struct kallsym_iter kdb_walk_kallsyms_iter;
838 if (*pos == 0) {
839 memset(&kdb_walk_kallsyms_iter, 0,
840 sizeof(kdb_walk_kallsyms_iter));
841 reset_iter(&kdb_walk_kallsyms_iter, 0);
842 }
843 while (1) {
844 if (!update_iter(&kdb_walk_kallsyms_iter, *pos))
845 return NULL;
846 ++*pos;
847 /* Some debugging symbols have no name. Ignore them. */
848 if (kdb_walk_kallsyms_iter.name[0])
849 return kdb_walk_kallsyms_iter.name;
850 }
851}
852#endif /* CONFIG_KGDB_KDB */
853
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800854static const struct proc_ops kallsyms_proc_ops = {
855 .proc_open = kallsyms_open,
856 .proc_read = seq_read,
857 .proc_lseek = seq_lseek,
858 .proc_release = seq_release_private,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859};
860
861static int __init kallsyms_init(void)
862{
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800863 proc_create("kallsyms", 0444, NULL, &kallsyms_proc_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 return 0;
865}
Manish Katiyarad6ccfa2009-05-12 13:43:35 -0700866device_initcall(kallsyms_init);