blob: 49887b1e91a934481cf6cc1df41f77540f04d215 [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 Stepanov3f2e7612015-01-12 17:13:20 +000069 void Enable();
70 void Disable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +000071 void ReInit();
Evgeniy Stepanovfe181022014-06-04 12:13:54 +000072 void BeforeFork();
73 void AfterFork(int child_pid);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000074 void Extend(uptr npcs);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000075 void Add(uptr pc, u32 *guard);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +000076 void IndirCall(uptr caller, uptr callee, uptr callee_cache[],
77 uptr cache_size);
78 void DumpCallerCalleePairs();
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +000079 void DumpTrace();
80
81 ALWAYS_INLINE
Kostya Serebryanyd421db02015-01-03 00:54:43 +000082 void TraceBasicBlock(s32 *id);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000083
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +000084 void InitializeGuardArray(s32 *guards);
Kostya Serebryany88599462015-02-20 00:30:44 +000085 void InitializeGuards(s32 *guards, uptr n, const char *module_name);
Kostya Serebryany21a1a232015-01-28 22:39:44 +000086 void ReinitializeGuards();
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000087
88 uptr *data();
89 uptr size();
90
91 private:
92 // Maximal size pc array may ever grow.
93 // We MmapNoReserve this space to ensure that the array is contiguous.
Evgeniy Stepanov10308462014-12-26 13:54:11 +000094 static const uptr kPcArrayMaxSize = FIRST_32_SECOND_64(1 << 24, 1 << 27);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000095 // The amount file mapping for the pc array is grown by.
96 static const uptr kPcArrayMmapSize = 64 * 1024;
97
98 // pc_array is allocated with MmapNoReserveOrDie and so it uses only as
99 // much RAM as it really needs.
100 uptr *pc_array;
101 // Index of the first available pc_array slot.
102 atomic_uintptr_t pc_array_index;
103 // Array size.
104 atomic_uintptr_t pc_array_size;
105 // Current file mapped size of the pc array.
106 uptr pc_array_mapped_size;
107 // Descriptor of the file mapped pc array.
108 int pc_fd;
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000109
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000110 // Vector of coverage guard arrays, protected by mu.
111 InternalMmapVectorNoCtor<s32*> guard_array_vec;
112
Kostya Serebryany88599462015-02-20 00:30:44 +0000113 // Vector of module (compilation unit) names.
114 InternalMmapVectorNoCtor<const char*> comp_unit_name_vec;
115
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000116 // Caller-Callee (cc) array, size and current index.
117 static const uptr kCcArrayMaxSize = FIRST_32_SECOND_64(1 << 18, 1 << 24);
118 uptr **cc_array;
119 atomic_uintptr_t cc_array_index;
120 atomic_uintptr_t cc_array_size;
121
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000122 // Tracing event array, size and current pointer.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000123 // We record all events (basic block entries) in a global buffer of u32
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000124 // values. Each such value is the index in pc_array.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000125 // So far the tracing is highly experimental:
126 // - not thread-safe;
127 // - does not support long traces;
128 // - not tuned for performance.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000129 static const uptr kTrEventArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 30);
130 u32 *tr_event_array;
131 uptr tr_event_array_size;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000132 u32 *tr_event_pointer;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000133 static const uptr kTrPcArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 27);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000134
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000135 StaticSpinMutex mu;
136
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000137 void DirectOpen();
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000138};
139
140static CoverageData coverage_data;
141
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000142void CovUpdateMapping(const char *path, uptr caller_pc = 0);
143
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000144void CoverageData::DirectOpen() {
Alexey Samsonov4cc76cb2014-11-26 01:48:39 +0000145 InternalScopedString path(kMaxPathLength);
Evgeniy Stepanovfa5c0752014-05-29 14:33:16 +0000146 internal_snprintf((char *)path.data(), path.size(), "%s/%zd.sancov.raw",
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000147 coverage_dir, internal_getpid());
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000148 pc_fd = OpenFile(path.data(), true);
149 if (internal_iserror(pc_fd)) {
150 Report(" Coverage: failed to open %s for writing\n", path.data());
151 Die();
152 }
153
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000154 pc_array_mapped_size = 0;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000155 CovUpdateMapping(coverage_dir);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000156}
157
158void CoverageData::Init() {
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000159 pc_fd = kInvalidFd;
160}
161
162void CoverageData::Enable() {
Viktor Kutuzov7891c8c2015-02-02 09:38:10 +0000163 if (pc_array)
164 return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000165 pc_array = reinterpret_cast<uptr *>(
166 MmapNoReserveOrDie(sizeof(uptr) * kPcArrayMaxSize, "CovInit"));
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000167 atomic_store(&pc_array_index, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000168 if (common_flags()->coverage_direct) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000169 atomic_store(&pc_array_size, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000170 } else {
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000171 atomic_store(&pc_array_size, kPcArrayMaxSize, memory_order_relaxed);
172 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000173
174 cc_array = reinterpret_cast<uptr **>(MmapNoReserveOrDie(
175 sizeof(uptr *) * kCcArrayMaxSize, "CovInit::cc_array"));
176 atomic_store(&cc_array_size, kCcArrayMaxSize, memory_order_relaxed);
177 atomic_store(&cc_array_index, 0, memory_order_relaxed);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000178
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000179 // Allocate tr_event_array with a guard page at the end.
180 tr_event_array = reinterpret_cast<u32 *>(MmapNoReserveOrDie(
181 sizeof(tr_event_array[0]) * kTrEventArrayMaxSize + GetMmapGranularity(),
182 "CovInit::tr_event_array"));
183 Mprotect(reinterpret_cast<uptr>(&tr_event_array[kTrEventArrayMaxSize]),
184 GetMmapGranularity());
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000185 tr_event_array_size = kTrEventArrayMaxSize;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000186 tr_event_pointer = tr_event_array;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000187}
188
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000189void CoverageData::InitializeGuardArray(s32 *guards) {
Viktor Kutuzov7891c8c2015-02-02 09:38:10 +0000190 Enable(); // Make sure coverage is enabled at this point.
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000191 s32 n = guards[0];
192 for (s32 j = 1; j <= n; j++) {
193 uptr idx = atomic_fetch_add(&pc_array_index, 1, memory_order_relaxed);
194 guards[j] = -static_cast<s32>(idx + 1);
195 }
196}
197
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000198void CoverageData::Disable() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000199 if (pc_array) {
200 internal_munmap(pc_array, sizeof(uptr) * kPcArrayMaxSize);
201 pc_array = nullptr;
202 }
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000203 if (cc_array) {
204 internal_munmap(cc_array, sizeof(uptr *) * kCcArrayMaxSize);
205 cc_array = nullptr;
206 }
207 if (tr_event_array) {
208 internal_munmap(tr_event_array,
209 sizeof(tr_event_array[0]) * kTrEventArrayMaxSize +
210 GetMmapGranularity());
211 tr_event_array = nullptr;
212 tr_event_pointer = nullptr;
213 }
214 if (pc_fd != kInvalidFd) {
215 internal_close(pc_fd);
216 pc_fd = kInvalidFd;
217 }
218}
219
Kostya Serebryany21a1a232015-01-28 22:39:44 +0000220void CoverageData::ReinitializeGuards() {
221 // Assuming single thread.
222 atomic_store(&pc_array_index, 0, memory_order_relaxed);
223 for (uptr i = 0; i < guard_array_vec.size(); i++)
224 InitializeGuardArray(guard_array_vec[i]);
225}
226
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000227void CoverageData::ReInit() {
228 Disable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000229 if (coverage_enabled) {
230 if (common_flags()->coverage_direct) {
231 // In memory-mapped mode we must extend the new file to the known array
232 // size.
233 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000234 Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000235 if (size) Extend(size);
236 if (coverage_enabled) CovUpdateMapping(coverage_dir);
237 } else {
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000238 Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000239 }
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000240 }
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000241 // Re-initialize the guards.
242 // We are single-threaded now, no need to grab any lock.
243 CHECK_EQ(atomic_load(&pc_array_index, memory_order_relaxed), 0);
Kostya Serebryany21a1a232015-01-28 22:39:44 +0000244 ReinitializeGuards();
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000245}
246
247void CoverageData::BeforeFork() {
248 mu.Lock();
249}
250
251void CoverageData::AfterFork(int child_pid) {
252 // We are single-threaded so it's OK to release the lock early.
253 mu.Unlock();
254 if (child_pid == 0) ReInit();
255}
256
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000257// Extend coverage PC array to fit additional npcs elements.
258void CoverageData::Extend(uptr npcs) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000259 if (!common_flags()->coverage_direct) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000260 SpinMutexLock l(&mu);
261
262 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
263 size += npcs * sizeof(uptr);
264
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000265 if (coverage_enabled && size > pc_array_mapped_size) {
266 if (pc_fd == kInvalidFd) DirectOpen();
267 CHECK_NE(pc_fd, kInvalidFd);
268
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000269 uptr new_mapped_size = pc_array_mapped_size;
270 while (size > new_mapped_size) new_mapped_size += kPcArrayMmapSize;
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000271 CHECK_LE(new_mapped_size, sizeof(uptr) * kPcArrayMaxSize);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000272
273 // Extend the file and map the new space at the end of pc_array.
274 uptr res = internal_ftruncate(pc_fd, new_mapped_size);
275 int err;
276 if (internal_iserror(res, &err)) {
277 Printf("failed to extend raw coverage file: %d\n", err);
278 Die();
279 }
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000280
281 uptr next_map_base = ((uptr)pc_array) + pc_array_mapped_size;
282 void *p = MapWritableFileToMemory((void *)next_map_base,
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000283 new_mapped_size - pc_array_mapped_size,
284 pc_fd, pc_array_mapped_size);
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000285 CHECK_EQ((uptr)p, next_map_base);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000286 pc_array_mapped_size = new_mapped_size;
287 }
288
289 atomic_store(&pc_array_size, size, memory_order_release);
290}
291
Kostya Serebryany88599462015-02-20 00:30:44 +0000292void CoverageData::InitializeGuards(s32 *guards, uptr n,
293 const char *module_name) {
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000294 // The array 'guards' has n+1 elements, we use the element zero
295 // to store 'n'.
296 CHECK_LT(n, 1 << 30);
297 guards[0] = static_cast<s32>(n);
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000298 InitializeGuardArray(guards);
299 SpinMutexLock l(&mu);
Kostya Serebryany88599462015-02-20 00:30:44 +0000300 comp_unit_name_vec.push_back(module_name);
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000301 guard_array_vec.push_back(guards);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000302}
303
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000304// If guard is negative, atomically set it to -guard and store the PC in
305// pc_array.
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000306void CoverageData::Add(uptr pc, u32 *guard) {
307 atomic_uint32_t *atomic_guard = reinterpret_cast<atomic_uint32_t*>(guard);
308 s32 guard_value = atomic_load(atomic_guard, memory_order_relaxed);
309 if (guard_value >= 0) return;
310
311 atomic_store(atomic_guard, -guard_value, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000312 if (!pc_array) return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000313
314 uptr idx = -guard_value - 1;
315 if (idx >= atomic_load(&pc_array_index, memory_order_acquire))
316 return; // May happen after fork when pc_array_index becomes 0.
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000317 CHECK_LT(idx * sizeof(uptr),
318 atomic_load(&pc_array_size, memory_order_acquire));
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000319 pc_array[idx] = pc;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000320 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000321}
322
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000323// Registers a pair caller=>callee.
324// When a given caller is seen for the first time, the callee_cache is added
325// to the global array cc_array, callee_cache[0] is set to caller and
326// callee_cache[1] is set to cache_size.
327// Then we are trying to add callee to callee_cache [2,cache_size) if it is
328// not there yet.
329// If the cache is full we drop the callee (may want to fix this later).
330void CoverageData::IndirCall(uptr caller, uptr callee, uptr callee_cache[],
331 uptr cache_size) {
332 if (!cc_array) return;
333 atomic_uintptr_t *atomic_callee_cache =
334 reinterpret_cast<atomic_uintptr_t *>(callee_cache);
335 uptr zero = 0;
336 if (atomic_compare_exchange_strong(&atomic_callee_cache[0], &zero, caller,
337 memory_order_seq_cst)) {
338 uptr idx = atomic_fetch_add(&cc_array_index, 1, memory_order_relaxed);
339 CHECK_LT(idx * sizeof(uptr),
340 atomic_load(&cc_array_size, memory_order_acquire));
341 callee_cache[1] = cache_size;
342 cc_array[idx] = callee_cache;
343 }
344 CHECK_EQ(atomic_load(&atomic_callee_cache[0], memory_order_relaxed), caller);
345 for (uptr i = 2; i < cache_size; i++) {
346 uptr was = 0;
347 if (atomic_compare_exchange_strong(&atomic_callee_cache[i], &was, callee,
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000348 memory_order_seq_cst)) {
349 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000350 return;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000351 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000352 if (was == callee) // Already have this callee.
353 return;
354 }
355}
356
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000357uptr *CoverageData::data() {
358 return pc_array;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000359}
360
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000361uptr CoverageData::size() {
362 return atomic_load(&pc_array_index, memory_order_relaxed);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000363}
364
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000365// Block layout for packed file format: header, followed by module name (no
366// trailing zero), followed by data blob.
367struct CovHeader {
368 int pid;
369 unsigned int module_name_length;
370 unsigned int data_length;
371};
372
373static void CovWritePacked(int pid, const char *module, const void *blob,
374 unsigned int blob_size) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000375 if (cov_fd < 0) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000376 unsigned module_name_length = internal_strlen(module);
377 CovHeader header = {pid, module_name_length, blob_size};
378
379 if (cov_max_block_size == 0) {
380 // Writing to a file. Just go ahead.
381 internal_write(cov_fd, &header, sizeof(header));
382 internal_write(cov_fd, module, module_name_length);
383 internal_write(cov_fd, blob, blob_size);
384 } else {
385 // Writing to a socket. We want to split the data into appropriately sized
386 // blocks.
387 InternalScopedBuffer<char> block(cov_max_block_size);
388 CHECK_EQ((uptr)block.data(), (uptr)(CovHeader *)block.data());
389 uptr header_size_with_module = sizeof(header) + module_name_length;
390 CHECK_LT(header_size_with_module, cov_max_block_size);
391 unsigned int max_payload_size =
392 cov_max_block_size - header_size_with_module;
393 char *block_pos = block.data();
394 internal_memcpy(block_pos, &header, sizeof(header));
395 block_pos += sizeof(header);
396 internal_memcpy(block_pos, module, module_name_length);
397 block_pos += module_name_length;
398 char *block_data_begin = block_pos;
Alexey Samsonov4925fd42014-11-13 22:40:59 +0000399 const char *blob_pos = (const char *)blob;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000400 while (blob_size > 0) {
401 unsigned int payload_size = Min(blob_size, max_payload_size);
402 blob_size -= payload_size;
403 internal_memcpy(block_data_begin, blob_pos, payload_size);
404 blob_pos += payload_size;
405 ((CovHeader *)block.data())->data_length = payload_size;
406 internal_write(cov_fd, block.data(),
407 header_size_with_module + payload_size);
408 }
409 }
410}
411
Sergey Matveev83f91e72014-05-21 13:43:52 +0000412// If packed = false: <name>.<pid>.<sancov> (name = module name).
413// If packed = true and name == 0: <pid>.<sancov>.<packed>.
414// If packed = true and name != 0: <name>.<sancov>.<packed> (name is
415// user-supplied).
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000416static int CovOpenFile(bool packed, const char *name,
417 const char *extension = "sancov") {
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000418 InternalScopedString path(kMaxPathLength);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000419 if (!packed) {
420 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000421 path.append("%s/%s.%zd.%s", coverage_dir, name, internal_getpid(),
422 extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000423 } else {
424 if (!name)
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000425 path.append("%s/%zd.%s.packed", coverage_dir, internal_getpid(),
Evgeniy Stepanovf8c7e252014-12-26 10:19:56 +0000426 extension);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000427 else
428 path.append("%s/%s.%s.packed", coverage_dir, name, extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000429 }
430 uptr fd = OpenFile(path.data(), true);
431 if (internal_iserror(fd)) {
432 Report(" SanitizerCoverage: failed to open %s for writing\n", path.data());
433 return -1;
434 }
435 return fd;
436}
437
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000438// Dump trace PCs and trace events into two separate files.
439void CoverageData::DumpTrace() {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000440 uptr max_idx = tr_event_pointer - tr_event_array;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000441 if (!max_idx) return;
442 auto sym = Symbolizer::GetOrInit();
443 if (!sym)
444 return;
445 InternalScopedString out(32 << 20);
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000446 for (uptr i = 0, n = size(); i < n; i++) {
447 const char *module_name = "<unknown>";
448 uptr module_address = 0;
449 sym->GetModuleNameAndOffsetForPC(pc_array[i], &module_name,
450 &module_address);
451 out.append("%s 0x%zx\n", module_name, module_address);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000452 }
453 int fd = CovOpenFile(false, "trace-points");
454 if (fd < 0) return;
455 internal_write(fd, out.data(), out.length());
456 internal_close(fd);
457
Kostya Serebryany88599462015-02-20 00:30:44 +0000458 fd = CovOpenFile(false, "trace-compunits");
459 if (fd < 0) return;
460 out.clear();
461 for (uptr i = 0; i < comp_unit_name_vec.size(); i++)
462 out.append("%s\n", comp_unit_name_vec[i]);
463 internal_write(fd, out.data(), out.length());
464 internal_close(fd);
465
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000466 fd = CovOpenFile(false, "trace-events");
467 if (fd < 0) return;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000468 uptr bytes_to_write = max_idx * sizeof(tr_event_array[0]);
469 u8 *event_bytes = reinterpret_cast<u8*>(tr_event_array);
470 // The trace file could be huge, and may not be written with a single syscall.
471 while (bytes_to_write) {
472 uptr actually_written = internal_write(fd, event_bytes, bytes_to_write);
473 if (actually_written <= bytes_to_write) {
474 bytes_to_write -= actually_written;
475 event_bytes += actually_written;
476 } else {
477 break;
478 }
479 }
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000480 internal_close(fd);
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000481 VReport(1, " CovDump: Trace: %zd PCs written\n", size());
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000482 VReport(1, " CovDump: Trace: %zd Events written\n", max_idx);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000483}
484
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000485// This function dumps the caller=>callee pairs into a file as a sequence of
486// lines like "module_name offset".
487void CoverageData::DumpCallerCalleePairs() {
488 uptr max_idx = atomic_load(&cc_array_index, memory_order_relaxed);
489 if (!max_idx) return;
490 auto sym = Symbolizer::GetOrInit();
491 if (!sym)
492 return;
Kostya Serebryany40aa4a22014-10-31 19:49:46 +0000493 InternalScopedString out(32 << 20);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000494 uptr total = 0;
495 for (uptr i = 0; i < max_idx; i++) {
496 uptr *cc_cache = cc_array[i];
497 CHECK(cc_cache);
498 uptr caller = cc_cache[0];
499 uptr n_callees = cc_cache[1];
500 const char *caller_module_name = "<unknown>";
501 uptr caller_module_address = 0;
502 sym->GetModuleNameAndOffsetForPC(caller, &caller_module_name,
503 &caller_module_address);
504 for (uptr j = 2; j < n_callees; j++) {
505 uptr callee = cc_cache[j];
506 if (!callee) break;
507 total++;
508 const char *callee_module_name = "<unknown>";
509 uptr callee_module_address = 0;
510 sym->GetModuleNameAndOffsetForPC(callee, &callee_module_name,
511 &callee_module_address);
512 out.append("%s 0x%zx\n%s 0x%zx\n", caller_module_name,
513 caller_module_address, callee_module_name,
514 callee_module_address);
515 }
516 }
517 int fd = CovOpenFile(false, "caller-callee");
518 if (fd < 0) return;
519 internal_write(fd, out.data(), out.length());
520 internal_close(fd);
521 VReport(1, " CovDump: %zd caller-callee pairs written\n", total);
522}
523
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000524// Record the current PC into the event buffer.
525// Every event is a u32 value (index in tr_pc_array_index) so we compute
526// it once and then cache in the provided 'cache' storage.
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000527//
528// This function will eventually be inlined by the compiler.
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000529void CoverageData::TraceBasicBlock(s32 *id) {
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000530 // Will trap here if
531 // 1. coverage is not enabled at run-time.
532 // 2. The array tr_event_array is full.
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000533 *tr_event_pointer = static_cast<u32>(*id - 1);
534 tr_event_pointer++;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000535}
536
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000537static void CovDumpAsBitSet() {
538 if (!common_flags()->coverage_bitset) return;
539 if (!coverage_data.size()) return;
540 int fd = CovOpenFile(/* packed */false, "combined", "bitset-sancov");
541 if (fd < 0) return;
542 uptr n = coverage_data.size();
543 uptr n_set_bits = 0;
544 InternalScopedBuffer<char> out(n);
545 for (uptr i = 0; i < n; i++) {
546 uptr pc = coverage_data.data()[i];
547 out[i] = pc ? '1' : '0';
548 if (pc)
549 n_set_bits++;
550 }
551 internal_write(fd, out.data(), n);
552 internal_close(fd);
553 VReport(1, " CovDump: bitset of %zd bits written, %zd bits are set\n", n,
554 n_set_bits);
555}
556
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000557// Dump the coverage on disk.
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000558static void CovDump() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000559 if (!coverage_enabled || common_flags()->coverage_direct) return;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000560#if !SANITIZER_WINDOWS
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000561 if (atomic_fetch_add(&dump_once_guard, 1, memory_order_relaxed))
562 return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000563 CovDumpAsBitSet();
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000564 coverage_data.DumpTrace();
Kostya Serebryanya7ee2732014-12-30 19:55:04 +0000565 if (!common_flags()->coverage_pcs) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000566 uptr size = coverage_data.size();
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000567 InternalMmapVector<u32> offsets(size);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000568 uptr *vb = coverage_data.data();
569 uptr *ve = vb + size;
570 SortArray(vb, size);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000571 MemoryMappingLayout proc_maps(/*cache_enabled*/true);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000572 uptr mb, me, off, prot;
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000573 InternalScopedString module(kMaxPathLength);
574 InternalScopedString path(kMaxPathLength);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000575 for (int i = 0;
576 proc_maps.Next(&mb, &me, &off, module.data(), module.size(), &prot);
577 i++) {
578 if ((prot & MemoryMappingLayout::kProtectionExecute) == 0)
579 continue;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000580 while (vb < ve && *vb < mb) vb++;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000581 if (vb >= ve) break;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000582 if (*vb < me) {
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000583 offsets.clear();
584 const uptr *old_vb = vb;
585 CHECK_LE(off, *vb);
586 for (; vb < ve && *vb < me; vb++) {
587 uptr diff = *vb - (i ? mb : 0) + off;
588 CHECK_LE(diff, 0xffffffffU);
589 offsets.push_back(static_cast<u32>(diff));
590 }
Alexey Samsonov26ca05a2014-11-04 19:34:29 +0000591 const char *module_name = StripModuleName(module.data());
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000592 if (cov_sandboxed) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000593 if (cov_fd >= 0) {
594 CovWritePacked(internal_getpid(), module_name, offsets.data(),
595 offsets.size() * sizeof(u32));
596 VReport(1, " CovDump: %zd PCs written to packed file\n", vb - old_vb);
597 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000598 } else {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000599 // One file per module per process.
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000600 path.clear();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000601 path.append("%s/%s.%zd.sancov", coverage_dir, module_name,
602 internal_getpid());
Sergey Matveev83f91e72014-05-21 13:43:52 +0000603 int fd = CovOpenFile(false /* packed */, module_name);
604 if (fd > 0) {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000605 internal_write(fd, offsets.data(), offsets.size() * sizeof(u32));
606 internal_close(fd);
607 VReport(1, " CovDump: %s: %zd PCs written\n", path.data(),
608 vb - old_vb);
609 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000610 }
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000611 }
612 }
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000613 if (cov_fd >= 0)
614 internal_close(cov_fd);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000615 coverage_data.DumpCallerCalleePairs();
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000616#endif // !SANITIZER_WINDOWS
617}
618
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000619void CovPrepareForSandboxing(__sanitizer_sandbox_arguments *args) {
620 if (!args) return;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000621 if (!coverage_enabled) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000622 cov_sandboxed = args->coverage_sandboxed;
623 if (!cov_sandboxed) return;
624 cov_fd = args->coverage_fd;
625 cov_max_block_size = args->coverage_max_block_size;
626 if (cov_fd < 0)
627 // Pre-open the file now. The sandbox won't allow us to do it later.
Sergey Matveev83f91e72014-05-21 13:43:52 +0000628 cov_fd = CovOpenFile(true /* packed */, 0);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000629}
630
Sergey Matveev83f91e72014-05-21 13:43:52 +0000631int MaybeOpenCovFile(const char *name) {
632 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000633 if (!coverage_enabled) return -1;
Sergey Matveev83f91e72014-05-21 13:43:52 +0000634 return CovOpenFile(true /* packed */, name);
635}
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000636
637void CovBeforeFork() {
638 coverage_data.BeforeFork();
639}
640
641void CovAfterFork(int child_pid) {
642 coverage_data.AfterFork(child_pid);
643}
644
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000645void InitializeCoverage(bool enabled, const char *dir) {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000646 if (coverage_enabled)
647 return; // May happen if two sanitizer enable coverage in the same process.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000648 coverage_enabled = enabled;
649 coverage_dir = dir;
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000650 coverage_data.Init();
651 if (enabled) coverage_data.Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000652#if !SANITIZER_WINDOWS
653 if (!common_flags()->coverage_direct) Atexit(__sanitizer_cov_dump);
654#endif
655}
656
657void ReInitializeCoverage(bool enabled, const char *dir) {
658 coverage_enabled = enabled;
659 coverage_dir = dir;
660 coverage_data.ReInit();
661}
662
663void CoverageUpdateMapping() {
664 if (coverage_enabled)
665 CovUpdateMapping(coverage_dir);
666}
667
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000668} // namespace __sanitizer
669
670extern "C" {
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000671SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov(u32 *guard) {
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +0000672 coverage_data.Add(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
673 guard);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000674}
Kostya Serebryany77cc7292015-02-04 01:21:45 +0000675SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_with_check(u32 *guard) {
676 atomic_uint32_t *atomic_guard = reinterpret_cast<atomic_uint32_t*>(guard);
677 if (__sanitizer::atomic_load(atomic_guard, memory_order_relaxed))
678 __sanitizer_cov(guard);
679}
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000680SANITIZER_INTERFACE_ATTRIBUTE void
681__sanitizer_cov_indir_call16(uptr callee, uptr callee_cache16[]) {
682 coverage_data.IndirCall(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
683 callee, callee_cache16, 16);
684}
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000685SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_init() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000686 coverage_enabled = true;
687 coverage_dir = common_flags()->coverage_dir;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000688 coverage_data.Init();
689}
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000690SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_dump() { CovDump(); }
Kostya Serebryany88599462015-02-20 00:30:44 +0000691SANITIZER_INTERFACE_ATTRIBUTE void
692__sanitizer_cov_module_init(s32 *guards, uptr npcs, const char *module_name) {
693 coverage_data.InitializeGuards(guards, npcs, module_name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000694 if (!common_flags()->coverage_direct) return;
695 if (SANITIZER_ANDROID && coverage_enabled) {
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000696 // dlopen/dlclose interceptors do not work on Android, so we rely on
697 // Extend() calls to update .sancov.map.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000698 CovUpdateMapping(coverage_dir, GET_CALLER_PC());
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000699 }
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000700 coverage_data.Extend(npcs);
701}
Sergey Matveev83f91e72014-05-21 13:43:52 +0000702SANITIZER_INTERFACE_ATTRIBUTE
703sptr __sanitizer_maybe_open_cov_file(const char *name) {
704 return MaybeOpenCovFile(name);
705}
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000706SANITIZER_INTERFACE_ATTRIBUTE
707uptr __sanitizer_get_total_unique_coverage() {
708 return atomic_load(&coverage_counter, memory_order_relaxed);
709}
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000710
711SANITIZER_INTERFACE_ATTRIBUTE
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000712void __sanitizer_cov_trace_func_enter(s32 *id) {
713 coverage_data.TraceBasicBlock(id);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000714}
715SANITIZER_INTERFACE_ATTRIBUTE
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000716void __sanitizer_cov_trace_basic_block(s32 *id) {
717 coverage_data.TraceBasicBlock(id);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000718}
Kostya Serebryany21a1a232015-01-28 22:39:44 +0000719SANITIZER_INTERFACE_ATTRIBUTE
720void __sanitizer_reset_coverage() {
721 coverage_data.ReinitializeGuards();
722 internal_bzero_aligned16(
723 coverage_data.data(),
724 RoundUpTo(coverage_data.size() * sizeof(coverage_data.data()[0]), 16));
725}
726SANITIZER_INTERFACE_ATTRIBUTE
727uptr __sanitizer_get_coverage_guards(uptr **data) {
728 *data = coverage_data.data();
729 return coverage_data.size();
730}
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000731} // extern "C"