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