Intel® oneAPI Threading Building Blocks Developer Guide and API Reference

Download PDF
ID 772616
Date 10/15/2026
Public
Document Table of Contents
Document Table of Contents x
Intel® oneAPI Threading Building Blocks (oneTBB) Developer Guide and API Reference
Intel® oneAPI Threading Building Blocks (oneTBB) Developer Guide and API Reference x
Getting Help and Support Notational Conventions Introduction oneTBB Benefits oneTBB Developer Guide oneTBB API Reference Notices and Disclaimers
oneTBB Developer Guide x
Package Contents Parallelizing Simple Loops Parallelizing Complex Loops Parallelizing Data Flow and Dependence Graphs Work Isolation Exceptions and Cancellation Containers Mutual Exclusion Timing Memory Allocation The Task Scheduler Design Patterns Migrating from Threading Building Blocks (TBB) Constrained APIs Appendix A Costs of Time Slicing Appendix B Mixing With Other Threading Packages References
Package Contents x
Debug Versus Release Libraries Scalable Memory Allocator Windows* Linux*
Parallelizing Simple Loops x
Initializing and Terminating the Library parallel_reduce Advanced Topic: Other Kinds of Iteration Spaces Initializing and Terminating the Library parallel_for parallel_reduce Advanced Example Advanced Topic: Other Kinds of Iteration Spaces
parallel_reduce x
Advanced Example Use of r-Values for Reduction
parallel_for x
Lambda Expressions Automatic Chunking Partitioner Summary Lambda Expressions Automatic Chunking Controlling Chunking Bandwidth and Cache Affinity Partitioner Summary
parallel_reduce x
Advanced Example Use of r-Values for Reduction
Parallelizing Complex Loops x
Cook Until Done: parallel_for_each Working on the Assembly Line: parallel_pipeline Summary of Loops and Pipelines
Working on the Assembly Line: parallel_pipeline x
Using Circular Buffers Throughput of pipeline Non-Linear Pipelines
Parallelizing Data Flow and Dependence Graphs x
Parallelizing Data Flow and Dependency Graphs Basic Flow Graph Concepts Graph Application Categories Predefined Node Types Flow Graph Tips and Tricks Estimating Flow Graph Performance Class Template Argument Deduction for Flow Graph Nodes
Basic Flow Graph Concepts x
Flow Graph Basics: Graph Object Flow Graph Basics: Nodes Flow Graph Basics: Edges Flow Graph Basics: Mapping Nodes to Tasks Flow Graph Basics: Message Passing Protocol Flow Graph Basics: Single-push vs. Broadcast-push Flow Graph Basics: Buffering and Forwarding Flow Graph Basics: Reservation
Graph Application Categories x
Data Flow Graph Dependence Graph
Flow Graph Tips and Tricks x
Flow Graph Tips for Waiting for and Destroying a Flow Graph Flow Graph Tips on Making Edges Flow Graph Tips on Nested Parallelism Flow Graph Tips for Limiting Resource Consumption Flow Graph Tips for Exception Handling and Cancellation
Flow Graph Tips for Waiting for and Destroying a Flow Graph x
Always Use wait_for_all() Avoid Dynamic Node Removal Destroying Graphs That Run Outside the Main Thread
Flow Graph Tips on Making Edges x
Use make_edge and remove_edge Sending to One or Multiple Successors Communication Between Graphs Using input_node Avoiding Data Races
Flow Graph Tips on Nested Parallelism x
Use Nested Algorithms to Increase Scalability Use Nested Flow Graphs
Flow Graph Tips for Limiting Resource Consumption x
Using limiter_node Use Concurrency Limits Create a Token-Based System Attach Flow Graph to an Arbitrary Task Arena
Attach Flow Graph to an Arbitrary Task Arena x
Guiding Task Scheduler Execution Work Isolation
Flow Graph Tips for Exception Handling and Cancellation x
Catching Exceptions Inside the Node that Throws the Exception Cancel a Graph Explicitly Use graph::reset() to Reset a Canceled Graph Canceling Nested Parallelism
Exceptions and Cancellation x
Cancellation Without An Exception Cancellation and Nested Parallelism
Containers x
concurrent_hash_map concurrent_vector Concurrent Queue Classes Summary of Containers
concurrent_hash_map x
More on HashCompare
Concurrent Queue Classes x
Iterating Over a Concurrent Queue for Debugging When Not to Use Queues
Mutual Exclusion x
Mutex Flavors Reader Writer Mutexes Upgrade/Downgrade Lock Pathologies
Memory Allocation x
Which Dynamic Libraries to Use Configuring the Memory Allocator
The Task Scheduler x
Task-Based Programming When Task-Based Programming Is Inappropriate How Task Scheduler Works Task Scheduler Bypass Guiding Task Scheduler Execution
Design Patterns x
Agglomeration Elementwise Odd-Even Communication Wavefront Reduction Divide and Conquer GUI Thread Non-Preemptive Priorities Lazy Initialization Local Serializer Fenced Data Transfer Reference Counting General References
Migrating from Threading Building Blocks (TBB) x
Migrating from tbb::task_scheduler_init Migrating from low-level task API Mixing two runtimes
oneTBB API Reference x
Identifiers Thread Safety Headers and Modules Preview Features Named Requirements Configuration Algorithms Flow Graph Task Scheduler Containers Thread Local Storage Memory Allocation Mutual Exclusion Timing info Namespace task_arena::attach
Named Requirements x
Range Splittable ParallelForBody ParallelForFunc ParallelForIndex ParallelReduceBody ParallelReduceFunc ParallelReduceReduction ParallelForEachBody ContainerBasedSequence ParallelScanBody ParallelScanCombine ParallelScanFunc BlockedRangeValue FilterBody Mutex ReaderWriterMutex HashCompare ContainerRange SuspendFunc AsyncNodeBody ContinueNodeBody GatewayType FunctionNodeBody JoinNodeFunctionObject InputNodeBody MultifunctionNodeBody Sequencer ResourceLimitedNodeBody (preview)
Configuration x
Namespaces Version Information Enabling Debugging Features Custom Assertion Handler Feature Macros Feature-test Macros Changelog for Feature-test Macros
Algorithms x
collaborative_call_once parallel_for parallel_reduce parallel_deterministic_reduce parallel_scan parallel_for_each parallel_invoke parallel_pipeline parallel_sort blocked_range blocked_range2d blocked_range3d blocked_nd_range auto_partitioner affinity_partitioner static_partitioner simple_partitioner proportional split split
collaborative_call_once x
collaborative_once_flag
parallel_scan x
pre_scan_tag and final_scan_tag
parallel_for_each x
feeder
parallel_pipeline x
filter flow_control
filter x
filter_mode
Flow Graph x
graph graph_node sender receiver Forwarding and Buffering continue_node function_node input_node multifunction_node async_node Function Nodes Policies Nodes Priorities Predefined Concurrency Limits copy_body overwrite_node write_once_node buffer_node queue_node priority_queue_node sequencer_node limiter_node broadcast_node join_node Type-specified message keys for join_node (preview) split_node indexer_node composite_node input_port output_port make_edge remove_edge continue_msg tagged_msg Resource Limiting in the Flow Graph (preview) Helper Functions for Expressing Graphs (preview) Waiting for Single Messages in Flow Graph (preview) Dependency Flow Graph Example Message Flow Graph Example
graph x
reset_flags Enumeration
join_node x
join_node Policies
Resource Limiting in the Flow Graph (preview) x
resource_limiter Class resource_limited_node Class
Helper Functions for Expressing Graphs (preview) x
Constructors for Flow Graph nodes follows and precedes functions make_node_set function make_edges function
Task Scheduler x
Worker Thread Retention task_group_context global_control Resumable tasks task_scheduler_handle task_group task_group_status task_handle task_completion_handle Class (preview) Task Bypass Support for task_group (preview) task_group Dynamic Dependencies (preview) Waiting for Individual Tasks in task_group (preview) task_arena this_task_arena parallel_phase task_scheduler_observer Core Type Selector for Task Arena Constraints (preview) attach tag type
Containers x
concurrent_vector concurrent_queue concurrent_bounded_queue concurrent_priority_queue concurrent_hash_map Customizing the Mutex Type for concurrent_hash_map (preview) concurrent_unordered_map concurrent_unordered_multimap concurrent_unordered_set concurrent_unordered_multiset concurrent_map concurrent_multimap concurrent_set concurrent_multiset concurrent_lru_cache (preview) tbb_hash_compare Node handles
concurrent_vector x
Construction, destruction, copying Concurrent growth Element access Iterators Size and capacity Concurrently unsafe operations Parallel iteration Non-member binary comparisons Non-member lexicographical comparisons Non-member swap Deduction guides
concurrent_queue x
Construction, destruction, copying Concurrently safe member functions Pushing elements Popping elements get_allocator Concurrently unsafe member functions Iterators Non-member swap Non-member binary comparisons Deduction guides
concurrent_bounded_queue x
Construction, destruction, copying Concurrently safe member functions Concurrently unsafe member functions Iterators Non-member swap Non-member binary comparisons Deduction guides
concurrent_priority_queue x
Construction, destruction, copying Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Non-member swap Non-member binary comparisons Deduction guides
concurrent_hash_map x
accessor and const_accessor Construction, destruction, copying Concurrently unsafe modifiers Hash policy Size and capacity Lookup Concurrently safe modifiers Iterators Parallel iteration Non-member swap Non-member binary comparisons Deduction guides
concurrent_unordered_map x
Construction, destruction, copying Iterators Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Element access Lookup Bucket interface Hash policy Observers Parallel iteration Non-member swap Non-member binary comparisons Deduction guides
concurrent_unordered_multimap x
Construction, destruction, copying Iterators Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Lookup Bucket interface Hash policy Observers Parallel iteration Non-member swap Non-member binary comparisons Deduction guides
concurrent_unordered_set x
Construction, destruction, copying Iterators Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Lookup Bucket interface Hash policy Observers Parallel iteration Non-member swap Non-member binary comparisons Deduction guides
concurrent_unordered_multiset x
Construction, destruction, copying Iterators Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Lookup Bucket interface Hash policy Observers Parallel iteration Non-member swap Non-member binary comparisons Deduction guides
concurrent_map x
value_compare Construction, destruction, copying Element access Iterators Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Lookup Observers Parallel iteration Non-member swap Non-member binary comparisons Non-member lexicographical comparisons Deduction guides
concurrent_multimap x
value_compare Construction, destruction, copying Iterators Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Lookup Observers Parallel iteration Non-member swap Non-member binary comparisons Non-member lexicographical comparisons Deduction guides
concurrent_set x
Construction, destruction, copying Iterators Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Lookup Observers Parallel iteration Non-member swap Non-member binary comparisons Non-member lexicographical comparisons Deduction guides
concurrent_multiset x
Construction, destruction, copying Iterators Size and capacity Concurrently safe modifiers Concurrently unsafe modifiers Lookup Observers Parallel iteration Non-member swap Non-member binary comparisons Non-member lexicographical comparisons Deduction guides
Thread Local Storage x
combinable enumerable_thread_specific flattened2d
enumerable_thread_specific x
Construction, destruction, copying Concurrently safe modifiers Concurrently unsafe modifiers Size and capacity Iteration Combining
Memory Allocation x
tbb_allocator scalable_allocator cache_aligned_allocator cache_aligned_resource scalable_memory_resource C Interface to Scalable Allocator Allocate Memory Interleaved between NUMA Nodes (preview) Scalable Memory Pools (preview) Automatically Replacing malloc and Other C/C++ Functions for Dynamic Memory Allocation
Scalable Memory Pools (preview) x
memory_pool fixed_pool memory_pool_allocator
Automatically Replacing malloc and Other C/C++ Functions for Dynamic Memory Allocation x
Windows* OS C/C++ Dynamic Memory Interface Replacement TBB_malloc_replacement_log Function Linux* OS C/C++ Dynamic Memory Interface Replacement
Mutual Exclusion x
mutex rw_mutex spin_mutex spin_rw_mutex speculative_spin_mutex speculative_spin_rw_mutex queuing_mutex queuing_rw_mutex null_mutex null_rw_mutex
Timing x
tick_count class
Intel® oneAPI Threading Building Blocks (oneTBB) Developer Guide and API Reference

Concurrently safe member functions

Level Two Title