blob: 2df188da658a96682723f23e06a2ae9c619386f4 [file] [log] [blame]
Bob Wilsona08e9ac2013-11-15 07:18:15 +00001//===-- sanitizer_coverage.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// Sanitizer Coverage.
11// This file implements run-time support for a poor man's coverage tool.
12//
13// Compiler instrumentation:
Kostya Serebryany714c67c2014-01-17 11:00:30 +000014// For every interesting basic block the compiler injects the following code:
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000015// if (Guard < 0) {
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +000016// __sanitizer_cov(&Guard);
Bob Wilsona08e9ac2013-11-15 07:18:15 +000017// }
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000018// At the module start up time __sanitizer_cov_module_init sets the guards
19// to consecutive negative numbers (-1, -2, -3, ...).
Kostya Serebryany714c67c2014-01-17 11:00:30 +000020// It's fine to call __sanitizer_cov more than once for a given block.
Bob Wilsona08e9ac2013-11-15 07:18:15 +000021//
22// Run-time:
Kostya Serebryany714c67c2014-01-17 11:00:30 +000023// - __sanitizer_cov(): record that we've executed the PC (GET_CALLER_PC).
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000024// and atomically set Guard to -Guard.
Bob Wilsona08e9ac2013-11-15 07:18:15 +000025// - __sanitizer_cov_dump: dump the coverage data to disk.
26// For every module of the current process that has coverage data
27// this will create a file module_name.PID.sancov. The file format is simple:
28// it's just a sorted sequence of 4-byte offsets in the module.
29//
30// Eventually, this coverage implementation should be obsoleted by a more
31// powerful general purpose Clang/LLVM coverage instrumentation.
32// Consider this implementation as prototype.
33//
34// FIXME: support (or at least test with) dlclose.
35//===----------------------------------------------------------------------===//
36
37#include "sanitizer_allocator_internal.h"
38#include "sanitizer_common.h"
39#include "sanitizer_libc.h"
40#include "sanitizer_mutex.h"
41#include "sanitizer_procmaps.h"
Kostya Serebryany714c67c2014-01-17 11:00:30 +000042#include "sanitizer_stacktrace.h"
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +000043#include "sanitizer_symbolizer.h"
Bob Wilsona08e9ac2013-11-15 07:18:15 +000044#include "sanitizer_flags.h"
45
Kostya Serebryany183cb6e2014-11-14 23:15:55 +000046static atomic_uint32_t dump_once_guard; // Ensure that CovDump runs only once.
47
48static atomic_uintptr_t coverage_counter;
Bob Wilsona08e9ac2013-11-15 07:18:15 +000049
Kostya Serebryany8b530e12014-04-30 10:40:48 +000050// pc_array is the array containing the covered PCs.
Sergey Matveev6cb47a082014-05-19 12:53:03 +000051// To make the pc_array thread- and async-signal-safe it has to be large enough.
Kostya Serebryany8b530e12014-04-30 10:40:48 +000052// 128M counters "ought to be enough for anybody" (4M on 32-bit).
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000053
54// With coverage_direct=1 in ASAN_OPTIONS, pc_array memory is mapped to a file.
55// In this mode, __sanitizer_cov_dump does nothing, and CovUpdateMapping()
56// dump current memory layout to another file.
Bob Wilsona08e9ac2013-11-15 07:18:15 +000057
Sergey Matveev6cb47a082014-05-19 12:53:03 +000058static bool cov_sandboxed = false;
59static int cov_fd = kInvalidFd;
60static unsigned int cov_max_block_size = 0;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +000061static bool coverage_enabled = false;
62static const char *coverage_dir;
Sergey Matveev6cb47a082014-05-19 12:53:03 +000063
Bob Wilsona08e9ac2013-11-15 07:18:15 +000064namespace __sanitizer {
65
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000066class CoverageData {
67 public:
68 void Init();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +000069 void ReInit();
Evgeniy Stepanovfe181022014-06-04 12:13:54 +000070 void BeforeFork();
71 void AfterFork(int child_pid);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000072 void Extend(uptr npcs);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000073 void Add(uptr pc, u32 *guard);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +000074 void IndirCall(uptr caller, uptr callee, uptr callee_cache[],
75 uptr cache_size);
76 void DumpCallerCalleePairs();
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +000077 void DumpTrace();
78
79 ALWAYS_INLINE
Kostya Serebryanyd421db02015-01-03 00:54:43 +000080 void TraceBasicBlock(s32 *id);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000081
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +000082 void InitializeGuardArray(s32 *guards);
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +000083 void InitializeGuards(s32 *guards, uptr n);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000084
85 uptr *data();
86 uptr size();
87
88 private:
89 // Maximal size pc array may ever grow.
90 // We MmapNoReserve this space to ensure that the array is contiguous.
Evgeniy Stepanov10308462014-12-26 13:54:11 +000091 static const uptr kPcArrayMaxSize = FIRST_32_SECOND_64(1 << 24, 1 << 27);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000092 // The amount file mapping for the pc array is grown by.
93 static const uptr kPcArrayMmapSize = 64 * 1024;
94
95 // pc_array is allocated with MmapNoReserveOrDie and so it uses only as
96 // much RAM as it really needs.
97 uptr *pc_array;
98 // Index of the first available pc_array slot.
99 atomic_uintptr_t pc_array_index;
100 // Array size.
101 atomic_uintptr_t pc_array_size;
102 // Current file mapped size of the pc array.
103 uptr pc_array_mapped_size;
104 // Descriptor of the file mapped pc array.
105 int pc_fd;
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000106
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000107 // Vector of coverage guard arrays, protected by mu.
108 InternalMmapVectorNoCtor<s32*> guard_array_vec;
109
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000110 // Caller-Callee (cc) array, size and current index.
111 static const uptr kCcArrayMaxSize = FIRST_32_SECOND_64(1 << 18, 1 << 24);
112 uptr **cc_array;
113 atomic_uintptr_t cc_array_index;
114 atomic_uintptr_t cc_array_size;
115
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000116 // Tracing event array, size and current pointer.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000117 // We record all events (basic block entries) in a global buffer of u32
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000118 // values. Each such value is the index in pc_array.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000119 // So far the tracing is highly experimental:
120 // - not thread-safe;
121 // - does not support long traces;
122 // - not tuned for performance.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000123 static const uptr kTrEventArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 30);
124 u32 *tr_event_array;
125 uptr tr_event_array_size;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000126 u32 *tr_event_pointer;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000127 static const uptr kTrPcArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 27);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000128
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000129 StaticSpinMutex mu;
130
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000131 void DirectOpen();
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000132};
133
134static CoverageData coverage_data;
135
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000136void CovUpdateMapping(const char *path, uptr caller_pc = 0);
137
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000138void CoverageData::DirectOpen() {
Alexey Samsonov4cc76cb2014-11-26 01:48:39 +0000139 InternalScopedString path(kMaxPathLength);
Evgeniy Stepanovfa5c0752014-05-29 14:33:16 +0000140 internal_snprintf((char *)path.data(), path.size(), "%s/%zd.sancov.raw",
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000141 coverage_dir, internal_getpid());
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000142 pc_fd = OpenFile(path.data(), true);
143 if (internal_iserror(pc_fd)) {
144 Report(" Coverage: failed to open %s for writing\n", path.data());
145 Die();
146 }
147
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000148 pc_array_mapped_size = 0;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000149 CovUpdateMapping(coverage_dir);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000150}
151
152void CoverageData::Init() {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000153 CHECK_EQ(pc_array, nullptr);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000154 pc_array = reinterpret_cast<uptr *>(
155 MmapNoReserveOrDie(sizeof(uptr) * kPcArrayMaxSize, "CovInit"));
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000156 pc_fd = kInvalidFd;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000157 atomic_store(&pc_array_index, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000158 if (common_flags()->coverage_direct) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000159 atomic_store(&pc_array_size, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000160 } else {
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000161 atomic_store(&pc_array_size, kPcArrayMaxSize, memory_order_relaxed);
162 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000163
164 cc_array = reinterpret_cast<uptr **>(MmapNoReserveOrDie(
165 sizeof(uptr *) * kCcArrayMaxSize, "CovInit::cc_array"));
166 atomic_store(&cc_array_size, kCcArrayMaxSize, memory_order_relaxed);
167 atomic_store(&cc_array_index, 0, memory_order_relaxed);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000168
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000169 // Allocate tr_event_array with a guard page at the end.
170 tr_event_array = reinterpret_cast<u32 *>(MmapNoReserveOrDie(
171 sizeof(tr_event_array[0]) * kTrEventArrayMaxSize + GetMmapGranularity(),
172 "CovInit::tr_event_array"));
173 Mprotect(reinterpret_cast<uptr>(&tr_event_array[kTrEventArrayMaxSize]),
174 GetMmapGranularity());
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000175 tr_event_array_size = kTrEventArrayMaxSize;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000176 tr_event_pointer = tr_event_array;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000177}
178
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000179void CoverageData::InitializeGuardArray(s32 *guards) {
180 s32 n = guards[0];
181 for (s32 j = 1; j <= n; j++) {
182 uptr idx = atomic_fetch_add(&pc_array_index, 1, memory_order_relaxed);
183 guards[j] = -static_cast<s32>(idx + 1);
184 }
185}
186
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000187void CoverageData::ReInit() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000188 if (pc_array) {
189 internal_munmap(pc_array, sizeof(uptr) * kPcArrayMaxSize);
190 pc_array = nullptr;
191 }
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000192 if (pc_fd != kInvalidFd) internal_close(pc_fd);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000193 if (coverage_enabled) {
194 if (common_flags()->coverage_direct) {
195 // In memory-mapped mode we must extend the new file to the known array
196 // size.
197 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
198 Init();
199 if (size) Extend(size);
200 if (coverage_enabled) CovUpdateMapping(coverage_dir);
201 } else {
202 Init();
203 }
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000204 }
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000205 // Re-initialize the guards.
206 // We are single-threaded now, no need to grab any lock.
207 CHECK_EQ(atomic_load(&pc_array_index, memory_order_relaxed), 0);
208 for (uptr i = 0; i < guard_array_vec.size(); i++)
209 InitializeGuardArray(guard_array_vec[i]);
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000210}
211
212void CoverageData::BeforeFork() {
213 mu.Lock();
214}
215
216void CoverageData::AfterFork(int child_pid) {
217 // We are single-threaded so it's OK to release the lock early.
218 mu.Unlock();
219 if (child_pid == 0) ReInit();
220}
221
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000222// Extend coverage PC array to fit additional npcs elements.
223void CoverageData::Extend(uptr npcs) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000224 if (!common_flags()->coverage_direct) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000225 SpinMutexLock l(&mu);
226
227 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
228 size += npcs * sizeof(uptr);
229
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000230 if (coverage_enabled && size > pc_array_mapped_size) {
231 if (pc_fd == kInvalidFd) DirectOpen();
232 CHECK_NE(pc_fd, kInvalidFd);
233
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000234 uptr new_mapped_size = pc_array_mapped_size;
235 while (size > new_mapped_size) new_mapped_size += kPcArrayMmapSize;
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000236 CHECK_LE(new_mapped_size, sizeof(uptr) * kPcArrayMaxSize);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000237
238 // Extend the file and map the new space at the end of pc_array.
239 uptr res = internal_ftruncate(pc_fd, new_mapped_size);
240 int err;
241 if (internal_iserror(res, &err)) {
242 Printf("failed to extend raw coverage file: %d\n", err);
243 Die();
244 }
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000245
246 uptr next_map_base = ((uptr)pc_array) + pc_array_mapped_size;
247 void *p = MapWritableFileToMemory((void *)next_map_base,
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000248 new_mapped_size - pc_array_mapped_size,
249 pc_fd, pc_array_mapped_size);
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000250 CHECK_EQ((uptr)p, next_map_base);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000251 pc_array_mapped_size = new_mapped_size;
252 }
253
254 atomic_store(&pc_array_size, size, memory_order_release);
255}
256
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000257void CoverageData::InitializeGuards(s32 *guards, uptr n) {
258 // The array 'guards' has n+1 elements, we use the element zero
259 // to store 'n'.
260 CHECK_LT(n, 1 << 30);
261 guards[0] = static_cast<s32>(n);
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000262 InitializeGuardArray(guards);
263 SpinMutexLock l(&mu);
264 guard_array_vec.push_back(guards);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000265}
266
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000267// If guard is negative, atomically set it to -guard and store the PC in
268// pc_array.
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000269void CoverageData::Add(uptr pc, u32 *guard) {
270 atomic_uint32_t *atomic_guard = reinterpret_cast<atomic_uint32_t*>(guard);
271 s32 guard_value = atomic_load(atomic_guard, memory_order_relaxed);
272 if (guard_value >= 0) return;
273
274 atomic_store(atomic_guard, -guard_value, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000275 if (!pc_array) return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000276
277 uptr idx = -guard_value - 1;
278 if (idx >= atomic_load(&pc_array_index, memory_order_acquire))
279 return; // May happen after fork when pc_array_index becomes 0.
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000280 CHECK_LT(idx * sizeof(uptr),
281 atomic_load(&pc_array_size, memory_order_acquire));
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000282 pc_array[idx] = pc;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000283 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000284}
285
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000286// Registers a pair caller=>callee.
287// When a given caller is seen for the first time, the callee_cache is added
288// to the global array cc_array, callee_cache[0] is set to caller and
289// callee_cache[1] is set to cache_size.
290// Then we are trying to add callee to callee_cache [2,cache_size) if it is
291// not there yet.
292// If the cache is full we drop the callee (may want to fix this later).
293void CoverageData::IndirCall(uptr caller, uptr callee, uptr callee_cache[],
294 uptr cache_size) {
295 if (!cc_array) return;
296 atomic_uintptr_t *atomic_callee_cache =
297 reinterpret_cast<atomic_uintptr_t *>(callee_cache);
298 uptr zero = 0;
299 if (atomic_compare_exchange_strong(&atomic_callee_cache[0], &zero, caller,
300 memory_order_seq_cst)) {
301 uptr idx = atomic_fetch_add(&cc_array_index, 1, memory_order_relaxed);
302 CHECK_LT(idx * sizeof(uptr),
303 atomic_load(&cc_array_size, memory_order_acquire));
304 callee_cache[1] = cache_size;
305 cc_array[idx] = callee_cache;
306 }
307 CHECK_EQ(atomic_load(&atomic_callee_cache[0], memory_order_relaxed), caller);
308 for (uptr i = 2; i < cache_size; i++) {
309 uptr was = 0;
310 if (atomic_compare_exchange_strong(&atomic_callee_cache[i], &was, callee,
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000311 memory_order_seq_cst)) {
312 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000313 return;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000314 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000315 if (was == callee) // Already have this callee.
316 return;
317 }
318}
319
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000320uptr *CoverageData::data() {
321 return pc_array;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000322}
323
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000324uptr CoverageData::size() {
325 return atomic_load(&pc_array_index, memory_order_relaxed);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000326}
327
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000328// Block layout for packed file format: header, followed by module name (no
329// trailing zero), followed by data blob.
330struct CovHeader {
331 int pid;
332 unsigned int module_name_length;
333 unsigned int data_length;
334};
335
336static void CovWritePacked(int pid, const char *module, const void *blob,
337 unsigned int blob_size) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000338 if (cov_fd < 0) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000339 unsigned module_name_length = internal_strlen(module);
340 CovHeader header = {pid, module_name_length, blob_size};
341
342 if (cov_max_block_size == 0) {
343 // Writing to a file. Just go ahead.
344 internal_write(cov_fd, &header, sizeof(header));
345 internal_write(cov_fd, module, module_name_length);
346 internal_write(cov_fd, blob, blob_size);
347 } else {
348 // Writing to a socket. We want to split the data into appropriately sized
349 // blocks.
350 InternalScopedBuffer<char> block(cov_max_block_size);
351 CHECK_EQ((uptr)block.data(), (uptr)(CovHeader *)block.data());
352 uptr header_size_with_module = sizeof(header) + module_name_length;
353 CHECK_LT(header_size_with_module, cov_max_block_size);
354 unsigned int max_payload_size =
355 cov_max_block_size - header_size_with_module;
356 char *block_pos = block.data();
357 internal_memcpy(block_pos, &header, sizeof(header));
358 block_pos += sizeof(header);
359 internal_memcpy(block_pos, module, module_name_length);
360 block_pos += module_name_length;
361 char *block_data_begin = block_pos;
Alexey Samsonov4925fd42014-11-13 22:40:59 +0000362 const char *blob_pos = (const char *)blob;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000363 while (blob_size > 0) {
364 unsigned int payload_size = Min(blob_size, max_payload_size);
365 blob_size -= payload_size;
366 internal_memcpy(block_data_begin, blob_pos, payload_size);
367 blob_pos += payload_size;
368 ((CovHeader *)block.data())->data_length = payload_size;
369 internal_write(cov_fd, block.data(),
370 header_size_with_module + payload_size);
371 }
372 }
373}
374
Sergey Matveev83f91e72014-05-21 13:43:52 +0000375// If packed = false: <name>.<pid>.<sancov> (name = module name).
376// If packed = true and name == 0: <pid>.<sancov>.<packed>.
377// If packed = true and name != 0: <name>.<sancov>.<packed> (name is
378// user-supplied).
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000379static int CovOpenFile(bool packed, const char *name,
380 const char *extension = "sancov") {
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000381 InternalScopedString path(kMaxPathLength);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000382 if (!packed) {
383 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000384 path.append("%s/%s.%zd.%s", coverage_dir, name, internal_getpid(),
385 extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000386 } else {
387 if (!name)
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000388 path.append("%s/%zd.%s.packed", coverage_dir, internal_getpid(),
Evgeniy Stepanovf8c7e252014-12-26 10:19:56 +0000389 extension);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000390 else
391 path.append("%s/%s.%s.packed", coverage_dir, name, extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000392 }
393 uptr fd = OpenFile(path.data(), true);
394 if (internal_iserror(fd)) {
395 Report(" SanitizerCoverage: failed to open %s for writing\n", path.data());
396 return -1;
397 }
398 return fd;
399}
400
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000401// Dump trace PCs and trace events into two separate files.
402void CoverageData::DumpTrace() {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000403 uptr max_idx = tr_event_pointer - tr_event_array;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000404 if (!max_idx) return;
405 auto sym = Symbolizer::GetOrInit();
406 if (!sym)
407 return;
408 InternalScopedString out(32 << 20);
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000409 for (uptr i = 0, n = size(); i < n; i++) {
410 const char *module_name = "<unknown>";
411 uptr module_address = 0;
412 sym->GetModuleNameAndOffsetForPC(pc_array[i], &module_name,
413 &module_address);
414 out.append("%s 0x%zx\n", module_name, module_address);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000415 }
416 int fd = CovOpenFile(false, "trace-points");
417 if (fd < 0) return;
418 internal_write(fd, out.data(), out.length());
419 internal_close(fd);
420
421 fd = CovOpenFile(false, "trace-events");
422 if (fd < 0) return;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000423 uptr bytes_to_write = max_idx * sizeof(tr_event_array[0]);
424 u8 *event_bytes = reinterpret_cast<u8*>(tr_event_array);
425 // The trace file could be huge, and may not be written with a single syscall.
426 while (bytes_to_write) {
427 uptr actually_written = internal_write(fd, event_bytes, bytes_to_write);
428 if (actually_written <= bytes_to_write) {
429 bytes_to_write -= actually_written;
430 event_bytes += actually_written;
431 } else {
432 break;
433 }
434 }
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000435 internal_close(fd);
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000436 VReport(1, " CovDump: Trace: %zd PCs written\n", size());
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000437 VReport(1, " CovDump: Trace: %zd Events written\n", max_idx);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000438}
439
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000440// This function dumps the caller=>callee pairs into a file as a sequence of
441// lines like "module_name offset".
442void CoverageData::DumpCallerCalleePairs() {
443 uptr max_idx = atomic_load(&cc_array_index, memory_order_relaxed);
444 if (!max_idx) return;
445 auto sym = Symbolizer::GetOrInit();
446 if (!sym)
447 return;
Kostya Serebryany40aa4a22014-10-31 19:49:46 +0000448 InternalScopedString out(32 << 20);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000449 uptr total = 0;
450 for (uptr i = 0; i < max_idx; i++) {
451 uptr *cc_cache = cc_array[i];
452 CHECK(cc_cache);
453 uptr caller = cc_cache[0];
454 uptr n_callees = cc_cache[1];
455 const char *caller_module_name = "<unknown>";
456 uptr caller_module_address = 0;
457 sym->GetModuleNameAndOffsetForPC(caller, &caller_module_name,
458 &caller_module_address);
459 for (uptr j = 2; j < n_callees; j++) {
460 uptr callee = cc_cache[j];
461 if (!callee) break;
462 total++;
463 const char *callee_module_name = "<unknown>";
464 uptr callee_module_address = 0;
465 sym->GetModuleNameAndOffsetForPC(callee, &callee_module_name,
466 &callee_module_address);
467 out.append("%s 0x%zx\n%s 0x%zx\n", caller_module_name,
468 caller_module_address, callee_module_name,
469 callee_module_address);
470 }
471 }
472 int fd = CovOpenFile(false, "caller-callee");
473 if (fd < 0) return;
474 internal_write(fd, out.data(), out.length());
475 internal_close(fd);
476 VReport(1, " CovDump: %zd caller-callee pairs written\n", total);
477}
478
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000479// Record the current PC into the event buffer.
480// Every event is a u32 value (index in tr_pc_array_index) so we compute
481// it once and then cache in the provided 'cache' storage.
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000482//
483// This function will eventually be inlined by the compiler.
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000484void CoverageData::TraceBasicBlock(s32 *id) {
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000485 // Will trap here if
486 // 1. coverage is not enabled at run-time.
487 // 2. The array tr_event_array is full.
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000488 *tr_event_pointer = static_cast<u32>(*id - 1);
489 tr_event_pointer++;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000490}
491
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000492static void CovDumpAsBitSet() {
493 if (!common_flags()->coverage_bitset) return;
494 if (!coverage_data.size()) return;
495 int fd = CovOpenFile(/* packed */false, "combined", "bitset-sancov");
496 if (fd < 0) return;
497 uptr n = coverage_data.size();
498 uptr n_set_bits = 0;
499 InternalScopedBuffer<char> out(n);
500 for (uptr i = 0; i < n; i++) {
501 uptr pc = coverage_data.data()[i];
502 out[i] = pc ? '1' : '0';
503 if (pc)
504 n_set_bits++;
505 }
506 internal_write(fd, out.data(), n);
507 internal_close(fd);
508 VReport(1, " CovDump: bitset of %zd bits written, %zd bits are set\n", n,
509 n_set_bits);
510}
511
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000512// Dump the coverage on disk.
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000513static void CovDump() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000514 if (!coverage_enabled || common_flags()->coverage_direct) return;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000515#if !SANITIZER_WINDOWS
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000516 if (atomic_fetch_add(&dump_once_guard, 1, memory_order_relaxed))
517 return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000518 CovDumpAsBitSet();
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000519 coverage_data.DumpTrace();
Kostya Serebryanya7ee2732014-12-30 19:55:04 +0000520 if (!common_flags()->coverage_pcs) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000521 uptr size = coverage_data.size();
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000522 InternalMmapVector<u32> offsets(size);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000523 uptr *vb = coverage_data.data();
524 uptr *ve = vb + size;
525 SortArray(vb, size);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000526 MemoryMappingLayout proc_maps(/*cache_enabled*/true);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000527 uptr mb, me, off, prot;
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000528 InternalScopedString module(kMaxPathLength);
529 InternalScopedString path(kMaxPathLength);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000530 for (int i = 0;
531 proc_maps.Next(&mb, &me, &off, module.data(), module.size(), &prot);
532 i++) {
533 if ((prot & MemoryMappingLayout::kProtectionExecute) == 0)
534 continue;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000535 while (vb < ve && *vb < mb) vb++;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000536 if (vb >= ve) break;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000537 if (*vb < me) {
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000538 offsets.clear();
539 const uptr *old_vb = vb;
540 CHECK_LE(off, *vb);
541 for (; vb < ve && *vb < me; vb++) {
542 uptr diff = *vb - (i ? mb : 0) + off;
543 CHECK_LE(diff, 0xffffffffU);
544 offsets.push_back(static_cast<u32>(diff));
545 }
Alexey Samsonov26ca05a2014-11-04 19:34:29 +0000546 const char *module_name = StripModuleName(module.data());
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000547 if (cov_sandboxed) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000548 if (cov_fd >= 0) {
549 CovWritePacked(internal_getpid(), module_name, offsets.data(),
550 offsets.size() * sizeof(u32));
551 VReport(1, " CovDump: %zd PCs written to packed file\n", vb - old_vb);
552 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000553 } else {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000554 // One file per module per process.
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000555 path.clear();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000556 path.append("%s/%s.%zd.sancov", coverage_dir, module_name,
557 internal_getpid());
Sergey Matveev83f91e72014-05-21 13:43:52 +0000558 int fd = CovOpenFile(false /* packed */, module_name);
559 if (fd > 0) {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000560 internal_write(fd, offsets.data(), offsets.size() * sizeof(u32));
561 internal_close(fd);
562 VReport(1, " CovDump: %s: %zd PCs written\n", path.data(),
563 vb - old_vb);
564 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000565 }
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000566 }
567 }
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000568 if (cov_fd >= 0)
569 internal_close(cov_fd);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000570 coverage_data.DumpCallerCalleePairs();
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000571#endif // !SANITIZER_WINDOWS
572}
573
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000574void CovPrepareForSandboxing(__sanitizer_sandbox_arguments *args) {
575 if (!args) return;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000576 if (!coverage_enabled) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000577 cov_sandboxed = args->coverage_sandboxed;
578 if (!cov_sandboxed) return;
579 cov_fd = args->coverage_fd;
580 cov_max_block_size = args->coverage_max_block_size;
581 if (cov_fd < 0)
582 // Pre-open the file now. The sandbox won't allow us to do it later.
Sergey Matveev83f91e72014-05-21 13:43:52 +0000583 cov_fd = CovOpenFile(true /* packed */, 0);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000584}
585
Sergey Matveev83f91e72014-05-21 13:43:52 +0000586int MaybeOpenCovFile(const char *name) {
587 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000588 if (!coverage_enabled) return -1;
Sergey Matveev83f91e72014-05-21 13:43:52 +0000589 return CovOpenFile(true /* packed */, name);
590}
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000591
592void CovBeforeFork() {
593 coverage_data.BeforeFork();
594}
595
596void CovAfterFork(int child_pid) {
597 coverage_data.AfterFork(child_pid);
598}
599
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000600void InitializeCoverage(bool enabled, const char *dir) {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000601 if (coverage_enabled)
602 return; // May happen if two sanitizer enable coverage in the same process.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000603 coverage_enabled = enabled;
604 coverage_dir = dir;
605 if (enabled) coverage_data.Init();
606#if !SANITIZER_WINDOWS
607 if (!common_flags()->coverage_direct) Atexit(__sanitizer_cov_dump);
608#endif
609}
610
611void ReInitializeCoverage(bool enabled, const char *dir) {
612 coverage_enabled = enabled;
613 coverage_dir = dir;
614 coverage_data.ReInit();
615}
616
617void CoverageUpdateMapping() {
618 if (coverage_enabled)
619 CovUpdateMapping(coverage_dir);
620}
621
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000622} // namespace __sanitizer
623
624extern "C" {
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000625SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov(u32 *guard) {
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +0000626 coverage_data.Add(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
627 guard);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000628}
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000629SANITIZER_INTERFACE_ATTRIBUTE void
630__sanitizer_cov_indir_call16(uptr callee, uptr callee_cache16[]) {
631 coverage_data.IndirCall(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
632 callee, callee_cache16, 16);
633}
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000634SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_init() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000635 coverage_enabled = true;
636 coverage_dir = common_flags()->coverage_dir;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000637 coverage_data.Init();
638}
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000639SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_dump() { CovDump(); }
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000640SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_module_init(s32 *guards,
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000641 uptr npcs) {
642 coverage_data.InitializeGuards(guards, npcs);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000643 if (!common_flags()->coverage_direct) return;
644 if (SANITIZER_ANDROID && coverage_enabled) {
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000645 // dlopen/dlclose interceptors do not work on Android, so we rely on
646 // Extend() calls to update .sancov.map.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000647 CovUpdateMapping(coverage_dir, GET_CALLER_PC());
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000648 }
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000649 coverage_data.Extend(npcs);
650}
Sergey Matveev83f91e72014-05-21 13:43:52 +0000651SANITIZER_INTERFACE_ATTRIBUTE
652sptr __sanitizer_maybe_open_cov_file(const char *name) {
653 return MaybeOpenCovFile(name);
654}
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000655SANITIZER_INTERFACE_ATTRIBUTE
656uptr __sanitizer_get_total_unique_coverage() {
657 return atomic_load(&coverage_counter, memory_order_relaxed);
658}
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000659
660SANITIZER_INTERFACE_ATTRIBUTE
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000661void __sanitizer_cov_trace_func_enter(s32 *id) {
662 coverage_data.TraceBasicBlock(id);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000663}
664SANITIZER_INTERFACE_ATTRIBUTE
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000665void __sanitizer_cov_trace_basic_block(s32 *id) {
666 coverage_data.TraceBasicBlock(id);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000667}
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000668} // extern "C"