1 //===- FuzzerLoop.cpp - Fuzzer's main loop --------------------------------===//
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 //===----------------------------------------------------------------------===//
10 //===----------------------------------------------------------------------===//
12 #include "FuzzerInternal.h"
13 #include <sanitizer/coverage_interface.h>
19 // Only one Fuzzer per process.
22 Fuzzer::Fuzzer(UserCallback Callback, FuzzingOptions Options)
23 : Callback(Callback), Options(Options) {
30 void Fuzzer::SetDeathCallback() {
31 __sanitizer_set_death_callback(StaticDeathCallback);
34 void Fuzzer::PrintUnitInASCIIOrTokens(const Unit &U, const char *PrintAfter) {
35 if (Options.Tokens.empty()) {
36 PrintASCII(U, PrintAfter);
38 auto T = SubstituteTokens(U);
40 std::cerr << T.data();
41 std::cerr << PrintAfter;
45 void Fuzzer::StaticDeathCallback() {
50 void Fuzzer::DeathCallback() {
51 std::cerr << "DEATH: " << std::endl;
52 Print(CurrentUnit, "\n");
53 PrintUnitInASCIIOrTokens(CurrentUnit, "\n");
54 WriteToCrash(CurrentUnit, "crash-");
57 void Fuzzer::StaticAlarmCallback() {
62 void Fuzzer::AlarmCallback() {
64 duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
65 std::cerr << "ALARM: working on the last Unit for " << Seconds << " seconds"
68 Print(CurrentUnit, "\n");
69 PrintUnitInASCIIOrTokens(CurrentUnit, "\n");
70 WriteToCrash(CurrentUnit, "timeout-");
75 void Fuzzer::PrintStats(const char *Where, size_t Cov, const char *End) {
76 if (!Options.Verbosity) return;
77 size_t Seconds = secondsSinceProcessStartUp();
78 size_t ExecPerSec = (Seconds ? TotalNumberOfRuns / Seconds : 0);
80 << "#" << TotalNumberOfRuns
83 << " bits " << TotalBits()
84 << " units " << Corpus.size()
85 << " exec/s " << ExecPerSec
89 void Fuzzer::ShuffleAndMinimize() {
92 (Options.PreferSmallDuringInitialShuffle == 1 ||
93 (Options.PreferSmallDuringInitialShuffle == -1 && rand() % 2));
94 if (Options.Verbosity)
95 std::cerr << "PreferSmall: " << PreferSmall << "\n";
96 PrintStats("READ ", 0);
97 std::vector<Unit> NewCorpus;
98 std::random_shuffle(Corpus.begin(), Corpus.end());
101 Corpus.begin(), Corpus.end(),
102 [](const Unit &A, const Unit &B) { return A.size() < B.size(); });
103 Unit &U = CurrentUnit;
104 for (const auto &C : Corpus) {
105 for (size_t First = 0; First < 1; First++) {
107 size_t Last = std::min(First + Options.MaxLen, C.size());
108 U.insert(U.begin(), C.begin() + First, C.begin() + Last);
109 size_t NewCoverage = RunOne(U);
111 MaxCov = NewCoverage;
112 NewCorpus.push_back(U);
113 if (Options.Verbosity >= 2)
114 std::cerr << "NEW0: " << NewCoverage
121 PrintStats("INITED", MaxCov);
124 size_t Fuzzer::RunOne(const Unit &U) {
125 UnitStartTime = system_clock::now();
128 if (Options.UseFullCoverageSet)
129 Res = RunOneMaximizeFullCoverageSet(U);
130 else if (Options.UseCoveragePairs)
131 Res = RunOneMaximizeCoveragePairs(U);
133 Res = RunOneMaximizeTotalCoverage(U);
134 auto UnitStopTime = system_clock::now();
136 duration_cast<seconds>(UnitStopTime - UnitStartTime).count();
137 if (TimeOfUnit > TimeOfLongestUnitInSeconds) {
138 TimeOfLongestUnitInSeconds = TimeOfUnit;
139 std::cerr << "Longest unit: " << TimeOfLongestUnitInSeconds
146 void Fuzzer::RunOneAndUpdateCorpus(const Unit &U) {
147 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
149 ReportNewCoverage(RunOne(U), U);
152 static uintptr_t HashOfArrayOfPCs(uintptr_t *PCs, uintptr_t NumPCs) {
154 for (uintptr_t i = 0; i < NumPCs; i++) {
155 Res = (Res + PCs[i]) * 7;
160 Unit Fuzzer::SubstituteTokens(const Unit &U) const {
163 if (Idx < Options.Tokens.size()) {
164 std::string Token = Options.Tokens[Idx];
165 Res.insert(Res.end(), Token.begin(), Token.end());
170 // FIXME: Apply DFSan labels.
174 void Fuzzer::ExecuteCallback(const Unit &U) {
175 if (Options.Tokens.empty()) {
176 Callback(U.data(), U.size());
178 auto T = SubstituteTokens(U);
179 Callback(T.data(), T.size());
183 // Experimental. Does not yet scale.
184 // Fuly reset the current coverage state, run a single unit,
185 // collect all coverage pairs and return non-zero if a new pair is observed.
186 size_t Fuzzer::RunOneMaximizeCoveragePairs(const Unit &U) {
187 __sanitizer_reset_coverage();
190 uintptr_t NumPCs = __sanitizer_get_coverage_guards(&PCs);
191 bool HasNewPairs = false;
192 for (uintptr_t i = 0; i < NumPCs; i++) {
193 if (!PCs[i]) continue;
194 for (uintptr_t j = 0; j < NumPCs; j++) {
195 if (!PCs[j]) continue;
196 uint64_t Pair = (i << 32) | j;
197 HasNewPairs |= CoveragePairs.insert(Pair).second;
201 return CoveragePairs.size();
206 // Fuly reset the current coverage state, run a single unit,
207 // compute a hash function from the full coverage set,
208 // return non-zero if the hash value is new.
209 // This produces tons of new units and as is it's only suitable for small tests,
210 // e.g. test/FullCoverageSetTest.cpp. FIXME: make it scale.
211 size_t Fuzzer::RunOneMaximizeFullCoverageSet(const Unit &U) {
212 __sanitizer_reset_coverage();
215 uintptr_t NumPCs =__sanitizer_get_coverage_guards(&PCs);
216 if (FullCoverageSets.insert(HashOfArrayOfPCs(PCs, NumPCs)).second)
217 return FullCoverageSets.size();
221 size_t Fuzzer::RunOneMaximizeTotalCoverage(const Unit &U) {
222 size_t NumCounters = __sanitizer_get_number_of_counters();
223 if (Options.UseCounters) {
224 CounterBitmap.resize(NumCounters);
225 __sanitizer_update_counter_bitset_and_clear_counters(0);
227 size_t OldCoverage = __sanitizer_get_total_unique_coverage();
229 size_t NewCoverage = __sanitizer_get_total_unique_coverage();
230 size_t NumNewBits = 0;
231 if (Options.UseCounters)
232 NumNewBits = __sanitizer_update_counter_bitset_and_clear_counters(
233 CounterBitmap.data());
235 if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) && Options.Verbosity)
236 PrintStats("pulse ", NewCoverage);
238 if (NewCoverage > OldCoverage || NumNewBits)
243 void Fuzzer::WriteToOutputCorpus(const Unit &U) {
244 if (Options.OutputCorpus.empty()) return;
245 std::string Path = DirPlusFile(Options.OutputCorpus, Hash(U));
246 WriteToFile(U, Path);
247 if (Options.Verbosity >= 2)
248 std::cerr << "Written to " << Path << std::endl;
251 void Fuzzer::WriteToCrash(const Unit &U, const char *Prefix) {
252 std::string Path = Prefix + Hash(U);
253 WriteToFile(U, Path);
254 std::cerr << "CRASHED; file written to " << Path << std::endl;
255 std::cerr << "Base64: ";
256 PrintFileAsBase64(Path);
259 void Fuzzer::SaveCorpus() {
260 if (Options.OutputCorpus.empty()) return;
261 for (const auto &U : Corpus)
262 WriteToFile(U, DirPlusFile(Options.OutputCorpus, Hash(U)));
263 if (Options.Verbosity)
264 std::cerr << "Written corpus of " << Corpus.size() << " files to "
265 << Options.OutputCorpus << "\n";
268 void Fuzzer::ReportNewCoverage(size_t NewCoverage, const Unit &U) {
269 if (!NewCoverage) return;
271 PrintStats("NEW ", NewCoverage, "");
272 if (Options.Verbosity) {
273 std::cerr << " L: " << U.size();
276 PrintUnitInASCIIOrTokens(U, "\t");
281 WriteToOutputCorpus(U);
282 if (Options.ExitOnFirst)
286 void Fuzzer::MutateAndTestOne(Unit *U) {
287 for (int i = 0; i < Options.MutateDepth; i++) {
289 Mutate(U, Options.MaxLen);
290 RunOneAndUpdateCorpus(*U);
294 void Fuzzer::Loop(size_t NumIterations) {
295 for (size_t i = 1; i <= NumIterations; i++) {
296 for (size_t J1 = 0; J1 < Corpus.size(); J1++) {
297 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
299 // First, simply mutate the unit w/o doing crosses.
300 CurrentUnit = Corpus[J1];
301 MutateAndTestOne(&CurrentUnit);
302 // Now, cross with others.
303 if (Options.DoCrossOver) {
304 for (size_t J2 = 0; J2 < Corpus.size(); J2++) {
306 CrossOver(Corpus[J1], Corpus[J2], &CurrentUnit, Options.MaxLen);
307 MutateAndTestOne(&CurrentUnit);
314 } // namespace fuzzer