blob: 1aba816e8327b5964fe71fcdc1c13ae458f6adb6 [file] [log] [blame]
george.karpenkov29efa6d2017-08-21 23:25:50 +00001//===- FuzzerTracePC.cpp - PC tracing--------------------------------------===//
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// Trace PCs.
10// This module implements __sanitizer_cov_trace_pc_guard[_init],
11// the callback required for -fsanitize-coverage=trace-pc-guard instrumentation.
12//
13//===----------------------------------------------------------------------===//
14
15#include "FuzzerTracePC.h"
16#include "FuzzerCorpus.h"
17#include "FuzzerDefs.h"
18#include "FuzzerDictionary.h"
19#include "FuzzerExtFunctions.h"
20#include "FuzzerIO.h"
21#include "FuzzerUtil.h"
22#include "FuzzerValueBitMap.h"
23#include <set>
24
25// The coverage counters and PCs.
26// These are declared as global variables named "__sancov_*" to simplify
27// experiments with inlined instrumentation.
28alignas(64) ATTRIBUTE_INTERFACE
29uint8_t __sancov_trace_pc_guard_8bit_counters[fuzzer::TracePC::kNumPCs];
30
31ATTRIBUTE_INTERFACE
32uintptr_t __sancov_trace_pc_pcs[fuzzer::TracePC::kNumPCs];
33
kcc1c0379f2017-08-22 01:28:32 +000034// Used by -fsanitize-coverage=stack-depth to track stack depth
morehouse78980332018-08-29 18:40:41 +000035ATTRIBUTE_INTERFACE __attribute__((tls_model("initial-exec")))
36thread_local uintptr_t __sancov_lowest_stack;
kcc1c0379f2017-08-22 01:28:32 +000037
george.karpenkov29efa6d2017-08-21 23:25:50 +000038namespace fuzzer {
39
40TracePC TPC;
41
george.karpenkov29efa6d2017-08-21 23:25:50 +000042uint8_t *TracePC::Counters() const {
43 return __sancov_trace_pc_guard_8bit_counters;
44}
45
46uintptr_t *TracePC::PCs() const {
47 return __sancov_trace_pc_pcs;
48}
49
50size_t TracePC::GetTotalPCCoverage() {
51 if (ObservedPCs.size())
52 return ObservedPCs.size();
53 size_t Res = 0;
54 for (size_t i = 1, N = GetNumPCs(); i < N; i++)
55 if (PCs()[i])
56 Res++;
57 return Res;
58}
59
dor1sd7197f42018-07-18 17:03:27 +000060template<class CallBack>
61void TracePC::IterateInline8bitCounters(CallBack CB) const {
dor1sbb933292018-07-16 16:01:31 +000062 if (NumInline8bitCounters && NumInline8bitCounters == NumPCsInPCTables) {
dor1sd7197f42018-07-18 17:03:27 +000063 size_t CounterIdx = 0;
dor1sbb933292018-07-16 16:01:31 +000064 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++) {
65 uint8_t *Beg = ModuleCounters[i].Start;
66 size_t Size = ModuleCounters[i].Stop - Beg;
67 assert(Size == (size_t)(ModulePCTable[i].Stop - ModulePCTable[i].Start));
dor1sd7197f42018-07-18 17:03:27 +000068 for (size_t j = 0; j < Size; j++, CounterIdx++)
69 CB(i, j, CounterIdx);
dor1sbb933292018-07-16 16:01:31 +000070 }
71 }
72}
73
dor1sd7197f42018-07-18 17:03:27 +000074// Initializes unstable counters by copying Inline8bitCounters to unstable
75// counters.
76void TracePC::InitializeUnstableCounters() {
77 IterateInline8bitCounters([&](int i, int j, int UnstableIdx) {
dor1sf50b3bb2018-07-23 14:20:52 +000078 UnstableCounters[UnstableIdx].Counter = ModuleCounters[i].Start[j];
dor1sd7197f42018-07-18 17:03:27 +000079 });
80}
81
dor1sbb933292018-07-16 16:01:31 +000082// Compares the current counters with counters from previous runs
83// and records differences as unstable edges.
dor1s658ff782018-08-08 14:32:46 +000084bool TracePC::UpdateUnstableCounters(int UnstableMode) {
85 bool Updated = false;
dor1sd7197f42018-07-18 17:03:27 +000086 IterateInline8bitCounters([&](int i, int j, int UnstableIdx) {
dor1sd6266262018-07-24 21:02:44 +000087 if (ModuleCounters[i].Start[j] != UnstableCounters[UnstableIdx].Counter) {
dor1s658ff782018-08-08 14:32:46 +000088 Updated = true;
dor1sf50b3bb2018-07-23 14:20:52 +000089 UnstableCounters[UnstableIdx].IsUnstable = true;
dor1sd6266262018-07-24 21:02:44 +000090 if (UnstableMode == ZeroUnstable)
91 UnstableCounters[UnstableIdx].Counter = 0;
92 else if (UnstableMode == MinUnstable)
93 UnstableCounters[UnstableIdx].Counter = std::min(
94 ModuleCounters[i].Start[j], UnstableCounters[UnstableIdx].Counter);
95 }
dor1sf50b3bb2018-07-23 14:20:52 +000096 });
dor1s658ff782018-08-08 14:32:46 +000097 return Updated;
dor1sf50b3bb2018-07-23 14:20:52 +000098}
99
dor1s658ff782018-08-08 14:32:46 +0000100// Updates and applies unstable counters to ModuleCounters in single iteration
101void TracePC::UpdateAndApplyUnstableCounters(int UnstableMode) {
dor1sf50b3bb2018-07-23 14:20:52 +0000102 IterateInline8bitCounters([&](int i, int j, int UnstableIdx) {
dor1s658ff782018-08-08 14:32:46 +0000103 if (ModuleCounters[i].Start[j] != UnstableCounters[UnstableIdx].Counter) {
104 UnstableCounters[UnstableIdx].IsUnstable = true;
105 if (UnstableMode == ZeroUnstable)
106 ModuleCounters[i].Start[j] = 0;
107 else if (UnstableMode == MinUnstable)
108 ModuleCounters[i].Start[j] = std::min(
109 ModuleCounters[i].Start[j], UnstableCounters[UnstableIdx].Counter);
110 }
dor1sd7197f42018-07-18 17:03:27 +0000111 });
dor1sbb933292018-07-16 16:01:31 +0000112}
george.karpenkov29efa6d2017-08-21 23:25:50 +0000113
114void TracePC::HandleInline8bitCountersInit(uint8_t *Start, uint8_t *Stop) {
115 if (Start == Stop) return;
116 if (NumModulesWithInline8bitCounters &&
117 ModuleCounters[NumModulesWithInline8bitCounters-1].Start == Start) return;
118 assert(NumModulesWithInline8bitCounters <
119 sizeof(ModuleCounters) / sizeof(ModuleCounters[0]));
120 ModuleCounters[NumModulesWithInline8bitCounters++] = {Start, Stop};
121 NumInline8bitCounters += Stop - Start;
122}
123
kcc98957a12017-08-25 19:29:47 +0000124void TracePC::HandlePCsInit(const uintptr_t *Start, const uintptr_t *Stop) {
125 const PCTableEntry *B = reinterpret_cast<const PCTableEntry *>(Start);
126 const PCTableEntry *E = reinterpret_cast<const PCTableEntry *>(Stop);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000127 if (NumPCTables && ModulePCTable[NumPCTables - 1].Start == B) return;
128 assert(NumPCTables < sizeof(ModulePCTable) / sizeof(ModulePCTable[0]));
129 ModulePCTable[NumPCTables++] = {B, E};
130 NumPCsInPCTables += E - B;
131}
132
133void TracePC::HandleInit(uint32_t *Start, uint32_t *Stop) {
134 if (Start == Stop || *Start) return;
135 assert(NumModules < sizeof(Modules) / sizeof(Modules[0]));
136 for (uint32_t *P = Start; P < Stop; P++) {
137 NumGuards++;
138 if (NumGuards == kNumPCs) {
139 RawPrint(
140 "WARNING: The binary has too many instrumented PCs.\n"
141 " You may want to reduce the size of the binary\n"
142 " for more efficient fuzzing and precise coverage data\n");
143 }
144 *P = NumGuards % kNumPCs;
145 }
146 Modules[NumModules].Start = Start;
147 Modules[NumModules].Stop = Stop;
148 NumModules++;
149}
150
151void TracePC::PrintModuleInfo() {
152 if (NumGuards) {
153 Printf("INFO: Loaded %zd modules (%zd guards): ", NumModules, NumGuards);
154 for (size_t i = 0; i < NumModules; i++)
155 Printf("%zd [%p, %p), ", Modules[i].Stop - Modules[i].Start,
156 Modules[i].Start, Modules[i].Stop);
157 Printf("\n");
158 }
159 if (NumModulesWithInline8bitCounters) {
160 Printf("INFO: Loaded %zd modules (%zd inline 8-bit counters): ",
161 NumModulesWithInline8bitCounters, NumInline8bitCounters);
162 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++)
163 Printf("%zd [%p, %p), ", ModuleCounters[i].Stop - ModuleCounters[i].Start,
164 ModuleCounters[i].Start, ModuleCounters[i].Stop);
165 Printf("\n");
166 }
167 if (NumPCTables) {
168 Printf("INFO: Loaded %zd PC tables (%zd PCs): ", NumPCTables,
169 NumPCsInPCTables);
170 for (size_t i = 0; i < NumPCTables; i++) {
171 Printf("%zd [%p,%p), ", ModulePCTable[i].Stop - ModulePCTable[i].Start,
172 ModulePCTable[i].Start, ModulePCTable[i].Stop);
173 }
174 Printf("\n");
175
176 if ((NumGuards && NumGuards != NumPCsInPCTables) ||
177 (NumInline8bitCounters && NumInline8bitCounters != NumPCsInPCTables)) {
kcce220ebb2017-10-14 00:07:11 +0000178 Printf("ERROR: The size of coverage PC tables does not match the\n"
179 "number of instrumented PCs. This might be a compiler bug,\n"
180 "please contact the libFuzzer developers.\n"
181 "Also check https://bugs.llvm.org/show_bug.cgi?id=34636\n"
182 "for possible workarounds (tl;dr: don't use the old GNU ld)\n");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000183 _Exit(1);
184 }
185 }
delcypherfcd19a82018-04-20 06:46:19 +0000186 if (size_t NumExtraCounters = ExtraCountersEnd() - ExtraCountersBegin())
187 Printf("INFO: %zd Extra Counters\n", NumExtraCounters);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000188}
189
190ATTRIBUTE_NO_SANITIZE_ALL
191void TracePC::HandleCallerCallee(uintptr_t Caller, uintptr_t Callee) {
192 const uintptr_t kBits = 12;
193 const uintptr_t kMask = (1 << kBits) - 1;
194 uintptr_t Idx = (Caller & kMask) | ((Callee & kMask) << kBits);
195 ValueProfileMap.AddValueModPrime(Idx);
196}
197
198void TracePC::UpdateObservedPCs() {
kccec9da662017-08-28 22:52:22 +0000199 Vector<uintptr_t> CoveredFuncs;
kcc00da6482017-08-25 20:09:25 +0000200 auto ObservePC = [&](uintptr_t PC) {
kcc09b3e5f2018-07-06 19:47:00 +0000201 if (ObservedPCs.insert(PC).second && DoPrintNewPCs) {
202 PrintPC("\tNEW_PC: %p %F %L", "\tNEW_PC: %p", PC + 1);
203 Printf("\n");
204 }
kcc1c0379f2017-08-22 01:28:32 +0000205 };
kcc00da6482017-08-25 20:09:25 +0000206
207 auto Observe = [&](const PCTableEntry &TE) {
208 if (TE.PCFlags & 1)
kccb3080d02018-07-19 22:00:48 +0000209 if (++ObservedFuncs[TE.PC] == 1 && NumPrintNewFuncs)
kccec9da662017-08-28 22:52:22 +0000210 CoveredFuncs.push_back(TE.PC);
kcc00da6482017-08-25 20:09:25 +0000211 ObservePC(TE.PC);
212 };
213
george.karpenkov29efa6d2017-08-21 23:25:50 +0000214 if (NumPCsInPCTables) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000215 if (NumInline8bitCounters == NumPCsInPCTables) {
dor1sd7197f42018-07-18 17:03:27 +0000216 IterateInline8bitCounters([&](int i, int j, int CounterIdx) {
217 if (ModuleCounters[i].Start[j])
218 Observe(ModulePCTable[i].Start[j]);
219 });
george.karpenkov29efa6d2017-08-21 23:25:50 +0000220 } else if (NumGuards == NumPCsInPCTables) {
221 size_t GuardIdx = 1;
222 for (size_t i = 0; i < NumModules; i++) {
223 uint32_t *Beg = Modules[i].Start;
224 size_t Size = Modules[i].Stop - Beg;
225 assert(Size ==
226 (size_t)(ModulePCTable[i].Stop - ModulePCTable[i].Start));
227 for (size_t j = 0; j < Size; j++, GuardIdx++)
228 if (Counters()[GuardIdx])
kcc00da6482017-08-25 20:09:25 +0000229 Observe(ModulePCTable[i].Start[j]);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000230 }
231 }
232 }
kccec9da662017-08-28 22:52:22 +0000233
kccb3080d02018-07-19 22:00:48 +0000234 for (size_t i = 0, N = Min(CoveredFuncs.size(), NumPrintNewFuncs); i < N;
235 i++) {
kcc873dc112018-06-07 21:15:24 +0000236 Printf("\tNEW_FUNC[%zd/%zd]: ", i + 1, CoveredFuncs.size());
kcc09b3e5f2018-07-06 19:47:00 +0000237 PrintPC("%p %F %L", "%p", CoveredFuncs[i] + 1);
238 Printf("\n");
kccec9da662017-08-28 22:52:22 +0000239 }
george.karpenkov29efa6d2017-08-21 23:25:50 +0000240}
241
242inline ALWAYS_INLINE uintptr_t GetPreviousInstructionPc(uintptr_t PC) {
243 // TODO: this implementation is x86 only.
244 // see sanitizer_common GetPreviousInstructionPc for full implementation.
245 return PC - 1;
246}
247
248inline ALWAYS_INLINE uintptr_t GetNextInstructionPc(uintptr_t PC) {
249 // TODO: this implementation is x86 only.
250 // see sanitizer_common GetPreviousInstructionPc for full implementation.
251 return PC + 1;
252}
253
254static std::string GetModuleName(uintptr_t PC) {
255 char ModulePathRaw[4096] = ""; // What's PATH_MAX in portable C++?
256 void *OffsetRaw = nullptr;
257 if (!EF->__sanitizer_get_module_and_offset_for_pc(
258 reinterpret_cast<void *>(PC), ModulePathRaw,
259 sizeof(ModulePathRaw), &OffsetRaw))
260 return "";
261 return ModulePathRaw;
262}
263
kcc85cad3d2018-05-11 01:17:52 +0000264template<class CallBack>
265void TracePC::IterateCoveredFunctions(CallBack CB) {
266 for (size_t i = 0; i < NumPCTables; i++) {
267 auto &M = ModulePCTable[i];
268 assert(M.Start < M.Stop);
269 auto ModuleName = GetModuleName(M.Start->PC);
270 for (auto NextFE = M.Start; NextFE < M.Stop; ) {
271 auto FE = NextFE;
272 assert((FE->PCFlags & 1) && "Not a function entry point");
273 do {
274 NextFE++;
275 } while (NextFE < M.Stop && !(NextFE->PCFlags & 1));
276 if (ObservedFuncs.count(FE->PC))
kccb3080d02018-07-19 22:00:48 +0000277 CB(FE, NextFE, ObservedFuncs[FE->PC]);
kcc85cad3d2018-05-11 01:17:52 +0000278 }
279 }
280}
281
kcc3acbe072018-05-16 23:26:37 +0000282void TracePC::SetFocusFunction(const std::string &FuncName) {
283 // This function should be called once.
284 assert(FocusFunction.first > NumModulesWithInline8bitCounters);
285 if (FuncName.empty())
286 return;
287 for (size_t M = 0; M < NumModulesWithInline8bitCounters; M++) {
288 auto &PCTE = ModulePCTable[M];
289 size_t N = PCTE.Stop - PCTE.Start;
290 for (size_t I = 0; I < N; I++) {
291 if (!(PCTE.Start[I].PCFlags & 1)) continue; // not a function entry.
292 auto Name = DescribePC("%F", GetNextInstructionPc(PCTE.Start[I].PC));
293 if (Name[0] == 'i' && Name[1] == 'n' && Name[2] == ' ')
294 Name = Name.substr(3, std::string::npos);
295 if (FuncName != Name) continue;
296 Printf("INFO: Focus function is set to '%s'\n", Name.c_str());
297 FocusFunction = {M, I};
298 return;
299 }
300 }
301}
302
303bool TracePC::ObservedFocusFunction() {
304 size_t I = FocusFunction.first;
305 size_t J = FocusFunction.second;
306 if (I >= NumModulesWithInline8bitCounters)
307 return false;
308 auto &MC = ModuleCounters[I];
309 size_t Size = MC.Stop - MC.Start;
310 if (J >= Size)
311 return false;
312 return MC.Start[J] != 0;
313}
314
george.karpenkov29efa6d2017-08-21 23:25:50 +0000315void TracePC::PrintCoverage() {
316 if (!EF->__sanitizer_symbolize_pc ||
317 !EF->__sanitizer_get_module_and_offset_for_pc) {
318 Printf("INFO: __sanitizer_symbolize_pc or "
319 "__sanitizer_get_module_and_offset_for_pc is not available,"
320 " not printing coverage\n");
321 return;
322 }
323 Printf("COVERAGE:\n");
kccb3080d02018-07-19 22:00:48 +0000324 auto CoveredFunctionCallback = [&](const PCTableEntry *First,
325 const PCTableEntry *Last,
326 uintptr_t Counter) {
kcc85cad3d2018-05-11 01:17:52 +0000327 assert(First < Last);
328 auto VisualizePC = GetNextInstructionPc(First->PC);
329 std::string FileStr = DescribePC("%s", VisualizePC);
kccb3080d02018-07-19 22:00:48 +0000330 if (!IsInterestingCoverageFile(FileStr))
331 return;
kcc85cad3d2018-05-11 01:17:52 +0000332 std::string FunctionStr = DescribePC("%F", VisualizePC);
kccb3080d02018-07-19 22:00:48 +0000333 if (FunctionStr.find("in ") == 0)
334 FunctionStr = FunctionStr.substr(3);
kcc85cad3d2018-05-11 01:17:52 +0000335 std::string LineStr = DescribePC("%l", VisualizePC);
336 size_t Line = std::stoul(LineStr);
kccb3080d02018-07-19 22:00:48 +0000337 size_t NumEdges = Last - First;
morehousef64b9402018-06-25 15:59:24 +0000338 Vector<uintptr_t> UncoveredPCs;
kcc85cad3d2018-05-11 01:17:52 +0000339 for (auto TE = First; TE < Last; TE++)
340 if (!ObservedPCs.count(TE->PC))
341 UncoveredPCs.push_back(TE->PC);
kccb3080d02018-07-19 22:00:48 +0000342 Printf("COVERED_FUNC: hits: %zd", Counter);
343 Printf(" edges: %zd/%zd", NumEdges - UncoveredPCs.size(), NumEdges);
344 Printf(" %s %s:%zd\n", FunctionStr.c_str(), FileStr.c_str(), Line);
345 for (auto PC: UncoveredPCs)
kcc85cad3d2018-05-11 01:17:52 +0000346 Printf(" UNCOVERED_PC: %s\n",
347 DescribePC("%s:%l", GetNextInstructionPc(PC)).c_str());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000348 };
349
kcc85cad3d2018-05-11 01:17:52 +0000350 IterateCoveredFunctions(CoveredFunctionCallback);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000351}
352
kcca7dd2a92018-05-21 19:47:00 +0000353void TracePC::DumpCoverage() {
354 if (EF->__sanitizer_dump_coverage) {
355 Vector<uintptr_t> PCsCopy(GetNumPCs());
356 for (size_t i = 0; i < GetNumPCs(); i++)
357 PCsCopy[i] = PCs()[i] ? GetPreviousInstructionPc(PCs()[i]) : 0;
358 EF->__sanitizer_dump_coverage(PCsCopy.data(), PCsCopy.size());
359 }
360}
361
dor1sbb933292018-07-16 16:01:31 +0000362void TracePC::PrintUnstableStats() {
363 size_t count = 0;
dor1s72667772018-08-06 23:14:13 +0000364 Printf("UNSTABLE_FUNCTIONS:\n");
365 IterateInline8bitCounters([&](int i, int j, int UnstableIdx) {
366 const PCTableEntry &TE = ModulePCTable[i].Start[j];
367 if (UnstableCounters[UnstableIdx].IsUnstable) {
dor1sbb933292018-07-16 16:01:31 +0000368 count++;
dor1s72667772018-08-06 23:14:13 +0000369 if (ObservedFuncs.count(TE.PC)) {
370 auto VisualizePC = GetNextInstructionPc(TE.PC);
371 std::string FunctionStr = DescribePC("%F", VisualizePC);
372 if (FunctionStr.find("in ") == 0)
373 FunctionStr = FunctionStr.substr(3);
374 Printf("%s\n", FunctionStr.c_str());
375 }
376 }
377 });
378
dor1sbb933292018-07-16 16:01:31 +0000379 Printf("stat::stability_rate: %.2f\n",
380 100 - static_cast<float>(count * 100) / NumInline8bitCounters);
381}
382
george.karpenkov29efa6d2017-08-21 23:25:50 +0000383// Value profile.
384// We keep track of various values that affect control flow.
385// These values are inserted into a bit-set-based hash map.
386// Every new bit in the map is treated as a new coverage.
387//
388// For memcmp/strcmp/etc the interesting value is the length of the common
389// prefix of the parameters.
390// For cmp instructions the interesting value is a XOR of the parameters.
391// The interesting value is mixed up with the PC and is then added to the map.
392
393ATTRIBUTE_NO_SANITIZE_ALL
394void TracePC::AddValueForMemcmp(void *caller_pc, const void *s1, const void *s2,
395 size_t n, bool StopAtZero) {
396 if (!n) return;
397 size_t Len = std::min(n, Word::GetMaxSize());
398 const uint8_t *A1 = reinterpret_cast<const uint8_t *>(s1);
399 const uint8_t *A2 = reinterpret_cast<const uint8_t *>(s2);
400 uint8_t B1[Word::kMaxSize];
401 uint8_t B2[Word::kMaxSize];
402 // Copy the data into locals in this non-msan-instrumented function
403 // to avoid msan complaining further.
404 size_t Hash = 0; // Compute some simple hash of both strings.
405 for (size_t i = 0; i < Len; i++) {
406 B1[i] = A1[i];
407 B2[i] = A2[i];
408 size_t T = B1[i];
409 Hash ^= (T << 8) | B2[i];
410 }
411 size_t I = 0;
412 for (; I < Len; I++)
413 if (B1[I] != B2[I] || (StopAtZero && B1[I] == 0))
414 break;
415 size_t PC = reinterpret_cast<size_t>(caller_pc);
416 size_t Idx = (PC & 4095) | (I << 12);
417 ValueProfileMap.AddValue(Idx);
418 TORCW.Insert(Idx ^ Hash, Word(B1, Len), Word(B2, Len));
419}
420
421template <class T>
422ATTRIBUTE_TARGET_POPCNT ALWAYS_INLINE
423ATTRIBUTE_NO_SANITIZE_ALL
424void TracePC::HandleCmp(uintptr_t PC, T Arg1, T Arg2) {
425 uint64_t ArgXor = Arg1 ^ Arg2;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000426 if (sizeof(T) == 4)
dor1se6729cb2018-07-16 15:15:34 +0000427 TORC4.Insert(ArgXor, Arg1, Arg2);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000428 else if (sizeof(T) == 8)
dor1se6729cb2018-07-16 15:15:34 +0000429 TORC8.Insert(ArgXor, Arg1, Arg2);
kcc6d3b8e92018-08-02 00:24:49 +0000430 uint64_t HammingDistance = __builtin_popcountll(ArgXor); // [0,64]
431 uint64_t AbsoluteDistance =
432 (Arg1 == Arg2 ? 0 : __builtin_clzll(Arg1 - Arg2) + 1);
433 ValueProfileMap.AddValue(PC * 128 + HammingDistance);
434 ValueProfileMap.AddValue(PC * 128 + 64 + AbsoluteDistance);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000435}
436
437static size_t InternalStrnlen(const char *S, size_t MaxLen) {
438 size_t Len = 0;
439 for (; Len < MaxLen && S[Len]; Len++) {}
440 return Len;
441}
442
443// Finds min of (strlen(S1), strlen(S2)).
444// Needed bacause one of these strings may actually be non-zero terminated.
445static size_t InternalStrnlen2(const char *S1, const char *S2) {
446 size_t Len = 0;
447 for (; S1[Len] && S2[Len]; Len++) {}
448 return Len;
449}
450
451void TracePC::ClearInlineCounters() {
452 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++) {
453 uint8_t *Beg = ModuleCounters[i].Start;
454 size_t Size = ModuleCounters[i].Stop - Beg;
455 memset(Beg, 0, Size);
456 }
457}
458
kcc0f3c0312017-08-22 01:50:00 +0000459ATTRIBUTE_NO_SANITIZE_ALL
kcc1c0379f2017-08-22 01:28:32 +0000460void TracePC::RecordInitialStack() {
kcc0f3c0312017-08-22 01:50:00 +0000461 int stack;
462 __sancov_lowest_stack = InitialStack = reinterpret_cast<uintptr_t>(&stack);
kcc1c0379f2017-08-22 01:28:32 +0000463}
464
465uintptr_t TracePC::GetMaxStackOffset() const {
466 return InitialStack - __sancov_lowest_stack; // Stack grows down
467}
468
george.karpenkov29efa6d2017-08-21 23:25:50 +0000469} // namespace fuzzer
470
471extern "C" {
472ATTRIBUTE_INTERFACE
473ATTRIBUTE_NO_SANITIZE_ALL
474void __sanitizer_cov_trace_pc_guard(uint32_t *Guard) {
475 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
476 uint32_t Idx = *Guard;
477 __sancov_trace_pc_pcs[Idx] = PC;
478 __sancov_trace_pc_guard_8bit_counters[Idx]++;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000479}
480
481// Best-effort support for -fsanitize-coverage=trace-pc, which is available
482// in both Clang and GCC.
483ATTRIBUTE_INTERFACE
484ATTRIBUTE_NO_SANITIZE_ALL
485void __sanitizer_cov_trace_pc() {
486 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
487 uintptr_t Idx = PC & (((uintptr_t)1 << fuzzer::TracePC::kTracePcBits) - 1);
488 __sancov_trace_pc_pcs[Idx] = PC;
489 __sancov_trace_pc_guard_8bit_counters[Idx]++;
490}
491
492ATTRIBUTE_INTERFACE
493void __sanitizer_cov_trace_pc_guard_init(uint32_t *Start, uint32_t *Stop) {
494 fuzzer::TPC.HandleInit(Start, Stop);
495}
496
497ATTRIBUTE_INTERFACE
498void __sanitizer_cov_8bit_counters_init(uint8_t *Start, uint8_t *Stop) {
499 fuzzer::TPC.HandleInline8bitCountersInit(Start, Stop);
500}
501
502ATTRIBUTE_INTERFACE
kcc98957a12017-08-25 19:29:47 +0000503void __sanitizer_cov_pcs_init(const uintptr_t *pcs_beg,
504 const uintptr_t *pcs_end) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000505 fuzzer::TPC.HandlePCsInit(pcs_beg, pcs_end);
506}
507
508ATTRIBUTE_INTERFACE
509ATTRIBUTE_NO_SANITIZE_ALL
510void __sanitizer_cov_trace_pc_indir(uintptr_t Callee) {
511 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
512 fuzzer::TPC.HandleCallerCallee(PC, Callee);
513}
514
515ATTRIBUTE_INTERFACE
516ATTRIBUTE_NO_SANITIZE_ALL
517ATTRIBUTE_TARGET_POPCNT
518void __sanitizer_cov_trace_cmp8(uint64_t Arg1, uint64_t Arg2) {
519 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
520 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
521}
522
523ATTRIBUTE_INTERFACE
524ATTRIBUTE_NO_SANITIZE_ALL
525ATTRIBUTE_TARGET_POPCNT
526// Now the __sanitizer_cov_trace_const_cmp[1248] callbacks just mimic
527// the behaviour of __sanitizer_cov_trace_cmp[1248] ones. This, however,
528// should be changed later to make full use of instrumentation.
529void __sanitizer_cov_trace_const_cmp8(uint64_t Arg1, uint64_t Arg2) {
530 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
531 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
532}
533
534ATTRIBUTE_INTERFACE
535ATTRIBUTE_NO_SANITIZE_ALL
536ATTRIBUTE_TARGET_POPCNT
537void __sanitizer_cov_trace_cmp4(uint32_t Arg1, uint32_t Arg2) {
538 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
539 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
540}
541
542ATTRIBUTE_INTERFACE
543ATTRIBUTE_NO_SANITIZE_ALL
544ATTRIBUTE_TARGET_POPCNT
545void __sanitizer_cov_trace_const_cmp4(uint32_t Arg1, uint32_t Arg2) {
546 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
547 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
548}
549
550ATTRIBUTE_INTERFACE
551ATTRIBUTE_NO_SANITIZE_ALL
552ATTRIBUTE_TARGET_POPCNT
553void __sanitizer_cov_trace_cmp2(uint16_t Arg1, uint16_t Arg2) {
554 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
555 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
556}
557
558ATTRIBUTE_INTERFACE
559ATTRIBUTE_NO_SANITIZE_ALL
560ATTRIBUTE_TARGET_POPCNT
561void __sanitizer_cov_trace_const_cmp2(uint16_t Arg1, uint16_t Arg2) {
562 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
563 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
564}
565
566ATTRIBUTE_INTERFACE
567ATTRIBUTE_NO_SANITIZE_ALL
568ATTRIBUTE_TARGET_POPCNT
569void __sanitizer_cov_trace_cmp1(uint8_t Arg1, uint8_t Arg2) {
570 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
571 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
572}
573
574ATTRIBUTE_INTERFACE
575ATTRIBUTE_NO_SANITIZE_ALL
576ATTRIBUTE_TARGET_POPCNT
577void __sanitizer_cov_trace_const_cmp1(uint8_t Arg1, uint8_t Arg2) {
578 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
579 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
580}
581
582ATTRIBUTE_INTERFACE
583ATTRIBUTE_NO_SANITIZE_ALL
584ATTRIBUTE_TARGET_POPCNT
585void __sanitizer_cov_trace_switch(uint64_t Val, uint64_t *Cases) {
586 uint64_t N = Cases[0];
587 uint64_t ValSizeInBits = Cases[1];
588 uint64_t *Vals = Cases + 2;
589 // Skip the most common and the most boring case.
590 if (Vals[N - 1] < 256 && Val < 256)
591 return;
592 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
593 size_t i;
594 uint64_t Token = 0;
595 for (i = 0; i < N; i++) {
596 Token = Val ^ Vals[i];
597 if (Val < Vals[i])
598 break;
599 }
600
601 if (ValSizeInBits == 16)
602 fuzzer::TPC.HandleCmp(PC + i, static_cast<uint16_t>(Token), (uint16_t)(0));
603 else if (ValSizeInBits == 32)
604 fuzzer::TPC.HandleCmp(PC + i, static_cast<uint32_t>(Token), (uint32_t)(0));
605 else
606 fuzzer::TPC.HandleCmp(PC + i, Token, (uint64_t)(0));
607}
608
609ATTRIBUTE_INTERFACE
610ATTRIBUTE_NO_SANITIZE_ALL
611ATTRIBUTE_TARGET_POPCNT
612void __sanitizer_cov_trace_div4(uint32_t Val) {
613 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
614 fuzzer::TPC.HandleCmp(PC, Val, (uint32_t)0);
615}
616
617ATTRIBUTE_INTERFACE
618ATTRIBUTE_NO_SANITIZE_ALL
619ATTRIBUTE_TARGET_POPCNT
620void __sanitizer_cov_trace_div8(uint64_t Val) {
621 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
622 fuzzer::TPC.HandleCmp(PC, Val, (uint64_t)0);
623}
624
625ATTRIBUTE_INTERFACE
626ATTRIBUTE_NO_SANITIZE_ALL
627ATTRIBUTE_TARGET_POPCNT
628void __sanitizer_cov_trace_gep(uintptr_t Idx) {
629 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
630 fuzzer::TPC.HandleCmp(PC, Idx, (uintptr_t)0);
631}
632
633ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
634void __sanitizer_weak_hook_memcmp(void *caller_pc, const void *s1,
635 const void *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000636 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000637 if (result == 0) return; // No reason to mutate.
638 if (n <= 1) return; // Not interesting.
639 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, n, /*StopAtZero*/false);
640}
641
642ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
643void __sanitizer_weak_hook_strncmp(void *caller_pc, const char *s1,
644 const char *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000645 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000646 if (result == 0) return; // No reason to mutate.
647 size_t Len1 = fuzzer::InternalStrnlen(s1, n);
648 size_t Len2 = fuzzer::InternalStrnlen(s2, n);
649 n = std::min(n, Len1);
650 n = std::min(n, Len2);
651 if (n <= 1) return; // Not interesting.
652 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, n, /*StopAtZero*/true);
653}
654
655ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
656void __sanitizer_weak_hook_strcmp(void *caller_pc, const char *s1,
dor1se6729cb2018-07-16 15:15:34 +0000657 const char *s2, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000658 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000659 if (result == 0) return; // No reason to mutate.
660 size_t N = fuzzer::InternalStrnlen2(s1, s2);
661 if (N <= 1) return; // Not interesting.
662 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, N, /*StopAtZero*/true);
663}
664
665ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
666void __sanitizer_weak_hook_strncasecmp(void *called_pc, const char *s1,
667 const char *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000668 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000669 return __sanitizer_weak_hook_strncmp(called_pc, s1, s2, n, result);
670}
671
672ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
673void __sanitizer_weak_hook_strcasecmp(void *called_pc, const char *s1,
674 const char *s2, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000675 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000676 return __sanitizer_weak_hook_strcmp(called_pc, s1, s2, result);
677}
678
679ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
680void __sanitizer_weak_hook_strstr(void *called_pc, const char *s1,
681 const char *s2, char *result) {
morehousec6ee8752018-07-17 16:12:00 +0000682 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000683 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), strlen(s2));
684}
685
686ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
687void __sanitizer_weak_hook_strcasestr(void *called_pc, const char *s1,
688 const char *s2, char *result) {
morehousec6ee8752018-07-17 16:12:00 +0000689 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000690 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), strlen(s2));
691}
692
693ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
694void __sanitizer_weak_hook_memmem(void *called_pc, const void *s1, size_t len1,
695 const void *s2, size_t len2, void *result) {
morehousec6ee8752018-07-17 16:12:00 +0000696 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000697 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), len2);
698}
699} // extern "C"