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 //===----------------------------------------------------------------------===//
12 #ifndef LLVM_FUZZER_INTERNAL_H
13 #define LLVM_FUZZER_INTERNAL_H
22 #include <unordered_set>
24 #include "FuzzerInterface.h"
27 typedef std::vector<uint8_t> Unit;
28 using namespace std::chrono;
30 std::string FileToString(const std::string &Path);
31 Unit FileToVector(const std::string &Path);
32 void ReadDirToVectorOfUnits(const char *Path, std::vector<Unit> *V,
34 void WriteToFile(const Unit &U, const std::string &Path);
35 void CopyFileToErr(const std::string &Path);
36 // Returns "Dir/FileName" or equivalent for the current OS.
37 std::string DirPlusFile(const std::string &DirPath,
38 const std::string &FileName);
40 void Printf(const char *Fmt, ...);
41 void Print(const Unit &U, const char *PrintAfter = "");
42 void PrintASCII(const Unit &U, const char *PrintAfter = "");
43 std::string Hash(const Unit &U);
44 void SetTimer(int Seconds);
45 void PrintFileAsBase64(const std::string &Path);
46 void ExecuteCommand(const std::string &Command);
48 // Private copy of SHA1 implementation.
49 static const int kSHA1NumBytes = 20;
50 // Computes SHA1 hash of 'Len' bytes in 'Data', writes kSHA1NumBytes to 'Out'.
51 void ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out);
53 // Changes U to contain only ASCII (isprint+isspace) characters.
54 // Returns true iff U has been changed.
55 bool ToASCII(Unit &U);
56 bool IsASCII(const Unit &U);
58 int NumberOfCpuCores();
62 // Parses one dictionary entry.
63 // If successfull, write the enty to Unit and returns true,
64 // otherwise returns false.
65 bool ParseOneDictionaryEntry(const std::string &Str, Unit *U);
66 // Parses the dictionary file, fills Units, returns true iff all lines
67 // were parsed succesfully.
68 bool ParseDictionaryFile(const std::string &Text, std::vector<Unit> *Units);
72 struct FuzzingOptions {
75 int UnitTimeoutSec = 300;
76 int MaxTotalTimeSec = 0;
77 bool DoCrossOver = true;
79 bool ExitOnFirst = false;
80 bool UseCounters = false;
81 bool UseTraces = false;
82 bool UseFullCoverageSet = false;
84 int PreferSmallDuringInitialShuffle = -1;
85 size_t MaxNumberOfRuns = ULONG_MAX;
86 int SyncTimeout = 600;
87 int ReportSlowUnits = 10;
88 bool OnlyASCII = false;
91 std::string OutputCorpus;
92 std::string SyncCommand;
93 std::string ArtifactPrefix = "./";
94 std::vector<std::string> Tokens;
95 std::vector<Unit> Dictionary;
96 bool SaveArtifacts = true;
98 Fuzzer(UserSuppliedFuzzer &USF, FuzzingOptions Options);
99 void AddToCorpus(const Unit &U) { Corpus.push_back(U); }
101 void ShuffleAndMinimize();
102 void InitializeTraceState();
103 size_t CorpusSize() const { return Corpus.size(); }
104 void ReadDir(const std::string &Path, long *Epoch) {
105 ReadDirToVectorOfUnits(Path.c_str(), &Corpus, Epoch);
107 void RereadOutputCorpus();
108 // Save the current corpus to OutputCorpus.
111 size_t secondsSinceProcessStartUp() {
112 return duration_cast<seconds>(system_clock::now() - ProcessStartTime)
116 size_t getTotalNumberOfRuns() { return TotalNumberOfRuns; }
118 static void StaticAlarmCallback();
120 Unit SubstituteTokens(const Unit &U) const;
121 void ExecuteCallback(const Unit &U);
124 void AlarmCallback();
125 void MutateAndTestOne(Unit *U);
126 void ReportNewCoverage(size_t NewCoverage, const Unit &U);
127 size_t RunOne(const Unit &U);
128 void RunOneAndUpdateCorpus(Unit &U);
129 size_t RunOneMaximizeTotalCoverage(const Unit &U);
130 size_t RunOneMaximizeCoveragePairs(const Unit &U);
131 void WriteToOutputCorpus(const Unit &U);
132 void WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix);
133 void PrintStats(const char *Where, size_t Cov, const char *End = "\n");
134 void PrintUnitInASCIIOrTokens(const Unit &U, const char *PrintAfter = "");
138 // Trace-based fuzzing: we run a unit with some kind of tracing
139 // enabled and record potentially useful mutations. Then
140 // We apply these mutations one by one to the unit and run it again.
142 // Start tracing; forget all previously proposed mutations.
143 void StartTraceRecording();
144 // Stop tracing and return the number of proposed mutations.
145 size_t StopTraceRecording();
146 // Apply Idx-th trace-based mutation to U.
147 void ApplyTraceBasedMutation(size_t Idx, Unit *U);
149 void SetDeathCallback();
150 static void StaticDeathCallback();
151 void DeathCallback();
154 size_t TotalNumberOfRuns = 0;
155 size_t TotalNumberOfExecutedTraceBasedMutations = 0;
157 std::vector<Unit> Corpus;
158 std::unordered_set<std::string> UnitHashesAddedToCorpus;
161 std::vector<uint8_t> CounterBitmap;
162 size_t TotalBits() { // Slow. Call it only for printing stats.
164 for (auto x : CounterBitmap) Res += __builtin_popcount(x);
168 UserSuppliedFuzzer &USF;
169 FuzzingOptions Options;
170 system_clock::time_point ProcessStartTime = system_clock::now();
171 system_clock::time_point LastExternalSync = system_clock::now();
172 system_clock::time_point UnitStartTime;
173 long TimeOfLongestUnitInSeconds = 0;
174 long EpochOfLastReadOfOutputCorpus = 0;
177 class SimpleUserSuppliedFuzzer: public UserSuppliedFuzzer {
179 SimpleUserSuppliedFuzzer(FuzzerRandomBase *Rand, UserCallback Callback)
180 : UserSuppliedFuzzer(Rand), Callback(Callback) {}
182 SimpleUserSuppliedFuzzer(FuzzerRandomBase *Rand, DeprecatedUserCallback Callback)
183 : UserSuppliedFuzzer(Rand), DeprecatedCallback(Callback) {}
185 virtual int TargetFunction(const uint8_t *Data, size_t Size) override {
186 if (Callback) return Callback(Data, Size);
187 DeprecatedCallback(Data, Size);
192 DeprecatedUserCallback DeprecatedCallback = nullptr;
193 UserCallback Callback = nullptr;
196 }; // namespace fuzzer
198 #endif // LLVM_FUZZER_INTERNAL_H