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
  12 #ifndef LLVM_FUZZER_INTERNAL_H
  13 #define LLVM_FUZZER_INTERNAL_H
  14
  15 #include <cassert>
  16 #include <climits>
  17 #include <chrono>
  18 #include <cstddef>
  19 #include <cstdlib>
  20 #include <string>
  21 #include <vector>
  22 #include <unordered_set>
  23
  24 #include "FuzzerInterface.h"
  25
  26 namespace fuzzer {
  27 typedef std::vector<uint8_t> Unit;
  28 using namespace std::chrono;
  29
  30 std::string FileToString(const std::string &Path);
  31 Unit FileToVector(const std::string &Path);
  32 void ReadDirToVectorOfUnits(const char *Path, std::vector<Unit> *V,
  33                             long *Epoch);
  34 void WriteToFile(const Unit &U, const std::string &Path);
  35 void CopyFileToErr(const std::string &Path);
  36 // Returns "Dir/FileName" or equivalent for the current OS.
  37 std::string DirPlusFile(const std::string &DirPath,
  38                         const std::string &FileName);
  39
  40 void Printf(const char *Fmt, ...);
  41 void Print(const Unit &U, const char *PrintAfter = "");
  42 void PrintASCII(const Unit &U, const char *PrintAfter = "");
  43 std::string Hash(const Unit &U);
  44 void SetTimer(int Seconds);
  45 void PrintFileAsBase64(const std::string &Path);
  46 void ExecuteCommand(const std::string &Command);
  47
  48 // Private copy of SHA1 implementation.
  49 static const int kSHA1NumBytes = 20;
  50 // Computes SHA1 hash of 'Len' bytes in 'Data', writes kSHA1NumBytes to 'Out'.
  51 void ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out);
  52
  53 // Changes U to contain only ASCII (isprint+isspace) characters.
  54 // Returns true iff U has been changed.
  55 bool ToASCII(Unit &U);
  56 bool IsASCII(const Unit &U);
  57
  58 int NumberOfCpuCores();
  59
  60 // Dictionary.
  61
  62 // Parses one dictionary entry.
  63 // If successfull, write the enty to Unit and returns true,
  64 // otherwise returns false.
  65 bool ParseOneDictionaryEntry(const std::string &Str, Unit *U);
  66 // Parses the dictionary file, fills Units, returns true iff all lines
  67 // were parsed succesfully.
  68 bool ParseDictionaryFile(const std::string &Text, std::vector<Unit> *Units);
  69
  70 class Fuzzer {
  71  public:
  72   struct FuzzingOptions {
  73     int Verbosity = 1;
  74     int MaxLen = 0;
  75     int UnitTimeoutSec = 300;
  76     int MaxTotalTimeSec = 0;
  77     bool DoCrossOver = true;
  78     int  MutateDepth = 5;
  79     bool ExitOnFirst = false;
  80     bool UseCounters = false;
  81     bool UseTraces = false;
  82     bool UseFullCoverageSet  = false;
  83     bool Reload = true;
  84     int PreferSmallDuringInitialShuffle = -1;
  85     size_t MaxNumberOfRuns = ULONG_MAX;
  86     int SyncTimeout = 600;
  87     int ReportSlowUnits = 10;
  88     bool OnlyASCII = false;
  89     int TBMDepth = 10;
  90     int TBMWidth = 10;
  91     std::string OutputCorpus;
  92     std::string SyncCommand;
  93     std::string ArtifactPrefix = "./";
  94     std::vector<std::string> Tokens;
  95     std::vector<Unit> Dictionary;
  96   };
  97   Fuzzer(UserSuppliedFuzzer &USF, FuzzingOptions Options);
  98   void AddToCorpus(const Unit &U) { Corpus.push_back(U); }
  99   void Loop();
 100   void ShuffleAndMinimize();
 101   void InitializeTraceState();
 102   size_t CorpusSize() const { return Corpus.size(); }
 103   void ReadDir(const std::string &Path, long *Epoch) {
 104     ReadDirToVectorOfUnits(Path.c_str(), &Corpus, Epoch);
 105   }
 106   void RereadOutputCorpus();
 107   // Save the current corpus to OutputCorpus.
 108   void SaveCorpus();
 109
 110   size_t secondsSinceProcessStartUp() {
 111     return duration_cast<seconds>(system_clock::now() - ProcessStartTime)
 112         .count();
 113   }
 114
 115   size_t getTotalNumberOfRuns() { return TotalNumberOfRuns; }
 116
 117   static void StaticAlarmCallback();
 118
 119   Unit SubstituteTokens(const Unit &U) const;
 120   void ExecuteCallback(const Unit &U);
 121
 122  private:
 123   void AlarmCallback();
 124   void MutateAndTestOne(Unit *U);
 125   void ReportNewCoverage(size_t NewCoverage, const Unit &U);
 126   size_t RunOne(const Unit &U);
 127   void RunOneAndUpdateCorpus(Unit &U);
 128   size_t RunOneMaximizeTotalCoverage(const Unit &U);
 129   size_t RunOneMaximizeCoveragePairs(const Unit &U);
 130   void WriteToOutputCorpus(const Unit &U);
 131   void WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix);
 132   void PrintStats(const char *Where, size_t Cov, const char *End = "\n");
 133   void PrintUnitInASCIIOrTokens(const Unit &U, const char *PrintAfter = "");
 134
 135   void SyncCorpus();
 136
 137   // Trace-based fuzzing: we run a unit with some kind of tracing
 138   // enabled and record potentially useful mutations. Then
 139   // We apply these mutations one by one to the unit and run it again.
 140
 141   // Start tracing; forget all previously proposed mutations.
 142   void StartTraceRecording();
 143   // Stop tracing and return the number of proposed mutations.
 144   size_t StopTraceRecording();
 145   // Apply Idx-th trace-based mutation to U.
 146   void ApplyTraceBasedMutation(size_t Idx, Unit *U);
 147
 148   void SetDeathCallback();
 149   static void StaticDeathCallback();
 150   void DeathCallback();
 151   Unit CurrentUnit;
 152
 153   size_t TotalNumberOfRuns = 0;
 154   size_t TotalNumberOfExecutedTraceBasedMutations = 0;
 155
 156   std::vector<Unit> Corpus;
 157   std::unordered_set<std::string> UnitHashesAddedToCorpus;
 158
 159   // For UseCounters
 160   std::vector<uint8_t> CounterBitmap;
 161   size_t TotalBits() {  // Slow. Call it only for printing stats.
 162     size_t Res = 0;
 163     for (auto x : CounterBitmap) Res += __builtin_popcount(x);
 164     return Res;
 165   }
 166
 167   UserSuppliedFuzzer &USF;
 168   FuzzingOptions Options;
 169   system_clock::time_point ProcessStartTime = system_clock::now();
 170   system_clock::time_point LastExternalSync = system_clock::now();
 171   system_clock::time_point UnitStartTime;
 172   long TimeOfLongestUnitInSeconds = 0;
 173   long EpochOfLastReadOfOutputCorpus = 0;
 174 };
 175
 176 class SimpleUserSuppliedFuzzer: public UserSuppliedFuzzer {
 177  public:
 178   SimpleUserSuppliedFuzzer(FuzzerRandomBase *Rand, UserCallback Callback)
 179       : UserSuppliedFuzzer(Rand), Callback(Callback) {}
 180
 181   SimpleUserSuppliedFuzzer(FuzzerRandomBase *Rand, DeprecatedUserCallback Callback)
 182       : UserSuppliedFuzzer(Rand), DeprecatedCallback(Callback) {}
 183
 184   virtual int TargetFunction(const uint8_t *Data, size_t Size) override {
 185     if (Callback) return Callback(Data, Size);
 186     DeprecatedCallback(Data, Size);
 187     return 0;
 188   }
 189
 190  private:
 191   DeprecatedUserCallback DeprecatedCallback = nullptr;
 192   UserCallback Callback = nullptr;
 193 };
 194
 195 };  // namespace fuzzer
 196
 197 #endif // LLVM_FUZZER_INTERNAL_H