0a777c5216b1a2916795c4b58dae2d513c01c822
[sfrench/cifs-2.6.git] / include / linux / kallsyms.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Rewritten and vastly simplified by Rusty Russell for in-kernel
3  * module loader:
4  *   Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
5  */
6 #ifndef _LINUX_KALLSYMS_H
7 #define _LINUX_KALLSYMS_H
8
9 #include <linux/errno.h>
10 #include <linux/kernel.h>
11 #include <linux/stddef.h>
12
13 #define KSYM_NAME_LEN 128
14 #define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s]") + (KSYM_NAME_LEN - 1) + \
15                          2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + 1)
16
17 /* How and when do we show kallsyms values? */
18 extern int kallsyms_show_value(void);
19 #ifndef CONFIG_64BIT
20 # define KALLSYM_FMT "%08lx"
21 #else
22 # define KALLSYM_FMT "%016lx"
23 #endif
24
25 struct module;
26
27 #ifdef CONFIG_KALLSYMS
28 /* Lookup the address for a symbol. Returns 0 if not found. */
29 unsigned long kallsyms_lookup_name(const char *name);
30
31 /* Call a function on each kallsyms symbol in the core kernel */
32 int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
33                                       unsigned long),
34                             void *data);
35
36 extern int kallsyms_lookup_size_offset(unsigned long addr,
37                                   unsigned long *symbolsize,
38                                   unsigned long *offset);
39
40 /* Lookup an address.  modname is set to NULL if it's in the kernel. */
41 const char *kallsyms_lookup(unsigned long addr,
42                             unsigned long *symbolsize,
43                             unsigned long *offset,
44                             char **modname, char *namebuf);
45
46 /* Look up a kernel symbol and return it in a text buffer. */
47 extern int sprint_symbol(char *buffer, unsigned long address);
48 extern int sprint_symbol_no_offset(char *buffer, unsigned long address);
49 extern int sprint_backtrace(char *buffer, unsigned long address);
50
51 /* Look up a kernel symbol and print it to the kernel messages. */
52 extern void __print_symbol(const char *fmt, unsigned long address);
53
54 int lookup_symbol_name(unsigned long addr, char *symname);
55 int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
56
57 #else /* !CONFIG_KALLSYMS */
58
59 static inline unsigned long kallsyms_lookup_name(const char *name)
60 {
61         return 0;
62 }
63
64 static inline int kallsyms_on_each_symbol(int (*fn)(void *, const char *,
65                                                     struct module *,
66                                                     unsigned long),
67                                           void *data)
68 {
69         return 0;
70 }
71
72 static inline int kallsyms_lookup_size_offset(unsigned long addr,
73                                               unsigned long *symbolsize,
74                                               unsigned long *offset)
75 {
76         return 0;
77 }
78
79 static inline const char *kallsyms_lookup(unsigned long addr,
80                                           unsigned long *symbolsize,
81                                           unsigned long *offset,
82                                           char **modname, char *namebuf)
83 {
84         return NULL;
85 }
86
87 static inline int sprint_symbol(char *buffer, unsigned long addr)
88 {
89         *buffer = '\0';
90         return 0;
91 }
92
93 static inline int sprint_symbol_no_offset(char *buffer, unsigned long addr)
94 {
95         *buffer = '\0';
96         return 0;
97 }
98
99 static inline int sprint_backtrace(char *buffer, unsigned long addr)
100 {
101         *buffer = '\0';
102         return 0;
103 }
104
105 static inline int lookup_symbol_name(unsigned long addr, char *symname)
106 {
107         return -ERANGE;
108 }
109
110 static inline int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
111 {
112         return -ERANGE;
113 }
114
115 /* Stupid that this does nothing, but I didn't create this mess. */
116 #define __print_symbol(fmt, addr)
117 #endif /*CONFIG_KALLSYMS*/
118
119 /* This macro allows us to keep printk typechecking */
120 static __printf(1, 2)
121 void __check_printsym_format(const char *fmt, ...)
122 {
123 }
124
125 static inline void print_symbol(const char *fmt, unsigned long addr)
126 {
127         __check_printsym_format(fmt, "");
128         __print_symbol(fmt, (unsigned long)
129                        __builtin_extract_return_addr((void *)addr));
130 }
131
132 static inline void print_ip_sym(unsigned long ip)
133 {
134         printk("[<%p>] %pS\n", (void *) ip, (void *) ip);
135 }
136
137 #endif /*_LINUX_KALLSYMS_H*/