asan_internal.h revision f8e6fee734cf5e3d061f576244b2704853148b04 
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#if !defined(__linux__) && !defined(__APPLE__) && !defined(_WIN32)
18# error "This operating system is not supported by AddressSanitizer"
19#endif
20
21#include <stddef.h>  // for size_t, uintptr_t, etc.
22
23#if defined(_WIN32)
24// There's no <stdint.h> in Visual Studio 9, so we have to define [u]int*_t.
25typedef unsigned __int8  uint8_t;
26typedef unsigned __int16 uint16_t;
27typedef unsigned __int32 uint32_t;
28typedef unsigned __int64 uint64_t;
29typedef __int8           int8_t;
30typedef __int16          int16_t;
31typedef __int32          int32_t;
32typedef __int64          int64_t;
33typedef unsigned long    DWORD;  // NOLINT
34
35extern "C" void* _ReturnAddress(void);
36# pragma intrinsic(_ReturnAddress)
37
38# define ALIAS(x)   // TODO(timurrrr): do we need this on Windows?
39# define ALIGNED(x) __declspec(align(x))
40# define NOINLINE __declspec(noinline)
41# define NORETURN __declspec(noreturn)
42
43# define ASAN_INTERFACE_ATTRIBUTE  // TODO(timurrrr): do we need this on Win?
44#else  // defined(_WIN32)
45# include <stdint.h>  // for __WORDSIZE
46
47# define ALIAS(x) __attribute__((alias(x)))
48# define ALIGNED(x) __attribute__((aligned(x)))
49# define NOINLINE __attribute__((noinline))
50# define NORETURN  __attribute__((noreturn))
51
52# define ASAN_INTERFACE_ATTRIBUTE __attribute__((visibility("default")))
53#endif  // defined(_WIN32)
54
55// If __WORDSIZE was undefined by the platform, define it in terms of the
56// compiler built-ins __LP64__ and _WIN64.
57#ifndef __WORDSIZE
58#if __LP64__ || defined(_WIN64)
59#define __WORDSIZE 64
60#else
61#define __WORDSIZE 32
62#endif
63#endif
64
65// Limits for integral types. We have to redefine it in case we don't
66// have stdint.h (like in Visual Studio 9).
67#if __WORDSIZE == 64
68# define __INT64_C(c)  c ## L
69# define __UINT64_C(c) c ## UL
70#else
71# define __INT64_C(c)  c ## LL
72# define __UINT64_C(c) c ## ULL
73#endif  // __WORDSIZE == 64
74#undef INT32_MIN
75#define INT32_MIN              (-2147483647-1)
76#undef INT32_MAX
77#define INT32_MAX              (2147483647)
78#undef UINT32_MAX
79#define UINT32_MAX             (4294967295U)
80#undef INT64_MIN
81#define INT64_MIN              (-__INT64_C(9223372036854775807)-1)
82#undef INT64_MAX
83#define INT64_MAX              (__INT64_C(9223372036854775807))
84#undef UINT64_MAX
85#define UINT64_MAX             (__UINT64_C(18446744073709551615))
86
87#define ASAN_DEFAULT_FAILURE_EXITCODE 1
88
89#if defined(__linux__)
90# define ASAN_LINUX   1
91#else
92# define ASAN_LINUX   0
93#endif
94
95#if defined(__APPLE__)
96# define ASAN_MAC     1
97#else
98# define ASAN_MAC     0
99#endif
100
101#if defined(_WIN32)
102# define ASAN_WINDOWS 1
103#else
104# define ASAN_WINDOWS 0
105#endif
106
107#define ASAN_POSIX (ASAN_LINUX || ASAN_MAC)
108
109#if !defined(__has_feature)
110#define __has_feature(x) 0
111#endif
112
113#if defined(__has_feature) && __has_feature(address_sanitizer)
114# error "The AddressSanitizer run-time should not be"
115        " instrumented by AddressSanitizer"
116#endif
117
118// Build-time configuration options.
119
120// If set, asan will install its own SEGV signal handler.
121#ifndef ASAN_NEEDS_SEGV
122# define ASAN_NEEDS_SEGV 1
123#endif
124
125// If set, asan will intercept C++ exception api call(s).
126#ifndef ASAN_HAS_EXCEPTIONS
127# define ASAN_HAS_EXCEPTIONS 1
128#endif
129
130// If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET
131// provided by the instrumented objects. Otherwise constants are used.
132#ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET
133# define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0
134#endif
135
136// If set, values like allocator chunk size, as well as defaults for some flags
137// will be changed towards less memory overhead.
138#ifndef ASAN_LOW_MEMORY
139# define ASAN_LOW_MEMORY 0
140#endif
141
142// All internal functions in asan reside inside the __asan namespace
143// to avoid namespace collisions with the user programs.
144// Seperate namespace also makes it simpler to distinguish the asan run-time
145// functions from the instrumented user code in a profile.
146namespace __asan {
147
148class AsanThread;
149struct AsanStackTrace;
150
151// asan_rtl.cc
152void NORETURN CheckFailed(const char *cond, const char *file, int line);
153void NORETURN ShowStatsAndAbort();
154
155// asan_globals.cc
156bool DescribeAddrIfGlobal(uintptr_t addr);
157
158// asan_malloc_linux.cc / asan_malloc_mac.cc
159void ReplaceSystemMalloc();
160
161void OutOfMemoryMessageAndDie(const char *mem_type, size_t size);
162
163// asan_linux.cc / asan_mac.cc / asan_win.cc
164void *AsanDoesNotSupportStaticLinkage();
165bool AsanShadowRangeIsAvailable();
166int AsanOpenReadonly(const char* filename);
167const char *AsanGetEnv(const char *name);
168void AsanDumpProcessMap();
169
170void *AsanMmapFixedNoReserve(uintptr_t fixed_addr, size_t size);
171void *AsanMmapFixedReserve(uintptr_t fixed_addr, size_t size);
172void *AsanMprotect(uintptr_t fixed_addr, size_t size);
173void *AsanMmapSomewhereOrDie(size_t size, const char *where);
174void AsanUnmapOrDie(void *ptr, size_t size);
175
176void AsanDisableCoreDumper();
177void GetPcSpBp(void *context, uintptr_t *pc, uintptr_t *sp, uintptr_t *bp);
178
179size_t AsanRead(int fd, void *buf, size_t count);
180size_t AsanWrite(int fd, const void *buf, size_t count);
181int AsanClose(int fd);
182
183bool AsanInterceptsSignal(int signum);
184void SetAlternateSignalStack();
185void UnsetAlternateSignalStack();
186void InstallSignalHandlers();
187int GetPid();
188uintptr_t GetThreadSelf();
189int AtomicInc(int *a);
190uint16_t AtomicExchange(uint16_t *a, uint16_t new_val);
191
192// Wrapper for TLS/TSD.
193void AsanTSDInit(void (*destructor)(void *tsd));
194void *AsanTSDGet();
195void AsanTSDSet(void *tsd);
196
197// Opens the file 'file_name" and reads up to 'max_len' bytes.
198// The resulting buffer is mmaped and stored in '*buff'.
199// The size of the mmaped region is stored in '*buff_size',
200// Returns the number of read bytes or 0 if file can not be opened.
201size_t ReadFileToBuffer(const char *file_name, char **buff,
202                        size_t *buff_size, size_t max_len);
203
204// asan_printf.cc
205void RawWrite(const char *buffer);
206int SNPrintf(char *buffer, size_t length, const char *format, ...);
207void Printf(const char *format, ...);
208int SScanf(const char *str, const char *format, ...);
209void Report(const char *format, ...);
210
211// Don't use std::min and std::max, to minimize dependency on libstdc++.
212template<class T> T Min(T a, T b) { return a < b ? a : b; }
213template<class T> T Max(T a, T b) { return a > b ? a : b; }
214
215void SortArray(uintptr_t *array, size_t size);
216
217// asan_poisoning.cc
218// Poisons the shadow memory for "size" bytes starting from "addr".
219void PoisonShadow(uintptr_t addr, size_t size, uint8_t value);
220// Poisons the shadow memory for "redzone_size" bytes starting from
221// "addr + size".
222void PoisonShadowPartialRightRedzone(uintptr_t addr,
223                                     uintptr_t size,
224                                     uintptr_t redzone_size,
225                                     uint8_t value);
226
227// Platfrom-specific options.
228#ifdef __APPLE__
229bool PlatformHasDifferentMemcpyAndMemmove();
230# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \
231    (PlatformHasDifferentMemcpyAndMemmove())
232#else
233# define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true
234#endif  // __APPLE__
235
236extern size_t FLAG_quarantine_size;
237extern int    FLAG_demangle;
238extern bool   FLAG_symbolize;
239extern int    FLAG_v;
240extern size_t FLAG_redzone;
241extern int    FLAG_debug;
242extern bool   FLAG_poison_shadow;
243extern int    FLAG_report_globals;
244extern size_t FLAG_malloc_context_size;
245extern bool   FLAG_replace_str;
246extern bool   FLAG_replace_intrin;
247extern bool   FLAG_replace_cfallocator;
248extern bool   FLAG_fast_unwind;
249extern bool   FLAG_use_fake_stack;
250extern size_t FLAG_max_malloc_fill_size;
251extern int    FLAG_exitcode;
252extern bool   FLAG_allow_user_poisoning;
253extern int    FLAG_sleep_before_dying;
254extern bool   FLAG_handle_segv;
255extern bool   FLAG_use_sigaltstack;
256
257extern int asan_inited;
258// Used to avoid infinite recursion in __asan_init().
259extern bool asan_init_is_running;
260
261enum LinkerInitialized { LINKER_INITIALIZED = 0 };
262
263void NORETURN AsanDie();
264void SleepForSeconds(int seconds);
265void NORETURN Exit(int exitcode);
266void NORETURN Abort();
267int Atexit(void (*function)(void));
268
269#define CHECK(cond) do { if (!(cond)) { \
270  CheckFailed(#cond, __FILE__, __LINE__); \
271}}while(0)
272
273#define RAW_CHECK_MSG(expr, msg) do { \
274  if (!(expr)) { \
275    RawWrite(msg); \
276    AsanDie(); \
277  } \
278} while (0)
279
280#define RAW_CHECK(expr) RAW_CHECK_MSG(expr, #expr)
281
282#define UNIMPLEMENTED() CHECK("unimplemented" && 0)
283
284#define ASAN_ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
285
286const size_t kWordSize = __WORDSIZE / 8;
287const size_t kWordSizeInBits = 8 * kWordSize;
288const size_t kPageSizeBits = 12;
289const size_t kPageSize = 1UL << kPageSizeBits;
290
291#ifndef _WIN32
292const size_t kMmapGranularity = kPageSize;
293# define GET_CALLER_PC() (uintptr_t)__builtin_return_address(0)
294# define GET_CURRENT_FRAME() (uintptr_t)__builtin_frame_address(0)
295# define THREAD_CALLING_CONV
296typedef void* thread_return_t;
297#else
298const size_t kMmapGranularity = 1UL << 16;
299# define GET_CALLER_PC() (uintptr_t)_ReturnAddress()
300// CaptureStackBackTrace doesn't need to know BP on Windows.
301// FIXME: This macro is still used when printing error reports though it's not
302// clear if the BP value is needed in the ASan reports on Windows.
303# define GET_CURRENT_FRAME() (uintptr_t)0xDEADBEEF
304# define THREAD_CALLING_CONV __stdcall
305typedef DWORD thread_return_t;
306
307# ifndef ASAN_USE_EXTERNAL_SYMBOLIZER
308#  define ASAN_USE_EXTERNAL_SYMBOLIZER __asan::WinSymbolize
309bool WinSymbolize(const void *addr, char *out_buffer, int buffer_size);
310# endif
311#endif
312
313typedef thread_return_t (THREAD_CALLING_CONV *thread_callback_t)(void* arg);
314
315// These magic values are written to shadow for better error reporting.
316const int kAsanHeapLeftRedzoneMagic = 0xfa;
317const int kAsanHeapRightRedzoneMagic = 0xfb;
318const int kAsanHeapFreeMagic = 0xfd;
319const int kAsanStackLeftRedzoneMagic = 0xf1;
320const int kAsanStackMidRedzoneMagic = 0xf2;
321const int kAsanStackRightRedzoneMagic = 0xf3;
322const int kAsanStackPartialRedzoneMagic = 0xf4;
323const int kAsanStackAfterReturnMagic = 0xf5;
324const int kAsanUserPoisonedMemoryMagic = 0xf7;
325const int kAsanGlobalRedzoneMagic = 0xf9;
326const int kAsanInternalHeapMagic = 0xfe;
327
328static const uintptr_t kCurrentStackFrameMagic = 0x41B58AB3;
329static const uintptr_t kRetiredStackFrameMagic = 0x45E0360E;
330
331// --------------------------- Bit twiddling ------- {{{1
332inline bool IsPowerOfTwo(size_t x) {
333  return (x & (x - 1)) == 0;
334}
335
336inline size_t RoundUpTo(size_t size, size_t boundary) {
337  CHECK(IsPowerOfTwo(boundary));
338  return (size + boundary - 1) & ~(boundary - 1);
339}
340
341// -------------------------- LowLevelAllocator ----- {{{1
342// A simple low-level memory allocator for internal use.
343class LowLevelAllocator {
344 public:
345  explicit LowLevelAllocator(LinkerInitialized) {}
346  // 'size' must be a power of two.
347  // Requires an external lock.
348  void *Allocate(size_t size);
349 private:
350  char *allocated_end_;
351  char *allocated_current_;
352};
353
354}  // namespace __asan
355
356#endif  // ASAN_INTERNAL_H
357