arch/x86/include/asm/stacktrace.h

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