Task system: Send incoming tasks directly to waiting executors (#7315)

Co-authored-by: Amaury Chamayou <[email protected]>

Author: eddyashton

.clang-tidy

@@ -8,6 +8,8 @@ Checks: >
   -bugprone-assignment-in-if-condition,
   -bugprone-casting-through-void,
   cert-*,
+  -cert-con36-c,
+  -cert-con54-cpp,
   -cert-err58-cpp,
   -cert-dcl50-cpp,
   concurrency-*,

CMakeLists.txt

@@ -279,9 +279,11 @@ add_ccf_static_library(
 # CCF task system library
 add_ccf_static_library(
   ccf_tasks
-  SRCS ${CCF_DIR}/src/tasks/task_system.cpp ${CCF_DIR}/src/tasks/job_board.cpp
+  SRCS ${CCF_DIR}/src/tasks/task_system.cpp
+       ${CCF_DIR}/src/tasks/job_board.cpp
        ${CCF_DIR}/src/tasks/ordered_tasks.cpp
        ${CCF_DIR}/src/tasks/fan_in_tasks.cpp
+       ${CCF_DIR}/src/tasks/thread_manager.cpp
 )
 
 # Common test args for Python scripts starting up CCF networks
@@ -564,6 +566,7 @@ if(BUILD_TESTS)
       ${CMAKE_CURRENT_SOURCE_DIR}/src/tasks/test/ordered_tasks.cpp
       ${CMAKE_CURRENT_SOURCE_DIR}/src/tasks/test/delayed_tasks.cpp
       ${CMAKE_CURRENT_SOURCE_DIR}/src/tasks/test/fan_in_tasks.cpp
+      ${CMAKE_CURRENT_SOURCE_DIR}/src/tasks/test/tasks_api.cpp
     )
     target_link_libraries(task_system_test PRIVATE ccf_tasks)
 

doc/build_apps/example_cpp.rst

@@ -221,7 +221,7 @@ A :cpp:type:`ccf::indexing::Strategy` may offload partial results to disk to avo
 Since the indexing system and all the strategies it manages exist entirely within the enclave, this has the same trust guarantees as any other in-enclave code - users can trust that the results are accurate and complete, and the query may process private data.
 
 An example :cpp:type:`ccf::indexing::Strategy` is included in the logging app, to accelerate historical range queries.
-This :cpp:type:`strategy <ccf::indexing::strategies::SeqnosByKey_Bucketed_Untyped>` stores the list of seqnos where every key is written to, offloading completed ranges to disk to cap the total memory useage.
+This :cpp:type:`strategy <ccf::indexing::strategies::SeqnosByKey_Bucketed_Untyped>` stores the list of seqnos where every key is written to, offloading completed ranges to disk to cap the total memory usage.
 In the endpoint handler, rather than requesting every transaction in the requested range, the node relies on its index to fetch only the `interesting` transactions; those which write to the target key:
 
 .. literalinclude:: ../../samples/apps/logging/logging.cpp

src/tasks/basic_task.h

@@ -13,15 +13,17 @@ namespace ccf::tasks
     Fn fn;
     const std::string name;
 
-    BasicTask(const Fn& _fn, const std::string& s = "[Anon]") : fn(_fn), name(s)
+    BasicTask(const Fn& fn_, const std::string& s = "BasicTask") :
+      fn(fn_),
+      name(s)
     {}
 
     void do_task_implementation() override
     {
       fn();
     }
 
-    std::string_view get_name() const override
+    const std::string& get_name() const override
     {
       return name;
     }

src/tasks/fan_in_tasks.cpp

@@ -14,8 +14,7 @@ namespace ccf::tasks
 {
   struct FanInTasks::PImpl
   {
-    std::string name;
-    IJobBoard& job_board;
+    JobBoard& job_board;
 
     // Synchronise access to pending_tasks and next_expected_task_index
     std::mutex pending_tasks_mutex;
@@ -71,16 +70,16 @@ namespace ccf::tasks
 
   FanInTasks::FanInTasks(
     [[maybe_unused]] FanInTasks::Private force_private_constructor,
-    IJobBoard& job_board_,
-    const std::string& name_) :
-    pimpl(std::make_unique<FanInTasks::PImpl>(name_, job_board_))
+    JobBoard& job_board_) :
+    pimpl(std::make_unique<FanInTasks::PImpl>(job_board_))
   {}
 
   FanInTasks::~FanInTasks() = default;
 
-  std::string_view FanInTasks::get_name() const
+  const std::string& FanInTasks::get_name() const
   {
-    return pimpl->name;
+    static const std::string name = "FanInTasks";
+    return name;
   }
 
   void FanInTasks::add_task(size_t task_index, Task task)
@@ -124,9 +123,8 @@ namespace ccf::tasks
     }
   }
 
-  std::shared_ptr<FanInTasks> FanInTasks::create(
-    IJobBoard& job_board_, const std::string& name_)
+  std::shared_ptr<FanInTasks> FanInTasks::create(JobBoard& job_board_)
   {
-    return std::make_shared<FanInTasks>(Private{}, job_board_, name_);
+    return std::make_shared<FanInTasks>(Private{}, job_board_);
   }
 }

src/tasks/fan_in_tasks.h

@@ -2,7 +2,7 @@
 // Licensed under the Apache 2.0 License.
 #pragma once
 
-#include "tasks/job_board_interface.h"
+#include "tasks/job_board.h"
 #include "tasks/task.h"
 
 #include <memory>
@@ -27,13 +27,12 @@ namespace ccf::tasks
     };
 
   public:
-    FanInTasks(Private, IJobBoard& job_board_, const std::string& name_);
+    FanInTasks(Private, JobBoard& job_board_);
     ~FanInTasks();
 
-    static std::shared_ptr<FanInTasks> create(
-      IJobBoard& job_board_, const std::string& name_ = "[FanIn]");
+    static std::shared_ptr<FanInTasks> create(JobBoard& job_board_);
 
-    std::string_view get_name() const override;
+    const std::string& get_name() const override;
 
     void add_task(size_t task_index, Task task);
   };