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

Forwards messages in arbitrary order. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::buffer_node< T, A >:
Collaboration diagram for tbb::flow::interface10::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::interface10::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::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

 buffer_node (graph &g)
 Constructor. More...
 
 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::interface10::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from tbb::flow::interface10::internal::reservable_item_buffer< T, A >
 reservable_item_buffer ()
 
void reset ()
 
- Public Member Functions inherited from tbb::flow::interface10::internal::item_buffer< T, A >
 item_buffer ()
 Constructor. More...
 
 ~item_buffer ()
 
void reset ()
 
- 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 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::interface10::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 () __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::internal::reservable_item_buffer< T, A >
bool reserve_front (T &v)
 
void consume_front ()
 
void release_front ()
 
- Protected Member Functions inherited from tbb::flow::interface10::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::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

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::interface10::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 
- Protected Attributes inherited from tbb::flow::interface10::internal::reservable_item_buffer< T, A >
bool my_reserved
 
- Protected Attributes inherited from tbb::flow::interface10::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

- Static Protected Attributes inherited from tbb::flow::interface10::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::interface10::buffer_node< T, A >

Forwards messages in arbitrary order.

Definition at line 1539 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::interface10::buffer_node< T, A >::class_type

Definition at line 1545 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::interface10::buffer_node< T, A >::handler_type
protected

Definition at line 1600 of file flow_graph.h.

◆ input_type

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

Definition at line 1541 of file flow_graph.h.

◆ output_type

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

Definition at line 1542 of file flow_graph.h.

◆ predecessor_type

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

Definition at line 1543 of file flow_graph.h.

◆ size_type

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

Definition at line 1551 of file flow_graph.h.

◆ successor_type

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

Definition at line 1544 of file flow_graph.h.

Member Enumeration Documentation

◆ op_type

template<typename T, typename A = cache_aligned_allocator<T>>
enum tbb::flow::interface10::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 1560 of file flow_graph.h.

1561 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
1562  , add_blt_succ, del_blt_succ,
1563  add_blt_pred, del_blt_pred,
1564  blt_succ_cnt, blt_pred_cnt,
1565  blt_succ_cpy, blt_pred_cpy // create vector copies of preds and succs
1566 #endif
1567  };

Constructor & Destructor Documentation

◆ buffer_node() [1/2]

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

Constructor.

Definition at line 1835 of file flow_graph.h.

1836  forwarder_busy(false) {
1837  my_successors.set_owner(this);
1838  my_aggregator.initialize_handler(handler_type(this));
1839  tbb::internal::fgt_node( tbb::internal::FLOW_BUFFER_NODE, &this->my_graph,
1840  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
1841  }
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1552
item_buffer with reservable front-end. NOTE: if reserving, do not
internal::aggregating_functor< class_type, buffer_operation > handler_type
Definition: flow_graph.h:1600
static void fgt_node(string_index, void *, void *)
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

References tbb::internal::fgt_node(), tbb::flow::interface10::buffer_node< T, A >::my_aggregator, tbb::flow::interface10::graph_node::my_graph, and tbb::flow::interface10::buffer_node< T, A >::my_successors.

Here is the call graph for this function:

◆ buffer_node() [2/2]

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

Copy constructor.

Definition at line 1844 of file flow_graph.h.

1844  : graph_node(src.my_graph),
1845  internal::reservable_item_buffer<T>(), receiver<T>(), sender<T>() {
1846  forwarder_busy = false;
1847  my_successors.set_owner(this);
1848  my_aggregator.initialize_handler(handler_type(this));
1849  tbb::internal::fgt_node( tbb::internal::FLOW_BUFFER_NODE, &this->my_graph,
1850  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
1851  }
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1552
item_buffer with reservable front-end. NOTE: if reserving, do not
internal::aggregating_functor< class_type, buffer_operation > handler_type
Definition: flow_graph.h:1600
static void fgt_node(string_index, void *, void *)
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

References tbb::internal::fgt_node(), tbb::flow::interface10::buffer_node< T, A >::forwarder_busy, tbb::flow::interface10::buffer_node< T, A >::my_aggregator, tbb::flow::interface10::graph_node::my_graph, and tbb::flow::interface10::buffer_node< T, A >::my_successors.

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::interface10::buffer_node< T, A >::enqueue_forwarding_task ( buffer_operation op_data)
inlineprotected

Definition at line 1662 of file flow_graph.h.

1662  {
1663  task *ft = grab_forwarding_task(op_data);
1664  if(ft) {
1666  return true;
1667  }
1668  return false;
1669  }
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(graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
graph & graph_reference() __TBB_override
Definition: flow_graph.h:2004
task * grab_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1658

Referenced by tbb::flow::interface10::buffer_node< T, A >::try_release(), and tbb::flow::interface10::internal::unfolded_join_node< 10, key_matching_port, OutputTuple, key_matching< K, KHash > >::unfolded_join_node().

Here is the caller graph for this function:

◆ forward_task()

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

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

Definition at line 1672 of file flow_graph.h.

1672  {
1673  buffer_operation op_data(try_fwd_task);
1674  task *last_task = NULL;
1675  do {
1676  op_data.status = internal::WAIT;
1677  op_data.ltask = NULL;
1678  my_aggregator.execute(&op_data);
1679 
1680  // workaround for icc bug
1681  tbb::task *xtask = op_data.ltask;
1682  graph& g = this->my_graph;
1683  last_task = combine_tasks(g, last_task, xtask);
1684  } while (op_data.status ==internal::SUCCEEDED);
1685  return last_task;
1686  }
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
Base class for user-defined tasks.
Definition: task.h:589
static tbb::task * combine_tasks(graph &g, tbb::task *left, tbb::task *right)
Definition: flow_graph.h:167
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

References tbb::flow::interface10::buffer_node< T, A >::my_aggregator, tbb::flow::interface10::buffer_node< T, A >::try_fwd_task, and tbb::flow::interface10::internal::WAIT.

◆ grab_forwarding_task()

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

Definition at line 1658 of file flow_graph.h.

1658  {
1659  return op_data.ltask;
1660  }

◆ graph_reference()

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

◆ handle_operations()

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

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

Definition at line 1604 of file flow_graph.h.

1604  {
1605  handle_operations_impl(op_list, this);
1606  }
void handle_operations_impl(buffer_operation *op_list, derived_type *derived)
Definition: flow_graph.h:1609

References tbb::flow::interface10::buffer_node< T, A >::handle_operations_impl().

Here is the call graph for this function:

◆ handle_operations_impl()

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

Definition at line 1609 of file flow_graph.h.

1609  {
1610  __TBB_ASSERT(static_cast<class_type*>(derived) == this, "'this' is not a base class for derived");
1611 
1612  buffer_operation *tmp = NULL;
1613  bool try_forwarding = false;
1614  while (op_list) {
1615  tmp = op_list;
1616  op_list = op_list->next;
1617  switch (tmp->type) {
1618  case reg_succ: internal_reg_succ(tmp); try_forwarding = true; break;
1619  case rem_succ: internal_rem_succ(tmp); break;
1620  case req_item: internal_pop(tmp); break;
1621  case res_item: internal_reserve(tmp); break;
1622  case rel_res: internal_release(tmp); try_forwarding = true; break;
1623  case con_res: internal_consume(tmp); try_forwarding = true; break;
1624  case put_item: try_forwarding = internal_push(tmp); break;
1625  case try_fwd_task: internal_forward_task(tmp); break;
1626 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
1627  // edge recording
1628  case add_blt_succ: internal_add_built_succ(tmp); break;
1629  case del_blt_succ: internal_del_built_succ(tmp); break;
1630  case add_blt_pred: internal_add_built_pred(tmp); break;
1631  case del_blt_pred: internal_del_built_pred(tmp); break;
1632  case blt_succ_cnt: internal_succ_cnt(tmp); break;
1633  case blt_pred_cnt: internal_pred_cnt(tmp); break;
1634  case blt_succ_cpy: internal_copy_succs(tmp); break;
1635  case blt_pred_cpy: internal_copy_preds(tmp); break;
1636 #endif
1637  }
1638  }
1639 
1640  derived->order();
1641 
1642  if (try_forwarding && !forwarder_busy) {
1643  if(internal::is_graph_active(this->my_graph)) {
1644  forwarder_busy = true;
1645  task *new_task = new(task::allocate_additional_child_of(*(this->my_graph.root_task()))) internal::
1646  forward_task_bypass
1647  < buffer_node<input_type, A> >(*this);
1648  // tmp should point to the last item handled by the aggregator. This is the operation
1649  // the handling thread enqueued. So modifying that record will be okay.
1650  // workaround for icc bug
1651  tbb::task *z = tmp->ltask;
1652  graph &g = this->my_graph;
1653  tmp->ltask = combine_tasks(g, z, new_task); // in case the op generated a task
1654  }
1655  }
1656  } // handle_operations
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
virtual void internal_forward_task(buffer_operation *op)
Tries to forward valid items to successors.
Definition: flow_graph.h:1770
virtual void internal_consume(buffer_operation *op)
Definition: flow_graph.h:1823
virtual void internal_reserve(buffer_operation *op)
Definition: flow_graph.h:1814
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
tbb::task * root_task()
Returns the root task of the graph.
Base class for user-defined tasks.
Definition: task.h:589
virtual void internal_reg_succ(buffer_operation *op)
Register successor.
Definition: flow_graph.h:1689
virtual bool internal_push(buffer_operation *op)
Definition: flow_graph.h:1799
virtual void internal_release(buffer_operation *op)
Definition: flow_graph.h:1828
virtual void internal_rem_succ(buffer_operation *op)
Remove successor.
Definition: flow_graph.h:1695
virtual void internal_pop(buffer_operation *op)
Definition: flow_graph.h:1805
static tbb::task * combine_tasks(graph &g, tbb::task *left, tbb::task *right)
Definition: flow_graph.h:167

Referenced by tbb::flow::interface10::buffer_node< T, A >::handle_operations(), and tbb::flow::interface10::priority_queue_node< T, Compare, A >::handle_operations().

Here is the caller graph for this function:

◆ internal_consume()

template<typename T, typename A = cache_aligned_allocator<T>>
virtual void tbb::flow::interface10::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::interface10::buffer_node< T, A >::internal_forward_task ( buffer_operation op)
inlineprotectedvirtual

Tries to forward valid items to successors.

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

Definition at line 1770 of file flow_graph.h.

1770  {
1771  internal_forward_task_impl(op, this);
1772  }
void internal_forward_task_impl(buffer_operation *op, derived_type *derived)
Definition: flow_graph.h:1775

References tbb::flow::interface10::buffer_node< T, A >::internal_forward_task_impl().

Here is the call graph for this function:

◆ internal_forward_task_impl()

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

Definition at line 1775 of file flow_graph.h.

1775  {
1776  __TBB_ASSERT(static_cast<class_type*>(derived) == this, "'this' is not a base class for derived");
1777 
1778  if (this->my_reserved || !derived->is_item_valid()) {
1780  this->forwarder_busy = false;
1781  return;
1782  }
1783  // Try forwarding, giving each successor a chance
1784  task * last_task = NULL;
1785  size_type counter = my_successors.size();
1786  for (; counter > 0 && derived->is_item_valid(); --counter)
1787  derived->try_put_and_add_task(last_task);
1788 
1789  op->ltask = last_task; // return task
1790  if (last_task && !counter) {
1792  }
1793  else {
1795  forwarder_busy = false;
1796  }
1797  }
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 __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:713
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1552
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

References __TBB_ASSERT, tbb::internal::__TBB_store_with_release(), and tbb::flow::interface10::internal::FAILED.

Referenced by tbb::flow::interface10::buffer_node< T, A >::internal_forward_task(), tbb::flow::interface10::queue_node< T, A >::internal_forward_task(), and tbb::flow::interface10::priority_queue_node< T, Compare, A >::internal_forward_task().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ internal_pop()

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

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

Definition at line 1805 of file flow_graph.h.

1805  {
1806  if(this->pop_back(*(op->elem))) {
1808  }
1809  else {
1811  }
1812  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:713

◆ internal_push()

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

Reimplemented in tbb::flow::interface10::priority_queue_node< T, Compare, A >, and tbb::flow::interface10::sequencer_node< T, A >.

Definition at line 1799 of file flow_graph.h.

1799  {
1800  this->push_back(*(op->elem));
1802  return true;
1803  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:713

References tbb::flow::interface10::internal::item_buffer< T, A >::push_back().

Here is the call graph for this function:

◆ internal_reg_succ()

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

Register successor.

Definition at line 1689 of file flow_graph.h.

1689  {
1690  my_successors.register_successor(*(op->r));
1692  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:713
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1552

◆ internal_release()

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

◆ internal_rem_succ()

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

Remove successor.

Definition at line 1695 of file flow_graph.h.

1695  {
1696  my_successors.remove_successor(*(op->r));
1698  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:713
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1552

◆ internal_reserve()

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

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

Definition at line 1814 of file flow_graph.h.

1814  {
1815  if(this->reserve_front(*(op->elem))) {
1817  }
1818  else {
1820  }
1821  }
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:713

◆ is_item_valid()

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

Definition at line 1754 of file flow_graph.h.

1754  {
1755  return this->my_item_valid(this->my_tail - 1);
1756  }

◆ order()

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

Definition at line 1752 of file flow_graph.h.

1752 {}

◆ register_successor()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface10::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::interface10::internal::untyped_sender.

Definition at line 1865 of file flow_graph.h.

1865  {
1866  buffer_operation op_data(reg_succ);
1867  op_data.r = &r;
1868  my_aggregator.execute(&op_data);
1869  (void)enqueue_forwarding_task(op_data);
1870  return true;
1871  }
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1662
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

◆ remove_successor()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface10::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::interface10::internal::untyped_sender.

Definition at line 1927 of file flow_graph.h.

1927  {
1928  r.remove_predecessor(*this);
1929  buffer_operation op_data(rem_succ);
1930  op_data.r = &r;
1931  my_aggregator.execute(&op_data);
1932  // even though this operation does not cause a forward, if we are the handler, and
1933  // a forward is scheduled, we may be the first to reach this point after the aggregator,
1934  // and so should check for the task.
1935  (void)enqueue_forwarding_task(op_data);
1936  return true;
1937  }
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1662
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

◆ reset_node()

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

◆ reset_receiver()

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

put receiver back in initial state

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

Definition at line 2008 of file flow_graph.h.

2008 { }

◆ try_consume()

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

Consumes a reserved item.

true = item is removed from sender and reservation removed

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

Definition at line 1972 of file flow_graph.h.

1972  {
1973  buffer_operation op_data(con_res);
1974  my_aggregator.execute(&op_data);
1975  (void)enqueue_forwarding_task(op_data);
1976  return true;
1977  }
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1662
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

◆ try_get()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface10::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::interface10::sender< T >.

Definition at line 1942 of file flow_graph.h.

1942  {
1943  buffer_operation op_data(req_item);
1944  op_data.elem = &v;
1945  my_aggregator.execute(&op_data);
1946  (void)enqueue_forwarding_task(op_data);
1947  return (op_data.status==internal::SUCCEEDED);
1948  }
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1662
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

◆ try_put_and_add_task()

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

Definition at line 1758 of file flow_graph.h.

1758  {
1759  task *new_task = my_successors.try_put_task(this->back());
1760  if (new_task) {
1761  // workaround for icc bug
1762  graph& g = this->my_graph;
1763  last_task = combine_tasks(g, last_task, new_task);
1764  this->destroy_back();
1765  }
1766  }
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:1552
static tbb::task * combine_tasks(graph &g, tbb::task *left, tbb::task *right)
Definition: flow_graph.h:167

◆ try_put_task()

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

receive an item, return a task *if possible

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

Definition at line 1985 of file flow_graph.h.

1985  {
1986  buffer_operation op_data(t, put_item);
1987  my_aggregator.execute(&op_data);
1988  task *ft = grab_forwarding_task(op_data);
1989  // sequencer_nodes can return failure (if an item has been previously inserted)
1990  // We have to spawn the returned task if our own operation fails.
1991 
1992  if(ft && op_data.status ==internal::FAILED) {
1993  // we haven't succeeded queueing the item, but for some reason the
1994  // call returned a task (if another request resulted in a successful
1995  // forward this could happen.) Queue the task and reset the pointer.
1997  }
1998  else if(!ft && op_data.status ==internal::SUCCEEDED) {
1999  ft = SUCCESSFULLY_ENQUEUED;
2000  }
2001  return ft;
2002  }
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(graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
static tbb::task *const SUCCESSFULLY_ENQUEUED
graph & graph_reference() __TBB_override
Definition: flow_graph.h:2004
task * grab_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1658
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

References tbb::flow::interface10::buffer_node< T, A >::put_item.

◆ try_release()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface10::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::interface10::internal::untyped_sender.

Definition at line 1963 of file flow_graph.h.

1963  {
1964  buffer_operation op_data(rel_res);
1965  my_aggregator.execute(&op_data);
1966  (void)enqueue_forwarding_task(op_data);
1967  return true;
1968  }
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1662
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

References tbb::flow::interface10::buffer_node< T, A >::enqueue_forwarding_task(), tbb::flow::interface10::buffer_node< T, A >::my_aggregator, tbb::flow::interface10::buffer_node< T, A >::rel_res, and void.

Here is the call graph for this function:

◆ try_reserve()

template<typename T, typename A = cache_aligned_allocator<T>>
bool tbb::flow::interface10::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::interface10::sender< T >.

Definition at line 1953 of file flow_graph.h.

1953  {
1954  buffer_operation op_data(res_item);
1955  op_data.elem = &v;
1956  my_aggregator.execute(&op_data);
1957  (void)enqueue_forwarding_task(op_data);
1958  return (op_data.status==internal::SUCCEEDED);
1959  }
bool enqueue_forwarding_task(buffer_operation &op_data)
Definition: flow_graph.h:1662
internal::aggregator< handler_type, buffer_operation > my_aggregator
Definition: flow_graph.h:1602

References tbb::flow::interface10::buffer_node< T, A >::res_item.

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 1601 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 1982 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 1558 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 1983 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 1981 of file flow_graph.h.

Member Data Documentation

◆ forwarder_busy

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

◆ my_aggregator

◆ my_successors


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.