blob: 695eee2fa93e29ab2854f33068d7017e7e7bab8a [file] [log] [blame]
george.karpenkov29efa6d2017-08-21 23:25:50 +00001//===- FuzzerTracePC.cpp - PC tracing--------------------------------------===//
2//
chandlerc40284492019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
george.karpenkov29efa6d2017-08-21 23:25:50 +00006//
7//===----------------------------------------------------------------------===//
8// Trace PCs.
9// This module implements __sanitizer_cov_trace_pc_guard[_init],
10// the callback required for -fsanitize-coverage=trace-pc-guard instrumentation.
11//
12//===----------------------------------------------------------------------===//
13
14#include "FuzzerTracePC.h"
metzman40132972019-01-09 21:46:09 +000015#include "FuzzerBuiltins.h"
16#include "FuzzerBuiltinsMsvc.h"
george.karpenkov29efa6d2017-08-21 23:25:50 +000017#include "FuzzerCorpus.h"
18#include "FuzzerDefs.h"
19#include "FuzzerDictionary.h"
20#include "FuzzerExtFunctions.h"
21#include "FuzzerIO.h"
22#include "FuzzerUtil.h"
23#include "FuzzerValueBitMap.h"
24#include <set>
25
kcc0e871512019-01-29 23:41:50 +000026// The coverage counters and PCs.
27// These are declared as global variables named "__sancov_*" to simplify
28// experiments with inlined instrumentation.
29alignas(64) ATTRIBUTE_INTERFACE
30uint8_t __sancov_trace_pc_guard_8bit_counters[fuzzer::TracePC::kNumPCs];
31
32ATTRIBUTE_INTERFACE
33uintptr_t __sancov_trace_pc_pcs[fuzzer::TracePC::kNumPCs];
34
kcc1c0379f2017-08-22 01:28:32 +000035// Used by -fsanitize-coverage=stack-depth to track stack depth
morehouse68f46432018-08-30 15:54:44 +000036ATTRIBUTES_INTERFACE_TLS_INITIAL_EXEC 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
kcc0e871512019-01-29 23:41:50 +000042uint8_t *TracePC::Counters() const {
43 return __sancov_trace_pc_guard_8bit_counters;
44}
george.karpenkov29efa6d2017-08-21 23:25:50 +000045
kcc0e871512019-01-29 23:41:50 +000046uintptr_t *TracePC::PCs() const {
47 return __sancov_trace_pc_pcs;
48}
george.karpenkov29efa6d2017-08-21 23:25:50 +000049
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
60
61void TracePC::HandleInline8bitCountersInit(uint8_t *Start, uint8_t *Stop) {
62 if (Start == Stop) return;
63 if (NumModulesWithInline8bitCounters &&
64 ModuleCounters[NumModulesWithInline8bitCounters-1].Start == Start) return;
65 assert(NumModulesWithInline8bitCounters <
66 sizeof(ModuleCounters) / sizeof(ModuleCounters[0]));
67 ModuleCounters[NumModulesWithInline8bitCounters++] = {Start, Stop};
68 NumInline8bitCounters += Stop - Start;
69}
70
kcc98957a12017-08-25 19:29:47 +000071void TracePC::HandlePCsInit(const uintptr_t *Start, const uintptr_t *Stop) {
72 const PCTableEntry *B = reinterpret_cast<const PCTableEntry *>(Start);
73 const PCTableEntry *E = reinterpret_cast<const PCTableEntry *>(Stop);
george.karpenkov29efa6d2017-08-21 23:25:50 +000074 if (NumPCTables && ModulePCTable[NumPCTables - 1].Start == B) return;
75 assert(NumPCTables < sizeof(ModulePCTable) / sizeof(ModulePCTable[0]));
76 ModulePCTable[NumPCTables++] = {B, E};
77 NumPCsInPCTables += E - B;
78}
79
80void TracePC::HandleInit(uint32_t *Start, uint32_t *Stop) {
81 if (Start == Stop || *Start) return;
82 assert(NumModules < sizeof(Modules) / sizeof(Modules[0]));
83 for (uint32_t *P = Start; P < Stop; P++) {
84 NumGuards++;
85 if (NumGuards == kNumPCs) {
86 RawPrint(
87 "WARNING: The binary has too many instrumented PCs.\n"
88 " You may want to reduce the size of the binary\n"
89 " for more efficient fuzzing and precise coverage data\n");
90 }
91 *P = NumGuards % kNumPCs;
92 }
93 Modules[NumModules].Start = Start;
94 Modules[NumModules].Stop = Stop;
95 NumModules++;
96}
97
98void TracePC::PrintModuleInfo() {
kcc0e871512019-01-29 23:41:50 +000099 if (NumGuards) {
100 Printf("INFO: Loaded %zd modules (%zd guards): ", NumModules, NumGuards);
101 for (size_t i = 0; i < NumModules; i++)
102 Printf("%zd [%p, %p), ", Modules[i].Stop - Modules[i].Start,
103 Modules[i].Start, Modules[i].Stop);
104 Printf("\n");
105 }
george.karpenkov29efa6d2017-08-21 23:25:50 +0000106 if (NumModulesWithInline8bitCounters) {
107 Printf("INFO: Loaded %zd modules (%zd inline 8-bit counters): ",
108 NumModulesWithInline8bitCounters, NumInline8bitCounters);
109 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++)
110 Printf("%zd [%p, %p), ", ModuleCounters[i].Stop - ModuleCounters[i].Start,
111 ModuleCounters[i].Start, ModuleCounters[i].Stop);
112 Printf("\n");
113 }
114 if (NumPCTables) {
115 Printf("INFO: Loaded %zd PC tables (%zd PCs): ", NumPCTables,
116 NumPCsInPCTables);
117 for (size_t i = 0; i < NumPCTables; i++) {
118 Printf("%zd [%p,%p), ", ModulePCTable[i].Stop - ModulePCTable[i].Start,
119 ModulePCTable[i].Start, ModulePCTable[i].Stop);
120 }
121 Printf("\n");
122
kcc0e871512019-01-29 23:41:50 +0000123 if ((NumGuards && NumGuards != NumPCsInPCTables) ||
124 (NumInline8bitCounters && NumInline8bitCounters != NumPCsInPCTables)) {
kcce220ebb2017-10-14 00:07:11 +0000125 Printf("ERROR: The size of coverage PC tables does not match the\n"
126 "number of instrumented PCs. This might be a compiler bug,\n"
127 "please contact the libFuzzer developers.\n"
128 "Also check https://bugs.llvm.org/show_bug.cgi?id=34636\n"
129 "for possible workarounds (tl;dr: don't use the old GNU ld)\n");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000130 _Exit(1);
131 }
132 }
delcypherfcd19a82018-04-20 06:46:19 +0000133 if (size_t NumExtraCounters = ExtraCountersEnd() - ExtraCountersBegin())
134 Printf("INFO: %zd Extra Counters\n", NumExtraCounters);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000135}
136
137ATTRIBUTE_NO_SANITIZE_ALL
138void TracePC::HandleCallerCallee(uintptr_t Caller, uintptr_t Callee) {
139 const uintptr_t kBits = 12;
140 const uintptr_t kMask = (1 << kBits) - 1;
141 uintptr_t Idx = (Caller & kMask) | ((Callee & kMask) << kBits);
142 ValueProfileMap.AddValueModPrime(Idx);
143}
144
george.karpenkovdc8a8c72018-10-10 00:57:44 +0000145/// \return the address of the previous instruction.
146/// Note: the logic is copied from `sanitizer_common/sanitizer_stacktrace.h`
147inline ALWAYS_INLINE uintptr_t GetPreviousInstructionPc(uintptr_t PC) {
148#if defined(__arm__)
149 // T32 (Thumb) branch instructions might be 16 or 32 bit long,
150 // so we return (pc-2) in that case in order to be safe.
151 // For A32 mode we return (pc-4) because all instructions are 32 bit long.
152 return (PC - 3) & (~1);
153#elif defined(__powerpc__) || defined(__powerpc64__) || defined(__aarch64__)
154 // PCs are always 4 byte aligned.
155 return PC - 4;
156#elif defined(__sparc__) || defined(__mips__)
157 return PC - 8;
158#else
159 return PC - 1;
160#endif
161}
162
163/// \return the address of the next instruction.
164/// Note: the logic is copied from `sanitizer_common/sanitizer_stacktrace.cc`
165inline ALWAYS_INLINE uintptr_t GetNextInstructionPc(uintptr_t PC) {
166#if defined(__mips__)
167 return PC + 8;
168#elif defined(__powerpc__) || defined(__sparc__) || defined(__arm__) || \
169 defined(__aarch64__)
170 return PC + 4;
171#else
172 return PC + 1;
173#endif
174}
175
george.karpenkov29efa6d2017-08-21 23:25:50 +0000176void TracePC::UpdateObservedPCs() {
kccec9da662017-08-28 22:52:22 +0000177 Vector<uintptr_t> CoveredFuncs;
kcc00da6482017-08-25 20:09:25 +0000178 auto ObservePC = [&](uintptr_t PC) {
kcc09b3e5f2018-07-06 19:47:00 +0000179 if (ObservedPCs.insert(PC).second && DoPrintNewPCs) {
george.karpenkovdc8a8c72018-10-10 00:57:44 +0000180 PrintPC("\tNEW_PC: %p %F %L", "\tNEW_PC: %p", GetNextInstructionPc(PC));
kcc09b3e5f2018-07-06 19:47:00 +0000181 Printf("\n");
182 }
kcc1c0379f2017-08-22 01:28:32 +0000183 };
kcc00da6482017-08-25 20:09:25 +0000184
185 auto Observe = [&](const PCTableEntry &TE) {
186 if (TE.PCFlags & 1)
kccb3080d02018-07-19 22:00:48 +0000187 if (++ObservedFuncs[TE.PC] == 1 && NumPrintNewFuncs)
kccec9da662017-08-28 22:52:22 +0000188 CoveredFuncs.push_back(TE.PC);
kcc00da6482017-08-25 20:09:25 +0000189 ObservePC(TE.PC);
190 };
191
george.karpenkov29efa6d2017-08-21 23:25:50 +0000192 if (NumPCsInPCTables) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000193 if (NumInline8bitCounters == NumPCsInPCTables) {
metzmanb8a1ad52019-01-15 22:12:51 +0000194 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++) {
195 uint8_t *Beg = ModuleCounters[i].Start;
196 size_t Size = ModuleCounters[i].Stop - Beg;
197 assert(Size ==
198 (size_t)(ModulePCTable[i].Stop - ModulePCTable[i].Start));
199 for (size_t j = 0; j < Size; j++)
200 if (Beg[j])
201 Observe(ModulePCTable[i].Start[j]);
202 }
kcc0e871512019-01-29 23:41:50 +0000203 } else if (NumGuards == NumPCsInPCTables) {
204 size_t GuardIdx = 1;
205 for (size_t i = 0; i < NumModules; i++) {
206 uint32_t *Beg = Modules[i].Start;
207 size_t Size = Modules[i].Stop - Beg;
208 assert(Size ==
209 (size_t)(ModulePCTable[i].Stop - ModulePCTable[i].Start));
210 for (size_t j = 0; j < Size; j++, GuardIdx++)
211 if (Counters()[GuardIdx])
212 Observe(ModulePCTable[i].Start[j]);
213 }
george.karpenkov29efa6d2017-08-21 23:25:50 +0000214 }
215 }
kccec9da662017-08-28 22:52:22 +0000216
kccb3080d02018-07-19 22:00:48 +0000217 for (size_t i = 0, N = Min(CoveredFuncs.size(), NumPrintNewFuncs); i < N;
218 i++) {
kcc873dc112018-06-07 21:15:24 +0000219 Printf("\tNEW_FUNC[%zd/%zd]: ", i + 1, CoveredFuncs.size());
george.karpenkovdc8a8c72018-10-10 00:57:44 +0000220 PrintPC("%p %F %L", "%p", GetNextInstructionPc(CoveredFuncs[i]));
kcc09b3e5f2018-07-06 19:47:00 +0000221 Printf("\n");
kccec9da662017-08-28 22:52:22 +0000222 }
george.karpenkov29efa6d2017-08-21 23:25:50 +0000223}
224
george.karpenkov29efa6d2017-08-21 23:25:50 +0000225
226static std::string GetModuleName(uintptr_t PC) {
227 char ModulePathRaw[4096] = ""; // What's PATH_MAX in portable C++?
228 void *OffsetRaw = nullptr;
229 if (!EF->__sanitizer_get_module_and_offset_for_pc(
230 reinterpret_cast<void *>(PC), ModulePathRaw,
231 sizeof(ModulePathRaw), &OffsetRaw))
232 return "";
233 return ModulePathRaw;
234}
235
kcc85cad3d2018-05-11 01:17:52 +0000236template<class CallBack>
237void TracePC::IterateCoveredFunctions(CallBack CB) {
238 for (size_t i = 0; i < NumPCTables; i++) {
239 auto &M = ModulePCTable[i];
240 assert(M.Start < M.Stop);
241 auto ModuleName = GetModuleName(M.Start->PC);
242 for (auto NextFE = M.Start; NextFE < M.Stop; ) {
243 auto FE = NextFE;
244 assert((FE->PCFlags & 1) && "Not a function entry point");
245 do {
246 NextFE++;
247 } while (NextFE < M.Stop && !(NextFE->PCFlags & 1));
kccfb675a72019-01-26 01:33:09 +0000248 CB(FE, NextFE, ObservedFuncs[FE->PC]);
kcc85cad3d2018-05-11 01:17:52 +0000249 }
250 }
251}
252
kcc3acbe072018-05-16 23:26:37 +0000253void TracePC::SetFocusFunction(const std::string &FuncName) {
254 // This function should be called once.
255 assert(FocusFunction.first > NumModulesWithInline8bitCounters);
256 if (FuncName.empty())
257 return;
258 for (size_t M = 0; M < NumModulesWithInline8bitCounters; M++) {
259 auto &PCTE = ModulePCTable[M];
260 size_t N = PCTE.Stop - PCTE.Start;
261 for (size_t I = 0; I < N; I++) {
262 if (!(PCTE.Start[I].PCFlags & 1)) continue; // not a function entry.
263 auto Name = DescribePC("%F", GetNextInstructionPc(PCTE.Start[I].PC));
264 if (Name[0] == 'i' && Name[1] == 'n' && Name[2] == ' ')
265 Name = Name.substr(3, std::string::npos);
266 if (FuncName != Name) continue;
267 Printf("INFO: Focus function is set to '%s'\n", Name.c_str());
268 FocusFunction = {M, I};
269 return;
270 }
271 }
272}
273
274bool TracePC::ObservedFocusFunction() {
275 size_t I = FocusFunction.first;
276 size_t J = FocusFunction.second;
277 if (I >= NumModulesWithInline8bitCounters)
278 return false;
279 auto &MC = ModuleCounters[I];
280 size_t Size = MC.Stop - MC.Start;
281 if (J >= Size)
282 return false;
283 return MC.Start[J] != 0;
284}
285
george.karpenkov29efa6d2017-08-21 23:25:50 +0000286void TracePC::PrintCoverage() {
287 if (!EF->__sanitizer_symbolize_pc ||
288 !EF->__sanitizer_get_module_and_offset_for_pc) {
289 Printf("INFO: __sanitizer_symbolize_pc or "
290 "__sanitizer_get_module_and_offset_for_pc is not available,"
291 " not printing coverage\n");
292 return;
293 }
294 Printf("COVERAGE:\n");
kccb3080d02018-07-19 22:00:48 +0000295 auto CoveredFunctionCallback = [&](const PCTableEntry *First,
296 const PCTableEntry *Last,
297 uintptr_t Counter) {
kcc85cad3d2018-05-11 01:17:52 +0000298 assert(First < Last);
299 auto VisualizePC = GetNextInstructionPc(First->PC);
300 std::string FileStr = DescribePC("%s", VisualizePC);
kccb3080d02018-07-19 22:00:48 +0000301 if (!IsInterestingCoverageFile(FileStr))
302 return;
kcc85cad3d2018-05-11 01:17:52 +0000303 std::string FunctionStr = DescribePC("%F", VisualizePC);
kccb3080d02018-07-19 22:00:48 +0000304 if (FunctionStr.find("in ") == 0)
305 FunctionStr = FunctionStr.substr(3);
kcc85cad3d2018-05-11 01:17:52 +0000306 std::string LineStr = DescribePC("%l", VisualizePC);
307 size_t Line = std::stoul(LineStr);
kccb3080d02018-07-19 22:00:48 +0000308 size_t NumEdges = Last - First;
morehousef64b9402018-06-25 15:59:24 +0000309 Vector<uintptr_t> UncoveredPCs;
kcc85cad3d2018-05-11 01:17:52 +0000310 for (auto TE = First; TE < Last; TE++)
311 if (!ObservedPCs.count(TE->PC))
312 UncoveredPCs.push_back(TE->PC);
kccfb675a72019-01-26 01:33:09 +0000313 Printf("%sCOVERED_FUNC: hits: %zd", Counter ? "" : "UN", Counter);
kccb3080d02018-07-19 22:00:48 +0000314 Printf(" edges: %zd/%zd", NumEdges - UncoveredPCs.size(), NumEdges);
315 Printf(" %s %s:%zd\n", FunctionStr.c_str(), FileStr.c_str(), Line);
kccfb675a72019-01-26 01:33:09 +0000316 if (Counter)
317 for (auto PC : UncoveredPCs)
318 Printf(" UNCOVERED_PC: %s\n",
319 DescribePC("%s:%l", GetNextInstructionPc(PC)).c_str());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000320 };
321
kcc85cad3d2018-05-11 01:17:52 +0000322 IterateCoveredFunctions(CoveredFunctionCallback);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000323}
324
kcca7dd2a92018-05-21 19:47:00 +0000325void TracePC::DumpCoverage() {
326 if (EF->__sanitizer_dump_coverage) {
327 Vector<uintptr_t> PCsCopy(GetNumPCs());
328 for (size_t i = 0; i < GetNumPCs(); i++)
329 PCsCopy[i] = PCs()[i] ? GetPreviousInstructionPc(PCs()[i]) : 0;
330 EF->__sanitizer_dump_coverage(PCsCopy.data(), PCsCopy.size());
331 }
332}
333
george.karpenkov29efa6d2017-08-21 23:25:50 +0000334// Value profile.
335// We keep track of various values that affect control flow.
336// These values are inserted into a bit-set-based hash map.
337// Every new bit in the map is treated as a new coverage.
338//
339// For memcmp/strcmp/etc the interesting value is the length of the common
340// prefix of the parameters.
341// For cmp instructions the interesting value is a XOR of the parameters.
342// The interesting value is mixed up with the PC and is then added to the map.
343
344ATTRIBUTE_NO_SANITIZE_ALL
345void TracePC::AddValueForMemcmp(void *caller_pc, const void *s1, const void *s2,
346 size_t n, bool StopAtZero) {
347 if (!n) return;
348 size_t Len = std::min(n, Word::GetMaxSize());
349 const uint8_t *A1 = reinterpret_cast<const uint8_t *>(s1);
350 const uint8_t *A2 = reinterpret_cast<const uint8_t *>(s2);
351 uint8_t B1[Word::kMaxSize];
352 uint8_t B2[Word::kMaxSize];
353 // Copy the data into locals in this non-msan-instrumented function
354 // to avoid msan complaining further.
355 size_t Hash = 0; // Compute some simple hash of both strings.
356 for (size_t i = 0; i < Len; i++) {
357 B1[i] = A1[i];
358 B2[i] = A2[i];
359 size_t T = B1[i];
360 Hash ^= (T << 8) | B2[i];
361 }
362 size_t I = 0;
363 for (; I < Len; I++)
364 if (B1[I] != B2[I] || (StopAtZero && B1[I] == 0))
365 break;
366 size_t PC = reinterpret_cast<size_t>(caller_pc);
367 size_t Idx = (PC & 4095) | (I << 12);
368 ValueProfileMap.AddValue(Idx);
369 TORCW.Insert(Idx ^ Hash, Word(B1, Len), Word(B2, Len));
370}
371
372template <class T>
373ATTRIBUTE_TARGET_POPCNT ALWAYS_INLINE
374ATTRIBUTE_NO_SANITIZE_ALL
375void TracePC::HandleCmp(uintptr_t PC, T Arg1, T Arg2) {
376 uint64_t ArgXor = Arg1 ^ Arg2;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000377 if (sizeof(T) == 4)
dor1se6729cb2018-07-16 15:15:34 +0000378 TORC4.Insert(ArgXor, Arg1, Arg2);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000379 else if (sizeof(T) == 8)
dor1se6729cb2018-07-16 15:15:34 +0000380 TORC8.Insert(ArgXor, Arg1, Arg2);
metzman40132972019-01-09 21:46:09 +0000381 uint64_t HammingDistance = Popcountll(ArgXor); // [0,64]
382 uint64_t AbsoluteDistance = (Arg1 == Arg2 ? 0 : Clzll(Arg1 - Arg2) + 1);
kcc6d3b8e92018-08-02 00:24:49 +0000383 ValueProfileMap.AddValue(PC * 128 + HammingDistance);
384 ValueProfileMap.AddValue(PC * 128 + 64 + AbsoluteDistance);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000385}
386
387static size_t InternalStrnlen(const char *S, size_t MaxLen) {
388 size_t Len = 0;
389 for (; Len < MaxLen && S[Len]; Len++) {}
390 return Len;
391}
392
393// Finds min of (strlen(S1), strlen(S2)).
394// Needed bacause one of these strings may actually be non-zero terminated.
395static size_t InternalStrnlen2(const char *S1, const char *S2) {
396 size_t Len = 0;
397 for (; S1[Len] && S2[Len]; Len++) {}
398 return Len;
399}
400
401void TracePC::ClearInlineCounters() {
402 for (size_t i = 0; i < NumModulesWithInline8bitCounters; i++) {
403 uint8_t *Beg = ModuleCounters[i].Start;
404 size_t Size = ModuleCounters[i].Stop - Beg;
405 memset(Beg, 0, Size);
406 }
407}
408
kcc0f3c0312017-08-22 01:50:00 +0000409ATTRIBUTE_NO_SANITIZE_ALL
kcc1c0379f2017-08-22 01:28:32 +0000410void TracePC::RecordInitialStack() {
kcc0f3c0312017-08-22 01:50:00 +0000411 int stack;
412 __sancov_lowest_stack = InitialStack = reinterpret_cast<uintptr_t>(&stack);
kcc1c0379f2017-08-22 01:28:32 +0000413}
414
415uintptr_t TracePC::GetMaxStackOffset() const {
416 return InitialStack - __sancov_lowest_stack; // Stack grows down
417}
418
kcc02db23c2019-01-29 23:37:20 +0000419void WarnAboutDeprecatedInstrumentation(const char *flag) {
420 Printf("libFuzzer does not support %s any more.\n"
421 "Please either migrate to a compiler that supports -fsanitize=fuzzer\n"
422 "or use an older version of libFuzzer\n", flag);
423 exit(1);
424}
425
george.karpenkov29efa6d2017-08-21 23:25:50 +0000426} // namespace fuzzer
427
428extern "C" {
429ATTRIBUTE_INTERFACE
430ATTRIBUTE_NO_SANITIZE_ALL
431void __sanitizer_cov_trace_pc_guard(uint32_t *Guard) {
kcc02db23c2019-01-29 23:37:20 +0000432 fuzzer::WarnAboutDeprecatedInstrumentation("-fsanitize-coverage=trace-pc");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000433}
434
435// Best-effort support for -fsanitize-coverage=trace-pc, which is available
436// in both Clang and GCC.
437ATTRIBUTE_INTERFACE
438ATTRIBUTE_NO_SANITIZE_ALL
439void __sanitizer_cov_trace_pc() {
kcc02db23c2019-01-29 23:37:20 +0000440 fuzzer::WarnAboutDeprecatedInstrumentation(
441 "-fsanitize-coverage=trace-pc-guard");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000442}
443
444ATTRIBUTE_INTERFACE
445void __sanitizer_cov_trace_pc_guard_init(uint32_t *Start, uint32_t *Stop) {
kcc02db23c2019-01-29 23:37:20 +0000446 fuzzer::WarnAboutDeprecatedInstrumentation(
447 "-fsanitize-coverage=trace-pc-guard");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000448}
449
450ATTRIBUTE_INTERFACE
451void __sanitizer_cov_8bit_counters_init(uint8_t *Start, uint8_t *Stop) {
452 fuzzer::TPC.HandleInline8bitCountersInit(Start, Stop);
453}
454
455ATTRIBUTE_INTERFACE
kcc98957a12017-08-25 19:29:47 +0000456void __sanitizer_cov_pcs_init(const uintptr_t *pcs_beg,
457 const uintptr_t *pcs_end) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000458 fuzzer::TPC.HandlePCsInit(pcs_beg, pcs_end);
459}
460
461ATTRIBUTE_INTERFACE
462ATTRIBUTE_NO_SANITIZE_ALL
463void __sanitizer_cov_trace_pc_indir(uintptr_t Callee) {
metzman40132972019-01-09 21:46:09 +0000464 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000465 fuzzer::TPC.HandleCallerCallee(PC, Callee);
466}
467
468ATTRIBUTE_INTERFACE
469ATTRIBUTE_NO_SANITIZE_ALL
470ATTRIBUTE_TARGET_POPCNT
471void __sanitizer_cov_trace_cmp8(uint64_t Arg1, uint64_t Arg2) {
metzman40132972019-01-09 21:46:09 +0000472 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000473 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
474}
475
476ATTRIBUTE_INTERFACE
477ATTRIBUTE_NO_SANITIZE_ALL
478ATTRIBUTE_TARGET_POPCNT
479// Now the __sanitizer_cov_trace_const_cmp[1248] callbacks just mimic
480// the behaviour of __sanitizer_cov_trace_cmp[1248] ones. This, however,
481// should be changed later to make full use of instrumentation.
482void __sanitizer_cov_trace_const_cmp8(uint64_t Arg1, uint64_t Arg2) {
metzman40132972019-01-09 21:46:09 +0000483 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000484 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
485}
486
487ATTRIBUTE_INTERFACE
488ATTRIBUTE_NO_SANITIZE_ALL
489ATTRIBUTE_TARGET_POPCNT
490void __sanitizer_cov_trace_cmp4(uint32_t Arg1, uint32_t Arg2) {
metzman40132972019-01-09 21:46:09 +0000491 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000492 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
493}
494
495ATTRIBUTE_INTERFACE
496ATTRIBUTE_NO_SANITIZE_ALL
497ATTRIBUTE_TARGET_POPCNT
498void __sanitizer_cov_trace_const_cmp4(uint32_t Arg1, uint32_t Arg2) {
metzman40132972019-01-09 21:46:09 +0000499 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000500 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
501}
502
503ATTRIBUTE_INTERFACE
504ATTRIBUTE_NO_SANITIZE_ALL
505ATTRIBUTE_TARGET_POPCNT
506void __sanitizer_cov_trace_cmp2(uint16_t Arg1, uint16_t Arg2) {
metzman40132972019-01-09 21:46:09 +0000507 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000508 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
509}
510
511ATTRIBUTE_INTERFACE
512ATTRIBUTE_NO_SANITIZE_ALL
513ATTRIBUTE_TARGET_POPCNT
514void __sanitizer_cov_trace_const_cmp2(uint16_t Arg1, uint16_t Arg2) {
metzman40132972019-01-09 21:46:09 +0000515 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000516 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
517}
518
519ATTRIBUTE_INTERFACE
520ATTRIBUTE_NO_SANITIZE_ALL
521ATTRIBUTE_TARGET_POPCNT
522void __sanitizer_cov_trace_cmp1(uint8_t Arg1, uint8_t Arg2) {
metzman40132972019-01-09 21:46:09 +0000523 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000524 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
525}
526
527ATTRIBUTE_INTERFACE
528ATTRIBUTE_NO_SANITIZE_ALL
529ATTRIBUTE_TARGET_POPCNT
530void __sanitizer_cov_trace_const_cmp1(uint8_t Arg1, uint8_t Arg2) {
metzman40132972019-01-09 21:46:09 +0000531 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000532 fuzzer::TPC.HandleCmp(PC, Arg1, Arg2);
533}
534
535ATTRIBUTE_INTERFACE
536ATTRIBUTE_NO_SANITIZE_ALL
537ATTRIBUTE_TARGET_POPCNT
538void __sanitizer_cov_trace_switch(uint64_t Val, uint64_t *Cases) {
539 uint64_t N = Cases[0];
540 uint64_t ValSizeInBits = Cases[1];
541 uint64_t *Vals = Cases + 2;
kcc59c3be42019-01-24 21:08:54 +0000542 // Skip the most common and the most boring case: all switch values are small.
543 // We may want to skip this at compile-time, but it will make the
544 // instrumentation less general.
545 if (Vals[N - 1] < 256)
546 return;
547 // Also skip small inputs values, they won't give good signal.
548 if (Val < 256)
george.karpenkov29efa6d2017-08-21 23:25:50 +0000549 return;
metzman40132972019-01-09 21:46:09 +0000550 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000551 size_t i;
kcc59c3be42019-01-24 21:08:54 +0000552 uint64_t Smaller = 0;
553 uint64_t Larger = ~(uint64_t)0;
554 // Find two switch values such that Smaller < Val < Larger.
555 // Use 0 and 0xfff..f as the defaults.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000556 for (i = 0; i < N; i++) {
kcc59c3be42019-01-24 21:08:54 +0000557 if (Val < Vals[i]) {
558 Larger = Vals[i];
george.karpenkov29efa6d2017-08-21 23:25:50 +0000559 break;
kcc59c3be42019-01-24 21:08:54 +0000560 }
561 if (Val > Vals[i]) Smaller = Vals[i];
george.karpenkov29efa6d2017-08-21 23:25:50 +0000562 }
563
kcc59c3be42019-01-24 21:08:54 +0000564 // Apply HandleCmp to {Val,Smaller} and {Val, Larger},
565 // use i as the PC modifier for HandleCmp.
566 if (ValSizeInBits == 16) {
567 fuzzer::TPC.HandleCmp(PC + 2 * i, static_cast<uint16_t>(Val),
568 (uint16_t)(Smaller));
569 fuzzer::TPC.HandleCmp(PC + 2 * i + 1, static_cast<uint16_t>(Val),
570 (uint16_t)(Larger));
571 } else if (ValSizeInBits == 32) {
572 fuzzer::TPC.HandleCmp(PC + 2 * i, static_cast<uint32_t>(Val),
573 (uint32_t)(Smaller));
574 fuzzer::TPC.HandleCmp(PC + 2 * i + 1, static_cast<uint32_t>(Val),
575 (uint32_t)(Larger));
576 } else {
577 fuzzer::TPC.HandleCmp(PC + 2*i, Val, Smaller);
578 fuzzer::TPC.HandleCmp(PC + 2*i + 1, Val, Larger);
579 }
george.karpenkov29efa6d2017-08-21 23:25:50 +0000580}
581
582ATTRIBUTE_INTERFACE
583ATTRIBUTE_NO_SANITIZE_ALL
584ATTRIBUTE_TARGET_POPCNT
585void __sanitizer_cov_trace_div4(uint32_t Val) {
metzman40132972019-01-09 21:46:09 +0000586 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000587 fuzzer::TPC.HandleCmp(PC, Val, (uint32_t)0);
588}
589
590ATTRIBUTE_INTERFACE
591ATTRIBUTE_NO_SANITIZE_ALL
592ATTRIBUTE_TARGET_POPCNT
593void __sanitizer_cov_trace_div8(uint64_t Val) {
metzman40132972019-01-09 21:46:09 +0000594 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000595 fuzzer::TPC.HandleCmp(PC, Val, (uint64_t)0);
596}
597
598ATTRIBUTE_INTERFACE
599ATTRIBUTE_NO_SANITIZE_ALL
600ATTRIBUTE_TARGET_POPCNT
601void __sanitizer_cov_trace_gep(uintptr_t Idx) {
metzman40132972019-01-09 21:46:09 +0000602 uintptr_t PC = reinterpret_cast<uintptr_t>(GET_CALLER_PC());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000603 fuzzer::TPC.HandleCmp(PC, Idx, (uintptr_t)0);
604}
605
606ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
607void __sanitizer_weak_hook_memcmp(void *caller_pc, const void *s1,
608 const void *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000609 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000610 if (result == 0) return; // No reason to mutate.
611 if (n <= 1) return; // Not interesting.
612 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, n, /*StopAtZero*/false);
613}
614
615ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
616void __sanitizer_weak_hook_strncmp(void *caller_pc, const char *s1,
617 const char *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000618 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000619 if (result == 0) return; // No reason to mutate.
620 size_t Len1 = fuzzer::InternalStrnlen(s1, n);
621 size_t Len2 = fuzzer::InternalStrnlen(s2, n);
622 n = std::min(n, Len1);
623 n = std::min(n, Len2);
624 if (n <= 1) return; // Not interesting.
625 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, n, /*StopAtZero*/true);
626}
627
628ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
629void __sanitizer_weak_hook_strcmp(void *caller_pc, const char *s1,
dor1se6729cb2018-07-16 15:15:34 +0000630 const char *s2, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000631 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000632 if (result == 0) return; // No reason to mutate.
633 size_t N = fuzzer::InternalStrnlen2(s1, s2);
634 if (N <= 1) return; // Not interesting.
635 fuzzer::TPC.AddValueForMemcmp(caller_pc, s1, s2, N, /*StopAtZero*/true);
636}
637
638ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
639void __sanitizer_weak_hook_strncasecmp(void *called_pc, const char *s1,
640 const char *s2, size_t n, int result) {
morehousec6ee8752018-07-17 16:12:00 +0000641 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000642 return __sanitizer_weak_hook_strncmp(called_pc, s1, s2, n, result);
643}
644
645ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
646void __sanitizer_weak_hook_strcasecmp(void *called_pc, const char *s1,
647 const char *s2, 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_strcmp(called_pc, s1, s2, result);
650}
651
652ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
653void __sanitizer_weak_hook_strstr(void *called_pc, const char *s1,
654 const char *s2, char *result) {
morehousec6ee8752018-07-17 16:12:00 +0000655 if (!fuzzer::RunningUserCallback) return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000656 fuzzer::TPC.MMT.Add(reinterpret_cast<const uint8_t *>(s2), strlen(s2));
657}
658
659ATTRIBUTE_INTERFACE ATTRIBUTE_NO_SANITIZE_MEMORY
660void __sanitizer_weak_hook_strcasestr(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_memmem(void *called_pc, const void *s1, size_t len1,
668 const void *s2, size_t len2, void *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), len2);
671}
672} // extern "C"