kallsyms: Skip the name search for empty string
[linux-2.6-block.git] / kernel / kallsyms.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * kallsyms.c: in-kernel printing of symbolic oopses and stack traces.
4 *
5 * Rewritten and vastly simplified by Rusty Russell for in-kernel
6 * module loader:
7 * Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
8 *
9 * ChangeLog:
10 *
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)
14 */
15#include <linux/kallsyms.h>
1da177e4
LT
16#include <linux/init.h>
17#include <linux/seq_file.h>
18#include <linux/fs.h>
67fc4e0c 19#include <linux/kdb.h>
1da177e4
LT
20#include <linux/err.h>
21#include <linux/proc_fs.h>
4e57b681 22#include <linux/sched.h> /* for cond_resched */
07354a00 23#include <linux/ctype.h>
5a0e3ad6 24#include <linux/slab.h>
74451e66 25#include <linux/filter.h>
aba4b5c2 26#include <linux/ftrace.h>
d002b8bc 27#include <linux/kprobes.h>
9294523e 28#include <linux/build_bug.h>
52f5684c 29#include <linux/compiler.h>
9294523e
SB
30#include <linux/module.h>
31#include <linux/kernel.h>
1da177e4 32
ad6ccfad
MK
33/*
34 * These will be re-linked against their real values
35 * during the second link stage.
36 */
52f5684c 37extern const unsigned long kallsyms_addresses[] __weak;
2213e9a6 38extern const int kallsyms_offsets[] __weak;
52f5684c 39extern const u8 kallsyms_names[] __weak;
1da177e4 40
ad6ccfad
MK
41/*
42 * Tell the compiler that the count isn't in the small data section if the arch
43 * has one (eg: FRV).
9e6c1e63 44 */
80ffbaa5 45extern const unsigned int kallsyms_num_syms
33def849 46__section(".rodata") __attribute__((weak));
9e6c1e63 47
2213e9a6 48extern const unsigned long kallsyms_relative_base
33def849 49__section(".rodata") __attribute__((weak));
2213e9a6 50
cde26a6e 51extern const char kallsyms_token_table[] __weak;
52f5684c 52extern const u16 kallsyms_token_index[] __weak;
1da177e4 53
80ffbaa5 54extern const unsigned int kallsyms_markers[] __weak;
1da177e4 55
ad6ccfad
MK
56/*
57 * Expand a compressed symbol data into the resulting uncompressed string,
e3f26752 58 * if uncompressed string is too long (>= maxlen), it will be truncated,
ad6ccfad
MK
59 * given the offset to where the symbol is in the compressed stream.
60 */
e3f26752
CG
61static unsigned int kallsyms_expand_symbol(unsigned int off,
62 char *result, size_t maxlen)
1da177e4
LT
63{
64 int len, skipped_first = 0;
cde26a6e
MY
65 const char *tptr;
66 const u8 *data;
1da177e4 67
ad6ccfad 68 /* Get the compressed symbol length from the first symbol byte. */
1da177e4
LT
69 data = &kallsyms_names[off];
70 len = *data;
71 data++;
72
ad6ccfad
MK
73 /*
74 * Update the offset to return the offset for the next symbol on
75 * the compressed stream.
76 */
1da177e4
LT
77 off += len + 1;
78
ad6ccfad
MK
79 /*
80 * For every byte on the compressed symbol data, copy the table
81 * entry for that byte.
82 */
83 while (len) {
84 tptr = &kallsyms_token_table[kallsyms_token_index[*data]];
1da177e4
LT
85 data++;
86 len--;
87
88 while (*tptr) {
ad6ccfad 89 if (skipped_first) {
e3f26752
CG
90 if (maxlen <= 1)
91 goto tail;
1da177e4
LT
92 *result = *tptr;
93 result++;
e3f26752 94 maxlen--;
1da177e4
LT
95 } else
96 skipped_first = 1;
97 tptr++;
98 }
99 }
100
e3f26752
CG
101tail:
102 if (maxlen)
103 *result = '\0';
1da177e4 104
ad6ccfad 105 /* Return to offset to the next symbol. */
1da177e4
LT
106 return off;
107}
108
ad6ccfad
MK
109/*
110 * Get symbol type information. This is encoded as a single char at the
111 * beginning of the symbol name.
112 */
1da177e4
LT
113static char kallsyms_get_symbol_type(unsigned int off)
114{
ad6ccfad
MK
115 /*
116 * Get just the first code, look it up in the token table,
117 * and return the first char from this token.
118 */
119 return kallsyms_token_table[kallsyms_token_index[kallsyms_names[off + 1]]];
1da177e4
LT
120}
121
122
ad6ccfad
MK
123/*
124 * Find the offset on the compressed stream given and index in the
125 * kallsyms array.
126 */
1da177e4
LT
127static unsigned int get_symbol_offset(unsigned long pos)
128{
aad09470 129 const u8 *name;
1da177e4
LT
130 int i;
131
ad6ccfad
MK
132 /*
133 * Use the closest marker we have. We have markers every 256 positions,
134 * so that should be close enough.
135 */
136 name = &kallsyms_names[kallsyms_markers[pos >> 8]];
1da177e4 137
ad6ccfad
MK
138 /*
139 * Sequentially scan all the symbols up to the point we're searching
140 * for. Every symbol is stored in a [<len>][<len> bytes of data] format,
141 * so we just need to add the len to the current pointer for every
142 * symbol we wish to skip.
143 */
144 for (i = 0; i < (pos & 0xFF); i++)
1da177e4
LT
145 name = name + (*name) + 1;
146
147 return name - kallsyms_names;
148}
149
2213e9a6
AB
150static unsigned long kallsyms_sym_address(int idx)
151{
152 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
153 return kallsyms_addresses[idx];
154
155 /* values are unsigned offsets if --absolute-percpu is not in effect */
156 if (!IS_ENABLED(CONFIG_KALLSYMS_ABSOLUTE_PERCPU))
157 return kallsyms_relative_base + (u32)kallsyms_offsets[idx];
158
159 /* ...otherwise, positive offsets are absolute values */
160 if (kallsyms_offsets[idx] >= 0)
161 return kallsyms_offsets[idx];
162
163 /* ...and negative offsets are relative to kallsyms_relative_base - 1 */
164 return kallsyms_relative_base - 1 - kallsyms_offsets[idx];
165}
166
6eb4bd92 167static bool cleanup_symbol_name(char *s)
8b8e6b5d
ST
168{
169 char *res;
170
6eb4bd92
ND
171 if (!IS_ENABLED(CONFIG_LTO_CLANG))
172 return false;
173
174 /*
175 * LLVM appends various suffixes for local functions and variables that
176 * must be promoted to global scope as part of LTO. This can break
177 * hooking of static functions with kprobes. '.' is not a valid
178 * character in an identifier in C. Suffixes observed:
179 * - foo.llvm.[0-9a-f]+
180 * - foo.[0-9a-f]+
181 * - foo.[0-9a-f]+.cfi_jt
182 */
183 res = strchr(s, '.');
184 if (res) {
185 *res = '\0';
186 return true;
187 }
188
189 if (!IS_ENABLED(CONFIG_CFI_CLANG) ||
190 !IS_ENABLED(CONFIG_LTO_CLANG_THIN) ||
191 CONFIG_CLANG_VERSION >= 130000)
192 return false;
193
194 /*
195 * Prior to LLVM 13, the following suffixes were observed when thinLTO
196 * and CFI are both enabled:
197 * - foo$[0-9]+
198 */
8b8e6b5d 199 res = strrchr(s, '$');
6eb4bd92 200 if (res) {
8b8e6b5d 201 *res = '\0';
6eb4bd92
ND
202 return true;
203 }
8b8e6b5d 204
6eb4bd92 205 return false;
8b8e6b5d 206}
8b8e6b5d 207
1da177e4
LT
208/* Lookup the address for this symbol. Returns 0 if not found. */
209unsigned long kallsyms_lookup_name(const char *name)
210{
9281acea 211 char namebuf[KSYM_NAME_LEN];
1da177e4
LT
212 unsigned long i;
213 unsigned int off;
214
aecf489f
JO
215 /* Skip the search for empty string. */
216 if (!*name)
217 return 0;
218
1da177e4 219 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
e3f26752 220 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
1da177e4
LT
221
222 if (strcmp(namebuf, name) == 0)
2213e9a6 223 return kallsyms_sym_address(i);
8b8e6b5d
ST
224
225 if (cleanup_symbol_name(namebuf) && strcmp(namebuf, name) == 0)
226 return kallsyms_sym_address(i);
1da177e4
LT
227 }
228 return module_kallsyms_lookup_name(name);
229}
1da177e4 230
3e355205 231#ifdef CONFIG_LIVEPATCH
013c1667
CH
232/*
233 * Iterate over all symbols in vmlinux. For symbols from modules use
234 * module_kallsyms_on_each_symbol instead.
235 */
75a66614
AK
236int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
237 unsigned long),
238 void *data)
239{
240 char namebuf[KSYM_NAME_LEN];
241 unsigned long i;
242 unsigned int off;
243 int ret;
244
245 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
e3f26752 246 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
2213e9a6 247 ret = fn(data, namebuf, NULL, kallsyms_sym_address(i));
75a66614
AK
248 if (ret != 0)
249 return ret;
f5bdb34b 250 cond_resched();
75a66614 251 }
013c1667 252 return 0;
75a66614 253}
3e355205 254#endif /* CONFIG_LIVEPATCH */
75a66614 255
ffc50891
FBH
256static unsigned long get_symbol_pos(unsigned long addr,
257 unsigned long *symbolsize,
258 unsigned long *offset)
259{
260 unsigned long symbol_start = 0, symbol_end = 0;
261 unsigned long i, low, high, mid;
262
2ea03891 263 /* This kernel should never had been booted. */
2213e9a6
AB
264 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
265 BUG_ON(!kallsyms_addresses);
266 else
267 BUG_ON(!kallsyms_offsets);
2ea03891 268
ad6ccfad 269 /* Do a binary search on the sorted kallsyms_addresses array. */
ffc50891
FBH
270 low = 0;
271 high = kallsyms_num_syms;
272
273 while (high - low > 1) {
2fc9c4e1 274 mid = low + (high - low) / 2;
2213e9a6 275 if (kallsyms_sym_address(mid) <= addr)
ffc50891
FBH
276 low = mid;
277 else
278 high = mid;
279 }
280
281 /*
ad6ccfad
MK
282 * Search for the first aliased symbol. Aliased
283 * symbols are symbols with the same address.
ffc50891 284 */
2213e9a6 285 while (low && kallsyms_sym_address(low-1) == kallsyms_sym_address(low))
ffc50891
FBH
286 --low;
287
2213e9a6 288 symbol_start = kallsyms_sym_address(low);
ffc50891 289
ad6ccfad 290 /* Search for next non-aliased symbol. */
ffc50891 291 for (i = low + 1; i < kallsyms_num_syms; i++) {
2213e9a6
AB
292 if (kallsyms_sym_address(i) > symbol_start) {
293 symbol_end = kallsyms_sym_address(i);
ffc50891
FBH
294 break;
295 }
296 }
297
ad6ccfad 298 /* If we found no next symbol, we use the end of the section. */
ffc50891
FBH
299 if (!symbol_end) {
300 if (is_kernel_inittext(addr))
301 symbol_end = (unsigned long)_einittext;
63b23e2c 302 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
ffc50891
FBH
303 symbol_end = (unsigned long)_end;
304 else
305 symbol_end = (unsigned long)_etext;
306 }
307
ffb45122
AD
308 if (symbolsize)
309 *symbolsize = symbol_end - symbol_start;
310 if (offset)
311 *offset = addr - symbol_start;
ffc50891
FBH
312
313 return low;
314}
315
316/*
317 * Lookup an address but don't bother to find any names.
318 */
319int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
320 unsigned long *offset)
321{
6dd06c9f 322 char namebuf[KSYM_NAME_LEN];
74451e66 323
2a1a3fa0
MZ
324 if (is_ksym_addr(addr)) {
325 get_symbol_pos(addr, symbolsize, offset);
326 return 1;
327 }
9294523e 328 return !!module_address_lookup(addr, symbolsize, offset, NULL, NULL, namebuf) ||
74451e66 329 !!__bpf_address_lookup(addr, symbolsize, offset, namebuf);
ffc50891
FBH
330}
331
9294523e
SB
332static const char *kallsyms_lookup_buildid(unsigned long addr,
333 unsigned long *symbolsize,
334 unsigned long *offset, char **modname,
335 const unsigned char **modbuildid, char *namebuf)
1da177e4 336{
74451e66
DB
337 const char *ret;
338
9281acea 339 namebuf[KSYM_NAME_LEN - 1] = 0;
1da177e4
LT
340 namebuf[0] = 0;
341
ffc50891
FBH
342 if (is_ksym_addr(addr)) {
343 unsigned long pos;
1da177e4 344
ffc50891 345 pos = get_symbol_pos(addr, symbolsize, offset);
1da177e4 346 /* Grab name */
e3f26752
CG
347 kallsyms_expand_symbol(get_symbol_offset(pos),
348 namebuf, KSYM_NAME_LEN);
7a74fc49
KM
349 if (modname)
350 *modname = NULL;
9294523e
SB
351 if (modbuildid)
352 *modbuildid = NULL;
8b8e6b5d
ST
353
354 ret = namebuf;
355 goto found;
1da177e4
LT
356 }
357
74451e66
DB
358 /* See if it's in a module or a BPF JITed image. */
359 ret = module_address_lookup(addr, symbolsize, offset,
9294523e 360 modname, modbuildid, namebuf);
74451e66
DB
361 if (!ret)
362 ret = bpf_address_lookup(addr, symbolsize,
363 offset, modname, namebuf);
aba4b5c2
SRV
364
365 if (!ret)
366 ret = ftrace_mod_address_lookup(addr, symbolsize,
367 offset, modname, namebuf);
8b8e6b5d
ST
368
369found:
370 cleanup_symbol_name(namebuf);
74451e66 371 return ret;
1da177e4
LT
372}
373
9294523e
SB
374/*
375 * Lookup an address
376 * - modname is set to NULL if it's in the kernel.
377 * - We guarantee that the returned name is valid until we reschedule even if.
378 * It resides in a module.
379 * - We also guarantee that modname will be valid until rescheduled.
380 */
381const char *kallsyms_lookup(unsigned long addr,
382 unsigned long *symbolsize,
383 unsigned long *offset,
384 char **modname, char *namebuf)
385{
386 return kallsyms_lookup_buildid(addr, symbolsize, offset, modname,
387 NULL, namebuf);
388}
389
9d65cb4a
AD
390int lookup_symbol_name(unsigned long addr, char *symname)
391{
8b8e6b5d
ST
392 int res;
393
9d65cb4a 394 symname[0] = '\0';
9281acea 395 symname[KSYM_NAME_LEN - 1] = '\0';
9d65cb4a
AD
396
397 if (is_ksym_addr(addr)) {
398 unsigned long pos;
399
400 pos = get_symbol_pos(addr, NULL, NULL);
401 /* Grab name */
e3f26752
CG
402 kallsyms_expand_symbol(get_symbol_offset(pos),
403 symname, KSYM_NAME_LEN);
8b8e6b5d 404 goto found;
9d65cb4a 405 }
ad6ccfad 406 /* See if it's in a module. */
8b8e6b5d
ST
407 res = lookup_module_symbol_name(addr, symname);
408 if (res)
409 return res;
410
411found:
412 cleanup_symbol_name(symname);
413 return 0;
9d65cb4a
AD
414}
415
a5c43dae
AD
416int lookup_symbol_attrs(unsigned long addr, unsigned long *size,
417 unsigned long *offset, char *modname, char *name)
418{
8b8e6b5d
ST
419 int res;
420
a5c43dae 421 name[0] = '\0';
9281acea 422 name[KSYM_NAME_LEN - 1] = '\0';
a5c43dae
AD
423
424 if (is_ksym_addr(addr)) {
425 unsigned long pos;
426
427 pos = get_symbol_pos(addr, size, offset);
428 /* Grab name */
e3f26752
CG
429 kallsyms_expand_symbol(get_symbol_offset(pos),
430 name, KSYM_NAME_LEN);
a5c43dae 431 modname[0] = '\0';
8b8e6b5d 432 goto found;
a5c43dae 433 }
ad6ccfad 434 /* See if it's in a module. */
8b8e6b5d
ST
435 res = lookup_module_symbol_attrs(addr, size, offset, modname, name);
436 if (res)
437 return res;
438
439found:
440 cleanup_symbol_name(name);
441 return 0;
a5c43dae
AD
442}
443
42e38083 444/* Look up a kernel symbol and return it in a text buffer. */
0f77a8d3 445static int __sprint_symbol(char *buffer, unsigned long address,
9294523e 446 int symbol_offset, int add_offset, int add_buildid)
1da177e4
LT
447{
448 char *modname;
9294523e 449 const unsigned char *buildid;
1da177e4
LT
450 const char *name;
451 unsigned long offset, size;
966c8c12 452 int len;
1da177e4 453
0f77a8d3 454 address += symbol_offset;
9294523e
SB
455 name = kallsyms_lookup_buildid(address, &size, &offset, &modname, &buildid,
456 buffer);
1da177e4 457 if (!name)
b86280aa 458 return sprintf(buffer, "0x%lx", address - symbol_offset);
19769b76 459
966c8c12
HD
460 if (name != buffer)
461 strcpy(buffer, name);
462 len = strlen(buffer);
0f77a8d3 463 offset -= symbol_offset;
966c8c12 464
4796dd20
SB
465 if (add_offset)
466 len += sprintf(buffer + len, "+%#lx/%#lx", offset, size);
467
9294523e
SB
468 if (modname) {
469 len += sprintf(buffer + len, " [%s", modname);
470#if IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID)
471 if (add_buildid && buildid) {
472 /* build ID should match length of sprintf */
473#if IS_ENABLED(CONFIG_MODULES)
474 static_assert(sizeof(typeof_member(struct module, build_id)) == 20);
475#endif
476 len += sprintf(buffer + len, " %20phN", buildid);
477 }
478#endif
479 len += sprintf(buffer + len, "]");
480 }
966c8c12
HD
481
482 return len;
42e38083 483}
0f77a8d3
NK
484
485/**
486 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
487 * @buffer: buffer to be stored
488 * @address: address to lookup
489 *
490 * This function looks up a kernel symbol with @address and stores its name,
491 * offset, size and module name to @buffer if possible. If no symbol was found,
492 * just saves its @address as is.
493 *
494 * This function returns the number of bytes stored in @buffer.
495 */
496int sprint_symbol(char *buffer, unsigned long address)
497{
9294523e 498 return __sprint_symbol(buffer, address, 0, 1, 0);
0f77a8d3 499}
ad6ccfad 500EXPORT_SYMBOL_GPL(sprint_symbol);
42e38083 501
9294523e
SB
502/**
503 * sprint_symbol_build_id - Look up a kernel symbol and return it in a text buffer
504 * @buffer: buffer to be stored
505 * @address: address to lookup
506 *
507 * This function looks up a kernel symbol with @address and stores its name,
508 * offset, size, module name and module build ID to @buffer if possible. If no
509 * symbol was found, just saves its @address as is.
510 *
511 * This function returns the number of bytes stored in @buffer.
512 */
513int sprint_symbol_build_id(char *buffer, unsigned long address)
514{
515 return __sprint_symbol(buffer, address, 0, 1, 1);
516}
517EXPORT_SYMBOL_GPL(sprint_symbol_build_id);
518
4796dd20
SB
519/**
520 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
521 * @buffer: buffer to be stored
522 * @address: address to lookup
523 *
524 * This function looks up a kernel symbol with @address and stores its name
525 * and module name to @buffer if possible. If no symbol was found, just saves
526 * its @address as is.
527 *
528 * This function returns the number of bytes stored in @buffer.
529 */
530int sprint_symbol_no_offset(char *buffer, unsigned long address)
531{
9294523e 532 return __sprint_symbol(buffer, address, 0, 0, 0);
4796dd20
SB
533}
534EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);
535
0f77a8d3
NK
536/**
537 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
538 * @buffer: buffer to be stored
539 * @address: address to lookup
540 *
541 * This function is for stack backtrace and does the same thing as
542 * sprint_symbol() but with modified/decreased @address. If there is a
543 * tail-call to the function marked "noreturn", gcc optimized out code after
544 * the call so that the stack-saved return address could point outside of the
545 * caller. This function ensures that kallsyms will find the original caller
546 * by decreasing @address.
547 *
548 * This function returns the number of bytes stored in @buffer.
549 */
550int sprint_backtrace(char *buffer, unsigned long address)
551{
9294523e
SB
552 return __sprint_symbol(buffer, address, -1, 1, 0);
553}
554
555/**
556 * sprint_backtrace_build_id - Look up a backtrace symbol and return it in a text buffer
557 * @buffer: buffer to be stored
558 * @address: address to lookup
559 *
560 * This function is for stack backtrace and does the same thing as
561 * sprint_symbol() but with modified/decreased @address. If there is a
562 * tail-call to the function marked "noreturn", gcc optimized out code after
563 * the call so that the stack-saved return address could point outside of the
564 * caller. This function ensures that kallsyms will find the original caller
565 * by decreasing @address. This function also appends the module build ID to
566 * the @buffer if @address is within a kernel module.
567 *
568 * This function returns the number of bytes stored in @buffer.
569 */
570int sprint_backtrace_build_id(char *buffer, unsigned long address)
571{
572 return __sprint_symbol(buffer, address, -1, 1, 1);
0f77a8d3
NK
573}
574
1da177e4 575/* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
ad6ccfad 576struct kallsym_iter {
1da177e4 577 loff_t pos;
d83212d5 578 loff_t pos_arch_end;
74451e66 579 loff_t pos_mod_end;
6171a031 580 loff_t pos_ftrace_mod_end;
d002b8bc 581 loff_t pos_bpf_end;
1da177e4 582 unsigned long value;
ad6ccfad 583 unsigned int nameoff; /* If iterating in core kernel symbols. */
1da177e4 584 char type;
9281acea
TH
585 char name[KSYM_NAME_LEN];
586 char module_name[MODULE_NAME_LEN];
ea07890a 587 int exported;
c0f3ea15 588 int show_value;
1da177e4
LT
589};
590
d83212d5
AS
591int __weak arch_get_kallsym(unsigned int symnum, unsigned long *value,
592 char *type, char *name)
593{
594 return -EINVAL;
595}
596
597static int get_ksymbol_arch(struct kallsym_iter *iter)
598{
599 int ret = arch_get_kallsym(iter->pos - kallsyms_num_syms,
600 &iter->value, &iter->type,
601 iter->name);
602
603 if (ret < 0) {
604 iter->pos_arch_end = iter->pos;
605 return 0;
606 }
607
608 return 1;
609}
610
1da177e4
LT
611static int get_ksymbol_mod(struct kallsym_iter *iter)
612{
d83212d5 613 int ret = module_get_kallsym(iter->pos - iter->pos_arch_end,
74451e66
DB
614 &iter->value, &iter->type,
615 iter->name, iter->module_name,
616 &iter->exported);
617 if (ret < 0) {
618 iter->pos_mod_end = iter->pos;
1da177e4 619 return 0;
74451e66
DB
620 }
621
1da177e4
LT
622 return 1;
623}
624
fc0ea795
AH
625/*
626 * ftrace_mod_get_kallsym() may also get symbols for pages allocated for ftrace
627 * purposes. In that case "__builtin__ftrace" is used as a module name, even
628 * though "__builtin__ftrace" is not a module.
629 */
6171a031
SRV
630static int get_ksymbol_ftrace_mod(struct kallsym_iter *iter)
631{
632 int ret = ftrace_mod_get_kallsym(iter->pos - iter->pos_mod_end,
633 &iter->value, &iter->type,
634 iter->name, iter->module_name,
635 &iter->exported);
636 if (ret < 0) {
637 iter->pos_ftrace_mod_end = iter->pos;
638 return 0;
639 }
640
641 return 1;
642}
643
74451e66
DB
644static int get_ksymbol_bpf(struct kallsym_iter *iter)
645{
d002b8bc
AH
646 int ret;
647
6934058d 648 strlcpy(iter->module_name, "bpf", MODULE_NAME_LEN);
74451e66 649 iter->exported = 0;
d002b8bc
AH
650 ret = bpf_get_kallsym(iter->pos - iter->pos_ftrace_mod_end,
651 &iter->value, &iter->type,
652 iter->name);
653 if (ret < 0) {
654 iter->pos_bpf_end = iter->pos;
655 return 0;
656 }
657
658 return 1;
659}
660
661/*
662 * This uses "__builtin__kprobes" as a module name for symbols for pages
663 * allocated for kprobes' purposes, even though "__builtin__kprobes" is not a
664 * module.
665 */
666static int get_ksymbol_kprobe(struct kallsym_iter *iter)
667{
668 strlcpy(iter->module_name, "__builtin__kprobes", MODULE_NAME_LEN);
669 iter->exported = 0;
670 return kprobe_get_kallsym(iter->pos - iter->pos_bpf_end,
671 &iter->value, &iter->type,
672 iter->name) < 0 ? 0 : 1;
74451e66
DB
673}
674
1da177e4
LT
675/* Returns space to next name. */
676static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
677{
678 unsigned off = iter->nameoff;
679
ea07890a 680 iter->module_name[0] = '\0';
2213e9a6 681 iter->value = kallsyms_sym_address(iter->pos);
1da177e4
LT
682
683 iter->type = kallsyms_get_symbol_type(off);
684
e3f26752 685 off = kallsyms_expand_symbol(off, iter->name, ARRAY_SIZE(iter->name));
1da177e4
LT
686
687 return off - iter->nameoff;
688}
689
690static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
691{
692 iter->name[0] = '\0';
693 iter->nameoff = get_symbol_offset(new_pos);
694 iter->pos = new_pos;
6171a031 695 if (new_pos == 0) {
d83212d5 696 iter->pos_arch_end = 0;
74451e66 697 iter->pos_mod_end = 0;
6171a031 698 iter->pos_ftrace_mod_end = 0;
d002b8bc 699 iter->pos_bpf_end = 0;
6171a031 700 }
74451e66
DB
701}
702
b9667942
AH
703/*
704 * The end position (last + 1) of each additional kallsyms section is recorded
705 * in iter->pos_..._end as each section is added, and so can be used to
706 * determine which get_ksymbol_...() function to call next.
707 */
74451e66
DB
708static int update_iter_mod(struct kallsym_iter *iter, loff_t pos)
709{
710 iter->pos = pos;
711
d83212d5
AS
712 if ((!iter->pos_arch_end || iter->pos_arch_end > pos) &&
713 get_ksymbol_arch(iter))
714 return 1;
715
b9667942
AH
716 if ((!iter->pos_mod_end || iter->pos_mod_end > pos) &&
717 get_ksymbol_mod(iter))
6171a031 718 return 1;
6171a031 719
b9667942
AH
720 if ((!iter->pos_ftrace_mod_end || iter->pos_ftrace_mod_end > pos) &&
721 get_ksymbol_ftrace_mod(iter))
722 return 1;
74451e66 723
d002b8bc
AH
724 if ((!iter->pos_bpf_end || iter->pos_bpf_end > pos) &&
725 get_ksymbol_bpf(iter))
726 return 1;
727
728 return get_ksymbol_kprobe(iter);
1da177e4
LT
729}
730
731/* Returns false if pos at or past end of file. */
732static int update_iter(struct kallsym_iter *iter, loff_t pos)
733{
734 /* Module symbols can be accessed randomly. */
74451e66
DB
735 if (pos >= kallsyms_num_syms)
736 return update_iter_mod(iter, pos);
ad6ccfad 737
1da177e4
LT
738 /* If we're not on the desired position, reset to new position. */
739 if (pos != iter->pos)
740 reset_iter(iter, pos);
741
742 iter->nameoff += get_ksymbol_core(iter);
743 iter->pos++;
744
745 return 1;
746}
747
748static void *s_next(struct seq_file *m, void *p, loff_t *pos)
749{
750 (*pos)++;
751
752 if (!update_iter(m->private, *pos))
753 return NULL;
754 return p;
755}
756
757static void *s_start(struct seq_file *m, loff_t *pos)
758{
759 if (!update_iter(m->private, *pos))
760 return NULL;
761 return m->private;
762}
763
764static void s_stop(struct seq_file *m, void *p)
765{
766}
767
768static int s_show(struct seq_file *m, void *p)
769{
668533dc 770 void *value;
1da177e4
LT
771 struct kallsym_iter *iter = m->private;
772
ad6ccfad 773 /* Some debugging symbols have no name. Ignore them. */
1da177e4
LT
774 if (!iter->name[0])
775 return 0;
776
668533dc 777 value = iter->show_value ? (void *)iter->value : NULL;
c0f3ea15 778
ea07890a
AD
779 if (iter->module_name[0]) {
780 char type;
781
ad6ccfad
MK
782 /*
783 * Label it "global" if it is exported,
784 * "local" if not exported.
785 */
ea07890a
AD
786 type = iter->exported ? toupper(iter->type) :
787 tolower(iter->type);
668533dc 788 seq_printf(m, "%px %c %s\t[%s]\n", value,
9f36e2c4 789 type, iter->name, iter->module_name);
ea07890a 790 } else
668533dc 791 seq_printf(m, "%px %c %s\n", value,
9f36e2c4 792 iter->type, iter->name);
1da177e4
LT
793 return 0;
794}
795
15ad7cdc 796static const struct seq_operations kallsyms_op = {
1da177e4
LT
797 .start = s_start,
798 .next = s_next,
799 .stop = s_stop,
800 .show = s_show
801};
802
c0f3ea15
LT
803static inline int kallsyms_for_perf(void)
804{
805#ifdef CONFIG_PERF_EVENTS
806 extern int sysctl_perf_event_paranoid;
807 if (sysctl_perf_event_paranoid <= 1)
808 return 1;
809#endif
810 return 0;
811}
812
813/*
814 * We show kallsyms information even to normal users if we've enabled
815 * kernel profiling and are explicitly not paranoid (so kptr_restrict
816 * is clear, and sysctl_perf_event_paranoid isn't set).
817 *
818 * Otherwise, require CAP_SYSLOG (assuming kptr_restrict isn't set to
819 * block even that).
820 */
16025184 821bool kallsyms_show_value(const struct cred *cred)
c0f3ea15
LT
822{
823 switch (kptr_restrict) {
824 case 0:
825 if (kallsyms_for_perf())
16025184 826 return true;
df561f66 827 fallthrough;
c0f3ea15 828 case 1:
16025184
KC
829 if (security_capable(cred, &init_user_ns, CAP_SYSLOG,
830 CAP_OPT_NOAUDIT) == 0)
831 return true;
df561f66 832 fallthrough;
c0f3ea15 833 default:
16025184 834 return false;
c0f3ea15
LT
835 }
836}
837
1da177e4
LT
838static int kallsyms_open(struct inode *inode, struct file *file)
839{
ad6ccfad
MK
840 /*
841 * We keep iterator in m->private, since normal case is to
1da177e4 842 * s_start from where we left off, so we avoid doing
ad6ccfad
MK
843 * using get_symbol_offset for every symbol.
844 */
1da177e4 845 struct kallsym_iter *iter;
0049f26a 846 iter = __seq_open_private(file, &kallsyms_op, sizeof(*iter));
1da177e4
LT
847 if (!iter)
848 return -ENOMEM;
849 reset_iter(iter, 0);
850
16025184
KC
851 /*
852 * Instead of checking this on every s_show() call, cache
853 * the result here at open time.
854 */
855 iter->show_value = kallsyms_show_value(file->f_cred);
0049f26a 856 return 0;
1da177e4
LT
857}
858
67fc4e0c
JW
859#ifdef CONFIG_KGDB_KDB
860const char *kdb_walk_kallsyms(loff_t *pos)
861{
862 static struct kallsym_iter kdb_walk_kallsyms_iter;
863 if (*pos == 0) {
864 memset(&kdb_walk_kallsyms_iter, 0,
865 sizeof(kdb_walk_kallsyms_iter));
866 reset_iter(&kdb_walk_kallsyms_iter, 0);
867 }
868 while (1) {
869 if (!update_iter(&kdb_walk_kallsyms_iter, *pos))
870 return NULL;
871 ++*pos;
872 /* Some debugging symbols have no name. Ignore them. */
873 if (kdb_walk_kallsyms_iter.name[0])
874 return kdb_walk_kallsyms_iter.name;
875 }
876}
877#endif /* CONFIG_KGDB_KDB */
878
97a32539
AD
879static const struct proc_ops kallsyms_proc_ops = {
880 .proc_open = kallsyms_open,
881 .proc_read = seq_read,
882 .proc_lseek = seq_lseek,
883 .proc_release = seq_release_private,
1da177e4
LT
884};
885
886static int __init kallsyms_init(void)
887{
97a32539 888 proc_create("kallsyms", 0444, NULL, &kallsyms_proc_ops);
1da177e4
LT
889 return 0;
890}
ad6ccfad 891device_initcall(kallsyms_init);