17#ifndef __TBB_flow_graph_impl_H
18#define __TBB_flow_graph_impl_H
20#include "../tbb_stddef.h"
22#include "../task_arena.h"
23#include "../flow_graph_abstractions.h"
25#if __TBB_PREVIEW_FLOW_GRAPH_PRIORITIES
26#include "../concurrent_priority_queue.h"
31#if TBB_DEPRECATED_FLOW_ENQUEUE
32#define FLOW_SPAWN(a) tbb::task::enqueue((a))
34#define FLOW_SPAWN(a) tbb::task::spawn((a))
37#if __TBB_PREVIEW_FLOW_GRAPH_PRIORITIES
38#define __TBB_FLOW_GRAPH_PRIORITY_EXPR( expr ) expr
39#define __TBB_FLOW_GRAPH_PRIORITY_ARG0( priority ) , priority
40#define __TBB_FLOW_GRAPH_PRIORITY_ARG1( arg1, priority ) arg1, priority
42#define __TBB_FLOW_GRAPH_PRIORITY_EXPR( expr )
43#define __TBB_FLOW_GRAPH_PRIORITY_ARG0( priority )
44#define __TBB_FLOW_GRAPH_PRIORITY_ARG1( arg1, priority ) arg1
47#if TBB_DEPRECATED_LIMITER_NODE_CONSTRUCTOR
48#define __TBB_DEPRECATED_LIMITER_EXPR( expr ) expr
49#define __TBB_DEPRECATED_LIMITER_ARG2( arg1, arg2 ) arg1, arg2
50#define __TBB_DEPRECATED_LIMITER_ARG4( arg1, arg2, arg3, arg4 ) arg1, arg3, arg4
52#define __TBB_DEPRECATED_LIMITER_EXPR( expr )
53#define __TBB_DEPRECATED_LIMITER_ARG2( arg1, arg2 ) arg1
54#define __TBB_DEPRECATED_LIMITER_ARG4( arg1, arg2, arg3, arg4 ) arg1, arg2
62#if __TBB_PREVIEW_FLOW_GRAPH_PRIORITIES
68namespace interface10 {
72namespace interface11 {
76#if __TBB_PREVIEW_FLOW_GRAPH_PRIORITIES
90template <
typename GraphContainerType,
typename GraphNodeType>
112 if (
this != &other) {
174#if __TBB_PREVIEW_FLOW_GRAPH_PRIORITIES
190 __TBB_ASSERT_EX( result,
"Number of critical tasks for scheduler and tasks"
191 " in graph's priority queue mismatched" );
193 "Incorrect task submitted to graph priority queue" );
195 "Tasks from graph's priority queue must have priority" );
208namespace interface10 {
214 template<
typename Body >
219 , tbb::flow::interface11::node_priority_t node_priority = tbb::flow::interface11::no_priority
233 template<
typename Receiver,
typename Body >
239 if (res == tbb::flow::interface11::SUCCESSFULLY_ENQUEUED) res = NULL;
291#if TBB_PREVIEW_FLOW_GRAPH_TRACE
292 void set_name(
const char *
name);
316 template< typename Receiver, typename Body >
319 task* rtask =
new (task::allocate_additional_child_of(*
root_task()))
328 template<
typename Body >
342#if TBB_USE_EXCEPTIONS
346#if __TBB_TASK_GROUP_CONTEXT
349#if TBB_USE_EXCEPTIONS
359#if __TBB_TASK_GROUP_CONTEXT
367#if __TBB_TASK_GROUP_CONTEXT
379 template<
typename C,
typename N>
409#if __TBB_TASK_GROUP_CONTEXT
426#if __TBB_PREVIEW_FLOW_GRAPH_PRIORITIES
443namespace interface11 {
447#if __TBB_PREVIEW_FLOW_GRAPH_NODE_SET
449class get_graph_helper;
456 template<
typename C,
typename N>
459#if __TBB_PREVIEW_FLOW_GRAPH_NODE_SET
460 friend class internal::get_graph_helper;
471#if TBB_PREVIEW_FLOW_GRAPH_TRACE
472 virtual void set_name(
const char *
name) = 0;
475#if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
476 virtual void extract() = 0;
498#if __TBB_PREVIEW_FLOW_GRAPH_PRIORITIES
500 task* critical_task = &t;
512 return *critical_task;
#define __TBB_PREVIEW_FLOW_GRAPH_PRIORITIES
#define __TBB_ASSERT_EX(predicate, comment)
"Extended" version is useful to suppress warnings if a variable is only used with an assert
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
void const char const char int ITT_FORMAT __itt_group_sync x void const char * name
void make_critical(task &t)
void spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
void deactivate_graph(tbb::flow::interface10::graph &g)
void enqueue_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Enqueues a task inside graph arena.
bool is_graph_active(tbb::flow::interface10::graph &g)
tbb::task & prioritize_task(tbb::flow::interface10::graph &g, tbb::task &arena_task)
tbb::concurrent_priority_queue< graph_task *, graph_task_comparator > graph_task_priority_queue_t
void add_task_to_graph_reset_list(tbb::flow::interface10::graph &g, tbb::task *tp)
void activate_graph(tbb::flow::interface10::graph &g)
static const node_priority_t no_priority
unsigned int node_priority_t
static tbb::task *const SUCCESSFULLY_ENQUEUED
Concurrent priority queue.
void push(const_reference elem)
Pushes elem onto the queue, increasing capacity of queue if necessary.
bool try_pop(reference elem)
Gets a reference to and removes highest priority element.
Pure virtual template classes that define interfaces for async communication.
Base class for tasks generated by graph nodes.
graph_task(node_priority_t node_priority=no_priority)
graph_iterator & operator++()
Pre-increment.
graph_iterator()
Default constructor.
reference operator*() const
Dereference.
graph_iterator operator++(int)
Post-increment.
graph_iterator(const graph_iterator &other)
Copy constructor.
bool operator!=(const graph_iterator &other) const
Inequality.
GraphContainerType * my_graph
pointer operator->() const
Dereference.
graph_iterator(GraphContainerType *g, bool begin)
Private initializing constructor for begin() and end() iterators.
const GraphNodeType & const_reference
std::forward_iterator_tag iterator_category
bool operator==(const graph_iterator &other) const
Equality.
GraphNodeType & reference
graph_iterator & operator=(const graph_iterator &other)
Assignment.
bool operator()(const graph_task *left, const graph_task *right)
priority_task_selector(graph_task_priority_queue_t &priority_queue)
graph_task_priority_queue_t & my_priority_queue
task * execute() __TBB_override
Should be overridden by derived classes.
void register_node(tbb::flow::interface11::graph_node *n)
tbb::flow::interface11::graph_iterator< const graph, const tbb::flow::interface11::graph_node > const_iterator
const_iterator cbegin() const
start const iterator
task_list_type my_reset_task_list
bool is_cancelled()
return status of graph execution
__TBB_DEPRECATED void run(Receiver &r, Body body)
Spawns a task that runs a body and puts its output to a specific receiver.
std::list< tbb::task * > task_list_type
tbb::task_group_context * my_context
tbb::flow::interface11::graph_node * my_nodes
void reset(tbb::flow::interface11::reset_flags f=tbb::flow::interface11::rf_reset_protocol)
iterator end()
end iterator
graph()
Constructs a graph with isolated task_group_context.
const_iterator cend() const
end const iterator
void remove_node(tbb::flow::interface11::graph_node *n)
__TBB_DEPRECATED void run(Body body)
Spawns a task that runs a function object.
void reserve_wait() __TBB_override
Used to register that an external entity may still interact with the graph.
tbb::spin_mutex nodelist_mutex
tbb::flow::interface11::graph_iterator< graph, tbb::flow::interface11::graph_node > iterator
__TBB_DEPRECATED void decrement_wait_count()
tbb::flow::interface11::internal::graph_task_priority_queue_t my_priority_queue
__TBB_DEPRECATED void increment_wait_count()
void wait_for_all()
Wait until graph is idle and decrement_wait_count calls equals increment_wait_count calls.
void prepare_task_arena(bool reinit=false)
tbb::task_arena * my_task_arena
tbb::flow::interface11::graph_node * my_nodes_last
__TBB_DEPRECATED tbb::task * root_task()
Returns the root task of the graph.
iterator begin()
start iterator
void release_wait() __TBB_override
Deregisters an external entity that may have interacted with the graph.
~graph()
Destroys the graph.
run_task(Body &body, tbb::flow::interface11::node_priority_t node_priority=tbb::flow::interface11::no_priority)
tbb::task * execute() __TBB_override
Should be overridden by derived classes.
run_and_put_task(Receiver &r, Body &body)
tbb::task * execute() __TBB_override
Should be overridden by derived classes.
wait_functor(tbb::task *t)
tbb::task * graph_root_task
A functor that spawns a task.
spawn_functor(tbb::task &t)
The base of all graph nodes.
virtual void reset_node(reset_flags f=rf_reset_protocol)=0
A lock that occupies a single byte.
Used to form groups of tasks.
bool __TBB_EXPORTED_METHOD is_group_execution_cancelled() const
Returns true if the context received cancellation request.
uintptr_t traits() const
Returns the context's trait.
void __TBB_EXPORTED_METHOD reset()
Forcefully reinitializes the context after the task tree it was associated with is completed.
Base class for user-defined tasks.
virtual task * execute()=0
Should be overridden by derived classes.
static void enqueue(task &t)
Enqueue task for starvation-resistant execution.
internal::allocate_continuation_proxy & allocate_continuation()
Returns proxy for overloaded new that allocates a continuation task of *this.
void wait_for_all()
Wait for reference count to become one, and set reference count to zero.
void set_ref_count(int count)
Set reference count.
internal::return_type_or_void< F >::type execute(F &f)
void initialize()
Forces allocation of the resources for the task_arena as specified in constructor arguments.
Tag class used to indicate the "attaching" constructor.
Base class for types that should not be assigned.
Base class for types that should not be copied or assigned.