capi: split by component (#2844)

Author: battlmonstr

cmake/compiler_settings.cmake

@@ -123,3 +123,5 @@ else()
     add_link_options(-fsanitize=safe-stack)
   endif()
 endif()
+
+add_compile_definitions(SILKWORM_CAPI_COMPONENT)

silkworm/capi/CMakeLists.txt

@@ -3,6 +3,8 @@
 
 include("${SILKWORM_MAIN_DIR}/cmake/common/targets.cmake")
 
+add_subdirectory(common)
+
 set(TARGET silkworm_capi)
 
 find_package(Microsoft.GSL REQUIRED)
@@ -11,10 +13,11 @@ set(PUBLIC_LIBS "")
 set(PRIVATE_LIBS
     glaze::glaze
     Microsoft.GSL::GSL
+    silkworm_capi_common
     silkworm_core
     silkworm_db
+    silkworm_execution
     silkworm_sentry
-    silkworm_node
     silkworm_rpcdaemon
 )
 
@@ -47,4 +50,14 @@ set_target_properties(${TARGET} PROPERTIES LINK_OPTIONS "${LINK_OPTIONS}")
 
 add_subdirectory(cli)
 
-target_link_libraries(silkworm_capi_static_test PRIVATE silkworm_db_test_util silkworm_node)
+target_link_libraries(silkworm_capi_static_test PRIVATE silkworm_db_test_util)
+
+# collect all public C headers into the same directory
+set(HEADERS_INSTALL_PATH "${CMAKE_CURRENT_BINARY_DIR}/include")
+file(GLOB_RECURSE HEADERS "../capi/*.h" "../*/capi/*.h")
+add_custom_command(
+  TARGET ${TARGET}
+  POST_BUILD
+  COMMAND ${CMAKE_COMMAND} ARGS -E make_directory "${HEADERS_INSTALL_PATH}"
+  COMMAND ${CMAKE_COMMAND} ARGS -E copy_if_different ${HEADERS} "${HEADERS_INSTALL_PATH}"
+)

silkworm/capi/cli/sample-go-client/main.go

@@ -3,7 +3,7 @@ package main
 // #cgo LDFLAGS: -lsilkworm_capi
 // #cgo LDFLAGS: -L${SRCDIR}/../../../../build/silkworm/capi
 // #cgo LDFLAGS: -Wl,-rpath ${SRCDIR}/../../../../build/silkworm/capi
-// #cgo CFLAGS: -I${SRCDIR}/../../../../silkworm/capi
+// #cgo CFLAGS: -I${SRCDIR}/../../../../build/silkworm/capi/include
 /*
 #include "silkworm.h"
 #include <stdlib.h>

silkworm/capi/common/CMakeLists.txt

@@ -0,0 +1,6 @@
+# Copyright 2025 The Silkworm Authors
+# SPDX-License-Identifier: Apache-2.0
+
+include("${SILKWORM_MAIN_DIR}/cmake/common/targets.cmake")
+
+silkworm_library(silkworm_capi_common)

silkworm/capi/common/common_component.hpp

@@ -0,0 +1,19 @@
+// Copyright 2025 The Silkworm Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <filesystem>
+
+#include <silkworm/infra/common/log.hpp>
+#include <silkworm/infra/concurrency/context_pool_settings.hpp>
+
+namespace silkworm::capi {
+
+struct CommonComponent {
+    silkworm::log::Settings log_settings;
+    silkworm::concurrency::ContextPoolSettings context_pool_settings;
+    std::filesystem::path data_dir_path;
+};
+
+}  // namespace silkworm::capi

silkworm/capi/common/errors.h

@@ -0,0 +1,29 @@
+// Copyright 2025 The Silkworm Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#ifndef SILKWORM_CAPI_ERRORS_H_
+#define SILKWORM_CAPI_ERRORS_H_
+
+// Silkworm library error codes (SILKWORM_OK indicates no error, i.e. success)
+
+#define SILKWORM_OK 0
+#define SILKWORM_INTERNAL_ERROR 1
+#define SILKWORM_UNKNOWN_ERROR 2
+#define SILKWORM_INVALID_HANDLE 3
+#define SILKWORM_INVALID_PATH 4
+#define SILKWORM_INVALID_SNAPSHOT 5
+#define SILKWORM_INVALID_MDBX_ENV 6
+#define SILKWORM_INVALID_BLOCK_RANGE 7
+#define SILKWORM_BLOCK_NOT_FOUND 8
+#define SILKWORM_UNKNOWN_CHAIN_ID 9
+#define SILKWORM_MDBX_ERROR 10
+#define SILKWORM_INVALID_BLOCK 11
+#define SILKWORM_DECODING_ERROR 12
+#define SILKWORM_TOO_MANY_INSTANCES 13
+#define SILKWORM_INVALID_SETTINGS 14
+#define SILKWORM_TERMINATION_SIGNAL 15
+#define SILKWORM_SERVICE_ALREADY_STARTED 16
+#define SILKWORM_INCOMPATIBLE_LIBMDBX 17
+#define SILKWORM_INVALID_MDBX_TXN 18
+
+#endif  // SILKWORM_CAPI_ERRORS_H_

silkworm/capi/common/instance.hpp

@@ -0,0 +1,34 @@
+// Copyright 2025 The Silkworm Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <memory>
+
+#include "common_component.hpp"
+
+namespace silkworm::db::capi {
+struct Component;
+}
+
+namespace silkworm::rpc {
+class Daemon;
+}
+
+namespace silkworm::sentry::capi {
+struct Component;
+}
+
+namespace capi_todo {
+
+struct SilkwormInstance {
+    silkworm::capi::CommonComponent common;
+    std::unique_ptr<silkworm::db::capi::Component> db;
+    std::unique_ptr<silkworm::rpc::Daemon> rpcdaemon;
+    std::unique_ptr<silkworm::sentry::capi::Component> sentry;
+
+    SilkwormInstance();
+    ~SilkwormInstance();
+};
+
+}  // namespace capi_todo

silkworm/capi/common/parse_path.cpp

@@ -0,0 +1,17 @@
+// Copyright 2025 The Silkworm Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#include "parse_path.hpp"
+
+#include <cstring>
+
+namespace silkworm::capi {
+
+std::filesystem::path parse_path(const char data_dir_path[SILKWORM_PATH_SIZE]) {
+    // Treat as char8_t so that filesystem::path assumes UTF-8 encoding of the input path
+    auto begin = reinterpret_cast<const char8_t*>(data_dir_path);
+    size_t len = strnlen(data_dir_path, SILKWORM_PATH_SIZE);
+    return std::filesystem::path{begin, begin + len};
+}
+
+}  // namespace silkworm::capi

silkworm/capi/common/parse_path.hpp

@@ -0,0 +1,15 @@
+// Copyright 2025 The Silkworm Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <filesystem>
+
+#include "preamble.h"
+
+namespace silkworm::capi {
+
+//! Build a file system path from its C null-terminated upper-bounded representation
+std::filesystem::path parse_path(const char path[SILKWORM_PATH_SIZE]);
+
+}  // namespace silkworm::capi

silkworm/capi/common/preamble.h

@@ -0,0 +1,36 @@
+// Copyright 2025 The Silkworm Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#ifndef SILKWORM_CAPI_PREAMBLE_H_
+#define SILKWORM_CAPI_PREAMBLE_H_
+
+#include <stdbool.h>  // NOLINT(*-deprecated-headers)
+#include <stddef.h>   // NOLINT(*-deprecated-headers)
+#include <stdint.h>   // NOLINT(*-deprecated-headers)
+
+#if defined _MSC_VER
+#define SILKWORM_EXPORT __declspec(dllexport)
+#else
+#define SILKWORM_EXPORT __attribute__((visibility("default")))
+#endif
+
+#if __cplusplus
+#define SILKWORM_NOEXCEPT noexcept
+#else
+#define SILKWORM_NOEXCEPT
+#endif
+
+#if __cplusplus
+extern "C" {
+#endif
+struct SilkwormInstance;
+typedef struct SilkwormInstance* SilkwormHandle;
+#if __cplusplus
+}
+#endif
+
+#include "errors.h"
+
+#define SILKWORM_PATH_SIZE 260
+
+#endif  // SILKWORM_CAPI_PREAMBLE_H_