1 //===- FuzzerInternal.h - Internal header for the Fuzzer --------*- C++ -* ===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
9 // Define the main class fuzzer::Fuzzer and most functions.
10 //===----------------------------------------------------------------------===//
18 #include <unordered_set>
20 #include "FuzzerInterface.h"
23 typedef std::vector<uint8_t> Unit;
24 using namespace std::chrono;
26 std::string FileToString(const std::string &Path);
27 Unit FileToVector(const std::string &Path);
28 void ReadDirToVectorOfUnits(const char *Path, std::vector<Unit> *V);
29 void WriteToFile(const Unit &U, const std::string &Path);
30 void CopyFileToErr(const std::string &Path);
31 // Returns "Dir/FileName" or equivalent for the current OS.
32 std::string DirPlusFile(const std::string &DirPath,
33 const std::string &FileName);
35 void Mutate(Unit *U, size_t MaxLen);
37 void CrossOver(const Unit &A, const Unit &B, Unit *U, size_t MaxLen);
39 void Print(const Unit &U, const char *PrintAfter = "");
40 void PrintASCII(const Unit &U, const char *PrintAfter = "");
41 std::string Hash(const Unit &U);
42 void SetTimer(int Seconds);
43 void PrintFileAsBase64(const std::string &Path);
47 struct FuzzingOptions {
50 bool DoCrossOver = true;
52 bool ExitOnFirst = false;
53 bool UseCounters = false;
54 bool UseFullCoverageSet = false;
55 bool UseCoveragePairs = false;
56 bool UseDFSan = false;
57 int PreferSmallDuringInitialShuffle = -1;
58 size_t MaxNumberOfRuns = ULONG_MAX;
59 std::string OutputCorpus;
60 std::vector<std::string> Tokens;
62 Fuzzer(UserCallback Callback, FuzzingOptions Options);
63 void AddToCorpus(const Unit &U) { Corpus.push_back(U); }
64 size_t Loop(size_t NumIterations);
65 void ShuffleAndMinimize();
66 void InitializeDFSan();
67 size_t CorpusSize() const { return Corpus.size(); }
68 void ReadDir(const std::string &Path) {
69 ReadDirToVectorOfUnits(Path.c_str(), &Corpus);
71 // Save the current corpus to OutputCorpus.
74 size_t secondsSinceProcessStartUp() {
75 return duration_cast<seconds>(system_clock::now() - ProcessStartTime)
79 size_t getTotalNumberOfRuns() { return TotalNumberOfRuns; }
81 static void StaticAlarmCallback();
83 Unit SubstituteTokens(const Unit &U) const;
87 void ExecuteCallback(const Unit &U);
88 size_t MutateAndTestOne(Unit *U);
89 size_t RunOne(const Unit &U);
90 size_t RunOneMaximizeTotalCoverage(const Unit &U);
91 size_t RunOneMaximizeFullCoverageSet(const Unit &U);
92 size_t RunOneMaximizeCoveragePairs(const Unit &U);
93 void WriteToOutputCorpus(const Unit &U);
94 void WriteToCrash(const Unit &U, const char *Prefix);
95 bool MutateWithDFSan(Unit *U);
96 void PrintStats(const char *Where, size_t Cov, const char *End = "\n");
97 void PrintUnitInASCIIOrTokens(const Unit &U, const char *PrintAfter = "");
99 void SetDeathCallback();
100 static void StaticDeathCallback();
101 void DeathCallback();
104 size_t TotalNumberOfRuns = 0;
106 std::vector<Unit> Corpus;
107 std::unordered_set<uintptr_t> FullCoverageSets;
108 std::unordered_set<uint64_t> CoveragePairs;
111 std::vector<uint8_t> CounterBitmap;
112 size_t TotalBits() { // Slow. Call it only for printing stats.
114 for (auto x : CounterBitmap) Res += __builtin_popcount(x);
118 UserCallback Callback;
119 FuzzingOptions Options;
120 system_clock::time_point ProcessStartTime = system_clock::now();
121 system_clock::time_point UnitStartTime;
122 long TimeOfLongestUnitInSeconds = 0;
125 }; // namespace fuzzer