blob: 0048f6791854952cede6c3e14e2a1f6ae3590f1a [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 Serebryanyaa185bf2014-12-30 19:29:28 +000085 void InitializeGuards(s32 *guards, uptr n);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000086
87 uptr *data();
88 uptr size();
89
90 private:
91 // Maximal size pc array may ever grow.
92 // We MmapNoReserve this space to ensure that the array is contiguous.
Evgeniy Stepanov10308462014-12-26 13:54:11 +000093 static const uptr kPcArrayMaxSize = FIRST_32_SECOND_64(1 << 24, 1 << 27);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000094 // The amount file mapping for the pc array is grown by.
95 static const uptr kPcArrayMmapSize = 64 * 1024;
96
97 // pc_array is allocated with MmapNoReserveOrDie and so it uses only as
98 // much RAM as it really needs.
99 uptr *pc_array;
100 // Index of the first available pc_array slot.
101 atomic_uintptr_t pc_array_index;
102 // Array size.
103 atomic_uintptr_t pc_array_size;
104 // Current file mapped size of the pc array.
105 uptr pc_array_mapped_size;
106 // Descriptor of the file mapped pc array.
107 int pc_fd;
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000108
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000109 // Vector of coverage guard arrays, protected by mu.
110 InternalMmapVectorNoCtor<s32*> guard_array_vec;
111
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000112 // Caller-Callee (cc) array, size and current index.
113 static const uptr kCcArrayMaxSize = FIRST_32_SECOND_64(1 << 18, 1 << 24);
114 uptr **cc_array;
115 atomic_uintptr_t cc_array_index;
116 atomic_uintptr_t cc_array_size;
117
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000118 // Tracing event array, size and current pointer.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000119 // We record all events (basic block entries) in a global buffer of u32
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000120 // values. Each such value is the index in pc_array.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000121 // So far the tracing is highly experimental:
122 // - not thread-safe;
123 // - does not support long traces;
124 // - not tuned for performance.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000125 static const uptr kTrEventArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 30);
126 u32 *tr_event_array;
127 uptr tr_event_array_size;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000128 u32 *tr_event_pointer;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000129 static const uptr kTrPcArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 27);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000130
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000131 StaticSpinMutex mu;
132
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000133 void DirectOpen();
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000134};
135
136static CoverageData coverage_data;
137
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000138void CovUpdateMapping(const char *path, uptr caller_pc = 0);
139
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000140void CoverageData::DirectOpen() {
Alexey Samsonov4cc76cb2014-11-26 01:48:39 +0000141 InternalScopedString path(kMaxPathLength);
Evgeniy Stepanovfa5c0752014-05-29 14:33:16 +0000142 internal_snprintf((char *)path.data(), path.size(), "%s/%zd.sancov.raw",
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000143 coverage_dir, internal_getpid());
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000144 pc_fd = OpenFile(path.data(), true);
145 if (internal_iserror(pc_fd)) {
146 Report(" Coverage: failed to open %s for writing\n", path.data());
147 Die();
148 }
149
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000150 pc_array_mapped_size = 0;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000151 CovUpdateMapping(coverage_dir);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000152}
153
154void CoverageData::Init() {
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000155 pc_fd = kInvalidFd;
156}
157
158void CoverageData::Enable() {
Evgeniy Stepanov0bc26c02015-01-27 15:06:54 +0000159 CHECK_EQ(pc_array, nullptr);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000160 pc_array = reinterpret_cast<uptr *>(
161 MmapNoReserveOrDie(sizeof(uptr) * kPcArrayMaxSize, "CovInit"));
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000162 atomic_store(&pc_array_index, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000163 if (common_flags()->coverage_direct) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000164 atomic_store(&pc_array_size, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000165 } else {
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000166 atomic_store(&pc_array_size, kPcArrayMaxSize, memory_order_relaxed);
167 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000168
169 cc_array = reinterpret_cast<uptr **>(MmapNoReserveOrDie(
170 sizeof(uptr *) * kCcArrayMaxSize, "CovInit::cc_array"));
171 atomic_store(&cc_array_size, kCcArrayMaxSize, memory_order_relaxed);
172 atomic_store(&cc_array_index, 0, memory_order_relaxed);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000173
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000174 // Allocate tr_event_array with a guard page at the end.
175 tr_event_array = reinterpret_cast<u32 *>(MmapNoReserveOrDie(
176 sizeof(tr_event_array[0]) * kTrEventArrayMaxSize + GetMmapGranularity(),
177 "CovInit::tr_event_array"));
178 Mprotect(reinterpret_cast<uptr>(&tr_event_array[kTrEventArrayMaxSize]),
179 GetMmapGranularity());
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000180 tr_event_array_size = kTrEventArrayMaxSize;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000181 tr_event_pointer = tr_event_array;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000182}
183
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000184void CoverageData::InitializeGuardArray(s32 *guards) {
185 s32 n = guards[0];
186 for (s32 j = 1; j <= n; j++) {
187 uptr idx = atomic_fetch_add(&pc_array_index, 1, memory_order_relaxed);
188 guards[j] = -static_cast<s32>(idx + 1);
189 }
190}
191
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000192void CoverageData::Disable() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000193 if (pc_array) {
194 internal_munmap(pc_array, sizeof(uptr) * kPcArrayMaxSize);
195 pc_array = nullptr;
196 }
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000197 if (cc_array) {
198 internal_munmap(cc_array, sizeof(uptr *) * kCcArrayMaxSize);
199 cc_array = nullptr;
200 }
201 if (tr_event_array) {
202 internal_munmap(tr_event_array,
203 sizeof(tr_event_array[0]) * kTrEventArrayMaxSize +
204 GetMmapGranularity());
205 tr_event_array = nullptr;
206 tr_event_pointer = nullptr;
207 }
208 if (pc_fd != kInvalidFd) {
209 internal_close(pc_fd);
210 pc_fd = kInvalidFd;
211 }
212}
213
214void CoverageData::ReInit() {
215 Disable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000216 if (coverage_enabled) {
217 if (common_flags()->coverage_direct) {
218 // In memory-mapped mode we must extend the new file to the known array
219 // size.
220 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000221 Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000222 if (size) Extend(size);
223 if (coverage_enabled) CovUpdateMapping(coverage_dir);
224 } else {
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000225 Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000226 }
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000227 }
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000228 // Re-initialize the guards.
229 // We are single-threaded now, no need to grab any lock.
230 CHECK_EQ(atomic_load(&pc_array_index, memory_order_relaxed), 0);
231 for (uptr i = 0; i < guard_array_vec.size(); i++)
232 InitializeGuardArray(guard_array_vec[i]);
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000233}
234
235void CoverageData::BeforeFork() {
236 mu.Lock();
237}
238
239void CoverageData::AfterFork(int child_pid) {
240 // We are single-threaded so it's OK to release the lock early.
241 mu.Unlock();
242 if (child_pid == 0) ReInit();
243}
244
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000245// Extend coverage PC array to fit additional npcs elements.
246void CoverageData::Extend(uptr npcs) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000247 if (!common_flags()->coverage_direct) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000248 SpinMutexLock l(&mu);
249
250 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
251 size += npcs * sizeof(uptr);
252
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000253 if (coverage_enabled && size > pc_array_mapped_size) {
254 if (pc_fd == kInvalidFd) DirectOpen();
255 CHECK_NE(pc_fd, kInvalidFd);
256
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000257 uptr new_mapped_size = pc_array_mapped_size;
258 while (size > new_mapped_size) new_mapped_size += kPcArrayMmapSize;
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000259 CHECK_LE(new_mapped_size, sizeof(uptr) * kPcArrayMaxSize);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000260
261 // Extend the file and map the new space at the end of pc_array.
262 uptr res = internal_ftruncate(pc_fd, new_mapped_size);
263 int err;
264 if (internal_iserror(res, &err)) {
265 Printf("failed to extend raw coverage file: %d\n", err);
266 Die();
267 }
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000268
269 uptr next_map_base = ((uptr)pc_array) + pc_array_mapped_size;
270 void *p = MapWritableFileToMemory((void *)next_map_base,
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000271 new_mapped_size - pc_array_mapped_size,
272 pc_fd, pc_array_mapped_size);
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000273 CHECK_EQ((uptr)p, next_map_base);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000274 pc_array_mapped_size = new_mapped_size;
275 }
276
277 atomic_store(&pc_array_size, size, memory_order_release);
278}
279
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000280void CoverageData::InitializeGuards(s32 *guards, uptr n) {
281 // The array 'guards' has n+1 elements, we use the element zero
282 // to store 'n'.
283 CHECK_LT(n, 1 << 30);
284 guards[0] = static_cast<s32>(n);
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000285 InitializeGuardArray(guards);
286 SpinMutexLock l(&mu);
287 guard_array_vec.push_back(guards);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000288}
289
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000290// If guard is negative, atomically set it to -guard and store the PC in
291// pc_array.
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000292void CoverageData::Add(uptr pc, u32 *guard) {
293 atomic_uint32_t *atomic_guard = reinterpret_cast<atomic_uint32_t*>(guard);
294 s32 guard_value = atomic_load(atomic_guard, memory_order_relaxed);
295 if (guard_value >= 0) return;
296
297 atomic_store(atomic_guard, -guard_value, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000298 if (!pc_array) return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000299
300 uptr idx = -guard_value - 1;
301 if (idx >= atomic_load(&pc_array_index, memory_order_acquire))
302 return; // May happen after fork when pc_array_index becomes 0.
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000303 CHECK_LT(idx * sizeof(uptr),
304 atomic_load(&pc_array_size, memory_order_acquire));
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000305 pc_array[idx] = pc;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000306 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000307}
308
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000309// Registers a pair caller=>callee.
310// When a given caller is seen for the first time, the callee_cache is added
311// to the global array cc_array, callee_cache[0] is set to caller and
312// callee_cache[1] is set to cache_size.
313// Then we are trying to add callee to callee_cache [2,cache_size) if it is
314// not there yet.
315// If the cache is full we drop the callee (may want to fix this later).
316void CoverageData::IndirCall(uptr caller, uptr callee, uptr callee_cache[],
317 uptr cache_size) {
318 if (!cc_array) return;
319 atomic_uintptr_t *atomic_callee_cache =
320 reinterpret_cast<atomic_uintptr_t *>(callee_cache);
321 uptr zero = 0;
322 if (atomic_compare_exchange_strong(&atomic_callee_cache[0], &zero, caller,
323 memory_order_seq_cst)) {
324 uptr idx = atomic_fetch_add(&cc_array_index, 1, memory_order_relaxed);
325 CHECK_LT(idx * sizeof(uptr),
326 atomic_load(&cc_array_size, memory_order_acquire));
327 callee_cache[1] = cache_size;
328 cc_array[idx] = callee_cache;
329 }
330 CHECK_EQ(atomic_load(&atomic_callee_cache[0], memory_order_relaxed), caller);
331 for (uptr i = 2; i < cache_size; i++) {
332 uptr was = 0;
333 if (atomic_compare_exchange_strong(&atomic_callee_cache[i], &was, callee,
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000334 memory_order_seq_cst)) {
335 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000336 return;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000337 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000338 if (was == callee) // Already have this callee.
339 return;
340 }
341}
342
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000343uptr *CoverageData::data() {
344 return pc_array;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000345}
346
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000347uptr CoverageData::size() {
348 return atomic_load(&pc_array_index, memory_order_relaxed);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000349}
350
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000351// Block layout for packed file format: header, followed by module name (no
352// trailing zero), followed by data blob.
353struct CovHeader {
354 int pid;
355 unsigned int module_name_length;
356 unsigned int data_length;
357};
358
359static void CovWritePacked(int pid, const char *module, const void *blob,
360 unsigned int blob_size) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000361 if (cov_fd < 0) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000362 unsigned module_name_length = internal_strlen(module);
363 CovHeader header = {pid, module_name_length, blob_size};
364
365 if (cov_max_block_size == 0) {
366 // Writing to a file. Just go ahead.
367 internal_write(cov_fd, &header, sizeof(header));
368 internal_write(cov_fd, module, module_name_length);
369 internal_write(cov_fd, blob, blob_size);
370 } else {
371 // Writing to a socket. We want to split the data into appropriately sized
372 // blocks.
373 InternalScopedBuffer<char> block(cov_max_block_size);
374 CHECK_EQ((uptr)block.data(), (uptr)(CovHeader *)block.data());
375 uptr header_size_with_module = sizeof(header) + module_name_length;
376 CHECK_LT(header_size_with_module, cov_max_block_size);
377 unsigned int max_payload_size =
378 cov_max_block_size - header_size_with_module;
379 char *block_pos = block.data();
380 internal_memcpy(block_pos, &header, sizeof(header));
381 block_pos += sizeof(header);
382 internal_memcpy(block_pos, module, module_name_length);
383 block_pos += module_name_length;
384 char *block_data_begin = block_pos;
Alexey Samsonov4925fd42014-11-13 22:40:59 +0000385 const char *blob_pos = (const char *)blob;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000386 while (blob_size > 0) {
387 unsigned int payload_size = Min(blob_size, max_payload_size);
388 blob_size -= payload_size;
389 internal_memcpy(block_data_begin, blob_pos, payload_size);
390 blob_pos += payload_size;
391 ((CovHeader *)block.data())->data_length = payload_size;
392 internal_write(cov_fd, block.data(),
393 header_size_with_module + payload_size);
394 }
395 }
396}
397
Sergey Matveev83f91e72014-05-21 13:43:52 +0000398// If packed = false: <name>.<pid>.<sancov> (name = module name).
399// If packed = true and name == 0: <pid>.<sancov>.<packed>.
400// If packed = true and name != 0: <name>.<sancov>.<packed> (name is
401// user-supplied).
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000402static int CovOpenFile(bool packed, const char *name,
403 const char *extension = "sancov") {
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000404 InternalScopedString path(kMaxPathLength);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000405 if (!packed) {
406 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000407 path.append("%s/%s.%zd.%s", coverage_dir, name, internal_getpid(),
408 extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000409 } else {
410 if (!name)
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000411 path.append("%s/%zd.%s.packed", coverage_dir, internal_getpid(),
Evgeniy Stepanovf8c7e252014-12-26 10:19:56 +0000412 extension);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000413 else
414 path.append("%s/%s.%s.packed", coverage_dir, name, extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000415 }
416 uptr fd = OpenFile(path.data(), true);
417 if (internal_iserror(fd)) {
418 Report(" SanitizerCoverage: failed to open %s for writing\n", path.data());
419 return -1;
420 }
421 return fd;
422}
423
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000424// Dump trace PCs and trace events into two separate files.
425void CoverageData::DumpTrace() {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000426 uptr max_idx = tr_event_pointer - tr_event_array;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000427 if (!max_idx) return;
428 auto sym = Symbolizer::GetOrInit();
429 if (!sym)
430 return;
431 InternalScopedString out(32 << 20);
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000432 for (uptr i = 0, n = size(); i < n; i++) {
433 const char *module_name = "<unknown>";
434 uptr module_address = 0;
435 sym->GetModuleNameAndOffsetForPC(pc_array[i], &module_name,
436 &module_address);
437 out.append("%s 0x%zx\n", module_name, module_address);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000438 }
439 int fd = CovOpenFile(false, "trace-points");
440 if (fd < 0) return;
441 internal_write(fd, out.data(), out.length());
442 internal_close(fd);
443
444 fd = CovOpenFile(false, "trace-events");
445 if (fd < 0) return;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000446 uptr bytes_to_write = max_idx * sizeof(tr_event_array[0]);
447 u8 *event_bytes = reinterpret_cast<u8*>(tr_event_array);
448 // The trace file could be huge, and may not be written with a single syscall.
449 while (bytes_to_write) {
450 uptr actually_written = internal_write(fd, event_bytes, bytes_to_write);
451 if (actually_written <= bytes_to_write) {
452 bytes_to_write -= actually_written;
453 event_bytes += actually_written;
454 } else {
455 break;
456 }
457 }
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000458 internal_close(fd);
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000459 VReport(1, " CovDump: Trace: %zd PCs written\n", size());
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000460 VReport(1, " CovDump: Trace: %zd Events written\n", max_idx);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000461}
462
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000463// This function dumps the caller=>callee pairs into a file as a sequence of
464// lines like "module_name offset".
465void CoverageData::DumpCallerCalleePairs() {
466 uptr max_idx = atomic_load(&cc_array_index, memory_order_relaxed);
467 if (!max_idx) return;
468 auto sym = Symbolizer::GetOrInit();
469 if (!sym)
470 return;
Kostya Serebryany40aa4a22014-10-31 19:49:46 +0000471 InternalScopedString out(32 << 20);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000472 uptr total = 0;
473 for (uptr i = 0; i < max_idx; i++) {
474 uptr *cc_cache = cc_array[i];
475 CHECK(cc_cache);
476 uptr caller = cc_cache[0];
477 uptr n_callees = cc_cache[1];
478 const char *caller_module_name = "<unknown>";
479 uptr caller_module_address = 0;
480 sym->GetModuleNameAndOffsetForPC(caller, &caller_module_name,
481 &caller_module_address);
482 for (uptr j = 2; j < n_callees; j++) {
483 uptr callee = cc_cache[j];
484 if (!callee) break;
485 total++;
486 const char *callee_module_name = "<unknown>";
487 uptr callee_module_address = 0;
488 sym->GetModuleNameAndOffsetForPC(callee, &callee_module_name,
489 &callee_module_address);
490 out.append("%s 0x%zx\n%s 0x%zx\n", caller_module_name,
491 caller_module_address, callee_module_name,
492 callee_module_address);
493 }
494 }
495 int fd = CovOpenFile(false, "caller-callee");
496 if (fd < 0) return;
497 internal_write(fd, out.data(), out.length());
498 internal_close(fd);
499 VReport(1, " CovDump: %zd caller-callee pairs written\n", total);
500}
501
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000502// Record the current PC into the event buffer.
503// Every event is a u32 value (index in tr_pc_array_index) so we compute
504// it once and then cache in the provided 'cache' storage.
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000505//
506// This function will eventually be inlined by the compiler.
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000507void CoverageData::TraceBasicBlock(s32 *id) {
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000508 // Will trap here if
509 // 1. coverage is not enabled at run-time.
510 // 2. The array tr_event_array is full.
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000511 *tr_event_pointer = static_cast<u32>(*id - 1);
512 tr_event_pointer++;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000513}
514
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000515static void CovDumpAsBitSet() {
516 if (!common_flags()->coverage_bitset) return;
517 if (!coverage_data.size()) return;
518 int fd = CovOpenFile(/* packed */false, "combined", "bitset-sancov");
519 if (fd < 0) return;
520 uptr n = coverage_data.size();
521 uptr n_set_bits = 0;
522 InternalScopedBuffer<char> out(n);
523 for (uptr i = 0; i < n; i++) {
524 uptr pc = coverage_data.data()[i];
525 out[i] = pc ? '1' : '0';
526 if (pc)
527 n_set_bits++;
528 }
529 internal_write(fd, out.data(), n);
530 internal_close(fd);
531 VReport(1, " CovDump: bitset of %zd bits written, %zd bits are set\n", n,
532 n_set_bits);
533}
534
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000535// Dump the coverage on disk.
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000536static void CovDump() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000537 if (!coverage_enabled || common_flags()->coverage_direct) return;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000538#if !SANITIZER_WINDOWS
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000539 if (atomic_fetch_add(&dump_once_guard, 1, memory_order_relaxed))
540 return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000541 CovDumpAsBitSet();
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000542 coverage_data.DumpTrace();
Kostya Serebryanya7ee2732014-12-30 19:55:04 +0000543 if (!common_flags()->coverage_pcs) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000544 uptr size = coverage_data.size();
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000545 InternalMmapVector<u32> offsets(size);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000546 uptr *vb = coverage_data.data();
547 uptr *ve = vb + size;
548 SortArray(vb, size);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000549 MemoryMappingLayout proc_maps(/*cache_enabled*/true);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000550 uptr mb, me, off, prot;
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000551 InternalScopedString module(kMaxPathLength);
552 InternalScopedString path(kMaxPathLength);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000553 for (int i = 0;
554 proc_maps.Next(&mb, &me, &off, module.data(), module.size(), &prot);
555 i++) {
556 if ((prot & MemoryMappingLayout::kProtectionExecute) == 0)
557 continue;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000558 while (vb < ve && *vb < mb) vb++;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000559 if (vb >= ve) break;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000560 if (*vb < me) {
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000561 offsets.clear();
562 const uptr *old_vb = vb;
563 CHECK_LE(off, *vb);
564 for (; vb < ve && *vb < me; vb++) {
565 uptr diff = *vb - (i ? mb : 0) + off;
566 CHECK_LE(diff, 0xffffffffU);
567 offsets.push_back(static_cast<u32>(diff));
568 }
Alexey Samsonov26ca05a2014-11-04 19:34:29 +0000569 const char *module_name = StripModuleName(module.data());
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000570 if (cov_sandboxed) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000571 if (cov_fd >= 0) {
572 CovWritePacked(internal_getpid(), module_name, offsets.data(),
573 offsets.size() * sizeof(u32));
574 VReport(1, " CovDump: %zd PCs written to packed file\n", vb - old_vb);
575 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000576 } else {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000577 // One file per module per process.
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000578 path.clear();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000579 path.append("%s/%s.%zd.sancov", coverage_dir, module_name,
580 internal_getpid());
Sergey Matveev83f91e72014-05-21 13:43:52 +0000581 int fd = CovOpenFile(false /* packed */, module_name);
582 if (fd > 0) {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000583 internal_write(fd, offsets.data(), offsets.size() * sizeof(u32));
584 internal_close(fd);
585 VReport(1, " CovDump: %s: %zd PCs written\n", path.data(),
586 vb - old_vb);
587 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000588 }
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000589 }
590 }
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000591 if (cov_fd >= 0)
592 internal_close(cov_fd);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000593 coverage_data.DumpCallerCalleePairs();
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000594#endif // !SANITIZER_WINDOWS
595}
596
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000597void CovPrepareForSandboxing(__sanitizer_sandbox_arguments *args) {
598 if (!args) return;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000599 if (!coverage_enabled) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000600 cov_sandboxed = args->coverage_sandboxed;
601 if (!cov_sandboxed) return;
602 cov_fd = args->coverage_fd;
603 cov_max_block_size = args->coverage_max_block_size;
604 if (cov_fd < 0)
605 // Pre-open the file now. The sandbox won't allow us to do it later.
Sergey Matveev83f91e72014-05-21 13:43:52 +0000606 cov_fd = CovOpenFile(true /* packed */, 0);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000607}
608
Sergey Matveev83f91e72014-05-21 13:43:52 +0000609int MaybeOpenCovFile(const char *name) {
610 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000611 if (!coverage_enabled) return -1;
Sergey Matveev83f91e72014-05-21 13:43:52 +0000612 return CovOpenFile(true /* packed */, name);
613}
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000614
615void CovBeforeFork() {
616 coverage_data.BeforeFork();
617}
618
619void CovAfterFork(int child_pid) {
620 coverage_data.AfterFork(child_pid);
621}
622
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000623void InitializeCoverage(bool enabled, const char *dir) {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000624 if (coverage_enabled)
625 return; // May happen if two sanitizer enable coverage in the same process.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000626 coverage_enabled = enabled;
627 coverage_dir = dir;
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000628 coverage_data.Init();
629 if (enabled) coverage_data.Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000630#if !SANITIZER_WINDOWS
631 if (!common_flags()->coverage_direct) Atexit(__sanitizer_cov_dump);
632#endif
633}
634
635void ReInitializeCoverage(bool enabled, const char *dir) {
636 coverage_enabled = enabled;
637 coverage_dir = dir;
638 coverage_data.ReInit();
639}
640
641void CoverageUpdateMapping() {
642 if (coverage_enabled)
643 CovUpdateMapping(coverage_dir);
644}
645
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000646} // namespace __sanitizer
647
648extern "C" {
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000649SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov(u32 *guard) {
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +0000650 coverage_data.Add(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
651 guard);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000652}
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000653SANITIZER_INTERFACE_ATTRIBUTE void
654__sanitizer_cov_indir_call16(uptr callee, uptr callee_cache16[]) {
655 coverage_data.IndirCall(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
656 callee, callee_cache16, 16);
657}
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000658SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_init() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000659 coverage_enabled = true;
660 coverage_dir = common_flags()->coverage_dir;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000661 coverage_data.Init();
662}
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000663SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_dump() { CovDump(); }
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000664SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_module_init(s32 *guards,
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000665 uptr npcs) {
666 coverage_data.InitializeGuards(guards, npcs);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000667 if (!common_flags()->coverage_direct) return;
668 if (SANITIZER_ANDROID && coverage_enabled) {
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000669 // dlopen/dlclose interceptors do not work on Android, so we rely on
670 // Extend() calls to update .sancov.map.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000671 CovUpdateMapping(coverage_dir, GET_CALLER_PC());
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000672 }
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000673 coverage_data.Extend(npcs);
674}
Sergey Matveev83f91e72014-05-21 13:43:52 +0000675SANITIZER_INTERFACE_ATTRIBUTE
676sptr __sanitizer_maybe_open_cov_file(const char *name) {
677 return MaybeOpenCovFile(name);
678}
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000679SANITIZER_INTERFACE_ATTRIBUTE
680uptr __sanitizer_get_total_unique_coverage() {
681 return atomic_load(&coverage_counter, memory_order_relaxed);
682}
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000683
684SANITIZER_INTERFACE_ATTRIBUTE
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000685void __sanitizer_cov_trace_func_enter(s32 *id) {
686 coverage_data.TraceBasicBlock(id);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000687}
688SANITIZER_INTERFACE_ATTRIBUTE
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000689void __sanitizer_cov_trace_basic_block(s32 *id) {
690 coverage_data.TraceBasicBlock(id);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000691}
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000692} // extern "C"