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_EraseByte(uint8_t *Data, size_t Size, size_t MaxSize,
37 FuzzerRandomBase &Rand);
38 size_t Mutate_InsertByte(uint8_t *Data, size_t Size, size_t MaxSize,
39 FuzzerRandomBase &Rand);
40 size_t Mutate_ChangeByte(uint8_t *Data, size_t Size, size_t MaxSize,
41 FuzzerRandomBase &Rand);
42 size_t Mutate_ChangeBit(uint8_t *Data, size_t Size, size_t MaxSize,
43 FuzzerRandomBase &Rand);
44 size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize,
45 FuzzerRandomBase &Rand);
47 size_t CrossOver(const uint8_t *Data1, size_t Size1, const uint8_t *Data2,
48 size_t Size2, uint8_t *Out, size_t MaxOutSize,
49 FuzzerRandomBase &Rand);
51 void Printf(const char *Fmt, ...);
52 void Print(const Unit &U, const char *PrintAfter = "");
53 void PrintASCII(const Unit &U, const char *PrintAfter = "");
54 std::string Hash(const Unit &U);
55 void SetTimer(int Seconds);
56 void PrintFileAsBase64(const std::string &Path);
57 void ExecuteCommand(const std::string &Command);
59 // Private copy of SHA1 implementation.
60 static const int kSHA1NumBytes = 20;
61 // Computes SHA1 hash of 'Len' bytes in 'Data', writes kSHA1NumBytes to 'Out'.
62 void ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out);
64 int NumberOfCpuCores();
68 struct FuzzingOptions {
71 int UnitTimeoutSec = 300;
72 bool DoCrossOver = true;
74 bool ExitOnFirst = false;
75 bool UseCounters = false;
76 bool UseTraces = false;
77 bool UseFullCoverageSet = false;
79 int PreferSmallDuringInitialShuffle = -1;
80 size_t MaxNumberOfRuns = ULONG_MAX;
81 int SyncTimeout = 600;
82 int ReportSlowUnits = 10;
83 std::string OutputCorpus;
84 std::string SyncCommand;
85 std::vector<std::string> Tokens;
87 Fuzzer(UserSuppliedFuzzer &USF, FuzzingOptions Options);
88 void AddToCorpus(const Unit &U) { Corpus.push_back(U); }
89 void Loop(size_t NumIterations);
90 void ShuffleAndMinimize();
91 void InitializeTraceState();
92 size_t CorpusSize() const { return Corpus.size(); }
93 void ReadDir(const std::string &Path, long *Epoch) {
94 ReadDirToVectorOfUnits(Path.c_str(), &Corpus, Epoch);
96 void RereadOutputCorpus();
97 // Save the current corpus to OutputCorpus.
100 size_t secondsSinceProcessStartUp() {
101 return duration_cast<seconds>(system_clock::now() - ProcessStartTime)
105 size_t getTotalNumberOfRuns() { return TotalNumberOfRuns; }
107 static void StaticAlarmCallback();
109 Unit SubstituteTokens(const Unit &U) const;
112 void AlarmCallback();
113 void ExecuteCallback(const Unit &U);
114 void MutateAndTestOne(Unit *U);
115 void ReportNewCoverage(size_t NewCoverage, const Unit &U);
116 size_t RunOne(const Unit &U);
117 void RunOneAndUpdateCorpus(const Unit &U);
118 size_t RunOneMaximizeTotalCoverage(const Unit &U);
119 size_t RunOneMaximizeFullCoverageSet(const Unit &U);
120 size_t RunOneMaximizeCoveragePairs(const Unit &U);
121 void WriteToOutputCorpus(const Unit &U);
122 void WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix);
123 void PrintStats(const char *Where, size_t Cov, const char *End = "\n");
124 void PrintUnitInASCIIOrTokens(const Unit &U, const char *PrintAfter = "");
128 // Trace-based fuzzing: we run a unit with some kind of tracing
129 // enabled and record potentially useful mutations. Then
130 // We apply these mutations one by one to the unit and run it again.
132 // Start tracing; forget all previously proposed mutations.
133 void StartTraceRecording();
134 // Stop tracing and return the number of proposed mutations.
135 size_t StopTraceRecording();
136 // Apply Idx-th trace-based mutation to U.
137 void ApplyTraceBasedMutation(size_t Idx, Unit *U);
139 void SetDeathCallback();
140 static void StaticDeathCallback();
141 void DeathCallback();
144 size_t TotalNumberOfRuns = 0;
146 std::vector<Unit> Corpus;
147 std::unordered_set<std::string> UnitHashesAddedToCorpus;
148 std::unordered_set<uintptr_t> FullCoverageSets;
151 std::vector<uint8_t> CounterBitmap;
152 size_t TotalBits() { // Slow. Call it only for printing stats.
154 for (auto x : CounterBitmap) Res += __builtin_popcount(x);
158 UserSuppliedFuzzer &USF;
159 FuzzingOptions Options;
160 system_clock::time_point ProcessStartTime = system_clock::now();
161 system_clock::time_point LastExternalSync = system_clock::now();
162 system_clock::time_point UnitStartTime;
163 long TimeOfLongestUnitInSeconds = 0;
164 long EpochOfLastReadOfOutputCorpus = 0;
167 class SimpleUserSuppliedFuzzer: public UserSuppliedFuzzer {
169 SimpleUserSuppliedFuzzer(FuzzerRandomBase *Rand, UserCallback Callback)
170 : UserSuppliedFuzzer(Rand), Callback(Callback) {}
171 virtual void TargetFunction(const uint8_t *Data, size_t Size) {
172 return Callback(Data, Size);
176 UserCallback Callback;
179 }; // namespace fuzzer