Merge pull request #624 from lifting-bits/will/cmake-fixes

CMake fixes

Author: Ninja3047

CMakeLists.txt

@@ -36,8 +36,24 @@ message(STATUS "Compiler ID is ${CMAKE_C_COMPILER_ID}")
 # libraries
 #
 
+# Z3
+find_package(Z3 CONFIG REQUIRED)
+
 # LLVM
 find_package(LLVM CONFIG REQUIRED)
+llvm_map_components_to_libnames(llvm_libs
+  support core irreader
+  bitreader bitwriter
+  passes asmprinter
+  aarch64codegen aarch64asmparser
+  armcodegen armasmparser
+  interpreter mcjit
+  nvptxdesc
+  x86codegen x86asmparser
+  sparccodegen sparcasmparser
+  webassemblydesc)
+message(STATUS "LLVM Libraries: ${llvm_libs}")
+
 message(STATUS "Found LLVM ${LLVM_PACKAGE_VERSION}")
 message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
 
@@ -60,66 +76,16 @@ set(REMILL_BUILD_SEMANTICS_DIR_SPARC64 "${CMAKE_CURRENT_BINARY_DIR}/lib/Arch/SPA
 set(REMILL_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include")
 set(REMILL_LIB_DIR "${CMAKE_CURRENT_SOURCE_DIR}/lib")
 
-add_library(thirdparty_llvm INTERFACE)
-target_include_directories(thirdparty_llvm SYSTEM INTERFACE
-  $<BUILD_INTERFACE:${LLVM_INCLUDE_DIRS}>
-)
-target_compile_definitions(thirdparty_llvm INTERFACE
-  ${LLVM_DEFINITIONS}
-)
 include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/BCCompiler.cmake")
 
-# Go find only the static libraries of LLVM, and link against those.
-foreach(LLVM_LIB IN LISTS LLVM_AVAILABLE_LIBS)
-  get_target_property(LLVM_LIB_TYPE ${LLVM_LIB} TYPE)
-
-  if(LLVM_LIB_TYPE STREQUAL "STATIC_LIBRARY")
-    list(APPEND LLVM_LIBRARIES "${LLVM_LIB}")
-  endif()
-endforeach()
-
-# These are out-of-order in `LLVM_AVAILABLE_LIBS` and should always be last.
-list(REMOVE_ITEM LLVM_LIBRARIES LLVMMC LLVMCore LLVMSupport)
-list(APPEND LLVM_LIBRARIES LLVMMC LLVMCore LLVMSupport)
-
-target_link_libraries(thirdparty_llvm INTERFACE
-  ${LLVM_LIBRARIES}
-)
-
-# Microsoft Z3 with LLVM. Not exactly used in remill, but LLVM doesn't link
-# against it correctly
-# NOTE: If changing this, also replicate in remillConfig file
-if(LLVM_WITH_Z3)
-  find_package(Z3 CONFIG REQUIRED 4.7.1)
-  get_target_property(LLVMSupport_LIBS LLVMSupport INTERFACE_LINK_LIBRARIES)
-  list(REMOVE_ITEM LLVMSupport_LIBS Z3)
-  list(APPEND LLVMSupport_LIBS z3::libz3)
-  set_target_properties(LLVMSupport PROPERTIES
-    INTERFACE_LINK_LIBRARIES "${LLVMSupport_LIBS}")
-endif()
-
-message(STATUS "LLVM Libraries: ${LLVM_LIBRARIES}")
-
 # Intel XED
 find_package(XED CONFIG REQUIRED)
-add_library(thirdparty_xed INTERFACE)
-target_link_libraries(thirdparty_xed INTERFACE
-  XED::XED
-)
 
 # Google glog module
 find_package(glog CONFIG REQUIRED)
-add_library(thirdparty_glog INTERFACE)
-target_link_libraries(thirdparty_glog INTERFACE
-  glog::glog
-)
 
 # Google gflags
 find_package(gflags CONFIG REQUIRED)
-add_library(thirdparty_gflags INTERFACE)
-target_link_libraries(thirdparty_gflags INTERFACE
-  gflags
-)
 
 set(sleigh_ENABLE_TESTS OFF)
 set(sleigh_ADDITIONAL_PATCHES "${CMAKE_CURRENT_SOURCE_DIR}/patches/sleigh/x86-ia.patch;${CMAKE_CURRENT_SOURCE_DIR}/patches/sleigh/arm-thumb.patch" CACHE STRING "" FORCE)
@@ -134,22 +100,6 @@ set(sleigh_BUILD_SUPPORT ON CACHE BOOL "" FORCE)
 set(sleigh_BUILD_SLEIGHSPECS ON CACHE BOOL "" FORCE)
 FetchContent_MakeAvailable(sleigh)
 
-add_library(thirdparty_sleigh INTERFACE)
-target_link_libraries(thirdparty_sleigh INTERFACE
-  sleigh::sla
-  sleigh::decomp
-  sleigh::support
-)
-
-# Windows SDK
-add_library(thirdparty_win32 INTERFACE)
-
-if(DEFINED WIN32)
-  target_link_libraries(thirdparty_win32 INTERFACE
-    "Kernel32.lib"
-  )
-endif()
-
 # For Linux builds, group LLVM libraries into a single group
 # that avoids frustrating library ordering issues.
 if(UNIX AND NOT APPLE)
@@ -255,9 +205,14 @@ target_compile_definitions(remill_settings INTERFACE
   "REMILL_BUILD_SEMANTICS_DIR_SPARC64=\"${REMILL_BUILD_SEMANTICS_DIR_SPARC64}\""
 )
 
-set(THIRDPARTY_LIBRARY_LIST thirdparty_llvm thirdparty_xed thirdparty_glog thirdparty_gflags thirdparty_sleigh)
 target_link_libraries(remill_settings INTERFACE
-  ${THIRDPARTY_LIBRARY_LIST}
+  ${llvm_libs}
+  XED::XED
+  glog::glog
+  gflags::gflags
+  sleigh::sla
+  sleigh::decomp
+  sleigh::support
 )
 
 add_subdirectory(lib/Arch)
@@ -268,7 +223,13 @@ add_subdirectory(lib/Version)
 add_library(remill INTERFACE)
 target_link_libraries(remill INTERFACE
   ${LINKER_START_GROUP}
-  ${THIRDPARTY_LIBRARY_LIST}
+  ${llvm_libs}
+  XED::XED
+  glog::glog
+  gflags::gflags
+  sleigh::sla
+  sleigh::decomp
+  sleigh::support
   remill_bc
   remill_os
   remill_arch
@@ -286,28 +247,6 @@ InstallExternalTarget("ext_clang" "${CLANG_PATH}" "BIN" "${INSTALLED_CLANG_NAME}
 
 InstallExternalTarget("ext_llvmlink" "${LLVMLINK_PATH}" "BIN" "${INSTALLED_LLVMLINK_NAME}")
 
-GetTargetTree(THIRDPARTY_LIBRARIES ${THIRDPARTY_LIBRARY_LIST})
-GetPublicIncludeFolders(THIRDPARTY_INCLUDE_DIRECTORIES ${THIRDPARTY_LIBRARIES})
-
-foreach(THIRDPARTY_LIB IN LISTS THIRDPARTY_LIBRARIES)
-  string(SUBSTRING "${THIRDPARTY_LIB}" 0 1 THIRDPARTY_LIB_PREFIX)
-
-  if(TARGET ${THIRDPARTY_LIB})
-    get_target_property(THIRDPARTY_LIB_TYPE ${THIRDPARTY_LIB} TYPE)
-
-    if(THIRDPARTY_LIB_TYPE STREQUAL "STATIC_LIBRARY" OR THIRDPARTY_LIB_TYPE STREQUAL "SHARED_LIBRARY")
-      list(APPEND THIRDPARTY_LIBRARY_FILES "$${}<TARGET_FILE:${THIRDPARTY_LIB}>")
-    endif()
-  elseif("${THIRDPARTY_LIB_PREFIX}" STREQUAL "$${}")
-  # E.g. $<LINK_ONLY:...>
-  else()
-    list(APPEND THIRDPARTY_LIBRARY_FILES "${THIRDPARTY_LIB}")
-  endif()
-endforeach()
-
-list(REMOVE_DUPLICATES THIRDPARTY_LIBRARY_FILES)
-
-#
 # additional targets
 #
 add_custom_target(semantics)
@@ -321,11 +260,10 @@ add_subdirectory(bin)
 if(REMILL_ENABLE_INSTALL_TARGET)
   install(TARGETS remill EXPORT remillTargets)
 
-  install(TARGETS remill_settings ${THIRDPARTY_LIBRARY_LIST}
+  install(TARGETS remill_settings
     EXPORT remillTargets
   )
 
-  # First do the basic substitutions.
   configure_file(
     "${CMAKE_CURRENT_SOURCE_DIR}/cmake/remillConfig.cmake.in"
     "${CMAKE_CURRENT_BINARY_DIR}/remillConfig.cmake"

bin/differential_tester_x86/CMakeLists.txt

@@ -24,12 +24,12 @@ target_link_libraries(
   lift-and-compare
   PRIVATE
   remill
-  thirdparty_glog
+  glog::glog
   test-runner
 )
 
 set_property(TARGET lift-and-compare PROPERTY ENABLE_EXPORTS ON)
 set_property(TARGET lift-and-compare PROPERTY POSITION_INDEPENDENT_CODE ON)
 enable_testing()
 
-add_test(NAME "small_diff_test" COMMAND "${Python_EXECUTABLE}" ${REMILL_SOURCE_DIR}/scripts/diff_tester_export_insns/diff_tester_export_insns/ci_runner.py --required_success_rate 1.0 --difftester_bin ${CMAKE_BINARY_DIR}/bin/differential_tester_x86/lift-and-compare --workdir ${CMAKE_BINARY_DIR} ${REMILL_SOURCE_DIR}/bin/differential_tester_x86/data/small_test/ --whitelist_file ${REMILL_SOURCE_DIR}/bin/differential_tester_x86/whitelist.json)
+add_test(NAME "small_diff_test" COMMAND "${Python_EXECUTABLE}" ${REMILL_SOURCE_DIR}/scripts/diff_tester_export_insns/diff_tester_export_insns/ci_runner.py --required_success_rate 1.0 --difftester_bin ${CMAKE_BINARY_DIR}/bin/differential_tester_x86/lift-and-compare --workdir ${CMAKE_BINARY_DIR} ${REMILL_SOURCE_DIR}/bin/differential_tester_x86/data/small_test/ --whitelist_file ${REMILL_SOURCE_DIR}/bin/differential_tester_x86/whitelist.json)

cmake/git_watcher.cmake

@@ -1,5 +1,5 @@
 # git_watcher.cmake
-# https://github.com/andrew-hardin/cmake-git-version-tracking/blob/20c58d5d08bad70550d969b478943c962faa6264/git_watcher.cmake
+# https://raw.githubusercontent.com/andrew-hardin/cmake-git-version-tracking/master/git_watcher.cmake
 #
 # Released under the MIT License.
 # https://raw.githubusercontent.com/andrew-hardin/cmake-git-version-tracking/master/LICENSE
@@ -27,6 +27,15 @@
 #   -- The path to the git executable. It'll automatically be set if the
 #      user doesn't supply a path.
 #
+#   GIT_FAIL_IF_NONZERO_EXIT (OPTIONAL)
+#   -- Raise a FATAL_ERROR if any of the git commands return a non-zero
+#      exit code. This is set to TRUE by default. You can set this to FALSE
+#      if you'd like the build to continue even if a git command fails.
+#
+#   GIT_IGNORE_UNTRACKED (OPTIONAL)
+#   -- Ignore the presence of untracked files when detecting if the
+#      working tree is dirty. This is set to FALSE by default.
+#
 # DESIGN
 #   - This script was designed similar to a Python application
 #     with a Main() function. I wanted to keep it compact to
@@ -57,17 +66,25 @@ macro(CHECK_REQUIRED_VARIABLE var_name)
 endmacro()
 
 # Check that an optional variable is set, or, set it to a default value.
-macro(CHECK_OPTIONAL_VARIABLE var_name default_value)
+macro(CHECK_OPTIONAL_VARIABLE_NOPATH var_name default_value)
     if(NOT DEFINED ${var_name})
         set(${var_name} ${default_value})
     endif()
+endmacro()
+
+# Check that an optional variable is set, or, set it to a default value.
+# Also converts that path to an abspath.
+macro(CHECK_OPTIONAL_VARIABLE var_name default_value)
+    CHECK_OPTIONAL_VARIABLE_NOPATH(${var_name} ${default_value})
     PATH_TO_ABSOLUTE(${var_name})
 endmacro()
 
 CHECK_REQUIRED_VARIABLE(PRE_CONFIGURE_FILE)
 CHECK_REQUIRED_VARIABLE(POST_CONFIGURE_FILE)
-CHECK_OPTIONAL_VARIABLE(GIT_STATE_FILE "${CMAKE_BINARY_DIR}/git-state-hash")
+CHECK_OPTIONAL_VARIABLE(GIT_STATE_FILE "${CMAKE_CURRENT_BINARY_DIR}/git-state-hash")
 CHECK_OPTIONAL_VARIABLE(GIT_WORKING_DIR "${CMAKE_SOURCE_DIR}")
+CHECK_OPTIONAL_VARIABLE_NOPATH(GIT_FAIL_IF_NONZERO_EXIT TRUE)
+CHECK_OPTIONAL_VARIABLE_NOPATH(GIT_IGNORE_UNTRACKED FALSE)
 
 # Check the optional git variable.
 # If it's not set, we'll try to find it using the CMake packaging system.
@@ -86,7 +103,8 @@ set(_state_variable_names
     GIT_COMMIT_DATE_ISO8601
     GIT_COMMIT_SUBJECT
     GIT_COMMIT_BODY
-    VERSION_STRING
+    GIT_DESCRIBE
+    GIT_BRANCH
     # >>>
     # 1. Add the name of the additional git variable you're interested in monitoring
     #    to this list.
@@ -96,17 +114,30 @@ set(_state_variable_names
 
 # Macro: RunGitCommand
 # Description: short-hand macro for calling a git function. Outputs are the
-#              "exit_code" and "output" variables.
+#              "exit_code" and "output" variables. The "_permit_git_failure"
+#              variable can locally override the exit code checking- use it
+#              with caution.
 macro(RunGitCommand)
     execute_process(COMMAND
         "${GIT_EXECUTABLE}" ${ARGV}
         WORKING_DIRECTORY "${_working_dir}"
         RESULT_VARIABLE exit_code
         OUTPUT_VARIABLE output
-        ERROR_QUIET
+        ERROR_VARIABLE stderr
         OUTPUT_STRIP_TRAILING_WHITESPACE)
-    if(NOT exit_code EQUAL 0)
+    if(NOT exit_code EQUAL 0 AND NOT _permit_git_failure)
         set(ENV{GIT_RETRIEVED_STATE} "false")
+
+        # Issue 26: git info not properly set
+        #
+        # Check if we should fail if any of the exit codes are non-zero.
+        # Most methods have a fall-back default value that's used in case of non-zero
+        # exit codes. If you're feeling risky, disable this safety check and use
+        # those default values.
+        if(GIT_FAIL_IF_NONZERO_EXIT )
+            string(REPLACE ";" " " args_with_spaces "${ARGV}")
+            message(FATAL_ERROR "${stderr} (${GIT_EXECUTABLE} ${args_with_spaces})")
+        endif()
     endif()
 endmacro()
 
@@ -123,7 +154,12 @@ function(GetGitState _working_dir)
     set(ENV{GIT_RETRIEVED_STATE} "true")
 
     # Get whether or not the working tree is dirty.
-    RunGitCommand(status --porcelain)
+    if (GIT_IGNORE_UNTRACKED)
+        set(untracked_flag "-uno")
+    else()
+        set(untracked_flag "-unormal")
+    endif()
+    RunGitCommand(status --porcelain ${untracked_flag})
     if(NOT exit_code EQUAL 0)
         set(ENV{GIT_IS_DIRTY} "false")
     else()
@@ -158,6 +194,8 @@ function(GetGitState _working_dir)
 
     RunGitCommand(show -s "--format=%s" ${object})
     if(exit_code EQUAL 0)
+        # Escape \
+        string(REPLACE "\\" "\\\\" output "${output}")
         # Escape quotes
         string(REPLACE "\"" "\\\"" output "${output}")
         set(ENV{GIT_COMMIT_SUBJECT} "${output}")
@@ -166,6 +204,8 @@ function(GetGitState _working_dir)
     RunGitCommand(show -s "--format=%b" ${object})
     if(exit_code EQUAL 0)
         if(output)
+            # Escape \
+            string(REPLACE "\\" "\\\\" output "${output}")
             # Escape quotes
             string(REPLACE "\"" "\\\"" output "${output}")
             # Escape line breaks in the commit message.
@@ -178,9 +218,9 @@ function(GetGitState _working_dir)
             # There was no commit body - set the safe string to empty.
             set(safe "")
         endif()
-        set(ENV{GIT_COMMIT_BODY} "\"${safe}\"")
+        set(ENV{GIT_COMMIT_BODY} "${safe}")
     else()
-        set(ENV{GIT_COMMIT_BODY} "\"\"") # empty string.
+        set(ENV{GIT_COMMIT_BODY} "") # empty string.
     endif()
 
     # Get output of git describe
@@ -191,20 +231,23 @@ function(GetGitState _working_dir)
         set(ENV{GIT_DESCRIBE} "${output}")
     endif()
 
+    # Convert HEAD to a symbolic ref. This can fail, in which case we just
+    # set that variable to HEAD.
+    set(_permit_git_failure ON)
+    RunGitCommand(symbolic-ref --short -q ${object})
+    unset(_permit_git_failure)
+    if(NOT exit_code EQUAL 0)
+        set(ENV{GIT_BRANCH} "${object}")
+    else()
+        set(ENV{GIT_BRANCH} "${output}")
+    endif()
+
     # >>>
     # 2. Additional git properties can be added here via the
     #    "execute_process()" command. Be sure to set them in
     #    the environment using the same variable name you added
     #    to the "_state_variable_names" list.
 
-    if(EXISTS "${GIT_WORKING_DIR}/VERSION")
-      file(READ "${GIT_WORKING_DIR}/VERSION" version_output_raw)
-      string(STRIP "${version_output_raw}" version_output)
-      set(ENV{VERSION_STRING} "${version_output}")
-    else()
-      set(ENV{VERSION_STRING} "")
-    endif()
-
 endfunction()
 
 
@@ -296,6 +339,8 @@ function(SetupGitMonitoring)
             -DGIT_STATE_FILE=${GIT_STATE_FILE}
             -DPRE_CONFIGURE_FILE=${PRE_CONFIGURE_FILE}
             -DPOST_CONFIGURE_FILE=${POST_CONFIGURE_FILE}
+            -DGIT_FAIL_IF_NONZERO_EXIT=${GIT_FAIL_IF_NONZERO_EXIT}
+            -DGIT_IGNORE_UNTRACKED=${GIT_IGNORE_UNTRACKED}
             -P "${CMAKE_CURRENT_LIST_FILE}")
 endfunction()