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
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 char 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;
64 /* Get the compressed symbol length from the first symbol byte. */
65 data = &kallsyms_names[off];
70 * Update the offset to return the offset for the next symbol on
71 * the compressed stream.
76 * For every byte on the compressed symbol data, copy the table
77 * entry for that byte.
80 tptr = &kallsyms_token_table[kallsyms_token_index[*data]];
101 /* Return to offset to the next symbol. */
106 * Get symbol type information. This is encoded as a single char at the
107 * beginning of the symbol name.
109 static char kallsyms_get_symbol_type(unsigned int off)
112 * Get just the first code, look it up in the token table,
113 * and return the first char from this token.
115 return kallsyms_token_table[kallsyms_token_index[kallsyms_names[off + 1]]];
120 * Find the offset on the compressed stream given and index in the
123 static unsigned int get_symbol_offset(unsigned long pos)
129 * Use the closest marker we have. We have markers every 256 positions,
130 * so that should be close enough.
132 name = &kallsyms_names[kallsyms_markers[pos >> 8]];
135 * Sequentially scan all the symbols up to the point we're searching
136 * for. Every symbol is stored in a [<len>][<len> bytes of data] format,
137 * so we just need to add the len to the current pointer for every
138 * symbol we wish to skip.
140 for (i = 0; i < (pos & 0xFF); i++)
141 name = name + (*name) + 1;
143 return name - kallsyms_names;
146 static unsigned long kallsyms_sym_address(int idx)
148 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
149 return kallsyms_addresses[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 /* Lookup the address for this symbol. Returns 0 if not found. */
164 unsigned long kallsyms_lookup_name(const char *name)
166 char namebuf[KSYM_NAME_LEN];
170 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
171 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
173 if (strcmp(namebuf, name) == 0)
174 return kallsyms_sym_address(i);
176 return module_kallsyms_lookup_name(name);
178 EXPORT_SYMBOL_GPL(kallsyms_lookup_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);
197 EXPORT_SYMBOL_GPL(kallsyms_on_each_symbol);
199 static unsigned long get_symbol_pos(unsigned long addr,
200 unsigned long *symbolsize,
201 unsigned long *offset)
203 unsigned long symbol_start = 0, symbol_end = 0;
204 unsigned long i, low, high, mid;
206 /* This kernel should never had been booted. */
207 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
208 BUG_ON(!kallsyms_addresses);
210 BUG_ON(!kallsyms_offsets);
212 /* Do a binary search on the sorted kallsyms_addresses array. */
214 high = kallsyms_num_syms;
216 while (high - low > 1) {
217 mid = low + (high - low) / 2;
218 if (kallsyms_sym_address(mid) <= addr)
225 * Search for the first aliased symbol. Aliased
226 * symbols are symbols with the same address.
228 while (low && kallsyms_sym_address(low-1) == kallsyms_sym_address(low))
231 symbol_start = kallsyms_sym_address(low);
233 /* Search for next non-aliased symbol. */
234 for (i = low + 1; i < kallsyms_num_syms; i++) {
235 if (kallsyms_sym_address(i) > symbol_start) {
236 symbol_end = kallsyms_sym_address(i);
241 /* If we found no next symbol, we use the end of the section. */
243 if (is_kernel_inittext(addr))
244 symbol_end = (unsigned long)_einittext;
245 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
246 symbol_end = (unsigned long)_end;
248 symbol_end = (unsigned long)_etext;
252 *symbolsize = symbol_end - symbol_start;
254 *offset = addr - symbol_start;
260 * Lookup an address but don't bother to find any names.
262 int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
263 unsigned long *offset)
265 char namebuf[KSYM_NAME_LEN];
267 if (is_ksym_addr(addr)) {
268 get_symbol_pos(addr, symbolsize, offset);
271 return !!module_address_lookup(addr, symbolsize, offset, NULL, namebuf) ||
272 !!__bpf_address_lookup(addr, symbolsize, offset, namebuf);
277 * - modname is set to NULL if it's in the kernel.
278 * - We guarantee that the returned name is valid until we reschedule even if.
279 * It resides in a module.
280 * - We also guarantee that modname will be valid until rescheduled.
282 const char *kallsyms_lookup(unsigned long addr,
283 unsigned long *symbolsize,
284 unsigned long *offset,
285 char **modname, char *namebuf)
289 namebuf[KSYM_NAME_LEN - 1] = 0;
292 if (is_ksym_addr(addr)) {
295 pos = get_symbol_pos(addr, symbolsize, offset);
297 kallsyms_expand_symbol(get_symbol_offset(pos),
298 namebuf, KSYM_NAME_LEN);
304 /* See if it's in a module or a BPF JITed image. */
305 ret = module_address_lookup(addr, symbolsize, offset,
308 ret = bpf_address_lookup(addr, symbolsize,
309 offset, modname, namebuf);
312 ret = ftrace_mod_address_lookup(addr, symbolsize,
313 offset, modname, namebuf);
317 int lookup_symbol_name(unsigned long addr, char *symname)
320 symname[KSYM_NAME_LEN - 1] = '\0';
322 if (is_ksym_addr(addr)) {
325 pos = get_symbol_pos(addr, NULL, NULL);
327 kallsyms_expand_symbol(get_symbol_offset(pos),
328 symname, KSYM_NAME_LEN);
331 /* See if it's in a module. */
332 return lookup_module_symbol_name(addr, symname);
335 int lookup_symbol_attrs(unsigned long addr, unsigned long *size,
336 unsigned long *offset, char *modname, char *name)
339 name[KSYM_NAME_LEN - 1] = '\0';
341 if (is_ksym_addr(addr)) {
344 pos = get_symbol_pos(addr, size, offset);
346 kallsyms_expand_symbol(get_symbol_offset(pos),
347 name, KSYM_NAME_LEN);
351 /* See if it's in a module. */
352 return lookup_module_symbol_attrs(addr, size, offset, modname, name);
355 /* Look up a kernel symbol and return it in a text buffer. */
356 static int __sprint_symbol(char *buffer, unsigned long address,
357 int symbol_offset, int add_offset)
361 unsigned long offset, size;
364 address += symbol_offset;
365 name = kallsyms_lookup(address, &size, &offset, &modname, buffer);
367 return sprintf(buffer, "0x%lx", address - symbol_offset);
370 strcpy(buffer, name);
371 len = strlen(buffer);
372 offset -= symbol_offset;
375 len += sprintf(buffer + len, "+%#lx/%#lx", offset, size);
378 len += sprintf(buffer + len, " [%s]", modname);
384 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
385 * @buffer: buffer to be stored
386 * @address: address to lookup
388 * This function looks up a kernel symbol with @address and stores its name,
389 * offset, size and module name to @buffer if possible. If no symbol was found,
390 * just saves its @address as is.
392 * This function returns the number of bytes stored in @buffer.
394 int sprint_symbol(char *buffer, unsigned long address)
396 return __sprint_symbol(buffer, address, 0, 1);
398 EXPORT_SYMBOL_GPL(sprint_symbol);
401 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
402 * @buffer: buffer to be stored
403 * @address: address to lookup
405 * This function looks up a kernel symbol with @address and stores its name
406 * and module name to @buffer if possible. If no symbol was found, just saves
407 * its @address as is.
409 * This function returns the number of bytes stored in @buffer.
411 int sprint_symbol_no_offset(char *buffer, unsigned long address)
413 return __sprint_symbol(buffer, address, 0, 0);
415 EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);
418 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
419 * @buffer: buffer to be stored
420 * @address: address to lookup
422 * This function is for stack backtrace and does the same thing as
423 * sprint_symbol() but with modified/decreased @address. If there is a
424 * tail-call to the function marked "noreturn", gcc optimized out code after
425 * the call so that the stack-saved return address could point outside of the
426 * caller. This function ensures that kallsyms will find the original caller
427 * by decreasing @address.
429 * This function returns the number of bytes stored in @buffer.
431 int sprint_backtrace(char *buffer, unsigned long address)
433 return __sprint_symbol(buffer, address, -1, 1);
436 /* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
437 struct kallsym_iter {
441 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;
485 static int get_ksymbol_ftrace_mod(struct kallsym_iter *iter)
487 int ret = ftrace_mod_get_kallsym(iter->pos - iter->pos_mod_end,
488 &iter->value, &iter->type,
489 iter->name, iter->module_name,
492 iter->pos_ftrace_mod_end = iter->pos;
499 static int get_ksymbol_bpf(struct kallsym_iter *iter)
501 strlcpy(iter->module_name, "bpf", MODULE_NAME_LEN);
503 return bpf_get_kallsym(iter->pos - iter->pos_ftrace_mod_end,
504 &iter->value, &iter->type,
505 iter->name) < 0 ? 0 : 1;
508 /* Returns space to next name. */
509 static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
511 unsigned off = iter->nameoff;
513 iter->module_name[0] = '\0';
514 iter->value = kallsyms_sym_address(iter->pos);
516 iter->type = kallsyms_get_symbol_type(off);
518 off = kallsyms_expand_symbol(off, iter->name, ARRAY_SIZE(iter->name));
520 return off - iter->nameoff;
523 static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
525 iter->name[0] = '\0';
526 iter->nameoff = get_symbol_offset(new_pos);
529 iter->pos_arch_end = 0;
530 iter->pos_mod_end = 0;
531 iter->pos_ftrace_mod_end = 0;
536 * The end position (last + 1) of each additional kallsyms section is recorded
537 * in iter->pos_..._end as each section is added, and so can be used to
538 * determine which get_ksymbol_...() function to call next.
540 static int update_iter_mod(struct kallsym_iter *iter, loff_t pos)
544 if ((!iter->pos_arch_end || iter->pos_arch_end > pos) &&
545 get_ksymbol_arch(iter))
548 if ((!iter->pos_mod_end || iter->pos_mod_end > pos) &&
549 get_ksymbol_mod(iter))
552 if ((!iter->pos_ftrace_mod_end || iter->pos_ftrace_mod_end > pos) &&
553 get_ksymbol_ftrace_mod(iter))
556 return get_ksymbol_bpf(iter);
559 /* Returns false if pos at or past end of file. */
560 static int update_iter(struct kallsym_iter *iter, loff_t pos)
562 /* Module symbols can be accessed randomly. */
563 if (pos >= kallsyms_num_syms)
564 return update_iter_mod(iter, pos);
566 /* If we're not on the desired position, reset to new position. */
567 if (pos != iter->pos)
568 reset_iter(iter, pos);
570 iter->nameoff += get_ksymbol_core(iter);
576 static void *s_next(struct seq_file *m, void *p, loff_t *pos)
580 if (!update_iter(m->private, *pos))
585 static void *s_start(struct seq_file *m, loff_t *pos)
587 if (!update_iter(m->private, *pos))
592 static void s_stop(struct seq_file *m, void *p)
596 static int s_show(struct seq_file *m, void *p)
599 struct kallsym_iter *iter = m->private;
601 /* Some debugging symbols have no name. Ignore them. */
605 value = iter->show_value ? (void *)iter->value : NULL;
607 if (iter->module_name[0]) {
611 * Label it "global" if it is exported,
612 * "local" if not exported.
614 type = iter->exported ? toupper(iter->type) :
616 seq_printf(m, "%px %c %s\t[%s]\n", value,
617 type, iter->name, iter->module_name);
619 seq_printf(m, "%px %c %s\n", value,
620 iter->type, iter->name);
624 static const struct seq_operations kallsyms_op = {
631 static inline int kallsyms_for_perf(void)
633 #ifdef CONFIG_PERF_EVENTS
634 extern int sysctl_perf_event_paranoid;
635 if (sysctl_perf_event_paranoid <= 1)
642 * We show kallsyms information even to normal users if we've enabled
643 * kernel profiling and are explicitly not paranoid (so kptr_restrict
644 * is clear, and sysctl_perf_event_paranoid isn't set).
646 * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
649 int kallsyms_show_value(void)
651 switch (kptr_restrict) {
653 if (kallsyms_for_perf())
657 if (has_capability_noaudit(current, CAP_SYSLOG))
665 static int kallsyms_open(struct inode *inode, struct file *file)
668 * We keep iterator in m->private, since normal case is to
669 * s_start from where we left off, so we avoid doing
670 * using get_symbol_offset for every symbol.
672 struct kallsym_iter *iter;
673 iter = __seq_open_private(file, &kallsyms_op, sizeof(*iter));
678 iter->show_value = kallsyms_show_value();
682 #ifdef CONFIG_KGDB_KDB
683 const char *kdb_walk_kallsyms(loff_t *pos)
685 static struct kallsym_iter kdb_walk_kallsyms_iter;
687 memset(&kdb_walk_kallsyms_iter, 0,
688 sizeof(kdb_walk_kallsyms_iter));
689 reset_iter(&kdb_walk_kallsyms_iter, 0);
692 if (!update_iter(&kdb_walk_kallsyms_iter, *pos))
695 /* Some debugging symbols have no name. Ignore them. */
696 if (kdb_walk_kallsyms_iter.name[0])
697 return kdb_walk_kallsyms_iter.name;
700 #endif /* CONFIG_KGDB_KDB */
702 static const struct proc_ops kallsyms_proc_ops = {
703 .proc_open = kallsyms_open,
704 .proc_read = seq_read,
705 .proc_lseek = seq_lseek,
706 .proc_release = seq_release_private,
709 static int __init kallsyms_init(void)
711 proc_create("kallsyms", 0444, NULL, &kallsyms_proc_ops);
714 device_initcall(kallsyms_init);