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

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10a::overwrite_node< T >:
Collaboration diagram for tbb::flow::interface10a::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::interface10::receiver< T >
typedef T input_type
 The input type of this receiver. More...
 
typedef internal::async_helpers< T >::filtered_type filtered_type
 
- Public Types inherited from tbb::flow::interface10::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node. More...
 
- Public Types inherited from tbb::flow::interface10::sender< T >
typedef T output_type
 The output type of this sender. More...
 
typedef internal::async_helpers< T >::filtered_type filtered_type
 
- Public Types inherited from tbb::flow::interface10::internal::untyped_sender
typedef untyped_receiver successor_type
 The successor type for this node. More...
 

Public Member Functions

 overwrite_node (graph &g)
 
 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::interface10::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from tbb::flow::interface10::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::interface10::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::interface10::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 () __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::interface10::receiver< T >
virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
virtual bool is_continue_receiver ()
 
- Protected Member Functions inherited from tbb::flow::interface10::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::interface10::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::interface10::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
 

Detailed Description

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

Definition at line 3652 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

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

Definition at line 3654 of file flow_graph.h.

◆ output_type

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

Definition at line 3655 of file flow_graph.h.

◆ predecessor_type

Definition at line 3656 of file flow_graph.h.

◆ successor_type

Definition at line 3657 of file flow_graph.h.

Constructor & Destructor Documentation

◆ overwrite_node() [1/2]

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

Definition at line 3665 of file flow_graph.h.

3665  : graph_node(g), my_buffer_is_valid(false) {
3666  my_successors.set_owner( this );
3667  tbb::internal::fgt_node( tbb::internal::FLOW_OVERWRITE_NODE, &this->my_graph,
3668  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
3669  }
internal::broadcast_cache< input_type, null_rw_mutex > my_successors
Definition: flow_graph.h:3840
static void fgt_node(string_index, void *, void *)

References tbb::internal::fgt_node(), and tbb::flow::interface10::internal::successor_cache< T, M >::set_owner().

Here is the call graph for this function:

◆ overwrite_node() [2/2]

template<typename T >
tbb::flow::interface10a::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 3672 of file flow_graph.h.

3672  :
3673  graph_node(src.my_graph), receiver<T>(), sender<T>(), my_buffer_is_valid(false)
3674  {
3675  my_successors.set_owner( this );
3676  tbb::internal::fgt_node( tbb::internal::FLOW_OVERWRITE_NODE, &this->my_graph,
3677  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
3678  }
internal::broadcast_cache< input_type, null_rw_mutex > my_successors
Definition: flow_graph.h:3840
static void fgt_node(string_index, void *, void *)

References tbb::internal::fgt_node(), and tbb::flow::interface10::internal::successor_cache< T, M >::set_owner().

Here is the call graph for this function:

◆ ~overwrite_node()

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

Definition at line 3680 of file flow_graph.h.

3680 {}

Member Function Documentation

◆ clear()

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

Definition at line 3795 of file flow_graph.h.

◆ graph_reference()

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

Implements tbb::flow::interface10::internal::untyped_receiver.

Definition at line 3818 of file flow_graph.h.

3818  {
3819  return my_graph;
3820  }

◆ is_valid()

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

Definition at line 3790 of file flow_graph.h.

◆ register_successor()

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

Add a new successor to this node.

Implements tbb::flow::interface10::internal::untyped_sender.

Definition at line 3688 of file flow_graph.h.

3688  {
3691  // We have a valid value that must be forwarded immediately.
3692  bool ret = s.try_put( my_buffer );
3693  if ( ret ) {
3694  // We add the successor that accepted our put
3695  my_successors.register_successor( s );
3696  } else {
3697  // In case of reservation a race between the moment of reservation and register_successor can appear,
3698  // because failed reserve does not mean that register_successor is not ready to put a message immediately.
3699  // We have some sort of infinite loop: reserving node tries to set pull state for the edge,
3700  // but overwrite_node tries to return push state back. That is why we have to break this loop with task creation.
3701  task *rtask = new ( task::allocate_additional_child_of( *( my_graph.root_task() ) ) )
3702  register_predecessor_task( *this, s );
3704  }
3705  } else {
3706  // No valid value yet, just add as successor
3707  my_successors.register_successor( s );
3708  }
3709  return true;
3710  }
internal::broadcast_cache< input_type, null_rw_mutex > my_successors
Definition: flow_graph.h:3840
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
void const char const char int ITT_FORMAT __itt_group_sync s
tbb::task * root_task()
Returns the root task of the graph.
void spawn_in_graph_arena(graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
friend class scoped_lock
Definition: spin_mutex.h:176

References tbb::flow::interface10::internal::is_graph_active(), tbb::flow::interface10::internal::successor_cache< T, M >::register_successor(), s, and tbb::flow::interface10::internal::spawn_in_graph_arena().

Here is the call graph for this function:

◆ remove_successor()

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

Removes a successor from this node.

Implements tbb::flow::interface10::internal::untyped_sender.

Definition at line 3712 of file flow_graph.h.

3712  {
3714  my_successors.remove_successor(s);
3715  return true;
3716  }
internal::broadcast_cache< input_type, null_rw_mutex > my_successors
Definition: flow_graph.h:3840
void const char const char int ITT_FORMAT __itt_group_sync s
friend class scoped_lock
Definition: spin_mutex.h:176

References tbb::flow::interface10::internal::successor_cache< T, M >::remove_successor(), and s.

Here is the call graph for this function:

◆ reset_node()

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

Implements tbb::flow::interface10::graph_node.

Definition at line 3848 of file flow_graph.h.

3848  {
3849  my_buffer_is_valid = false;
3850  if (f&rf_clear_edges) {
3851  my_successors.clear();
3852  }
3853  }
internal::broadcast_cache< input_type, null_rw_mutex > my_successors
Definition: flow_graph.h:3840

References tbb::flow::interface10::internal::successor_cache< T, M >::clear(), and tbb::flow::interface10::rf_clear_edges.

Here is the call graph for this function:

◆ reset_receiver()

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

put receiver back in initial state

Implements tbb::flow::interface10::internal::untyped_receiver.

Definition at line 3846 of file flow_graph.h.

3846 {}

◆ try_consume()

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

Consumes the reserved item.

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

Definition at line 3788 of file flow_graph.h.

3788 { return true; }

◆ try_get()

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

Request an item from the sender.

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

Definition at line 3770 of file flow_graph.h.

3770  {
3772  if ( my_buffer_is_valid ) {
3773  v = my_buffer;
3774  return true;
3775  }
3776  return false;
3777  }
friend class scoped_lock
Definition: spin_mutex.h:176

◆ try_put_task()

template<typename T >
task* tbb::flow::interface10a::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::interface10::receiver< T >.

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

Definition at line 3805 of file flow_graph.h.

3805  {
3807  return try_put_task_impl(v);
3808  }
task * try_put_task_impl(const input_type &v)
Definition: flow_graph.h:3810
friend class scoped_lock
Definition: spin_mutex.h:176

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

◆ try_put_task_impl()

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

Definition at line 3810 of file flow_graph.h.

3810  {
3811  my_buffer = v;
3812  my_buffer_is_valid = true;
3813  task * rtask = my_successors.try_put_task(v);
3814  if (!rtask) rtask = SUCCESSFULLY_ENQUEUED;
3815  return rtask;
3816  }
internal::broadcast_cache< input_type, null_rw_mutex > my_successors
Definition: flow_graph.h:3840
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
static tbb::task *const SUCCESSFULLY_ENQUEUED

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

◆ try_release()

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

Releases the reserved item.

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

Definition at line 3785 of file flow_graph.h.

3785 { return true; }

◆ try_reserve()

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

Reserves an item.

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

Definition at line 3780 of file flow_graph.h.

3780  {
3781  return try_get(v);
3782  }
bool try_get(input_type &v) __TBB_override
Request an item from the sender.
Definition: flow_graph.h:3770

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 3803 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 3804 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 3802 of file flow_graph.h.

Member Data Documentation

◆ my_buffer

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

Definition at line 3844 of file flow_graph.h.

◆ my_buffer_is_valid

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

Definition at line 3845 of file flow_graph.h.

◆ my_mutex

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

Definition at line 3839 of file flow_graph.h.

◆ my_successors

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

Definition at line 3840 of file flow_graph.h.


The documentation for this class was generated from the following file:

Copyright © 2005-2019 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.