blob: 7dc2fd48dd7159c33224d75446f4da23bed3817d [file] [log] [blame]
george.karpenkov29efa6d2017-08-21 23:25:50 +00001//===- FuzzerLoop.cpp - Fuzzer's main loop --------------------------------===//
2//
chandlerc40284492019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
george.karpenkov29efa6d2017-08-21 23:25:50 +00006//
7//===----------------------------------------------------------------------===//
8// Fuzzer's main loop.
9//===----------------------------------------------------------------------===//
10
11#include "FuzzerCorpus.h"
12#include "FuzzerIO.h"
13#include "FuzzerInternal.h"
14#include "FuzzerMutate.h"
15#include "FuzzerRandom.h"
george.karpenkov29efa6d2017-08-21 23:25:50 +000016#include "FuzzerTracePC.h"
17#include <algorithm>
18#include <cstring>
19#include <memory>
vitalybukab3e5a2c2017-11-01 03:02:59 +000020#include <mutex>
george.karpenkov29efa6d2017-08-21 23:25:50 +000021#include <set>
22
23#if defined(__has_include)
24#if __has_include(<sanitizer / lsan_interface.h>)
25#include <sanitizer/lsan_interface.h>
26#endif
27#endif
28
29#define NO_SANITIZE_MEMORY
30#if defined(__has_feature)
31#if __has_feature(memory_sanitizer)
32#undef NO_SANITIZE_MEMORY
33#define NO_SANITIZE_MEMORY __attribute__((no_sanitize_memory))
34#endif
35#endif
36
37namespace fuzzer {
38static const size_t kMaxUnitSizeToPrint = 256;
39
40thread_local bool Fuzzer::IsMyThread;
41
morehousec6ee8752018-07-17 16:12:00 +000042bool RunningUserCallback = false;
43
george.karpenkov29efa6d2017-08-21 23:25:50 +000044// Only one Fuzzer per process.
45static Fuzzer *F;
46
47// Leak detection is expensive, so we first check if there were more mallocs
48// than frees (using the sanitizer malloc hooks) and only then try to call lsan.
49struct MallocFreeTracer {
50 void Start(int TraceLevel) {
51 this->TraceLevel = TraceLevel;
52 if (TraceLevel)
53 Printf("MallocFreeTracer: START\n");
54 Mallocs = 0;
55 Frees = 0;
56 }
57 // Returns true if there were more mallocs than frees.
58 bool Stop() {
59 if (TraceLevel)
60 Printf("MallocFreeTracer: STOP %zd %zd (%s)\n", Mallocs.load(),
61 Frees.load(), Mallocs == Frees ? "same" : "DIFFERENT");
62 bool Result = Mallocs > Frees;
63 Mallocs = 0;
64 Frees = 0;
65 TraceLevel = 0;
66 return Result;
67 }
68 std::atomic<size_t> Mallocs;
69 std::atomic<size_t> Frees;
70 int TraceLevel = 0;
vitalybukae6504cf2017-11-02 04:12:10 +000071
72 std::recursive_mutex TraceMutex;
73 bool TraceDisabled = false;
george.karpenkov29efa6d2017-08-21 23:25:50 +000074};
75
76static MallocFreeTracer AllocTracer;
77
vitalybukae6504cf2017-11-02 04:12:10 +000078// Locks printing and avoids nested hooks triggered from mallocs/frees in
79// sanitizer.
80class TraceLock {
81public:
82 TraceLock() : Lock(AllocTracer.TraceMutex) {
83 AllocTracer.TraceDisabled = !AllocTracer.TraceDisabled;
84 }
85 ~TraceLock() { AllocTracer.TraceDisabled = !AllocTracer.TraceDisabled; }
86
87 bool IsDisabled() const {
88 // This is already inverted value.
89 return !AllocTracer.TraceDisabled;
90 }
91
92private:
93 std::lock_guard<std::recursive_mutex> Lock;
94};
vitalybukab3e5a2c2017-11-01 03:02:59 +000095
george.karpenkov29efa6d2017-08-21 23:25:50 +000096ATTRIBUTE_NO_SANITIZE_MEMORY
97void MallocHook(const volatile void *ptr, size_t size) {
98 size_t N = AllocTracer.Mallocs++;
99 F->HandleMalloc(size);
100 if (int TraceLevel = AllocTracer.TraceLevel) {
vitalybukae6504cf2017-11-02 04:12:10 +0000101 TraceLock Lock;
102 if (Lock.IsDisabled())
103 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000104 Printf("MALLOC[%zd] %p %zd\n", N, ptr, size);
105 if (TraceLevel >= 2 && EF)
morehousebd67cc22018-05-08 23:45:05 +0000106 PrintStackTrace();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000107 }
108}
109
110ATTRIBUTE_NO_SANITIZE_MEMORY
111void FreeHook(const volatile void *ptr) {
112 size_t N = AllocTracer.Frees++;
113 if (int TraceLevel = AllocTracer.TraceLevel) {
vitalybukae6504cf2017-11-02 04:12:10 +0000114 TraceLock Lock;
115 if (Lock.IsDisabled())
116 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000117 Printf("FREE[%zd] %p\n", N, ptr);
118 if (TraceLevel >= 2 && EF)
morehousebd67cc22018-05-08 23:45:05 +0000119 PrintStackTrace();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000120 }
121}
122
123// Crash on a single malloc that exceeds the rss limit.
124void Fuzzer::HandleMalloc(size_t Size) {
kcc120e40b2017-12-01 22:12:04 +0000125 if (!Options.MallocLimitMb || (Size >> 20) < (size_t)Options.MallocLimitMb)
george.karpenkov29efa6d2017-08-21 23:25:50 +0000126 return;
127 Printf("==%d== ERROR: libFuzzer: out-of-memory (malloc(%zd))\n", GetPid(),
128 Size);
129 Printf(" To change the out-of-memory limit use -rss_limit_mb=<N>\n\n");
morehousebd67cc22018-05-08 23:45:05 +0000130 PrintStackTrace();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000131 DumpCurrentUnit("oom-");
132 Printf("SUMMARY: libFuzzer: out-of-memory\n");
133 PrintFinalStats();
kcc4b5aa122019-02-09 00:16:21 +0000134 _Exit(Options.OOMExitCode); // Stop right now.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000135}
136
137Fuzzer::Fuzzer(UserCallback CB, InputCorpus &Corpus, MutationDispatcher &MD,
138 FuzzingOptions Options)
139 : CB(CB), Corpus(Corpus), MD(MD), Options(Options) {
140 if (EF->__sanitizer_set_death_callback)
141 EF->__sanitizer_set_death_callback(StaticDeathCallback);
142 assert(!F);
143 F = this;
144 TPC.ResetMaps();
145 IsMyThread = true;
146 if (Options.DetectLeaks && EF->__sanitizer_install_malloc_and_free_hooks)
147 EF->__sanitizer_install_malloc_and_free_hooks(MallocHook, FreeHook);
148 TPC.SetUseCounters(Options.UseCounters);
kcc3850d062018-07-03 22:33:09 +0000149 TPC.SetUseValueProfileMask(Options.UseValueProfile);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000150
151 if (Options.Verbosity)
152 TPC.PrintModuleInfo();
153 if (!Options.OutputCorpus.empty() && Options.ReloadIntervalSec)
154 EpochOfLastReadOfOutputCorpus = GetEpoch(Options.OutputCorpus);
155 MaxInputLen = MaxMutationLen = Options.MaxLen;
156 TmpMaxMutationLen = Max(size_t(4), Corpus.MaxInputSize());
157 AllocateCurrentUnitData();
158 CurrentUnitSize = 0;
159 memset(BaseSha1, 0, sizeof(BaseSha1));
kcc3acbe072018-05-16 23:26:37 +0000160 TPC.SetFocusFunction(Options.FocusFunction);
kcc86e43882018-06-06 01:23:29 +0000161 DFT.Init(Options.DataFlowTrace, Options.FocusFunction);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000162}
163
alekseyshl9f6a9f22017-10-23 23:24:33 +0000164Fuzzer::~Fuzzer() {}
george.karpenkov29efa6d2017-08-21 23:25:50 +0000165
166void Fuzzer::AllocateCurrentUnitData() {
alekseyshl9f6a9f22017-10-23 23:24:33 +0000167 if (CurrentUnitData || MaxInputLen == 0)
168 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000169 CurrentUnitData = new uint8_t[MaxInputLen];
170}
171
172void Fuzzer::StaticDeathCallback() {
173 assert(F);
174 F->DeathCallback();
175}
176
177void Fuzzer::DumpCurrentUnit(const char *Prefix) {
alekseyshl9f6a9f22017-10-23 23:24:33 +0000178 if (!CurrentUnitData)
179 return; // Happens when running individual inputs.
morehouse1467b792018-07-09 23:51:08 +0000180 ScopedDisableMsanInterceptorChecks S;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000181 MD.PrintMutationSequence();
182 Printf("; base unit: %s\n", Sha1ToString(BaseSha1).c_str());
183 size_t UnitSize = CurrentUnitSize;
184 if (UnitSize <= kMaxUnitSizeToPrint) {
185 PrintHexArray(CurrentUnitData, UnitSize, "\n");
186 PrintASCII(CurrentUnitData, UnitSize, "\n");
187 }
188 WriteUnitToFileWithPrefix({CurrentUnitData, CurrentUnitData + UnitSize},
189 Prefix);
190}
191
192NO_SANITIZE_MEMORY
193void Fuzzer::DeathCallback() {
194 DumpCurrentUnit("crash-");
195 PrintFinalStats();
196}
197
198void Fuzzer::StaticAlarmCallback() {
199 assert(F);
200 F->AlarmCallback();
201}
202
203void Fuzzer::StaticCrashSignalCallback() {
204 assert(F);
205 F->CrashCallback();
206}
207
208void Fuzzer::StaticExitCallback() {
209 assert(F);
210 F->ExitCallback();
211}
212
213void Fuzzer::StaticInterruptCallback() {
214 assert(F);
215 F->InterruptCallback();
216}
217
kcc1239a992017-11-09 20:30:19 +0000218void Fuzzer::StaticGracefulExitCallback() {
219 assert(F);
220 F->GracefulExitRequested = true;
221 Printf("INFO: signal received, trying to exit gracefully\n");
222}
223
george.karpenkov29efa6d2017-08-21 23:25:50 +0000224void Fuzzer::StaticFileSizeExceedCallback() {
225 Printf("==%lu== ERROR: libFuzzer: file size exceeded\n", GetPid());
226 exit(1);
227}
228
229void Fuzzer::CrashCallback() {
yln3418b942019-01-31 01:24:01 +0000230 if (EF->__sanitizer_acquire_crash_state &&
231 !EF->__sanitizer_acquire_crash_state())
232 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000233 Printf("==%lu== ERROR: libFuzzer: deadly signal\n", GetPid());
morehousebd67cc22018-05-08 23:45:05 +0000234 PrintStackTrace();
george.karpenkov29efa6d2017-08-21 23:25:50 +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();
alekseyshl9f6a9f22017-10-23 23:24:33 +0000241 _Exit(Options.ErrorExitCode); // Stop right now.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000242}
243
244void Fuzzer::ExitCallback() {
morehousec6ee8752018-07-17 16:12:00 +0000245 if (!RunningUserCallback)
george.karpenkov29efa6d2017-08-21 23:25:50 +0000246 return; // This exit did not come from the user callback
morehouse5a4566a2018-05-01 21:01:53 +0000247 if (EF->__sanitizer_acquire_crash_state &&
248 !EF->__sanitizer_acquire_crash_state())
249 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000250 Printf("==%lu== ERROR: libFuzzer: fuzz target exited\n", GetPid());
morehousebd67cc22018-05-08 23:45:05 +0000251 PrintStackTrace();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000252 Printf("SUMMARY: libFuzzer: fuzz target exited\n");
253 DumpCurrentUnit("crash-");
254 PrintFinalStats();
255 _Exit(Options.ErrorExitCode);
256}
257
kcc1239a992017-11-09 20:30:19 +0000258void Fuzzer::MaybeExitGracefully() {
kcca3815862019-02-08 21:27:23 +0000259 if (!F->GracefulExitRequested) return;
kcc1239a992017-11-09 20:30:19 +0000260 Printf("==%lu== INFO: libFuzzer: exiting as requested\n", GetPid());
kcca3815862019-02-08 21:27:23 +0000261 F->PrintFinalStats();
kcc1239a992017-11-09 20:30:19 +0000262 _Exit(0);
263}
264
george.karpenkov29efa6d2017-08-21 23:25:50 +0000265void Fuzzer::InterruptCallback() {
266 Printf("==%lu== libFuzzer: run interrupted; exiting\n", GetPid());
267 PrintFinalStats();
kcc4b5aa122019-02-09 00:16:21 +0000268 // Stop right now, don't perform any at-exit actions.
269 _Exit(Options.InterruptExitCode);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000270}
271
272NO_SANITIZE_MEMORY
273void Fuzzer::AlarmCallback() {
274 assert(Options.UnitTimeoutSec > 0);
275 // In Windows Alarm callback is executed by a different thread.
kamil3849ee02018-11-06 01:28:01 +0000276 // NetBSD's current behavior needs this change too.
277#if !LIBFUZZER_WINDOWS && !LIBFUZZER_NETBSD
alekseyshl9f6a9f22017-10-23 23:24:33 +0000278 if (!InFuzzingThread())
279 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000280#endif
morehousec6ee8752018-07-17 16:12:00 +0000281 if (!RunningUserCallback)
george.karpenkov29efa6d2017-08-21 23:25:50 +0000282 return; // We have not started running units yet.
283 size_t Seconds =
284 duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
285 if (Seconds == 0)
286 return;
287 if (Options.Verbosity >= 2)
288 Printf("AlarmCallback %zd\n", Seconds);
289 if (Seconds >= (size_t)Options.UnitTimeoutSec) {
morehouse5a4566a2018-05-01 21:01:53 +0000290 if (EF->__sanitizer_acquire_crash_state &&
291 !EF->__sanitizer_acquire_crash_state())
292 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000293 Printf("ALARM: working on the last Unit for %zd seconds\n", Seconds);
294 Printf(" and the timeout value is %d (use -timeout=N to change)\n",
295 Options.UnitTimeoutSec);
296 DumpCurrentUnit("timeout-");
297 Printf("==%lu== ERROR: libFuzzer: timeout after %d seconds\n", GetPid(),
298 Seconds);
morehousebd67cc22018-05-08 23:45:05 +0000299 PrintStackTrace();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000300 Printf("SUMMARY: libFuzzer: timeout\n");
301 PrintFinalStats();
302 _Exit(Options.TimeoutExitCode); // Stop right now.
303 }
304}
305
306void Fuzzer::RssLimitCallback() {
morehouse5a4566a2018-05-01 21:01:53 +0000307 if (EF->__sanitizer_acquire_crash_state &&
308 !EF->__sanitizer_acquire_crash_state())
309 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000310 Printf(
311 "==%lu== ERROR: libFuzzer: out-of-memory (used: %zdMb; limit: %zdMb)\n",
312 GetPid(), GetPeakRSSMb(), Options.RssLimitMb);
313 Printf(" To change the out-of-memory limit use -rss_limit_mb=<N>\n\n");
morehousebd67cc22018-05-08 23:45:05 +0000314 PrintMemoryProfile();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000315 DumpCurrentUnit("oom-");
316 Printf("SUMMARY: libFuzzer: out-of-memory\n");
317 PrintFinalStats();
kcc4b5aa122019-02-09 00:16:21 +0000318 _Exit(Options.OOMExitCode); // Stop right now.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000319}
320
321void Fuzzer::PrintStats(const char *Where, const char *End, size_t Units) {
322 size_t ExecPerSec = execPerSec();
323 if (!Options.Verbosity)
324 return;
325 Printf("#%zd\t%s", TotalNumberOfRuns, Where);
326 if (size_t N = TPC.GetTotalPCCoverage())
327 Printf(" cov: %zd", N);
328 if (size_t N = Corpus.NumFeatures())
alekseyshl9f6a9f22017-10-23 23:24:33 +0000329 Printf(" ft: %zd", N);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000330 if (!Corpus.empty()) {
331 Printf(" corp: %zd", Corpus.NumActiveUnits());
332 if (size_t N = Corpus.SizeInBytes()) {
alekseyshl9f6a9f22017-10-23 23:24:33 +0000333 if (N < (1 << 14))
george.karpenkov29efa6d2017-08-21 23:25:50 +0000334 Printf("/%zdb", N);
335 else if (N < (1 << 24))
336 Printf("/%zdKb", N >> 10);
337 else
338 Printf("/%zdMb", N >> 20);
339 }
kcc3acbe072018-05-16 23:26:37 +0000340 if (size_t FF = Corpus.NumInputsThatTouchFocusFunction())
341 Printf(" focus: %zd", FF);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000342 }
morehousea6c692c2018-02-22 19:00:17 +0000343 if (TmpMaxMutationLen)
344 Printf(" lim: %zd", TmpMaxMutationLen);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000345 if (Units)
346 Printf(" units: %zd", Units);
347
348 Printf(" exec/s: %zd", ExecPerSec);
349 Printf(" rss: %zdMb", GetPeakRSSMb());
350 Printf("%s", End);
351}
352
353void Fuzzer::PrintFinalStats() {
354 if (Options.PrintCoverage)
355 TPC.PrintCoverage();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000356 if (Options.PrintCorpusStats)
357 Corpus.PrintStats();
alekseyshl9f6a9f22017-10-23 23:24:33 +0000358 if (!Options.PrintFinalStats)
359 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000360 size_t ExecPerSec = execPerSec();
361 Printf("stat::number_of_executed_units: %zd\n", TotalNumberOfRuns);
362 Printf("stat::average_exec_per_sec: %zd\n", ExecPerSec);
363 Printf("stat::new_units_added: %zd\n", NumberOfNewUnitsAdded);
364 Printf("stat::slowest_unit_time_sec: %zd\n", TimeOfLongestUnitInSeconds);
365 Printf("stat::peak_rss_mb: %zd\n", GetPeakRSSMb());
366}
367
368void Fuzzer::SetMaxInputLen(size_t MaxInputLen) {
369 assert(this->MaxInputLen == 0); // Can only reset MaxInputLen from 0 to non-0.
370 assert(MaxInputLen);
371 this->MaxInputLen = MaxInputLen;
372 this->MaxMutationLen = MaxInputLen;
373 AllocateCurrentUnitData();
374 Printf("INFO: -max_len is not provided; "
375 "libFuzzer will not generate inputs larger than %zd bytes\n",
376 MaxInputLen);
377}
378
379void Fuzzer::SetMaxMutationLen(size_t MaxMutationLen) {
380 assert(MaxMutationLen && MaxMutationLen <= MaxInputLen);
381 this->MaxMutationLen = MaxMutationLen;
382}
383
384void Fuzzer::CheckExitOnSrcPosOrItem() {
385 if (!Options.ExitOnSrcPos.empty()) {
george.karpenkovfbfa45c2017-08-27 23:20:09 +0000386 static auto *PCsSet = new Set<uintptr_t>;
kcc001e5f72019-02-14 23:12:33 +0000387 auto HandlePC = [&](const TracePC::PCTableEntry *TE) {
388 if (!PCsSet->insert(TE->PC).second)
alekseyshl9f6a9f22017-10-23 23:24:33 +0000389 return;
kcc001e5f72019-02-14 23:12:33 +0000390 std::string Descr = DescribePC("%F %L", TE->PC + 1);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000391 if (Descr.find(Options.ExitOnSrcPos) != std::string::npos) {
392 Printf("INFO: found line matching '%s', exiting.\n",
393 Options.ExitOnSrcPos.c_str());
394 _Exit(0);
395 }
396 };
397 TPC.ForEachObservedPC(HandlePC);
398 }
399 if (!Options.ExitOnItem.empty()) {
400 if (Corpus.HasUnit(Options.ExitOnItem)) {
401 Printf("INFO: found item with checksum '%s', exiting.\n",
402 Options.ExitOnItem.c_str());
403 _Exit(0);
404 }
405 }
406}
407
408void Fuzzer::RereadOutputCorpus(size_t MaxSize) {
alekseyshl9f6a9f22017-10-23 23:24:33 +0000409 if (Options.OutputCorpus.empty() || !Options.ReloadIntervalSec)
410 return;
george.karpenkovfbfa45c2017-08-27 23:20:09 +0000411 Vector<Unit> AdditionalCorpus;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000412 ReadDirToVectorOfUnits(Options.OutputCorpus.c_str(), &AdditionalCorpus,
413 &EpochOfLastReadOfOutputCorpus, MaxSize,
414 /*ExitOnError*/ false);
415 if (Options.Verbosity >= 2)
416 Printf("Reload: read %zd new units.\n", AdditionalCorpus.size());
417 bool Reloaded = false;
418 for (auto &U : AdditionalCorpus) {
419 if (U.size() > MaxSize)
420 U.resize(MaxSize);
421 if (!Corpus.HasUnit(U)) {
422 if (RunOne(U.data(), U.size())) {
423 CheckExitOnSrcPosOrItem();
424 Reloaded = true;
425 }
426 }
427 }
428 if (Reloaded)
429 PrintStats("RELOAD");
430}
431
george.karpenkov29efa6d2017-08-21 23:25:50 +0000432void Fuzzer::PrintPulseAndReportSlowInput(const uint8_t *Data, size_t Size) {
433 auto TimeOfUnit =
434 duration_cast<seconds>(UnitStopTime - UnitStartTime).count();
435 if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) &&
436 secondsSinceProcessStartUp() >= 2)
437 PrintStats("pulse ");
438 if (TimeOfUnit > TimeOfLongestUnitInSeconds * 1.1 &&
439 TimeOfUnit >= Options.ReportSlowUnits) {
440 TimeOfLongestUnitInSeconds = TimeOfUnit;
441 Printf("Slowest unit: %zd s:\n", TimeOfLongestUnitInSeconds);
442 WriteUnitToFileWithPrefix({Data, Data + Size}, "slow-unit-");
443 }
444}
445
446bool Fuzzer::RunOne(const uint8_t *Data, size_t Size, bool MayDeleteFile,
kccb6836be2017-12-01 19:18:38 +0000447 InputInfo *II, bool *FoundUniqFeatures) {
alekseyshl9f6a9f22017-10-23 23:24:33 +0000448 if (!Size)
449 return false;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000450
451 ExecuteCallback(Data, Size);
452
453 UniqFeatureSetTmp.clear();
454 size_t FoundUniqFeaturesOfII = 0;
455 size_t NumUpdatesBefore = Corpus.NumFeatureUpdates();
456 TPC.CollectFeatures([&](size_t Feature) {
457 if (Corpus.AddFeature(Feature, Size, Options.Shrink))
458 UniqFeatureSetTmp.push_back(Feature);
459 if (Options.ReduceInputs && II)
460 if (std::binary_search(II->UniqFeatureSet.begin(),
461 II->UniqFeatureSet.end(), Feature))
462 FoundUniqFeaturesOfII++;
463 });
kccb6836be2017-12-01 19:18:38 +0000464 if (FoundUniqFeatures)
465 *FoundUniqFeatures = FoundUniqFeaturesOfII;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000466 PrintPulseAndReportSlowInput(Data, Size);
467 size_t NumNewFeatures = Corpus.NumFeatureUpdates() - NumUpdatesBefore;
468 if (NumNewFeatures) {
469 TPC.UpdateObservedPCs();
470 Corpus.AddToCorpus({Data, Data + Size}, NumNewFeatures, MayDeleteFile,
kcc0cab3f02018-07-19 01:23:32 +0000471 TPC.ObservedFocusFunction(), UniqFeatureSetTmp, DFT, II);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000472 return true;
473 }
474 if (II && FoundUniqFeaturesOfII &&
kccadf188b2018-06-07 01:40:20 +0000475 II->DataFlowTraceForFocusFunction.empty() &&
george.karpenkov29efa6d2017-08-21 23:25:50 +0000476 FoundUniqFeaturesOfII == II->UniqFeatureSet.size() &&
477 II->U.size() > Size) {
478 Corpus.Replace(II, {Data, Data + Size});
479 return true;
480 }
481 return false;
482}
483
484size_t Fuzzer::GetCurrentUnitInFuzzingThead(const uint8_t **Data) const {
485 assert(InFuzzingThread());
486 *Data = CurrentUnitData;
487 return CurrentUnitSize;
488}
489
490void Fuzzer::CrashOnOverwrittenData() {
491 Printf("==%d== ERROR: libFuzzer: fuzz target overwrites it's const input\n",
492 GetPid());
493 DumpCurrentUnit("crash-");
494 Printf("SUMMARY: libFuzzer: out-of-memory\n");
495 _Exit(Options.ErrorExitCode); // Stop right now.
496}
497
498// Compare two arrays, but not all bytes if the arrays are large.
499static bool LooseMemeq(const uint8_t *A, const uint8_t *B, size_t Size) {
500 const size_t Limit = 64;
501 if (Size <= 64)
502 return !memcmp(A, B, Size);
503 // Compare first and last Limit/2 bytes.
504 return !memcmp(A, B, Limit / 2) &&
505 !memcmp(A + Size - Limit / 2, B + Size - Limit / 2, Limit / 2);
506}
507
508void Fuzzer::ExecuteCallback(const uint8_t *Data, size_t Size) {
509 TPC.RecordInitialStack();
510 TotalNumberOfRuns++;
511 assert(InFuzzingThread());
george.karpenkov29efa6d2017-08-21 23:25:50 +0000512 // We copy the contents of Unit into a separate heap buffer
513 // so that we reliably find buffer overflows in it.
514 uint8_t *DataCopy = new uint8_t[Size];
515 memcpy(DataCopy, Data, Size);
morehouse1467b792018-07-09 23:51:08 +0000516 if (EF->__msan_unpoison)
517 EF->__msan_unpoison(DataCopy, Size);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000518 if (CurrentUnitData && CurrentUnitData != Data)
519 memcpy(CurrentUnitData, Data, Size);
520 CurrentUnitSize = Size;
morehouse1467b792018-07-09 23:51:08 +0000521 {
522 ScopedEnableMsanInterceptorChecks S;
523 AllocTracer.Start(Options.TraceMalloc);
524 UnitStartTime = system_clock::now();
525 TPC.ResetMaps();
morehousec6ee8752018-07-17 16:12:00 +0000526 RunningUserCallback = true;
morehouse1467b792018-07-09 23:51:08 +0000527 int Res = CB(DataCopy, Size);
morehousec6ee8752018-07-17 16:12:00 +0000528 RunningUserCallback = false;
morehouse1467b792018-07-09 23:51:08 +0000529 UnitStopTime = system_clock::now();
530 (void)Res;
531 assert(Res == 0);
532 HasMoreMallocsThanFrees = AllocTracer.Stop();
533 }
george.karpenkov29efa6d2017-08-21 23:25:50 +0000534 if (!LooseMemeq(DataCopy, Data, Size))
535 CrashOnOverwrittenData();
536 CurrentUnitSize = 0;
537 delete[] DataCopy;
538}
539
kcc243006d2019-02-12 00:12:33 +0000540std::string Fuzzer::WriteToOutputCorpus(const Unit &U) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000541 if (Options.OnlyASCII)
542 assert(IsASCII(U));
543 if (Options.OutputCorpus.empty())
kcc243006d2019-02-12 00:12:33 +0000544 return "";
george.karpenkov29efa6d2017-08-21 23:25:50 +0000545 std::string Path = DirPlusFile(Options.OutputCorpus, Hash(U));
546 WriteToFile(U, Path);
547 if (Options.Verbosity >= 2)
548 Printf("Written %zd bytes to %s\n", U.size(), Path.c_str());
kcc243006d2019-02-12 00:12:33 +0000549 return Path;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000550}
551
552void Fuzzer::WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix) {
553 if (!Options.SaveArtifacts)
554 return;
555 std::string Path = Options.ArtifactPrefix + Prefix + Hash(U);
556 if (!Options.ExactArtifactPath.empty())
557 Path = Options.ExactArtifactPath; // Overrides ArtifactPrefix.
558 WriteToFile(U, Path);
559 Printf("artifact_prefix='%s'; Test unit written to %s\n",
560 Options.ArtifactPrefix.c_str(), Path.c_str());
561 if (U.size() <= kMaxUnitSizeToPrint)
562 Printf("Base64: %s\n", Base64(U).c_str());
563}
564
565void Fuzzer::PrintStatusForNewUnit(const Unit &U, const char *Text) {
566 if (!Options.PrintNEW)
567 return;
568 PrintStats(Text, "");
569 if (Options.Verbosity) {
570 Printf(" L: %zd/%zd ", U.size(), Corpus.MaxInputSize());
571 MD.PrintMutationSequence();
572 Printf("\n");
573 }
574}
575
576void Fuzzer::ReportNewCoverage(InputInfo *II, const Unit &U) {
577 II->NumSuccessfullMutations++;
578 MD.RecordSuccessfulMutationSequence();
alekseyshl9f6a9f22017-10-23 23:24:33 +0000579 PrintStatusForNewUnit(U, II->Reduced ? "REDUCE" : "NEW ");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000580 WriteToOutputCorpus(U);
581 NumberOfNewUnitsAdded++;
alekseyshl9f6a9f22017-10-23 23:24:33 +0000582 CheckExitOnSrcPosOrItem(); // Check only after the unit is saved to corpus.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000583 LastCorpusUpdateRun = TotalNumberOfRuns;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000584}
585
586// Tries detecting a memory leak on the particular input that we have just
587// executed before calling this function.
588void Fuzzer::TryDetectingAMemoryLeak(const uint8_t *Data, size_t Size,
589 bool DuringInitialCorpusExecution) {
alekseyshl9f6a9f22017-10-23 23:24:33 +0000590 if (!HasMoreMallocsThanFrees)
591 return; // mallocs==frees, a leak is unlikely.
592 if (!Options.DetectLeaks)
593 return;
dor1s38279cb2017-09-12 02:01:54 +0000594 if (!DuringInitialCorpusExecution &&
alekseyshl9f6a9f22017-10-23 23:24:33 +0000595 TotalNumberOfRuns >= Options.MaxNumberOfRuns)
596 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000597 if (!&(EF->__lsan_enable) || !&(EF->__lsan_disable) ||
598 !(EF->__lsan_do_recoverable_leak_check))
alekseyshl9f6a9f22017-10-23 23:24:33 +0000599 return; // No lsan.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000600 // Run the target once again, but with lsan disabled so that if there is
601 // a real leak we do not report it twice.
602 EF->__lsan_disable();
603 ExecuteCallback(Data, Size);
604 EF->__lsan_enable();
alekseyshl9f6a9f22017-10-23 23:24:33 +0000605 if (!HasMoreMallocsThanFrees)
606 return; // a leak is unlikely.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000607 if (NumberOfLeakDetectionAttempts++ > 1000) {
608 Options.DetectLeaks = false;
609 Printf("INFO: libFuzzer disabled leak detection after every mutation.\n"
610 " Most likely the target function accumulates allocated\n"
611 " memory in a global state w/o actually leaking it.\n"
612 " You may try running this binary with -trace_malloc=[12]"
613 " to get a trace of mallocs and frees.\n"
614 " If LeakSanitizer is enabled in this process it will still\n"
615 " run on the process shutdown.\n");
616 return;
617 }
618 // Now perform the actual lsan pass. This is expensive and we must ensure
619 // we don't call it too often.
620 if (EF->__lsan_do_recoverable_leak_check()) { // Leak is found, report it.
621 if (DuringInitialCorpusExecution)
622 Printf("\nINFO: a leak has been found in the initial corpus.\n\n");
623 Printf("INFO: to ignore leaks on libFuzzer side use -detect_leaks=0.\n\n");
624 CurrentUnitSize = Size;
625 DumpCurrentUnit("leak-");
626 PrintFinalStats();
alekseyshl9f6a9f22017-10-23 23:24:33 +0000627 _Exit(Options.ErrorExitCode); // not exit() to disable lsan further on.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000628 }
629}
630
631void Fuzzer::MutateAndTestOne() {
632 MD.StartMutationSequence();
633
634 auto &II = Corpus.ChooseUnitToMutate(MD.GetRand());
kcc0c34c832019-02-08 01:20:54 +0000635 if (Options.DoCrossOver)
636 MD.SetCrossOverWith(&Corpus.ChooseUnitToMutate(MD.GetRand()).U);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000637 const auto &U = II.U;
638 memcpy(BaseSha1, II.Sha1, sizeof(BaseSha1));
639 assert(CurrentUnitData);
640 size_t Size = U.size();
641 assert(Size <= MaxInputLen && "Oversized Unit");
642 memcpy(CurrentUnitData, U.data(), Size);
643
644 assert(MaxMutationLen > 0);
645
646 size_t CurrentMaxMutationLen =
647 Min(MaxMutationLen, Max(U.size(), TmpMaxMutationLen));
648 assert(CurrentMaxMutationLen > 0);
649
650 for (int i = 0; i < Options.MutateDepth; i++) {
651 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
652 break;
kcc1239a992017-11-09 20:30:19 +0000653 MaybeExitGracefully();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000654 size_t NewSize = 0;
kcc0cab3f02018-07-19 01:23:32 +0000655 if (II.HasFocusFunction && !II.DataFlowTraceForFocusFunction.empty() &&
656 Size <= CurrentMaxMutationLen)
657 NewSize = MD.MutateWithMask(CurrentUnitData, Size, Size,
658 II.DataFlowTraceForFocusFunction);
659 else
660 NewSize = MD.Mutate(CurrentUnitData, Size, CurrentMaxMutationLen);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000661 assert(NewSize > 0 && "Mutator returned empty unit");
alekseyshld995b552017-10-23 22:04:30 +0000662 assert(NewSize <= CurrentMaxMutationLen && "Mutator return oversized unit");
george.karpenkov29efa6d2017-08-21 23:25:50 +0000663 Size = NewSize;
664 II.NumExecutedMutations++;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000665
kccb6836be2017-12-01 19:18:38 +0000666 bool FoundUniqFeatures = false;
667 bool NewCov = RunOne(CurrentUnitData, Size, /*MayDeleteFile=*/true, &II,
668 &FoundUniqFeatures);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000669 TryDetectingAMemoryLeak(CurrentUnitData, Size,
670 /*DuringInitialCorpusExecution*/ false);
kccb6836be2017-12-01 19:18:38 +0000671 if (NewCov) {
morehouse553f00b2017-11-09 20:44:08 +0000672 ReportNewCoverage(&II, {CurrentUnitData, CurrentUnitData + Size});
kccb6836be2017-12-01 19:18:38 +0000673 break; // We will mutate this input more in the next rounds.
674 }
675 if (Options.ReduceDepth && !FoundUniqFeatures)
dor1se6729cb2018-07-16 15:15:34 +0000676 break;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000677 }
678}
679
alekseyshld995b552017-10-23 22:04:30 +0000680void Fuzzer::PurgeAllocator() {
alekseyshl9f6a9f22017-10-23 23:24:33 +0000681 if (Options.PurgeAllocatorIntervalSec < 0 || !EF->__sanitizer_purge_allocator)
alekseyshld995b552017-10-23 22:04:30 +0000682 return;
alekseyshld995b552017-10-23 22:04:30 +0000683 if (duration_cast<seconds>(system_clock::now() -
alekseyshl9f6a9f22017-10-23 23:24:33 +0000684 LastAllocatorPurgeAttemptTime)
685 .count() < Options.PurgeAllocatorIntervalSec)
alekseyshld995b552017-10-23 22:04:30 +0000686 return;
alekseyshld995b552017-10-23 22:04:30 +0000687
688 if (Options.RssLimitMb <= 0 ||
alekseyshl9f6a9f22017-10-23 23:24:33 +0000689 GetPeakRSSMb() > static_cast<size_t>(Options.RssLimitMb) / 2)
alekseyshld995b552017-10-23 22:04:30 +0000690 EF->__sanitizer_purge_allocator();
alekseyshld995b552017-10-23 22:04:30 +0000691
692 LastAllocatorPurgeAttemptTime = system_clock::now();
693}
694
kcc0c34c832019-02-08 01:20:54 +0000695void Fuzzer::ReadAndExecuteSeedCorpora(
696 const Vector<std::string> &CorpusDirs,
697 const Vector<std::string> &ExtraSeedFiles) {
kcc2e93b3f2017-08-29 02:05:01 +0000698 const size_t kMaxSaneLen = 1 << 20;
699 const size_t kMinDefaultLen = 4096;
kccdc00cd32017-08-29 20:51:24 +0000700 Vector<SizedFile> SizedFiles;
701 size_t MaxSize = 0;
702 size_t MinSize = -1;
703 size_t TotalSize = 0;
kcc7f5f2222017-09-12 21:58:07 +0000704 size_t LastNumFiles = 0;
kccdc00cd32017-08-29 20:51:24 +0000705 for (auto &Dir : CorpusDirs) {
kcc7f5f2222017-09-12 21:58:07 +0000706 GetSizedFilesFromDir(Dir, &SizedFiles);
707 Printf("INFO: % 8zd files found in %s\n", SizedFiles.size() - LastNumFiles,
708 Dir.c_str());
709 LastNumFiles = SizedFiles.size();
710 }
kcc0c34c832019-02-08 01:20:54 +0000711 // Add files from -seed_inputs.
712 for (auto &File : ExtraSeedFiles)
713 if (auto Size = FileSize(File))
714 SizedFiles.push_back({File, Size});
715
kcc7f5f2222017-09-12 21:58:07 +0000716 for (auto &File : SizedFiles) {
717 MaxSize = Max(File.Size, MaxSize);
718 MinSize = Min(File.Size, MinSize);
719 TotalSize += File.Size;
kcc2e93b3f2017-08-29 02:05:01 +0000720 }
kccdc00cd32017-08-29 20:51:24 +0000721 if (Options.MaxLen == 0)
722 SetMaxInputLen(std::min(std::max(kMinDefaultLen, MaxSize), kMaxSaneLen));
723 assert(MaxInputLen > 0);
724
kcc2cd9f092017-10-13 01:12:23 +0000725 // Test the callback with empty input and never try it again.
726 uint8_t dummy = 0;
727 ExecuteCallback(&dummy, 0);
728
kccc0a0b1f2019-01-31 01:40:14 +0000729 // Protect lazy counters here, after the once-init code has been executed.
730 if (Options.LazyCounters)
731 TPC.ProtectLazyCounters();
732
kccdc00cd32017-08-29 20:51:24 +0000733 if (SizedFiles.empty()) {
734 Printf("INFO: A corpus is not provided, starting from an empty corpus\n");
735 Unit U({'\n'}); // Valid ASCII input.
736 RunOne(U.data(), U.size());
737 } else {
738 Printf("INFO: seed corpus: files: %zd min: %zdb max: %zdb total: %zdb"
739 " rss: %zdMb\n",
740 SizedFiles.size(), MinSize, MaxSize, TotalSize, GetPeakRSSMb());
741 if (Options.ShuffleAtStartUp)
742 std::shuffle(SizedFiles.begin(), SizedFiles.end(), MD.GetRand());
743
kcc7f5f2222017-09-12 21:58:07 +0000744 if (Options.PreferSmall) {
745 std::stable_sort(SizedFiles.begin(), SizedFiles.end());
746 assert(SizedFiles.front().Size <= SizedFiles.back().Size);
747 }
kccdc00cd32017-08-29 20:51:24 +0000748
749 // Load and execute inputs one by one.
750 for (auto &SF : SizedFiles) {
kccae85e292017-08-31 19:17:15 +0000751 auto U = FileToVector(SF.File, MaxInputLen, /*ExitOnError=*/false);
kccdc00cd32017-08-29 20:51:24 +0000752 assert(U.size() <= MaxInputLen);
753 RunOne(U.data(), U.size());
754 CheckExitOnSrcPosOrItem();
755 TryDetectingAMemoryLeak(U.data(), U.size(),
756 /*DuringInitialCorpusExecution*/ true);
757 }
kcc2e93b3f2017-08-29 02:05:01 +0000758 }
759
kccdc00cd32017-08-29 20:51:24 +0000760 PrintStats("INITED");
kcc3acbe072018-05-16 23:26:37 +0000761 if (!Options.FocusFunction.empty())
762 Printf("INFO: %zd/%zd inputs touch the focus function\n",
763 Corpus.NumInputsThatTouchFocusFunction(), Corpus.size());
kccadf188b2018-06-07 01:40:20 +0000764 if (!Options.DataFlowTrace.empty())
765 Printf("INFO: %zd/%zd inputs have the Data Flow Trace\n",
766 Corpus.NumInputsWithDataFlowTrace(), Corpus.size());
kcc3acbe072018-05-16 23:26:37 +0000767
dor1s770a9bc2018-05-23 19:42:30 +0000768 if (Corpus.empty() && Options.MaxNumberOfRuns) {
kccdc00cd32017-08-29 20:51:24 +0000769 Printf("ERROR: no interesting inputs were found. "
770 "Is the code instrumented for coverage? Exiting.\n");
771 exit(1);
kcc2e93b3f2017-08-29 02:05:01 +0000772 }
kcc2e93b3f2017-08-29 02:05:01 +0000773}
774
kcc0c34c832019-02-08 01:20:54 +0000775void Fuzzer::Loop(const Vector<std::string> &CorpusDirs,
776 const Vector<std::string> &ExtraSeedFiles) {
777 ReadAndExecuteSeedCorpora(CorpusDirs, ExtraSeedFiles);
kccadf188b2018-06-07 01:40:20 +0000778 DFT.Clear(); // No need for DFT any more.
george.karpenkov29efa6d2017-08-21 23:25:50 +0000779 TPC.SetPrintNewPCs(Options.PrintNewCovPcs);
kcc00da6482017-08-25 20:09:25 +0000780 TPC.SetPrintNewFuncs(Options.PrintNewCovFuncs);
george.karpenkov29efa6d2017-08-21 23:25:50 +0000781 system_clock::time_point LastCorpusReload = system_clock::now();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000782 while (true) {
783 auto Now = system_clock::now();
784 if (duration_cast<seconds>(Now - LastCorpusReload).count() >=
785 Options.ReloadIntervalSec) {
786 RereadOutputCorpus(MaxInputLen);
787 LastCorpusReload = system_clock::now();
788 }
789 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
790 break;
alekseyshl9f6a9f22017-10-23 23:24:33 +0000791 if (TimedOut())
792 break;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000793
794 // Update TmpMaxMutationLen
morehouse8c42ada2018-02-13 20:52:15 +0000795 if (Options.LenControl) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000796 if (TmpMaxMutationLen < MaxMutationLen &&
kcce29d7e32017-12-12 23:11:28 +0000797 TotalNumberOfRuns - LastCorpusUpdateRun >
morehouse8c42ada2018-02-13 20:52:15 +0000798 Options.LenControl * Log(TmpMaxMutationLen)) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000799 TmpMaxMutationLen =
kcce29d7e32017-12-12 23:11:28 +0000800 Min(MaxMutationLen, TmpMaxMutationLen + Log(TmpMaxMutationLen));
kcce29d7e32017-12-12 23:11:28 +0000801 LastCorpusUpdateRun = TotalNumberOfRuns;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000802 }
803 } else {
804 TmpMaxMutationLen = MaxMutationLen;
805 }
806
807 // Perform several mutations and runs.
808 MutateAndTestOne();
alekseyshld995b552017-10-23 22:04:30 +0000809
810 PurgeAllocator();
george.karpenkov29efa6d2017-08-21 23:25:50 +0000811 }
812
813 PrintStats("DONE ", "\n");
814 MD.PrintRecommendedDictionary();
815}
816
817void Fuzzer::MinimizeCrashLoop(const Unit &U) {
alekseyshl9f6a9f22017-10-23 23:24:33 +0000818 if (U.size() <= 1)
819 return;
george.karpenkov29efa6d2017-08-21 23:25:50 +0000820 while (!TimedOut() && TotalNumberOfRuns < Options.MaxNumberOfRuns) {
821 MD.StartMutationSequence();
822 memcpy(CurrentUnitData, U.data(), U.size());
823 for (int i = 0; i < Options.MutateDepth; i++) {
824 size_t NewSize = MD.Mutate(CurrentUnitData, U.size(), MaxMutationLen);
825 assert(NewSize > 0 && NewSize <= MaxMutationLen);
826 ExecuteCallback(CurrentUnitData, NewSize);
827 PrintPulseAndReportSlowInput(CurrentUnitData, NewSize);
828 TryDetectingAMemoryLeak(CurrentUnitData, NewSize,
829 /*DuringInitialCorpusExecution*/ false);
830 }
831 }
832}
833
george.karpenkov29efa6d2017-08-21 23:25:50 +0000834} // namespace fuzzer
835
836extern "C" {
837
metzman2fe66e62019-01-17 16:36:05 +0000838ATTRIBUTE_INTERFACE size_t
phosek966475e2018-01-17 20:39:14 +0000839LLVMFuzzerMutate(uint8_t *Data, size_t Size, size_t MaxSize) {
george.karpenkov29efa6d2017-08-21 23:25:50 +0000840 assert(fuzzer::F);
841 return fuzzer::F->GetMD().DefaultMutate(Data, Size, MaxSize);
842}
843
alekseyshl9f6a9f22017-10-23 23:24:33 +0000844} // extern "C"