Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface11::source_node< Output > Class Template Reference

An executable node that acts as a source, i.e. it has no predecessors. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::source_node< Output >:
Collaboration diagram for tbb::flow::interface11::source_node< Output >:

Public Types

typedef Output output_type
 The type of the output message, which is complete. More...
 
typedef sender< output_type >::successor_type successor_type
 The type of successors of this node. More...
 
typedef null_type input_type
 
- 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

template<typename Body >
__TBB_NOINLINE_SYM source_node (graph &g, Body body, bool is_active=true)
 Constructor for a node with a successor. More...
 
__TBB_NOINLINE_SYM source_node (const source_node &src)
 Copy constructor. More...
 
 ~source_node ()
 The destructor. More...
 
bool register_successor (successor_type &r) __TBB_override
 Add a new successor to this node. More...
 
bool remove_successor (successor_type &r) __TBB_override
 Removes a successor from this node. More...
 
bool try_get (output_type &v) __TBB_override
 Request an item from the node. More...
 
bool try_reserve (output_type &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...
 
void activate ()
 Activates a node that was created in the inactive state. More...
 
template<typename Body >
Body copy_function_object ()
 
- 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::untyped_sender
virtual ~untyped_sender ()
 

Protected Member Functions

void reset_node (reset_flags f) __TBB_override
 resets the source_node to its initial state More...
 
- Protected Member Functions inherited from tbb::flow::interface11::sender< Output >
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...
 

Private Member Functions

bool try_reserve_apply_body (output_type &v)
 
taskcreate_put_task ()
 
void spawn_put ()
 Spawns a task that applies the body. More...
 
taskapply_body_bypass ()
 Applies the body. Returning SUCCESSFULLY_ENQUEUED okay; forward_task_bypass will handle it. More...
 

Private Attributes

spin_mutex my_mutex
 
bool my_active
 
bool init_my_active
 
internal::source_body< output_type > * my_body
 
internal::source_body< output_type > * my_init_body
 
internal::broadcast_cache< output_typemy_successors
 
bool my_reserved
 
bool my_has_cached_item
 
output_type my_cached_item
 

Friends

class internal::source_task_bypass< source_node< output_type > >
 

Additional Inherited Members

- Public Attributes inherited from tbb::flow::interface11::sender< Output >
__TBB_DEPRECATED typedef Output output_type
 The output type of this sender. More...
 
__TBB_DEPRECATED typedef internal::async_helpers< Output >::filtered_type filtered_type
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 

Detailed Description

template<typename Output>
class tbb::flow::interface11::source_node< Output >

An executable node that acts as a source, i.e. it has no predecessors.

Definition at line 896 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

template<typename Output >
typedef null_type tbb::flow::interface11::source_node< Output >::input_type

Definition at line 905 of file flow_graph.h.

◆ output_type

template<typename Output >
typedef Output tbb::flow::interface11::source_node< Output >::output_type

The type of the output message, which is complete.

Definition at line 899 of file flow_graph.h.

◆ successor_type

template<typename Output >
typedef sender<output_type>::successor_type tbb::flow::interface11::source_node< Output >::successor_type

The type of successors of this node.

Definition at line 902 of file flow_graph.h.

Constructor & Destructor Documentation

◆ source_node() [1/2]

template<typename Output >
template<typename Body >
__TBB_NOINLINE_SYM tbb::flow::interface11::source_node< Output >::source_node ( graph g,
Body  body,
bool  is_active = true 
)
inline

Constructor for a node with a successor.

Definition at line 914 of file flow_graph.h.

915  : graph_node(g), my_active(is_active), init_my_active(is_active),
918  my_reserved(false), my_has_cached_item(false)
919  {
920  my_successors.set_owner(this);
921  tbb::internal::fgt_node_with_body( CODEPTR(), tbb::internal::FLOW_SOURCE_NODE, &this->my_graph,
922  static_cast<sender<output_type> *>(this), this->my_body );
923  }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1098
#define CODEPTR()
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1097
The leaf for source_body.
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099
static void fgt_node_with_body(void *, string_index, void *, void *, void *)

◆ source_node() [2/2]

template<typename Output >
__TBB_NOINLINE_SYM tbb::flow::interface11::source_node< Output >::source_node ( const source_node< Output > &  src)
inline

Copy constructor.

Definition at line 934 of file flow_graph.h.

934  :
935  graph_node(src.my_graph), sender<Output>(),
936  my_active(src.init_my_active),
937  init_my_active(src.init_my_active), my_body( src.my_init_body->clone() ), my_init_body(src.my_init_body->clone() ),
938  my_reserved(false), my_has_cached_item(false)
939  {
940  my_successors.set_owner(this);
941  tbb::internal::fgt_node_with_body(CODEPTR(), tbb::internal::FLOW_SOURCE_NODE, &this->my_graph,
942  static_cast<sender<output_type> *>(this), this->my_body );
943  }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1098
#define CODEPTR()
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1097
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099
static void fgt_node_with_body(void *, string_index, void *, void *, void *)

◆ ~source_node()

template<typename Output >
tbb::flow::interface11::source_node< Output >::~source_node ( )
inline

The destructor.

Definition at line 946 of file flow_graph.h.

946 { delete my_body; delete my_init_body; }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1098
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1097

References tbb::flow::interface11::source_node< Output >::my_body, and tbb::flow::interface11::source_node< Output >::my_init_body.

Member Function Documentation

◆ activate()

template<typename Output >
void tbb::flow::interface11::source_node< Output >::activate ( )
inline

Activates a node that was created in the inactive state.

Definition at line 1052 of file flow_graph.h.

1052  {
1054  my_active = true;
1055  if (!my_successors.empty())
1056  spawn_put();
1057  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1137
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099
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 __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

◆ apply_body_bypass()

template<typename Output >
task* tbb::flow::interface11::source_node< Output >::apply_body_bypass ( )
inlineprivate

Applies the body. Returning SUCCESSFULLY_ENQUEUED okay; forward_task_bypass will handle it.

Definition at line 1145 of file flow_graph.h.

1145  {
1146  output_type v;
1147  if ( !try_reserve_apply_body(v) )
1148  return NULL;
1149 
1150  task *last_task = my_successors.try_put_task(v);
1151  if ( last_task )
1152  try_consume();
1153  else
1154  try_release();
1155  return last_task;
1156  }
Output output_type
The type of the output message, which is complete.
Definition: flow_graph.h:899
bool try_consume() __TBB_override
Consumes a reserved item.
Definition: flow_graph.h:1040
bool try_reserve_apply_body(output_type &v)
Definition: flow_graph.h:1105
bool try_release() __TBB_override
Release a reserved item.
Definition: flow_graph.h:1030
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::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099

References tbb::flow::interface11::source_node< Output >::my_successors, tbb::flow::interface11::source_node< Output >::try_consume(), tbb::flow::interface11::internal::broadcast_cache< T, M >::try_put_task(), tbb::flow::interface11::source_node< Output >::try_release(), and tbb::flow::interface11::source_node< Output >::try_reserve_apply_body().

Here is the call graph for this function:

◆ copy_function_object()

template<typename Output >
template<typename Body >
Body tbb::flow::interface11::source_node< Output >::copy_function_object ( )
inline

Definition at line 1060 of file flow_graph.h.

1060  {
1061  internal::source_body<output_type> &body_ref = *this->my_body;
1062  return dynamic_cast< internal::source_body_leaf<output_type, Body> & >(body_ref).get_body();
1063  }
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1097
The leaf for source_body.
A functor that takes no input and generates a value of type Output.

◆ create_put_task()

template<typename Output >
task* tbb::flow::interface11::source_node< Output >::create_put_task ( )
inlineprivate

Definition at line 1131 of file flow_graph.h.

1131  {
1132  return ( new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
1133  internal:: source_task_bypass < source_node< output_type > >( *this ) );
1134  }
tbb::task * root_task()
Returns the root task of the graph.
A task that calls a node's apply_body_bypass function with no input.

References tbb::flow::interface11::graph_node::my_graph, and tbb::flow::interface10::graph::root_task().

Referenced by tbb::flow::interface11::source_node< Output >::spawn_put().

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

◆ register_successor()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::register_successor ( successor_type r)
inlinevirtual

Add a new successor to this node.

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

Definition at line 955 of file flow_graph.h.

955  {
958  if ( my_active )
959  spawn_put();
960  return true;
961  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1137
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099
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 __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

◆ remove_successor()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::remove_successor ( successor_type r)
inlinevirtual

Removes a successor from this node.

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

Definition at line 964 of file flow_graph.h.

964  {
967  return true;
968  }
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099
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 __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

◆ reset_node()

template<typename Output >
void tbb::flow::interface11::source_node< Output >::reset_node ( reset_flags  f)
inlineprotectedvirtual

resets the source_node to its initial state

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

Definition at line 1077 of file flow_graph.h.

1077  {
1079  my_reserved =false;
1080  if(my_has_cached_item) {
1081  my_has_cached_item = false;
1082  }
1084  if(f & rf_reset_bodies) {
1086  delete my_body;
1087  my_body = tmp;
1088  }
1089  if(my_active)
1091  }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1098
void add_task_to_graph_reset_list(tbb::flow::interface10::graph &g, tbb::task *tp)
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1097
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099
A functor that takes no input and generates a value of type Output.

◆ spawn_put()

template<typename Output >
void tbb::flow::interface11::source_node< Output >::spawn_put ( )
inlineprivate

Spawns a task that applies the body.

Definition at line 1137 of file flow_graph.h.

1137  {
1138  if(internal::is_graph_active(this->my_graph)) {
1140  }
1141  }
bool is_graph_active(tbb::flow::interface10::graph &g)
void spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.

References tbb::flow::interface11::source_node< Output >::create_put_task(), tbb::flow::interface11::internal::is_graph_active(), tbb::flow::interface11::graph_node::my_graph, and tbb::flow::interface11::internal::spawn_in_graph_arena().

Here is the call graph for this function:

◆ try_consume()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_consume ( )
inlinevirtual

Consumes a reserved item.

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

Definition at line 1040 of file flow_graph.h.

1040  {
1042  __TBB_ASSERT( my_reserved && my_has_cached_item, "consuming non-existent reservation" );
1043  my_reserved = false;
1044  my_has_cached_item = false;
1045  if ( !my_successors.empty() ) {
1046  spawn_put();
1047  }
1048  return true;
1049  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1137
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
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 __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

References __TBB_ASSERT, tbb::flow::interface11::internal::successor_cache< T, M >::empty(), lock, tbb::flow::interface11::source_node< Output >::my_has_cached_item, tbb::flow::interface11::source_node< Output >::my_mutex, tbb::flow::interface11::source_node< Output >::my_reserved, and tbb::flow::interface11::source_node< Output >::my_successors.

Referenced by tbb::flow::interface11::source_node< Output >::apply_body_bypass().

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

◆ try_get()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_get ( output_type v)
inlinevirtual

Request an item from the node.

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

Definition at line 996 of file flow_graph.h.

996  {
998  if ( my_reserved )
999  return false;
1000 
1001  if ( my_has_cached_item ) {
1002  v = my_cached_item;
1003  my_has_cached_item = false;
1004  return true;
1005  }
1006  // we've been asked to provide an item, but we have none. enqueue a task to
1007  // provide one.
1008  spawn_put();
1009  return false;
1010  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1137
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 __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

◆ try_release()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_release ( )
inlinevirtual

Release a reserved item.

true = item has been released and so remains in sender, dest must request or reserve future items

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

Definition at line 1030 of file flow_graph.h.

1030  {
1032  __TBB_ASSERT( my_reserved && my_has_cached_item, "releasing non-existent reservation" );
1033  my_reserved = false;
1034  if(!my_successors.empty())
1035  spawn_put();
1036  return true;
1037  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1137
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1099
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
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 __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

References __TBB_ASSERT, lock, tbb::flow::interface11::source_node< Output >::my_has_cached_item, tbb::flow::interface11::source_node< Output >::my_mutex, and tbb::flow::interface11::source_node< Output >::my_reserved.

Referenced by tbb::flow::interface11::source_node< Output >::apply_body_bypass().

Here is the caller graph for this function:

◆ try_reserve()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_reserve ( output_type v)
inlinevirtual

Reserves an item.

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

Definition at line 1013 of file flow_graph.h.

1013  {
1015  if ( my_reserved ) {
1016  return false;
1017  }
1018 
1019  if ( my_has_cached_item ) {
1020  v = my_cached_item;
1021  my_reserved = true;
1022  return true;
1023  } else {
1024  return false;
1025  }
1026  }
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 __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

◆ try_reserve_apply_body()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_reserve_apply_body ( output_type v)
inlineprivate

Definition at line 1105 of file flow_graph.h.

1105  {
1107  if ( my_reserved ) {
1108  return false;
1109  }
1110  if ( !my_has_cached_item ) {
1112  bool r = (*my_body)(my_cached_item);
1114  if (r) {
1115  my_has_cached_item = true;
1116  }
1117  }
1118  if ( my_has_cached_item ) {
1119  v = my_cached_item;
1120  my_reserved = true;
1121  return true;
1122  } else {
1123  return false;
1124  }
1125  }
static void fgt_begin_body(void *)
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1097
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 __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179
static void fgt_end_body(void *)

References tbb::internal::fgt_begin_body(), tbb::internal::fgt_end_body(), lock, tbb::flow::interface11::source_node< Output >::my_body, tbb::flow::interface11::source_node< Output >::my_cached_item, tbb::flow::interface11::source_node< Output >::my_has_cached_item, tbb::flow::interface11::source_node< Output >::my_mutex, and tbb::flow::interface11::source_node< Output >::my_reserved.

Referenced by tbb::flow::interface11::source_node< Output >::apply_body_bypass().

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

Friends And Related Function Documentation

◆ internal::source_task_bypass< source_node< output_type > >

template<typename Output >
friend class internal::source_task_bypass< source_node< output_type > >
friend

Definition at line 1143 of file flow_graph.h.

Member Data Documentation

◆ init_my_active

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::init_my_active
private

Definition at line 1096 of file flow_graph.h.

◆ my_active

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::my_active
private

Definition at line 1095 of file flow_graph.h.

◆ my_body

◆ my_cached_item

◆ my_has_cached_item

◆ my_init_body

◆ my_mutex

◆ my_reserved

◆ 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.