lib/Fuzzer/FuzzerInternal.h

   1 //===- FuzzerInternal.h - Internal header for the Fuzzer --------*- C++ -* ===//
   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 // Define the main class fuzzer::Fuzzer and most functions.
  10 //===----------------------------------------------------------------------===//
  11 #include <cassert>
  12 #include <climits>
  13 #include <chrono>
  14 #include <cstddef>
  15 #include <cstdlib>
  16 #include <string>
  17 #include <vector>
  18 #include <unordered_set>
  19
  20 #include "FuzzerInterface.h"
  21
  22 namespace fuzzer {
  23 typedef std::vector<uint8_t> Unit;
  24 using namespace std::chrono;
  25
  26 Unit ReadFile(const char *Path);
  27 void ReadDirToVectorOfUnits(const char *Path, std::vector<Unit> *V);
  28 void WriteToFile(const Unit &U, const std::string &Path);
  29 void CopyFileToErr(const std::string &Path);
  30 // Returns "Dir/FileName" or equivalent for the current OS.
  31 std::string DirPlusFile(const std::string &DirPath,
  32                         const std::string &FileName);
  33
  34 void Mutate(Unit *U, size_t MaxLen);
  35
  36 void CrossOver(const Unit &A, const Unit &B, Unit *U, size_t MaxLen);
  37
  38 void Print(const Unit &U, const char *PrintAfter = "");
  39 void PrintASCII(const Unit &U, const char *PrintAfter = "");
  40 std::string Hash(const Unit &U);
  41 void SetTimer(int Seconds);
  42
  43 class Fuzzer {
  44  public:
  45   struct FuzzingOptions {
  46     int Verbosity = 1;
  47     int MaxLen = 0;
  48     bool DoCrossOver = true;
  49     int  MutateDepth = 5;
  50     bool ExitOnFirst = false;
  51     bool UseCounters = false;
  52     bool UseFullCoverageSet  = false;
  53     bool UseCoveragePairs = false;
  54     bool UseDFSan = false;
  55     int PreferSmallDuringInitialShuffle = -1;
  56     size_t MaxNumberOfRuns = ULONG_MAX;
  57     std::string OutputCorpus;
  58   };
  59   Fuzzer(UserCallback Callback, FuzzingOptions Options)
  60       : Callback(Callback), Options(Options) {
  61     SetDeathCallback();
  62     InitializeDFSan();
  63   }
  64   void AddToCorpus(const Unit &U) { Corpus.push_back(U); }
  65   size_t Loop(size_t NumIterations);
  66   void ShuffleAndMinimize();
  67   void InitializeDFSan();
  68   size_t CorpusSize() const { return Corpus.size(); }
  69   void ReadDir(const std::string &Path) {
  70     ReadDirToVectorOfUnits(Path.c_str(), &Corpus);
  71   }
  72   // Save the current corpus to OutputCorpus.
  73   void SaveCorpus();
  74
  75   size_t secondsSinceProcessStartUp() {
  76     return duration_cast<seconds>(system_clock::now() - ProcessStartTime)
  77         .count();
  78   }
  79
  80   size_t getTotalNumberOfRuns() { return TotalNumberOfRuns; }
  81
  82   static void AlarmCallback();
  83
  84  private:
  85   size_t MutateAndTestOne(Unit *U);
  86   size_t RunOne(const Unit &U);
  87   size_t RunOneMaximizeTotalCoverage(const Unit &U);
  88   size_t RunOneMaximizeFullCoverageSet(const Unit &U);
  89   size_t RunOneMaximizeCoveragePairs(const Unit &U);
  90   void WriteToOutputCorpus(const Unit &U);
  91   static void WriteToCrash(const Unit &U, const char *Prefix);
  92   bool MutateWithDFSan(Unit *U);
  93   void PrintStats(const char *Where, size_t Cov, const char *End = "\n");
  94
  95   void SetDeathCallback();
  96   static void DeathCallback();
  97   static Unit CurrentUnit;
  98
  99   size_t TotalNumberOfRuns = 0;
 100
 101   std::vector<Unit> Corpus;
 102   std::unordered_set<uintptr_t> FullCoverageSets;
 103   std::unordered_set<uint64_t>  CoveragePairs;
 104
 105   // For UseCounters
 106   std::vector<uint8_t> CounterBitmap;
 107   size_t TotalBits() {  // Slow. Call it only for printing stats.
 108     size_t Res = 0;
 109     for (auto x : CounterBitmap) Res += __builtin_popcount(x);
 110     return Res;
 111   }
 112
 113   UserCallback Callback;
 114   FuzzingOptions Options;
 115   system_clock::time_point ProcessStartTime = system_clock::now();
 116   static system_clock::time_point UnitStartTime;
 117 };
 118
 119 };  // namespace fuzzer