blob: 191556339b3c5c71cdf533c5aa39d84900371177 [file] [log] [blame]
George Karpenkov10ab2ac2017-08-21 23:25:501//===- 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 "FuzzerCorpus.h"
13#include "FuzzerIO.h"
14#include "FuzzerInternal.h"
15#include "FuzzerMutate.h"
16#include "FuzzerRandom.h"
17#include "FuzzerShmem.h"
18#include "FuzzerTracePC.h"
19#include <algorithm>
20#include <cstring>
21#include <memory>
Vitaly Buka7dbc1d82017-11-01 03:02:5922#include <mutex>
George Karpenkov10ab2ac2017-08-21 23:25:5023#include <set>
24
25#if defined(__has_include)
26#if __has_include(<sanitizer / lsan_interface.h>)
27#include <sanitizer/lsan_interface.h>
28#endif
29#endif
30
31#define NO_SANITIZE_MEMORY
32#if defined(__has_feature)
33#if __has_feature(memory_sanitizer)
34#undef NO_SANITIZE_MEMORY
35#define NO_SANITIZE_MEMORY __attribute__((no_sanitize_memory))
36#endif
37#endif
38
39namespace fuzzer {
40static const size_t kMaxUnitSizeToPrint = 256;
41
42thread_local bool Fuzzer::IsMyThread;
43
44SharedMemoryRegion SMR;
45
46// Only one Fuzzer per process.
47static Fuzzer *F;
48
49// Leak detection is expensive, so we first check if there were more mallocs
50// than frees (using the sanitizer malloc hooks) and only then try to call lsan.
51struct MallocFreeTracer {
52 void Start(int TraceLevel) {
53 this->TraceLevel = TraceLevel;
54 if (TraceLevel)
55 Printf("MallocFreeTracer: START\n");
56 Mallocs = 0;
57 Frees = 0;
58 }
59 // Returns true if there were more mallocs than frees.
60 bool Stop() {
61 if (TraceLevel)
62 Printf("MallocFreeTracer: STOP %zd %zd (%s)\n", Mallocs.load(),
63 Frees.load(), Mallocs == Frees ? "same" : "DIFFERENT");
64 bool Result = Mallocs > Frees;
65 Mallocs = 0;
66 Frees = 0;
67 TraceLevel = 0;
68 return Result;
69 }
70 std::atomic<size_t> Mallocs;
71 std::atomic<size_t> Frees;
72 int TraceLevel = 0;
Vitaly Buka7d223242017-11-02 04:12:1073
74 std::recursive_mutex TraceMutex;
75 bool TraceDisabled = false;
George Karpenkov10ab2ac2017-08-21 23:25:5076};
77
78static MallocFreeTracer AllocTracer;
79
Vitaly Buka7d223242017-11-02 04:12:1080// Locks printing and avoids nested hooks triggered from mallocs/frees in
81// sanitizer.
82class TraceLock {
83public:
84 TraceLock() : Lock(AllocTracer.TraceMutex) {
85 AllocTracer.TraceDisabled = !AllocTracer.TraceDisabled;
86 }
87 ~TraceLock() { AllocTracer.TraceDisabled = !AllocTracer.TraceDisabled; }
88
89 bool IsDisabled() const {
90 // This is already inverted value.
91 return !AllocTracer.TraceDisabled;
92 }
93
94private:
95 std::lock_guard<std::recursive_mutex> Lock;
96};
Vitaly Buka7dbc1d82017-11-01 03:02:5997
George Karpenkov10ab2ac2017-08-21 23:25:5098ATTRIBUTE_NO_SANITIZE_MEMORY
99void MallocHook(const volatile void *ptr, size_t size) {
100 size_t N = AllocTracer.Mallocs++;
101 F->HandleMalloc(size);
102 if (int TraceLevel = AllocTracer.TraceLevel) {
Vitaly Buka7d223242017-11-02 04:12:10103 TraceLock Lock;
104 if (Lock.IsDisabled())
105 return;
George Karpenkov10ab2ac2017-08-21 23:25:50106 Printf("MALLOC[%zd] %p %zd\n", N, ptr, size);
107 if (TraceLevel >= 2 && EF)
Matt Morehouse14cf71a2018-05-08 23:45:05108 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50109 }
110}
111
112ATTRIBUTE_NO_SANITIZE_MEMORY
113void FreeHook(const volatile void *ptr) {
114 size_t N = AllocTracer.Frees++;
115 if (int TraceLevel = AllocTracer.TraceLevel) {
Vitaly Buka7d223242017-11-02 04:12:10116 TraceLock Lock;
117 if (Lock.IsDisabled())
118 return;
George Karpenkov10ab2ac2017-08-21 23:25:50119 Printf("FREE[%zd] %p\n", N, ptr);
120 if (TraceLevel >= 2 && EF)
Matt Morehouse14cf71a2018-05-08 23:45:05121 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50122 }
123}
124
125// Crash on a single malloc that exceeds the rss limit.
126void Fuzzer::HandleMalloc(size_t Size) {
Kostya Serebryanyde9bafb2017-12-01 22:12:04127 if (!Options.MallocLimitMb || (Size >> 20) < (size_t)Options.MallocLimitMb)
George Karpenkov10ab2ac2017-08-21 23:25:50128 return;
129 Printf("==%d== ERROR: libFuzzer: out-of-memory (malloc(%zd))\n", GetPid(),
130 Size);
131 Printf(" To change the out-of-memory limit use -rss_limit_mb=<N>\n\n");
Matt Morehouse14cf71a2018-05-08 23:45:05132 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50133 DumpCurrentUnit("oom-");
134 Printf("SUMMARY: libFuzzer: out-of-memory\n");
135 PrintFinalStats();
136 _Exit(Options.ErrorExitCode); // Stop right now.
137}
138
139Fuzzer::Fuzzer(UserCallback CB, InputCorpus &Corpus, MutationDispatcher &MD,
140 FuzzingOptions Options)
141 : CB(CB), Corpus(Corpus), MD(MD), Options(Options) {
142 if (EF->__sanitizer_set_death_callback)
143 EF->__sanitizer_set_death_callback(StaticDeathCallback);
144 assert(!F);
145 F = this;
146 TPC.ResetMaps();
147 IsMyThread = true;
148 if (Options.DetectLeaks && EF->__sanitizer_install_malloc_and_free_hooks)
149 EF->__sanitizer_install_malloc_and_free_hooks(MallocHook, FreeHook);
150 TPC.SetUseCounters(Options.UseCounters);
151 TPC.SetUseValueProfile(Options.UseValueProfile);
Max Moroz330496c2017-10-05 22:41:03152 TPC.SetUseClangCoverage(Options.UseClangCoverage);
George Karpenkov10ab2ac2017-08-21 23:25:50153
154 if (Options.Verbosity)
155 TPC.PrintModuleInfo();
156 if (!Options.OutputCorpus.empty() && Options.ReloadIntervalSec)
157 EpochOfLastReadOfOutputCorpus = GetEpoch(Options.OutputCorpus);
158 MaxInputLen = MaxMutationLen = Options.MaxLen;
159 TmpMaxMutationLen = Max(size_t(4), Corpus.MaxInputSize());
160 AllocateCurrentUnitData();
161 CurrentUnitSize = 0;
162 memset(BaseSha1, 0, sizeof(BaseSha1));
163}
164
Alex Shlyapnikov5ded0702017-10-23 23:24:33165Fuzzer::~Fuzzer() {}
George Karpenkov10ab2ac2017-08-21 23:25:50166
167void Fuzzer::AllocateCurrentUnitData() {
Alex Shlyapnikov5ded0702017-10-23 23:24:33168 if (CurrentUnitData || MaxInputLen == 0)
169 return;
George Karpenkov10ab2ac2017-08-21 23:25:50170 CurrentUnitData = new uint8_t[MaxInputLen];
171}
172
173void Fuzzer::StaticDeathCallback() {
174 assert(F);
175 F->DeathCallback();
176}
177
178void Fuzzer::DumpCurrentUnit(const char *Prefix) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33179 if (!CurrentUnitData)
180 return; // Happens when running individual inputs.
George Karpenkov10ab2ac2017-08-21 23:25:50181 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
Kostya Serebryanya2ca2dc2017-11-09 20:30:19218void Fuzzer::StaticGracefulExitCallback() {
219 assert(F);
220 F->GracefulExitRequested = true;
221 Printf("INFO: signal received, trying to exit gracefully\n");
222}
223
George Karpenkov10ab2ac2017-08-21 23:25:50224void Fuzzer::StaticFileSizeExceedCallback() {
225 Printf("==%lu== ERROR: libFuzzer: file size exceeded\n", GetPid());
226 exit(1);
227}
228
229void Fuzzer::CrashCallback() {
Matt Morehouse7764a042018-05-02 02:55:28230 if (EF->__sanitizer_acquire_crash_state)
231 EF->__sanitizer_acquire_crash_state();
George Karpenkov10ab2ac2017-08-21 23:25:50232 Printf("==%lu== ERROR: libFuzzer: deadly signal\n", GetPid());
Matt Morehouse14cf71a2018-05-08 23:45:05233 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50234 Printf("NOTE: libFuzzer has rudimentary signal handlers.\n"
235 " Combine libFuzzer with AddressSanitizer or similar for better "
236 "crash reports.\n");
237 Printf("SUMMARY: libFuzzer: deadly signal\n");
238 DumpCurrentUnit("crash-");
239 PrintFinalStats();
Alex Shlyapnikov5ded0702017-10-23 23:24:33240 _Exit(Options.ErrorExitCode); // Stop right now.
George Karpenkov10ab2ac2017-08-21 23:25:50241}
242
243void Fuzzer::ExitCallback() {
244 if (!RunningCB)
245 return; // This exit did not come from the user callback
Matt Morehouse52fd1692018-05-01 21:01:53246 if (EF->__sanitizer_acquire_crash_state &&
247 !EF->__sanitizer_acquire_crash_state())
248 return;
George Karpenkov10ab2ac2017-08-21 23:25:50249 Printf("==%lu== ERROR: libFuzzer: fuzz target exited\n", GetPid());
Matt Morehouse14cf71a2018-05-08 23:45:05250 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50251 Printf("SUMMARY: libFuzzer: fuzz target exited\n");
252 DumpCurrentUnit("crash-");
253 PrintFinalStats();
254 _Exit(Options.ErrorExitCode);
255}
256
Kostya Serebryanya2ca2dc2017-11-09 20:30:19257void Fuzzer::MaybeExitGracefully() {
258 if (!GracefulExitRequested) return;
259 Printf("==%lu== INFO: libFuzzer: exiting as requested\n", GetPid());
260 PrintFinalStats();
261 _Exit(0);
262}
263
George Karpenkov10ab2ac2017-08-21 23:25:50264void Fuzzer::InterruptCallback() {
265 Printf("==%lu== libFuzzer: run interrupted; exiting\n", GetPid());
266 PrintFinalStats();
Alex Shlyapnikov5ded0702017-10-23 23:24:33267 _Exit(0); // Stop right now, don't perform any at-exit actions.
George Karpenkov10ab2ac2017-08-21 23:25:50268}
269
270NO_SANITIZE_MEMORY
271void Fuzzer::AlarmCallback() {
272 assert(Options.UnitTimeoutSec > 0);
273 // In Windows Alarm callback is executed by a different thread.
274#if !LIBFUZZER_WINDOWS
Alex Shlyapnikov5ded0702017-10-23 23:24:33275 if (!InFuzzingThread())
276 return;
George Karpenkov10ab2ac2017-08-21 23:25:50277#endif
278 if (!RunningCB)
279 return; // We have not started running units yet.
280 size_t Seconds =
281 duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
282 if (Seconds == 0)
283 return;
284 if (Options.Verbosity >= 2)
285 Printf("AlarmCallback %zd\n", Seconds);
286 if (Seconds >= (size_t)Options.UnitTimeoutSec) {
Matt Morehouse52fd1692018-05-01 21:01:53287 if (EF->__sanitizer_acquire_crash_state &&
288 !EF->__sanitizer_acquire_crash_state())
289 return;
George Karpenkov10ab2ac2017-08-21 23:25:50290 Printf("ALARM: working on the last Unit for %zd seconds\n", Seconds);
291 Printf(" and the timeout value is %d (use -timeout=N to change)\n",
292 Options.UnitTimeoutSec);
293 DumpCurrentUnit("timeout-");
294 Printf("==%lu== ERROR: libFuzzer: timeout after %d seconds\n", GetPid(),
295 Seconds);
Matt Morehouse14cf71a2018-05-08 23:45:05296 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50297 Printf("SUMMARY: libFuzzer: timeout\n");
298 PrintFinalStats();
299 _Exit(Options.TimeoutExitCode); // Stop right now.
300 }
301}
302
303void Fuzzer::RssLimitCallback() {
Matt Morehouse52fd1692018-05-01 21:01:53304 if (EF->__sanitizer_acquire_crash_state &&
305 !EF->__sanitizer_acquire_crash_state())
306 return;
George Karpenkov10ab2ac2017-08-21 23:25:50307 Printf(
308 "==%lu== ERROR: libFuzzer: out-of-memory (used: %zdMb; limit: %zdMb)\n",
309 GetPid(), GetPeakRSSMb(), Options.RssLimitMb);
310 Printf(" To change the out-of-memory limit use -rss_limit_mb=<N>\n\n");
Matt Morehouse14cf71a2018-05-08 23:45:05311 PrintMemoryProfile();
George Karpenkov10ab2ac2017-08-21 23:25:50312 DumpCurrentUnit("oom-");
313 Printf("SUMMARY: libFuzzer: out-of-memory\n");
314 PrintFinalStats();
315 _Exit(Options.ErrorExitCode); // Stop right now.
316}
317
318void Fuzzer::PrintStats(const char *Where, const char *End, size_t Units) {
319 size_t ExecPerSec = execPerSec();
320 if (!Options.Verbosity)
321 return;
322 Printf("#%zd\t%s", TotalNumberOfRuns, Where);
323 if (size_t N = TPC.GetTotalPCCoverage())
324 Printf(" cov: %zd", N);
325 if (size_t N = Corpus.NumFeatures())
Alex Shlyapnikov5ded0702017-10-23 23:24:33326 Printf(" ft: %zd", N);
George Karpenkov10ab2ac2017-08-21 23:25:50327 if (!Corpus.empty()) {
328 Printf(" corp: %zd", Corpus.NumActiveUnits());
329 if (size_t N = Corpus.SizeInBytes()) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33330 if (N < (1 << 14))
George Karpenkov10ab2ac2017-08-21 23:25:50331 Printf("/%zdb", N);
332 else if (N < (1 << 24))
333 Printf("/%zdKb", N >> 10);
334 else
335 Printf("/%zdMb", N >> 20);
336 }
337 }
Matt Morehouseddf352b2018-02-22 19:00:17338 if (TmpMaxMutationLen)
339 Printf(" lim: %zd", TmpMaxMutationLen);
George Karpenkov10ab2ac2017-08-21 23:25:50340 if (Units)
341 Printf(" units: %zd", Units);
342
343 Printf(" exec/s: %zd", ExecPerSec);
344 Printf(" rss: %zdMb", GetPeakRSSMb());
345 Printf("%s", End);
346}
347
348void Fuzzer::PrintFinalStats() {
349 if (Options.PrintCoverage)
350 TPC.PrintCoverage();
351 if (Options.DumpCoverage)
352 TPC.DumpCoverage();
353 if (Options.PrintCorpusStats)
354 Corpus.PrintStats();
Alex Shlyapnikov5ded0702017-10-23 23:24:33355 if (!Options.PrintFinalStats)
356 return;
George Karpenkov10ab2ac2017-08-21 23:25:50357 size_t ExecPerSec = execPerSec();
358 Printf("stat::number_of_executed_units: %zd\n", TotalNumberOfRuns);
359 Printf("stat::average_exec_per_sec: %zd\n", ExecPerSec);
360 Printf("stat::new_units_added: %zd\n", NumberOfNewUnitsAdded);
361 Printf("stat::slowest_unit_time_sec: %zd\n", TimeOfLongestUnitInSeconds);
362 Printf("stat::peak_rss_mb: %zd\n", GetPeakRSSMb());
363}
364
365void Fuzzer::SetMaxInputLen(size_t MaxInputLen) {
366 assert(this->MaxInputLen == 0); // Can only reset MaxInputLen from 0 to non-0.
367 assert(MaxInputLen);
368 this->MaxInputLen = MaxInputLen;
369 this->MaxMutationLen = MaxInputLen;
370 AllocateCurrentUnitData();
371 Printf("INFO: -max_len is not provided; "
372 "libFuzzer will not generate inputs larger than %zd bytes\n",
373 MaxInputLen);
374}
375
376void Fuzzer::SetMaxMutationLen(size_t MaxMutationLen) {
377 assert(MaxMutationLen && MaxMutationLen <= MaxInputLen);
378 this->MaxMutationLen = MaxMutationLen;
379}
380
381void Fuzzer::CheckExitOnSrcPosOrItem() {
382 if (!Options.ExitOnSrcPos.empty()) {
George Karpenkovbebcbfb2017-08-27 23:20:09383 static auto *PCsSet = new Set<uintptr_t>;
George Karpenkov10ab2ac2017-08-21 23:25:50384 auto HandlePC = [&](uintptr_t PC) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33385 if (!PCsSet->insert(PC).second)
386 return;
George Karpenkov10ab2ac2017-08-21 23:25:50387 std::string Descr = DescribePC("%F %L", PC + 1);
388 if (Descr.find(Options.ExitOnSrcPos) != std::string::npos) {
389 Printf("INFO: found line matching '%s', exiting.\n",
390 Options.ExitOnSrcPos.c_str());
391 _Exit(0);
392 }
393 };
394 TPC.ForEachObservedPC(HandlePC);
395 }
396 if (!Options.ExitOnItem.empty()) {
397 if (Corpus.HasUnit(Options.ExitOnItem)) {
398 Printf("INFO: found item with checksum '%s', exiting.\n",
399 Options.ExitOnItem.c_str());
400 _Exit(0);
401 }
402 }
403}
404
405void Fuzzer::RereadOutputCorpus(size_t MaxSize) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33406 if (Options.OutputCorpus.empty() || !Options.ReloadIntervalSec)
407 return;
George Karpenkovbebcbfb2017-08-27 23:20:09408 Vector<Unit> AdditionalCorpus;
George Karpenkov10ab2ac2017-08-21 23:25:50409 ReadDirToVectorOfUnits(Options.OutputCorpus.c_str(), &AdditionalCorpus,
410 &EpochOfLastReadOfOutputCorpus, MaxSize,
411 /*ExitOnError*/ false);
412 if (Options.Verbosity >= 2)
413 Printf("Reload: read %zd new units.\n", AdditionalCorpus.size());
414 bool Reloaded = false;
415 for (auto &U : AdditionalCorpus) {
416 if (U.size() > MaxSize)
417 U.resize(MaxSize);
418 if (!Corpus.HasUnit(U)) {
419 if (RunOne(U.data(), U.size())) {
420 CheckExitOnSrcPosOrItem();
421 Reloaded = true;
422 }
423 }
424 }
425 if (Reloaded)
426 PrintStats("RELOAD");
427}
428
George Karpenkov10ab2ac2017-08-21 23:25:50429void Fuzzer::PrintPulseAndReportSlowInput(const uint8_t *Data, size_t Size) {
430 auto TimeOfUnit =
431 duration_cast<seconds>(UnitStopTime - UnitStartTime).count();
432 if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) &&
433 secondsSinceProcessStartUp() >= 2)
434 PrintStats("pulse ");
435 if (TimeOfUnit > TimeOfLongestUnitInSeconds * 1.1 &&
436 TimeOfUnit >= Options.ReportSlowUnits) {
437 TimeOfLongestUnitInSeconds = TimeOfUnit;
438 Printf("Slowest unit: %zd s:\n", TimeOfLongestUnitInSeconds);
439 WriteUnitToFileWithPrefix({Data, Data + Size}, "slow-unit-");
440 }
441}
442
443bool Fuzzer::RunOne(const uint8_t *Data, size_t Size, bool MayDeleteFile,
Kostya Serebryanyad05ee02017-12-01 19:18:38444 InputInfo *II, bool *FoundUniqFeatures) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33445 if (!Size)
446 return false;
George Karpenkov10ab2ac2017-08-21 23:25:50447
448 ExecuteCallback(Data, Size);
449
450 UniqFeatureSetTmp.clear();
451 size_t FoundUniqFeaturesOfII = 0;
452 size_t NumUpdatesBefore = Corpus.NumFeatureUpdates();
453 TPC.CollectFeatures([&](size_t Feature) {
Kostya Serebryany2659c632017-12-08 22:21:42454 if (Options.UseFeatureFrequency)
455 Corpus.UpdateFeatureFrequency(Feature);
George Karpenkov10ab2ac2017-08-21 23:25:50456 if (Corpus.AddFeature(Feature, Size, Options.Shrink))
457 UniqFeatureSetTmp.push_back(Feature);
458 if (Options.ReduceInputs && II)
459 if (std::binary_search(II->UniqFeatureSet.begin(),
460 II->UniqFeatureSet.end(), Feature))
461 FoundUniqFeaturesOfII++;
462 });
Kostya Serebryanyad05ee02017-12-01 19:18:38463 if (FoundUniqFeatures)
464 *FoundUniqFeatures = FoundUniqFeaturesOfII;
George Karpenkov10ab2ac2017-08-21 23:25:50465 PrintPulseAndReportSlowInput(Data, Size);
466 size_t NumNewFeatures = Corpus.NumFeatureUpdates() - NumUpdatesBefore;
467 if (NumNewFeatures) {
468 TPC.UpdateObservedPCs();
469 Corpus.AddToCorpus({Data, Data + Size}, NumNewFeatures, MayDeleteFile,
470 UniqFeatureSetTmp);
471 return true;
472 }
473 if (II && FoundUniqFeaturesOfII &&
474 FoundUniqFeaturesOfII == II->UniqFeatureSet.size() &&
475 II->U.size() > Size) {
476 Corpus.Replace(II, {Data, Data + Size});
477 return true;
478 }
479 return false;
480}
481
482size_t Fuzzer::GetCurrentUnitInFuzzingThead(const uint8_t **Data) const {
483 assert(InFuzzingThread());
484 *Data = CurrentUnitData;
485 return CurrentUnitSize;
486}
487
488void Fuzzer::CrashOnOverwrittenData() {
489 Printf("==%d== ERROR: libFuzzer: fuzz target overwrites it's const input\n",
490 GetPid());
491 DumpCurrentUnit("crash-");
492 Printf("SUMMARY: libFuzzer: out-of-memory\n");
493 _Exit(Options.ErrorExitCode); // Stop right now.
494}
495
496// Compare two arrays, but not all bytes if the arrays are large.
497static bool LooseMemeq(const uint8_t *A, const uint8_t *B, size_t Size) {
498 const size_t Limit = 64;
499 if (Size <= 64)
500 return !memcmp(A, B, Size);
501 // Compare first and last Limit/2 bytes.
502 return !memcmp(A, B, Limit / 2) &&
503 !memcmp(A + Size - Limit / 2, B + Size - Limit / 2, Limit / 2);
504}
505
506void Fuzzer::ExecuteCallback(const uint8_t *Data, size_t Size) {
507 TPC.RecordInitialStack();
508 TotalNumberOfRuns++;
509 assert(InFuzzingThread());
510 if (SMR.IsClient())
511 SMR.WriteByteArray(Data, Size);
512 // 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);
516 if (CurrentUnitData && CurrentUnitData != Data)
517 memcpy(CurrentUnitData, Data, Size);
518 CurrentUnitSize = Size;
519 AllocTracer.Start(Options.TraceMalloc);
520 UnitStartTime = system_clock::now();
521 TPC.ResetMaps();
522 RunningCB = true;
523 int Res = CB(DataCopy, Size);
524 RunningCB = false;
525 UnitStopTime = system_clock::now();
526 (void)Res;
527 assert(Res == 0);
528 HasMoreMallocsThanFrees = AllocTracer.Stop();
529 if (!LooseMemeq(DataCopy, Data, Size))
530 CrashOnOverwrittenData();
531 CurrentUnitSize = 0;
532 delete[] DataCopy;
533}
534
535void Fuzzer::WriteToOutputCorpus(const Unit &U) {
536 if (Options.OnlyASCII)
537 assert(IsASCII(U));
538 if (Options.OutputCorpus.empty())
539 return;
540 std::string Path = DirPlusFile(Options.OutputCorpus, Hash(U));
541 WriteToFile(U, Path);
542 if (Options.Verbosity >= 2)
543 Printf("Written %zd bytes to %s\n", U.size(), Path.c_str());
544}
545
546void Fuzzer::WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix) {
547 if (!Options.SaveArtifacts)
548 return;
549 std::string Path = Options.ArtifactPrefix + Prefix + Hash(U);
550 if (!Options.ExactArtifactPath.empty())
551 Path = Options.ExactArtifactPath; // Overrides ArtifactPrefix.
552 WriteToFile(U, Path);
553 Printf("artifact_prefix='%s'; Test unit written to %s\n",
554 Options.ArtifactPrefix.c_str(), Path.c_str());
555 if (U.size() <= kMaxUnitSizeToPrint)
556 Printf("Base64: %s\n", Base64(U).c_str());
557}
558
559void Fuzzer::PrintStatusForNewUnit(const Unit &U, const char *Text) {
560 if (!Options.PrintNEW)
561 return;
562 PrintStats(Text, "");
563 if (Options.Verbosity) {
564 Printf(" L: %zd/%zd ", U.size(), Corpus.MaxInputSize());
565 MD.PrintMutationSequence();
566 Printf("\n");
567 }
568}
569
570void Fuzzer::ReportNewCoverage(InputInfo *II, const Unit &U) {
571 II->NumSuccessfullMutations++;
572 MD.RecordSuccessfulMutationSequence();
Alex Shlyapnikov5ded0702017-10-23 23:24:33573 PrintStatusForNewUnit(U, II->Reduced ? "REDUCE" : "NEW ");
George Karpenkov10ab2ac2017-08-21 23:25:50574 WriteToOutputCorpus(U);
575 NumberOfNewUnitsAdded++;
Alex Shlyapnikov5ded0702017-10-23 23:24:33576 CheckExitOnSrcPosOrItem(); // Check only after the unit is saved to corpus.
George Karpenkov10ab2ac2017-08-21 23:25:50577 LastCorpusUpdateRun = TotalNumberOfRuns;
George Karpenkov10ab2ac2017-08-21 23:25:50578}
579
580// Tries detecting a memory leak on the particular input that we have just
581// executed before calling this function.
582void Fuzzer::TryDetectingAMemoryLeak(const uint8_t *Data, size_t Size,
583 bool DuringInitialCorpusExecution) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33584 if (!HasMoreMallocsThanFrees)
585 return; // mallocs==frees, a leak is unlikely.
586 if (!Options.DetectLeaks)
587 return;
Max Moroz3f26dac2017-09-12 02:01:54588 if (!DuringInitialCorpusExecution &&
Alex Shlyapnikov5ded0702017-10-23 23:24:33589 TotalNumberOfRuns >= Options.MaxNumberOfRuns)
590 return;
George Karpenkov10ab2ac2017-08-21 23:25:50591 if (!&(EF->__lsan_enable) || !&(EF->__lsan_disable) ||
592 !(EF->__lsan_do_recoverable_leak_check))
Alex Shlyapnikov5ded0702017-10-23 23:24:33593 return; // No lsan.
George Karpenkov10ab2ac2017-08-21 23:25:50594 // Run the target once again, but with lsan disabled so that if there is
595 // a real leak we do not report it twice.
596 EF->__lsan_disable();
597 ExecuteCallback(Data, Size);
598 EF->__lsan_enable();
Alex Shlyapnikov5ded0702017-10-23 23:24:33599 if (!HasMoreMallocsThanFrees)
600 return; // a leak is unlikely.
George Karpenkov10ab2ac2017-08-21 23:25:50601 if (NumberOfLeakDetectionAttempts++ > 1000) {
602 Options.DetectLeaks = false;
603 Printf("INFO: libFuzzer disabled leak detection after every mutation.\n"
604 " Most likely the target function accumulates allocated\n"
605 " memory in a global state w/o actually leaking it.\n"
606 " You may try running this binary with -trace_malloc=[12]"
607 " to get a trace of mallocs and frees.\n"
608 " If LeakSanitizer is enabled in this process it will still\n"
609 " run on the process shutdown.\n");
610 return;
611 }
612 // Now perform the actual lsan pass. This is expensive and we must ensure
613 // we don't call it too often.
614 if (EF->__lsan_do_recoverable_leak_check()) { // Leak is found, report it.
615 if (DuringInitialCorpusExecution)
616 Printf("\nINFO: a leak has been found in the initial corpus.\n\n");
617 Printf("INFO: to ignore leaks on libFuzzer side use -detect_leaks=0.\n\n");
618 CurrentUnitSize = Size;
619 DumpCurrentUnit("leak-");
620 PrintFinalStats();
Alex Shlyapnikov5ded0702017-10-23 23:24:33621 _Exit(Options.ErrorExitCode); // not exit() to disable lsan further on.
George Karpenkov10ab2ac2017-08-21 23:25:50622 }
623}
624
625void Fuzzer::MutateAndTestOne() {
626 MD.StartMutationSequence();
627
628 auto &II = Corpus.ChooseUnitToMutate(MD.GetRand());
Kostya Serebryany4083d542017-10-11 01:44:26629 if (Options.UseFeatureFrequency)
630 Corpus.UpdateFeatureFrequencyScore(&II);
George Karpenkov10ab2ac2017-08-21 23:25:50631 const auto &U = II.U;
632 memcpy(BaseSha1, II.Sha1, sizeof(BaseSha1));
633 assert(CurrentUnitData);
634 size_t Size = U.size();
635 assert(Size <= MaxInputLen && "Oversized Unit");
636 memcpy(CurrentUnitData, U.data(), Size);
637
638 assert(MaxMutationLen > 0);
639
640 size_t CurrentMaxMutationLen =
641 Min(MaxMutationLen, Max(U.size(), TmpMaxMutationLen));
642 assert(CurrentMaxMutationLen > 0);
643
644 for (int i = 0; i < Options.MutateDepth; i++) {
645 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
646 break;
Kostya Serebryanya2ca2dc2017-11-09 20:30:19647 MaybeExitGracefully();
George Karpenkov10ab2ac2017-08-21 23:25:50648 size_t NewSize = 0;
649 NewSize = MD.Mutate(CurrentUnitData, Size, CurrentMaxMutationLen);
650 assert(NewSize > 0 && "Mutator returned empty unit");
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30651 assert(NewSize <= CurrentMaxMutationLen && "Mutator return oversized unit");
George Karpenkov10ab2ac2017-08-21 23:25:50652 Size = NewSize;
653 II.NumExecutedMutations++;
George Karpenkov10ab2ac2017-08-21 23:25:50654
Kostya Serebryanyad05ee02017-12-01 19:18:38655 bool FoundUniqFeatures = false;
656 bool NewCov = RunOne(CurrentUnitData, Size, /*MayDeleteFile=*/true, &II,
657 &FoundUniqFeatures);
George Karpenkov10ab2ac2017-08-21 23:25:50658 TryDetectingAMemoryLeak(CurrentUnitData, Size,
659 /*DuringInitialCorpusExecution*/ false);
Kostya Serebryanyad05ee02017-12-01 19:18:38660 if (NewCov) {
Matt Morehouse947838c2017-11-09 20:44:08661 ReportNewCoverage(&II, {CurrentUnitData, CurrentUnitData + Size});
Kostya Serebryanyad05ee02017-12-01 19:18:38662 break; // We will mutate this input more in the next rounds.
663 }
664 if (Options.ReduceDepth && !FoundUniqFeatures)
665 break;
George Karpenkov10ab2ac2017-08-21 23:25:50666 }
667}
668
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30669void Fuzzer::PurgeAllocator() {
Alex Shlyapnikov5ded0702017-10-23 23:24:33670 if (Options.PurgeAllocatorIntervalSec < 0 || !EF->__sanitizer_purge_allocator)
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30671 return;
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30672 if (duration_cast<seconds>(system_clock::now() -
Alex Shlyapnikov5ded0702017-10-23 23:24:33673 LastAllocatorPurgeAttemptTime)
674 .count() < Options.PurgeAllocatorIntervalSec)
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30675 return;
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30676
677 if (Options.RssLimitMb <= 0 ||
Alex Shlyapnikov5ded0702017-10-23 23:24:33678 GetPeakRSSMb() > static_cast<size_t>(Options.RssLimitMb) / 2)
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30679 EF->__sanitizer_purge_allocator();
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30680
681 LastAllocatorPurgeAttemptTime = system_clock::now();
682}
683
Kostya Serebryany3a8e3c82017-08-29 02:05:01684void Fuzzer::ReadAndExecuteSeedCorpora(const Vector<std::string> &CorpusDirs) {
685 const size_t kMaxSaneLen = 1 << 20;
686 const size_t kMinDefaultLen = 4096;
Kostya Serebryany4faeb872017-08-29 20:51:24687 Vector<SizedFile> SizedFiles;
688 size_t MaxSize = 0;
689 size_t MinSize = -1;
690 size_t TotalSize = 0;
Kostya Serebryany93679be2017-09-12 21:58:07691 size_t LastNumFiles = 0;
Kostya Serebryany4faeb872017-08-29 20:51:24692 for (auto &Dir : CorpusDirs) {
Kostya Serebryany93679be2017-09-12 21:58:07693 GetSizedFilesFromDir(Dir, &SizedFiles);
694 Printf("INFO: % 8zd files found in %s\n", SizedFiles.size() - LastNumFiles,
695 Dir.c_str());
696 LastNumFiles = SizedFiles.size();
697 }
698 for (auto &File : SizedFiles) {
699 MaxSize = Max(File.Size, MaxSize);
700 MinSize = Min(File.Size, MinSize);
701 TotalSize += File.Size;
Kostya Serebryany3a8e3c82017-08-29 02:05:01702 }
Kostya Serebryany4faeb872017-08-29 20:51:24703 if (Options.MaxLen == 0)
704 SetMaxInputLen(std::min(std::max(kMinDefaultLen, MaxSize), kMaxSaneLen));
705 assert(MaxInputLen > 0);
706
Kostya Serebryany51823d32017-10-13 01:12:23707 // Test the callback with empty input and never try it again.
708 uint8_t dummy = 0;
709 ExecuteCallback(&dummy, 0);
710
Kostya Serebryany4faeb872017-08-29 20:51:24711 if (SizedFiles.empty()) {
712 Printf("INFO: A corpus is not provided, starting from an empty corpus\n");
713 Unit U({'\n'}); // Valid ASCII input.
714 RunOne(U.data(), U.size());
715 } else {
716 Printf("INFO: seed corpus: files: %zd min: %zdb max: %zdb total: %zdb"
717 " rss: %zdMb\n",
718 SizedFiles.size(), MinSize, MaxSize, TotalSize, GetPeakRSSMb());
719 if (Options.ShuffleAtStartUp)
720 std::shuffle(SizedFiles.begin(), SizedFiles.end(), MD.GetRand());
721
Kostya Serebryany93679be2017-09-12 21:58:07722 if (Options.PreferSmall) {
723 std::stable_sort(SizedFiles.begin(), SizedFiles.end());
724 assert(SizedFiles.front().Size <= SizedFiles.back().Size);
725 }
Kostya Serebryany4faeb872017-08-29 20:51:24726
727 // Load and execute inputs one by one.
728 for (auto &SF : SizedFiles) {
Kostya Serebryany082e9a72017-08-31 19:17:15729 auto U = FileToVector(SF.File, MaxInputLen, /*ExitOnError=*/false);
Kostya Serebryany4faeb872017-08-29 20:51:24730 assert(U.size() <= MaxInputLen);
731 RunOne(U.data(), U.size());
732 CheckExitOnSrcPosOrItem();
733 TryDetectingAMemoryLeak(U.data(), U.size(),
734 /*DuringInitialCorpusExecution*/ true);
735 }
Kostya Serebryany3a8e3c82017-08-29 02:05:01736 }
737
Kostya Serebryany4faeb872017-08-29 20:51:24738 PrintStats("INITED");
739 if (Corpus.empty()) {
740 Printf("ERROR: no interesting inputs were found. "
741 "Is the code instrumented for coverage? Exiting.\n");
742 exit(1);
Kostya Serebryany3a8e3c82017-08-29 02:05:01743 }
Kostya Serebryany3a8e3c82017-08-29 02:05:01744}
745
746void Fuzzer::Loop(const Vector<std::string> &CorpusDirs) {
747 ReadAndExecuteSeedCorpora(CorpusDirs);
George Karpenkov10ab2ac2017-08-21 23:25:50748 TPC.SetPrintNewPCs(Options.PrintNewCovPcs);
Kostya Serebryany2eef8162017-08-25 20:09:25749 TPC.SetPrintNewFuncs(Options.PrintNewCovFuncs);
George Karpenkov10ab2ac2017-08-21 23:25:50750 system_clock::time_point LastCorpusReload = system_clock::now();
751 if (Options.DoCrossOver)
752 MD.SetCorpus(&Corpus);
753 while (true) {
754 auto Now = system_clock::now();
755 if (duration_cast<seconds>(Now - LastCorpusReload).count() >=
756 Options.ReloadIntervalSec) {
757 RereadOutputCorpus(MaxInputLen);
758 LastCorpusReload = system_clock::now();
759 }
760 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
761 break;
Alex Shlyapnikov5ded0702017-10-23 23:24:33762 if (TimedOut())
763 break;
George Karpenkov10ab2ac2017-08-21 23:25:50764
765 // Update TmpMaxMutationLen
Matt Morehouse36c89b32018-02-13 20:52:15766 if (Options.LenControl) {
George Karpenkov10ab2ac2017-08-21 23:25:50767 if (TmpMaxMutationLen < MaxMutationLen &&
Kostya Serebryanye9ed2322017-12-12 23:11:28768 TotalNumberOfRuns - LastCorpusUpdateRun >
Matt Morehouse36c89b32018-02-13 20:52:15769 Options.LenControl * Log(TmpMaxMutationLen)) {
George Karpenkov10ab2ac2017-08-21 23:25:50770 TmpMaxMutationLen =
Kostya Serebryanye9ed2322017-12-12 23:11:28771 Min(MaxMutationLen, TmpMaxMutationLen + Log(TmpMaxMutationLen));
Kostya Serebryanye9ed2322017-12-12 23:11:28772 LastCorpusUpdateRun = TotalNumberOfRuns;
George Karpenkov10ab2ac2017-08-21 23:25:50773 }
774 } else {
775 TmpMaxMutationLen = MaxMutationLen;
776 }
777
778 // Perform several mutations and runs.
779 MutateAndTestOne();
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30780
781 PurgeAllocator();
George Karpenkov10ab2ac2017-08-21 23:25:50782 }
783
784 PrintStats("DONE ", "\n");
785 MD.PrintRecommendedDictionary();
786}
787
788void Fuzzer::MinimizeCrashLoop(const Unit &U) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33789 if (U.size() <= 1)
790 return;
George Karpenkov10ab2ac2017-08-21 23:25:50791 while (!TimedOut() && TotalNumberOfRuns < Options.MaxNumberOfRuns) {
792 MD.StartMutationSequence();
793 memcpy(CurrentUnitData, U.data(), U.size());
794 for (int i = 0; i < Options.MutateDepth; i++) {
795 size_t NewSize = MD.Mutate(CurrentUnitData, U.size(), MaxMutationLen);
796 assert(NewSize > 0 && NewSize <= MaxMutationLen);
797 ExecuteCallback(CurrentUnitData, NewSize);
798 PrintPulseAndReportSlowInput(CurrentUnitData, NewSize);
799 TryDetectingAMemoryLeak(CurrentUnitData, NewSize,
800 /*DuringInitialCorpusExecution*/ false);
801 }
802 }
803}
804
805void Fuzzer::AnnounceOutput(const uint8_t *Data, size_t Size) {
806 if (SMR.IsServer()) {
807 SMR.WriteByteArray(Data, Size);
808 } else if (SMR.IsClient()) {
809 SMR.PostClient();
810 SMR.WaitServer();
811 size_t OtherSize = SMR.ReadByteArraySize();
812 uint8_t *OtherData = SMR.GetByteArray();
813 if (Size != OtherSize || memcmp(Data, OtherData, Size) != 0) {
814 size_t i = 0;
815 for (i = 0; i < Min(Size, OtherSize); i++)
816 if (Data[i] != OtherData[i])
817 break;
818 Printf("==%lu== ERROR: libFuzzer: equivalence-mismatch. Sizes: %zd %zd; "
Alex Shlyapnikov5ded0702017-10-23 23:24:33819 "offset %zd\n",
820 GetPid(), Size, OtherSize, i);
George Karpenkov10ab2ac2017-08-21 23:25:50821 DumpCurrentUnit("mismatch-");
822 Printf("SUMMARY: libFuzzer: equivalence-mismatch\n");
823 PrintFinalStats();
824 _Exit(Options.ErrorExitCode);
825 }
826 }
827}
828
829} // namespace fuzzer
830
831extern "C" {
832
Petr Hosekeac2b472018-01-17 20:39:14833__attribute__((visibility("default"))) size_t
834LLVMFuzzerMutate(uint8_t *Data, size_t Size, size_t MaxSize) {
George Karpenkov10ab2ac2017-08-21 23:25:50835 assert(fuzzer::F);
836 return fuzzer::F->GetMD().DefaultMutate(Data, Size, MaxSize);
837}
838
839// Experimental
Petr Hosekeac2b472018-01-17 20:39:14840__attribute__((visibility("default"))) void
841LLVMFuzzerAnnounceOutput(const uint8_t *Data, size_t Size) {
George Karpenkov10ab2ac2017-08-21 23:25:50842 assert(fuzzer::F);
843 fuzzer::F->AnnounceOutput(Data, Size);
844}
Alex Shlyapnikov5ded0702017-10-23 23:24:33845} // extern "C"