[libFuzzer] Diff 5 - Split FuzzerExtFunction implementation for Linux, Apple and Windows.

[mpividori]

Summary

Implement external functions for Windows using weak symbols with alias.

[zturner]

This one looks fine, but since I'm not sure which CLs depend on which other CLs, to avoid weird merge conflicts I will wait until the first ones go in before submitting this.

[kcc]

lib/Fuzzer/CMakeLists.txt

15–16

do you have to change the file names?
We've spent quite some time with the Apple folks bike-shedding about these names...

[mpividori]

lib/Fuzzer/CMakeLists.txt

15–16

@kcc We have 3 different implementations, one for Windows, one for Apple and one for Linux. So I thought it would be sensible to name the files this way. What would you suggest?

[kcc]

Look at it from another side.
What if we decide to switch Linux implementation to use dlsym?
Or what if we port to FreeBSD, where "weak" works equally well.

My suggestion is to not rename the existing files and to call the new file
FuzzerExtFunctionsWindows.cpp or FuzzerExtFunctionsWeakAlias.cpp

[mpividori]

@kcc Yes, I agree. I will change that. Thanks

[mpividori]

Done.

[kcc]

lib/Fuzzer/FuzzerCorpus.h

17

is this a related change?

lib/Fuzzer/FuzzerExtFunctionsDlsym.cpp

17

do you need this change here?

lib/Fuzzer/FuzzerExtFunctionsWeak.cpp

16

do you need this change here?

lib/Fuzzer/FuzzerExtFunctionsWeakAlias.cpp

9

Implementation using weak aliases. Works for Windows.

[mpividori]

lib/Fuzzer/FuzzerCorpus.h

17

That header is required to include std::iota() declaration, in Windows. It is a detail, if you prefer, I can add that line in a different diff.
I apologize for these unrelated "details". This is the result of splitting a previous diff into many diffs.
Now that I understand how the review system works, I will be more careful with future diffs.

lib/Fuzzer/FuzzerExtFunctionsDlsym.cpp

17

@kcc Yes, it is needed to use the Printf() function.

lib/Fuzzer/FuzzerExtFunctionsWeak.cpp

16

@kcc I remove an empty line, so the 3 files FuzzerExtFunctions*.cpp have the same format. If you prefer, I can remove that change.

lib/Fuzzer/FuzzerExtFunctionsWeakAlias.cpp

9

@kcc Ok, I will add that comment.

[mpividori]

+ Remove unrelated changes.

[kcc]

LGTM

lib/Fuzzer/CMakeLists.txt

 set(LIBFUZZER_FLAGS_BASE "${CMAKE_CXX_FLAGS}")
 # Disable the coverage and sanitizer instrumentation for the fuzzer itself.
 set(CMAKE_CXX_FLAGS "${LIBFUZZER_FLAGS_BASE} -fno-sanitize=all -fno-sanitize-coverage=edge,trace-cmp,indirect-calls,8bit-counters -Werror")
 if( LLVM_USE_SANITIZE_COVERAGE )
   if(NOT "${LLVM_USE_SANITIZER}" STREQUAL "Address")
     message(FATAL_ERROR
       "LibFuzzer and its tests require LLVM_USE_SANITIZER=Address and "
       "LLVM_USE_SANITIZE_COVERAGE=YES to be set."
       )
   endif()
   add_library(LLVMFuzzerNoMainObjects OBJECT
     FuzzerCrossOver.cpp
     FuzzerDriver.cpp
     FuzzerExtFunctionsDlsym.cpp
     FuzzerExtFunctionsWeak.cpp
+    FuzzerExtFunctionsWeakAlias.cpp
     FuzzerIO.cpp
     FuzzerIOPosix.cpp
     FuzzerIOWindows.cpp
     FuzzerLoop.cpp
     FuzzerMutate.cpp
     FuzzerSHA1.cpp
     FuzzerTracePC.cpp
     FuzzerTraceState.cpp

lib/Fuzzer/FuzzerCorpus.h

 //===- FuzzerCorpus.h - Internal header for the Fuzzer ----------*- C++ -* ===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 // fuzzer::InputCorpus
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_FUZZER_CORPUS
 #define LLVM_FUZZER_CORPUS
 
 #include <random>
 #include <unordered_set>
+#include <numeric>
 
 #include "FuzzerDefs.h"
 #include "FuzzerIO.h"
 #include "FuzzerRandom.h"
 #include "FuzzerSHA1.h"
 #include "FuzzerTracePC.h"
 
 namespace fuzzer {

lib/Fuzzer/FuzzerExtFunctionsDlsym.cpp

 //===- FuzzerExtFunctionsDlsym.cpp - Interface to external functions ------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 // Implementation for operating systems that support dlsym(). We only use it on
 // Apple platforms for now. We don't use this approach on Linux because it
 // requires that clients of LibFuzzer pass ``--export-dynamic`` to the linker.
 // That is a complication we don't wish to expose to clients right now.
 //===----------------------------------------------------------------------===//
 #include "FuzzerDefs.h"
 #if LIBFUZZER_APPLE
-
 #include "FuzzerExtFunctions.h"
+#include "FuzzerIO.h"
 #include <dlfcn.h>
 
 using namespace fuzzer;
 
 template <typename T>
 static T GetFnPtr(const char *FnName, bool WarnIfMissing) {
   dlerror(); // Clear any previous errors.
   void *Fn = dlsym(RTLD_DEFAULT, FnName);

lib/Fuzzer/FuzzerExtFunctionsWeak.cpp

-//===- FuzzerExtFunctionsWeak.cpp - Interface to external functions -------===//
+//===- FuzzerExtFunctionsWeak.cpp - Interface to external functions ------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 // Implementation for Linux. This relies on the linker's support for weak
 // symbols. We don't use this approach on Apple platforms because it requires
 // clients of LibFuzzer to pass ``-U _<symbol_name>`` to the linker to allow
 // weak symbols to be undefined. That is a complication we don't want to expose
 // to clients right now.
 //===----------------------------------------------------------------------===//
 #include "FuzzerDefs.h"
 #if LIBFUZZER_LINUX
-
 #include "FuzzerExtFunctions.h"
 #include "FuzzerIO.h"
 
 extern "C" {
 // Declare these symbols as weak to allow them to be optionally defined.
 #define EXT_FUNC(NAME, RETURN_TYPE, FUNC_SIG, WARN)                            \
   __attribute__((weak)) RETURN_TYPE NAME FUNC_SIG
 

lib/Fuzzer/FuzzerExtFunctionsWeakAlias.cpp

+//===- FuzzerExtFunctionsWeakAlias.cpp - Interface to external functions ----===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+// Implementation for Windows.
+//===----------------------------------------------------------------------===//
+#include "FuzzerDefs.h"
+#if LIBFUZZER_WINDOWS
+#include "FuzzerExtFunctions.h"
+#include "FuzzerIO.h"
+
+using namespace fuzzer;
+
+extern "C" {
+// Declare these symbols as weak to allow them to be optionally defined.
+#define EXT_FUNC(NAME, RETURN_TYPE, FUNC_SIG, WARN)                            \
+  RETURN_TYPE NAME ## Def FUNC_SIG {                                           \
+    Printf("ERROR: Function \"%s\" not defined.\n", #NAME);                    \
+    exit(1);                                                                   \
+  }                                                                            \
+  RETURN_TYPE NAME FUNC_SIG __attribute__ ((weak, alias (#NAME "Def")));
+
+#include "FuzzerExtFunctions.def"
+
+#undef EXT_FUNC
+}
+
+template <typename T>
+static T* GetFnPtr(T *Fun, T *FunDef, const char *FnName, bool WarnIfMissing) {
+  if (Fun == FunDef) {
+    if (WarnIfMissing)
+      Printf("WARNING: Failed to find function \"%s\".\n", FnName);
+    return nullptr;
+  }
+  return Fun;
+}
+
+namespace fuzzer {
+
+ExternalFunctions::ExternalFunctions() {
+#define EXT_FUNC(NAME, RETURN_TYPE, FUNC_SIG, WARN)                            \
+  this->NAME = GetFnPtr<decltype(::NAME)>(::NAME, ::NAME ## Def, #NAME, WARN);
+
+#include "FuzzerExtFunctions.def"
+
+#undef EXT_FUNC
+}
+} // namespace fuzzer
+#endif // LIBFUZZER_WINDOWS