forked from OSchip/llvm-project
137 lines
4.2 KiB
C++
137 lines
4.2 KiB
C++
//===-- sanitizer_stacktrace.h ----------------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file is shared between AddressSanitizer and ThreadSanitizer
|
|
// run-time libraries.
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef SANITIZER_STACKTRACE_H
|
|
#define SANITIZER_STACKTRACE_H
|
|
|
|
#include "sanitizer_internal_defs.h"
|
|
|
|
namespace __sanitizer {
|
|
|
|
static const u32 kStackTraceMax = 256;
|
|
|
|
#if SANITIZER_LINUX && (defined(__sparc__) || defined(__mips__))
|
|
# define SANITIZER_CAN_FAST_UNWIND 0
|
|
#elif SANITIZER_WINDOWS
|
|
# define SANITIZER_CAN_FAST_UNWIND 0
|
|
#else
|
|
# define SANITIZER_CAN_FAST_UNWIND 1
|
|
#endif
|
|
|
|
// Fast unwind is the only option on Mac for now; we will need to
|
|
// revisit this macro when slow unwind works on Mac, see
|
|
// https://code.google.com/p/address-sanitizer/issues/detail?id=137
|
|
#if SANITIZER_MAC
|
|
# define SANITIZER_CAN_SLOW_UNWIND 0
|
|
#else
|
|
# define SANITIZER_CAN_SLOW_UNWIND 1
|
|
#endif
|
|
|
|
struct StackTrace {
|
|
const uptr *trace;
|
|
u32 size;
|
|
u32 tag;
|
|
|
|
static const int TAG_UNKNOWN = 0;
|
|
static const int TAG_ALLOC = 1;
|
|
static const int TAG_DEALLOC = 2;
|
|
static const int TAG_CUSTOM = 100; // Tool specific tags start here.
|
|
|
|
StackTrace() : trace(nullptr), size(0), tag(0) {}
|
|
StackTrace(const uptr *trace, u32 size) : trace(trace), size(size), tag(0) {}
|
|
StackTrace(const uptr *trace, u32 size, u32 tag)
|
|
: trace(trace), size(size), tag(tag) {}
|
|
|
|
// Prints a symbolized stacktrace, followed by an empty line.
|
|
void Print() const;
|
|
|
|
static bool WillUseFastUnwind(bool request_fast_unwind) {
|
|
if (!SANITIZER_CAN_FAST_UNWIND)
|
|
return false;
|
|
else if (!SANITIZER_CAN_SLOW_UNWIND)
|
|
return true;
|
|
return request_fast_unwind;
|
|
}
|
|
|
|
static uptr GetCurrentPc();
|
|
static inline uptr GetPreviousInstructionPc(uptr pc);
|
|
static uptr GetNextInstructionPc(uptr pc);
|
|
typedef bool (*SymbolizeCallback)(const void *pc, char *out_buffer,
|
|
int out_size);
|
|
};
|
|
|
|
// Performance-critical, must be in the header.
|
|
ALWAYS_INLINE
|
|
uptr StackTrace::GetPreviousInstructionPc(uptr pc) {
|
|
#if defined(__arm__)
|
|
// Cancel Thumb bit.
|
|
pc = pc & (~1);
|
|
#endif
|
|
#if defined(__powerpc__) || defined(__powerpc64__)
|
|
// PCs are always 4 byte aligned.
|
|
return pc - 4;
|
|
#elif defined(__sparc__) || defined(__mips__)
|
|
return pc - 8;
|
|
#else
|
|
return pc - 1;
|
|
#endif
|
|
}
|
|
|
|
// StackTrace that owns the buffer used to store the addresses.
|
|
struct BufferedStackTrace : public StackTrace {
|
|
uptr trace_buffer[kStackTraceMax];
|
|
uptr top_frame_bp; // Optional bp of a top frame.
|
|
|
|
BufferedStackTrace() : StackTrace(trace_buffer, 0), top_frame_bp(0) {}
|
|
|
|
void Init(const uptr *pcs, uptr cnt, uptr extra_top_pc = 0);
|
|
void Unwind(u32 max_depth, uptr pc, uptr bp, void *context, uptr stack_top,
|
|
uptr stack_bottom, bool request_fast_unwind);
|
|
|
|
private:
|
|
void FastUnwindStack(uptr pc, uptr bp, uptr stack_top, uptr stack_bottom,
|
|
u32 max_depth);
|
|
void SlowUnwindStack(uptr pc, u32 max_depth);
|
|
void SlowUnwindStackWithContext(uptr pc, void *context,
|
|
u32 max_depth);
|
|
void PopStackFrames(uptr count);
|
|
uptr LocatePcInTrace(uptr pc);
|
|
|
|
BufferedStackTrace(const BufferedStackTrace &);
|
|
void operator=(const BufferedStackTrace &);
|
|
};
|
|
|
|
} // namespace __sanitizer
|
|
|
|
// Use this macro if you want to print stack trace with the caller
|
|
// of the current function in the top frame.
|
|
#define GET_CALLER_PC_BP_SP \
|
|
uptr bp = GET_CURRENT_FRAME(); \
|
|
uptr pc = GET_CALLER_PC(); \
|
|
uptr local_stack; \
|
|
uptr sp = (uptr)&local_stack
|
|
|
|
#define GET_CALLER_PC_BP \
|
|
uptr bp = GET_CURRENT_FRAME(); \
|
|
uptr pc = GET_CALLER_PC();
|
|
|
|
// Use this macro if you want to print stack trace with the current
|
|
// function in the top frame.
|
|
#define GET_CURRENT_PC_BP_SP \
|
|
uptr bp = GET_CURRENT_FRAME(); \
|
|
uptr pc = StackTrace::GetCurrentPc(); \
|
|
uptr local_stack; \
|
|
uptr sp = (uptr)&local_stack
|
|
|
|
|
|
#endif // SANITIZER_STACKTRACE_H
|