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 // static
  20 Unit Fuzzer::CurrentUnit;
  21 system_clock::time_point Fuzzer::UnitStartTime;
  22
  23 void Fuzzer::SetDeathCallback() {
  24   __sanitizer_set_death_callback(DeathCallback);
  25 }
  26
  27 void Fuzzer::DeathCallback() {
  28   std::cerr << "DEATH: " <<  std::endl;
  29   Print(CurrentUnit, "\n");
  30   PrintASCII(CurrentUnit, "\n");
  31   WriteToCrash(CurrentUnit, "crash-");
  32 }
  33
  34 void Fuzzer::AlarmCallback() {
  35   size_t Seconds =
  36       duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
  37   std::cerr << "ALARM: working on the last Unit for " << Seconds << " seconds"
  38             << std::endl;
  39   if (Seconds >= 3) {
  40     Print(CurrentUnit, "\n");
  41     PrintASCII(CurrentUnit, "\n");
  42     WriteToCrash(CurrentUnit, "timeout-");
  43   }
  44   exit(1);
  45 }
  46
  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);
  51   std::cerr
  52       << "#" << TotalNumberOfRuns
  53       << "\t" << Where
  54       << " cov " << Cov
  55       << " bits " << TotalBits()
  56       << " units " << Corpus.size()
  57       << " exec/s " << ExecPerSec
  58       << End;
  59 }
  60
  61 void Fuzzer::ShuffleAndMinimize() {
  62   size_t MaxCov = 0;
  63   bool PreferSmall =
  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());
  71   if (PreferSmall)
  72     std::stable_sort(
  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++) {
  78       U.clear();
  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);
  82       if (NewCoverage) {
  83         MaxCov = NewCoverage;
  84         NewCorpus.push_back(U);
  85         if (Options.Verbosity >= 2)
  86           std::cerr << "NEW0: " << NewCoverage
  87                     << " L " << U.size()
  88                     << "\n";
  89       }
  90     }
  91   }
  92   Corpus = NewCorpus;
  93   PrintStats("INITED", MaxCov);
  94 }
  95
  96 size_t Fuzzer::RunOne(const Unit &U) {
  97   UnitStartTime = system_clock::now();
  98   TotalNumberOfRuns++;
  99   if (Options.UseFullCoverageSet)
 100     return RunOneMaximizeFullCoverageSet(U);
 101   if (Options.UseCoveragePairs)
 102     return RunOneMaximizeCoveragePairs(U);
 103   return RunOneMaximizeTotalCoverage(U);
 104 }
 105
 106 static uintptr_t HashOfArrayOfPCs(uintptr_t *PCs, uintptr_t NumPCs) {
 107   uintptr_t Res = 0;
 108   for (uintptr_t i = 0; i < NumPCs; i++) {
 109     Res = (Res + PCs[i]) * 7;
 110   }
 111   return Res;
 112 }
 113
 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());
 120   uintptr_t *PCs;
 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;
 129     }
 130   }
 131   if (HasNewPairs)
 132     return CoveragePairs.size();
 133   return 0;
 134 }
 135
 136 // Experimental.
 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());
 145   uintptr_t *PCs;
 146   uintptr_t NumPCs =__sanitizer_get_coverage_guards(&PCs);
 147   if (FullCoverageSets.insert(HashOfArrayOfPCs(PCs, NumPCs)).second)
 148     return FullCoverageSets.size();
 149   return 0;
 150 }
 151
 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);
 157   }
 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());
 165
 166   if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) && Options.Verbosity)
 167     PrintStats("pulse ", NewCoverage);
 168
 169   if (NewCoverage > OldCoverage || NumNewBits)
 170     return NewCoverage;
 171   return 0;
 172 }
 173
 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;
 180 }
 181
 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;
 186 }
 187
 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";
 195 }
 196
 197 size_t Fuzzer::MutateAndTestOne(Unit *U) {
 198   size_t NewUnits = 0;
 199   for (int i = 0; i < Options.MutateDepth; i++) {
 200     if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
 201       return NewUnits;
 202     MutateWithDFSan(U);
 203     Mutate(U, Options.MaxLen);
 204     size_t NewCoverage = RunOne(*U);
 205     if (NewCoverage) {
 206       Corpus.push_back(*U);
 207       NewUnits++;
 208       PrintStats("NEW   ", NewCoverage, "");
 209       if (Options.Verbosity) {
 210         std::cerr << " L: " << U->size();
 211         if (U->size() < 30) {
 212           std::cerr << " ";
 213           PrintASCII(*U);
 214           std::cerr << "\t";
 215           Print(*U);
 216         }
 217         std::cerr << "\n";
 218       }
 219       WriteToOutputCorpus(*U);
 220       if (Options.ExitOnFirst)
 221         exit(0);
 222     }
 223   }
 224   return NewUnits;
 225 }
 226
 227 size_t Fuzzer::Loop(size_t NumIterations) {
 228   size_t NewUnits = 0;
 229   for (size_t i = 1; i <= NumIterations; i++) {
 230     for (size_t J1 = 0; J1 < Corpus.size(); J1++) {
 231       if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
 232         return NewUnits;
 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++) {
 239           CurrentUnit.clear();
 240           CrossOver(Corpus[J1], Corpus[J2], &CurrentUnit, Options.MaxLen);
 241           NewUnits += MutateAndTestOne(&CurrentUnit);
 242         }
 243       }
 244     }
 245   }
 246   return NewUnits;
 247 }
 248
 249 }  // namespace fuzzer