17 #ifndef __TBB_pipeline_H 18 #define __TBB_pipeline_H 25 #if __TBB_CPP11_TYPE_PROPERTIES_PRESENT || __TBB_TR1_TYPE_PROPERTIES_IN_STD_PRESENT 26 #include <type_traits> 38 #define __TBB_PIPELINE_VERSION(x) ((unsigned char)(x-2)<<1) 49 namespace interface6 {
50 template<
typename T,
typename U>
class filter_t;
82 #if TBB_USE_CAPTURED_EXCEPTION 152 #if __TBB_TASK_GROUP_CONTEXT 247 #if __TBB_TASK_GROUP_CONTEXT 290 #if __TBB_TASK_GROUP_CONTEXT 300 namespace interface6 {
321 #if __TBB_CPP11_TYPE_PROPERTIES_PRESENT 323 #elif __TBB_TR1_TYPE_PROPERTIES_IN_STD_PRESENT 337 #endif // Obtaining type properties 352 return new (output_t) T(source);
382 } type_to_void_ptr_map;
390 type_to_void_ptr_map mymap;
391 mymap.void_overlay = NULL;
392 mymap.actual_value = ref;
393 return mymap.void_overlay;
396 type_to_void_ptr_map mymap;
397 mymap.void_overlay = ref;
398 return mymap.actual_value;
403 template<
typename T,
typename U,
typename Body>
412 t_pointer temp_input = t_helper::cast_from_void_ptr(input);
413 u_pointer output_u = u_helper::create_token(
my_body(t_helper::token(temp_input)));
414 t_helper::destroy_token(temp_input);
415 return u_helper::cast_to_void_ptr(output_u);
419 t_pointer temp_input = t_helper::cast_from_void_ptr(input);
420 t_helper::destroy_token(temp_input);
428 template<
typename U,
typename Body>
438 u_helper::destroy_token(output_u);
442 return u_helper::cast_to_void_ptr(output_u);
452 template<
typename T,
typename Body>
459 t_pointer temp_input = t_helper::cast_from_void_ptr(input);
460 my_body(t_helper::token(temp_input));
461 t_helper::destroy_token(temp_input);
465 t_pointer temp_input = t_helper::cast_from_void_ptr(input);
466 t_helper::destroy_token(temp_input);
473 template<
typename Body>
509 #ifdef __TBB_TEST_FILTER_NODE_COUNT 510 ++(__TBB_TEST_FILTER_NODE_COUNT);
525 #ifdef __TBB_TEST_FILTER_NODE_COUNT 526 --(__TBB_TEST_FILTER_NODE_COUNT);
532 template<
typename T,
typename U,
typename Body>
568 template<
typename T,
typename U,
typename Body>
570 return new internal::filter_node_leaf<T,U,Body>(
mode, body);
573 template<
typename T,
typename V,
typename U>
575 __TBB_ASSERT(left.
root,
"cannot use default-constructed filter_t as left argument of '&'");
576 __TBB_ASSERT(right.
root,
"cannot use default-constructed filter_t as right argument of '&'");
577 return new internal::filter_node_join(*left.
root,*right.
root);
581 template<
typename T,
typename U>
589 template<
typename T_,
typename U_,
typename Body>
591 template<
typename T_,
typename V_,
typename U_>
599 template<
typename Body>
601 root( new internal::filter_node_leaf<T,U,Body>(
mode, body) ) {
611 if( old ) old->remove_ref();
627 __TBB_ASSERT( filter_chain.
root,
"cannot apply parallel_pipeline to default-constructed filter_t" );
636 internal::pipeline_proxy pipe(filter_chain);
638 pipe->run(max_number_of_live_tokens
645 #if __TBB_TASK_GROUP_CONTEXT 650 #endif // __TBB_TASK_GROUP_CONTEXT 654 using interface6::flow_control;
655 using interface6::filter_t;
void * operator()(void *input) __TBB_override
Operate on an item from the input stream, and return item for output stream.
filter_t(const filter_t< T, U > &rhs)
bool is_ordered() const
True if filter must receive stream in order.
friend filter_t< T_, U_ > operator &(const filter_t< T_, V_ > &, const filter_t< V_, U_ > &)
atomic< internal::Token > input_tokens
Number of idle tokens waiting for input stage.
static const unsigned char filter_is_serial
The lowest bit 0 is for parallel vs. serial.
tbb::atomic< intptr_t > ref_count
friend class internal::pipeline_cleaner
virtual void finalize(void *)
Destroys item if pipeline was cancelled.
bool end_of_input
False until fetch_input returns NULL.
processes items one at a time and in no particular order
void remove_ref()
Decrement reference count and delete if it becomes zero.
filter_node_join(filter_node &x, filter_node &y)
bool object_may_be_null()
true if an input filter can emit null
filter_t(tbb::filter::mode mode, const Body &body)
static pointer create_token(const value_type &source)
const tbb::filter::mode mode
filter * prev_filter_in_pipeline
Pointer to previous filter in the pipeline.
static value_type & token(pointer &t)
tbb::pipeline * operator->()
pipeline * my_pipeline
Pointer to the pipeline.
#define __TBB_EXPORTED_METHOD
task * end_counter
task who's reference count is used to determine when all stages are done.
friend class internal::pipeline_proxy
internal::filter_node filter_node
bool is_bound() const
True if filter is thread-bound.
static pointer cast_from_void_ptr(void *ref)
A processing pipeline that applies filters to items.
Node in parse tree representing result of make_filter.
static pointer create_token(const value_type &source)
void * operator()(void *) __TBB_override
Class representing a chain of type-safe pipeline filters.
void __TBB_EXPORTED_METHOD set_end_of_input()
#define __TBB_PIPELINE_VERSION(x)
filter * filter_end
Pointer to location where address of next filter to be added should be stored.
processes multiple items in parallel and in no particular order
t_helper::pointer t_pointer
input_filter control to signal end-of-input for parallel_pipeline
void __TBB_EXPORTED_METHOD add_filter(filter &filter_)
Add filter to end of pipeline.
filter_node_leaf(tbb::filter::mode m, const Body &b)
Used to form groups of tasks.
token_helper< T, is_large_object< T >::value > t_helper
static void destroy_token(pointer)
concrete_filter(tbb::filter::mode filter_mode, const Body &body)
void add_to(pipeline &p) __TBB_override
Add concrete_filter to pipeline.
void parallel_pipeline(size_t max_number_of_live_tokens, const filter_t< void, void > &filter_chain, tbb::task_group_context &context)
Base class for types that should not be copied or assigned.
concrete_filter(filter::mode filter_mode, const Body &body)
A buffer of input items for a filter.
static value_type & token(pointer &t)
filter_t< T, U > make_filter(tbb::filter::mode mode, const Body &body)
Create a filter to participate in parallel_pipeline.
void __TBB_EXPORTED_METHOD run(size_t max_number_of_live_tokens)
Run the pipeline to completion.
static void * cast_to_void_ptr(pointer ref)
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 ITT_FORMAT p void ITT_FORMAT p void size_t ITT_FORMAT d void ITT_FORMAT p const wchar_t ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s no args void ITT_FORMAT p size_t ITT_FORMAT d no args const wchar_t const wchar_t ITT_FORMAT s __itt_heap_function void size_t int ITT_FORMAT d __itt_heap_function void ITT_FORMAT p __itt_heap_function void void size_t int ITT_FORMAT d no args no args unsigned int ITT_FORMAT u const __itt_domain __itt_id ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain __itt_id ITT_FORMAT p const __itt_domain __itt_id __itt_timestamp __itt_timestamp ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain ITT_FORMAT p const __itt_domain __itt_string_handle unsigned long long value
concrete_filter(tbb::filter::mode filter_mode, const Body &body)
static value_type & token(pointer &t)
processes items one at a time; all such filters process items in the same order
A stage in a pipeline served by a user thread.
filter_t< T, U > operator &(const filter_t< T, V > &left, const filter_t< V, U > &right)
Meets "allocator" requirements of ISO C++ Standard, Section 20.1.5.
Abstract base class that represents a node in a parse tree underlying a filter_t.
void operator=(const filter_t< T, U > &rhs)
void destroy(pointer p)
Destroy value at location pointed to by p.
const unsigned char my_filter_mode
Storage for filter mode and dynamically checked implementation version.
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
__TBB_EXPORTED_METHOD pipeline()
Construct empty pipeline.
filter_t(filter_node *root_)
tbb::tbb_allocator< T > allocator
friend class internal::stage_task
static const unsigned char filter_is_bound
5th bit distinguishes thread-bound and regular filters.
bool has_thread_bound_filters
True if the pipeline contains a thread-bound filter; false otherwise.
virtual __TBB_EXPORTED_METHOD ~pipeline()
static const unsigned char version_mask
#define __TBB_TASK_GROUP_CONTEXT
internal::input_buffer * my_input_buffer
Buffer for incoming tokens, or NULL if not required.
pointer allocate(size_type n, const void *=0)
Allocate space for n objects.
void __TBB_EXPORTED_METHOD clear()
Remove all filters from the pipeline.
void finalize(void *input) __TBB_override
Destroys item if pipeline was cancelled.
friend class internal::pipeline_root_task
thread_bound_filter(mode filter_mode)
filter * next_segment
Pointer to the next "segment" of filters, or NULL if not required.
Base class for user-defined tasks.
virtual void add_to(pipeline &)=0
Add concrete_filter to pipeline.
u_helper::pointer u_pointer
Node in parse tree representing join of two filters.
atomic< internal::Token > token_counter
Global counter of tokens.
token_helper< U, is_large_object< U >::value > u_helper
The class that represents an object of the pipeline for parallel_pipeline().
bool has_more_work()
has the filter not yet processed all the tokens it will ever see?
bool is_serial() const
True if filter is serial.
token_helper< U, is_large_object< U >::value > u_helper
concrete_filter(tbb::filter::mode filter_mode, const Body &body)
virtual __TBB_EXPORTED_METHOD ~filter()
Destroy filter.
result_type internal_process_item(bool is_blocking)
Internal routine for item processing.
static const unsigned char filter_may_emit_null
6th bit marks input filters emitting small objects
friend class internal::stage_task
void * operator()(void *) __TBB_override
Operate on an item from the input stream, and return item for output stream.
void finalize(void *input) __TBB_override
Destroys item if pipeline was cancelled.
virtual void * operator()(void *item)=0
Operate on an item from the input stream, and return item for output stream.
result_type __TBB_EXPORTED_METHOD process_item()
Wait until a data item becomes available, and invoke operator() on that item.
static const unsigned char current_version
static filter * not_in_pipeline()
Value used to mark "not in pipeline".
friend class internal::pipeline_root_task
static void * cast_to_void_ptr(pointer ref)
static pointer cast_from_void_ptr(void *ref)
t_helper::pointer t_pointer
static void destroy_token(pointer token)
token_helper< T, is_large_object< T >::value > t_helper
friend class internal::concrete_filter
result_type __TBB_EXPORTED_METHOD try_process_item()
If a data item is available, invoke operator() on that item.
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 ITT_FORMAT p void ITT_FORMAT p void size_t ITT_FORMAT d void ITT_FORMAT p const wchar_t ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s no args void ITT_FORMAT p size_t ITT_FORMAT d no args const wchar_t const wchar_t ITT_FORMAT s __itt_heap_function void size_t int ITT_FORMAT d __itt_heap_function void ITT_FORMAT p __itt_heap_function void void size_t int ITT_FORMAT d no args no args unsigned int ITT_FORMAT u const __itt_domain __itt_id ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain __itt_id ITT_FORMAT p const __itt_domain __itt_id __itt_timestamp __itt_timestamp ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain ITT_FORMAT p const __itt_domain __itt_string_handle unsigned long long ITT_FORMAT lu const __itt_domain __itt_id __itt_string_handle __itt_metadata_type size_t void ITT_FORMAT p const __itt_domain __itt_id __itt_string_handle const wchar_t size_t ITT_FORMAT lu const __itt_domain __itt_id __itt_relation __itt_id ITT_FORMAT p const wchar_t int ITT_FORMAT __itt_group_mark d int
static const unsigned char filter_is_out_of_order
4th bit distinguishes ordered vs unordered filters.
filter * next_filter_in_pipeline
Pointer to next filter in the pipeline.
void const char const char int ITT_FORMAT __itt_group_sync p
void deallocate(pointer p, size_type)
Free previously allocated block of memory.
u_helper::pointer u_pointer
static pointer create_token(const value_type &source)
filter * filter_list
Pointer to first filter in the pipeline.
void remove_filter(filter &filter_)
Remove filter from pipeline.
static pointer cast_from_void_ptr(void *ref)
static const unsigned char exact_exception_propagation
7th bit defines exception propagation mode expected by the application.
void clear_filters()
Does clean up if pipeline is cancelled or exception occurred.
void add_ref()
Increment reference count.
void * operator()(void *input) __TBB_override
Operate on an item from the input stream, and return item for output stream.
pipeline_proxy(const filter_t< void, void > &filter_chain)
static void * cast_to_void_ptr(pointer ref)
static void destroy_token(pointer)
void add_to(pipeline &p) __TBB_override
Add concrete_filter to pipeline.
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 mode
friend filter_t< T_, U_ > make_filter(tbb::filter::mode, const Body &)
Create a filter to participate in parallel_pipeline.
void __TBB_EXPORTED_METHOD inject_token(task &self)
Not used, but retained to satisfy old export files.