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