Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Member Functions | Friends | List of all members
tbb::flow::interface11::queue_node< T, A > Class Template Reference

Forwards messages in FIFO order. More...

#include <flow_graph.h>

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

Public Types

typedef T input_type
 
typedef T output_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef sender< output_type >::successor_type successor_type
 
- Public Types inherited from tbb::flow::interface11::buffer_node< T, cache_aligned_allocator< T > >
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, cache_aligned_allocator< T > > class_type
 
- Public Types inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
enum  buffer_item_state
 
typedef T item_type
 

Public Member Functions

__TBB_NOINLINE_SYM queue_node (graph &g)
 Constructor. More...
 
__TBB_NOINLINE_SYM queue_node (const queue_node &src)
 Copy constructor. More...
 
- Public Member Functions inherited from tbb::flow::interface11::buffer_node< T, cache_aligned_allocator< T > >
__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 internal::reservable_item_buffer< T, cache_aligned_allocator< T > >
 reservable_item_buffer ()
 
void reset ()
 
- Public Member Functions inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
 item_buffer ()
 Constructor. More...
 
 ~item_buffer ()
 
void reset ()
 
- 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 Types

typedef buffer_node< T, A > base_type
 
typedef base_type::size_type size_type
 
typedef base_type::buffer_operation queue_operation
 
typedef queue_node class_type
 
- Protected Types inherited from tbb::flow::interface11::buffer_node< T, cache_aligned_allocator< T > >
enum  op_type
 
typedef size_t size_type
 
typedef internal::aggregating_functor< class_type, buffer_operation > handler_type
 
- Protected Types inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
typedef size_t size_type
 
typedef aligned_pair< item_type, buffer_item_state >::type buffer_item_type
 
typedef cache_aligned_allocator< T > ::template rebind< buffer_item_type >::other allocator_type
 

Protected Member Functions

void internal_forward_task (queue_operation *op) __TBB_override
 
void internal_pop (queue_operation *op) __TBB_override
 
void internal_reserve (queue_operation *op) __TBB_override
 
void internal_consume (queue_operation *op) __TBB_override
 
void reset_node (reset_flags f) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::buffer_node< T, cache_aligned_allocator< T > >
virtual void handle_operations (buffer_operation *op_list)
 
void handle_operations_impl (buffer_operation *op_list, derived_type *derived)
 
task * grab_forwarding_task (buffer_operation &op_data)
 
bool enqueue_forwarding_task (buffer_operation &op_data)
 
virtual task * forward_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...
 
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)
 
task * try_put_task (const T &t) __TBB_override
 receive an item, return a task *if possible More...
 
graph & graph_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 internal::reservable_item_buffer< T, cache_aligned_allocator< T > >
bool reserve_front (T &v)
 
void consume_front ()
 
void release_front ()
 
- Protected Member Functions inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
bool buffer_empty () const
 
buffer_item_type & item (size_type i)
 
const buffer_item_type & item (size_type i) const
 
bool my_item_valid (size_type i) const
 
bool my_item_reserved (size_type i) const
 
const item_type & get_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_type & front () const
 
const item_type & back () 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 graph & graph_reference () const =0
 
virtual bool is_continue_receiver ()
 

Private Member Functions

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

Friends

template<typename , typename >
class buffer_node
 

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...
 
- Protected Attributes inherited from tbb::flow::interface11::buffer_node< T, cache_aligned_allocator< T > >
internal::round_robin_cache< T, null_rw_mutex > my_successors
 
bool forwarder_busy
 
internal::aggregator< handler_type, buffer_operation > my_aggregator
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graph & my_graph
 
graph_node * next
 
graph_node * prev
 
- Protected Attributes inherited from internal::reservable_item_buffer< T, cache_aligned_allocator< T > >
bool my_reserved
 
- Protected Attributes inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
buffer_item_type * my_array
 
size_type my_array_size
 
size_type my_head
 
size_type my_tail
 
- Static Protected Attributes inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
static const size_type initial_buffer_size
 

Detailed Description

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

Forwards messages in FIFO order.

Definition at line 2206 of file flow_graph.h.

Member Typedef Documentation

◆ base_type

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

Definition at line 2208 of file flow_graph.h.

◆ class_type

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

Definition at line 2211 of file flow_graph.h.

◆ input_type

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

Definition at line 2259 of file flow_graph.h.

◆ output_type

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

Definition at line 2260 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::queue_node< T, A >::predecessor_type

Definition at line 2261 of file flow_graph.h.

◆ queue_operation

template<typename T , typename A = cache_aligned_allocator<T>>
typedef base_type::buffer_operation tbb::flow::interface11::queue_node< T, A >::queue_operation
protected

Definition at line 2210 of file flow_graph.h.

◆ size_type

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

Definition at line 2209 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::queue_node< T, A >::successor_type

Definition at line 2262 of file flow_graph.h.

Constructor & Destructor Documentation

◆ queue_node() [1/2]

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

Constructor.

Definition at line 2265 of file flow_graph.h.

2265  : base_type(g) {
2266  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_QUEUE_NODE, &(this->my_graph),
2267  static_cast<receiver<input_type> *>(this),
2268  static_cast<sender<output_type> *>(this) );
2269  }

◆ queue_node() [2/2]

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

Copy constructor.

Definition at line 2279 of file flow_graph.h.

2279  : base_type(src) {
2280  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_QUEUE_NODE, &(this->my_graph),
2281  static_cast<receiver<input_type> *>(this),
2282  static_cast<sender<output_type> *>(this) );
2283  }

Member Function Documentation

◆ internal_consume()

template<typename T , typename A = cache_aligned_allocator<T>>
void tbb::flow::interface11::queue_node< T, A >::internal_consume ( queue_operation *  op)
inlineprotected

Definition at line 2253 of file flow_graph.h.

2253  {
2254  this->consume_front();
2255  __TBB_store_with_release(op->status, internal::SUCCEEDED);
2256  }

◆ internal_forward_task()

template<typename T , typename A = cache_aligned_allocator<T>>
void tbb::flow::interface11::queue_node< T, A >::internal_forward_task ( queue_operation *  op)
inlineprotected

Definition at line 2231 of file flow_graph.h.

2231  {
2232  this->internal_forward_task_impl(op, this);
2233  }

◆ internal_pop()

template<typename T , typename A = cache_aligned_allocator<T>>
void tbb::flow::interface11::queue_node< T, A >::internal_pop ( queue_operation *  op)
inlineprotected

Definition at line 2235 of file flow_graph.h.

2235  {
2236  if ( this->my_reserved || !this->my_item_valid(this->my_head)){
2237  __TBB_store_with_release(op->status, internal::FAILED);
2238  }
2239  else {
2240  this->pop_front(*(op->elem));
2241  __TBB_store_with_release(op->status, internal::SUCCEEDED);
2242  }
2243  }

◆ internal_reserve()

template<typename T , typename A = cache_aligned_allocator<T>>
void tbb::flow::interface11::queue_node< T, A >::internal_reserve ( queue_operation *  op)
inlineprotected

Definition at line 2244 of file flow_graph.h.

2244  {
2245  if (this->my_reserved || !this->my_item_valid(this->my_head)) {
2246  __TBB_store_with_release(op->status, internal::FAILED);
2247  }
2248  else {
2249  this->reserve_front(*(op->elem));
2250  __TBB_store_with_release(op->status, internal::SUCCEEDED);
2251  }
2252  }

◆ is_item_valid()

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

Definition at line 2216 of file flow_graph.h.

2216  {
2217  return this->my_item_valid(this->my_head);
2218  }

◆ reset_node()

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

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

Definition at line 2292 of file flow_graph.h.

2292  {
2293  base_type::reset_node(f);
2294  }

◆ try_put_and_add_task()

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

Definition at line 2220 of file flow_graph.h.

2220  {
2221  task *new_task = this->my_successors.try_put_task(this->front());
2222  if (new_task) {
2223  // workaround for icc bug
2224  graph& graph_ref = this->graph_reference();
2225  last_task = combine_tasks(graph_ref, last_task, new_task);
2226  this->destroy_front();
2227  }
2228  }

Friends And Related Function Documentation

◆ buffer_node

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

Definition at line 2214 of file flow_graph.h.

The documentation for this class was generated from the following file:
internal::item_buffer< T, cache_aligned_allocator< T > >::my_item_valid
bool my_item_valid(size_type i) const
Definition: _flow_graph_item_buffer_impl.h:69
internal::reservable_item_buffer< T, cache_aligned_allocator< T > >::reserve_front
bool reserve_front(T &v)
Definition: _flow_graph_item_buffer_impl.h:258
internal::SUCCEEDED
@ SUCCEEDED
Definition: _flow_graph_types_impl.h:719
CODEPTR
#define CODEPTR()
Definition: _flow_graph_trace_impl.h:297
internal::item_buffer< T, cache_aligned_allocator< T > >::pop_front
bool pop_front(item_type &v)
Definition: _flow_graph_item_buffer_impl.h:204
tbb::flow::interface11::graph_node::my_graph
graph & my_graph
Definition: _flow_graph_impl.h:464
internal::reservable_item_buffer< T, cache_aligned_allocator< T > >::consume_front
void consume_front()
Definition: _flow_graph_item_buffer_impl.h:267
internal::item_buffer< T, cache_aligned_allocator< T > >::destroy_front
void destroy_front()
Definition: _flow_graph_item_buffer_impl.h:147
tbb::flow::interface11::combine_tasks
static tbb::task * combine_tasks(graph &g, tbb::task *left, tbb::task *right)
Definition: flow_graph.h:191
tbb::internal::__TBB_store_with_release
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:716
internal::item_buffer< T, cache_aligned_allocator< T > >::my_head
size_type my_head
Definition: _flow_graph_item_buffer_impl.h:52
tbb::flow::interface11::buffer_node< T, cache_aligned_allocator< T > >::my_successors
internal::round_robin_cache< T, null_rw_mutex > my_successors
Definition: flow_graph.h:1717
internal::item_buffer< T, cache_aligned_allocator< T > >::front
const item_type & front() const
Definition: _flow_graph_item_buffer_impl.h:130
tbb::flow::interface11::buffer_node::reset_node
void reset_node(reset_flags f) __TBB_override
Definition: flow_graph.h:2191
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::queue_node::base_type
buffer_node< T, A > base_type
Definition: flow_graph.h:2208
internal::FAILED
@ FAILED
Definition: _flow_graph_types_impl.h:719
tbb::flow::interface11::buffer_node< T, cache_aligned_allocator< T > >::graph_reference
graph & graph_reference() const __TBB_override
Definition: flow_graph.h:2176
tbb::internal::fgt_node
static void fgt_node(void *, string_index, void *, void *)
Definition: _flow_graph_trace_impl.h:326
tbb::flow::interface11::buffer_node< T, cache_aligned_allocator< T > >::internal_forward_task_impl
void internal_forward_task_impl(buffer_operation *op, derived_type *derived)
Definition: flow_graph.h:1940
internal::reservable_item_buffer< T, cache_aligned_allocator< T > >::my_reserved
bool my_reserved
Definition: _flow_graph_item_buffer_impl.h:279
tbb::flow::interface11::graph_node::graph
friend class graph
Definition: _flow_graph_impl.h:455

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.