lib/Fuzzer/FuzzerMain.cpp

   1 //===- FuzzerMain.cpp - main() function and flags -------------------------===//
   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 // main() and flags.
  10 //===----------------------------------------------------------------------===//
  11
  12 #include "FuzzerInternal.h"
  13
  14 #include <climits>
  15 #include <cstring>
  16 #include <unistd.h>
  17 #include <iostream>
  18
  19 // ASAN options:
  20 //   * don't dump the coverage to disk.
  21 //   * enable coverage by default.
  22 extern "C" const char *__asan_default_options() {
  23   return "coverage_pcs=0:coverage=1";
  24 }
  25
  26 // Program arguments.
  27 struct FlagDescription {
  28   const char *Name;
  29   const char *Description;
  30   int   Default;
  31   int   *Flag;
  32 };
  33
  34 struct {
  35 #define FUZZER_FLAG(Type, Name, Default, Description) Type Name;
  36 #include "FuzzerFlags.def"
  37 #undef FUZZER_FLAG
  38 } Flags;
  39
  40 static FlagDescription FlagDescriptions [] {
  41 #define FUZZER_FLAG(Type, Name, Default, Description) {#Name, Description, Default, &Flags.Name},
  42 #include "FuzzerFlags.def"
  43 #undef FUZZER_FLAG
  44 };
  45
  46 static const size_t kNumFlags =
  47     sizeof(FlagDescriptions) / sizeof(FlagDescriptions[0]);
  48
  49 static std::vector<std::string> inputs;
  50 static const char *ProgName;
  51
  52 static void PrintHelp() {
  53   std::cerr << "Usage: " << ProgName
  54             << " [-flag1=val1 [-flag2=val2 ...] ] [dir1 [dir2 ...] ]\n";
  55   std::cerr << "\nFlags: (strictly in form -flag=value)\n";
  56   size_t MaxFlagLen = 0;
  57   for (size_t F = 0; F < kNumFlags; F++)
  58     MaxFlagLen = std::max(strlen(FlagDescriptions[F].Name), MaxFlagLen);
  59
  60   for (size_t F = 0; F < kNumFlags; F++) {
  61     const auto &D = FlagDescriptions[F];
  62     std::cerr << "  " << D.Name;
  63     for (size_t i = 0, n = MaxFlagLen - strlen(D.Name); i < n; i++)
  64       std::cerr << " ";
  65     std::cerr << "\t";
  66     std::cerr << D.Default << "\t" << D.Description << "\n";
  67   }
  68 }
  69
  70 static const char *FlagValue(const char *Param, const char *Name) {
  71   size_t Len = strlen(Name);
  72   if (Param[0] == '-' && strstr(Param + 1, Name) == Param + 1 &&
  73       Param[Len + 1] == '=')
  74       return &Param[Len + 2];
  75   return nullptr;
  76 }
  77
  78 static bool ParseOneFlag(const char *Param) {
  79   if (Param[0] != '-') return false;
  80   for (size_t F = 0; F < kNumFlags; F++) {
  81     const char *Name = FlagDescriptions[F].Name;
  82     const char *Str = FlagValue(Param, Name);
  83     if (Str)  {
  84       int Val = std::stol(Str);
  85       *FlagDescriptions[F].Flag = Val;
  86       if (Flags.verbosity >= 2)
  87         std::cerr << "Flag: " << Name << " " << Val << "\n";
  88       return true;
  89     }
  90   }
  91   PrintHelp();
  92   exit(1);
  93 }
  94
  95 // We don't use any library to minimize dependencies.
  96 static void ParseFlags(int argc, char **argv) {
  97   for (size_t F = 0; F < kNumFlags; F++)
  98     *FlagDescriptions[F].Flag = FlagDescriptions[F].Default;
  99   for (int A = 1; A < argc; A++) {
 100     if (ParseOneFlag(argv[A])) continue;
 101     inputs.push_back(argv[A]);
 102   }
 103 }
 104
 105 int main(int argc, char **argv) {
 106   using namespace fuzzer;
 107
 108   ProgName = argv[0];
 109   ParseFlags(argc, argv);
 110   if (Flags.help) {
 111     PrintHelp();
 112     return 0;
 113   }
 114   Fuzzer::FuzzingOptions Options;
 115   Options.Verbosity = Flags.verbosity;
 116   Options.MaxLen = Flags.max_len;
 117   Options.DoCrossOver = Flags.cross_over;
 118   Options.MutateDepth = Flags.mutate_depth;
 119   Options.ExitOnFirst = Flags.exit_on_first;
 120   if (!inputs.empty())
 121     Options.OutputCorpus = inputs[0];
 122   Fuzzer F(Options);
 123
 124   unsigned seed = Flags.seed;
 125   // Initialize seed.
 126   if (seed == 0)
 127     seed = time(0) * 10000 + getpid();
 128   if (Flags.verbosity)
 129     std::cerr << "Seed: " << seed << "\n";
 130   srand(seed);
 131
 132   // Timer
 133   if (Flags.timeout > 0)
 134     SetTimer(Flags.timeout);
 135
 136   for (auto &inp : inputs)
 137     F.ReadDir(inp);
 138
 139   if (F.CorpusSize() == 0)
 140     F.AddToCorpus(Unit());  // Can't fuzz empty corpus, so add an empty input.
 141   F.ShuffleAndMinimize();
 142   if (Flags.save_minimized_corpus)
 143     F.SaveCorpus();
 144   F.Loop(Flags.iterations < 0 ? INT_MAX : Flags.iterations);
 145   if (Flags.verbosity)
 146     std::cerr << "Done\n";
 147   return 1;
 148 }