sanitizer_stacktrace.h revision 7177d2bbb5850fb499d3e8910b2e05f5c6b025b0 
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 size;
37  uptr trace[kStackTraceMax];
38
39  // Prints a symbolized stacktrace, followed by an empty line.
40  static void PrintStack(const uptr *addr, uptr size,
41                         SymbolizeCallback symbolize_callback = 0);
42
43  void CopyFrom(const uptr *src, uptr src_size) {
44    size = src_size;
45    if (size > kStackTraceMax) size = kStackTraceMax;
46    for (uptr i = 0; i < size; i++)
47      trace[i] = src[i];
48  }
49
50  static bool WillUseFastUnwind(bool request_fast_unwind) {
51    // Check if fast unwind is available. Fast unwind is the only option on Mac.
52    if (!SANITIZER_CAN_FAST_UNWIND)
53      return false;
54    else if (SANITIZER_MAC)
55      return true;
56    return request_fast_unwind;
57  }
58
59  void Unwind(uptr max_depth, uptr pc, uptr bp, uptr stack_top,
60              uptr stack_bottom, bool request_fast_unwind);
61
62  static uptr GetCurrentPc();
63  static uptr GetPreviousInstructionPc(uptr pc);
64
65 private:
66  void FastUnwindStack(uptr pc, uptr bp, uptr stack_top, uptr stack_bottom,
67                       uptr max_depth);
68  void SlowUnwindStack(uptr pc, uptr max_depth);
69  void PopStackFrames(uptr count);
70  uptr LocatePcInTrace(uptr pc, uptr pc_threshold = 0, uptr max_pc_depth = -1);
71};
72
73}  // namespace __sanitizer
74
75// Use this macro if you want to print stack trace with the caller
76// of the current function in the top frame.
77#define GET_CALLER_PC_BP_SP \
78  uptr bp = GET_CURRENT_FRAME();              \
79  uptr pc = GET_CALLER_PC();                  \
80  uptr local_stack;                           \
81  uptr sp = (uptr)&local_stack
82
83// Use this macro if you want to print stack trace with the current
84// function in the top frame.
85#define GET_CURRENT_PC_BP_SP \
86  uptr bp = GET_CURRENT_FRAME();              \
87  uptr pc = StackTrace::GetCurrentPc();   \
88  uptr local_stack;                           \
89  uptr sp = (uptr)&local_stack
90
91
92#endif  // SANITIZER_STACKTRACE_H
93