lifting-bits
diff --git a/‎.github/actions/prepare_git_user/action.yml‎
Lines changed: 10 additions & 0 deletions b/‎.github/actions/prepare_git_user/action.yml‎
Lines changed: 10 additions & 0 deletions
diff --git a/‎.github/workflows/ci.yml‎
Lines changed: 11 additions & 0 deletions b/‎.github/workflows/ci.yml‎
Lines changed: 11 additions & 0 deletions
diff --git a/‎.gitignore‎
Lines changed: 0 additions & 1 deletion b/‎.gitignore‎
Lines changed: 0 additions & 1 deletion
diff --git a/‎CMakeLists.txt‎
Lines changed: 42 additions & 16 deletions b/‎CMakeLists.txt‎
Lines changed: 42 additions & 16 deletions
diff --git a/‎Dockerfile‎
Lines changed: 8 additions & 3 deletions b/‎Dockerfile‎
Lines changed: 8 additions & 3 deletions
diff --git a/‎bin/CMakeLists.txt‎
Lines changed: 5 additions & 2 deletions b/‎bin/CMakeLists.txt‎
Lines changed: 5 additions & 2 deletions
diff --git a/‎bin/differential_tester_x86/CMakeLists.txt‎
Lines changed: 35 additions & 0 deletions b/‎bin/differential_tester_x86/CMakeLists.txt‎
Lines changed: 35 additions & 0 deletions
@@ -0,0 +1,10 @@
+name: 'Setup Git User for Applying Patches'
+description: 'Setup bot user so git doesnt complain when patching'
+  # See this thread for more details https://github.community/t/github-actions-bot-email-address/17204/5
+runs:
+  using: "composite"
+  steps:
+    - shell: bash
+      run: |
+        git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+        git config --global user.name "github-actions[bot]"
@@ -36,6 +36,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
+      - uses: ./.github/actions/prepare_git_user
       - name: Build with build script
         shell: bash
         run: |
@@ -48,6 +49,11 @@ jobs:
           export VCPKG_ROOT=$(pwd)/../lifting-bits-downloads/vcpkg_${{ matrix.image.name }}-${{ matrix.image.tag }}_llvm-${{ matrix.llvm }}_amd64
           export INSTALL_DIR=$(pwd)/remill-preset-install
           ./scripts/build-preset.sh release
+
+      - name: Install Python Test Deps
+        shell: bash
+        run: |
+          pip3 install --user ./scripts/diff_tester_export_insns
       - name: Run tests
         shell: bash
         working-directory: remill-build
@@ -102,6 +108,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
+      - uses: ./.github/actions/prepare_git_user
       - name: Build with build script
         shell: bash
         run: |
@@ -114,6 +121,10 @@ jobs:
           export VCPKG_ROOT=$(pwd)/../lifting-bits-downloads/vcpkg_${{ matrix.os}}_llvm-${{ matrix.llvm }}_xcode-13.0_amd64
           export INSTALL_DIR=$(pwd)/remill-preset-install
           ./scripts/build-preset.sh release
+      - name: Install Python Test Deps
+        shell: bash
+        run: |
+          pip3 install --user ./scripts/diff_tester_export_insns
       - name: Run tests
         shell: bash
         working-directory: remill-build
 
@@ -26,7 +26,6 @@ cmake-build-debug
 cmake-build-release
 compile_commands.json
 
-bin/*
 
 third_party/*
 build/*
 
@@ -4,7 +4,7 @@
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+# http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -20,7 +20,7 @@ include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/ccache.cmake")
 
 project(remill C CXX ASM)
 include(GNUInstallDirs)
-
+include(FetchContent)
 include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/settings.cmake")
 include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/utils.cmake")
 include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/options.cmake")
@@ -72,6 +72,7 @@ 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()
@@ -88,7 +89,7 @@ target_link_libraries(thirdparty_llvm INTERFACE
 # 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)
+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)
@@ -120,15 +121,32 @@ 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")
+
+# GHIDRA SLEIGH
+FetchContent_Declare(sleigh
+  GIT_REPOSITORY https://github.com/lifting-bits/sleigh.git
+  GIT_TAG 5ee2f2c16250a6529108e6a6fff89e0f147502d2
+)
+
+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"
+    "Kernel32.lib"
   )
 endif()
 
-
 # For Linux builds, group LLVM libraries into a single group
 # that avoids frustrating library ordering issues.
 if(UNIX AND NOT APPLE)
@@ -150,7 +168,6 @@ option(REMILL_BUILD_SPARC32_RUNTIME "Build the Runtime for SPARC32. Turn this of
 #
 
 # add everything as public.
-
 add_library(remill_settings INTERFACE)
 
 target_include_directories(remill_settings INTERFACE
@@ -235,7 +252,7 @@ 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)
+set(THIRDPARTY_LIBRARY_LIST thirdparty_llvm thirdparty_xed thirdparty_glog thirdparty_gflags thirdparty_sleigh)
 target_link_libraries(remill_settings INTERFACE
   ${THIRDPARTY_LIBRARY_LIST}
 )
@@ -259,7 +276,6 @@ target_link_libraries(remill INTERFACE
 #
 # Also install clang, libllvm and llvm-link
 #
-
 set(INSTALLED_CLANG_NAME "remill-clang-${REMILL_LLVM_VERSION}${CMAKE_EXECUTABLE_SUFFIX}")
 set(INSTALLED_LLVMLINK_NAME "remill-llvm-link-${REMILL_LLVM_VERSION}${CMAKE_EXECUTABLE_SUFFIX}")
 
@@ -269,15 +285,18 @@ InstallExternalTarget("ext_llvmlink" "${LLVMLINK_PATH}" "BIN" "${INSTALLED_LLVML
 
 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:...>
+  # E.g. $<LINK_ONLY:...>
   else()
     list(APPEND THIRDPARTY_LIBRARY_FILES "${THIRDPARTY_LIB}")
   endif()
@@ -288,31 +307,33 @@ list(REMOVE_DUPLICATES THIRDPARTY_LIBRARY_FILES)
 #
 # additional targets
 #
-
 add_custom_target(semantics)
 
+# shared JIT tools
+add_subdirectory(test_runner_lib)
+
 # tools
 add_subdirectory(bin)
 
 if(REMILL_ENABLE_INSTALL_TARGET)
   install(TARGETS remill EXPORT remillTargets)
-  
+
   install(TARGETS remill_settings ${THIRDPARTY_LIBRARY_LIST}
     EXPORT remillTargets
   )
-  
+
   # First do the basic substitutions.
   configure_file(
     "${CMAKE_CURRENT_SOURCE_DIR}/cmake/remillConfig.cmake.in"
     "${CMAKE_CURRENT_BINARY_DIR}/remillConfig.cmake"
     @ONLY
   )
-  
+
   install(FILES "${CMAKE_CURRENT_BINARY_DIR}/remillConfig.cmake"
-                "${CMAKE_CURRENT_LIST_DIR}/cmake/vcpkg_helper.cmake"
+    "${CMAKE_CURRENT_LIST_DIR}/cmake/vcpkg_helper.cmake"
     DESTINATION "${REMILL_INSTALL_LIB_DIR}/cmake/remill"
   )
-  
+
   install(DIRECTORY "${REMILL_INCLUDE_DIR}/remill/"
     DESTINATION "${REMILL_INSTALL_INCLUDE_DIR}/remill"
   )
@@ -322,14 +343,19 @@ if(REMILL_ENABLE_INSTALL_TARGET)
 endif()
 
 # tests
-if (REMILL_ENABLE_TESTING)
+if(REMILL_ENABLE_TESTING)
   # Tests require enabling exports on binaries
   # https://cmake.org/cmake/help/latest/variable/CMAKE_ENABLE_EXPORTS.html#variable:CMAKE_ENABLE_EXPORTS
   set(CMAKE_ENABLE_EXPORTS ON)
 
   find_package(Threads REQUIRED)
   add_custom_target(test_dependencies)
 
+  if(REMILL_ENABLE_TESTING_SLEIGH_THUMB)
+    message(STATUS "thumb tests enabled")
+    add_subdirectory(tests/Thumb)
+  endif()
+
   if(REMILL_ENABLE_TESTING_X86)
     message(STATUS "X86 tests enabled")
     add_subdirectory(tests/X86)
 
@@ -30,10 +30,15 @@ ARG LLVM_VERSION
 
 WORKDIR /remill
 COPY ./ ./
+
+RUN git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" && git config --global user.name "github-actions[bot]"
+
 RUN ./scripts/build.sh \
-  --llvm-version ${LLVM_VERSION} \
-  --prefix /opt/trailofbits \
-  --extra-cmake-args "-DCMAKE_BUILD_TYPE=Release"
+    --llvm-version ${LLVM_VERSION} \
+    --prefix /opt/trailofbits \
+    --extra-cmake-args "-DCMAKE_BUILD_TYPE=Release"
+
+RUN pip3 install ./scripts/diff_tester_export_insns
 
 RUN cd remill-build && \
     cmake --build . --target test_dependencies -- -j $(nproc) && \
 
@@ -1,10 +1,10 @@
-# Copyright (c) 2017 Trail of Bits, Inc.
+# Copyright (c) 2022 Trail of Bits, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+# http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -14,3 +14,6 @@
 
 add_subdirectory(lift)
 
+if(REMILL_ENABLE_DIFFERENTIAL_TESTING)
+    add_subdirectory(differential_tester_x86)
+endif()
@@ -0,0 +1,35 @@
+# Copyright (c) 2022 Trail of Bits, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+find_package(Python COMPONENTS Interpreter)
+add_executable(
+  lift-and-compare
+  LiftAndCompare.cpp
+  Whitelist.cpp
+  Whitelist.h
+)
+
+target_link_libraries(
+  lift-and-compare
+  PRIVATE
+  remill
+  thirdparty_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)
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`		`-# Copyright (c) 2017 Trail of Bits, Inc.`
	`1`	`+# Copyright (c) 2022 Trail of Bits, Inc.`
`2`	`2`	`#`
`3`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`# you may not use this file except in compliance with the License.`
`5`	`5`	`# You may obtain a copy of the License at`
`6`	`6`	`#`
`7`		`-# http://www.apache.org/licenses/LICENSE-2.0`
	`7`	`+# http://www.apache.org/licenses/LICENSE-2.0`
`8`	`8`	`#`
`9`	`9`	`# Unless required by applicable law or agreed to in writing, software`
`10`	`10`	`# distributed under the License is distributed on an "AS IS" BASIS,`
`@@ -14,3 +14,6 @@`
`14`	`14`
`15`	`15`	`add_subdirectory(lift)`
`16`	`16`
	`17`	`+if(REMILL_ENABLE_DIFFERENTIAL_TESTING)`
	`18`	`+ add_subdirectory(differential_tester_x86)`
	`19`	`+endif()`