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

Forwards messages in arbitrary order. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::buffer_node< T, A >:
Collaboration diagram for tbb::flow::interface11::buffer_node< T, A >:

Classes

class  buffer_operation
 

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
 
typedef buffer_node< T, A > class_type
 
- Public Types inherited from tbb::flow::interface11::internal::item_buffer< T, A >
enum  buffer_item_state { no_item =0, has_item =1, reserved_item =2 }
 
typedef T item_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 buffer_node (graph &g)
 Constructor. More...
 
__TBB_NOINLINE_SYM buffer_node (const buffer_node &src)
 Copy constructor. More...
 
bool register_successor (successor_type &r) __TBB_override
 Adds a new successor. More...
 
bool remove_successor (successor_type &r) __TBB_override
 Removes a successor. More...
 
bool try_get (T &v) __TBB_override
 Request an item from the buffer_node. More...
 
bool try_reserve (T &v) __TBB_override
 Reserves an item. More...
 
bool try_release () __TBB_override
 Release a reserved item. More...
 
bool try_consume () __TBB_override
 Consumes a reserved item. More...
 
- 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::internal::reservable_item_buffer< T, A >
 reservable_item_buffer ()
 
void reset ()
 
- Public Member Functions inherited from tbb::flow::interface11::internal::item_buffer< T, A >
 item_buffer ()
 Constructor. More...
 
 ~item_buffer ()
 
void reset ()
 
- 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 Types

enum  op_type {
  reg_succ, rem_succ, req_item, res_item,
  rel_res, con_res, put_item, try_fwd_task
}
 
typedef size_t size_type
 
typedef internal::aggregating_functor< class_type, buffer_operationhandler_type
 
- Protected Types inherited from tbb::flow::interface11::internal::item_buffer< T, A >
typedef size_t size_type
 
typedef aligned_pair< item_type, buffer_item_state >::type buffer_item_type
 
typedef A::template rebind< buffer_item_type >::other allocator_type
 

Protected Member Functions

virtual void handle_operations (buffer_operation *op_list)
 
template<typename derived_type >
void handle_operations_impl (buffer_operation *op_list, derived_type *derived)
 
taskgrab_forwarding_task (buffer_operation &op_data)
 
bool enqueue_forwarding_task (buffer_operation &op_data)
 
virtual taskforward_task ()
 This is executed by an enqueued task, the "forwarder". More...
 
virtual void internal_reg_succ (buffer_operation *op)
 Register successor. More...
 
virtual void internal_rem_succ (buffer_operation *op)
 Remove successor. More...
 
virtual void internal_forward_task (buffer_operation *op)
 Tries to forward valid items to successors. More...
 
template<typename derived_type >
void internal_forward_task_impl (buffer_operation *op, derived_type *derived)
 
virtual bool internal_push (buffer_operation *op)
 
virtual void internal_pop (buffer_operation *op)
 
virtual void internal_reserve (buffer_operation *op)
 
virtual void internal_consume (buffer_operation *op)
 
virtual void internal_release (buffer_operation *op)
 
tasktry_put_task (const T &t) __TBB_override
 receive an item, return a task *if possible More...
 
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::internal::reservable_item_buffer< T, A >
bool reserve_front (T &v)
 
void consume_front ()
 
void release_front ()
 
- Protected Member Functions inherited from tbb::flow::interface11::internal::item_buffer< T, A >
bool buffer_empty () const
 
buffer_item_typeitem (size_type i)
 
const buffer_item_typeitem (size_type i) const
 
bool my_item_valid (size_type i) const
 
bool my_item_reserved (size_type i) const
 
const item_typeget_my_item (size_t i) const
 
void set_my_item (size_t i, const item_type &o)
 
void fetch_item (size_t i, item_type &o)
 
void move_item (size_t to, size_t from)
 
bool place_item (size_t here, const item_type &me)
 
void swap_items (size_t i, size_t j)
 
void destroy_item (size_type i)
 
const item_typefront () const
 
const item_typeback () const
 
void reserve_item (size_type i)
 
void release_item (size_type i)
 
void destroy_front ()
 
void destroy_back ()
 
size_type size (size_t new_tail=0)
 
size_type capacity ()
 
bool buffer_full ()
 
void grow_my_array (size_t minimum_size)
 Grows the internal array. More...
 
bool push_back (item_type &v)
 
bool pop_back (item_type &v)
 
bool pop_front (item_type &v)
 
void clean_up_buffer (bool reset_pointers)
 
- 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

internal::round_robin_cache< T, null_rw_mutexmy_successors
 
bool forwarder_busy
 
internal::aggregator< handler_type, buffer_operationmy_aggregator
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 
- Protected Attributes inherited from tbb::flow::interface11::internal::reservable_item_buffer< T, A >
bool my_reserved
 
- Protected Attributes inherited from tbb::flow::interface11::internal::item_buffer< T, A >
buffer_item_typemy_array
 
size_type my_array_size
 
size_type my_head
 
size_type my_tail
 

Private Member Functions

void order ()
 
bool is_item_valid ()
 
void try_put_and_add_task (task *&last_task)
 

Friends

class internal::forward_task_bypass< buffer_node< T, A > >
 
class internal::aggregating_functor< class_type, buffer_operation >
 
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
 
- Static Protected Attributes inherited from tbb::flow::interface11::internal::item_buffer< T, A >
static const size_type initial_buffer_size = 4
 

Detailed Description

template<typename T, typename A = cache_aligned_allocator<T>>
class tbb::flow::interface11::buffer_node< T, A >

Forwards messages in arbitrary order.

Definition at line 1702 of file flow_graph.h.

Member Typedef Documentation

◆ class_type

template<typename T, typename A = cache_aligned_allocator<T>>
typedef buffer_node<T, A> tbb::flow::interface11::buffer_node< T, A >::class_type

Definition at line 1708 of file flow_graph.h.

◆ handler_type

template<typename T, typename A = cache_aligned_allocator<T>>
typedef internal::aggregating_functor<class_type, buffer_operation> tbb::flow::interface11::buffer_node< T, A >::handler_type
protected

Definition at line 1763 of file flow_graph.h.

◆ input_type

template<typename T, typename A = cache_aligned_allocator<T>>
typedef T tbb::flow::interface11::buffer_node< T, A >::input_type

Definition at line 1704 of file flow_graph.h.

◆ output_type

template<typename T, typename A = cache_aligned_allocator<T>>
typedef T tbb::flow::interface11::buffer_node< T, A >::output_type

Definition at line 1705 of file flow_graph.h.

◆ predecessor_type

template<typename T, typename A = cache_aligned_allocator<T>>
typedef receiver<input_type>::predecessor_type tbb::flow::interface11::buffer_node< T, A >::predecessor_type

Definition at line 1706 of file flow_graph.h.

◆ size_type

template<typename T, typename A = cache_aligned_allocator<T>>
typedef size_t tbb::flow::interface11::buffer_node< T, A >::size_type
protected

Definition at line 1714 of file flow_graph.h.

◆ successor_type

template<typename T, typename A = cache_aligned_allocator<T>>
typedef sender<output_type>::successor_type tbb::flow::interface11::buffer_node< T, A >::successor_type

Definition at line 1707 of file flow_graph.h.

Member Enumeration Documentation

◆ op_type

template<typename T, typename A = cache_aligned_allocator<T>>
enum tbb::flow::interface11::buffer_node::op_type
protected
Enumerator
reg_succ 
rem_succ 
req_item 
res_item 
rel_res 
con_res 
put_item 
try_fwd_task 

Definition at line 1723 of file flow_graph.h.

1724 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
1725  , add_blt_succ, del_blt_succ,
1726  add_blt_pred, del_blt_pred,
1727  blt_succ_cnt, blt_pred_cnt,
1728  blt_succ_cpy, blt_pred_cpy // create vector copies of preds and succs
1729 #endif
1730  };

Constructor & Destructor Documentation

◆ buffer_node() [1/2]

template<typename T, typename A = cache_aligned_allocator<T>>
__TBB_NOINLINE_SYM tbb::flow::interface11::buffer_node< T, A >::buffer_node ( graph g)
inlineexplicit

Constructor.

Definition at line 1998 of file flow_graph.h.

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

1999  forwarder_busy(false) {
2000  my_successors.set_owner(this);
2001  my_aggregator.initialize_handler(handler_type(this));
2002  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_BUFFER_NODE, &this->my_graph,
2003  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
2004  }
static void fgt_node(void *, string_index, void *, void *)
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1715
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
item_buffer with reservable front-end. NOTE: if reserving, do not
#define CODEPTR()
internal::aggregating_functor< class_type, buffer_operation > handler_type
Definition: flow_graph.h:1763
Here is the call graph for this function:

◆ buffer_node() [2/2]

template<typename T, typename A = cache_aligned_allocator<T>>
__TBB_NOINLINE_SYM tbb::flow::interface11::buffer_node< T, A >::buffer_node ( const buffer_node< T, A > &  src)
inline

Copy constructor.

Definition at line 2014 of file flow_graph.h.

References __TBB_override, CODEPTR, tbb::internal::fgt_node(), tbb::internal::fgt_node_desc(), and tbb::flow::interface11::internal::successor_cache< T, M >::set_owner().

2014  : graph_node(src.my_graph),
2015  internal::reservable_item_buffer<T>(), receiver<T>(), sender<T>() {
2016  forwarder_busy = false;
2017  my_successors.set_owner(this);
2018  my_aggregator.initialize_handler(handler_type(this));
2019  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_BUFFER_NODE, &this->my_graph,
2020  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
2021  }
static void fgt_node(void *, string_index, void *, void *)
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1715
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
item_buffer with reservable front-end. NOTE: if reserving, do not
#define CODEPTR()
internal::aggregating_functor< class_type, buffer_operation > handler_type
Definition: flow_graph.h:1763
Here is the call graph for this function:

Member Function Documentation

◆ enqueue_forwarding_task()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::enqueue_forwarding_task ( buffer_operation op_data)
inlineprotected

Definition at line 1825 of file flow_graph.h.

1825  {
1826  task *ft = grab_forwarding_task(op_data);
1827  if(ft) {
1829  return true;
1830  }
1831  return false;
1832  }
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 spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
graph & graph_reference() const __TBB_override
Definition: flow_graph.h:2174
task * grab_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1821

◆ forward_task()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual task* tbb::flow::interface11::buffer_node< T, A >::forward_task ( )
inlineprotectedvirtual

This is executed by an enqueued task, the "forwarder".

Definition at line 1835 of file flow_graph.h.

References tbb::task::execute(), tbb::flow::interface11::buffer_node< T, A >::buffer_operation::ltask, and tbb::flow::interface11::internal::WAIT.

1835  {
1836  buffer_operation op_data(try_fwd_task);
1837  task *last_task = NULL;
1838  do {
1839  op_data.status = internal::WAIT;
1840  op_data.ltask = NULL;
1841  my_aggregator.execute(&op_data);
1842 
1843  // workaround for icc bug
1844  tbb::task *xtask = op_data.ltask;
1845  graph& g = this->my_graph;
1846  last_task = combine_tasks(g, last_task, xtask);
1847  } while (op_data.status ==internal::SUCCEEDED);
1848  return last_task;
1849  }
Base class for user-defined tasks.
Definition: task.h:604
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
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
static tbb::task * combine_tasks(graph &g, tbb::task *left, tbb::task *right)
Definition: flow_graph.h:191
Here is the call graph for this function:

◆ grab_forwarding_task()

template<typename T, typename A = cache_aligned_allocator<T>>
task* tbb::flow::interface11::buffer_node< T, A >::grab_forwarding_task ( buffer_operation op_data)
inlineprotected

Definition at line 1821 of file flow_graph.h.

1821  {
1822  return op_data.ltask;
1823  }

◆ graph_reference()

template<typename T, typename A = cache_aligned_allocator<T>>
graph& tbb::flow::interface11::buffer_node< T, A >::graph_reference ( ) const
inlineprotectedvirtual

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

Definition at line 2174 of file flow_graph.h.

2174  {
2175  return my_graph;
2176  }

◆ handle_operations()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface11::buffer_node< T, A >::handle_operations ( buffer_operation op_list)
inlineprotectedvirtual

Reimplemented in tbb::flow::interface11::priority_queue_node< T, Compare, A >.

Definition at line 1767 of file flow_graph.h.

1767  {
1768  handle_operations_impl(op_list, this);
1769  }
void handle_operations_impl(buffer_operation *op_list, derived_type *derived)
Definition: flow_graph.h:1772

◆ handle_operations_impl()

template<typename T, typename A = cache_aligned_allocator<T>>
template<typename derived_type >
void tbb::flow::interface11::buffer_node< T, A >::handle_operations_impl ( buffer_operation op_list,
derived_type *  derived 
)
inlineprotected

Definition at line 1772 of file flow_graph.h.

1772  {
1773  __TBB_ASSERT(static_cast<class_type*>(derived) == this, "'this' is not a base class for derived");
1774 
1775  buffer_operation *tmp = NULL;
1776  bool try_forwarding = false;
1777  while (op_list) {
1778  tmp = op_list;
1779  op_list = op_list->next;
1780  switch (tmp->type) {
1781  case reg_succ: internal_reg_succ(tmp); try_forwarding = true; break;
1782  case rem_succ: internal_rem_succ(tmp); break;
1783  case req_item: internal_pop(tmp); break;
1784  case res_item: internal_reserve(tmp); break;
1785  case rel_res: internal_release(tmp); try_forwarding = true; break;
1786  case con_res: internal_consume(tmp); try_forwarding = true; break;
1787  case put_item: try_forwarding = internal_push(tmp); break;
1788  case try_fwd_task: internal_forward_task(tmp); break;
1789 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
1790  // edge recording
1791  case add_blt_succ: internal_add_built_succ(tmp); break;
1792  case del_blt_succ: internal_del_built_succ(tmp); break;
1793  case add_blt_pred: internal_add_built_pred(tmp); break;
1794  case del_blt_pred: internal_del_built_pred(tmp); break;
1795  case blt_succ_cnt: internal_succ_cnt(tmp); break;
1796  case blt_pred_cnt: internal_pred_cnt(tmp); break;
1797  case blt_succ_cpy: internal_copy_succs(tmp); break;
1798  case blt_pred_cpy: internal_copy_preds(tmp); break;
1799 #endif
1800  }
1801  }
1802 
1803  derived->order();
1804 
1805  if (try_forwarding && !forwarder_busy) {
1806  if(internal::is_graph_active(this->my_graph)) {
1807  forwarder_busy = true;
1808  task *new_task = new(task::allocate_additional_child_of(*(this->my_graph.root_task()))) internal::
1809  forward_task_bypass
1810  < buffer_node<input_type, A> >(*this);
1811  // tmp should point to the last item handled by the aggregator. This is the operation
1812  // the handling thread enqueued. So modifying that record will be okay.
1813  // workaround for icc bug
1814  tbb::task *z = tmp->ltask;
1815  graph &g = this->my_graph;
1816  tmp->ltask = combine_tasks(g, z, new_task); // in case the op generated a task
1817  }
1818  }
1819  } // handle_operations
virtual void internal_pop(buffer_operation *op)
Definition: flow_graph.h:1968
Base class for user-defined tasks.
Definition: task.h:604
virtual void internal_consume(buffer_operation *op)
Definition: flow_graph.h:1986
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
bool is_graph_active(tbb::flow::interface10::graph &g)
virtual void internal_reserve(buffer_operation *op)
Definition: flow_graph.h:1977
tbb::task * root_task()
Returns the root task of the graph.
static tbb::task * combine_tasks(graph &g, tbb::task *left, tbb::task *right)
Definition: flow_graph.h:191
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
virtual bool internal_push(buffer_operation *op)
Definition: flow_graph.h:1962
virtual void internal_reg_succ(buffer_operation *op)
Register successor.
Definition: flow_graph.h:1852
virtual void internal_rem_succ(buffer_operation *op)
Remove successor.
Definition: flow_graph.h:1858
virtual void internal_release(buffer_operation *op)
Definition: flow_graph.h:1991
virtual void internal_forward_task(buffer_operation *op)
Tries to forward valid items to successors.
Definition: flow_graph.h:1933

◆ internal_consume()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface11::buffer_node< T, A >::internal_consume ( buffer_operation op)
inlineprotectedvirtual

◆ internal_forward_task()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface11::buffer_node< T, A >::internal_forward_task ( buffer_operation op)
inlineprotectedvirtual

Tries to forward valid items to successors.

Reimplemented in tbb::flow::interface11::priority_queue_node< T, Compare, A >, and tbb::flow::interface11::queue_node< T, A >.

Definition at line 1933 of file flow_graph.h.

1933  {
1934  internal_forward_task_impl(op, this);
1935  }
void internal_forward_task_impl(buffer_operation *op, derived_type *derived)
Definition: flow_graph.h:1938

◆ internal_forward_task_impl()

template<typename T, typename A = cache_aligned_allocator<T>>
template<typename derived_type >
void tbb::flow::interface11::buffer_node< T, A >::internal_forward_task_impl ( buffer_operation op,
derived_type *  derived 
)
inlineprotected

Definition at line 1938 of file flow_graph.h.

1938  {
1939  __TBB_ASSERT(static_cast<class_type*>(derived) == this, "'this' is not a base class for derived");
1940 
1941  if (this->my_reserved || !derived->is_item_valid()) {
1943  this->forwarder_busy = false;
1944  return;
1945  }
1946  // Try forwarding, giving each successor a chance
1947  task * last_task = NULL;
1948  size_type counter = my_successors.size();
1949  for (; counter > 0 && derived->is_item_valid(); --counter)
1950  derived->try_put_and_add_task(last_task);
1951 
1952  op->ltask = last_task; // return task
1953  if (last_task && !counter) {
1955  }
1956  else {
1958  forwarder_busy = false;
1959  }
1960  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:716
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
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1715
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

◆ internal_pop()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface11::buffer_node< T, A >::internal_pop ( buffer_operation op)
inlineprotectedvirtual

◆ internal_push()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual bool tbb::flow::interface11::buffer_node< T, A >::internal_push ( buffer_operation op)
inlineprotectedvirtual

◆ internal_reg_succ()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface11::buffer_node< T, A >::internal_reg_succ ( buffer_operation op)
inlineprotectedvirtual

Register successor.

Definition at line 1852 of file flow_graph.h.

References tbb::internal::__TBB_store_with_release(), tbb::flow::interface11::buffer_node< T, A >::buffer_operation::r, tbb::flow::interface11::internal::successor_cache< T, M >::register_successor(), and tbb::flow::interface11::internal::SUCCEEDED.

1852  {
1853  my_successors.register_successor(*(op->r));
1855  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:716
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1715
Here is the call graph for this function:

◆ internal_release()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface11::buffer_node< T, A >::internal_release ( buffer_operation op)
inlineprotectedvirtual

Reimplemented in tbb::flow::interface11::priority_queue_node< T, Compare, A >.

Definition at line 1991 of file flow_graph.h.

References tbb::internal::__TBB_store_with_release(), and tbb::flow::interface11::internal::SUCCEEDED.

1991  {
1992  this->release_front();
1994  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:716
Here is the call graph for this function:

◆ internal_rem_succ()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface11::buffer_node< T, A >::internal_rem_succ ( buffer_operation op)
inlineprotectedvirtual

Remove successor.

Definition at line 1858 of file flow_graph.h.

1858  {
1859  my_successors.remove_successor(*(op->r));
1861  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:716
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1715

◆ internal_reserve()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface11::buffer_node< T, A >::internal_reserve ( buffer_operation op)
inlineprotectedvirtual

◆ is_item_valid()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::is_item_valid ( )
inlineprivate

Definition at line 1917 of file flow_graph.h.

1917  {
1918  return this->my_item_valid(this->my_tail - 1);
1919  }

◆ order()

template<typename T, typename A = cache_aligned_allocator<T>>
void tbb::flow::interface11::buffer_node< T, A >::order ( )
inlineprivate

Definition at line 1915 of file flow_graph.h.

1915 {}

◆ register_successor()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::register_successor ( successor_type r)
inlinevirtual

Adds a new successor.

Adds successor r to the list of successors; may forward tasks.

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

Definition at line 2035 of file flow_graph.h.

References __TBB_override, p, tbb::flow::interface11::buffer_node< T, A >::buffer_operation::r, and void.

2035  {
2036  buffer_operation op_data(reg_succ);
2037  op_data.r = &r;
2038  my_aggregator.execute(&op_data);
2039  (void)enqueue_forwarding_task(op_data);
2040  return true;
2041  }
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1825

◆ remove_successor()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::remove_successor ( successor_type r)
inlinevirtual

Removes a successor.

Removes successor r from the list of successors. It also calls r.remove_predecessor(*this) to remove this node as a predecessor.

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

Definition at line 2097 of file flow_graph.h.

References tbb::flow::interface11::buffer_node< T, A >::buffer_operation::r, tbb::flow::interface11::internal::untyped_receiver::remove_predecessor(), and void.

2097  {
2098  r.remove_predecessor(*this);
2099  buffer_operation op_data(rem_succ);
2100  op_data.r = &r;
2101  my_aggregator.execute(&op_data);
2102  // even though this operation does not cause a forward, if we are the handler, and
2103  // a forward is scheduled, we may be the first to reach this point after the aggregator,
2104  // and so should check for the task.
2105  (void)enqueue_forwarding_task(op_data);
2106  return true;
2107  }
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1825
Here is the call graph for this function:

◆ reset_node()

template<typename T, typename A = cache_aligned_allocator<T>>
void tbb::flow::interface11::buffer_node< T, A >::reset_node ( reset_flags  f)
inlineprotectedvirtual

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

Reimplemented in tbb::flow::interface11::priority_queue_node< T, Compare, A >, and tbb::flow::interface11::queue_node< T, A >.

Definition at line 2189 of file flow_graph.h.

References tbb::flow::interface11::internal::successor_cache< T, M >::clear(), and tbb::flow::interface11::internal::reservable_item_buffer< T, A >::reset().

2189  {
2191  // TODO: just clear structures
2192  if (f&rf_clear_edges) {
2193  my_successors.clear();
2194 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
2195  my_built_predecessors.clear();
2196 #endif
2197  }
2198  forwarder_busy = false;
2199  }
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1715
Here is the call graph for this function:

◆ reset_receiver()

template<typename T, typename A = cache_aligned_allocator<T>>
void tbb::flow::interface11::buffer_node< T, A >::reset_receiver ( reset_flags  f)
inlineprotectedvirtual

put receiver back in initial state

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

Definition at line 2178 of file flow_graph.h.

References __TBB_override.

2178 { }

◆ try_consume()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::try_consume ( )
inlinevirtual

Consumes a reserved item.

true = item is removed from sender and reservation removed

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

Definition at line 2142 of file flow_graph.h.

References void.

2142  {
2143  buffer_operation op_data(con_res);
2144  my_aggregator.execute(&op_data);
2145  (void)enqueue_forwarding_task(op_data);
2146  return true;
2147  }
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1825

◆ try_get()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::try_get ( T &  v)
inlinevirtual

Request an item from the buffer_node.

true = v contains the returned item
false = no item has been returned

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

Definition at line 2112 of file flow_graph.h.

References tbb::flow::interface11::buffer_node< T, A >::buffer_operation::elem, tbb::flow::interface11::internal::SUCCEEDED, and void.

2112  {
2113  buffer_operation op_data(req_item);
2114  op_data.elem = &v;
2115  my_aggregator.execute(&op_data);
2116  (void)enqueue_forwarding_task(op_data);
2117  return (op_data.status==internal::SUCCEEDED);
2118  }
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1825

◆ try_put_and_add_task()

template<typename T, typename A = cache_aligned_allocator<T>>
void tbb::flow::interface11::buffer_node< T, A >::try_put_and_add_task ( task *&  last_task)
inlineprivate

Definition at line 1921 of file flow_graph.h.

1921  {
1922  task *new_task = my_successors.try_put_task(this->back());
1923  if (new_task) {
1924  // workaround for icc bug
1925  graph& g = this->my_graph;
1926  last_task = combine_tasks(g, last_task, new_task);
1927  this->destroy_back();
1928  }
1929  }
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
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1715
static tbb::task * combine_tasks(graph &g, tbb::task *left, tbb::task *right)
Definition: flow_graph.h:191

◆ try_put_task()

template<typename T, typename A = cache_aligned_allocator<T>>
task* tbb::flow::interface11::buffer_node< T, A >::try_put_task ( const T &  t)
inlineprotectedvirtual

receive an item, return a task *if possible

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

Definition at line 2155 of file flow_graph.h.

References tbb::flow::interface11::internal::FAILED, tbb::flow::interface11::internal::function_output< Output >::graph_reference(), tbb::flow::interface11::internal::spawn_in_graph_arena(), tbb::flow::interface11::internal::SUCCEEDED, and tbb::flow::internal::SUCCESSFULLY_ENQUEUED.

2155  {
2156  buffer_operation op_data(t, put_item);
2157  my_aggregator.execute(&op_data);
2158  task *ft = grab_forwarding_task(op_data);
2159  // sequencer_nodes can return failure (if an item has been previously inserted)
2160  // We have to spawn the returned task if our own operation fails.
2161 
2162  if(ft && op_data.status ==internal::FAILED) {
2163  // we haven't succeeded queueing the item, but for some reason the
2164  // call returned a task (if another request resulted in a successful
2165  // forward this could happen.) Queue the task and reset the pointer.
2167  }
2168  else if(!ft && op_data.status ==internal::SUCCEEDED) {
2169  ft = SUCCESSFULLY_ENQUEUED;
2170  }
2171  return ft;
2172  }
static tbb::task *const SUCCESSFULLY_ENQUEUED
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
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
void spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
graph & graph_reference() const __TBB_override
Definition: flow_graph.h:2174
task * grab_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1821
Here is the call graph for this function:

◆ try_release()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::try_release ( )
inlinevirtual

Release a reserved item.

true = item has been released and so remains in sender

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

Definition at line 2133 of file flow_graph.h.

References void.

2133  {
2134  buffer_operation op_data(rel_res);
2135  my_aggregator.execute(&op_data);
2136  (void)enqueue_forwarding_task(op_data);
2137  return true;
2138  }
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1825

◆ try_reserve()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::try_reserve ( T &  v)
inlinevirtual

Reserves an item.

false = no item can be reserved
true = an item is reserved

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

Definition at line 2123 of file flow_graph.h.

References tbb::flow::interface11::buffer_node< T, A >::buffer_operation::elem, tbb::flow::interface11::internal::SUCCEEDED, and void.

2123  {
2124  buffer_operation op_data(res_item);
2125  op_data.elem = &v;
2126  my_aggregator.execute(&op_data);
2127  (void)enqueue_forwarding_task(op_data);
2128  return (op_data.status==internal::SUCCEEDED);
2129  }
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1765
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1825

Friends And Related Function Documentation

◆ internal::aggregating_functor< class_type, buffer_operation >

template<typename T, typename A = cache_aligned_allocator<T>>
friend class internal::aggregating_functor< class_type, buffer_operation >
friend

Definition at line 1764 of file flow_graph.h.

◆ internal::broadcast_cache

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

Definition at line 2152 of file flow_graph.h.

◆ internal::forward_task_bypass< buffer_node< T, A > >

template<typename T, typename A = cache_aligned_allocator<T>>
friend class internal::forward_task_bypass< buffer_node< T, A > >
friend

Definition at line 1721 of file flow_graph.h.

◆ internal::round_robin_cache

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

Definition at line 2153 of file flow_graph.h.

◆ run_and_put_task

template<typename T, typename A = cache_aligned_allocator<T>>
template<typename R , typename B >
friend class run_and_put_task
friend

Definition at line 2151 of file flow_graph.h.

Member Data Documentation

◆ forwarder_busy

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface11::buffer_node< T, A >::forwarder_busy
protected

Definition at line 1762 of file flow_graph.h.

◆ my_aggregator

template<typename T, typename A = cache_aligned_allocator<T>>
internal::aggregator< handler_type, buffer_operation> tbb::flow::interface11::buffer_node< T, A >::my_aggregator
protected

Definition at line 1765 of file flow_graph.h.

◆ my_successors

template<typename T, typename A = cache_aligned_allocator<T>>
internal::round_robin_cache< T, null_rw_mutex > tbb::flow::interface11::buffer_node< T, A >::my_successors
protected

Definition at line 1715 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.