asan_internal.h revision c93d3e2bdfb1ad9cce26a6e8d66764ed97a6d6b4 
1//===-- asan_internal.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 a part of AddressSanitizer, an address sanity checker.
11//
12// ASan-private header which defines various general utilities.
13//===----------------------------------------------------------------------===//
14#ifndef ASAN_INTERNAL_H
15#define ASAN_INTERNAL_H
16
17#include "asan_flags.h"
18#include "sanitizer_common/sanitizer_common.h"
19#include "sanitizer_common/sanitizer_internal_defs.h"
20#include "sanitizer_common/sanitizer_libc.h"
21
22#if !defined(__linux__) && !defined(__APPLE__) && !defined(_WIN32)
23# error "This operating system is not supported by AddressSanitizer"
24#endif
25
26#if defined(_WIN32)
27extern "C" void* _ReturnAddress(void);
28# pragma intrinsic(_ReturnAddress)
29#endif  // defined(_WIN32)
30
31#define ASAN_DEFAULT_FAILURE_EXITCODE 1
32
33#if defined(__linux__)
34# define ASAN_LINUX   1
35#else
36# define ASAN_LINUX   0
37#endif
38
39#if defined(__APPLE__)
40# define ASAN_MAC     1
41#else
42# define ASAN_MAC     0
43#endif
44
45#if defined(_WIN32)
46# define ASAN_WINDOWS 1
47#else
48# define ASAN_WINDOWS 0
49#endif
50
51#define ASAN_POSIX (ASAN_LINUX || ASAN_MAC)
52
53#if __has_feature(address_sanitizer)
54# error "The AddressSanitizer run-time should not be"
55        " instrumented by AddressSanitizer"
56#endif
57
58// Build-time configuration options.
59
60// If set, asan will install its own SEGV signal handler.
61#ifndef ASAN_NEEDS_SEGV
62# define ASAN_NEEDS_SEGV 1
63#endif
64
65// If set, asan will intercept C++ exception api call(s).
66#ifndef ASAN_HAS_EXCEPTIONS
67# define ASAN_HAS_EXCEPTIONS 1
68#endif
69
70// If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET
71// provided by the instrumented objects. Otherwise constants are used.
72#ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET
73# define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0
74#endif
75
76// If set, values like allocator chunk size, as well as defaults for some flags
77// will be changed towards less memory overhead.
78#ifndef ASAN_LOW_MEMORY
79# define ASAN_LOW_MEMORY 0
80#endif
81
82// All internal functions in asan reside inside the __asan namespace
83// to avoid namespace collisions with the user programs.
84// Seperate namespace also makes it simpler to distinguish the asan run-time
85// functions from the instrumented user code in a profile.
86namespace __asan {
87
88class AsanThread;
89struct AsanStackTrace;
90
91// asan_rtl.cc
92void NORETURN ShowStatsAndAbort();
93
94void ReplaceOperatorsNewAndDelete();
95// asan_malloc_linux.cc / asan_malloc_mac.cc
96void ReplaceSystemMalloc();
97
98// asan_linux.cc / asan_mac.cc / asan_win.cc
99void *AsanDoesNotSupportStaticLinkage();
100
101void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp);
102
103bool AsanInterceptsSignal(int signum);
104void SetAlternateSignalStack();
105void UnsetAlternateSignalStack();
106void InstallSignalHandlers();
107void AsanPlatformThreadInit();
108
109// Wrapper for TLS/TSD.
110void AsanTSDInit(void (*destructor)(void *tsd));
111void *AsanTSDGet();
112void AsanTSDSet(void *tsd);
113
114void AppendToErrorMessageBuffer(const char *buffer);
115// asan_printf.cc
116void AsanPrintf(const char *format, ...);
117void AsanReport(const char *format, ...);
118
119// asan_poisoning.cc
120// Poisons the shadow memory for "size" bytes starting from "addr".
121void PoisonShadow(uptr addr, uptr size, u8 value);
122// Poisons the shadow memory for "redzone_size" bytes starting from
123// "addr + size".
124void PoisonShadowPartialRightRedzone(uptr addr,
125                                     uptr size,
126                                     uptr redzone_size,
127                                     u8 value);
128
129// Platfrom-specific options.
130#ifdef __APPLE__
131bool PlatformHasDifferentMemcpyAndMemmove();
132# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \
133    (PlatformHasDifferentMemcpyAndMemmove())
134#else
135# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true
136#endif  // __APPLE__
137
138extern int asan_inited;
139// Used to avoid infinite recursion in __asan_init().
140extern bool asan_init_is_running;
141extern void (*death_callback)(void);
142
143enum LinkerInitialized { LINKER_INITIALIZED = 0 };
144
145#define ASAN_ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
146
147#if !defined(_WIN32) || defined(__clang__)
148# define GET_CALLER_PC() (uptr)__builtin_return_address(0)
149# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0)
150#else
151# define GET_CALLER_PC() (uptr)_ReturnAddress()
152// CaptureStackBackTrace doesn't need to know BP on Windows.
153// FIXME: This macro is still used when printing error reports though it's not
154// clear if the BP value is needed in the ASan reports on Windows.
155# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF
156#endif
157
158#ifdef _WIN32
159bool WinSymbolize(const void *addr, char *out_buffer, int buffer_size);
160#endif  // _WIN32
161
162// These magic values are written to shadow for better error reporting.
163const int kAsanHeapLeftRedzoneMagic = 0xfa;
164const int kAsanHeapRightRedzoneMagic = 0xfb;
165const int kAsanHeapFreeMagic = 0xfd;
166const int kAsanStackLeftRedzoneMagic = 0xf1;
167const int kAsanStackMidRedzoneMagic = 0xf2;
168const int kAsanStackRightRedzoneMagic = 0xf3;
169const int kAsanStackPartialRedzoneMagic = 0xf4;
170const int kAsanStackAfterReturnMagic = 0xf5;
171const int kAsanInitializationOrderMagic = 0xf6;
172const int kAsanUserPoisonedMemoryMagic = 0xf7;
173const int kAsanGlobalRedzoneMagic = 0xf9;
174const int kAsanInternalHeapMagic = 0xfe;
175
176static const uptr kCurrentStackFrameMagic = 0x41B58AB3;
177static const uptr kRetiredStackFrameMagic = 0x45E0360E;
178
179// -------------------------- LowLevelAllocator ----- {{{1
180// A simple low-level memory allocator for internal use.
181class LowLevelAllocator {
182 public:
183  explicit LowLevelAllocator(LinkerInitialized) {}
184  // 'size' must be a power of two.
185  // Requires an external lock.
186  void *Allocate(uptr size);
187 private:
188  char *allocated_end_;
189  char *allocated_current_;
190};
191
192}  // namespace __asan
193
194#endif  // ASAN_INTERNAL_H
195