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