Intel(R) Threading Building Blocks Doxygen Documentation version 4.2.3
Loading...
Searching...
No Matches
tbb::internal::stage_task Class Reference
Inheritance diagram for tbb::internal::stage_task:
Collaboration diagram for tbb::internal::stage_task:

Public Member Functions

 stage_task (pipeline &pipeline)
 Construct stage_task for first stage in a pipeline.
 
 stage_task (pipeline &pipeline, filter *filter_, const task_info &info)
 Construct stage_task for a subsequent stage in a pipeline.
 
void reset ()
 Roughly equivalent to the constructor of input stage task.
 
taskexecute () __TBB_override
 The virtual task execution method.
 
void spawn_stage_task (const task_info &info)
 Creates and spawns stage_task from task_info.
 
- Public Member Functions inherited from tbb::task
virtual ~task ()
 Destructor.
 
virtual taskexecute ()=0
 Should be overridden by derived classes.
 
internal::allocate_continuation_proxyallocate_continuation ()
 Returns proxy for overloaded new that allocates a continuation task of *this.
 
internal::allocate_child_proxyallocate_child ()
 Returns proxy for overloaded new that allocates a child task of *this.
 
void recycle_as_continuation ()
 Change this to be a continuation of its former self.
 
void recycle_as_safe_continuation ()
 Recommended to use, safe variant of recycle_as_continuation.
 
void recycle_as_child_of (task &new_parent)
 Change this to be a child of new_parent.
 
void recycle_to_reexecute ()
 Schedule this for reexecution after current execute() returns.
 
void set_ref_count (int count)
 Set reference count.
 
void increment_ref_count ()
 Atomically increment reference count.
 
int add_ref_count (int count)
 Atomically adds to reference count and returns its new value.
 
int decrement_ref_count ()
 Atomically decrement reference count and returns its new value.
 
void spawn_and_wait_for_all (task &child)
 Similar to spawn followed by wait_for_all, but more efficient.
 
void __TBB_EXPORTED_METHOD spawn_and_wait_for_all (task_list &list)
 Similar to spawn followed by wait_for_all, but more efficient.
 
void wait_for_all ()
 Wait for reference count to become one, and set reference count to zero.
 
taskparent () const
 task on whose behalf this task is working, or NULL if this is a root.
 
void set_parent (task *p)
 sets parent task pointer to specified value
 
task_group_contextcontext ()
 This method is deprecated and will be removed in the future.
 
task_group_contextgroup ()
 Pointer to the task group descriptor.
 
bool is_stolen_task () const
 True if task was stolen from the task pool of another thread.
 
bool is_enqueued_task () const
 True if the task was enqueued.
 
state_type state () const
 Current execution state.
 
int ref_count () const
 The internal reference count.
 
bool __TBB_EXPORTED_METHOD is_owned_by_current_thread () const
 Obsolete, and only retained for the sake of backward compatibility. Always returns true.
 
void set_affinity (affinity_id id)
 Set affinity for this task.
 
affinity_id affinity () const
 Current affinity of this task.
 
virtual void __TBB_EXPORTED_METHOD note_affinity (affinity_id id)
 Invoked by scheduler to notify task that it ran on unexpected thread.
 
void __TBB_EXPORTED_METHOD change_group (task_group_context &ctx)
 Moves this task from its current group into another one.
 
bool cancel_group_execution ()
 Initiates cancellation of all tasks in this cancellation group and its subordinate groups.
 
bool is_cancelled () const
 Returns true if the context has received cancellation request.
 
__TBB_DEPRECATED void set_group_priority (priority_t p)
 Changes priority of the task group this task belongs to.
 
__TBB_DEPRECATED priority_t group_priority () const
 Retrieves current priority of the task group this task belongs to.
 
- Public Member Functions inherited from tbb::internal::task_info
void reset ()
 Set to initial state (no object, no token)
 

Private Attributes

pipelinemy_pipeline
 
filtermy_filter
 
bool my_at_start
 True if this task has not yet read the input.
 

Friends

class tbb::pipeline
 

Additional Inherited Members

- Public Types inherited from tbb::task
enum  state_type {
  executing , reexecute , ready , allocated ,
  freed , recycle
}
 Enumeration of task states that the scheduler considers. More...
 
typedef internal::affinity_id affinity_id
 An id as used for specifying affinity.
 
- Static Public Member Functions inherited from tbb::task
static internal::allocate_root_proxy allocate_root ()
 Returns proxy for overloaded new that allocates a root task.
 
static internal::allocate_root_with_context_proxy allocate_root (task_group_context &ctx)
 Returns proxy for overloaded new that allocates a root task associated with user supplied context.
 
static void spawn_root_and_wait (task &root)
 Spawn task allocated by allocate_root, wait for it to complete, and deallocate it.
 
static void spawn_root_and_wait (task_list &root_list)
 Spawn root tasks on list and wait for all of them to finish.
 
static void enqueue (task &t)
 Enqueue task for starvation-resistant execution.
 
static void enqueue (task &t, priority_t p)
 Enqueue task for starvation-resistant execution on the specified priority level.
 
static void enqueue (task &t, task_arena &arena, priority_t p=priority_t(0))
 Enqueue task in task_arena.
 
static task &__TBB_EXPORTED_FUNC self ()
 The innermost task being executed or destroyed by the current thread at the moment.
 
- Public Attributes inherited from tbb::internal::task_info
voidmy_object
 
Token my_token
 Invalid unless a task went through an ordered stage.
 
bool my_token_ready
 False until my_token is set.
 
bool is_valid
 True if my_object is valid.
 
- Protected Member Functions inherited from tbb::task
 task ()
 Default constructor.
 

Detailed Description

Definition at line 249 of file pipeline.cpp.

Constructor & Destructor Documentation

◆ stage_task() [1/2]

tbb::internal::stage_task::stage_task ( pipeline pipeline)
inline

Construct stage_task for first stage in a pipeline.

Such a stage has not read any input yet.

Definition at line 260 of file pipeline.cpp.

260 :
262 my_filter(pipeline.filter_list),
263 my_at_start(true)
264 {
266 }
void reset()
Set to initial state (no object, no token)
Definition: pipeline.cpp:39
friend class tbb::pipeline
Definition: pipeline.cpp:251
bool my_at_start
True if this task has not yet read the input.
Definition: pipeline.cpp:255

References tbb::internal::task_info::reset().

Here is the call graph for this function:

◆ stage_task() [2/2]

tbb::internal::stage_task::stage_task ( pipeline pipeline,
filter filter_,
const task_info info 
)
inline

Construct stage_task for a subsequent stage in a pipeline.

Definition at line 268 of file pipeline.cpp.

268 :
269 task_info(info),
271 my_filter(filter_),
272 my_at_start(false)
273 {}

Member Function Documentation

◆ execute()

task * tbb::internal::stage_task::execute ( )
virtual

The virtual task execution method.

Implements tbb::task.

Definition at line 301 of file pipeline.cpp.

301 {
302 __TBB_ASSERT( !my_at_start || !my_object, NULL );
303 __TBB_ASSERT( !my_filter->is_bound(), NULL );
304 if( my_at_start ) {
305 if( my_filter->is_serial() ) {
306 my_object = (*my_filter)(my_object);
307 if( my_object || ( my_filter->object_may_be_null() && !my_pipeline.end_of_input) )
308 {
309 if( my_filter->is_ordered() ) {
310 my_token = my_pipeline.token_counter++; // ideally, with relaxed semantics
311 my_token_ready = true;
313 if( my_pipeline.has_thread_bound_filters )
314 my_pipeline.token_counter++; // ideally, with relaxed semantics
315 }
316 if( !my_filter->next_filter_in_pipeline ) { // we're only filter in pipeline
317 reset();
318 goto process_another_stage;
319 } else {
320 ITT_NOTIFY( sync_releasing, &my_pipeline.input_tokens );
321 if( --my_pipeline.input_tokens>0 )
322 spawn( *new( allocate_additional_child_of(*parent()) ) stage_task( my_pipeline ) );
323 }
324 } else {
325 my_pipeline.end_of_input = true;
326 return NULL;
327 }
328 } else /*not is_serial*/ {
329 if( my_pipeline.end_of_input )
330 return NULL;
332 if( my_pipeline.has_thread_bound_filters )
333 my_pipeline.token_counter++;
334 }
335 ITT_NOTIFY( sync_releasing, &my_pipeline.input_tokens );
336 if( --my_pipeline.input_tokens>0 )
337 spawn( *new( allocate_additional_child_of(*parent()) ) stage_task( my_pipeline ) );
338 my_object = (*my_filter)(my_object);
340 {
341 my_pipeline.end_of_input = true;
343 if( my_pipeline.has_thread_bound_filters )
344 my_pipeline.token_counter--; // fix token_counter
345 }
346 return NULL;
347 }
348 }
349 my_at_start = false;
350 } else {
351 my_object = (*my_filter)(my_object);
352 if( my_filter->is_serial() )
354 }
356 if( my_filter ) {
357 // There is another filter to execute.
358 if( my_filter->is_serial() ) {
359 // The next filter must execute tokens in order
360 if( my_filter->my_input_buffer->put_token(*this) ){
361 // Can't proceed with the same item
362 if( my_filter->is_bound() ) {
363 // Find the next non-thread-bound filter
364 do {
366 } while( my_filter && my_filter->is_bound() );
367 // Check if there is an item ready to process
369 goto process_another_stage;
370 }
371 my_filter = NULL; // To prevent deleting my_object twice if exception occurs
372 return NULL;
373 }
374 }
375 } else {
376 // Reached end of the pipe.
377 size_t ntokens_avail = ++my_pipeline.input_tokens;
378 if(my_pipeline.filter_list->is_bound() ) {
379 if(ntokens_avail == 1) {
380 my_pipeline.filter_list->my_input_buffer->sema_V();
381 }
382 return NULL;
383 }
384 if( ntokens_avail>1 // Only recycle if there is one available token
385 || my_pipeline.end_of_input ) {
386 return NULL; // No need to recycle for new input
387 }
388 ITT_NOTIFY( sync_acquired, &my_pipeline.input_tokens );
389 // Recycle as an input stage task.
390 reset();
391 }
392process_another_stage:
393 /* A semi-hackish way to reexecute the same task object immediately without spawning.
394 recycle_as_continuation marks the task for future execution,
395 and then 'this' pointer is returned to bypass spawning. */
397 return this;
398}
#define __TBB_PIPELINE_VERSION(x)
Definition: pipeline.h:41
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
#define ITT_NOTIFY(name, obj)
Definition: itt_notify.h:112
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 sync_releasing
bool is_ordered() const
True if filter must receive stream in order.
Definition: pipeline.h:133
internal::input_buffer * my_input_buffer
Buffer for incoming tokens, or NULL if not required.
Definition: pipeline.h:173
static const unsigned char version_mask
Definition: pipeline.h:92
filter * next_filter_in_pipeline
Pointer to next filter in the pipeline.
Definition: pipeline.h:164
bool is_bound() const
True if filter is thread-bound.
Definition: pipeline.h:138
const unsigned char my_filter_mode
Storage for filter mode and dynamically checked implementation version.
Definition: pipeline.h:181
bool object_may_be_null()
true if an input filter can emit null
Definition: pipeline.h:143
bool is_serial() const
True if filter is serial.
Definition: pipeline.h:128
task * parent() const
task on whose behalf this task is working, or NULL if this is a root.
Definition: task.h:865
void recycle_as_continuation()
Change this to be a continuation of its former self.
Definition: task.h:711
Token my_token
Invalid unless a task went through an ordered stage.
Definition: pipeline.cpp:33
bool my_token_ready
False until my_token is set.
Definition: pipeline.cpp:35
bool put_token(task_info &info_, bool force_put=false)
Put a token into the buffer.
Definition: pipeline.cpp:135
void note_done(Token token, StageTask &spawner)
Note that processing of a token is finished.
Definition: pipeline.cpp:174
bool return_item(task_info &info, bool advance)
return an item, invalidate the queued item, but only advance if the filter
Definition: pipeline.cpp:208
stage_task(pipeline &pipeline)
Construct stage_task for first stage in a pipeline.
Definition: pipeline.cpp:260
void reset()
Roughly equivalent to the constructor of input stage task.
Definition: pipeline.cpp:275

References __TBB_ASSERT, __TBB_PIPELINE_VERSION, tbb::filter::is_bound(), tbb::filter::is_ordered(), tbb::filter::is_serial(), ITT_NOTIFY, my_at_start, my_filter, tbb::filter::my_filter_mode, tbb::filter::my_input_buffer, tbb::internal::task_info::my_object, my_pipeline, tbb::internal::input_buffer::my_tls_end_of_input(), tbb::internal::task_info::my_token, tbb::internal::task_info::my_token_ready, tbb::filter::next_filter_in_pipeline, tbb::internal::input_buffer::note_done(), tbb::filter::object_may_be_null(), tbb::task::parent(), tbb::internal::input_buffer::put_token(), tbb::task::recycle_as_continuation(), reset(), tbb::internal::input_buffer::return_item(), sync_releasing, and tbb::filter::version_mask.

Here is the call graph for this function:

◆ reset()

void tbb::internal::stage_task::reset ( )
inline

Roughly equivalent to the constructor of input stage task.

Definition at line 275 of file pipeline.cpp.

275 {
277 my_filter = my_pipeline.filter_list;
278 my_at_start = true;
279 }

References my_at_start, my_filter, my_pipeline, and tbb::internal::task_info::reset().

Referenced by execute().

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

◆ spawn_stage_task()

void tbb::internal::stage_task::spawn_stage_task ( const task_info info)
inline

Creates and spawns stage_task from task_info.

Definition at line 293 of file pipeline.cpp.

294 {
295 stage_task* clone = new (allocate_additional_child_of(*parent()))
297 spawn(*clone);
298 }

References my_filter, my_pipeline, and tbb::task::parent().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ tbb::pipeline

friend class tbb::pipeline
friend

Definition at line 251 of file pipeline.cpp.

Member Data Documentation

◆ my_at_start

bool tbb::internal::stage_task::my_at_start
private

True if this task has not yet read the input.

Definition at line 255 of file pipeline.cpp.

Referenced by execute(), and reset().

◆ my_filter

filter* tbb::internal::stage_task::my_filter
private

Definition at line 253 of file pipeline.cpp.

Referenced by execute(), reset(), and spawn_stage_task().

◆ my_pipeline

pipeline& tbb::internal::stage_task::my_pipeline
private

Definition at line 252 of file pipeline.cpp.

Referenced by execute(), reset(), and spawn_stage_task().


The documentation for this class was generated from the following file:

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.