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