Add cmake boilerplate to install ichor

Also fix a threading issue in HttpHost
volt-software · Nov 6, 2022 · 530a9b9 · 530a9b9
1 parent 5f628b3
commit 530a9b9
Show file tree

Hide file tree

Showing 16 changed files with 249 additions and 86 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
diff --git a/IchorConfig.cmake.in b/IchorConfig.cmake.in
@@ -0,0 +1,24 @@
+@PACKAGE_INIT@
+
+include(CMakeFindDependencyMacro)
+
+set(ICHOR_USE_SYSTEM_MIMALLOC @ICHOR_USE_SYSTEM_MIMALLOC@)
+set(ICHOR_USE_ABSEIL @ICHOR_USE_ABSEIL@)
+set(ICHOR_USE_SDEVENT @ICHOR_USE_SDEVENT@)
+set(ICHOR_USE_BOOST_BEAST @ICHOR_USE_BOOST_BEAST@)
+
+if(ICHOR_USE_SYSTEM_MIMALLOC)
+    find_dependency(mimalloc REQUIRED)
+endif()
+if(ICHOR_USE_ABSEIL)
+    find_dependency(absl REQUIRED)
+endif()
+if(ICHOR_USE_SDEVENT)
+    find_dependency(PkgConfig REQUIRED)
+    pkg_check_modules(Systemd IMPORTED_TARGET GLOBAL libsystemd)
+endif()
+if(ICHOR_USE_BOOST_BEAST)
+    find_dependency(boost_coroutine REQUIRED)
+endif()
+
+include("${CMAKE_CURRENT_LIST_DIR}/IchorTargets.cmake")
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Michael de Lang
+Copyright (c) 2022 Michael de Lang
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/build.sh b/build.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-
+#sudo rm -rf * ../bin/* /usr/include/ichor/ ../../ichor-install/ /usr/lib/cmake/ichor && cmake -GNinja -DICHOR_BUILD_TESTING=OFF -DICHOR_BUILD_EXAMPLES=OFF -DICHOR_BUILD_BENCHMARKS=OFF -DCMAKE_BUILD_TYPE=Debug -DICHOR_USE_SANITIZERS=ON -DICHOR_ARCH_OPTIMIZATION=X86_64_AVX512 -DICHOR_USE_ABSEIL=ON -DICHOR_SERIALIZATION_FRAMEWORK=BOOST_JSON -DICHOR_USE_BOOST_BEAST=ON -DICHOR_USE_SPDLOG=ON -DCMAKE_INSTALL_PREFIX=/usr .. && ninja && sudo ninja install
 cleanup ()
 {
     kill -s SIGTERM $!
@@ -63,4 +63,4 @@ for i in ${!ccompilers[@]}; do
   ninja test || exit 1
   run_examples
   run_benchmarks
-done
+done
diff --git a/cloc.sh b/cloc.sh
@@ -1,4 +1,4 @@
 #!/bin/bash
-cloc src/ include/ test/ examples/ benchmarks/ --exclude-dir=etcd,etcd_example,tl
+cloc src/ include/ test/ examples/ benchmarks/ --exclude-dir=etcd,etcd_example,tl,sole
 echo ""
-cloc src/ include/ test/ examples/ benchmarks/ --exclude-dir=etcd,etcd_example,tl --by-file
+cloc src/ include/ test/ examples/ benchmarks/ --exclude-dir=etcd,etcd_example,tl,sole --by-file
diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md
@@ -3,6 +3,7 @@
 ## Compiling Ichor
 
 Compiling is done through the help of CMake. Ichor requires at least gcc 11.3 (due to [this gcc bug](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=95137)) or clang 14, and is tested with gcc 11.3, 12.1, clang 14, clang 15 and clang 16.
+
 ### Dependencies
 
 #### Ubuntu 20.04:
@@ -62,6 +63,20 @@ sudo apt install libabsl-dev
 
 Tried with MSVC 19.33, but it seemed like coroutines and concepts are not fully implemented yet.
 
+#### CMakeLists.txt
+
+To use Ichor, compile and install it in a location that cmake can find (e.g. /usr) and use the following CMakeLists.txt:
+
+```cmake
+cmake_minimum_required(VERSION 3.12)
+project(my_project)
+
+set(CMAKE_CXX_STANDARD 20)
+find_package(my_exe CONFIG REQUIRED)
+
+add_executable(my_exe main.cpp)
+target_link_libraries(my_exe Ichor::ichor)
+```
 
 ### CMake Options
 
@@ -134,6 +149,10 @@ Enables the use of the [sdevent event queue](../include/ichor/event_queues/Sdeve
 
 Enables the use of the abseil containers in Ichor. Requires having abseil headers and libraries installed on your system.
 
+#### ICHOR_DISABLE_RTTI
+
+Disables `dynamic_cast<>()` in most cases as well as `typeid`. Ichor is an opinionated piece of software and we strongly encourage you to disable RTTI. We believe `dynamic_cast<>()` is wrong in almost all instances. Virtual methods and double dispatch should be used instead. If, however, you really want to use RTTI, use this option to re-enable it. 
+
 #### ICHOR_USE_MIMALLOC
 
 If `ICHOR_USE_SANITIZERS` is turned OFF, Ichor by default compiles itself with mimalloc, speeding up the runtime a lot and reducing peak memory usage.
@@ -273,7 +292,7 @@ struct MyTimerService final : public IMyTimerService, public Ichor::Service<MyTi
         return Ichor::StartBehaviour::SUCCEEDED;
     }
 
-    Ichor::AsyncGenerator<void> handleEvent(Ichor::TimerEvent const * const) {
+    Ichor::AsyncGenerator<void> handleEvent(Ichor::TimerEvent const &) {
         co_return;        
     }
 
@@ -339,7 +358,7 @@ struct MyTimerService final : public IMyTimerService, public Ichor::Service<MyTi
         return Ichor::StartBehaviour::SUCCEEDED;
     }
 
-    Ichor::AsyncGenerator<void> handleEvent(Ichor::TimerEvent const * const) {
+    Ichor::AsyncGenerator<void> handleEvent(Ichor::TimerEvent const &) {
         getManager().pushEvent<Ichor::QuitEvent>(getServiceId()); // Add this
         co_return;
     }
@@ -409,7 +428,7 @@ Pushing an event with a priority is done with the `pushPrioritisedEvent` functio
 getManager().pushPrioritisedEvent<TimerEvent>(getServiceId(), 10);
 ```
 
-The default priority for events is 1000. For dependency related things (like start service, dependency online events) this is 100.
+The default priority for events is 1000. For dependency related things (like start service, dependency online events) it is 100.
 
 ### Memory allocation
 

diff --git a/examples/common/TestMsgJsonSerializer.h b/examples/common/TestMsgJsonSerializer.h
@@ -7,10 +7,10 @@
 #include <ichor/LifecycleManager.h>
 #include "TestMsg.h"
 
-#ifdef USE_RAPIDJSON
+#ifdef ICHOR_USE_RAPIDJSON
 #include <rapidjson/document.h>
 #include <rapidjson/writer.h>
-#elif USE_BOOST_JSON
+#elif ICHOR_USE_BOOST_JSON
 #pragma GCC diagnostic push
 #ifndef __clang__
 #pragma GCC diagnostic ignored "-Wduplicated-branches"
@@ -35,7 +35,7 @@ class TestMsgJsonSerializer final : public ISerializer, public Service<TestMsgJs
     std::vector<uint8_t> serialize(const void* obj) final {
         auto msg = static_cast<const TestMsg*>(obj);
 
-#ifdef USE_RAPIDJSON
+#ifdef ICHOR_USE_RAPIDJSON
         rapidjson::StringBuffer sb;
         rapidjson::Writer<rapidjson::StringBuffer> writer(sb);
 
@@ -50,7 +50,7 @@ class TestMsgJsonSerializer final : public ISerializer, public Service<TestMsgJs
         writer.EndObject();
         auto *ret = sb.GetString();
         return std::vector<uint8_t>(ret, ret + sb.GetSize() + 1);
-#elif USE_BOOST_JSON
+#elif ICHOR_USE_BOOST_JSON
         boost::json::value jv{};
         boost::json::serializer sr;
         jv = {{"id", msg->id}, {"val", msg->val}};
@@ -84,7 +84,7 @@ class TestMsgJsonSerializer final : public ISerializer, public Service<TestMsgJs
 #endif
     }
     void* deserialize(std::vector<uint8_t> &&stream) final {
-#ifdef USE_RAPIDJSON
+#ifdef ICHOR_USE_RAPIDJSON
         rapidjson::Document d;
         d.ParseInsitu(reinterpret_cast<char*>(stream.data()));
 
@@ -93,7 +93,7 @@ class TestMsgJsonSerializer final : public ISerializer, public Service<TestMsgJs
         }
 
         return new TestMsg{d["id"].GetUint64(), d["val"].GetString()};
-#elif USE_BOOST_JSON
+#elif ICHOR_USE_BOOST_JSON
         boost::json::parser p{};
 
         std::error_code ec;

diff --git a/examples/http_ping_pong/PingMsgJsonSerializer.h b/examples/http_ping_pong/PingMsgJsonSerializer.h
@@ -7,10 +7,10 @@
 #include <ichor/LifecycleManager.h>
 #include "PingMsg.h"
 
-#ifdef USE_RAPIDJSON
+#ifdef ICHOR_USE_RAPIDJSON
 #include <rapidjson/document.h>
 #include <rapidjson/writer.h>
-#elif USE_BOOST_JSON
+#elif ICHOR_USE_BOOST_JSON
 #pragma GCC diagnostic push
 #ifndef __clang__
 #pragma GCC diagnostic ignored "-Wduplicated-branches"
@@ -35,7 +35,7 @@ class PingMsgJsonSerializer final : public ISerializer, public Service<PingMsgJs
     std::vector<uint8_t> serialize(const void* obj) final {
         auto msg = static_cast<const PingMsg*>(obj);
 
-#ifdef USE_RAPIDJSON
+#ifdef ICHOR_USE_RAPIDJSON
         rapidjson::StringBuffer sb;
         rapidjson::Writer<rapidjson::StringBuffer> writer(sb);
 
@@ -47,7 +47,7 @@ class PingMsgJsonSerializer final : public ISerializer, public Service<PingMsgJs
         writer.EndObject();
         auto *ret = sb.GetString();
         return std::vector<uint8_t>(ret, ret + sb.GetSize() + 1);
-#elif USE_BOOST_JSON
+#elif ICHOR_USE_BOOST_JSON
         boost::json::value jv{};
         boost::json::serializer sr;
         jv = {{"sequence", msg->sequence}};
@@ -81,7 +81,7 @@ class PingMsgJsonSerializer final : public ISerializer, public Service<PingMsgJs
 #endif
     }
     void* deserialize(std::vector<uint8_t> &&stream) final {
-#ifdef USE_RAPIDJSON
+#ifdef ICHOR_USE_RAPIDJSON
         rapidjson::Document d;
         d.ParseInsitu(reinterpret_cast<char*>(stream.data()));
 
@@ -90,7 +90,7 @@ class PingMsgJsonSerializer final : public ISerializer, public Service<PingMsgJs
         }
 
         return new PingMsg{d["sequence"].GetUint64()};
-#elif USE_BOOST_JSON
+#elif ICHOR_USE_BOOST_JSON
         boost::json::parser p{};
 
         std::error_code ec;

diff --git a/include/ichor/Service.h b/include/ichor/Service.h
@@ -2,7 +2,7 @@
 
 #include <cstdint>
 #include <atomic>
-#include "sole.hpp"
+#include <sole/sole.h>
 #include <ichor/Common.h>
 #include <ichor/Concepts.h>
 #include <ichor/Enums.h>

diff --git a/include/ichor/services/network/http/HttpHostService.h b/include/ichor/services/network/http/HttpHostService.h
@@ -50,6 +50,7 @@ namespace Ichor {
         friend DependencyRegister;
 
         std::unique_ptr<tcp::acceptor> _httpAcceptor{};
+        // _httpStreams should only be modified from the boost thread
         unordered_map<uint64_t, std::unique_ptr<beast::tcp_stream>> _httpStreams{};
         std::atomic<uint64_t> _priority{INTERNAL_EVENT_PRIORITY};
         std::atomic<bool> _quit{};

diff --git a/...vices/network/http/HttpScopeGuardFinish.h → ...r/services/network/http/HttpScopeGuards.h b/...vices/network/http/HttpScopeGuardFinish.h → ...r/services/network/http/HttpScopeGuards.h
diff --git a/include/ichor/sole.hpp → include/sole/sole.h b/include/ichor/sole.hpp → include/sole/sole.h
diff --git a/sonar-project.properties b/sonar-project.properties
diff --git a/src/services/network/http/HttpConnectionService.cpp b/src/services/network/http/HttpConnectionService.cpp
@@ -3,7 +3,7 @@
 #include <ichor/DependencyManager.h>
 #include <ichor/events/RunFunctionEvent.h>
 #include <ichor/services/network/http/HttpConnectionService.h>
-#include <ichor/services/network/http/HttpScopeGuardFinish.h>
+#include <ichor/services/network/http/HttpScopeGuards.h>
 #include <ichor/services/network/NetworkEvents.h>
 
 namespace Ichor {

diff --git a/src/services/network/http/HttpHostService.cpp b/src/services/network/http/HttpHostService.cpp
@@ -2,7 +2,7 @@
 
 #include <ichor/DependencyManager.h>
 #include <ichor/services/network/http/HttpHostService.h>
-#include <ichor/services/network/http/HttpScopeGuardFinish.h>
+#include <ichor/services/network/http/HttpScopeGuards.h>
 
 Ichor::HttpHostService::HttpHostService(DependencyRegister &reg, Properties props, DependencyManager *mng) : Service(std::move(props), mng) {
     reg.registerDependency<ILogger>(this, true);
@@ -41,9 +41,12 @@ Ichor::StartBehaviour Ichor::HttpHostService::stop() {
         if (_httpAcceptor->is_open()) {
             _httpAcceptor->close();
         }
-        for(auto &[id, stream] : _httpStreams) {
-            stream->cancel();
-        }
+        net::spawn(*_httpContextService->getContext(), [this](net::yield_context _yield) {
+            // _httpStreams should only be modified from the boost thread
+            for (auto &[id, stream]: _httpStreams) {
+                stream->cancel();
+            }
+        });
 
         _httpAcceptor = nullptr;
         _cleanedupStream = true;
@@ -52,6 +55,7 @@ Ichor::StartBehaviour Ichor::HttpHostService::stop() {
     if(_finishedListenAndRead.load(std::memory_order_acquire) != 0 || !_cleanedupStream) {
         return Ichor::StartBehaviour::FAILED_AND_RETRY;
     }
+    // _httpStreams should only be modified from the boost thread, except here where we know there are no fibers running
     _httpStreams.clear();
 
     return Ichor::StartBehaviour::SUCCEEDED;
@@ -182,6 +186,7 @@ void Ichor::HttpHostService::read(tcp::socket socket, net::yield_context yield)
     beast::error_code ec;
     auto addr = socket.remote_endpoint().address().to_string();
     uint64_t streamId = _streamIdCounter++;
+    // _httpStreams should only be modified from the boost thread
     auto *httpStream = _httpStreams.emplace(streamId, std::make_unique<beast::tcp_stream>(std::move(socket))).first->second.get();
 
     // This buffer is required to persist across reads
@@ -265,6 +270,7 @@ void Ichor::HttpHostService::read(tcp::socket socket, net::yield_context yield)
             co_return;
         });
     }
+    // _httpStreams should only be modified from the boost thread
     _httpStreams.erase(streamId);
 
     // At this point the connection is closed gracefully
@@ -291,6 +297,7 @@ void Ichor::HttpHostService::sendInternal(uint64_t streamId, http::response<http
         while(!_outbox.empty()) {
             // Move message, should be trivially copyable and prevents iterator invalidation
             auto next = std::move(_outbox.front());
+            // _httpStreams should only be modified from the boost thread
             auto streamIt = _httpStreams.find(next.streamId);
 
             if (streamIt == end(_httpStreams)) {

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -12,6 +12,7 @@ foreach(filename ${PROJECT_TEST_SOURCES})
     target_link_libraries(${testname} ${CMAKE_THREAD_LIBS_INIT})
     target_link_libraries(${testname} ichor)
     target_link_libraries(${testname} Catch2::Catch2WithMain)
+    target_compile_definitions(${testname} PUBLIC CATCH_CONFIG_FAST_COMPILE)
 
     if(ICHOR_USE_SANITIZERS)
         target_link_libraries(${testname})