task.hpp

Go to the documentation of this file.

#pragma once
 
#include "graph.hpp"
 
namespace tf {
 
// ----------------------------------------------------------------------------
// Task Types
// ----------------------------------------------------------------------------
 
enum class TaskType : int {
  PLACEHOLDER = 0,
  CUDAFLOW,
  SYCLFLOW,
  STATIC,
  DYNAMIC,
  CONDITION,
  MULTI_CONDITION,
  MODULE,
  ASYNC,
  RUNTIME,
  UNDEFINED
};
 
inline constexpr std::array<TaskType, 10> TASK_TYPES = {
  TaskType::PLACEHOLDER,
  TaskType::CUDAFLOW,
  TaskType::SYCLFLOW,
  TaskType::STATIC,
  TaskType::DYNAMIC,
  TaskType::CONDITION,
  TaskType::MULTI_CONDITION,
  TaskType::MODULE,
  TaskType::ASYNC,
  TaskType::RUNTIME
};
 
inline const char* to_string(TaskType type) {
 
  const char* val;
 
  switch(type) {
    case TaskType::PLACEHOLDER:      val = "placeholder";     break;
    case TaskType::CUDAFLOW:         val = "cudaflow";        break;
    case TaskType::SYCLFLOW:         val = "syclflow";        break;
    case TaskType::STATIC:           val = "static";          break;
    case TaskType::DYNAMIC:          val = "subflow";         break;
    case TaskType::CONDITION:        val = "condition";       break;
    case TaskType::MULTI_CONDITION:  val = "multi_condition"; break;
    case TaskType::MODULE:           val = "module";          break;
    case TaskType::ASYNC:            val = "async";           break;
    case TaskType::RUNTIME:          val = "runtime";         break;
    default:                         val = "undefined";       break;
  }
 
  return val;
}
 
// ----------------------------------------------------------------------------
// Task Traits
// ----------------------------------------------------------------------------
 
template <typename C>
constexpr bool is_static_task_v =
  std::is_invocable_r_v<void, C> &&
  !std::is_invocable_r_v<int, C> &&
  !std::is_invocable_r_v<tf::SmallVector<int>, C>;
 
template <typename C>
constexpr bool is_dynamic_task_v = std::is_invocable_r_v<void, C, Subflow&>;
 
template <typename C>
constexpr bool is_condition_task_v = std::is_invocable_r_v<int, C>;
 
template <typename C>
constexpr bool is_multi_condition_task_v =
  std::is_invocable_r_v<SmallVector<int>, C>;
 
template <typename C>
constexpr bool is_cudaflow_task_v = std::is_invocable_r_v<void, C, cudaFlow&> ||
                                    std::is_invocable_r_v<void, C, cudaFlowCapturer&>;
 
template <typename C>
constexpr bool is_syclflow_task_v = std::is_invocable_r_v<void, C, syclFlow&>;
 
template <typename C>
constexpr bool is_runtime_task_v = std::is_invocable_r_v<void, C, Runtime&>;
 
// ----------------------------------------------------------------------------
// Task
// ----------------------------------------------------------------------------
 
class Task {
 
  friend class FlowBuilder;
  friend class Runtime;
  friend class Taskflow;
  friend class TaskView;
  friend class Executor;
 
  public:
 
    Task() = default;
 
    Task(const Task& other);
 
    Task& operator = (const Task&);
 
    Task& operator = (std::nullptr_t);
 
    bool operator == (const Task& rhs) const;
 
    bool operator != (const Task& rhs) const;
 
    const std::string& name() const;
 
    size_t num_successors() const;
 
    size_t num_dependents() const;
 
    size_t num_strong_dependents() const;
 
    size_t num_weak_dependents() const;
 
    Task& name(const std::string& name);
 
    template <typename C>
    Task& work(C&& callable);
 
    template <typename T>
    Task& composed_of(T& object);
 
    template <typename... Ts>
    Task& precede(Ts&&... tasks);
 
    template <typename... Ts>
    Task& succeed(Ts&&... tasks);
 
    Task& release(Semaphore& semaphore);
 
    Task& acquire(Semaphore& semaphore);
 
    Task& data(void* data);
 
    void reset();
 
    void reset_work();
 
    bool empty() const;
 
    bool has_work() const;
 
    template <typename V>
    void for_each_successor(V&& visitor) const;
 
    template <typename V>
    void for_each_dependent(V&& visitor) const;
 
    size_t hash_value() const;
 
    TaskType type() const;
 
    void dump(std::ostream& ostream) const;
 
    void* data() const;
 
 
  private:
 
    Task(Node*);
 
    Node* _node {nullptr};
};
 
// Constructor
inline Task::Task(Node* node) : _node {node} {
}
 
// Constructor
inline Task::Task(const Task& rhs) : _node {rhs._node} {
}
 
// Function: precede
template <typename... Ts>
Task& Task::precede(Ts&&... tasks) {
  (_node->_precede(tasks._node), ...);
  //_precede(std::forward<Ts>(tasks)...);
  return *this;
}
 
// Function: succeed
template <typename... Ts>
Task& Task::succeed(Ts&&... tasks) {
  (tasks._node->_precede(_node), ...);
  //_succeed(std::forward<Ts>(tasks)...);
  return *this;
}
 
// Function: composed_of
template <typename T>
Task& Task::composed_of(T& object) {
  _node->_handle.emplace<Node::Module>(object);
  return *this;
}
 
// Operator =
inline Task& Task::operator = (const Task& rhs) {
  _node = rhs._node;
  return *this;
}
 
// Operator =
inline Task& Task::operator = (std::nullptr_t ptr) {
  _node = ptr;
  return *this;
}
 
// Operator ==
inline bool Task::operator == (const Task& rhs) const {
  return _node == rhs._node;
}
 
// Operator !=
inline bool Task::operator != (const Task& rhs) const {
  return _node != rhs._node;
}
 
// Function: name
inline Task& Task::name(const std::string& name) {
  _node->_name = name;
  return *this;
}
 
// Function: acquire
inline Task& Task::acquire(Semaphore& s) {
  if(!_node->_semaphores) {
    _node->_semaphores = std::make_unique<Node::Semaphores>();
  }
  _node->_semaphores->to_acquire.push_back(&s);
  return *this;
}
 
// Function: release
inline Task& Task::release(Semaphore& s) {
  if(!_node->_semaphores) {
    //_node->_semaphores.emplace();
    _node->_semaphores = std::make_unique<Node::Semaphores>();
  }
  _node->_semaphores->to_release.push_back(&s);
  return *this;
}
 
// Procedure: reset
inline void Task::reset() {
  _node = nullptr;
}
 
// Procedure: reset_work
inline void Task::reset_work() {
  _node->_handle.emplace<std::monostate>();
}
 
// Function: name
inline const std::string& Task::name() const {
  return _node->_name;
}
 
// Function: num_dependents
inline size_t Task::num_dependents() const {
  return _node->num_dependents();
}
 
// Function: num_strong_dependents
inline size_t Task::num_strong_dependents() const {
  return _node->num_strong_dependents();
}
 
// Function: num_weak_dependents
inline size_t Task::num_weak_dependents() const {
  return _node->num_weak_dependents();
}
 
// Function: num_successors
inline size_t Task::num_successors() const {
  return _node->num_successors();
}
 
// Function: empty
inline bool Task::empty() const {
  return _node == nullptr;
}
 
// Function: has_work
inline bool Task::has_work() const {
  return _node ? _node->_handle.index() != 0 : false;
}
 
// Function: task_type
inline TaskType Task::type() const {
  switch(_node->_handle.index()) {
    case Node::PLACEHOLDER:     return TaskType::PLACEHOLDER;
    case Node::STATIC:          return TaskType::STATIC;
    case Node::DYNAMIC:         return TaskType::DYNAMIC;
    case Node::CONDITION:       return TaskType::CONDITION;
    case Node::MULTI_CONDITION: return TaskType::MULTI_CONDITION;
    case Node::MODULE:          return TaskType::MODULE;
    case Node::ASYNC:           return TaskType::ASYNC;
    case Node::SILENT_ASYNC:    return TaskType::ASYNC;
    case Node::CUDAFLOW:        return TaskType::CUDAFLOW;
    case Node::SYCLFLOW:        return TaskType::SYCLFLOW;
    case Node::RUNTIME:         return TaskType::RUNTIME;
    default:                    return TaskType::UNDEFINED;
  }
}
 
// Function: for_each_successor
template <typename V>
void Task::for_each_successor(V&& visitor) const {
  for(size_t i=0; i<_node->_successors.size(); ++i) {
    visitor(Task(_node->_successors[i]));
  }
}
 
// Function: for_each_dependent
template <typename V>
void Task::for_each_dependent(V&& visitor) const {
  for(size_t i=0; i<_node->_dependents.size(); ++i) {
    visitor(Task(_node->_dependents[i]));
  }
}
 
// Function: hash_value
inline size_t Task::hash_value() const {
  return std::hash<Node*>{}(_node);
}
 
// Procedure: dump
inline void Task::dump(std::ostream& os) const {
  os << "task ";
  if(name().empty()) os << _node;
  else os << name();
  os << " [type=" << to_string(type()) << ']';
}
 
// Function: work
template <typename C>
Task& Task::work(C&& c) {
 
  if constexpr(is_static_task_v<C>) {
    _node->_handle.emplace<Node::Static>(std::forward<C>(c));
  }
  else if constexpr(is_dynamic_task_v<C>) {
    _node->_handle.emplace<Node::Dynamic>(std::forward<C>(c));
  }
  else if constexpr(is_condition_task_v<C>) {
    _node->_handle.emplace<Node::Condition>(std::forward<C>(c));
  }
  else if constexpr(is_multi_condition_task_v<C>) {
    _node->_handle.emplace<Node::MultiCondition>(std::forward<C>(c));
  }
  else if constexpr(is_cudaflow_task_v<C>) {
    _node->_handle.emplace<Node::cudaFlow>(std::forward<C>(c));
  }
  else if constexpr(is_runtime_task_v<C>) {
    _node->_handle.emplace<Node::Runtime>(std::forward<C>(c));
  }
  else {
    static_assert(dependent_false_v<C>, "invalid task callable");
  }
  return *this;
}
 
// Function: name
inline void* Task::data() const {
  return _node->_data;
}
 
// Function: name
inline Task& Task::data(void* data) {
  _node->_data = data;
  return *this;
}
 
// ----------------------------------------------------------------------------
// global ostream
// ----------------------------------------------------------------------------
 
inline std::ostream& operator << (std::ostream& os, const Task& task) {
  task.dump(os);
  return os;
}
 
// ----------------------------------------------------------------------------
 
class TaskView {
 
  friend class Executor;
 
  public:
 
    const std::string& name() const;
 
    size_t num_successors() const;
 
    size_t num_dependents() const;
 
    size_t num_strong_dependents() const;
 
    size_t num_weak_dependents() const;
 
    template <typename V>
    void for_each_successor(V&& visitor) const;
 
    template <typename V>
    void for_each_dependent(V&& visitor) const;
 
    TaskType type() const;
 
    size_t hash_value() const;
 
  private:
 
    TaskView(const Node&);
    TaskView(const TaskView&) = default;
 
    const Node& _node;
};
 
// Constructor
inline TaskView::TaskView(const Node& node) : _node {node} {
}
 
// Function: name
inline const std::string& TaskView::name() const {
  return _node._name;
}
 
// Function: num_dependents
inline size_t TaskView::num_dependents() const {
  return _node.num_dependents();
}
 
// Function: num_strong_dependents
inline size_t TaskView::num_strong_dependents() const {
  return _node.num_strong_dependents();
}
 
// Function: num_weak_dependents
inline size_t TaskView::num_weak_dependents() const {
  return _node.num_weak_dependents();
}
 
// Function: num_successors
inline size_t TaskView::num_successors() const {
  return _node.num_successors();
}
 
// Function: type
inline TaskType TaskView::type() const {
  switch(_node._handle.index()) {
    case Node::PLACEHOLDER:     return TaskType::PLACEHOLDER;
    case Node::STATIC:          return TaskType::STATIC;
    case Node::DYNAMIC:         return TaskType::DYNAMIC;
    case Node::CONDITION:       return TaskType::CONDITION;
    case Node::MULTI_CONDITION: return TaskType::MULTI_CONDITION;
    case Node::MODULE:          return TaskType::MODULE;
    case Node::ASYNC:           return TaskType::ASYNC;
    case Node::SILENT_ASYNC:    return TaskType::ASYNC;
    case Node::CUDAFLOW:        return TaskType::CUDAFLOW;
    case Node::SYCLFLOW:        return TaskType::SYCLFLOW;
    case Node::RUNTIME:         return TaskType::RUNTIME;
    default:                    return TaskType::UNDEFINED;
  }
}
 
// Function: hash_value
inline size_t TaskView::hash_value() const {
  return std::hash<const Node*>{}(&_node);
}
 
// Function: for_each_successor
template <typename V>
void TaskView::for_each_successor(V&& visitor) const {
  for(size_t i=0; i<_node._successors.size(); ++i) {
    visitor(TaskView(_node._successors[i]));
  }
}
 
// Function: for_each_dependent
template <typename V>
void TaskView::for_each_dependent(V&& visitor) const {
  for(size_t i=0; i<_node._dependents.size(); ++i) {
    visitor(TaskView(_node._dependents[i]));
  }
}
 
}  // end of namespace tf. ---------------------------------------------------
 
namespace std {
 
template <>
struct hash<tf::Task> {
  auto operator() (const tf::Task& task) const noexcept {
    return task.hash_value();
  }
};
 
template <>
struct hash<tf::TaskView> {
  auto operator() (const tf::TaskView& task_view) const noexcept {
    return task_view.hash_value();
  }
};
 
}  // end of namespace std ----------------------------------------------------