Rename tbb_task to fork_join_task.

app/playground/main.cpp

@@ -12,7 +12,7 @@ using namespace pls;
 // Example for static memory allocation (no malloc or free required)
 static static_scheduler_memory<8, 2 << 12> my_scheduler_memory;
 
-class fib: public tbb_sub_task {
+class fib: public fork_join_sub_task {
     static constexpr int CUTOFF = 20;
 
     int num_;
@@ -64,7 +64,7 @@ int main() {
         int result;
 
         fib fib_sub_task{45, &result};
-        tbb_task tbb_task{&fib_sub_task, task_id{1}};
+        fork_join_task tbb_task{&fib_sub_task, task_id{1}};
         scheduler::execute_task(tbb_task);
 
         std::cout << "Result: " << result << std::endl;

lib/pls/CMakeLists.txt

@@ -12,8 +12,9 @@ add_library(pls STATIC
             src/internal/base/aligned_stack.cpp include/pls/internal/base/aligned_stack.h
             include/pls/internal/base/system_details.h
             src/internal/scheduling/run_on_n_threads_task.cpp include/pls/internal/scheduling/run_on_n_threads_task.h
-            src/internal/scheduling/tbb_task.cpp include/pls/internal/scheduling/tbb_task.h
-            src/internal/base/deque.cpp include/pls/internal/base/deque.h)
+            src/internal/scheduling/fork_join_task.cpp include/pls/internal/scheduling/fork_join_task.h
+            src/internal/base/deque.cpp include/pls/internal/base/deque.h
+            src/algorithms/invoke_parallel.cpp include/pls/algorithms/invoke_parallel.h)
 
 # Add everything in `./include` to be in the include path of this project
 target_include_directories(pls

lib/pls/include/pls/algorithms/invoke_parallel.h

+
+#ifndef PLS_PARALLEL_INVOKE_H
+#define PLS_PARALLEL_INVOKE_H
+
+namespace pls {
+    namespace algorithm {
+//        template<typename Function1, typename Function2>
+//        void invoke_parallel(Function1 function1, Function2 function2) {
+//            if (already_this_invoke_parallel_instance) {
+//
+//            }
+//        }
+    }
+}
+
+#endif //PLS_PARALLEL_INVOKE_H

lib/pls/include/pls/internal/scheduling/tbb_task.h → lib/pls/include/pls/internal/scheduling/fork_join_task.h

@@ -11,22 +11,22 @@
 namespace pls {
     namespace internal {
         namespace scheduling {
-            class tbb_task;
-            class tbb_sub_task: public base::deque_item {
-                friend class tbb_task;
+            class fork_join_task;
+            class fork_join_sub_task: public base::deque_item {
+                friend class fork_join_task;
 
                 // Coordinate finishing of sub_tasks
                 std::atomic_uint32_t ref_count_;
-                tbb_sub_task* parent_;
+                fork_join_sub_task* parent_;
 
                 // Access to TBB scheduling environment
-                tbb_task* tbb_task_;
+                fork_join_task* tbb_task_;
 
                 // Stack Management (reset stack pointer after wait_for_all() calls)
                 base::aligned_stack::state stack_state_;
             protected:
-                explicit tbb_sub_task();
-                tbb_sub_task(const tbb_sub_task& other);
+                explicit fork_join_sub_task();
+                fork_join_sub_task(const fork_join_sub_task& other);
 
                 virtual void execute_internal() = 0;
                 // SubClass Implementations:
@@ -42,7 +42,7 @@ namespace pls {
                 void spawn_child(const T& sub_task);
                 void wait_for_all();
             private:
-                void spawn_child_internal(tbb_sub_task* sub_task);
+                void spawn_child_internal(fork_join_sub_task* sub_task);
                 void execute();
 
             public:
@@ -51,26 +51,26 @@ namespace pls {
                 }
             };
 
-            class tbb_task: public abstract_task {
-                friend class tbb_sub_task;
+            class fork_join_task: public abstract_task {
+                friend class fork_join_sub_task;
 
-                tbb_sub_task* root_task_;
+                fork_join_sub_task* root_task_;
                 base::aligned_stack* my_stack_;
 
                 // Double-Ended Queue management
-                base::deque<tbb_sub_task> deque_;
+                base::deque<fork_join_sub_task> deque_;
 
                 // Steal Management
-                tbb_sub_task* last_stolen_;
+                fork_join_sub_task* last_stolen_;
 
-                tbb_sub_task* get_local_sub_task();
-                tbb_sub_task* get_stolen_sub_task();
+                fork_join_sub_task* get_local_sub_task();
+                fork_join_sub_task* get_stolen_sub_task();
 
                 bool internal_stealing(abstract_task* other_task) override;
                 bool split_task(base::spin_lock* /*lock*/) override;
 
             public:
-                explicit tbb_task(tbb_sub_task* root_task, const abstract_task::id& id):
+                explicit fork_join_task(fork_join_sub_task* root_task, const abstract_task::id& id):
                         abstract_task{0, id},
                         root_task_{root_task},
                         my_stack_{nullptr},
@@ -89,8 +89,8 @@ namespace pls {
             };
 
             template<typename T>
-            void tbb_sub_task::spawn_child(const T& task)  {
-                static_assert(std::is_base_of<tbb_sub_task, T>::value, "Only pass tbb_sub_task subclasses!");
+            void fork_join_sub_task::spawn_child(const T& task)  {
+                static_assert(std::is_base_of<fork_join_sub_task, T>::value, "Only pass fork_join_sub_task subclasses!");
 
                 T* new_task = tbb_task_->my_stack_->push(task);
                 spawn_child_internal(new_task);

lib/pls/include/pls/pls.h

@@ -2,7 +2,7 @@
 #define PLS_LIBRARY_H
 
 #include "pls/internal/scheduling/scheduler.h"
-#include "pls/internal/scheduling/tbb_task.h"
+#include "pls/internal/scheduling/fork_join_task.h"
 #include "pls/internal/scheduling/abstract_task.h"
 
 namespace pls {
@@ -10,8 +10,8 @@ namespace pls {
     using internal::scheduling::static_scheduler_memory;
     using task_id = internal::scheduling::abstract_task::id;
 
-    using internal::scheduling::tbb_sub_task;
-    using internal::scheduling::tbb_task;
+    using internal::scheduling::fork_join_sub_task;
+    using internal::scheduling::fork_join_task;
 }
 
 #endif

lib/pls/src/algorithms/invoke_parallel.cpp

+#include "pls/algorithms/invoke_parallel.h"

lib/pls/src/internal/scheduling/tbb_task.cpp → lib/pls/src/internal/scheduling/fork_join_task.cpp

 #include "pls/internal/scheduling/scheduler.h"
-#include "pls/internal/scheduling/tbb_task.h"
+#include "pls/internal/scheduling/fork_join_task.h"
 
 namespace pls {
     namespace internal {
         namespace scheduling {
-            tbb_sub_task::tbb_sub_task():
+            fork_join_sub_task::fork_join_sub_task():
                 base::deque_item{},
                 ref_count_{0},
                 parent_{nullptr},
                 tbb_task_{nullptr},
                 stack_state_{nullptr} {}
 
-            tbb_sub_task::tbb_sub_task(const tbb_sub_task& other): base::deque_item(other) {
+            fork_join_sub_task::fork_join_sub_task(const fork_join_sub_task& other): base::deque_item(other) {
                 // Do Nothing, will be inited after this anyways
             }
 
-            void tbb_sub_task::execute()  {
+            void fork_join_sub_task::execute()  {
                 execute_internal();
                 wait_for_all();
 
@@ -24,7 +24,7 @@ namespace pls {
                 }
             }
 
-            void tbb_sub_task::spawn_child_internal(tbb_sub_task* sub_task) {
+            void fork_join_sub_task::spawn_child_internal(fork_join_sub_task* sub_task) {
                 // Keep our refcount up to date
                 ref_count_++;
 
@@ -36,9 +36,9 @@ namespace pls {
                 tbb_task_->deque_.push_tail(sub_task);
             }
 
-            void tbb_sub_task::wait_for_all() {
+            void fork_join_sub_task::wait_for_all() {
                 while (ref_count_ > 0) {
-                    tbb_sub_task* local_task = tbb_task_->get_local_sub_task();
+                    fork_join_sub_task* local_task = tbb_task_->get_local_sub_task();
                     if (local_task != nullptr) {
                         local_task->execute();
                     } else {
@@ -52,22 +52,22 @@ namespace pls {
                 tbb_task_->my_stack_->reset_state(stack_state_);
             }
 
-            tbb_sub_task* tbb_task::get_local_sub_task() {
+            fork_join_sub_task* fork_join_task::get_local_sub_task() {
                 return deque_.pop_tail();
             }
 
-            tbb_sub_task* tbb_task::get_stolen_sub_task() {
+            fork_join_sub_task* fork_join_task::get_stolen_sub_task() {
                 return deque_.pop_head();
             }
 
-            bool tbb_task::internal_stealing(abstract_task* other_task) {
-                auto cast_other_task = reinterpret_cast<tbb_task*>(other_task);
+            bool fork_join_task::internal_stealing(abstract_task* other_task) {
+                auto cast_other_task = reinterpret_cast<fork_join_task*>(other_task);
 
                 auto stolen_sub_task = cast_other_task->get_stolen_sub_task();
                 if (stolen_sub_task == nullptr) {
                     return false;
                 } else {
-                    // Make sub-task belong to our tbb_task instance
+                    // Make sub-task belong to our fork_join_task instance
                     stolen_sub_task->tbb_task_ = this;
                     stolen_sub_task->stack_state_ = my_stack_->save_state();
                     // We will execute this next without explicitly moving it onto our stack storage
@@ -77,12 +77,12 @@ namespace pls {
                 }
             }
 
-            bool tbb_task::split_task(base::spin_lock* lock) {
-                tbb_sub_task* stolen_sub_task = get_stolen_sub_task();
+            bool fork_join_task::split_task(base::spin_lock* lock) {
+                fork_join_sub_task* stolen_sub_task = get_stolen_sub_task();
                 if (stolen_sub_task == nullptr) {
                     return false;
                 }
-                tbb_task task{stolen_sub_task, this->unique_id()};
+                fork_join_task task{stolen_sub_task, this->unique_id()};
 
                 // In success case, unlock.
                 // TODO: this locking is complicated and error prone.

test/scheduling_tests.cpp

@@ -4,7 +4,7 @@
 
 using namespace pls;
 
-class once_sub_task: public tbb_sub_task {
+class once_sub_task: public fork_join_sub_task {
     std::atomic<int>* counter_;
     int children_;
 
@@ -18,12 +18,12 @@ protected:
 
 public:
     explicit once_sub_task(std::atomic<int>* counter, int children):
-        tbb_sub_task(),
+        fork_join_sub_task(),
         counter_{counter},
         children_{children} {}
 };
 
-class force_steal_sub_task: public tbb_sub_task {
+class force_steal_sub_task: public fork_join_sub_task {
     std::atomic<int>* parent_counter_;
     std::atomic<int>* overall_counter_;
 
@@ -42,12 +42,12 @@ protected:
 
 public:
     explicit force_steal_sub_task(std::atomic<int>* parent_counter, std::atomic<int>* overall_counter):
-            tbb_sub_task(),
+            fork_join_sub_task(),
             parent_counter_{parent_counter},
             overall_counter_{overall_counter} {}
 };
 
-TEST_CASE( "tbb task are scheduled correctly", "[internal/scheduling/tbb_task.h]") {
+TEST_CASE( "tbb task are scheduled correctly", "[internal/scheduling/fork_join_task.h]") {
     static static_scheduler_memory<8, 2 << 12> my_scheduler_memory;
 
     SECTION("tasks are executed exactly once") {
@@ -58,7 +58,7 @@ TEST_CASE( "tbb task are scheduled correctly", "[internal/scheduling/tbb_task.h]
 
         my_scheduler.perform_work([&] (){
             once_sub_task sub_task{&counter, start_counter};
-            tbb_task task{&sub_task};
+            fork_join_task task{&sub_task};
             scheduler::execute_task(task);
         });
 
@@ -71,7 +71,7 @@ TEST_CASE( "tbb task are scheduled correctly", "[internal/scheduling/tbb_task.h]
         my_scheduler.perform_work([&] (){
             std::atomic<int> dummy_parent{1}, overall_counter{8};
             force_steal_sub_task sub_task{&dummy_parent, &overall_counter};
-            tbb_task task{&sub_task};
+            fork_join_task task{&sub_task};
             scheduler::execute_task(task);
         });
         my_scheduler.terminate(true);