cmake: Build libbitcoinconsensus library

Author: hebasto

CMakeLists.txt

@@ -40,6 +40,7 @@ option(BUILD_DAEMON "Build bitcoind executable." ON)
 option(BUILD_CLI "Build bitcoin-cli executable." ON)
 option(BUILD_TX "Build bitcoin-tx executable." ON)
 option(BUILD_UTIL "Build bitcoin-util executable." ON)
+option(BUILD_BITCOINCONSENSUS_LIB "Build bitcoinconsensus library." ON)
 option(ASM "Use assembly routines." ON)
 
 option(ENABLE_WALLET "Enable wallet." ON)
@@ -95,9 +96,17 @@ unset(check_pie_output)
 # It is intended to be a usage requirement for all other targets.
 add_library(core INTERFACE)
 
+# The lib interface library aims to encapsulate build flags, which
+# are specific to non-internal libraries.
+# It is intended to be a usage requirement for non-internal library
+# targets.
+add_library(lib INTERFACE)
+
 include(TryAppendCXXFlags)
 include(TryAppendLinkerFlag)
 
+try_append_linker_flag("-Wl,--no-undefined" TARGET lib)
+
 if(WIN32)
   #[=[
   This build system supports two ways to build binaries for Windows.
@@ -320,6 +329,10 @@ if(WERROR)
   unset(werror_flag)
 endif()
 
+if(BUILD_BITCOINCONSENSUS_LIB)
+  set(HAVE_CONSENSUS_LIB TRUE)
+endif()
+
 find_package(Python3 3.9 COMPONENTS Interpreter)
 set(PYTHON_COMMAND ${Python3_EXECUTABLE})
 
@@ -340,6 +353,13 @@ message("  bitcoin-cli ......................... ${BUILD_CLI}")
 message("  bitcoin-tx .......................... ${BUILD_TX}")
 message("  bitcoin-util ........................ ${BUILD_UTIL}")
 message("  bitcoin-wallet ...................... ${BUILD_WALLET_TOOL}")
+message("Libraries:")
+if(BUILD_SHARED_LIBS)
+  message("  library type ........................ Shared")
+else()
+  message("  library type ........................ Static")
+endif()
+message("  libbitcoinconsensus ................. ${BUILD_BITCOINCONSENSUS_LIB}")
 message("Wallet support:")
 message("  SQLite, descriptor wallets .......... ${WITH_SQLITE}")
 message("  Berkeley DB, legacy wallets ......... ${WITH_BDB}")

cmake/bitcoin-config.h.in

@@ -46,6 +46,9 @@
 /* Define to 1 if you have the <byteswap.h> header file. */
 #cmakedefine HAVE_BYTESWAP_H 1
 
+/* Define this symbol if the consensus lib has been built */
+#cmakedefine HAVE_CONSENSUS_LIB 1
+
 /* Define to 1 if you have the declaration of `be16toh', and to 0 if you
    don't. */
 #cmakedefine01 HAVE_DECL_BE16TOH

cmake/module/GeneratePkgConfigFile.cmake

@@ -0,0 +1,13 @@
+# Copyright (c) 2023-present The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or https://opensource.org/license/mit/.
+
+function(generate_pkg_config_file in_file out_file)
+  set(prefix ${CMAKE_INSTALL_PREFIX})
+  set(exec_prefix "\${prefix}")
+  set(libdir "\${exec_prefix}/${CMAKE_INSTALL_LIBDIR}")
+  set(includedir "\${prefix}/${CMAKE_INSTALL_INCLUDEDIR}")
+  set(PACKAGE_NAME ${PROJECT_NAME})
+  set(PACKAGE_VERSION ${PROJECT_VERSION})
+  configure_file(${in_file} ${out_file} @ONLY)
+endfunction()

src/CMakeLists.txt

@@ -306,6 +306,11 @@ if(BUILD_UTIL)
 endif()
 
 
+if(BUILD_BITCOINCONSENSUS_LIB)
+  add_subdirectory(script)
+endif()
+
+
 add_subdirectory(test/util)
 if(BUILD_BENCH)
   add_subdirectory(bench)

src/bench/CMakeLists.txt

@@ -53,6 +53,7 @@ target_link_libraries(bench_bitcoin
   core
   test_util
   bitcoin_node
+  $<TARGET_NAME_IF_EXISTS:bitcoinconsensus>
   Boost::headers
 )
 
@@ -67,6 +68,8 @@ if(ENABLE_WALLET)
   target_link_libraries(bench_bitcoin bitcoin_wallet)
 endif()
 
+make_bitcoinconsensus_dll_available(bench_bitcoin)
+
 install(TARGETS bench_bitcoin
   RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
 )

src/script/CMakeLists.txt

@@ -0,0 +1,59 @@
+# Copyright (c) 2023-present The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or https://opensource.org/license/mit/.
+
+# Must be included before CMAKE_INSTALL_INCLUDEDIR is used.
+include(GNUInstallDirs)
+
+add_library(bitcoinconsensus
+  ../support/cleanse.cpp
+  bitcoinconsensus.cpp
+  ${bitcoin_crypto_base_sources}
+  ${bitcoin_consensus_sources}
+)
+target_compile_definitions(bitcoinconsensus
+  PRIVATE
+    BUILD_BITCOIN_INTERNAL
+)
+target_include_directories(bitcoinconsensus
+  PUBLIC
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>
+    $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
+)
+target_link_libraries(bitcoinconsensus
+  PRIVATE
+    core
+    lib
+    secp256k1
+)
+set_target_properties(bitcoinconsensus PROPERTIES
+  SOVERSION 0
+  VERSION 0.0.0
+)
+
+install(TARGETS bitcoinconsensus
+  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+)
+install(FILES bitcoinconsensus.h
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+)
+
+include(GeneratePkgConfigFile)
+generate_pkg_config_file(${PROJECT_SOURCE_DIR}/libbitcoinconsensus.pc.in libbitcoinconsensus.pc)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libbitcoinconsensus.pc
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig
+)
+
+function(make_bitcoinconsensus_dll_available target)
+  if(WIN32 AND BUILD_SHARED_LIBS)
+    # The DLL must reside either in the same folder where the executable is
+    # or somewhere in PATH. Using the former option.
+    add_custom_command(
+      TARGET ${target} POST_BUILD
+      COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:bitcoinconsensus> $<TARGET_FILE_DIR:${target}>
+      VERBATIM
+    )
+  endif()
+endfunction()

src/test/CMakeLists.txt

@@ -142,6 +142,7 @@ target_link_libraries(test_bitcoin
   bitcoin_cli
   bitcoin_node
   minisketch
+  $<TARGET_NAME_IF_EXISTS:bitcoinconsensus>
   Boost::headers
 )
 
@@ -172,6 +173,8 @@ if(ENABLE_WALLET)
   endif()
 endif()
 
+make_bitcoinconsensus_dll_available(test_bitcoin)
+
 install(TARGETS test_bitcoin
   RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
 )