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>
20 Unit Fuzzer::CurrentUnit;
21 system_clock::time_point Fuzzer::UnitStartTime;
23 void Fuzzer::SetDeathCallback() {
24 __sanitizer_set_death_callback(DeathCallback);
27 void Fuzzer::DeathCallback() {
28 std::cerr << "DEATH: " << std::endl;
29 Print(CurrentUnit, "\n");
30 PrintASCII(CurrentUnit, "\n");
31 WriteToCrash(CurrentUnit, "crash-");
34 void Fuzzer::AlarmCallback() {
36 duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
37 std::cerr << "ALARM: working on the last Unit for " << Seconds << " seconds"
40 Print(CurrentUnit, "\n");
41 PrintASCII(CurrentUnit, "\n");
42 WriteToCrash(CurrentUnit, "timeout-");
47 void Fuzzer::PrintStats(const char *Where, size_t Cov, const char *End) {
48 if (!Options.Verbosity) return;
49 size_t Seconds = secondsSinceProcessStartUp();
50 size_t ExecPerSec = (Seconds ? TotalNumberOfRuns / Seconds : 0);
52 << "#" << TotalNumberOfRuns
55 << " bits " << TotalBits()
56 << " units " << Corpus.size()
57 << " exec/s " << ExecPerSec
61 void Fuzzer::ShuffleAndMinimize() {
64 (Options.PreferSmallDuringInitialShuffle == 1 ||
65 (Options.PreferSmallDuringInitialShuffle == -1 && rand() % 2));
66 if (Options.Verbosity)
67 std::cerr << "PreferSmall: " << PreferSmall << "\n";
68 PrintStats("READ ", 0);
69 std::vector<Unit> NewCorpus;
70 std::random_shuffle(Corpus.begin(), Corpus.end());
73 Corpus.begin(), Corpus.end(),
74 [](const Unit &A, const Unit &B) { return A.size() < B.size(); });
75 Unit &U = CurrentUnit;
76 for (const auto &C : Corpus) {
77 for (size_t First = 0; First < 1; First++) {
79 size_t Last = std::min(First + Options.MaxLen, C.size());
80 U.insert(U.begin(), C.begin() + First, C.begin() + Last);
81 size_t NewCoverage = RunOne(U);
84 NewCorpus.push_back(U);
85 if (Options.Verbosity >= 2)
86 std::cerr << "NEW0: " << NewCoverage
93 PrintStats("INITED", MaxCov);
96 size_t Fuzzer::RunOne(const Unit &U) {
97 UnitStartTime = system_clock::now();
99 if (Options.UseFullCoverageSet)
100 return RunOneMaximizeFullCoverageSet(U);
101 if (Options.UseCoveragePairs)
102 return RunOneMaximizeCoveragePairs(U);
103 return RunOneMaximizeTotalCoverage(U);
106 static uintptr_t HashOfArrayOfPCs(uintptr_t *PCs, uintptr_t NumPCs) {
108 for (uintptr_t i = 0; i < NumPCs; i++) {
109 Res = (Res + PCs[i]) * 7;
114 // Experimental. Does not yet scale.
115 // Fuly reset the current coverage state, run a single unit,
116 // collect all coverage pairs and return non-zero if a new pair is observed.
117 size_t Fuzzer::RunOneMaximizeCoveragePairs(const Unit &U) {
118 __sanitizer_reset_coverage();
119 Callback(U.data(), U.size());
121 uintptr_t NumPCs = __sanitizer_get_coverage_guards(&PCs);
122 bool HasNewPairs = false;
123 for (uintptr_t i = 0; i < NumPCs; i++) {
124 if (!PCs[i]) continue;
125 for (uintptr_t j = 0; j < NumPCs; j++) {
126 if (!PCs[j]) continue;
127 uint64_t Pair = (i << 32) | j;
128 HasNewPairs |= CoveragePairs.insert(Pair).second;
132 return CoveragePairs.size();
137 // Fuly reset the current coverage state, run a single unit,
138 // compute a hash function from the full coverage set,
139 // return non-zero if the hash value is new.
140 // This produces tons of new units and as is it's only suitable for small tests,
141 // e.g. test/FullCoverageSetTest.cpp. FIXME: make it scale.
142 size_t Fuzzer::RunOneMaximizeFullCoverageSet(const Unit &U) {
143 __sanitizer_reset_coverage();
144 Callback(U.data(), U.size());
146 uintptr_t NumPCs =__sanitizer_get_coverage_guards(&PCs);
147 if (FullCoverageSets.insert(HashOfArrayOfPCs(PCs, NumPCs)).second)
148 return FullCoverageSets.size();
152 size_t Fuzzer::RunOneMaximizeTotalCoverage(const Unit &U) {
153 size_t NumCounters = __sanitizer_get_number_of_counters();
154 if (Options.UseCounters) {
155 CounterBitmap.resize(NumCounters);
156 __sanitizer_update_counter_bitset_and_clear_counters(0);
158 size_t OldCoverage = __sanitizer_get_total_unique_coverage();
159 Callback(U.data(), U.size());
160 size_t NewCoverage = __sanitizer_get_total_unique_coverage();
161 size_t NumNewBits = 0;
162 if (Options.UseCounters)
163 NumNewBits = __sanitizer_update_counter_bitset_and_clear_counters(
164 CounterBitmap.data());
166 if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) && Options.Verbosity)
167 PrintStats("pulse ", NewCoverage);
169 if (NewCoverage > OldCoverage || NumNewBits)
174 void Fuzzer::WriteToOutputCorpus(const Unit &U) {
175 if (Options.OutputCorpus.empty()) return;
176 std::string Path = DirPlusFile(Options.OutputCorpus, Hash(U));
177 WriteToFile(U, Path);
178 if (Options.Verbosity >= 2)
179 std::cerr << "Written to " << Path << std::endl;
182 void Fuzzer::WriteToCrash(const Unit &U, const char *Prefix) {
183 std::string Path = Prefix + Hash(U);
184 WriteToFile(U, Path);
185 std::cerr << "CRASHED; file written to " << Path << std::endl;
188 void Fuzzer::SaveCorpus() {
189 if (Options.OutputCorpus.empty()) return;
190 for (const auto &U : Corpus)
191 WriteToFile(U, DirPlusFile(Options.OutputCorpus, Hash(U)));
192 if (Options.Verbosity)
193 std::cerr << "Written corpus of " << Corpus.size() << " files to "
194 << Options.OutputCorpus << "\n";
197 size_t Fuzzer::MutateAndTestOne(Unit *U) {
199 for (int i = 0; i < Options.MutateDepth; i++) {
200 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
203 Mutate(U, Options.MaxLen);
204 size_t NewCoverage = RunOne(*U);
206 Corpus.push_back(*U);
208 PrintStats("NEW ", NewCoverage, "");
209 if (Options.Verbosity) {
210 std::cerr << " L: " << U->size();
211 if (U->size() < 30) {
219 WriteToOutputCorpus(*U);
220 if (Options.ExitOnFirst)
227 size_t Fuzzer::Loop(size_t NumIterations) {
229 for (size_t i = 1; i <= NumIterations; i++) {
230 for (size_t J1 = 0; J1 < Corpus.size(); J1++) {
231 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
233 // First, simply mutate the unit w/o doing crosses.
234 CurrentUnit = Corpus[J1];
235 NewUnits += MutateAndTestOne(&CurrentUnit);
236 // Now, cross with others.
237 if (Options.DoCrossOver) {
238 for (size_t J2 = 0; J2 < Corpus.size(); J2++) {
240 CrossOver(Corpus[J1], Corpus[J2], &CurrentUnit, Options.MaxLen);
241 NewUnits += MutateAndTestOne(&CurrentUnit);
249 } // namespace fuzzer