lib/lsan/lsan_common.cc

   1 //=-- lsan_common.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 LeakSanitizer.
  11 // Implementation of common leak checking functionality.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "lsan_common.h"
  16
  17 #include "sanitizer_common/sanitizer_common.h"
  18 #include "sanitizer_common/sanitizer_flags.h"
  19 #include "sanitizer_common/sanitizer_flag_parser.h"
  20 #include "sanitizer_common/sanitizer_placement_new.h"
  21 #include "sanitizer_common/sanitizer_procmaps.h"
  22 #include "sanitizer_common/sanitizer_stackdepot.h"
  23 #include "sanitizer_common/sanitizer_stacktrace.h"
  24 #include "sanitizer_common/sanitizer_suppressions.h"
  25 #include "sanitizer_common/sanitizer_report_decorator.h"
  26 #include "sanitizer_common/sanitizer_tls_get_addr.h"
  27
  28 #if CAN_SANITIZE_LEAKS
  29 namespace __lsan {
  30
  31 // This mutex is used to prevent races between DoLeakCheck and IgnoreObject, and
  32 // also to protect the global list of root regions.
  33 BlockingMutex global_mutex(LINKER_INITIALIZED);
  34
  35 Flags lsan_flags;
  36
  37 void DisableCounterUnderflow() {
  38   if (common_flags()->detect_leaks) {
  39     Report("Unmatched call to __lsan_enable().\n");
  40     Die();
  41   }
  42 }
  43
  44 void Flags::SetDefaults() {
  45 #define LSAN_FLAG(Type, Name, DefaultValue, Description) Name = DefaultValue;
  46 #include "lsan_flags.inc"
  47 #undef LSAN_FLAG
  48 }
  49
  50 void RegisterLsanFlags(FlagParser *parser, Flags *f) {
  51 #define LSAN_FLAG(Type, Name, DefaultValue, Description) \
  52   RegisterFlag(parser, #Name, Description, &f->Name);
  53 #include "lsan_flags.inc"
  54 #undef LSAN_FLAG
  55 }
  56
  57 #define LOG_POINTERS(...)                           \
  58   do {                                              \
  59     if (flags()->log_pointers) Report(__VA_ARGS__); \
  60   } while (0)
  61
  62 #define LOG_THREADS(...)                           \
  63   do {                                             \
  64     if (flags()->log_threads) Report(__VA_ARGS__); \
  65   } while (0)
  66
  67 ALIGNED(64) static char suppression_placeholder[sizeof(SuppressionContext)];
  68 static SuppressionContext *suppression_ctx = nullptr;
  69 static const char kSuppressionLeak[] = "leak";
  70 static const char *kSuppressionTypes[] = { kSuppressionLeak };
  71 static const char kStdSuppressions[] =
  72 #if SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT
  73   // For more details refer to the SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT
  74   // definition.
  75   "leak:*pthread_exit*\n"
  76 #endif  // SANITIZER_SUPPRESS_LEAK_ON_PTHREAD_EXIT
  77 #if SANITIZER_MAC
  78   // For Darwin and os_log/os_trace: https://reviews.llvm.org/D35173
  79   "leak:*_os_trace*\n"
  80 #endif
  81   // TLS leak in some glibc versions, described in
  82   // https://sourceware.org/bugzilla/show_bug.cgi?id=12650.
  83   "leak:*tls_get_addr*\n";
  84
  85 void InitializeSuppressions() {
  86   CHECK_EQ(nullptr, suppression_ctx);
  87   suppression_ctx = new (suppression_placeholder) // NOLINT
  88       SuppressionContext(kSuppressionTypes, ARRAY_SIZE(kSuppressionTypes));
  89   suppression_ctx->ParseFromFile(flags()->suppressions);
  90   if (&__lsan_default_suppressions)
  91     suppression_ctx->Parse(__lsan_default_suppressions());
  92   suppression_ctx->Parse(kStdSuppressions);
  93 }
  94
  95 static SuppressionContext *GetSuppressionContext() {
  96   CHECK(suppression_ctx);
  97   return suppression_ctx;
  98 }
  99
 100 static InternalMmapVector<RootRegion> *root_regions;
 101
 102 InternalMmapVector<RootRegion> const *GetRootRegions() { return root_regions; }
 103
 104 void InitializeRootRegions() {
 105   CHECK(!root_regions);
 106   ALIGNED(64) static char placeholder[sizeof(InternalMmapVector<RootRegion>)];
 107   root_regions = new(placeholder) InternalMmapVector<RootRegion>(1);
 108 }
 109
 110 const char *MaybeCallLsanDefaultOptions() {
 111   return (&__lsan_default_options) ? __lsan_default_options() : "";
 112 }
 113
 114 void InitCommonLsan() {
 115   InitializeRootRegions();
 116   if (common_flags()->detect_leaks) {
 117     // Initialization which can fail or print warnings should only be done if
 118     // LSan is actually enabled.
 119     InitializeSuppressions();
 120     InitializePlatformSpecificModules();
 121   }
 122 }
 123
 124 class Decorator: public __sanitizer::SanitizerCommonDecorator {
 125  public:
 126   Decorator() : SanitizerCommonDecorator() { }
 127   const char *Error() { return Red(); }
 128   const char *Leak() { return Blue(); }
 129 };
 130
 131 static inline bool CanBeAHeapPointer(uptr p) {
 132   // Since our heap is located in mmap-ed memory, we can assume a sensible lower
 133   // bound on heap addresses.
 134   const uptr kMinAddress = 4 * 4096;
 135   if (p < kMinAddress) return false;
 136 #if defined(__x86_64__)
 137   // Accept only canonical form user-space addresses.
 138   return ((p >> 47) == 0);
 139 #elif defined(__mips64)
 140   return ((p >> 40) == 0);
 141 #elif defined(__aarch64__)
 142   unsigned runtimeVMA =
 143     (MostSignificantSetBitIndex(GET_CURRENT_FRAME()) + 1);
 144   return ((p >> runtimeVMA) == 0);
 145 #else
 146   return true;
 147 #endif
 148 }
 149
 150 // Scans the memory range, looking for byte patterns that point into allocator
 151 // chunks. Marks those chunks with |tag| and adds them to |frontier|.
 152 // There are two usage modes for this function: finding reachable chunks
 153 // (|tag| = kReachable) and finding indirectly leaked chunks
 154 // (|tag| = kIndirectlyLeaked). In the second case, there's no flood fill,
 155 // so |frontier| = 0.
 156 void ScanRangeForPointers(uptr begin, uptr end,
 157                           Frontier *frontier,
 158                           const char *region_type, ChunkTag tag) {
 159   CHECK(tag == kReachable || tag == kIndirectlyLeaked);
 160   const uptr alignment = flags()->pointer_alignment();
 161   LOG_POINTERS("Scanning %s range %p-%p.\n", region_type, begin, end);
 162   uptr pp = begin;
 163   if (pp % alignment)
 164     pp = pp + alignment - pp % alignment;
 165   for (; pp + sizeof(void *) <= end; pp += alignment) {  // NOLINT
 166     void *p = *reinterpret_cast<void **>(pp);
 167     if (!CanBeAHeapPointer(reinterpret_cast<uptr>(p))) continue;
 168     uptr chunk = PointsIntoChunk(p);
 169     if (!chunk) continue;
 170     // Pointers to self don't count. This matters when tag == kIndirectlyLeaked.
 171     if (chunk == begin) continue;
 172     LsanMetadata m(chunk);
 173     if (m.tag() == kReachable || m.tag() == kIgnored) continue;
 174
 175     // Do this check relatively late so we can log only the interesting cases.
 176     if (!flags()->use_poisoned && WordIsPoisoned(pp)) {
 177       LOG_POINTERS(
 178           "%p is poisoned: ignoring %p pointing into chunk %p-%p of size "
 179           "%zu.\n",
 180           pp, p, chunk, chunk + m.requested_size(), m.requested_size());
 181       continue;
 182     }
 183
 184     m.set_tag(tag);
 185     LOG_POINTERS("%p: found %p pointing into chunk %p-%p of size %zu.\n", pp, p,
 186                  chunk, chunk + m.requested_size(), m.requested_size());
 187     if (frontier)
 188       frontier->push_back(chunk);
 189   }
 190 }
 191
 192 // Scans a global range for pointers
 193 void ScanGlobalRange(uptr begin, uptr end, Frontier *frontier) {
 194   uptr allocator_begin = 0, allocator_end = 0;
 195   GetAllocatorGlobalRange(&allocator_begin, &allocator_end);
 196   if (begin <= allocator_begin && allocator_begin < end) {
 197     CHECK_LE(allocator_begin, allocator_end);
 198     CHECK_LE(allocator_end, end);
 199     if (begin < allocator_begin)
 200       ScanRangeForPointers(begin, allocator_begin, frontier, "GLOBAL",
 201                            kReachable);
 202     if (allocator_end < end)
 203       ScanRangeForPointers(allocator_end, end, frontier, "GLOBAL", kReachable);
 204   } else {
 205     ScanRangeForPointers(begin, end, frontier, "GLOBAL", kReachable);
 206   }
 207 }
 208
 209 void ForEachExtraStackRangeCb(uptr begin, uptr end, void* arg) {
 210   Frontier *frontier = reinterpret_cast<Frontier *>(arg);
 211   ScanRangeForPointers(begin, end, frontier, "FAKE STACK", kReachable);
 212 }
 213
 214 // Scans thread data (stacks and TLS) for heap pointers.
 215 static void ProcessThreads(SuspendedThreadsList const &suspended_threads,
 216                            Frontier *frontier) {
 217   InternalScopedBuffer<uptr> registers(suspended_threads.RegisterCount());
 218   uptr registers_begin = reinterpret_cast<uptr>(registers.data());
 219   uptr registers_end = registers_begin + registers.size();
 220   for (uptr i = 0; i < suspended_threads.ThreadCount(); i++) {
 221     tid_t os_id = static_cast<tid_t>(suspended_threads.GetThreadID(i));
 222     LOG_THREADS("Processing thread %d.\n", os_id);
 223     uptr stack_begin, stack_end, tls_begin, tls_end, cache_begin, cache_end;
 224     DTLS *dtls;
 225     bool thread_found = GetThreadRangesLocked(os_id, &stack_begin, &stack_end,
 226                                               &tls_begin, &tls_end,
 227                                               &cache_begin, &cache_end, &dtls);
 228     if (!thread_found) {
 229       // If a thread can't be found in the thread registry, it's probably in the
 230       // process of destruction. Log this event and move on.
 231       LOG_THREADS("Thread %d not found in registry.\n", os_id);
 232       continue;
 233     }
 234     uptr sp;
 235     PtraceRegistersStatus have_registers =
 236         suspended_threads.GetRegistersAndSP(i, registers.data(), &sp);
 237     if (have_registers != REGISTERS_AVAILABLE) {
 238       Report("Unable to get registers from thread %d.\n", os_id);
 239       // If unable to get SP, consider the entire stack to be reachable unless
 240       // GetRegistersAndSP failed with ESRCH.
 241       if (have_registers == REGISTERS_UNAVAILABLE_FATAL) continue;
 242       sp = stack_begin;
 243     }
 244
 245     if (flags()->use_registers && have_registers)
 246       ScanRangeForPointers(registers_begin, registers_end, frontier,
 247                            "REGISTERS", kReachable);
 248
 249     if (flags()->use_stacks) {
 250       LOG_THREADS("Stack at %p-%p (SP = %p).\n", stack_begin, stack_end, sp);
 251       if (sp < stack_begin || sp >= stack_end) {
 252         // SP is outside the recorded stack range (e.g. the thread is running a
 253         // signal handler on alternate stack, or swapcontext was used).
 254         // Again, consider the entire stack range to be reachable.
 255         LOG_THREADS("WARNING: stack pointer not in stack range.\n");
 256         uptr page_size = GetPageSizeCached();
 257         int skipped = 0;
 258         while (stack_begin < stack_end &&
 259                !IsAccessibleMemoryRange(stack_begin, 1)) {
 260           skipped++;
 261           stack_begin += page_size;
 262         }
 263         LOG_THREADS("Skipped %d guard page(s) to obtain stack %p-%p.\n",
 264                     skipped, stack_begin, stack_end);
 265       } else {
 266         // Shrink the stack range to ignore out-of-scope values.
 267         stack_begin = sp;
 268       }
 269       ScanRangeForPointers(stack_begin, stack_end, frontier, "STACK",
 270                            kReachable);
 271       ForEachExtraStackRange(os_id, ForEachExtraStackRangeCb, frontier);
 272     }
 273
 274     if (flags()->use_tls) {
 275       if (tls_begin) {
 276         LOG_THREADS("TLS at %p-%p.\n", tls_begin, tls_end);
 277         // If the tls and cache ranges don't overlap, scan full tls range,
 278         // otherwise, only scan the non-overlapping portions
 279         if (cache_begin == cache_end || tls_end < cache_begin ||
 280             tls_begin > cache_end) {
 281           ScanRangeForPointers(tls_begin, tls_end, frontier, "TLS", kReachable);
 282         } else {
 283           if (tls_begin < cache_begin)
 284             ScanRangeForPointers(tls_begin, cache_begin, frontier, "TLS",
 285                                  kReachable);
 286           if (tls_end > cache_end)
 287             ScanRangeForPointers(cache_end, tls_end, frontier, "TLS",
 288                                  kReachable);
 289         }
 290       }
 291       if (dtls && !DTLSInDestruction(dtls)) {
 292         for (uptr j = 0; j < dtls->dtv_size; ++j) {
 293           uptr dtls_beg = dtls->dtv[j].beg;
 294           uptr dtls_end = dtls_beg + dtls->dtv[j].size;
 295           if (dtls_beg < dtls_end) {
 296             LOG_THREADS("DTLS %zu at %p-%p.\n", j, dtls_beg, dtls_end);
 297             ScanRangeForPointers(dtls_beg, dtls_end, frontier, "DTLS",
 298                                  kReachable);
 299           }
 300         }
 301       } else {
 302         // We are handling a thread with DTLS under destruction. Log about
 303         // this and continue.
 304         LOG_THREADS("Thread %d has DTLS under destruction.\n", os_id);
 305       }
 306     }
 307   }
 308 }
 309
 310 void ScanRootRegion(Frontier *frontier, const RootRegion &root_region,
 311                     uptr region_begin, uptr region_end, bool is_readable) {
 312   uptr intersection_begin = Max(root_region.begin, region_begin);
 313   uptr intersection_end = Min(region_end, root_region.begin + root_region.size);
 314   if (intersection_begin >= intersection_end) return;
 315   LOG_POINTERS("Root region %p-%p intersects with mapped region %p-%p (%s)\n",
 316                root_region.begin, root_region.begin + root_region.size,
 317                region_begin, region_end,
 318                is_readable ? "readable" : "unreadable");
 319   if (is_readable)
 320     ScanRangeForPointers(intersection_begin, intersection_end, frontier, "ROOT",
 321                          kReachable);
 322 }
 323
 324 static void ProcessRootRegion(Frontier *frontier,
 325                               const RootRegion &root_region) {
 326   MemoryMappingLayout proc_maps(/*cache_enabled*/ true);
 327   MemoryMappedSegment segment;
 328   while (proc_maps.Next(&segment)) {
 329     ScanRootRegion(frontier, root_region, segment.start, segment.end,
 330                    segment.IsReadable());
 331   }
 332 }
 333
 334 // Scans root regions for heap pointers.
 335 static void ProcessRootRegions(Frontier *frontier) {
 336   if (!flags()->use_root_regions) return;
 337   CHECK(root_regions);
 338   for (uptr i = 0; i < root_regions->size(); i++) {
 339     ProcessRootRegion(frontier, (*root_regions)[i]);
 340   }
 341 }
 342
 343 static void FloodFillTag(Frontier *frontier, ChunkTag tag) {
 344   while (frontier->size()) {
 345     uptr next_chunk = frontier->back();
 346     frontier->pop_back();
 347     LsanMetadata m(next_chunk);
 348     ScanRangeForPointers(next_chunk, next_chunk + m.requested_size(), frontier,
 349                          "HEAP", tag);
 350   }
 351 }
 352
 353 // ForEachChunk callback. If the chunk is marked as leaked, marks all chunks
 354 // which are reachable from it as indirectly leaked.
 355 static void MarkIndirectlyLeakedCb(uptr chunk, void *arg) {
 356   chunk = GetUserBegin(chunk);
 357   LsanMetadata m(chunk);
 358   if (m.allocated() && m.tag() != kReachable) {
 359     ScanRangeForPointers(chunk, chunk + m.requested_size(),
 360                          /* frontier */ nullptr, "HEAP", kIndirectlyLeaked);
 361   }
 362 }
 363
 364 // ForEachChunk callback. If chunk is marked as ignored, adds its address to
 365 // frontier.
 366 static void CollectIgnoredCb(uptr chunk, void *arg) {
 367   CHECK(arg);
 368   chunk = GetUserBegin(chunk);
 369   LsanMetadata m(chunk);
 370   if (m.allocated() && m.tag() == kIgnored) {
 371     LOG_POINTERS("Ignored: chunk %p-%p of size %zu.\n",
 372                  chunk, chunk + m.requested_size(), m.requested_size());
 373     reinterpret_cast<Frontier *>(arg)->push_back(chunk);
 374   }
 375 }
 376
 377 static uptr GetCallerPC(u32 stack_id, StackDepotReverseMap *map) {
 378   CHECK(stack_id);
 379   StackTrace stack = map->Get(stack_id);
 380   // The top frame is our malloc/calloc/etc. The next frame is the caller.
 381   if (stack.size >= 2)
 382     return stack.trace[1];
 383   return 0;
 384 }
 385
 386 struct InvalidPCParam {
 387   Frontier *frontier;
 388   StackDepotReverseMap *stack_depot_reverse_map;
 389   bool skip_linker_allocations;
 390 };
 391
 392 // ForEachChunk callback. If the caller pc is invalid or is within the linker,
 393 // mark as reachable. Called by ProcessPlatformSpecificAllocations.
 394 static void MarkInvalidPCCb(uptr chunk, void *arg) {
 395   CHECK(arg);
 396   InvalidPCParam *param = reinterpret_cast<InvalidPCParam *>(arg);
 397   chunk = GetUserBegin(chunk);
 398   LsanMetadata m(chunk);
 399   if (m.allocated() && m.tag() != kReachable && m.tag() != kIgnored) {
 400     u32 stack_id = m.stack_trace_id();
 401     uptr caller_pc = 0;
 402     if (stack_id > 0)
 403       caller_pc = GetCallerPC(stack_id, param->stack_depot_reverse_map);
 404     // If caller_pc is unknown, this chunk may be allocated in a coroutine. Mark
 405     // it as reachable, as we can't properly report its allocation stack anyway.
 406     if (caller_pc == 0 || (param->skip_linker_allocations &&
 407                            GetLinker()->containsAddress(caller_pc))) {
 408       m.set_tag(kReachable);
 409       param->frontier->push_back(chunk);
 410     }
 411   }
 412 }
 413
 414 // On Linux, treats all chunks allocated from ld-linux.so as reachable, which
 415 // covers dynamically allocated TLS blocks, internal dynamic loader's loaded
 416 // modules accounting etc.
 417 // Dynamic TLS blocks contain the TLS variables of dynamically loaded modules.
 418 // They are allocated with a __libc_memalign() call in allocate_and_init()
 419 // (elf/dl-tls.c). Glibc won't tell us the address ranges occupied by those
 420 // blocks, but we can make sure they come from our own allocator by intercepting
 421 // __libc_memalign(). On top of that, there is no easy way to reach them. Their
 422 // addresses are stored in a dynamically allocated array (the DTV) which is
 423 // referenced from the static TLS. Unfortunately, we can't just rely on the DTV
 424 // being reachable from the static TLS, and the dynamic TLS being reachable from
 425 // the DTV. This is because the initial DTV is allocated before our interception
 426 // mechanism kicks in, and thus we don't recognize it as allocated memory. We
 427 // can't special-case it either, since we don't know its size.
 428 // Our solution is to include in the root set all allocations made from
 429 // ld-linux.so (which is where allocate_and_init() is implemented). This is
 430 // guaranteed to include all dynamic TLS blocks (and possibly other allocations
 431 // which we don't care about).
 432 // On all other platforms, this simply checks to ensure that the caller pc is
 433 // valid before reporting chunks as leaked.
 434 void ProcessPC(Frontier *frontier) {
 435   StackDepotReverseMap stack_depot_reverse_map;
 436   InvalidPCParam arg;
 437   arg.frontier = frontier;
 438   arg.stack_depot_reverse_map = &stack_depot_reverse_map;
 439   arg.skip_linker_allocations =
 440       flags()->use_tls && flags()->use_ld_allocations && GetLinker() != nullptr;
 441   ForEachChunk(MarkInvalidPCCb, &arg);
 442 }
 443
 444 // Sets the appropriate tag on each chunk.
 445 static void ClassifyAllChunks(SuspendedThreadsList const &suspended_threads) {
 446   // Holds the flood fill frontier.
 447   Frontier frontier(1);
 448
 449   ForEachChunk(CollectIgnoredCb, &frontier);
 450   ProcessGlobalRegions(&frontier);
 451   ProcessThreads(suspended_threads, &frontier);
 452   ProcessRootRegions(&frontier);
 453   FloodFillTag(&frontier, kReachable);
 454
 455   CHECK_EQ(0, frontier.size());
 456   ProcessPC(&frontier);
 457
 458   // The check here is relatively expensive, so we do this in a separate flood
 459   // fill. That way we can skip the check for chunks that are reachable
 460   // otherwise.
 461   LOG_POINTERS("Processing platform-specific allocations.\n");
 462   ProcessPlatformSpecificAllocations(&frontier);
 463   FloodFillTag(&frontier, kReachable);
 464
 465   // Iterate over leaked chunks and mark those that are reachable from other
 466   // leaked chunks.
 467   LOG_POINTERS("Scanning leaked chunks.\n");
 468   ForEachChunk(MarkIndirectlyLeakedCb, nullptr);
 469 }
 470
 471 // ForEachChunk callback. Resets the tags to pre-leak-check state.
 472 static void ResetTagsCb(uptr chunk, void *arg) {
 473   (void)arg;
 474   chunk = GetUserBegin(chunk);
 475   LsanMetadata m(chunk);
 476   if (m.allocated() && m.tag() != kIgnored)
 477     m.set_tag(kDirectlyLeaked);
 478 }
 479
 480 static void PrintStackTraceById(u32 stack_trace_id) {
 481   CHECK(stack_trace_id);
 482   StackDepotGet(stack_trace_id).Print();
 483 }
 484
 485 // ForEachChunk callback. Aggregates information about unreachable chunks into
 486 // a LeakReport.
 487 static void CollectLeaksCb(uptr chunk, void *arg) {
 488   CHECK(arg);
 489   LeakReport *leak_report = reinterpret_cast<LeakReport *>(arg);
 490   chunk = GetUserBegin(chunk);
 491   LsanMetadata m(chunk);
 492   if (!m.allocated()) return;
 493   if (m.tag() == kDirectlyLeaked || m.tag() == kIndirectlyLeaked) {
 494     u32 resolution = flags()->resolution;
 495     u32 stack_trace_id = 0;
 496     if (resolution > 0) {
 497       StackTrace stack = StackDepotGet(m.stack_trace_id());
 498       stack.size = Min(stack.size, resolution);
 499       stack_trace_id = StackDepotPut(stack);
 500     } else {
 501       stack_trace_id = m.stack_trace_id();
 502     }
 503     leak_report->AddLeakedChunk(chunk, stack_trace_id, m.requested_size(),
 504                                 m.tag());
 505   }
 506 }
 507
 508 static void PrintMatchedSuppressions() {
 509   InternalMmapVector<Suppression *> matched(1);
 510   GetSuppressionContext()->GetMatched(&matched);
 511   if (!matched.size())
 512     return;
 513   const char *line = "-----------------------------------------------------";
 514   Printf("%s\n", line);
 515   Printf("Suppressions used:\n");
 516   Printf("  count      bytes template\n");
 517   for (uptr i = 0; i < matched.size(); i++)
 518     Printf("%7zu %10zu %s\n", static_cast<uptr>(atomic_load_relaxed(
 519         &matched[i]->hit_count)), matched[i]->weight, matched[i]->templ);
 520   Printf("%s\n\n", line);
 521 }
 522
 523 struct CheckForLeaksParam {
 524   bool success;
 525   LeakReport leak_report;
 526 };
 527
 528 static void CheckForLeaksCallback(const SuspendedThreadsList &suspended_threads,
 529                                   void *arg) {
 530   CheckForLeaksParam *param = reinterpret_cast<CheckForLeaksParam *>(arg);
 531   CHECK(param);
 532   CHECK(!param->success);
 533   ClassifyAllChunks(suspended_threads);
 534   ForEachChunk(CollectLeaksCb, &param->leak_report);
 535   // Clean up for subsequent leak checks. This assumes we did not overwrite any
 536   // kIgnored tags.
 537   ForEachChunk(ResetTagsCb, nullptr);
 538   param->success = true;
 539 }
 540
 541 static bool CheckForLeaks() {
 542   if (&__lsan_is_turned_off && __lsan_is_turned_off())
 543       return false;
 544   EnsureMainThreadIDIsCorrect();
 545   CheckForLeaksParam param;
 546   param.success = false;
 547   LockThreadRegistry();
 548   LockAllocator();
 549   DoStopTheWorld(CheckForLeaksCallback, &param);
 550   UnlockAllocator();
 551   UnlockThreadRegistry();
 552
 553   if (!param.success) {
 554     Report("LeakSanitizer has encountered a fatal error.\n");
 555     Report(
 556         "HINT: For debugging, try setting environment variable "
 557         "LSAN_OPTIONS=verbosity=1:log_threads=1\n");
 558     Report(
 559         "HINT: LeakSanitizer does not work under ptrace (strace, gdb, etc)\n");
 560     Die();
 561   }
 562   param.leak_report.ApplySuppressions();
 563   uptr unsuppressed_count = param.leak_report.UnsuppressedLeakCount();
 564   if (unsuppressed_count > 0) {
 565     Decorator d;
 566     Printf("\n"
 567            "================================================================="
 568            "\n");
 569     Printf("%s", d.Error());
 570     Report("ERROR: LeakSanitizer: detected memory leaks\n");
 571     Printf("%s", d.Default());
 572     param.leak_report.ReportTopLeaks(flags()->max_leaks);
 573   }
 574   if (common_flags()->print_suppressions)
 575     PrintMatchedSuppressions();
 576   if (unsuppressed_count > 0) {
 577     param.leak_report.PrintSummary();
 578     return true;
 579   }
 580   return false;
 581 }
 582
 583 static bool has_reported_leaks = false;
 584 bool HasReportedLeaks() { return has_reported_leaks; }
 585
 586 void DoLeakCheck() {
 587   BlockingMutexLock l(&global_mutex);
 588   static bool already_done;
 589   if (already_done) return;
 590   already_done = true;
 591   has_reported_leaks = CheckForLeaks();
 592   if (has_reported_leaks) HandleLeaks();
 593 }
 594
 595 static int DoRecoverableLeakCheck() {
 596   BlockingMutexLock l(&global_mutex);
 597   bool have_leaks = CheckForLeaks();
 598   return have_leaks ? 1 : 0;
 599 }
 600
 601 void DoRecoverableLeakCheckVoid() { DoRecoverableLeakCheck(); }
 602
 603 static Suppression *GetSuppressionForAddr(uptr addr) {
 604   Suppression *s = nullptr;
 605
 606   // Suppress by module name.
 607   SuppressionContext *suppressions = GetSuppressionContext();
 608   if (const char *module_name =
 609           Symbolizer::GetOrInit()->GetModuleNameForPc(addr))
 610     if (suppressions->Match(module_name, kSuppressionLeak, &s))
 611       return s;
 612
 613   // Suppress by file or function name.
 614   SymbolizedStack *frames = Symbolizer::GetOrInit()->SymbolizePC(addr);
 615   for (SymbolizedStack *cur = frames; cur; cur = cur->next) {
 616     if (suppressions->Match(cur->info.function, kSuppressionLeak, &s) ||
 617         suppressions->Match(cur->info.file, kSuppressionLeak, &s)) {
 618       break;
 619     }
 620   }
 621   frames->ClearAll();
 622   return s;
 623 }
 624
 625 static Suppression *GetSuppressionForStack(u32 stack_trace_id) {
 626   StackTrace stack = StackDepotGet(stack_trace_id);
 627   for (uptr i = 0; i < stack.size; i++) {
 628     Suppression *s = GetSuppressionForAddr(
 629         StackTrace::GetPreviousInstructionPc(stack.trace[i]));
 630     if (s) return s;
 631   }
 632   return nullptr;
 633 }
 634
 635 ///// LeakReport implementation. /////
 636
 637 // A hard limit on the number of distinct leaks, to avoid quadratic complexity
 638 // in LeakReport::AddLeakedChunk(). We don't expect to ever see this many leaks
 639 // in real-world applications.
 640 // FIXME: Get rid of this limit by changing the implementation of LeakReport to
 641 // use a hash table.
 642 const uptr kMaxLeaksConsidered = 5000;
 643
 644 void LeakReport::AddLeakedChunk(uptr chunk, u32 stack_trace_id,
 645                                 uptr leaked_size, ChunkTag tag) {
 646   CHECK(tag == kDirectlyLeaked || tag == kIndirectlyLeaked);
 647   bool is_directly_leaked = (tag == kDirectlyLeaked);
 648   uptr i;
 649   for (i = 0; i < leaks_.size(); i++) {
 650     if (leaks_[i].stack_trace_id == stack_trace_id &&
 651         leaks_[i].is_directly_leaked == is_directly_leaked) {
 652       leaks_[i].hit_count++;
 653       leaks_[i].total_size += leaked_size;
 654       break;
 655     }
 656   }
 657   if (i == leaks_.size()) {
 658     if (leaks_.size() == kMaxLeaksConsidered) return;
 659     Leak leak = { next_id_++, /* hit_count */ 1, leaked_size, stack_trace_id,
 660                   is_directly_leaked, /* is_suppressed */ false };
 661     leaks_.push_back(leak);
 662   }
 663   if (flags()->report_objects) {
 664     LeakedObject obj = {leaks_[i].id, chunk, leaked_size};
 665     leaked_objects_.push_back(obj);
 666   }
 667 }
 668
 669 static bool LeakComparator(const Leak &leak1, const Leak &leak2) {
 670   if (leak1.is_directly_leaked == leak2.is_directly_leaked)
 671     return leak1.total_size > leak2.total_size;
 672   else
 673     return leak1.is_directly_leaked;
 674 }
 675
 676 void LeakReport::ReportTopLeaks(uptr num_leaks_to_report) {
 677   CHECK(leaks_.size() <= kMaxLeaksConsidered);
 678   Printf("\n");
 679   if (leaks_.size() == kMaxLeaksConsidered)
 680     Printf("Too many leaks! Only the first %zu leaks encountered will be "
 681            "reported.\n",
 682            kMaxLeaksConsidered);
 683
 684   uptr unsuppressed_count = UnsuppressedLeakCount();
 685   if (num_leaks_to_report > 0 && num_leaks_to_report < unsuppressed_count)
 686     Printf("The %zu top leak(s):\n", num_leaks_to_report);
 687   InternalSort(&leaks_, leaks_.size(), LeakComparator);
 688   uptr leaks_reported = 0;
 689   for (uptr i = 0; i < leaks_.size(); i++) {
 690     if (leaks_[i].is_suppressed) continue;
 691     PrintReportForLeak(i);
 692     leaks_reported++;
 693     if (leaks_reported == num_leaks_to_report) break;
 694   }
 695   if (leaks_reported < unsuppressed_count) {
 696     uptr remaining = unsuppressed_count - leaks_reported;
 697     Printf("Omitting %zu more leak(s).\n", remaining);
 698   }
 699 }
 700
 701 void LeakReport::PrintReportForLeak(uptr index) {
 702   Decorator d;
 703   Printf("%s", d.Leak());
 704   Printf("%s leak of %zu byte(s) in %zu object(s) allocated from:\n",
 705          leaks_[index].is_directly_leaked ? "Direct" : "Indirect",
 706          leaks_[index].total_size, leaks_[index].hit_count);
 707   Printf("%s", d.Default());
 708
 709   PrintStackTraceById(leaks_[index].stack_trace_id);
 710
 711   if (flags()->report_objects) {
 712     Printf("Objects leaked above:\n");
 713     PrintLeakedObjectsForLeak(index);
 714     Printf("\n");
 715   }
 716 }
 717
 718 void LeakReport::PrintLeakedObjectsForLeak(uptr index) {
 719   u32 leak_id = leaks_[index].id;
 720   for (uptr j = 0; j < leaked_objects_.size(); j++) {
 721     if (leaked_objects_[j].leak_id == leak_id)
 722       Printf("%p (%zu bytes)\n", leaked_objects_[j].addr,
 723              leaked_objects_[j].size);
 724   }
 725 }
 726
 727 void LeakReport::PrintSummary() {
 728   CHECK(leaks_.size() <= kMaxLeaksConsidered);
 729   uptr bytes = 0, allocations = 0;
 730   for (uptr i = 0; i < leaks_.size(); i++) {
 731       if (leaks_[i].is_suppressed) continue;
 732       bytes += leaks_[i].total_size;
 733       allocations += leaks_[i].hit_count;
 734   }
 735   InternalScopedString summary(kMaxSummaryLength);
 736   summary.append("%zu byte(s) leaked in %zu allocation(s).", bytes,
 737                  allocations);
 738   ReportErrorSummary(summary.data());
 739 }
 740
 741 void LeakReport::ApplySuppressions() {
 742   for (uptr i = 0; i < leaks_.size(); i++) {
 743     Suppression *s = GetSuppressionForStack(leaks_[i].stack_trace_id);
 744     if (s) {
 745       s->weight += leaks_[i].total_size;
 746       atomic_store_relaxed(&s->hit_count, atomic_load_relaxed(&s->hit_count) +
 747           leaks_[i].hit_count);
 748       leaks_[i].is_suppressed = true;
 749     }
 750   }
 751 }
 752
 753 uptr LeakReport::UnsuppressedLeakCount() {
 754   uptr result = 0;
 755   for (uptr i = 0; i < leaks_.size(); i++)
 756     if (!leaks_[i].is_suppressed) result++;
 757   return result;
 758 }
 759
 760 } // namespace __lsan
 761 #else // CAN_SANITIZE_LEAKS
 762 namespace __lsan {
 763 void InitCommonLsan() { }
 764 void DoLeakCheck() { }
 765 void DoRecoverableLeakCheckVoid() { }
 766 void DisableInThisThread() { }
 767 void EnableInThisThread() { }
 768 }
 769 #endif // CAN_SANITIZE_LEAKS
 770
 771 using namespace __lsan;  // NOLINT
 772
 773 extern "C" {
 774 SANITIZER_INTERFACE_ATTRIBUTE
 775 void __lsan_ignore_object(const void *p) {
 776 #if CAN_SANITIZE_LEAKS
 777   if (!common_flags()->detect_leaks)
 778     return;
 779   // Cannot use PointsIntoChunk or LsanMetadata here, since the allocator is not
 780   // locked.
 781   BlockingMutexLock l(&global_mutex);
 782   IgnoreObjectResult res = IgnoreObjectLocked(p);
 783   if (res == kIgnoreObjectInvalid)
 784     VReport(1, "__lsan_ignore_object(): no heap object found at %p", p);
 785   if (res == kIgnoreObjectAlreadyIgnored)
 786     VReport(1, "__lsan_ignore_object(): "
 787            "heap object at %p is already being ignored\n", p);
 788   if (res == kIgnoreObjectSuccess)
 789     VReport(1, "__lsan_ignore_object(): ignoring heap object at %p\n", p);
 790 #endif // CAN_SANITIZE_LEAKS
 791 }
 792
 793 SANITIZER_INTERFACE_ATTRIBUTE
 794 void __lsan_register_root_region(const void *begin, uptr size) {
 795 #if CAN_SANITIZE_LEAKS
 796   BlockingMutexLock l(&global_mutex);
 797   CHECK(root_regions);
 798   RootRegion region = {reinterpret_cast<uptr>(begin), size};
 799   root_regions->push_back(region);
 800   VReport(1, "Registered root region at %p of size %llu\n", begin, size);
 801 #endif // CAN_SANITIZE_LEAKS
 802 }
 803
 804 SANITIZER_INTERFACE_ATTRIBUTE
 805 void __lsan_unregister_root_region(const void *begin, uptr size) {
 806 #if CAN_SANITIZE_LEAKS
 807   BlockingMutexLock l(&global_mutex);
 808   CHECK(root_regions);
 809   bool removed = false;
 810   for (uptr i = 0; i < root_regions->size(); i++) {
 811     RootRegion region = (*root_regions)[i];
 812     if (region.begin == reinterpret_cast<uptr>(begin) && region.size == size) {
 813       removed = true;
 814       uptr last_index = root_regions->size() - 1;
 815       (*root_regions)[i] = (*root_regions)[last_index];
 816       root_regions->pop_back();
 817       VReport(1, "Unregistered root region at %p of size %llu\n", begin, size);
 818       break;
 819     }
 820   }
 821   if (!removed) {
 822     Report(
 823         "__lsan_unregister_root_region(): region at %p of size %llu has not "
 824         "been registered.\n",
 825         begin, size);
 826     Die();
 827   }
 828 #endif // CAN_SANITIZE_LEAKS
 829 }
 830
 831 SANITIZER_INTERFACE_ATTRIBUTE
 832 void __lsan_disable() {
 833 #if CAN_SANITIZE_LEAKS
 834   __lsan::DisableInThisThread();
 835 #endif
 836 }
 837
 838 SANITIZER_INTERFACE_ATTRIBUTE
 839 void __lsan_enable() {
 840 #if CAN_SANITIZE_LEAKS
 841   __lsan::EnableInThisThread();
 842 #endif
 843 }
 844
 845 SANITIZER_INTERFACE_ATTRIBUTE
 846 void __lsan_do_leak_check() {
 847 #if CAN_SANITIZE_LEAKS
 848   if (common_flags()->detect_leaks)
 849     __lsan::DoLeakCheck();
 850 #endif // CAN_SANITIZE_LEAKS
 851 }
 852
 853 SANITIZER_INTERFACE_ATTRIBUTE
 854 int __lsan_do_recoverable_leak_check() {
 855 #if CAN_SANITIZE_LEAKS
 856   if (common_flags()->detect_leaks)
 857     return __lsan::DoRecoverableLeakCheck();
 858 #endif // CAN_SANITIZE_LEAKS
 859   return 0;
 860 }
 861
 862 #if !SANITIZER_SUPPORTS_WEAK_HOOKS
 863 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
 864 const char * __lsan_default_options() {
 865   return "";
 866 }
 867
 868 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
 869 int __lsan_is_turned_off() {
 870   return 0;
 871 }
 872
 873 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
 874 const char *__lsan_default_suppressions() {
 875   return "";
 876 }
 877 #endif
 878 } // extern "C"