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