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 #ifdef CONFIG_LIVEPATCH
182 * Iterate over all symbols in vmlinux. For symbols from modules use
183 * module_kallsyms_on_each_symbol instead.
185 int kallsyms_on_each_symbol(int (*fn
)(void *, const char *, struct module
*,
189 char namebuf
[KSYM_NAME_LEN
];
194 for (i
= 0, off
= 0; i
< kallsyms_num_syms
; i
++) {
195 off
= kallsyms_expand_symbol(off
, namebuf
, ARRAY_SIZE(namebuf
));
196 ret
= fn(data
, namebuf
, NULL
, kallsyms_sym_address(i
));
202 #endif /* CONFIG_LIVEPATCH */
204 static unsigned long get_symbol_pos(unsigned long addr
,
205 unsigned long *symbolsize
,
206 unsigned long *offset
)
208 unsigned long symbol_start
= 0, symbol_end
= 0;
209 unsigned long i
, low
, high
, mid
;
211 /* This kernel should never had been booted. */
212 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE
))
213 BUG_ON(!kallsyms_addresses
);
215 BUG_ON(!kallsyms_offsets
);
217 /* Do a binary search on the sorted kallsyms_addresses array. */
219 high
= kallsyms_num_syms
;
221 while (high
- low
> 1) {
222 mid
= low
+ (high
- low
) / 2;
223 if (kallsyms_sym_address(mid
) <= addr
)
230 * Search for the first aliased symbol. Aliased
231 * symbols are symbols with the same address.
233 while (low
&& kallsyms_sym_address(low
-1) == kallsyms_sym_address(low
))
236 symbol_start
= kallsyms_sym_address(low
);
238 /* Search for next non-aliased symbol. */
239 for (i
= low
+ 1; i
< kallsyms_num_syms
; i
++) {
240 if (kallsyms_sym_address(i
) > symbol_start
) {
241 symbol_end
= kallsyms_sym_address(i
);
246 /* If we found no next symbol, we use the end of the section. */
248 if (is_kernel_inittext(addr
))
249 symbol_end
= (unsigned long)_einittext
;
250 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL
))
251 symbol_end
= (unsigned long)_end
;
253 symbol_end
= (unsigned long)_etext
;
257 *symbolsize
= symbol_end
- symbol_start
;
259 *offset
= addr
- symbol_start
;
265 * Lookup an address but don't bother to find any names.
267 int kallsyms_lookup_size_offset(unsigned long addr
, unsigned long *symbolsize
,
268 unsigned long *offset
)
270 char namebuf
[KSYM_NAME_LEN
];
272 if (is_ksym_addr(addr
)) {
273 get_symbol_pos(addr
, symbolsize
, offset
);
276 return !!module_address_lookup(addr
, symbolsize
, offset
, NULL
, namebuf
) ||
277 !!__bpf_address_lookup(addr
, symbolsize
, offset
, namebuf
);
282 * - modname is set to NULL if it's in the kernel.
283 * - We guarantee that the returned name is valid until we reschedule even if.
284 * It resides in a module.
285 * - We also guarantee that modname will be valid until rescheduled.
287 const char *kallsyms_lookup(unsigned long addr
,
288 unsigned long *symbolsize
,
289 unsigned long *offset
,
290 char **modname
, char *namebuf
)
294 namebuf
[KSYM_NAME_LEN
- 1] = 0;
297 if (is_ksym_addr(addr
)) {
300 pos
= get_symbol_pos(addr
, symbolsize
, offset
);
302 kallsyms_expand_symbol(get_symbol_offset(pos
),
303 namebuf
, KSYM_NAME_LEN
);
309 /* See if it's in a module or a BPF JITed image. */
310 ret
= module_address_lookup(addr
, symbolsize
, offset
,
313 ret
= bpf_address_lookup(addr
, symbolsize
,
314 offset
, modname
, namebuf
);
317 ret
= ftrace_mod_address_lookup(addr
, symbolsize
,
318 offset
, modname
, namebuf
);
322 int lookup_symbol_name(unsigned long addr
, char *symname
)
325 symname
[KSYM_NAME_LEN
- 1] = '\0';
327 if (is_ksym_addr(addr
)) {
330 pos
= get_symbol_pos(addr
, NULL
, NULL
);
332 kallsyms_expand_symbol(get_symbol_offset(pos
),
333 symname
, KSYM_NAME_LEN
);
336 /* See if it's in a module. */
337 return lookup_module_symbol_name(addr
, symname
);
340 int lookup_symbol_attrs(unsigned long addr
, unsigned long *size
,
341 unsigned long *offset
, char *modname
, char *name
)
344 name
[KSYM_NAME_LEN
- 1] = '\0';
346 if (is_ksym_addr(addr
)) {
349 pos
= get_symbol_pos(addr
, size
, offset
);
351 kallsyms_expand_symbol(get_symbol_offset(pos
),
352 name
, KSYM_NAME_LEN
);
356 /* See if it's in a module. */
357 return lookup_module_symbol_attrs(addr
, size
, offset
, modname
, name
);
360 /* Look up a kernel symbol and return it in a text buffer. */
361 static int __sprint_symbol(char *buffer
, unsigned long address
,
362 int symbol_offset
, int add_offset
)
366 unsigned long offset
, size
;
369 address
+= symbol_offset
;
370 name
= kallsyms_lookup(address
, &size
, &offset
, &modname
, buffer
);
372 return sprintf(buffer
, "0x%lx", address
- symbol_offset
);
375 strcpy(buffer
, name
);
376 len
= strlen(buffer
);
377 offset
-= symbol_offset
;
380 len
+= sprintf(buffer
+ len
, "+%#lx/%#lx", offset
, size
);
383 len
+= sprintf(buffer
+ len
, " [%s]", modname
);
389 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
390 * @buffer: buffer to be stored
391 * @address: address to lookup
393 * This function looks up a kernel symbol with @address and stores its name,
394 * offset, size and module name to @buffer if possible. If no symbol was found,
395 * just saves its @address as is.
397 * This function returns the number of bytes stored in @buffer.
399 int sprint_symbol(char *buffer
, unsigned long address
)
401 return __sprint_symbol(buffer
, address
, 0, 1);
403 EXPORT_SYMBOL_GPL(sprint_symbol
);
406 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
407 * @buffer: buffer to be stored
408 * @address: address to lookup
410 * This function looks up a kernel symbol with @address and stores its name
411 * and module name to @buffer if possible. If no symbol was found, just saves
412 * its @address as is.
414 * This function returns the number of bytes stored in @buffer.
416 int sprint_symbol_no_offset(char *buffer
, unsigned long address
)
418 return __sprint_symbol(buffer
, address
, 0, 0);
420 EXPORT_SYMBOL_GPL(sprint_symbol_no_offset
);
423 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
424 * @buffer: buffer to be stored
425 * @address: address to lookup
427 * This function is for stack backtrace and does the same thing as
428 * sprint_symbol() but with modified/decreased @address. If there is a
429 * tail-call to the function marked "noreturn", gcc optimized out code after
430 * the call so that the stack-saved return address could point outside of the
431 * caller. This function ensures that kallsyms will find the original caller
432 * by decreasing @address.
434 * This function returns the number of bytes stored in @buffer.
436 int sprint_backtrace(char *buffer
, unsigned long address
)
438 return __sprint_symbol(buffer
, address
, -1, 1);
441 /* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
442 struct kallsym_iter
{
446 loff_t pos_ftrace_mod_end
;
449 unsigned int nameoff
; /* If iterating in core kernel symbols. */
451 char name
[KSYM_NAME_LEN
];
452 char module_name
[MODULE_NAME_LEN
];
457 int __weak
arch_get_kallsym(unsigned int symnum
, unsigned long *value
,
458 char *type
, char *name
)
463 static int get_ksymbol_arch(struct kallsym_iter
*iter
)
465 int ret
= arch_get_kallsym(iter
->pos
- kallsyms_num_syms
,
466 &iter
->value
, &iter
->type
,
470 iter
->pos_arch_end
= iter
->pos
;
477 static int get_ksymbol_mod(struct kallsym_iter
*iter
)
479 int ret
= module_get_kallsym(iter
->pos
- iter
->pos_arch_end
,
480 &iter
->value
, &iter
->type
,
481 iter
->name
, iter
->module_name
,
484 iter
->pos_mod_end
= iter
->pos
;
492 * ftrace_mod_get_kallsym() may also get symbols for pages allocated for ftrace
493 * purposes. In that case "__builtin__ftrace" is used as a module name, even
494 * though "__builtin__ftrace" is not a module.
496 static int get_ksymbol_ftrace_mod(struct kallsym_iter
*iter
)
498 int ret
= ftrace_mod_get_kallsym(iter
->pos
- iter
->pos_mod_end
,
499 &iter
->value
, &iter
->type
,
500 iter
->name
, iter
->module_name
,
503 iter
->pos_ftrace_mod_end
= iter
->pos
;
510 static int get_ksymbol_bpf(struct kallsym_iter
*iter
)
514 strlcpy(iter
->module_name
, "bpf", MODULE_NAME_LEN
);
516 ret
= bpf_get_kallsym(iter
->pos
- iter
->pos_ftrace_mod_end
,
517 &iter
->value
, &iter
->type
,
520 iter
->pos_bpf_end
= iter
->pos
;
528 * This uses "__builtin__kprobes" as a module name for symbols for pages
529 * allocated for kprobes' purposes, even though "__builtin__kprobes" is not a
532 static int get_ksymbol_kprobe(struct kallsym_iter
*iter
)
534 strlcpy(iter
->module_name
, "__builtin__kprobes", MODULE_NAME_LEN
);
536 return kprobe_get_kallsym(iter
->pos
- iter
->pos_bpf_end
,
537 &iter
->value
, &iter
->type
,
538 iter
->name
) < 0 ? 0 : 1;
541 /* Returns space to next name. */
542 static unsigned long get_ksymbol_core(struct kallsym_iter
*iter
)
544 unsigned off
= iter
->nameoff
;
546 iter
->module_name
[0] = '\0';
547 iter
->value
= kallsyms_sym_address(iter
->pos
);
549 iter
->type
= kallsyms_get_symbol_type(off
);
551 off
= kallsyms_expand_symbol(off
, iter
->name
, ARRAY_SIZE(iter
->name
));
553 return off
- iter
->nameoff
;
556 static void reset_iter(struct kallsym_iter
*iter
, loff_t new_pos
)
558 iter
->name
[0] = '\0';
559 iter
->nameoff
= get_symbol_offset(new_pos
);
562 iter
->pos_arch_end
= 0;
563 iter
->pos_mod_end
= 0;
564 iter
->pos_ftrace_mod_end
= 0;
565 iter
->pos_bpf_end
= 0;
570 * The end position (last + 1) of each additional kallsyms section is recorded
571 * in iter->pos_..._end as each section is added, and so can be used to
572 * determine which get_ksymbol_...() function to call next.
574 static int update_iter_mod(struct kallsym_iter
*iter
, loff_t pos
)
578 if ((!iter
->pos_arch_end
|| iter
->pos_arch_end
> pos
) &&
579 get_ksymbol_arch(iter
))
582 if ((!iter
->pos_mod_end
|| iter
->pos_mod_end
> pos
) &&
583 get_ksymbol_mod(iter
))
586 if ((!iter
->pos_ftrace_mod_end
|| iter
->pos_ftrace_mod_end
> pos
) &&
587 get_ksymbol_ftrace_mod(iter
))
590 if ((!iter
->pos_bpf_end
|| iter
->pos_bpf_end
> pos
) &&
591 get_ksymbol_bpf(iter
))
594 return get_ksymbol_kprobe(iter
);
597 /* Returns false if pos at or past end of file. */
598 static int update_iter(struct kallsym_iter
*iter
, loff_t pos
)
600 /* Module symbols can be accessed randomly. */
601 if (pos
>= kallsyms_num_syms
)
602 return update_iter_mod(iter
, pos
);
604 /* If we're not on the desired position, reset to new position. */
605 if (pos
!= iter
->pos
)
606 reset_iter(iter
, pos
);
608 iter
->nameoff
+= get_ksymbol_core(iter
);
614 static void *s_next(struct seq_file
*m
, void *p
, loff_t
*pos
)
618 if (!update_iter(m
->private, *pos
))
623 static void *s_start(struct seq_file
*m
, loff_t
*pos
)
625 if (!update_iter(m
->private, *pos
))
630 static void s_stop(struct seq_file
*m
, void *p
)
634 static int s_show(struct seq_file
*m
, void *p
)
637 struct kallsym_iter
*iter
= m
->private;
639 /* Some debugging symbols have no name. Ignore them. */
643 value
= iter
->show_value
? (void *)iter
->value
: NULL
;
645 if (iter
->module_name
[0]) {
649 * Label it "global" if it is exported,
650 * "local" if not exported.
652 type
= iter
->exported
? toupper(iter
->type
) :
654 seq_printf(m
, "%px %c %s\t[%s]\n", value
,
655 type
, iter
->name
, iter
->module_name
);
657 seq_printf(m
, "%px %c %s\n", value
,
658 iter
->type
, iter
->name
);
662 static const struct seq_operations kallsyms_op
= {
669 static inline int kallsyms_for_perf(void)
671 #ifdef CONFIG_PERF_EVENTS
672 extern int sysctl_perf_event_paranoid
;
673 if (sysctl_perf_event_paranoid
<= 1)
680 * We show kallsyms information even to normal users if we've enabled
681 * kernel profiling and are explicitly not paranoid (so kptr_restrict
682 * is clear, and sysctl_perf_event_paranoid isn't set).
684 * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
687 bool kallsyms_show_value(const struct cred
*cred
)
689 switch (kptr_restrict
) {
691 if (kallsyms_for_perf())
695 if (security_capable(cred
, &init_user_ns
, CAP_SYSLOG
,
696 CAP_OPT_NOAUDIT
) == 0)
704 static int kallsyms_open(struct inode
*inode
, struct file
*file
)
707 * We keep iterator in m->private, since normal case is to
708 * s_start from where we left off, so we avoid doing
709 * using get_symbol_offset for every symbol.
711 struct kallsym_iter
*iter
;
712 iter
= __seq_open_private(file
, &kallsyms_op
, sizeof(*iter
));
718 * Instead of checking this on every s_show() call, cache
719 * the result here at open time.
721 iter
->show_value
= kallsyms_show_value(file
->f_cred
);
725 #ifdef CONFIG_KGDB_KDB
726 const char *kdb_walk_kallsyms(loff_t
*pos
)
728 static struct kallsym_iter kdb_walk_kallsyms_iter
;
730 memset(&kdb_walk_kallsyms_iter
, 0,
731 sizeof(kdb_walk_kallsyms_iter
));
732 reset_iter(&kdb_walk_kallsyms_iter
, 0);
735 if (!update_iter(&kdb_walk_kallsyms_iter
, *pos
))
738 /* Some debugging symbols have no name. Ignore them. */
739 if (kdb_walk_kallsyms_iter
.name
[0])
740 return kdb_walk_kallsyms_iter
.name
;
743 #endif /* CONFIG_KGDB_KDB */
745 static const struct proc_ops kallsyms_proc_ops
= {
746 .proc_open
= kallsyms_open
,
747 .proc_read
= seq_read
,
748 .proc_lseek
= seq_lseek
,
749 .proc_release
= seq_release_private
,
752 static int __init
kallsyms_init(void)
754 proc_create("kallsyms", 0444, NULL
, &kallsyms_proc_ops
);
757 device_initcall(kallsyms_init
);