sanitizer_stacktrace.h revision 1b17f5b79d58c5aff291dde05727ad0b215b81c6 
1//===-- sanitizer_stacktrace.h ----------------------------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file is shared between AddressSanitizer and ThreadSanitizer
11// run-time libraries.
12//===----------------------------------------------------------------------===//
13#ifndef SANITIZER_STACKTRACE_H
14#define SANITIZER_STACKTRACE_H
15
16#include "sanitizer_internal_defs.h"
17
18namespace __sanitizer {
19
20static const uptr kStackTraceMax = 256;
21
22#if SANITIZER_LINUX && (defined(__arm__) || \
23    defined(__powerpc__) || defined(__powerpc64__) || \
24    defined(__sparc__) || \
25    defined(__mips__))
26# define SANITIZER_CAN_FAST_UNWIND 0
27#elif SANITIZER_WINDOWS
28# define SANITIZER_CAN_FAST_UNWIND 0
29#else
30# define SANITIZER_CAN_FAST_UNWIND 1
31#endif
32
33struct StackTrace {
34  typedef bool (*SymbolizeCallback)(const void *pc, char *out_buffer,
35                                     int out_size);
36  uptr top_frame_bp;
37  uptr size;
38  uptr trace[kStackTraceMax];
39
40  // Prints a symbolized stacktrace, followed by an empty line.
41  static void PrintStack(const uptr *addr, uptr size,
42                         SymbolizeCallback symbolize_callback = 0);
43
44  void CopyFrom(const uptr *src, uptr src_size) {
45    top_frame_bp = 0;
46    size = src_size;
47    if (size > kStackTraceMax) size = kStackTraceMax;
48    for (uptr i = 0; i < size; i++)
49      trace[i] = src[i];
50  }
51
52  static bool WillUseFastUnwind(bool request_fast_unwind) {
53    // Check if fast unwind is available. Fast unwind is the only option on Mac.
54    if (!SANITIZER_CAN_FAST_UNWIND)
55      return false;
56    else if (SANITIZER_MAC)
57      return true;
58    return request_fast_unwind;
59  }
60
61  void Unwind(uptr max_depth, uptr pc, uptr bp, uptr stack_top,
62              uptr stack_bottom, bool request_fast_unwind);
63
64  static uptr GetCurrentPc();
65  static uptr GetPreviousInstructionPc(uptr pc);
66
67 private:
68  void FastUnwindStack(uptr pc, uptr bp, uptr stack_top, uptr stack_bottom,
69                       uptr max_depth);
70  void SlowUnwindStack(uptr pc, uptr max_depth);
71  void PopStackFrames(uptr count);
72  uptr LocatePcInTrace(uptr pc, uptr pc_threshold = 0, uptr max_pc_depth = -1);
73};
74
75}  // namespace __sanitizer
76
77// Use this macro if you want to print stack trace with the caller
78// of the current function in the top frame.
79#define GET_CALLER_PC_BP_SP \
80  uptr bp = GET_CURRENT_FRAME();              \
81  uptr pc = GET_CALLER_PC();                  \
82  uptr local_stack;                           \
83  uptr sp = (uptr)&local_stack
84
85// Use this macro if you want to print stack trace with the current
86// function in the top frame.
87#define GET_CURRENT_PC_BP_SP \
88  uptr bp = GET_CURRENT_FRAME();              \
89  uptr pc = StackTrace::GetCurrentPc();   \
90  uptr local_stack;                           \
91  uptr sp = (uptr)&local_stack
92
93
94#endif  // SANITIZER_STACKTRACE_H
95