1 //===-- asan_stack.h --------------------------------------------*- C++ -*-===//
2 //
3 // This file is distributed under the University of Illinois Open Source
4 // License. See LICENSE.TXT for details.
5 //
6 //===----------------------------------------------------------------------===//
7 //
8 // This file is a part of AddressSanitizer, an address sanity checker.
9 //
10 // ASan-private header for asan_stack.cc.
11 //===----------------------------------------------------------------------===//
12
13 #ifndef ASAN_STACK_H
14 #define ASAN_STACK_H
15
16 #include "asan_flags.h"
17 #include "asan_thread.h"
18 #include "sanitizer_common/sanitizer_flags.h"
19 #include "sanitizer_common/sanitizer_stacktrace.h"
20
21 namespace __asan {
22
23 static const u32 kDefaultMallocContextSize = 30;
24
25 void SetMallocContextSize(u32 size);
26 u32 GetMallocContextSize();
27
28 // Get the stack trace with the given pc and bp.
29 // The pc will be in the position 0 of the resulting stack trace.
30 // The bp may refer to the current frame or to the caller's frame.
31 ALWAYS_INLINE
GetStackTraceWithPcBpAndContext(BufferedStackTrace * stack,uptr max_depth,uptr pc,uptr bp,void * context,bool fast)32 void GetStackTraceWithPcBpAndContext(BufferedStackTrace *stack, uptr max_depth,
33 uptr pc, uptr bp, void *context,
34 bool fast) {
35 #if SANITIZER_WINDOWS
36 stack->Unwind(max_depth, pc, bp, context, 0, 0, fast);
37 #else
38 AsanThread *t;
39 stack->size = 0;
40 if (LIKELY(asan_inited)) {
41 if ((t = GetCurrentThread()) && !t->isUnwinding()) {
42 // On FreeBSD the slow unwinding that leverages _Unwind_Backtrace()
43 // yields the call stack of the signal's handler and not of the code
44 // that raised the signal (as it does on Linux).
45 if (SANITIZER_FREEBSD && t->isInDeadlySignal()) fast = true;
46 uptr stack_top = t->stack_top();
47 uptr stack_bottom = t->stack_bottom();
48 ScopedUnwinding unwind_scope(t);
49 stack->Unwind(max_depth, pc, bp, context, stack_top, stack_bottom, fast);
50 } else if (!t && !fast) {
51 /* If GetCurrentThread() has failed, try to do slow unwind anyways. */
52 stack->Unwind(max_depth, pc, bp, context, 0, 0, false);
53 }
54 }
55 #endif // SANITIZER_WINDOWS
56 }
57
58 } // namespace __asan
59
60 // NOTE: A Rule of thumb is to retrieve stack trace in the interceptors
61 // as early as possible (in functions exposed to the user), as we generally
62 // don't want stack trace to contain functions from ASan internals.
63
64 #define GET_STACK_TRACE(max_size, fast) \
65 BufferedStackTrace stack; \
66 if (max_size <= 2) { \
67 stack.size = max_size; \
68 if (max_size > 0) { \
69 stack.top_frame_bp = GET_CURRENT_FRAME(); \
70 stack.trace_buffer[0] = StackTrace::GetCurrentPc(); \
71 if (max_size > 1) \
72 stack.trace_buffer[1] = GET_CALLER_PC(); \
73 } \
74 } else { \
75 GetStackTraceWithPcBpAndContext(&stack, max_size, \
76 StackTrace::GetCurrentPc(), \
77 GET_CURRENT_FRAME(), 0, fast); \
78 }
79
80 #define GET_STACK_TRACE_FATAL(pc, bp) \
81 BufferedStackTrace stack; \
82 GetStackTraceWithPcBpAndContext(&stack, kStackTraceMax, pc, bp, 0, \
83 common_flags()->fast_unwind_on_fatal)
84
85 #define GET_STACK_TRACE_SIGNAL(sig) \
86 BufferedStackTrace stack; \
87 GetStackTraceWithPcBpAndContext(&stack, kStackTraceMax, \
88 (sig).pc, (sig).bp, (sig).context, \
89 common_flags()->fast_unwind_on_fatal)
90
91 #define GET_STACK_TRACE_FATAL_HERE \
92 GET_STACK_TRACE(kStackTraceMax, common_flags()->fast_unwind_on_fatal)
93
94 #define GET_STACK_TRACE_CHECK_HERE \
95 GET_STACK_TRACE(kStackTraceMax, common_flags()->fast_unwind_on_check)
96
97 #define GET_STACK_TRACE_THREAD \
98 GET_STACK_TRACE(kStackTraceMax, true)
99
100 #define GET_STACK_TRACE_MALLOC \
101 GET_STACK_TRACE(GetMallocContextSize(), common_flags()->fast_unwind_on_malloc)
102
103 #define GET_STACK_TRACE_FREE GET_STACK_TRACE_MALLOC
104
105 #define PRINT_CURRENT_STACK() \
106 { \
107 GET_STACK_TRACE_FATAL_HERE; \
108 stack.Print(); \
109 }
110
111 #define PRINT_CURRENT_STACK_CHECK() \
112 { \
113 GET_STACK_TRACE_CHECK_HERE; \
114 stack.Print(); \
115 }
116
117 #endif // ASAN_STACK_H
118