lib/Fuzzer/FuzzerLoop.cpp

   1 //===- FuzzerLoop.cpp - Fuzzer's main loop --------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 // Fuzzer's main loop.
  10 //===----------------------------------------------------------------------===//
  11
  12 #include "FuzzerInternal.h"
  13 #include <sanitizer/coverage_interface.h>
  14 #include <algorithm>
  15 #include <iostream>
  16
  17 namespace fuzzer {
  18
  19 // Only one Fuzzer per process.
  20 static Fuzzer *F;
  21
  22 Fuzzer::Fuzzer(UserCallback Callback, FuzzingOptions Options)
  23     : Callback(Callback), Options(Options) {
  24   SetDeathCallback();
  25   InitializeDFSan();
  26   assert(!F);
  27   F = this;
  28 }
  29
  30 void Fuzzer::SetDeathCallback() {
  31   __sanitizer_set_death_callback(StaticDeathCallback);
  32 }
  33
  34 void Fuzzer::PrintUnitInASCIIOrTokens(const Unit &U, const char *PrintAfter) {
  35   if (Options.Tokens.empty()) {
  36     PrintASCII(U, PrintAfter);
  37   } else {
  38     auto T = SubstituteTokens(U);
  39     T.push_back(0);
  40     std::cerr << T.data();
  41     std::cerr << PrintAfter;
  42   }
  43 }
  44
  45 void Fuzzer::StaticDeathCallback() {
  46   assert(F);
  47   F->DeathCallback();
  48 }
  49
  50 void Fuzzer::DeathCallback() {
  51   std::cerr << "DEATH: " <<  std::endl;
  52   Print(CurrentUnit, "\n");
  53   PrintUnitInASCIIOrTokens(CurrentUnit, "\n");
  54   WriteToCrash(CurrentUnit, "crash-");
  55 }
  56
  57 void Fuzzer::StaticAlarmCallback() {
  58   assert(F);
  59   F->AlarmCallback();
  60 }
  61
  62 void Fuzzer::AlarmCallback() {
  63   size_t Seconds =
  64       duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
  65   std::cerr << "ALARM: working on the last Unit for " << Seconds << " seconds"
  66             << std::endl;
  67   if (Seconds >= 3) {
  68     Print(CurrentUnit, "\n");
  69     PrintUnitInASCIIOrTokens(CurrentUnit, "\n");
  70     WriteToCrash(CurrentUnit, "timeout-");
  71   }
  72   exit(1);
  73 }
  74
  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);
  79   std::cerr
  80       << "#" << TotalNumberOfRuns
  81       << "\t" << Where
  82       << " cov " << Cov
  83       << " bits " << TotalBits()
  84       << " units " << Corpus.size()
  85       << " exec/s " << ExecPerSec
  86       << End;
  87 }
  88
  89 void Fuzzer::ShuffleAndMinimize() {
  90   size_t MaxCov = 0;
  91   bool PreferSmall =
  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());
  99   if (PreferSmall)
 100     std::stable_sort(
 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++) {
 106       U.clear();
 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);
 110       if (NewCoverage) {
 111         MaxCov = NewCoverage;
 112         NewCorpus.push_back(U);
 113         if (Options.Verbosity >= 2)
 114           std::cerr << "NEW0: " << NewCoverage
 115                     << " L " << U.size()
 116                     << "\n";
 117       }
 118     }
 119   }
 120   Corpus = NewCorpus;
 121   PrintStats("INITED", MaxCov);
 122 }
 123
 124 size_t Fuzzer::RunOne(const Unit &U) {
 125   UnitStartTime = system_clock::now();
 126   TotalNumberOfRuns++;
 127   size_t Res = 0;
 128   if (Options.UseFullCoverageSet)
 129     Res = RunOneMaximizeFullCoverageSet(U);
 130   else if (Options.UseCoveragePairs)
 131     Res = RunOneMaximizeCoveragePairs(U);
 132   else
 133     Res = RunOneMaximizeTotalCoverage(U);
 134   auto UnitStopTime = system_clock::now();
 135   auto TimeOfUnit =
 136       duration_cast<seconds>(UnitStopTime - UnitStartTime).count();
 137   if (TimeOfUnit > TimeOfLongestUnitInSeconds) {
 138     TimeOfLongestUnitInSeconds = TimeOfUnit;
 139     std::cerr << "Longest unit: " << TimeOfLongestUnitInSeconds
 140               << " s:\n";
 141     Print(U, "\n");
 142   }
 143   return Res;
 144 }
 145
 146 void Fuzzer::RunOneAndUpdateCorpus(const Unit &U) {
 147   if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
 148     return;
 149   ReportNewCoverage(RunOne(U), U);
 150 }
 151
 152 static uintptr_t HashOfArrayOfPCs(uintptr_t *PCs, uintptr_t NumPCs) {
 153   uintptr_t Res = 0;
 154   for (uintptr_t i = 0; i < NumPCs; i++) {
 155     Res = (Res + PCs[i]) * 7;
 156   }
 157   return Res;
 158 }
 159
 160 Unit Fuzzer::SubstituteTokens(const Unit &U) const {
 161   Unit Res;
 162   for (auto Idx : U) {
 163     if (Idx < Options.Tokens.size()) {
 164       std::string Token = Options.Tokens[Idx];
 165       Res.insert(Res.end(), Token.begin(), Token.end());
 166     } else {
 167       Res.push_back(' ');
 168     }
 169   }
 170   // FIXME: Apply DFSan labels.
 171   return Res;
 172 }
 173
 174 void Fuzzer::ExecuteCallback(const Unit &U) {
 175   if (Options.Tokens.empty()) {
 176     Callback(U.data(), U.size());
 177   } else {
 178     auto T = SubstituteTokens(U);
 179     Callback(T.data(), T.size());
 180   }
 181 }
 182
 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();
 188   ExecuteCallback(U);
 189   uintptr_t *PCs;
 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;
 198     }
 199   }
 200   if (HasNewPairs)
 201     return CoveragePairs.size();
 202   return 0;
 203 }
 204
 205 // Experimental.
 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();
 213   ExecuteCallback(U);
 214   uintptr_t *PCs;
 215   uintptr_t NumPCs =__sanitizer_get_coverage_guards(&PCs);
 216   if (FullCoverageSets.insert(HashOfArrayOfPCs(PCs, NumPCs)).second)
 217     return FullCoverageSets.size();
 218   return 0;
 219 }
 220
 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);
 226   }
 227   size_t OldCoverage = __sanitizer_get_total_unique_coverage();
 228   ExecuteCallback(U);
 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());
 234
 235   if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) && Options.Verbosity)
 236     PrintStats("pulse ", NewCoverage);
 237
 238   if (NewCoverage > OldCoverage || NumNewBits)
 239     return NewCoverage;
 240   return 0;
 241 }
 242
 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;
 249 }
 250
 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);
 257 }
 258
 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";
 266 }
 267
 268 void Fuzzer::ReportNewCoverage(size_t NewCoverage, const Unit &U) {
 269   if (!NewCoverage) return;
 270   Corpus.push_back(U);
 271   PrintStats("NEW   ", NewCoverage, "");
 272   if (Options.Verbosity) {
 273     std::cerr << " L: " << U.size();
 274     if (U.size() < 30) {
 275       std::cerr << " ";
 276       PrintUnitInASCIIOrTokens(U, "\t");
 277       Print(U);
 278     }
 279     std::cerr << "\n";
 280   }
 281   WriteToOutputCorpus(U);
 282   if (Options.ExitOnFirst)
 283     exit(0);
 284 }
 285
 286 void Fuzzer::MutateAndTestOne(Unit *U) {
 287   for (int i = 0; i < Options.MutateDepth; i++) {
 288     MutateWithDFSan(U);
 289     Mutate(U, Options.MaxLen);
 290     RunOneAndUpdateCorpus(*U);
 291   }
 292 }
 293
 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)
 298         return;
 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++) {
 305           CurrentUnit.clear();
 306           CrossOver(Corpus[J1], Corpus[J2], &CurrentUnit, Options.MaxLen);
 307           MutateAndTestOne(&CurrentUnit);
 308         }
 309       }
 310     }
 311   }
 312 }
 313
 314 }  // namespace fuzzer