35 class task_group_context;
39 #if _MSC_VER || (__GNUC__==3 && __GNUC_MINOR__<3) 40 #define __TBB_TASK_BASE_ACCESS public 42 #define __TBB_TASK_BASE_ACCESS private 62 namespace interface5 {
116 virtual void enqueue(
task& t,
void* reserved ) = 0;
126 #if __TBB_TASK_ISOLATION 132 #if __TBB_TASK_GROUP_CONTEXT 167 #if __TBB_PREVIEW_CRITICAL_TASKS 198 #if __TBB_PREVIEW_CRITICAL_TASKS 203 #if __TBB_TASK_ISOLATION 207 intptr_t reserved_space_for_task_isolation_tag;
210 #if __TBB_TASK_GROUP_CONTEXT 226 #if __TBB_TASK_PRIORITY 234 #if __TBB_TASK_PRIORITY 284 #if __TBB_TASK_GROUP_CONTEXT 286 #if __TBB_TASK_PRIORITY 289 #if __TBB_PREVIEW_CRITICAL_TASKS 303 #if TBB_USE_CAPTURED_EXCEPTION 307 class tbb_exception_ptr;
311 class task_scheduler_init;
312 namespace interface7 {
class task_arena; }
341 #if TBB_USE_CAPTURED_EXCEPTION 365 #if TBB_USE_CAPTURED_EXCEPTION 402 - 2 *
sizeof(uintptr_t)-
sizeof(
void*) -
sizeof(internal::context_list_node_t)
405 -
sizeof(internal::cpu_ctl_env_space)
434 #if __TBB_TASK_PRIORITY 445 #if __TBB_TASK_PRIORITY 483 :
my_kind(relation_with_parent)
485 ,
my_name(internal::CUSTOM_CTX)
546 #if __TBB_TASK_PRIORITY 572 template <
typename T>
576 void bind_to ( internal::generic_scheduler *local_sched );
579 void register_with ( internal::generic_scheduler *local_sched );
625 #if __TBB_RECYCLE_TO_ENQUEUE 640 #if __TBB_TASK_GROUP_CONTEXT 643 return internal::allocate_root_with_context_proxy(ctx);
650 return *reinterpret_cast<internal::allocate_continuation_proxy*>(
this);
655 return *reinterpret_cast<internal::allocate_child_proxy*>(
this);
659 using task_base::allocate_additional_child_of;
661 #if __TBB_DEPRECATED_TASK_INTERFACE 669 using task_base::destroy;
699 internal::task_prefix&
p =
prefix();
706 p.parent = &new_parent;
707 #if __TBB_TASK_GROUP_CONTEXT 708 p.context = new_parent.
prefix().context;
720 #if __TBB_RECYCLE_TO_ENQUEUE 723 void recycle_to_enqueue() {
725 prefix().state = to_enqueue;
735 #if TBB_USE_THREADING_TOOLS||TBB_USE_ASSERT 753 __TBB_ASSERT( k>=0,
"task's reference count underflowed" );
762 #if TBB_USE_THREADING_TOOLS||TBB_USE_ASSERT 770 using task_base::spawn;
774 prefix().owner->wait_for_all( *
this, &child );
782 root.
prefix().owner->spawn_root_and_wait( root, root.
prefix().next );
793 prefix().owner->wait_for_all( *
this, NULL );
797 #if __TBB_TASK_PRIORITY 810 t.
prefix().owner->enqueue( t, NULL );
813 #if __TBB_TASK_PRIORITY 816 #if __TBB_PREVIEW_CRITICAL_TASKS 822 t.
prefix().owner->enqueue( t, (
void*)
p );
834 #if __TBB_TASK_GROUP_CONTEXT 840 #if __TBB_TASK_GROUP_CONTEXT 851 return (
prefix().extra_state & 0x80)!=0;
865 __TBB_ASSERT( ref_count_==
int(ref_count_),
"integer overflow error");
894 #if __TBB_TASK_GROUP_CONTEXT 918 #if __TBB_TASK_PRIORITY 932 #if __TBB_TASK_GROUP_CONTEXT 942 return reinterpret_cast<internal::task_prefix*>(const_cast<task*>(
this))[-1];
944 #if __TBB_PREVIEW_CRITICAL_TASKS 950 #if __TBB_PREVIEW_CRITICAL_TASKS 969 #if __TBB_ALLOW_MUTABLE_FUNCTORS 980 #if __TBB_CPP11_RVALUE_REF_PRESENT 1053 t->
prefix().owner->spawn_root_and_wait( *t, *root_list.
next_ptr );
1068 #if __TBB_TASK_GROUP_CONTEXT 1070 return &
p.allocate(bytes);
1074 p.free( *static_cast<tbb::task*>(
task) );
1079 return &
p.allocate(bytes);
1083 p.free( *static_cast<tbb::task*>(
task) );
1087 return &
p.allocate(bytes);
1091 p.free( *static_cast<tbb::task*>(
task) );
1095 return &
p.allocate(bytes);
1099 p.free( *static_cast<tbb::task*>(
task) );
task & pop_front()
Pop the front task from the list.
void __TBB_EXPORTED_METHOD free(task &) const
bool empty() const
True if list if empty; false otherwise.
__TBB_EXPORTED_METHOD ~task_group_context()
task_group_context(kind_type relation_with_parent=bound, uintptr_t t=default_traits)
Default & binding constructor.
friend class internal::allocate_root_proxy
internal::allocate_child_proxy & allocate_child()
Returns proxy for overloaded new that allocates a child task of *this.
void __TBB_EXPORTED_METHOD register_pending_exception()
Records the pending exception, and cancels the task group.
task * self
No longer used, but retained for binary layout compatibility. Always NULL.
__TBB_atomic reference_count ref_count
Reference count used for synchronization.
static const kind_type detached
void clear()
Clear the list.
Memory prefix to a task object.
friend class internal::scheduler
friend class internal::allocate_root_with_context_proxy
unsigned short affinity_id
An id as used for specifying affinity.
friend class internal::allocate_child_proxy
void __TBB_EXPORTED_METHOD internal_set_ref_count(int count)
Set reference count.
uintptr_t my_state
Internal state (combination of state flags, currently only may_have_children).
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 id
int depth
Obsolete. Used to be scheduling depth before TBB 2.2.
char _leading_padding[internal::NFS_MaxLineSize - 2 *sizeof(uintptr_t) - sizeof(void *) - sizeof(internal::context_list_node_t) - sizeof(__itt_caller) - sizeof(internal::cpu_ctl_env_space)]
Leading padding protecting accesses to frequently used members from false sharing.
friend class internal::allocate_additional_child_of_proxy
static void __TBB_EXPORTED_FUNC destroy(task &victim)
Destroy a task.
#define __TBB_FetchAndDecrementWrelease(P)
friend bool is_critical(task &)
virtual task * execute()=0
Should be overridden by derived classes.
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
const isolation_tag no_isolation
priority_t priority() const
Retrieves current priority of the current task group.
task object is freshly allocated or recycled.
void __TBB_EXPORTED_METHOD free(task &) const
task &__TBB_EXPORTED_METHOD allocate(size_t size) const
task that does nothing. Useful for synchronization.
affinity_id affinity() const
Current affinity of this task.
auto first(Container &c) -> decltype(begin(c))
allocate_root_with_context_proxy(task_group_context &ctx)
Used to form groups of tasks.
void suppress_unused_warning(const T1 &)
Utility template function to prevent "unused" warnings by various compilers.
internal::reference_count __TBB_EXPORTED_METHOD internal_decrement_ref_count()
Decrement reference count and return its new value.
exception_container_type * my_exception
Pointer to the container storing exception being propagated across this task group.
#define __TBB_TASK_BASE_ACCESS
tbb::task * next
"next" field for list of task
friend class internal::scheduler
static void spawn_root_and_wait(task &root)
Spawn task allocated by allocate_root, wait for it to complete, and deallocate it.
~task_list()
Destroys the list, but does not destroy the task objects.
friend class internal::allocate_root_with_context_proxy
Base class for types that should not be copied or assigned.
task &__TBB_EXPORTED_METHOD allocate(size_t size) const
tbb::task & task()
The task corresponding to this task_prefix.
static void __TBB_EXPORTED_FUNC free(task &)
#define __TBB_FetchAndIncrementWacquire(P)
void recycle_as_child_of(task &new_parent)
Change this to be a child of new_parent.
friend class internal::allocate_continuation_proxy
__itt_caller itt_caller
Used to set and maintain stack stitching point for Intel Performance Tools.
bool __TBB_EXPORTED_METHOD cancel_group_execution()
Initiates cancellation of all tasks in this cancellation group and its subordinate groups.
Base class for user-defined tasks.
Work stealing task scheduler.
char _trailing_padding[internal::NFS_MaxLineSize - 2 *sizeof(uintptr_t) - 2 *sizeof(void *) - sizeof(intptr_t) - sizeof(internal::string_index)]
Trailing padding protecting accesses to frequently used members from false sharing.
void set_parent(task *p)
sets parent task pointer to specified value
internal::string_index my_name
Decription of algorithm for scheduler based instrumentation.
context_list_node_t * my_prev
version_tag_v3 version_tag
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 count
intptr_t isolation_tag
A tag for task isolation.
uintptr_t _my_kind_aligner
internal::generic_scheduler * my_owner
Scheduler instance that registered this context in its thread specific list.
static const kind_type binding_required
task is running, and will be destroyed after method execute() completes.
void bind_to(internal::generic_scheduler *local_sched)
Registers this context with the local scheduler and binds it to its parent context.
function_task(const F &f)
void const char const char int ITT_FORMAT __itt_group_sync p
void __TBB_EXPORTED_METHOD reset()
Forcefully reinitializes the context after the task tree it was associated with is completed.
Interface to be implemented by all exceptions TBB recognizes and propagates across the threads.
bool is_critical(task &t)
virtual void wait_for_all(task &parent, task *child)=0
For internal use only.
static void enqueue(task &t)
Enqueue task for starvation-resistant execution.
task * execute() __TBB_override
Should be overridden by derived classes.
Base class for types that should not be assigned.
void spawn_and_wait_for_all(task &child)
Similar to spawn followed by wait_for_all, but more efficient.
internal::affinity_id affinity_id
An id as used for specifying affinity.
task()
Default constructor.
task_list()
Construct empty list.
task * parent() const
task on whose behalf this task is working, or NULL if this is a root.
void wait_for_all()
Wait for reference count to become one, and set reference count to zero.
int space[sizeof(internal::uint64_t)/sizeof(int)]
friend class internal::allocate_continuation_proxy
internal::allocate_continuation_proxy & allocate_continuation()
Returns proxy for overloaded new that allocates a continuation task of *this.
void __TBB_EXPORTED_METHOD free(task &) const
context_list_node_t * my_next
void __TBB_EXPORTED_METHOD free(task &) const
#define __TBB_EXPORTED_METHOD
static tbb::internal::allocate_additional_child_of_proxy allocate_additional_child_of(task &t)
Like allocate_child, except that task's parent becomes "t", not this.
friend class internal::generic_scheduler
state_type
Enumeration of task states that the scheduler considers.
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 set_priority(priority_t)
Changes priority of the task group.
__TBB_atomic kind_type my_kind
Flavor of this context: bound or isolated.
static const int priority_stride_v4
uintptr_t my_cancellation_requested
Specifies whether cancellation was requested for this task group.
priority_t group_priority() const
Retrieves current priority of the task group this task belongs to.
task to be recycled as continuation
virtual void enqueue(task &t, void *reserved)=0
For internal use only.
void set_affinity(affinity_id id)
Set affinity for this 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 __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 parent
int decrement_ref_count()
Atomically decrement reference count and returns its new value.
void call_itt_notify(notify_type, void *)
void push_back(task &task)
Push task onto back of list.
intptr_t my_priority
Priority level of the task group (in normalized representation)
task &__TBB_EXPORTED_METHOD allocate(size_t size) const
allocate_additional_child_of_proxy(task &parent_)
internal::tbb_exception_ptr exception_container_type
task is in ready pool, or is going to be put there, or was just taken off.
void propagate_task_group_state(T task_group_context::*mptr_state, task_group_context &src, T new_state)
Propagates any state change detected to *this, and as an optimisation possibly also upward along the ...
friend class internal::allocate_child_proxy
task object is on free list, or is going to be put there, or was just taken off.
virtual void spawn(task &first, task *&next)=0
For internal use only.
void recycle_to_reexecute()
Schedule this for reexecution after current execute() returns.
static task &__TBB_EXPORTED_FUNC allocate(size_t size)
task_group_context * group()
Pointer to the task group descriptor.
virtual ~task()
Destructor.
Class delimiting the scope of task scheduler activity.
uintptr_t my_version_and_traits
Version for run-time checks and behavioral traits of the context.
friend void make_critical(task &)
bool __TBB_EXPORTED_METHOD is_group_execution_cancelled() const
Returns true if the context received cancellation request.
virtual void spawn_root_and_wait(task &first, task *&next)=0
For internal use only.
void increment_ref_count()
Atomically increment reference count.
#define __TBB_EXPORTED_FUNC
void move(tbb_thread &t1, tbb_thread &t2)
Base class for methods that became static in TBB 3.0.
scheduler * owner
Obsolete. The scheduler that owns the task.
isolation_tag isolation
The tag used for task isolation.
bool __TBB_EXPORTED_METHOD is_owned_by_current_thread() const
Obsolete, and only retained for the sake of backward compatibility. Always returns true.
const size_t NFS_MaxLineSize
Compile-time constant that is upper bound on cache line/sector size.
task * next_offloaded
Pointer to the next offloaded lower priority task.
friend class internal::allocate_root_proxy
void __TBB_EXPORTED_METHOD change_group(task_group_context &ctx)
Moves this task from its current group into another one.
static const kind_type binding_completed
task_group_context * my_parent
Pointer to the context of the parent cancellation group. NULL for isolated contexts.
void recycle_as_safe_continuation()
Recommended to use, safe variant of recycle_as_continuation.
static void spawn(task &t)
Schedule task for execution when a worker becomes available.
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.
internal::context_list_node_t my_node
Used to form the thread specific list of contexts without additional memory allocation.
unsigned char state
A task::state_type, stored as a byte for compactness.
void set_ref_count(int count)
Set reference count.
task_group_context * context
Shared context that is used to communicate asynchronous state changes.
void __TBB_EXPORTED_METHOD init()
Out-of-line part of the constructor.
friend class internal::allocate_additional_child_of_proxy
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 size
void copy_fp_settings(const task_group_context &src)
Copies FPU control setting from another context.
void recycle_as_continuation()
Change this to be a continuation of its former self.
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
version_traits_word_layout
virtual ~scheduler()=0
Pure virtual destructor;.
state_type state() const
Current execution state.
task_group_context * context()
This method is deprecated and will be removed in the future.
static internal::allocate_root_proxy allocate_root()
Returns proxy for overloaded new that allocates a root task.
void make_critical(task &t)
intptr_t reference_count
A reference count.
static const int priority_critical
internal::task_prefix & prefix(internal::version_tag *=NULL) const
Get reference to corresponding task_prefix.
void register_with(internal::generic_scheduler *local_sched)
Registers this context with the local scheduler.
unsigned char extra_state
Miscellaneous state that is not directly visible to users, stored as a byte for compactness.
bool is_stolen_task() const
True if task was stolen from the task pool of another thread.
scheduler * origin
The scheduler that allocated the task, or NULL if the task is big.
int add_ref_count(int count)
Atomically adds to reference count and returns its new value.
struct ___itt_caller * __itt_caller
internal::cpu_ctl_env_space my_cpu_ctl_env
Space for platform-specific FPU settings.
void set_group_priority(priority_t p)
Changes priority of the task group this task belongs to.
void __TBB_EXPORTED_METHOD capture_fp_settings()
Captures the current FPU control settings to the context.
task_group_context(internal::string_index name)
void const char const char int ITT_FORMAT __itt_group_sync x void const char * name
virtual void __TBB_EXPORTED_METHOD note_affinity(affinity_id id)
Invoked by scheduler to notify task that it ran on unexpected thread.
task &__TBB_EXPORTED_METHOD allocate(size_t size) const
task * execute() __TBB_override
Should be overridden by derived classes.
tbb::task * parent
The task whose reference count includes me.
task_group_context & my_context
static const kind_type dying
uintptr_t traits() const
Returns the context's trait.
int ref_count() const
The internal reference count.