Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 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 "FuzzerInternal.h" |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 13 | #include <algorithm> |
Kostya Serebryany | d50a3ee | 2016-01-13 23:02:30 +0000 | [diff] [blame] | 14 | #include <cstring> |
| 15 | #include <memory> |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 16 | |
Kostya Serebryany | 2a48c24 | 2015-11-13 01:54:40 +0000 | [diff] [blame] | 17 | #if defined(__has_include) |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 18 | #if __has_include(<sanitizer / coverage_interface.h>) |
| 19 | #include <sanitizer/coverage_interface.h> |
| 20 | #endif |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 21 | #if __has_include(<sanitizer / lsan_interface.h>) |
| 22 | #include <sanitizer/lsan_interface.h> |
| 23 | #endif |
Kostya Serebryany | 2a48c24 | 2015-11-13 01:54:40 +0000 | [diff] [blame] | 24 | #endif |
| 25 | |
Benjamin Kramer | d96b0c1 | 2016-03-18 14:19:19 +0000 | [diff] [blame] | 26 | #define NO_SANITIZE_MEMORY |
| 27 | #if defined(__has_feature) |
| 28 | #if __has_feature(memory_sanitizer) |
| 29 | #undef NO_SANITIZE_MEMORY |
| 30 | #define NO_SANITIZE_MEMORY __attribute__((no_sanitize_memory)) |
| 31 | #endif |
| 32 | #endif |
| 33 | |
Kostya Serebryany | d6edce9 | 2015-10-16 23:04:31 +0000 | [diff] [blame] | 34 | extern "C" { |
Kostya Serebryany | 5eab74e | 2015-11-09 23:17:45 +0000 | [diff] [blame] | 35 | // Re-declare some of the sanitizer functions as "weak" so that |
Kostya Serebryany | 2a48c24 | 2015-11-13 01:54:40 +0000 | [diff] [blame] | 36 | // libFuzzer can be linked w/o the sanitizers and sanitizer-coverage |
Kostya Serebryany | 5eab74e | 2015-11-09 23:17:45 +0000 | [diff] [blame] | 37 | // (in which case it will complain at start-up time). |
Kostya Serebryany | d6edce9 | 2015-10-16 23:04:31 +0000 | [diff] [blame] | 38 | __attribute__((weak)) void __sanitizer_print_stack_trace(); |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 39 | __attribute__((weak)) void __sanitizer_reset_coverage(); |
Kostya Serebryany | 94660b3 | 2015-10-23 18:37:58 +0000 | [diff] [blame] | 40 | __attribute__((weak)) size_t __sanitizer_get_total_unique_caller_callee_pairs(); |
Kostya Serebryany | 5eab74e | 2015-11-09 23:17:45 +0000 | [diff] [blame] | 41 | __attribute__((weak)) size_t __sanitizer_get_total_unique_coverage(); |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 42 | __attribute__((weak)) void |
| 43 | __sanitizer_set_death_callback(void (*callback)(void)); |
Kostya Serebryany | 5eab74e | 2015-11-09 23:17:45 +0000 | [diff] [blame] | 44 | __attribute__((weak)) size_t __sanitizer_get_number_of_counters(); |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 45 | __attribute__((weak)) uintptr_t |
| 46 | __sanitizer_update_counter_bitset_and_clear_counters(uint8_t *bitset); |
Mike Aizatsky | 8b11f87 | 2016-01-06 00:21:22 +0000 | [diff] [blame] | 47 | __attribute__((weak)) uintptr_t |
| 48 | __sanitizer_get_coverage_pc_buffer(uintptr_t **data); |
Kostya Serebryany | 22cc5e2 | 2016-02-13 02:29:38 +0000 | [diff] [blame] | 49 | |
| 50 | __attribute__((weak)) size_t LLVMFuzzerCustomMutator(uint8_t *Data, size_t Size, |
| 51 | size_t MaxSize, |
| 52 | unsigned int Seed); |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 53 | __attribute__((weak)) void __sanitizer_malloc_hook(void *ptr, size_t size); |
| 54 | __attribute__((weak)) void __sanitizer_free_hook(void *ptr); |
| 55 | __attribute__((weak)) void __lsan_enable(); |
| 56 | __attribute__((weak)) void __lsan_disable(); |
| 57 | __attribute__((weak)) int __lsan_do_recoverable_leak_check(); |
Kostya Serebryany | d6edce9 | 2015-10-16 23:04:31 +0000 | [diff] [blame] | 58 | } |
| 59 | |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 60 | namespace fuzzer { |
Kostya Serebryany | a9da9b4 | 2015-10-16 22:47:20 +0000 | [diff] [blame] | 61 | static const size_t kMaxUnitSizeToPrint = 256; |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 62 | |
Kostya Serebryany | 5eab74e | 2015-11-09 23:17:45 +0000 | [diff] [blame] | 63 | static void MissingWeakApiFunction(const char *FnName) { |
| 64 | Printf("ERROR: %s is not defined. Exiting.\n" |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 65 | "Did you use -fsanitize-coverage=... to build your code?\n", |
| 66 | FnName); |
Kostya Serebryany | 5eab74e | 2015-11-09 23:17:45 +0000 | [diff] [blame] | 67 | exit(1); |
| 68 | } |
| 69 | |
| 70 | #define CHECK_WEAK_API_FUNCTION(fn) \ |
| 71 | do { \ |
| 72 | if (!fn) \ |
| 73 | MissingWeakApiFunction(#fn); \ |
| 74 | } while (false) |
| 75 | |
Kostya Serebryany | 52a788e | 2015-03-31 20:13:20 +0000 | [diff] [blame] | 76 | // Only one Fuzzer per process. |
| 77 | static Fuzzer *F; |
| 78 | |
Kostya Serebryany | 1deb049 | 2016-02-13 06:24:18 +0000 | [diff] [blame] | 79 | size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize) { |
| 80 | assert(F); |
| 81 | return F->GetMD().Mutate(Data, Size, MaxSize); |
| 82 | } |
| 83 | |
Kostya Serebryany | 7ec0c56 | 2016-02-13 03:25:16 +0000 | [diff] [blame] | 84 | Fuzzer::Fuzzer(UserCallback CB, MutationDispatcher &MD, FuzzingOptions Options) |
| 85 | : CB(CB), MD(MD), Options(Options) { |
Kostya Serebryany | 52a788e | 2015-03-31 20:13:20 +0000 | [diff] [blame] | 86 | SetDeathCallback(); |
Kostya Serebryany | 2252625 | 2015-05-11 21:16:27 +0000 | [diff] [blame] | 87 | InitializeTraceState(); |
Kostya Serebryany | 52a788e | 2015-03-31 20:13:20 +0000 | [diff] [blame] | 88 | assert(!F); |
| 89 | F = this; |
| 90 | } |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 91 | |
| 92 | void Fuzzer::SetDeathCallback() { |
Kostya Serebryany | 5eab74e | 2015-11-09 23:17:45 +0000 | [diff] [blame] | 93 | CHECK_WEAK_API_FUNCTION(__sanitizer_set_death_callback); |
Kostya Serebryany | 52a788e | 2015-03-31 20:13:20 +0000 | [diff] [blame] | 94 | __sanitizer_set_death_callback(StaticDeathCallback); |
| 95 | } |
| 96 | |
Kostya Serebryany | 52a788e | 2015-03-31 20:13:20 +0000 | [diff] [blame] | 97 | void Fuzzer::StaticDeathCallback() { |
| 98 | assert(F); |
| 99 | F->DeathCallback(); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 100 | } |
| 101 | |
Kostya Serebryany | 228d5b1 | 2016-03-01 22:19:21 +0000 | [diff] [blame] | 102 | void Fuzzer::DumpCurrentUnit(const char *Prefix) { |
Kostya Serebryany | 98abb2c | 2016-01-13 23:46:01 +0000 | [diff] [blame] | 103 | if (CurrentUnitSize <= kMaxUnitSizeToPrint) { |
| 104 | PrintHexArray(CurrentUnitData, CurrentUnitSize, "\n"); |
| 105 | PrintASCII(CurrentUnitData, CurrentUnitSize, "\n"); |
Kostya Serebryany | e95022a | 2015-10-09 04:03:14 +0000 | [diff] [blame] | 106 | } |
Kostya Serebryany | 98abb2c | 2016-01-13 23:46:01 +0000 | [diff] [blame] | 107 | WriteUnitToFileWithPrefix( |
Kostya Serebryany | 228d5b1 | 2016-03-01 22:19:21 +0000 | [diff] [blame] | 108 | {CurrentUnitData, CurrentUnitData + CurrentUnitSize}, Prefix); |
| 109 | } |
| 110 | |
Benjamin Kramer | d96b0c1 | 2016-03-18 14:19:19 +0000 | [diff] [blame] | 111 | NO_SANITIZE_MEMORY |
Kostya Serebryany | 228d5b1 | 2016-03-01 22:19:21 +0000 | [diff] [blame] | 112 | void Fuzzer::DeathCallback() { |
| 113 | if (!CurrentUnitSize) return; |
| 114 | Printf("DEATH:\n"); |
| 115 | DumpCurrentUnit("crash-"); |
Kostya Serebryany | 66ff075 | 2016-02-26 22:42:23 +0000 | [diff] [blame] | 116 | PrintFinalStats(); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 117 | } |
| 118 | |
Kostya Serebryany | 52a788e | 2015-03-31 20:13:20 +0000 | [diff] [blame] | 119 | void Fuzzer::StaticAlarmCallback() { |
| 120 | assert(F); |
| 121 | F->AlarmCallback(); |
| 122 | } |
| 123 | |
Kostya Serebryany | 228d5b1 | 2016-03-01 22:19:21 +0000 | [diff] [blame] | 124 | void Fuzzer::StaticCrashSignalCallback() { |
| 125 | assert(F); |
| 126 | F->CrashCallback(); |
| 127 | } |
| 128 | |
| 129 | void Fuzzer::StaticInterruptCallback() { |
| 130 | assert(F); |
| 131 | F->InterruptCallback(); |
| 132 | } |
| 133 | |
| 134 | void Fuzzer::CrashCallback() { |
| 135 | Printf("==%d== ERROR: libFuzzer: deadly signal\n", GetPid()); |
| 136 | if (__sanitizer_print_stack_trace) |
| 137 | __sanitizer_print_stack_trace(); |
| 138 | Printf("NOTE: libFuzzer has rudimentary signal handlers.\n" |
| 139 | " Combine libFuzzer with AddressSanitizer or similar for better " |
| 140 | "crash reports.\n"); |
| 141 | Printf("SUMMARY: libFuzzer: deadly signal\n"); |
| 142 | DumpCurrentUnit("crash-"); |
| 143 | PrintFinalStats(); |
| 144 | exit(Options.ErrorExitCode); |
| 145 | } |
| 146 | |
| 147 | void Fuzzer::InterruptCallback() { |
| 148 | Printf("==%d== libFuzzer: run interrupted; exiting\n", GetPid()); |
| 149 | PrintFinalStats(); |
Kostya Serebryany | e483ed2 | 2016-03-03 22:36:37 +0000 | [diff] [blame] | 150 | _Exit(0); // Stop right now, don't perform any at-exit actions. |
Kostya Serebryany | 228d5b1 | 2016-03-01 22:19:21 +0000 | [diff] [blame] | 151 | } |
| 152 | |
Benjamin Kramer | d96b0c1 | 2016-03-18 14:19:19 +0000 | [diff] [blame] | 153 | NO_SANITIZE_MEMORY |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 154 | void Fuzzer::AlarmCallback() { |
Kostya Serebryany | 490bbd6 | 2015-05-19 22:12:57 +0000 | [diff] [blame] | 155 | assert(Options.UnitTimeoutSec > 0); |
Kostya Serebryany | 8b8f7a3 | 2016-05-06 23:38:07 +0000 | [diff] [blame^] | 156 | if (InOOMState) { |
| 157 | Printf("==%d== ERROR: libFuzzer: out-of-memory (used: %zdMb; limit: %zdMb)\n", |
| 158 | GetPid(), GetPeakRSSMb(), Options.RssLimitMb); |
| 159 | Printf(" To change the out-of-memory limit use -rss_limit_mb=<N>\n"); |
| 160 | if (CurrentUnitSize && CurrentUnitData) { |
| 161 | DumpCurrentUnit("oom-"); |
| 162 | if (__sanitizer_print_stack_trace) |
| 163 | __sanitizer_print_stack_trace(); |
| 164 | } |
| 165 | Printf("SUMMARY: libFuzzer: out-of-memory\n"); |
| 166 | PrintFinalStats(); |
| 167 | _Exit(Options.ErrorExitCode); // Stop right now. |
| 168 | } |
| 169 | |
Kostya Serebryany | cfbcf90 | 2016-02-17 19:42:34 +0000 | [diff] [blame] | 170 | if (!CurrentUnitSize) |
| 171 | return; // We have not started running units yet. |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 172 | size_t Seconds = |
| 173 | duration_cast<seconds>(system_clock::now() - UnitStartTime).count(); |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 174 | if (Seconds == 0) |
| 175 | return; |
Kostya Serebryany | 490bbd6 | 2015-05-19 22:12:57 +0000 | [diff] [blame] | 176 | if (Options.Verbosity >= 2) |
Kostya Serebryany | 7c180ea | 2015-05-23 01:22:35 +0000 | [diff] [blame] | 177 | Printf("AlarmCallback %zd\n", Seconds); |
Kostya Serebryany | 490bbd6 | 2015-05-19 22:12:57 +0000 | [diff] [blame] | 178 | if (Seconds >= (size_t)Options.UnitTimeoutSec) { |
Kostya Serebryany | 7c180ea | 2015-05-23 01:22:35 +0000 | [diff] [blame] | 179 | Printf("ALARM: working on the last Unit for %zd seconds\n", Seconds); |
Kostya Serebryany | 316b571 | 2015-05-26 20:57:47 +0000 | [diff] [blame] | 180 | Printf(" and the timeout value is %d (use -timeout=N to change)\n", |
| 181 | Options.UnitTimeoutSec); |
Kostya Serebryany | 228d5b1 | 2016-03-01 22:19:21 +0000 | [diff] [blame] | 182 | DumpCurrentUnit("timeout-"); |
Kostya Serebryany | d6edce9 | 2015-10-16 23:04:31 +0000 | [diff] [blame] | 183 | Printf("==%d== ERROR: libFuzzer: timeout after %d seconds\n", GetPid(), |
| 184 | Seconds); |
| 185 | if (__sanitizer_print_stack_trace) |
| 186 | __sanitizer_print_stack_trace(); |
| 187 | Printf("SUMMARY: libFuzzer: timeout\n"); |
Kostya Serebryany | 66ff075 | 2016-02-26 22:42:23 +0000 | [diff] [blame] | 188 | PrintFinalStats(); |
Kostya Serebryany | 3151673 | 2016-03-24 01:32:08 +0000 | [diff] [blame] | 189 | _Exit(Options.TimeoutExitCode); // Stop right now. |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 190 | } |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 191 | } |
| 192 | |
Kostya Serebryany | 8b8f7a3 | 2016-05-06 23:38:07 +0000 | [diff] [blame^] | 193 | void Fuzzer::RssLimitCallback() { |
| 194 | InOOMState = true; |
| 195 | SignalToMainThread(); |
| 196 | SleepSeconds(5); |
| 197 | Printf("Signal to main thread failed (non-linux?). Exiting.\n"); |
| 198 | _Exit(Options.ErrorExitCode); |
| 199 | return; |
Kostya Serebryany | 52b394e | 2016-05-06 21:58:35 +0000 | [diff] [blame] | 200 | } |
| 201 | |
Kostya Serebryany | 09d2a5f | 2015-10-22 22:56:45 +0000 | [diff] [blame] | 202 | void Fuzzer::PrintStats(const char *Where, const char *End) { |
Kostya Serebryany | 66ff075 | 2016-02-26 22:42:23 +0000 | [diff] [blame] | 203 | size_t ExecPerSec = execPerSec(); |
Mike Aizatsky | a9c2387 | 2015-11-12 04:38:40 +0000 | [diff] [blame] | 204 | if (Options.OutputCSV) { |
| 205 | static bool csvHeaderPrinted = false; |
| 206 | if (!csvHeaderPrinted) { |
| 207 | csvHeaderPrinted = true; |
| 208 | Printf("runs,block_cov,bits,cc_cov,corpus,execs_per_sec,tbms,reason\n"); |
| 209 | } |
Kostya Serebryany | 9ba1918 | 2016-04-25 19:41:45 +0000 | [diff] [blame] | 210 | Printf("%zd,%zd,%zd,%zd,%zd,%zd,%s\n", TotalNumberOfRuns, |
Mike Aizatsky | a9c2387 | 2015-11-12 04:38:40 +0000 | [diff] [blame] | 211 | LastRecordedBlockCoverage, TotalBits(), |
| 212 | LastRecordedCallerCalleeCoverage, Corpus.size(), ExecPerSec, |
Kostya Serebryany | 9ba1918 | 2016-04-25 19:41:45 +0000 | [diff] [blame] | 213 | Where); |
Mike Aizatsky | a9c2387 | 2015-11-12 04:38:40 +0000 | [diff] [blame] | 214 | } |
| 215 | |
| 216 | if (!Options.Verbosity) |
| 217 | return; |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 218 | Printf("#%zd\t%s", TotalNumberOfRuns, Where); |
Kostya Serebryany | 09d2a5f | 2015-10-22 22:56:45 +0000 | [diff] [blame] | 219 | if (LastRecordedBlockCoverage) |
| 220 | Printf(" cov: %zd", LastRecordedBlockCoverage); |
Kostya Serebryany | da63c1d | 2016-02-26 21:33:56 +0000 | [diff] [blame] | 221 | if (LastRecordedPcMapSize) |
| 222 | Printf(" path: %zd", LastRecordedPcMapSize); |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 223 | if (auto TB = TotalBits()) |
| 224 | Printf(" bits: %zd", TB); |
Kostya Serebryany | 2e9fca9 | 2015-10-22 23:55:39 +0000 | [diff] [blame] | 225 | if (LastRecordedCallerCalleeCoverage) |
| 226 | Printf(" indir: %zd", LastRecordedCallerCalleeCoverage); |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 227 | Printf(" units: %zd exec/s: %zd", Corpus.size(), ExecPerSec); |
Kostya Serebryany | 12c7837 | 2015-08-12 01:55:37 +0000 | [diff] [blame] | 228 | Printf("%s", End); |
Kostya Serebryany | 03db8b9 | 2015-03-30 22:44:03 +0000 | [diff] [blame] | 229 | } |
| 230 | |
Kostya Serebryany | 66ff075 | 2016-02-26 22:42:23 +0000 | [diff] [blame] | 231 | void Fuzzer::PrintFinalStats() { |
| 232 | if (!Options.PrintFinalStats) return; |
| 233 | size_t ExecPerSec = execPerSec(); |
| 234 | Printf("stat::number_of_executed_units: %zd\n", TotalNumberOfRuns); |
| 235 | Printf("stat::average_exec_per_sec: %zd\n", ExecPerSec); |
| 236 | Printf("stat::new_units_added: %zd\n", NumberOfNewUnitsAdded); |
| 237 | Printf("stat::slowest_unit_time_sec: %zd\n", TimeOfLongestUnitInSeconds); |
| 238 | Printf("stat::peak_rss_mb: %zd\n", GetPeakRSSMb()); |
| 239 | } |
| 240 | |
Kostya Serebryany | 64d2457 | 2016-03-12 01:57:04 +0000 | [diff] [blame] | 241 | size_t Fuzzer::MaxUnitSizeInCorpus() const { |
| 242 | size_t Res = 0; |
| 243 | for (auto &X : Corpus) |
| 244 | Res = std::max(Res, X.size()); |
| 245 | return Res; |
| 246 | } |
| 247 | |
| 248 | void Fuzzer::SetMaxLen(size_t MaxLen) { |
| 249 | assert(Options.MaxLen == 0); // Can only reset MaxLen from 0 to non-0. |
| 250 | assert(MaxLen); |
| 251 | Options.MaxLen = MaxLen; |
| 252 | Printf("INFO: -max_len is not provided, using %zd\n", Options.MaxLen); |
| 253 | } |
| 254 | |
| 255 | |
| 256 | void Fuzzer::RereadOutputCorpus(size_t MaxSize) { |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 257 | if (Options.OutputCorpus.empty()) |
| 258 | return; |
Kostya Serebryany | 1ac8055 | 2015-05-08 21:30:55 +0000 | [diff] [blame] | 259 | std::vector<Unit> AdditionalCorpus; |
| 260 | ReadDirToVectorOfUnits(Options.OutputCorpus.c_str(), &AdditionalCorpus, |
Kostya Serebryany | 64d2457 | 2016-03-12 01:57:04 +0000 | [diff] [blame] | 261 | &EpochOfLastReadOfOutputCorpus, MaxSize); |
Kostya Serebryany | 1ac8055 | 2015-05-08 21:30:55 +0000 | [diff] [blame] | 262 | if (Corpus.empty()) { |
| 263 | Corpus = AdditionalCorpus; |
| 264 | return; |
| 265 | } |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 266 | if (!Options.Reload) |
| 267 | return; |
Kostya Serebryany | 490bbd6 | 2015-05-19 22:12:57 +0000 | [diff] [blame] | 268 | if (Options.Verbosity >= 2) |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 269 | Printf("Reload: read %zd new units.\n", AdditionalCorpus.size()); |
Kostya Serebryany | 1ac8055 | 2015-05-08 21:30:55 +0000 | [diff] [blame] | 270 | for (auto &X : AdditionalCorpus) { |
Kostya Serebryany | 64d2457 | 2016-03-12 01:57:04 +0000 | [diff] [blame] | 271 | if (X.size() > MaxSize) |
| 272 | X.resize(MaxSize); |
Kostya Serebryany | cbb2334 | 2015-05-19 01:06:07 +0000 | [diff] [blame] | 273 | if (UnitHashesAddedToCorpus.insert(Hash(X)).second) { |
Kostya Serebryany | 98abb2c | 2016-01-13 23:46:01 +0000 | [diff] [blame] | 274 | if (RunOne(X)) { |
Kostya Serebryany | cbb2334 | 2015-05-19 01:06:07 +0000 | [diff] [blame] | 275 | Corpus.push_back(X); |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 276 | UpdateCorpusDistribution(); |
Mike Aizatsky | a9c2387 | 2015-11-12 04:38:40 +0000 | [diff] [blame] | 277 | PrintStats("RELOAD"); |
Kostya Serebryany | cbb2334 | 2015-05-19 01:06:07 +0000 | [diff] [blame] | 278 | } |
Kostya Serebryany | 1ac8055 | 2015-05-08 21:30:55 +0000 | [diff] [blame] | 279 | } |
| 280 | } |
| 281 | } |
| 282 | |
Kostya Serebryany | 945761b | 2016-03-18 00:23:29 +0000 | [diff] [blame] | 283 | void Fuzzer::ShuffleCorpus(UnitVector *V) { |
| 284 | std::random_shuffle(V->begin(), V->end(), MD.GetRand()); |
| 285 | if (Options.PreferSmall) |
| 286 | std::stable_sort(V->begin(), V->end(), [](const Unit &A, const Unit &B) { |
| 287 | return A.size() < B.size(); |
| 288 | }); |
| 289 | } |
| 290 | |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 291 | void Fuzzer::ShuffleAndMinimize() { |
Kostya Serebryany | 09d2a5f | 2015-10-22 22:56:45 +0000 | [diff] [blame] | 292 | PrintStats("READ "); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 293 | std::vector<Unit> NewCorpus; |
Kostya Serebryany | 945761b | 2016-03-18 00:23:29 +0000 | [diff] [blame] | 294 | if (Options.ShuffleAtStartUp) |
| 295 | ShuffleCorpus(&Corpus); |
| 296 | |
| 297 | for (const auto &U : Corpus) { |
| 298 | if (RunOne(U)) { |
| 299 | NewCorpus.push_back(U); |
| 300 | if (Options.Verbosity >= 2) |
| 301 | Printf("NEW0: %zd L %zd\n", LastRecordedBlockCoverage, U.size()); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 302 | } |
| 303 | } |
| 304 | Corpus = NewCorpus; |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 305 | UpdateCorpusDistribution(); |
Kostya Serebryany | cbb2334 | 2015-05-19 01:06:07 +0000 | [diff] [blame] | 306 | for (auto &X : Corpus) |
| 307 | UnitHashesAddedToCorpus.insert(Hash(X)); |
Kostya Serebryany | 09d2a5f | 2015-10-22 22:56:45 +0000 | [diff] [blame] | 308 | PrintStats("INITED"); |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 309 | CheckForMemoryLeaks(); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 310 | } |
| 311 | |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 312 | bool Fuzzer::RunOne(const uint8_t *Data, size_t Size) { |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 313 | TotalNumberOfRuns++; |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 314 | |
| 315 | PrepareCoverageBeforeRun(); |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 316 | ExecuteCallback(Data, Size); |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 317 | bool Res = CheckCoverageAfterRun(); |
| 318 | |
Kostya Serebryany | 16901a9 | 2015-03-30 23:04:35 +0000 | [diff] [blame] | 319 | auto UnitStopTime = system_clock::now(); |
| 320 | auto TimeOfUnit = |
| 321 | duration_cast<seconds>(UnitStopTime - UnitStartTime).count(); |
Mike Aizatsky | a9c2387 | 2015-11-12 04:38:40 +0000 | [diff] [blame] | 322 | if (!(TotalNumberOfRuns & (TotalNumberOfRuns - 1)) && |
| 323 | secondsSinceProcessStartUp() >= 2) |
Kostya Serebryany | 09d2a5f | 2015-10-22 22:56:45 +0000 | [diff] [blame] | 324 | PrintStats("pulse "); |
Kostya Serebryany | 70926ae | 2015-08-05 21:43:48 +0000 | [diff] [blame] | 325 | if (TimeOfUnit > TimeOfLongestUnitInSeconds && |
| 326 | TimeOfUnit >= Options.ReportSlowUnits) { |
Kostya Serebryany | 16901a9 | 2015-03-30 23:04:35 +0000 | [diff] [blame] | 327 | TimeOfLongestUnitInSeconds = TimeOfUnit; |
Kostya Serebryany | 70926ae | 2015-08-05 21:43:48 +0000 | [diff] [blame] | 328 | Printf("Slowest unit: %zd s:\n", TimeOfLongestUnitInSeconds); |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 329 | WriteUnitToFileWithPrefix({Data, Data + Size}, "slow-unit-"); |
Kostya Serebryany | 16901a9 | 2015-03-30 23:04:35 +0000 | [diff] [blame] | 330 | } |
| 331 | return Res; |
Kostya Serebryany | 2c1b33b | 2015-01-29 23:01:07 +0000 | [diff] [blame] | 332 | } |
| 333 | |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 334 | void Fuzzer::RunOneAndUpdateCorpus(uint8_t *Data, size_t Size) { |
Kostya Serebryany | 7d470cf | 2015-05-07 18:32:29 +0000 | [diff] [blame] | 335 | if (TotalNumberOfRuns >= Options.MaxNumberOfRuns) |
| 336 | return; |
Kostya Serebryany | bc7c0ad | 2015-08-11 01:44:42 +0000 | [diff] [blame] | 337 | if (Options.OnlyASCII) |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 338 | ToASCII(Data, Size); |
| 339 | if (RunOne(Data, Size)) |
| 340 | ReportNewCoverage({Data, Data + Size}); |
Kostya Serebryany | 7d470cf | 2015-05-07 18:32:29 +0000 | [diff] [blame] | 341 | } |
| 342 | |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 343 | // Leak detection is expensive, so we first check if there were more mallocs |
| 344 | // than frees (using the sanitizer malloc hooks) and only then try to call lsan. |
| 345 | struct MallocFreeTracer { |
| 346 | void Start() { |
| 347 | Mallocs = 0; |
| 348 | Frees = 0; |
| 349 | } |
| 350 | // Returns true if there were more mallocs than frees. |
| 351 | bool Stop() { return Mallocs > Frees; } |
| 352 | size_t Mallocs; |
| 353 | size_t Frees; |
| 354 | }; |
| 355 | |
| 356 | static thread_local MallocFreeTracer AllocTracer; |
| 357 | |
| 358 | extern "C" { |
| 359 | void __sanitizer_malloc_hook(void *ptr, size_t size) { AllocTracer.Mallocs++; } |
| 360 | void __sanitizer_free_hook(void *ptr) { AllocTracer.Frees++; } |
| 361 | } // extern "C" |
| 362 | |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 363 | void Fuzzer::ExecuteCallback(const uint8_t *Data, size_t Size) { |
Kostya Serebryany | ebb932d | 2016-04-18 22:50:39 +0000 | [diff] [blame] | 364 | UnitStartTime = system_clock::now(); |
Kostya Serebryany | d50a3ee | 2016-01-13 23:02:30 +0000 | [diff] [blame] | 365 | // We copy the contents of Unit into a separate heap buffer |
| 366 | // so that we reliably find buffer overflows in it. |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 367 | std::unique_ptr<uint8_t[]> DataCopy(new uint8_t[Size]); |
| 368 | memcpy(DataCopy.get(), Data, Size); |
| 369 | AssignTaintLabels(DataCopy.get(), Size); |
| 370 | CurrentUnitData = DataCopy.get(); |
| 371 | CurrentUnitSize = Size; |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 372 | AllocTracer.Start(); |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 373 | int Res = CB(DataCopy.get(), Size); |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 374 | (void)Res; |
| 375 | HasMoreMallocsThanFrees = AllocTracer.Stop(); |
Kostya Serebryany | ebb932d | 2016-04-18 22:50:39 +0000 | [diff] [blame] | 376 | CurrentUnitSize = 0; |
| 377 | CurrentUnitData = nullptr; |
Kostya Serebryany | 20bb5e7 | 2015-10-02 23:34:06 +0000 | [diff] [blame] | 378 | assert(Res == 0); |
Kostya Serebryany | 52a788e | 2015-03-31 20:13:20 +0000 | [diff] [blame] | 379 | } |
| 380 | |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 381 | size_t Fuzzer::RecordBlockCoverage() { |
Kostya Serebryany | 5eab74e | 2015-11-09 23:17:45 +0000 | [diff] [blame] | 382 | CHECK_WEAK_API_FUNCTION(__sanitizer_get_total_unique_coverage); |
Mike Aizatsky | 8b11f87 | 2016-01-06 00:21:22 +0000 | [diff] [blame] | 383 | uintptr_t PrevCoverage = LastRecordedBlockCoverage; |
| 384 | LastRecordedBlockCoverage = __sanitizer_get_total_unique_coverage(); |
| 385 | |
| 386 | if (PrevCoverage == LastRecordedBlockCoverage || !Options.PrintNewCovPcs) |
| 387 | return LastRecordedBlockCoverage; |
| 388 | |
| 389 | uintptr_t PrevBufferLen = LastCoveragePcBufferLen; |
| 390 | uintptr_t *CoverageBuf; |
| 391 | LastCoveragePcBufferLen = __sanitizer_get_coverage_pc_buffer(&CoverageBuf); |
| 392 | assert(CoverageBuf); |
| 393 | for (size_t i = PrevBufferLen; i < LastCoveragePcBufferLen; ++i) { |
Mike Aizatsky | e313f8f | 2016-01-21 00:02:09 +0000 | [diff] [blame] | 394 | Printf("%p\n", CoverageBuf[i]); |
Mike Aizatsky | 8b11f87 | 2016-01-06 00:21:22 +0000 | [diff] [blame] | 395 | } |
| 396 | |
| 397 | return LastRecordedBlockCoverage; |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 398 | } |
| 399 | |
Kostya Serebryany | 2e9fca9 | 2015-10-22 23:55:39 +0000 | [diff] [blame] | 400 | size_t Fuzzer::RecordCallerCalleeCoverage() { |
| 401 | if (!Options.UseIndirCalls) |
| 402 | return 0; |
Kostya Serebryany | 94660b3 | 2015-10-23 18:37:58 +0000 | [diff] [blame] | 403 | if (!__sanitizer_get_total_unique_caller_callee_pairs) |
| 404 | return 0; |
Kostya Serebryany | 2e9fca9 | 2015-10-22 23:55:39 +0000 | [diff] [blame] | 405 | return LastRecordedCallerCalleeCoverage = |
| 406 | __sanitizer_get_total_unique_caller_callee_pairs(); |
| 407 | } |
| 408 | |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 409 | void Fuzzer::PrepareCoverageBeforeRun() { |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 410 | if (Options.UseCounters) { |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 411 | size_t NumCounters = __sanitizer_get_number_of_counters(); |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 412 | CounterBitmap.resize(NumCounters); |
| 413 | __sanitizer_update_counter_bitset_and_clear_counters(0); |
| 414 | } |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 415 | RecordBlockCoverage(); |
Kostya Serebryany | 2e9fca9 | 2015-10-22 23:55:39 +0000 | [diff] [blame] | 416 | RecordCallerCalleeCoverage(); |
Kostya Serebryany | 007c9b2 | 2015-10-22 22:50:47 +0000 | [diff] [blame] | 417 | } |
| 418 | |
| 419 | bool Fuzzer::CheckCoverageAfterRun() { |
| 420 | size_t OldCoverage = LastRecordedBlockCoverage; |
| 421 | size_t NewCoverage = RecordBlockCoverage(); |
Kostya Serebryany | 2e9fca9 | 2015-10-22 23:55:39 +0000 | [diff] [blame] | 422 | size_t OldCallerCalleeCoverage = LastRecordedCallerCalleeCoverage; |
| 423 | size_t NewCallerCalleeCoverage = RecordCallerCalleeCoverage(); |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 424 | size_t NumNewBits = 0; |
Kostya Serebryany | da63c1d | 2016-02-26 21:33:56 +0000 | [diff] [blame] | 425 | size_t OldPcMapSize = LastRecordedPcMapSize; |
| 426 | PcMapMergeCurrentToCombined(); |
| 427 | size_t NewPcMapSize = PcMapCombinedSize(); |
| 428 | LastRecordedPcMapSize = NewPcMapSize; |
| 429 | if (NewPcMapSize > OldPcMapSize) |
| 430 | return true; |
Kostya Serebryany | be5e0ed | 2015-03-03 23:27:02 +0000 | [diff] [blame] | 431 | if (Options.UseCounters) |
| 432 | NumNewBits = __sanitizer_update_counter_bitset_and_clear_counters( |
| 433 | CounterBitmap.data()); |
Kostya Serebryany | 2e9fca9 | 2015-10-22 23:55:39 +0000 | [diff] [blame] | 434 | return NewCoverage > OldCoverage || |
| 435 | NewCallerCalleeCoverage > OldCallerCalleeCoverage || NumNewBits; |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 436 | } |
| 437 | |
| 438 | void Fuzzer::WriteToOutputCorpus(const Unit &U) { |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 439 | if (Options.OutputCorpus.empty()) |
| 440 | return; |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 441 | std::string Path = DirPlusFile(Options.OutputCorpus, Hash(U)); |
| 442 | WriteToFile(U, Path); |
| 443 | if (Options.Verbosity >= 2) |
Kostya Serebryany | 7c180ea | 2015-05-23 01:22:35 +0000 | [diff] [blame] | 444 | Printf("Written to %s\n", Path.c_str()); |
Kostya Serebryany | a9346c2 | 2015-09-02 19:08:08 +0000 | [diff] [blame] | 445 | assert(!Options.OnlyASCII || IsASCII(U)); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 446 | } |
| 447 | |
Kostya Serebryany | 2b7d2e9 | 2015-07-23 18:37:22 +0000 | [diff] [blame] | 448 | void Fuzzer::WriteUnitToFileWithPrefix(const Unit &U, const char *Prefix) { |
Kostya Serebryany | b91c62b | 2015-10-16 22:41:47 +0000 | [diff] [blame] | 449 | if (!Options.SaveArtifacts) |
| 450 | return; |
Kostya Serebryany | bd5d1cd | 2015-10-09 03:57:59 +0000 | [diff] [blame] | 451 | std::string Path = Options.ArtifactPrefix + Prefix + Hash(U); |
Kostya Serebryany | 2d0ef14 | 2015-11-25 21:40:46 +0000 | [diff] [blame] | 452 | if (!Options.ExactArtifactPath.empty()) |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 453 | Path = Options.ExactArtifactPath; // Overrides ArtifactPrefix. |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 454 | WriteToFile(U, Path); |
Kostya Serebryany | bd5d1cd | 2015-10-09 03:57:59 +0000 | [diff] [blame] | 455 | Printf("artifact_prefix='%s'; Test unit written to %s\n", |
| 456 | Options.ArtifactPrefix.c_str(), Path.c_str()); |
Kostya Serebryany | 9e48cda | 2015-12-04 22:29:39 +0000 | [diff] [blame] | 457 | if (U.size() <= kMaxUnitSizeToPrint) |
| 458 | Printf("Base64: %s\n", Base64(U).c_str()); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 459 | } |
| 460 | |
| 461 | void Fuzzer::SaveCorpus() { |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 462 | if (Options.OutputCorpus.empty()) |
| 463 | return; |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 464 | for (const auto &U : Corpus) |
| 465 | WriteToFile(U, DirPlusFile(Options.OutputCorpus, Hash(U))); |
| 466 | if (Options.Verbosity) |
Kostya Serebryany | 7c180ea | 2015-05-23 01:22:35 +0000 | [diff] [blame] | 467 | Printf("Written corpus of %zd files to %s\n", Corpus.size(), |
| 468 | Options.OutputCorpus.c_str()); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 469 | } |
| 470 | |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 471 | void Fuzzer::PrintStatusForNewUnit(const Unit &U) { |
| 472 | if (!Options.PrintNEW) |
| 473 | return; |
Kostya Serebryany | 09d2a5f | 2015-10-22 22:56:45 +0000 | [diff] [blame] | 474 | PrintStats("NEW ", ""); |
Kostya Serebryany | 7d470cf | 2015-05-07 18:32:29 +0000 | [diff] [blame] | 475 | if (Options.Verbosity) { |
Kostya Serebryany | 14c5028 | 2015-12-19 01:09:49 +0000 | [diff] [blame] | 476 | Printf(" L: %zd ", U.size()); |
Kostya Serebryany | 7ec0c56 | 2016-02-13 03:25:16 +0000 | [diff] [blame] | 477 | MD.PrintMutationSequence(); |
Kostya Serebryany | 7c180ea | 2015-05-23 01:22:35 +0000 | [diff] [blame] | 478 | Printf("\n"); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 479 | } |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 480 | } |
| 481 | |
| 482 | void Fuzzer::ReportNewCoverage(const Unit &U) { |
| 483 | Corpus.push_back(U); |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 484 | UpdateCorpusDistribution(); |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 485 | UnitHashesAddedToCorpus.insert(Hash(U)); |
Kostya Serebryany | 7ec0c56 | 2016-02-13 03:25:16 +0000 | [diff] [blame] | 486 | MD.RecordSuccessfulMutationSequence(); |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 487 | PrintStatusForNewUnit(U); |
Kostya Serebryany | 7d470cf | 2015-05-07 18:32:29 +0000 | [diff] [blame] | 488 | WriteToOutputCorpus(U); |
Kostya Serebryany | 66ff075 | 2016-02-26 22:42:23 +0000 | [diff] [blame] | 489 | NumberOfNewUnitsAdded++; |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 490 | } |
| 491 | |
Kostya Serebryany | 945761b | 2016-03-18 00:23:29 +0000 | [diff] [blame] | 492 | // Finds minimal number of units in 'Extra' that add coverage to 'Initial'. |
| 493 | // We do it by actually executing the units, sometimes more than once, |
| 494 | // because we may be using different coverage-like signals and the only |
| 495 | // common thing between them is that we can say "this unit found new stuff". |
| 496 | UnitVector Fuzzer::FindExtraUnits(const UnitVector &Initial, |
| 497 | const UnitVector &Extra) { |
| 498 | UnitVector Res = Extra; |
| 499 | size_t OldSize = Res.size(); |
| 500 | for (int Iter = 0; Iter < 10; Iter++) { |
| 501 | ShuffleCorpus(&Res); |
| 502 | ResetCoverage(); |
| 503 | |
| 504 | for (auto &U : Initial) |
| 505 | RunOne(U); |
| 506 | |
| 507 | Corpus.clear(); |
| 508 | for (auto &U : Res) |
| 509 | if (RunOne(U)) |
| 510 | Corpus.push_back(U); |
| 511 | |
| 512 | char Stat[7] = "MIN "; |
| 513 | Stat[3] = '0' + Iter; |
| 514 | PrintStats(Stat); |
| 515 | |
| 516 | size_t NewSize = Corpus.size(); |
| 517 | Res.swap(Corpus); |
| 518 | |
| 519 | if (NewSize == OldSize) |
| 520 | break; |
| 521 | OldSize = NewSize; |
| 522 | } |
| 523 | return Res; |
| 524 | } |
| 525 | |
Kostya Serebryany | 9cc3b0d | 2015-10-24 01:16:40 +0000 | [diff] [blame] | 526 | void Fuzzer::Merge(const std::vector<std::string> &Corpora) { |
| 527 | if (Corpora.size() <= 1) { |
| 528 | Printf("Merge requires two or more corpus dirs\n"); |
| 529 | return; |
| 530 | } |
Kostya Serebryany | 9cc3b0d | 2015-10-24 01:16:40 +0000 | [diff] [blame] | 531 | std::vector<std::string> ExtraCorpora(Corpora.begin() + 1, Corpora.end()); |
| 532 | |
Kostya Serebryany | 945761b | 2016-03-18 00:23:29 +0000 | [diff] [blame] | 533 | assert(Options.MaxLen > 0); |
| 534 | UnitVector Initial, Extra; |
| 535 | ReadDirToVectorOfUnits(Corpora[0].c_str(), &Initial, nullptr, Options.MaxLen); |
| 536 | for (auto &C : ExtraCorpora) |
| 537 | ReadDirToVectorOfUnits(C.c_str(), &Extra, nullptr, Options.MaxLen); |
| 538 | |
| 539 | if (!Initial.empty()) { |
| 540 | Printf("=== Minimizing the initial corpus of %zd units\n", Initial.size()); |
| 541 | Initial = FindExtraUnits({}, Initial); |
Kostya Serebryany | 9cc3b0d | 2015-10-24 01:16:40 +0000 | [diff] [blame] | 542 | } |
Kostya Serebryany | 945761b | 2016-03-18 00:23:29 +0000 | [diff] [blame] | 543 | |
| 544 | Printf("=== Merging extra %zd units\n", Extra.size()); |
| 545 | auto Res = FindExtraUnits(Initial, Extra); |
| 546 | |
| 547 | for (auto &U: Res) |
| 548 | WriteToOutputCorpus(U); |
| 549 | |
| 550 | Printf("=== Merge: written %zd units\n", Res.size()); |
Kostya Serebryany | 9cc3b0d | 2015-10-24 01:16:40 +0000 | [diff] [blame] | 551 | } |
| 552 | |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 553 | // Tries to call lsan, and if there are leaks exits. We call this right after |
| 554 | // the initial corpus was read because if there are leaky inputs in the corpus |
| 555 | // further fuzzing will likely hit OOMs. |
| 556 | void Fuzzer::CheckForMemoryLeaks() { |
| 557 | if (!Options.DetectLeaks) return; |
| 558 | if (!__lsan_do_recoverable_leak_check) |
| 559 | return; |
| 560 | if (__lsan_do_recoverable_leak_check()) { |
| 561 | Printf("==%d== ERROR: libFuzzer: initial corpus triggers memory leaks.\n" |
| 562 | "Exiting now. Use -detect_leaks=0 to disable leak detection here.\n" |
| 563 | "LeakSanitizer will still check for leaks at the process exit.\n", |
| 564 | GetPid()); |
| 565 | PrintFinalStats(); |
| 566 | _Exit(Options.ErrorExitCode); |
| 567 | } |
| 568 | } |
| 569 | |
| 570 | // Tries detecting a memory leak on the particular input that we have just |
| 571 | // executed before calling this function. |
| 572 | void Fuzzer::TryDetectingAMemoryLeak(uint8_t *Data, size_t Size) { |
| 573 | if (!HasMoreMallocsThanFrees) return; // mallocs==frees, a leak is unlikely. |
| 574 | if (!Options.DetectLeaks) return; |
| 575 | if (!&__lsan_enable || !&__lsan_disable || !__lsan_do_recoverable_leak_check) |
| 576 | return; // No lsan. |
| 577 | // Run the target once again, but with lsan disabled so that if there is |
| 578 | // a real leak we do not report it twice. |
| 579 | __lsan_disable(); |
| 580 | RunOneAndUpdateCorpus(Data, Size); |
| 581 | __lsan_enable(); |
| 582 | if (!HasMoreMallocsThanFrees) return; // a leak is unlikely. |
Kostya Serebryany | 7018a1a | 2016-04-27 19:52:34 +0000 | [diff] [blame] | 583 | if (NumberOfLeakDetectionAttempts++ > 1000) { |
| 584 | Options.DetectLeaks = false; |
| 585 | Printf("INFO: libFuzzer disabled leak detection after every mutation.\n" |
| 586 | " Most likely the target function accumulates allocated\n" |
| 587 | " memory in a global state w/o actually leaking it.\n" |
| 588 | " If LeakSanitizer is enabled in this process it will still\n" |
| 589 | " run on the process shutdown.\n"); |
| 590 | return; |
| 591 | } |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 592 | // Now perform the actual lsan pass. This is expensive and we must ensure |
| 593 | // we don't call it too often. |
| 594 | if (__lsan_do_recoverable_leak_check()) { // Leak is found, report it. |
| 595 | CurrentUnitData = Data; |
| 596 | CurrentUnitSize = Size; |
| 597 | DumpCurrentUnit("leak-"); |
| 598 | PrintFinalStats(); |
| 599 | _Exit(Options.ErrorExitCode); // not exit() to disable lsan further on. |
| 600 | } |
| 601 | } |
| 602 | |
Kostya Serebryany | 27ab2d7 | 2015-12-19 02:49:09 +0000 | [diff] [blame] | 603 | void Fuzzer::MutateAndTestOne() { |
Kostya Serebryany | 7ec0c56 | 2016-02-13 03:25:16 +0000 | [diff] [blame] | 604 | MD.StartMutationSequence(); |
Kostya Serebryany | 27ab2d7 | 2015-12-19 02:49:09 +0000 | [diff] [blame] | 605 | |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 606 | auto &U = ChooseUnitToMutate(); |
| 607 | MutateInPlaceHere.resize(Options.MaxLen); |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 608 | size_t Size = U.size(); |
Mike Aizatsky | 94e2966 | 2016-04-08 23:32:24 +0000 | [diff] [blame] | 609 | assert(Size <= Options.MaxLen && "Oversized Unit"); |
| 610 | memcpy(MutateInPlaceHere.data(), U.data(), Size); |
Kostya Serebryany | 27ab2d7 | 2015-12-19 02:49:09 +0000 | [diff] [blame] | 611 | |
Kostya Serebryany | 7d470cf | 2015-05-07 18:32:29 +0000 | [diff] [blame] | 612 | for (int i = 0; i < Options.MutateDepth; i++) { |
Kostya Serebryany | 22cc5e2 | 2016-02-13 02:29:38 +0000 | [diff] [blame] | 613 | size_t NewSize = 0; |
| 614 | if (LLVMFuzzerCustomMutator) |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 615 | NewSize = LLVMFuzzerCustomMutator(MutateInPlaceHere.data(), Size, |
| 616 | Options.MaxLen, MD.GetRand().Rand()); |
Kostya Serebryany | 22cc5e2 | 2016-02-13 02:29:38 +0000 | [diff] [blame] | 617 | else |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 618 | NewSize = MD.Mutate(MutateInPlaceHere.data(), Size, Options.MaxLen); |
Kostya Serebryany | 2ea204e | 2015-05-30 17:33:13 +0000 | [diff] [blame] | 619 | assert(NewSize > 0 && "Mutator returned empty unit"); |
Kostya Serebryany | 64d2457 | 2016-03-12 01:57:04 +0000 | [diff] [blame] | 620 | assert(NewSize <= Options.MaxLen && |
Kostya Serebryany | 2ea204e | 2015-05-30 17:33:13 +0000 | [diff] [blame] | 621 | "Mutator return overisized unit"); |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 622 | Size = NewSize; |
Kostya Serebryany | b65805a | 2016-01-09 03:08:58 +0000 | [diff] [blame] | 623 | if (i == 0) |
| 624 | StartTraceRecording(); |
Kostya Serebryany | 8a5bef0 | 2016-02-13 17:56:51 +0000 | [diff] [blame] | 625 | RunOneAndUpdateCorpus(MutateInPlaceHere.data(), Size); |
Kostya Serebryany | b65805a | 2016-01-09 03:08:58 +0000 | [diff] [blame] | 626 | StopTraceRecording(); |
Kostya Serebryany | 1bfd583 | 2016-04-20 00:24:21 +0000 | [diff] [blame] | 627 | TryDetectingAMemoryLeak(MutateInPlaceHere.data(), Size); |
Kostya Serebryany | 7d470cf | 2015-05-07 18:32:29 +0000 | [diff] [blame] | 628 | } |
| 629 | } |
| 630 | |
Kostya Serebryany | e692621 | 2015-11-04 23:22:25 +0000 | [diff] [blame] | 631 | // Returns an index of random unit from the corpus to mutate. |
| 632 | // Hypothesis: units added to the corpus last are more likely to be interesting. |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 633 | // This function gives more weight to the more recent units. |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 634 | size_t Fuzzer::ChooseUnitIdxToMutate() { |
Kostya Serebryany | 7ec0c56 | 2016-02-13 03:25:16 +0000 | [diff] [blame] | 635 | size_t Idx = |
| 636 | static_cast<size_t>(CorpusDistribution(MD.GetRand().Get_mt19937())); |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 637 | assert(Idx < Corpus.size()); |
| 638 | return Idx; |
Kostya Serebryany | e692621 | 2015-11-04 23:22:25 +0000 | [diff] [blame] | 639 | } |
| 640 | |
Kostya Serebryany | 945761b | 2016-03-18 00:23:29 +0000 | [diff] [blame] | 641 | void Fuzzer::ResetCoverage() { |
| 642 | CHECK_WEAK_API_FUNCTION(__sanitizer_reset_coverage); |
| 643 | __sanitizer_reset_coverage(); |
| 644 | CounterBitmap.clear(); |
| 645 | } |
| 646 | |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 647 | // Experimental search heuristic: drilling. |
| 648 | // - Read, shuffle, execute and minimize the corpus. |
| 649 | // - Choose one random unit. |
| 650 | // - Reset the coverage. |
| 651 | // - Start fuzzing as if the chosen unit was the only element of the corpus. |
| 652 | // - When done, reset the coverage again. |
| 653 | // - Merge the newly created corpus into the original one. |
| 654 | void Fuzzer::Drill() { |
| 655 | // The corpus is already read, shuffled, and minimized. |
| 656 | assert(!Corpus.empty()); |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 657 | Options.PrintNEW = false; // Don't print NEW status lines when drilling. |
Kostya Serebryany | 7d21166 | 2015-09-04 00:12:11 +0000 | [diff] [blame] | 658 | |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 659 | Unit U = ChooseUnitToMutate(); |
| 660 | |
Kostya Serebryany | 945761b | 2016-03-18 00:23:29 +0000 | [diff] [blame] | 661 | ResetCoverage(); |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 662 | |
| 663 | std::vector<Unit> SavedCorpus; |
| 664 | SavedCorpus.swap(Corpus); |
| 665 | Corpus.push_back(U); |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 666 | UpdateCorpusDistribution(); |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 667 | assert(Corpus.size() == 1); |
| 668 | RunOne(U); |
| 669 | PrintStats("DRILL "); |
| 670 | std::string SavedOutputCorpusPath; // Don't write new units while drilling. |
| 671 | SavedOutputCorpusPath.swap(Options.OutputCorpus); |
| 672 | Loop(); |
| 673 | |
Kostya Serebryany | 945761b | 2016-03-18 00:23:29 +0000 | [diff] [blame] | 674 | ResetCoverage(); |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 675 | |
| 676 | PrintStats("REINIT"); |
| 677 | SavedOutputCorpusPath.swap(Options.OutputCorpus); |
Kostya Serebryany | 98abb2c | 2016-01-13 23:46:01 +0000 | [diff] [blame] | 678 | for (auto &U : SavedCorpus) |
Kostya Serebryany | dc3135d | 2015-11-12 01:02:01 +0000 | [diff] [blame] | 679 | RunOne(U); |
| 680 | PrintStats("MERGE "); |
| 681 | Options.PrintNEW = true; |
| 682 | size_t NumMerged = 0; |
| 683 | for (auto &U : Corpus) { |
| 684 | if (RunOne(U)) { |
| 685 | PrintStatusForNewUnit(U); |
| 686 | NumMerged++; |
| 687 | WriteToOutputCorpus(U); |
| 688 | } |
| 689 | } |
| 690 | PrintStats("MERGED"); |
| 691 | if (NumMerged && Options.Verbosity) |
| 692 | Printf("Drilling discovered %zd new units\n", NumMerged); |
| 693 | } |
| 694 | |
| 695 | void Fuzzer::Loop() { |
Kostya Serebryany | 8617aaa | 2015-12-05 02:09:22 +0000 | [diff] [blame] | 696 | system_clock::time_point LastCorpusReload = system_clock::now(); |
Kostya Serebryany | 27ab2d7 | 2015-12-19 02:49:09 +0000 | [diff] [blame] | 697 | if (Options.DoCrossOver) |
Kostya Serebryany | 7ec0c56 | 2016-02-13 03:25:16 +0000 | [diff] [blame] | 698 | MD.SetCorpus(&Corpus); |
Kostya Serebryany | 468ed78 | 2015-09-08 17:30:35 +0000 | [diff] [blame] | 699 | while (true) { |
Kostya Serebryany | 8617aaa | 2015-12-05 02:09:22 +0000 | [diff] [blame] | 700 | auto Now = system_clock::now(); |
| 701 | if (duration_cast<seconds>(Now - LastCorpusReload).count()) { |
Kostya Serebryany | 64d2457 | 2016-03-12 01:57:04 +0000 | [diff] [blame] | 702 | RereadOutputCorpus(Options.MaxLen); |
Kostya Serebryany | 8617aaa | 2015-12-05 02:09:22 +0000 | [diff] [blame] | 703 | LastCorpusReload = Now; |
| 704 | } |
Kostya Serebryany | e692621 | 2015-11-04 23:22:25 +0000 | [diff] [blame] | 705 | if (TotalNumberOfRuns >= Options.MaxNumberOfRuns) |
Mike Aizatsky | a9c2387 | 2015-11-12 04:38:40 +0000 | [diff] [blame] | 706 | break; |
Kostya Serebryany | e692621 | 2015-11-04 23:22:25 +0000 | [diff] [blame] | 707 | if (Options.MaxTotalTimeSec > 0 && |
| 708 | secondsSinceProcessStartUp() > |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 709 | static_cast<size_t>(Options.MaxTotalTimeSec)) |
Mike Aizatsky | a9c2387 | 2015-11-12 04:38:40 +0000 | [diff] [blame] | 710 | break; |
Kostya Serebryany | e692621 | 2015-11-04 23:22:25 +0000 | [diff] [blame] | 711 | // Perform several mutations and runs. |
Kostya Serebryany | 27ab2d7 | 2015-12-19 02:49:09 +0000 | [diff] [blame] | 712 | MutateAndTestOne(); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 713 | } |
Mike Aizatsky | a9c2387 | 2015-11-12 04:38:40 +0000 | [diff] [blame] | 714 | |
| 715 | PrintStats("DONE ", "\n"); |
Kostya Serebryany | 7ec0c56 | 2016-02-13 03:25:16 +0000 | [diff] [blame] | 716 | MD.PrintRecommendedDictionary(); |
Aaron Ballman | ef11698 | 2015-01-29 16:58:29 +0000 | [diff] [blame] | 717 | } |
| 718 | |
Ivan Krasin | df91910 | 2016-01-22 22:28:27 +0000 | [diff] [blame] | 719 | void Fuzzer::UpdateCorpusDistribution() { |
| 720 | size_t N = Corpus.size(); |
| 721 | std::vector<double> Intervals(N + 1); |
| 722 | std::vector<double> Weights(N); |
| 723 | std::iota(Intervals.begin(), Intervals.end(), 0); |
| 724 | std::iota(Weights.begin(), Weights.end(), 1); |
| 725 | CorpusDistribution = std::piecewise_constant_distribution<double>( |
| 726 | Intervals.begin(), Intervals.end(), Weights.begin()); |
| 727 | } |
| 728 | |
| 729 | } // namespace fuzzer |