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