Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 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 | |
Alexey Samsonov | 7ed1d2b | 2012-07-10 07:41:27 +0000 | [diff] [blame] | 17 | #include "asan_flags.h" |
Alexey Samsonov | c70fa28 | 2013-01-31 13:46:14 +0000 | [diff] [blame] | 18 | #include "asan_interface_internal.h" |
Alexey Samsonov | 47657ce | 2012-06-06 07:02:44 +0000 | [diff] [blame] | 19 | #include "sanitizer_common/sanitizer_common.h" |
Alexey Samsonov | 94b5036 | 2012-06-05 14:25:27 +0000 | [diff] [blame] | 20 | #include "sanitizer_common/sanitizer_internal_defs.h" |
Kostya Serebryany | 1b5ea8f | 2012-08-28 14:11:57 +0000 | [diff] [blame] | 21 | #include "sanitizer_common/sanitizer_stacktrace.h" |
Kostya Serebryany | 16e0075 | 2012-05-31 13:42:53 +0000 | [diff] [blame] | 22 | #include "sanitizer_common/sanitizer_libc.h" |
Kostya Serebryany | b3cedf9 | 2012-05-29 12:18:18 +0000 | [diff] [blame] | 23 | |
Alexey Samsonov | b823e3c | 2012-02-22 14:07:06 +0000 | [diff] [blame] | 24 | #define ASAN_DEFAULT_FAILURE_EXITCODE 1 |
| 25 | |
Kostya Serebryany | e31eca9 | 2013-02-15 12:00:24 +0000 | [diff] [blame] | 26 | #if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__) |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 27 | # error "The AddressSanitizer run-time should not be" |
| 28 | " instrumented by AddressSanitizer" |
| 29 | #endif |
| 30 | |
Kostya Serebryany | c6f2223 | 2011-12-08 18:30:42 +0000 | [diff] [blame] | 31 | // Build-time configuration options. |
| 32 | |
Kostya Serebryany | c6f2223 | 2011-12-08 18:30:42 +0000 | [diff] [blame] | 33 | // If set, asan will install its own SEGV signal handler. |
| 34 | #ifndef ASAN_NEEDS_SEGV |
Evgeniy Stepanov | 83cb787 | 2013-03-19 13:54:41 +0000 | [diff] [blame] | 35 | # if SANITIZER_ANDROID == 1 |
Evgeniy Stepanov | 9712af9 | 2012-09-28 10:07:53 +0000 | [diff] [blame] | 36 | # define ASAN_NEEDS_SEGV 0 |
| 37 | # else |
| 38 | # define ASAN_NEEDS_SEGV 1 |
| 39 | # endif |
Kostya Serebryany | c6f2223 | 2011-12-08 18:30:42 +0000 | [diff] [blame] | 40 | #endif |
| 41 | |
| 42 | // If set, asan will intercept C++ exception api call(s). |
| 43 | #ifndef ASAN_HAS_EXCEPTIONS |
| 44 | # define ASAN_HAS_EXCEPTIONS 1 |
| 45 | #endif |
| 46 | |
| 47 | // If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET |
| 48 | // provided by the instrumented objects. Otherwise constants are used. |
| 49 | #ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET |
| 50 | # define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0 |
| 51 | #endif |
| 52 | |
Evgeniy Stepanov | 8ae44ac | 2012-02-27 13:07:29 +0000 | [diff] [blame] | 53 | // If set, values like allocator chunk size, as well as defaults for some flags |
| 54 | // will be changed towards less memory overhead. |
| 55 | #ifndef ASAN_LOW_MEMORY |
Kostya Serebryany | e52810d | 2012-12-25 07:17:17 +0000 | [diff] [blame] | 56 | #if SANITIZER_WORDSIZE == 32 |
Evgeniy Stepanov | 9712af9 | 2012-09-28 10:07:53 +0000 | [diff] [blame] | 57 | # define ASAN_LOW_MEMORY 1 |
Kostya Serebryany | e52810d | 2012-12-25 07:17:17 +0000 | [diff] [blame] | 58 | #else |
Evgeniy Stepanov | 9712af9 | 2012-09-28 10:07:53 +0000 | [diff] [blame] | 59 | # define ASAN_LOW_MEMORY 0 |
| 60 | # endif |
Evgeniy Stepanov | 8ae44ac | 2012-02-27 13:07:29 +0000 | [diff] [blame] | 61 | #endif |
| 62 | |
Kostya Serebryany | e135343 | 2013-02-20 14:28:08 +0000 | [diff] [blame] | 63 | #ifndef ASAN_USE_PREINIT_ARRAY |
Evgeniy Stepanov | 83cb787 | 2013-03-19 13:54:41 +0000 | [diff] [blame] | 64 | # define ASAN_USE_PREINIT_ARRAY (SANITIZER_LINUX && !SANITIZER_ANDROID) |
Kostya Serebryany | e135343 | 2013-02-20 14:28:08 +0000 | [diff] [blame] | 65 | #endif |
| 66 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 67 | // All internal functions in asan reside inside the __asan namespace |
| 68 | // to avoid namespace collisions with the user programs. |
| 69 | // Seperate namespace also makes it simpler to distinguish the asan run-time |
| 70 | // functions from the instrumented user code in a profile. |
| 71 | namespace __asan { |
| 72 | |
| 73 | class AsanThread; |
Kostya Serebryany | 1b5ea8f | 2012-08-28 14:11:57 +0000 | [diff] [blame] | 74 | using __sanitizer::StackTrace; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 75 | |
Kostya Serebryany | 218a9b7 | 2011-11-30 18:50:23 +0000 | [diff] [blame] | 76 | // asan_rtl.cc |
Timur Iskhodzhanov | b55c88d | 2012-03-13 16:29:25 +0000 | [diff] [blame] | 77 | void NORETURN ShowStatsAndAbort(); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 78 | |
Alexey Samsonov | 4d5f98d | 2012-04-06 08:21:08 +0000 | [diff] [blame] | 79 | void ReplaceOperatorsNewAndDelete(); |
Kostya Serebryany | 218a9b7 | 2011-11-30 18:50:23 +0000 | [diff] [blame] | 80 | // asan_malloc_linux.cc / asan_malloc_mac.cc |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 81 | void ReplaceSystemMalloc(); |
| 82 | |
Alexander Potapenko | f73a6a3 | 2012-02-13 17:09:40 +0000 | [diff] [blame] | 83 | // asan_linux.cc / asan_mac.cc / asan_win.cc |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 84 | void *AsanDoesNotSupportStaticLinkage(); |
Kostya Serebryany | de496f4 | 2011-12-28 22:58:01 +0000 | [diff] [blame] | 85 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 86 | void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp); |
Kostya Serebryany | ef14ff6 | 2012-01-06 02:12:25 +0000 | [diff] [blame] | 87 | |
Alexander Potapenko | eb8c46e | 2012-08-24 09:22:05 +0000 | [diff] [blame] | 88 | void MaybeReexec(); |
Kostya Serebryany | 4803ab9 | 2012-01-09 18:53:15 +0000 | [diff] [blame] | 89 | bool AsanInterceptsSignal(int signum); |
Alexander Potapenko | f03d8af | 2012-04-05 10:54:52 +0000 | [diff] [blame] | 90 | void SetAlternateSignalStack(); |
| 91 | void UnsetAlternateSignalStack(); |
Kostya Serebryany | a7e760a | 2012-01-09 19:18:27 +0000 | [diff] [blame] | 92 | void InstallSignalHandlers(); |
Alexey Samsonov | 57db4ba | 2013-01-17 15:45:28 +0000 | [diff] [blame] | 93 | void ReadContextStack(void *context, uptr *stack, uptr *ssize); |
Alexander Potapenko | 75b19eb | 2012-07-23 14:07:58 +0000 | [diff] [blame] | 94 | void AsanPlatformThreadInit(); |
Alexey Samsonov | 46efcb0 | 2013-05-24 11:46:56 +0000 | [diff] [blame] | 95 | void StopInitOrderChecking(); |
Kostya Serebryany | cc4e686 | 2012-01-11 02:21:06 +0000 | [diff] [blame] | 96 | |
| 97 | // Wrapper for TLS/TSD. |
Kostya Serebryany | f58f998 | 2012-02-07 00:27:15 +0000 | [diff] [blame] | 98 | void AsanTSDInit(void (*destructor)(void *tsd)); |
Kostya Serebryany | cc4e686 | 2012-01-11 02:21:06 +0000 | [diff] [blame] | 99 | void *AsanTSDGet(); |
| 100 | void AsanTSDSet(void *tsd); |
Sergey Matveev | e86e35f | 2013-10-14 12:01:05 +0000 | [diff] [blame] | 101 | void PlatformTSDDtor(void *tsd); |
Kostya Serebryany | 4803ab9 | 2012-01-09 18:53:15 +0000 | [diff] [blame] | 102 | |
Alexey Samsonov | e954101 | 2012-06-06 13:11:29 +0000 | [diff] [blame] | 103 | void AppendToErrorMessageBuffer(const char *buffer); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 104 | |
Alexey Samsonov | 38dd4ed | 2012-03-20 10:54:40 +0000 | [diff] [blame] | 105 | // Platfrom-specific options. |
Evgeniy Stepanov | 30e110e | 2013-03-19 14:54:17 +0000 | [diff] [blame] | 106 | #if SANITIZER_MAC |
Alexey Samsonov | 38dd4ed | 2012-03-20 10:54:40 +0000 | [diff] [blame] | 107 | bool PlatformHasDifferentMemcpyAndMemmove(); |
| 108 | # define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \ |
| 109 | (PlatformHasDifferentMemcpyAndMemmove()) |
| 110 | #else |
| 111 | # define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true |
Alexey Samsonov | 649a270 | 2013-04-03 07:29:53 +0000 | [diff] [blame] | 112 | #endif // SANITIZER_MAC |
Alexey Samsonov | 38dd4ed | 2012-03-20 10:54:40 +0000 | [diff] [blame] | 113 | |
Alexey Samsonov | 6a08d29 | 2012-12-07 22:01:28 +0000 | [diff] [blame] | 114 | // Add convenient macro for interface functions that may be represented as |
| 115 | // weak hooks. |
| 116 | #define ASAN_MALLOC_HOOK(ptr, size) \ |
| 117 | if (&__asan_malloc_hook) __asan_malloc_hook(ptr, size) |
| 118 | #define ASAN_FREE_HOOK(ptr) \ |
| 119 | if (&__asan_free_hook) __asan_free_hook(ptr) |
| 120 | #define ASAN_ON_ERROR() \ |
| 121 | if (&__asan_on_error) __asan_on_error() |
| 122 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 123 | extern int asan_inited; |
| 124 | // Used to avoid infinite recursion in __asan_init(). |
| 125 | extern bool asan_init_is_running; |
Alexey Samsonov | 47657ce | 2012-06-06 07:02:44 +0000 | [diff] [blame] | 126 | extern void (*death_callback)(void); |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 127 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 128 | // These magic values are written to shadow for better error reporting. |
| 129 | const int kAsanHeapLeftRedzoneMagic = 0xfa; |
| 130 | const int kAsanHeapRightRedzoneMagic = 0xfb; |
| 131 | const int kAsanHeapFreeMagic = 0xfd; |
| 132 | const int kAsanStackLeftRedzoneMagic = 0xf1; |
| 133 | const int kAsanStackMidRedzoneMagic = 0xf2; |
| 134 | const int kAsanStackRightRedzoneMagic = 0xf3; |
| 135 | const int kAsanStackPartialRedzoneMagic = 0xf4; |
| 136 | const int kAsanStackAfterReturnMagic = 0xf5; |
Kostya Serebryany | 3945c58 | 2012-08-21 14:10:25 +0000 | [diff] [blame] | 137 | const int kAsanInitializationOrderMagic = 0xf6; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 138 | const int kAsanUserPoisonedMemoryMagic = 0xf7; |
Alexey Samsonov | d4b5db8 | 2012-12-04 01:38:15 +0000 | [diff] [blame] | 139 | const int kAsanStackUseAfterScopeMagic = 0xf8; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 140 | const int kAsanGlobalRedzoneMagic = 0xf9; |
Kostya Serebryany | 6b30e2c | 2011-12-15 17:41:30 +0000 | [diff] [blame] | 141 | const int kAsanInternalHeapMagic = 0xfe; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 142 | |
Kostya Serebryany | 3f4c387 | 2012-05-31 14:35:53 +0000 | [diff] [blame] | 143 | static const uptr kCurrentStackFrameMagic = 0x41B58AB3; |
| 144 | static const uptr kRetiredStackFrameMagic = 0x45E0360E; |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 145 | |
Kostya Serebryany | 1e172b4 | 2011-11-30 01:07:02 +0000 | [diff] [blame] | 146 | } // namespace __asan |
| 147 | |
| 148 | #endif // ASAN_INTERNAL_H |