1 //===- FuzzerDriver.cpp - FuzzerDriver function and flags -----------------===// 2 // 3 // 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 6 // 7 //===----------------------------------------------------------------------===// 8 // FuzzerDriver and flag parsing. 9 //===----------------------------------------------------------------------===// 10 11 #include "FuzzerCommand.h" 12 #include "FuzzerCorpus.h" 13 #include "FuzzerFork.h" 14 #include "FuzzerIO.h" 15 #include "FuzzerInterface.h" 16 #include "FuzzerInternal.h" 17 #include "FuzzerMerge.h" 18 #include "FuzzerMutate.h" 19 #include "FuzzerPlatform.h" 20 #include "FuzzerRandom.h" 21 #include "FuzzerTracePC.h" 22 #include <algorithm> 23 #include <atomic> 24 #include <chrono> 25 #include <cstdlib> 26 #include <cstring> 27 #include <mutex> 28 #include <string> 29 #include <thread> 30 #include <fstream> 31 32 // This function should be present in the libFuzzer so that the client 33 // binary can test for its existence. 34 #if LIBFUZZER_MSVC 35 extern "C" void __libfuzzer_is_present() {} 36 #if defined(_M_IX86) || defined(__i386__) 37 #pragma comment(linker, "/include:___libfuzzer_is_present") 38 #else 39 #pragma comment(linker, "/include:__libfuzzer_is_present") 40 #endif 41 #else 42 extern "C" __attribute__((used)) void __libfuzzer_is_present() {} 43 #endif // LIBFUZZER_MSVC 44 45 namespace fuzzer { 46 47 // Program arguments. 48 struct FlagDescription { 49 const char *Name; 50 const char *Description; 51 int Default; 52 int *IntFlag; 53 const char **StrFlag; 54 unsigned int *UIntFlag; 55 }; 56 57 struct { 58 #define FUZZER_DEPRECATED_FLAG(Name) 59 #define FUZZER_FLAG_INT(Name, Default, Description) int Name; 60 #define FUZZER_FLAG_UNSIGNED(Name, Default, Description) unsigned int Name; 61 #define FUZZER_FLAG_STRING(Name, Description) const char *Name; 62 #include "FuzzerFlags.def" 63 #undef FUZZER_DEPRECATED_FLAG 64 #undef FUZZER_FLAG_INT 65 #undef FUZZER_FLAG_UNSIGNED 66 #undef FUZZER_FLAG_STRING 67 } Flags; 68 69 static const FlagDescription FlagDescriptions [] { 70 #define FUZZER_DEPRECATED_FLAG(Name) \ 71 {#Name, "Deprecated; don't use", 0, nullptr, nullptr, nullptr}, 72 #define FUZZER_FLAG_INT(Name, Default, Description) \ 73 {#Name, Description, Default, &Flags.Name, nullptr, nullptr}, 74 #define FUZZER_FLAG_UNSIGNED(Name, Default, Description) \ 75 {#Name, Description, static_cast<int>(Default), \ 76 nullptr, nullptr, &Flags.Name}, 77 #define FUZZER_FLAG_STRING(Name, Description) \ 78 {#Name, Description, 0, nullptr, &Flags.Name, nullptr}, 79 #include "FuzzerFlags.def" 80 #undef FUZZER_DEPRECATED_FLAG 81 #undef FUZZER_FLAG_INT 82 #undef FUZZER_FLAG_UNSIGNED 83 #undef FUZZER_FLAG_STRING 84 }; 85 86 static const size_t kNumFlags = 87 sizeof(FlagDescriptions) / sizeof(FlagDescriptions[0]); 88 89 static Vector<std::string> *Inputs; 90 static std::string *ProgName; 91 92 static void PrintHelp() { 93 Printf("Usage:\n"); 94 auto Prog = ProgName->c_str(); 95 Printf("\nTo run fuzzing pass 0 or more directories.\n"); 96 Printf("%s [-flag1=val1 [-flag2=val2 ...] ] [dir1 [dir2 ...] ]\n", Prog); 97 98 Printf("\nTo run individual tests without fuzzing pass 1 or more files:\n"); 99 Printf("%s [-flag1=val1 [-flag2=val2 ...] ] file1 [file2 ...]\n", Prog); 100 101 Printf("\nFlags: (strictly in form -flag=value)\n"); 102 size_t MaxFlagLen = 0; 103 for (size_t F = 0; F < kNumFlags; F++) 104 MaxFlagLen = std::max(strlen(FlagDescriptions[F].Name), MaxFlagLen); 105 106 for (size_t F = 0; F < kNumFlags; F++) { 107 const auto &D = FlagDescriptions[F]; 108 if (strstr(D.Description, "internal flag") == D.Description) continue; 109 Printf(" %s", D.Name); 110 for (size_t i = 0, n = MaxFlagLen - strlen(D.Name); i < n; i++) 111 Printf(" "); 112 Printf("\t"); 113 Printf("%d\t%s\n", D.Default, D.Description); 114 } 115 Printf("\nFlags starting with '--' will be ignored and " 116 "will be passed verbatim to subprocesses.\n"); 117 } 118 119 static const char *FlagValue(const char *Param, const char *Name) { 120 size_t Len = strlen(Name); 121 if (Param[0] == '-' && strstr(Param + 1, Name) == Param + 1 && 122 Param[Len + 1] == '=') 123 return &Param[Len + 2]; 124 return nullptr; 125 } 126 127 // Avoid calling stol as it triggers a bug in clang/glibc build. 128 static long MyStol(const char *Str) { 129 long Res = 0; 130 long Sign = 1; 131 if (*Str == '-') { 132 Str++; 133 Sign = -1; 134 } 135 for (size_t i = 0; Str[i]; i++) { 136 char Ch = Str[i]; 137 if (Ch < '0' || Ch > '9') 138 return Res; 139 Res = Res * 10 + (Ch - '0'); 140 } 141 return Res * Sign; 142 } 143 144 static bool ParseOneFlag(const char *Param) { 145 if (Param[0] != '-') return false; 146 if (Param[1] == '-') { 147 static bool PrintedWarning = false; 148 if (!PrintedWarning) { 149 PrintedWarning = true; 150 Printf("INFO: libFuzzer ignores flags that start with '--'\n"); 151 } 152 for (size_t F = 0; F < kNumFlags; F++) 153 if (FlagValue(Param + 1, FlagDescriptions[F].Name)) 154 Printf("WARNING: did you mean '%s' (single dash)?\n", Param + 1); 155 return true; 156 } 157 for (size_t F = 0; F < kNumFlags; F++) { 158 const char *Name = FlagDescriptions[F].Name; 159 const char *Str = FlagValue(Param, Name); 160 if (Str) { 161 if (FlagDescriptions[F].IntFlag) { 162 int Val = MyStol(Str); 163 *FlagDescriptions[F].IntFlag = Val; 164 if (Flags.verbosity >= 2) 165 Printf("Flag: %s %d\n", Name, Val); 166 return true; 167 } else if (FlagDescriptions[F].UIntFlag) { 168 unsigned int Val = std::stoul(Str); 169 *FlagDescriptions[F].UIntFlag = Val; 170 if (Flags.verbosity >= 2) 171 Printf("Flag: %s %u\n", Name, Val); 172 return true; 173 } else if (FlagDescriptions[F].StrFlag) { 174 *FlagDescriptions[F].StrFlag = Str; 175 if (Flags.verbosity >= 2) 176 Printf("Flag: %s %s\n", Name, Str); 177 return true; 178 } else { // Deprecated flag. 179 Printf("Flag: %s: deprecated, don't use\n", Name); 180 return true; 181 } 182 } 183 } 184 Printf("\n\nWARNING: unrecognized flag '%s'; " 185 "use -help=1 to list all flags\n\n", Param); 186 return true; 187 } 188 189 // We don't use any library to minimize dependencies. 190 static void ParseFlags(const Vector<std::string> &Args, 191 const ExternalFunctions *EF) { 192 for (size_t F = 0; F < kNumFlags; F++) { 193 if (FlagDescriptions[F].IntFlag) 194 *FlagDescriptions[F].IntFlag = FlagDescriptions[F].Default; 195 if (FlagDescriptions[F].UIntFlag) 196 *FlagDescriptions[F].UIntFlag = 197 static_cast<unsigned int>(FlagDescriptions[F].Default); 198 if (FlagDescriptions[F].StrFlag) 199 *FlagDescriptions[F].StrFlag = nullptr; 200 } 201 202 // Disable len_control by default, if LLVMFuzzerCustomMutator is used. 203 if (EF->LLVMFuzzerCustomMutator) { 204 Flags.len_control = 0; 205 Printf("INFO: found LLVMFuzzerCustomMutator (%p). " 206 "Disabling -len_control by default.\n", EF->LLVMFuzzerCustomMutator); 207 } 208 209 Inputs = new Vector<std::string>; 210 for (size_t A = 1; A < Args.size(); A++) { 211 if (ParseOneFlag(Args[A].c_str())) { 212 if (Flags.ignore_remaining_args) 213 break; 214 continue; 215 } 216 Inputs->push_back(Args[A]); 217 } 218 } 219 220 static std::mutex Mu; 221 222 static void PulseThread() { 223 while (true) { 224 SleepSeconds(600); 225 std::lock_guard<std::mutex> Lock(Mu); 226 Printf("pulse...\n"); 227 } 228 } 229 230 static void WorkerThread(const Command &BaseCmd, std::atomic<unsigned> *Counter, 231 unsigned NumJobs, std::atomic<bool> *HasErrors) { 232 while (true) { 233 unsigned C = (*Counter)++; 234 if (C >= NumJobs) break; 235 std::string Log = "fuzz-" + std::to_string(C) + ".log"; 236 Command Cmd(BaseCmd); 237 Cmd.setOutputFile(Log); 238 Cmd.combineOutAndErr(); 239 if (Flags.verbosity) { 240 std::string CommandLine = Cmd.toString(); 241 Printf("%s\n", CommandLine.c_str()); 242 } 243 int ExitCode = ExecuteCommand(Cmd); 244 if (ExitCode != 0) 245 *HasErrors = true; 246 std::lock_guard<std::mutex> Lock(Mu); 247 Printf("================== Job %u exited with exit code %d ============\n", 248 C, ExitCode); 249 fuzzer::CopyFileToErr(Log); 250 } 251 } 252 253 static void ValidateDirectoryExists(const std::string &Path, 254 bool CreateDirectory) { 255 if (Path.empty()) { 256 Printf("ERROR: Provided directory path is an empty string\n"); 257 exit(1); 258 } 259 260 if (IsDirectory(Path)) 261 return; 262 263 if (CreateDirectory) { 264 if (!MkDirRecursive(Path)) { 265 Printf("ERROR: Failed to create directory \"%s\"\n", Path.c_str()); 266 exit(1); 267 } 268 return; 269 } 270 271 Printf("ERROR: The required directory \"%s\" does not exist\n", Path.c_str()); 272 exit(1); 273 } 274 275 std::string CloneArgsWithoutX(const Vector<std::string> &Args, 276 const char *X1, const char *X2) { 277 std::string Cmd; 278 for (auto &S : Args) { 279 if (FlagValue(S.c_str(), X1) || FlagValue(S.c_str(), X2)) 280 continue; 281 Cmd += S + " "; 282 } 283 return Cmd; 284 } 285 286 static int RunInMultipleProcesses(const Vector<std::string> &Args, 287 unsigned NumWorkers, unsigned NumJobs) { 288 std::atomic<unsigned> Counter(0); 289 std::atomic<bool> HasErrors(false); 290 Command Cmd(Args); 291 Cmd.removeFlag("jobs"); 292 Cmd.removeFlag("workers"); 293 Vector<std::thread> V; 294 std::thread Pulse(PulseThread); 295 Pulse.detach(); 296 for (unsigned i = 0; i < NumWorkers; i++) 297 V.push_back(std::thread(WorkerThread, std::ref(Cmd), &Counter, NumJobs, &HasErrors)); 298 for (auto &T : V) 299 T.join(); 300 return HasErrors ? 1 : 0; 301 } 302 303 static void RssThread(Fuzzer *F, size_t RssLimitMb) { 304 while (true) { 305 SleepSeconds(1); 306 size_t Peak = GetPeakRSSMb(); 307 if (Peak > RssLimitMb) 308 F->RssLimitCallback(); 309 } 310 } 311 312 static void StartRssThread(Fuzzer *F, size_t RssLimitMb) { 313 if (!RssLimitMb) 314 return; 315 std::thread T(RssThread, F, RssLimitMb); 316 T.detach(); 317 } 318 319 int RunOneTest(Fuzzer *F, const char *InputFilePath, size_t MaxLen) { 320 Unit U = FileToVector(InputFilePath); 321 if (MaxLen && MaxLen < U.size()) 322 U.resize(MaxLen); 323 F->ExecuteCallback(U.data(), U.size()); 324 F->TryDetectingAMemoryLeak(U.data(), U.size(), true); 325 return 0; 326 } 327 328 static bool AllInputsAreFiles() { 329 if (Inputs->empty()) return false; 330 for (auto &Path : *Inputs) 331 if (!IsFile(Path)) 332 return false; 333 return true; 334 } 335 336 static std::string GetDedupTokenFromCmdOutput(const std::string &S) { 337 auto Beg = S.find("DEDUP_TOKEN:"); 338 if (Beg == std::string::npos) 339 return ""; 340 auto End = S.find('\n', Beg); 341 if (End == std::string::npos) 342 return ""; 343 return S.substr(Beg, End - Beg); 344 } 345 346 int CleanseCrashInput(const Vector<std::string> &Args, 347 const FuzzingOptions &Options) { 348 if (Inputs->size() != 1 || !Flags.exact_artifact_path) { 349 Printf("ERROR: -cleanse_crash should be given one input file and" 350 " -exact_artifact_path\n"); 351 exit(1); 352 } 353 std::string InputFilePath = Inputs->at(0); 354 std::string OutputFilePath = Flags.exact_artifact_path; 355 Command Cmd(Args); 356 Cmd.removeFlag("cleanse_crash"); 357 358 assert(Cmd.hasArgument(InputFilePath)); 359 Cmd.removeArgument(InputFilePath); 360 361 auto TmpFilePath = TempPath("CleanseCrashInput", ".repro"); 362 Cmd.addArgument(TmpFilePath); 363 Cmd.setOutputFile(getDevNull()); 364 Cmd.combineOutAndErr(); 365 366 std::string CurrentFilePath = InputFilePath; 367 auto U = FileToVector(CurrentFilePath); 368 size_t Size = U.size(); 369 370 const Vector<uint8_t> ReplacementBytes = {' ', 0xff}; 371 for (int NumAttempts = 0; NumAttempts < 5; NumAttempts++) { 372 bool Changed = false; 373 for (size_t Idx = 0; Idx < Size; Idx++) { 374 Printf("CLEANSE[%d]: Trying to replace byte %zd of %zd\n", NumAttempts, 375 Idx, Size); 376 uint8_t OriginalByte = U[Idx]; 377 if (ReplacementBytes.end() != std::find(ReplacementBytes.begin(), 378 ReplacementBytes.end(), 379 OriginalByte)) 380 continue; 381 for (auto NewByte : ReplacementBytes) { 382 U[Idx] = NewByte; 383 WriteToFile(U, TmpFilePath); 384 auto ExitCode = ExecuteCommand(Cmd); 385 RemoveFile(TmpFilePath); 386 if (!ExitCode) { 387 U[Idx] = OriginalByte; 388 } else { 389 Changed = true; 390 Printf("CLEANSE: Replaced byte %zd with 0x%x\n", Idx, NewByte); 391 WriteToFile(U, OutputFilePath); 392 break; 393 } 394 } 395 } 396 if (!Changed) break; 397 } 398 return 0; 399 } 400 401 int MinimizeCrashInput(const Vector<std::string> &Args, 402 const FuzzingOptions &Options) { 403 if (Inputs->size() != 1) { 404 Printf("ERROR: -minimize_crash should be given one input file\n"); 405 exit(1); 406 } 407 std::string InputFilePath = Inputs->at(0); 408 Command BaseCmd(Args); 409 BaseCmd.removeFlag("minimize_crash"); 410 BaseCmd.removeFlag("exact_artifact_path"); 411 assert(BaseCmd.hasArgument(InputFilePath)); 412 BaseCmd.removeArgument(InputFilePath); 413 if (Flags.runs <= 0 && Flags.max_total_time == 0) { 414 Printf("INFO: you need to specify -runs=N or " 415 "-max_total_time=N with -minimize_crash=1\n" 416 "INFO: defaulting to -max_total_time=600\n"); 417 BaseCmd.addFlag("max_total_time", "600"); 418 } 419 420 BaseCmd.combineOutAndErr(); 421 422 std::string CurrentFilePath = InputFilePath; 423 while (true) { 424 Unit U = FileToVector(CurrentFilePath); 425 Printf("CRASH_MIN: minimizing crash input: '%s' (%zd bytes)\n", 426 CurrentFilePath.c_str(), U.size()); 427 428 Command Cmd(BaseCmd); 429 Cmd.addArgument(CurrentFilePath); 430 431 Printf("CRASH_MIN: executing: %s\n", Cmd.toString().c_str()); 432 std::string CmdOutput; 433 bool Success = ExecuteCommand(Cmd, &CmdOutput); 434 if (Success) { 435 Printf("ERROR: the input %s did not crash\n", CurrentFilePath.c_str()); 436 exit(1); 437 } 438 Printf("CRASH_MIN: '%s' (%zd bytes) caused a crash. Will try to minimize " 439 "it further\n", 440 CurrentFilePath.c_str(), U.size()); 441 auto DedupToken1 = GetDedupTokenFromCmdOutput(CmdOutput); 442 if (!DedupToken1.empty()) 443 Printf("CRASH_MIN: DedupToken1: %s\n", DedupToken1.c_str()); 444 445 std::string ArtifactPath = 446 Flags.exact_artifact_path 447 ? Flags.exact_artifact_path 448 : Options.ArtifactPrefix + "minimized-from-" + Hash(U); 449 Cmd.addFlag("minimize_crash_internal_step", "1"); 450 Cmd.addFlag("exact_artifact_path", ArtifactPath); 451 Printf("CRASH_MIN: executing: %s\n", Cmd.toString().c_str()); 452 CmdOutput.clear(); 453 Success = ExecuteCommand(Cmd, &CmdOutput); 454 Printf("%s", CmdOutput.c_str()); 455 if (Success) { 456 if (Flags.exact_artifact_path) { 457 CurrentFilePath = Flags.exact_artifact_path; 458 WriteToFile(U, CurrentFilePath); 459 } 460 Printf("CRASH_MIN: failed to minimize beyond %s (%d bytes), exiting\n", 461 CurrentFilePath.c_str(), U.size()); 462 break; 463 } 464 auto DedupToken2 = GetDedupTokenFromCmdOutput(CmdOutput); 465 if (!DedupToken2.empty()) 466 Printf("CRASH_MIN: DedupToken2: %s\n", DedupToken2.c_str()); 467 468 if (DedupToken1 != DedupToken2) { 469 if (Flags.exact_artifact_path) { 470 CurrentFilePath = Flags.exact_artifact_path; 471 WriteToFile(U, CurrentFilePath); 472 } 473 Printf("CRASH_MIN: mismatch in dedup tokens" 474 " (looks like a different bug). Won't minimize further\n"); 475 break; 476 } 477 478 CurrentFilePath = ArtifactPath; 479 Printf("*********************************\n"); 480 } 481 return 0; 482 } 483 484 int MinimizeCrashInputInternalStep(Fuzzer *F, InputCorpus *Corpus) { 485 assert(Inputs->size() == 1); 486 std::string InputFilePath = Inputs->at(0); 487 Unit U = FileToVector(InputFilePath); 488 Printf("INFO: Starting MinimizeCrashInputInternalStep: %zd\n", U.size()); 489 if (U.size() < 2) { 490 Printf("INFO: The input is small enough, exiting\n"); 491 exit(0); 492 } 493 F->SetMaxInputLen(U.size()); 494 F->SetMaxMutationLen(U.size() - 1); 495 F->MinimizeCrashLoop(U); 496 Printf("INFO: Done MinimizeCrashInputInternalStep, no crashes found\n"); 497 exit(0); 498 return 0; 499 } 500 501 void Merge(Fuzzer *F, FuzzingOptions &Options, const Vector<std::string> &Args, 502 const Vector<std::string> &Corpora, const char *CFPathOrNull) { 503 if (Corpora.size() < 2) { 504 Printf("INFO: Merge requires two or more corpus dirs\n"); 505 exit(0); 506 } 507 508 Vector<SizedFile> OldCorpus, NewCorpus; 509 GetSizedFilesFromDir(Corpora[0], &OldCorpus); 510 for (size_t i = 1; i < Corpora.size(); i++) 511 GetSizedFilesFromDir(Corpora[i], &NewCorpus); 512 std::sort(OldCorpus.begin(), OldCorpus.end()); 513 std::sort(NewCorpus.begin(), NewCorpus.end()); 514 515 std::string CFPath = CFPathOrNull ? CFPathOrNull : TempPath("Merge", ".txt"); 516 Vector<std::string> NewFiles; 517 Set<uint32_t> NewFeatures, NewCov; 518 CrashResistantMerge(Args, OldCorpus, NewCorpus, &NewFiles, {}, &NewFeatures, 519 {}, &NewCov, CFPath, true); 520 for (auto &Path : NewFiles) 521 F->WriteToOutputCorpus(FileToVector(Path, Options.MaxLen)); 522 // We are done, delete the control file if it was a temporary one. 523 if (!Flags.merge_control_file) 524 RemoveFile(CFPath); 525 526 exit(0); 527 } 528 529 int AnalyzeDictionary(Fuzzer *F, const Vector<Unit>& Dict, 530 UnitVector& Corpus) { 531 Printf("Started dictionary minimization (up to %d tests)\n", 532 Dict.size() * Corpus.size() * 2); 533 534 // Scores and usage count for each dictionary unit. 535 Vector<int> Scores(Dict.size()); 536 Vector<int> Usages(Dict.size()); 537 538 Vector<size_t> InitialFeatures; 539 Vector<size_t> ModifiedFeatures; 540 for (auto &C : Corpus) { 541 // Get coverage for the testcase without modifications. 542 F->ExecuteCallback(C.data(), C.size()); 543 InitialFeatures.clear(); 544 TPC.CollectFeatures([&](size_t Feature) { 545 InitialFeatures.push_back(Feature); 546 }); 547 548 for (size_t i = 0; i < Dict.size(); ++i) { 549 Vector<uint8_t> Data = C; 550 auto StartPos = std::search(Data.begin(), Data.end(), 551 Dict[i].begin(), Dict[i].end()); 552 // Skip dictionary unit, if the testcase does not contain it. 553 if (StartPos == Data.end()) 554 continue; 555 556 ++Usages[i]; 557 while (StartPos != Data.end()) { 558 // Replace all occurrences of dictionary unit in the testcase. 559 auto EndPos = StartPos + Dict[i].size(); 560 for (auto It = StartPos; It != EndPos; ++It) 561 *It ^= 0xFF; 562 563 StartPos = std::search(EndPos, Data.end(), 564 Dict[i].begin(), Dict[i].end()); 565 } 566 567 // Get coverage for testcase with masked occurrences of dictionary unit. 568 F->ExecuteCallback(Data.data(), Data.size()); 569 ModifiedFeatures.clear(); 570 TPC.CollectFeatures([&](size_t Feature) { 571 ModifiedFeatures.push_back(Feature); 572 }); 573 574 if (InitialFeatures == ModifiedFeatures) 575 --Scores[i]; 576 else 577 Scores[i] += 2; 578 } 579 } 580 581 Printf("###### Useless dictionary elements. ######\n"); 582 for (size_t i = 0; i < Dict.size(); ++i) { 583 // Dictionary units with positive score are treated as useful ones. 584 if (Scores[i] > 0) 585 continue; 586 587 Printf("\""); 588 PrintASCII(Dict[i].data(), Dict[i].size(), "\""); 589 Printf(" # Score: %d, Used: %d\n", Scores[i], Usages[i]); 590 } 591 Printf("###### End of useless dictionary elements. ######\n"); 592 return 0; 593 } 594 595 Vector<std::string> ParseSeedInuts(const char *seed_inputs) { 596 // Parse -seed_inputs=file1,file2,... or -seed_inputs=@seed_inputs_file 597 Vector<std::string> Files; 598 if (!seed_inputs) return Files; 599 std::string SeedInputs; 600 if (Flags.seed_inputs[0] == '@') 601 SeedInputs = FileToString(Flags.seed_inputs + 1); // File contains list. 602 else 603 SeedInputs = Flags.seed_inputs; // seed_inputs contains the list. 604 if (SeedInputs.empty()) { 605 Printf("seed_inputs is empty or @file does not exist.\n"); 606 exit(1); 607 } 608 // Parse SeedInputs. 609 size_t comma_pos = 0; 610 while ((comma_pos = SeedInputs.find_last_of(',')) != std::string::npos) { 611 Files.push_back(SeedInputs.substr(comma_pos + 1)); 612 SeedInputs = SeedInputs.substr(0, comma_pos); 613 } 614 Files.push_back(SeedInputs); 615 return Files; 616 } 617 618 static Vector<SizedFile> ReadCorpora(const Vector<std::string> &CorpusDirs, 619 const Vector<std::string> &ExtraSeedFiles) { 620 Vector<SizedFile> SizedFiles; 621 size_t LastNumFiles = 0; 622 for (auto &Dir : CorpusDirs) { 623 GetSizedFilesFromDir(Dir, &SizedFiles); 624 Printf("INFO: % 8zd files found in %s\n", SizedFiles.size() - LastNumFiles, 625 Dir.c_str()); 626 LastNumFiles = SizedFiles.size(); 627 } 628 for (auto &File : ExtraSeedFiles) 629 if (auto Size = FileSize(File)) 630 SizedFiles.push_back({File, Size}); 631 return SizedFiles; 632 } 633 634 int FuzzerDriver(int *argc, char ***argv, UserCallback Callback) { 635 using namespace fuzzer; 636 assert(argc && argv && "Argument pointers cannot be nullptr"); 637 std::string Argv0((*argv)[0]); 638 EF = new ExternalFunctions(); 639 if (EF->LLVMFuzzerInitialize) 640 EF->LLVMFuzzerInitialize(argc, argv); 641 if (EF->__msan_scoped_disable_interceptor_checks) 642 EF->__msan_scoped_disable_interceptor_checks(); 643 const Vector<std::string> Args(*argv, *argv + *argc); 644 assert(!Args.empty()); 645 ProgName = new std::string(Args[0]); 646 if (Argv0 != *ProgName) { 647 Printf("ERROR: argv[0] has been modified in LLVMFuzzerInitialize\n"); 648 exit(1); 649 } 650 ParseFlags(Args, EF); 651 if (Flags.help) { 652 PrintHelp(); 653 return 0; 654 } 655 656 if (Flags.close_fd_mask & 2) 657 DupAndCloseStderr(); 658 if (Flags.close_fd_mask & 1) 659 CloseStdout(); 660 661 if (Flags.jobs > 0 && Flags.workers == 0) { 662 Flags.workers = std::min(NumberOfCpuCores() / 2, Flags.jobs); 663 if (Flags.workers > 1) 664 Printf("Running %u workers\n", Flags.workers); 665 } 666 667 if (Flags.workers > 0 && Flags.jobs > 0) 668 return RunInMultipleProcesses(Args, Flags.workers, Flags.jobs); 669 670 FuzzingOptions Options; 671 Options.Verbosity = Flags.verbosity; 672 Options.MaxLen = Flags.max_len; 673 Options.LenControl = Flags.len_control; 674 Options.KeepSeed = Flags.keep_seed; 675 Options.UnitTimeoutSec = Flags.timeout; 676 Options.ErrorExitCode = Flags.error_exitcode; 677 Options.TimeoutExitCode = Flags.timeout_exitcode; 678 Options.IgnoreTimeouts = Flags.ignore_timeouts; 679 Options.IgnoreOOMs = Flags.ignore_ooms; 680 Options.IgnoreCrashes = Flags.ignore_crashes; 681 Options.MaxTotalTimeSec = Flags.max_total_time; 682 Options.DoCrossOver = Flags.cross_over; 683 Options.CrossOverUniformDist = Flags.cross_over_uniform_dist; 684 Options.MutateDepth = Flags.mutate_depth; 685 Options.ReduceDepth = Flags.reduce_depth; 686 Options.UseCounters = Flags.use_counters; 687 Options.UseMemmem = Flags.use_memmem; 688 Options.UseCmp = Flags.use_cmp; 689 Options.UseValueProfile = Flags.use_value_profile; 690 Options.Shrink = Flags.shrink; 691 Options.ReduceInputs = Flags.reduce_inputs; 692 Options.ShuffleAtStartUp = Flags.shuffle; 693 Options.PreferSmall = Flags.prefer_small; 694 Options.ReloadIntervalSec = Flags.reload; 695 Options.OnlyASCII = Flags.only_ascii; 696 Options.DetectLeaks = Flags.detect_leaks; 697 Options.PurgeAllocatorIntervalSec = Flags.purge_allocator_interval; 698 Options.TraceMalloc = Flags.trace_malloc; 699 Options.RssLimitMb = Flags.rss_limit_mb; 700 Options.MallocLimitMb = Flags.malloc_limit_mb; 701 if (!Options.MallocLimitMb) 702 Options.MallocLimitMb = Options.RssLimitMb; 703 if (Flags.runs >= 0) 704 Options.MaxNumberOfRuns = Flags.runs; 705 if (!Inputs->empty() && !Flags.minimize_crash_internal_step) { 706 // Ensure output corpus assumed to be the first arbitrary argument input 707 // is not a path to an existing file. 708 std::string OutputCorpusDir = (*Inputs)[0]; 709 if (!IsFile(OutputCorpusDir)) { 710 Options.OutputCorpus = OutputCorpusDir; 711 ValidateDirectoryExists(Options.OutputCorpus, Flags.create_missing_dirs); 712 } 713 } 714 Options.ReportSlowUnits = Flags.report_slow_units; 715 if (Flags.artifact_prefix) { 716 Options.ArtifactPrefix = Flags.artifact_prefix; 717 718 // Since the prefix could be a full path to a file name prefix, assume 719 // that if the path ends with the platform's separator that a directory 720 // is desired 721 std::string ArtifactPathDir = Options.ArtifactPrefix; 722 if (!IsSeparator(ArtifactPathDir[ArtifactPathDir.length() - 1])) { 723 ArtifactPathDir = DirName(ArtifactPathDir); 724 } 725 ValidateDirectoryExists(ArtifactPathDir, Flags.create_missing_dirs); 726 } 727 if (Flags.exact_artifact_path) { 728 Options.ExactArtifactPath = Flags.exact_artifact_path; 729 ValidateDirectoryExists(DirName(Options.ExactArtifactPath), 730 Flags.create_missing_dirs); 731 } 732 Vector<Unit> Dictionary; 733 if (Flags.dict) 734 if (!ParseDictionaryFile(FileToString(Flags.dict), &Dictionary)) 735 return 1; 736 if (Flags.verbosity > 0 && !Dictionary.empty()) 737 Printf("Dictionary: %zd entries\n", Dictionary.size()); 738 bool RunIndividualFiles = AllInputsAreFiles(); 739 Options.SaveArtifacts = 740 !RunIndividualFiles || Flags.minimize_crash_internal_step; 741 Options.PrintNewCovPcs = Flags.print_pcs; 742 Options.PrintNewCovFuncs = Flags.print_funcs; 743 Options.PrintFinalStats = Flags.print_final_stats; 744 Options.PrintCorpusStats = Flags.print_corpus_stats; 745 Options.PrintCoverage = Flags.print_coverage; 746 if (Flags.exit_on_src_pos) 747 Options.ExitOnSrcPos = Flags.exit_on_src_pos; 748 if (Flags.exit_on_item) 749 Options.ExitOnItem = Flags.exit_on_item; 750 if (Flags.focus_function) 751 Options.FocusFunction = Flags.focus_function; 752 if (Flags.data_flow_trace) 753 Options.DataFlowTrace = Flags.data_flow_trace; 754 if (Flags.features_dir) { 755 Options.FeaturesDir = Flags.features_dir; 756 ValidateDirectoryExists(Options.FeaturesDir, Flags.create_missing_dirs); 757 } 758 if (Flags.mutation_graph_file) 759 Options.MutationGraphFile = Flags.mutation_graph_file; 760 if (Flags.collect_data_flow) 761 Options.CollectDataFlow = Flags.collect_data_flow; 762 if (Flags.stop_file) 763 Options.StopFile = Flags.stop_file; 764 Options.Entropic = Flags.entropic; 765 Options.EntropicFeatureFrequencyThreshold = 766 (size_t)Flags.entropic_feature_frequency_threshold; 767 Options.EntropicNumberOfRarestFeatures = 768 (size_t)Flags.entropic_number_of_rarest_features; 769 Options.EntropicScalePerExecTime = Flags.entropic_scale_per_exec_time; 770 if (!Options.FocusFunction.empty()) 771 Options.Entropic = false; // FocusFunction overrides entropic scheduling. 772 if (Options.Entropic) 773 Printf("INFO: Running with entropic power schedule (0x%X, %d).\n", 774 Options.EntropicFeatureFrequencyThreshold, 775 Options.EntropicNumberOfRarestFeatures); 776 struct EntropicOptions Entropic; 777 Entropic.Enabled = Options.Entropic; 778 Entropic.FeatureFrequencyThreshold = 779 Options.EntropicFeatureFrequencyThreshold; 780 Entropic.NumberOfRarestFeatures = Options.EntropicNumberOfRarestFeatures; 781 Entropic.ScalePerExecTime = Options.EntropicScalePerExecTime; 782 783 unsigned Seed = Flags.seed; 784 // Initialize Seed. 785 if (Seed == 0) 786 Seed = 787 std::chrono::system_clock::now().time_since_epoch().count() + GetPid(); 788 if (Flags.verbosity) 789 Printf("INFO: Seed: %u\n", Seed); 790 791 if (Flags.collect_data_flow && !Flags.fork && !Flags.merge) { 792 if (RunIndividualFiles) 793 return CollectDataFlow(Flags.collect_data_flow, Flags.data_flow_trace, 794 ReadCorpora({}, *Inputs)); 795 else 796 return CollectDataFlow(Flags.collect_data_flow, Flags.data_flow_trace, 797 ReadCorpora(*Inputs, {})); 798 } 799 800 Random Rand(Seed); 801 auto *MD = new MutationDispatcher(Rand, Options); 802 auto *Corpus = new InputCorpus(Options.OutputCorpus, Entropic); 803 auto *F = new Fuzzer(Callback, *Corpus, *MD, Options); 804 805 for (auto &U: Dictionary) 806 if (U.size() <= Word::GetMaxSize()) 807 MD->AddWordToManualDictionary(Word(U.data(), U.size())); 808 809 // Threads are only supported by Chrome. Don't use them with emscripten 810 // for now. 811 #if !LIBFUZZER_EMSCRIPTEN 812 StartRssThread(F, Flags.rss_limit_mb); 813 #endif // LIBFUZZER_EMSCRIPTEN 814 815 Options.HandleAbrt = Flags.handle_abrt; 816 Options.HandleAlrm = !Flags.minimize_crash; 817 Options.HandleBus = Flags.handle_bus; 818 Options.HandleFpe = Flags.handle_fpe; 819 Options.HandleIll = Flags.handle_ill; 820 Options.HandleInt = Flags.handle_int; 821 Options.HandleSegv = Flags.handle_segv; 822 Options.HandleTerm = Flags.handle_term; 823 Options.HandleXfsz = Flags.handle_xfsz; 824 Options.HandleUsr1 = Flags.handle_usr1; 825 Options.HandleUsr2 = Flags.handle_usr2; 826 SetSignalHandler(Options); 827 828 std::atexit(Fuzzer::StaticExitCallback); 829 830 if (Flags.minimize_crash) 831 return MinimizeCrashInput(Args, Options); 832 833 if (Flags.minimize_crash_internal_step) 834 return MinimizeCrashInputInternalStep(F, Corpus); 835 836 if (Flags.cleanse_crash) 837 return CleanseCrashInput(Args, Options); 838 839 if (RunIndividualFiles) { 840 Options.SaveArtifacts = false; 841 int Runs = std::max(1, Flags.runs); 842 Printf("%s: Running %zd inputs %d time(s) each.\n", ProgName->c_str(), 843 Inputs->size(), Runs); 844 for (auto &Path : *Inputs) { 845 auto StartTime = system_clock::now(); 846 Printf("Running: %s\n", Path.c_str()); 847 for (int Iter = 0; Iter < Runs; Iter++) 848 RunOneTest(F, Path.c_str(), Options.MaxLen); 849 auto StopTime = system_clock::now(); 850 auto MS = duration_cast<milliseconds>(StopTime - StartTime).count(); 851 Printf("Executed %s in %zd ms\n", Path.c_str(), (long)MS); 852 } 853 Printf("***\n" 854 "*** NOTE: fuzzing was not performed, you have only\n" 855 "*** executed the target code on a fixed set of inputs.\n" 856 "***\n"); 857 F->PrintFinalStats(); 858 exit(0); 859 } 860 861 if (Flags.fork) 862 FuzzWithFork(F->GetMD().GetRand(), Options, Args, *Inputs, Flags.fork); 863 864 if (Flags.merge) 865 Merge(F, Options, Args, *Inputs, Flags.merge_control_file); 866 867 if (Flags.merge_inner) { 868 const size_t kDefaultMaxMergeLen = 1 << 20; 869 if (Options.MaxLen == 0) 870 F->SetMaxInputLen(kDefaultMaxMergeLen); 871 assert(Flags.merge_control_file); 872 F->CrashResistantMergeInternalStep(Flags.merge_control_file); 873 exit(0); 874 } 875 876 if (Flags.analyze_dict) { 877 size_t MaxLen = INT_MAX; // Large max length. 878 UnitVector InitialCorpus; 879 for (auto &Inp : *Inputs) { 880 Printf("Loading corpus dir: %s\n", Inp.c_str()); 881 ReadDirToVectorOfUnits(Inp.c_str(), &InitialCorpus, nullptr, 882 MaxLen, /*ExitOnError=*/false); 883 } 884 885 if (Dictionary.empty() || Inputs->empty()) { 886 Printf("ERROR: can't analyze dict without dict and corpus provided\n"); 887 return 1; 888 } 889 if (AnalyzeDictionary(F, Dictionary, InitialCorpus)) { 890 Printf("Dictionary analysis failed\n"); 891 exit(1); 892 } 893 Printf("Dictionary analysis succeeded\n"); 894 exit(0); 895 } 896 897 auto CorporaFiles = ReadCorpora(*Inputs, ParseSeedInuts(Flags.seed_inputs)); 898 F->Loop(CorporaFiles); 899 900 if (Flags.verbosity) 901 Printf("Done %zd runs in %zd second(s)\n", F->getTotalNumberOfRuns(), 902 F->secondsSinceProcessStartUp()); 903 F->PrintFinalStats(); 904 905 exit(0); // Don't let F destroy itself. 906 } 907 908 extern "C" ATTRIBUTE_INTERFACE int 909 LLVMFuzzerRunDriver(int *argc, char ***argv, 910 int (*UserCb)(const uint8_t *Data, size_t Size)) { 911 return FuzzerDriver(argc, argv, UserCb); 912 } 913 914 // Storage for global ExternalFunctions object. 915 ExternalFunctions *EF = nullptr; 916 917 } // namespace fuzzer 918