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