asan_report.cc revision 650c7d44b659ddfb4af471dc2ad79a727b7de939 
1//===-- asan_report.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// This file contains error reporting code.
13//===----------------------------------------------------------------------===//
14#include "asan_flags.h"
15#include "asan_internal.h"
16#include "asan_mapping.h"
17#include "asan_report.h"
18#include "asan_stack.h"
19#include "asan_thread.h"
20#include "sanitizer_common/sanitizer_common.h"
21#include "sanitizer_common/sanitizer_flags.h"
22#include "sanitizer_common/sanitizer_report_decorator.h"
23#include "sanitizer_common/sanitizer_symbolizer.h"
24
25namespace __asan {
26
27// -------------------- User-specified callbacks ----------------- {{{1
28static void (*error_report_callback)(const char*);
29static char *error_message_buffer = 0;
30static uptr error_message_buffer_pos = 0;
31static uptr error_message_buffer_size = 0;
32
33void AppendToErrorMessageBuffer(const char *buffer) {
34  if (error_message_buffer) {
35    uptr length = internal_strlen(buffer);
36    CHECK_GE(error_message_buffer_size, error_message_buffer_pos);
37    uptr remaining = error_message_buffer_size - error_message_buffer_pos;
38    internal_strncpy(error_message_buffer + error_message_buffer_pos,
39                     buffer, remaining);
40    error_message_buffer[error_message_buffer_size - 1] = '\0';
41    // FIXME: reallocate the buffer instead of truncating the message.
42    error_message_buffer_pos += remaining > length ? length : remaining;
43  }
44}
45
46// ---------------------- Decorator ------------------------------ {{{1
47class Decorator: private __sanitizer::AnsiColorDecorator {
48 public:
49  Decorator() : __sanitizer::AnsiColorDecorator(PrintsToTtyCached()) { }
50  const char *Warning()    { return Red(); }
51  const char *EndWarning() { return Default(); }
52  const char *Access()     { return Blue(); }
53  const char *EndAccess()  { return Default(); }
54  const char *Location()   { return Green(); }
55  const char *EndLocation() { return Default(); }
56  const char *Allocation()  { return Magenta(); }
57  const char *EndAllocation()  { return Default(); }
58
59  const char *ShadowByte(u8 byte) {
60    switch (byte) {
61      case kAsanHeapLeftRedzoneMagic:
62      case kAsanHeapRightRedzoneMagic:
63        return Red();
64      case kAsanHeapFreeMagic:
65        return Magenta();
66      case kAsanStackLeftRedzoneMagic:
67      case kAsanStackMidRedzoneMagic:
68      case kAsanStackRightRedzoneMagic:
69      case kAsanStackPartialRedzoneMagic:
70        return Red();
71      case kAsanStackAfterReturnMagic:
72        return Magenta();
73      case kAsanInitializationOrderMagic:
74        return Cyan();
75      case kAsanUserPoisonedMemoryMagic:
76        return Blue();
77      case kAsanStackUseAfterScopeMagic:
78        return Magenta();
79      case kAsanGlobalRedzoneMagic:
80        return Red();
81      case kAsanInternalHeapMagic:
82        return Yellow();
83      default:
84        return Default();
85    }
86  }
87  const char *EndShadowByte() { return Default(); }
88};
89
90// ---------------------- Helper functions ----------------------- {{{1
91
92static void PrintShadowByte(const char *before, u8 byte,
93                            const char *after = "\n") {
94  Decorator d;
95  Printf("%s%s%x%x%s%s", before,
96         d.ShadowByte(byte), byte >> 4, byte & 15, d.EndShadowByte(), after);
97}
98
99static void PrintShadowBytes(const char *before, u8 *bytes,
100                             u8 *guilty, uptr n) {
101  Decorator d;
102  if (before)
103    Printf("%s%p:", before, bytes);
104  for (uptr i = 0; i < n; i++) {
105    u8 *p = bytes + i;
106    const char *before = p == guilty ? "[" :
107        (p - 1 == guilty && i != 0) ? "" : " ";
108    const char *after = p == guilty ? "]" : "";
109    PrintShadowByte(before, *p, after);
110  }
111  Printf("\n");
112}
113
114static void PrintLegend() {
115  Printf("Shadow byte legend (one shadow byte represents %d "
116         "application bytes):\n", (int)SHADOW_GRANULARITY);
117  PrintShadowByte("  Addressable:           ", 0);
118  Printf("  Partially addressable: ");
119  for (u8 i = 1; i < SHADOW_GRANULARITY; i++)
120    PrintShadowByte("", i, " ");
121  Printf("\n");
122  PrintShadowByte("  Heap left redzone:     ", kAsanHeapLeftRedzoneMagic);
123  PrintShadowByte("  Heap right redzone:    ", kAsanHeapRightRedzoneMagic);
124  PrintShadowByte("  Freed heap region:     ", kAsanHeapFreeMagic);
125  PrintShadowByte("  Stack left redzone:    ", kAsanStackLeftRedzoneMagic);
126  PrintShadowByte("  Stack mid redzone:     ", kAsanStackMidRedzoneMagic);
127  PrintShadowByte("  Stack right redzone:   ", kAsanStackRightRedzoneMagic);
128  PrintShadowByte("  Stack partial redzone: ", kAsanStackPartialRedzoneMagic);
129  PrintShadowByte("  Stack after return:    ", kAsanStackAfterReturnMagic);
130  PrintShadowByte("  Stack use after scope: ", kAsanStackUseAfterScopeMagic);
131  PrintShadowByte("  Global redzone:        ", kAsanGlobalRedzoneMagic);
132  PrintShadowByte("  Global init order:     ", kAsanInitializationOrderMagic);
133  PrintShadowByte("  Poisoned by user:      ", kAsanUserPoisonedMemoryMagic);
134  PrintShadowByte("  ASan internal:         ", kAsanInternalHeapMagic);
135}
136
137static void PrintShadowMemoryForAddress(uptr addr) {
138  if (!AddrIsInMem(addr))
139    return;
140  uptr shadow_addr = MemToShadow(addr);
141  const uptr n_bytes_per_row = 16;
142  uptr aligned_shadow = shadow_addr & ~(n_bytes_per_row - 1);
143  Printf("Shadow bytes around the buggy address:\n");
144  for (int i = -5; i <= 5; i++) {
145    const char *prefix = (i == 0) ? "=>" : "  ";
146    PrintShadowBytes(prefix,
147                     (u8*)(aligned_shadow + i * n_bytes_per_row),
148                     (u8*)shadow_addr, n_bytes_per_row);
149  }
150  if (flags()->print_legend)
151    PrintLegend();
152}
153
154static void PrintZoneForPointer(uptr ptr, uptr zone_ptr,
155                                const char *zone_name) {
156  if (zone_ptr) {
157    if (zone_name) {
158      Printf("malloc_zone_from_ptr(%p) = %p, which is %s\n",
159                 ptr, zone_ptr, zone_name);
160    } else {
161      Printf("malloc_zone_from_ptr(%p) = %p, which doesn't have a name\n",
162                 ptr, zone_ptr);
163    }
164  } else {
165    Printf("malloc_zone_from_ptr(%p) = 0\n", ptr);
166  }
167}
168
169// ---------------------- Address Descriptions ------------------- {{{1
170
171static bool IsASCII(unsigned char c) {
172  return /*0x00 <= c &&*/ c <= 0x7F;
173}
174
175static const char *MaybeDemangleGlobalName(const char *name) {
176  // We can spoil names of globals with C linkage, so use an heuristic
177  // approach to check if the name should be demangled.
178  return (name[0] == '_' && name[1] == 'Z') ? Demangle(name) : name;
179}
180
181// Check if the global is a zero-terminated ASCII string. If so, print it.
182static void PrintGlobalNameIfASCII(const __asan_global &g) {
183  for (uptr p = g.beg; p < g.beg + g.size - 1; p++) {
184    unsigned char c = *(unsigned char*)p;
185    if (c == '\0' || !IsASCII(c)) return;
186  }
187  if (*(char*)(g.beg + g.size - 1) != '\0') return;
188  Printf("  '%s' is ascii string '%s'\n",
189         MaybeDemangleGlobalName(g.name), (char*)g.beg);
190}
191
192bool DescribeAddressRelativeToGlobal(uptr addr, uptr size,
193                                     const __asan_global &g) {
194  static const uptr kMinimalDistanceFromAnotherGlobal = 64;
195  if (addr <= g.beg - kMinimalDistanceFromAnotherGlobal) return false;
196  if (addr >= g.beg + g.size_with_redzone) return false;
197  Decorator d;
198  Printf("%s", d.Location());
199  if (addr < g.beg) {
200    Printf("%p is located %zd bytes to the left", (void*)addr, g.beg - addr);
201  } else if (addr + size > g.beg + g.size) {
202    if (addr < g.beg + g.size)
203      addr = g.beg + g.size;
204    Printf("%p is located %zd bytes to the right", (void*)addr,
205           addr - (g.beg + g.size));
206  } else {
207    // Can it happen?
208    Printf("%p is located %zd bytes inside", (void*)addr, addr - g.beg);
209  }
210  Printf(" of global variable '%s' from '%s' (0x%zx) of size %zu\n",
211             MaybeDemangleGlobalName(g.name), g.module_name, g.beg, g.size);
212  Printf("%s", d.EndLocation());
213  PrintGlobalNameIfASCII(g);
214  return true;
215}
216
217bool DescribeAddressIfShadow(uptr addr) {
218  if (AddrIsInMem(addr))
219    return false;
220  static const char kAddrInShadowReport[] =
221      "Address %p is located in the %s.\n";
222  if (AddrIsInShadowGap(addr)) {
223    Printf(kAddrInShadowReport, addr, "shadow gap area");
224    return true;
225  }
226  if (AddrIsInHighShadow(addr)) {
227    Printf(kAddrInShadowReport, addr, "high shadow area");
228    return true;
229  }
230  if (AddrIsInLowShadow(addr)) {
231    Printf(kAddrInShadowReport, addr, "low shadow area");
232    return true;
233  }
234  CHECK(0 && "Address is not in memory and not in shadow?");
235  return false;
236}
237
238// Return " (thread_name) " or an empty string if the name is empty.
239const char *ThreadNameWithParenthesis(AsanThreadContext *t, char buff[],
240                                      uptr buff_len) {
241  const char *name = t->name;
242  if (name[0] == '\0') return "";
243  buff[0] = 0;
244  internal_strncat(buff, " (", 3);
245  internal_strncat(buff, name, buff_len - 4);
246  internal_strncat(buff, ")", 2);
247  return buff;
248}
249
250const char *ThreadNameWithParenthesis(u32 tid, char buff[],
251                                      uptr buff_len) {
252  if (tid == kInvalidTid) return "";
253  asanThreadRegistry().CheckLocked();
254  AsanThreadContext *t = GetThreadContextByTidLocked(tid);
255  return ThreadNameWithParenthesis(t, buff, buff_len);
256}
257
258bool DescribeAddressIfStack(uptr addr, uptr access_size) {
259  AsanThread *t = FindThreadByStackAddress(addr);
260  if (!t) return false;
261  const s64 kBufSize = 4095;
262  char buf[kBufSize];
263  uptr offset = 0;
264  uptr frame_pc = 0;
265  char tname[128];
266  const char *frame_descr = t->GetFrameNameByAddr(addr, &offset, &frame_pc);
267
268#ifdef __powerpc64__
269  // On PowerPC64, the address of a function actually points to a
270  // three-doubleword data structure with the first field containing
271  // the address of the function's code.
272  frame_pc = *reinterpret_cast<uptr *>(frame_pc);
273#endif
274
275  // This string is created by the compiler and has the following form:
276  // "n alloc_1 alloc_2 ... alloc_n"
277  // where alloc_i looks like "offset size len ObjectName ".
278  CHECK(frame_descr);
279  Decorator d;
280  Printf("%s", d.Location());
281  Printf("Address %p is located in stack of thread T%d%s "
282         "at offset %zu in frame\n",
283         addr, t->tid(),
284         ThreadNameWithParenthesis(t->tid(), tname, sizeof(tname)),
285         offset);
286  // Now we print the frame where the alloca has happened.
287  // We print this frame as a stack trace with one element.
288  // The symbolizer may print more than one frame if inlining was involved.
289  // The frame numbers may be different than those in the stack trace printed
290  // previously. That's unfortunate, but I have no better solution,
291  // especially given that the alloca may be from entirely different place
292  // (e.g. use-after-scope, or different thread's stack).
293  StackTrace alloca_stack;
294  alloca_stack.trace[0] = frame_pc + 16;
295  alloca_stack.size = 1;
296  Printf("%s", d.EndLocation());
297  PrintStack(&alloca_stack);
298  // Report the number of stack objects.
299  char *p;
300  s64 n_objects = internal_simple_strtoll(frame_descr, &p, 10);
301  CHECK_GT(n_objects, 0);
302  Printf("  This frame has %zu object(s):\n", n_objects);
303  // Report all objects in this frame.
304  for (s64 i = 0; i < n_objects; i++) {
305    s64 beg, size;
306    s64 len;
307    beg  = internal_simple_strtoll(p, &p, 10);
308    size = internal_simple_strtoll(p, &p, 10);
309    len  = internal_simple_strtoll(p, &p, 10);
310    if (beg <= 0 || size <= 0 || len < 0 || *p != ' ') {
311      Printf("AddressSanitizer can't parse the stack frame "
312                 "descriptor: |%s|\n", frame_descr);
313      break;
314    }
315    p++;
316    buf[0] = 0;
317    internal_strncat(buf, p, static_cast<uptr>(Min(kBufSize, len)));
318    p += len;
319    Printf("    [%lld, %lld) '%s'\n", beg, beg + size, buf);
320  }
321  Printf("HINT: this may be a false positive if your program uses "
322             "some custom stack unwind mechanism or swapcontext\n"
323             "      (longjmp and C++ exceptions *are* supported)\n");
324  DescribeThread(t->context());
325  return true;
326}
327
328static void DescribeAccessToHeapChunk(AsanChunkView chunk, uptr addr,
329                                      uptr access_size) {
330  sptr offset;
331  Decorator d;
332  Printf("%s", d.Location());
333  if (chunk.AddrIsAtLeft(addr, access_size, &offset)) {
334    Printf("%p is located %zd bytes to the left of", (void*)addr, offset);
335  } else if (chunk.AddrIsAtRight(addr, access_size, &offset)) {
336    if (offset < 0) {
337      addr -= offset;
338      offset = 0;
339    }
340    Printf("%p is located %zd bytes to the right of", (void*)addr, offset);
341  } else if (chunk.AddrIsInside(addr, access_size, &offset)) {
342    Printf("%p is located %zd bytes inside of", (void*)addr, offset);
343  } else {
344    Printf("%p is located somewhere around (this is AddressSanitizer bug!)",
345           (void*)addr);
346  }
347  Printf(" %zu-byte region [%p,%p)\n", chunk.UsedSize(),
348         (void*)(chunk.Beg()), (void*)(chunk.End()));
349  Printf("%s", d.EndLocation());
350}
351
352void DescribeHeapAddress(uptr addr, uptr access_size) {
353  AsanChunkView chunk = FindHeapChunkByAddress(addr);
354  if (!chunk.IsValid()) return;
355  DescribeAccessToHeapChunk(chunk, addr, access_size);
356  CHECK(chunk.AllocTid() != kInvalidTid);
357  asanThreadRegistry().CheckLocked();
358  AsanThreadContext *alloc_thread =
359      GetThreadContextByTidLocked(chunk.AllocTid());
360  StackTrace alloc_stack;
361  chunk.GetAllocStack(&alloc_stack);
362  AsanThread *t = GetCurrentThread();
363  CHECK(t);
364  char tname[128];
365  Decorator d;
366  if (chunk.FreeTid() != kInvalidTid) {
367    AsanThreadContext *free_thread =
368        GetThreadContextByTidLocked(chunk.FreeTid());
369    Printf("%sfreed by thread T%d%s here:%s\n", d.Allocation(),
370           free_thread->tid,
371           ThreadNameWithParenthesis(free_thread, tname, sizeof(tname)),
372           d.EndAllocation());
373    StackTrace free_stack;
374    chunk.GetFreeStack(&free_stack);
375    PrintStack(&free_stack);
376    Printf("%spreviously allocated by thread T%d%s here:%s\n",
377           d.Allocation(), alloc_thread->tid,
378           ThreadNameWithParenthesis(alloc_thread, tname, sizeof(tname)),
379           d.EndAllocation());
380    PrintStack(&alloc_stack);
381    DescribeThread(t->context());
382    DescribeThread(free_thread);
383    DescribeThread(alloc_thread);
384  } else {
385    Printf("%sallocated by thread T%d%s here:%s\n", d.Allocation(),
386           alloc_thread->tid,
387           ThreadNameWithParenthesis(alloc_thread, tname, sizeof(tname)),
388           d.EndAllocation());
389    PrintStack(&alloc_stack);
390    DescribeThread(t->context());
391    DescribeThread(alloc_thread);
392  }
393}
394
395void DescribeAddress(uptr addr, uptr access_size) {
396  // Check if this is shadow or shadow gap.
397  if (DescribeAddressIfShadow(addr))
398    return;
399  CHECK(AddrIsInMem(addr));
400  if (DescribeAddressIfGlobal(addr, access_size))
401    return;
402  if (DescribeAddressIfStack(addr, access_size))
403    return;
404  // Assume it is a heap address.
405  DescribeHeapAddress(addr, access_size);
406}
407
408// ------------------- Thread description -------------------- {{{1
409
410void DescribeThread(AsanThreadContext *context) {
411  CHECK(context);
412  asanThreadRegistry().CheckLocked();
413  // No need to announce the main thread.
414  if (context->tid == 0 || context->announced) {
415    return;
416  }
417  context->announced = true;
418  char tname[128];
419  Printf("Thread T%d%s", context->tid,
420         ThreadNameWithParenthesis(context->tid, tname, sizeof(tname)));
421  Printf(" created by T%d%s here:\n",
422         context->parent_tid,
423         ThreadNameWithParenthesis(context->parent_tid,
424                                   tname, sizeof(tname)));
425  PrintStack(&context->stack);
426  // Recursively described parent thread if needed.
427  if (flags()->print_full_thread_history) {
428    AsanThreadContext *parent_context =
429        GetThreadContextByTidLocked(context->parent_tid);
430    DescribeThread(parent_context);
431  }
432}
433
434// -------------------- Different kinds of reports ----------------- {{{1
435
436// Use ScopedInErrorReport to run common actions just before and
437// immediately after printing error report.
438class ScopedInErrorReport {
439 public:
440  ScopedInErrorReport() {
441    static atomic_uint32_t num_calls;
442    static u32 reporting_thread_tid;
443    if (atomic_fetch_add(&num_calls, 1, memory_order_relaxed) != 0) {
444      // Do not print more than one report, otherwise they will mix up.
445      // Error reporting functions shouldn't return at this situation, as
446      // they are defined as no-return.
447      Report("AddressSanitizer: while reporting a bug found another one."
448                 "Ignoring.\n");
449      u32 current_tid = GetCurrentTidOrInvalid();
450      if (current_tid != reporting_thread_tid) {
451        // ASan found two bugs in different threads simultaneously. Sleep
452        // long enough to make sure that the thread which started to print
453        // an error report will finish doing it.
454        SleepForSeconds(Max(100, flags()->sleep_before_dying + 1));
455      }
456      // If we're still not dead for some reason, use raw _exit() instead of
457      // Die() to bypass any additional checks.
458      internal__exit(flags()->exitcode);
459    }
460    ASAN_ON_ERROR();
461    // Make sure the registry and sanitizer report mutexes are locked while
462    // we're printing an error report.
463    // We can lock them only here to avoid self-deadlock in case of
464    // recursive reports.
465    asanThreadRegistry().Lock();
466    CommonSanitizerReportMutex.Lock();
467    reporting_thread_tid = GetCurrentTidOrInvalid();
468    Printf("===================================================="
469           "=============\n");
470    if (reporting_thread_tid != kInvalidTid) {
471      // We started reporting an error message. Stop using the fake stack
472      // in case we call an instrumented function from a symbolizer.
473      AsanThread *curr_thread = GetCurrentThread();
474      CHECK(curr_thread);
475      if (curr_thread->fake_stack())
476        curr_thread->fake_stack()->StopUsingFakeStack();
477    }
478  }
479  // Destructor is NORETURN, as functions that report errors are.
480  NORETURN ~ScopedInErrorReport() {
481    // Make sure the current thread is announced.
482    AsanThread *curr_thread = GetCurrentThread();
483    if (curr_thread) {
484      DescribeThread(curr_thread->context());
485    }
486    // Print memory stats.
487    if (flags()->print_stats)
488      __asan_print_accumulated_stats();
489    if (error_report_callback) {
490      error_report_callback(error_message_buffer);
491    }
492    Report("ABORTING\n");
493    Die();
494  }
495};
496
497static void ReportSummary(const char *error_type, StackTrace *stack) {
498  if (!stack->size) return;
499  if (IsSymbolizerAvailable()) {
500    AddressInfo ai;
501    // Currently, we include the first stack frame into the report summary.
502    // Maybe sometimes we need to choose another frame (e.g. skip memcpy/etc).
503    uptr pc = StackTrace::GetPreviousInstructionPc(stack->trace[0]);
504    SymbolizeCode(pc, &ai, 1);
505    ReportErrorSummary(error_type,
506                       StripPathPrefix(ai.file,
507                                       common_flags()->strip_path_prefix),
508                       ai.line, ai.function);
509  }
510  // FIXME: do we need to print anything at all if there is no symbolizer?
511}
512
513void ReportSIGSEGV(uptr pc, uptr sp, uptr bp, uptr addr) {
514  ScopedInErrorReport in_report;
515  Decorator d;
516  Printf("%s", d.Warning());
517  Report("ERROR: AddressSanitizer: SEGV on unknown address %p"
518             " (pc %p sp %p bp %p T%d)\n",
519             (void*)addr, (void*)pc, (void*)sp, (void*)bp,
520             GetCurrentTidOrInvalid());
521  Printf("%s", d.EndWarning());
522  Printf("AddressSanitizer can not provide additional info.\n");
523  GET_STACK_TRACE_FATAL(pc, bp);
524  PrintStack(&stack);
525  ReportSummary("SEGV", &stack);
526}
527
528void ReportDoubleFree(uptr addr, StackTrace *stack) {
529  ScopedInErrorReport in_report;
530  Decorator d;
531  Printf("%s", d.Warning());
532  char tname[128];
533  u32 curr_tid = GetCurrentTidOrInvalid();
534  Report("ERROR: AddressSanitizer: attempting double-free on %p in "
535         "thread T%d%s:\n",
536         addr, curr_tid,
537         ThreadNameWithParenthesis(curr_tid, tname, sizeof(tname)));
538
539  Printf("%s", d.EndWarning());
540  PrintStack(stack);
541  DescribeHeapAddress(addr, 1);
542  ReportSummary("double-free", stack);
543}
544
545void ReportFreeNotMalloced(uptr addr, StackTrace *stack) {
546  ScopedInErrorReport in_report;
547  Decorator d;
548  Printf("%s", d.Warning());
549  char tname[128];
550  u32 curr_tid = GetCurrentTidOrInvalid();
551  Report("ERROR: AddressSanitizer: attempting free on address "
552             "which was not malloc()-ed: %p in thread T%d%s\n", addr,
553         curr_tid, ThreadNameWithParenthesis(curr_tid, tname, sizeof(tname)));
554  Printf("%s", d.EndWarning());
555  PrintStack(stack);
556  DescribeHeapAddress(addr, 1);
557  ReportSummary("bad-free", stack);
558}
559
560void ReportAllocTypeMismatch(uptr addr, StackTrace *stack,
561                             AllocType alloc_type,
562                             AllocType dealloc_type) {
563  static const char *alloc_names[] =
564    {"INVALID", "malloc", "operator new", "operator new []"};
565  static const char *dealloc_names[] =
566    {"INVALID", "free", "operator delete", "operator delete []"};
567  CHECK_NE(alloc_type, dealloc_type);
568  ScopedInErrorReport in_report;
569  Decorator d;
570  Printf("%s", d.Warning());
571  Report("ERROR: AddressSanitizer: alloc-dealloc-mismatch (%s vs %s) on %p\n",
572        alloc_names[alloc_type], dealloc_names[dealloc_type], addr);
573  Printf("%s", d.EndWarning());
574  PrintStack(stack);
575  DescribeHeapAddress(addr, 1);
576  ReportSummary("alloc-dealloc-mismatch", stack);
577  Report("HINT: if you don't care about these warnings you may set "
578         "ASAN_OPTIONS=alloc_dealloc_mismatch=0\n");
579}
580
581void ReportMallocUsableSizeNotOwned(uptr addr, StackTrace *stack) {
582  ScopedInErrorReport in_report;
583  Decorator d;
584  Printf("%s", d.Warning());
585  Report("ERROR: AddressSanitizer: attempting to call "
586             "malloc_usable_size() for pointer which is "
587             "not owned: %p\n", addr);
588  Printf("%s", d.EndWarning());
589  PrintStack(stack);
590  DescribeHeapAddress(addr, 1);
591  ReportSummary("bad-malloc_usable_size", stack);
592}
593
594void ReportAsanGetAllocatedSizeNotOwned(uptr addr, StackTrace *stack) {
595  ScopedInErrorReport in_report;
596  Decorator d;
597  Printf("%s", d.Warning());
598  Report("ERROR: AddressSanitizer: attempting to call "
599             "__asan_get_allocated_size() for pointer which is "
600             "not owned: %p\n", addr);
601  Printf("%s", d.EndWarning());
602  PrintStack(stack);
603  DescribeHeapAddress(addr, 1);
604  ReportSummary("bad-__asan_get_allocated_size", stack);
605}
606
607void ReportStringFunctionMemoryRangesOverlap(
608    const char *function, const char *offset1, uptr length1,
609    const char *offset2, uptr length2, StackTrace *stack) {
610  ScopedInErrorReport in_report;
611  Decorator d;
612  char bug_type[100];
613  internal_snprintf(bug_type, sizeof(bug_type), "%s-param-overlap", function);
614  Printf("%s", d.Warning());
615  Report("ERROR: AddressSanitizer: %s: "
616             "memory ranges [%p,%p) and [%p, %p) overlap\n", \
617             bug_type, offset1, offset1 + length1, offset2, offset2 + length2);
618  Printf("%s", d.EndWarning());
619  PrintStack(stack);
620  DescribeAddress((uptr)offset1, length1);
621  DescribeAddress((uptr)offset2, length2);
622  ReportSummary(bug_type, stack);
623}
624
625// ----------------------- Mac-specific reports ----------------- {{{1
626
627void WarnMacFreeUnallocated(
628    uptr addr, uptr zone_ptr, const char *zone_name, StackTrace *stack) {
629  // Just print a warning here.
630  Printf("free_common(%p) -- attempting to free unallocated memory.\n"
631             "AddressSanitizer is ignoring this error on Mac OS now.\n",
632             addr);
633  PrintZoneForPointer(addr, zone_ptr, zone_name);
634  PrintStack(stack);
635  DescribeHeapAddress(addr, 1);
636}
637
638void ReportMacMzReallocUnknown(
639    uptr addr, uptr zone_ptr, const char *zone_name, StackTrace *stack) {
640  ScopedInErrorReport in_report;
641  Printf("mz_realloc(%p) -- attempting to realloc unallocated memory.\n"
642             "This is an unrecoverable problem, exiting now.\n",
643             addr);
644  PrintZoneForPointer(addr, zone_ptr, zone_name);
645  PrintStack(stack);
646  DescribeHeapAddress(addr, 1);
647}
648
649void ReportMacCfReallocUnknown(
650    uptr addr, uptr zone_ptr, const char *zone_name, StackTrace *stack) {
651  ScopedInErrorReport in_report;
652  Printf("cf_realloc(%p) -- attempting to realloc unallocated memory.\n"
653             "This is an unrecoverable problem, exiting now.\n",
654             addr);
655  PrintZoneForPointer(addr, zone_ptr, zone_name);
656  PrintStack(stack);
657  DescribeHeapAddress(addr, 1);
658}
659
660}  // namespace __asan
661
662// --------------------------- Interface --------------------- {{{1
663using namespace __asan;  // NOLINT
664
665void __asan_report_error(uptr pc, uptr bp, uptr sp,
666                         uptr addr, bool is_write, uptr access_size) {
667  ScopedInErrorReport in_report;
668
669  // Determine the error type.
670  const char *bug_descr = "unknown-crash";
671  if (AddrIsInMem(addr)) {
672    u8 *shadow_addr = (u8*)MemToShadow(addr);
673    // If we are accessing 16 bytes, look at the second shadow byte.
674    if (*shadow_addr == 0 && access_size > SHADOW_GRANULARITY)
675      shadow_addr++;
676    // If we are in the partial right redzone, look at the next shadow byte.
677    if (*shadow_addr > 0 && *shadow_addr < 128)
678      shadow_addr++;
679    switch (*shadow_addr) {
680      case kAsanHeapLeftRedzoneMagic:
681      case kAsanHeapRightRedzoneMagic:
682        bug_descr = "heap-buffer-overflow";
683        break;
684      case kAsanHeapFreeMagic:
685        bug_descr = "heap-use-after-free";
686        break;
687      case kAsanStackLeftRedzoneMagic:
688        bug_descr = "stack-buffer-underflow";
689        break;
690      case kAsanInitializationOrderMagic:
691        bug_descr = "initialization-order-fiasco";
692        break;
693      case kAsanStackMidRedzoneMagic:
694      case kAsanStackRightRedzoneMagic:
695      case kAsanStackPartialRedzoneMagic:
696        bug_descr = "stack-buffer-overflow";
697        break;
698      case kAsanStackAfterReturnMagic:
699        bug_descr = "stack-use-after-return";
700        break;
701      case kAsanUserPoisonedMemoryMagic:
702        bug_descr = "use-after-poison";
703        break;
704      case kAsanStackUseAfterScopeMagic:
705        bug_descr = "stack-use-after-scope";
706        break;
707      case kAsanGlobalRedzoneMagic:
708        bug_descr = "global-buffer-overflow";
709        break;
710    }
711  }
712  Decorator d;
713  Printf("%s", d.Warning());
714  Report("ERROR: AddressSanitizer: %s on address "
715             "%p at pc 0x%zx bp 0x%zx sp 0x%zx\n",
716             bug_descr, (void*)addr, pc, bp, sp);
717  Printf("%s", d.EndWarning());
718
719  u32 curr_tid = GetCurrentTidOrInvalid();
720  char tname[128];
721  Printf("%s%s of size %zu at %p thread T%d%s%s\n",
722         d.Access(),
723         access_size ? (is_write ? "WRITE" : "READ") : "ACCESS",
724         access_size, (void*)addr, curr_tid,
725         ThreadNameWithParenthesis(curr_tid, tname, sizeof(tname)),
726         d.EndAccess());
727
728  GET_STACK_TRACE_FATAL(pc, bp);
729  PrintStack(&stack);
730
731  DescribeAddress(addr, access_size);
732  ReportSummary(bug_descr, &stack);
733  PrintShadowMemoryForAddress(addr);
734}
735
736void NOINLINE __asan_set_error_report_callback(void (*callback)(const char*)) {
737  error_report_callback = callback;
738  if (callback) {
739    error_message_buffer_size = 1 << 16;
740    error_message_buffer =
741        (char*)MmapOrDie(error_message_buffer_size, __FUNCTION__);
742    error_message_buffer_pos = 0;
743  }
744}
745
746void __asan_describe_address(uptr addr) {
747  DescribeAddress(addr, 1);
748}
749
750#if !SANITIZER_SUPPORTS_WEAK_HOOKS
751// Provide default implementation of __asan_on_error that does nothing
752// and may be overriden by user.
753SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE NOINLINE
754void __asan_on_error() {}
755#endif
756