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/compiler.h>
31 * These will be re-linked against their real values
32 * during the second link stage.
34 extern const unsigned long kallsyms_addresses
[] __weak
;
35 extern const int kallsyms_offsets
[] __weak
;
36 extern const u8 kallsyms_names
[] __weak
;
39 * Tell the compiler that the count isn't in the small data section if the arch
42 extern const unsigned int kallsyms_num_syms
43 __section(".rodata") __attribute__((weak
));
45 extern const unsigned long kallsyms_relative_base
46 __section(".rodata") __attribute__((weak
));
48 extern const char kallsyms_token_table
[] __weak
;
49 extern const u16 kallsyms_token_index
[] __weak
;
51 extern const unsigned int kallsyms_markers
[] __weak
;
54 * Expand a compressed symbol data into the resulting uncompressed string,
55 * if uncompressed string is too long (>= maxlen), it will be truncated,
56 * given the offset to where the symbol is in the compressed stream.
58 static unsigned int kallsyms_expand_symbol(unsigned int off
,
59 char *result
, size_t maxlen
)
61 int len
, skipped_first
= 0;
65 /* Get the compressed symbol length from the first symbol byte. */
66 data
= &kallsyms_names
[off
];
71 * Update the offset to return the offset for the next symbol on
72 * the compressed stream.
77 * For every byte on the compressed symbol data, copy the table
78 * entry for that byte.
81 tptr
= &kallsyms_token_table
[kallsyms_token_index
[*data
]];
102 /* Return to offset to the next symbol. */
107 * Get symbol type information. This is encoded as a single char at the
108 * beginning of the symbol name.
110 static char kallsyms_get_symbol_type(unsigned int off
)
113 * Get just the first code, look it up in the token table,
114 * and return the first char from this token.
116 return kallsyms_token_table
[kallsyms_token_index
[kallsyms_names
[off
+ 1]]];
121 * Find the offset on the compressed stream given and index in the
124 static unsigned int get_symbol_offset(unsigned long pos
)
130 * Use the closest marker we have. We have markers every 256 positions,
131 * so that should be close enough.
133 name
= &kallsyms_names
[kallsyms_markers
[pos
>> 8]];
136 * Sequentially scan all the symbols up to the point we're searching
137 * for. Every symbol is stored in a [<len>][<len> bytes of data] format,
138 * so we just need to add the len to the current pointer for every
139 * symbol we wish to skip.
141 for (i
= 0; i
< (pos
& 0xFF); i
++)
142 name
= name
+ (*name
) + 1;
144 return name
- kallsyms_names
;
147 static unsigned long kallsyms_sym_address(int idx
)
149 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE
))
150 return kallsyms_addresses
[idx
];
152 /* values are unsigned offsets if --absolute-percpu is not in effect */
153 if (!IS_ENABLED(CONFIG_KALLSYMS_ABSOLUTE_PERCPU
))
154 return kallsyms_relative_base
+ (u32
)kallsyms_offsets
[idx
];
156 /* ...otherwise, positive offsets are absolute values */
157 if (kallsyms_offsets
[idx
] >= 0)
158 return kallsyms_offsets
[idx
];
160 /* ...and negative offsets are relative to kallsyms_relative_base - 1 */
161 return kallsyms_relative_base
- 1 - kallsyms_offsets
[idx
];
164 /* Lookup the address for this symbol. Returns 0 if not found. */
165 unsigned long kallsyms_lookup_name(const char *name
)
167 char namebuf
[KSYM_NAME_LEN
];
171 for (i
= 0, off
= 0; i
< kallsyms_num_syms
; i
++) {
172 off
= kallsyms_expand_symbol(off
, namebuf
, ARRAY_SIZE(namebuf
));
174 if (strcmp(namebuf
, name
) == 0)
175 return kallsyms_sym_address(i
);
177 return module_kallsyms_lookup_name(name
);
180 int kallsyms_on_each_symbol(int (*fn
)(void *, const char *, struct module
*,
184 char namebuf
[KSYM_NAME_LEN
];
189 for (i
= 0, off
= 0; i
< kallsyms_num_syms
; i
++) {
190 off
= kallsyms_expand_symbol(off
, namebuf
, ARRAY_SIZE(namebuf
));
191 ret
= fn(data
, namebuf
, NULL
, kallsyms_sym_address(i
));
195 return module_kallsyms_on_each_symbol(fn
, data
);
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 get_symbol_pos(addr
, symbolsize
, offset
);
270 return !!module_address_lookup(addr
, symbolsize
, offset
, NULL
, namebuf
) ||
271 !!__bpf_address_lookup(addr
, symbolsize
, offset
, namebuf
);
276 * - modname is set to NULL if it's in the kernel.
277 * - We guarantee that the returned name is valid until we reschedule even if.
278 * It resides in a module.
279 * - We also guarantee that modname will be valid until rescheduled.
281 const char *kallsyms_lookup(unsigned long addr
,
282 unsigned long *symbolsize
,
283 unsigned long *offset
,
284 char **modname
, char *namebuf
)
288 namebuf
[KSYM_NAME_LEN
- 1] = 0;
291 if (is_ksym_addr(addr
)) {
294 pos
= get_symbol_pos(addr
, symbolsize
, offset
);
296 kallsyms_expand_symbol(get_symbol_offset(pos
),
297 namebuf
, KSYM_NAME_LEN
);
303 /* See if it's in a module or a BPF JITed image. */
304 ret
= module_address_lookup(addr
, symbolsize
, offset
,
307 ret
= bpf_address_lookup(addr
, symbolsize
,
308 offset
, modname
, namebuf
);
311 ret
= ftrace_mod_address_lookup(addr
, symbolsize
,
312 offset
, modname
, namebuf
);
316 int lookup_symbol_name(unsigned long addr
, char *symname
)
319 symname
[KSYM_NAME_LEN
- 1] = '\0';
321 if (is_ksym_addr(addr
)) {
324 pos
= get_symbol_pos(addr
, NULL
, NULL
);
326 kallsyms_expand_symbol(get_symbol_offset(pos
),
327 symname
, KSYM_NAME_LEN
);
330 /* See if it's in a module. */
331 return lookup_module_symbol_name(addr
, symname
);
334 int lookup_symbol_attrs(unsigned long addr
, unsigned long *size
,
335 unsigned long *offset
, char *modname
, char *name
)
338 name
[KSYM_NAME_LEN
- 1] = '\0';
340 if (is_ksym_addr(addr
)) {
343 pos
= get_symbol_pos(addr
, size
, offset
);
345 kallsyms_expand_symbol(get_symbol_offset(pos
),
346 name
, KSYM_NAME_LEN
);
350 /* See if it's in a module. */
351 return lookup_module_symbol_attrs(addr
, size
, offset
, modname
, name
);
354 /* Look up a kernel symbol and return it in a text buffer. */
355 static int __sprint_symbol(char *buffer
, unsigned long address
,
356 int symbol_offset
, int add_offset
)
360 unsigned long offset
, size
;
363 address
+= symbol_offset
;
364 name
= kallsyms_lookup(address
, &size
, &offset
, &modname
, buffer
);
366 return sprintf(buffer
, "0x%lx", address
- symbol_offset
);
369 strcpy(buffer
, name
);
370 len
= strlen(buffer
);
371 offset
-= symbol_offset
;
374 len
+= sprintf(buffer
+ len
, "+%#lx/%#lx", offset
, size
);
377 len
+= sprintf(buffer
+ len
, " [%s]", modname
);
383 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
384 * @buffer: buffer to be stored
385 * @address: address to lookup
387 * This function looks up a kernel symbol with @address and stores its name,
388 * offset, size and module name to @buffer if possible. If no symbol was found,
389 * just saves its @address as is.
391 * This function returns the number of bytes stored in @buffer.
393 int sprint_symbol(char *buffer
, unsigned long address
)
395 return __sprint_symbol(buffer
, address
, 0, 1);
397 EXPORT_SYMBOL_GPL(sprint_symbol
);
400 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
401 * @buffer: buffer to be stored
402 * @address: address to lookup
404 * This function looks up a kernel symbol with @address and stores its name
405 * and module name to @buffer if possible. If no symbol was found, just saves
406 * its @address as is.
408 * This function returns the number of bytes stored in @buffer.
410 int sprint_symbol_no_offset(char *buffer
, unsigned long address
)
412 return __sprint_symbol(buffer
, address
, 0, 0);
414 EXPORT_SYMBOL_GPL(sprint_symbol_no_offset
);
417 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
418 * @buffer: buffer to be stored
419 * @address: address to lookup
421 * This function is for stack backtrace and does the same thing as
422 * sprint_symbol() but with modified/decreased @address. If there is a
423 * tail-call to the function marked "noreturn", gcc optimized out code after
424 * the call so that the stack-saved return address could point outside of the
425 * caller. This function ensures that kallsyms will find the original caller
426 * by decreasing @address.
428 * This function returns the number of bytes stored in @buffer.
430 int sprint_backtrace(char *buffer
, unsigned long address
)
432 return __sprint_symbol(buffer
, address
, -1, 1);
435 /* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
436 struct kallsym_iter
{
440 loff_t pos_ftrace_mod_end
;
443 unsigned int nameoff
; /* If iterating in core kernel symbols. */
445 char name
[KSYM_NAME_LEN
];
446 char module_name
[MODULE_NAME_LEN
];
451 int __weak
arch_get_kallsym(unsigned int symnum
, unsigned long *value
,
452 char *type
, char *name
)
457 static int get_ksymbol_arch(struct kallsym_iter
*iter
)
459 int ret
= arch_get_kallsym(iter
->pos
- kallsyms_num_syms
,
460 &iter
->value
, &iter
->type
,
464 iter
->pos_arch_end
= iter
->pos
;
471 static int get_ksymbol_mod(struct kallsym_iter
*iter
)
473 int ret
= module_get_kallsym(iter
->pos
- iter
->pos_arch_end
,
474 &iter
->value
, &iter
->type
,
475 iter
->name
, iter
->module_name
,
478 iter
->pos_mod_end
= iter
->pos
;
486 * ftrace_mod_get_kallsym() may also get symbols for pages allocated for ftrace
487 * purposes. In that case "__builtin__ftrace" is used as a module name, even
488 * though "__builtin__ftrace" is not a module.
490 static int get_ksymbol_ftrace_mod(struct kallsym_iter
*iter
)
492 int ret
= ftrace_mod_get_kallsym(iter
->pos
- iter
->pos_mod_end
,
493 &iter
->value
, &iter
->type
,
494 iter
->name
, iter
->module_name
,
497 iter
->pos_ftrace_mod_end
= iter
->pos
;
504 static int get_ksymbol_bpf(struct kallsym_iter
*iter
)
508 strlcpy(iter
->module_name
, "bpf", MODULE_NAME_LEN
);
510 ret
= bpf_get_kallsym(iter
->pos
- iter
->pos_ftrace_mod_end
,
511 &iter
->value
, &iter
->type
,
514 iter
->pos_bpf_end
= iter
->pos
;
522 * This uses "__builtin__kprobes" as a module name for symbols for pages
523 * allocated for kprobes' purposes, even though "__builtin__kprobes" is not a
526 static int get_ksymbol_kprobe(struct kallsym_iter
*iter
)
528 strlcpy(iter
->module_name
, "__builtin__kprobes", MODULE_NAME_LEN
);
530 return kprobe_get_kallsym(iter
->pos
- iter
->pos_bpf_end
,
531 &iter
->value
, &iter
->type
,
532 iter
->name
) < 0 ? 0 : 1;
535 /* Returns space to next name. */
536 static unsigned long get_ksymbol_core(struct kallsym_iter
*iter
)
538 unsigned off
= iter
->nameoff
;
540 iter
->module_name
[0] = '\0';
541 iter
->value
= kallsyms_sym_address(iter
->pos
);
543 iter
->type
= kallsyms_get_symbol_type(off
);
545 off
= kallsyms_expand_symbol(off
, iter
->name
, ARRAY_SIZE(iter
->name
));
547 return off
- iter
->nameoff
;
550 static void reset_iter(struct kallsym_iter
*iter
, loff_t new_pos
)
552 iter
->name
[0] = '\0';
553 iter
->nameoff
= get_symbol_offset(new_pos
);
556 iter
->pos_arch_end
= 0;
557 iter
->pos_mod_end
= 0;
558 iter
->pos_ftrace_mod_end
= 0;
559 iter
->pos_bpf_end
= 0;
564 * The end position (last + 1) of each additional kallsyms section is recorded
565 * in iter->pos_..._end as each section is added, and so can be used to
566 * determine which get_ksymbol_...() function to call next.
568 static int update_iter_mod(struct kallsym_iter
*iter
, loff_t pos
)
572 if ((!iter
->pos_arch_end
|| iter
->pos_arch_end
> pos
) &&
573 get_ksymbol_arch(iter
))
576 if ((!iter
->pos_mod_end
|| iter
->pos_mod_end
> pos
) &&
577 get_ksymbol_mod(iter
))
580 if ((!iter
->pos_ftrace_mod_end
|| iter
->pos_ftrace_mod_end
> pos
) &&
581 get_ksymbol_ftrace_mod(iter
))
584 if ((!iter
->pos_bpf_end
|| iter
->pos_bpf_end
> pos
) &&
585 get_ksymbol_bpf(iter
))
588 return get_ksymbol_kprobe(iter
);
591 /* Returns false if pos at or past end of file. */
592 static int update_iter(struct kallsym_iter
*iter
, loff_t pos
)
594 /* Module symbols can be accessed randomly. */
595 if (pos
>= kallsyms_num_syms
)
596 return update_iter_mod(iter
, pos
);
598 /* If we're not on the desired position, reset to new position. */
599 if (pos
!= iter
->pos
)
600 reset_iter(iter
, pos
);
602 iter
->nameoff
+= get_ksymbol_core(iter
);
608 static void *s_next(struct seq_file
*m
, void *p
, loff_t
*pos
)
612 if (!update_iter(m
->private, *pos
))
617 static void *s_start(struct seq_file
*m
, loff_t
*pos
)
619 if (!update_iter(m
->private, *pos
))
624 static void s_stop(struct seq_file
*m
, void *p
)
628 static int s_show(struct seq_file
*m
, void *p
)
631 struct kallsym_iter
*iter
= m
->private;
633 /* Some debugging symbols have no name. Ignore them. */
637 value
= iter
->show_value
? (void *)iter
->value
: NULL
;
639 if (iter
->module_name
[0]) {
643 * Label it "global" if it is exported,
644 * "local" if not exported.
646 type
= iter
->exported
? toupper(iter
->type
) :
648 seq_printf(m
, "%px %c %s\t[%s]\n", value
,
649 type
, iter
->name
, iter
->module_name
);
651 seq_printf(m
, "%px %c %s\n", value
,
652 iter
->type
, iter
->name
);
656 static const struct seq_operations kallsyms_op
= {
663 static inline int kallsyms_for_perf(void)
665 #ifdef CONFIG_PERF_EVENTS
666 extern int sysctl_perf_event_paranoid
;
667 if (sysctl_perf_event_paranoid
<= 1)
674 * We show kallsyms information even to normal users if we've enabled
675 * kernel profiling and are explicitly not paranoid (so kptr_restrict
676 * is clear, and sysctl_perf_event_paranoid isn't set).
678 * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
681 bool kallsyms_show_value(const struct cred
*cred
)
683 switch (kptr_restrict
) {
685 if (kallsyms_for_perf())
689 if (security_capable(cred
, &init_user_ns
, CAP_SYSLOG
,
690 CAP_OPT_NOAUDIT
) == 0)
698 static int kallsyms_open(struct inode
*inode
, struct file
*file
)
701 * We keep iterator in m->private, since normal case is to
702 * s_start from where we left off, so we avoid doing
703 * using get_symbol_offset for every symbol.
705 struct kallsym_iter
*iter
;
706 iter
= __seq_open_private(file
, &kallsyms_op
, sizeof(*iter
));
712 * Instead of checking this on every s_show() call, cache
713 * the result here at open time.
715 iter
->show_value
= kallsyms_show_value(file
->f_cred
);
719 #ifdef CONFIG_KGDB_KDB
720 const char *kdb_walk_kallsyms(loff_t
*pos
)
722 static struct kallsym_iter kdb_walk_kallsyms_iter
;
724 memset(&kdb_walk_kallsyms_iter
, 0,
725 sizeof(kdb_walk_kallsyms_iter
));
726 reset_iter(&kdb_walk_kallsyms_iter
, 0);
729 if (!update_iter(&kdb_walk_kallsyms_iter
, *pos
))
732 /* Some debugging symbols have no name. Ignore them. */
733 if (kdb_walk_kallsyms_iter
.name
[0])
734 return kdb_walk_kallsyms_iter
.name
;
737 #endif /* CONFIG_KGDB_KDB */
739 static const struct proc_ops kallsyms_proc_ops
= {
740 .proc_open
= kallsyms_open
,
741 .proc_read
= seq_read
,
742 .proc_lseek
= seq_lseek
,
743 .proc_release
= seq_release_private
,
746 static int __init
kallsyms_init(void)
748 proc_create("kallsyms", 0444, NULL
, &kallsyms_proc_ops
);
751 device_initcall(kallsyms_init
);