blob: 6359b26865e7977b9caa3361d869deb6642e4cc4 [file] [log] [blame]
Alexey Samsonov73545092012-08-09 07:40:58 +00001//===-- 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//===----------------------------------------------------------------------===//
Alexey Samsonov98737922012-08-10 15:13:05 +000014#include "asan_flags.h"
Alexey Samsonov73545092012-08-09 07:40:58 +000015#include "asan_internal.h"
Alexey Samsonove218beb2012-08-09 09:06:52 +000016#include "asan_mapping.h"
Alexey Samsonov73545092012-08-09 07:40:58 +000017#include "asan_report.h"
18#include "asan_stack.h"
Alexey Samsonove4bfca22012-08-09 09:27:24 +000019#include "asan_thread.h"
Alexey Samsonov73545092012-08-09 07:40:58 +000020#include "asan_thread_registry.h"
Kostya Serebryany58f54552012-12-18 07:32:16 +000021#include "sanitizer_common/sanitizer_common.h"
22#include "sanitizer_common/sanitizer_report_decorator.h"
Alexey Samsonov9c927482012-12-26 14:44:46 +000023#include "sanitizer_common/sanitizer_symbolizer.h"
Alexey Samsonov73545092012-08-09 07:40:58 +000024
25namespace __asan {
26
Alexey Samsonovf657a192012-08-13 11:23:40 +000027// -------------------- User-specified callbacks ----------------- {{{1
Alexey Samsonovc98570b2012-08-09 10:56:57 +000028static 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
Kostya Serebryany58f54552012-12-18 07:32:16 +000046// ---------------------- Decorator ------------------------------ {{{1
Kostya Serebryany9514a532012-12-19 09:53:32 +000047bool 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}
Kostya Serebryany58f54552012-12-18 07:32:16 +000056class Decorator: private __sanitizer::AnsiColorDecorator {
57 public:
Kostya Serebryany9514a532012-12-19 09:53:32 +000058 Decorator() : __sanitizer::AnsiColorDecorator(PrintsToTtyCached()) { }
Kostya Serebryany58f54552012-12-18 07:32:16 +000059 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(); }
Kostya Serebryany9514a532012-12-19 09:53:32 +000067
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(); }
Kostya Serebryany58f54552012-12-18 07:32:16 +000097};
98
Alexey Samsonov98737922012-08-10 15:13:05 +000099// ---------------------- Helper functions ----------------------- {{{1
100
Kostya Serebryany9514a532012-12-19 09:53:32 +0000101static 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);
Alexey Samsonov98737922012-08-10 15:13:05 +0000119 }
Kostya Serebryany283c2962012-08-28 11:34:40 +0000120 Printf("\n");
Alexey Samsonov98737922012-08-10 15:13:05 +0000121}
122
Kostya Serebryany95f630a2013-01-28 07:34:22 +0000123static void PrintLegend() {
Kostya Serebryany9514a532012-12-19 09:53:32 +0000124 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 righ 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);
Kostya Serebryany9514a532012-12-19 09:53:32 +0000138 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);
Alexey Samsonov98737922012-08-10 15:13:05 +0000144}
145
Kostya Serebryany95f630a2013-01-28 07:34:22 +0000146static 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
Alexey Samsonov98737922012-08-10 15:13:05 +0000163static void PrintZoneForPointer(uptr ptr, uptr zone_ptr,
164 const char *zone_name) {
165 if (zone_ptr) {
166 if (zone_name) {
Kostya Serebryany283c2962012-08-28 11:34:40 +0000167 Printf("malloc_zone_from_ptr(%p) = %p, which is %s\n",
Alexey Samsonov98737922012-08-10 15:13:05 +0000168 ptr, zone_ptr, zone_name);
169 } else {
Kostya Serebryany283c2962012-08-28 11:34:40 +0000170 Printf("malloc_zone_from_ptr(%p) = %p, which doesn't have a name\n",
Alexey Samsonov98737922012-08-10 15:13:05 +0000171 ptr, zone_ptr);
172 }
173 } else {
Kostya Serebryany283c2962012-08-28 11:34:40 +0000174 Printf("malloc_zone_from_ptr(%p) = 0\n", ptr);
Alexey Samsonov98737922012-08-10 15:13:05 +0000175 }
176}
177
Alexey Samsonove218beb2012-08-09 09:06:52 +0000178// ---------------------- Address Descriptions ------------------- {{{1
179
Alexey Samsonove4bfca22012-08-09 09:27:24 +0000180static bool IsASCII(unsigned char c) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000181 return /*0x00 <= c &&*/ c <= 0x7F;
Alexey Samsonove4bfca22012-08-09 09:27:24 +0000182}
183
184// Check if the global is a zero-terminated ASCII string. If so, print it.
185static void PrintGlobalNameIfASCII(const __asan_global &g) {
186 for (uptr p = g.beg; p < g.beg + g.size - 1; p++) {
187 if (!IsASCII(*(unsigned char*)p)) return;
188 }
189 if (*(char*)(g.beg + g.size - 1) != 0) return;
Kostya Serebryany283c2962012-08-28 11:34:40 +0000190 Printf(" '%s' is ascii string '%s'\n", g.name, (char*)g.beg);
Alexey Samsonove4bfca22012-08-09 09:27:24 +0000191}
192
Evgeniy Stepanov589dcda2013-02-05 14:32:03 +0000193bool DescribeAddressRelativeToGlobal(uptr addr, uptr size,
194 const __asan_global &g) {
Kostya Serebryanya3b0e5e2013-01-23 11:14:21 +0000195 static const uptr kMinimalDistanceFromAnotherGlobal = 64;
196 if (addr <= g.beg - kMinimalDistanceFromAnotherGlobal) return false;
Alexey Samsonove4bfca22012-08-09 09:27:24 +0000197 if (addr >= g.beg + g.size_with_redzone) return false;
Kostya Serebryany58f54552012-12-18 07:32:16 +0000198 Decorator d;
199 Printf("%s", d.Location());
Alexey Samsonove4bfca22012-08-09 09:27:24 +0000200 if (addr < g.beg) {
Evgeniy Stepanov589dcda2013-02-05 14:32:03 +0000201 Printf("%p is located %zd bytes to the left", (void*)addr, g.beg - addr);
202 } else if (addr + size > g.beg + g.size) {
203 if (addr < g.beg + g.size)
204 addr = g.beg + g.size;
205 Printf("%p is located %zd bytes to the right", (void*)addr,
206 addr - (g.beg + g.size));
Alexey Samsonove4bfca22012-08-09 09:27:24 +0000207 } else {
Evgeniy Stepanov589dcda2013-02-05 14:32:03 +0000208 // Can it happen?
209 Printf("%p is located %zd bytes inside", (void*)addr, addr - g.beg);
Alexey Samsonove4bfca22012-08-09 09:27:24 +0000210 }
Kostya Serebryany60c9f442013-03-18 08:04:55 +0000211 Printf(" of global variable '%s' from '%s' (0x%zx) of size %zu\n",
212 g.name, g.module_name, g.beg, g.size);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000213 Printf("%s", d.EndLocation());
Alexey Samsonove4bfca22012-08-09 09:27:24 +0000214 PrintGlobalNameIfASCII(g);
215 return true;
216}
217
Alexey Samsonove218beb2012-08-09 09:06:52 +0000218bool DescribeAddressIfShadow(uptr addr) {
219 if (AddrIsInMem(addr))
220 return false;
221 static const char kAddrInShadowReport[] =
222 "Address %p is located in the %s.\n";
223 if (AddrIsInShadowGap(addr)) {
Kostya Serebryany283c2962012-08-28 11:34:40 +0000224 Printf(kAddrInShadowReport, addr, "shadow gap area");
Alexey Samsonove218beb2012-08-09 09:06:52 +0000225 return true;
226 }
227 if (AddrIsInHighShadow(addr)) {
Kostya Serebryany283c2962012-08-28 11:34:40 +0000228 Printf(kAddrInShadowReport, addr, "high shadow area");
Alexey Samsonove218beb2012-08-09 09:06:52 +0000229 return true;
230 }
231 if (AddrIsInLowShadow(addr)) {
Kostya Serebryany283c2962012-08-28 11:34:40 +0000232 Printf(kAddrInShadowReport, addr, "low shadow area");
Alexey Samsonove218beb2012-08-09 09:06:52 +0000233 return true;
234 }
235 CHECK(0 && "Address is not in memory and not in shadow?");
236 return false;
237}
238
239bool DescribeAddressIfStack(uptr addr, uptr access_size) {
240 AsanThread *t = asanThreadRegistry().FindThreadByStackAddress(addr);
241 if (!t) return false;
242 const sptr kBufSize = 4095;
243 char buf[kBufSize];
244 uptr offset = 0;
245 const char *frame_descr = t->GetFrameNameByAddr(addr, &offset);
246 // This string is created by the compiler and has the following form:
247 // "FunctioName n alloc_1 alloc_2 ... alloc_n"
248 // where alloc_i looks like "offset size len ObjectName ".
249 CHECK(frame_descr);
250 // Report the function name and the offset.
251 const char *name_end = internal_strchr(frame_descr, ' ');
252 CHECK(name_end);
253 buf[0] = 0;
254 internal_strncat(buf, frame_descr,
255 Min(kBufSize,
256 static_cast<sptr>(name_end - frame_descr)));
Kostya Serebryany58f54552012-12-18 07:32:16 +0000257 Decorator d;
258 Printf("%s", d.Location());
Kostya Serebryany283c2962012-08-28 11:34:40 +0000259 Printf("Address %p is located at offset %zu "
Alexey Samsonove218beb2012-08-09 09:06:52 +0000260 "in frame <%s> of T%d's stack:\n",
Alexey Samsonov9c927482012-12-26 14:44:46 +0000261 (void*)addr, offset, Demangle(buf), t->tid());
Kostya Serebryany58f54552012-12-18 07:32:16 +0000262 Printf("%s", d.EndLocation());
Alexey Samsonove218beb2012-08-09 09:06:52 +0000263 // Report the number of stack objects.
264 char *p;
265 uptr n_objects = internal_simple_strtoll(name_end, &p, 10);
266 CHECK(n_objects > 0);
Kostya Serebryany283c2962012-08-28 11:34:40 +0000267 Printf(" This frame has %zu object(s):\n", n_objects);
Alexey Samsonove218beb2012-08-09 09:06:52 +0000268 // Report all objects in this frame.
269 for (uptr i = 0; i < n_objects; i++) {
270 uptr beg, size;
271 sptr len;
272 beg = internal_simple_strtoll(p, &p, 10);
273 size = internal_simple_strtoll(p, &p, 10);
274 len = internal_simple_strtoll(p, &p, 10);
275 if (beg <= 0 || size <= 0 || len < 0 || *p != ' ') {
Kostya Serebryany283c2962012-08-28 11:34:40 +0000276 Printf("AddressSanitizer can't parse the stack frame "
Alexey Samsonove218beb2012-08-09 09:06:52 +0000277 "descriptor: |%s|\n", frame_descr);
278 break;
279 }
280 p++;
281 buf[0] = 0;
282 internal_strncat(buf, p, Min(kBufSize, len));
283 p += len;
Kostya Serebryany283c2962012-08-28 11:34:40 +0000284 Printf(" [%zu, %zu) '%s'\n", beg, beg + size, buf);
Alexey Samsonove218beb2012-08-09 09:06:52 +0000285 }
Kostya Serebryany283c2962012-08-28 11:34:40 +0000286 Printf("HINT: this may be a false positive if your program uses "
Alexey Samsonov08700282012-11-23 09:46:34 +0000287 "some custom stack unwind mechanism or swapcontext\n"
Alexey Samsonove218beb2012-08-09 09:06:52 +0000288 " (longjmp and C++ exceptions *are* supported)\n");
Alexey Samsonov71b42c92012-09-05 07:37:15 +0000289 DescribeThread(t->summary());
Alexey Samsonove218beb2012-08-09 09:06:52 +0000290 return true;
291}
292
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000293static void DescribeAccessToHeapChunk(AsanChunkView chunk, uptr addr,
294 uptr access_size) {
Evgeniy Stepanov589dcda2013-02-05 14:32:03 +0000295 sptr offset;
Kostya Serebryany58f54552012-12-18 07:32:16 +0000296 Decorator d;
297 Printf("%s", d.Location());
Evgeniy Stepanov589dcda2013-02-05 14:32:03 +0000298 if (chunk.AddrIsAtLeft(addr, access_size, &offset)) {
299 Printf("%p is located %zd bytes to the left of", (void*)addr, offset);
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000300 } else if (chunk.AddrIsAtRight(addr, access_size, &offset)) {
Evgeniy Stepanov589dcda2013-02-05 14:32:03 +0000301 if (offset < 0) {
302 addr -= offset;
303 offset = 0;
304 }
305 Printf("%p is located %zd bytes to the right of", (void*)addr, offset);
306 } else if (chunk.AddrIsInside(addr, access_size, &offset)) {
307 Printf("%p is located %zd bytes inside of", (void*)addr, offset);
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000308 } else {
Evgeniy Stepanov589dcda2013-02-05 14:32:03 +0000309 Printf("%p is located somewhere around (this is AddressSanitizer bug!)",
310 (void*)addr);
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000311 }
312 Printf(" %zu-byte region [%p,%p)\n", chunk.UsedSize(),
313 (void*)(chunk.Beg()), (void*)(chunk.End()));
Kostya Serebryany58f54552012-12-18 07:32:16 +0000314 Printf("%s", d.EndLocation());
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000315}
316
Kostya Serebryany716e2f22012-12-07 15:15:01 +0000317// Return " (thread_name) " or an empty string if the name is empty.
318const char *ThreadNameWithParenthesis(AsanThreadSummary *t, char buff[],
319 uptr buff_len) {
320 const char *name = t->name();
321 if (*name == 0) return "";
322 buff[0] = 0;
323 internal_strncat(buff, " (", 3);
324 internal_strncat(buff, name, buff_len - 4);
325 internal_strncat(buff, ")", 2);
326 return buff;
327}
328
329const char *ThreadNameWithParenthesis(u32 tid, char buff[],
330 uptr buff_len) {
331 if (tid == kInvalidTid) return "";
332 AsanThreadSummary *t = asanThreadRegistry().FindByTid(tid);
333 return ThreadNameWithParenthesis(t, buff, buff_len);
334}
335
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000336void DescribeHeapAddress(uptr addr, uptr access_size) {
337 AsanChunkView chunk = FindHeapChunkByAddress(addr);
338 if (!chunk.IsValid()) return;
339 DescribeAccessToHeapChunk(chunk, addr, access_size);
340 CHECK(chunk.AllocTid() != kInvalidTid);
341 AsanThreadSummary *alloc_thread =
342 asanThreadRegistry().FindByTid(chunk.AllocTid());
343 StackTrace alloc_stack;
344 chunk.GetAllocStack(&alloc_stack);
345 AsanThread *t = asanThreadRegistry().GetCurrent();
346 CHECK(t);
Kostya Serebryany716e2f22012-12-07 15:15:01 +0000347 char tname[128];
Kostya Serebryany58f54552012-12-18 07:32:16 +0000348 Decorator d;
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000349 if (chunk.FreeTid() != kInvalidTid) {
350 AsanThreadSummary *free_thread =
351 asanThreadRegistry().FindByTid(chunk.FreeTid());
Kostya Serebryany58f54552012-12-18 07:32:16 +0000352 Printf("%sfreed by thread T%d%s here:%s\n", d.Allocation(),
353 free_thread->tid(),
354 ThreadNameWithParenthesis(free_thread, tname, sizeof(tname)),
355 d.EndAllocation());
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000356 StackTrace free_stack;
357 chunk.GetFreeStack(&free_stack);
358 PrintStack(&free_stack);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000359 Printf("%spreviously allocated by thread T%d%s here:%s\n",
360 d.Allocation(), alloc_thread->tid(),
361 ThreadNameWithParenthesis(alloc_thread, tname, sizeof(tname)),
362 d.EndAllocation());
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000363 PrintStack(&alloc_stack);
364 DescribeThread(t->summary());
365 DescribeThread(free_thread);
366 DescribeThread(alloc_thread);
367 } else {
Kostya Serebryany58f54552012-12-18 07:32:16 +0000368 Printf("%sallocated by thread T%d%s here:%s\n", d.Allocation(),
369 alloc_thread->tid(),
370 ThreadNameWithParenthesis(alloc_thread, tname, sizeof(tname)),
371 d.EndAllocation());
Alexey Samsonov5c153fa2012-09-18 07:38:10 +0000372 PrintStack(&alloc_stack);
373 DescribeThread(t->summary());
374 DescribeThread(alloc_thread);
375 }
376}
377
Alexey Samsonove218beb2012-08-09 09:06:52 +0000378void DescribeAddress(uptr addr, uptr access_size) {
379 // Check if this is shadow or shadow gap.
380 if (DescribeAddressIfShadow(addr))
381 return;
382 CHECK(AddrIsInMem(addr));
Evgeniy Stepanov589dcda2013-02-05 14:32:03 +0000383 if (DescribeAddressIfGlobal(addr, access_size))
Alexey Samsonove218beb2012-08-09 09:06:52 +0000384 return;
385 if (DescribeAddressIfStack(addr, access_size))
386 return;
387 // Assume it is a heap address.
388 DescribeHeapAddress(addr, access_size);
389}
390
Alexey Samsonov71b42c92012-09-05 07:37:15 +0000391// ------------------- Thread description -------------------- {{{1
392
393void DescribeThread(AsanThreadSummary *summary) {
394 CHECK(summary);
395 // No need to announce the main thread.
396 if (summary->tid() == 0 || summary->announced()) {
397 return;
398 }
399 summary->set_announced(true);
Kostya Serebryany716e2f22012-12-07 15:15:01 +0000400 char tname[128];
401 Printf("Thread T%d%s", summary->tid(),
402 ThreadNameWithParenthesis(summary->tid(), tname, sizeof(tname)));
403 Printf(" created by T%d%s here:\n",
404 summary->parent_tid(),
405 ThreadNameWithParenthesis(summary->parent_tid(),
406 tname, sizeof(tname)));
Alexey Samsonov71b42c92012-09-05 07:37:15 +0000407 PrintStack(summary->stack());
408 // Recursively described parent thread if needed.
409 if (flags()->print_full_thread_history) {
410 AsanThreadSummary *parent_summary =
411 asanThreadRegistry().FindByTid(summary->parent_tid());
412 DescribeThread(parent_summary);
413 }
414}
415
Alexey Samsonove218beb2012-08-09 09:06:52 +0000416// -------------------- Different kinds of reports ----------------- {{{1
417
Alexey Samsonov98737922012-08-10 15:13:05 +0000418// Use ScopedInErrorReport to run common actions just before and
419// immediately after printing error report.
420class ScopedInErrorReport {
421 public:
422 ScopedInErrorReport() {
423 static atomic_uint32_t num_calls;
Alexey Samsonov62e27092012-09-17 08:02:19 +0000424 static u32 reporting_thread_tid;
Alexey Samsonov98737922012-08-10 15:13:05 +0000425 if (atomic_fetch_add(&num_calls, 1, memory_order_relaxed) != 0) {
426 // Do not print more than one report, otherwise they will mix up.
427 // Error reporting functions shouldn't return at this situation, as
428 // they are defined as no-return.
Kostya Serebryany283c2962012-08-28 11:34:40 +0000429 Report("AddressSanitizer: while reporting a bug found another one."
Alexey Samsonov98737922012-08-10 15:13:05 +0000430 "Ignoring.\n");
Alexey Samsonov62e27092012-09-17 08:02:19 +0000431 u32 current_tid = asanThreadRegistry().GetCurrentTidOrInvalid();
432 if (current_tid != reporting_thread_tid) {
433 // ASan found two bugs in different threads simultaneously. Sleep
434 // long enough to make sure that the thread which started to print
435 // an error report will finish doing it.
436 SleepForSeconds(Max(100, flags()->sleep_before_dying + 1));
437 }
Alexey Samsonovf8822472013-02-20 13:54:32 +0000438 // If we're still not dead for some reason, use raw _exit() instead of
Alexey Samsonov031633b2012-11-19 11:22:22 +0000439 // Die() to bypass any additional checks.
Alexey Samsonovf8822472013-02-20 13:54:32 +0000440 internal__exit(flags()->exitcode);
Alexey Samsonov98737922012-08-10 15:13:05 +0000441 }
Alexey Samsonov6a08d292012-12-07 22:01:28 +0000442 ASAN_ON_ERROR();
Alexey Samsonov62e27092012-09-17 08:02:19 +0000443 reporting_thread_tid = asanThreadRegistry().GetCurrentTidOrInvalid();
Kostya Serebryany283c2962012-08-28 11:34:40 +0000444 Printf("===================================================="
Alexey Samsonov62e27092012-09-17 08:02:19 +0000445 "=============\n");
446 if (reporting_thread_tid != kInvalidTid) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000447 // We started reporting an error message. Stop using the fake stack
448 // in case we call an instrumented function from a symbolizer.
Alexey Samsonov62e27092012-09-17 08:02:19 +0000449 AsanThread *curr_thread = asanThreadRegistry().GetCurrent();
450 CHECK(curr_thread);
Alexey Samsonov98737922012-08-10 15:13:05 +0000451 curr_thread->fake_stack().StopUsingFakeStack();
452 }
453 }
454 // Destructor is NORETURN, as functions that report errors are.
455 NORETURN ~ScopedInErrorReport() {
456 // Make sure the current thread is announced.
457 AsanThread *curr_thread = asanThreadRegistry().GetCurrent();
458 if (curr_thread) {
Alexey Samsonov71b42c92012-09-05 07:37:15 +0000459 DescribeThread(curr_thread->summary());
Alexey Samsonov98737922012-08-10 15:13:05 +0000460 }
461 // Print memory stats.
Kostya Serebryany95f630a2013-01-28 07:34:22 +0000462 if (flags()->print_stats)
463 __asan_print_accumulated_stats();
Alexey Samsonov98737922012-08-10 15:13:05 +0000464 if (error_report_callback) {
465 error_report_callback(error_message_buffer);
466 }
Kostya Serebryany283c2962012-08-28 11:34:40 +0000467 Report("ABORTING\n");
Alexey Samsonov98737922012-08-10 15:13:05 +0000468 Die();
469 }
470};
471
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000472static void ReportSummary(const char *error_type, StackTrace *stack) {
473 if (!stack->size) return;
474 if (IsSymbolizerAvailable()) {
475 AddressInfo ai;
476 // Currently, we include the first stack frame into the report summary.
477 // Maybe sometimes we need to choose another frame (e.g. skip memcpy/etc).
478 SymbolizeCode(stack->trace[0], &ai, 1);
479 ReportErrorSummary(error_type,
480 StripPathPrefix(ai.file, flags()->strip_path_prefix),
481 ai.line, ai.function);
482 }
483 // FIXME: do we need to print anything at all if there is no symbolizer?
484}
485
Alexey Samsonov73545092012-08-09 07:40:58 +0000486void ReportSIGSEGV(uptr pc, uptr sp, uptr bp, uptr addr) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000487 ScopedInErrorReport in_report;
Kostya Serebryany58f54552012-12-18 07:32:16 +0000488 Decorator d;
489 Printf("%s", d.Warning());
Kostya Serebryany69d8ede2012-10-15 13:04:58 +0000490 Report("ERROR: AddressSanitizer: SEGV on unknown address %p"
Alexey Samsonov73545092012-08-09 07:40:58 +0000491 " (pc %p sp %p bp %p T%d)\n",
492 (void*)addr, (void*)pc, (void*)sp, (void*)bp,
493 asanThreadRegistry().GetCurrentTidOrInvalid());
Kostya Serebryany58f54552012-12-18 07:32:16 +0000494 Printf("%s", d.EndWarning());
Kostya Serebryany283c2962012-08-28 11:34:40 +0000495 Printf("AddressSanitizer can not provide additional info.\n");
Kostya Serebryanya30c8f92012-12-13 09:34:23 +0000496 GET_STACK_TRACE_FATAL(pc, bp);
Kostya Serebryanycc347222012-08-28 13:49:49 +0000497 PrintStack(&stack);
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000498 ReportSummary("SEGV", &stack);
Alexey Samsonov73545092012-08-09 07:40:58 +0000499}
500
Kostya Serebryanyc3390df2012-08-28 11:54:30 +0000501void ReportDoubleFree(uptr addr, StackTrace *stack) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000502 ScopedInErrorReport in_report;
Kostya Serebryany58f54552012-12-18 07:32:16 +0000503 Decorator d;
504 Printf("%s", d.Warning());
Kostya Serebryany69d8ede2012-10-15 13:04:58 +0000505 Report("ERROR: AddressSanitizer: attempting double-free on %p:\n", addr);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000506 Printf("%s", d.EndWarning());
Kostya Serebryanycc347222012-08-28 13:49:49 +0000507 PrintStack(stack);
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000508 DescribeHeapAddress(addr, 1);
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000509 ReportSummary("double-free", stack);
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000510}
511
Kostya Serebryanyc3390df2012-08-28 11:54:30 +0000512void ReportFreeNotMalloced(uptr addr, StackTrace *stack) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000513 ScopedInErrorReport in_report;
Kostya Serebryany58f54552012-12-18 07:32:16 +0000514 Decorator d;
515 Printf("%s", d.Warning());
Kostya Serebryany69d8ede2012-10-15 13:04:58 +0000516 Report("ERROR: AddressSanitizer: attempting free on address "
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000517 "which was not malloc()-ed: %p\n", addr);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000518 Printf("%s", d.EndWarning());
Kostya Serebryanycc347222012-08-28 13:49:49 +0000519 PrintStack(stack);
Alexey Samsonov98737922012-08-10 15:13:05 +0000520 DescribeHeapAddress(addr, 1);
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000521 ReportSummary("bad-free", stack);
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000522}
523
Kostya Serebryanyfe6d9162012-12-21 08:53:59 +0000524void ReportAllocTypeMismatch(uptr addr, StackTrace *stack,
525 AllocType alloc_type,
526 AllocType dealloc_type) {
527 static const char *alloc_names[] =
528 {"INVALID", "malloc", "operator new", "operator new []"};
529 static const char *dealloc_names[] =
530 {"INVALID", "free", "operator delete", "operator delete []"};
531 CHECK_NE(alloc_type, dealloc_type);
532 ScopedInErrorReport in_report;
533 Decorator d;
534 Printf("%s", d.Warning());
535 Report("ERROR: AddressSanitizer: alloc-dealloc-mismatch (%s vs %s) on %p\n",
536 alloc_names[alloc_type], dealloc_names[dealloc_type], addr);
537 Printf("%s", d.EndWarning());
538 PrintStack(stack);
539 DescribeHeapAddress(addr, 1);
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000540 ReportSummary("alloc-dealloc-mismatch", stack);
Kostya Serebryanyfe6d9162012-12-21 08:53:59 +0000541 Report("HINT: if you don't care about these warnings you may set "
542 "ASAN_OPTIONS=alloc_dealloc_mismatch=0\n");
543}
544
Kostya Serebryanyc3390df2012-08-28 11:54:30 +0000545void ReportMallocUsableSizeNotOwned(uptr addr, StackTrace *stack) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000546 ScopedInErrorReport in_report;
Kostya Serebryany58f54552012-12-18 07:32:16 +0000547 Decorator d;
548 Printf("%s", d.Warning());
Kostya Serebryany69d8ede2012-10-15 13:04:58 +0000549 Report("ERROR: AddressSanitizer: attempting to call "
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000550 "malloc_usable_size() for pointer which is "
551 "not owned: %p\n", addr);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000552 Printf("%s", d.EndWarning());
Kostya Serebryanycc347222012-08-28 13:49:49 +0000553 PrintStack(stack);
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000554 DescribeHeapAddress(addr, 1);
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000555 ReportSummary("bad-malloc_usable_size", stack);
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000556}
557
Kostya Serebryanyc3390df2012-08-28 11:54:30 +0000558void ReportAsanGetAllocatedSizeNotOwned(uptr addr, StackTrace *stack) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000559 ScopedInErrorReport in_report;
Kostya Serebryany58f54552012-12-18 07:32:16 +0000560 Decorator d;
561 Printf("%s", d.Warning());
Kostya Serebryany69d8ede2012-10-15 13:04:58 +0000562 Report("ERROR: AddressSanitizer: attempting to call "
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000563 "__asan_get_allocated_size() for pointer which is "
564 "not owned: %p\n", addr);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000565 Printf("%s", d.EndWarning());
Kostya Serebryanycc347222012-08-28 13:49:49 +0000566 PrintStack(stack);
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000567 DescribeHeapAddress(addr, 1);
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000568 ReportSummary("bad-__asan_get_allocated_size", stack);
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000569}
570
Alexey Samsonov487fee72012-08-09 08:32:33 +0000571void ReportStringFunctionMemoryRangesOverlap(
572 const char *function, const char *offset1, uptr length1,
Kostya Serebryanyc3390df2012-08-28 11:54:30 +0000573 const char *offset2, uptr length2, StackTrace *stack) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000574 ScopedInErrorReport in_report;
Kostya Serebryany58f54552012-12-18 07:32:16 +0000575 Decorator d;
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000576 char bug_type[100];
577 internal_snprintf(bug_type, sizeof(bug_type), "%s-param-overlap", function);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000578 Printf("%s", d.Warning());
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000579 Report("ERROR: AddressSanitizer: %s: "
Alexey Samsonov487fee72012-08-09 08:32:33 +0000580 "memory ranges [%p,%p) and [%p, %p) overlap\n", \
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000581 bug_type, offset1, offset1 + length1, offset2, offset2 + length2);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000582 Printf("%s", d.EndWarning());
Kostya Serebryanycc347222012-08-28 13:49:49 +0000583 PrintStack(stack);
Alexey Samsonov98737922012-08-10 15:13:05 +0000584 DescribeAddress((uptr)offset1, length1);
585 DescribeAddress((uptr)offset2, length2);
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000586 ReportSummary(bug_type, stack);
Alexey Samsonov487fee72012-08-09 08:32:33 +0000587}
Alexey Samsonovf7c1d182012-08-09 08:15:46 +0000588
Alexey Samsonov663c5012012-08-09 12:15:40 +0000589// ----------------------- Mac-specific reports ----------------- {{{1
590
Alexey Samsonov663c5012012-08-09 12:15:40 +0000591void WarnMacFreeUnallocated(
Kostya Serebryanyc3390df2012-08-28 11:54:30 +0000592 uptr addr, uptr zone_ptr, const char *zone_name, StackTrace *stack) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000593 // Just print a warning here.
Kostya Serebryany283c2962012-08-28 11:34:40 +0000594 Printf("free_common(%p) -- attempting to free unallocated memory.\n"
Alexey Samsonov663c5012012-08-09 12:15:40 +0000595 "AddressSanitizer is ignoring this error on Mac OS now.\n",
596 addr);
597 PrintZoneForPointer(addr, zone_ptr, zone_name);
Kostya Serebryanycc347222012-08-28 13:49:49 +0000598 PrintStack(stack);
Alexey Samsonov98737922012-08-10 15:13:05 +0000599 DescribeHeapAddress(addr, 1);
Alexey Samsonov663c5012012-08-09 12:15:40 +0000600}
601
602void ReportMacMzReallocUnknown(
Kostya Serebryanyc3390df2012-08-28 11:54:30 +0000603 uptr addr, uptr zone_ptr, const char *zone_name, StackTrace *stack) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000604 ScopedInErrorReport in_report;
Kostya Serebryany283c2962012-08-28 11:34:40 +0000605 Printf("mz_realloc(%p) -- attempting to realloc unallocated memory.\n"
Alexey Samsonov663c5012012-08-09 12:15:40 +0000606 "This is an unrecoverable problem, exiting now.\n",
607 addr);
608 PrintZoneForPointer(addr, zone_ptr, zone_name);
Kostya Serebryanycc347222012-08-28 13:49:49 +0000609 PrintStack(stack);
Alexey Samsonov98737922012-08-10 15:13:05 +0000610 DescribeHeapAddress(addr, 1);
Alexey Samsonov663c5012012-08-09 12:15:40 +0000611}
612
613void ReportMacCfReallocUnknown(
Kostya Serebryanyc3390df2012-08-28 11:54:30 +0000614 uptr addr, uptr zone_ptr, const char *zone_name, StackTrace *stack) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000615 ScopedInErrorReport in_report;
Kostya Serebryany283c2962012-08-28 11:34:40 +0000616 Printf("cf_realloc(%p) -- attempting to realloc unallocated memory.\n"
Alexey Samsonov663c5012012-08-09 12:15:40 +0000617 "This is an unrecoverable problem, exiting now.\n",
618 addr);
619 PrintZoneForPointer(addr, zone_ptr, zone_name);
Kostya Serebryanycc347222012-08-28 13:49:49 +0000620 PrintStack(stack);
Alexey Samsonov98737922012-08-10 15:13:05 +0000621 DescribeHeapAddress(addr, 1);
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000622}
623
Alexey Samsonov812ff902012-08-09 11:29:13 +0000624} // namespace __asan
625
626// --------------------------- Interface --------------------- {{{1
627using namespace __asan; // NOLINT
628
629void __asan_report_error(uptr pc, uptr bp, uptr sp,
630 uptr addr, bool is_write, uptr access_size) {
Alexey Samsonov98737922012-08-10 15:13:05 +0000631 ScopedInErrorReport in_report;
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000632
Alexey Samsonov98737922012-08-10 15:13:05 +0000633 // Determine the error type.
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000634 const char *bug_descr = "unknown-crash";
635 if (AddrIsInMem(addr)) {
636 u8 *shadow_addr = (u8*)MemToShadow(addr);
637 // If we are accessing 16 bytes, look at the second shadow byte.
638 if (*shadow_addr == 0 && access_size > SHADOW_GRANULARITY)
639 shadow_addr++;
640 // If we are in the partial right redzone, look at the next shadow byte.
641 if (*shadow_addr > 0 && *shadow_addr < 128)
642 shadow_addr++;
643 switch (*shadow_addr) {
644 case kAsanHeapLeftRedzoneMagic:
645 case kAsanHeapRightRedzoneMagic:
646 bug_descr = "heap-buffer-overflow";
647 break;
648 case kAsanHeapFreeMagic:
649 bug_descr = "heap-use-after-free";
650 break;
651 case kAsanStackLeftRedzoneMagic:
652 bug_descr = "stack-buffer-underflow";
653 break;
Kostya Serebryany3945c582012-08-21 14:10:25 +0000654 case kAsanInitializationOrderMagic:
655 bug_descr = "initialization-order-fiasco";
656 break;
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000657 case kAsanStackMidRedzoneMagic:
658 case kAsanStackRightRedzoneMagic:
659 case kAsanStackPartialRedzoneMagic:
660 bug_descr = "stack-buffer-overflow";
661 break;
662 case kAsanStackAfterReturnMagic:
663 bug_descr = "stack-use-after-return";
664 break;
665 case kAsanUserPoisonedMemoryMagic:
666 bug_descr = "use-after-poison";
667 break;
Alexey Samsonovd4b5db82012-12-04 01:38:15 +0000668 case kAsanStackUseAfterScopeMagic:
669 bug_descr = "stack-use-after-scope";
670 break;
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000671 case kAsanGlobalRedzoneMagic:
672 bug_descr = "global-buffer-overflow";
673 break;
674 }
675 }
Kostya Serebryany58f54552012-12-18 07:32:16 +0000676 Decorator d;
677 Printf("%s", d.Warning());
Kostya Serebryany69d8ede2012-10-15 13:04:58 +0000678 Report("ERROR: AddressSanitizer: %s on address "
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000679 "%p at pc 0x%zx bp 0x%zx sp 0x%zx\n",
680 bug_descr, (void*)addr, pc, bp, sp);
Kostya Serebryany58f54552012-12-18 07:32:16 +0000681 Printf("%s", d.EndWarning());
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000682
Alexey Samsonov98737922012-08-10 15:13:05 +0000683 u32 curr_tid = asanThreadRegistry().GetCurrentTidOrInvalid();
Kostya Serebryany716e2f22012-12-07 15:15:01 +0000684 char tname[128];
Kostya Serebryany58f54552012-12-18 07:32:16 +0000685 Printf("%s%s of size %zu at %p thread T%d%s%s\n",
686 d.Access(),
687 access_size ? (is_write ? "WRITE" : "READ") : "ACCESS",
688 access_size, (void*)addr, curr_tid,
689 ThreadNameWithParenthesis(curr_tid, tname, sizeof(tname)),
690 d.EndAccess());
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000691
Kostya Serebryanya30c8f92012-12-13 09:34:23 +0000692 GET_STACK_TRACE_FATAL(pc, bp);
Kostya Serebryanycc347222012-08-28 13:49:49 +0000693 PrintStack(&stack);
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000694
695 DescribeAddress(addr, access_size);
Kostya Serebryany2673fd82013-02-06 12:36:49 +0000696 ReportSummary(bug_descr, &stack);
Alexey Samsonov98737922012-08-10 15:13:05 +0000697 PrintShadowMemoryForAddress(addr);
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000698}
699
Alexey Samsonovc98570b2012-08-09 10:56:57 +0000700void NOINLINE __asan_set_error_report_callback(void (*callback)(const char*)) {
701 error_report_callback = callback;
702 if (callback) {
703 error_message_buffer_size = 1 << 16;
704 error_message_buffer =
705 (char*)MmapOrDie(error_message_buffer_size, __FUNCTION__);
706 error_message_buffer_pos = 0;
707 }
708}
Alexey Samsonovf657a192012-08-13 11:23:40 +0000709
Kostya Serebryany17a7c672012-12-29 10:18:31 +0000710void __asan_describe_address(uptr addr) {
711 DescribeAddress(addr, 1);
712}
713
Alexey Samsonov6a08d292012-12-07 22:01:28 +0000714#if !SANITIZER_SUPPORTS_WEAK_HOOKS
Alexey Samsonov86633432012-10-02 14:06:39 +0000715// Provide default implementation of __asan_on_error that does nothing
716// and may be overriden by user.
717SANITIZER_WEAK_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE NOINLINE
718void __asan_on_error() {}
Alexey Samsonov6a08d292012-12-07 22:01:28 +0000719#endif