lib/Fuzzer/FuzzerInterface.h

   1 //===- FuzzerInterface.h - Interface 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 interface between the Fuzzer and the library being tested.
  10 //===----------------------------------------------------------------------===//
  11
  12 // WARNING: keep the interface free of STL or any other header-based C++ lib,
  13 // to avoid bad interactions between the code used in the fuzzer and
  14 // the code used in the target function.
  15
  16 #ifndef LLVM_FUZZER_INTERFACE_H
  17 #define LLVM_FUZZER_INTERFACE_H
  18
  19 #include <cstddef>
  20 #include <cstdint>
  21
  22 namespace fuzzer {
  23
  24 typedef void (*UserCallback)(const uint8_t *Data, size_t Size);
  25 /** Simple C-like interface with a single user-supplied callback.
  26
  27 Usage:
  28
  29 #\code
  30 #include "FuzzerInterface.h"
  31
  32 void LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
  33   DoStuffWithData(Data, Size);
  34 }
  35
  36 // Implement your own main() or use the one from FuzzerMain.cpp.
  37 int main(int argc, char **argv) {
  38   InitializeMeIfNeeded();
  39   return fuzzer::FuzzerDriver(argc, argv, LLVMFuzzerTestOneInput);
  40 }
  41 #\endcode
  42 */
  43 int FuzzerDriver(int argc, char **argv, UserCallback Callback);
  44
  45 class FuzzerRandomBase {
  46  public:
  47   FuzzerRandomBase(){}
  48   virtual ~FuzzerRandomBase(){};
  49   virtual void ResetSeed(int seed) = 0;
  50   // Return a random number.
  51   virtual size_t Rand() = 0;
  52   // Return a random number in range [0,n).
  53   size_t operator()(size_t n) { return n ? Rand() % n : 0; }
  54   bool RandBool() { return Rand() % 2; }
  55 };
  56
  57 class FuzzerRandomLibc : public FuzzerRandomBase {
  58  public:
  59   FuzzerRandomLibc(int seed) { ResetSeed(seed); }
  60   void ResetSeed(int seed) override;
  61   ~FuzzerRandomLibc() override {}
  62   size_t Rand() override;
  63 };
  64
  65 class MutationDispatcher {
  66  public:
  67   MutationDispatcher(FuzzerRandomBase &Rand) : Rand(Rand) {}
  68   /// Mutates data by shuffling bytes.
  69   size_t Mutate_ShuffleBytes(uint8_t *Data, size_t Size, size_t MaxSize);
  70   /// Mutates data by erasing a byte.
  71   size_t Mutate_EraseByte(uint8_t *Data, size_t Size, size_t MaxSize);
  72   /// Mutates data by inserting a byte.
  73   size_t Mutate_InsertByte(uint8_t *Data, size_t Size, size_t MaxSize);
  74   /// Mutates data by chanding one byte.
  75   size_t Mutate_ChangeByte(uint8_t *Data, size_t Size, size_t MaxSize);
  76   /// Mutates data by chanding one bit.
  77   size_t Mutate_ChangeBit(uint8_t *Data, size_t Size, size_t MaxSize);
  78
  79   /// Applies one of the above mutations.
  80   /// Returns the new size of data which could be up to MaxSize.
  81   size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize);
  82
  83   /// Creates a cross-over of two pieces of Data, returns its size.
  84   size_t CrossOver(const uint8_t *Data1, size_t Size1, const uint8_t *Data2,
  85                    size_t Size2, uint8_t *Out, size_t MaxOutSize);
  86
  87  private:
  88   FuzzerRandomBase &Rand;
  89 };
  90
  91 // For backward compatibility only, deprecated.
  92 static inline size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize,
  93                             FuzzerRandomBase &Rand) {
  94   MutationDispatcher MD(Rand);
  95   return MD.Mutate(Data, Size, MaxSize);
  96 }
  97
  98 /** An abstract class that allows to use user-supplied mutators with libFuzzer.
  99
 100 Usage:
 101
 102 #\code
 103 #include "FuzzerInterface.h"
 104 class MyFuzzer : public fuzzer::UserSuppliedFuzzer {
 105  public:
 106   MyFuzzer(fuzzer::FuzzerRandomBase *Rand);
 107   // Must define the target function.
 108   void TargetFunction(...) { ... }
 109   // Optionally define the mutator.
 110   size_t Mutate(...) { ... }
 111   // Optionally define the CrossOver method.
 112   size_t CrossOver(...) { ... }
 113 };
 114
 115 int main(int argc, char **argv) {
 116   MyFuzzer F;
 117   fuzzer::FuzzerDriver(argc, argv, F);
 118 }
 119 #\endcode
 120 */
 121 class UserSuppliedFuzzer {
 122  public:
 123   UserSuppliedFuzzer();  // Deprecated, don't use.
 124   UserSuppliedFuzzer(FuzzerRandomBase *Rand);
 125   /// Executes the target function on 'Size' bytes of 'Data'.
 126   virtual void TargetFunction(const uint8_t *Data, size_t Size) = 0;
 127   /// Mutates 'Size' bytes of data in 'Data' inplace into up to 'MaxSize' bytes,
 128   /// returns the new size of the data, which should be positive.
 129   virtual size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize) {
 130     return MD.Mutate(Data, Size, MaxSize);
 131   }
 132   /// Crosses 'Data1' and 'Data2', writes up to 'MaxOutSize' bytes into Out,
 133   /// returns the number of bytes written, which should be positive.
 134   virtual size_t CrossOver(const uint8_t *Data1, size_t Size1,
 135                            const uint8_t *Data2, size_t Size2,
 136                            uint8_t *Out, size_t MaxOutSize) {
 137     return MD.CrossOver(Data1, Size1, Data2, Size2, Out, MaxOutSize);
 138   }
 139   virtual ~UserSuppliedFuzzer();
 140
 141   FuzzerRandomBase &GetRand() { return *Rand; }
 142
 143  private:
 144   bool OwnRand = false;
 145   FuzzerRandomBase *Rand;
 146   MutationDispatcher MD;
 147 };
 148
 149 /// Runs the fuzzing with the UserSuppliedFuzzer.
 150 int FuzzerDriver(int argc, char **argv, UserSuppliedFuzzer &USF);
 151
 152 }  // namespace fuzzer
 153
 154 #endif  // LLVM_FUZZER_INTERFACE_H