[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/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]") + (KSYM_NAME_LEN - 1) + \
			 2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + 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;
}

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

/* Call a function on each kallsyms symbol in the core kernel */
int kallsyms_on_each_symbol(int (*fn)(void *, const char *, struct module *,
				      unsigned long),
			    void *data);

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