blob: 792274269f2b38bfa288af12b87ec952f742966c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Rewritten and vastly simplified by Rusty Russell for in-kernel
2 * module loader:
3 * Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
4 */
5#ifndef _LINUX_KALLSYMS_H
6#define _LINUX_KALLSYMS_H
7
Adrian Bunk40e48ee2007-07-07 00:54:09 +02008#include <linux/errno.h>
Vegard Nossum2711b792008-07-25 01:45:56 -07009#include <linux/kernel.h>
Kamalesh Babulal5a759832007-11-05 14:50:55 -080010#include <linux/stddef.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
Tejun Heo9281ace2007-07-17 04:03:51 -070012#define KSYM_NAME_LEN 128
13#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s]") + (KSYM_NAME_LEN - 1) + \
14 2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
Anders Kaseorg75a66612008-12-05 19:03:58 -050016struct module;
17
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#ifdef CONFIG_KALLSYMS
19/* Lookup the address for a symbol. Returns 0 if not found. */
20unsigned long kallsyms_lookup_name(const char *name);
21
Anders Kaseorg75a66612008-12-05 19:03:58 -050022/* Call a function on each kallsyms symbol in the core kernel */
23int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
24 unsigned long),
25 void *data);
26
Franck Bui-Huuffc50892006-10-03 01:13:48 -070027extern int kallsyms_lookup_size_offset(unsigned long addr,
28 unsigned long *symbolsize,
29 unsigned long *offset);
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/* Lookup an address. modname is set to NULL if it's in the kernel. */
32const char *kallsyms_lookup(unsigned long addr,
33 unsigned long *symbolsize,
34 unsigned long *offset,
35 char **modname, char *namebuf);
36
Robert Peterson42e38082007-04-30 15:09:48 -070037/* Look up a kernel symbol and return it in a text buffer. */
38extern int sprint_symbol(char *buffer, unsigned long address);
39
40/* Look up a kernel symbol and print it to the kernel messages. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041extern void __print_symbol(const char *fmt, unsigned long address);
42
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -070043int lookup_symbol_name(unsigned long addr, char *symname);
Alexey Dobriyana5c43da2007-05-08 00:28:47 -070044int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -070045
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#else /* !CONFIG_KALLSYMS */
47
48static inline unsigned long kallsyms_lookup_name(const char *name)
49{
50 return 0;
51}
52
Anders Kaseorg75a66612008-12-05 19:03:58 -050053static inline int kallsyms_on_each_symbol(int (*fn)(void *, const char *,
54 struct module *,
55 unsigned long),
56 void *data)
57{
58 return 0;
59}
60
Franck Bui-Huuffc50892006-10-03 01:13:48 -070061static inline int kallsyms_lookup_size_offset(unsigned long addr,
62 unsigned long *symbolsize,
63 unsigned long *offset)
64{
65 return 0;
66}
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068static inline const char *kallsyms_lookup(unsigned long addr,
69 unsigned long *symbolsize,
70 unsigned long *offset,
71 char **modname, char *namebuf)
72{
73 return NULL;
74}
75
Robert Peterson42e38082007-04-30 15:09:48 -070076static inline int sprint_symbol(char *buffer, unsigned long addr)
77{
78 *buffer = '\0';
79 return 0;
80}
81
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -070082static inline int lookup_symbol_name(unsigned long addr, char *symname)
83{
84 return -ERANGE;
85}
86
Alexey Dobriyana5c43da2007-05-08 00:28:47 -070087static inline int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
88{
89 return -ERANGE;
90}
91
Linus Torvalds1da177e2005-04-16 15:20:36 -070092/* Stupid that this does nothing, but I didn't create this mess. */
93#define __print_symbol(fmt, addr)
94#endif /*CONFIG_KALLSYMS*/
95
96/* This macro allows us to keep printk typechecking */
97static void __check_printsym_format(const char *fmt, ...)
98__attribute__((format(printf,1,2)));
99static inline void __check_printsym_format(const char *fmt, ...)
100{
101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Heiko Carstensb02454f2006-07-03 00:24:06 -0700103static inline void print_symbol(const char *fmt, unsigned long addr)
104{
105 __check_printsym_format(fmt, "");
106 __print_symbol(fmt, (unsigned long)
107 __builtin_extract_return_addr((void *)addr));
108}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Linus Torvaldsa442ac52008-05-15 17:50:37 -0700110/*
Bjorn Helgaasc80cfb02008-10-15 22:01:35 -0700111 * Pretty-print a function pointer. This function is deprecated.
112 * Please use the "%pF" vsprintf format instead.
Linus Torvaldsa442ac52008-05-15 17:50:37 -0700113 */
Bjorn Helgaasc80cfb02008-10-15 22:01:35 -0700114static inline void __deprecated print_fn_descriptor_symbol(const char *fmt, void *addr)
Linus Torvaldsa442ac52008-05-15 17:50:37 -0700115{
116#if defined(CONFIG_IA64) || defined(CONFIG_PPC64)
117 addr = *(void **)addr;
118#endif
119 print_symbol(fmt, (unsigned long)addr);
120}
121
Vegard Nossum2711b792008-07-25 01:45:56 -0700122static inline void print_ip_sym(unsigned long ip)
123{
Vegard Nossum3f1712b2008-07-29 22:33:32 -0700124 printk("[<%p>] %pS\n", (void *) ip, (void *) ip);
Vegard Nossum2711b792008-07-25 01:45:56 -0700125}
Heiko Carstens8d8fdf52006-07-03 00:24:25 -0700126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127#endif /*_LINUX_KALLSYMS_H*/