1 //===- 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>
22 #include <mutex>
23 #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 
39 namespace fuzzer {
40 static const size_t kMaxUnitSizeToPrint = 256;
41 
42 thread_local bool Fuzzer::IsMyThread;
43 
44 SharedMemoryRegion SMR;
45 
46 // Only one Fuzzer per process.
47 static 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.
51 struct 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;
73 
74   std::recursive_mutex TraceMutex;
75   bool TraceDisabled = false;
76 };
77 
78 static MallocFreeTracer AllocTracer;
79 
80 // Locks printing and avoids nested hooks triggered from mallocs/frees in
81 // sanitizer.
82 class TraceLock {
83 public:
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 
94 private:
95   std::lock_guard<std::recursive_mutex> Lock;
96 };
97 
98 ATTRIBUTE_NO_SANITIZE_MEMORY
99 void MallocHook(const volatile void *ptr, size_t size) {
100   size_t N = AllocTracer.Mallocs++;
101   F->HandleMalloc(size);
102   if (int TraceLevel = AllocTracer.TraceLevel) {
103     TraceLock Lock;
104     if (Lock.IsDisabled())
105       return;
106     Printf("MALLOC[%zd] %p %zd\n", N, ptr, size);
107     if (TraceLevel >= 2 && EF)
108       EF->__sanitizer_print_stack_trace();
109   }
110 }
111 
112 ATTRIBUTE_NO_SANITIZE_MEMORY
113 void FreeHook(const volatile void *ptr) {
114   size_t N = AllocTracer.Frees++;
115   if (int TraceLevel = AllocTracer.TraceLevel) {
116     TraceLock Lock;
117     if (Lock.IsDisabled())
118       return;
119     Printf("FREE[%zd]   %p\n", N, ptr);
120     if (TraceLevel >= 2 && EF)
121       EF->__sanitizer_print_stack_trace();
122   }
123 }
124 
125 // Crash on a single malloc that exceeds the rss limit.
126 void Fuzzer::HandleMalloc(size_t Size) {
127   if (!Options.MallocLimitMb || (Size >> 20) < (size_t)Options.MallocLimitMb)
128     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");
132   if (EF->__sanitizer_print_stack_trace)
133     EF->__sanitizer_print_stack_trace();
134   DumpCurrentUnit("oom-");
135   Printf("SUMMARY: libFuzzer: out-of-memory\n");
136   PrintFinalStats();
137   _Exit(Options.ErrorExitCode); // Stop right now.
138 }
139 
140 Fuzzer::Fuzzer(UserCallback CB, InputCorpus &Corpus, MutationDispatcher &MD,
141                FuzzingOptions Options)
142     : CB(CB), Corpus(Corpus), MD(MD), Options(Options) {
143   if (EF->__sanitizer_set_death_callback)
144     EF->__sanitizer_set_death_callback(StaticDeathCallback);
145   assert(!F);
146   F = this;
147   TPC.ResetMaps();
148   IsMyThread = true;
149   if (Options.DetectLeaks && EF->__sanitizer_install_malloc_and_free_hooks)
150     EF->__sanitizer_install_malloc_and_free_hooks(MallocHook, FreeHook);
151   TPC.SetUseCounters(Options.UseCounters);
152   TPC.SetUseValueProfile(Options.UseValueProfile);
153   TPC.SetUseClangCoverage(Options.UseClangCoverage);
154 
155   if (Options.Verbosity)
156     TPC.PrintModuleInfo();
157   if (!Options.OutputCorpus.empty() && Options.ReloadIntervalSec)
158     EpochOfLastReadOfOutputCorpus = GetEpoch(Options.OutputCorpus);
159   MaxInputLen = MaxMutationLen = Options.MaxLen;
160   TmpMaxMutationLen = Max(size_t(4), Corpus.MaxInputSize());
161   AllocateCurrentUnitData();
162   CurrentUnitSize = 0;
163   memset(BaseSha1, 0, sizeof(BaseSha1));
164 }
165 
166 Fuzzer::~Fuzzer() {}
167 
168 void Fuzzer::AllocateCurrentUnitData() {
169   if (CurrentUnitData || MaxInputLen == 0)
170     return;
171   CurrentUnitData = new uint8_t[MaxInputLen];
172 }
173 
174 void Fuzzer::StaticDeathCallback() {
175   assert(F);
176   F->DeathCallback();
177 }
178 
179 void Fuzzer::DumpCurrentUnit(const char *Prefix) {
180   if (!CurrentUnitData)
181     return; // Happens when running individual inputs.
182   MD.PrintMutationSequence();
183   Printf("; base unit: %s\n", Sha1ToString(BaseSha1).c_str());
184   size_t UnitSize = CurrentUnitSize;
185   if (UnitSize <= kMaxUnitSizeToPrint) {
186     PrintHexArray(CurrentUnitData, UnitSize, "\n");
187     PrintASCII(CurrentUnitData, UnitSize, "\n");
188   }
189   WriteUnitToFileWithPrefix({CurrentUnitData, CurrentUnitData + UnitSize},
190                             Prefix);
191 }
192 
193 NO_SANITIZE_MEMORY
194 void Fuzzer::DeathCallback() {
195   DumpCurrentUnit("crash-");
196   PrintFinalStats();
197 }
198 
199 void Fuzzer::StaticAlarmCallback() {
200   assert(F);
201   F->AlarmCallback();
202 }
203 
204 void Fuzzer::StaticCrashSignalCallback() {
205   assert(F);
206   F->CrashCallback();
207 }
208 
209 void Fuzzer::StaticExitCallback() {
210   assert(F);
211   F->ExitCallback();
212 }
213 
214 void Fuzzer::StaticInterruptCallback() {
215   assert(F);
216   F->InterruptCallback();
217 }
218 
219 void Fuzzer::StaticGracefulExitCallback() {
220   assert(F);
221   F->GracefulExitRequested = true;
222   Printf("INFO: signal received, trying to exit gracefully\n");
223 }
224 
225 void Fuzzer::StaticFileSizeExceedCallback() {
226   Printf("==%lu== ERROR: libFuzzer: file size exceeded\n", GetPid());
227   exit(1);
228 }
229 
230 void Fuzzer::CrashCallback() {
231   Printf("==%lu== ERROR: libFuzzer: deadly signal\n", GetPid());
232   if (EF->__sanitizer_print_stack_trace)
233     EF->__sanitizer_print_stack_trace();
234   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();
240   _Exit(Options.ErrorExitCode); // Stop right now.
241 }
242 
243 void Fuzzer::ExitCallback() {
244   if (!RunningCB)
245     return; // This exit did not come from the user callback
246   Printf("==%lu== ERROR: libFuzzer: fuzz target exited\n", GetPid());
247   if (EF->__sanitizer_print_stack_trace)
248     EF->__sanitizer_print_stack_trace();
249   Printf("SUMMARY: libFuzzer: fuzz target exited\n");
250   DumpCurrentUnit("crash-");
251   PrintFinalStats();
252   _Exit(Options.ErrorExitCode);
253 }
254 
255 void Fuzzer::MaybeExitGracefully() {
256   if (!GracefulExitRequested) return;
257   Printf("==%lu== INFO: libFuzzer: exiting as requested\n", GetPid());
258   PrintFinalStats();
259   _Exit(0);
260 }
261 
262 void Fuzzer::InterruptCallback() {
263   Printf("==%lu== libFuzzer: run interrupted; exiting\n", GetPid());
264   PrintFinalStats();
265   _Exit(0); // Stop right now, don't perform any at-exit actions.
266 }
267 
268 NO_SANITIZE_MEMORY
269 void Fuzzer::AlarmCallback() {
270   assert(Options.UnitTimeoutSec > 0);
271   // In Windows Alarm callback is executed by a different thread.
272 #if !LIBFUZZER_WINDOWS
273   if (!InFuzzingThread())
274     return;
275 #endif
276   if (!RunningCB)
277     return; // We have not started running units yet.
278   size_t Seconds =
279       duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
280   if (Seconds == 0)
281     return;
282   if (Options.Verbosity >= 2)
283     Printf("AlarmCallback %zd\n", Seconds);
284   if (Seconds >= (size_t)Options.UnitTimeoutSec) {
285     Printf("ALARM: working on the last Unit for %zd seconds\n", Seconds);
286     Printf("       and the timeout value is %d (use -timeout=N to change)\n",
287            Options.UnitTimeoutSec);
288     DumpCurrentUnit("timeout-");
289     Printf("==%lu== ERROR: libFuzzer: timeout after %d seconds\n", GetPid(),
290            Seconds);
291     if (EF->__sanitizer_print_stack_trace)
292       EF->__sanitizer_print_stack_trace();
293     Printf("SUMMARY: libFuzzer: timeout\n");
294     PrintFinalStats();
295     _Exit(Options.TimeoutExitCode); // Stop right now.
296   }
297 }
298 
299 void Fuzzer::RssLimitCallback() {
300   Printf(
301       "==%lu== ERROR: libFuzzer: out-of-memory (used: %zdMb; limit: %zdMb)\n",
302       GetPid(), GetPeakRSSMb(), Options.RssLimitMb);
303   Printf("   To change the out-of-memory limit use -rss_limit_mb=<N>\n\n");
304   if (EF->__sanitizer_print_memory_profile)
305     EF->__sanitizer_print_memory_profile(95, 8);
306   DumpCurrentUnit("oom-");
307   Printf("SUMMARY: libFuzzer: out-of-memory\n");
308   PrintFinalStats();
309   _Exit(Options.ErrorExitCode); // Stop right now.
310 }
311 
312 void Fuzzer::PrintStats(const char *Where, const char *End, size_t Units) {
313   size_t ExecPerSec = execPerSec();
314   if (!Options.Verbosity)
315     return;
316   Printf("#%zd\t%s", TotalNumberOfRuns, Where);
317   if (size_t N = TPC.GetTotalPCCoverage())
318     Printf(" cov: %zd", N);
319   if (size_t N = Corpus.NumFeatures())
320     Printf(" ft: %zd", N);
321   if (!Corpus.empty()) {
322     Printf(" corp: %zd", Corpus.NumActiveUnits());
323     if (size_t N = Corpus.SizeInBytes()) {
324       if (N < (1 << 14))
325         Printf("/%zdb", N);
326       else if (N < (1 << 24))
327         Printf("/%zdKb", N >> 10);
328       else
329         Printf("/%zdMb", N >> 20);
330     }
331   }
332   if (Units)
333     Printf(" units: %zd", Units);
334 
335   Printf(" exec/s: %zd", ExecPerSec);
336   Printf(" rss: %zdMb", GetPeakRSSMb());
337   Printf("%s", End);
338 }
339 
340 void Fuzzer::PrintFinalStats() {
341   if (Options.PrintCoverage)
342     TPC.PrintCoverage();
343   if (Options.DumpCoverage)
344     TPC.DumpCoverage();
345   if (Options.PrintCorpusStats)
346     Corpus.PrintStats();
347   if (!Options.PrintFinalStats)
348     return;
349   size_t ExecPerSec = execPerSec();
350   Printf("stat::number_of_executed_units: %zd\n", TotalNumberOfRuns);
351   Printf("stat::average_exec_per_sec:     %zd\n", ExecPerSec);
352   Printf("stat::new_units_added:          %zd\n", NumberOfNewUnitsAdded);
353   Printf("stat::slowest_unit_time_sec:    %zd\n", TimeOfLongestUnitInSeconds);
354   Printf("stat::peak_rss_mb:              %zd\n", GetPeakRSSMb());
355 }
356 
357 void Fuzzer::SetMaxInputLen(size_t MaxInputLen) {
358   assert(this->MaxInputLen == 0); // Can only reset MaxInputLen from 0 to non-0.
359   assert(MaxInputLen);
360   this->MaxInputLen = MaxInputLen;
361   this->MaxMutationLen = MaxInputLen;
362   AllocateCurrentUnitData();
363   Printf("INFO: -max_len is not provided; "
364          "libFuzzer will not generate inputs larger than %zd bytes\n",
365          MaxInputLen);
366 }
367 
368 void Fuzzer::SetMaxMutationLen(size_t MaxMutationLen) {
369   assert(MaxMutationLen && MaxMutationLen <= MaxInputLen);
370   this->MaxMutationLen = MaxMutationLen;
371 }
372 
373 void Fuzzer::CheckExitOnSrcPosOrItem() {
374   if (!Options.ExitOnSrcPos.empty()) {
375     static auto *PCsSet = new Set<uintptr_t>;
376     auto HandlePC = [&](uintptr_t PC) {
377       if (!PCsSet->insert(PC).second)
378         return;
379       std::string Descr = DescribePC("%F %L", PC + 1);
380       if (Descr.find(Options.ExitOnSrcPos) != std::string::npos) {
381         Printf("INFO: found line matching '%s', exiting.\n",
382                Options.ExitOnSrcPos.c_str());
383         _Exit(0);
384       }
385     };
386     TPC.ForEachObservedPC(HandlePC);
387   }
388   if (!Options.ExitOnItem.empty()) {
389     if (Corpus.HasUnit(Options.ExitOnItem)) {
390       Printf("INFO: found item with checksum '%s', exiting.\n",
391              Options.ExitOnItem.c_str());
392       _Exit(0);
393     }
394   }
395 }
396 
397 void Fuzzer::RereadOutputCorpus(size_t MaxSize) {
398   if (Options.OutputCorpus.empty() || !Options.ReloadIntervalSec)
399     return;
400   Vector<Unit> AdditionalCorpus;
401   ReadDirToVectorOfUnits(Options.OutputCorpus.c_str(), &AdditionalCorpus,
402                          &EpochOfLastReadOfOutputCorpus, MaxSize,
403                          /*ExitOnError*/ false);
404   if (Options.Verbosity >= 2)
405     Printf("Reload: read %zd new units.\n", AdditionalCorpus.size());
406   bool Reloaded = false;
407   for (auto &U : AdditionalCorpus) {
408     if (U.size() > MaxSize)
409       U.resize(MaxSize);
410     if (!Corpus.HasUnit(U)) {
411       if (RunOne(U.data(), U.size())) {
412         CheckExitOnSrcPosOrItem();
413         Reloaded = true;
414       }
415     }
416   }
417   if (Reloaded)
418     PrintStats("RELOAD");
419 }
420 
421 void Fuzzer::PrintPulseAndReportSlowInput(const uint8_t *Data, size_t Size) {
422   auto TimeOfUnit =
423       duration_cast<seconds>(UnitStopTime - UnitStartTime).count();
424   if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) &&
425       secondsSinceProcessStartUp() >= 2)
426     PrintStats("pulse ");
427   if (TimeOfUnit > TimeOfLongestUnitInSeconds * 1.1 &&
428       TimeOfUnit >= Options.ReportSlowUnits) {
429     TimeOfLongestUnitInSeconds = TimeOfUnit;
430     Printf("Slowest unit: %zd s:\n", TimeOfLongestUnitInSeconds);
431     WriteUnitToFileWithPrefix({Data, Data + Size}, "slow-unit-");
432   }
433 }
434 
435 bool Fuzzer::RunOne(const uint8_t *Data, size_t Size, bool MayDeleteFile,
436                     InputInfo *II, bool *FoundUniqFeatures) {
437   if (!Size)
438     return false;
439 
440   ExecuteCallback(Data, Size);
441 
442   UniqFeatureSetTmp.clear();
443   size_t FoundUniqFeaturesOfII = 0;
444   size_t NumUpdatesBefore = Corpus.NumFeatureUpdates();
445   TPC.CollectFeatures([&](size_t Feature) {
446     Corpus.UpdateFeatureFrequency(Feature);
447     if (Corpus.AddFeature(Feature, Size, Options.Shrink))
448       UniqFeatureSetTmp.push_back(Feature);
449     if (Options.ReduceInputs && II)
450       if (std::binary_search(II->UniqFeatureSet.begin(),
451                              II->UniqFeatureSet.end(), Feature))
452         FoundUniqFeaturesOfII++;
453   });
454   if (FoundUniqFeatures)
455     *FoundUniqFeatures = FoundUniqFeaturesOfII;
456   PrintPulseAndReportSlowInput(Data, Size);
457   size_t NumNewFeatures = Corpus.NumFeatureUpdates() - NumUpdatesBefore;
458   if (NumNewFeatures) {
459     TPC.UpdateObservedPCs();
460     Corpus.AddToCorpus({Data, Data + Size}, NumNewFeatures, MayDeleteFile,
461                        UniqFeatureSetTmp);
462     return true;
463   }
464   if (II && FoundUniqFeaturesOfII &&
465       FoundUniqFeaturesOfII == II->UniqFeatureSet.size() &&
466       II->U.size() > Size) {
467     Corpus.Replace(II, {Data, Data + Size});
468     return true;
469   }
470   return false;
471 }
472 
473 size_t Fuzzer::GetCurrentUnitInFuzzingThead(const uint8_t **Data) const {
474   assert(InFuzzingThread());
475   *Data = CurrentUnitData;
476   return CurrentUnitSize;
477 }
478 
479 void Fuzzer::CrashOnOverwrittenData() {
480   Printf("==%d== ERROR: libFuzzer: fuzz target overwrites it's const input\n",
481          GetPid());
482   DumpCurrentUnit("crash-");
483   Printf("SUMMARY: libFuzzer: out-of-memory\n");
484   _Exit(Options.ErrorExitCode); // Stop right now.
485 }
486 
487 // Compare two arrays, but not all bytes if the arrays are large.
488 static bool LooseMemeq(const uint8_t *A, const uint8_t *B, size_t Size) {
489   const size_t Limit = 64;
490   if (Size <= 64)
491     return !memcmp(A, B, Size);
492   // Compare first and last Limit/2 bytes.
493   return !memcmp(A, B, Limit / 2) &&
494          !memcmp(A + Size - Limit / 2, B + Size - Limit / 2, Limit / 2);
495 }
496 
497 void Fuzzer::ExecuteCallback(const uint8_t *Data, size_t Size) {
498   TPC.RecordInitialStack();
499   TotalNumberOfRuns++;
500   assert(InFuzzingThread());
501   if (SMR.IsClient())
502     SMR.WriteByteArray(Data, Size);
503   // We copy the contents of Unit into a separate heap buffer
504   // so that we reliably find buffer overflows in it.
505   uint8_t *DataCopy = new uint8_t[Size];
506   memcpy(DataCopy, Data, Size);
507   if (CurrentUnitData && CurrentUnitData != Data)
508     memcpy(CurrentUnitData, Data, Size);
509   CurrentUnitSize = Size;
510   AllocTracer.Start(Options.TraceMalloc);
511   UnitStartTime = system_clock::now();
512   TPC.ResetMaps();
513   RunningCB = true;
514   int Res = CB(DataCopy, Size);
515   RunningCB = false;
516   UnitStopTime = system_clock::now();
517   (void)Res;
518   assert(Res == 0);
519   HasMoreMallocsThanFrees = AllocTracer.Stop();
520   if (!LooseMemeq(DataCopy, Data, Size))
521     CrashOnOverwrittenData();
522   CurrentUnitSize = 0;
523   delete[] DataCopy;
524 }
525 
526 void Fuzzer::WriteToOutputCorpus(const Unit &U) {
527   if (Options.OnlyASCII)
528     assert(IsASCII(U));
529   if (Options.OutputCorpus.empty())
530     return;
531   std::string Path = DirPlusFile(Options.OutputCorpus, Hash(U));
532   WriteToFile(U, Path);
533   if (Options.Verbosity >= 2)
534     Printf("Written %zd bytes to %s\n", U.size(), Path.c_str());
535 }
536 
537 void Fuzzer::WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix) {
538   if (!Options.SaveArtifacts)
539     return;
540   std::string Path = Options.ArtifactPrefix + Prefix + Hash(U);
541   if (!Options.ExactArtifactPath.empty())
542     Path = Options.ExactArtifactPath; // Overrides ArtifactPrefix.
543   WriteToFile(U, Path);
544   Printf("artifact_prefix='%s'; Test unit written to %s\n",
545          Options.ArtifactPrefix.c_str(), Path.c_str());
546   if (U.size() <= kMaxUnitSizeToPrint)
547     Printf("Base64: %s\n", Base64(U).c_str());
548 }
549 
550 void Fuzzer::PrintStatusForNewUnit(const Unit &U, const char *Text) {
551   if (!Options.PrintNEW)
552     return;
553   PrintStats(Text, "");
554   if (Options.Verbosity) {
555     Printf(" L: %zd/%zd ", U.size(), Corpus.MaxInputSize());
556     MD.PrintMutationSequence();
557     Printf("\n");
558   }
559 }
560 
561 void Fuzzer::ReportNewCoverage(InputInfo *II, const Unit &U) {
562   II->NumSuccessfullMutations++;
563   MD.RecordSuccessfulMutationSequence();
564   PrintStatusForNewUnit(U, II->Reduced ? "REDUCE" : "NEW   ");
565   WriteToOutputCorpus(U);
566   NumberOfNewUnitsAdded++;
567   CheckExitOnSrcPosOrItem(); // Check only after the unit is saved to corpus.
568   LastCorpusUpdateRun = TotalNumberOfRuns;
569   LastCorpusUpdateTime = system_clock::now();
570 }
571 
572 // Tries detecting a memory leak on the particular input that we have just
573 // executed before calling this function.
574 void Fuzzer::TryDetectingAMemoryLeak(const uint8_t *Data, size_t Size,
575                                      bool DuringInitialCorpusExecution) {
576   if (!HasMoreMallocsThanFrees)
577     return; // mallocs==frees, a leak is unlikely.
578   if (!Options.DetectLeaks)
579     return;
580   if (!DuringInitialCorpusExecution &&
581       TotalNumberOfRuns >= Options.MaxNumberOfRuns)
582     return;
583   if (!&(EF->__lsan_enable) || !&(EF->__lsan_disable) ||
584       !(EF->__lsan_do_recoverable_leak_check))
585     return; // No lsan.
586   // Run the target once again, but with lsan disabled so that if there is
587   // a real leak we do not report it twice.
588   EF->__lsan_disable();
589   ExecuteCallback(Data, Size);
590   EF->__lsan_enable();
591   if (!HasMoreMallocsThanFrees)
592     return; // a leak is unlikely.
593   if (NumberOfLeakDetectionAttempts++ > 1000) {
594     Options.DetectLeaks = false;
595     Printf("INFO: libFuzzer disabled leak detection after every mutation.\n"
596            "      Most likely the target function accumulates allocated\n"
597            "      memory in a global state w/o actually leaking it.\n"
598            "      You may try running this binary with -trace_malloc=[12]"
599            "      to get a trace of mallocs and frees.\n"
600            "      If LeakSanitizer is enabled in this process it will still\n"
601            "      run on the process shutdown.\n");
602     return;
603   }
604   // Now perform the actual lsan pass. This is expensive and we must ensure
605   // we don't call it too often.
606   if (EF->__lsan_do_recoverable_leak_check()) { // Leak is found, report it.
607     if (DuringInitialCorpusExecution)
608       Printf("\nINFO: a leak has been found in the initial corpus.\n\n");
609     Printf("INFO: to ignore leaks on libFuzzer side use -detect_leaks=0.\n\n");
610     CurrentUnitSize = Size;
611     DumpCurrentUnit("leak-");
612     PrintFinalStats();
613     _Exit(Options.ErrorExitCode); // not exit() to disable lsan further on.
614   }
615 }
616 
617 void Fuzzer::MutateAndTestOne() {
618   MD.StartMutationSequence();
619 
620   auto &II = Corpus.ChooseUnitToMutate(MD.GetRand());
621   if (Options.UseFeatureFrequency)
622     Corpus.UpdateFeatureFrequencyScore(&II);
623   const auto &U = II.U;
624   memcpy(BaseSha1, II.Sha1, sizeof(BaseSha1));
625   assert(CurrentUnitData);
626   size_t Size = U.size();
627   assert(Size <= MaxInputLen && "Oversized Unit");
628   memcpy(CurrentUnitData, U.data(), Size);
629 
630   assert(MaxMutationLen > 0);
631 
632   size_t CurrentMaxMutationLen =
633       Min(MaxMutationLen, Max(U.size(), TmpMaxMutationLen));
634   assert(CurrentMaxMutationLen > 0);
635 
636   for (int i = 0; i < Options.MutateDepth; i++) {
637     if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
638       break;
639     MaybeExitGracefully();
640     size_t NewSize = 0;
641     NewSize = MD.Mutate(CurrentUnitData, Size, CurrentMaxMutationLen);
642     assert(NewSize > 0 && "Mutator returned empty unit");
643     assert(NewSize <= CurrentMaxMutationLen && "Mutator return oversized unit");
644     Size = NewSize;
645     II.NumExecutedMutations++;
646 
647     bool FoundUniqFeatures = false;
648     bool NewCov = RunOne(CurrentUnitData, Size, /*MayDeleteFile=*/true, &II,
649                          &FoundUniqFeatures);
650     TryDetectingAMemoryLeak(CurrentUnitData, Size,
651                             /*DuringInitialCorpusExecution*/ false);
652     if (NewCov) {
653       ReportNewCoverage(&II, {CurrentUnitData, CurrentUnitData + Size});
654       break;  // We will mutate this input more in the next rounds.
655     }
656     if (Options.ReduceDepth && !FoundUniqFeatures)
657         break;
658   }
659 }
660 
661 void Fuzzer::PurgeAllocator() {
662   if (Options.PurgeAllocatorIntervalSec < 0 || !EF->__sanitizer_purge_allocator)
663     return;
664   if (duration_cast<seconds>(system_clock::now() -
665                              LastAllocatorPurgeAttemptTime)
666           .count() < Options.PurgeAllocatorIntervalSec)
667     return;
668 
669   if (Options.RssLimitMb <= 0 ||
670       GetPeakRSSMb() > static_cast<size_t>(Options.RssLimitMb) / 2)
671     EF->__sanitizer_purge_allocator();
672 
673   LastAllocatorPurgeAttemptTime = system_clock::now();
674 }
675 
676 void Fuzzer::ReadAndExecuteSeedCorpora(const Vector<std::string> &CorpusDirs) {
677   const size_t kMaxSaneLen = 1 << 20;
678   const size_t kMinDefaultLen = 4096;
679   Vector<SizedFile> SizedFiles;
680   size_t MaxSize = 0;
681   size_t MinSize = -1;
682   size_t TotalSize = 0;
683   size_t LastNumFiles = 0;
684   for (auto &Dir : CorpusDirs) {
685     GetSizedFilesFromDir(Dir, &SizedFiles);
686     Printf("INFO: % 8zd files found in %s\n", SizedFiles.size() - LastNumFiles,
687            Dir.c_str());
688     LastNumFiles = SizedFiles.size();
689   }
690   for (auto &File : SizedFiles) {
691     MaxSize = Max(File.Size, MaxSize);
692     MinSize = Min(File.Size, MinSize);
693     TotalSize += File.Size;
694   }
695   if (Options.MaxLen == 0)
696     SetMaxInputLen(std::min(std::max(kMinDefaultLen, MaxSize), kMaxSaneLen));
697   assert(MaxInputLen > 0);
698 
699   // Test the callback with empty input and never try it again.
700   uint8_t dummy = 0;
701   ExecuteCallback(&dummy, 0);
702 
703   if (SizedFiles.empty()) {
704     Printf("INFO: A corpus is not provided, starting from an empty corpus\n");
705     Unit U({'\n'}); // Valid ASCII input.
706     RunOne(U.data(), U.size());
707   } else {
708     Printf("INFO: seed corpus: files: %zd min: %zdb max: %zdb total: %zdb"
709            " rss: %zdMb\n",
710            SizedFiles.size(), MinSize, MaxSize, TotalSize, GetPeakRSSMb());
711     if (Options.ShuffleAtStartUp)
712       std::shuffle(SizedFiles.begin(), SizedFiles.end(), MD.GetRand());
713 
714     if (Options.PreferSmall) {
715       std::stable_sort(SizedFiles.begin(), SizedFiles.end());
716       assert(SizedFiles.front().Size <= SizedFiles.back().Size);
717     }
718 
719     // Load and execute inputs one by one.
720     for (auto &SF : SizedFiles) {
721       auto U = FileToVector(SF.File, MaxInputLen, /*ExitOnError=*/false);
722       assert(U.size() <= MaxInputLen);
723       RunOne(U.data(), U.size());
724       CheckExitOnSrcPosOrItem();
725       TryDetectingAMemoryLeak(U.data(), U.size(),
726                               /*DuringInitialCorpusExecution*/ true);
727     }
728   }
729 
730   PrintStats("INITED");
731   if (Corpus.empty()) {
732     Printf("ERROR: no interesting inputs were found. "
733            "Is the code instrumented for coverage? Exiting.\n");
734     exit(1);
735   }
736 }
737 
738 void Fuzzer::Loop(const Vector<std::string> &CorpusDirs) {
739   ReadAndExecuteSeedCorpora(CorpusDirs);
740   TPC.SetPrintNewPCs(Options.PrintNewCovPcs);
741   TPC.SetPrintNewFuncs(Options.PrintNewCovFuncs);
742   system_clock::time_point LastCorpusReload = system_clock::now();
743   if (Options.DoCrossOver)
744     MD.SetCorpus(&Corpus);
745   while (true) {
746     auto Now = system_clock::now();
747     if (duration_cast<seconds>(Now - LastCorpusReload).count() >=
748         Options.ReloadIntervalSec) {
749       RereadOutputCorpus(MaxInputLen);
750       LastCorpusReload = system_clock::now();
751     }
752     if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
753       break;
754     if (TimedOut())
755       break;
756 
757     // Update TmpMaxMutationLen
758     if (Options.ExperimentalLenControl) {
759       if (TmpMaxMutationLen < MaxMutationLen &&
760           (TotalNumberOfRuns - LastCorpusUpdateRun > 1000 &&
761            duration_cast<seconds>(Now - LastCorpusUpdateTime).count() >= 1)) {
762         LastCorpusUpdateRun = TotalNumberOfRuns;
763         LastCorpusUpdateTime = Now;
764         TmpMaxMutationLen =
765             Min(MaxMutationLen,
766                 TmpMaxMutationLen + Max(size_t(4), TmpMaxMutationLen / 8));
767         if (TmpMaxMutationLen <= MaxMutationLen)
768           Printf("#%zd\tTEMP_MAX_LEN: %zd\n", TotalNumberOfRuns,
769                  TmpMaxMutationLen);
770       }
771     } else {
772       TmpMaxMutationLen = MaxMutationLen;
773     }
774 
775     // Perform several mutations and runs.
776     MutateAndTestOne();
777 
778     PurgeAllocator();
779   }
780 
781   PrintStats("DONE  ", "\n");
782   MD.PrintRecommendedDictionary();
783 }
784 
785 void Fuzzer::MinimizeCrashLoop(const Unit &U) {
786   if (U.size() <= 1)
787     return;
788   while (!TimedOut() && TotalNumberOfRuns < Options.MaxNumberOfRuns) {
789     MD.StartMutationSequence();
790     memcpy(CurrentUnitData, U.data(), U.size());
791     for (int i = 0; i < Options.MutateDepth; i++) {
792       size_t NewSize = MD.Mutate(CurrentUnitData, U.size(), MaxMutationLen);
793       assert(NewSize > 0 && NewSize <= MaxMutationLen);
794       ExecuteCallback(CurrentUnitData, NewSize);
795       PrintPulseAndReportSlowInput(CurrentUnitData, NewSize);
796       TryDetectingAMemoryLeak(CurrentUnitData, NewSize,
797                               /*DuringInitialCorpusExecution*/ false);
798     }
799   }
800 }
801 
802 void Fuzzer::AnnounceOutput(const uint8_t *Data, size_t Size) {
803   if (SMR.IsServer()) {
804     SMR.WriteByteArray(Data, Size);
805   } else if (SMR.IsClient()) {
806     SMR.PostClient();
807     SMR.WaitServer();
808     size_t OtherSize = SMR.ReadByteArraySize();
809     uint8_t *OtherData = SMR.GetByteArray();
810     if (Size != OtherSize || memcmp(Data, OtherData, Size) != 0) {
811       size_t i = 0;
812       for (i = 0; i < Min(Size, OtherSize); i++)
813         if (Data[i] != OtherData[i])
814           break;
815       Printf("==%lu== ERROR: libFuzzer: equivalence-mismatch. Sizes: %zd %zd; "
816              "offset %zd\n",
817              GetPid(), Size, OtherSize, i);
818       DumpCurrentUnit("mismatch-");
819       Printf("SUMMARY: libFuzzer: equivalence-mismatch\n");
820       PrintFinalStats();
821       _Exit(Options.ErrorExitCode);
822     }
823   }
824 }
825 
826 } // namespace fuzzer
827 
828 extern "C" {
829 
830 size_t LLVMFuzzerMutate(uint8_t *Data, size_t Size, size_t MaxSize) {
831   assert(fuzzer::F);
832   return fuzzer::F->GetMD().DefaultMutate(Data, Size, MaxSize);
833 }
834 
835 // Experimental
836 void LLVMFuzzerAnnounceOutput(const uint8_t *Data, size_t Size) {
837   assert(fuzzer::F);
838   fuzzer::F->AnnounceOutput(Data, Size);
839 }
840 } // extern "C"
841