Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface11::overwrite_node< T > Class Template Reference

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::overwrite_node< T >:
Collaboration diagram for tbb::flow::interface11::overwrite_node< T >:

Classes

struct  register_predecessor_task
 Breaks an infinite loop between the node reservation and register_successor call. More...
 

Public Types

typedef T input_type
 
typedef T output_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef sender< output_type >::successor_type successor_type
 
- Public Types inherited from tbb::flow::interface11::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node. More...
 
- Public Types inherited from tbb::flow::interface11::internal::untyped_sender
typedef untyped_receiver successor_type
 The successor type for this node. More...
 

Public Member Functions

__TBB_NOINLINE_SYM overwrite_node (graph &g)
 
__TBB_NOINLINE_SYM overwrite_node (const overwrite_node &src)
 Copy constructor; doesn't take anything from src; default won't work. More...
 
 ~overwrite_node ()
 
bool register_successor (successor_type &s) __TBB_override
 Add a new successor to this node. More...
 
bool remove_successor (successor_type &s) __TBB_override
 Removes a successor from this node. More...
 
bool try_get (input_type &v) __TBB_override
 Request an item from the sender. More...
 
bool try_reserve (T &v) __TBB_override
 Reserves an item. More...
 
bool try_release () __TBB_override
 Releases the reserved item. More...
 
bool try_consume () __TBB_override
 Consumes the reserved item. More...
 
bool is_valid ()
 
void clear ()
 
- Public Member Functions inherited from tbb::flow::interface11::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from tbb::flow::interface11::receiver< T >
bool try_put (const typename internal::async_helpers< T >::filtered_type &t)
 Put an item to the receiver. More...
 
bool try_put (const typename internal::async_helpers< T >::async_type &t)
 
- Public Member Functions inherited from tbb::flow::interface11::internal::untyped_receiver
virtual ~untyped_receiver ()
 Destructor. More...
 
template<typename X >
bool try_put (const X &t)
 Put an item to the receiver. More...
 
virtual bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 
- Public Member Functions inherited from tbb::flow::interface11::internal::untyped_sender
virtual ~untyped_sender ()
 

Protected Member Functions

tasktry_put_task (const input_type &v) __TBB_override
 Put item to successor; return task to run the successor if possible. More...
 
tasktry_put_task_impl (const input_type &v)
 
graphgraph_reference () const __TBB_override
 
void reset_receiver (reset_flags) __TBB_override
 put receiver back in initial state More...
 
void reset_node (reset_flags f) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::receiver< T >
virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
virtual bool is_continue_receiver ()
 
- Protected Member Functions inherited from tbb::flow::interface11::sender< T >
virtual bool try_get_wrapper (void *p, bool is_async) __TBB_override
 
virtual bool try_reserve_wrapper (void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::internal::untyped_sender
template<typename X >
bool try_get (X &t)
 Request an item from the sender. More...
 
template<typename X >
bool try_reserve (X &t)
 Reserves an item in the sender. More...
 

Protected Attributes

spin_mutex my_mutex
 
internal::broadcast_cache< input_type, null_rw_mutexmy_successors
 
input_type my_buffer
 
bool my_buffer_is_valid
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 

Friends

template<typename R , typename B >
class run_and_put_task
 
template<typename X , typename Y >
class internal::broadcast_cache
 
template<typename X , typename Y >
class internal::round_robin_cache
 

Additional Inherited Members

- Public Attributes inherited from tbb::flow::interface11::receiver< T >
__TBB_DEPRECATED typedef T input_type
 The input type of this receiver. More...
 
__TBB_DEPRECATED typedef internal::async_helpers< T >::filtered_type filtered_type
 
- Public Attributes inherited from tbb::flow::interface11::sender< T >
__TBB_DEPRECATED typedef T output_type
 The output type of this sender. More...
 
__TBB_DEPRECATED typedef internal::async_helpers< T >::filtered_type filtered_type
 

Detailed Description

template<typename T>
class tbb::flow::interface11::overwrite_node< T >

Definition at line 4016 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

template<typename T >
typedef T tbb::flow::interface11::overwrite_node< T >::input_type

Definition at line 4018 of file flow_graph.h.

◆ output_type

template<typename T >
typedef T tbb::flow::interface11::overwrite_node< T >::output_type

Definition at line 4019 of file flow_graph.h.

◆ predecessor_type

Definition at line 4020 of file flow_graph.h.

◆ successor_type

Definition at line 4021 of file flow_graph.h.

Constructor & Destructor Documentation

◆ overwrite_node() [1/2]

template<typename T >
__TBB_NOINLINE_SYM tbb::flow::interface11::overwrite_node< T >::overwrite_node ( graph g)
inlineexplicit

Definition at line 4029 of file flow_graph.h.

4029  : graph_node(g), my_buffer_is_valid(false) {
4030  my_successors.set_owner( this );
4031  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_OVERWRITE_NODE, &this->my_graph,
4032  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
4033  }

References CODEPTR, and tbb::internal::fgt_node().

Here is the call graph for this function:

◆ overwrite_node() [2/2]

template<typename T >
__TBB_NOINLINE_SYM tbb::flow::interface11::overwrite_node< T >::overwrite_node ( const overwrite_node< T > &  src)
inline

Copy constructor; doesn't take anything from src; default won't work.

Definition at line 4043 of file flow_graph.h.

4043  :
4044  graph_node(src.my_graph), receiver<T>(), sender<T>(), my_buffer_is_valid(false)
4045  {
4046  my_successors.set_owner( this );
4047  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_OVERWRITE_NODE, &this->my_graph,
4048  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
4049  }

References CODEPTR, and tbb::internal::fgt_node().

Here is the call graph for this function:

◆ ~overwrite_node()

template<typename T >
tbb::flow::interface11::overwrite_node< T >::~overwrite_node ( )
inline

Definition at line 4051 of file flow_graph.h.

4051 {}

Member Function Documentation

◆ clear()

template<typename T >
void tbb::flow::interface11::overwrite_node< T >::clear ( )
inline

Definition at line 4166 of file flow_graph.h.

4166  {
4168  my_buffer_is_valid = false;
4169  }

◆ graph_reference()

template<typename T >
graph& tbb::flow::interface11::overwrite_node< T >::graph_reference ( ) const
inlineprotectedvirtual

Implements tbb::flow::interface11::internal::untyped_receiver.

Definition at line 4189 of file flow_graph.h.

4189  {
4190  return my_graph;
4191  }

◆ is_valid()

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::is_valid ( )
inline

Definition at line 4161 of file flow_graph.h.

4161  {
4163  return my_buffer_is_valid;
4164  }

◆ register_successor()

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::register_successor ( successor_type r)
inlinevirtual

Add a new successor to this node.

Implements tbb::flow::interface11::internal::untyped_sender.

Definition at line 4059 of file flow_graph.h.

4059  {
4062  // We have a valid value that must be forwarded immediately.
4063  bool ret = s.try_put( my_buffer );
4064  if ( ret ) {
4065  // We add the successor that accepted our put
4066  my_successors.register_successor( s );
4067  } else {
4068  // In case of reservation a race between the moment of reservation and register_successor can appear,
4069  // because failed reserve does not mean that register_successor is not ready to put a message immediately.
4070  // We have some sort of infinite loop: reserving node tries to set pull state for the edge,
4071  // but overwrite_node tries to return push state back. That is why we have to break this loop with task creation.
4072  task *rtask = new ( task::allocate_additional_child_of( *( my_graph.root_task() ) ) )
4073  register_predecessor_task( *this, s );
4075  }
4076  } else {
4077  // No valid value yet, just add as successor
4078  my_successors.register_successor( s );
4079  }
4080  return true;
4081  }

References tbb::flow::interface11::internal::is_graph_active(), s, and tbb::flow::interface11::internal::spawn_in_graph_arena().

Here is the call graph for this function:

◆ remove_successor()

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::remove_successor ( successor_type r)
inlinevirtual

Removes a successor from this node.

Implements tbb::flow::interface11::internal::untyped_sender.

Definition at line 4083 of file flow_graph.h.

4083  {
4085  my_successors.remove_successor(s);
4086  return true;
4087  }

References s.

◆ reset_node()

template<typename T >
void tbb::flow::interface11::overwrite_node< T >::reset_node ( reset_flags  f)
inlineprotectedvirtual

Implements tbb::flow::interface11::graph_node.

Definition at line 4219 of file flow_graph.h.

4219  {
4220  my_buffer_is_valid = false;
4221  if (f&rf_clear_edges) {
4222  my_successors.clear();
4223  }
4224  }

References tbb::flow::interface11::rf_clear_edges.

◆ reset_receiver()

template<typename T >
void tbb::flow::interface11::overwrite_node< T >::reset_receiver ( reset_flags  f)
inlineprotectedvirtual

put receiver back in initial state

Implements tbb::flow::interface11::internal::untyped_receiver.

Definition at line 4217 of file flow_graph.h.

4217 {}

◆ try_consume()

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::try_consume ( )
inlinevirtual

Consumes the reserved item.

Reimplemented from tbb::flow::interface11::internal::untyped_sender.

Definition at line 4159 of file flow_graph.h.

4159 { return true; }

◆ try_get()

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::try_get ( input_type )
inlinevirtual

Request an item from the sender.

Reimplemented from tbb::flow::interface11::sender< T >.

Definition at line 4141 of file flow_graph.h.

4141  {
4143  if ( my_buffer_is_valid ) {
4144  v = my_buffer;
4145  return true;
4146  }
4147  return false;
4148  }

◆ try_put_task()

template<typename T >
task* tbb::flow::interface11::overwrite_node< T >::try_put_task ( const input_type t)
inlineprotectedvirtual

Put item to successor; return task to run the successor if possible.

Implements tbb::flow::interface11::receiver< T >.

Reimplemented in tbb::flow::interface11::write_once_node< T >.

Definition at line 4176 of file flow_graph.h.

4176  {
4178  return try_put_task_impl(v);
4179  }

References internal::successor_cache< T, M >::my_mutex.

◆ try_put_task_impl()

template<typename T >
task* tbb::flow::interface11::overwrite_node< T >::try_put_task_impl ( const input_type v)
inlineprotected

Definition at line 4181 of file flow_graph.h.

4181  {
4182  my_buffer = v;
4183  my_buffer_is_valid = true;
4184  task * rtask = my_successors.try_put_task(v);
4185  if (!rtask) rtask = SUCCESSFULLY_ENQUEUED;
4186  return rtask;
4187  }

References internal::successor_cache< T, M >::my_successors, and tbb::flow::internal::SUCCESSFULLY_ENQUEUED.

◆ try_release()

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::try_release ( )
inlinevirtual

Releases the reserved item.

Reimplemented from tbb::flow::interface11::internal::untyped_sender.

Definition at line 4156 of file flow_graph.h.

4156 { return true; }

◆ try_reserve()

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::try_reserve ( T &  v)
inlinevirtual

Reserves an item.

Reimplemented from tbb::flow::interface11::sender< T >.

Definition at line 4151 of file flow_graph.h.

4151  {
4152  return try_get(v);
4153  }

Friends And Related Function Documentation

◆ internal::broadcast_cache

template<typename T >
template<typename X , typename Y >
friend class internal::broadcast_cache
friend

Definition at line 4174 of file flow_graph.h.

◆ internal::round_robin_cache

template<typename T >
template<typename X , typename Y >
friend class internal::round_robin_cache
friend

Definition at line 4175 of file flow_graph.h.

◆ run_and_put_task

template<typename T >
template<typename R , typename B >
friend class run_and_put_task
friend

Definition at line 4173 of file flow_graph.h.

Member Data Documentation

◆ my_buffer

template<typename T >
input_type tbb::flow::interface11::overwrite_node< T >::my_buffer
protected

Definition at line 4215 of file flow_graph.h.

◆ my_buffer_is_valid

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::my_buffer_is_valid
protected

Definition at line 4216 of file flow_graph.h.

◆ my_mutex

template<typename T >
spin_mutex tbb::flow::interface11::overwrite_node< T >::my_mutex
protected

Definition at line 4210 of file flow_graph.h.

◆ my_successors

template<typename T >
internal::broadcast_cache< input_type, null_rw_mutex > tbb::flow::interface11::overwrite_node< T >::my_successors
protected

Definition at line 4211 of file flow_graph.h.


The documentation for this class was generated from the following file:
tbb::flow::interface11::internal::is_graph_active
bool is_graph_active(tbb::flow::interface10::graph &g)
Definition: _flow_graph_impl.h:494
tbb::flow::interface11::internal::spawn_in_graph_arena
void spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
Definition: _flow_graph_impl.h:521
CODEPTR
#define CODEPTR()
Definition: _flow_graph_trace_impl.h:297
tbb::flow::interface11::graph_node::graph_node
graph_node(graph &g)
Definition: flow_graph.h:880
tbb::flow::interface11::overwrite_node::my_buffer_is_valid
bool my_buffer_is_valid
Definition: flow_graph.h:4216
tbb::flow::internal::SUCCESSFULLY_ENQUEUED
static tbb::task *const SUCCESSFULLY_ENQUEUED
Definition: _flow_graph_impl.h:61
tbb::spin_mutex::scoped_lock
friend class scoped_lock
Definition: spin_mutex.h:179
tbb::flow::interface11::graph_node::my_graph
graph & my_graph
Definition: _flow_graph_impl.h:464
tbb::flow::interface11::overwrite_node::try_get
bool try_get(input_type &v) __TBB_override
Request an item from the sender.
Definition: flow_graph.h:4141
tbb::flow::interface11::overwrite_node::try_put_task_impl
task * try_put_task_impl(const input_type &v)
Definition: flow_graph.h:4181
s
void const char const char int ITT_FORMAT __itt_group_sync s
Definition: ittnotify_static.h:91
task
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task * task
Definition: ittnotify_static.h:119
tbb::flow::interface11::overwrite_node::my_successors
internal::broadcast_cache< input_type, null_rw_mutex > my_successors
Definition: flow_graph.h:4211
tbb::flow::interface11::rf_clear_edges
Definition: _flow_graph_impl.h:161
tbb::flow::interface11::overwrite_node::my_buffer
input_type my_buffer
Definition: flow_graph.h:4215
tbb::internal::fgt_node
static void fgt_node(void *, string_index, void *, void *)
Definition: _flow_graph_trace_impl.h:326
tbb::flow::interface11::overwrite_node::my_mutex
spin_mutex my_mutex
Definition: flow_graph.h:4210
tbb::flow::interface10::graph::root_task
tbb::task * root_task()
Returns the root task of the graph.
Definition: _flow_graph_impl.h:374

Copyright © 2005-2020 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.