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/kprobes.h>
28 #include <linux/build_bug.h>
29 #include <linux/compiler.h>
30 #include <linux/module.h>
31 #include <linux/kernel.h>
32 #include <linux/bsearch.h>
33 #include <linux/btf_ids.h>
35 #include "kallsyms_internal.h"
38 * Expand a compressed symbol data into the resulting uncompressed string,
39 * if uncompressed string is too long (>= maxlen), it will be truncated,
40 * given the offset to where the symbol is in the compressed stream.
42 static unsigned int kallsyms_expand_symbol(unsigned int off
,
43 char *result
, size_t maxlen
)
45 int len
, skipped_first
= 0;
49 /* Get the compressed symbol length from the first symbol byte. */
50 data
= &kallsyms_names
[off
];
55 /* If MSB is 1, it is a "big" symbol, so needs an additional byte. */
56 if ((len
& 0x80) != 0) {
57 len
= (len
& 0x7F) | (*data
<< 7);
63 * Update the offset to return the offset for the next symbol on
64 * the compressed stream.
69 * For every byte on the compressed symbol data, copy the table
70 * entry for that byte.
73 tptr
= &kallsyms_token_table
[kallsyms_token_index
[*data
]];
94 /* Return to offset to the next symbol. */
99 * Get symbol type information. This is encoded as a single char at the
100 * beginning of the symbol name.
102 static char kallsyms_get_symbol_type(unsigned int off
)
105 * Get just the first code, look it up in the token table,
106 * and return the first char from this token.
108 return kallsyms_token_table
[kallsyms_token_index
[kallsyms_names
[off
+ 1]]];
113 * Find the offset on the compressed stream given and index in the
116 static unsigned int get_symbol_offset(unsigned long pos
)
122 * Use the closest marker we have. We have markers every 256 positions,
123 * so that should be close enough.
125 name
= &kallsyms_names
[kallsyms_markers
[pos
>> 8]];
128 * Sequentially scan all the symbols up to the point we're searching
129 * for. Every symbol is stored in a [<len>][<len> bytes of data] format,
130 * so we just need to add the len to the current pointer for every
131 * symbol we wish to skip.
133 for (i
= 0; i
< (pos
& 0xFF); i
++) {
137 * If MSB is 1, it is a "big" symbol, so we need to look into
138 * the next byte (and skip it, too).
140 if ((len
& 0x80) != 0)
141 len
= ((len
& 0x7F) | (name
[1] << 7)) + 1;
143 name
= name
+ len
+ 1;
146 return name
- kallsyms_names
;
149 unsigned long kallsyms_sym_address(int idx
)
151 /* values are unsigned offsets if --absolute-percpu is not in effect */
152 if (!IS_ENABLED(CONFIG_KALLSYMS_ABSOLUTE_PERCPU
))
153 return kallsyms_relative_base
+ (u32
)kallsyms_offsets
[idx
];
155 /* ...otherwise, positive offsets are absolute values */
156 if (kallsyms_offsets
[idx
] >= 0)
157 return kallsyms_offsets
[idx
];
159 /* ...and negative offsets are relative to kallsyms_relative_base - 1 */
160 return kallsyms_relative_base
- 1 - kallsyms_offsets
[idx
];
163 static unsigned int get_symbol_seq(int index
)
165 unsigned int i
, seq
= 0;
167 for (i
= 0; i
< 3; i
++)
168 seq
= (seq
<< 8) | kallsyms_seqs_of_names
[3 * index
+ i
];
173 static int kallsyms_lookup_names(const char *name
,
179 unsigned int seq
, off
;
180 char namebuf
[KSYM_NAME_LEN
];
183 high
= kallsyms_num_syms
- 1;
185 while (low
<= high
) {
186 mid
= low
+ (high
- low
) / 2;
187 seq
= get_symbol_seq(mid
);
188 off
= get_symbol_offset(seq
);
189 kallsyms_expand_symbol(off
, namebuf
, ARRAY_SIZE(namebuf
));
190 ret
= strcmp(name
, namebuf
);
204 seq
= get_symbol_seq(low
- 1);
205 off
= get_symbol_offset(seq
);
206 kallsyms_expand_symbol(off
, namebuf
, ARRAY_SIZE(namebuf
));
207 if (strcmp(name
, namebuf
))
215 while (high
< kallsyms_num_syms
- 1) {
216 seq
= get_symbol_seq(high
+ 1);
217 off
= get_symbol_offset(seq
);
218 kallsyms_expand_symbol(off
, namebuf
, ARRAY_SIZE(namebuf
));
219 if (strcmp(name
, namebuf
))
229 /* Lookup the address for this symbol. Returns 0 if not found. */
230 unsigned long kallsyms_lookup_name(const char *name
)
235 /* Skip the search for empty string. */
239 ret
= kallsyms_lookup_names(name
, &i
, NULL
);
241 return kallsyms_sym_address(get_symbol_seq(i
));
243 return module_kallsyms_lookup_name(name
);
247 * Iterate over all symbols in vmlinux. For symbols from modules use
248 * module_kallsyms_on_each_symbol instead.
250 int kallsyms_on_each_symbol(int (*fn
)(void *, const char *, unsigned long),
253 char namebuf
[KSYM_NAME_LEN
];
258 for (i
= 0, off
= 0; i
< kallsyms_num_syms
; i
++) {
259 off
= kallsyms_expand_symbol(off
, namebuf
, ARRAY_SIZE(namebuf
));
260 ret
= fn(data
, namebuf
, kallsyms_sym_address(i
));
268 int kallsyms_on_each_match_symbol(int (*fn
)(void *, unsigned long),
269 const char *name
, void *data
)
272 unsigned int i
, start
, end
;
274 ret
= kallsyms_lookup_names(name
, &start
, &end
);
278 for (i
= start
; !ret
&& i
<= end
; i
++) {
279 ret
= fn(data
, kallsyms_sym_address(get_symbol_seq(i
)));
286 static unsigned long get_symbol_pos(unsigned long addr
,
287 unsigned long *symbolsize
,
288 unsigned long *offset
)
290 unsigned long symbol_start
= 0, symbol_end
= 0;
291 unsigned long i
, low
, high
, mid
;
293 /* Do a binary search on the sorted kallsyms_offsets array. */
295 high
= kallsyms_num_syms
;
297 while (high
- low
> 1) {
298 mid
= low
+ (high
- low
) / 2;
299 if (kallsyms_sym_address(mid
) <= addr
)
306 * Search for the first aliased symbol. Aliased
307 * symbols are symbols with the same address.
309 while (low
&& kallsyms_sym_address(low
-1) == kallsyms_sym_address(low
))
312 symbol_start
= kallsyms_sym_address(low
);
314 /* Search for next non-aliased symbol. */
315 for (i
= low
+ 1; i
< kallsyms_num_syms
; i
++) {
316 if (kallsyms_sym_address(i
) > symbol_start
) {
317 symbol_end
= kallsyms_sym_address(i
);
322 /* If we found no next symbol, we use the end of the section. */
324 if (is_kernel_inittext(addr
))
325 symbol_end
= (unsigned long)_einittext
;
326 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL
))
327 symbol_end
= (unsigned long)_end
;
329 symbol_end
= (unsigned long)_etext
;
333 *symbolsize
= symbol_end
- symbol_start
;
335 *offset
= addr
- symbol_start
;
341 * Lookup an address but don't bother to find any names.
343 int kallsyms_lookup_size_offset(unsigned long addr
, unsigned long *symbolsize
,
344 unsigned long *offset
)
346 char namebuf
[KSYM_NAME_LEN
];
348 if (is_ksym_addr(addr
)) {
349 get_symbol_pos(addr
, symbolsize
, offset
);
352 return !!module_address_lookup(addr
, symbolsize
, offset
, NULL
, NULL
, namebuf
) ||
353 !!__bpf_address_lookup(addr
, symbolsize
, offset
, namebuf
);
356 static int kallsyms_lookup_buildid(unsigned long addr
,
357 unsigned long *symbolsize
,
358 unsigned long *offset
, char **modname
,
359 const unsigned char **modbuildid
, char *namebuf
)
363 namebuf
[KSYM_NAME_LEN
- 1] = 0;
366 if (is_ksym_addr(addr
)) {
369 pos
= get_symbol_pos(addr
, symbolsize
, offset
);
371 kallsyms_expand_symbol(get_symbol_offset(pos
),
372 namebuf
, KSYM_NAME_LEN
);
378 return strlen(namebuf
);
381 /* See if it's in a module or a BPF JITed image. */
382 ret
= module_address_lookup(addr
, symbolsize
, offset
,
383 modname
, modbuildid
, namebuf
);
385 ret
= bpf_address_lookup(addr
, symbolsize
,
386 offset
, modname
, namebuf
);
389 ret
= ftrace_mod_address_lookup(addr
, symbolsize
,
390 offset
, modname
, namebuf
);
397 * - modname is set to NULL if it's in the kernel.
398 * - We guarantee that the returned name is valid until we reschedule even if.
399 * It resides in a module.
400 * - We also guarantee that modname will be valid until rescheduled.
402 const char *kallsyms_lookup(unsigned long addr
,
403 unsigned long *symbolsize
,
404 unsigned long *offset
,
405 char **modname
, char *namebuf
)
407 int ret
= kallsyms_lookup_buildid(addr
, symbolsize
, offset
, modname
,
416 int lookup_symbol_name(unsigned long addr
, char *symname
)
419 symname
[KSYM_NAME_LEN
- 1] = '\0';
421 if (is_ksym_addr(addr
)) {
424 pos
= get_symbol_pos(addr
, NULL
, NULL
);
426 kallsyms_expand_symbol(get_symbol_offset(pos
),
427 symname
, KSYM_NAME_LEN
);
430 /* See if it's in a module. */
431 return lookup_module_symbol_name(addr
, symname
);
434 /* Look up a kernel symbol and return it in a text buffer. */
435 static int __sprint_symbol(char *buffer
, unsigned long address
,
436 int symbol_offset
, int add_offset
, int add_buildid
)
439 const unsigned char *buildid
;
440 unsigned long offset
, size
;
443 address
+= symbol_offset
;
444 len
= kallsyms_lookup_buildid(address
, &size
, &offset
, &modname
, &buildid
,
447 return sprintf(buffer
, "0x%lx", address
- symbol_offset
);
449 offset
-= symbol_offset
;
452 len
+= sprintf(buffer
+ len
, "+%#lx/%#lx", offset
, size
);
455 len
+= sprintf(buffer
+ len
, " [%s", modname
);
456 #if IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID)
457 if (add_buildid
&& buildid
) {
458 /* build ID should match length of sprintf */
459 #if IS_ENABLED(CONFIG_MODULES)
460 static_assert(sizeof(typeof_member(struct module
, build_id
)) == 20);
462 len
+= sprintf(buffer
+ len
, " %20phN", buildid
);
465 len
+= sprintf(buffer
+ len
, "]");
472 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
473 * @buffer: buffer to be stored
474 * @address: address to lookup
476 * This function looks up a kernel symbol with @address and stores its name,
477 * offset, size and module name to @buffer if possible. If no symbol was found,
478 * just saves its @address as is.
480 * This function returns the number of bytes stored in @buffer.
482 int sprint_symbol(char *buffer
, unsigned long address
)
484 return __sprint_symbol(buffer
, address
, 0, 1, 0);
486 EXPORT_SYMBOL_GPL(sprint_symbol
);
489 * sprint_symbol_build_id - Look up a kernel symbol and return it in a text buffer
490 * @buffer: buffer to be stored
491 * @address: address to lookup
493 * This function looks up a kernel symbol with @address and stores its name,
494 * offset, size, module name and module build ID to @buffer if possible. If no
495 * symbol was found, just saves its @address as is.
497 * This function returns the number of bytes stored in @buffer.
499 int sprint_symbol_build_id(char *buffer
, unsigned long address
)
501 return __sprint_symbol(buffer
, address
, 0, 1, 1);
503 EXPORT_SYMBOL_GPL(sprint_symbol_build_id
);
506 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
507 * @buffer: buffer to be stored
508 * @address: address to lookup
510 * This function looks up a kernel symbol with @address and stores its name
511 * and module name to @buffer if possible. If no symbol was found, just saves
512 * its @address as is.
514 * This function returns the number of bytes stored in @buffer.
516 int sprint_symbol_no_offset(char *buffer
, unsigned long address
)
518 return __sprint_symbol(buffer
, address
, 0, 0, 0);
520 EXPORT_SYMBOL_GPL(sprint_symbol_no_offset
);
523 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
524 * @buffer: buffer to be stored
525 * @address: address to lookup
527 * This function is for stack backtrace and does the same thing as
528 * sprint_symbol() but with modified/decreased @address. If there is a
529 * tail-call to the function marked "noreturn", gcc optimized out code after
530 * the call so that the stack-saved return address could point outside of the
531 * caller. This function ensures that kallsyms will find the original caller
532 * by decreasing @address.
534 * This function returns the number of bytes stored in @buffer.
536 int sprint_backtrace(char *buffer
, unsigned long address
)
538 return __sprint_symbol(buffer
, address
, -1, 1, 0);
542 * sprint_backtrace_build_id - Look up a backtrace symbol and return it in a text buffer
543 * @buffer: buffer to be stored
544 * @address: address to lookup
546 * This function is for stack backtrace and does the same thing as
547 * sprint_symbol() but with modified/decreased @address. If there is a
548 * tail-call to the function marked "noreturn", gcc optimized out code after
549 * the call so that the stack-saved return address could point outside of the
550 * caller. This function ensures that kallsyms will find the original caller
551 * by decreasing @address. This function also appends the module build ID to
552 * the @buffer if @address is within a kernel module.
554 * This function returns the number of bytes stored in @buffer.
556 int sprint_backtrace_build_id(char *buffer
, unsigned long address
)
558 return __sprint_symbol(buffer
, address
, -1, 1, 1);
561 /* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
562 struct kallsym_iter
{
565 loff_t pos_ftrace_mod_end
;
568 unsigned int nameoff
; /* If iterating in core kernel symbols. */
570 char name
[KSYM_NAME_LEN
];
571 char module_name
[MODULE_NAME_LEN
];
576 static int get_ksymbol_mod(struct kallsym_iter
*iter
)
578 int ret
= module_get_kallsym(iter
->pos
- kallsyms_num_syms
,
579 &iter
->value
, &iter
->type
,
580 iter
->name
, iter
->module_name
,
583 iter
->pos_mod_end
= iter
->pos
;
591 * ftrace_mod_get_kallsym() may also get symbols for pages allocated for ftrace
592 * purposes. In that case "__builtin__ftrace" is used as a module name, even
593 * though "__builtin__ftrace" is not a module.
595 static int get_ksymbol_ftrace_mod(struct kallsym_iter
*iter
)
597 int ret
= ftrace_mod_get_kallsym(iter
->pos
- iter
->pos_mod_end
,
598 &iter
->value
, &iter
->type
,
599 iter
->name
, iter
->module_name
,
602 iter
->pos_ftrace_mod_end
= iter
->pos
;
609 static int get_ksymbol_bpf(struct kallsym_iter
*iter
)
613 strscpy(iter
->module_name
, "bpf", MODULE_NAME_LEN
);
615 ret
= bpf_get_kallsym(iter
->pos
- iter
->pos_ftrace_mod_end
,
616 &iter
->value
, &iter
->type
,
619 iter
->pos_bpf_end
= iter
->pos
;
627 * This uses "__builtin__kprobes" as a module name for symbols for pages
628 * allocated for kprobes' purposes, even though "__builtin__kprobes" is not a
631 static int get_ksymbol_kprobe(struct kallsym_iter
*iter
)
633 strscpy(iter
->module_name
, "__builtin__kprobes", MODULE_NAME_LEN
);
635 return kprobe_get_kallsym(iter
->pos
- iter
->pos_bpf_end
,
636 &iter
->value
, &iter
->type
,
637 iter
->name
) < 0 ? 0 : 1;
640 /* Returns space to next name. */
641 static unsigned long get_ksymbol_core(struct kallsym_iter
*iter
)
643 unsigned off
= iter
->nameoff
;
645 iter
->module_name
[0] = '\0';
646 iter
->value
= kallsyms_sym_address(iter
->pos
);
648 iter
->type
= kallsyms_get_symbol_type(off
);
650 off
= kallsyms_expand_symbol(off
, iter
->name
, ARRAY_SIZE(iter
->name
));
652 return off
- iter
->nameoff
;
655 static void reset_iter(struct kallsym_iter
*iter
, loff_t new_pos
)
657 iter
->name
[0] = '\0';
658 iter
->nameoff
= get_symbol_offset(new_pos
);
661 iter
->pos_mod_end
= 0;
662 iter
->pos_ftrace_mod_end
= 0;
663 iter
->pos_bpf_end
= 0;
668 * The end position (last + 1) of each additional kallsyms section is recorded
669 * in iter->pos_..._end as each section is added, and so can be used to
670 * determine which get_ksymbol_...() function to call next.
672 static int update_iter_mod(struct kallsym_iter
*iter
, loff_t pos
)
676 if ((!iter
->pos_mod_end
|| iter
->pos_mod_end
> pos
) &&
677 get_ksymbol_mod(iter
))
680 if ((!iter
->pos_ftrace_mod_end
|| iter
->pos_ftrace_mod_end
> pos
) &&
681 get_ksymbol_ftrace_mod(iter
))
684 if ((!iter
->pos_bpf_end
|| iter
->pos_bpf_end
> pos
) &&
685 get_ksymbol_bpf(iter
))
688 return get_ksymbol_kprobe(iter
);
691 /* Returns false if pos at or past end of file. */
692 static int update_iter(struct kallsym_iter
*iter
, loff_t pos
)
694 /* Module symbols can be accessed randomly. */
695 if (pos
>= kallsyms_num_syms
)
696 return update_iter_mod(iter
, pos
);
698 /* If we're not on the desired position, reset to new position. */
699 if (pos
!= iter
->pos
)
700 reset_iter(iter
, pos
);
702 iter
->nameoff
+= get_ksymbol_core(iter
);
708 static void *s_next(struct seq_file
*m
, void *p
, loff_t
*pos
)
712 if (!update_iter(m
->private, *pos
))
717 static void *s_start(struct seq_file
*m
, loff_t
*pos
)
719 if (!update_iter(m
->private, *pos
))
724 static void s_stop(struct seq_file
*m
, void *p
)
728 static int s_show(struct seq_file
*m
, void *p
)
731 struct kallsym_iter
*iter
= m
->private;
733 /* Some debugging symbols have no name. Ignore them. */
737 value
= iter
->show_value
? (void *)iter
->value
: NULL
;
739 if (iter
->module_name
[0]) {
743 * Label it "global" if it is exported,
744 * "local" if not exported.
746 type
= iter
->exported
? toupper(iter
->type
) :
748 seq_printf(m
, "%px %c %s\t[%s]\n", value
,
749 type
, iter
->name
, iter
->module_name
);
751 seq_printf(m
, "%px %c %s\n", value
,
752 iter
->type
, iter
->name
);
756 static const struct seq_operations kallsyms_op
= {
763 #ifdef CONFIG_BPF_SYSCALL
765 struct bpf_iter__ksym
{
766 __bpf_md_ptr(struct bpf_iter_meta
*, meta
);
767 __bpf_md_ptr(struct kallsym_iter
*, ksym
);
770 static int ksym_prog_seq_show(struct seq_file
*m
, bool in_stop
)
772 struct bpf_iter__ksym ctx
;
773 struct bpf_iter_meta meta
;
774 struct bpf_prog
*prog
;
777 prog
= bpf_iter_get_info(&meta
, in_stop
);
782 ctx
.ksym
= m
? m
->private : NULL
;
783 return bpf_iter_run_prog(prog
, &ctx
);
786 static int bpf_iter_ksym_seq_show(struct seq_file
*m
, void *p
)
788 return ksym_prog_seq_show(m
, false);
791 static void bpf_iter_ksym_seq_stop(struct seq_file
*m
, void *p
)
794 (void) ksym_prog_seq_show(m
, true);
799 static const struct seq_operations bpf_iter_ksym_ops
= {
802 .stop
= bpf_iter_ksym_seq_stop
,
803 .show
= bpf_iter_ksym_seq_show
,
806 static int bpf_iter_ksym_init(void *priv_data
, struct bpf_iter_aux_info
*aux
)
808 struct kallsym_iter
*iter
= priv_data
;
812 /* cache here as in kallsyms_open() case; use current process
813 * credentials to tell BPF iterators if values should be shown.
815 iter
->show_value
= kallsyms_show_value(current_cred());
820 DEFINE_BPF_ITER_FUNC(ksym
, struct bpf_iter_meta
*meta
, struct kallsym_iter
*ksym
)
822 static const struct bpf_iter_seq_info ksym_iter_seq_info
= {
823 .seq_ops
= &bpf_iter_ksym_ops
,
824 .init_seq_private
= bpf_iter_ksym_init
,
825 .fini_seq_private
= NULL
,
826 .seq_priv_size
= sizeof(struct kallsym_iter
),
829 static struct bpf_iter_reg ksym_iter_reg_info
= {
831 .feature
= BPF_ITER_RESCHED
,
832 .ctx_arg_info_size
= 1,
834 { offsetof(struct bpf_iter__ksym
, ksym
),
835 PTR_TO_BTF_ID_OR_NULL
},
837 .seq_info
= &ksym_iter_seq_info
,
840 BTF_ID_LIST(btf_ksym_iter_id
)
841 BTF_ID(struct, kallsym_iter
)
843 static int __init
bpf_ksym_iter_register(void)
845 ksym_iter_reg_info
.ctx_arg_info
[0].btf_id
= *btf_ksym_iter_id
;
846 return bpf_iter_reg_target(&ksym_iter_reg_info
);
849 late_initcall(bpf_ksym_iter_register
);
851 #endif /* CONFIG_BPF_SYSCALL */
853 static int kallsyms_open(struct inode
*inode
, struct file
*file
)
856 * We keep iterator in m->private, since normal case is to
857 * s_start from where we left off, so we avoid doing
858 * using get_symbol_offset for every symbol.
860 struct kallsym_iter
*iter
;
861 iter
= __seq_open_private(file
, &kallsyms_op
, sizeof(*iter
));
867 * Instead of checking this on every s_show() call, cache
868 * the result here at open time.
870 iter
->show_value
= kallsyms_show_value(file
->f_cred
);
874 #ifdef CONFIG_KGDB_KDB
875 const char *kdb_walk_kallsyms(loff_t
*pos
)
877 static struct kallsym_iter kdb_walk_kallsyms_iter
;
879 memset(&kdb_walk_kallsyms_iter
, 0,
880 sizeof(kdb_walk_kallsyms_iter
));
881 reset_iter(&kdb_walk_kallsyms_iter
, 0);
884 if (!update_iter(&kdb_walk_kallsyms_iter
, *pos
))
887 /* Some debugging symbols have no name. Ignore them. */
888 if (kdb_walk_kallsyms_iter
.name
[0])
889 return kdb_walk_kallsyms_iter
.name
;
892 #endif /* CONFIG_KGDB_KDB */
894 static const struct proc_ops kallsyms_proc_ops
= {
895 .proc_open
= kallsyms_open
,
896 .proc_read
= seq_read
,
897 .proc_lseek
= seq_lseek
,
898 .proc_release
= seq_release_private
,
901 static int __init
kallsyms_init(void)
903 proc_create("kallsyms", 0444, NULL
, &kallsyms_proc_ops
);
906 device_initcall(kallsyms_init
);