From 1a3900e81ea3e5993040700eedacf1416904d0b7 Mon Sep 17 00:00:00 2001 From: Zachary Turner Date: Wed, 30 Nov 2016 19:06:14 +0000 Subject: [PATCH] [LibFuzzer] Split up some functions among different headers. In an effort to get libfuzzer working on Windows, we need to make a distinction between what functions require platform specific code (e.g. different code on Windows vs Linux) and what code doesn't. IO functions, for example, tend to be platform specific. This patch separates out some of the functions which will need to have platform specific implementations into different headers, so that we can then provide different implementations for each platform. Aside from that, this patch contains no functional change. It is purely a re-organization. Patch by Marcos Pividori Differential Revision: https://reviews.llvm.org/D27230 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@288264 91177308-0d34-0410-b5e6-96231b3b80d8 --- lib/Fuzzer/FuzzerCorpus.h | 2 + lib/Fuzzer/FuzzerDefs.h | 58 +----------------------- lib/Fuzzer/FuzzerDictionary.h | 5 ++- lib/Fuzzer/FuzzerDriver.cpp | 1 + lib/Fuzzer/FuzzerExtFunctionsWeak.cpp | 1 + lib/Fuzzer/FuzzerIO.cpp | 3 +- lib/Fuzzer/FuzzerIO.h | 47 +++++++++++++++++++ lib/Fuzzer/FuzzerInternal.h | 1 + lib/Fuzzer/FuzzerLoop.cpp | 7 +-- lib/Fuzzer/FuzzerMutate.cpp | 3 +- lib/Fuzzer/FuzzerSHA1.cpp | 22 ++++++++- lib/Fuzzer/FuzzerSHA1.h | 31 +++++++++++++ lib/Fuzzer/FuzzerTracePC.cpp | 8 ++-- lib/Fuzzer/FuzzerTraceState.cpp | 6 +-- lib/Fuzzer/FuzzerUtil.cpp | 15 +------ lib/Fuzzer/FuzzerUtil.h | 65 +++++++++++++++++++++++++++ lib/Fuzzer/FuzzerUtilDarwin.cpp | 1 + lib/Fuzzer/FuzzerUtilLinux.cpp | 2 +- 18 files changed, 191 insertions(+), 87 deletions(-) create mode 100644 lib/Fuzzer/FuzzerIO.h create mode 100644 lib/Fuzzer/FuzzerSHA1.h create mode 100644 lib/Fuzzer/FuzzerUtil.h diff --git a/lib/Fuzzer/FuzzerCorpus.h b/lib/Fuzzer/FuzzerCorpus.h index 355c242e1f4..bbe192f53f8 100644 --- a/lib/Fuzzer/FuzzerCorpus.h +++ b/lib/Fuzzer/FuzzerCorpus.h @@ -16,7 +16,9 @@ #include #include "FuzzerDefs.h" +#include "FuzzerIO.h" #include "FuzzerRandom.h" +#include "FuzzerSHA1.h" #include "FuzzerTracePC.h" namespace fuzzer { diff --git a/lib/Fuzzer/FuzzerDefs.h b/lib/Fuzzer/FuzzerDefs.h index 13aa212c96c..89d675ac1a4 100644 --- a/lib/Fuzzer/FuzzerDefs.h +++ b/lib/Fuzzer/FuzzerDefs.h @@ -63,64 +63,8 @@ extern ExternalFunctions *EF; typedef std::vector Unit; typedef std::vector UnitVector; typedef int (*UserCallback)(const uint8_t *Data, size_t Size); -int FuzzerDriver(int *argc, char ***argv, UserCallback Callback); - -bool IsFile(const std::string &Path); -long GetEpoch(const std::string &Path); -std::string FileToString(const std::string &Path); -Unit FileToVector(const std::string &Path, size_t MaxSize = 0, - bool ExitOnError = true); -void ReadDirToVectorOfUnits(const char *Path, std::vector *V, - long *Epoch, size_t MaxSize, bool ExitOnError); -void WriteToFile(const Unit &U, const std::string &Path); -void CopyFileToErr(const std::string &Path); -void DeleteFile(const std::string &Path); -// Returns "Dir/FileName" or equivalent for the current OS. -std::string DirPlusFile(const std::string &DirPath, - const std::string &FileName); - -void DupAndCloseStderr(); -void CloseStdout(); -void Printf(const char *Fmt, ...); -void PrintHexArray(const Unit &U, const char *PrintAfter = ""); -void PrintHexArray(const uint8_t *Data, size_t Size, - const char *PrintAfter = ""); -void PrintASCII(const uint8_t *Data, size_t Size, const char *PrintAfter = ""); -void PrintASCII(const Unit &U, const char *PrintAfter = ""); - -void PrintPC(const char *SymbolizedFMT, const char *FallbackFMT, uintptr_t PC); -std::string DescribePC(const char *SymbolizedFMT, uintptr_t PC); -std::string Hash(const Unit &U); -void SetTimer(int Seconds); -void SetSigSegvHandler(); -void SetSigBusHandler(); -void SetSigAbrtHandler(); -void SetSigIllHandler(); -void SetSigFpeHandler(); -void SetSigIntHandler(); -void SetSigTermHandler(); -std::string Base64(const Unit &U); -int ExecuteCommand(const std::string &Command); -bool ExecuteCommandAndReadOutput(const std::string &Command, std::string *Out); - -size_t GetPeakRSSMb(); - -// Private copy of SHA1 implementation. -static const int kSHA1NumBytes = 20; -// Computes SHA1 hash of 'Len' bytes in 'Data', writes kSHA1NumBytes to 'Out'. -void ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out); -std::string Sha1ToString(const uint8_t Sha1[kSHA1NumBytes]); - -// Changes U to contain only ASCII (isprint+isspace) characters. -// Returns true iff U has been changed. -bool ToASCII(uint8_t *Data, size_t Size); -bool IsASCII(const Unit &U); -bool IsASCII(const uint8_t *Data, size_t Size); - -int NumberOfCpuCores(); -int GetPid(); -void SleepSeconds(int Seconds); +int FuzzerDriver(int *argc, char ***argv, UserCallback Callback); struct ScopedDoingMyOwnMemmem { ScopedDoingMyOwnMemmem(); diff --git a/lib/Fuzzer/FuzzerDictionary.h b/lib/Fuzzer/FuzzerDictionary.h index c009838ced6..b23b4b022e3 100644 --- a/lib/Fuzzer/FuzzerDictionary.h +++ b/lib/Fuzzer/FuzzerDictionary.h @@ -12,11 +12,12 @@ #ifndef LLVM_FUZZER_DICTIONARY_H #define LLVM_FUZZER_DICTIONARY_H +#include "FuzzerDefs.h" +#include "FuzzerIO.h" +#include "FuzzerUtil.h" #include #include -#include "FuzzerDefs.h" - namespace fuzzer { // A simple POD sized array of bytes. template class FixedWord { diff --git a/lib/Fuzzer/FuzzerDriver.cpp b/lib/Fuzzer/FuzzerDriver.cpp index abf0597e0d3..ab1fdf76ebf 100644 --- a/lib/Fuzzer/FuzzerDriver.cpp +++ b/lib/Fuzzer/FuzzerDriver.cpp @@ -12,6 +12,7 @@ #include "FuzzerCorpus.h" #include "FuzzerInterface.h" #include "FuzzerInternal.h" +#include "FuzzerIO.h" #include "FuzzerMutate.h" #include "FuzzerRandom.h" diff --git a/lib/Fuzzer/FuzzerExtFunctionsWeak.cpp b/lib/Fuzzer/FuzzerExtFunctionsWeak.cpp index cd4371ad44f..cb3b31105d5 100644 --- a/lib/Fuzzer/FuzzerExtFunctionsWeak.cpp +++ b/lib/Fuzzer/FuzzerExtFunctionsWeak.cpp @@ -16,6 +16,7 @@ #if LIBFUZZER_LINUX #include "FuzzerExtFunctions.h" +#include "FuzzerIO.h" extern "C" { // Declare these symbols as weak to allow them to be optionally defined. diff --git a/lib/Fuzzer/FuzzerIO.cpp b/lib/Fuzzer/FuzzerIO.cpp index a70af886c2b..6cc8a8e0fd5 100644 --- a/lib/Fuzzer/FuzzerIO.cpp +++ b/lib/Fuzzer/FuzzerIO.cpp @@ -8,8 +8,9 @@ //===----------------------------------------------------------------------===// // IO functions. //===----------------------------------------------------------------------===// -#include "FuzzerExtFunctions.h" +#include "FuzzerIO.h" #include "FuzzerDefs.h" +#include "FuzzerExtFunctions.h" #include #include #include diff --git a/lib/Fuzzer/FuzzerIO.h b/lib/Fuzzer/FuzzerIO.h new file mode 100644 index 00000000000..e3d22ad9c9a --- /dev/null +++ b/lib/Fuzzer/FuzzerIO.h @@ -0,0 +1,47 @@ +//===- FuzzerIO.h - Internal header for IO utils ----------------*- C++ -* ===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// IO interface. +//===----------------------------------------------------------------------===// +#ifndef LLVM_FUZZER_IO_H +#define LLVM_FUZZER_IO_H + +#include "FuzzerDefs.h" + +namespace fuzzer { + +bool IsFile(const std::string &Path); + +long GetEpoch(const std::string &Path); + +Unit FileToVector(const std::string &Path, size_t MaxSize = 0, + bool ExitOnError = true); + +void DeleteFile(const std::string &Path); + +std::string FileToString(const std::string &Path); + +void CopyFileToErr(const std::string &Path); + +void WriteToFile(const Unit &U, const std::string &Path); + +void ReadDirToVectorOfUnits(const char *Path, std::vector *V, + long *Epoch, size_t MaxSize, bool ExitOnError); + +// Returns "Dir/FileName" or equivalent for the current OS. +std::string DirPlusFile(const std::string &DirPath, + const std::string &FileName); + +void DupAndCloseStderr(); + +void CloseStdout(); + +void Printf(const char *Fmt, ...); + +} // namespace fuzzer +#endif // LLVM_FUZZER_IO_H diff --git a/lib/Fuzzer/FuzzerInternal.h b/lib/Fuzzer/FuzzerInternal.h index 1b491eaafc5..02e806c65a3 100644 --- a/lib/Fuzzer/FuzzerInternal.h +++ b/lib/Fuzzer/FuzzerInternal.h @@ -23,6 +23,7 @@ #include "FuzzerExtFunctions.h" #include "FuzzerInterface.h" #include "FuzzerOptions.h" +#include "FuzzerSHA1.h" #include "FuzzerValueBitMap.h" namespace fuzzer { diff --git a/lib/Fuzzer/FuzzerLoop.cpp b/lib/Fuzzer/FuzzerLoop.cpp index 0d2a38b6a85..63cb5c8bf1b 100644 --- a/lib/Fuzzer/FuzzerLoop.cpp +++ b/lib/Fuzzer/FuzzerLoop.cpp @@ -9,16 +9,17 @@ // Fuzzer's main loop. //===----------------------------------------------------------------------===// -#include "FuzzerInternal.h" #include "FuzzerCorpus.h" +#include "FuzzerInternal.h" +#include "FuzzerIO.h" #include "FuzzerMutate.h" -#include "FuzzerTracePC.h" #include "FuzzerRandom.h" +#include "FuzzerTracePC.h" #include #include -#include #include +#include #if defined(__has_include) #if __has_include() diff --git a/lib/Fuzzer/FuzzerMutate.cpp b/lib/Fuzzer/FuzzerMutate.cpp index 0109f5104fe..eaef1bb494a 100644 --- a/lib/Fuzzer/FuzzerMutate.cpp +++ b/lib/Fuzzer/FuzzerMutate.cpp @@ -9,11 +9,10 @@ // Mutate a test input. //===----------------------------------------------------------------------===// -#include - #include "FuzzerCorpus.h" #include "FuzzerDefs.h" #include "FuzzerExtFunctions.h" +#include "FuzzerIO.h" #include "FuzzerMutate.h" #include "FuzzerOptions.h" diff --git a/lib/Fuzzer/FuzzerSHA1.cpp b/lib/Fuzzer/FuzzerSHA1.cpp index cab81a404db..d2f8e811bbf 100644 --- a/lib/Fuzzer/FuzzerSHA1.cpp +++ b/lib/Fuzzer/FuzzerSHA1.cpp @@ -16,12 +16,15 @@ // For the same reason we do not want to depend on SHA1 from LLVM tree. //===----------------------------------------------------------------------===// +#include "FuzzerSHA1.h" #include "FuzzerDefs.h" /* This code is public-domain - it is based on libcrypt * placed in the public domain by Wei Dai and other contributors. */ +#include +#include #include #include @@ -193,10 +196,27 @@ uint8_t* sha1_result(sha1nfo *s) { } // namespace; Added for LibFuzzer +namespace fuzzer { + // The rest is added for LibFuzzer -void fuzzer::ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out) { +void ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out) { sha1nfo s; sha1_init(&s); sha1_write(&s, (const char*)Data, Len); memcpy(Out, sha1_result(&s), HASH_LENGTH); } + +std::string Sha1ToString(const uint8_t Sha1[kSHA1NumBytes]) { + std::stringstream SS; + for (int i = 0; i < kSHA1NumBytes; i++) + SS << std::hex << std::setfill('0') << std::setw(2) << (unsigned)Sha1[i]; + return SS.str(); +} + +std::string Hash(const Unit &U) { + uint8_t Hash[kSHA1NumBytes]; + ComputeSHA1(U.data(), U.size(), Hash); + return Sha1ToString(Hash); +} + +} diff --git a/lib/Fuzzer/FuzzerSHA1.h b/lib/Fuzzer/FuzzerSHA1.h new file mode 100644 index 00000000000..b3e6111b474 --- /dev/null +++ b/lib/Fuzzer/FuzzerSHA1.h @@ -0,0 +1,31 @@ +//===- FuzzerSHA1.h - Internal header for the SHA1 utils --------*- C++ -* ===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// SHA1 utils. +//===----------------------------------------------------------------------===// +#ifndef LLVM_FUZZER_SHA1_H +#define LLVM_FUZZER_SHA1_H + +#include "FuzzerDefs.h" +#include +#include + +namespace fuzzer { + +// Private copy of SHA1 implementation. +static const int kSHA1NumBytes = 20; + +// Computes SHA1 hash of 'Len' bytes in 'Data', writes kSHA1NumBytes to 'Out'. +void ComputeSHA1(const uint8_t *Data, size_t Len, uint8_t *Out); + +std::string Sha1ToString(const uint8_t Sha1[kSHA1NumBytes]); + +std::string Hash(const Unit &U); + +} // namespace fuzzer +#endif // LLVM_FUZZER_SHA1_H diff --git a/lib/Fuzzer/FuzzerTracePC.cpp b/lib/Fuzzer/FuzzerTracePC.cpp index f85b150a000..eabf0d087f4 100644 --- a/lib/Fuzzer/FuzzerTracePC.cpp +++ b/lib/Fuzzer/FuzzerTracePC.cpp @@ -12,16 +12,16 @@ // //===----------------------------------------------------------------------===// -#include -#include -#include - #include "FuzzerCorpus.h" #include "FuzzerDefs.h" #include "FuzzerDictionary.h" #include "FuzzerExtFunctions.h" +#include "FuzzerIO.h" #include "FuzzerTracePC.h" #include "FuzzerValueBitMap.h" +#include +#include +#include namespace fuzzer { diff --git a/lib/Fuzzer/FuzzerTraceState.cpp b/lib/Fuzzer/FuzzerTraceState.cpp index 9cccfcbc26f..a920f57c4e2 100644 --- a/lib/Fuzzer/FuzzerTraceState.cpp +++ b/lib/Fuzzer/FuzzerTraceState.cpp @@ -9,17 +9,17 @@ // Data tracing. //===----------------------------------------------------------------------===// -#include "FuzzerInternal.h" #include "FuzzerDictionary.h" +#include "FuzzerInternal.h" +#include "FuzzerIO.h" #include "FuzzerMutate.h" #include "FuzzerRandom.h" #include "FuzzerTracePC.h" - #include #include -#include #include #include +#include namespace fuzzer { diff --git a/lib/Fuzzer/FuzzerUtil.cpp b/lib/Fuzzer/FuzzerUtil.cpp index d845333a169..579c4f83a87 100644 --- a/lib/Fuzzer/FuzzerUtil.cpp +++ b/lib/Fuzzer/FuzzerUtil.cpp @@ -9,7 +9,9 @@ // Misc utils. //===----------------------------------------------------------------------===// +#include "FuzzerUtil.h" #include "FuzzerInternal.h" +#include "FuzzerIO.h" #include #include #include @@ -60,19 +62,6 @@ void PrintASCII(const Unit &U, const char *PrintAfter) { PrintASCII(U.data(), U.size(), PrintAfter); } -std::string Sha1ToString(const uint8_t Sha1[kSHA1NumBytes]) { - std::stringstream SS; - for (int i = 0; i < kSHA1NumBytes; i++) - SS << std::hex << std::setfill('0') << std::setw(2) << (unsigned)Sha1[i]; - return SS.str(); -} - -std::string Hash(const Unit &U) { - uint8_t Hash[kSHA1NumBytes]; - ComputeSHA1(U.data(), U.size(), Hash); - return Sha1ToString(Hash); -} - static void AlarmHandler(int, siginfo_t *, void *) { Fuzzer::StaticAlarmCallback(); } diff --git a/lib/Fuzzer/FuzzerUtil.h b/lib/Fuzzer/FuzzerUtil.h new file mode 100644 index 00000000000..97271b99307 --- /dev/null +++ b/lib/Fuzzer/FuzzerUtil.h @@ -0,0 +1,65 @@ +//===- FuzzerUtil.h - Internal header for the Fuzzer Utils ------*- C++ -* ===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// Util functions. +//===----------------------------------------------------------------------===// +#ifndef LLVM_FUZZER_UTIL_H +#define LLVM_FUZZER_UTIL_H + +#include "FuzzerDefs.h" + +namespace fuzzer { + +void PrintHexArray(const Unit &U, const char *PrintAfter = ""); + +void PrintHexArray(const uint8_t *Data, size_t Size, + const char *PrintAfter = ""); + +void PrintASCII(const uint8_t *Data, size_t Size, const char *PrintAfter = ""); + +void PrintASCII(const Unit &U, const char *PrintAfter = ""); + +// Changes U to contain only ASCII (isprint+isspace) characters. +// Returns true iff U has been changed. +bool ToASCII(uint8_t *Data, size_t Size); + +bool IsASCII(const Unit &U); + +bool IsASCII(const uint8_t *Data, size_t Size); + +std::string Base64(const Unit &U); + +void PrintPC(const char *SymbolizedFMT, const char *FallbackFMT, uintptr_t PC); + +std::string DescribePC(const char *SymbolizedFMT, uintptr_t PC); + +int NumberOfCpuCores(); + +// Platform specific functions. +void SetTimer(int Seconds); + +void SetSigSegvHandler(); +void SetSigBusHandler(); +void SetSigAbrtHandler(); +void SetSigIllHandler(); +void SetSigFpeHandler(); +void SetSigIntHandler(); +void SetSigTermHandler(); + +void SleepSeconds(int Seconds); + +int GetPid(); + +size_t GetPeakRSSMb(); + +bool ExecuteCommandAndReadOutput(const std::string &Command, std::string *Out); + +int ExecuteCommand(const std::string &Command); + +} // namespace fuzzer +#endif // LLVM_FUZZER_UTIL_H diff --git a/lib/Fuzzer/FuzzerUtilDarwin.cpp b/lib/Fuzzer/FuzzerUtilDarwin.cpp index 4c90998c897..62f0f2271fe 100644 --- a/lib/Fuzzer/FuzzerUtilDarwin.cpp +++ b/lib/Fuzzer/FuzzerUtilDarwin.cpp @@ -10,6 +10,7 @@ //===----------------------------------------------------------------------===// #include "FuzzerDefs.h" #if LIBFUZZER_APPLE +#include "FuzzerIO.h" #include #include #include diff --git a/lib/Fuzzer/FuzzerUtilLinux.cpp b/lib/Fuzzer/FuzzerUtilLinux.cpp index e63c7d9a07f..060cec04542 100644 --- a/lib/Fuzzer/FuzzerUtilLinux.cpp +++ b/lib/Fuzzer/FuzzerUtilLinux.cpp @@ -1,4 +1,4 @@ -//===- FuzzerUtilLinux.cpp - Misc utils -----------------------------------===// +//===- FuzzerUtilLinux.cpp - Misc utils for Linux. ------------------------===// // // The LLVM Compiler Infrastructure // -- 2.50.1