[mirror_ubuntu-jammy-kernel.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 128
#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_inittext(unsigned long addr)
{
	if (addr >= (unsigned long)_sinittext
	    && addr <= (unsigned long)_einittext)
		return 1;
	return 0;
}

static inline int is_kernel_text(unsigned long addr)
{
	if ((addr >= (unsigned long)_stext && addr <= (unsigned long)_etext) ||
	    arch_is_kernel_text(addr))
		return 1;
	return in_gate_area_no_mm(addr);
}

static inline int is_kernel(unsigned long addr)
{
	if (addr >= (unsigned long)_stext && addr <= (unsigned long)_end)
		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 HAVE_DEREFERENCE_FUNCTION_DESCRIPTOR
	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;
}

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

#ifdef CONFIG_KALLSYMS
/* 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;
}

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