asan_report.cc revision ed20ebe35c64b8c7043447f6a48b0e5adc89aded 
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
47bool PrintsToTtyCached() {
48  static int cached = 0;
49  static bool prints_to_tty;
50  if (!cached) {  // Ok wrt threads since we are printing only from one thread.
51    prints_to_tty = PrintsToTty();
52    cached = 1;
53  }
54  return prints_to_tty;
55}
56class Decorator: private __sanitizer::AnsiColorDecorator {
57 public:
58  Decorator() : __sanitizer::AnsiColorDecorator(PrintsToTtyCached()) { }
59  const char *Warning()    { return Red(); }
60  const char *EndWarning() { return Default(); }
61  const char *Access()     { return Blue(); }
62  const char *EndAccess()  { return Default(); }
63  const char *Location()   { return Green(); }
64  const char *EndLocation() { return Default(); }
65  const char *Allocation()  { return Magenta(); }
66  const char *EndAllocation()  { return Default(); }
67
68  const char *ShadowByte(u8 byte) {
69    switch (byte) {
70      case kAsanHeapLeftRedzoneMagic:
71      case kAsanHeapRightRedzoneMagic:
72        return Red();
73      case kAsanHeapFreeMagic:
74        return Magenta();
75      case kAsanStackLeftRedzoneMagic:
76      case kAsanStackMidRedzoneMagic:
77      case kAsanStackRightRedzoneMagic:
78      case kAsanStackPartialRedzoneMagic:
79        return Red();
80      case kAsanStackAfterReturnMagic:
81        return Magenta();
82      case kAsanInitializationOrderMagic:
83        return Cyan();
84      case kAsanUserPoisonedMemoryMagic:
85        return Blue();
86      case kAsanStackUseAfterScopeMagic:
87        return Magenta();
88      case kAsanGlobalRedzoneMagic:
89        return Red();
90      case kAsanInternalHeapMagic:
91        return Yellow();
92      default:
93        return Default();
94    }
95  }
96  const char *EndShadowByte() { return Default(); }
97};
98
99// ---------------------- Helper functions ----------------------- {{{1
100
101static void PrintShadowByte(const char *before, u8 byte,
102                            const char *after = "\n") {
103  Decorator d;
104  Printf("%s%s%x%x%s%s", before,
105         d.ShadowByte(byte), byte >> 4, byte & 15, d.EndShadowByte(), after);
106}
107
108static void PrintShadowBytes(const char *before, u8 *bytes,
109                             u8 *guilty, uptr n) {
110  Decorator d;
111  if (before)
112    Printf("%s%p:", before, bytes);
113  for (uptr i = 0; i < n; i++) {
114    u8 *p = bytes + i;
115    const char *before = p == guilty ? "[" :
116        p - 1 == guilty ? "" : " ";
117    const char *after = p == guilty ? "]" : "";
118    PrintShadowByte(before, *p, after);
119  }
120  Printf("\n");
121}
122
123static void PrintLegend() {
124  Printf("Shadow byte legend (one shadow byte represents %d "
125         "application bytes):\n", (int)SHADOW_GRANULARITY);
126  PrintShadowByte("  Addressable:           ", 0);
127  Printf("  Partially addressable: ");
128  for (uptr i = 1; i < SHADOW_GRANULARITY; i++)
129    PrintShadowByte("", i, " ");
130  Printf("\n");
131  PrintShadowByte("  Heap left redzone:     ", kAsanHeapLeftRedzoneMagic);
132  PrintShadowByte("  Heap right redzone:    ", kAsanHeapRightRedzoneMagic);
133  PrintShadowByte("  Freed heap region:     ", kAsanHeapFreeMagic);
134  PrintShadowByte("  Stack left redzone:    ", kAsanStackLeftRedzoneMagic);
135  PrintShadowByte("  Stack mid redzone:     ", kAsanStackMidRedzoneMagic);
136  PrintShadowByte("  Stack right redzone:   ", kAsanStackRightRedzoneMagic);
137  PrintShadowByte("  Stack partial redzone: ", kAsanStackPartialRedzoneMagic);
138  PrintShadowByte("  Stack after return:    ", kAsanStackAfterReturnMagic);
139  PrintShadowByte("  Stack use after scope: ", kAsanStackUseAfterScopeMagic);
140  PrintShadowByte("  Global redzone:        ", kAsanGlobalRedzoneMagic);
141  PrintShadowByte("  Global init order:     ", kAsanInitializationOrderMagic);
142  PrintShadowByte("  Poisoned by user:      ", kAsanUserPoisonedMemoryMagic);
143  PrintShadowByte("  ASan internal:         ", kAsanInternalHeapMagic);
144}
145
146static void PrintShadowMemoryForAddress(uptr addr) {
147  if (!AddrIsInMem(addr))
148    return;
149  uptr shadow_addr = MemToShadow(addr);
150  const uptr n_bytes_per_row = 16;
151  uptr aligned_shadow = shadow_addr & ~(n_bytes_per_row - 1);
152  Printf("Shadow bytes around the buggy address:\n");
153  for (int i = -5; i <= 5; i++) {
154    const char *prefix = (i == 0) ? "=>" : "  ";
155    PrintShadowBytes(prefix,
156                     (u8*)(aligned_shadow + i * n_bytes_per_row),
157                     (u8*)shadow_addr, n_bytes_per_row);
158  }
159  if (flags()->print_legend)
160    PrintLegend();
161}
162
163static void PrintZoneForPointer(uptr ptr, uptr zone_ptr,
164                                const char *zone_name) {
165  if (zone_ptr) {
166    if (zone_name) {
167      Printf("malloc_zone_from_ptr(%p) = %p, which is %s\n",
168                 ptr, zone_ptr, zone_name);
169    } else {
170      Printf("malloc_zone_from_ptr(%p) = %p, which doesn't have a name\n",
171                 ptr, zone_ptr);
172    }
173  } else {
174    Printf("malloc_zone_from_ptr(%p) = 0\n", ptr);
175  }
176}
177
178// ---------------------- Address Descriptions ------------------- {{{1
179
180static bool IsASCII(unsigned char c) {
181  return /*0x00 <= c &&*/ c <= 0x7F;
182}
183
184static const char *MaybeDemangleGlobalName(const char *name) {
185  // We can spoil names of globals with C linkage, so use an heuristic
186  // approach to check if the name should be demangled.
187  return (name[0] == '_' && name[1] == 'Z') ? Demangle(name) : name;
188}
189
190// Check if the global is a zero-terminated ASCII string. If so, print it.
191static void PrintGlobalNameIfASCII(const __asan_global &g) {
192  for (uptr p = g.beg; p < g.beg + g.size - 1; p++) {
193    unsigned char c = *(unsigned char*)p;
194    if (c == '\0' || !IsASCII(c)) return;
195  }
196  if (*(char*)(g.beg + g.size - 1) != '\0') return;
197  Printf("  '%s' is ascii string '%s'\n",
198         MaybeDemangleGlobalName(g.name), (char*)g.beg);
199}
200
201bool DescribeAddressRelativeToGlobal(uptr addr, uptr size,
202                                     const __asan_global &g) {
203  static const uptr kMinimalDistanceFromAnotherGlobal = 64;
204  if (addr <= g.beg - kMinimalDistanceFromAnotherGlobal) return false;
205  if (addr >= g.beg + g.size_with_redzone) return false;
206  Decorator d;
207  Printf("%s", d.Location());
208  if (addr < g.beg) {
209    Printf("%p is located %zd bytes to the left", (void*)addr, g.beg - addr);
210  } else if (addr + size > g.beg + g.size) {
211    if (addr < g.beg + g.size)
212      addr = g.beg + g.size;
213    Printf("%p is located %zd bytes to the right", (void*)addr,
214           addr - (g.beg + g.size));
215  } else {
216    // Can it happen?
217    Printf("%p is located %zd bytes inside", (void*)addr, addr - g.beg);
218  }
219  Printf(" of global variable '%s' from '%s' (0x%zx) of size %zu\n",
220             MaybeDemangleGlobalName(g.name), g.module_name, g.beg, g.size);
221  Printf("%s", d.EndLocation());
222  PrintGlobalNameIfASCII(g);
223  return true;
224}
225
226bool DescribeAddressIfShadow(uptr addr) {
227  if (AddrIsInMem(addr))
228    return false;
229  static const char kAddrInShadowReport[] =
230      "Address %p is located in the %s.\n";
231  if (AddrIsInShadowGap(addr)) {
232    Printf(kAddrInShadowReport, addr, "shadow gap area");
233    return true;
234  }
235  if (AddrIsInHighShadow(addr)) {
236    Printf(kAddrInShadowReport, addr, "high shadow area");
237    return true;
238  }
239  if (AddrIsInLowShadow(addr)) {
240    Printf(kAddrInShadowReport, addr, "low shadow area");
241    return true;
242  }
243  CHECK(0 && "Address is not in memory and not in shadow?");
244  return false;
245}
246
247// Return " (thread_name) " or an empty string if the name is empty.
248const char *ThreadNameWithParenthesis(AsanThreadContext *t, char buff[],
249                                      uptr buff_len) {
250  const char *name = t->name;
251  if (name[0] == '\0') return "";
252  buff[0] = 0;
253  internal_strncat(buff, " (", 3);
254  internal_strncat(buff, name, buff_len - 4);
255  internal_strncat(buff, ")", 2);
256  return buff;
257}
258
259const char *ThreadNameWithParenthesis(u32 tid, char buff[],
260                                      uptr buff_len) {
261  if (tid == kInvalidTid) return "";
262  asanThreadRegistry().CheckLocked();
263  AsanThreadContext *t = GetThreadContextByTidLocked(tid);
264  return ThreadNameWithParenthesis(t, buff, buff_len);
265}
266
267bool DescribeAddressIfStack(uptr addr, uptr access_size) {
268  AsanThread *t = FindThreadByStackAddress(addr);
269  if (!t) return false;
270  const sptr kBufSize = 4095;
271  char buf[kBufSize];
272  uptr offset = 0;
273  uptr frame_pc = 0;
274  char tname[128];
275  const char *frame_descr = t->GetFrameNameByAddr(addr, &offset, &frame_pc);
276  // This string is created by the compiler and has the following form:
277  // "n alloc_1 alloc_2 ... alloc_n"
278  // where alloc_i looks like "offset size len ObjectName ".
279  CHECK(frame_descr);
280  Decorator d;
281  Printf("%s", d.Location());
282  Printf("Address %p is located in stack of thread T%d%s "
283         "at offset %zu in frame\n",
284         addr, t->tid(),
285         ThreadNameWithParenthesis(t->tid(), tname, sizeof(tname)),
286         offset);
287  // Now we print the frame where the alloca has happened.
288  // We print this frame as a stack trace with one element.
289  // The symbolizer may print more than one frame if inlining was involved.
290  // The frame numbers may be different than those in the stack trace printed
291  // previously. That's unfortunate, but I have no better solution,
292  // especially given that the alloca may be from entirely different place
293  // (e.g. use-after-scope, or different thread's stack).
294  StackTrace alloca_stack;
295  alloca_stack.trace[0] = frame_pc + 16;
296  alloca_stack.size = 1;
297  Printf("%s", d.EndLocation());
298  PrintStack(&alloca_stack);
299  // Report the number of stack objects.
300  char *p;
301  uptr n_objects = internal_simple_strtoll(frame_descr, &p, 10);
302  CHECK_GT(n_objects, 0);
303  Printf("  This frame has %zu object(s):\n", n_objects);
304  // Report all objects in this frame.
305  for (uptr i = 0; i < n_objects; i++) {
306    uptr beg, size;
307    sptr len;
308    beg  = internal_simple_strtoll(p, &p, 10);
309    size = internal_simple_strtoll(p, &p, 10);
310    len  = internal_simple_strtoll(p, &p, 10);
311    if (beg <= 0 || size <= 0 || len < 0 || *p != ' ') {
312      Printf("AddressSanitizer can't parse the stack frame "
313                 "descriptor: |%s|\n", frame_descr);
314      break;
315    }
316    p++;
317    buf[0] = 0;
318    internal_strncat(buf, p, Min(kBufSize, len));
319    p += len;
320    Printf("    [%zu, %zu) '%s'\n", beg, beg + size, buf);
321  }
322  Printf("HINT: this may be a false positive if your program uses "
323             "some custom stack unwind mechanism or swapcontext\n"
324             "      (longjmp and C++ exceptions *are* supported)\n");
325  DescribeThread(t->context());
326  return true;
327}
328
329static void DescribeAccessToHeapChunk(AsanChunkView chunk, uptr addr,
330                                      uptr access_size) {
331  sptr offset;
332  Decorator d;
333  Printf("%s", d.Location());
334  if (chunk.AddrIsAtLeft(addr, access_size, &offset)) {
335    Printf("%p is located %zd bytes to the left of", (void*)addr, offset);
336  } else if (chunk.AddrIsAtRight(addr, access_size, &offset)) {
337    if (offset < 0) {
338      addr -= offset;
339      offset = 0;
340    }
341    Printf("%p is located %zd bytes to the right of", (void*)addr, offset);
342  } else if (chunk.AddrIsInside(addr, access_size, &offset)) {
343    Printf("%p is located %zd bytes inside of", (void*)addr, offset);
344  } else {
345    Printf("%p is located somewhere around (this is AddressSanitizer bug!)",
346           (void*)addr);
347  }
348  Printf(" %zu-byte region [%p,%p)\n", chunk.UsedSize(),
349         (void*)(chunk.Beg()), (void*)(chunk.End()));
350  Printf("%s", d.EndLocation());
351}
352
353void DescribeHeapAddress(uptr addr, uptr access_size) {
354  AsanChunkView chunk = FindHeapChunkByAddress(addr);
355  if (!chunk.IsValid()) return;
356  DescribeAccessToHeapChunk(chunk, addr, access_size);
357  CHECK(chunk.AllocTid() != kInvalidTid);
358  asanThreadRegistry().CheckLocked();
359  AsanThreadContext *alloc_thread =
360      GetThreadContextByTidLocked(chunk.AllocTid());
361  StackTrace alloc_stack;
362  chunk.GetAllocStack(&alloc_stack);
363  AsanThread *t = GetCurrentThread();
364  CHECK(t);
365  char tname[128];
366  Decorator d;
367  if (chunk.FreeTid() != kInvalidTid) {
368    AsanThreadContext *free_thread =
369        GetThreadContextByTidLocked(chunk.FreeTid());
370    Printf("%sfreed by thread T%d%s here:%s\n", d.Allocation(),
371           free_thread->tid,
372           ThreadNameWithParenthesis(free_thread, tname, sizeof(tname)),
373           d.EndAllocation());
374    StackTrace free_stack;
375    chunk.GetFreeStack(&free_stack);
376    PrintStack(&free_stack);
377    Printf("%spreviously allocated by thread T%d%s here:%s\n",
378           d.Allocation(), alloc_thread->tid,
379           ThreadNameWithParenthesis(alloc_thread, tname, sizeof(tname)),
380           d.EndAllocation());
381    PrintStack(&alloc_stack);
382    DescribeThread(t->context());
383    DescribeThread(free_thread);
384    DescribeThread(alloc_thread);
385  } else {
386    Printf("%sallocated by thread T%d%s here:%s\n", d.Allocation(),
387           alloc_thread->tid,
388           ThreadNameWithParenthesis(alloc_thread, tname, sizeof(tname)),
389           d.EndAllocation());
390    PrintStack(&alloc_stack);
391    DescribeThread(t->context());
392    DescribeThread(alloc_thread);
393  }
394}
395
396void DescribeAddress(uptr addr, uptr access_size) {
397  // Check if this is shadow or shadow gap.
398  if (DescribeAddressIfShadow(addr))
399    return;
400  CHECK(AddrIsInMem(addr));
401  if (DescribeAddressIfGlobal(addr, access_size))
402    return;
403  if (DescribeAddressIfStack(addr, access_size))
404    return;
405  // Assume it is a heap address.
406  DescribeHeapAddress(addr, access_size);
407}
408
409// ------------------- Thread description -------------------- {{{1
410
411void DescribeThread(AsanThreadContext *context) {
412  CHECK(context);
413  asanThreadRegistry().CheckLocked();
414  // No need to announce the main thread.
415  if (context->tid == 0 || context->announced) {
416    return;
417  }
418  context->announced = true;
419  char tname[128];
420  Printf("Thread T%d%s", context->tid,
421         ThreadNameWithParenthesis(context->tid, tname, sizeof(tname)));
422  Printf(" created by T%d%s here:\n",
423         context->parent_tid,
424         ThreadNameWithParenthesis(context->parent_tid,
425                                   tname, sizeof(tname)));
426  PrintStack(&context->stack);
427  // Recursively described parent thread if needed.
428  if (flags()->print_full_thread_history) {
429    AsanThreadContext *parent_context =
430        GetThreadContextByTidLocked(context->parent_tid);
431    DescribeThread(parent_context);
432  }
433}
434
435// -------------------- Different kinds of reports ----------------- {{{1
436
437// Use ScopedInErrorReport to run common actions just before and
438// immediately after printing error report.
439class ScopedInErrorReport {
440 public:
441  ScopedInErrorReport() {
442    static atomic_uint32_t num_calls;
443    static u32 reporting_thread_tid;
444    if (atomic_fetch_add(&num_calls, 1, memory_order_relaxed) != 0) {
445      // Do not print more than one report, otherwise they will mix up.
446      // Error reporting functions shouldn't return at this situation, as
447      // they are defined as no-return.
448      Report("AddressSanitizer: while reporting a bug found another one."
449                 "Ignoring.\n");
450      u32 current_tid = GetCurrentTidOrInvalid();
451      if (current_tid != reporting_thread_tid) {
452        // ASan found two bugs in different threads simultaneously. Sleep
453        // long enough to make sure that the thread which started to print
454        // an error report will finish doing it.
455        SleepForSeconds(Max(100, flags()->sleep_before_dying + 1));
456      }
457      // If we're still not dead for some reason, use raw _exit() instead of
458      // Die() to bypass any additional checks.
459      internal__exit(flags()->exitcode);
460    }
461    ASAN_ON_ERROR();
462    // Make sure the registry and sanitizer report mutexes are locked while
463    // we're printing an error report.
464    // We can lock them only here to avoid self-deadlock in case of
465    // recursive reports.
466    asanThreadRegistry().Lock();
467    CommonSanitizerReportMutex.Lock();
468    reporting_thread_tid = GetCurrentTidOrInvalid();
469    Printf("===================================================="
470           "=============\n");
471    if (reporting_thread_tid != kInvalidTid) {
472      // We started reporting an error message. Stop using the fake stack
473      // in case we call an instrumented function from a symbolizer.
474      AsanThread *curr_thread = GetCurrentThread();
475      CHECK(curr_thread);
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_WEAK_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE NOINLINE
754void __asan_on_error() {}
755#endif
756