blob: dbb7f97760e4fd2d0d38472de5c25e729901461d [file] [log] [blame]
Bob Wilsona08e9ac2013-11-15 07:18:15 +00001//===-- sanitizer_coverage.cc ---------------------------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Sanitizer Coverage.
11// This file implements run-time support for a poor man's coverage tool.
12//
13// Compiler instrumentation:
Kostya Serebryany714c67c2014-01-17 11:00:30 +000014// For every interesting basic block the compiler injects the following code:
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000015// if (Guard < 0) {
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +000016// __sanitizer_cov(&Guard);
Bob Wilsona08e9ac2013-11-15 07:18:15 +000017// }
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000018// At the module start up time __sanitizer_cov_module_init sets the guards
19// to consecutive negative numbers (-1, -2, -3, ...).
Kostya Serebryany714c67c2014-01-17 11:00:30 +000020// It's fine to call __sanitizer_cov more than once for a given block.
Bob Wilsona08e9ac2013-11-15 07:18:15 +000021//
22// Run-time:
Kostya Serebryany714c67c2014-01-17 11:00:30 +000023// - __sanitizer_cov(): record that we've executed the PC (GET_CALLER_PC).
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000024// and atomically set Guard to -Guard.
Bob Wilsona08e9ac2013-11-15 07:18:15 +000025// - __sanitizer_cov_dump: dump the coverage data to disk.
26// For every module of the current process that has coverage data
27// this will create a file module_name.PID.sancov. The file format is simple:
28// it's just a sorted sequence of 4-byte offsets in the module.
29//
30// Eventually, this coverage implementation should be obsoleted by a more
31// powerful general purpose Clang/LLVM coverage instrumentation.
32// Consider this implementation as prototype.
33//
34// FIXME: support (or at least test with) dlclose.
35//===----------------------------------------------------------------------===//
36
37#include "sanitizer_allocator_internal.h"
38#include "sanitizer_common.h"
39#include "sanitizer_libc.h"
40#include "sanitizer_mutex.h"
41#include "sanitizer_procmaps.h"
Kostya Serebryany714c67c2014-01-17 11:00:30 +000042#include "sanitizer_stacktrace.h"
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +000043#include "sanitizer_symbolizer.h"
Bob Wilsona08e9ac2013-11-15 07:18:15 +000044#include "sanitizer_flags.h"
45
Kostya Serebryany183cb6e2014-11-14 23:15:55 +000046static atomic_uint32_t dump_once_guard; // Ensure that CovDump runs only once.
47
48static atomic_uintptr_t coverage_counter;
Bob Wilsona08e9ac2013-11-15 07:18:15 +000049
Kostya Serebryany8b530e12014-04-30 10:40:48 +000050// pc_array is the array containing the covered PCs.
Sergey Matveev6cb47a082014-05-19 12:53:03 +000051// To make the pc_array thread- and async-signal-safe it has to be large enough.
Kostya Serebryany8b530e12014-04-30 10:40:48 +000052// 128M counters "ought to be enough for anybody" (4M on 32-bit).
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000053
54// With coverage_direct=1 in ASAN_OPTIONS, pc_array memory is mapped to a file.
55// In this mode, __sanitizer_cov_dump does nothing, and CovUpdateMapping()
56// dump current memory layout to another file.
Bob Wilsona08e9ac2013-11-15 07:18:15 +000057
Sergey Matveev6cb47a082014-05-19 12:53:03 +000058static bool cov_sandboxed = false;
59static int cov_fd = kInvalidFd;
60static unsigned int cov_max_block_size = 0;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +000061static bool coverage_enabled = false;
62static const char *coverage_dir;
Sergey Matveev6cb47a082014-05-19 12:53:03 +000063
Bob Wilsona08e9ac2013-11-15 07:18:15 +000064namespace __sanitizer {
65
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000066class CoverageData {
67 public:
68 void Init();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +000069 void ReInit();
Evgeniy Stepanovfe181022014-06-04 12:13:54 +000070 void BeforeFork();
71 void AfterFork(int child_pid);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000072 void Extend(uptr npcs);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000073 void Add(uptr pc, u32 *guard);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +000074 void IndirCall(uptr caller, uptr callee, uptr callee_cache[],
75 uptr cache_size);
76 void DumpCallerCalleePairs();
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +000077 void DumpTrace();
78
79 ALWAYS_INLINE
Kostya Serebryany9fdeb372014-12-23 22:32:17 +000080 void TraceBasicBlock(uptr *cache);
81
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +000082 void InitializeGuardArray(s32 *guards);
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +000083 void InitializeGuards(s32 *guards, uptr n);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000084
85 uptr *data();
86 uptr size();
87
88 private:
89 // Maximal size pc array may ever grow.
90 // We MmapNoReserve this space to ensure that the array is contiguous.
Evgeniy Stepanov10308462014-12-26 13:54:11 +000091 static const uptr kPcArrayMaxSize = FIRST_32_SECOND_64(1 << 24, 1 << 27);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +000092 // The amount file mapping for the pc array is grown by.
93 static const uptr kPcArrayMmapSize = 64 * 1024;
94
95 // pc_array is allocated with MmapNoReserveOrDie and so it uses only as
96 // much RAM as it really needs.
97 uptr *pc_array;
98 // Index of the first available pc_array slot.
99 atomic_uintptr_t pc_array_index;
100 // Array size.
101 atomic_uintptr_t pc_array_size;
102 // Current file mapped size of the pc array.
103 uptr pc_array_mapped_size;
104 // Descriptor of the file mapped pc array.
105 int pc_fd;
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000106
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000107 // Vector of coverage guard arrays, protected by mu.
108 InternalMmapVectorNoCtor<s32*> guard_array_vec;
109
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000110 // Caller-Callee (cc) array, size and current index.
111 static const uptr kCcArrayMaxSize = FIRST_32_SECOND_64(1 << 18, 1 << 24);
112 uptr **cc_array;
113 atomic_uintptr_t cc_array_index;
114 atomic_uintptr_t cc_array_size;
115
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000116 // Tracing (tr) pc and event arrays, their size and current index.
117 // We record all events (basic block entries) in a global buffer of u32
118 // values. Each such value is an index in the table of TracedPc objects.
119 // So far the tracing is highly experimental:
120 // - not thread-safe;
121 // - does not support long traces;
122 // - not tuned for performance.
123 struct TracedPc {
124 uptr pc;
125 const char *module_name;
126 uptr module_offset;
127 };
128 static const uptr kTrEventArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 30);
129 u32 *tr_event_array;
130 uptr tr_event_array_size;
131 uptr tr_event_array_index;
132 static const uptr kTrPcArrayMaxSize = FIRST_32_SECOND_64(1 << 22, 1 << 27);
133 TracedPc *tr_pc_array;
134 uptr tr_pc_array_size;
135 uptr tr_pc_array_index;
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000136
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000137 StaticSpinMutex mu;
138
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000139 void DirectOpen();
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000140};
141
142static CoverageData coverage_data;
143
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000144void CovUpdateMapping(const char *path, uptr caller_pc = 0);
145
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000146void CoverageData::DirectOpen() {
Alexey Samsonov4cc76cb2014-11-26 01:48:39 +0000147 InternalScopedString path(kMaxPathLength);
Evgeniy Stepanovfa5c0752014-05-29 14:33:16 +0000148 internal_snprintf((char *)path.data(), path.size(), "%s/%zd.sancov.raw",
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000149 coverage_dir, internal_getpid());
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000150 pc_fd = OpenFile(path.data(), true);
151 if (internal_iserror(pc_fd)) {
152 Report(" Coverage: failed to open %s for writing\n", path.data());
153 Die();
154 }
155
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000156 pc_array_mapped_size = 0;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000157 CovUpdateMapping(coverage_dir);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000158}
159
160void CoverageData::Init() {
161 pc_array = reinterpret_cast<uptr *>(
162 MmapNoReserveOrDie(sizeof(uptr) * kPcArrayMaxSize, "CovInit"));
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000163 pc_fd = kInvalidFd;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000164 atomic_store(&pc_array_index, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000165 if (common_flags()->coverage_direct) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000166 atomic_store(&pc_array_size, 0, memory_order_relaxed);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000167 } else {
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000168 atomic_store(&pc_array_size, kPcArrayMaxSize, memory_order_relaxed);
169 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000170
171 cc_array = reinterpret_cast<uptr **>(MmapNoReserveOrDie(
172 sizeof(uptr *) * kCcArrayMaxSize, "CovInit::cc_array"));
173 atomic_store(&cc_array_size, kCcArrayMaxSize, memory_order_relaxed);
174 atomic_store(&cc_array_index, 0, memory_order_relaxed);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000175
176 tr_event_array = reinterpret_cast<u32 *>(
177 MmapNoReserveOrDie(sizeof(tr_event_array[0]) * kTrEventArrayMaxSize,
178 "CovInit::tr_event_array"));
179 tr_event_array_size = kTrEventArrayMaxSize;
180 tr_event_array_index = 0;
181
182 tr_pc_array = reinterpret_cast<TracedPc *>(MmapNoReserveOrDie(
183 sizeof(tr_pc_array[0]) * kTrEventArrayMaxSize, "CovInit::tr_pc_array"));
184 tr_pc_array_size = kTrEventArrayMaxSize;
185 tr_pc_array_index = 0;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000186}
187
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000188void CoverageData::InitializeGuardArray(s32 *guards) {
189 s32 n = guards[0];
190 for (s32 j = 1; j <= n; j++) {
191 uptr idx = atomic_fetch_add(&pc_array_index, 1, memory_order_relaxed);
192 guards[j] = -static_cast<s32>(idx + 1);
193 }
194}
195
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000196void CoverageData::ReInit() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000197 if (pc_array) {
198 internal_munmap(pc_array, sizeof(uptr) * kPcArrayMaxSize);
199 pc_array = nullptr;
200 }
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000201 if (pc_fd != kInvalidFd) internal_close(pc_fd);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000202 if (coverage_enabled) {
203 if (common_flags()->coverage_direct) {
204 // In memory-mapped mode we must extend the new file to the known array
205 // size.
206 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
207 Init();
208 if (size) Extend(size);
209 if (coverage_enabled) CovUpdateMapping(coverage_dir);
210 } else {
211 Init();
212 }
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000213 }
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000214 // Re-initialize the guards.
215 // We are single-threaded now, no need to grab any lock.
216 CHECK_EQ(atomic_load(&pc_array_index, memory_order_relaxed), 0);
217 for (uptr i = 0; i < guard_array_vec.size(); i++)
218 InitializeGuardArray(guard_array_vec[i]);
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000219}
220
221void CoverageData::BeforeFork() {
222 mu.Lock();
223}
224
225void CoverageData::AfterFork(int child_pid) {
226 // We are single-threaded so it's OK to release the lock early.
227 mu.Unlock();
228 if (child_pid == 0) ReInit();
229}
230
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000231// Extend coverage PC array to fit additional npcs elements.
232void CoverageData::Extend(uptr npcs) {
Evgeniy Stepanovce984522014-06-03 15:27:15 +0000233 if (!common_flags()->coverage_direct) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000234 SpinMutexLock l(&mu);
235
236 uptr size = atomic_load(&pc_array_size, memory_order_relaxed);
237 size += npcs * sizeof(uptr);
238
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000239 if (coverage_enabled && size > pc_array_mapped_size) {
240 if (pc_fd == kInvalidFd) DirectOpen();
241 CHECK_NE(pc_fd, kInvalidFd);
242
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000243 uptr new_mapped_size = pc_array_mapped_size;
244 while (size > new_mapped_size) new_mapped_size += kPcArrayMmapSize;
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000245 CHECK_LE(new_mapped_size, sizeof(uptr) * kPcArrayMaxSize);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000246
247 // Extend the file and map the new space at the end of pc_array.
248 uptr res = internal_ftruncate(pc_fd, new_mapped_size);
249 int err;
250 if (internal_iserror(res, &err)) {
251 Printf("failed to extend raw coverage file: %d\n", err);
252 Die();
253 }
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000254
255 uptr next_map_base = ((uptr)pc_array) + pc_array_mapped_size;
256 void *p = MapWritableFileToMemory((void *)next_map_base,
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000257 new_mapped_size - pc_array_mapped_size,
258 pc_fd, pc_array_mapped_size);
Evgeniy Stepanovca9e0452014-12-24 13:57:11 +0000259 CHECK_EQ((uptr)p, next_map_base);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000260 pc_array_mapped_size = new_mapped_size;
261 }
262
263 atomic_store(&pc_array_size, size, memory_order_release);
264}
265
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000266void CoverageData::InitializeGuards(s32 *guards, uptr n) {
267 // The array 'guards' has n+1 elements, we use the element zero
268 // to store 'n'.
269 CHECK_LT(n, 1 << 30);
270 guards[0] = static_cast<s32>(n);
Kostya Serebryany77c5c1a2014-12-30 23:16:12 +0000271 InitializeGuardArray(guards);
272 SpinMutexLock l(&mu);
273 guard_array_vec.push_back(guards);
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000274}
275
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000276// If guard is negative, atomically set it to -guard and store the PC in
277// pc_array.
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000278void CoverageData::Add(uptr pc, u32 *guard) {
279 atomic_uint32_t *atomic_guard = reinterpret_cast<atomic_uint32_t*>(guard);
280 s32 guard_value = atomic_load(atomic_guard, memory_order_relaxed);
281 if (guard_value >= 0) return;
282
283 atomic_store(atomic_guard, -guard_value, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000284 if (!pc_array) return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000285
286 uptr idx = -guard_value - 1;
287 if (idx >= atomic_load(&pc_array_index, memory_order_acquire))
288 return; // May happen after fork when pc_array_index becomes 0.
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000289 CHECK_LT(idx * sizeof(uptr),
290 atomic_load(&pc_array_size, memory_order_acquire));
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000291 pc_array[idx] = pc;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000292 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000293}
294
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000295// Registers a pair caller=>callee.
296// When a given caller is seen for the first time, the callee_cache is added
297// to the global array cc_array, callee_cache[0] is set to caller and
298// callee_cache[1] is set to cache_size.
299// Then we are trying to add callee to callee_cache [2,cache_size) if it is
300// not there yet.
301// If the cache is full we drop the callee (may want to fix this later).
302void CoverageData::IndirCall(uptr caller, uptr callee, uptr callee_cache[],
303 uptr cache_size) {
304 if (!cc_array) return;
305 atomic_uintptr_t *atomic_callee_cache =
306 reinterpret_cast<atomic_uintptr_t *>(callee_cache);
307 uptr zero = 0;
308 if (atomic_compare_exchange_strong(&atomic_callee_cache[0], &zero, caller,
309 memory_order_seq_cst)) {
310 uptr idx = atomic_fetch_add(&cc_array_index, 1, memory_order_relaxed);
311 CHECK_LT(idx * sizeof(uptr),
312 atomic_load(&cc_array_size, memory_order_acquire));
313 callee_cache[1] = cache_size;
314 cc_array[idx] = callee_cache;
315 }
316 CHECK_EQ(atomic_load(&atomic_callee_cache[0], memory_order_relaxed), caller);
317 for (uptr i = 2; i < cache_size; i++) {
318 uptr was = 0;
319 if (atomic_compare_exchange_strong(&atomic_callee_cache[i], &was, callee,
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000320 memory_order_seq_cst)) {
321 atomic_fetch_add(&coverage_counter, 1, memory_order_relaxed);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000322 return;
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000323 }
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000324 if (was == callee) // Already have this callee.
325 return;
326 }
327}
328
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000329uptr *CoverageData::data() {
330 return pc_array;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000331}
332
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000333uptr CoverageData::size() {
334 return atomic_load(&pc_array_index, memory_order_relaxed);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000335}
336
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000337// Block layout for packed file format: header, followed by module name (no
338// trailing zero), followed by data blob.
339struct CovHeader {
340 int pid;
341 unsigned int module_name_length;
342 unsigned int data_length;
343};
344
345static void CovWritePacked(int pid, const char *module, const void *blob,
346 unsigned int blob_size) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000347 if (cov_fd < 0) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000348 unsigned module_name_length = internal_strlen(module);
349 CovHeader header = {pid, module_name_length, blob_size};
350
351 if (cov_max_block_size == 0) {
352 // Writing to a file. Just go ahead.
353 internal_write(cov_fd, &header, sizeof(header));
354 internal_write(cov_fd, module, module_name_length);
355 internal_write(cov_fd, blob, blob_size);
356 } else {
357 // Writing to a socket. We want to split the data into appropriately sized
358 // blocks.
359 InternalScopedBuffer<char> block(cov_max_block_size);
360 CHECK_EQ((uptr)block.data(), (uptr)(CovHeader *)block.data());
361 uptr header_size_with_module = sizeof(header) + module_name_length;
362 CHECK_LT(header_size_with_module, cov_max_block_size);
363 unsigned int max_payload_size =
364 cov_max_block_size - header_size_with_module;
365 char *block_pos = block.data();
366 internal_memcpy(block_pos, &header, sizeof(header));
367 block_pos += sizeof(header);
368 internal_memcpy(block_pos, module, module_name_length);
369 block_pos += module_name_length;
370 char *block_data_begin = block_pos;
Alexey Samsonov4925fd42014-11-13 22:40:59 +0000371 const char *blob_pos = (const char *)blob;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000372 while (blob_size > 0) {
373 unsigned int payload_size = Min(blob_size, max_payload_size);
374 blob_size -= payload_size;
375 internal_memcpy(block_data_begin, blob_pos, payload_size);
376 blob_pos += payload_size;
377 ((CovHeader *)block.data())->data_length = payload_size;
378 internal_write(cov_fd, block.data(),
379 header_size_with_module + payload_size);
380 }
381 }
382}
383
Sergey Matveev83f91e72014-05-21 13:43:52 +0000384// If packed = false: <name>.<pid>.<sancov> (name = module name).
385// If packed = true and name == 0: <pid>.<sancov>.<packed>.
386// If packed = true and name != 0: <name>.<sancov>.<packed> (name is
387// user-supplied).
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000388static int CovOpenFile(bool packed, const char *name,
389 const char *extension = "sancov") {
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000390 InternalScopedString path(kMaxPathLength);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000391 if (!packed) {
392 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000393 path.append("%s/%s.%zd.%s", coverage_dir, name, internal_getpid(),
394 extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000395 } else {
396 if (!name)
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000397 path.append("%s/%zd.%s.packed", coverage_dir, internal_getpid(),
Evgeniy Stepanovf8c7e252014-12-26 10:19:56 +0000398 extension);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000399 else
400 path.append("%s/%s.%s.packed", coverage_dir, name, extension);
Sergey Matveev83f91e72014-05-21 13:43:52 +0000401 }
402 uptr fd = OpenFile(path.data(), true);
403 if (internal_iserror(fd)) {
404 Report(" SanitizerCoverage: failed to open %s for writing\n", path.data());
405 return -1;
406 }
407 return fd;
408}
409
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000410// Dump trace PCs and trace events into two separate files.
411void CoverageData::DumpTrace() {
412 uptr max_idx = tr_event_array_index;
413 if (!max_idx) return;
414 auto sym = Symbolizer::GetOrInit();
415 if (!sym)
416 return;
417 InternalScopedString out(32 << 20);
418 for (uptr i = 0; i < max_idx; i++) {
419 u32 pc_idx = tr_event_array[i];
420 TracedPc *t = &tr_pc_array[pc_idx];
421 if (!t->module_name) {
422 const char *module_name = "<unknown>";
423 uptr module_address = 0;
424 sym->GetModuleNameAndOffsetForPC(t->pc, &module_name, &module_address);
425 t->module_name = internal_strdup(module_name);
426 t->module_offset = module_address;
427 out.append("%s 0x%zx\n", t->module_name, t->module_offset);
428 }
429 }
430 int fd = CovOpenFile(false, "trace-points");
431 if (fd < 0) return;
432 internal_write(fd, out.data(), out.length());
433 internal_close(fd);
434
435 fd = CovOpenFile(false, "trace-events");
436 if (fd < 0) return;
437 internal_write(fd, tr_event_array, max_idx * sizeof(tr_event_array[0]));
438 internal_close(fd);
439 VReport(1, " CovDump: Trace: %zd PCs written\n", tr_pc_array_index);
440 VReport(1, " CovDump: Trace: %zd Events written\n", tr_event_array_index);
441}
442
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000443// This function dumps the caller=>callee pairs into a file as a sequence of
444// lines like "module_name offset".
445void CoverageData::DumpCallerCalleePairs() {
446 uptr max_idx = atomic_load(&cc_array_index, memory_order_relaxed);
447 if (!max_idx) return;
448 auto sym = Symbolizer::GetOrInit();
449 if (!sym)
450 return;
Kostya Serebryany40aa4a22014-10-31 19:49:46 +0000451 InternalScopedString out(32 << 20);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000452 uptr total = 0;
453 for (uptr i = 0; i < max_idx; i++) {
454 uptr *cc_cache = cc_array[i];
455 CHECK(cc_cache);
456 uptr caller = cc_cache[0];
457 uptr n_callees = cc_cache[1];
458 const char *caller_module_name = "<unknown>";
459 uptr caller_module_address = 0;
460 sym->GetModuleNameAndOffsetForPC(caller, &caller_module_name,
461 &caller_module_address);
462 for (uptr j = 2; j < n_callees; j++) {
463 uptr callee = cc_cache[j];
464 if (!callee) break;
465 total++;
466 const char *callee_module_name = "<unknown>";
467 uptr callee_module_address = 0;
468 sym->GetModuleNameAndOffsetForPC(callee, &callee_module_name,
469 &callee_module_address);
470 out.append("%s 0x%zx\n%s 0x%zx\n", caller_module_name,
471 caller_module_address, callee_module_name,
472 callee_module_address);
473 }
474 }
475 int fd = CovOpenFile(false, "caller-callee");
476 if (fd < 0) return;
477 internal_write(fd, out.data(), out.length());
478 internal_close(fd);
479 VReport(1, " CovDump: %zd caller-callee pairs written\n", total);
480}
481
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000482// Record the current PC into the event buffer.
483// Every event is a u32 value (index in tr_pc_array_index) so we compute
484// it once and then cache in the provided 'cache' storage.
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000485void CoverageData::TraceBasicBlock(uptr *cache) {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000486 CHECK(coverage_enabled);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000487 uptr idx = *cache;
488 if (!idx) {
489 CHECK_LT(tr_pc_array_index, kTrPcArrayMaxSize);
490 idx = tr_pc_array_index++;
491 TracedPc *t = &tr_pc_array[idx];
492 t->pc = GET_CALLER_PC();
493 *cache = idx;
494 CHECK_LT(idx, 1U << 31);
495 }
496 CHECK_LT(tr_event_array_index, tr_event_array_size);
497 tr_event_array[tr_event_array_index] = static_cast<u32>(idx);
498 tr_event_array_index++;
499}
500
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000501static void CovDumpAsBitSet() {
502 if (!common_flags()->coverage_bitset) return;
503 if (!coverage_data.size()) return;
504 int fd = CovOpenFile(/* packed */false, "combined", "bitset-sancov");
505 if (fd < 0) return;
506 uptr n = coverage_data.size();
507 uptr n_set_bits = 0;
508 InternalScopedBuffer<char> out(n);
509 for (uptr i = 0; i < n; i++) {
510 uptr pc = coverage_data.data()[i];
511 out[i] = pc ? '1' : '0';
512 if (pc)
513 n_set_bits++;
514 }
515 internal_write(fd, out.data(), n);
516 internal_close(fd);
517 VReport(1, " CovDump: bitset of %zd bits written, %zd bits are set\n", n,
518 n_set_bits);
519}
520
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000521// Dump the coverage on disk.
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000522static void CovDump() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000523 if (!coverage_enabled || common_flags()->coverage_direct) return;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000524#if !SANITIZER_WINDOWS
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000525 if (atomic_fetch_add(&dump_once_guard, 1, memory_order_relaxed))
526 return;
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000527 CovDumpAsBitSet();
Kostya Serebryanya7ee2732014-12-30 19:55:04 +0000528 if (!common_flags()->coverage_pcs) return;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000529 uptr size = coverage_data.size();
Kostya Serebryany8b530e12014-04-30 10:40:48 +0000530 InternalMmapVector<u32> offsets(size);
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000531 uptr *vb = coverage_data.data();
532 uptr *ve = vb + size;
533 SortArray(vb, size);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000534 MemoryMappingLayout proc_maps(/*cache_enabled*/true);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000535 uptr mb, me, off, prot;
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000536 InternalScopedString module(kMaxPathLength);
537 InternalScopedString path(kMaxPathLength);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000538 for (int i = 0;
539 proc_maps.Next(&mb, &me, &off, module.data(), module.size(), &prot);
540 i++) {
541 if ((prot & MemoryMappingLayout::kProtectionExecute) == 0)
542 continue;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000543 while (vb < ve && *vb < mb) vb++;
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000544 if (vb >= ve) break;
Sergey Matveev76e02e92014-05-08 16:09:54 +0000545 if (*vb < me) {
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000546 offsets.clear();
547 const uptr *old_vb = vb;
548 CHECK_LE(off, *vb);
549 for (; vb < ve && *vb < me; vb++) {
550 uptr diff = *vb - (i ? mb : 0) + off;
551 CHECK_LE(diff, 0xffffffffU);
552 offsets.push_back(static_cast<u32>(diff));
553 }
Alexey Samsonov26ca05a2014-11-04 19:34:29 +0000554 const char *module_name = StripModuleName(module.data());
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000555 if (cov_sandboxed) {
Sergey Matveev83f91e72014-05-21 13:43:52 +0000556 if (cov_fd >= 0) {
557 CovWritePacked(internal_getpid(), module_name, offsets.data(),
558 offsets.size() * sizeof(u32));
559 VReport(1, " CovDump: %zd PCs written to packed file\n", vb - old_vb);
560 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000561 } else {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000562 // One file per module per process.
Alexey Samsonov656c29b2014-12-02 22:20:11 +0000563 path.clear();
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000564 path.append("%s/%s.%zd.sancov", coverage_dir, module_name,
565 internal_getpid());
Sergey Matveev83f91e72014-05-21 13:43:52 +0000566 int fd = CovOpenFile(false /* packed */, module_name);
567 if (fd > 0) {
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000568 internal_write(fd, offsets.data(), offsets.size() * sizeof(u32));
569 internal_close(fd);
570 VReport(1, " CovDump: %s: %zd PCs written\n", path.data(),
571 vb - old_vb);
572 }
Evgeniy Stepanov8ab205f2014-02-12 15:29:22 +0000573 }
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000574 }
575 }
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000576 if (cov_fd >= 0)
577 internal_close(cov_fd);
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000578 coverage_data.DumpCallerCalleePairs();
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000579 coverage_data.DumpTrace();
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000580#endif // !SANITIZER_WINDOWS
581}
582
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000583void CovPrepareForSandboxing(__sanitizer_sandbox_arguments *args) {
584 if (!args) return;
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000585 if (!coverage_enabled) return;
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000586 cov_sandboxed = args->coverage_sandboxed;
587 if (!cov_sandboxed) return;
588 cov_fd = args->coverage_fd;
589 cov_max_block_size = args->coverage_max_block_size;
590 if (cov_fd < 0)
591 // Pre-open the file now. The sandbox won't allow us to do it later.
Sergey Matveev83f91e72014-05-21 13:43:52 +0000592 cov_fd = CovOpenFile(true /* packed */, 0);
Sergey Matveev6cb47a082014-05-19 12:53:03 +0000593}
594
Sergey Matveev83f91e72014-05-21 13:43:52 +0000595int MaybeOpenCovFile(const char *name) {
596 CHECK(name);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000597 if (!coverage_enabled) return -1;
Sergey Matveev83f91e72014-05-21 13:43:52 +0000598 return CovOpenFile(true /* packed */, name);
599}
Evgeniy Stepanovfe181022014-06-04 12:13:54 +0000600
601void CovBeforeFork() {
602 coverage_data.BeforeFork();
603}
604
605void CovAfterFork(int child_pid) {
606 coverage_data.AfterFork(child_pid);
607}
608
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000609void InitializeCoverage(bool enabled, const char *dir) {
610 coverage_enabled = enabled;
611 coverage_dir = dir;
612 if (enabled) coverage_data.Init();
613#if !SANITIZER_WINDOWS
614 if (!common_flags()->coverage_direct) Atexit(__sanitizer_cov_dump);
615#endif
616}
617
618void ReInitializeCoverage(bool enabled, const char *dir) {
619 coverage_enabled = enabled;
620 coverage_dir = dir;
621 coverage_data.ReInit();
622}
623
624void CoverageUpdateMapping() {
625 if (coverage_enabled)
626 CovUpdateMapping(coverage_dir);
627}
628
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000629} // namespace __sanitizer
630
631extern "C" {
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000632SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov(u32 *guard) {
Kostya Serebryany4cadd4a2014-11-24 18:49:53 +0000633 coverage_data.Add(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
634 guard);
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000635}
Kostya Serebryanyb6eae0c2014-10-31 17:19:11 +0000636SANITIZER_INTERFACE_ATTRIBUTE void
637__sanitizer_cov_indir_call16(uptr callee, uptr callee_cache16[]) {
638 coverage_data.IndirCall(StackTrace::GetPreviousInstructionPc(GET_CALLER_PC()),
639 callee, callee_cache16, 16);
640}
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000641SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_init() {
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000642 coverage_enabled = true;
643 coverage_dir = common_flags()->coverage_dir;
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000644 coverage_data.Init();
645}
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000646SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_dump() { CovDump(); }
Kostya Serebryanyaa185bf2014-12-30 19:29:28 +0000647SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_module_init(s32 *guards,
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000648 uptr npcs) {
649 coverage_data.InitializeGuards(guards, npcs);
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000650 if (!common_flags()->coverage_direct) return;
651 if (SANITIZER_ANDROID && coverage_enabled) {
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000652 // dlopen/dlclose interceptors do not work on Android, so we rely on
653 // Extend() calls to update .sancov.map.
Evgeniy Stepanov05dc4be2014-12-26 12:32:32 +0000654 CovUpdateMapping(coverage_dir, GET_CALLER_PC());
Evgeniy Stepanov38c228a2014-06-05 14:38:53 +0000655 }
Evgeniy Stepanov567e5162014-05-27 12:37:52 +0000656 coverage_data.Extend(npcs);
657}
Sergey Matveev83f91e72014-05-21 13:43:52 +0000658SANITIZER_INTERFACE_ATTRIBUTE
659sptr __sanitizer_maybe_open_cov_file(const char *name) {
660 return MaybeOpenCovFile(name);
661}
Kostya Serebryany183cb6e2014-11-14 23:15:55 +0000662SANITIZER_INTERFACE_ATTRIBUTE
663uptr __sanitizer_get_total_unique_coverage() {
664 return atomic_load(&coverage_counter, memory_order_relaxed);
665}
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000666
667SANITIZER_INTERFACE_ATTRIBUTE
668void __sanitizer_cov_trace_func_enter(uptr *cache) {
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000669 coverage_data.TraceBasicBlock(cache);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000670}
671SANITIZER_INTERFACE_ATTRIBUTE
672void __sanitizer_cov_trace_basic_block(uptr *cache) {
Kostya Serebryany9fdeb372014-12-23 22:32:17 +0000673 coverage_data.TraceBasicBlock(cache);
Kostya Serebryanyc9d251e2014-11-19 00:24:11 +0000674}
Bob Wilsona08e9ac2013-11-15 07:18:15 +0000675} // extern "C"