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 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
;
442 unsigned int nameoff
; /* If iterating in core kernel symbols. */
444 char name
[KSYM_NAME_LEN
];
445 char module_name
[MODULE_NAME_LEN
];
450 int __weak
arch_get_kallsym(unsigned int symnum
, unsigned long *value
,
451 char *type
, char *name
)
456 static int get_ksymbol_arch(struct kallsym_iter
*iter
)
458 int ret
= arch_get_kallsym(iter
->pos
- kallsyms_num_syms
,
459 &iter
->value
, &iter
->type
,
463 iter
->pos_arch_end
= iter
->pos
;
470 static int get_ksymbol_mod(struct kallsym_iter
*iter
)
472 int ret
= module_get_kallsym(iter
->pos
- iter
->pos_arch_end
,
473 &iter
->value
, &iter
->type
,
474 iter
->name
, iter
->module_name
,
477 iter
->pos_mod_end
= iter
->pos
;
484 static int get_ksymbol_ftrace_mod(struct kallsym_iter
*iter
)
486 int ret
= ftrace_mod_get_kallsym(iter
->pos
- iter
->pos_mod_end
,
487 &iter
->value
, &iter
->type
,
488 iter
->name
, iter
->module_name
,
491 iter
->pos_ftrace_mod_end
= iter
->pos
;
498 static int get_ksymbol_bpf(struct kallsym_iter
*iter
)
500 strlcpy(iter
->module_name
, "bpf", MODULE_NAME_LEN
);
502 return bpf_get_kallsym(iter
->pos
- iter
->pos_ftrace_mod_end
,
503 &iter
->value
, &iter
->type
,
504 iter
->name
) < 0 ? 0 : 1;
507 /* Returns space to next name. */
508 static unsigned long get_ksymbol_core(struct kallsym_iter
*iter
)
510 unsigned off
= iter
->nameoff
;
512 iter
->module_name
[0] = '\0';
513 iter
->value
= kallsyms_sym_address(iter
->pos
);
515 iter
->type
= kallsyms_get_symbol_type(off
);
517 off
= kallsyms_expand_symbol(off
, iter
->name
, ARRAY_SIZE(iter
->name
));
519 return off
- iter
->nameoff
;
522 static void reset_iter(struct kallsym_iter
*iter
, loff_t new_pos
)
524 iter
->name
[0] = '\0';
525 iter
->nameoff
= get_symbol_offset(new_pos
);
528 iter
->pos_arch_end
= 0;
529 iter
->pos_mod_end
= 0;
530 iter
->pos_ftrace_mod_end
= 0;
535 * The end position (last + 1) of each additional kallsyms section is recorded
536 * in iter->pos_..._end as each section is added, and so can be used to
537 * determine which get_ksymbol_...() function to call next.
539 static int update_iter_mod(struct kallsym_iter
*iter
, loff_t pos
)
543 if ((!iter
->pos_arch_end
|| iter
->pos_arch_end
> pos
) &&
544 get_ksymbol_arch(iter
))
547 if ((!iter
->pos_mod_end
|| iter
->pos_mod_end
> pos
) &&
548 get_ksymbol_mod(iter
))
551 if ((!iter
->pos_ftrace_mod_end
|| iter
->pos_ftrace_mod_end
> pos
) &&
552 get_ksymbol_ftrace_mod(iter
))
555 return get_ksymbol_bpf(iter
);
558 /* Returns false if pos at or past end of file. */
559 static int update_iter(struct kallsym_iter
*iter
, loff_t pos
)
561 /* Module symbols can be accessed randomly. */
562 if (pos
>= kallsyms_num_syms
)
563 return update_iter_mod(iter
, pos
);
565 /* If we're not on the desired position, reset to new position. */
566 if (pos
!= iter
->pos
)
567 reset_iter(iter
, pos
);
569 iter
->nameoff
+= get_ksymbol_core(iter
);
575 static void *s_next(struct seq_file
*m
, void *p
, loff_t
*pos
)
579 if (!update_iter(m
->private, *pos
))
584 static void *s_start(struct seq_file
*m
, loff_t
*pos
)
586 if (!update_iter(m
->private, *pos
))
591 static void s_stop(struct seq_file
*m
, void *p
)
595 static int s_show(struct seq_file
*m
, void *p
)
598 struct kallsym_iter
*iter
= m
->private;
600 /* Some debugging symbols have no name. Ignore them. */
604 value
= iter
->show_value
? (void *)iter
->value
: NULL
;
606 if (iter
->module_name
[0]) {
610 * Label it "global" if it is exported,
611 * "local" if not exported.
613 type
= iter
->exported
? toupper(iter
->type
) :
615 seq_printf(m
, "%px %c %s\t[%s]\n", value
,
616 type
, iter
->name
, iter
->module_name
);
618 seq_printf(m
, "%px %c %s\n", value
,
619 iter
->type
, iter
->name
);
623 static const struct seq_operations kallsyms_op
= {
630 static inline int kallsyms_for_perf(void)
632 #ifdef CONFIG_PERF_EVENTS
633 extern int sysctl_perf_event_paranoid
;
634 if (sysctl_perf_event_paranoid
<= 1)
641 * We show kallsyms information even to normal users if we've enabled
642 * kernel profiling and are explicitly not paranoid (so kptr_restrict
643 * is clear, and sysctl_perf_event_paranoid isn't set).
645 * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
648 bool kallsyms_show_value(const struct cred
*cred
)
650 switch (kptr_restrict
) {
652 if (kallsyms_for_perf())
656 if (security_capable(cred
, &init_user_ns
, CAP_SYSLOG
,
657 CAP_OPT_NOAUDIT
) == 0)
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
));
679 * Instead of checking this on every s_show() call, cache
680 * the result here at open time.
682 iter
->show_value
= kallsyms_show_value(file
->f_cred
);
686 #ifdef CONFIG_KGDB_KDB
687 const char *kdb_walk_kallsyms(loff_t
*pos
)
689 static struct kallsym_iter kdb_walk_kallsyms_iter
;
691 memset(&kdb_walk_kallsyms_iter
, 0,
692 sizeof(kdb_walk_kallsyms_iter
));
693 reset_iter(&kdb_walk_kallsyms_iter
, 0);
696 if (!update_iter(&kdb_walk_kallsyms_iter
, *pos
))
699 /* Some debugging symbols have no name. Ignore them. */
700 if (kdb_walk_kallsyms_iter
.name
[0])
701 return kdb_walk_kallsyms_iter
.name
;
704 #endif /* CONFIG_KGDB_KDB */
706 static const struct file_operations kallsyms_operations
= {
707 .open
= kallsyms_open
,
710 .release
= seq_release_private
,
713 static int __init
kallsyms_init(void)
715 proc_create("kallsyms", 0444, NULL
, &kallsyms_operations
);
718 device_initcall(kallsyms_init
);