blob: 859ff633373c4b9b2eade657e15025abfcda912d [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) {
dor1sf50b3bb2018-07-23 14:20:52 +000086 if (ModuleCounters[i].Start[j] != UnstableCounters[UnstableIdx].Counter)
87 UnstableCounters[UnstableIdx].IsUnstable = true;
88 if (UnstableMode &&
89 ModuleCounters[i].Start[j] < UnstableCounters[UnstableIdx].Counter)
90 UnstableCounters[UnstableIdx].Counter = ModuleCounters[i].Start[j];
91 });
92}
93
94// Moves the minimum hit counts to ModuleCounters.
95void TracePC::ApplyUnstableCounters() {
96 IterateInline8bitCounters([&](int i, int j, int UnstableIdx) {
97 ModuleCounters[i].Start[j] = UnstableCounters[UnstableIdx].Counter;
dor1sd7197f42018-07-18 17:03:27 +000098 });
dor1sbb933292018-07-16 16:01:31 +000099}
george.karpenkov29efa6d2017-08-21 23:25:50 +0000100
101void TracePC::HandleInline8bitCountersInit(uint8_t *Start, uint8_t *Stop) {
102 if (Start == Stop) return;
103 if (NumModulesWithInline8bitCounters &&
104 ModuleCounters[NumModulesWithInline8bitCounters-1].Start == Start) return;
105 assert(NumModulesWithInline8bitCounters <
106 sizeof(ModuleCounters) / sizeof(ModuleCounters[0]));
107 ModuleCounters[NumModulesWithInline8bitCounters++] = {Start, Stop};
108 NumInline8bitCounters += Stop - Start;
109}
110
kcc98957a12017-08-25 19:29:47 +0000111void TracePC::HandlePCsInit(const uintptr_t *Start, const uintptr_t *Stop) {
112 const PCTableEntry *B = reinterpret_cast<const PCTableEntry *>(Start);
113 const PCTableEntry *E = reinterpret_cast<const PCTableEntry *>(Stop);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000114 if (NumPCTables && ModulePCTable[NumPCTables - 1].Start == B) return;
115 assert(NumPCTables < sizeof(ModulePCTable) / sizeof(ModulePCTable[0]));
116 ModulePCTable[NumPCTables++] = {B, E};
117 NumPCsInPCTables += E - B;
118}
119
120void TracePC::HandleInit(uint32_t *Start, uint32_t *Stop) {
121 if (Start == Stop || *Start) return;
122 assert(NumModules < sizeof(Modules) / sizeof(Modules[0]));
123 for (uint32_t *P = Start; P < Stop; P++) {
124 NumGuards++;
125 if (NumGuards == kNumPCs) {
126 RawPrint(
127 "WARNING: The binary has too many instrumented PCs.\n"
128 " You may want to reduce the size of the binary\n"
129 " for more efficient fuzzing and precise coverage data\n");
130 }
131 *P = NumGuards % kNumPCs;
132 }
133 Modules[NumModules].Start = Start;
134 Modules[NumModules].Stop = Stop;
135 NumModules++;
136}
137
138void TracePC::PrintModuleInfo() {
139 if (NumGuards) {
140 Printf("INFO: Loaded %zd modules (%zd guards): ", NumModules, NumGuards);
141 for (size_t i = 0; i < NumModules; i++)
142 Printf("%zd [%p, %p), ", Modules[i].Stop - Modules[i].Start,
143 Modules[i].Start, Modules[i].Stop);
144 Printf("\n");
145 }
146 if (NumModulesWithInline8bitCounters) {
147 Printf("INFO: Loaded %zd modules (%zd inline 8-bit counters): ",
148 NumModulesWithInline8bitCounters, NumInline8bitCounters);
149 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++)
150 Printf("%zd [%p, %p), ", ModuleCounters[i].Stop - ModuleCounters[i].Start,
151 ModuleCounters[i].Start, ModuleCounters[i].Stop);
152 Printf("\n");
153 }
154 if (NumPCTables) {
155 Printf("INFO: Loaded %zd PC tables (%zd PCs): ", NumPCTables,
156 NumPCsInPCTables);
157 for (size_t i = 0; i < NumPCTables; i++) {
158 Printf("%zd [%p,%p), ", ModulePCTable[i].Stop - ModulePCTable[i].Start,
159 ModulePCTable[i].Start, ModulePCTable[i].Stop);
160 }
161 Printf("\n");
162
163 if ((NumGuards && NumGuards != NumPCsInPCTables) ||
164 (NumInline8bitCounters && NumInline8bitCounters != NumPCsInPCTables)) {
kcce220ebb2017-10-14 00:07:11 +0000165 Printf("ERROR: The size of coverage PC tables does not match the\n"
166 "number of instrumented PCs. This might be a compiler bug,\n"
167 "please contact the libFuzzer developers.\n"
168 "Also check https://bugs.llvm.org/show_bug.cgi?id=34636\n"
169 "for possible workarounds (tl;dr: don't use the old GNU ld)\n");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000170 _Exit(1);
171 }
172 }
delcypherfcd19a82018-04-20 06:46:19 +0000173 if (size_t NumExtraCounters = ExtraCountersEnd() - ExtraCountersBegin())
174 Printf("INFO: %zd Extra Counters\n", NumExtraCounters);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000175}
176
177ATTRIBUTE_NO_SANITIZE_ALL
178void TracePC::HandleCallerCallee(uintptr_t Caller, uintptr_t Callee) {
179 const uintptr_t kBits = 12;
180 const uintptr_t kMask = (1 << kBits) - 1;
181 uintptr_t Idx = (Caller & kMask) | ((Callee & kMask) << kBits);
182 ValueProfileMap.AddValueModPrime(Idx);
183}
184
185void TracePC::UpdateObservedPCs() {
kccec9da662017-08-28 22:52:22 +0000186 Vector<uintptr_t> CoveredFuncs;
kcc00da6482017-08-25 20:09:25 +0000187 auto ObservePC = [&](uintptr_t PC) {
kcc09b3e5f2018-07-06 19:47:00 +0000188 if (ObservedPCs.insert(PC).second && DoPrintNewPCs) {
189 PrintPC("\tNEW_PC: %p %F %L", "\tNEW_PC: %p", PC + 1);
190 Printf("\n");
191 }
kcc1c0379f2017-08-22 01:28:32 +0000192 };
kcc00da6482017-08-25 20:09:25 +0000193
194 auto Observe = [&](const PCTableEntry &TE) {
195 if (TE.PCFlags & 1)
kccb3080d02018-07-19 22:00:48 +0000196 if (++ObservedFuncs[TE.PC] == 1 && NumPrintNewFuncs)
kccec9da662017-08-28 22:52:22 +0000197 CoveredFuncs.push_back(TE.PC);
kcc00da6482017-08-25 20:09:25 +0000198 ObservePC(TE.PC);
199 };
200
george.karpenkov29efa6d2017-08-21 23:25:50 +0000201 if (NumPCsInPCTables) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000202 if (NumInline8bitCounters == NumPCsInPCTables) {
dor1sd7197f42018-07-18 17:03:27 +0000203 IterateInline8bitCounters([&](int i, int j, int CounterIdx) {
204 if (ModuleCounters[i].Start[j])
205 Observe(ModulePCTable[i].Start[j]);
206 });
george.karpenkov29efa6d2017-08-21 23:25:50 +0000207 } else if (NumGuards == NumPCsInPCTables) {
208 size_t GuardIdx = 1;
209 for (size_t i = 0; i < NumModules; i++) {
210 uint32_t *Beg = Modules[i].Start;
211 size_t Size = Modules[i].Stop - Beg;
212 assert(Size ==
213 (size_t)(ModulePCTable[i].Stop - ModulePCTable[i].Start));
214 for (size_t j = 0; j < Size; j++, GuardIdx++)
215 if (Counters()[GuardIdx])
kcc00da6482017-08-25 20:09:25 +0000216 Observe(ModulePCTable[i].Start[j]);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000217 }
218 }
219 }
kccec9da662017-08-28 22:52:22 +0000220
kccb3080d02018-07-19 22:00:48 +0000221 for (size_t i = 0, N = Min(CoveredFuncs.size(), NumPrintNewFuncs); i < N;
222 i++) {
kcc873dc112018-06-07 21:15:24 +0000223 Printf("\tNEW_FUNC[%zd/%zd]: ", i + 1, CoveredFuncs.size());
kcc09b3e5f2018-07-06 19:47:00 +0000224 PrintPC("%p %F %L", "%p", CoveredFuncs[i] + 1);
225 Printf("\n");
kccec9da662017-08-28 22:52:22 +0000226 }
george.karpenkov29efa6d2017-08-21 23:25:50 +0000227}
228
229inline ALWAYS_INLINE uintptr_t GetPreviousInstructionPc(uintptr_t PC) {
230 // TODO: this implementation is x86 only.
231 // see sanitizer_common GetPreviousInstructionPc for full implementation.
232 return PC - 1;
233}
234
235inline ALWAYS_INLINE uintptr_t GetNextInstructionPc(uintptr_t PC) {
236 // TODO: this implementation is x86 only.
237 // see sanitizer_common GetPreviousInstructionPc for full implementation.
238 return PC + 1;
239}
240
241static std::string GetModuleName(uintptr_t PC) {
242 char ModulePathRaw[4096] = ""; // What's PATH_MAX in portable C++?
243 void *OffsetRaw = nullptr;
244 if (!EF->__sanitizer_get_module_and_offset_for_pc(
245 reinterpret_cast<void *>(PC), ModulePathRaw,
246 sizeof(ModulePathRaw), &OffsetRaw))
247 return "";
248 return ModulePathRaw;
249}
250
kcc85cad3d2018-05-11 01:17:52 +0000251template<class CallBack>
252void TracePC::IterateCoveredFunctions(CallBack CB) {
253 for (size_t i = 0; i < NumPCTables; i++) {
254 auto &M = ModulePCTable[i];
255 assert(M.Start < M.Stop);
256 auto ModuleName = GetModuleName(M.Start->PC);
257 for (auto NextFE = M.Start; NextFE < M.Stop; ) {
258 auto FE = NextFE;
259 assert((FE->PCFlags & 1) && "Not a function entry point");
260 do {
261 NextFE++;
262 } while (NextFE < M.Stop && !(NextFE->PCFlags & 1));
263 if (ObservedFuncs.count(FE->PC))
kccb3080d02018-07-19 22:00:48 +0000264 CB(FE, NextFE, ObservedFuncs[FE->PC]);
kcc85cad3d2018-05-11 01:17:52 +0000265 }
266 }
267}
268
kcc3acbe072018-05-16 23:26:37 +0000269void TracePC::SetFocusFunction(const std::string &FuncName) {
270 // This function should be called once.
271 assert(FocusFunction.first > NumModulesWithInline8bitCounters);
272 if (FuncName.empty())
273 return;
274 for (size_t M = 0; M < NumModulesWithInline8bitCounters; M++) {
275 auto &PCTE = ModulePCTable[M];
276 size_t N = PCTE.Stop - PCTE.Start;
277 for (size_t I = 0; I < N; I++) {
278 if (!(PCTE.Start[I].PCFlags & 1)) continue; // not a function entry.
279 auto Name = DescribePC("%F", GetNextInstructionPc(PCTE.Start[I].PC));
280 if (Name[0] == 'i' && Name[1] == 'n' && Name[2] == ' ')
281 Name = Name.substr(3, std::string::npos);
282 if (FuncName != Name) continue;
283 Printf("INFO: Focus function is set to '%s'\n", Name.c_str());
284 FocusFunction = {M, I};
285 return;
286 }
287 }
288}
289
290bool TracePC::ObservedFocusFunction() {
291 size_t I = FocusFunction.first;
292 size_t J = FocusFunction.second;
293 if (I >= NumModulesWithInline8bitCounters)
294 return false;
295 auto &MC = ModuleCounters[I];
296 size_t Size = MC.Stop - MC.Start;
297 if (J >= Size)
298 return false;
299 return MC.Start[J] != 0;
300}
301
george.karpenkov29efa6d2017-08-21 23:25:50 +0000302void TracePC::PrintCoverage() {
303 if (!EF->__sanitizer_symbolize_pc ||
304 !EF->__sanitizer_get_module_and_offset_for_pc) {
305 Printf("INFO: __sanitizer_symbolize_pc or "
306 "__sanitizer_get_module_and_offset_for_pc is not available,"
307 " not printing coverage\n");
308 return;
309 }
310 Printf("COVERAGE:\n");
kccb3080d02018-07-19 22:00:48 +0000311 auto CoveredFunctionCallback = [&](const PCTableEntry *First,
312 const PCTableEntry *Last,
313 uintptr_t Counter) {
kcc85cad3d2018-05-11 01:17:52 +0000314 assert(First < Last);
315 auto VisualizePC = GetNextInstructionPc(First->PC);
316 std::string FileStr = DescribePC("%s", VisualizePC);
kccb3080d02018-07-19 22:00:48 +0000317 if (!IsInterestingCoverageFile(FileStr))
318 return;
kcc85cad3d2018-05-11 01:17:52 +0000319 std::string FunctionStr = DescribePC("%F", VisualizePC);
kccb3080d02018-07-19 22:00:48 +0000320 if (FunctionStr.find("in ") == 0)
321 FunctionStr = FunctionStr.substr(3);
kcc85cad3d2018-05-11 01:17:52 +0000322 std::string LineStr = DescribePC("%l", VisualizePC);
323 size_t Line = std::stoul(LineStr);
kccb3080d02018-07-19 22:00:48 +0000324 size_t NumEdges = Last - First;
morehousef64b9402018-06-25 15:59:24 +0000325 Vector<uintptr_t> UncoveredPCs;
kcc85cad3d2018-05-11 01:17:52 +0000326 for (auto TE = First; TE < Last; TE++)
327 if (!ObservedPCs.count(TE->PC))
328 UncoveredPCs.push_back(TE->PC);
kccb3080d02018-07-19 22:00:48 +0000329 Printf("COVERED_FUNC: hits: %zd", Counter);
330 Printf(" edges: %zd/%zd", NumEdges - UncoveredPCs.size(), NumEdges);
331 Printf(" %s %s:%zd\n", FunctionStr.c_str(), FileStr.c_str(), Line);
332 for (auto PC: UncoveredPCs)
kcc85cad3d2018-05-11 01:17:52 +0000333 Printf(" UNCOVERED_PC: %s\n",
334 DescribePC("%s:%l", GetNextInstructionPc(PC)).c_str());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000335 };
336
kcc85cad3d2018-05-11 01:17:52 +0000337 IterateCoveredFunctions(CoveredFunctionCallback);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000338}
339
kcca7dd2a92018-05-21 19:47:00 +0000340void TracePC::DumpCoverage() {
341 if (EF->__sanitizer_dump_coverage) {
342 Vector<uintptr_t> PCsCopy(GetNumPCs());
343 for (size_t i = 0; i < GetNumPCs(); i++)
344 PCsCopy[i] = PCs()[i] ? GetPreviousInstructionPc(PCs()[i]) : 0;
345 EF->__sanitizer_dump_coverage(PCsCopy.data(), PCsCopy.size());
346 }
347}
348
dor1sbb933292018-07-16 16:01:31 +0000349void TracePC::PrintUnstableStats() {
350 size_t count = 0;
351 for (size_t i = 0; i < NumInline8bitCounters; i++)
dor1sf50b3bb2018-07-23 14:20:52 +0000352 if (UnstableCounters[i].IsUnstable)
dor1sbb933292018-07-16 16:01:31 +0000353 count++;
354 Printf("stat::stability_rate: %.2f\n",
355 100 - static_cast<float>(count * 100) / NumInline8bitCounters);
356}
357
george.karpenkov29efa6d2017-08-21 23:25:50 +0000358// Value profile.
359// We keep track of various values that affect control flow.
360// These values are inserted into a bit-set-based hash map.
361// Every new bit in the map is treated as a new coverage.
362//
363// For memcmp/strcmp/etc the interesting value is the length of the common
364// prefix of the parameters.
365// For cmp instructions the interesting value is a XOR of the parameters.
366// The interesting value is mixed up with the PC and is then added to the map.
367
368ATTRIBUTE_NO_SANITIZE_ALL
369void TracePC::AddValueForMemcmp(void *caller_pc, const void *s1, const void *s2,
370 size_t n, bool StopAtZero) {
371 if (!n) return;
372 size_t Len = std::min(n, Word::GetMaxSize());
373 const uint8_t *A1 = reinterpret_cast<const uint8_t *>(s1);
374 const uint8_t *A2 = reinterpret_cast<const uint8_t *>(s2);
375 uint8_t B1[Word::kMaxSize];
376 uint8_t B2[Word::kMaxSize];
377 // Copy the data into locals in this non-msan-instrumented function
378 // to avoid msan complaining further.
379 size_t Hash = 0; // Compute some simple hash of both strings.
380 for (size_t i = 0; i < Len; i++) {
381 B1[i] = A1[i];
382 B2[i] = A2[i];
383 size_t T = B1[i];
384 Hash ^= (T << 8) | B2[i];
385 }
386 size_t I = 0;
387 for (; I < Len; I++)
388 if (B1[I] != B2[I] || (StopAtZero && B1[I] == 0))
389 break;
390 size_t PC = reinterpret_cast<size_t>(caller_pc);
391 size_t Idx = (PC & 4095) | (I << 12);
392 ValueProfileMap.AddValue(Idx);
393 TORCW.Insert(Idx ^ Hash, Word(B1, Len), Word(B2, Len));
394}
395
396template <class T>
397ATTRIBUTE_TARGET_POPCNT ALWAYS_INLINE
398ATTRIBUTE_NO_SANITIZE_ALL
399void TracePC::HandleCmp(uintptr_t PC, T Arg1, T Arg2) {
400 uint64_t ArgXor = Arg1 ^ Arg2;
401 uint64_t ArgDistance = __builtin_popcountll(ArgXor) + 1; // [1,65]
402 uintptr_t Idx = ((PC & 4095) + 1) * ArgDistance;
403 if (sizeof(T) == 4)
dor1se6729cb2018-07-16 15:15:34 +0000404 TORC4.Insert(ArgXor, Arg1, Arg2);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000405 else if (sizeof(T) == 8)
dor1se6729cb2018-07-16 15:15:34 +0000406 TORC8.Insert(ArgXor, Arg1, Arg2);
kcc3850d062018-07-03 22:33:09 +0000407 // TODO: remove these flags and instead use all metrics at once.
408 if (UseValueProfileMask & 1)
409 ValueProfileMap.AddValue(Idx);
410 if (UseValueProfileMask & 2)
411 ValueProfileMap.AddValue(
412 PC * 64 + (Arg1 == Arg2 ? 0 : __builtin_clzll(Arg1 - Arg2) + 1));
413 if (UseValueProfileMask & 4) // alternative way to use the hamming distance
414 ValueProfileMap.AddValue(PC * 64 + ArgDistance);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000415}
416
417static size_t InternalStrnlen(const char *S, size_t MaxLen) {
418 size_t Len = 0;
419 for (; Len < MaxLen && S[Len]; Len++) {}
420 return Len;
421}
422
423// Finds min of (strlen(S1), strlen(S2)).
424// Needed bacause one of these strings may actually be non-zero terminated.
425static size_t InternalStrnlen2(const char *S1, const char *S2) {
426 size_t Len = 0;
427 for (; S1[Len] && S2[Len]; Len++) {}
428 return Len;
429}
430
431void TracePC::ClearInlineCounters() {
432 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++) {
433 uint8_t *Beg = ModuleCounters[i].Start;
434 size_t Size = ModuleCounters[i].Stop - Beg;
435 memset(Beg, 0, Size);
436 }
437}
438
kcc0f3c0312017-08-22 01:50:00 +0000439ATTRIBUTE_NO_SANITIZE_ALL
kcc1c0379f2017-08-22 01:28:32 +0000440void TracePC::RecordInitialStack() {
kcc0f3c0312017-08-22 01:50:00 +0000441 int stack;
442 __sancov_lowest_stack = InitialStack = reinterpret_cast<uintptr_t>(&stack);
kcc1c0379f2017-08-22 01:28:32 +0000443}
444
445uintptr_t TracePC::GetMaxStackOffset() const {
446 return InitialStack - __sancov_lowest_stack; // Stack grows down
447}
448
george.karpenkov29efa6d2017-08-21 23:25:50 +0000449} // namespace fuzzer
450
451extern "C" {
452ATTRIBUTE_INTERFACE
453ATTRIBUTE_NO_SANITIZE_ALL
454void __sanitizer_cov_trace_pc_guard(uint32_t *Guard) {
455 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
456 uint32_t Idx = *Guard;
457 __sancov_trace_pc_pcs[Idx] = PC;
458 __sancov_trace_pc_guard_8bit_counters[Idx]++;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000459}
460
461// Best-effort support for -fsanitize-coverage=trace-pc, which is available
462// in both Clang and GCC.
463ATTRIBUTE_INTERFACE
464ATTRIBUTE_NO_SANITIZE_ALL
465void __sanitizer_cov_trace_pc() {
466 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
467 uintptr_t Idx = PC & (((uintptr_t)1 << fuzzer::TracePC::kTracePcBits) - 1);
468 __sancov_trace_pc_pcs[Idx] = PC;
469 __sancov_trace_pc_guard_8bit_counters[Idx]++;
470}
471
472ATTRIBUTE_INTERFACE
473void __sanitizer_cov_trace_pc_guard_init(uint32_t *Start, uint32_t *Stop) {
474 fuzzer::TPC.HandleInit(Start, Stop);
475}
476
477ATTRIBUTE_INTERFACE
478void __sanitizer_cov_8bit_counters_init(uint8_t *Start, uint8_t *Stop) {
479 fuzzer::TPC.HandleInline8bitCountersInit(Start, Stop);
480}
481
482ATTRIBUTE_INTERFACE
kcc98957a12017-08-25 19:29:47 +0000483void __sanitizer_cov_pcs_init(const uintptr_t *pcs_beg,
484 const uintptr_t *pcs_end) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000485 fuzzer::TPC.HandlePCsInit(pcs_beg, pcs_end);
486}
487
488ATTRIBUTE_INTERFACE
489ATTRIBUTE_NO_SANITIZE_ALL
490void __sanitizer_cov_trace_pc_indir(uintptr_t Callee) {
491 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
492 fuzzer::TPC.HandleCallerCallee(PC, Callee);
493}
494
495ATTRIBUTE_INTERFACE
496ATTRIBUTE_NO_SANITIZE_ALL
497ATTRIBUTE_TARGET_POPCNT
498void __sanitizer_cov_trace_cmp8(uint64_t Arg1, uint64_t Arg2) {
499 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
500 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
501}
502
503ATTRIBUTE_INTERFACE
504ATTRIBUTE_NO_SANITIZE_ALL
505ATTRIBUTE_TARGET_POPCNT
506// Now the __sanitizer_cov_trace_const_cmp[1248] callbacks just mimic
507// the behaviour of __sanitizer_cov_trace_cmp[1248] ones. This, however,
508// should be changed later to make full use of instrumentation.
509void __sanitizer_cov_trace_const_cmp8(uint64_t Arg1, uint64_t Arg2) {
510 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
511 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
512}
513
514ATTRIBUTE_INTERFACE
515ATTRIBUTE_NO_SANITIZE_ALL
516ATTRIBUTE_TARGET_POPCNT
517void __sanitizer_cov_trace_cmp4(uint32_t Arg1, uint32_t Arg2) {
518 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
519 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
520}
521
522ATTRIBUTE_INTERFACE
523ATTRIBUTE_NO_SANITIZE_ALL
524ATTRIBUTE_TARGET_POPCNT
525void __sanitizer_cov_trace_const_cmp4(uint32_t Arg1, uint32_t Arg2) {
526 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
527 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
528}
529
530ATTRIBUTE_INTERFACE
531ATTRIBUTE_NO_SANITIZE_ALL
532ATTRIBUTE_TARGET_POPCNT
533void __sanitizer_cov_trace_cmp2(uint16_t Arg1, uint16_t Arg2) {
534 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
535 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
536}
537
538ATTRIBUTE_INTERFACE
539ATTRIBUTE_NO_SANITIZE_ALL
540ATTRIBUTE_TARGET_POPCNT
541void __sanitizer_cov_trace_const_cmp2(uint16_t Arg1, uint16_t Arg2) {
542 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
543 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
544}
545
546ATTRIBUTE_INTERFACE
547ATTRIBUTE_NO_SANITIZE_ALL
548ATTRIBUTE_TARGET_POPCNT
549void __sanitizer_cov_trace_cmp1(uint8_t Arg1, uint8_t Arg2) {
550 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
551 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
552}
553
554ATTRIBUTE_INTERFACE
555ATTRIBUTE_NO_SANITIZE_ALL
556ATTRIBUTE_TARGET_POPCNT
557void __sanitizer_cov_trace_const_cmp1(uint8_t Arg1, uint8_t Arg2) {
558 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
559 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
560}
561
562ATTRIBUTE_INTERFACE
563ATTRIBUTE_NO_SANITIZE_ALL
564ATTRIBUTE_TARGET_POPCNT
565void __sanitizer_cov_trace_switch(uint64_t Val, uint64_t *Cases) {
566 uint64_t N = Cases[0];
567 uint64_t ValSizeInBits = Cases[1];
568 uint64_t *Vals = Cases + 2;
569 // Skip the most common and the most boring case.
570 if (Vals[N - 1] < 256 && Val < 256)
571 return;
572 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
573 size_t i;
574 uint64_t Token = 0;
575 for (i = 0; i < N; i++) {
576 Token = Val ^ Vals[i];
577 if (Val < Vals[i])
578 break;
579 }
580
581 if (ValSizeInBits == 16)
582 fuzzer::TPC.HandleCmp(PC + i, static_cast<uint16_t>(Token), (uint16_t)(0));
583 else if (ValSizeInBits == 32)
584 fuzzer::TPC.HandleCmp(PC + i, static_cast<uint32_t>(Token), (uint32_t)(0));
585 else
586 fuzzer::TPC.HandleCmp(PC + i, Token, (uint64_t)(0));
587}
588
589ATTRIBUTE_INTERFACE
590ATTRIBUTE_NO_SANITIZE_ALL
591ATTRIBUTE_TARGET_POPCNT
592void __sanitizer_cov_trace_div4(uint32_t Val) {
593 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
594 fuzzer::TPC.HandleCmp(PC, Val, (uint32_t)0);
595}
596
597ATTRIBUTE_INTERFACE
598ATTRIBUTE_NO_SANITIZE_ALL
599ATTRIBUTE_TARGET_POPCNT
600void __sanitizer_cov_trace_div8(uint64_t Val) {
601 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
602 fuzzer::TPC.HandleCmp(PC, Val, (uint64_t)0);
603}
604
605ATTRIBUTE_INTERFACE
606ATTRIBUTE_NO_SANITIZE_ALL
607ATTRIBUTE_TARGET_POPCNT
608void __sanitizer_cov_trace_gep(uintptr_t Idx) {
609 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
610 fuzzer::TPC.HandleCmp(PC, Idx, (uintptr_t)0);
611}
612
613ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
614void __sanitizer_weak_hook_memcmp(void *caller_pc, const void *s1,
615 const void *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000616 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000617 if (result == 0) return; // No reason to mutate.
618 if (n <= 1) return; // Not interesting.
619 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, n, /*StopAtZero*/false);
620}
621
622ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
623void __sanitizer_weak_hook_strncmp(void *caller_pc, const char *s1,
624 const char *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000625 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000626 if (result == 0) return; // No reason to mutate.
627 size_t Len1 = fuzzer::InternalStrnlen(s1, n);
628 size_t Len2 = fuzzer::InternalStrnlen(s2, n);
629 n = std::min(n, Len1);
630 n = std::min(n, Len2);
631 if (n <= 1) return; // Not interesting.
632 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, n, /*StopAtZero*/true);
633}
634
635ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
636void __sanitizer_weak_hook_strcmp(void *caller_pc, const char *s1,
dor1se6729cb2018-07-16 15:15:34 +0000637 const char *s2, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000638 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000639 if (result == 0) return; // No reason to mutate.
640 size_t N = fuzzer::InternalStrnlen2(s1, s2);
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_strncasecmp(void *called_pc, const char *s1,
647 const char *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000648 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000649 return __sanitizer_weak_hook_strncmp(called_pc, s1, s2, n, result);
650}
651
652ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
653void __sanitizer_weak_hook_strcasecmp(void *called_pc, const char *s1,
654 const char *s2, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000655 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000656 return __sanitizer_weak_hook_strcmp(called_pc, s1, s2, result);
657}
658
659ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
660void __sanitizer_weak_hook_strstr(void *called_pc, const char *s1,
661 const char *s2, char *result) {
morehousec6ee8752018-07-17 16:12:00 +0000662 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000663 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), strlen(s2));
664}
665
666ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
667void __sanitizer_weak_hook_strcasestr(void *called_pc, const char *s1,
668 const char *s2, char *result) {
morehousec6ee8752018-07-17 16:12:00 +0000669 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000670 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), strlen(s2));
671}
672
673ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
674void __sanitizer_weak_hook_memmem(void *called_pc, const void *s1, size_t len1,
675 const void *s2, size_t len2, void *result) {
morehousec6ee8752018-07-17 16:12:00 +0000676 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000677 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), len2);
678}
679} // extern "C"