blob: 71f7bd48d203c50af54e964aa477a70af788a5be [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);
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 Serebryanyb6eae0c2014-10-31 17:19:11 +0000113 // Caller-Callee (cc) array, size and current index.
114 static const uptr kCcArrayMaxSize = FIRST_32_SECOND_64(1 << 18, 1 << 24);
115 uptr **cc_array;
116 atomic_uintptr_t cc_array_index;
117 atomic_uintptr_t cc_array_size;
118
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000119 // Tracing event array, size and current pointer.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000120 // We record all events (basic block entries) in a global buffer of u32
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000121 // values. Each such value is the index in pc_array.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000122 // So far the tracing is highly experimental:
123 // - not thread-safe;
124 // - does not support long traces;
125 // - not tuned for performance.
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000126 static const uptr kTrEventArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 30);
127 u32 *tr_event_array;
128 uptr tr_event_array_size;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000129 u32 *tr_event_pointer;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000130 static const uptr kTrPcArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 27);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000131
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000132 StaticSpinMutex mu;
133
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000134 void DirectOpen();
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000135};
136
137static CoverageData coverage_data;
138
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000139void CovUpdateMapping(const char *path, uptr caller_pc = 0);
140
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000141void CoverageData::DirectOpen() {
Alexey Samsonov4cc76cb2014-11-26 01:48:39 +0000142 InternalScopedString path(kMaxPathLength);
Evgeniy Stepanovfa5c0752014-05-29 14:33:16 +0000143 internal_snprintf((char *)path.data(), path.size(), "%s/%zd.sancov.raw",
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000144 coverage_dir, internal_getpid());
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000145 pc_fd = OpenFile(path.data(), true);
146 if (internal_iserror(pc_fd)) {
147 Report(" Coverage: failed to open %s for writing\n", path.data());
148 Die();
149 }
150
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000151 pc_array_mapped_size = 0;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000152 CovUpdateMapping(coverage_dir);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000153}
154
155void CoverageData::Init() {
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000156 pc_fd = kInvalidFd;
157}
158
159void CoverageData::Enable() {
Evgeniy Stepanov0bc26c02015-01-27 15:06:54 +0000160 CHECK_EQ(pc_array, nullptr);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000161 pc_array = reinterpret_cast<uptr *>(
162 MmapNoReserveOrDie(sizeof(uptr) * kPcArrayMaxSize, "CovInit"));
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000163 atomic_store(&pc_array_index, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000164 if (common_flags()->coverage_direct) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000165 atomic_store(&pc_array_size, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000166 } else {
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000167 atomic_store(&pc_array_size, kPcArrayMaxSize, memory_order_relaxed);
168 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000169
170 cc_array = reinterpret_cast<uptr **>(MmapNoReserveOrDie(
171 sizeof(uptr *) * kCcArrayMaxSize, "CovInit::cc_array"));
172 atomic_store(&cc_array_size, kCcArrayMaxSize, memory_order_relaxed);
173 atomic_store(&cc_array_index, 0, memory_order_relaxed);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000174
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000175 // Allocate tr_event_array with a guard page at the end.
176 tr_event_array = reinterpret_cast<u32 *>(MmapNoReserveOrDie(
177 sizeof(tr_event_array[0]) * kTrEventArrayMaxSize + GetMmapGranularity(),
178 "CovInit::tr_event_array"));
179 Mprotect(reinterpret_cast<uptr>(&tr_event_array[kTrEventArrayMaxSize]),
180 GetMmapGranularity());
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000181 tr_event_array_size = kTrEventArrayMaxSize;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000182 tr_event_pointer = tr_event_array;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000183}
184
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000185void CoverageData::InitializeGuardArray(s32 *guards) {
186 s32 n = guards[0];
187 for (s32 j = 1; j <= n; j++) {
188 uptr idx = atomic_fetch_add(&pc_array_index, 1, memory_order_relaxed);
189 guards[j] = -static_cast<s32>(idx + 1);
190 }
191}
192
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000193void CoverageData::Disable() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000194 if (pc_array) {
195 internal_munmap(pc_array, sizeof(uptr) * kPcArrayMaxSize);
196 pc_array = nullptr;
197 }
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000198 if (cc_array) {
199 internal_munmap(cc_array, sizeof(uptr *) * kCcArrayMaxSize);
200 cc_array = nullptr;
201 }
202 if (tr_event_array) {
203 internal_munmap(tr_event_array,
204 sizeof(tr_event_array[0]) * kTrEventArrayMaxSize +
205 GetMmapGranularity());
206 tr_event_array = nullptr;
207 tr_event_pointer = nullptr;
208 }
209 if (pc_fd != kInvalidFd) {
210 internal_close(pc_fd);
211 pc_fd = kInvalidFd;
212 }
213}
214
Kostya Serebryany21a1a232015-01-28 22:39:44 +0000215void CoverageData::ReinitializeGuards() {
216 // Assuming single thread.
217 atomic_store(&pc_array_index, 0, memory_order_relaxed);
218 for (uptr i = 0; i < guard_array_vec.size(); i++)
219 InitializeGuardArray(guard_array_vec[i]);
220}
221
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000222void CoverageData::ReInit() {
223 Disable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000224 if (coverage_enabled) {
225 if (common_flags()->coverage_direct) {
226 // In memory-mapped mode we must extend the new file to the known array
227 // size.
228 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000229 Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000230 if (size) Extend(size);
231 if (coverage_enabled) CovUpdateMapping(coverage_dir);
232 } else {
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000233 Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000234 }
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000235 }
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000236 // Re-initialize the guards.
237 // We are single-threaded now, no need to grab any lock.
238 CHECK_EQ(atomic_load(&pc_array_index, memory_order_relaxed), 0);
Kostya Serebryany21a1a232015-01-28 22:39:44 +0000239 ReinitializeGuards();
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000240}
241
242void CoverageData::BeforeFork() {
243 mu.Lock();
244}
245
246void CoverageData::AfterFork(int child_pid) {
247 // We are single-threaded so it's OK to release the lock early.
248 mu.Unlock();
249 if (child_pid == 0) ReInit();
250}
251
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000252// Extend coverage PC array to fit additional npcs elements.
253void CoverageData::Extend(uptr npcs) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000254 if (!common_flags()->coverage_direct) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000255 SpinMutexLock l(&mu);
256
257 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
258 size += npcs * sizeof(uptr);
259
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000260 if (coverage_enabled && size > pc_array_mapped_size) {
261 if (pc_fd == kInvalidFd) DirectOpen();
262 CHECK_NE(pc_fd, kInvalidFd);
263
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000264 uptr new_mapped_size = pc_array_mapped_size;
265 while (size > new_mapped_size) new_mapped_size += kPcArrayMmapSize;
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000266 CHECK_LE(new_mapped_size, sizeof(uptr) * kPcArrayMaxSize);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000267
268 // Extend the file and map the new space at the end of pc_array.
269 uptr res = internal_ftruncate(pc_fd, new_mapped_size);
270 int err;
271 if (internal_iserror(res, &err)) {
272 Printf("failed to extend raw coverage file: %d\n", err);
273 Die();
274 }
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000275
276 uptr next_map_base = ((uptr)pc_array) + pc_array_mapped_size;
277 void *p = MapWritableFileToMemory((void *)next_map_base,
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000278 new_mapped_size - pc_array_mapped_size,
279 pc_fd, pc_array_mapped_size);
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000280 CHECK_EQ((uptr)p, next_map_base);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000281 pc_array_mapped_size = new_mapped_size;
282 }
283
284 atomic_store(&pc_array_size, size, memory_order_release);
285}
286
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000287void CoverageData::InitializeGuards(s32 *guards, uptr n) {
288 // The array 'guards' has n+1 elements, we use the element zero
289 // to store 'n'.
290 CHECK_LT(n, 1 << 30);
291 guards[0] = static_cast<s32>(n);
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000292 InitializeGuardArray(guards);
293 SpinMutexLock l(&mu);
294 guard_array_vec.push_back(guards);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000295}
296
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000297// If guard is negative, atomically set it to -guard and store the PC in
298// pc_array.
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000299void CoverageData::Add(uptr pc, u32 *guard) {
300 atomic_uint32_t *atomic_guard = reinterpret_cast<atomic_uint32_t*>(guard);
301 s32 guard_value = atomic_load(atomic_guard, memory_order_relaxed);
302 if (guard_value >= 0) return;
303
304 atomic_store(atomic_guard, -guard_value, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000305 if (!pc_array) return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000306
307 uptr idx = -guard_value - 1;
308 if (idx >= atomic_load(&pc_array_index, memory_order_acquire))
309 return; // May happen after fork when pc_array_index becomes 0.
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000310 CHECK_LT(idx * sizeof(uptr),
311 atomic_load(&pc_array_size, memory_order_acquire));
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000312 pc_array[idx] = pc;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000313 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000314}
315
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000316// Registers a pair caller=>callee.
317// When a given caller is seen for the first time, the callee_cache is added
318// to the global array cc_array, callee_cache[0] is set to caller and
319// callee_cache[1] is set to cache_size.
320// Then we are trying to add callee to callee_cache [2,cache_size) if it is
321// not there yet.
322// If the cache is full we drop the callee (may want to fix this later).
323void CoverageData::IndirCall(uptr caller, uptr callee, uptr callee_cache[],
324 uptr cache_size) {
325 if (!cc_array) return;
326 atomic_uintptr_t *atomic_callee_cache =
327 reinterpret_cast<atomic_uintptr_t *>(callee_cache);
328 uptr zero = 0;
329 if (atomic_compare_exchange_strong(&atomic_callee_cache[0], &zero, caller,
330 memory_order_seq_cst)) {
331 uptr idx = atomic_fetch_add(&cc_array_index, 1, memory_order_relaxed);
332 CHECK_LT(idx * sizeof(uptr),
333 atomic_load(&cc_array_size, memory_order_acquire));
334 callee_cache[1] = cache_size;
335 cc_array[idx] = callee_cache;
336 }
337 CHECK_EQ(atomic_load(&atomic_callee_cache[0], memory_order_relaxed), caller);
338 for (uptr i = 2; i < cache_size; i++) {
339 uptr was = 0;
340 if (atomic_compare_exchange_strong(&atomic_callee_cache[i], &was, callee,
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000341 memory_order_seq_cst)) {
342 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000343 return;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000344 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000345 if (was == callee) // Already have this callee.
346 return;
347 }
348}
349
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000350uptr *CoverageData::data() {
351 return pc_array;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000352}
353
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000354uptr CoverageData::size() {
355 return atomic_load(&pc_array_index, memory_order_relaxed);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000356}
357
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000358// Block layout for packed file format: header, followed by module name (no
359// trailing zero), followed by data blob.
360struct CovHeader {
361 int pid;
362 unsigned int module_name_length;
363 unsigned int data_length;
364};
365
366static void CovWritePacked(int pid, const char *module, const void *blob,
367 unsigned int blob_size) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000368 if (cov_fd < 0) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000369 unsigned module_name_length = internal_strlen(module);
370 CovHeader header = {pid, module_name_length, blob_size};
371
372 if (cov_max_block_size == 0) {
373 // Writing to a file. Just go ahead.
374 internal_write(cov_fd, &header, sizeof(header));
375 internal_write(cov_fd, module, module_name_length);
376 internal_write(cov_fd, blob, blob_size);
377 } else {
378 // Writing to a socket. We want to split the data into appropriately sized
379 // blocks.
380 InternalScopedBuffer<char> block(cov_max_block_size);
381 CHECK_EQ((uptr)block.data(), (uptr)(CovHeader *)block.data());
382 uptr header_size_with_module = sizeof(header) + module_name_length;
383 CHECK_LT(header_size_with_module, cov_max_block_size);
384 unsigned int max_payload_size =
385 cov_max_block_size - header_size_with_module;
386 char *block_pos = block.data();
387 internal_memcpy(block_pos, &header, sizeof(header));
388 block_pos += sizeof(header);
389 internal_memcpy(block_pos, module, module_name_length);
390 block_pos += module_name_length;
391 char *block_data_begin = block_pos;
Alexey Samsonov4925fd42014-11-13 22:40:59 +0000392 const char *blob_pos = (const char *)blob;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000393 while (blob_size > 0) {
394 unsigned int payload_size = Min(blob_size, max_payload_size);
395 blob_size -= payload_size;
396 internal_memcpy(block_data_begin, blob_pos, payload_size);
397 blob_pos += payload_size;
398 ((CovHeader *)block.data())->data_length = payload_size;
399 internal_write(cov_fd, block.data(),
400 header_size_with_module + payload_size);
401 }
402 }
403}
404
Sergey Matveev83f91e72014-05-21 13:43:52 +0000405// If packed = false: <name>.<pid>.<sancov> (name = module name).
406// If packed = true and name == 0: <pid>.<sancov>.<packed>.
407// If packed = true and name != 0: <name>.<sancov>.<packed> (name is
408// user-supplied).
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000409static int CovOpenFile(bool packed, const char *name,
410 const char *extension = "sancov") {
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000411 InternalScopedString path(kMaxPathLength);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000412 if (!packed) {
413 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000414 path.append("%s/%s.%zd.%s", coverage_dir, name, internal_getpid(),
415 extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000416 } else {
417 if (!name)
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000418 path.append("%s/%zd.%s.packed", coverage_dir, internal_getpid(),
Evgeniy Stepanovf8c7e252014-12-26 10:19:56 +0000419 extension);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000420 else
421 path.append("%s/%s.%s.packed", coverage_dir, name, extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000422 }
423 uptr fd = OpenFile(path.data(), true);
424 if (internal_iserror(fd)) {
425 Report(" SanitizerCoverage: failed to open %s for writing\n", path.data());
426 return -1;
427 }
428 return fd;
429}
430
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000431// Dump trace PCs and trace events into two separate files.
432void CoverageData::DumpTrace() {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000433 uptr max_idx = tr_event_pointer - tr_event_array;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000434 if (!max_idx) return;
435 auto sym = Symbolizer::GetOrInit();
436 if (!sym)
437 return;
438 InternalScopedString out(32 << 20);
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000439 for (uptr i = 0, n = size(); i < n; i++) {
440 const char *module_name = "<unknown>";
441 uptr module_address = 0;
442 sym->GetModuleNameAndOffsetForPC(pc_array[i], &module_name,
443 &module_address);
444 out.append("%s 0x%zx\n", module_name, module_address);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000445 }
446 int fd = CovOpenFile(false, "trace-points");
447 if (fd < 0) return;
448 internal_write(fd, out.data(), out.length());
449 internal_close(fd);
450
451 fd = CovOpenFile(false, "trace-events");
452 if (fd < 0) return;
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000453 uptr bytes_to_write = max_idx * sizeof(tr_event_array[0]);
454 u8 *event_bytes = reinterpret_cast<u8*>(tr_event_array);
455 // The trace file could be huge, and may not be written with a single syscall.
456 while (bytes_to_write) {
457 uptr actually_written = internal_write(fd, event_bytes, bytes_to_write);
458 if (actually_written <= bytes_to_write) {
459 bytes_to_write -= actually_written;
460 event_bytes += actually_written;
461 } else {
462 break;
463 }
464 }
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000465 internal_close(fd);
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000466 VReport(1, " CovDump: Trace: %zd PCs written\n", size());
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000467 VReport(1, " CovDump: Trace: %zd Events written\n", max_idx);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000468}
469
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000470// This function dumps the caller=>callee pairs into a file as a sequence of
471// lines like "module_name offset".
472void CoverageData::DumpCallerCalleePairs() {
473 uptr max_idx = atomic_load(&cc_array_index, memory_order_relaxed);
474 if (!max_idx) return;
475 auto sym = Symbolizer::GetOrInit();
476 if (!sym)
477 return;
Kostya Serebryany40aa4a22014-10-31 19:49:46 +0000478 InternalScopedString out(32 << 20);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000479 uptr total = 0;
480 for (uptr i = 0; i < max_idx; i++) {
481 uptr *cc_cache = cc_array[i];
482 CHECK(cc_cache);
483 uptr caller = cc_cache[0];
484 uptr n_callees = cc_cache[1];
485 const char *caller_module_name = "<unknown>";
486 uptr caller_module_address = 0;
487 sym->GetModuleNameAndOffsetForPC(caller, &caller_module_name,
488 &caller_module_address);
489 for (uptr j = 2; j < n_callees; j++) {
490 uptr callee = cc_cache[j];
491 if (!callee) break;
492 total++;
493 const char *callee_module_name = "<unknown>";
494 uptr callee_module_address = 0;
495 sym->GetModuleNameAndOffsetForPC(callee, &callee_module_name,
496 &callee_module_address);
497 out.append("%s 0x%zx\n%s 0x%zx\n", caller_module_name,
498 caller_module_address, callee_module_name,
499 callee_module_address);
500 }
501 }
502 int fd = CovOpenFile(false, "caller-callee");
503 if (fd < 0) return;
504 internal_write(fd, out.data(), out.length());
505 internal_close(fd);
506 VReport(1, " CovDump: %zd caller-callee pairs written\n", total);
507}
508
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000509// Record the current PC into the event buffer.
510// Every event is a u32 value (index in tr_pc_array_index) so we compute
511// it once and then cache in the provided 'cache' storage.
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000512//
513// This function will eventually be inlined by the compiler.
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000514void CoverageData::TraceBasicBlock(s32 *id) {
Kostya Serebryany0f53d9a2015-01-03 02:07:58 +0000515 // Will trap here if
516 // 1. coverage is not enabled at run-time.
517 // 2. The array tr_event_array is full.
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000518 *tr_event_pointer = static_cast<u32>(*id - 1);
519 tr_event_pointer++;
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000520}
521
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000522static void CovDumpAsBitSet() {
523 if (!common_flags()->coverage_bitset) return;
524 if (!coverage_data.size()) return;
525 int fd = CovOpenFile(/* packed */false, "combined", "bitset-sancov");
526 if (fd < 0) return;
527 uptr n = coverage_data.size();
528 uptr n_set_bits = 0;
529 InternalScopedBuffer<char> out(n);
530 for (uptr i = 0; i < n; i++) {
531 uptr pc = coverage_data.data()[i];
532 out[i] = pc ? '1' : '0';
533 if (pc)
534 n_set_bits++;
535 }
536 internal_write(fd, out.data(), n);
537 internal_close(fd);
538 VReport(1, " CovDump: bitset of %zd bits written, %zd bits are set\n", n,
539 n_set_bits);
540}
541
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000542// Dump the coverage on disk.
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000543static void CovDump() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000544 if (!coverage_enabled || common_flags()->coverage_direct) return;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000545#if !SANITIZER_WINDOWS
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000546 if (atomic_fetch_add(&dump_once_guard, 1, memory_order_relaxed))
547 return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000548 CovDumpAsBitSet();
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000549 coverage_data.DumpTrace();
Kostya Serebryanya7ee2732014-12-30 19:55:04 +0000550 if (!common_flags()->coverage_pcs) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000551 uptr size = coverage_data.size();
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000552 InternalMmapVector<u32> offsets(size);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000553 uptr *vb = coverage_data.data();
554 uptr *ve = vb + size;
555 SortArray(vb, size);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000556 MemoryMappingLayout proc_maps(/*cache_enabled*/true);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000557 uptr mb, me, off, prot;
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000558 InternalScopedString module(kMaxPathLength);
559 InternalScopedString path(kMaxPathLength);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000560 for (int i = 0;
561 proc_maps.Next(&mb, &me, &off, module.data(), module.size(), &prot);
562 i++) {
563 if ((prot & MemoryMappingLayout::kProtectionExecute) == 0)
564 continue;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000565 while (vb < ve && *vb < mb) vb++;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000566 if (vb >= ve) break;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000567 if (*vb < me) {
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000568 offsets.clear();
569 const uptr *old_vb = vb;
570 CHECK_LE(off, *vb);
571 for (; vb < ve && *vb < me; vb++) {
572 uptr diff = *vb - (i ? mb : 0) + off;
573 CHECK_LE(diff, 0xffffffffU);
574 offsets.push_back(static_cast<u32>(diff));
575 }
Alexey Samsonov26ca05a2014-11-04 19:34:29 +0000576 const char *module_name = StripModuleName(module.data());
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000577 if (cov_sandboxed) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000578 if (cov_fd >= 0) {
579 CovWritePacked(internal_getpid(), module_name, offsets.data(),
580 offsets.size() * sizeof(u32));
581 VReport(1, " CovDump: %zd PCs written to packed file\n", vb - old_vb);
582 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000583 } else {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000584 // One file per module per process.
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000585 path.clear();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000586 path.append("%s/%s.%zd.sancov", coverage_dir, module_name,
587 internal_getpid());
Sergey Matveev83f91e72014-05-21 13:43:52 +0000588 int fd = CovOpenFile(false /* packed */, module_name);
589 if (fd > 0) {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000590 internal_write(fd, offsets.data(), offsets.size() * sizeof(u32));
591 internal_close(fd);
592 VReport(1, " CovDump: %s: %zd PCs written\n", path.data(),
593 vb - old_vb);
594 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000595 }
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000596 }
597 }
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000598 if (cov_fd >= 0)
599 internal_close(cov_fd);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000600 coverage_data.DumpCallerCalleePairs();
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000601#endif // !SANITIZER_WINDOWS
602}
603
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000604void CovPrepareForSandboxing(__sanitizer_sandbox_arguments *args) {
605 if (!args) return;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000606 if (!coverage_enabled) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000607 cov_sandboxed = args->coverage_sandboxed;
608 if (!cov_sandboxed) return;
609 cov_fd = args->coverage_fd;
610 cov_max_block_size = args->coverage_max_block_size;
611 if (cov_fd < 0)
612 // Pre-open the file now. The sandbox won't allow us to do it later.
Sergey Matveev83f91e72014-05-21 13:43:52 +0000613 cov_fd = CovOpenFile(true /* packed */, 0);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000614}
615
Sergey Matveev83f91e72014-05-21 13:43:52 +0000616int MaybeOpenCovFile(const char *name) {
617 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000618 if (!coverage_enabled) return -1;
Sergey Matveev83f91e72014-05-21 13:43:52 +0000619 return CovOpenFile(true /* packed */, name);
620}
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000621
622void CovBeforeFork() {
623 coverage_data.BeforeFork();
624}
625
626void CovAfterFork(int child_pid) {
627 coverage_data.AfterFork(child_pid);
628}
629
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000630void InitializeCoverage(bool enabled, const char *dir) {
Kostya Serebryanye02839b2015-01-06 01:11:23 +0000631 if (coverage_enabled)
632 return; // May happen if two sanitizer enable coverage in the same process.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000633 coverage_enabled = enabled;
634 coverage_dir = dir;
Evgeniy Stepanov3f2e7612015-01-12 17:13:20 +0000635 coverage_data.Init();
636 if (enabled) coverage_data.Enable();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000637#if !SANITIZER_WINDOWS
638 if (!common_flags()->coverage_direct) Atexit(__sanitizer_cov_dump);
639#endif
640}
641
642void ReInitializeCoverage(bool enabled, const char *dir) {
643 coverage_enabled = enabled;
644 coverage_dir = dir;
645 coverage_data.ReInit();
646}
647
648void CoverageUpdateMapping() {
649 if (coverage_enabled)
650 CovUpdateMapping(coverage_dir);
651}
652
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000653} // namespace __sanitizer
654
655extern "C" {
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000656SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov(u32 *guard) {
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +0000657 coverage_data.Add(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
658 guard);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000659}
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000660SANITIZER_INTERFACE_ATTRIBUTE void
661__sanitizer_cov_indir_call16(uptr callee, uptr callee_cache16[]) {
662 coverage_data.IndirCall(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
663 callee, callee_cache16, 16);
664}
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000665SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_init() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000666 coverage_enabled = true;
667 coverage_dir = common_flags()->coverage_dir;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000668 coverage_data.Init();
669}
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000670SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_dump() { CovDump(); }
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000671SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_module_init(s32 *guards,
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000672 uptr npcs) {
673 coverage_data.InitializeGuards(guards, npcs);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000674 if (!common_flags()->coverage_direct) return;
675 if (SANITIZER_ANDROID && coverage_enabled) {
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000676 // dlopen/dlclose interceptors do not work on Android, so we rely on
677 // Extend() calls to update .sancov.map.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000678 CovUpdateMapping(coverage_dir, GET_CALLER_PC());
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000679 }
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000680 coverage_data.Extend(npcs);
681}
Sergey Matveev83f91e72014-05-21 13:43:52 +0000682SANITIZER_INTERFACE_ATTRIBUTE
683sptr __sanitizer_maybe_open_cov_file(const char *name) {
684 return MaybeOpenCovFile(name);
685}
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000686SANITIZER_INTERFACE_ATTRIBUTE
687uptr __sanitizer_get_total_unique_coverage() {
688 return atomic_load(&coverage_counter, memory_order_relaxed);
689}
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000690
691SANITIZER_INTERFACE_ATTRIBUTE
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000692void __sanitizer_cov_trace_func_enter(s32 *id) {
693 coverage_data.TraceBasicBlock(id);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000694}
695SANITIZER_INTERFACE_ATTRIBUTE
Kostya Serebryanyd421db02015-01-03 00:54:43 +0000696void __sanitizer_cov_trace_basic_block(s32 *id) {
697 coverage_data.TraceBasicBlock(id);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000698}
Kostya Serebryany21a1a232015-01-28 22:39:44 +0000699SANITIZER_INTERFACE_ATTRIBUTE
700void __sanitizer_reset_coverage() {
701 coverage_data.ReinitializeGuards();
702 internal_bzero_aligned16(
703 coverage_data.data(),
704 RoundUpTo(coverage_data.size() * sizeof(coverage_data.data()[0]), 16));
705}
706SANITIZER_INTERFACE_ATTRIBUTE
707uptr __sanitizer_get_coverage_guards(uptr **data) {
708 *data = coverage_data.data();
709 return coverage_data.size();
710}
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000711} // extern "C"