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