xref: /linux-6.15/arch/x86/include/asm/stacktrace.h (revision e18bcccd)
1 /*
2  *  Copyright (C) 1991, 1992  Linus Torvalds
3  *  Copyright (C) 2000, 2001, 2002 Andi Kleen, SuSE Labs
4  */
5 
6 #ifndef _ASM_X86_STACKTRACE_H
7 #define _ASM_X86_STACKTRACE_H
8 
9 #include <linux/uaccess.h>
10 #include <linux/ptrace.h>
11 #include <asm/switch_to.h>
12 
13 enum stack_type {
14 	STACK_TYPE_UNKNOWN,
15 	STACK_TYPE_TASK,
16 	STACK_TYPE_IRQ,
17 	STACK_TYPE_SOFTIRQ,
18 	STACK_TYPE_EXCEPTION,
19 	STACK_TYPE_EXCEPTION_LAST = STACK_TYPE_EXCEPTION + N_EXCEPTION_STACKS-1,
20 };
21 
22 struct stack_info {
23 	enum stack_type type;
24 	unsigned long *begin, *end, *next_sp;
25 };
26 
27 bool in_task_stack(unsigned long *stack, struct task_struct *task,
28 		   struct stack_info *info);
29 
30 int get_stack_info(unsigned long *stack, struct task_struct *task,
31 		   struct stack_info *info, unsigned long *visit_mask);
32 
33 void stack_type_str(enum stack_type type, const char **begin,
34 		    const char **end);
35 
36 static inline bool on_stack(struct stack_info *info, void *addr, size_t len)
37 {
38 	void *begin = info->begin;
39 	void *end   = info->end;
40 
41 	return (info->type != STACK_TYPE_UNKNOWN &&
42 		addr >= begin && addr < end &&
43 		addr + len > begin && addr + len <= end);
44 }
45 
46 extern int kstack_depth_to_print;
47 
48 struct thread_info;
49 struct stacktrace_ops;
50 
51 typedef unsigned long (*walk_stack_t)(struct task_struct *task,
52 				      unsigned long *stack,
53 				      unsigned long bp,
54 				      const struct stacktrace_ops *ops,
55 				      void *data,
56 				      struct stack_info *info,
57 				      int *graph);
58 
59 extern unsigned long
60 print_context_stack(struct task_struct *task,
61 		    unsigned long *stack, unsigned long bp,
62 		    const struct stacktrace_ops *ops, void *data,
63 		    struct stack_info *info, int *graph);
64 
65 extern unsigned long
66 print_context_stack_bp(struct task_struct *task,
67 		       unsigned long *stack, unsigned long bp,
68 		       const struct stacktrace_ops *ops, void *data,
69 		       struct stack_info *info, int *graph);
70 
71 /* Generic stack tracer with callbacks */
72 
73 struct stacktrace_ops {
74 	int (*address)(void *data, unsigned long address, int reliable);
75 	/* On negative return stop dumping */
76 	int (*stack)(void *data, const char *name);
77 	walk_stack_t	walk_stack;
78 };
79 
80 void dump_trace(struct task_struct *tsk, struct pt_regs *regs,
81 		unsigned long *stack, unsigned long bp,
82 		const struct stacktrace_ops *ops, void *data);
83 
84 #ifdef CONFIG_X86_32
85 #define STACKSLOTS_PER_LINE 8
86 #else
87 #define STACKSLOTS_PER_LINE 4
88 #endif
89 
90 #ifdef CONFIG_FRAME_POINTER
91 static inline unsigned long *
92 get_frame_pointer(struct task_struct *task, struct pt_regs *regs)
93 {
94 	if (regs)
95 		return (unsigned long *)regs->bp;
96 
97 	if (task == current)
98 		return __builtin_frame_address(0);
99 
100 	return (unsigned long *)((struct inactive_task_frame *)task->thread.sp)->bp;
101 }
102 #else
103 static inline unsigned long *
104 get_frame_pointer(struct task_struct *task, struct pt_regs *regs)
105 {
106 	return NULL;
107 }
108 #endif /* CONFIG_FRAME_POINTER */
109 
110 static inline unsigned long *
111 get_stack_pointer(struct task_struct *task, struct pt_regs *regs)
112 {
113 	if (regs)
114 		return (unsigned long *)kernel_stack_pointer(regs);
115 
116 	if (task == current)
117 		return __builtin_frame_address(0);
118 
119 	return (unsigned long *)task->thread.sp;
120 }
121 
122 void show_trace_log_lvl(struct task_struct *task, struct pt_regs *regs,
123 			unsigned long *stack, char *log_lvl);
124 
125 void show_stack_log_lvl(struct task_struct *task, struct pt_regs *regs,
126 			unsigned long *sp, char *log_lvl);
127 
128 extern unsigned int code_bytes;
129 
130 /* The form of the top of the frame on the stack */
131 struct stack_frame {
132 	struct stack_frame *next_frame;
133 	unsigned long return_address;
134 };
135 
136 struct stack_frame_ia32 {
137     u32 next_frame;
138     u32 return_address;
139 };
140 
141 static inline unsigned long caller_frame_pointer(void)
142 {
143 	struct stack_frame *frame;
144 
145 	frame = __builtin_frame_address(0);
146 
147 #ifdef CONFIG_FRAME_POINTER
148 	frame = frame->next_frame;
149 #endif
150 
151 	return (unsigned long)frame;
152 }
153 
154 #endif /* _ASM_X86_STACKTRACE_H */
155