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 std::string FileToString(const std::string &Path);
  27 Unit FileToVector(const std::string &Path);
  28 void ReadDirToVectorOfUnits(const char *Path, std::vector<Unit> *V,
  29                             long *Epoch);
  30 void WriteToFile(const Unit &U, const std::string &Path);
  31 void CopyFileToErr(const std::string &Path);
  32 // Returns "Dir/FileName" or equivalent for the current OS.
  33 std::string DirPlusFile(const std::string &DirPath,
  34                         const std::string &FileName);
  35
  36 size_t Mutate_EraseByte(uint8_t *Data, size_t size, size_t MaxSize,
  37                         FuzzerRandomBase &Rand);
  38 size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize,
  39               FuzzerRandomBase &Rand);
  40
  41 size_t CrossOver(const uint8_t *Data1, size_t Size1, const uint8_t *Data2,
  42                  size_t Size2, uint8_t *Out, size_t MaxOutSize,
  43                  FuzzerRandomBase &Rand);
  44
  45 void Printf(const char *Fmt, ...);
  46 void Print(const Unit &U, const char *PrintAfter = "");
  47 void PrintASCII(const Unit &U, const char *PrintAfter = "");
  48 std::string Hash(const Unit &U);
  49 void SetTimer(int Seconds);
  50 void PrintFileAsBase64(const std::string &Path);
  51 void ExecuteCommand(const std::string &Command);
  52
  53 // Private copy of SHA1 implementation.
  54 static const int kSHA1NumBytes = 20;
  55 // Computes SHA1 hash of 'Len' bytes in 'Data', writes kSHA1NumBytes to 'Out'.
  56 void ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out);
  57
  58 int NumberOfCpuCores();
  59
  60 class Fuzzer {
  61  public:
  62   struct FuzzingOptions {
  63     int Verbosity = 1;
  64     int MaxLen = 0;
  65     int UnitTimeoutSec = 300;
  66     bool DoCrossOver = true;
  67     int  MutateDepth = 5;
  68     bool ExitOnFirst = false;
  69     bool UseCounters = false;
  70     bool UseTraces = false;
  71     bool UseFullCoverageSet  = false;
  72     bool Reload = true;
  73     int PreferSmallDuringInitialShuffle = -1;
  74     size_t MaxNumberOfRuns = ULONG_MAX;
  75     int SyncTimeout = 600;
  76     std::string OutputCorpus;
  77     std::string SyncCommand;
  78     std::vector<std::string> Tokens;
  79   };
  80   Fuzzer(UserSuppliedFuzzer &USF, FuzzingOptions Options);
  81   void AddToCorpus(const Unit &U) { Corpus.push_back(U); }
  82   void Loop(size_t NumIterations);
  83   void ShuffleAndMinimize();
  84   void InitializeTraceState();
  85   size_t CorpusSize() const { return Corpus.size(); }
  86   void ReadDir(const std::string &Path, long *Epoch) {
  87     ReadDirToVectorOfUnits(Path.c_str(), &Corpus, Epoch);
  88   }
  89   void RereadOutputCorpus();
  90   // Save the current corpus to OutputCorpus.
  91   void SaveCorpus();
  92
  93   size_t secondsSinceProcessStartUp() {
  94     return duration_cast<seconds>(system_clock::now() - ProcessStartTime)
  95         .count();
  96   }
  97
  98   size_t getTotalNumberOfRuns() { return TotalNumberOfRuns; }
  99
 100   static void StaticAlarmCallback();
 101
 102   Unit SubstituteTokens(const Unit &U) const;
 103
 104  private:
 105   void AlarmCallback();
 106   void ExecuteCallback(const Unit &U);
 107   void MutateAndTestOne(Unit *U);
 108   void ReportNewCoverage(size_t NewCoverage, const Unit &U);
 109   size_t RunOne(const Unit &U);
 110   void RunOneAndUpdateCorpus(const Unit &U);
 111   size_t RunOneMaximizeTotalCoverage(const Unit &U);
 112   size_t RunOneMaximizeFullCoverageSet(const Unit &U);
 113   size_t RunOneMaximizeCoveragePairs(const Unit &U);
 114   void WriteToOutputCorpus(const Unit &U);
 115   void WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix);
 116   void PrintStats(const char *Where, size_t Cov, const char *End = "\n");
 117   void PrintUnitInASCIIOrTokens(const Unit &U, const char *PrintAfter = "");
 118
 119   void SyncCorpus();
 120
 121   // Trace-based fuzzing: we run a unit with some kind of tracing
 122   // enabled and record potentially useful mutations. Then
 123   // We apply these mutations one by one to the unit and run it again.
 124
 125   // Start tracing; forget all previously proposed mutations.
 126   void StartTraceRecording();
 127   // Stop tracing and return the number of proposed mutations.
 128   size_t StopTraceRecording();
 129   // Apply Idx-th trace-based mutation to U.
 130   void ApplyTraceBasedMutation(size_t Idx, Unit *U);
 131
 132   void SetDeathCallback();
 133   static void StaticDeathCallback();
 134   void DeathCallback();
 135   Unit CurrentUnit;
 136
 137   size_t TotalNumberOfRuns = 0;
 138
 139   std::vector<Unit> Corpus;
 140   std::unordered_set<std::string> UnitHashesAddedToCorpus;
 141   std::unordered_set<uintptr_t> FullCoverageSets;
 142
 143   // For UseCounters
 144   std::vector<uint8_t> CounterBitmap;
 145   size_t TotalBits() {  // Slow. Call it only for printing stats.
 146     size_t Res = 0;
 147     for (auto x : CounterBitmap) Res += __builtin_popcount(x);
 148     return Res;
 149   }
 150
 151   UserSuppliedFuzzer &USF;
 152   FuzzingOptions Options;
 153   system_clock::time_point ProcessStartTime = system_clock::now();
 154   system_clock::time_point LastExternalSync = system_clock::now();
 155   system_clock::time_point UnitStartTime;
 156   long TimeOfLongestUnitInSeconds = 0;
 157   long EpochOfLastReadOfOutputCorpus = 0;
 158 };
 159
 160 class SimpleUserSuppliedFuzzer: public UserSuppliedFuzzer {
 161  public:
 162   SimpleUserSuppliedFuzzer(FuzzerRandomBase *Rand, UserCallback Callback)
 163       : UserSuppliedFuzzer(Rand), Callback(Callback) {}
 164   virtual void TargetFunction(const uint8_t *Data, size_t Size) {
 165     return Callback(Data, Size);
 166   }
 167
 168  private:
 169   UserCallback Callback;
 170 };
 171
 172 };  // namespace fuzzer