1 //===- FuzzerDriver.cpp - FuzzerDriver function and flags -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
9 // FuzzerDriver and flag parsing.
10 //===----------------------------------------------------------------------===//
12 #include "FuzzerInterface.h"
13 #include "FuzzerInternal.h"
30 struct FlagDescription {
32 const char *Description;
39 #define FUZZER_FLAG_INT(Name, Default, Description) int Name;
40 #define FUZZER_FLAG_STRING(Name, Description) const char *Name;
41 #include "FuzzerFlags.def"
42 #undef FUZZER_FLAG_INT
43 #undef FUZZER_FLAG_STRING
46 static FlagDescription FlagDescriptions [] {
47 #define FUZZER_FLAG_INT(Name, Default, Description) \
48 { #Name, Description, Default, &Flags.Name, nullptr},
49 #define FUZZER_FLAG_STRING(Name, Description) \
50 { #Name, Description, 0, nullptr, &Flags.Name },
51 #include "FuzzerFlags.def"
52 #undef FUZZER_FLAG_INT
53 #undef FUZZER_FLAG_STRING
56 static const size_t kNumFlags =
57 sizeof(FlagDescriptions) / sizeof(FlagDescriptions[0]);
59 static std::vector<std::string> inputs;
60 static const char *ProgName;
62 static void PrintHelp() {
63 std::cerr << "Usage: " << ProgName
64 << " [-flag1=val1 [-flag2=val2 ...] ] [dir1 [dir2 ...] ]\n";
65 std::cerr << "\nFlags: (strictly in form -flag=value)\n";
66 size_t MaxFlagLen = 0;
67 for (size_t F = 0; F < kNumFlags; F++)
68 MaxFlagLen = std::max(strlen(FlagDescriptions[F].Name), MaxFlagLen);
70 for (size_t F = 0; F < kNumFlags; F++) {
71 const auto &D = FlagDescriptions[F];
72 std::cerr << " " << D.Name;
73 for (size_t i = 0, n = MaxFlagLen - strlen(D.Name); i < n; i++)
76 std::cerr << D.Default << "\t" << D.Description << "\n";
80 static const char *FlagValue(const char *Param, const char *Name) {
81 size_t Len = strlen(Name);
82 if (Param[0] == '-' && strstr(Param + 1, Name) == Param + 1 &&
83 Param[Len + 1] == '=')
84 return &Param[Len + 2];
88 static bool ParseOneFlag(const char *Param) {
89 if (Param[0] != '-') return false;
90 for (size_t F = 0; F < kNumFlags; F++) {
91 const char *Name = FlagDescriptions[F].Name;
92 const char *Str = FlagValue(Param, Name);
94 if (FlagDescriptions[F].IntFlag) {
95 int Val = std::stol(Str);
96 *FlagDescriptions[F].IntFlag = Val;
97 if (Flags.verbosity >= 2)
98 std::cerr << "Flag: " << Name << " " << Val << "\n";
100 } else if (FlagDescriptions[F].StrFlag) {
101 *FlagDescriptions[F].StrFlag = Str;
102 if (Flags.verbosity >= 2)
103 std::cerr << "Flag: " << Name << " " << Str << "\n";
112 // We don't use any library to minimize dependencies.
113 static void ParseFlags(int argc, char **argv) {
114 for (size_t F = 0; F < kNumFlags; F++) {
115 if (FlagDescriptions[F].IntFlag)
116 *FlagDescriptions[F].IntFlag = FlagDescriptions[F].Default;
117 if (FlagDescriptions[F].StrFlag)
118 *FlagDescriptions[F].StrFlag = nullptr;
120 for (int A = 1; A < argc; A++) {
121 if (ParseOneFlag(argv[A])) continue;
122 inputs.push_back(argv[A]);
126 static std::mutex Mu;
128 static void PulseThread() {
130 std::this_thread::sleep_for(std::chrono::seconds(600));
131 std::lock_guard<std::mutex> Lock(Mu);
132 std::cerr << "pulse...\n";
136 static void WorkerThread(const std::string &Cmd, std::atomic<int> *Counter,
137 int NumJobs, std::atomic<bool> *HasErrors) {
139 int C = (*Counter)++;
140 if (C >= NumJobs) break;
141 std::string Log = "fuzz-" + std::to_string(C) + ".log";
142 std::string ToRun = Cmd + " > " + Log + " 2>&1\n";
145 int ExitCode = system(ToRun.c_str());
148 std::lock_guard<std::mutex> Lock(Mu);
149 std::cerr << "================== Job " << C
150 << " exited with exit code " << ExitCode
151 << " =================\n";
152 fuzzer::CopyFileToErr(Log);
156 static int RunInMultipleProcesses(int argc, char **argv, int NumWorkers,
158 std::atomic<int> Counter(0);
159 std::atomic<bool> HasErrors(false);
161 for (int i = 0; i < argc; i++) {
162 if (FlagValue(argv[i], "jobs") || FlagValue(argv[i], "workers")) continue;
166 std::vector<std::thread> V;
167 std::thread Pulse(PulseThread);
169 for (int i = 0; i < NumWorkers; i++)
170 V.push_back(std::thread(WorkerThread, Cmd, &Counter, NumJobs, &HasErrors));
173 return HasErrors ? 1 : 0;
176 std::vector<std::string> ReadTokensFile(const char *TokensFilePath) {
177 if (!TokensFilePath) return {};
178 std::string TokensFileContents = FileToString(TokensFilePath);
179 std::istringstream ISS(TokensFileContents);
180 std::vector<std::string> Res = {std::istream_iterator<std::string>{ISS},
181 std::istream_iterator<std::string>{}};
188 int ApplyTokens(const Fuzzer &F, const char *InputFilePath) {
189 Unit U = FileToVector(InputFilePath);
190 auto T = F.SubstituteTokens(U);
192 std::cout << T.data();
196 int FuzzerDriver(int argc, char **argv, UserCallback Callback) {
197 using namespace fuzzer;
200 ParseFlags(argc, argv);
206 if (Flags.workers > 0 && Flags.jobs > 0)
207 return RunInMultipleProcesses(argc, argv, Flags.workers, Flags.jobs);
209 Fuzzer::FuzzingOptions Options;
210 Options.Verbosity = Flags.verbosity;
211 Options.MaxLen = Flags.max_len;
212 Options.DoCrossOver = Flags.cross_over;
213 Options.MutateDepth = Flags.mutate_depth;
214 Options.ExitOnFirst = Flags.exit_on_first;
215 Options.UseCounters = Flags.use_counters;
216 Options.UseTraces = Flags.use_traces;
217 Options.UseFullCoverageSet = Flags.use_full_coverage_set;
218 Options.UseCoveragePairs = Flags.use_coverage_pairs;
219 Options.UseDFSan = Flags.dfsan;
220 Options.PreferSmallDuringInitialShuffle =
221 Flags.prefer_small_during_initial_shuffle;
222 Options.Tokens = ReadTokensFile(Flags.tokens);
223 Options.Reload = Flags.reload;
225 Options.MaxNumberOfRuns = Flags.runs;
227 Options.OutputCorpus = inputs[0];
228 Fuzzer F(Callback, Options);
230 unsigned seed = Flags.seed;
233 seed = time(0) * 10000 + getpid();
235 std::cerr << "Seed: " << seed << "\n";
239 if (Flags.timeout > 0)
240 SetTimer(Flags.timeout);
242 if (Flags.verbosity >= 2) {
243 std::cerr << "Tokens: {";
244 for (auto &T : Options.Tokens)
245 std::cerr << T << ",";
249 if (Flags.apply_tokens)
250 return ApplyTokens(F, Flags.apply_tokens);
252 F.RereadOutputCorpus();
253 for (auto &inp : inputs)
254 if (inp != Options.OutputCorpus)
255 F.ReadDir(inp, nullptr);
257 if (F.CorpusSize() == 0)
258 F.AddToCorpus(Unit()); // Can't fuzz empty corpus, so add an empty input.
259 F.ShuffleAndMinimize();
260 if (Flags.save_minimized_corpus)
262 F.Loop(Flags.iterations < 0 ? INT_MAX : Flags.iterations);
264 std::cerr << "Done " << F.getTotalNumberOfRuns()
265 << " runs in " << F.secondsSinceProcessStartUp()
270 } // namespace fuzzer