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 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
 
bool remove_successor (successor_type &s) __TBB_override
 
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 >
virtual ~receiver ()
 Destructor. More...
 
bool try_put (const T &t)
 Put an item to the receiver. More...
 
virtual __TBB_DEPRECATED bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual __TBB_DEPRECATED bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 
- Public Member Functions inherited from tbb::flow::interface11::sender< T >
virtual ~sender ()
 
virtual __TBB_DEPRECATED bool register_successor (successor_type &r)=0
 Add a new successor to this node. More...
 
virtual __TBB_DEPRECATED bool remove_successor (successor_type &r)=0
 Removes a successor from this node. More...
 

Protected Member Functions

tasktry_put_task (const input_type &v) __TBB_override
 
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 bool is_continue_receiver ()
 

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 sender< T > predecessor_type
 The predecessor type for this node. More...
 
- 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 receiver< T > successor_type
 The successor type for this node. More...
 

Detailed Description

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

Definition at line 4402 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 4404 of file flow_graph.h.

◆ output_type

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

Definition at line 4405 of file flow_graph.h.

◆ predecessor_type

Definition at line 4406 of file flow_graph.h.

◆ successor_type

Definition at line 4407 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 4415 of file flow_graph.h.

4415  : graph_node(g), my_buffer_is_valid(false) {
4416  my_successors.set_owner( this );
4417  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_OVERWRITE_NODE, &this->my_graph,
4418  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
4419  }

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 4429 of file flow_graph.h.

4429  :
4430  graph_node(src.my_graph), receiver<T>(), sender<T>(), my_buffer_is_valid(false)
4431  {
4432  my_successors.set_owner( this );
4433  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_OVERWRITE_NODE, &this->my_graph,
4434  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
4435  }

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 4437 of file flow_graph.h.

4437 {}

Member Function Documentation

◆ clear()

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

Definition at line 4552 of file flow_graph.h.

4552  {
4554  my_buffer_is_valid = false;
4555  }

◆ graph_reference()

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

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

Definition at line 4575 of file flow_graph.h.

4575  {
4576  return my_graph;
4577  }

◆ is_valid()

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

Definition at line 4547 of file flow_graph.h.

4547  {
4549  return my_buffer_is_valid;
4550  }

◆ register_successor()

template<typename T >
bool tbb::flow::interface11::overwrite_node< T >::register_successor ( successor_type s)
inline

Definition at line 4445 of file flow_graph.h.

4445  {
4448  // We have a valid value that must be forwarded immediately.
4449  bool ret = s.try_put( my_buffer );
4450  if ( ret ) {
4451  // We add the successor that accepted our put
4452  my_successors.register_successor( s );
4453  } else {
4454  // In case of reservation a race between the moment of reservation and register_successor can appear,
4455  // because failed reserve does not mean that register_successor is not ready to put a message immediately.
4456  // We have some sort of infinite loop: reserving node tries to set pull state for the edge,
4457  // but overwrite_node tries to return push state back. That is why we have to break this loop with task creation.
4458  task *rtask = new ( task::allocate_additional_child_of( *( my_graph.root_task() ) ) )
4459  register_predecessor_task( *this, s );
4461  }
4462  } else {
4463  // No valid value yet, just add as successor
4464  my_successors.register_successor( s );
4465  }
4466  return true;
4467  }

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 s)
inline

Definition at line 4469 of file flow_graph.h.

4469  {
4471  my_successors.remove_successor(s);
4472  return true;
4473  }

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 4605 of file flow_graph.h.

4605  {
4606  my_buffer_is_valid = false;
4607  if (f&rf_clear_edges) {
4608  my_successors.clear();
4609  }
4610  }

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::receiver< T >.

Definition at line 4603 of file flow_graph.h.

4603 {}

◆ try_consume()

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

Consumes the reserved item.

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

Definition at line 4545 of file flow_graph.h.

4545 { 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 4527 of file flow_graph.h.

4527  {
4529  if ( my_buffer_is_valid ) {
4530  v = my_buffer;
4531  return true;
4532  }
4533  return false;
4534  }

◆ try_put_task()

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

◆ 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 4567 of file flow_graph.h.

4567  {
4568  my_buffer = v;
4569  my_buffer_is_valid = true;
4570  task * rtask = my_successors.try_put_task(v);
4571  if (!rtask) rtask = SUCCESSFULLY_ENQUEUED;
4572  return rtask;
4573  }

References internal::successor_cache< T, spin_rw_mutex >::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::sender< T >.

Definition at line 4542 of file flow_graph.h.

4542 { 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 4537 of file flow_graph.h.

4537  {
4538  return try_get(v);
4539  }

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 4560 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 4561 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 4559 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 4601 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 4602 of file flow_graph.h.

◆ my_mutex

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

Definition at line 4596 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 4597 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::my_graph
graph & my_graph
Definition: _flow_graph_impl.h:464
tbb::flow::interface11::overwrite_node::my_buffer_is_valid
bool my_buffer_is_valid
Definition: flow_graph.h:4602
tbb::flow::interface10::graph::root_task
tbb::task * root_task()
Returns the root task of the graph.
Definition: _flow_graph_impl.h:374
tbb::flow::internal::SUCCESSFULLY_ENQUEUED
static tbb::task *const SUCCESSFULLY_ENQUEUED
Definition: _flow_graph_impl.h:61
tbb::flow::interface11::overwrite_node::my_buffer
input_type my_buffer
Definition: flow_graph.h:4601
tbb::spin_mutex::scoped_lock
friend class scoped_lock
Definition: spin_mutex.h:179
tbb::flow::interface11::overwrite_node::try_put_task_impl
task * try_put_task_impl(const input_type &v)
Definition: flow_graph.h:4567
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:4527
tbb::flow::interface11::overwrite_node::my_successors
internal::broadcast_cache< input_type, null_rw_mutex > my_successors
Definition: flow_graph.h:4597
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_mutex
spin_mutex my_mutex
Definition: flow_graph.h:4596
tbb::flow::interface11::graph_node::graph_node
graph_node(graph &g)
Definition: flow_graph.h:887
tbb::flow::interface11::rf_clear_edges
@ rf_clear_edges
Definition: _flow_graph_impl.h:161
tbb::internal::fgt_node
static void fgt_node(void *, string_index, void *, void *)
Definition: _flow_graph_trace_impl.h:326

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.