[linux-block.git] / include / linux / kallsyms.h

/* SPDX-License-Identifier: GPL-2.0 */
/* Rewritten and vastly simplified by Rusty Russell for in-kernel
 * module loader:
 *   Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
 */
#ifndef _LINUX_KALLSYMS_H
#define _LINUX_KALLSYMS_H

#include <linux/errno.h>
#include <linux/buildid.h>
#include <linux/kernel.h>
#include <linux/stddef.h>
#include <linux/mm.h>
#include <linux/module.h>

#include <asm/sections.h>

#define KSYM_NAME_LEN 512
#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s %s]") + \
			(KSYM_NAME_LEN - 1) + \
			2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + \
			(BUILD_ID_SIZE_MAX * 2) + 1)

struct cred;
struct module;

static inline int is_kernel_text(unsigned long addr)
{
	if (__is_kernel_text(addr))
		return 1;
	return in_gate_area_no_mm(addr);
}

static inline int is_kernel(unsigned long addr)
{
	if (__is_kernel(addr))
		return 1;
	return in_gate_area_no_mm(addr);
}

static inline int is_ksym_addr(unsigned long addr)
{
	if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
		return is_kernel(addr);

	return is_kernel_text(addr) || is_kernel_inittext(addr);
}

static inline void *dereference_symbol_descriptor(void *ptr)
{
#ifdef CONFIG_HAVE_FUNCTION_DESCRIPTORS
	struct module *mod;

	ptr = dereference_kernel_function_descriptor(ptr);
	if (is_ksym_addr((unsigned long)ptr))
		return ptr;

	preempt_disable();
	mod = __module_address((unsigned long)ptr);
	preempt_enable();

	if (mod)
		ptr = dereference_module_function_descriptor(mod, ptr);
#endif
	return ptr;
}

#ifdef CONFIG_KALLSYMS
int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
				      unsigned long),
			    void *data);

/* Lookup the address for a symbol. Returns 0 if not found. */
unsigned long kallsyms_lookup_name(const char *name);

extern int kallsyms_lookup_size_offset(unsigned long addr,
				  unsigned long *symbolsize,
				  unsigned long *offset);

/* Lookup an address.  modname is set to NULL if it's in the kernel. */
const char *kallsyms_lookup(unsigned long addr,
			    unsigned long *symbolsize,
			    unsigned long *offset,
			    char **modname, char *namebuf);

/* Look up a kernel symbol and return it in a text buffer. */
extern int sprint_symbol(char *buffer, unsigned long address);
extern int sprint_symbol_build_id(char *buffer, unsigned long address);
extern int sprint_symbol_no_offset(char *buffer, unsigned long address);
extern int sprint_backtrace(char *buffer, unsigned long address);
extern int sprint_backtrace_build_id(char *buffer, unsigned long address);

int lookup_symbol_name(unsigned long addr, char *symname);
int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);

/* How and when do we show kallsyms values? */
extern bool kallsyms_show_value(const struct cred *cred);

#else /* !CONFIG_KALLSYMS */

static inline unsigned long kallsyms_lookup_name(const char *name)
{
	return 0;
}

static inline int kallsyms_lookup_size_offset(unsigned long addr,
					      unsigned long *symbolsize,
					      unsigned long *offset)
{
	return 0;
}

static inline const char *kallsyms_lookup(unsigned long addr,
					  unsigned long *symbolsize,
					  unsigned long *offset,
					  char **modname, char *namebuf)
{
	return NULL;
}

static inline int sprint_symbol(char *buffer, unsigned long addr)
{
	*buffer = '\0';
	return 0;
}

static inline int sprint_symbol_build_id(char *buffer, unsigned long address)
{
	*buffer = '\0';
	return 0;
}

static inline int sprint_symbol_no_offset(char *buffer, unsigned long addr)
{
	*buffer = '\0';
	return 0;
}

static inline int sprint_backtrace(char *buffer, unsigned long addr)
{
	*buffer = '\0';
	return 0;
}

static inline int sprint_backtrace_build_id(char *buffer, unsigned long addr)
{
	*buffer = '\0';
	return 0;
}

static inline int lookup_symbol_name(unsigned long addr, char *symname)
{
	return -ERANGE;
}

static inline int lookup_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
{
	return -ERANGE;
}

static inline bool kallsyms_show_value(const struct cred *cred)
{
	return false;
}

static inline int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
					  unsigned long), void *data)
{
	return -EOPNOTSUPP;
}
#endif /*CONFIG_KALLSYMS*/

static inline void print_ip_sym(const char *loglvl, unsigned long ip)
{
	printk("%s[<%px>] %pS\n", loglvl, (void *) ip, (void *) ip);
}

#endif /*_LINUX_KALLSYMS_H*/
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	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
40e48eed	9	#include <linux/errno.h>
9294523e	10	#include <linux/buildid.h>
2711b793	11	#include <linux/kernel.h>
5a75983e	12	#include <linux/stddef.h>
04b8eb7a SS	13	#include <linux/mm.h>
	14	#include <linux/module.h>
	15
	16	#include <asm/sections.h>
1da177e4	17
b8a94bfb	18	#define KSYM_NAME_LEN 512
9294523e SB	19	#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s %s]") + \
	20	(KSYM_NAME_LEN - 1) + \
	21	2(BITS_PER_LONG3/10) + (MODULE_NAME_LEN - 1) + \
	22	(BUILD_ID_SIZE_MAX * 2) + 1)
1da177e4	23
16025184	24	struct cred;
75a66614 AK	25	struct module;
75a66614 AK	26
04b8eb7a SS	27	static inline int is_kernel_text(unsigned long addr)
04b8eb7a SS	28	{
8f6e42e8	29	if (__is_kernel_text(addr))
04b8eb7a SS	30	return 1;
	31	return in_gate_area_no_mm(addr);
	32	}
	33
	34	static inline int is_kernel(unsigned long addr)
	35	{
8f6e42e8	36	if (__is_kernel(addr))
04b8eb7a SS	37	return 1;
	38	return in_gate_area_no_mm(addr);
	39	}
	40
	41	static inline int is_ksym_addr(unsigned long addr)
	42	{
	43	if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
	44	return is_kernel(addr);
	45
	46	return is_kernel_text(addr) \|\| is_kernel_inittext(addr);
	47	}
	48
	49	static inline void dereference_symbol_descriptor(void ptr)
	50	{
a257cacc	51	#ifdef CONFIG_HAVE_FUNCTION_DESCRIPTORS
04b8eb7a SS	52	struct module *mod;
	53
	54	ptr = dereference_kernel_function_descriptor(ptr);
	55	if (is_ksym_addr((unsigned long)ptr))
	56	return ptr;
	57
	58	preempt_disable();
	59	mod = __module_address((unsigned long)ptr);
	60	preempt_enable();
	61
	62	if (mod)
	63	ptr = dereference_module_function_descriptor(mod, ptr);
	64	#endif
	65	return ptr;
	66	}
	67
d721def7	68	#ifdef CONFIG_KALLSYMS
75a66614 AK	69	int kallsyms_on_each_symbol(int (fn)(void , const char , struct module ,
	70	unsigned long),
	71	void *data);
	72
3e355205 CH	73	/* Lookup the address for a symbol. Returns 0 if not found. */
	74	unsigned long kallsyms_lookup_name(const char *name);
	75
ffc50891 FBH	76	extern int kallsyms_lookup_size_offset(unsigned long addr,
	77	unsigned long *symbolsize,
	78	unsigned long *offset);
	79
1da177e4 LT	80	/* Lookup an address. modname is set to NULL if it's in the kernel. */
	81	const char *kallsyms_lookup(unsigned long addr,
	82	unsigned long *symbolsize,
	83	unsigned long *offset,
	84	char *modname, char namebuf);
	85
42e38083 RP	86	/* Look up a kernel symbol and return it in a text buffer. */
42e38083 RP	87	extern int sprint_symbol(char *buffer, unsigned long address);
9294523e	88	extern int sprint_symbol_build_id(char *buffer, unsigned long address);
4796dd20	89	extern int sprint_symbol_no_offset(char *buffer, unsigned long address);
0f77a8d3	90	extern int sprint_backtrace(char *buffer, unsigned long address);
9294523e	91	extern int sprint_backtrace_build_id(char *buffer, unsigned long address);
42e38083	92
9d65cb4a	93	int lookup_symbol_name(unsigned long addr, char *symname);
a5c43dae	94	int lookup_symbol_attrs(unsigned long addr, unsigned long size, unsigned long offset, char modname, char name);
9d65cb4a	95
e4a8ca3b	96	/* How and when do we show kallsyms values? */
16025184	97	extern bool kallsyms_show_value(const struct cred *cred);
e4a8ca3b	98
1da177e4 LT	99	#else /* !CONFIG_KALLSYMS */
	100
	101	static inline unsigned long kallsyms_lookup_name(const char *name)
	102	{
	103	return 0;
	104	}
	105
ffc50891 FBH	106	static inline int kallsyms_lookup_size_offset(unsigned long addr,
	107	unsigned long *symbolsize,
	108	unsigned long *offset)
	109	{
	110	return 0;
	111	}
	112
1da177e4 LT	113	static inline const char *kallsyms_lookup(unsigned long addr,
	114	unsigned long *symbolsize,
	115	unsigned long *offset,
	116	char *modname, char namebuf)
	117	{
	118	return NULL;
	119	}
	120
42e38083 RP	121	static inline int sprint_symbol(char *buffer, unsigned long addr)
	122	{
	123	*buffer = '\0';
	124	return 0;
	125	}
	126
9294523e SB	127	static inline int sprint_symbol_build_id(char *buffer, unsigned long address)
	128	{
	129	*buffer = '\0';
	130	return 0;
	131	}
	132
4796dd20 SB	133	static inline int sprint_symbol_no_offset(char *buffer, unsigned long addr)
	134	{
	135	*buffer = '\0';
	136	return 0;
	137	}
	138
0f77a8d3 NK	139	static inline int sprint_backtrace(char *buffer, unsigned long addr)
	140	{
	141	*buffer = '\0';
	142	return 0;
	143	}
	144
9294523e SB	145	static inline int sprint_backtrace_build_id(char *buffer, unsigned long addr)
	146	{
	147	*buffer = '\0';
	148	return 0;
	149	}
	150
9d65cb4a AD	151	static inline int lookup_symbol_name(unsigned long addr, char *symname)
	152	{
	153	return -ERANGE;
	154	}
	155
a5c43dae AD	156	static inline int lookup_symbol_attrs(unsigned long addr, unsigned long size, unsigned long offset, char modname, char name)
	157	{
	158	return -ERANGE;
	159	}
	160
16025184	161	static inline bool kallsyms_show_value(const struct cred *cred)
e4a8ca3b AB	162	{
	163	return false;
	164	}
	165
d721def7 JO	166	static inline int kallsyms_on_each_symbol(int (fn)(void , const char , struct module ,
	167	unsigned long), void *data)
	168	{
	169	return -EOPNOTSUPP;
	170	}
1da177e4 LT	171	#endif /CONFIG_KALLSYMS/
1da177e4 LT	172
2062a4e8	173	static inline void print_ip_sym(const char *loglvl, unsigned long ip)
2711b793	174	{
2062a4e8	175	printk("%s[<%px>] %pS\n", loglvl, (void ) ip, (void ) ip);
2711b793	176	}
8d8fdf5c	177
1da177e4	178	#endif /_LINUX_KALLSYMS_H/