]> git.proxmox.com Git - mirror_ubuntu-kernels.git/blame - kernel/kallsyms.c
kallsyms: strip LTO-only suffixes from promoted global functions
[mirror_ubuntu-kernels.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
8cc32a9b 177 * character in an identifier in C. Suffixes only in LLVM LTO observed:
6eb4bd92 178 * - foo.llvm.[0-9a-f]+
6eb4bd92 179 */
8cc32a9b 180 res = strstr(s, ".llvm.");
6eb4bd92
ND
181 if (res) {
182 *res = '\0';
183 return true;
184 }
185
6eb4bd92 186 return false;
8b8e6b5d 187}
8b8e6b5d 188
60443c88
ZL
189static int compare_symbol_name(const char *name, char *namebuf)
190{
191 int ret;
192
193 ret = strcmp(name, namebuf);
194 if (!ret)
195 return ret;
196
197 if (cleanup_symbol_name(namebuf) && !strcmp(name, namebuf))
198 return 0;
199
200 return ret;
201}
202
19bd8981
ZL
203static unsigned int get_symbol_seq(int index)
204{
205 unsigned int i, seq = 0;
206
207 for (i = 0; i < 3; i++)
208 seq = (seq << 8) | kallsyms_seqs_of_names[3 * index + i];
209
210 return seq;
211}
212
60443c88
ZL
213static int kallsyms_lookup_names(const char *name,
214 unsigned int *start,
215 unsigned int *end)
216{
217 int ret;
218 int low, mid, high;
219 unsigned int seq, off;
220 char namebuf[KSYM_NAME_LEN];
221
222 low = 0;
223 high = kallsyms_num_syms - 1;
224
225 while (low <= high) {
226 mid = low + (high - low) / 2;
19bd8981 227 seq = get_symbol_seq(mid);
60443c88
ZL
228 off = get_symbol_offset(seq);
229 kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
230 ret = compare_symbol_name(name, namebuf);
231 if (ret > 0)
232 low = mid + 1;
233 else if (ret < 0)
234 high = mid - 1;
235 else
236 break;
237 }
238
239 if (low > high)
240 return -ESRCH;
241
242 low = mid;
243 while (low) {
19bd8981 244 seq = get_symbol_seq(low - 1);
60443c88
ZL
245 off = get_symbol_offset(seq);
246 kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
247 if (compare_symbol_name(name, namebuf))
248 break;
249 low--;
250 }
251 *start = low;
252
253 if (end) {
254 high = mid;
255 while (high < kallsyms_num_syms - 1) {
19bd8981 256 seq = get_symbol_seq(high + 1);
60443c88
ZL
257 off = get_symbol_offset(seq);
258 kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
259 if (compare_symbol_name(name, namebuf))
260 break;
261 high++;
262 }
263 *end = high;
264 }
265
266 return 0;
267}
268
1da177e4
LT
269/* Lookup the address for this symbol. Returns 0 if not found. */
270unsigned long kallsyms_lookup_name(const char *name)
271{
60443c88
ZL
272 int ret;
273 unsigned int i;
1da177e4 274
aecf489f
JO
275 /* Skip the search for empty string. */
276 if (!*name)
277 return 0;
278
60443c88
ZL
279 ret = kallsyms_lookup_names(name, &i, NULL);
280 if (!ret)
19bd8981 281 return kallsyms_sym_address(get_symbol_seq(i));
8b8e6b5d 282
1da177e4
LT
283 return module_kallsyms_lookup_name(name);
284}
1da177e4 285
013c1667
CH
286/*
287 * Iterate over all symbols in vmlinux. For symbols from modules use
288 * module_kallsyms_on_each_symbol instead.
289 */
3703bd54 290int kallsyms_on_each_symbol(int (*fn)(void *, const char *, unsigned long),
75a66614
AK
291 void *data)
292{
293 char namebuf[KSYM_NAME_LEN];
294 unsigned long i;
295 unsigned int off;
296 int ret;
297
298 for (i = 0, off = 0; i < kallsyms_num_syms; i++) {
e3f26752 299 off = kallsyms_expand_symbol(off, namebuf, ARRAY_SIZE(namebuf));
3703bd54 300 ret = fn(data, namebuf, kallsyms_sym_address(i));
75a66614
AK
301 if (ret != 0)
302 return ret;
f5bdb34b 303 cond_resched();
75a66614 304 }
013c1667 305 return 0;
75a66614 306}
75a66614 307
4dc533e0
ZL
308int kallsyms_on_each_match_symbol(int (*fn)(void *, unsigned long),
309 const char *name, void *data)
310{
311 int ret;
312 unsigned int i, start, end;
313
314 ret = kallsyms_lookup_names(name, &start, &end);
315 if (ret)
316 return 0;
317
318 for (i = start; !ret && i <= end; i++) {
319 ret = fn(data, kallsyms_sym_address(get_symbol_seq(i)));
320 cond_resched();
321 }
322
323 return ret;
324}
325
ffc50891
FBH
326static unsigned long get_symbol_pos(unsigned long addr,
327 unsigned long *symbolsize,
328 unsigned long *offset)
329{
330 unsigned long symbol_start = 0, symbol_end = 0;
331 unsigned long i, low, high, mid;
332
2ea03891 333 /* This kernel should never had been booted. */
2213e9a6
AB
334 if (!IS_ENABLED(CONFIG_KALLSYMS_BASE_RELATIVE))
335 BUG_ON(!kallsyms_addresses);
336 else
337 BUG_ON(!kallsyms_offsets);
2ea03891 338
ad6ccfad 339 /* Do a binary search on the sorted kallsyms_addresses array. */
ffc50891
FBH
340 low = 0;
341 high = kallsyms_num_syms;
342
343 while (high - low > 1) {
2fc9c4e1 344 mid = low + (high - low) / 2;
2213e9a6 345 if (kallsyms_sym_address(mid) <= addr)
ffc50891
FBH
346 low = mid;
347 else
348 high = mid;
349 }
350
351 /*
ad6ccfad
MK
352 * Search for the first aliased symbol. Aliased
353 * symbols are symbols with the same address.
ffc50891 354 */
2213e9a6 355 while (low && kallsyms_sym_address(low-1) == kallsyms_sym_address(low))
ffc50891
FBH
356 --low;
357
2213e9a6 358 symbol_start = kallsyms_sym_address(low);
ffc50891 359
ad6ccfad 360 /* Search for next non-aliased symbol. */
ffc50891 361 for (i = low + 1; i < kallsyms_num_syms; i++) {
2213e9a6
AB
362 if (kallsyms_sym_address(i) > symbol_start) {
363 symbol_end = kallsyms_sym_address(i);
ffc50891
FBH
364 break;
365 }
366 }
367
ad6ccfad 368 /* If we found no next symbol, we use the end of the section. */
ffc50891
FBH
369 if (!symbol_end) {
370 if (is_kernel_inittext(addr))
371 symbol_end = (unsigned long)_einittext;
63b23e2c 372 else if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
ffc50891
FBH
373 symbol_end = (unsigned long)_end;
374 else
375 symbol_end = (unsigned long)_etext;
376 }
377
ffb45122
AD
378 if (symbolsize)
379 *symbolsize = symbol_end - symbol_start;
380 if (offset)
381 *offset = addr - symbol_start;
ffc50891
FBH
382
383 return low;
384}
385
386/*
387 * Lookup an address but don't bother to find any names.
388 */
389int kallsyms_lookup_size_offset(unsigned long addr, unsigned long *symbolsize,
390 unsigned long *offset)
391{
6dd06c9f 392 char namebuf[KSYM_NAME_LEN];
74451e66 393
2a1a3fa0
MZ
394 if (is_ksym_addr(addr)) {
395 get_symbol_pos(addr, symbolsize, offset);
396 return 1;
397 }
9294523e 398 return !!module_address_lookup(addr, symbolsize, offset, NULL, NULL, namebuf) ||
74451e66 399 !!__bpf_address_lookup(addr, symbolsize, offset, namebuf);
ffc50891
FBH
400}
401
9294523e
SB
402static const char *kallsyms_lookup_buildid(unsigned long addr,
403 unsigned long *symbolsize,
404 unsigned long *offset, char **modname,
405 const unsigned char **modbuildid, char *namebuf)
1da177e4 406{
74451e66
DB
407 const char *ret;
408
9281acea 409 namebuf[KSYM_NAME_LEN - 1] = 0;
1da177e4
LT
410 namebuf[0] = 0;
411
ffc50891
FBH
412 if (is_ksym_addr(addr)) {
413 unsigned long pos;
1da177e4 414
ffc50891 415 pos = get_symbol_pos(addr, symbolsize, offset);
1da177e4 416 /* Grab name */
e3f26752
CG
417 kallsyms_expand_symbol(get_symbol_offset(pos),
418 namebuf, KSYM_NAME_LEN);
7a74fc49
KM
419 if (modname)
420 *modname = NULL;
9294523e
SB
421 if (modbuildid)
422 *modbuildid = NULL;
8b8e6b5d
ST
423
424 ret = namebuf;
425 goto found;
1da177e4
LT
426 }
427
74451e66
DB
428 /* See if it's in a module or a BPF JITed image. */
429 ret = module_address_lookup(addr, symbolsize, offset,
9294523e 430 modname, modbuildid, namebuf);
74451e66
DB
431 if (!ret)
432 ret = bpf_address_lookup(addr, symbolsize,
433 offset, modname, namebuf);
aba4b5c2
SRV
434
435 if (!ret)
436 ret = ftrace_mod_address_lookup(addr, symbolsize,
437 offset, modname, namebuf);
8b8e6b5d
ST
438
439found:
440 cleanup_symbol_name(namebuf);
74451e66 441 return ret;
1da177e4
LT
442}
443
9294523e
SB
444/*
445 * Lookup an address
446 * - modname is set to NULL if it's in the kernel.
447 * - We guarantee that the returned name is valid until we reschedule even if.
448 * It resides in a module.
449 * - We also guarantee that modname will be valid until rescheduled.
450 */
451const char *kallsyms_lookup(unsigned long addr,
452 unsigned long *symbolsize,
453 unsigned long *offset,
454 char **modname, char *namebuf)
455{
456 return kallsyms_lookup_buildid(addr, symbolsize, offset, modname,
457 NULL, namebuf);
458}
459
9d65cb4a
AD
460int lookup_symbol_name(unsigned long addr, char *symname)
461{
8b8e6b5d
ST
462 int res;
463
9d65cb4a 464 symname[0] = '\0';
9281acea 465 symname[KSYM_NAME_LEN - 1] = '\0';
9d65cb4a
AD
466
467 if (is_ksym_addr(addr)) {
468 unsigned long pos;
469
470 pos = get_symbol_pos(addr, NULL, NULL);
471 /* Grab name */
e3f26752
CG
472 kallsyms_expand_symbol(get_symbol_offset(pos),
473 symname, KSYM_NAME_LEN);
8b8e6b5d 474 goto found;
9d65cb4a 475 }
ad6ccfad 476 /* See if it's in a module. */
8b8e6b5d
ST
477 res = lookup_module_symbol_name(addr, symname);
478 if (res)
479 return res;
480
481found:
482 cleanup_symbol_name(symname);
483 return 0;
9d65cb4a
AD
484}
485
42e38083 486/* Look up a kernel symbol and return it in a text buffer. */
0f77a8d3 487static int __sprint_symbol(char *buffer, unsigned long address,
9294523e 488 int symbol_offset, int add_offset, int add_buildid)
1da177e4
LT
489{
490 char *modname;
9294523e 491 const unsigned char *buildid;
1da177e4
LT
492 const char *name;
493 unsigned long offset, size;
966c8c12 494 int len;
1da177e4 495
0f77a8d3 496 address += symbol_offset;
9294523e
SB
497 name = kallsyms_lookup_buildid(address, &size, &offset, &modname, &buildid,
498 buffer);
1da177e4 499 if (!name)
b86280aa 500 return sprintf(buffer, "0x%lx", address - symbol_offset);
19769b76 501
966c8c12
HD
502 if (name != buffer)
503 strcpy(buffer, name);
504 len = strlen(buffer);
0f77a8d3 505 offset -= symbol_offset;
966c8c12 506
4796dd20
SB
507 if (add_offset)
508 len += sprintf(buffer + len, "+%#lx/%#lx", offset, size);
509
9294523e
SB
510 if (modname) {
511 len += sprintf(buffer + len, " [%s", modname);
512#if IS_ENABLED(CONFIG_STACKTRACE_BUILD_ID)
513 if (add_buildid && buildid) {
514 /* build ID should match length of sprintf */
515#if IS_ENABLED(CONFIG_MODULES)
516 static_assert(sizeof(typeof_member(struct module, build_id)) == 20);
517#endif
518 len += sprintf(buffer + len, " %20phN", buildid);
519 }
520#endif
521 len += sprintf(buffer + len, "]");
522 }
966c8c12
HD
523
524 return len;
42e38083 525}
0f77a8d3
NK
526
527/**
528 * sprint_symbol - Look up a kernel symbol and return it in a text buffer
529 * @buffer: buffer to be stored
530 * @address: address to lookup
531 *
532 * This function looks up a kernel symbol with @address and stores its name,
533 * offset, size and module name to @buffer if possible. If no symbol was found,
534 * just saves its @address as is.
535 *
536 * This function returns the number of bytes stored in @buffer.
537 */
538int sprint_symbol(char *buffer, unsigned long address)
539{
9294523e 540 return __sprint_symbol(buffer, address, 0, 1, 0);
0f77a8d3 541}
ad6ccfad 542EXPORT_SYMBOL_GPL(sprint_symbol);
42e38083 543
9294523e
SB
544/**
545 * sprint_symbol_build_id - Look up a kernel symbol and return it in a text buffer
546 * @buffer: buffer to be stored
547 * @address: address to lookup
548 *
549 * This function looks up a kernel symbol with @address and stores its name,
550 * offset, size, module name and module build ID to @buffer if possible. If no
551 * symbol was found, just saves its @address as is.
552 *
553 * This function returns the number of bytes stored in @buffer.
554 */
555int sprint_symbol_build_id(char *buffer, unsigned long address)
556{
557 return __sprint_symbol(buffer, address, 0, 1, 1);
558}
559EXPORT_SYMBOL_GPL(sprint_symbol_build_id);
560
4796dd20
SB
561/**
562 * sprint_symbol_no_offset - Look up a kernel symbol and return it in a text buffer
563 * @buffer: buffer to be stored
564 * @address: address to lookup
565 *
566 * This function looks up a kernel symbol with @address and stores its name
567 * and module name to @buffer if possible. If no symbol was found, just saves
568 * its @address as is.
569 *
570 * This function returns the number of bytes stored in @buffer.
571 */
572int sprint_symbol_no_offset(char *buffer, unsigned long address)
573{
9294523e 574 return __sprint_symbol(buffer, address, 0, 0, 0);
4796dd20
SB
575}
576EXPORT_SYMBOL_GPL(sprint_symbol_no_offset);
577
0f77a8d3
NK
578/**
579 * sprint_backtrace - Look up a backtrace symbol and return it in a text buffer
580 * @buffer: buffer to be stored
581 * @address: address to lookup
582 *
583 * This function is for stack backtrace and does the same thing as
584 * sprint_symbol() but with modified/decreased @address. If there is a
585 * tail-call to the function marked "noreturn", gcc optimized out code after
586 * the call so that the stack-saved return address could point outside of the
587 * caller. This function ensures that kallsyms will find the original caller
588 * by decreasing @address.
589 *
590 * This function returns the number of bytes stored in @buffer.
591 */
592int sprint_backtrace(char *buffer, unsigned long address)
593{
9294523e
SB
594 return __sprint_symbol(buffer, address, -1, 1, 0);
595}
596
597/**
598 * sprint_backtrace_build_id - Look up a backtrace symbol and return it in a text buffer
599 * @buffer: buffer to be stored
600 * @address: address to lookup
601 *
602 * This function is for stack backtrace and does the same thing as
603 * sprint_symbol() but with modified/decreased @address. If there is a
604 * tail-call to the function marked "noreturn", gcc optimized out code after
605 * the call so that the stack-saved return address could point outside of the
606 * caller. This function ensures that kallsyms will find the original caller
607 * by decreasing @address. This function also appends the module build ID to
608 * the @buffer if @address is within a kernel module.
609 *
610 * This function returns the number of bytes stored in @buffer.
611 */
612int sprint_backtrace_build_id(char *buffer, unsigned long address)
613{
614 return __sprint_symbol(buffer, address, -1, 1, 1);
0f77a8d3
NK
615}
616
1da177e4 617/* To avoid using get_symbol_offset for every symbol, we carry prefix along. */
ad6ccfad 618struct kallsym_iter {
1da177e4 619 loff_t pos;
74451e66 620 loff_t pos_mod_end;
6171a031 621 loff_t pos_ftrace_mod_end;
d002b8bc 622 loff_t pos_bpf_end;
1da177e4 623 unsigned long value;
ad6ccfad 624 unsigned int nameoff; /* If iterating in core kernel symbols. */
1da177e4 625 char type;
9281acea
TH
626 char name[KSYM_NAME_LEN];
627 char module_name[MODULE_NAME_LEN];
ea07890a 628 int exported;
c0f3ea15 629 int show_value;
1da177e4
LT
630};
631
1da177e4
LT
632static int get_ksymbol_mod(struct kallsym_iter *iter)
633{
15d5daa0 634 int ret = module_get_kallsym(iter->pos - kallsyms_num_syms,
74451e66
DB
635 &iter->value, &iter->type,
636 iter->name, iter->module_name,
637 &iter->exported);
638 if (ret < 0) {
639 iter->pos_mod_end = iter->pos;
1da177e4 640 return 0;
74451e66
DB
641 }
642
1da177e4
LT
643 return 1;
644}
645
fc0ea795
AH
646/*
647 * ftrace_mod_get_kallsym() may also get symbols for pages allocated for ftrace
648 * purposes. In that case "__builtin__ftrace" is used as a module name, even
649 * though "__builtin__ftrace" is not a module.
650 */
6171a031
SRV
651static int get_ksymbol_ftrace_mod(struct kallsym_iter *iter)
652{
653 int ret = ftrace_mod_get_kallsym(iter->pos - iter->pos_mod_end,
654 &iter->value, &iter->type,
655 iter->name, iter->module_name,
656 &iter->exported);
657 if (ret < 0) {
658 iter->pos_ftrace_mod_end = iter->pos;
659 return 0;
660 }
661
662 return 1;
663}
664
74451e66
DB
665static int get_ksymbol_bpf(struct kallsym_iter *iter)
666{
d002b8bc
AH
667 int ret;
668
33457938 669 strscpy(iter->module_name, "bpf", MODULE_NAME_LEN);
74451e66 670 iter->exported = 0;
d002b8bc
AH
671 ret = bpf_get_kallsym(iter->pos - iter->pos_ftrace_mod_end,
672 &iter->value, &iter->type,
673 iter->name);
674 if (ret < 0) {
675 iter->pos_bpf_end = iter->pos;
676 return 0;
677 }
678
679 return 1;
680}
681
682/*
683 * This uses "__builtin__kprobes" as a module name for symbols for pages
684 * allocated for kprobes' purposes, even though "__builtin__kprobes" is not a
685 * module.
686 */
687static int get_ksymbol_kprobe(struct kallsym_iter *iter)
688{
33457938 689 strscpy(iter->module_name, "__builtin__kprobes", MODULE_NAME_LEN);
d002b8bc
AH
690 iter->exported = 0;
691 return kprobe_get_kallsym(iter->pos - iter->pos_bpf_end,
692 &iter->value, &iter->type,
693 iter->name) < 0 ? 0 : 1;
74451e66
DB
694}
695
1da177e4
LT
696/* Returns space to next name. */
697static unsigned long get_ksymbol_core(struct kallsym_iter *iter)
698{
699 unsigned off = iter->nameoff;
700
ea07890a 701 iter->module_name[0] = '\0';
2213e9a6 702 iter->value = kallsyms_sym_address(iter->pos);
1da177e4
LT
703
704 iter->type = kallsyms_get_symbol_type(off);
705
e3f26752 706 off = kallsyms_expand_symbol(off, iter->name, ARRAY_SIZE(iter->name));
1da177e4
LT
707
708 return off - iter->nameoff;
709}
710
711static void reset_iter(struct kallsym_iter *iter, loff_t new_pos)
712{
713 iter->name[0] = '\0';
714 iter->nameoff = get_symbol_offset(new_pos);
715 iter->pos = new_pos;
6171a031 716 if (new_pos == 0) {
74451e66 717 iter->pos_mod_end = 0;
6171a031 718 iter->pos_ftrace_mod_end = 0;
d002b8bc 719 iter->pos_bpf_end = 0;
6171a031 720 }
74451e66
DB
721}
722
b9667942
AH
723/*
724 * The end position (last + 1) of each additional kallsyms section is recorded
725 * in iter->pos_..._end as each section is added, and so can be used to
726 * determine which get_ksymbol_...() function to call next.
727 */
74451e66
DB
728static int update_iter_mod(struct kallsym_iter *iter, loff_t pos)
729{
730 iter->pos = pos;
731
b9667942
AH
732 if ((!iter->pos_mod_end || iter->pos_mod_end > pos) &&
733 get_ksymbol_mod(iter))
6171a031 734 return 1;
6171a031 735
b9667942
AH
736 if ((!iter->pos_ftrace_mod_end || iter->pos_ftrace_mod_end > pos) &&
737 get_ksymbol_ftrace_mod(iter))
738 return 1;
74451e66 739
d002b8bc
AH
740 if ((!iter->pos_bpf_end || iter->pos_bpf_end > pos) &&
741 get_ksymbol_bpf(iter))
742 return 1;
743
744 return get_ksymbol_kprobe(iter);
1da177e4
LT
745}
746
747/* Returns false if pos at or past end of file. */
748static int update_iter(struct kallsym_iter *iter, loff_t pos)
749{
750 /* Module symbols can be accessed randomly. */
74451e66
DB
751 if (pos >= kallsyms_num_syms)
752 return update_iter_mod(iter, pos);
ad6ccfad 753
1da177e4
LT
754 /* If we're not on the desired position, reset to new position. */
755 if (pos != iter->pos)
756 reset_iter(iter, pos);
757
758 iter->nameoff += get_ksymbol_core(iter);
759 iter->pos++;
760
761 return 1;
762}
763
764static void *s_next(struct seq_file *m, void *p, loff_t *pos)
765{
766 (*pos)++;
767
768 if (!update_iter(m->private, *pos))
769 return NULL;
770 return p;
771}
772
773static void *s_start(struct seq_file *m, loff_t *pos)
774{
775 if (!update_iter(m->private, *pos))
776 return NULL;
777 return m->private;
778}
779
780static void s_stop(struct seq_file *m, void *p)
781{
782}
783
784static int s_show(struct seq_file *m, void *p)
785{
668533dc 786 void *value;
1da177e4
LT
787 struct kallsym_iter *iter = m->private;
788
ad6ccfad 789 /* Some debugging symbols have no name. Ignore them. */
1da177e4
LT
790 if (!iter->name[0])
791 return 0;
792
668533dc 793 value = iter->show_value ? (void *)iter->value : NULL;
c0f3ea15 794
ea07890a
AD
795 if (iter->module_name[0]) {
796 char type;
797
ad6ccfad
MK
798 /*
799 * Label it "global" if it is exported,
800 * "local" if not exported.
801 */
ea07890a
AD
802 type = iter->exported ? toupper(iter->type) :
803 tolower(iter->type);
668533dc 804 seq_printf(m, "%px %c %s\t[%s]\n", value,
9f36e2c4 805 type, iter->name, iter->module_name);
ea07890a 806 } else
668533dc 807 seq_printf(m, "%px %c %s\n", value,
9f36e2c4 808 iter->type, iter->name);
1da177e4
LT
809 return 0;
810}
811
15ad7cdc 812static const struct seq_operations kallsyms_op = {
1da177e4
LT
813 .start = s_start,
814 .next = s_next,
815 .stop = s_stop,
816 .show = s_show
817};
818
647cafa2
AM
819#ifdef CONFIG_BPF_SYSCALL
820
821struct bpf_iter__ksym {
822 __bpf_md_ptr(struct bpf_iter_meta *, meta);
823 __bpf_md_ptr(struct kallsym_iter *, ksym);
824};
825
826static int ksym_prog_seq_show(struct seq_file *m, bool in_stop)
827{
828 struct bpf_iter__ksym ctx;
829 struct bpf_iter_meta meta;
830 struct bpf_prog *prog;
831
832 meta.seq = m;
833 prog = bpf_iter_get_info(&meta, in_stop);
834 if (!prog)
835 return 0;
836
837 ctx.meta = &meta;
838 ctx.ksym = m ? m->private : NULL;
839 return bpf_iter_run_prog(prog, &ctx);
840}
841
842static int bpf_iter_ksym_seq_show(struct seq_file *m, void *p)
843{
844 return ksym_prog_seq_show(m, false);
845}
846
847static void bpf_iter_ksym_seq_stop(struct seq_file *m, void *p)
848{
849 if (!p)
850 (void) ksym_prog_seq_show(m, true);
851 else
852 s_stop(m, p);
853}
854
855static const struct seq_operations bpf_iter_ksym_ops = {
856 .start = s_start,
857 .next = s_next,
858 .stop = bpf_iter_ksym_seq_stop,
859 .show = bpf_iter_ksym_seq_show,
860};
861
862static int bpf_iter_ksym_init(void *priv_data, struct bpf_iter_aux_info *aux)
863{
864 struct kallsym_iter *iter = priv_data;
865
866 reset_iter(iter, 0);
867
868 /* cache here as in kallsyms_open() case; use current process
869 * credentials to tell BPF iterators if values should be shown.
870 */
871 iter->show_value = kallsyms_show_value(current_cred());
872
873 return 0;
874}
875
876DEFINE_BPF_ITER_FUNC(ksym, struct bpf_iter_meta *meta, struct kallsym_iter *ksym)
877
878static const struct bpf_iter_seq_info ksym_iter_seq_info = {
879 .seq_ops = &bpf_iter_ksym_ops,
880 .init_seq_private = bpf_iter_ksym_init,
881 .fini_seq_private = NULL,
882 .seq_priv_size = sizeof(struct kallsym_iter),
883};
884
885static struct bpf_iter_reg ksym_iter_reg_info = {
886 .target = "ksym",
887 .feature = BPF_ITER_RESCHED,
888 .ctx_arg_info_size = 1,
889 .ctx_arg_info = {
890 { offsetof(struct bpf_iter__ksym, ksym),
891 PTR_TO_BTF_ID_OR_NULL },
892 },
893 .seq_info = &ksym_iter_seq_info,
894};
895
896BTF_ID_LIST(btf_ksym_iter_id)
897BTF_ID(struct, kallsym_iter)
898
899static int __init bpf_ksym_iter_register(void)
900{
901 ksym_iter_reg_info.ctx_arg_info[0].btf_id = *btf_ksym_iter_id;
902 return bpf_iter_reg_target(&ksym_iter_reg_info);
903}
904
905late_initcall(bpf_ksym_iter_register);
906
907#endif /* CONFIG_BPF_SYSCALL */
908
1da177e4
LT
909static int kallsyms_open(struct inode *inode, struct file *file)
910{
ad6ccfad
MK
911 /*
912 * We keep iterator in m->private, since normal case is to
1da177e4 913 * s_start from where we left off, so we avoid doing
ad6ccfad
MK
914 * using get_symbol_offset for every symbol.
915 */
1da177e4 916 struct kallsym_iter *iter;
0049f26a 917 iter = __seq_open_private(file, &kallsyms_op, sizeof(*iter));
1da177e4
LT
918 if (!iter)
919 return -ENOMEM;
920 reset_iter(iter, 0);
921
16025184
KC
922 /*
923 * Instead of checking this on every s_show() call, cache
924 * the result here at open time.
925 */
926 iter->show_value = kallsyms_show_value(file->f_cred);
0049f26a 927 return 0;
1da177e4
LT
928}
929
67fc4e0c
JW
930#ifdef CONFIG_KGDB_KDB
931const char *kdb_walk_kallsyms(loff_t *pos)
932{
933 static struct kallsym_iter kdb_walk_kallsyms_iter;
934 if (*pos == 0) {
935 memset(&kdb_walk_kallsyms_iter, 0,
936 sizeof(kdb_walk_kallsyms_iter));
937 reset_iter(&kdb_walk_kallsyms_iter, 0);
938 }
939 while (1) {
940 if (!update_iter(&kdb_walk_kallsyms_iter, *pos))
941 return NULL;
942 ++*pos;
943 /* Some debugging symbols have no name. Ignore them. */
944 if (kdb_walk_kallsyms_iter.name[0])
945 return kdb_walk_kallsyms_iter.name;
946 }
947}
948#endif /* CONFIG_KGDB_KDB */
949
97a32539
AD
950static const struct proc_ops kallsyms_proc_ops = {
951 .proc_open = kallsyms_open,
952 .proc_read = seq_read,
953 .proc_lseek = seq_lseek,
954 .proc_release = seq_release_private,
1da177e4
LT
955};
956
957static int __init kallsyms_init(void)
958{
97a32539 959 proc_create("kallsyms", 0444, NULL, &kallsyms_proc_ops);
1da177e4
LT
960 return 0;
961}
ad6ccfad 962device_initcall(kallsyms_init);