blob: 58fd5c3e97b8158649442214b0ce2e71f358d371 [file] [log] [blame]
George Karpenkov10ab2ac2017-08-21 23:25:501//===- FuzzerLoop.cpp - Fuzzer's main loop --------------------------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:563// 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 Karpenkov10ab2ac2017-08-21 23:25:506//
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 Karpenkov10ab2ac2017-08-21 23:25:5016#include "FuzzerTracePC.h"
17#include <algorithm>
18#include <cstring>
19#include <memory>
Vitaly Buka7dbc1d82017-11-01 03:02:5920#include <mutex>
George Karpenkov10ab2ac2017-08-21 23:25:5021#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
Matt Morehouse43a22962018-07-17 16:12:0042bool RunningUserCallback = false;
43
George Karpenkov10ab2ac2017-08-21 23:25:5044// 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;
Vitaly Buka7d223242017-11-02 04:12:1071
72 std::recursive_mutex TraceMutex;
73 bool TraceDisabled = false;
George Karpenkov10ab2ac2017-08-21 23:25:5074};
75
76static MallocFreeTracer AllocTracer;
77
Vitaly Buka7d223242017-11-02 04:12:1078// 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};
Vitaly Buka7dbc1d82017-11-01 03:02:5995
George Karpenkov10ab2ac2017-08-21 23:25:5096ATTRIBUTE_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) {
Vitaly Buka7d223242017-11-02 04:12:10101 TraceLock Lock;
102 if (Lock.IsDisabled())
103 return;
George Karpenkov10ab2ac2017-08-21 23:25:50104 Printf("MALLOC[%zd] %p %zd\n", N, ptr, size);
105 if (TraceLevel >= 2 && EF)
Matt Morehouse14cf71a2018-05-08 23:45:05106 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50107 }
108}
109
110ATTRIBUTE_NO_SANITIZE_MEMORY
111void FreeHook(const volatile void *ptr) {
112 size_t N = AllocTracer.Frees++;
113 if (int TraceLevel = AllocTracer.TraceLevel) {
Vitaly Buka7d223242017-11-02 04:12:10114 TraceLock Lock;
115 if (Lock.IsDisabled())
116 return;
George Karpenkov10ab2ac2017-08-21 23:25:50117 Printf("FREE[%zd] %p\n", N, ptr);
118 if (TraceLevel >= 2 && EF)
Matt Morehouse14cf71a2018-05-08 23:45:05119 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50120 }
121}
122
123// Crash on a single malloc that exceeds the rss limit.
124void Fuzzer::HandleMalloc(size_t Size) {
Kostya Serebryanyde9bafb2017-12-01 22:12:04125 if (!Options.MallocLimitMb || (Size >> 20) < (size_t)Options.MallocLimitMb)
George Karpenkov10ab2ac2017-08-21 23:25:50126 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");
Matt Morehouse14cf71a2018-05-08 23:45:05130 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50131 DumpCurrentUnit("oom-");
132 Printf("SUMMARY: libFuzzer: out-of-memory\n");
133 PrintFinalStats();
134 _Exit(Options.ErrorExitCode); // Stop right now.
135}
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);
Kostya Serebryany51ddb882018-07-03 22:33:09149 TPC.SetUseValueProfileMask(Options.UseValueProfile);
George Karpenkov10ab2ac2017-08-21 23:25:50150
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));
Kostya Serebryanye9c6f062018-05-16 23:26:37160 TPC.SetFocusFunction(Options.FocusFunction);
Kostya Serebryany1fd005f2018-06-06 01:23:29161 DFT.Init(Options.DataFlowTrace, Options.FocusFunction);
George Karpenkov10ab2ac2017-08-21 23:25:50162}
163
Alex Shlyapnikov5ded0702017-10-23 23:24:33164Fuzzer::~Fuzzer() {}
George Karpenkov10ab2ac2017-08-21 23:25:50165
166void Fuzzer::AllocateCurrentUnitData() {
Alex Shlyapnikov5ded0702017-10-23 23:24:33167 if (CurrentUnitData || MaxInputLen == 0)
168 return;
George Karpenkov10ab2ac2017-08-21 23:25:50169 CurrentUnitData = new uint8_t[MaxInputLen];
170}
171
172void Fuzzer::StaticDeathCallback() {
173 assert(F);
174 F->DeathCallback();
175}
176
177void Fuzzer::DumpCurrentUnit(const char *Prefix) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33178 if (!CurrentUnitData)
179 return; // Happens when running individual inputs.
Matt Morehousea34c65e2018-07-09 23:51:08180 ScopedDisableMsanInterceptorChecks S;
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
George Karpenkov10ab2ac2017-08-21 23:25:50208void 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() {
Julian Lettner15df2732019-01-31 01:24:01230 if (EF->__sanitizer_acquire_crash_state &&
231 !EF->__sanitizer_acquire_crash_state())
232 return;
George Karpenkov10ab2ac2017-08-21 23:25:50233 Printf("==%lu== ERROR: libFuzzer: deadly signal\n", GetPid());
Matt Morehouse14cf71a2018-05-08 23:45:05234 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50235 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();
Alex Shlyapnikov5ded0702017-10-23 23:24:33241 _Exit(Options.ErrorExitCode); // Stop right now.
George Karpenkov10ab2ac2017-08-21 23:25:50242}
243
244void Fuzzer::ExitCallback() {
Matt Morehouse43a22962018-07-17 16:12:00245 if (!RunningUserCallback)
George Karpenkov10ab2ac2017-08-21 23:25:50246 return; // This exit did not come from the user callback
Matt Morehouse52fd1692018-05-01 21:01:53247 if (EF->__sanitizer_acquire_crash_state &&
248 !EF->__sanitizer_acquire_crash_state())
249 return;
George Karpenkov10ab2ac2017-08-21 23:25:50250 Printf("==%lu== ERROR: libFuzzer: fuzz target exited\n", GetPid());
Matt Morehouse14cf71a2018-05-08 23:45:05251 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50252 Printf("SUMMARY: libFuzzer: fuzz target exited\n");
253 DumpCurrentUnit("crash-");
254 PrintFinalStats();
255 _Exit(Options.ErrorExitCode);
256}
257
Kostya Serebryanya2ca2dc2017-11-09 20:30:19258void Fuzzer::MaybeExitGracefully() {
259 if (!GracefulExitRequested) return;
260 Printf("==%lu== INFO: libFuzzer: exiting as requested\n", GetPid());
261 PrintFinalStats();
262 _Exit(0);
263}
264
George Karpenkov10ab2ac2017-08-21 23:25:50265void Fuzzer::InterruptCallback() {
266 Printf("==%lu== libFuzzer: run interrupted; exiting\n", GetPid());
267 PrintFinalStats();
Alex Shlyapnikov5ded0702017-10-23 23:24:33268 _Exit(0); // Stop right now, don't perform any at-exit actions.
George Karpenkov10ab2ac2017-08-21 23:25:50269}
270
271NO_SANITIZE_MEMORY
272void Fuzzer::AlarmCallback() {
273 assert(Options.UnitTimeoutSec > 0);
274 // In Windows Alarm callback is executed by a different thread.
Kamil Rytarowski2e611862018-11-06 01:28:01275 // NetBSD's current behavior needs this change too.
276#if !LIBFUZZER_WINDOWS && !LIBFUZZER_NETBSD
Alex Shlyapnikov5ded0702017-10-23 23:24:33277 if (!InFuzzingThread())
278 return;
George Karpenkov10ab2ac2017-08-21 23:25:50279#endif
Matt Morehouse43a22962018-07-17 16:12:00280 if (!RunningUserCallback)
George Karpenkov10ab2ac2017-08-21 23:25:50281 return; // We have not started running units yet.
282 size_t Seconds =
283 duration_cast<seconds>(system_clock::now() - UnitStartTime).count();
284 if (Seconds == 0)
285 return;
286 if (Options.Verbosity >= 2)
287 Printf("AlarmCallback %zd\n", Seconds);
288 if (Seconds >= (size_t)Options.UnitTimeoutSec) {
Matt Morehouse52fd1692018-05-01 21:01:53289 if (EF->__sanitizer_acquire_crash_state &&
290 !EF->__sanitizer_acquire_crash_state())
291 return;
George Karpenkov10ab2ac2017-08-21 23:25:50292 Printf("ALARM: working on the last Unit for %zd seconds\n", Seconds);
293 Printf(" and the timeout value is %d (use -timeout=N to change)\n",
294 Options.UnitTimeoutSec);
295 DumpCurrentUnit("timeout-");
296 Printf("==%lu== ERROR: libFuzzer: timeout after %d seconds\n", GetPid(),
297 Seconds);
Matt Morehouse14cf71a2018-05-08 23:45:05298 PrintStackTrace();
George Karpenkov10ab2ac2017-08-21 23:25:50299 Printf("SUMMARY: libFuzzer: timeout\n");
300 PrintFinalStats();
301 _Exit(Options.TimeoutExitCode); // Stop right now.
302 }
303}
304
305void Fuzzer::RssLimitCallback() {
Matt Morehouse52fd1692018-05-01 21:01:53306 if (EF->__sanitizer_acquire_crash_state &&
307 !EF->__sanitizer_acquire_crash_state())
308 return;
George Karpenkov10ab2ac2017-08-21 23:25:50309 Printf(
310 "==%lu== ERROR: libFuzzer: out-of-memory (used: %zdMb; limit: %zdMb)\n",
311 GetPid(), GetPeakRSSMb(), Options.RssLimitMb);
312 Printf(" To change the out-of-memory limit use -rss_limit_mb=<N>\n\n");
Matt Morehouse14cf71a2018-05-08 23:45:05313 PrintMemoryProfile();
George Karpenkov10ab2ac2017-08-21 23:25:50314 DumpCurrentUnit("oom-");
315 Printf("SUMMARY: libFuzzer: out-of-memory\n");
316 PrintFinalStats();
317 _Exit(Options.ErrorExitCode); // Stop right now.
318}
319
320void Fuzzer::PrintStats(const char *Where, const char *End, size_t Units) {
321 size_t ExecPerSec = execPerSec();
322 if (!Options.Verbosity)
323 return;
324 Printf("#%zd\t%s", TotalNumberOfRuns, Where);
325 if (size_t N = TPC.GetTotalPCCoverage())
326 Printf(" cov: %zd", N);
327 if (size_t N = Corpus.NumFeatures())
Alex Shlyapnikov5ded0702017-10-23 23:24:33328 Printf(" ft: %zd", N);
George Karpenkov10ab2ac2017-08-21 23:25:50329 if (!Corpus.empty()) {
330 Printf(" corp: %zd", Corpus.NumActiveUnits());
331 if (size_t N = Corpus.SizeInBytes()) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33332 if (N < (1 << 14))
George Karpenkov10ab2ac2017-08-21 23:25:50333 Printf("/%zdb", N);
334 else if (N < (1 << 24))
335 Printf("/%zdKb", N >> 10);
336 else
337 Printf("/%zdMb", N >> 20);
338 }
Kostya Serebryanye9c6f062018-05-16 23:26:37339 if (size_t FF = Corpus.NumInputsThatTouchFocusFunction())
340 Printf(" focus: %zd", FF);
George Karpenkov10ab2ac2017-08-21 23:25:50341 }
Matt Morehouseddf352b2018-02-22 19:00:17342 if (TmpMaxMutationLen)
343 Printf(" lim: %zd", TmpMaxMutationLen);
George Karpenkov10ab2ac2017-08-21 23:25:50344 if (Units)
345 Printf(" units: %zd", Units);
346
347 Printf(" exec/s: %zd", ExecPerSec);
348 Printf(" rss: %zdMb", GetPeakRSSMb());
349 Printf("%s", End);
350}
351
352void Fuzzer::PrintFinalStats() {
353 if (Options.PrintCoverage)
354 TPC.PrintCoverage();
George Karpenkov10ab2ac2017-08-21 23:25:50355 if (Options.PrintCorpusStats)
356 Corpus.PrintStats();
Alex Shlyapnikov5ded0702017-10-23 23:24:33357 if (!Options.PrintFinalStats)
358 return;
George Karpenkov10ab2ac2017-08-21 23:25:50359 size_t ExecPerSec = execPerSec();
360 Printf("stat::number_of_executed_units: %zd\n", TotalNumberOfRuns);
361 Printf("stat::average_exec_per_sec: %zd\n", ExecPerSec);
362 Printf("stat::new_units_added: %zd\n", NumberOfNewUnitsAdded);
363 Printf("stat::slowest_unit_time_sec: %zd\n", TimeOfLongestUnitInSeconds);
364 Printf("stat::peak_rss_mb: %zd\n", GetPeakRSSMb());
365}
366
367void Fuzzer::SetMaxInputLen(size_t MaxInputLen) {
368 assert(this->MaxInputLen == 0); // Can only reset MaxInputLen from 0 to non-0.
369 assert(MaxInputLen);
370 this->MaxInputLen = MaxInputLen;
371 this->MaxMutationLen = MaxInputLen;
372 AllocateCurrentUnitData();
373 Printf("INFO: -max_len is not provided; "
374 "libFuzzer will not generate inputs larger than %zd bytes\n",
375 MaxInputLen);
376}
377
378void Fuzzer::SetMaxMutationLen(size_t MaxMutationLen) {
379 assert(MaxMutationLen && MaxMutationLen <= MaxInputLen);
380 this->MaxMutationLen = MaxMutationLen;
381}
382
383void Fuzzer::CheckExitOnSrcPosOrItem() {
384 if (!Options.ExitOnSrcPos.empty()) {
George Karpenkovbebcbfb2017-08-27 23:20:09385 static auto *PCsSet = new Set<uintptr_t>;
George Karpenkov10ab2ac2017-08-21 23:25:50386 auto HandlePC = [&](uintptr_t PC) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33387 if (!PCsSet->insert(PC).second)
388 return;
George Karpenkov10ab2ac2017-08-21 23:25:50389 std::string Descr = DescribePC("%F %L", PC + 1);
390 if (Descr.find(Options.ExitOnSrcPos) != std::string::npos) {
391 Printf("INFO: found line matching '%s', exiting.\n",
392 Options.ExitOnSrcPos.c_str());
393 _Exit(0);
394 }
395 };
396 TPC.ForEachObservedPC(HandlePC);
397 }
398 if (!Options.ExitOnItem.empty()) {
399 if (Corpus.HasUnit(Options.ExitOnItem)) {
400 Printf("INFO: found item with checksum '%s', exiting.\n",
401 Options.ExitOnItem.c_str());
402 _Exit(0);
403 }
404 }
405}
406
407void Fuzzer::RereadOutputCorpus(size_t MaxSize) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33408 if (Options.OutputCorpus.empty() || !Options.ReloadIntervalSec)
409 return;
George Karpenkovbebcbfb2017-08-27 23:20:09410 Vector<Unit> AdditionalCorpus;
George Karpenkov10ab2ac2017-08-21 23:25:50411 ReadDirToVectorOfUnits(Options.OutputCorpus.c_str(), &AdditionalCorpus,
412 &EpochOfLastReadOfOutputCorpus, MaxSize,
413 /*ExitOnError*/ false);
414 if (Options.Verbosity >= 2)
415 Printf("Reload: read %zd new units.\n", AdditionalCorpus.size());
416 bool Reloaded = false;
417 for (auto &U : AdditionalCorpus) {
418 if (U.size() > MaxSize)
419 U.resize(MaxSize);
420 if (!Corpus.HasUnit(U)) {
421 if (RunOne(U.data(), U.size())) {
422 CheckExitOnSrcPosOrItem();
423 Reloaded = true;
424 }
425 }
426 }
427 if (Reloaded)
428 PrintStats("RELOAD");
429}
430
George Karpenkov10ab2ac2017-08-21 23:25:50431void Fuzzer::PrintPulseAndReportSlowInput(const uint8_t *Data, size_t Size) {
432 auto TimeOfUnit =
433 duration_cast<seconds>(UnitStopTime - UnitStartTime).count();
434 if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) &&
435 secondsSinceProcessStartUp() >= 2)
436 PrintStats("pulse ");
437 if (TimeOfUnit > TimeOfLongestUnitInSeconds * 1.1 &&
438 TimeOfUnit >= Options.ReportSlowUnits) {
439 TimeOfLongestUnitInSeconds = TimeOfUnit;
440 Printf("Slowest unit: %zd s:\n", TimeOfLongestUnitInSeconds);
441 WriteUnitToFileWithPrefix({Data, Data + Size}, "slow-unit-");
442 }
443}
444
445bool Fuzzer::RunOne(const uint8_t *Data, size_t Size, bool MayDeleteFile,
Kostya Serebryanyad05ee02017-12-01 19:18:38446 InputInfo *II, bool *FoundUniqFeatures) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33447 if (!Size)
448 return false;
George Karpenkov10ab2ac2017-08-21 23:25:50449
450 ExecuteCallback(Data, Size);
451
452 UniqFeatureSetTmp.clear();
453 size_t FoundUniqFeaturesOfII = 0;
454 size_t NumUpdatesBefore = Corpus.NumFeatureUpdates();
455 TPC.CollectFeatures([&](size_t 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,
Kostya Serebryany6b87e0c2018-07-19 01:23:32470 TPC.ObservedFocusFunction(), UniqFeatureSetTmp, DFT, II);
George Karpenkov10ab2ac2017-08-21 23:25:50471 return true;
472 }
473 if (II && FoundUniqFeaturesOfII &&
Kostya Serebryany67af9922018-06-07 01:40:20474 II->DataFlowTraceForFocusFunction.empty() &&
George Karpenkov10ab2ac2017-08-21 23:25:50475 FoundUniqFeaturesOfII == II->UniqFeatureSet.size() &&
476 II->U.size() > Size) {
477 Corpus.Replace(II, {Data, Data + Size});
478 return true;
479 }
480 return false;
481}
482
483size_t Fuzzer::GetCurrentUnitInFuzzingThead(const uint8_t **Data) const {
484 assert(InFuzzingThread());
485 *Data = CurrentUnitData;
486 return CurrentUnitSize;
487}
488
489void Fuzzer::CrashOnOverwrittenData() {
490 Printf("==%d== ERROR: libFuzzer: fuzz target overwrites it's const input\n",
491 GetPid());
492 DumpCurrentUnit("crash-");
493 Printf("SUMMARY: libFuzzer: out-of-memory\n");
494 _Exit(Options.ErrorExitCode); // Stop right now.
495}
496
497// Compare two arrays, but not all bytes if the arrays are large.
498static bool LooseMemeq(const uint8_t *A, const uint8_t *B, size_t Size) {
499 const size_t Limit = 64;
500 if (Size <= 64)
501 return !memcmp(A, B, Size);
502 // Compare first and last Limit/2 bytes.
503 return !memcmp(A, B, Limit / 2) &&
504 !memcmp(A + Size - Limit / 2, B + Size - Limit / 2, Limit / 2);
505}
506
507void Fuzzer::ExecuteCallback(const uint8_t *Data, size_t Size) {
508 TPC.RecordInitialStack();
509 TotalNumberOfRuns++;
510 assert(InFuzzingThread());
George Karpenkov10ab2ac2017-08-21 23:25:50511 // We copy the contents of Unit into a separate heap buffer
512 // so that we reliably find buffer overflows in it.
513 uint8_t *DataCopy = new uint8_t[Size];
514 memcpy(DataCopy, Data, Size);
Matt Morehousea34c65e2018-07-09 23:51:08515 if (EF->__msan_unpoison)
516 EF->__msan_unpoison(DataCopy, Size);
George Karpenkov10ab2ac2017-08-21 23:25:50517 if (CurrentUnitData && CurrentUnitData != Data)
518 memcpy(CurrentUnitData, Data, Size);
519 CurrentUnitSize = Size;
Matt Morehousea34c65e2018-07-09 23:51:08520 {
521 ScopedEnableMsanInterceptorChecks S;
522 AllocTracer.Start(Options.TraceMalloc);
523 UnitStartTime = system_clock::now();
524 TPC.ResetMaps();
Matt Morehouse43a22962018-07-17 16:12:00525 RunningUserCallback = true;
Matt Morehousea34c65e2018-07-09 23:51:08526 int Res = CB(DataCopy, Size);
Matt Morehouse43a22962018-07-17 16:12:00527 RunningUserCallback = false;
Matt Morehousea34c65e2018-07-09 23:51:08528 UnitStopTime = system_clock::now();
529 (void)Res;
530 assert(Res == 0);
531 HasMoreMallocsThanFrees = AllocTracer.Stop();
532 }
George Karpenkov10ab2ac2017-08-21 23:25:50533 if (!LooseMemeq(DataCopy, Data, Size))
534 CrashOnOverwrittenData();
535 CurrentUnitSize = 0;
536 delete[] DataCopy;
537}
538
539void Fuzzer::WriteToOutputCorpus(const Unit &U) {
540 if (Options.OnlyASCII)
541 assert(IsASCII(U));
542 if (Options.OutputCorpus.empty())
543 return;
544 std::string Path = DirPlusFile(Options.OutputCorpus, Hash(U));
545 WriteToFile(U, Path);
546 if (Options.Verbosity >= 2)
547 Printf("Written %zd bytes to %s\n", U.size(), Path.c_str());
548}
549
550void Fuzzer::WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix) {
551 if (!Options.SaveArtifacts)
552 return;
553 std::string Path = Options.ArtifactPrefix + Prefix + Hash(U);
554 if (!Options.ExactArtifactPath.empty())
555 Path = Options.ExactArtifactPath; // Overrides ArtifactPrefix.
556 WriteToFile(U, Path);
557 Printf("artifact_prefix='%s'; Test unit written to %s\n",
558 Options.ArtifactPrefix.c_str(), Path.c_str());
559 if (U.size() <= kMaxUnitSizeToPrint)
560 Printf("Base64: %s\n", Base64(U).c_str());
561}
562
563void Fuzzer::PrintStatusForNewUnit(const Unit &U, const char *Text) {
564 if (!Options.PrintNEW)
565 return;
566 PrintStats(Text, "");
567 if (Options.Verbosity) {
568 Printf(" L: %zd/%zd ", U.size(), Corpus.MaxInputSize());
569 MD.PrintMutationSequence();
570 Printf("\n");
571 }
572}
573
574void Fuzzer::ReportNewCoverage(InputInfo *II, const Unit &U) {
575 II->NumSuccessfullMutations++;
576 MD.RecordSuccessfulMutationSequence();
Alex Shlyapnikov5ded0702017-10-23 23:24:33577 PrintStatusForNewUnit(U, II->Reduced ? "REDUCE" : "NEW ");
George Karpenkov10ab2ac2017-08-21 23:25:50578 WriteToOutputCorpus(U);
579 NumberOfNewUnitsAdded++;
Alex Shlyapnikov5ded0702017-10-23 23:24:33580 CheckExitOnSrcPosOrItem(); // Check only after the unit is saved to corpus.
George Karpenkov10ab2ac2017-08-21 23:25:50581 LastCorpusUpdateRun = TotalNumberOfRuns;
George Karpenkov10ab2ac2017-08-21 23:25:50582}
583
584// Tries detecting a memory leak on the particular input that we have just
585// executed before calling this function.
586void Fuzzer::TryDetectingAMemoryLeak(const uint8_t *Data, size_t Size,
587 bool DuringInitialCorpusExecution) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33588 if (!HasMoreMallocsThanFrees)
589 return; // mallocs==frees, a leak is unlikely.
590 if (!Options.DetectLeaks)
591 return;
Max Moroz3f26dac2017-09-12 02:01:54592 if (!DuringInitialCorpusExecution &&
Alex Shlyapnikov5ded0702017-10-23 23:24:33593 TotalNumberOfRuns >= Options.MaxNumberOfRuns)
594 return;
George Karpenkov10ab2ac2017-08-21 23:25:50595 if (!&(EF->__lsan_enable) || !&(EF->__lsan_disable) ||
596 !(EF->__lsan_do_recoverable_leak_check))
Alex Shlyapnikov5ded0702017-10-23 23:24:33597 return; // No lsan.
George Karpenkov10ab2ac2017-08-21 23:25:50598 // Run the target once again, but with lsan disabled so that if there is
599 // a real leak we do not report it twice.
600 EF->__lsan_disable();
601 ExecuteCallback(Data, Size);
602 EF->__lsan_enable();
Alex Shlyapnikov5ded0702017-10-23 23:24:33603 if (!HasMoreMallocsThanFrees)
604 return; // a leak is unlikely.
George Karpenkov10ab2ac2017-08-21 23:25:50605 if (NumberOfLeakDetectionAttempts++ > 1000) {
606 Options.DetectLeaks = false;
607 Printf("INFO: libFuzzer disabled leak detection after every mutation.\n"
608 " Most likely the target function accumulates allocated\n"
609 " memory in a global state w/o actually leaking it.\n"
610 " You may try running this binary with -trace_malloc=[12]"
611 " to get a trace of mallocs and frees.\n"
612 " If LeakSanitizer is enabled in this process it will still\n"
613 " run on the process shutdown.\n");
614 return;
615 }
616 // Now perform the actual lsan pass. This is expensive and we must ensure
617 // we don't call it too often.
618 if (EF->__lsan_do_recoverable_leak_check()) { // Leak is found, report it.
619 if (DuringInitialCorpusExecution)
620 Printf("\nINFO: a leak has been found in the initial corpus.\n\n");
621 Printf("INFO: to ignore leaks on libFuzzer side use -detect_leaks=0.\n\n");
622 CurrentUnitSize = Size;
623 DumpCurrentUnit("leak-");
624 PrintFinalStats();
Alex Shlyapnikov5ded0702017-10-23 23:24:33625 _Exit(Options.ErrorExitCode); // not exit() to disable lsan further on.
George Karpenkov10ab2ac2017-08-21 23:25:50626 }
627}
628
629void Fuzzer::MutateAndTestOne() {
630 MD.StartMutationSequence();
631
632 auto &II = Corpus.ChooseUnitToMutate(MD.GetRand());
Kostya Serebryany0719b352019-02-08 01:20:54633 if (Options.DoCrossOver)
634 MD.SetCrossOverWith(&Corpus.ChooseUnitToMutate(MD.GetRand()).U);
George Karpenkov10ab2ac2017-08-21 23:25:50635 const auto &U = II.U;
636 memcpy(BaseSha1, II.Sha1, sizeof(BaseSha1));
637 assert(CurrentUnitData);
638 size_t Size = U.size();
639 assert(Size <= MaxInputLen && "Oversized Unit");
640 memcpy(CurrentUnitData, U.data(), Size);
641
642 assert(MaxMutationLen > 0);
643
644 size_t CurrentMaxMutationLen =
645 Min(MaxMutationLen, Max(U.size(), TmpMaxMutationLen));
646 assert(CurrentMaxMutationLen > 0);
647
648 for (int i = 0; i < Options.MutateDepth; i++) {
649 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
650 break;
Kostya Serebryanya2ca2dc2017-11-09 20:30:19651 MaybeExitGracefully();
George Karpenkov10ab2ac2017-08-21 23:25:50652 size_t NewSize = 0;
Kostya Serebryany6b87e0c2018-07-19 01:23:32653 if (II.HasFocusFunction && !II.DataFlowTraceForFocusFunction.empty() &&
654 Size <= CurrentMaxMutationLen)
655 NewSize = MD.MutateWithMask(CurrentUnitData, Size, Size,
656 II.DataFlowTraceForFocusFunction);
657 else
658 NewSize = MD.Mutate(CurrentUnitData, Size, CurrentMaxMutationLen);
George Karpenkov10ab2ac2017-08-21 23:25:50659 assert(NewSize > 0 && "Mutator returned empty unit");
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30660 assert(NewSize <= CurrentMaxMutationLen && "Mutator return oversized unit");
George Karpenkov10ab2ac2017-08-21 23:25:50661 Size = NewSize;
662 II.NumExecutedMutations++;
George Karpenkov10ab2ac2017-08-21 23:25:50663
Kostya Serebryanyad05ee02017-12-01 19:18:38664 bool FoundUniqFeatures = false;
665 bool NewCov = RunOne(CurrentUnitData, Size, /*MayDeleteFile=*/true, &II,
666 &FoundUniqFeatures);
George Karpenkov10ab2ac2017-08-21 23:25:50667 TryDetectingAMemoryLeak(CurrentUnitData, Size,
668 /*DuringInitialCorpusExecution*/ false);
Kostya Serebryanyad05ee02017-12-01 19:18:38669 if (NewCov) {
Matt Morehouse947838c2017-11-09 20:44:08670 ReportNewCoverage(&II, {CurrentUnitData, CurrentUnitData + Size});
Kostya Serebryanyad05ee02017-12-01 19:18:38671 break; // We will mutate this input more in the next rounds.
672 }
673 if (Options.ReduceDepth && !FoundUniqFeatures)
Max Moroz1d369a52018-07-16 15:15:34674 break;
George Karpenkov10ab2ac2017-08-21 23:25:50675 }
676}
677
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30678void Fuzzer::PurgeAllocator() {
Alex Shlyapnikov5ded0702017-10-23 23:24:33679 if (Options.PurgeAllocatorIntervalSec < 0 || !EF->__sanitizer_purge_allocator)
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30680 return;
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30681 if (duration_cast<seconds>(system_clock::now() -
Alex Shlyapnikov5ded0702017-10-23 23:24:33682 LastAllocatorPurgeAttemptTime)
683 .count() < Options.PurgeAllocatorIntervalSec)
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30684 return;
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30685
686 if (Options.RssLimitMb <= 0 ||
Alex Shlyapnikov5ded0702017-10-23 23:24:33687 GetPeakRSSMb() > static_cast<size_t>(Options.RssLimitMb) / 2)
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30688 EF->__sanitizer_purge_allocator();
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30689
690 LastAllocatorPurgeAttemptTime = system_clock::now();
691}
692
Kostya Serebryany0719b352019-02-08 01:20:54693void Fuzzer::ReadAndExecuteSeedCorpora(
694 const Vector<std::string> &CorpusDirs,
695 const Vector<std::string> &ExtraSeedFiles) {
Kostya Serebryany3a8e3c82017-08-29 02:05:01696 const size_t kMaxSaneLen = 1 << 20;
697 const size_t kMinDefaultLen = 4096;
Kostya Serebryany4faeb872017-08-29 20:51:24698 Vector<SizedFile> SizedFiles;
699 size_t MaxSize = 0;
700 size_t MinSize = -1;
701 size_t TotalSize = 0;
Kostya Serebryany93679be2017-09-12 21:58:07702 size_t LastNumFiles = 0;
Kostya Serebryany4faeb872017-08-29 20:51:24703 for (auto &Dir : CorpusDirs) {
Kostya Serebryany93679be2017-09-12 21:58:07704 GetSizedFilesFromDir(Dir, &SizedFiles);
705 Printf("INFO: % 8zd files found in %s\n", SizedFiles.size() - LastNumFiles,
706 Dir.c_str());
707 LastNumFiles = SizedFiles.size();
708 }
Kostya Serebryany0719b352019-02-08 01:20:54709 // Add files from -seed_inputs.
710 for (auto &File : ExtraSeedFiles)
711 if (auto Size = FileSize(File))
712 SizedFiles.push_back({File, Size});
713
Kostya Serebryany93679be2017-09-12 21:58:07714 for (auto &File : SizedFiles) {
715 MaxSize = Max(File.Size, MaxSize);
716 MinSize = Min(File.Size, MinSize);
717 TotalSize += File.Size;
Kostya Serebryany3a8e3c82017-08-29 02:05:01718 }
Kostya Serebryany4faeb872017-08-29 20:51:24719 if (Options.MaxLen == 0)
720 SetMaxInputLen(std::min(std::max(kMinDefaultLen, MaxSize), kMaxSaneLen));
721 assert(MaxInputLen > 0);
722
Kostya Serebryany51823d32017-10-13 01:12:23723 // Test the callback with empty input and never try it again.
724 uint8_t dummy = 0;
725 ExecuteCallback(&dummy, 0);
726
Kostya Serebryany23482e12019-01-31 01:40:14727 // Protect lazy counters here, after the once-init code has been executed.
728 if (Options.LazyCounters)
729 TPC.ProtectLazyCounters();
730
Kostya Serebryany4faeb872017-08-29 20:51:24731 if (SizedFiles.empty()) {
732 Printf("INFO: A corpus is not provided, starting from an empty corpus\n");
733 Unit U({'\n'}); // Valid ASCII input.
734 RunOne(U.data(), U.size());
735 } else {
736 Printf("INFO: seed corpus: files: %zd min: %zdb max: %zdb total: %zdb"
737 " rss: %zdMb\n",
738 SizedFiles.size(), MinSize, MaxSize, TotalSize, GetPeakRSSMb());
739 if (Options.ShuffleAtStartUp)
740 std::shuffle(SizedFiles.begin(), SizedFiles.end(), MD.GetRand());
741
Kostya Serebryany93679be2017-09-12 21:58:07742 if (Options.PreferSmall) {
743 std::stable_sort(SizedFiles.begin(), SizedFiles.end());
744 assert(SizedFiles.front().Size <= SizedFiles.back().Size);
745 }
Kostya Serebryany4faeb872017-08-29 20:51:24746
747 // Load and execute inputs one by one.
748 for (auto &SF : SizedFiles) {
Kostya Serebryany082e9a72017-08-31 19:17:15749 auto U = FileToVector(SF.File, MaxInputLen, /*ExitOnError=*/false);
Kostya Serebryany4faeb872017-08-29 20:51:24750 assert(U.size() <= MaxInputLen);
751 RunOne(U.data(), U.size());
752 CheckExitOnSrcPosOrItem();
753 TryDetectingAMemoryLeak(U.data(), U.size(),
754 /*DuringInitialCorpusExecution*/ true);
755 }
Kostya Serebryany3a8e3c82017-08-29 02:05:01756 }
757
Kostya Serebryany4faeb872017-08-29 20:51:24758 PrintStats("INITED");
Kostya Serebryanye9c6f062018-05-16 23:26:37759 if (!Options.FocusFunction.empty())
760 Printf("INFO: %zd/%zd inputs touch the focus function\n",
761 Corpus.NumInputsThatTouchFocusFunction(), Corpus.size());
Kostya Serebryany67af9922018-06-07 01:40:20762 if (!Options.DataFlowTrace.empty())
763 Printf("INFO: %zd/%zd inputs have the Data Flow Trace\n",
764 Corpus.NumInputsWithDataFlowTrace(), Corpus.size());
Kostya Serebryanye9c6f062018-05-16 23:26:37765
Max Morozfe974412018-05-23 19:42:30766 if (Corpus.empty() && Options.MaxNumberOfRuns) {
Kostya Serebryany4faeb872017-08-29 20:51:24767 Printf("ERROR: no interesting inputs were found. "
768 "Is the code instrumented for coverage? Exiting.\n");
769 exit(1);
Kostya Serebryany3a8e3c82017-08-29 02:05:01770 }
Kostya Serebryany3a8e3c82017-08-29 02:05:01771}
772
Kostya Serebryany0719b352019-02-08 01:20:54773void Fuzzer::Loop(const Vector<std::string> &CorpusDirs,
774 const Vector<std::string> &ExtraSeedFiles) {
775 ReadAndExecuteSeedCorpora(CorpusDirs, ExtraSeedFiles);
Kostya Serebryany67af9922018-06-07 01:40:20776 DFT.Clear(); // No need for DFT any more.
George Karpenkov10ab2ac2017-08-21 23:25:50777 TPC.SetPrintNewPCs(Options.PrintNewCovPcs);
Kostya Serebryany2eef8162017-08-25 20:09:25778 TPC.SetPrintNewFuncs(Options.PrintNewCovFuncs);
George Karpenkov10ab2ac2017-08-21 23:25:50779 system_clock::time_point LastCorpusReload = system_clock::now();
George Karpenkov10ab2ac2017-08-21 23:25:50780 while (true) {
781 auto Now = system_clock::now();
782 if (duration_cast<seconds>(Now - LastCorpusReload).count() >=
783 Options.ReloadIntervalSec) {
784 RereadOutputCorpus(MaxInputLen);
785 LastCorpusReload = system_clock::now();
786 }
787 if (TotalNumberOfRuns >= Options.MaxNumberOfRuns)
788 break;
Alex Shlyapnikov5ded0702017-10-23 23:24:33789 if (TimedOut())
790 break;
George Karpenkov10ab2ac2017-08-21 23:25:50791
792 // Update TmpMaxMutationLen
Matt Morehouse36c89b32018-02-13 20:52:15793 if (Options.LenControl) {
George Karpenkov10ab2ac2017-08-21 23:25:50794 if (TmpMaxMutationLen < MaxMutationLen &&
Kostya Serebryanye9ed2322017-12-12 23:11:28795 TotalNumberOfRuns - LastCorpusUpdateRun >
Matt Morehouse36c89b32018-02-13 20:52:15796 Options.LenControl * Log(TmpMaxMutationLen)) {
George Karpenkov10ab2ac2017-08-21 23:25:50797 TmpMaxMutationLen =
Kostya Serebryanye9ed2322017-12-12 23:11:28798 Min(MaxMutationLen, TmpMaxMutationLen + Log(TmpMaxMutationLen));
Kostya Serebryanye9ed2322017-12-12 23:11:28799 LastCorpusUpdateRun = TotalNumberOfRuns;
George Karpenkov10ab2ac2017-08-21 23:25:50800 }
801 } else {
802 TmpMaxMutationLen = MaxMutationLen;
803 }
804
805 // Perform several mutations and runs.
806 MutateAndTestOne();
Alex Shlyapnikov6f1c26f2017-10-23 22:04:30807
808 PurgeAllocator();
George Karpenkov10ab2ac2017-08-21 23:25:50809 }
810
811 PrintStats("DONE ", "\n");
812 MD.PrintRecommendedDictionary();
813}
814
815void Fuzzer::MinimizeCrashLoop(const Unit &U) {
Alex Shlyapnikov5ded0702017-10-23 23:24:33816 if (U.size() <= 1)
817 return;
George Karpenkov10ab2ac2017-08-21 23:25:50818 while (!TimedOut() && TotalNumberOfRuns < Options.MaxNumberOfRuns) {
819 MD.StartMutationSequence();
820 memcpy(CurrentUnitData, U.data(), U.size());
821 for (int i = 0; i < Options.MutateDepth; i++) {
822 size_t NewSize = MD.Mutate(CurrentUnitData, U.size(), MaxMutationLen);
823 assert(NewSize > 0 && NewSize <= MaxMutationLen);
824 ExecuteCallback(CurrentUnitData, NewSize);
825 PrintPulseAndReportSlowInput(CurrentUnitData, NewSize);
826 TryDetectingAMemoryLeak(CurrentUnitData, NewSize,
827 /*DuringInitialCorpusExecution*/ false);
828 }
829 }
830}
831
George Karpenkov10ab2ac2017-08-21 23:25:50832} // namespace fuzzer
833
834extern "C" {
835
Jonathan Metzmanb795c312019-01-17 16:36:05836ATTRIBUTE_INTERFACE size_t
Petr Hosekeac2b472018-01-17 20:39:14837LLVMFuzzerMutate(uint8_t *Data, size_t Size, size_t MaxSize) {
George Karpenkov10ab2ac2017-08-21 23:25:50838 assert(fuzzer::F);
839 return fuzzer::F->GetMD().DefaultMutate(Data, Size, MaxSize);
840}
841
Alex Shlyapnikov5ded0702017-10-23 23:24:33842} // extern "C"