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 32 void GetStackTrace(BufferedStackTrace *stack, uptr max_depth, uptr pc, uptr bp, 33 void *context, bool fast) { 34 #if SANITIZER_WINDOWS 35 stack->Unwind(max_depth, pc, bp, context, 0, 0, fast); 36 #else 37 AsanThread *t; 38 stack->size = 0; 39 if (LIKELY(asan_inited)) { 40 if ((t = GetCurrentThread()) && !t->isUnwinding()) { 41 // On FreeBSD the slow unwinding that leverages _Unwind_Backtrace() 42 // yields the call stack of the signal's handler and not of the code 43 // that raised the signal (as it does on Linux). 44 //if ((SANITIZER_NETBSD || SANITIZER_FREEBSD) && t->isInDeadlySignal()) fast = true; 45 uptr stack_top = t->stack_top(); 46 uptr stack_bottom = t->stack_bottom(); 47 ScopedUnwinding unwind_scope(t); 48 if (!SANITIZER_MIPS || IsValidFrame(bp, stack_top, stack_bottom)) { 49 stack->Unwind(max_depth, pc, bp, context, stack_top, stack_bottom, 50 fast); 51 } 52 } else if (!t && !fast) { 53 /* If GetCurrentThread() has failed, try to do slow unwind anyways. */ 54 stack->Unwind(max_depth, pc, bp, context, 0, 0, false); 55 } 56 } 57 #endif // SANITIZER_WINDOWS 58 } 59 60 } // namespace __asan 61 62 // NOTE: A Rule of thumb is to retrieve stack trace in the interceptors 63 // as early as possible (in functions exposed to the user), as we generally 64 // don't want stack trace to contain functions from ASan internals. 65 66 #define GET_STACK_TRACE(max_size, fast) \ 67 BufferedStackTrace stack; \ 68 if (max_size <= 2) { \ 69 stack.size = max_size; \ 70 if (max_size > 0) { \ 71 stack.top_frame_bp = GET_CURRENT_FRAME(); \ 72 stack.trace_buffer[0] = StackTrace::GetCurrentPc(); \ 73 if (max_size > 1) stack.trace_buffer[1] = GET_CALLER_PC(); \ 74 } \ 75 } else { \ 76 GetStackTrace(&stack, max_size, StackTrace::GetCurrentPc(), \ 77 GET_CURRENT_FRAME(), 0, fast); \ 78 } 79 80 #define GET_STACK_TRACE_FATAL(pc, bp) \ 81 BufferedStackTrace stack; \ 82 GetStackTrace(&stack, kStackTraceMax, pc, bp, 0, \ 83 common_flags()->fast_unwind_on_fatal) 84 85 #define GET_STACK_TRACE_SIGNAL(sig) \ 86 BufferedStackTrace stack; \ 87 GetStackTrace(&stack, kStackTraceMax, (sig).pc, (sig).bp, (sig).context, \ 88 common_flags()->fast_unwind_on_fatal) 89 90 #define GET_STACK_TRACE_FATAL_HERE \ 91 GET_STACK_TRACE(kStackTraceMax, common_flags()->fast_unwind_on_fatal) 92 93 #define GET_STACK_TRACE_CHECK_HERE \ 94 GET_STACK_TRACE(kStackTraceMax, common_flags()->fast_unwind_on_check) 95 96 #define GET_STACK_TRACE_THREAD \ 97 GET_STACK_TRACE(kStackTraceMax, true) 98 99 #define GET_STACK_TRACE_MALLOC \ 100 GET_STACK_TRACE(GetMallocContextSize(), common_flags()->fast_unwind_on_malloc) 101 102 #define GET_STACK_TRACE_FREE GET_STACK_TRACE_MALLOC 103 104 #define PRINT_CURRENT_STACK() \ 105 { \ 106 GET_STACK_TRACE_FATAL_HERE; \ 107 stack.Print(); \ 108 } 109 110 #define PRINT_CURRENT_STACK_CHECK() \ 111 { \ 112 GET_STACK_TRACE_CHECK_HERE; \ 113 stack.Print(); \ 114 } 115 116 #endif // ASAN_STACK_H 117