[mirror_ubuntu-jammy-kernel.git] / arch / x86 / include / asm / stacktrace.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  Copyright (C) 1991, 1992  Linus Torvalds
 *  Copyright (C) 2000, 2001, 2002 Andi Kleen, SuSE Labs
 */

#ifndef _ASM_X86_STACKTRACE_H
#define _ASM_X86_STACKTRACE_H

#include <linux/uaccess.h>
#include <linux/ptrace.h>
#include <asm/switch_to.h>

enum stack_type {
	STACK_TYPE_UNKNOWN,
	STACK_TYPE_TASK,
	STACK_TYPE_IRQ,
	STACK_TYPE_SOFTIRQ,
	STACK_TYPE_ENTRY,
	STACK_TYPE_EXCEPTION,
	STACK_TYPE_EXCEPTION_LAST = STACK_TYPE_EXCEPTION + N_EXCEPTION_STACKS-1,
};

struct stack_info {
	enum stack_type type;
	unsigned long *begin, *end, *next_sp;
};

bool in_task_stack(unsigned long *stack, struct task_struct *task,
		   struct stack_info *info);

bool in_entry_stack(unsigned long *stack, struct stack_info *info);

int get_stack_info(unsigned long *stack, struct task_struct *task,
		   struct stack_info *info, unsigned long *visit_mask);

const char *stack_type_name(enum stack_type type);

static inline bool on_stack(struct stack_info *info, void *addr, size_t len)
{
	void *begin = info->begin;
	void *end   = info->end;

	return (info->type != STACK_TYPE_UNKNOWN &&
		addr >= begin && addr < end &&
		addr + len > begin && addr + len <= end);
}

#ifdef CONFIG_X86_32
#define STACKSLOTS_PER_LINE 8
#else
#define STACKSLOTS_PER_LINE 4
#endif

#ifdef CONFIG_FRAME_POINTER
static inline unsigned long *
get_frame_pointer(struct task_struct *task, struct pt_regs *regs)
{
	if (regs)
		return (unsigned long *)regs->bp;

	if (task == current)
		return __builtin_frame_address(0);

	return &((struct inactive_task_frame *)task->thread.sp)->bp;
}
#else
static inline unsigned long *
get_frame_pointer(struct task_struct *task, struct pt_regs *regs)
{
	return NULL;
}
#endif /* CONFIG_FRAME_POINTER */

static inline unsigned long *
get_stack_pointer(struct task_struct *task, struct pt_regs *regs)
{
	if (regs)
		return (unsigned long *)kernel_stack_pointer(regs);

	if (task == current)
		return __builtin_frame_address(0);

	return (unsigned long *)task->thread.sp;
}

void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
			unsigned long *stack, char *log_lvl);

extern unsigned int code_bytes;

/* The form of the top of the frame on the stack */
struct stack_frame {
	struct stack_frame *next_frame;
	unsigned long return_address;
};

struct stack_frame_ia32 {
    u32 next_frame;
    u32 return_address;
};

static inline unsigned long caller_frame_pointer(void)
{
	struct stack_frame *frame;

	frame = __builtin_frame_address(0);

#ifdef CONFIG_FRAME_POINTER
	frame = frame->next_frame;
#endif

	return (unsigned long)frame;
}

#endif /* _ASM_X86_STACKTRACE_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
c9cf4dbb FW	2	/*
	3	* Copyright (C) 1991, 1992 Linus Torvalds
	4	* Copyright (C) 2000, 2001, 2002 Andi Kleen, SuSE Labs
	5	*/
	6
1965aae3 PA	7	#ifndef _ASM_X86_STACKTRACE_H
1965aae3 PA	8	#define _ASM_X86_STACKTRACE_H
c0b766f1	9
c9cf4dbb	10	#include <linux/uaccess.h>
9c0729dc	11	#include <linux/ptrace.h>
7b32aead	12	#include <asm/switch_to.h>
c9cf4dbb	13
cb76c939 JP	14	enum stack_type {
	15	STACK_TYPE_UNKNOWN,
	16	STACK_TYPE_TASK,
	17	STACK_TYPE_IRQ,
	18	STACK_TYPE_SOFTIRQ,
4fe2d8b1	19	STACK_TYPE_ENTRY,
cb76c939 JP	20	STACK_TYPE_EXCEPTION,
	21	STACK_TYPE_EXCEPTION_LAST = STACK_TYPE_EXCEPTION + N_EXCEPTION_STACKS-1,
	22	};
	23
	24	struct stack_info {
	25	enum stack_type type;
	26	unsigned long begin, end, *next_sp;
	27	};
	28
	29	bool in_task_stack(unsigned long stack, struct task_struct task,
	30	struct stack_info *info);
	31
4fe2d8b1	32	bool in_entry_stack(unsigned long stack, struct stack_info info);
33a2f1a6	33
cb76c939 JP	34	int get_stack_info(unsigned long stack, struct task_struct task,
	35	struct stack_info info, unsigned long visit_mask);
	36
3d02a9c4	37	const char *stack_type_name(enum stack_type type);
cb76c939 JP	38
	39	static inline bool on_stack(struct stack_info info, void addr, size_t len)
	40	{
	41	void *begin = info->begin;
	42	void *end = info->end;
	43
	44	return (info->type != STACK_TYPE_UNKNOWN &&
	45	addr >= begin && addr < end &&
	46	addr + len > begin && addr + len <= end);
	47	}
	48
c9cf4dbb FW	49	#ifdef CONFIG_X86_32
c9cf4dbb FW	50	#define STACKSLOTS_PER_LINE 8
c9cf4dbb FW	51	#else
c9cf4dbb FW	52	#define STACKSLOTS_PER_LINE 4
c9cf4dbb FW	53	#endif
c9cf4dbb FW	54
9c0729dc	55	#ifdef CONFIG_FRAME_POINTER
4b8afafb JP	56	static inline unsigned long *
4b8afafb JP	57	get_frame_pointer(struct task_struct task, struct pt_regs regs)
9c0729dc	58	{
9c0729dc	59	if (regs)
4b8afafb	60	return (unsigned long *)regs->bp;
9c0729dc	61
81539169	62	if (task == current)
4b8afafb	63	return __builtin_frame_address(0);
9c0729dc	64
2c96b2fe	65	return &((struct inactive_task_frame *)task->thread.sp)->bp;
9c0729dc SSP	66	}
9c0729dc SSP	67	#else
4b8afafb JP	68	static inline unsigned long *
4b8afafb JP	69	get_frame_pointer(struct task_struct task, struct pt_regs regs)
9c0729dc	70	{
4b8afafb JP	71	return NULL;
	72	}
	73	#endif /* CONFIG_FRAME_POINTER */
	74
	75	static inline unsigned long *
	76	get_stack_pointer(struct task_struct task, struct pt_regs regs)
	77	{
	78	if (regs)
	79	return (unsigned long *)kernel_stack_pointer(regs);
	80
81539169	81	if (task == current)
4b8afafb JP	82	return __builtin_frame_address(0);
	83
	84	return (unsigned long *)task->thread.sp;
9c0729dc	85	}
9c0729dc	86
e18bcccd JP	87	void show_trace_log_lvl(struct task_struct task, struct pt_regs regs,
e18bcccd JP	88	unsigned long stack, char log_lvl);
c9cf4dbb	89
c9cf4dbb FW	90	extern unsigned int code_bytes;
	91
	92	/* The form of the top of the frame on the stack */
	93	struct stack_frame {
	94	struct stack_frame *next_frame;
	95	unsigned long return_address;
	96	};
	97
	98	struct stack_frame_ia32 {
	99	u32 next_frame;
	100	u32 return_address;
	101	};
	102
b0f82b81	103	static inline unsigned long caller_frame_pointer(void)
c9cf4dbb FW	104	{
	105	struct stack_frame *frame;
	106
4b8afafb	107	frame = __builtin_frame_address(0);
c9cf4dbb FW	108
c9cf4dbb FW	109	#ifdef CONFIG_FRAME_POINTER
b0f82b81	110	frame = frame->next_frame;
c9cf4dbb FW	111	#endif
	112
	113	return (unsigned long)frame;
	114	}
	115
1965aae3	116	#endif /* _ASM_X86_STACKTRACE_H */