asan_internal.h revision 15a77612e0a89c1df444a2034e531c8968d0cedf 
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 "sanitizer_common/sanitizer_common.h"
18#include "sanitizer_common/sanitizer_internal_defs.h"
19#include "sanitizer_common/sanitizer_libc.h"
20
21#if !defined(__linux__) && !defined(__APPLE__) && !defined(_WIN32)
22# error "This operating system is not supported by AddressSanitizer"
23#endif
24
25#if defined(_WIN32)
26extern "C" void* _ReturnAddress(void);
27# pragma intrinsic(_ReturnAddress)
28#endif  // defined(_WIN32)
29
30// Limits for integral types. We have to redefine it in case we don't
31// have stdint.h (like in Visual Studio 9).
32#if __WORDSIZE == 64
33# define __INT64_C(c)  c ## L
34# define __UINT64_C(c) c ## UL
35#else
36# define __INT64_C(c)  c ## LL
37# define __UINT64_C(c) c ## ULL
38#endif  // __WORDSIZE == 64
39#undef INT32_MIN
40#define INT32_MIN              (-2147483647-1)
41#undef INT32_MAX
42#define INT32_MAX              (2147483647)
43#undef UINT32_MAX
44#define UINT32_MAX             (4294967295U)
45#undef INT64_MIN
46#define INT64_MIN              (-__INT64_C(9223372036854775807)-1)
47#undef INT64_MAX
48#define INT64_MAX              (__INT64_C(9223372036854775807))
49#undef UINT64_MAX
50#define UINT64_MAX             (__UINT64_C(18446744073709551615))
51
52#define ASAN_DEFAULT_FAILURE_EXITCODE 1
53
54#if defined(__linux__)
55# define ASAN_LINUX   1
56#else
57# define ASAN_LINUX   0
58#endif
59
60#if defined(__APPLE__)
61# define ASAN_MAC     1
62#else
63# define ASAN_MAC     0
64#endif
65
66#if defined(_WIN32)
67# define ASAN_WINDOWS 1
68#else
69# define ASAN_WINDOWS 0
70#endif
71
72#define ASAN_POSIX (ASAN_LINUX || ASAN_MAC)
73
74#if __has_feature(address_sanitizer)
75# error "The AddressSanitizer run-time should not be"
76        " instrumented by AddressSanitizer"
77#endif
78
79// Build-time configuration options.
80
81// If set, asan will install its own SEGV signal handler.
82#ifndef ASAN_NEEDS_SEGV
83# define ASAN_NEEDS_SEGV 1
84#endif
85
86// If set, asan will intercept C++ exception api call(s).
87#ifndef ASAN_HAS_EXCEPTIONS
88# define ASAN_HAS_EXCEPTIONS 1
89#endif
90
91// If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET
92// provided by the instrumented objects. Otherwise constants are used.
93#ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET
94# define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0
95#endif
96
97// If set, values like allocator chunk size, as well as defaults for some flags
98// will be changed towards less memory overhead.
99#ifndef ASAN_LOW_MEMORY
100# define ASAN_LOW_MEMORY 0
101#endif
102
103// All internal functions in asan reside inside the __asan namespace
104// to avoid namespace collisions with the user programs.
105// Seperate namespace also makes it simpler to distinguish the asan run-time
106// functions from the instrumented user code in a profile.
107namespace __asan {
108
109class AsanThread;
110struct AsanStackTrace;
111
112// asan_rtl.cc
113void NORETURN ShowStatsAndAbort();
114
115// asan_globals.cc
116bool DescribeAddrIfGlobal(uptr addr);
117
118void ReplaceOperatorsNewAndDelete();
119// asan_malloc_linux.cc / asan_malloc_mac.cc
120void ReplaceSystemMalloc();
121
122void OutOfMemoryMessageAndDie(const char *mem_type, uptr size);
123
124// asan_linux.cc / asan_mac.cc / asan_win.cc
125void *AsanDoesNotSupportStaticLinkage();
126bool AsanShadowRangeIsAvailable();
127const char *AsanGetEnv(const char *name);
128void AsanDumpProcessMap();
129
130void *AsanMmapFixedNoReserve(uptr fixed_addr, uptr size);
131void *AsanMmapFixedReserve(uptr fixed_addr, uptr size);
132void *AsanMprotect(uptr fixed_addr, uptr size);
133void *AsanMmapSomewhereOrDie(uptr size, const char *where);
134void AsanUnmapOrDie(void *ptr, uptr size);
135
136void AsanDisableCoreDumper();
137void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp);
138
139bool AsanInterceptsSignal(int signum);
140void SetAlternateSignalStack();
141void UnsetAlternateSignalStack();
142void InstallSignalHandlers();
143uptr GetThreadSelf();
144int AtomicInc(int *a);
145u16 AtomicExchange(u16 *a, u16 new_val);
146u8 AtomicExchange(u8 *a, u8 new_val);
147
148// Wrapper for TLS/TSD.
149void AsanTSDInit(void (*destructor)(void *tsd));
150void *AsanTSDGet();
151void AsanTSDSet(void *tsd);
152
153// Opens the file 'file_name" and reads up to 'max_len' bytes.
154// The resulting buffer is mmaped and stored in '*buff'.
155// The size of the mmaped region is stored in '*buff_size',
156// Returns the number of read bytes or 0 if file can not be opened.
157uptr ReadFileToBuffer(const char *file_name, char **buff,
158                        uptr *buff_size, uptr max_len);
159
160void AppendToErrorMessageBuffer(const char *buffer);
161// asan_printf.cc
162void AsanPrintf(const char *format, ...);
163void AsanReport(const char *format, ...);
164
165// Don't use std::min and std::max, to minimize dependency on libstdc++.
166template<class T> T Min(T a, T b) { return a < b ? a : b; }
167template<class T> T Max(T a, T b) { return a > b ? a : b; }
168
169void SortArray(uptr *array, uptr size);
170
171// asan_poisoning.cc
172// Poisons the shadow memory for "size" bytes starting from "addr".
173void PoisonShadow(uptr addr, uptr size, u8 value);
174// Poisons the shadow memory for "redzone_size" bytes starting from
175// "addr + size".
176void PoisonShadowPartialRightRedzone(uptr addr,
177                                     uptr size,
178                                     uptr redzone_size,
179                                     u8 value);
180
181// Platfrom-specific options.
182#ifdef __APPLE__
183bool PlatformHasDifferentMemcpyAndMemmove();
184# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \
185    (PlatformHasDifferentMemcpyAndMemmove())
186#else
187# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true
188#endif  // __APPLE__
189
190extern uptr  FLAG_quarantine_size;
191extern s64 FLAG_demangle;
192extern bool    FLAG_symbolize;
193extern s64 FLAG_v;
194extern uptr  FLAG_redzone;
195extern s64 FLAG_debug;
196extern bool    FLAG_poison_shadow;
197extern s64 FLAG_report_globals;
198extern uptr  FLAG_malloc_context_size;
199extern bool    FLAG_replace_str;
200extern bool    FLAG_replace_intrin;
201extern bool    FLAG_replace_cfallocator;
202extern bool    FLAG_fast_unwind;
203extern bool    FLAG_use_fake_stack;
204extern uptr  FLAG_max_malloc_fill_size;
205extern s64 FLAG_exitcode;
206extern bool    FLAG_allow_user_poisoning;
207extern s64 FLAG_sleep_before_dying;
208extern bool    FLAG_handle_segv;
209extern bool    FLAG_use_sigaltstack;
210extern bool    FLAG_check_malloc_usable_size;
211extern bool    FLAG_unmap_shadow_on_exit;
212extern bool    FLAG_abort_on_error;
213
214extern int asan_inited;
215// Used to avoid infinite recursion in __asan_init().
216extern bool asan_init_is_running;
217extern void (*death_callback)(void);
218
219enum LinkerInitialized { LINKER_INITIALIZED = 0 };
220
221void SleepForSeconds(int seconds);
222void NORETURN Exit(int exitcode);
223void NORETURN Abort();
224int Atexit(void (*function)(void));
225
226#define UNIMPLEMENTED() CHECK("unimplemented" && 0)
227
228#define ASAN_ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
229
230#if !defined(_WIN32) || defined(__clang__)
231# define GET_CALLER_PC() (uptr)__builtin_return_address(0)
232# define GET_CURRENT_FRAME() (uptr)__builtin_frame_address(0)
233#else
234# define GET_CALLER_PC() (uptr)_ReturnAddress()
235// CaptureStackBackTrace doesn't need to know BP on Windows.
236// FIXME: This macro is still used when printing error reports though it's not
237// clear if the BP value is needed in the ASan reports on Windows.
238# define GET_CURRENT_FRAME() (uptr)0xDEADBEEF
239#endif
240
241#ifndef _WIN32
242const uptr kMmapGranularity = kPageSize;
243# define THREAD_CALLING_CONV
244typedef void* thread_return_t;
245#else
246const uptr kMmapGranularity = 1UL << 16;
247# define THREAD_CALLING_CONV __stdcall
248typedef DWORD thread_return_t;
249
250# ifndef ASAN_USE_EXTERNAL_SYMBOLIZER
251#  define ASAN_USE_EXTERNAL_SYMBOLIZER __asan_WinSymbolize
252bool __asan_WinSymbolize(const void *addr, char *out_buffer, int buffer_size);
253# endif
254#endif
255
256typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg);
257
258// These magic values are written to shadow for better error reporting.
259const int kAsanHeapLeftRedzoneMagic = 0xfa;
260const int kAsanHeapRightRedzoneMagic = 0xfb;
261const int kAsanHeapFreeMagic = 0xfd;
262const int kAsanStackLeftRedzoneMagic = 0xf1;
263const int kAsanStackMidRedzoneMagic = 0xf2;
264const int kAsanStackRightRedzoneMagic = 0xf3;
265const int kAsanStackPartialRedzoneMagic = 0xf4;
266const int kAsanStackAfterReturnMagic = 0xf5;
267const int kAsanUserPoisonedMemoryMagic = 0xf7;
268const int kAsanGlobalRedzoneMagic = 0xf9;
269const int kAsanInternalHeapMagic = 0xfe;
270
271static const uptr kCurrentStackFrameMagic = 0x41B58AB3;
272static const uptr kRetiredStackFrameMagic = 0x45E0360E;
273
274// -------------------------- LowLevelAllocator ----- {{{1
275// A simple low-level memory allocator for internal use.
276class LowLevelAllocator {
277 public:
278  explicit LowLevelAllocator(LinkerInitialized) {}
279  // 'size' must be a power of two.
280  // Requires an external lock.
281  void *Allocate(uptr size);
282 private:
283  char *allocated_end_;
284  char *allocated_current_;
285};
286
287}  // namespace __asan
288
289#endif  // ASAN_INTERNAL_H
290