1 // SPDX-License-Identifier: GPL-2.0-only
3 * kallsyms.c: in-kernel printing of symbolic oopses and stack traces.
5 * Rewritten and vastly simplified by Rusty Russell for in-kernel
7 * Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
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)
15 #include <linux/kallsyms.h>
16 #include <linux/init.h>
17 #include <linux/seq_file.h>
19 #include <linux/kdb.h>
20 #include <linux/err.h>
21 #include <linux/proc_fs.h>
22 #include <linux/sched.h> /* for cond_resched */
23 #include <linux/ctype.h>
24 #include <linux/slab.h>
25 #include <linux/filter.h>
26 #include <linux/ftrace.h>
27 #include <linux/compiler.h>
30 * These will be re-linked against their real values
31 * during the second link stage.
33 extern const unsigned long kallsyms_addresses[] __weak;
34 extern const int kallsyms_offsets[] __weak;
35 extern const u8 kallsyms_names[] __weak;
38 * Tell the compiler that the count isn't in the small data section if the arch
41 extern const unsigned int kallsyms_num_syms
42 __attribute__((weak, section(".rodata")));
44 extern const unsigned long kallsyms_relative_base
45 __attribute__((weak, section(".rodata")));
47 extern const u8 kallsyms_token_table[] __weak;
48 extern const u16 kallsyms_token_index[] __weak;
50 extern const unsigned int kallsyms_markers[] __weak;
53 * Expand a compressed symbol data into the resulting uncompressed string,
54 * if uncompressed string is too long (>= maxlen), it will be truncated,
55 * given the offset to where the symbol is in the compressed stream.
57 static unsigned int kallsyms_expand_symbol(unsigned int off,
58 char *result, size_t maxlen)
60 int len, skipped_first = 0;
61 const u8 *tptr, *data;
63 /* Get the compressed symbol length from the first symbol byte. */
64 data = &kallsyms_names[off];
69 * Update the offset to return the offset for the next symbol on
70 * the compressed stream.
75 * For every byte on the compressed symbol data, copy the table
76 * entry for that byte.
79 tptr = &kallsyms_token_table[kallsyms_token_index[*data]];
100 /* Return to offset to the next symbol. */
105 * Get symbol type information. This is encoded as a single char at the
106 * beginning of the symbol name.
108 static char kallsyms_get_symbol_type(unsigned int off)
111 * Get just the first code, look it up in the token table,
112 * and return the first char from this token.
114 return kallsyms_token_table[kallsyms_token_index[kallsyms_names[off + 1]]];
119 * Find the offset on the compressed stream given and index in the
122 static unsigned int get_symbol_offset(unsigned long pos)
128 * Use the closest marker we have. We have markers every 256 positions,
129 * so that should be close enough.
131 name = &kallsyms_names[kallsyms_markers[pos >> 8]];
134 * Sequentially scan all the symbols up to the point we're searching
135 * for. Every symbol is stored in a [<len>][<len> bytes of data] format,
136 * so we just need to add the len to the current pointer for every
137 * symbol we wish to skip.
139 for (i = 0; i < (pos & 0xFF); i++)
140 name = name + (*name) + 1;
142 return name - kallsyms_names;
145 static unsigned long kallsyms_sym_address(int idx)
147 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
148 return kallsyms_addresses[idx];
150 /* values are unsigned offsets if --absolute-percpu is not in effect */
151 if (!IS_ENABLED(CONFIG_KALLSYMS_ABSOLUTE_PERCPU))
152 return kallsyms_relative_base + (u32)kallsyms_offsets[idx];
154 /* ...otherwise, positive offsets are absolute values */
155 if (kallsyms_offsets[idx] >= 0)
156 return kallsyms_offsets[idx];
158 /* ...and negative offsets are relative to kallsyms_relative_base - 1 */
159 return kallsyms_relative_base - 1 - kallsyms_offsets[idx];
162 /* Lookup the address for this symbol. Returns 0 if not found. */
163 unsigned long kallsyms_lookup_name(const char *name)
165 char namebuf[KSYM_NAME_LEN];
169 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
170 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
172 if (strcmp(namebuf, name) == 0)
173 return kallsyms_sym_address(i);
175 return module_kallsyms_lookup_name(name);
177 EXPORT_SYMBOL_GPL(kallsyms_lookup_name);
179 int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
183 char namebuf[KSYM_NAME_LEN];
188 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
189 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
190 ret = fn(data, namebuf, NULL, kallsyms_sym_address(i));
194 return module_kallsyms_on_each_symbol(fn, data);
196 EXPORT_SYMBOL_GPL(kallsyms_on_each_symbol);
198 static unsigned long get_symbol_pos(unsigned long addr,
199 unsigned long *symbolsize,
200 unsigned long *offset)
202 unsigned long symbol_start = 0, symbol_end = 0;
203 unsigned long i, low, high, mid;
205 /* This kernel should never had been booted. */
206 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
207 BUG_ON(!kallsyms_addresses);
209 BUG_ON(!kallsyms_offsets);
211 /* Do a binary search on the sorted kallsyms_addresses array. */
213 high = kallsyms_num_syms;
215 while (high - low > 1) {
216 mid = low + (high - low) / 2;
217 if (kallsyms_sym_address(mid) <= addr)
224 * Search for the first aliased symbol. Aliased
225 * symbols are symbols with the same address.
227 while (low && kallsyms_sym_address(low-1) == kallsyms_sym_address(low))
230 symbol_start = kallsyms_sym_address(low);
232 /* Search for next non-aliased symbol. */
233 for (i = low + 1; i < kallsyms_num_syms; i++) {
234 if (kallsyms_sym_address(i) > symbol_start) {
235 symbol_end = kallsyms_sym_address(i);
240 /* If we found no next symbol, we use the end of the section. */
242 if (is_kernel_inittext(addr))
243 symbol_end = (unsigned long)_einittext;
244 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
245 symbol_end = (unsigned long)_end;
247 symbol_end = (unsigned long)_etext;
251 *symbolsize = symbol_end - symbol_start;
253 *offset = addr - symbol_start;
259 * Lookup an address but don't bother to find any names.
261 int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
262 unsigned long *offset)
264 char namebuf[KSYM_NAME_LEN];
266 if (is_ksym_addr(addr))
267 return !!get_symbol_pos(addr, symbolsize, offset);
268 return !!module_address_lookup(addr, symbolsize, offset, NULL, namebuf) ||
269 !!__bpf_address_lookup(addr, symbolsize, offset, namebuf);
274 * - modname is set to NULL if it's in the kernel.
275 * - We guarantee that the returned name is valid until we reschedule even if.
276 * It resides in a module.
277 * - We also guarantee that modname will be valid until rescheduled.
279 const char *kallsyms_lookup(unsigned long addr,
280 unsigned long *symbolsize,
281 unsigned long *offset,
282 char **modname, char *namebuf)
286 namebuf[KSYM_NAME_LEN - 1] = 0;
289 if (is_ksym_addr(addr)) {
292 pos = get_symbol_pos(addr, symbolsize, offset);
294 kallsyms_expand_symbol(get_symbol_offset(pos),
295 namebuf, KSYM_NAME_LEN);
301 /* See if it's in a module or a BPF JITed image. */
302 ret = module_address_lookup(addr, symbolsize, offset,
305 ret = bpf_address_lookup(addr, symbolsize,
306 offset, modname, namebuf);
309 ret = ftrace_mod_address_lookup(addr, symbolsize,
310 offset, modname, namebuf);
314 int lookup_symbol_name(unsigned long addr, char *symname)
317 symname[KSYM_NAME_LEN - 1] = '\0';
319 if (is_ksym_addr(addr)) {
322 pos = get_symbol_pos(addr, NULL, NULL);
324 kallsyms_expand_symbol(get_symbol_offset(pos),
325 symname, KSYM_NAME_LEN);
328 /* See if it's in a module. */
329 return lookup_module_symbol_name(addr, symname);
332 int lookup_symbol_attrs(unsigned long addr, unsigned long *size,
333 unsigned long *offset, char *modname, char *name)
336 name[KSYM_NAME_LEN - 1] = '\0';
338 if (is_ksym_addr(addr)) {
341 pos = get_symbol_pos(addr, size, offset);
343 kallsyms_expand_symbol(get_symbol_offset(pos),
344 name, KSYM_NAME_LEN);
348 /* See if it's in a module. */
349 return lookup_module_symbol_attrs(addr, size, offset, modname, name);
352 /* Look up a kernel symbol and return it in a text buffer. */
353 static int __sprint_symbol(char *buffer, unsigned long address,
354 int symbol_offset, int add_offset)
358 unsigned long offset, size;
361 address += symbol_offset;
362 name = kallsyms_lookup(address, &size, &offset, &modname, buffer);
364 return sprintf(buffer, "0x%lx", address - symbol_offset);
367 strcpy(buffer, name);
368 len = strlen(buffer);
369 offset -= symbol_offset;
372 len += sprintf(buffer + len, "+%#lx/%#lx", offset, size);
375 len += sprintf(buffer + len, " [%s]", modname);
381 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
382 * @buffer: buffer to be stored
383 * @address: address to lookup
385 * This function looks up a kernel symbol with @address and stores its name,
386 * offset, size and module name to @buffer if possible. If no symbol was found,
387 * just saves its @address as is.
389 * This function returns the number of bytes stored in @buffer.
391 int sprint_symbol(char *buffer, unsigned long address)
393 return __sprint_symbol(buffer, address, 0, 1);
395 EXPORT_SYMBOL_GPL(sprint_symbol);
398 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
399 * @buffer: buffer to be stored
400 * @address: address to lookup
402 * This function looks up a kernel symbol with @address and stores its name
403 * and module name to @buffer if possible. If no symbol was found, just saves
404 * its @address as is.
406 * This function returns the number of bytes stored in @buffer.
408 int sprint_symbol_no_offset(char *buffer, unsigned long address)
410 return __sprint_symbol(buffer, address, 0, 0);
412 EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);
415 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
416 * @buffer: buffer to be stored
417 * @address: address to lookup
419 * This function is for stack backtrace and does the same thing as
420 * sprint_symbol() but with modified/decreased @address. If there is a
421 * tail-call to the function marked "noreturn", gcc optimized out code after
422 * the call so that the stack-saved return address could point outside of the
423 * caller. This function ensures that kallsyms will find the original caller
424 * by decreasing @address.
426 * This function returns the number of bytes stored in @buffer.
428 int sprint_backtrace(char *buffer, unsigned long address)
430 return __sprint_symbol(buffer, address, -1, 1);
433 /* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
434 struct kallsym_iter {
438 loff_t pos_ftrace_mod_end;
440 unsigned int nameoff; /* If iterating in core kernel symbols. */
442 char name[KSYM_NAME_LEN];
443 char module_name[MODULE_NAME_LEN];
448 int __weak arch_get_kallsym(unsigned int symnum, unsigned long *value,
449 char *type, char *name)
454 static int get_ksymbol_arch(struct kallsym_iter *iter)
456 int ret = arch_get_kallsym(iter->pos - kallsyms_num_syms,
457 &iter->value, &iter->type,
461 iter->pos_arch_end = iter->pos;
468 static int get_ksymbol_mod(struct kallsym_iter *iter)
470 int ret = module_get_kallsym(iter->pos - iter->pos_arch_end,
471 &iter->value, &iter->type,
472 iter->name, iter->module_name,
475 iter->pos_mod_end = iter->pos;
482 static int get_ksymbol_ftrace_mod(struct kallsym_iter *iter)
484 int ret = ftrace_mod_get_kallsym(iter->pos - iter->pos_mod_end,
485 &iter->value, &iter->type,
486 iter->name, iter->module_name,
489 iter->pos_ftrace_mod_end = iter->pos;
496 static int get_ksymbol_bpf(struct kallsym_iter *iter)
498 strlcpy(iter->module_name, "bpf", MODULE_NAME_LEN);
500 return bpf_get_kallsym(iter->pos - iter->pos_ftrace_mod_end,
501 &iter->value, &iter->type,
502 iter->name) < 0 ? 0 : 1;
505 /* Returns space to next name. */
506 static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
508 unsigned off = iter->nameoff;
510 iter->module_name[0] = '\0';
511 iter->value = kallsyms_sym_address(iter->pos);
513 iter->type = kallsyms_get_symbol_type(off);
515 off = kallsyms_expand_symbol(off, iter->name, ARRAY_SIZE(iter->name));
517 return off - iter->nameoff;
520 static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
522 iter->name[0] = '\0';
523 iter->nameoff = get_symbol_offset(new_pos);
526 iter->pos_arch_end = 0;
527 iter->pos_mod_end = 0;
528 iter->pos_ftrace_mod_end = 0;
533 * The end position (last + 1) of each additional kallsyms section is recorded
534 * in iter->pos_..._end as each section is added, and so can be used to
535 * determine which get_ksymbol_...() function to call next.
537 static int update_iter_mod(struct kallsym_iter *iter, loff_t pos)
541 if ((!iter->pos_arch_end || iter->pos_arch_end > pos) &&
542 get_ksymbol_arch(iter))
545 if ((!iter->pos_mod_end || iter->pos_mod_end > pos) &&
546 get_ksymbol_mod(iter))
549 if ((!iter->pos_ftrace_mod_end || iter->pos_ftrace_mod_end > pos) &&
550 get_ksymbol_ftrace_mod(iter))
553 return get_ksymbol_bpf(iter);
556 /* Returns false if pos at or past end of file. */
557 static int update_iter(struct kallsym_iter *iter, loff_t pos)
559 /* Module symbols can be accessed randomly. */
560 if (pos >= kallsyms_num_syms)
561 return update_iter_mod(iter, pos);
563 /* If we're not on the desired position, reset to new position. */
564 if (pos != iter->pos)
565 reset_iter(iter, pos);
567 iter->nameoff += get_ksymbol_core(iter);
573 static void *s_next(struct seq_file *m, void *p, loff_t *pos)
577 if (!update_iter(m->private, *pos))
582 static void *s_start(struct seq_file *m, loff_t *pos)
584 if (!update_iter(m->private, *pos))
589 static void s_stop(struct seq_file *m, void *p)
593 static int s_show(struct seq_file *m, void *p)
596 struct kallsym_iter *iter = m->private;
598 /* Some debugging symbols have no name. Ignore them. */
602 value = iter->show_value ? (void *)iter->value : NULL;
604 if (iter->module_name[0]) {
608 * Label it "global" if it is exported,
609 * "local" if not exported.
611 type = iter->exported ? toupper(iter->type) :
613 seq_printf(m, "%px %c %s\t[%s]\n", value,
614 type, iter->name, iter->module_name);
616 seq_printf(m, "%px %c %s\n", value,
617 iter->type, iter->name);
621 static const struct seq_operations kallsyms_op = {
628 static inline int kallsyms_for_perf(void)
630 #ifdef CONFIG_PERF_EVENTS
631 extern int sysctl_perf_event_paranoid;
632 if (sysctl_perf_event_paranoid <= 1)
639 * We show kallsyms information even to normal users if we've enabled
640 * kernel profiling and are explicitly not paranoid (so kptr_restrict
641 * is clear, and sysctl_perf_event_paranoid isn't set).
643 * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
646 int kallsyms_show_value(void)
648 switch (kptr_restrict) {
650 if (kallsyms_for_perf())
654 if (has_capability_noaudit(current, CAP_SYSLOG))
662 static int kallsyms_open(struct inode *inode, struct file *file)
665 * We keep iterator in m->private, since normal case is to
666 * s_start from where we left off, so we avoid doing
667 * using get_symbol_offset for every symbol.
669 struct kallsym_iter *iter;
670 iter = __seq_open_private(file, &kallsyms_op, sizeof(*iter));
675 iter->show_value = kallsyms_show_value();
679 #ifdef CONFIG_KGDB_KDB
680 const char *kdb_walk_kallsyms(loff_t *pos)
682 static struct kallsym_iter kdb_walk_kallsyms_iter;
684 memset(&kdb_walk_kallsyms_iter, 0,
685 sizeof(kdb_walk_kallsyms_iter));
686 reset_iter(&kdb_walk_kallsyms_iter, 0);
689 if (!update_iter(&kdb_walk_kallsyms_iter, *pos))
692 /* Some debugging symbols have no name. Ignore them. */
693 if (kdb_walk_kallsyms_iter.name[0])
694 return kdb_walk_kallsyms_iter.name;
697 #endif /* CONFIG_KGDB_KDB */
699 static const struct file_operations kallsyms_operations = {
700 .open = kallsyms_open,
703 .release = seq_release_private,
706 static int __init kallsyms_init(void)
708 proc_create("kallsyms", 0444, NULL, &kallsyms_operations);
711 device_initcall(kallsyms_init);