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