blob: 7874f1315aa2f8f94f1069094475d16072d44e19 [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
morehouse398297f2017-08-22 21:28:29 +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.
dor1sf50b3bb2018-07-23 14:20:52 +000084void TracePC::UpdateUnstableCounters(int UnstableMode) {
dor1sd7197f42018-07-18 17:03:27 +000085 IterateInline8bitCounters([&](int i, int j, int UnstableIdx) {
dor1sd6266262018-07-24 21:02:44 +000086 if (ModuleCounters[i].Start[j] != UnstableCounters[UnstableIdx].Counter) {
dor1sf50b3bb2018-07-23 14:20:52 +000087 UnstableCounters[UnstableIdx].IsUnstable = true;
dor1sd6266262018-07-24 21:02:44 +000088 if (UnstableMode == ZeroUnstable)
89 UnstableCounters[UnstableIdx].Counter = 0;
90 else if (UnstableMode == MinUnstable)
91 UnstableCounters[UnstableIdx].Counter = std::min(
92 ModuleCounters[i].Start[j], UnstableCounters[UnstableIdx].Counter);
93 }
dor1sf50b3bb2018-07-23 14:20:52 +000094 });
95}
96
97// Moves the minimum hit counts to ModuleCounters.
98void TracePC::ApplyUnstableCounters() {
99 IterateInline8bitCounters([&](int i, int j, int UnstableIdx) {
100 ModuleCounters[i].Start[j] = UnstableCounters[UnstableIdx].Counter;
dor1sd7197f42018-07-18 17:03:27 +0000101 });
dor1sbb933292018-07-16 16:01:31 +0000102}
george.karpenkov29efa6d2017-08-21 23:25:50 +0000103
104void TracePC::HandleInline8bitCountersInit(uint8_t *Start, uint8_t *Stop) {
105 if (Start == Stop) return;
106 if (NumModulesWithInline8bitCounters &&
107 ModuleCounters[NumModulesWithInline8bitCounters-1].Start == Start) return;
108 assert(NumModulesWithInline8bitCounters <
109 sizeof(ModuleCounters) / sizeof(ModuleCounters[0]));
110 ModuleCounters[NumModulesWithInline8bitCounters++] = {Start, Stop};
111 NumInline8bitCounters += Stop - Start;
112}
113
kcc98957a12017-08-25 19:29:47 +0000114void TracePC::HandlePCsInit(const uintptr_t *Start, const uintptr_t *Stop) {
115 const PCTableEntry *B = reinterpret_cast<const PCTableEntry *>(Start);
116 const PCTableEntry *E = reinterpret_cast<const PCTableEntry *>(Stop);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000117 if (NumPCTables && ModulePCTable[NumPCTables - 1].Start == B) return;
118 assert(NumPCTables < sizeof(ModulePCTable) / sizeof(ModulePCTable[0]));
119 ModulePCTable[NumPCTables++] = {B, E};
120 NumPCsInPCTables += E - B;
121}
122
123void TracePC::HandleInit(uint32_t *Start, uint32_t *Stop) {
124 if (Start == Stop || *Start) return;
125 assert(NumModules < sizeof(Modules) / sizeof(Modules[0]));
126 for (uint32_t *P = Start; P < Stop; P++) {
127 NumGuards++;
128 if (NumGuards == kNumPCs) {
129 RawPrint(
130 "WARNING: The binary has too many instrumented PCs.\n"
131 " You may want to reduce the size of the binary\n"
132 " for more efficient fuzzing and precise coverage data\n");
133 }
134 *P = NumGuards % kNumPCs;
135 }
136 Modules[NumModules].Start = Start;
137 Modules[NumModules].Stop = Stop;
138 NumModules++;
139}
140
141void TracePC::PrintModuleInfo() {
142 if (NumGuards) {
143 Printf("INFO: Loaded %zd modules (%zd guards): ", NumModules, NumGuards);
144 for (size_t i = 0; i < NumModules; i++)
145 Printf("%zd [%p, %p), ", Modules[i].Stop - Modules[i].Start,
146 Modules[i].Start, Modules[i].Stop);
147 Printf("\n");
148 }
149 if (NumModulesWithInline8bitCounters) {
150 Printf("INFO: Loaded %zd modules (%zd inline 8-bit counters): ",
151 NumModulesWithInline8bitCounters, NumInline8bitCounters);
152 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++)
153 Printf("%zd [%p, %p), ", ModuleCounters[i].Stop - ModuleCounters[i].Start,
154 ModuleCounters[i].Start, ModuleCounters[i].Stop);
155 Printf("\n");
156 }
157 if (NumPCTables) {
158 Printf("INFO: Loaded %zd PC tables (%zd PCs): ", NumPCTables,
159 NumPCsInPCTables);
160 for (size_t i = 0; i < NumPCTables; i++) {
161 Printf("%zd [%p,%p), ", ModulePCTable[i].Stop - ModulePCTable[i].Start,
162 ModulePCTable[i].Start, ModulePCTable[i].Stop);
163 }
164 Printf("\n");
165
166 if ((NumGuards && NumGuards != NumPCsInPCTables) ||
167 (NumInline8bitCounters && NumInline8bitCounters != NumPCsInPCTables)) {
kcce220ebb2017-10-14 00:07:11 +0000168 Printf("ERROR: The size of coverage PC tables does not match the\n"
169 "number of instrumented PCs. This might be a compiler bug,\n"
170 "please contact the libFuzzer developers.\n"
171 "Also check https://bugs.llvm.org/show_bug.cgi?id=34636\n"
172 "for possible workarounds (tl;dr: don't use the old GNU ld)\n");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000173 _Exit(1);
174 }
175 }
delcypherfcd19a82018-04-20 06:46:19 +0000176 if (size_t NumExtraCounters = ExtraCountersEnd() - ExtraCountersBegin())
177 Printf("INFO: %zd Extra Counters\n", NumExtraCounters);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000178}
179
180ATTRIBUTE_NO_SANITIZE_ALL
181void TracePC::HandleCallerCallee(uintptr_t Caller, uintptr_t Callee) {
182 const uintptr_t kBits = 12;
183 const uintptr_t kMask = (1 << kBits) - 1;
184 uintptr_t Idx = (Caller & kMask) | ((Callee & kMask) << kBits);
185 ValueProfileMap.AddValueModPrime(Idx);
186}
187
188void TracePC::UpdateObservedPCs() {
kccec9da662017-08-28 22:52:22 +0000189 Vector<uintptr_t> CoveredFuncs;
kcc00da6482017-08-25 20:09:25 +0000190 auto ObservePC = [&](uintptr_t PC) {
kcc09b3e5f2018-07-06 19:47:00 +0000191 if (ObservedPCs.insert(PC).second && DoPrintNewPCs) {
192 PrintPC("\tNEW_PC: %p %F %L", "\tNEW_PC: %p", PC + 1);
193 Printf("\n");
194 }
kcc1c0379f2017-08-22 01:28:32 +0000195 };
kcc00da6482017-08-25 20:09:25 +0000196
197 auto Observe = [&](const PCTableEntry &TE) {
198 if (TE.PCFlags & 1)
kccb3080d02018-07-19 22:00:48 +0000199 if (++ObservedFuncs[TE.PC] == 1 && NumPrintNewFuncs)
kccec9da662017-08-28 22:52:22 +0000200 CoveredFuncs.push_back(TE.PC);
kcc00da6482017-08-25 20:09:25 +0000201 ObservePC(TE.PC);
202 };
203
george.karpenkov29efa6d2017-08-21 23:25:50 +0000204 if (NumPCsInPCTables) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000205 if (NumInline8bitCounters == NumPCsInPCTables) {
dor1sd7197f42018-07-18 17:03:27 +0000206 IterateInline8bitCounters([&](int i, int j, int CounterIdx) {
207 if (ModuleCounters[i].Start[j])
208 Observe(ModulePCTable[i].Start[j]);
209 });
george.karpenkov29efa6d2017-08-21 23:25:50 +0000210 } else if (NumGuards == NumPCsInPCTables) {
211 size_t GuardIdx = 1;
212 for (size_t i = 0; i < NumModules; i++) {
213 uint32_t *Beg = Modules[i].Start;
214 size_t Size = Modules[i].Stop - Beg;
215 assert(Size ==
216 (size_t)(ModulePCTable[i].Stop - ModulePCTable[i].Start));
217 for (size_t j = 0; j < Size; j++, GuardIdx++)
218 if (Counters()[GuardIdx])
kcc00da6482017-08-25 20:09:25 +0000219 Observe(ModulePCTable[i].Start[j]);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000220 }
221 }
222 }
kccec9da662017-08-28 22:52:22 +0000223
kccb3080d02018-07-19 22:00:48 +0000224 for (size_t i = 0, N = Min(CoveredFuncs.size(), NumPrintNewFuncs); i < N;
225 i++) {
kcc873dc112018-06-07 21:15:24 +0000226 Printf("\tNEW_FUNC[%zd/%zd]: ", i + 1, CoveredFuncs.size());
kcc09b3e5f2018-07-06 19:47:00 +0000227 PrintPC("%p %F %L", "%p", CoveredFuncs[i] + 1);
228 Printf("\n");
kccec9da662017-08-28 22:52:22 +0000229 }
george.karpenkov29efa6d2017-08-21 23:25:50 +0000230}
231
232inline ALWAYS_INLINE uintptr_t GetPreviousInstructionPc(uintptr_t PC) {
233 // TODO: this implementation is x86 only.
234 // see sanitizer_common GetPreviousInstructionPc for full implementation.
235 return PC - 1;
236}
237
238inline ALWAYS_INLINE uintptr_t GetNextInstructionPc(uintptr_t PC) {
239 // TODO: this implementation is x86 only.
240 // see sanitizer_common GetPreviousInstructionPc for full implementation.
241 return PC + 1;
242}
243
244static std::string GetModuleName(uintptr_t PC) {
245 char ModulePathRaw[4096] = ""; // What's PATH_MAX in portable C++?
246 void *OffsetRaw = nullptr;
247 if (!EF->__sanitizer_get_module_and_offset_for_pc(
248 reinterpret_cast<void *>(PC), ModulePathRaw,
249 sizeof(ModulePathRaw), &OffsetRaw))
250 return "";
251 return ModulePathRaw;
252}
253
kcc85cad3d2018-05-11 01:17:52 +0000254template<class CallBack>
255void TracePC::IterateCoveredFunctions(CallBack CB) {
256 for (size_t i = 0; i < NumPCTables; i++) {
257 auto &M = ModulePCTable[i];
258 assert(M.Start < M.Stop);
259 auto ModuleName = GetModuleName(M.Start->PC);
260 for (auto NextFE = M.Start; NextFE < M.Stop; ) {
261 auto FE = NextFE;
262 assert((FE->PCFlags & 1) && "Not a function entry point");
263 do {
264 NextFE++;
265 } while (NextFE < M.Stop && !(NextFE->PCFlags & 1));
266 if (ObservedFuncs.count(FE->PC))
kccb3080d02018-07-19 22:00:48 +0000267 CB(FE, NextFE, ObservedFuncs[FE->PC]);
kcc85cad3d2018-05-11 01:17:52 +0000268 }
269 }
270}
271
kcc3acbe072018-05-16 23:26:37 +0000272void TracePC::SetFocusFunction(const std::string &FuncName) {
273 // This function should be called once.
274 assert(FocusFunction.first > NumModulesWithInline8bitCounters);
275 if (FuncName.empty())
276 return;
277 for (size_t M = 0; M < NumModulesWithInline8bitCounters; M++) {
278 auto &PCTE = ModulePCTable[M];
279 size_t N = PCTE.Stop - PCTE.Start;
280 for (size_t I = 0; I < N; I++) {
281 if (!(PCTE.Start[I].PCFlags & 1)) continue; // not a function entry.
282 auto Name = DescribePC("%F", GetNextInstructionPc(PCTE.Start[I].PC));
283 if (Name[0] == 'i' && Name[1] == 'n' && Name[2] == ' ')
284 Name = Name.substr(3, std::string::npos);
285 if (FuncName != Name) continue;
286 Printf("INFO: Focus function is set to '%s'\n", Name.c_str());
287 FocusFunction = {M, I};
288 return;
289 }
290 }
291}
292
293bool TracePC::ObservedFocusFunction() {
294 size_t I = FocusFunction.first;
295 size_t J = FocusFunction.second;
296 if (I >= NumModulesWithInline8bitCounters)
297 return false;
298 auto &MC = ModuleCounters[I];
299 size_t Size = MC.Stop - MC.Start;
300 if (J >= Size)
301 return false;
302 return MC.Start[J] != 0;
303}
304
george.karpenkov29efa6d2017-08-21 23:25:50 +0000305void TracePC::PrintCoverage() {
306 if (!EF->__sanitizer_symbolize_pc ||
307 !EF->__sanitizer_get_module_and_offset_for_pc) {
308 Printf("INFO: __sanitizer_symbolize_pc or "
309 "__sanitizer_get_module_and_offset_for_pc is not available,"
310 " not printing coverage\n");
311 return;
312 }
313 Printf("COVERAGE:\n");
kccb3080d02018-07-19 22:00:48 +0000314 auto CoveredFunctionCallback = [&](const PCTableEntry *First,
315 const PCTableEntry *Last,
316 uintptr_t Counter) {
kcc85cad3d2018-05-11 01:17:52 +0000317 assert(First < Last);
318 auto VisualizePC = GetNextInstructionPc(First->PC);
319 std::string FileStr = DescribePC("%s", VisualizePC);
kccb3080d02018-07-19 22:00:48 +0000320 if (!IsInterestingCoverageFile(FileStr))
321 return;
kcc85cad3d2018-05-11 01:17:52 +0000322 std::string FunctionStr = DescribePC("%F", VisualizePC);
kccb3080d02018-07-19 22:00:48 +0000323 if (FunctionStr.find("in ") == 0)
324 FunctionStr = FunctionStr.substr(3);
kcc85cad3d2018-05-11 01:17:52 +0000325 std::string LineStr = DescribePC("%l", VisualizePC);
326 size_t Line = std::stoul(LineStr);
kccb3080d02018-07-19 22:00:48 +0000327 size_t NumEdges = Last - First;
morehousef64b9402018-06-25 15:59:24 +0000328 Vector<uintptr_t> UncoveredPCs;
kcc85cad3d2018-05-11 01:17:52 +0000329 for (auto TE = First; TE < Last; TE++)
330 if (!ObservedPCs.count(TE->PC))
331 UncoveredPCs.push_back(TE->PC);
kccb3080d02018-07-19 22:00:48 +0000332 Printf("COVERED_FUNC: hits: %zd", Counter);
333 Printf(" edges: %zd/%zd", NumEdges - UncoveredPCs.size(), NumEdges);
334 Printf(" %s %s:%zd\n", FunctionStr.c_str(), FileStr.c_str(), Line);
335 for (auto PC: UncoveredPCs)
kcc85cad3d2018-05-11 01:17:52 +0000336 Printf(" UNCOVERED_PC: %s\n",
337 DescribePC("%s:%l", GetNextInstructionPc(PC)).c_str());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000338 };
339
kcc85cad3d2018-05-11 01:17:52 +0000340 IterateCoveredFunctions(CoveredFunctionCallback);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000341}
342
kcca7dd2a92018-05-21 19:47:00 +0000343void TracePC::DumpCoverage() {
344 if (EF->__sanitizer_dump_coverage) {
345 Vector<uintptr_t> PCsCopy(GetNumPCs());
346 for (size_t i = 0; i < GetNumPCs(); i++)
347 PCsCopy[i] = PCs()[i] ? GetPreviousInstructionPc(PCs()[i]) : 0;
348 EF->__sanitizer_dump_coverage(PCsCopy.data(), PCsCopy.size());
349 }
350}
351
dor1sbb933292018-07-16 16:01:31 +0000352void TracePC::PrintUnstableStats() {
353 size_t count = 0;
dor1s72667772018-08-06 23:14:13 +0000354 Printf("UNSTABLE_FUNCTIONS:\n");
355 IterateInline8bitCounters([&](int i, int j, int UnstableIdx) {
356 const PCTableEntry &TE = ModulePCTable[i].Start[j];
357 if (UnstableCounters[UnstableIdx].IsUnstable) {
dor1sbb933292018-07-16 16:01:31 +0000358 count++;
dor1s72667772018-08-06 23:14:13 +0000359 if (ObservedFuncs.count(TE.PC)) {
360 auto VisualizePC = GetNextInstructionPc(TE.PC);
361 std::string FunctionStr = DescribePC("%F", VisualizePC);
362 if (FunctionStr.find("in ") == 0)
363 FunctionStr = FunctionStr.substr(3);
364 Printf("%s\n", FunctionStr.c_str());
365 }
366 }
367 });
368
dor1sbb933292018-07-16 16:01:31 +0000369 Printf("stat::stability_rate: %.2f\n",
370 100 - static_cast<float>(count * 100) / NumInline8bitCounters);
371}
372
george.karpenkov29efa6d2017-08-21 23:25:50 +0000373// Value profile.
374// We keep track of various values that affect control flow.
375// These values are inserted into a bit-set-based hash map.
376// Every new bit in the map is treated as a new coverage.
377//
378// For memcmp/strcmp/etc the interesting value is the length of the common
379// prefix of the parameters.
380// For cmp instructions the interesting value is a XOR of the parameters.
381// The interesting value is mixed up with the PC and is then added to the map.
382
383ATTRIBUTE_NO_SANITIZE_ALL
384void TracePC::AddValueForMemcmp(void *caller_pc, const void *s1, const void *s2,
385 size_t n, bool StopAtZero) {
386 if (!n) return;
387 size_t Len = std::min(n, Word::GetMaxSize());
388 const uint8_t *A1 = reinterpret_cast<const uint8_t *>(s1);
389 const uint8_t *A2 = reinterpret_cast<const uint8_t *>(s2);
390 uint8_t B1[Word::kMaxSize];
391 uint8_t B2[Word::kMaxSize];
392 // Copy the data into locals in this non-msan-instrumented function
393 // to avoid msan complaining further.
394 size_t Hash = 0; // Compute some simple hash of both strings.
395 for (size_t i = 0; i < Len; i++) {
396 B1[i] = A1[i];
397 B2[i] = A2[i];
398 size_t T = B1[i];
399 Hash ^= (T << 8) | B2[i];
400 }
401 size_t I = 0;
402 for (; I < Len; I++)
403 if (B1[I] != B2[I] || (StopAtZero && B1[I] == 0))
404 break;
405 size_t PC = reinterpret_cast<size_t>(caller_pc);
406 size_t Idx = (PC & 4095) | (I << 12);
407 ValueProfileMap.AddValue(Idx);
408 TORCW.Insert(Idx ^ Hash, Word(B1, Len), Word(B2, Len));
409}
410
411template <class T>
412ATTRIBUTE_TARGET_POPCNT ALWAYS_INLINE
413ATTRIBUTE_NO_SANITIZE_ALL
414void TracePC::HandleCmp(uintptr_t PC, T Arg1, T Arg2) {
415 uint64_t ArgXor = Arg1 ^ Arg2;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000416 if (sizeof(T) == 4)
dor1se6729cb2018-07-16 15:15:34 +0000417 TORC4.Insert(ArgXor, Arg1, Arg2);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000418 else if (sizeof(T) == 8)
dor1se6729cb2018-07-16 15:15:34 +0000419 TORC8.Insert(ArgXor, Arg1, Arg2);
kcc6d3b8e92018-08-02 00:24:49 +0000420 uint64_t HammingDistance = __builtin_popcountll(ArgXor); // [0,64]
421 uint64_t AbsoluteDistance =
422 (Arg1 == Arg2 ? 0 : __builtin_clzll(Arg1 - Arg2) + 1);
423 ValueProfileMap.AddValue(PC * 128 + HammingDistance);
424 ValueProfileMap.AddValue(PC * 128 + 64 + AbsoluteDistance);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000425}
426
427static size_t InternalStrnlen(const char *S, size_t MaxLen) {
428 size_t Len = 0;
429 for (; Len < MaxLen && S[Len]; Len++) {}
430 return Len;
431}
432
433// Finds min of (strlen(S1), strlen(S2)).
434// Needed bacause one of these strings may actually be non-zero terminated.
435static size_t InternalStrnlen2(const char *S1, const char *S2) {
436 size_t Len = 0;
437 for (; S1[Len] && S2[Len]; Len++) {}
438 return Len;
439}
440
441void TracePC::ClearInlineCounters() {
442 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++) {
443 uint8_t *Beg = ModuleCounters[i].Start;
444 size_t Size = ModuleCounters[i].Stop - Beg;
445 memset(Beg, 0, Size);
446 }
447}
448
kcc0f3c0312017-08-22 01:50:00 +0000449ATTRIBUTE_NO_SANITIZE_ALL
kcc1c0379f2017-08-22 01:28:32 +0000450void TracePC::RecordInitialStack() {
kcc0f3c0312017-08-22 01:50:00 +0000451 int stack;
452 __sancov_lowest_stack = InitialStack = reinterpret_cast<uintptr_t>(&stack);
kcc1c0379f2017-08-22 01:28:32 +0000453}
454
455uintptr_t TracePC::GetMaxStackOffset() const {
456 return InitialStack - __sancov_lowest_stack; // Stack grows down
457}
458
george.karpenkov29efa6d2017-08-21 23:25:50 +0000459} // namespace fuzzer
460
461extern "C" {
462ATTRIBUTE_INTERFACE
463ATTRIBUTE_NO_SANITIZE_ALL
464void __sanitizer_cov_trace_pc_guard(uint32_t *Guard) {
465 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
466 uint32_t Idx = *Guard;
467 __sancov_trace_pc_pcs[Idx] = PC;
468 __sancov_trace_pc_guard_8bit_counters[Idx]++;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000469}
470
471// Best-effort support for -fsanitize-coverage=trace-pc, which is available
472// in both Clang and GCC.
473ATTRIBUTE_INTERFACE
474ATTRIBUTE_NO_SANITIZE_ALL
475void __sanitizer_cov_trace_pc() {
476 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
477 uintptr_t Idx = PC & (((uintptr_t)1 << fuzzer::TracePC::kTracePcBits) - 1);
478 __sancov_trace_pc_pcs[Idx] = PC;
479 __sancov_trace_pc_guard_8bit_counters[Idx]++;
480}
481
482ATTRIBUTE_INTERFACE
483void __sanitizer_cov_trace_pc_guard_init(uint32_t *Start, uint32_t *Stop) {
484 fuzzer::TPC.HandleInit(Start, Stop);
485}
486
487ATTRIBUTE_INTERFACE
488void __sanitizer_cov_8bit_counters_init(uint8_t *Start, uint8_t *Stop) {
489 fuzzer::TPC.HandleInline8bitCountersInit(Start, Stop);
490}
491
492ATTRIBUTE_INTERFACE
kcc98957a12017-08-25 19:29:47 +0000493void __sanitizer_cov_pcs_init(const uintptr_t *pcs_beg,
494 const uintptr_t *pcs_end) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000495 fuzzer::TPC.HandlePCsInit(pcs_beg, pcs_end);
496}
497
498ATTRIBUTE_INTERFACE
499ATTRIBUTE_NO_SANITIZE_ALL
500void __sanitizer_cov_trace_pc_indir(uintptr_t Callee) {
501 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
502 fuzzer::TPC.HandleCallerCallee(PC, Callee);
503}
504
505ATTRIBUTE_INTERFACE
506ATTRIBUTE_NO_SANITIZE_ALL
507ATTRIBUTE_TARGET_POPCNT
508void __sanitizer_cov_trace_cmp8(uint64_t Arg1, uint64_t Arg2) {
509 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
510 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
511}
512
513ATTRIBUTE_INTERFACE
514ATTRIBUTE_NO_SANITIZE_ALL
515ATTRIBUTE_TARGET_POPCNT
516// Now the __sanitizer_cov_trace_const_cmp[1248] callbacks just mimic
517// the behaviour of __sanitizer_cov_trace_cmp[1248] ones. This, however,
518// should be changed later to make full use of instrumentation.
519void __sanitizer_cov_trace_const_cmp8(uint64_t Arg1, uint64_t Arg2) {
520 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
521 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
522}
523
524ATTRIBUTE_INTERFACE
525ATTRIBUTE_NO_SANITIZE_ALL
526ATTRIBUTE_TARGET_POPCNT
527void __sanitizer_cov_trace_cmp4(uint32_t Arg1, uint32_t Arg2) {
528 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
529 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
530}
531
532ATTRIBUTE_INTERFACE
533ATTRIBUTE_NO_SANITIZE_ALL
534ATTRIBUTE_TARGET_POPCNT
535void __sanitizer_cov_trace_const_cmp4(uint32_t Arg1, uint32_t Arg2) {
536 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
537 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
538}
539
540ATTRIBUTE_INTERFACE
541ATTRIBUTE_NO_SANITIZE_ALL
542ATTRIBUTE_TARGET_POPCNT
543void __sanitizer_cov_trace_cmp2(uint16_t Arg1, uint16_t Arg2) {
544 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
545 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
546}
547
548ATTRIBUTE_INTERFACE
549ATTRIBUTE_NO_SANITIZE_ALL
550ATTRIBUTE_TARGET_POPCNT
551void __sanitizer_cov_trace_const_cmp2(uint16_t Arg1, uint16_t Arg2) {
552 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
553 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
554}
555
556ATTRIBUTE_INTERFACE
557ATTRIBUTE_NO_SANITIZE_ALL
558ATTRIBUTE_TARGET_POPCNT
559void __sanitizer_cov_trace_cmp1(uint8_t Arg1, uint8_t Arg2) {
560 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
561 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
562}
563
564ATTRIBUTE_INTERFACE
565ATTRIBUTE_NO_SANITIZE_ALL
566ATTRIBUTE_TARGET_POPCNT
567void __sanitizer_cov_trace_const_cmp1(uint8_t Arg1, uint8_t Arg2) {
568 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
569 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
570}
571
572ATTRIBUTE_INTERFACE
573ATTRIBUTE_NO_SANITIZE_ALL
574ATTRIBUTE_TARGET_POPCNT
575void __sanitizer_cov_trace_switch(uint64_t Val, uint64_t *Cases) {
576 uint64_t N = Cases[0];
577 uint64_t ValSizeInBits = Cases[1];
578 uint64_t *Vals = Cases + 2;
579 // Skip the most common and the most boring case.
580 if (Vals[N - 1] < 256 && Val < 256)
581 return;
582 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
583 size_t i;
584 uint64_t Token = 0;
585 for (i = 0; i < N; i++) {
586 Token = Val ^ Vals[i];
587 if (Val < Vals[i])
588 break;
589 }
590
591 if (ValSizeInBits == 16)
592 fuzzer::TPC.HandleCmp(PC + i, static_cast<uint16_t>(Token), (uint16_t)(0));
593 else if (ValSizeInBits == 32)
594 fuzzer::TPC.HandleCmp(PC + i, static_cast<uint32_t>(Token), (uint32_t)(0));
595 else
596 fuzzer::TPC.HandleCmp(PC + i, Token, (uint64_t)(0));
597}
598
599ATTRIBUTE_INTERFACE
600ATTRIBUTE_NO_SANITIZE_ALL
601ATTRIBUTE_TARGET_POPCNT
602void __sanitizer_cov_trace_div4(uint32_t Val) {
603 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
604 fuzzer::TPC.HandleCmp(PC, Val, (uint32_t)0);
605}
606
607ATTRIBUTE_INTERFACE
608ATTRIBUTE_NO_SANITIZE_ALL
609ATTRIBUTE_TARGET_POPCNT
610void __sanitizer_cov_trace_div8(uint64_t Val) {
611 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
612 fuzzer::TPC.HandleCmp(PC, Val, (uint64_t)0);
613}
614
615ATTRIBUTE_INTERFACE
616ATTRIBUTE_NO_SANITIZE_ALL
617ATTRIBUTE_TARGET_POPCNT
618void __sanitizer_cov_trace_gep(uintptr_t Idx) {
619 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
620 fuzzer::TPC.HandleCmp(PC, Idx, (uintptr_t)0);
621}
622
623ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
624void __sanitizer_weak_hook_memcmp(void *caller_pc, const void *s1,
625 const void *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000626 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000627 if (result == 0) return; // No reason to mutate.
628 if (n <= 1) return; // Not interesting.
629 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, n, /*StopAtZero*/false);
630}
631
632ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
633void __sanitizer_weak_hook_strncmp(void *caller_pc, const char *s1,
634 const char *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000635 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000636 if (result == 0) return; // No reason to mutate.
637 size_t Len1 = fuzzer::InternalStrnlen(s1, n);
638 size_t Len2 = fuzzer::InternalStrnlen(s2, n);
639 n = std::min(n, Len1);
640 n = std::min(n, Len2);
641 if (n <= 1) return; // Not interesting.
642 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, n, /*StopAtZero*/true);
643}
644
645ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
646void __sanitizer_weak_hook_strcmp(void *caller_pc, const char *s1,
dor1se6729cb2018-07-16 15:15:34 +0000647 const char *s2, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000648 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000649 if (result == 0) return; // No reason to mutate.
650 size_t N = fuzzer::InternalStrnlen2(s1, s2);
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_strncasecmp(void *called_pc, const char *s1,
657 const char *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000658 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000659 return __sanitizer_weak_hook_strncmp(called_pc, s1, s2, n, result);
660}
661
662ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
663void __sanitizer_weak_hook_strcasecmp(void *called_pc, const char *s1,
664 const char *s2, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000665 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000666 return __sanitizer_weak_hook_strcmp(called_pc, s1, s2, result);
667}
668
669ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
670void __sanitizer_weak_hook_strstr(void *called_pc, const char *s1,
671 const char *s2, char *result) {
morehousec6ee8752018-07-17 16:12:00 +0000672 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000673 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), strlen(s2));
674}
675
676ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
677void __sanitizer_weak_hook_strcasestr(void *called_pc, const char *s1,
678 const char *s2, char *result) {
morehousec6ee8752018-07-17 16:12:00 +0000679 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000680 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), strlen(s2));
681}
682
683ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
684void __sanitizer_weak_hook_memmem(void *called_pc, const void *s1, size_t len1,
685 const void *s2, size_t len2, void *result) {
morehousec6ee8752018-07-17 16:12:00 +0000686 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000687 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), len2);
688}
689} // extern "C"