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,
30 void WriteToFile(const Unit &U, const std::string &Path);
31 void CopyFileToErr(const std::string &Path);
32 // Returns "Dir/FileName" or equivalent for the current OS.
33 std::string DirPlusFile(const std::string &DirPath,
34 const std::string &FileName);
36 size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize,
37 FuzzerRandomBase &Rand);
39 size_t CrossOver(const uint8_t *Data1, size_t Size1, const uint8_t *Data2,
40 size_t Size2, uint8_t *Out, size_t MaxOutSize,
41 FuzzerRandomBase &Rand);
43 void Printf(const char *Fmt, ...);
44 void Print(const Unit &U, const char *PrintAfter = "");
45 void PrintASCII(const Unit &U, const char *PrintAfter = "");
46 std::string Hash(const Unit &U);
47 void SetTimer(int Seconds);
48 void PrintFileAsBase64(const std::string &Path);
49 void ExecuteCommand(const std::string &Command);
51 // Private copy of SHA1 implementation.
52 static const int kSHA1NumBytes = 20;
53 // Computes SHA1 hash of 'Len' bytes in 'Data', writes kSHA1NumBytes to 'Out'.
54 void ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out);
56 int NumberOfCpuCores();
60 struct FuzzingOptions {
63 int UnitTimeoutSec = 300;
64 bool DoCrossOver = true;
66 bool ExitOnFirst = false;
67 bool UseCounters = false;
68 bool UseTraces = false;
69 bool UseFullCoverageSet = false;
71 int PreferSmallDuringInitialShuffle = -1;
72 size_t MaxNumberOfRuns = ULONG_MAX;
73 int SyncTimeout = 600;
74 std::string OutputCorpus;
75 std::string SyncCommand;
76 std::vector<std::string> Tokens;
78 Fuzzer(UserSuppliedFuzzer &USF, FuzzingOptions Options);
79 void AddToCorpus(const Unit &U) { Corpus.push_back(U); }
80 void Loop(size_t NumIterations);
81 void ShuffleAndMinimize();
82 void InitializeTraceState();
83 size_t CorpusSize() const { return Corpus.size(); }
84 void ReadDir(const std::string &Path, long *Epoch) {
85 ReadDirToVectorOfUnits(Path.c_str(), &Corpus, Epoch);
87 void RereadOutputCorpus();
88 // Save the current corpus to OutputCorpus.
91 size_t secondsSinceProcessStartUp() {
92 return duration_cast<seconds>(system_clock::now() - ProcessStartTime)
96 size_t getTotalNumberOfRuns() { return TotalNumberOfRuns; }
98 static void StaticAlarmCallback();
100 Unit SubstituteTokens(const Unit &U) const;
103 void AlarmCallback();
104 void ExecuteCallback(const Unit &U);
105 void MutateAndTestOne(Unit *U);
106 void ReportNewCoverage(size_t NewCoverage, const Unit &U);
107 size_t RunOne(const Unit &U);
108 void RunOneAndUpdateCorpus(const Unit &U);
109 size_t RunOneMaximizeTotalCoverage(const Unit &U);
110 size_t RunOneMaximizeFullCoverageSet(const Unit &U);
111 size_t RunOneMaximizeCoveragePairs(const Unit &U);
112 void WriteToOutputCorpus(const Unit &U);
113 void WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix);
114 void PrintStats(const char *Where, size_t Cov, const char *End = "\n");
115 void PrintUnitInASCIIOrTokens(const Unit &U, const char *PrintAfter = "");
119 // Trace-based fuzzing: we run a unit with some kind of tracing
120 // enabled and record potentially useful mutations. Then
121 // We apply these mutations one by one to the unit and run it again.
123 // Start tracing; forget all previously proposed mutations.
124 void StartTraceRecording();
125 // Stop tracing and return the number of proposed mutations.
126 size_t StopTraceRecording();
127 // Apply Idx-th trace-based mutation to U.
128 void ApplyTraceBasedMutation(size_t Idx, Unit *U);
130 void SetDeathCallback();
131 static void StaticDeathCallback();
132 void DeathCallback();
135 size_t TotalNumberOfRuns = 0;
137 std::vector<Unit> Corpus;
138 std::unordered_set<std::string> UnitHashesAddedToCorpus;
139 std::unordered_set<uintptr_t> FullCoverageSets;
142 std::vector<uint8_t> CounterBitmap;
143 size_t TotalBits() { // Slow. Call it only for printing stats.
145 for (auto x : CounterBitmap) Res += __builtin_popcount(x);
149 UserSuppliedFuzzer &USF;
150 FuzzingOptions Options;
151 system_clock::time_point ProcessStartTime = system_clock::now();
152 system_clock::time_point LastExternalSync = system_clock::now();
153 system_clock::time_point UnitStartTime;
154 long TimeOfLongestUnitInSeconds = 0;
155 long EpochOfLastReadOfOutputCorpus = 0;
158 class SimpleUserSuppliedFuzzer: public UserSuppliedFuzzer {
160 SimpleUserSuppliedFuzzer(FuzzerRandomBase *Rand, UserCallback Callback)
161 : UserSuppliedFuzzer(Rand), Callback(Callback) {}
162 virtual void TargetFunction(const uint8_t *Data, size_t Size) {
163 return Callback(Data, Size);
167 UserCallback Callback;
170 }; // namespace fuzzer