[mirror_ubuntu-bionic-kernel.git] / arch / x86 / include / asm / unwind.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _ASM_X86_UNWIND_H
#define _ASM_X86_UNWIND_H

#include <linux/sched.h>
#include <linux/ftrace.h>
#include <asm/ptrace.h>
#include <asm/stacktrace.h>

#define IRET_FRAME_OFFSET (offsetof(struct pt_regs, ip))
#define IRET_FRAME_SIZE   (sizeof(struct pt_regs) - IRET_FRAME_OFFSET)

struct unwind_state {
	struct stack_info stack_info;
	unsigned long stack_mask;
	struct task_struct *task;
	int graph_idx;
	bool error;
#if defined(CONFIG_UNWINDER_ORC)
	bool signal, full_regs;
	unsigned long sp, bp, ip;
	struct pt_regs *regs;
#elif defined(CONFIG_UNWINDER_FRAME_POINTER)
	bool got_irq;
	unsigned long *bp, *orig_sp, ip;
	struct pt_regs *regs;
#else
	unsigned long *sp;
#endif
};

void __unwind_start(struct unwind_state *state, struct task_struct *task,
		    struct pt_regs *regs, unsigned long *first_frame);
bool unwind_next_frame(struct unwind_state *state);
unsigned long unwind_get_return_address(struct unwind_state *state);
unsigned long *unwind_get_return_address_ptr(struct unwind_state *state);

static inline bool unwind_done(struct unwind_state *state)
{
	return state->stack_info.type == STACK_TYPE_UNKNOWN;
}

static inline bool unwind_error(struct unwind_state *state)
{
	return state->error;
}

static inline
void unwind_start(struct unwind_state *state, struct task_struct *task,
		  struct pt_regs *regs, unsigned long *first_frame)
{
	first_frame = first_frame ? : get_stack_pointer(task, regs);

	__unwind_start(state, task, regs, first_frame);
}

#if defined(CONFIG_UNWINDER_ORC) || defined(CONFIG_UNWINDER_FRAME_POINTER)
/*
 * If 'partial' returns true, only the iret frame registers are valid.
 */
static inline struct pt_regs *unwind_get_entry_regs(struct unwind_state *state,
						    bool *partial)
{
	if (unwind_done(state))
		return NULL;

	if (partial) {
#ifdef CONFIG_UNWINDER_ORC
		*partial = !state->full_regs;
#else
		*partial = false;
#endif
	}

	return state->regs;
}
#else
static inline struct pt_regs *unwind_get_entry_regs(struct unwind_state *state,
						    bool *partial)
{
	return NULL;
}
#endif

#ifdef CONFIG_UNWINDER_ORC
void unwind_init(void);
void unwind_module_init(struct module *mod, void *orc_ip, size_t orc_ip_size,
			void *orc, size_t orc_size);
#else
static inline void unwind_init(void) {}
static inline
void unwind_module_init(struct module *mod, void *orc_ip, size_t orc_ip_size,
			void *orc, size_t orc_size) {}
#endif

/*
 * This disables KASAN checking when reading a value from another task's stack,
 * since the other task could be running on another CPU and could have poisoned
 * the stack in the meantime.
 */
#define READ_ONCE_TASK_STACK(task, x)			\
({							\
	unsigned long val;				\
	if (task == current)				\
		val = READ_ONCE(x);			\
	else						\
		val = READ_ONCE_NOCHECK(x);		\
	val;						\
})

static inline bool task_on_another_cpu(struct task_struct *task)
{
#ifdef CONFIG_SMP
	return task != current && task->on_cpu;
#else
	return false;
#endif
}

#endif /* _ASM_X86_UNWIND_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
7c7900f8 JP	2	#ifndef _ASM_X86_UNWIND_H
	3	#define _ASM_X86_UNWIND_H
	4
	5	#include <linux/sched.h>
	6	#include <linux/ftrace.h>
	7	#include <asm/ptrace.h>
	8	#include <asm/stacktrace.h>
	9
b02fcf9b JP	10	#define IRET_FRAME_OFFSET (offsetof(struct pt_regs, ip))
	11	#define IRET_FRAME_SIZE (sizeof(struct pt_regs) - IRET_FRAME_OFFSET)
	12
7c7900f8 JP	13	struct unwind_state {
	14	struct stack_info stack_info;
	15	unsigned long stack_mask;
	16	struct task_struct *task;
	17	int graph_idx;
af085d90	18	bool error;
11af8474	19	#if defined(CONFIG_UNWINDER_ORC)
ee9f8fce JP	20	bool signal, full_regs;
	21	unsigned long sp, bp, ip;
	22	struct pt_regs *regs;
11af8474	23	#elif defined(CONFIG_UNWINDER_FRAME_POINTER)
a8b7a923	24	bool got_irq;
ee9f8fce	25	unsigned long bp, orig_sp, ip;
946c1911	26	struct pt_regs *regs;
7c7900f8 JP	27	#else
	28	unsigned long *sp;
	29	#endif
	30	};
	31
	32	void __unwind_start(struct unwind_state state, struct task_struct task,
	33	struct pt_regs regs, unsigned long first_frame);
7c7900f8	34	bool unwind_next_frame(struct unwind_state *state);
cfee9edd	35	unsigned long unwind_get_return_address(struct unwind_state *state);
ee9f8fce	36	unsigned long unwind_get_return_address_ptr(struct unwind_state state);
cfee9edd	37
7c7900f8 JP	38	static inline bool unwind_done(struct unwind_state *state)
	39	{
	40	return state->stack_info.type == STACK_TYPE_UNKNOWN;
	41	}
	42
af085d90 JP	43	static inline bool unwind_error(struct unwind_state *state)
	44	{
	45	return state->error;
	46	}
	47
7c7900f8	48	static inline
ee9f8fce JP	49	void unwind_start(struct unwind_state state, struct task_struct task,
ee9f8fce JP	50	struct pt_regs regs, unsigned long first_frame)
7c7900f8	51	{
ee9f8fce	52	first_frame = first_frame ? : get_stack_pointer(task, regs);
7c7900f8	53
ee9f8fce	54	__unwind_start(state, task, regs, first_frame);
946c1911 JP	55	}
946c1911 JP	56
11af8474	57	#if defined(CONFIG_UNWINDER_ORC) \|\| defined(CONFIG_UNWINDER_FRAME_POINTER)
b02fcf9b	58	/*
a9cdbe72	59	* If 'partial' returns true, only the iret frame registers are valid.
b02fcf9b	60	*/
a9cdbe72 JP	61	static inline struct pt_regs unwind_get_entry_regs(struct unwind_state state,
a9cdbe72 JP	62	bool *partial)
946c1911 JP	63	{
	64	if (unwind_done(state))
	65	return NULL;
	66
a9cdbe72 JP	67	if (partial) {
	68	#ifdef CONFIG_UNWINDER_ORC
	69	*partial = !state->full_regs;
	70	#else
	71	*partial = false;
	72	#endif
	73	}
	74
946c1911	75	return state->regs;
7c7900f8	76	}
ee9f8fce	77	#else
a9cdbe72 JP	78	static inline struct pt_regs unwind_get_entry_regs(struct unwind_state state,
a9cdbe72 JP	79	bool *partial)
7c7900f8 JP	80	{
	81	return NULL;
	82	}
ee9f8fce	83	#endif
7c7900f8	84
11af8474	85	#ifdef CONFIG_UNWINDER_ORC
ee9f8fce JP	86	void unwind_init(void);
	87	void unwind_module_init(struct module mod, void orc_ip, size_t orc_ip_size,
	88	void *orc, size_t orc_size);
	89	#else
	90	static inline void unwind_init(void) {}
	91	static inline
	92	void unwind_module_init(struct module mod, void orc_ip, size_t orc_ip_size,
	93	void *orc, size_t orc_size) {}
	94	#endif
	95
	96	/*
	97	* This disables KASAN checking when reading a value from another task's stack,
	98	* since the other task could be running on another CPU and could have poisoned
	99	* the stack in the meantime.
	100	*/
	101	#define READ_ONCE_TASK_STACK(task, x) \
	102	({ \
	103	unsigned long val; \
	104	if (task == current) \
	105	val = READ_ONCE(x); \
	106	else \
	107	val = READ_ONCE_NOCHECK(x); \
	108	val; \
	109	})
	110
	111	static inline bool task_on_another_cpu(struct task_struct *task)
946c1911	112	{
ee9f8fce JP	113	#ifdef CONFIG_SMP
	114	return task != current && task->on_cpu;
	115	#else
	116	return false;
	117	#endif
946c1911 JP	118	}
946c1911 JP	119
7c7900f8	120	#endif /* _ASM_X86_UNWIND_H */