blob: f90b7092d4966c906ded73d65197616eb44f628d [file] [log] [blame]
Aaron Ballmanef116982015-01-29 16:58:29 +00001//===- FuzzerLoop.cpp - Fuzzer's main loop --------------------------------===//
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// Fuzzer's main loop.
10//===----------------------------------------------------------------------===//
11
12#include "FuzzerInternal.h"
Aaron Ballmanef116982015-01-29 16:58:29 +000013#include <algorithm>
Kostya Serebryanyd50a3ee2016-01-13 23:02:30 +000014#include <cstring>
15#include <memory>
Aaron Ballmanef116982015-01-29 16:58:29 +000016
Kostya Serebryany2a48c242015-11-13 01:54:40 +000017#if defined(__has_include)
Ivan Krasindf919102016-01-22 22:28:27 +000018#if __has_include(<sanitizer / coverage_interface.h>)
19#include <sanitizer/coverage_interface.h>
20#endif
Kostya Serebryany1bfd5832016-04-20 00:24:21 +000021#if __has_include(<sanitizer / lsan_interface.h>)
22#include <sanitizer/lsan_interface.h>
23#endif
Kostya Serebryany2a48c242015-11-13 01:54:40 +000024#endif
25
Benjamin Kramerd96b0c12016-03-18 14:19:19 +000026#define NO_SANITIZE_MEMORY
27#if defined(__has_feature)
28#if __has_feature(memory_sanitizer)
29#undef NO_SANITIZE_MEMORY
30#define NO_SANITIZE_MEMORY __attribute__((no_sanitize_memory))
31#endif
32#endif
33
Aaron Ballmanef116982015-01-29 16:58:29 +000034namespace fuzzer {
Kostya Serebryanya9da9b42015-10-16 22:47:20 +000035static const size_t kMaxUnitSizeToPrint = 256;
Mike Aizatskyaf432a42016-05-24 23:14:29 +000036static const size_t TruncateMaxRuns = 1000;
Aaron Ballmanef116982015-01-29 16:58:29 +000037
Kostya Serebryanyf26017b2016-05-26 21:32:30 +000038thread_local bool Fuzzer::IsMyThread;
39
Dan Liew1873a492016-06-07 23:32:50 +000040static void MissingExternalApiFunction(const char *FnName) {
Kostya Serebryany5eab74e2015-11-09 23:17:45 +000041 Printf("ERROR: %s is not defined. Exiting.\n"
Ivan Krasindf919102016-01-22 22:28:27 +000042 "Did you use -fsanitize-coverage=... to build your code?\n",
43 FnName);
Kostya Serebryany5eab74e2015-11-09 23:17:45 +000044 exit(1);
45}
46
Dan Liew1873a492016-06-07 23:32:50 +000047#define CHECK_EXTERNAL_FUNCTION(fn) \
Kostya Serebryany5eab74e2015-11-09 23:17:45 +000048 do { \
Dan Liew1873a492016-06-07 23:32:50 +000049 if (!(EF->fn)) \
50 MissingExternalApiFunction(#fn); \
Kostya Serebryany5eab74e2015-11-09 23:17:45 +000051 } while (false)
52
Kostya Serebryany52a788e2015-03-31 20:13:20 +000053// Only one Fuzzer per process.
54static Fuzzer *F;
55
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +000056// Only one CoverageController per process should be created.
57class CoverageController {
58 public:
Kostya Serebryanyc98ef712016-08-16 17:37:13 +000059 explicit CoverageController(const FuzzingOptions &Options)
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +000060 : Options(Options) {
61 if (Options.PrintNewCovPcs) {
62 PcBufferLen = 1 << 24;
63 PcBuffer = new uintptr_t[PcBufferLen];
64 EF->__sanitizer_set_coverage_pc_buffer(PcBuffer, PcBufferLen);
65 }
66 }
67
68 uintptr_t* pc_buffer() const { return PcBuffer; }
69
70 void Reset() {
Dan Liew1873a492016-06-07 23:32:50 +000071 CHECK_EXTERNAL_FUNCTION(__sanitizer_reset_coverage);
72 EF->__sanitizer_reset_coverage();
Mike Aizatsky1aa501e2016-05-10 23:43:15 +000073 }
74
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +000075 void ResetCounters() {
Mike Aizatsky1aa501e2016-05-10 23:43:15 +000076 if (Options.UseCounters) {
Dan Liew1873a492016-06-07 23:32:50 +000077 EF->__sanitizer_update_counter_bitset_and_clear_counters(0);
Mike Aizatsky1aa501e2016-05-10 23:43:15 +000078 }
79 }
80
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +000081 void Prepare(Fuzzer::Coverage *C) {
Mike Aizatsky1aa501e2016-05-10 23:43:15 +000082 if (Options.UseCounters) {
Dan Liew1873a492016-06-07 23:32:50 +000083 size_t NumCounters = EF->__sanitizer_get_number_of_counters();
Mike Aizatsky1aa501e2016-05-10 23:43:15 +000084 C->CounterBitmap.resize(NumCounters);
85 }
86 }
87
88 // Records data to a maximum coverage tracker. Returns true if additional
89 // coverage was discovered.
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +000090 bool RecordMax(Fuzzer::Coverage *C) {
Mike Aizatsky1aa501e2016-05-10 23:43:15 +000091 bool Res = false;
92
Dan Liew1873a492016-06-07 23:32:50 +000093 uint64_t NewBlockCoverage = EF->__sanitizer_get_total_unique_coverage();
Mike Aizatsky1aa501e2016-05-10 23:43:15 +000094 if (NewBlockCoverage > C->BlockCoverage) {
95 Res = true;
96 C->BlockCoverage = NewBlockCoverage;
97 }
98
99 if (Options.UseIndirCalls &&
Dan Liew1873a492016-06-07 23:32:50 +0000100 EF->__sanitizer_get_total_unique_caller_callee_pairs) {
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000101 uint64_t NewCallerCalleeCoverage =
Dan Liew1873a492016-06-07 23:32:50 +0000102 EF->__sanitizer_get_total_unique_caller_callee_pairs();
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000103 if (NewCallerCalleeCoverage > C->CallerCalleeCoverage) {
104 Res = true;
105 C->CallerCalleeCoverage = NewCallerCalleeCoverage;
106 }
107 }
108
109 if (Options.UseCounters) {
110 uint64_t CounterDelta =
Dan Liew1873a492016-06-07 23:32:50 +0000111 EF->__sanitizer_update_counter_bitset_and_clear_counters(
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000112 C->CounterBitmap.data());
113 if (CounterDelta > 0) {
114 Res = true;
115 C->CounterBitmapBits += CounterDelta;
116 }
117 }
118
Kostya Serebryanyc98ef712016-08-16 17:37:13 +0000119 size_t NewPCMapBits = PCMapMergeFromCurrent(C->PCMap);
120 if (NewPCMapBits > C->PCMapBits) {
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000121 Res = true;
Kostya Serebryanyc98ef712016-08-16 17:37:13 +0000122 C->PCMapBits = NewPCMapBits;
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000123 }
124
Kostya Serebryany728447b2016-08-06 21:28:56 +0000125 if (EF->__sanitizer_get_coverage_pc_buffer_pos) {
126 uint64_t NewPcBufferPos = EF->__sanitizer_get_coverage_pc_buffer_pos();
127 if (NewPcBufferPos > C->PcBufferPos) {
128 Res = true;
129 C->PcBufferPos = NewPcBufferPos;
130 }
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000131
Kostya Serebryany728447b2016-08-06 21:28:56 +0000132 if (PcBufferLen && NewPcBufferPos >= PcBufferLen) {
133 Printf("ERROR: PC buffer overflow\n");
134 _Exit(1);
135 }
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000136 }
137
138 return Res;
139 }
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000140
141 private:
142 const FuzzingOptions Options;
143 uintptr_t* PcBuffer = nullptr;
144 size_t PcBufferLen = 0;
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000145};
146
Kostya Serebryanyfd6ad5b2016-06-16 20:17:41 +0000147// Leak detection is expensive, so we first check if there were more mallocs
148// than frees (using the sanitizer malloc hooks) and only then try to call lsan.
149struct MallocFreeTracer {
150 void Start() {
151 Mallocs = 0;
152 Frees = 0;
153 }
154 // Returns true if there were more mallocs than frees.
155 bool Stop() { return Mallocs > Frees; }
156 std::atomic<size_t> Mallocs;
157 std::atomic<size_t> Frees;
158};
159
160static MallocFreeTracer AllocTracer;
161
162void MallocHook(const volatile void *ptr, size_t size) {
163 AllocTracer.Mallocs++;
164}
165void FreeHook(const volatile void *ptr) {
166 AllocTracer.Frees++;
167}
168
Kostya Serebryany7ec0c562016-02-13 03:25:16 +0000169Fuzzer::Fuzzer(UserCallback CB, MutationDispatcher &MD, FuzzingOptions Options)
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000170 : CB(CB), MD(MD), Options(Options),
171 CController(new CoverageController(Options)) {
Kostya Serebryany52a788e2015-03-31 20:13:20 +0000172 SetDeathCallback();
Kostya Serebryany22526252015-05-11 21:16:27 +0000173 InitializeTraceState();
Kostya Serebryany52a788e2015-03-31 20:13:20 +0000174 assert(!F);
175 F = this;
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000176 ResetCoverage();
Kostya Serebryanyf26017b2016-05-26 21:32:30 +0000177 IsMyThread = true;
Kostya Serebryanyfd6ad5b2016-06-16 20:17:41 +0000178 if (Options.DetectLeaks && EF->__sanitizer_install_malloc_and_free_hooks)
179 EF->__sanitizer_install_malloc_and_free_hooks(MallocHook, FreeHook);
Kostya Serebryany52a788e2015-03-31 20:13:20 +0000180}
Aaron Ballmanef116982015-01-29 16:58:29 +0000181
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000182Fuzzer::~Fuzzer() { }
183
Kostya Serebryany8fc3a272016-05-27 00:21:33 +0000184void Fuzzer::LazyAllocateCurrentUnitData() {
185 if (CurrentUnitData || Options.MaxLen == 0) return;
186 CurrentUnitData = new uint8_t[Options.MaxLen];
187}
188
Aaron Ballmanef116982015-01-29 16:58:29 +0000189void Fuzzer::SetDeathCallback() {
Dan Liew1873a492016-06-07 23:32:50 +0000190 CHECK_EXTERNAL_FUNCTION(__sanitizer_set_death_callback);
191 EF->__sanitizer_set_death_callback(StaticDeathCallback);
Kostya Serebryany52a788e2015-03-31 20:13:20 +0000192}
193
Kostya Serebryany52a788e2015-03-31 20:13:20 +0000194void Fuzzer::StaticDeathCallback() {
195 assert(F);
196 F->DeathCallback();
Aaron Ballmanef116982015-01-29 16:58:29 +0000197}
198
Kostya Serebryany228d5b12016-03-01 22:19:21 +0000199void Fuzzer::DumpCurrentUnit(const char *Prefix) {
Kostya Serebryany311cc832016-05-28 04:19:46 +0000200 if (!CurrentUnitData) return; // Happens when running individual inputs.
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000201 size_t UnitSize = CurrentUnitSize;
Kostya Serebryanyd8384122016-05-26 22:17:32 +0000202 if (UnitSize <= kMaxUnitSizeToPrint) {
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000203 PrintHexArray(CurrentUnitData, UnitSize, "\n");
204 PrintASCII(CurrentUnitData, UnitSize, "\n");
Kostya Serebryanye95022a2015-10-09 04:03:14 +0000205 }
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000206 WriteUnitToFileWithPrefix({CurrentUnitData, CurrentUnitData + UnitSize},
207 Prefix);
Kostya Serebryany228d5b12016-03-01 22:19:21 +0000208}
209
Benjamin Kramerd96b0c12016-03-18 14:19:19 +0000210NO_SANITIZE_MEMORY
Kostya Serebryany228d5b12016-03-01 22:19:21 +0000211void Fuzzer::DeathCallback() {
Kostya Serebryanyd8384122016-05-26 22:17:32 +0000212 DumpCurrentUnit("crash-");
Kostya Serebryany66ff0752016-02-26 22:42:23 +0000213 PrintFinalStats();
Aaron Ballmanef116982015-01-29 16:58:29 +0000214}
215
Kostya Serebryany52a788e2015-03-31 20:13:20 +0000216void Fuzzer::StaticAlarmCallback() {
217 assert(F);
218 F->AlarmCallback();
219}
220
Kostya Serebryany228d5b12016-03-01 22:19:21 +0000221void Fuzzer::StaticCrashSignalCallback() {
222 assert(F);
223 F->CrashCallback();
224}
225
226void Fuzzer::StaticInterruptCallback() {
227 assert(F);
228 F->InterruptCallback();
229}
230
231void Fuzzer::CrashCallback() {
232 Printf("==%d== ERROR: libFuzzer: deadly signal\n", GetPid());
Dan Liew1873a492016-06-07 23:32:50 +0000233 if (EF->__sanitizer_print_stack_trace)
234 EF->__sanitizer_print_stack_trace();
Kostya Serebryany228d5b12016-03-01 22:19:21 +0000235 Printf("NOTE: libFuzzer has rudimentary signal handlers.\n"
236 " Combine libFuzzer with AddressSanitizer or similar for better "
237 "crash reports.\n");
238 Printf("SUMMARY: libFuzzer: deadly signal\n");
239 DumpCurrentUnit("crash-");
240 PrintFinalStats();
241 exit(Options.ErrorExitCode);
242}
243
244void Fuzzer::InterruptCallback() {
245 Printf("==%d== libFuzzer: run interrupted; exiting\n", GetPid());
246 PrintFinalStats();
Kostya Serebryanye483ed22016-03-03 22:36:37 +0000247 _Exit(0); // Stop right now, don't perform any at-exit actions.
Kostya Serebryany228d5b12016-03-01 22:19:21 +0000248}
249
Benjamin Kramerd96b0c12016-03-18 14:19:19 +0000250NO_SANITIZE_MEMORY
Aaron Ballmanef116982015-01-29 16:58:29 +0000251void Fuzzer::AlarmCallback() {
Kostya Serebryany490bbd62015-05-19 22:12:57 +0000252 assert(Options.UnitTimeoutSec > 0);
Kostya Serebryanyd8384122016-05-26 22:17:32 +0000253 if (!InFuzzingThread()) return;
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000254 if (!CurrentUnitSize)
Kostya Serebryanycfbcf902016-02-17 19:42:34 +0000255 return; // We have not started running units yet.
Aaron Ballmanef116982015-01-29 16:58:29 +0000256 size_t Seconds =
257 duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
Ivan Krasindf919102016-01-22 22:28:27 +0000258 if (Seconds == 0)
259 return;
Kostya Serebryany490bbd62015-05-19 22:12:57 +0000260 if (Options.Verbosity >= 2)
Kostya Serebryany7c180ea2015-05-23 01:22:35 +0000261 Printf("AlarmCallback %zd\n", Seconds);
Kostya Serebryany490bbd62015-05-19 22:12:57 +0000262 if (Seconds >= (size_t)Options.UnitTimeoutSec) {
Kostya Serebryany7c180ea2015-05-23 01:22:35 +0000263 Printf("ALARM: working on the last Unit for %zd seconds\n", Seconds);
Kostya Serebryany316b5712015-05-26 20:57:47 +0000264 Printf(" and the timeout value is %d (use -timeout=N to change)\n",
265 Options.UnitTimeoutSec);
Kostya Serebryany228d5b12016-03-01 22:19:21 +0000266 DumpCurrentUnit("timeout-");
Kostya Serebryanyd6edce92015-10-16 23:04:31 +0000267 Printf("==%d== ERROR: libFuzzer: timeout after %d seconds\n", GetPid(),
268 Seconds);
Dan Liew1873a492016-06-07 23:32:50 +0000269 if (EF->__sanitizer_print_stack_trace)
270 EF->__sanitizer_print_stack_trace();
Kostya Serebryanyd6edce92015-10-16 23:04:31 +0000271 Printf("SUMMARY: libFuzzer: timeout\n");
Kostya Serebryany66ff0752016-02-26 22:42:23 +0000272 PrintFinalStats();
Kostya Serebryany31516732016-03-24 01:32:08 +0000273 _Exit(Options.TimeoutExitCode); // Stop right now.
Aaron Ballmanef116982015-01-29 16:58:29 +0000274 }
Aaron Ballmanef116982015-01-29 16:58:29 +0000275}
276
Kostya Serebryany8b8f7a32016-05-06 23:38:07 +0000277void Fuzzer::RssLimitCallback() {
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000278 Printf(
279 "==%d== ERROR: libFuzzer: out-of-memory (used: %zdMb; limit: %zdMb)\n",
280 GetPid(), GetPeakRSSMb(), Options.RssLimitMb);
Kostya Serebryanyf6414422016-06-02 01:33:11 +0000281 Printf(" To change the out-of-memory limit use -rss_limit_mb=<N>\n\n");
Dan Liew1873a492016-06-07 23:32:50 +0000282 if (EF->__sanitizer_print_memory_profile)
283 EF->__sanitizer_print_memory_profile(50);
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000284 DumpCurrentUnit("oom-");
285 Printf("SUMMARY: libFuzzer: out-of-memory\n");
286 PrintFinalStats();
287 _Exit(Options.ErrorExitCode); // Stop right now.
Kostya Serebryany52b394e2016-05-06 21:58:35 +0000288}
289
Kostya Serebryany09d2a5f2015-10-22 22:56:45 +0000290void Fuzzer::PrintStats(const char *Where, const char *End) {
Kostya Serebryany66ff0752016-02-26 22:42:23 +0000291 size_t ExecPerSec = execPerSec();
Mike Aizatskya9c23872015-11-12 04:38:40 +0000292 if (Options.OutputCSV) {
293 static bool csvHeaderPrinted = false;
294 if (!csvHeaderPrinted) {
295 csvHeaderPrinted = true;
296 Printf("runs,block_cov,bits,cc_cov,corpus,execs_per_sec,tbms,reason\n");
297 }
Kostya Serebryany9ba19182016-04-25 19:41:45 +0000298 Printf("%zd,%zd,%zd,%zd,%zd,%zd,%s\n", TotalNumberOfRuns,
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000299 MaxCoverage.BlockCoverage, MaxCoverage.CounterBitmapBits,
300 MaxCoverage.CallerCalleeCoverage, Corpus.size(), ExecPerSec, Where);
Mike Aizatskya9c23872015-11-12 04:38:40 +0000301 }
302
303 if (!Options.Verbosity)
304 return;
Kostya Serebryany007c9b22015-10-22 22:50:47 +0000305 Printf("#%zd\t%s", TotalNumberOfRuns, Where);
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000306 if (MaxCoverage.BlockCoverage)
307 Printf(" cov: %zd", MaxCoverage.BlockCoverage);
Kostya Serebryanyc98ef712016-08-16 17:37:13 +0000308 if (MaxCoverage.PCMapBits)
309 Printf(" path: %zd", MaxCoverage.PCMapBits);
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000310 if (auto TB = MaxCoverage.CounterBitmapBits)
Kostya Serebryany007c9b22015-10-22 22:50:47 +0000311 Printf(" bits: %zd", TB);
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000312 if (MaxCoverage.CallerCalleeCoverage)
313 Printf(" indir: %zd", MaxCoverage.CallerCalleeCoverage);
Kostya Serebryany007c9b22015-10-22 22:50:47 +0000314 Printf(" units: %zd exec/s: %zd", Corpus.size(), ExecPerSec);
Kostya Serebryany12c78372015-08-12 01:55:37 +0000315 Printf("%s", End);
Kostya Serebryany03db8b92015-03-30 22:44:03 +0000316}
317
Kostya Serebryany66ff0752016-02-26 22:42:23 +0000318void Fuzzer::PrintFinalStats() {
319 if (!Options.PrintFinalStats) return;
320 size_t ExecPerSec = execPerSec();
321 Printf("stat::number_of_executed_units: %zd\n", TotalNumberOfRuns);
322 Printf("stat::average_exec_per_sec: %zd\n", ExecPerSec);
323 Printf("stat::new_units_added: %zd\n", NumberOfNewUnitsAdded);
324 Printf("stat::slowest_unit_time_sec: %zd\n", TimeOfLongestUnitInSeconds);
325 Printf("stat::peak_rss_mb: %zd\n", GetPeakRSSMb());
326}
327
Kostya Serebryany64d24572016-03-12 01:57:04 +0000328size_t Fuzzer::MaxUnitSizeInCorpus() const {
329 size_t Res = 0;
330 for (auto &X : Corpus)
331 Res = std::max(Res, X.size());
332 return Res;
333}
334
335void Fuzzer::SetMaxLen(size_t MaxLen) {
336 assert(Options.MaxLen == 0); // Can only reset MaxLen from 0 to non-0.
337 assert(MaxLen);
338 Options.MaxLen = MaxLen;
339 Printf("INFO: -max_len is not provided, using %zd\n", Options.MaxLen);
340}
341
342
343void Fuzzer::RereadOutputCorpus(size_t MaxSize) {
Ivan Krasindf919102016-01-22 22:28:27 +0000344 if (Options.OutputCorpus.empty())
345 return;
Kostya Serebryany1ac80552015-05-08 21:30:55 +0000346 std::vector<Unit> AdditionalCorpus;
347 ReadDirToVectorOfUnits(Options.OutputCorpus.c_str(), &AdditionalCorpus,
Kostya Serebryany64d24572016-03-12 01:57:04 +0000348 &EpochOfLastReadOfOutputCorpus, MaxSize);
Kostya Serebryany1ac80552015-05-08 21:30:55 +0000349 if (Corpus.empty()) {
350 Corpus = AdditionalCorpus;
351 return;
352 }
Ivan Krasindf919102016-01-22 22:28:27 +0000353 if (!Options.Reload)
354 return;
Kostya Serebryany490bbd62015-05-19 22:12:57 +0000355 if (Options.Verbosity >= 2)
Ivan Krasindf919102016-01-22 22:28:27 +0000356 Printf("Reload: read %zd new units.\n", AdditionalCorpus.size());
Kostya Serebryany1ac80552015-05-08 21:30:55 +0000357 for (auto &X : AdditionalCorpus) {
Kostya Serebryany64d24572016-03-12 01:57:04 +0000358 if (X.size() > MaxSize)
359 X.resize(MaxSize);
Kostya Serebryanycbb23342015-05-19 01:06:07 +0000360 if (UnitHashesAddedToCorpus.insert(Hash(X)).second) {
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000361 if (RunOne(X)) {
Kostya Serebryanycbb23342015-05-19 01:06:07 +0000362 Corpus.push_back(X);
Ivan Krasindf919102016-01-22 22:28:27 +0000363 UpdateCorpusDistribution();
Mike Aizatskya9c23872015-11-12 04:38:40 +0000364 PrintStats("RELOAD");
Kostya Serebryanycbb23342015-05-19 01:06:07 +0000365 }
Kostya Serebryany1ac80552015-05-08 21:30:55 +0000366 }
367 }
368}
369
Kostya Serebryany945761b2016-03-18 00:23:29 +0000370void Fuzzer::ShuffleCorpus(UnitVector *V) {
371 std::random_shuffle(V->begin(), V->end(), MD.GetRand());
372 if (Options.PreferSmall)
373 std::stable_sort(V->begin(), V->end(), [](const Unit &A, const Unit &B) {
374 return A.size() < B.size();
375 });
376}
377
Mike Aizatskyaf432a42016-05-24 23:14:29 +0000378// Tries random prefixes of corpus items.
379// Prefix length is chosen according to exponential distribution
380// to sample short lengths much more heavily.
381void Fuzzer::TruncateUnits(std::vector<Unit> *NewCorpus) {
382 size_t MaxCorpusLen = 0;
383 for (const auto &U : Corpus)
384 MaxCorpusLen = std::max(MaxCorpusLen, U.size());
385
386 if (MaxCorpusLen <= 1)
387 return;
388
389 // 50% of exponential distribution is Log[2]/lambda.
390 // Choose lambda so that median is MaxCorpusLen / 2.
391 double Lambda = 2.0 * log(2.0) / static_cast<double>(MaxCorpusLen);
392 std::exponential_distribution<> Dist(Lambda);
393 std::vector<double> Sizes;
394 size_t TruncatePoints = std::max(1ul, TruncateMaxRuns / Corpus.size());
395 Sizes.reserve(TruncatePoints);
396 for (size_t I = 0; I < TruncatePoints; ++I) {
397 Sizes.push_back(Dist(MD.GetRand().Get_mt19937()) + 1);
398 }
399 std::sort(Sizes.begin(), Sizes.end());
400
401 for (size_t S : Sizes) {
402 for (const auto &U : Corpus) {
403 if (S < U.size() && RunOne(U.data(), S)) {
404 Unit U1(U.begin(), U.begin() + S);
405 NewCorpus->push_back(U1);
406 WriteToOutputCorpus(U1);
407 PrintStatusForNewUnit(U1);
408 }
409 }
410 }
411 PrintStats("TRUNC ");
412}
413
Aaron Ballmanef116982015-01-29 16:58:29 +0000414void Fuzzer::ShuffleAndMinimize() {
Kostya Serebryany09d2a5f2015-10-22 22:56:45 +0000415 PrintStats("READ ");
Aaron Ballmanef116982015-01-29 16:58:29 +0000416 std::vector<Unit> NewCorpus;
Kostya Serebryany945761b2016-03-18 00:23:29 +0000417 if (Options.ShuffleAtStartUp)
418 ShuffleCorpus(&Corpus);
419
Mike Aizatskyaf432a42016-05-24 23:14:29 +0000420 if (Options.TruncateUnits) {
421 ResetCoverage();
422 TruncateUnits(&NewCorpus);
423 ResetCoverage();
424 }
425
Kostya Serebryany945761b2016-03-18 00:23:29 +0000426 for (const auto &U : Corpus) {
Mike Aizatsky1f88b122016-06-07 18:16:32 +0000427 bool NewCoverage = RunOne(U);
428 if (!Options.PruneCorpus || NewCoverage) {
Kostya Serebryany945761b2016-03-18 00:23:29 +0000429 NewCorpus.push_back(U);
430 if (Options.Verbosity >= 2)
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000431 Printf("NEW0: %zd L %zd\n", MaxCoverage.BlockCoverage, U.size());
Aaron Ballmanef116982015-01-29 16:58:29 +0000432 }
Kostya Serebryany4b923262016-05-26 20:25:49 +0000433 TryDetectingAMemoryLeak(U.data(), U.size(),
434 /*DuringInitialCorpusExecution*/ true);
Aaron Ballmanef116982015-01-29 16:58:29 +0000435 }
436 Corpus = NewCorpus;
Ivan Krasindf919102016-01-22 22:28:27 +0000437 UpdateCorpusDistribution();
Kostya Serebryanycbb23342015-05-19 01:06:07 +0000438 for (auto &X : Corpus)
439 UnitHashesAddedToCorpus.insert(Hash(X));
Kostya Serebryany09d2a5f2015-10-22 22:56:45 +0000440 PrintStats("INITED");
Kostya Serebryany76f42522016-06-08 01:46:13 +0000441 if (Corpus.empty()) {
442 Printf("ERROR: no interesting inputs were found. "
443 "Is the code instrumented for coverage? Exiting.\n");
444 exit(1);
445 }
Aaron Ballmanef116982015-01-29 16:58:29 +0000446}
447
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000448bool Fuzzer::UpdateMaxCoverage() {
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000449 uintptr_t PrevPcBufferPos = MaxCoverage.PcBufferPos;
450 bool Res = CController->RecordMax(&MaxCoverage);
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000451
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000452 if (Options.PrintNewCovPcs && PrevPcBufferPos != MaxCoverage.PcBufferPos) {
453 uintptr_t* PcBuffer = CController->pc_buffer();
454 for (size_t I = PrevPcBufferPos; I < MaxCoverage.PcBufferPos; ++I) {
455 Printf("%p\n", PcBuffer[I]);
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000456 }
457 }
458
459 return Res;
460}
461
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000462bool Fuzzer::RunOne(const uint8_t *Data, size_t Size) {
Aaron Ballmanef116982015-01-29 16:58:29 +0000463 TotalNumberOfRuns++;
Kostya Serebryany007c9b22015-10-22 22:50:47 +0000464
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000465 // TODO(aizatsky): this Reset call seems to be not needed.
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000466 CController->ResetCounters();
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000467 ExecuteCallback(Data, Size);
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000468 bool Res = UpdateMaxCoverage();
Kostya Serebryany007c9b22015-10-22 22:50:47 +0000469
Kostya Serebryany16901a92015-03-30 23:04:35 +0000470 auto UnitStopTime = system_clock::now();
471 auto TimeOfUnit =
472 duration_cast<seconds>(UnitStopTime - UnitStartTime).count();
Mike Aizatskya9c23872015-11-12 04:38:40 +0000473 if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) &&
474 secondsSinceProcessStartUp() >= 2)
Kostya Serebryany09d2a5f2015-10-22 22:56:45 +0000475 PrintStats("pulse ");
Kostya Serebryany70926ae2015-08-05 21:43:48 +0000476 if (TimeOfUnit > TimeOfLongestUnitInSeconds &&
477 TimeOfUnit >= Options.ReportSlowUnits) {
Kostya Serebryany16901a92015-03-30 23:04:35 +0000478 TimeOfLongestUnitInSeconds = TimeOfUnit;
Kostya Serebryany70926ae2015-08-05 21:43:48 +0000479 Printf("Slowest unit: %zd s:\n", TimeOfLongestUnitInSeconds);
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000480 WriteUnitToFileWithPrefix({Data, Data + Size}, "slow-unit-");
Kostya Serebryany16901a92015-03-30 23:04:35 +0000481 }
482 return Res;
Kostya Serebryany2c1b33b2015-01-29 23:01:07 +0000483}
484
Kostya Serebryanyf1f3f932016-05-26 20:03:02 +0000485void Fuzzer::RunOneAndUpdateCorpus(const uint8_t *Data, size_t Size) {
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000486 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
487 return;
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000488 if (RunOne(Data, Size))
489 ReportNewCoverage({Data, Data + Size});
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000490}
491
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000492size_t Fuzzer::GetCurrentUnitInFuzzingThead(const uint8_t **Data) const {
Kostya Serebryanyd8384122016-05-26 22:17:32 +0000493 assert(InFuzzingThread());
Kostya Serebryanyd8384122016-05-26 22:17:32 +0000494 *Data = CurrentUnitData;
495 return CurrentUnitSize;
496}
497
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000498void Fuzzer::ExecuteCallback(const uint8_t *Data, size_t Size) {
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000499 assert(InFuzzingThread());
Kostya Serebryany8fc3a272016-05-27 00:21:33 +0000500 LazyAllocateCurrentUnitData();
Kostya Serebryanyebb932d2016-04-18 22:50:39 +0000501 UnitStartTime = system_clock::now();
Kostya Serebryanyd50a3ee2016-01-13 23:02:30 +0000502 // We copy the contents of Unit into a separate heap buffer
503 // so that we reliably find buffer overflows in it.
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000504 std::unique_ptr<uint8_t[]> DataCopy(new uint8_t[Size]);
505 memcpy(DataCopy.get(), Data, Size);
Kostya Serebryany8fc3a272016-05-27 00:21:33 +0000506 if (CurrentUnitData && CurrentUnitData != Data)
507 memcpy(CurrentUnitData, Data, Size);
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000508 AssignTaintLabels(DataCopy.get(), Size);
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000509 CurrentUnitSize = Size;
Kostya Serebryany1bfd5832016-04-20 00:24:21 +0000510 AllocTracer.Start();
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000511 int Res = CB(DataCopy.get(), Size);
Kostya Serebryany1bfd5832016-04-20 00:24:21 +0000512 (void)Res;
513 HasMoreMallocsThanFrees = AllocTracer.Stop();
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000514 CurrentUnitSize = 0;
Kostya Serebryany20bb5e72015-10-02 23:34:06 +0000515 assert(Res == 0);
Kostya Serebryany52a788e2015-03-31 20:13:20 +0000516}
517
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000518std::string Fuzzer::Coverage::DebugString() const {
519 std::string Result =
520 std::string("Coverage{") + "BlockCoverage=" +
521 std::to_string(BlockCoverage) + " CallerCalleeCoverage=" +
522 std::to_string(CallerCalleeCoverage) + " CounterBitmapBits=" +
523 std::to_string(CounterBitmapBits) + " PcMapBits=" +
Kostya Serebryanyc98ef712016-08-16 17:37:13 +0000524 std::to_string(PCMapBits) + "}";
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000525 return Result;
Aaron Ballmanef116982015-01-29 16:58:29 +0000526}
527
528void Fuzzer::WriteToOutputCorpus(const Unit &U) {
Kostya Serebryanyf1f3f932016-05-26 20:03:02 +0000529 if (Options.OnlyASCII)
530 assert(IsASCII(U));
Ivan Krasindf919102016-01-22 22:28:27 +0000531 if (Options.OutputCorpus.empty())
532 return;
Aaron Ballmanef116982015-01-29 16:58:29 +0000533 std::string Path = DirPlusFile(Options.OutputCorpus, Hash(U));
534 WriteToFile(U, Path);
535 if (Options.Verbosity >= 2)
Kostya Serebryany7c180ea2015-05-23 01:22:35 +0000536 Printf("Written to %s\n", Path.c_str());
Aaron Ballmanef116982015-01-29 16:58:29 +0000537}
538
Kostya Serebryany2b7d2e92015-07-23 18:37:22 +0000539void Fuzzer::WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix) {
Kostya Serebryanyb91c62b2015-10-16 22:41:47 +0000540 if (!Options.SaveArtifacts)
541 return;
Kostya Serebryanybd5d1cd2015-10-09 03:57:59 +0000542 std::string Path = Options.ArtifactPrefix + Prefix + Hash(U);
Kostya Serebryany2d0ef142015-11-25 21:40:46 +0000543 if (!Options.ExactArtifactPath.empty())
Ivan Krasindf919102016-01-22 22:28:27 +0000544 Path = Options.ExactArtifactPath; // Overrides ArtifactPrefix.
Aaron Ballmanef116982015-01-29 16:58:29 +0000545 WriteToFile(U, Path);
Kostya Serebryanybd5d1cd2015-10-09 03:57:59 +0000546 Printf("artifact_prefix='%s'; Test unit written to %s\n",
547 Options.ArtifactPrefix.c_str(), Path.c_str());
Kostya Serebryany9e48cda2015-12-04 22:29:39 +0000548 if (U.size() <= kMaxUnitSizeToPrint)
549 Printf("Base64: %s\n", Base64(U).c_str());
Aaron Ballmanef116982015-01-29 16:58:29 +0000550}
551
552void Fuzzer::SaveCorpus() {
Ivan Krasindf919102016-01-22 22:28:27 +0000553 if (Options.OutputCorpus.empty())
554 return;
Aaron Ballmanef116982015-01-29 16:58:29 +0000555 for (const auto &U : Corpus)
556 WriteToFile(U, DirPlusFile(Options.OutputCorpus, Hash(U)));
557 if (Options.Verbosity)
Kostya Serebryany7c180ea2015-05-23 01:22:35 +0000558 Printf("Written corpus of %zd files to %s\n", Corpus.size(),
559 Options.OutputCorpus.c_str());
Aaron Ballmanef116982015-01-29 16:58:29 +0000560}
561
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000562void Fuzzer::PrintStatusForNewUnit(const Unit &U) {
563 if (!Options.PrintNEW)
564 return;
Kostya Serebryany09d2a5f2015-10-22 22:56:45 +0000565 PrintStats("NEW ", "");
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000566 if (Options.Verbosity) {
Kostya Serebryany14c50282015-12-19 01:09:49 +0000567 Printf(" L: %zd ", U.size());
Kostya Serebryany7ec0c562016-02-13 03:25:16 +0000568 MD.PrintMutationSequence();
Kostya Serebryany7c180ea2015-05-23 01:22:35 +0000569 Printf("\n");
Aaron Ballmanef116982015-01-29 16:58:29 +0000570 }
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000571}
572
573void Fuzzer::ReportNewCoverage(const Unit &U) {
574 Corpus.push_back(U);
Ivan Krasindf919102016-01-22 22:28:27 +0000575 UpdateCorpusDistribution();
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000576 UnitHashesAddedToCorpus.insert(Hash(U));
Kostya Serebryany7ec0c562016-02-13 03:25:16 +0000577 MD.RecordSuccessfulMutationSequence();
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000578 PrintStatusForNewUnit(U);
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000579 WriteToOutputCorpus(U);
Kostya Serebryany66ff0752016-02-26 22:42:23 +0000580 NumberOfNewUnitsAdded++;
Aaron Ballmanef116982015-01-29 16:58:29 +0000581}
582
Kostya Serebryany945761b2016-03-18 00:23:29 +0000583// Finds minimal number of units in 'Extra' that add coverage to 'Initial'.
584// We do it by actually executing the units, sometimes more than once,
585// because we may be using different coverage-like signals and the only
586// common thing between them is that we can say "this unit found new stuff".
587UnitVector Fuzzer::FindExtraUnits(const UnitVector &Initial,
588 const UnitVector &Extra) {
589 UnitVector Res = Extra;
590 size_t OldSize = Res.size();
591 for (int Iter = 0; Iter < 10; Iter++) {
592 ShuffleCorpus(&Res);
593 ResetCoverage();
594
595 for (auto &U : Initial)
596 RunOne(U);
597
598 Corpus.clear();
599 for (auto &U : Res)
600 if (RunOne(U))
601 Corpus.push_back(U);
602
603 char Stat[7] = "MIN ";
604 Stat[3] = '0' + Iter;
605 PrintStats(Stat);
606
607 size_t NewSize = Corpus.size();
Kostya Serebryanya0788e72016-05-13 22:11:23 +0000608 assert(NewSize <= OldSize);
Kostya Serebryany945761b2016-03-18 00:23:29 +0000609 Res.swap(Corpus);
610
Kostya Serebryanya0788e72016-05-13 22:11:23 +0000611 if (NewSize + 5 >= OldSize)
Kostya Serebryany945761b2016-03-18 00:23:29 +0000612 break;
613 OldSize = NewSize;
614 }
615 return Res;
616}
617
Kostya Serebryany9cc3b0d2015-10-24 01:16:40 +0000618void Fuzzer::Merge(const std::vector<std::string> &Corpora) {
619 if (Corpora.size() <= 1) {
620 Printf("Merge requires two or more corpus dirs\n");
621 return;
622 }
Kostya Serebryany9cc3b0d2015-10-24 01:16:40 +0000623 std::vector<std::string> ExtraCorpora(Corpora.begin() + 1, Corpora.end());
624
Kostya Serebryany945761b2016-03-18 00:23:29 +0000625 assert(Options.MaxLen > 0);
626 UnitVector Initial, Extra;
627 ReadDirToVectorOfUnits(Corpora[0].c_str(), &Initial, nullptr, Options.MaxLen);
628 for (auto &C : ExtraCorpora)
629 ReadDirToVectorOfUnits(C.c_str(), &Extra, nullptr, Options.MaxLen);
630
631 if (!Initial.empty()) {
632 Printf("=== Minimizing the initial corpus of %zd units\n", Initial.size());
633 Initial = FindExtraUnits({}, Initial);
Kostya Serebryany9cc3b0d2015-10-24 01:16:40 +0000634 }
Kostya Serebryany945761b2016-03-18 00:23:29 +0000635
636 Printf("=== Merging extra %zd units\n", Extra.size());
637 auto Res = FindExtraUnits(Initial, Extra);
638
639 for (auto &U: Res)
640 WriteToOutputCorpus(U);
641
642 Printf("=== Merge: written %zd units\n", Res.size());
Kostya Serebryany9cc3b0d2015-10-24 01:16:40 +0000643}
644
Kostya Serebryany1bfd5832016-04-20 00:24:21 +0000645// Tries detecting a memory leak on the particular input that we have just
646// executed before calling this function.
Kostya Serebryany4b923262016-05-26 20:25:49 +0000647void Fuzzer::TryDetectingAMemoryLeak(const uint8_t *Data, size_t Size,
648 bool DuringInitialCorpusExecution) {
Kostya Serebryany1bfd5832016-04-20 00:24:21 +0000649 if (!HasMoreMallocsThanFrees) return; // mallocs==frees, a leak is unlikely.
650 if (!Options.DetectLeaks) return;
Dan Liew1873a492016-06-07 23:32:50 +0000651 if (!&(EF->__lsan_enable) || !&(EF->__lsan_disable) ||
652 !(EF->__lsan_do_recoverable_leak_check))
Kostya Serebryany1bfd5832016-04-20 00:24:21 +0000653 return; // No lsan.
654 // Run the target once again, but with lsan disabled so that if there is
655 // a real leak we do not report it twice.
Dan Liew1873a492016-06-07 23:32:50 +0000656 EF->__lsan_disable();
Kostya Serebryany47952102016-05-29 15:58:57 +0000657 RunOne(Data, Size);
Dan Liew1873a492016-06-07 23:32:50 +0000658 EF->__lsan_enable();
Kostya Serebryany1bfd5832016-04-20 00:24:21 +0000659 if (!HasMoreMallocsThanFrees) return; // a leak is unlikely.
Kostya Serebryany7018a1a2016-04-27 19:52:34 +0000660 if (NumberOfLeakDetectionAttempts++ > 1000) {
661 Options.DetectLeaks = false;
662 Printf("INFO: libFuzzer disabled leak detection after every mutation.\n"
663 " Most likely the target function accumulates allocated\n"
664 " memory in a global state w/o actually leaking it.\n"
665 " If LeakSanitizer is enabled in this process it will still\n"
666 " run on the process shutdown.\n");
667 return;
668 }
Kostya Serebryany1bfd5832016-04-20 00:24:21 +0000669 // Now perform the actual lsan pass. This is expensive and we must ensure
670 // we don't call it too often.
Dan Liew1873a492016-06-07 23:32:50 +0000671 if (EF->__lsan_do_recoverable_leak_check()) { // Leak is found, report it.
Kostya Serebryany4b923262016-05-26 20:25:49 +0000672 if (DuringInitialCorpusExecution)
673 Printf("\nINFO: a leak has been found in the initial corpus.\n\n");
674 Printf("INFO: to ignore leaks on libFuzzer side use -detect_leaks=0.\n\n");
Kostya Serebryany0edb5632016-05-27 00:54:15 +0000675 CurrentUnitSize = Size;
Kostya Serebryany1bfd5832016-04-20 00:24:21 +0000676 DumpCurrentUnit("leak-");
677 PrintFinalStats();
678 _Exit(Options.ErrorExitCode); // not exit() to disable lsan further on.
679 }
680}
681
Kostya Serebryany27ab2d72015-12-19 02:49:09 +0000682void Fuzzer::MutateAndTestOne() {
Kostya Serebryany8fc3a272016-05-27 00:21:33 +0000683 LazyAllocateCurrentUnitData();
Kostya Serebryany7ec0c562016-02-13 03:25:16 +0000684 MD.StartMutationSequence();
Kostya Serebryany27ab2d72015-12-19 02:49:09 +0000685
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000686 auto &U = ChooseUnitToMutate();
Kostya Serebryany8fc3a272016-05-27 00:21:33 +0000687 assert(CurrentUnitData);
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000688 size_t Size = U.size();
Mike Aizatsky94e29662016-04-08 23:32:24 +0000689 assert(Size <= Options.MaxLen && "Oversized Unit");
Kostya Serebryany8fc3a272016-05-27 00:21:33 +0000690 memcpy(CurrentUnitData, U.data(), Size);
Kostya Serebryany27ab2d72015-12-19 02:49:09 +0000691
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000692 for (int i = 0; i < Options.MutateDepth; i++) {
Kostya Serebryany22cc5e22016-02-13 02:29:38 +0000693 size_t NewSize = 0;
Mike Aizatsky70fd3e42016-06-03 21:34:29 +0000694 NewSize = MD.Mutate(CurrentUnitData, Size, Options.MaxLen);
Kostya Serebryany2ea204e2015-05-30 17:33:13 +0000695 assert(NewSize > 0 && "Mutator returned empty unit");
Kostya Serebryany64d24572016-03-12 01:57:04 +0000696 assert(NewSize <= Options.MaxLen &&
Kostya Serebryany2ea204e2015-05-30 17:33:13 +0000697 "Mutator return overisized unit");
Kostya Serebryany8a5bef02016-02-13 17:56:51 +0000698 Size = NewSize;
Kostya Serebryanyb65805a2016-01-09 03:08:58 +0000699 if (i == 0)
700 StartTraceRecording();
Kostya Serebryany8fc3a272016-05-27 00:21:33 +0000701 RunOneAndUpdateCorpus(CurrentUnitData, Size);
Kostya Serebryanyb65805a2016-01-09 03:08:58 +0000702 StopTraceRecording();
Kostya Serebryany8fc3a272016-05-27 00:21:33 +0000703 TryDetectingAMemoryLeak(CurrentUnitData, Size,
Kostya Serebryany4b923262016-05-26 20:25:49 +0000704 /*DuringInitialCorpusExecution*/ false);
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000705 }
706}
707
Kostya Serebryanye6926212015-11-04 23:22:25 +0000708// Returns an index of random unit from the corpus to mutate.
709// Hypothesis: units added to the corpus last are more likely to be interesting.
Ivan Krasindf919102016-01-22 22:28:27 +0000710// This function gives more weight to the more recent units.
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000711size_t Fuzzer::ChooseUnitIdxToMutate() {
Kostya Serebryany7ec0c562016-02-13 03:25:16 +0000712 size_t Idx =
713 static_cast<size_t>(CorpusDistribution(MD.GetRand().Get_mt19937()));
Ivan Krasindf919102016-01-22 22:28:27 +0000714 assert(Idx < Corpus.size());
715 return Idx;
Kostya Serebryanye6926212015-11-04 23:22:25 +0000716}
717
Kostya Serebryany945761b2016-03-18 00:23:29 +0000718void Fuzzer::ResetCoverage() {
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000719 CController->Reset();
Mike Aizatsky1aa501e2016-05-10 23:43:15 +0000720 MaxCoverage.Reset();
Mike Aizatskyb4bbc3b2016-08-05 20:09:53 +0000721 CController->Prepare(&MaxCoverage);
Kostya Serebryany945761b2016-03-18 00:23:29 +0000722}
723
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000724// Experimental search heuristic: drilling.
725// - Read, shuffle, execute and minimize the corpus.
726// - Choose one random unit.
727// - Reset the coverage.
728// - Start fuzzing as if the chosen unit was the only element of the corpus.
729// - When done, reset the coverage again.
730// - Merge the newly created corpus into the original one.
731void Fuzzer::Drill() {
732 // The corpus is already read, shuffled, and minimized.
733 assert(!Corpus.empty());
Ivan Krasindf919102016-01-22 22:28:27 +0000734 Options.PrintNEW = false; // Don't print NEW status lines when drilling.
Kostya Serebryany7d211662015-09-04 00:12:11 +0000735
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000736 Unit U = ChooseUnitToMutate();
737
Kostya Serebryany945761b2016-03-18 00:23:29 +0000738 ResetCoverage();
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000739
740 std::vector<Unit> SavedCorpus;
741 SavedCorpus.swap(Corpus);
742 Corpus.push_back(U);
Ivan Krasindf919102016-01-22 22:28:27 +0000743 UpdateCorpusDistribution();
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000744 assert(Corpus.size() == 1);
745 RunOne(U);
746 PrintStats("DRILL ");
747 std::string SavedOutputCorpusPath; // Don't write new units while drilling.
748 SavedOutputCorpusPath.swap(Options.OutputCorpus);
749 Loop();
750
Kostya Serebryany945761b2016-03-18 00:23:29 +0000751 ResetCoverage();
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000752
753 PrintStats("REINIT");
754 SavedOutputCorpusPath.swap(Options.OutputCorpus);
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000755 for (auto &U : SavedCorpus)
Kostya Serebryanydc3135d2015-11-12 01:02:01 +0000756 RunOne(U);
757 PrintStats("MERGE ");
758 Options.PrintNEW = true;
759 size_t NumMerged = 0;
760 for (auto &U : Corpus) {
761 if (RunOne(U)) {
762 PrintStatusForNewUnit(U);
763 NumMerged++;
764 WriteToOutputCorpus(U);
765 }
766 }
767 PrintStats("MERGED");
768 if (NumMerged && Options.Verbosity)
769 Printf("Drilling discovered %zd new units\n", NumMerged);
770}
771
772void Fuzzer::Loop() {
Kostya Serebryany8617aaa2015-12-05 02:09:22 +0000773 system_clock::time_point LastCorpusReload = system_clock::now();
Kostya Serebryany27ab2d72015-12-19 02:49:09 +0000774 if (Options.DoCrossOver)
Kostya Serebryany7ec0c562016-02-13 03:25:16 +0000775 MD.SetCorpus(&Corpus);
Kostya Serebryany468ed782015-09-08 17:30:35 +0000776 while (true) {
Kostya Serebryany8617aaa2015-12-05 02:09:22 +0000777 auto Now = system_clock::now();
778 if (duration_cast<seconds>(Now - LastCorpusReload).count()) {
Kostya Serebryany64d24572016-03-12 01:57:04 +0000779 RereadOutputCorpus(Options.MaxLen);
Kostya Serebryany8617aaa2015-12-05 02:09:22 +0000780 LastCorpusReload = Now;
781 }
Kostya Serebryanye6926212015-11-04 23:22:25 +0000782 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
Mike Aizatskya9c23872015-11-12 04:38:40 +0000783 break;
Kostya Serebryanye6926212015-11-04 23:22:25 +0000784 if (Options.MaxTotalTimeSec > 0 &&
785 secondsSinceProcessStartUp() >
Ivan Krasindf919102016-01-22 22:28:27 +0000786 static_cast<size_t>(Options.MaxTotalTimeSec))
Mike Aizatskya9c23872015-11-12 04:38:40 +0000787 break;
Kostya Serebryanye6926212015-11-04 23:22:25 +0000788 // Perform several mutations and runs.
Kostya Serebryany27ab2d72015-12-19 02:49:09 +0000789 MutateAndTestOne();
Aaron Ballmanef116982015-01-29 16:58:29 +0000790 }
Mike Aizatskya9c23872015-11-12 04:38:40 +0000791
792 PrintStats("DONE ", "\n");
Kostya Serebryany7ec0c562016-02-13 03:25:16 +0000793 MD.PrintRecommendedDictionary();
Aaron Ballmanef116982015-01-29 16:58:29 +0000794}
795
Ivan Krasindf919102016-01-22 22:28:27 +0000796void Fuzzer::UpdateCorpusDistribution() {
797 size_t N = Corpus.size();
798 std::vector<double> Intervals(N + 1);
799 std::vector<double> Weights(N);
800 std::iota(Intervals.begin(), Intervals.end(), 0);
801 std::iota(Weights.begin(), Weights.end(), 1);
802 CorpusDistribution = std::piecewise_constant_distribution<double>(
803 Intervals.begin(), Intervals.end(), Weights.begin());
804}
805
806} // namespace fuzzer
Kostya Serebryany8b0d90a2016-05-13 18:04:35 +0000807
808extern "C" {
809
810size_t LLVMFuzzerMutate(uint8_t *Data, size_t Size, size_t MaxSize) {
811 assert(fuzzer::F);
Mike Aizatsky70fd3e42016-06-03 21:34:29 +0000812 return fuzzer::F->GetMD().DefaultMutate(Data, Size, MaxSize);
Kostya Serebryany8b0d90a2016-05-13 18:04:35 +0000813}
814} // extern "C"