cmake: Add MULTIPROCESS option

Author: hebasto

CMakeLists.txt

@@ -83,6 +83,7 @@ tristate_option(WITH_EXTERNAL_SIGNER
   "if Boost.Process is found."
   AUTO
 )
+tristate_option(MULTIPROCESS "Build multiprocess bitcoin-node, bitcoin-wallet, and bitcoin-gui executables in addition to monolithic bitcoind and bitcoin-qt executables. Requires libmultiprocess library. Experimental." "if libmultiprocess is found." OFF)
 
 option(BUILD_TESTS "Build test_bitcoin executable." ON)
 option(BUILD_BENCH "Build bench_bitcoin executable." ON)
@@ -428,6 +429,7 @@ message("  Berkeley DB, legacy wallets ......... ${WITH_BDB}")
 message("Optional packages:")
 message("  GUI ................................. ${WITH_GUI}")
 message("  external signer ..................... ${WITH_EXTERNAL_SIGNER}")
+message("  multiprocess ........................ ${MULTIPROCESS}")
 message("  NAT-PMP ............................. ${WITH_NATPMP}")
 message("  UPnP ................................ ${WITH_MINIUPNPC}")
 message("  ZeroMQ .............................. ${WITH_ZMQ}")

cmake/module/GenerateMPCode.cmake

@@ -0,0 +1,31 @@
+# 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(target_capnp_sources target)
+  foreach(capnp_file IN LISTS ARGN)
+    add_custom_command(
+      OUTPUT ${capnp_file}.c++ ${capnp_file}.h ${capnp_file}.proxy-client.c++ ${capnp_file}.proxy-types.h ${capnp_file}.proxy-server.c++ ${capnp_file}.proxy-types.c++ ${capnp_file}.proxy.h
+      COMMAND ${MPGEN_PREFIX}/bin/mpgen ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_SOURCE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/${capnp_file}
+      DEPENDS ${capnp_file}
+      VERBATIM
+    )
+    target_sources(${target}
+      PRIVATE
+        ${CMAKE_CURRENT_BINARY_DIR}/${capnp_file}.c++
+        ${CMAKE_CURRENT_BINARY_DIR}/${capnp_file}.proxy-client.c++
+        ${CMAKE_CURRENT_BINARY_DIR}/${capnp_file}.proxy-server.c++
+        ${CMAKE_CURRENT_BINARY_DIR}/${capnp_file}.proxy-types.c++
+    )
+  endforeach()
+
+  target_include_directories(${target}
+    PUBLIC
+      $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}>
+  )
+
+  target_link_libraries(${target}
+    PRIVATE
+      PkgConfig::libmultiprocess
+  )
+endfunction()

cmake/optional.cmake

@@ -187,3 +187,17 @@ else()
   set(WITH_SQLITE OFF)
   set(WITH_BDB OFF)
 endif()
+
+if(MULTIPROCESS)
+  # TODO: Switch to find_package() command.
+  include(CrossPkgConfig)
+  cross_pkg_check_modules(libmultiprocess libmultiprocess IMPORTED_TARGET)
+  if(libmultiprocess_FOUND)
+    set(MULTIPROCESS ON)
+    set(MPGEN_PREFIX "${libmultiprocess_PREFIX}" CACHE PATH "libmultiprocess codegen tool prefix.")
+  elseif(MULTIPROCESS STREQUAL "AUTO")
+    set(MULTIPROCESS OFF)
+  else()
+    message(FATAL_ERROR "\"-DMULTIPROCESS=ON\" specified, but libmultiprocess library was not found.")
+  endif()
+endif()

depends/Makefile

@@ -286,6 +286,7 @@ $(host_prefix)/share/toolchain.cmake : toolchain.cmake.in $(host_prefix)/.stamp_
             -e 's|@no_natpmp@|$(NO_NATPMP)|' \
             -e 's|@no_usdt@|$(NO_USDT)|' \
             -e 's|@no_harden@|$(NO_HARDEN)|' \
+            -e 's|@multiprocess@|$(MULTIPROCESS)|' \
             $< > $@
 	touch $@
 

depends/toolchain.cmake.in

@@ -146,3 +146,12 @@ endif()
 if(NOT HARDENING AND "@no_harden@" STREQUAL "1")
   set(HARDENING OFF CACHE STRING "")
 endif()
+
+if("@multiprocess@" STREQUAL "1")
+  if(NOT MULTIPROCESS)
+    set(MULTIPROCESS ON CACHE STRING "")
+  endif()
+  if(NOT MPGEN_PREFIX)
+    set(MPGEN_PREFIX "${CMAKE_FIND_ROOT_PATH}/native" CACHE PATH "")
+  endif()
+endif()

src/CMakeLists.txt

@@ -35,6 +35,9 @@ add_dependencies(bitcoin_clientversion generate_build_info)
 add_subdirectory(crypto)
 add_subdirectory(univalue)
 add_subdirectory(util)
+if(MULTIPROCESS)
+  add_subdirectory(ipc)
+endif()
 
 
 add_library(bitcoin_consensus_sources INTERFACE)
@@ -277,6 +280,19 @@ if(BUILD_DAEMON)
   )
   list(APPEND installable_targets bitcoind)
 endif()
+if(MULTIPROCESS)
+  add_executable(bitcoin-node
+    bitcoind.cpp
+    init/bitcoin-node.cpp
+  )
+  target_link_libraries(bitcoin-node
+    core_interface
+    bitcoin_node
+    bitcoin_ipc
+    $<TARGET_NAME_IF_EXISTS:bitcoin_wallet>
+  )
+  list(APPEND installable_targets bitcoin-node)
+endif()
 
 
 add_library(bitcoin_cli STATIC EXCLUDE_FROM_ALL

src/ipc/CMakeLists.txt

@@ -0,0 +1,17 @@
+# 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/.
+
+add_library(bitcoin_ipc STATIC EXCLUDE_FROM_ALL
+  capnp/protocol.cpp
+  interfaces.cpp
+  process.cpp
+)
+
+include(GenerateMPCode)
+target_capnp_sources(bitcoin_ipc capnp/echo.capnp capnp/init.capnp)
+
+target_link_libraries(bitcoin_ipc
+  PRIVATE
+    core_interface
+)

src/qt/CMakeLists.txt

@@ -179,12 +179,30 @@ target_link_libraries(bitcoin-qt
 )
 
 import_plugins(bitcoin-qt)
-
+set(installable_targets bitcoin-qt)
 if(WIN32)
   set_target_properties(bitcoin-qt PROPERTIES WIN32_EXECUTABLE TRUE)
 endif()
 
-install(TARGETS bitcoin-qt
+if(MULTIPROCESS)
+  add_executable(bitcoin-gui
+    main.cpp
+    ../init/bitcoin-gui.cpp
+  )
+  target_link_libraries(bitcoin-gui
+    core_interface
+    bitcoinqt
+    bitcoin_node
+    bitcoin_ipc
+  )
+  import_plugins(bitcoin-gui)
+  list(APPEND installable_targets bitcoin-gui)
+  if(WIN32)
+    set_target_properties(bitcoin-gui PROPERTIES WIN32_EXECUTABLE TRUE)
+  endif()
+endif()
+
+install(TARGETS ${installable_targets}
   RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
   COMPONENT GUI
 )

src/test/CMakeLists.txt

@@ -174,6 +174,27 @@ if(ENABLE_WALLET)
   endif()
 endif()
 
+if(MULTIPROCESS)
+  add_library(bitcoin_ipc_test STATIC EXCLUDE_FROM_ALL
+    ipc_test.cpp
+  )
+
+  include(GenerateMPCode)
+  target_capnp_sources(bitcoin_ipc_test ipc_test.capnp)
+
+  target_link_libraries(bitcoin_ipc_test
+    PRIVATE
+      core_interface
+      univalue
+  )
+
+  target_sources(test_bitcoin
+    PRIVATE
+      ipc_tests.cpp
+  )
+  target_link_libraries(test_bitcoin bitcoin_ipc_test)
+endif()
+
 install(TARGETS test_bitcoin
   RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
 )