George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 1 | //===- FuzzerLoop.cpp - Fuzzer's main loop --------------------------------===// |
| 2 | // |
Chandler Carruth | 2946cd7 | 2019-01-19 08:50:56 | [diff] [blame] | 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 |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 6 | // |
| 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 Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 16 | #include "FuzzerTracePC.h" |
| 17 | #include <algorithm> |
| 18 | #include <cstring> |
| 19 | #include <memory> |
Vitaly Buka | 7dbc1d8 | 2017-11-01 03:02:59 | [diff] [blame] | 20 | #include <mutex> |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 21 | #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 | |
| 37 | namespace fuzzer { |
| 38 | static const size_t kMaxUnitSizeToPrint = 256; |
| 39 | |
| 40 | thread_local bool Fuzzer::IsMyThread; |
| 41 | |
Matt Morehouse | 43a2296 | 2018-07-17 16:12:00 | [diff] [blame] | 42 | bool RunningUserCallback = false; |
| 43 | |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 44 | // Only one Fuzzer per process. |
| 45 | static 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. |
| 49 | struct 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 Buka | 7d22324 | 2017-11-02 04:12:10 | [diff] [blame] | 71 | |
| 72 | std::recursive_mutex TraceMutex; |
| 73 | bool TraceDisabled = false; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 74 | }; |
| 75 | |
| 76 | static MallocFreeTracer AllocTracer; |
| 77 | |
Vitaly Buka | 7d22324 | 2017-11-02 04:12:10 | [diff] [blame] | 78 | // Locks printing and avoids nested hooks triggered from mallocs/frees in |
| 79 | // sanitizer. |
| 80 | class TraceLock { |
| 81 | public: |
| 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 | |
| 92 | private: |
| 93 | std::lock_guard<std::recursive_mutex> Lock; |
| 94 | }; |
Vitaly Buka | 7dbc1d8 | 2017-11-01 03:02:59 | [diff] [blame] | 95 | |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 96 | ATTRIBUTE_NO_SANITIZE_MEMORY |
| 97 | void 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 Buka | 7d22324 | 2017-11-02 04:12:10 | [diff] [blame] | 101 | TraceLock Lock; |
| 102 | if (Lock.IsDisabled()) |
| 103 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 104 | Printf("MALLOC[%zd] %p %zd\n", N, ptr, size); |
| 105 | if (TraceLevel >= 2 && EF) |
Matt Morehouse | 14cf71a | 2018-05-08 23:45:05 | [diff] [blame] | 106 | PrintStackTrace(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 107 | } |
| 108 | } |
| 109 | |
| 110 | ATTRIBUTE_NO_SANITIZE_MEMORY |
| 111 | void FreeHook(const volatile void *ptr) { |
| 112 | size_t N = AllocTracer.Frees++; |
| 113 | if (int TraceLevel = AllocTracer.TraceLevel) { |
Vitaly Buka | 7d22324 | 2017-11-02 04:12:10 | [diff] [blame] | 114 | TraceLock Lock; |
| 115 | if (Lock.IsDisabled()) |
| 116 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 117 | Printf("FREE[%zd] %p\n", N, ptr); |
| 118 | if (TraceLevel >= 2 && EF) |
Matt Morehouse | 14cf71a | 2018-05-08 23:45:05 | [diff] [blame] | 119 | PrintStackTrace(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 120 | } |
| 121 | } |
| 122 | |
| 123 | // Crash on a single malloc that exceeds the rss limit. |
| 124 | void Fuzzer::HandleMalloc(size_t Size) { |
Kostya Serebryany | de9bafb | 2017-12-01 22:12:04 | [diff] [blame] | 125 | if (!Options.MallocLimitMb || (Size >> 20) < (size_t)Options.MallocLimitMb) |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 126 | 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 Morehouse | 14cf71a | 2018-05-08 23:45:05 | [diff] [blame] | 130 | PrintStackTrace(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 131 | DumpCurrentUnit("oom-"); |
| 132 | Printf("SUMMARY: libFuzzer: out-of-memory\n"); |
| 133 | PrintFinalStats(); |
| 134 | _Exit(Options.ErrorExitCode); // Stop right now. |
| 135 | } |
| 136 | |
| 137 | Fuzzer::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 Serebryany | 51ddb88 | 2018-07-03 22:33:09 | [diff] [blame] | 149 | TPC.SetUseValueProfileMask(Options.UseValueProfile); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 150 | |
| 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 Serebryany | e9c6f06 | 2018-05-16 23:26:37 | [diff] [blame] | 160 | TPC.SetFocusFunction(Options.FocusFunction); |
Kostya Serebryany | 1fd005f | 2018-06-06 01:23:29 | [diff] [blame] | 161 | DFT.Init(Options.DataFlowTrace, Options.FocusFunction); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 162 | } |
| 163 | |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 164 | Fuzzer::~Fuzzer() {} |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 165 | |
| 166 | void Fuzzer::AllocateCurrentUnitData() { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 167 | if (CurrentUnitData || MaxInputLen == 0) |
| 168 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 169 | CurrentUnitData = new uint8_t[MaxInputLen]; |
| 170 | } |
| 171 | |
| 172 | void Fuzzer::StaticDeathCallback() { |
| 173 | assert(F); |
| 174 | F->DeathCallback(); |
| 175 | } |
| 176 | |
| 177 | void Fuzzer::DumpCurrentUnit(const char *Prefix) { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 178 | if (!CurrentUnitData) |
| 179 | return; // Happens when running individual inputs. |
Matt Morehouse | a34c65e | 2018-07-09 23:51:08 | [diff] [blame] | 180 | ScopedDisableMsanInterceptorChecks S; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 181 | 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 | |
| 192 | NO_SANITIZE_MEMORY |
| 193 | void Fuzzer::DeathCallback() { |
| 194 | DumpCurrentUnit("crash-"); |
| 195 | PrintFinalStats(); |
| 196 | } |
| 197 | |
| 198 | void Fuzzer::StaticAlarmCallback() { |
| 199 | assert(F); |
| 200 | F->AlarmCallback(); |
| 201 | } |
| 202 | |
| 203 | void Fuzzer::StaticCrashSignalCallback() { |
| 204 | assert(F); |
| 205 | F->CrashCallback(); |
| 206 | } |
| 207 | |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 208 | void Fuzzer::StaticExitCallback() { |
| 209 | assert(F); |
| 210 | F->ExitCallback(); |
| 211 | } |
| 212 | |
| 213 | void Fuzzer::StaticInterruptCallback() { |
| 214 | assert(F); |
| 215 | F->InterruptCallback(); |
| 216 | } |
| 217 | |
Kostya Serebryany | a2ca2dc | 2017-11-09 20:30:19 | [diff] [blame] | 218 | void Fuzzer::StaticGracefulExitCallback() { |
| 219 | assert(F); |
| 220 | F->GracefulExitRequested = true; |
| 221 | Printf("INFO: signal received, trying to exit gracefully\n"); |
| 222 | } |
| 223 | |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 224 | void Fuzzer::StaticFileSizeExceedCallback() { |
| 225 | Printf("==%lu== ERROR: libFuzzer: file size exceeded\n", GetPid()); |
| 226 | exit(1); |
| 227 | } |
| 228 | |
| 229 | void Fuzzer::CrashCallback() { |
Julian Lettner | 15df273 | 2019-01-31 01:24:01 | [diff] [blame] | 230 | if (EF->__sanitizer_acquire_crash_state && |
| 231 | !EF->__sanitizer_acquire_crash_state()) |
| 232 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 233 | Printf("==%lu== ERROR: libFuzzer: deadly signal\n", GetPid()); |
Matt Morehouse | 14cf71a | 2018-05-08 23:45:05 | [diff] [blame] | 234 | PrintStackTrace(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 235 | 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 Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 241 | _Exit(Options.ErrorExitCode); // Stop right now. |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 242 | } |
| 243 | |
| 244 | void Fuzzer::ExitCallback() { |
Matt Morehouse | 43a2296 | 2018-07-17 16:12:00 | [diff] [blame] | 245 | if (!RunningUserCallback) |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 246 | return; // This exit did not come from the user callback |
Matt Morehouse | 52fd169 | 2018-05-01 21:01:53 | [diff] [blame] | 247 | if (EF->__sanitizer_acquire_crash_state && |
| 248 | !EF->__sanitizer_acquire_crash_state()) |
| 249 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 250 | Printf("==%lu== ERROR: libFuzzer: fuzz target exited\n", GetPid()); |
Matt Morehouse | 14cf71a | 2018-05-08 23:45:05 | [diff] [blame] | 251 | PrintStackTrace(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 252 | Printf("SUMMARY: libFuzzer: fuzz target exited\n"); |
| 253 | DumpCurrentUnit("crash-"); |
| 254 | PrintFinalStats(); |
| 255 | _Exit(Options.ErrorExitCode); |
| 256 | } |
| 257 | |
Kostya Serebryany | a2ca2dc | 2017-11-09 20:30:19 | [diff] [blame] | 258 | void Fuzzer::MaybeExitGracefully() { |
| 259 | if (!GracefulExitRequested) return; |
| 260 | Printf("==%lu== INFO: libFuzzer: exiting as requested\n", GetPid()); |
| 261 | PrintFinalStats(); |
| 262 | _Exit(0); |
| 263 | } |
| 264 | |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 265 | void Fuzzer::InterruptCallback() { |
| 266 | Printf("==%lu== libFuzzer: run interrupted; exiting\n", GetPid()); |
| 267 | PrintFinalStats(); |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 268 | _Exit(0); // Stop right now, don't perform any at-exit actions. |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 269 | } |
| 270 | |
| 271 | NO_SANITIZE_MEMORY |
| 272 | void Fuzzer::AlarmCallback() { |
| 273 | assert(Options.UnitTimeoutSec > 0); |
| 274 | // In Windows Alarm callback is executed by a different thread. |
Kamil Rytarowski | 2e61186 | 2018-11-06 01:28:01 | [diff] [blame] | 275 | // NetBSD's current behavior needs this change too. |
| 276 | #if !LIBFUZZER_WINDOWS && !LIBFUZZER_NETBSD |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 277 | if (!InFuzzingThread()) |
| 278 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 279 | #endif |
Matt Morehouse | 43a2296 | 2018-07-17 16:12:00 | [diff] [blame] | 280 | if (!RunningUserCallback) |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 281 | 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 Morehouse | 52fd169 | 2018-05-01 21:01:53 | [diff] [blame] | 289 | if (EF->__sanitizer_acquire_crash_state && |
| 290 | !EF->__sanitizer_acquire_crash_state()) |
| 291 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 292 | 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 Morehouse | 14cf71a | 2018-05-08 23:45:05 | [diff] [blame] | 298 | PrintStackTrace(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 299 | Printf("SUMMARY: libFuzzer: timeout\n"); |
| 300 | PrintFinalStats(); |
| 301 | _Exit(Options.TimeoutExitCode); // Stop right now. |
| 302 | } |
| 303 | } |
| 304 | |
| 305 | void Fuzzer::RssLimitCallback() { |
Matt Morehouse | 52fd169 | 2018-05-01 21:01:53 | [diff] [blame] | 306 | if (EF->__sanitizer_acquire_crash_state && |
| 307 | !EF->__sanitizer_acquire_crash_state()) |
| 308 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 309 | 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 Morehouse | 14cf71a | 2018-05-08 23:45:05 | [diff] [blame] | 313 | PrintMemoryProfile(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 314 | DumpCurrentUnit("oom-"); |
| 315 | Printf("SUMMARY: libFuzzer: out-of-memory\n"); |
| 316 | PrintFinalStats(); |
| 317 | _Exit(Options.ErrorExitCode); // Stop right now. |
| 318 | } |
| 319 | |
| 320 | void 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 Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 328 | Printf(" ft: %zd", N); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 329 | if (!Corpus.empty()) { |
| 330 | Printf(" corp: %zd", Corpus.NumActiveUnits()); |
| 331 | if (size_t N = Corpus.SizeInBytes()) { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 332 | if (N < (1 << 14)) |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 333 | Printf("/%zdb", N); |
| 334 | else if (N < (1 << 24)) |
| 335 | Printf("/%zdKb", N >> 10); |
| 336 | else |
| 337 | Printf("/%zdMb", N >> 20); |
| 338 | } |
Kostya Serebryany | e9c6f06 | 2018-05-16 23:26:37 | [diff] [blame] | 339 | if (size_t FF = Corpus.NumInputsThatTouchFocusFunction()) |
| 340 | Printf(" focus: %zd", FF); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 341 | } |
Matt Morehouse | ddf352b | 2018-02-22 19:00:17 | [diff] [blame] | 342 | if (TmpMaxMutationLen) |
| 343 | Printf(" lim: %zd", TmpMaxMutationLen); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 344 | 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 | |
| 352 | void Fuzzer::PrintFinalStats() { |
| 353 | if (Options.PrintCoverage) |
| 354 | TPC.PrintCoverage(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 355 | if (Options.PrintCorpusStats) |
| 356 | Corpus.PrintStats(); |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 357 | if (!Options.PrintFinalStats) |
| 358 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 359 | 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 | |
| 367 | void 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 | |
| 378 | void Fuzzer::SetMaxMutationLen(size_t MaxMutationLen) { |
| 379 | assert(MaxMutationLen && MaxMutationLen <= MaxInputLen); |
| 380 | this->MaxMutationLen = MaxMutationLen; |
| 381 | } |
| 382 | |
| 383 | void Fuzzer::CheckExitOnSrcPosOrItem() { |
| 384 | if (!Options.ExitOnSrcPos.empty()) { |
George Karpenkov | bebcbfb | 2017-08-27 23:20:09 | [diff] [blame] | 385 | static auto *PCsSet = new Set<uintptr_t>; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 386 | auto HandlePC = [&](uintptr_t PC) { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 387 | if (!PCsSet->insert(PC).second) |
| 388 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 389 | 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 | |
| 407 | void Fuzzer::RereadOutputCorpus(size_t MaxSize) { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 408 | if (Options.OutputCorpus.empty() || !Options.ReloadIntervalSec) |
| 409 | return; |
George Karpenkov | bebcbfb | 2017-08-27 23:20:09 | [diff] [blame] | 410 | Vector<Unit> AdditionalCorpus; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 411 | 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 Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 431 | void 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 | |
| 445 | bool Fuzzer::RunOne(const uint8_t *Data, size_t Size, bool MayDeleteFile, |
Kostya Serebryany | ad05ee0 | 2017-12-01 19:18:38 | [diff] [blame] | 446 | InputInfo *II, bool *FoundUniqFeatures) { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 447 | if (!Size) |
| 448 | return false; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 449 | |
| 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 Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 456 | 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 Serebryany | ad05ee0 | 2017-12-01 19:18:38 | [diff] [blame] | 463 | if (FoundUniqFeatures) |
| 464 | *FoundUniqFeatures = FoundUniqFeaturesOfII; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 465 | 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 Serebryany | 6b87e0c | 2018-07-19 01:23:32 | [diff] [blame] | 470 | TPC.ObservedFocusFunction(), UniqFeatureSetTmp, DFT, II); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 471 | return true; |
| 472 | } |
| 473 | if (II && FoundUniqFeaturesOfII && |
Kostya Serebryany | 67af992 | 2018-06-07 01:40:20 | [diff] [blame] | 474 | II->DataFlowTraceForFocusFunction.empty() && |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 475 | 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 | |
| 483 | size_t Fuzzer::GetCurrentUnitInFuzzingThead(const uint8_t **Data) const { |
| 484 | assert(InFuzzingThread()); |
| 485 | *Data = CurrentUnitData; |
| 486 | return CurrentUnitSize; |
| 487 | } |
| 488 | |
| 489 | void 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. |
| 498 | static 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 | |
| 507 | void Fuzzer::ExecuteCallback(const uint8_t *Data, size_t Size) { |
| 508 | TPC.RecordInitialStack(); |
| 509 | TotalNumberOfRuns++; |
| 510 | assert(InFuzzingThread()); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 511 | // 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 Morehouse | a34c65e | 2018-07-09 23:51:08 | [diff] [blame] | 515 | if (EF->__msan_unpoison) |
| 516 | EF->__msan_unpoison(DataCopy, Size); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 517 | if (CurrentUnitData && CurrentUnitData != Data) |
| 518 | memcpy(CurrentUnitData, Data, Size); |
| 519 | CurrentUnitSize = Size; |
Matt Morehouse | a34c65e | 2018-07-09 23:51:08 | [diff] [blame] | 520 | { |
| 521 | ScopedEnableMsanInterceptorChecks S; |
| 522 | AllocTracer.Start(Options.TraceMalloc); |
| 523 | UnitStartTime = system_clock::now(); |
| 524 | TPC.ResetMaps(); |
Matt Morehouse | 43a2296 | 2018-07-17 16:12:00 | [diff] [blame] | 525 | RunningUserCallback = true; |
Matt Morehouse | a34c65e | 2018-07-09 23:51:08 | [diff] [blame] | 526 | int Res = CB(DataCopy, Size); |
Matt Morehouse | 43a2296 | 2018-07-17 16:12:00 | [diff] [blame] | 527 | RunningUserCallback = false; |
Matt Morehouse | a34c65e | 2018-07-09 23:51:08 | [diff] [blame] | 528 | UnitStopTime = system_clock::now(); |
| 529 | (void)Res; |
| 530 | assert(Res == 0); |
| 531 | HasMoreMallocsThanFrees = AllocTracer.Stop(); |
| 532 | } |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 533 | if (!LooseMemeq(DataCopy, Data, Size)) |
| 534 | CrashOnOverwrittenData(); |
| 535 | CurrentUnitSize = 0; |
| 536 | delete[] DataCopy; |
| 537 | } |
| 538 | |
| 539 | void 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 | |
| 550 | void 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 | |
| 563 | void 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 | |
| 574 | void Fuzzer::ReportNewCoverage(InputInfo *II, const Unit &U) { |
| 575 | II->NumSuccessfullMutations++; |
| 576 | MD.RecordSuccessfulMutationSequence(); |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 577 | PrintStatusForNewUnit(U, II->Reduced ? "REDUCE" : "NEW "); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 578 | WriteToOutputCorpus(U); |
| 579 | NumberOfNewUnitsAdded++; |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 580 | CheckExitOnSrcPosOrItem(); // Check only after the unit is saved to corpus. |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 581 | LastCorpusUpdateRun = TotalNumberOfRuns; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 582 | } |
| 583 | |
| 584 | // Tries detecting a memory leak on the particular input that we have just |
| 585 | // executed before calling this function. |
| 586 | void Fuzzer::TryDetectingAMemoryLeak(const uint8_t *Data, size_t Size, |
| 587 | bool DuringInitialCorpusExecution) { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 588 | if (!HasMoreMallocsThanFrees) |
| 589 | return; // mallocs==frees, a leak is unlikely. |
| 590 | if (!Options.DetectLeaks) |
| 591 | return; |
Max Moroz | 3f26dac | 2017-09-12 02:01:54 | [diff] [blame] | 592 | if (!DuringInitialCorpusExecution && |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 593 | TotalNumberOfRuns >= Options.MaxNumberOfRuns) |
| 594 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 595 | if (!&(EF->__lsan_enable) || !&(EF->__lsan_disable) || |
| 596 | !(EF->__lsan_do_recoverable_leak_check)) |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 597 | return; // No lsan. |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 598 | // 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 Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 603 | if (!HasMoreMallocsThanFrees) |
| 604 | return; // a leak is unlikely. |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 605 | 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 Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 625 | _Exit(Options.ErrorExitCode); // not exit() to disable lsan further on. |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 626 | } |
| 627 | } |
| 628 | |
| 629 | void Fuzzer::MutateAndTestOne() { |
| 630 | MD.StartMutationSequence(); |
| 631 | |
| 632 | auto &II = Corpus.ChooseUnitToMutate(MD.GetRand()); |
Kostya Serebryany | 0719b35 | 2019-02-08 01:20:54 | [diff] [blame^] | 633 | if (Options.DoCrossOver) |
| 634 | MD.SetCrossOverWith(&Corpus.ChooseUnitToMutate(MD.GetRand()).U); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 635 | 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 Serebryany | a2ca2dc | 2017-11-09 20:30:19 | [diff] [blame] | 651 | MaybeExitGracefully(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 652 | size_t NewSize = 0; |
Kostya Serebryany | 6b87e0c | 2018-07-19 01:23:32 | [diff] [blame] | 653 | 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 Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 659 | assert(NewSize > 0 && "Mutator returned empty unit"); |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 660 | assert(NewSize <= CurrentMaxMutationLen && "Mutator return oversized unit"); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 661 | Size = NewSize; |
| 662 | II.NumExecutedMutations++; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 663 | |
Kostya Serebryany | ad05ee0 | 2017-12-01 19:18:38 | [diff] [blame] | 664 | bool FoundUniqFeatures = false; |
| 665 | bool NewCov = RunOne(CurrentUnitData, Size, /*MayDeleteFile=*/true, &II, |
| 666 | &FoundUniqFeatures); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 667 | TryDetectingAMemoryLeak(CurrentUnitData, Size, |
| 668 | /*DuringInitialCorpusExecution*/ false); |
Kostya Serebryany | ad05ee0 | 2017-12-01 19:18:38 | [diff] [blame] | 669 | if (NewCov) { |
Matt Morehouse | 947838c | 2017-11-09 20:44:08 | [diff] [blame] | 670 | ReportNewCoverage(&II, {CurrentUnitData, CurrentUnitData + Size}); |
Kostya Serebryany | ad05ee0 | 2017-12-01 19:18:38 | [diff] [blame] | 671 | break; // We will mutate this input more in the next rounds. |
| 672 | } |
| 673 | if (Options.ReduceDepth && !FoundUniqFeatures) |
Max Moroz | 1d369a5 | 2018-07-16 15:15:34 | [diff] [blame] | 674 | break; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 675 | } |
| 676 | } |
| 677 | |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 678 | void Fuzzer::PurgeAllocator() { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 679 | if (Options.PurgeAllocatorIntervalSec < 0 || !EF->__sanitizer_purge_allocator) |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 680 | return; |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 681 | if (duration_cast<seconds>(system_clock::now() - |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 682 | LastAllocatorPurgeAttemptTime) |
| 683 | .count() < Options.PurgeAllocatorIntervalSec) |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 684 | return; |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 685 | |
| 686 | if (Options.RssLimitMb <= 0 || |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 687 | GetPeakRSSMb() > static_cast<size_t>(Options.RssLimitMb) / 2) |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 688 | EF->__sanitizer_purge_allocator(); |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 689 | |
| 690 | LastAllocatorPurgeAttemptTime = system_clock::now(); |
| 691 | } |
| 692 | |
Kostya Serebryany | 0719b35 | 2019-02-08 01:20:54 | [diff] [blame^] | 693 | void Fuzzer::ReadAndExecuteSeedCorpora( |
| 694 | const Vector<std::string> &CorpusDirs, |
| 695 | const Vector<std::string> &ExtraSeedFiles) { |
Kostya Serebryany | 3a8e3c8 | 2017-08-29 02:05:01 | [diff] [blame] | 696 | const size_t kMaxSaneLen = 1 << 20; |
| 697 | const size_t kMinDefaultLen = 4096; |
Kostya Serebryany | 4faeb87 | 2017-08-29 20:51:24 | [diff] [blame] | 698 | Vector<SizedFile> SizedFiles; |
| 699 | size_t MaxSize = 0; |
| 700 | size_t MinSize = -1; |
| 701 | size_t TotalSize = 0; |
Kostya Serebryany | 93679be | 2017-09-12 21:58:07 | [diff] [blame] | 702 | size_t LastNumFiles = 0; |
Kostya Serebryany | 4faeb87 | 2017-08-29 20:51:24 | [diff] [blame] | 703 | for (auto &Dir : CorpusDirs) { |
Kostya Serebryany | 93679be | 2017-09-12 21:58:07 | [diff] [blame] | 704 | 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 Serebryany | 0719b35 | 2019-02-08 01:20:54 | [diff] [blame^] | 709 | // Add files from -seed_inputs. |
| 710 | for (auto &File : ExtraSeedFiles) |
| 711 | if (auto Size = FileSize(File)) |
| 712 | SizedFiles.push_back({File, Size}); |
| 713 | |
Kostya Serebryany | 93679be | 2017-09-12 21:58:07 | [diff] [blame] | 714 | for (auto &File : SizedFiles) { |
| 715 | MaxSize = Max(File.Size, MaxSize); |
| 716 | MinSize = Min(File.Size, MinSize); |
| 717 | TotalSize += File.Size; |
Kostya Serebryany | 3a8e3c8 | 2017-08-29 02:05:01 | [diff] [blame] | 718 | } |
Kostya Serebryany | 4faeb87 | 2017-08-29 20:51:24 | [diff] [blame] | 719 | if (Options.MaxLen == 0) |
| 720 | SetMaxInputLen(std::min(std::max(kMinDefaultLen, MaxSize), kMaxSaneLen)); |
| 721 | assert(MaxInputLen > 0); |
| 722 | |
Kostya Serebryany | 51823d3 | 2017-10-13 01:12:23 | [diff] [blame] | 723 | // Test the callback with empty input and never try it again. |
| 724 | uint8_t dummy = 0; |
| 725 | ExecuteCallback(&dummy, 0); |
| 726 | |
Kostya Serebryany | 23482e1 | 2019-01-31 01:40:14 | [diff] [blame] | 727 | // Protect lazy counters here, after the once-init code has been executed. |
| 728 | if (Options.LazyCounters) |
| 729 | TPC.ProtectLazyCounters(); |
| 730 | |
Kostya Serebryany | 4faeb87 | 2017-08-29 20:51:24 | [diff] [blame] | 731 | 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 Serebryany | 93679be | 2017-09-12 21:58:07 | [diff] [blame] | 742 | if (Options.PreferSmall) { |
| 743 | std::stable_sort(SizedFiles.begin(), SizedFiles.end()); |
| 744 | assert(SizedFiles.front().Size <= SizedFiles.back().Size); |
| 745 | } |
Kostya Serebryany | 4faeb87 | 2017-08-29 20:51:24 | [diff] [blame] | 746 | |
| 747 | // Load and execute inputs one by one. |
| 748 | for (auto &SF : SizedFiles) { |
Kostya Serebryany | 082e9a7 | 2017-08-31 19:17:15 | [diff] [blame] | 749 | auto U = FileToVector(SF.File, MaxInputLen, /*ExitOnError=*/false); |
Kostya Serebryany | 4faeb87 | 2017-08-29 20:51:24 | [diff] [blame] | 750 | assert(U.size() <= MaxInputLen); |
| 751 | RunOne(U.data(), U.size()); |
| 752 | CheckExitOnSrcPosOrItem(); |
| 753 | TryDetectingAMemoryLeak(U.data(), U.size(), |
| 754 | /*DuringInitialCorpusExecution*/ true); |
| 755 | } |
Kostya Serebryany | 3a8e3c8 | 2017-08-29 02:05:01 | [diff] [blame] | 756 | } |
| 757 | |
Kostya Serebryany | 4faeb87 | 2017-08-29 20:51:24 | [diff] [blame] | 758 | PrintStats("INITED"); |
Kostya Serebryany | e9c6f06 | 2018-05-16 23:26:37 | [diff] [blame] | 759 | if (!Options.FocusFunction.empty()) |
| 760 | Printf("INFO: %zd/%zd inputs touch the focus function\n", |
| 761 | Corpus.NumInputsThatTouchFocusFunction(), Corpus.size()); |
Kostya Serebryany | 67af992 | 2018-06-07 01:40:20 | [diff] [blame] | 762 | if (!Options.DataFlowTrace.empty()) |
| 763 | Printf("INFO: %zd/%zd inputs have the Data Flow Trace\n", |
| 764 | Corpus.NumInputsWithDataFlowTrace(), Corpus.size()); |
Kostya Serebryany | e9c6f06 | 2018-05-16 23:26:37 | [diff] [blame] | 765 | |
Max Moroz | fe97441 | 2018-05-23 19:42:30 | [diff] [blame] | 766 | if (Corpus.empty() && Options.MaxNumberOfRuns) { |
Kostya Serebryany | 4faeb87 | 2017-08-29 20:51:24 | [diff] [blame] | 767 | Printf("ERROR: no interesting inputs were found. " |
| 768 | "Is the code instrumented for coverage? Exiting.\n"); |
| 769 | exit(1); |
Kostya Serebryany | 3a8e3c8 | 2017-08-29 02:05:01 | [diff] [blame] | 770 | } |
Kostya Serebryany | 3a8e3c8 | 2017-08-29 02:05:01 | [diff] [blame] | 771 | } |
| 772 | |
Kostya Serebryany | 0719b35 | 2019-02-08 01:20:54 | [diff] [blame^] | 773 | void Fuzzer::Loop(const Vector<std::string> &CorpusDirs, |
| 774 | const Vector<std::string> &ExtraSeedFiles) { |
| 775 | ReadAndExecuteSeedCorpora(CorpusDirs, ExtraSeedFiles); |
Kostya Serebryany | 67af992 | 2018-06-07 01:40:20 | [diff] [blame] | 776 | DFT.Clear(); // No need for DFT any more. |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 777 | TPC.SetPrintNewPCs(Options.PrintNewCovPcs); |
Kostya Serebryany | 2eef816 | 2017-08-25 20:09:25 | [diff] [blame] | 778 | TPC.SetPrintNewFuncs(Options.PrintNewCovFuncs); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 779 | system_clock::time_point LastCorpusReload = system_clock::now(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 780 | 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 Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 789 | if (TimedOut()) |
| 790 | break; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 791 | |
| 792 | // Update TmpMaxMutationLen |
Matt Morehouse | 36c89b3 | 2018-02-13 20:52:15 | [diff] [blame] | 793 | if (Options.LenControl) { |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 794 | if (TmpMaxMutationLen < MaxMutationLen && |
Kostya Serebryany | e9ed232 | 2017-12-12 23:11:28 | [diff] [blame] | 795 | TotalNumberOfRuns - LastCorpusUpdateRun > |
Matt Morehouse | 36c89b3 | 2018-02-13 20:52:15 | [diff] [blame] | 796 | Options.LenControl * Log(TmpMaxMutationLen)) { |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 797 | TmpMaxMutationLen = |
Kostya Serebryany | e9ed232 | 2017-12-12 23:11:28 | [diff] [blame] | 798 | Min(MaxMutationLen, TmpMaxMutationLen + Log(TmpMaxMutationLen)); |
Kostya Serebryany | e9ed232 | 2017-12-12 23:11:28 | [diff] [blame] | 799 | LastCorpusUpdateRun = TotalNumberOfRuns; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 800 | } |
| 801 | } else { |
| 802 | TmpMaxMutationLen = MaxMutationLen; |
| 803 | } |
| 804 | |
| 805 | // Perform several mutations and runs. |
| 806 | MutateAndTestOne(); |
Alex Shlyapnikov | 6f1c26f | 2017-10-23 22:04:30 | [diff] [blame] | 807 | |
| 808 | PurgeAllocator(); |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 809 | } |
| 810 | |
| 811 | PrintStats("DONE ", "\n"); |
| 812 | MD.PrintRecommendedDictionary(); |
| 813 | } |
| 814 | |
| 815 | void Fuzzer::MinimizeCrashLoop(const Unit &U) { |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 816 | if (U.size() <= 1) |
| 817 | return; |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 818 | 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 Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 832 | } // namespace fuzzer |
| 833 | |
| 834 | extern "C" { |
| 835 | |
Jonathan Metzman | b795c31 | 2019-01-17 16:36:05 | [diff] [blame] | 836 | ATTRIBUTE_INTERFACE size_t |
Petr Hosek | eac2b47 | 2018-01-17 20:39:14 | [diff] [blame] | 837 | LLVMFuzzerMutate(uint8_t *Data, size_t Size, size_t MaxSize) { |
George Karpenkov | 10ab2ac | 2017-08-21 23:25:50 | [diff] [blame] | 838 | assert(fuzzer::F); |
| 839 | return fuzzer::F->GetMD().DefaultMutate(Data, Size, MaxSize); |
| 840 | } |
| 841 | |
Alex Shlyapnikov | 5ded070 | 2017-10-23 23:24:33 | [diff] [blame] | 842 | } // extern "C" |