annotate libsanitizer/lsan/lsan_common.cc @ 120:f93fa5091070

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