xref: /linux-6.15/include/linux/kallsyms.h (revision a0f97e06)
1 /* Rewritten and vastly simplified by Rusty Russell for in-kernel
2  * module loader:
3  *   Copyright 2002 Rusty Russell <[email protected]> IBM Corporation
4  */
5 #ifndef _LINUX_KALLSYMS_H
6 #define _LINUX_KALLSYMS_H
7 
8 #include <linux/errno.h>
9 
10 #define KSYM_NAME_LEN 128
11 #define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s]") + (KSYM_NAME_LEN - 1) + \
12 			 2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + 1)
13 
14 #ifdef CONFIG_KALLSYMS
15 /* Lookup the address for a symbol. Returns 0 if not found. */
16 unsigned long kallsyms_lookup_name(const char *name);
17 
18 extern int kallsyms_lookup_size_offset(unsigned long addr,
19 				  unsigned long *symbolsize,
20 				  unsigned long *offset);
21 
22 /* Lookup an address.  modname is set to NULL if it's in the kernel. */
23 const char *kallsyms_lookup(unsigned long addr,
24 			    unsigned long *symbolsize,
25 			    unsigned long *offset,
26 			    char **modname, char *namebuf);
27 
28 /* Look up a kernel symbol and return it in a text buffer. */
29 extern int sprint_symbol(char *buffer, unsigned long address);
30 
31 /* Look up a kernel symbol and print it to the kernel messages. */
32 extern void __print_symbol(const char *fmt, unsigned long address);
33 
34 int lookup_symbol_name(unsigned long addr, char *symname);
35 int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
36 
37 #else /* !CONFIG_KALLSYMS */
38 
39 static inline unsigned long kallsyms_lookup_name(const char *name)
40 {
41 	return 0;
42 }
43 
44 static inline int kallsyms_lookup_size_offset(unsigned long addr,
45 					      unsigned long *symbolsize,
46 					      unsigned long *offset)
47 {
48 	return 0;
49 }
50 
51 static inline const char *kallsyms_lookup(unsigned long addr,
52 					  unsigned long *symbolsize,
53 					  unsigned long *offset,
54 					  char **modname, char *namebuf)
55 {
56 	return NULL;
57 }
58 
59 static inline int sprint_symbol(char *buffer, unsigned long addr)
60 {
61 	*buffer = '\0';
62 	return 0;
63 }
64 
65 static inline int lookup_symbol_name(unsigned long addr, char *symname)
66 {
67 	return -ERANGE;
68 }
69 
70 static inline int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
71 {
72 	return -ERANGE;
73 }
74 
75 /* Stupid that this does nothing, but I didn't create this mess. */
76 #define __print_symbol(fmt, addr)
77 #endif /*CONFIG_KALLSYMS*/
78 
79 /* This macro allows us to keep printk typechecking */
80 static void __check_printsym_format(const char *fmt, ...)
81 __attribute__((format(printf,1,2)));
82 static inline void __check_printsym_format(const char *fmt, ...)
83 {
84 }
85 /* ia64 and ppc64 use function descriptors, which contain the real address */
86 #if defined(CONFIG_IA64) || defined(CONFIG_PPC64)
87 #define print_fn_descriptor_symbol(fmt, addr)		\
88 do {						\
89 	unsigned long *__faddr = (unsigned long*) addr;		\
90 	print_symbol(fmt, __faddr[0]);		\
91 } while (0)
92 #else
93 #define print_fn_descriptor_symbol(fmt, addr) print_symbol(fmt, addr)
94 #endif
95 
96 static inline void print_symbol(const char *fmt, unsigned long addr)
97 {
98 	__check_printsym_format(fmt, "");
99 	__print_symbol(fmt, (unsigned long)
100 		       __builtin_extract_return_addr((void *)addr));
101 }
102 
103 #ifndef CONFIG_64BIT
104 #define print_ip_sym(ip)		\
105 do {					\
106 	printk("[<%08lx>]", ip);	\
107 	print_symbol(" %s\n", ip);	\
108 } while(0)
109 #else
110 #define print_ip_sym(ip)		\
111 do {					\
112 	printk("[<%016lx>]", ip);	\
113 	print_symbol(" %s\n", ip);	\
114 } while(0)
115 #endif
116 
117 #endif /*_LINUX_KALLSYMS_H*/
118