asan_rtl.cc revision 08d978809ac98095815e5cab80caeb0089f89a1e
1//===-- asan_rtl.cc -------------------------------------------------------===// 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// Main file of the ASan run-time library. 13//===----------------------------------------------------------------------===// 14#include "asan_allocator.h" 15#include "asan_interceptors.h" 16#include "asan_interface.h" 17#include "asan_internal.h" 18#include "asan_lock.h" 19#include "asan_mapping.h" 20#include "asan_report.h" 21#include "asan_stack.h" 22#include "asan_stats.h" 23#include "asan_thread.h" 24#include "asan_thread_registry.h" 25#include "sanitizer_common/sanitizer_atomic.h" 26#include "sanitizer_common/sanitizer_flags.h" 27#include "sanitizer_common/sanitizer_libc.h" 28 29namespace __sanitizer { 30using namespace __asan; 31 32void Die() { 33 static atomic_uint32_t num_calls; 34 if (atomic_fetch_add(&num_calls, 1, memory_order_relaxed) != 0) { 35 // Don't die twice - run a busy loop. 36 while (1) { } 37 } 38 if (flags()->sleep_before_dying) { 39 Report("Sleeping for %d second(s)\n", flags()->sleep_before_dying); 40 SleepForSeconds(flags()->sleep_before_dying); 41 } 42 if (flags()->unmap_shadow_on_exit) 43 UnmapOrDie((void*)kLowShadowBeg, kHighShadowEnd - kLowShadowBeg); 44 if (death_callback) 45 death_callback(); 46 if (flags()->abort_on_error) 47 Abort(); 48 Exit(flags()->exitcode); 49} 50 51void CheckFailed(const char *file, int line, const char *cond, u64 v1, u64 v2) { 52 AsanReport("AddressSanitizer CHECK failed: %s:%d \"%s\" (0x%zx, 0x%zx)\n", 53 file, line, cond, (uptr)v1, (uptr)v2); 54 PRINT_CURRENT_STACK(); 55 ShowStatsAndAbort(); 56} 57 58} // namespace __sanitizer 59 60namespace __asan { 61 62// -------------------------- Flags ------------------------- {{{1 63static const int kMallocContextSize = 30; 64 65static Flags asan_flags; 66 67Flags *flags() { 68 return &asan_flags; 69} 70 71static void ParseFlagsFromString(Flags *f, const char *str) { 72 ParseFlag(str, &f->quarantine_size, "quarantine_size"); 73 ParseFlag(str, &f->symbolize, "symbolize"); 74 ParseFlag(str, &f->verbosity, "verbosity"); 75 ParseFlag(str, &f->redzone, "redzone"); 76 CHECK(f->redzone >= 16); 77 CHECK(IsPowerOfTwo(f->redzone)); 78 79 ParseFlag(str, &f->debug, "debug"); 80 ParseFlag(str, &f->report_globals, "report_globals"); 81 ParseFlag(str, &f->malloc_context_size, "malloc_context_size"); 82 CHECK(f->malloc_context_size <= kMallocContextSize); 83 84 ParseFlag(str, &f->replace_str, "replace_str"); 85 ParseFlag(str, &f->replace_intrin, "replace_intrin"); 86 ParseFlag(str, &f->replace_cfallocator, "replace_cfallocator"); 87 ParseFlag(str, &f->mac_ignore_invalid_free, "mac_ignore_invalid_free"); 88 ParseFlag(str, &f->use_fake_stack, "use_fake_stack"); 89 ParseFlag(str, &f->max_malloc_fill_size, "max_malloc_fill_size"); 90 ParseFlag(str, &f->exitcode, "exitcode"); 91 ParseFlag(str, &f->allow_user_poisoning, "allow_user_poisoning"); 92 ParseFlag(str, &f->sleep_before_dying, "sleep_before_dying"); 93 ParseFlag(str, &f->handle_segv, "handle_segv"); 94 ParseFlag(str, &f->use_sigaltstack, "use_sigaltstack"); 95 ParseFlag(str, &f->check_malloc_usable_size, "check_malloc_usable_size"); 96 ParseFlag(str, &f->unmap_shadow_on_exit, "unmap_shadow_on_exit"); 97 ParseFlag(str, &f->abort_on_error, "abort_on_error"); 98 ParseFlag(str, &f->atexit, "atexit"); 99 ParseFlag(str, &f->disable_core, "disable_core"); 100 ParseFlag(str, &f->strip_path_prefix, "strip_path_prefix"); 101} 102 103extern "C" { 104SANITIZER_WEAK_ATTRIBUTE 105SANITIZER_INTERFACE_ATTRIBUTE 106const char* __asan_default_options() { return ""; } 107} // extern "C" 108 109void InitializeFlags(Flags *f, const char *env) { 110 internal_memset(f, 0, sizeof(*f)); 111 112 f->quarantine_size = (ASAN_LOW_MEMORY) ? 1UL << 24 : 1UL << 28; 113 f->symbolize = false; 114 f->verbosity = 0; 115 f->redzone = (ASAN_LOW_MEMORY) ? 64 : 128; 116 f->debug = false; 117 f->report_globals = 1; 118 f->malloc_context_size = kMallocContextSize; 119 f->replace_str = true; 120 f->replace_intrin = true; 121 f->replace_cfallocator = true; 122 f->mac_ignore_invalid_free = false; 123 f->use_fake_stack = true; 124 f->max_malloc_fill_size = 0; 125 f->exitcode = ASAN_DEFAULT_FAILURE_EXITCODE; 126 f->allow_user_poisoning = true; 127 f->sleep_before_dying = 0; 128 f->handle_segv = ASAN_NEEDS_SEGV; 129 f->use_sigaltstack = false; 130 f->check_malloc_usable_size = true; 131 f->unmap_shadow_on_exit = false; 132 f->abort_on_error = false; 133 f->atexit = false; 134 f->disable_core = (__WORDSIZE == 64); 135 f->strip_path_prefix = ""; 136 137 // Override from user-specified string. 138 ParseFlagsFromString(f, __asan_default_options()); 139 if (flags()->verbosity) { 140 Report("Using the defaults from __asan_default_options: %s\n", 141 __asan_default_options()); 142 } 143 144 // Override from command line. 145 ParseFlagsFromString(f, env); 146} 147 148// -------------------------- Globals --------------------- {{{1 149int asan_inited; 150bool asan_init_is_running; 151void (*death_callback)(void); 152 153// -------------------------- Misc ---------------- {{{1 154void ShowStatsAndAbort() { 155 __asan_print_accumulated_stats(); 156 Die(); 157} 158 159// ---------------------- mmap -------------------- {{{1 160// Reserve memory range [beg, end]. 161static void ReserveShadowMemoryRange(uptr beg, uptr end) { 162 CHECK((beg % kPageSize) == 0); 163 CHECK(((end + 1) % kPageSize) == 0); 164 uptr size = end - beg + 1; 165 void *res = MmapFixedNoReserve(beg, size); 166 CHECK(res == (void*)beg && "ReserveShadowMemoryRange failed"); 167} 168 169// ---------------------- LowLevelAllocator ------------- {{{1 170void *LowLevelAllocator::Allocate(uptr size) { 171 CHECK((size & (size - 1)) == 0 && "size must be a power of two"); 172 if (allocated_end_ - allocated_current_ < (sptr)size) { 173 uptr size_to_allocate = Max(size, kPageSize); 174 allocated_current_ = 175 (char*)MmapOrDie(size_to_allocate, __FUNCTION__); 176 allocated_end_ = allocated_current_ + size_to_allocate; 177 PoisonShadow((uptr)allocated_current_, size_to_allocate, 178 kAsanInternalHeapMagic); 179 } 180 CHECK(allocated_end_ - allocated_current_ >= (sptr)size); 181 void *res = allocated_current_; 182 allocated_current_ += size; 183 return res; 184} 185 186// -------------------------- Run-time entry ------------------- {{{1 187// exported functions 188#define ASAN_REPORT_ERROR(type, is_write, size) \ 189extern "C" NOINLINE INTERFACE_ATTRIBUTE \ 190void __asan_report_ ## type ## size(uptr addr); \ 191void __asan_report_ ## type ## size(uptr addr) { \ 192 GET_CALLER_PC_BP_SP; \ 193 __asan_report_error(pc, bp, sp, addr, is_write, size); \ 194} 195 196ASAN_REPORT_ERROR(load, false, 1) 197ASAN_REPORT_ERROR(load, false, 2) 198ASAN_REPORT_ERROR(load, false, 4) 199ASAN_REPORT_ERROR(load, false, 8) 200ASAN_REPORT_ERROR(load, false, 16) 201ASAN_REPORT_ERROR(store, true, 1) 202ASAN_REPORT_ERROR(store, true, 2) 203ASAN_REPORT_ERROR(store, true, 4) 204ASAN_REPORT_ERROR(store, true, 8) 205ASAN_REPORT_ERROR(store, true, 16) 206 207// Force the linker to keep the symbols for various ASan interface functions. 208// We want to keep those in the executable in order to let the instrumented 209// dynamic libraries access the symbol even if it is not used by the executable 210// itself. This should help if the build system is removing dead code at link 211// time. 212static NOINLINE void force_interface_symbols() { 213 volatile int fake_condition = 0; // prevent dead condition elimination. 214 // __asan_report_* functions are noreturn, so we need a switch to prevent 215 // the compiler from removing any of them. 216 switch (fake_condition) { 217 case 1: __asan_report_load1(0); break; 218 case 2: __asan_report_load2(0); break; 219 case 3: __asan_report_load4(0); break; 220 case 4: __asan_report_load8(0); break; 221 case 5: __asan_report_load16(0); break; 222 case 6: __asan_report_store1(0); break; 223 case 7: __asan_report_store2(0); break; 224 case 8: __asan_report_store4(0); break; 225 case 9: __asan_report_store8(0); break; 226 case 10: __asan_report_store16(0); break; 227 case 11: __asan_register_global(0, 0, 0); break; 228 case 12: __asan_register_globals(0, 0); break; 229 case 13: __asan_unregister_globals(0, 0); break; 230 case 14: __asan_set_death_callback(0); break; 231 case 15: __asan_set_error_report_callback(0); break; 232 case 16: __asan_handle_no_return(); break; 233 case 17: __asan_address_is_poisoned(0); break; 234 case 18: __asan_get_allocated_size(0); break; 235 case 19: __asan_get_current_allocated_bytes(); break; 236 case 20: __asan_get_estimated_allocated_size(0); break; 237 case 21: __asan_get_free_bytes(); break; 238 case 22: __asan_get_heap_size(); break; 239 case 23: __asan_get_ownership(0); break; 240 case 24: __asan_get_unmapped_bytes(); break; 241 case 25: __asan_poison_memory_region(0, 0); break; 242 case 26: __asan_unpoison_memory_region(0, 0); break; 243 case 27: __asan_set_error_exit_code(0); break; 244 case 28: __asan_stack_free(0, 0, 0); break; 245 case 29: __asan_stack_malloc(0, 0); break; 246 case 30: __asan_set_on_error_callback(0); break; 247 case 31: __asan_default_options(); break; 248 } 249} 250 251static void asan_atexit() { 252 AsanPrintf("AddressSanitizer exit stats:\n"); 253 __asan_print_accumulated_stats(); 254} 255 256} // namespace __asan 257 258// ---------------------- Interface ---------------- {{{1 259using namespace __asan; // NOLINT 260 261int NOINLINE __asan_set_error_exit_code(int exit_code) { 262 int old = flags()->exitcode; 263 flags()->exitcode = exit_code; 264 return old; 265} 266 267void NOINLINE __asan_handle_no_return() { 268 int local_stack; 269 AsanThread *curr_thread = asanThreadRegistry().GetCurrent(); 270 CHECK(curr_thread); 271 uptr top = curr_thread->stack_top(); 272 uptr bottom = ((uptr)&local_stack - kPageSize) & ~(kPageSize-1); 273 PoisonShadow(bottom, top - bottom, 0); 274} 275 276void NOINLINE __asan_set_death_callback(void (*callback)(void)) { 277 death_callback = callback; 278} 279 280void __asan_init() { 281 if (asan_inited) return; 282 asan_init_is_running = true; 283 284 // Make sure we are not statically linked. 285 AsanDoesNotSupportStaticLinkage(); 286 287 // Initialize flags. 288 const char *options = GetEnv("ASAN_OPTIONS"); 289 InitializeFlags(flags(), options); 290 291 if (flags()->verbosity && options) { 292 Report("Parsed ASAN_OPTIONS: %s\n", options); 293 } 294 295 if (flags()->atexit) { 296 Atexit(asan_atexit); 297 } 298 299 // interceptors 300 InitializeAsanInterceptors(); 301 302 ReplaceSystemMalloc(); 303 ReplaceOperatorsNewAndDelete(); 304 305 if (flags()->verbosity) { 306 Printf("|| `[%p, %p]` || HighMem ||\n", 307 (void*)kHighMemBeg, (void*)kHighMemEnd); 308 Printf("|| `[%p, %p]` || HighShadow ||\n", 309 (void*)kHighShadowBeg, (void*)kHighShadowEnd); 310 Printf("|| `[%p, %p]` || ShadowGap ||\n", 311 (void*)kShadowGapBeg, (void*)kShadowGapEnd); 312 Printf("|| `[%p, %p]` || LowShadow ||\n", 313 (void*)kLowShadowBeg, (void*)kLowShadowEnd); 314 Printf("|| `[%p, %p]` || LowMem ||\n", 315 (void*)kLowMemBeg, (void*)kLowMemEnd); 316 Printf("MemToShadow(shadow): %p %p %p %p\n", 317 (void*)MEM_TO_SHADOW(kLowShadowBeg), 318 (void*)MEM_TO_SHADOW(kLowShadowEnd), 319 (void*)MEM_TO_SHADOW(kHighShadowBeg), 320 (void*)MEM_TO_SHADOW(kHighShadowEnd)); 321 Printf("red_zone=%zu\n", (uptr)flags()->redzone); 322 Printf("malloc_context_size=%zu\n", (uptr)flags()->malloc_context_size); 323 324 Printf("SHADOW_SCALE: %zx\n", (uptr)SHADOW_SCALE); 325 Printf("SHADOW_GRANULARITY: %zx\n", (uptr)SHADOW_GRANULARITY); 326 Printf("SHADOW_OFFSET: %zx\n", (uptr)SHADOW_OFFSET); 327 CHECK(SHADOW_SCALE >= 3 && SHADOW_SCALE <= 7); 328 } 329 330 if (flags()->disable_core) { 331 DisableCoreDumper(); 332 } 333 334 uptr shadow_start = kLowShadowBeg; 335 if (kLowShadowBeg > 0) shadow_start -= kMmapGranularity; 336 uptr shadow_end = kHighShadowEnd; 337 if (MemoryRangeIsAvailable(shadow_start, shadow_end)) { 338 if (kLowShadowBeg != kLowShadowEnd) { 339 // mmap the low shadow plus at least one page. 340 ReserveShadowMemoryRange(kLowShadowBeg - kMmapGranularity, kLowShadowEnd); 341 } 342 // mmap the high shadow. 343 ReserveShadowMemoryRange(kHighShadowBeg, kHighShadowEnd); 344 // protect the gap 345 void *prot = Mprotect(kShadowGapBeg, kShadowGapEnd - kShadowGapBeg + 1); 346 CHECK(prot == (void*)kShadowGapBeg); 347 } else { 348 Report("Shadow memory range interleaves with an existing memory mapping. " 349 "ASan cannot proceed correctly. ABORTING.\n"); 350 DumpProcessMap(); 351 Die(); 352 } 353 354 InstallSignalHandlers(); 355 356 // On Linux AsanThread::ThreadStart() calls malloc() that's why asan_inited 357 // should be set to 1 prior to initializing the threads. 358 asan_inited = 1; 359 asan_init_is_running = false; 360 361 asanThreadRegistry().Init(); 362 asanThreadRegistry().GetMain()->ThreadStart(); 363 force_interface_symbols(); // no-op. 364 365 if (flags()->verbosity) { 366 Report("AddressSanitizer Init done\n"); 367 } 368} 369 370#if defined(ASAN_USE_PREINIT_ARRAY) 371 // On Linux, we force __asan_init to be called before anyone else 372 // by placing it into .preinit_array section. 373 // FIXME: do we have anything like this on Mac? 374 __attribute__((section(".preinit_array"))) 375 typeof(__asan_init) *__asan_preinit =__asan_init; 376#elif defined(_WIN32) && defined(_DLL) 377 // On Windows, when using dynamic CRT (/MD), we can put a pointer 378 // to __asan_init into the global list of C initializers. 379 // See crt0dat.c in the CRT sources for the details. 380 #pragma section(".CRT$XIB", long, read) // NOLINT 381 __declspec(allocate(".CRT$XIB")) void (*__asan_preinit)() = __asan_init; 382#endif 383