deps: fix #279, support for using local repository clones of RetDec deps

avast · Apr 25, 2019 · 658bb9d · 658bb9d
1 parent 14ee574
commit 658bb9d
Show file tree

Hide file tree

Showing 12 changed files with 697 additions and 295 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 * New Feature: Added presentation of section and overlay entropy in `retdec-fileinfo` ([#502](https://github.com/avast/retdec/issues/502), [#507](https://github.com/avast/retdec/pull/507)).
 * New Feature: Added presentation of version info from PE file in `retdec-fileinfo` ([#408](https://github.com/avast/retdec/issues/408), [#519](https://github.com/avast/retdec/pull/519)).
+* Enhancement: Added support for using a local repository clone for RetDec external dependencies ([#279](https://github.com/avast/retdec/issues/279)).
 * Enhancement: Parallelized compilation of YARA rules during installation ([#540](https://github.com/avast/retdec/issues/540)).
 * Enhancement: Updated LLVM to version 8.0.0 ([#110](https://github.com/avast/retdec/issues/110)).
 * Enhancement: Updated YARA to version 3.9 ([#527](https://github.com/avast/retdec/pull/527)).

diff --git a/README.md b/README.md
@@ -251,6 +251,7 @@ You can pass the following additional parameters to `cmake`:
 * `-DRETDEC_COMPILE_YARA=OFF` to disable YARA rules compilation at installation step (enabled by default).
 * `-DCMAKE_BUILD_TYPE=Debug` to build with debugging information, which is useful during development. By default, the project is built in the `Release` mode. This has no effect on Windows, but the same thing can be achieved by running `cmake --build .` with the `--config Debug` parameter.
 * `-DCMAKE_PROGRAM_PATH=<path>` to use Perl at `<path>` (probably useful only on Windows).
+* `-D<dep>_LOCAL_DIR=<path>` where `<dep>` is from `{CAPSTONE, ELFIO, GOOGLETEST, JSONCPP, KEYSTONE, LIBDWARF, LLVM, PELIB, RAPIDJSON, TINYXML, YARACPP, YARAMOD}` (e.g. `-DCAPSTONE_LOCAL_DIR=<path>`), to use the local repository clone at `<path>` for RetDec dependency instead of downloading a fresh copy at build time. Multiple such options may be used at the same time. 
 
 ## Build in Docker
 

diff --git a/deps/capstone/CMakeLists.txt b/deps/capstone/CMakeLists.txt
@@ -7,46 +7,94 @@ if(CMAKE_CXX_COMPILER)
 	set(CMAKE_CXX_COMPILER_OPTION "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}")
 endif()
 
-ExternalProject_Add(capstone-project
-	URL https://github.com/avast/capstone/archive/27c713fe4f6eaf9721785932d850b6291a6073fe.zip
-	URL_HASH SHA256=4d8d0461d7d5737893253698cd0b6d0d64545c1a74b166e8b1d823156a3109cb
-	DOWNLOAD_NAME capstone.zip
-	CMAKE_ARGS
-		# This does not work on MSVC, but may be useful on Linux.
-		-DCMAKE_BUILD_TYPE=Release
-		-DCAPSTONE_BUILD_STATIC=ON
-		-DCAPSTONE_BUILD_SHARED=OFF
-		-DCAPSTONE_BUILD_STATIC_RUNTIME=OFF
-		-DCAPSTONE_BUILD_TESTS=OFF
-		-DCAPSTONE_X86_ATT_DISABLE=OFF
-		# Enabled architectures.
-		-DCAPSTONE_ARM_SUPPORT=ON
-		-DCAPSTONE_MIPS_SUPPORT=ON
-		-DCAPSTONE_PPC_SUPPORT=ON
-		-DCAPSTONE_X86_SUPPORT=ON
-		# Disabled architectures.
-		-DCAPSTONE_ARM64_SUPPORT=OFF
-		-DCAPSTONE_M68K_SUPPORT=OFF
-		-DCAPSTONE_SPARC_SUPPORT=OFF
-		-DCAPSTONE_SYSZ_SUPPORT=OFF
-		-DCAPSTONE_XCORE_SUPPORT=OFF
-		-DCAPSTONE_TMS320C64X_SUPPORT=OFF
-		-DCAPSTONE_M680X_SUPPORT=OFF
-		# Force the use of the same compiler as used to build the top-level
-		# project. Otherwise, the external project may pick up a different
-		# compiler, which may result in link errors.
-		"${CMAKE_C_COMPILER_OPTION}"
-		"${CMAKE_CXX_COMPILER_OPTION}"
-	# Disable the update step.
-	UPDATE_COMMAND ""
-	# Disable the install step.
-	INSTALL_COMMAND ""
-	LOG_DOWNLOAD ON
-	LOG_CONFIGURE ON
-	LOG_BUILD ON
-)
+if(CAPSTONE_LOCAL_DIR)
+	message(STATUS "Capstone: using local Capstone directory.")
+
+	ExternalProject_Add(capstone-project
+		DOWNLOAD_COMMAND ""
+		SOURCE_DIR "${CAPSTONE_LOCAL_DIR}"
+		CMAKE_ARGS
+			# This does not work on MSVC, but may be useful on Linux.
+			-DCMAKE_BUILD_TYPE=Release
+			-DCAPSTONE_BUILD_STATIC=ON
+			-DCAPSTONE_BUILD_SHARED=OFF
+			-DCAPSTONE_BUILD_STATIC_RUNTIME=OFF
+			-DCAPSTONE_BUILD_TESTS=OFF
+			-DCAPSTONE_X86_ATT_DISABLE=OFF
+			# Enabled architectures.
+			-DCAPSTONE_ARM_SUPPORT=ON
+			-DCAPSTONE_MIPS_SUPPORT=ON
+			-DCAPSTONE_PPC_SUPPORT=ON
+			-DCAPSTONE_X86_SUPPORT=ON
+			# Disabled architectures.
+			-DCAPSTONE_ARM64_SUPPORT=OFF
+			-DCAPSTONE_M68K_SUPPORT=OFF
+			-DCAPSTONE_SPARC_SUPPORT=OFF
+			-DCAPSTONE_SYSZ_SUPPORT=OFF
+			-DCAPSTONE_XCORE_SUPPORT=OFF
+			-DCAPSTONE_TMS320C64X_SUPPORT=OFF
+			-DCAPSTONE_M680X_SUPPORT=OFF
+			# Force the use of the same compiler as used to build the top-level
+			# project. Otherwise, the external project may pick up a different
+			# compiler, which may result in link errors.
+			"${CMAKE_C_COMPILER_OPTION}"
+			"${CMAKE_CXX_COMPILER_OPTION}"
+		# Disable the update step.
+		UPDATE_COMMAND ""
+		# Disable the install step.
+		INSTALL_COMMAND ""
+	)
+	force_configure_step(capstone-project)
+else()
+	message(STATUS "Capstone: using remote Capstone revision.")
+
+	ExternalProject_Add(capstone-project
+		URL https://github.com/avast/capstone/archive/27c713fe4f6eaf9721785932d850b6291a6073fe.zip
+		URL_HASH SHA256=4d8d0461d7d5737893253698cd0b6d0d64545c1a74b166e8b1d823156a3109cb
+		DOWNLOAD_NAME capstone.zip
+		CMAKE_ARGS
+			# This does not work on MSVC, but may be useful on Linux.
+			-DCMAKE_BUILD_TYPE=Release
+			-DCAPSTONE_BUILD_STATIC=ON
+			-DCAPSTONE_BUILD_SHARED=OFF
+			-DCAPSTONE_BUILD_STATIC_RUNTIME=OFF
+			-DCAPSTONE_BUILD_TESTS=OFF
+			-DCAPSTONE_X86_ATT_DISABLE=OFF
+			# Enabled architectures.
+			-DCAPSTONE_ARM_SUPPORT=ON
+			-DCAPSTONE_MIPS_SUPPORT=ON
+			-DCAPSTONE_PPC_SUPPORT=ON
+			-DCAPSTONE_X86_SUPPORT=ON
+			# Disabled architectures.
+			-DCAPSTONE_ARM64_SUPPORT=OFF
+			-DCAPSTONE_M68K_SUPPORT=OFF
+			-DCAPSTONE_SPARC_SUPPORT=OFF
+			-DCAPSTONE_SYSZ_SUPPORT=OFF
+			-DCAPSTONE_XCORE_SUPPORT=OFF
+			-DCAPSTONE_TMS320C64X_SUPPORT=OFF
+			-DCAPSTONE_M680X_SUPPORT=OFF
+			# Force the use of the same compiler as used to build the top-level
+			# project. Otherwise, the external project may pick up a different
+			# compiler, which may result in link errors.
+			"${CMAKE_C_COMPILER_OPTION}"
+			"${CMAKE_CXX_COMPILER_OPTION}"
+		# Disable the update step.
+		UPDATE_COMMAND ""
+		# Disable the install step.
+		INSTALL_COMMAND ""
+		LOG_DOWNLOAD ON
+		LOG_CONFIGURE ON
+		LOG_BUILD ON
+	)
+endif()
+
+check_if_variable_changed(CAPSTONE_LOCAL_DIR CHANGED)
+if(CHANGED)
+	ExternalProject_Get_Property(capstone-project binary_dir)
+	message(STATUS "Capstone: path to Capstone directory changed -> cleaning CMake files in ${binary_dir}.")
+	clean_cmake_files(${binary_dir})
+endif()
 
-# Set include directories.
 ExternalProject_Get_Property(capstone-project source_dir)
 ExternalProject_Get_Property(capstone-project binary_dir)
 

diff --git a/deps/elfio/CMakeLists.txt b/deps/elfio/CMakeLists.txt
@@ -7,30 +7,65 @@ if(CMAKE_CXX_COMPILER)
 	set(CMAKE_CXX_COMPILER_OPTION "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}")
 endif()
 
-ExternalProject_Add(elfio-project
-	URL https://github.com/avast/elfio/archive/f85f07390b756fee61408dfe0b04ae4fb86c5477.zip
-	URL_HASH SHA256=bc821b602cad22de1d671f0314b1171e4bca7ca1aabc85eb2d32945ed8dfcc66
-	DOWNLOAD_NAME elfio.zip
-	CMAKE_ARGS
-		# This does not work on MSVC, but may be useful on Linux.
-		-DCMAKE_BUILD_TYPE=Release
-		# Force the use of the same compiler as used to build the top-level
-		# project. Otherwise, the external project may pick up a different
-		# compiler, which may result in link errors.
-		"${CMAKE_C_COMPILER_OPTION}"
-		"${CMAKE_CXX_COMPILER_OPTION}"
-	# Disable the configure step - header only.
-	CONFIGURE_COMMAND ""
-	# Disable the build step.
-	BUILD_COMMAND ""
-	# Disable the update step.
-	UPDATE_COMMAND ""
-	# Disable the install step.
-	INSTALL_COMMAND ""
-	LOG_DOWNLOAD ON
-	LOG_CONFIGURE ON
-	LOG_BUILD ON
-)
+if(ELFIO_LOCAL_DIR)
+	message(STATUS "ELFIO: using local ELFIO directory.")
+
+	ExternalProject_Add(elfio-project
+		DOWNLOAD_COMMAND ""
+		SOURCE_DIR "${ELFIO_LOCAL_DIR}"
+		CMAKE_ARGS
+			# This does not work on MSVC, but may be useful on Linux.
+			-DCMAKE_BUILD_TYPE=Release
+			# Force the use of the same compiler as used to build the top-level
+			# project. Otherwise, the external project may pick up a different
+			# compiler, which may result in link errors.
+			"${CMAKE_C_COMPILER_OPTION}"
+			"${CMAKE_CXX_COMPILER_OPTION}"
+		# Disable the configure step - header only.
+		CONFIGURE_COMMAND ""
+		# Disable the build step.
+		BUILD_COMMAND ""
+		# Disable the update step.
+		UPDATE_COMMAND ""
+		# Disable the install step.
+		INSTALL_COMMAND ""
+	)
+	force_configure_step(elfio-project)
+else()
+	message(STATUS "ELFIO: using remote ELFIO revision.")
+
+	ExternalProject_Add(elfio-project
+		URL https://github.com/avast/elfio/archive/f85f07390b756fee61408dfe0b04ae4fb86c5477.zip
+		URL_HASH SHA256=bc821b602cad22de1d671f0314b1171e4bca7ca1aabc85eb2d32945ed8dfcc66
+		DOWNLOAD_NAME elfio.zip
+		CMAKE_ARGS
+			# This does not work on MSVC, but may be useful on Linux.
+			-DCMAKE_BUILD_TYPE=Release
+			# Force the use of the same compiler as used to build the top-level
+			# project. Otherwise, the external project may pick up a different
+			# compiler, which may result in link errors.
+			"${CMAKE_C_COMPILER_OPTION}"
+			"${CMAKE_CXX_COMPILER_OPTION}"
+		# Disable the configure step - header only.
+		CONFIGURE_COMMAND ""
+		# Disable the build step.
+		BUILD_COMMAND ""
+		# Disable the update step.
+		UPDATE_COMMAND ""
+		# Disable the install step.
+		INSTALL_COMMAND ""
+		LOG_DOWNLOAD ON
+		LOG_CONFIGURE ON
+		LOG_BUILD ON
+	)
+endif()
+
+check_if_variable_changed(ELFIO_LOCAL_DIR CHANGED)
+if(CHANGED)
+	ExternalProject_Get_Property(elfio-project binary_dir)
+	message(STATUS "ELFIO: path to ELFIO directory changed -> cleaning CMake files in ${binary_dir}.")
+	clean_cmake_files(${binary_dir})
+endif()
 
 ExternalProject_Get_Property(elfio-project source_dir)
 

diff --git a/deps/googletest/CMakeLists.txt b/deps/googletest/CMakeLists.txt
@@ -9,30 +9,65 @@ if(CMAKE_CXX_COMPILER)
 	set(CMAKE_CXX_COMPILER_OPTION "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}")
 endif()
 
-ExternalProject_Add(googletest
-	URL https://github.com/google/googletest/archive/83fa0cb17dad47a1d905526dcdddb5b96ed189d2.zip
-	URL_HASH SHA256=3b7cf6bfd1fdec3204933b4c0419c010e89b2409dcd8cbc1ac6a78aab058e2b0
-	DOWNLOAD_NAME googletest.zip
-	CMAKE_ARGS
-		# This does not work on MSVC, but is useful on Linux.
-		-DCMAKE_BUILD_TYPE=Release
-		# Without this, googletest's CMakeLists.txt replaces "/MD" (dynamic run-time) with "-MT" (static runtime).
-		# Default config for most applications is "/MD", so this will cause problems if linked with "-MT" googletest.
-		# https://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
-		-Dgtest_force_shared_crt=ON
-		# Force the use of the same compiler as used to build the top-level
-		# project. Otherwise, the external project may pick up a different
-		# compiler, which may result in link errors.
-		"${CMAKE_C_COMPILER_OPTION}"
-		"${CMAKE_CXX_COMPILER_OPTION}"
-	# Disable the update step.
-	UPDATE_COMMAND ""
-	# Disable the install step.
-	INSTALL_COMMAND ""
-	LOG_DOWNLOAD ON
-	LOG_CONFIGURE ON
-	LOG_BUILD ON
-)
+if(GOOGLETEST_LOCAL_DIR)
+	message(STATUS "Googletest: using local Googletest directory.")
+
+	ExternalProject_Add(googletest
+		DOWNLOAD_COMMAND ""
+		SOURCE_DIR "${GOOGLETEST_LOCAL_DIR}"
+		CMAKE_ARGS
+			# This does not work on MSVC, but is useful on Linux.
+			-DCMAKE_BUILD_TYPE=Release
+			# Without this, googletest's CMakeLists.txt replaces "/MD" (dynamic run-time) with "-MT" (static runtime).
+			# Default config for most applications is "/MD", so this will cause problems if linked with "-MT" googletest.
+			# https://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
+			-Dgtest_force_shared_crt=ON
+			# Force the use of the same compiler as used to build the top-level
+			# project. Otherwise, the external project may pick up a different
+			# compiler, which may result in link errors.
+			"${CMAKE_C_COMPILER_OPTION}"
+			"${CMAKE_CXX_COMPILER_OPTION}"
+		# Disable the update step.
+		UPDATE_COMMAND ""
+		# Disable the install step.
+		INSTALL_COMMAND ""
+	)
+	force_configure_step(googletest)
+else()
+	message(STATUS "Googletest: using remote Googletest revision.")
+
+	ExternalProject_Add(googletest
+		URL https://github.com/google/googletest/archive/83fa0cb17dad47a1d905526dcdddb5b96ed189d2.zip
+		URL_HASH SHA256=3b7cf6bfd1fdec3204933b4c0419c010e89b2409dcd8cbc1ac6a78aab058e2b0
+		DOWNLOAD_NAME googletest.zip
+		CMAKE_ARGS
+			# This does not work on MSVC, but is useful on Linux.
+			-DCMAKE_BUILD_TYPE=Release
+			# Without this, googletest's CMakeLists.txt replaces "/MD" (dynamic run-time) with "-MT" (static runtime).
+			# Default config for most applications is "/MD", so this will cause problems if linked with "-MT" googletest.
+			# https://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
+			-Dgtest_force_shared_crt=ON
+			# Force the use of the same compiler as used to build the top-level
+			# project. Otherwise, the external project may pick up a different
+			# compiler, which may result in link errors.
+			"${CMAKE_C_COMPILER_OPTION}"
+			"${CMAKE_CXX_COMPILER_OPTION}"
+		# Disable the update step.
+		UPDATE_COMMAND ""
+		# Disable the install step.
+		INSTALL_COMMAND ""
+		LOG_DOWNLOAD ON
+		LOG_CONFIGURE ON
+		LOG_BUILD ON
+	)
+endif()
+
+check_if_variable_changed(GOOGLETEST_LOCAL_DIR CHANGED)
+if(CHANGED)
+	ExternalProject_Get_Property(googletest binary_dir)
+	message(STATUS "Googletest: path to Googletest directory changed -> cleaning CMake files in ${binary_dir}.")
+	clean_cmake_files(${binary_dir})
+endif()
 
 # Set include directories.
 ExternalProject_Get_Property(googletest source_dir)