126 lines
18 KiB
HTML
126 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>Release Notes » Release 3.3.0 (2022/01/03) | Taskflow QuickStart</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
|
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
|
<link rel="icon" href="favicon.ico" type="image/vnd.microsoft.icon" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="theme-color" content="#22272e" />
|
|
</head>
|
|
<body>
|
|
<header><nav id="navigation">
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
|
|
<a href="https://taskflow.github.io"><img src="taskflow_logo.png" alt="" />Taskflow</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">QuickStart</a>
|
|
</span>
|
|
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
|
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
|
</svg></a>
|
|
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
|
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
|
</div>
|
|
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
|
<div class="m-row">
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
<li><a href="pages.html">Handbook</a></li>
|
|
<li><a href="namespaces.html">Namespaces</a></li>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="3">
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="files.html">Files</a></li>
|
|
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<use href="#m-doc-search-icon-path" />
|
|
</svg></a></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></header>
|
|
<main><article>
|
|
<div class="m-container m-container-inflatable">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<h1>
|
|
<span class="m-breadcrumb"><a href="Releases.html">Release Notes</a> »</span>
|
|
Release 3.3.0 (2022/01/03)
|
|
</h1>
|
|
<nav class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li><a href="#release-3-3-0_download">Download</a></li>
|
|
<li><a href="#release-3-3-0_system_requirements">System Requirements</a></li>
|
|
<li><a href="#release-3-3-0_summary">Release Summary</a></li>
|
|
<li>
|
|
<a href="#release-3-3-0_new_features">New Features</a>
|
|
<ul>
|
|
<li><a href="#release-3-3-0_taskflow_core">Taskflow Core</a></li>
|
|
<li><a href="#release-3-3-0_cudaflow">cudaFlow</a></li>
|
|
<li><a href="#release-3-3-0_syclflow">syclFlow</a></li>
|
|
<li><a href="#release-3-3-0_utilities">Utilities</a></li>
|
|
<li><a href="#release-3-3-0_profiler">Taskflow Profiler (TFProf)</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#release-3-3-0_bug_fixes">Bug Fixes</a></li>
|
|
<li><a href="#release-3-3-0_breaking_changes">Breaking Changes</a></li>
|
|
<li><a href="#release-3-3-0_deprecated_items">Deprecated and Removed Items</a></li>
|
|
<li><a href="#release-3-3-0_documentation">Documentation</a></li>
|
|
<li><a href="#release-3-3-0_miscellaneous_items">Miscellaneous Items</a></li>
|
|
</ul>
|
|
</nav>
|
|
<p>Taskflow 3.3.0 is the 4th release in the 3.x line! This release includes several new changes, such as sanitized data race, pipeline parallelism, documentation, and unit tests.</p><aside class="m-note m-info"><h4>Note</h4><p>We highly recommend that adopting Taskflow v3.3 in your projects if possible. This release has resolved pretty much all the potential data-race issues induced by incorrect memory order.</p></aside><section id="release-3-3-0_download"><h2><a href="#release-3-3-0_download">Download</a></h2><p>Taskflow 3.3.0 can be downloaded from <a href="https://github.com/taskflow/taskflow/releases/tag/v3.3.0">here</a>.</p></section><section id="release-3-3-0_system_requirements"><h2><a href="#release-3-3-0_system_requirements">System Requirements</a></h2><p>To use Taskflow v3.3.0, you need a compiler that supports C++17:</p><ul><li>GNU C++ Compiler at least v8.4 with -std=c++17</li><li>Clang C++ Compiler at least v6.0 with -std=c++17</li><li>Microsoft Visual Studio at least v19.27 with /std:c++17</li><li>AppleClang Xcode Version at least v12.0 with -std=c++17</li><li>Nvidia CUDA Toolkit and Compiler (nvcc) at least v11.1 with -std=c++17</li><li>Intel C++ Compiler at least v19.0.1 with -std=c++17</li><li>Intel DPC++ Clang Compiler at least v13.0.0 with -std=c++17 and SYCL20</li></ul><p>Taskflow works on Linux, Windows, and Mac OS X.</p></section><section id="release-3-3-0_summary"><h2><a href="#release-3-3-0_summary">Release Summary</a></h2><ol><li>This release has resolved data race issues reported by <a href="https://github.com/google/sanitizers">tsan</a> and has incorporated essential sanitizers into the <a href="https://github.com/taskflow/taskflow/actions">continuous integration workflows</a> for detecting data race, illegal memory access, and memory leak of the Taskflow codebase.</li><li>This release has introduced a new pipeline interface (<a href="classtf_1_1Pipeline.html" class="m-doc">tf::<wbr />Pipeline</a>) that allow users to create a pipeline scheduling framework for implementing pipeline algorithms.</li><li>This release has introduced a new thread-id mapping algorithm to resolve unexpected thread-local storage (TLS) errors when building Taskflow projects in a shared library environment.</li></ol></section><section id="release-3-3-0_new_features"><h2><a href="#release-3-3-0_new_features">New Features</a></h2><section id="release-3-3-0_taskflow_core"><h3><a href="#release-3-3-0_taskflow_core">Taskflow Core</a></h3><ul><li>Changed all lambda operators in parallel algorithms to copy by default</li><li>Cleaned up data race errors in <a href="https://github.com/google/sanitizers">tsan</a> caused by incorrect memory order</li><li>Enhanced scheduling performance by caching tasks in the invoke loop</li><li>Added <a href="classtf_1_1Task.html#afd82ab6d6518d1142a72c4d2c97ff114" class="m-doc">tf::<wbr />Task::<wbr />data</a> to allow associating a task with user-level data</li><li>Added tf::Executor::named_async to allow associating an asynchronous task a name</li><li>Added tf::Executor::named_silent_async to allow associating a silent asynchronous task a name</li><li>Added tf::Subflow::named_async to allow associating an asynchronous task a name</li><li>Added tf::Subflow::named_silent_async to allow associating a silent asynchronous task a name</li><li>Added multi-conditional tasking to allow a task to jump to multiple successors</li><li>Added <a href="classtf_1_1Runtime.html" class="m-doc">tf::<wbr />Runtime</a> tasking interface to enable in-task scheduling control</li><li>Added <a href="classtf_1_1FlowBuilder.html#a97be7ceef6fa4276e3b074c10c13b826" class="m-doc">tf::<wbr />Taskflow::<wbr />transform</a> to perform parallel-transform algorithms</li><li>Added <a href="classtf_1_1Graph.html" class="m-doc">tf::<wbr />Graph</a> interface to allow users to create custom module tasks</li><li>Added <a href="classtf_1_1FlowBuilder.html#a5627f7962099ac7c4986993cffa7b909" class="m-doc">tf::<wbr />FlowBuilder::<wbr />erase</a> to remove a task from the associated graph</li></ul></section><section id="release-3-3-0_cudaflow"><h3><a href="#release-3-3-0_cudaflow">cudaFlow</a></h3><p>Starting from v3.3, using <a href="classtf_1_1cudaFlow.html" class="m-doc">tf::<wbr />cudaFlow</a> needs to include the header, <code>taskflow/cuda/cudaflow.hpp</code>. See <a href="#release-3-3-0_breaking_changes" class="m-doc">Breaking Changes</a>.</p></section><section id="release-3-3-0_syclflow"><h3><a href="#release-3-3-0_syclflow">syclFlow</a></h3><p>This release does not have any update on syclFlow.</p></section><section id="release-3-3-0_utilities"><h3><a href="#release-3-3-0_utilities">Utilities</a></h3><ul><li>Added <a href="classtf_1_1SmallVector.html" class="m-doc">tf::<wbr />SmallVector</a> to the documentation</li><li>Added relax_cpu call to optimize the work-stealing loop</li></ul></section><section id="release-3-3-0_profiler"><h3><a href="#release-3-3-0_profiler">Taskflow Profiler (TFProf)</a></h3><p>This release does not have any update on the profiler.</p></section></section><section id="release-3-3-0_bug_fixes"><h2><a href="#release-3-3-0_bug_fixes">Bug Fixes</a></h2><ul><li>Fixed incorrect static TLS access when building Taskflow in a shared lib</li><li>Fixed memory leak in updating <a href="classtf_1_1cudaFlowCapturer.html" class="m-doc">tf::<wbr />cudaFlowCapturer</a> of undestroyed graph</li><li>Fixed data race in the object-pool when accessing the heap pointer</li><li>Fixed invalid lambda capture by reference in <a href="classtf_1_1FlowBuilder.html#a35e180eb63de6c9f28e43185e837a4fa" class="m-doc">tf::<wbr />Taskflow::<wbr />sort</a></li><li>Fixed invalid lambda capture by reference in <a href="classtf_1_1FlowBuilder.html#afb24798ebf46e253a40b01bffb1da6a7" class="m-doc">tf::<wbr />Taskflow::<wbr />reduce</a></li><li>Fixed invalid lambda capture by reference in <a href="classtf_1_1FlowBuilder.html#aa62d24438c0860e76153ffd129deba41" class="m-doc">tf::<wbr />Taskflow::<wbr />transform_reduce</a></li><li>Fixed invalid lambda capture by reference in <a href="classtf_1_1FlowBuilder.html#aae3edfa278baa75b08414e083c14c836" class="m-doc">tf::<wbr />Taskflow::<wbr />for_each</a></li><li>Fixed invalid lambda capture by reference in <a href="classtf_1_1FlowBuilder.html#a3b132bd902331a11b04b4ad66cf8bf77" class="m-doc">tf::<wbr />Taskflow::<wbr />for_each_index</a></li></ul><p>If you encounter any potential bugs, please submit an issue at <a href="https://github.com/taskflow/taskflow/issues">issue tracker</a>.</p></section><section id="release-3-3-0_breaking_changes"><h2><a href="#release-3-3-0_breaking_changes">Breaking Changes</a></h2><p>For the purpose of compilation speed, you will need to separately include the follwoing files for using specific features and algorithms:</p><ul><li><code>taskflow/algorithm/reduce.hpp</code> for creating a parallel-reduction task</li><li><code>taskflow/algorithm/sort.hpp</code> for creating a parallel-sort task</li><li><code>taskflow/algorithm/transform.hpp</code> for creating a parallel-transform task</li><li><code>taskflow/algorithm/pipeline.hpp</code> for creating a parallel-pipeline task</li><li><code>taskflow/cuda/cudaflow.hpp</code> for creating a <a href="classtf_1_1cudaFlow.html" class="m-doc">tf::<wbr />cudaFlow</a> and a <a href="classtf_1_1cudaFlowCapturer.html" class="m-doc">tf::<wbr />cudaFlowCapturer</a> tasks</li><li><code>taskflow/cuda/algorithm/for_each.hpp</code> for creating a single-threaded task on a CUDA GPU</li><li><code>taskflow/cuda/algorithm/for_each.hpp</code> for creating a parallel-iteration task on a CUDA GPU</li><li><code>taskflow/cuda/algorithm/transform.hpp</code> for creating a parallel-transform task on a CUDA GPU</li><li><code>taskflow/cuda/algorithm/reduce.hpp</code> for creating a parallel-reduce task on a CUDA GPU</li><li><code>taskflow/cuda/algorithm/scan.hpp</code> for creating a parallel-scan task on a CUDA GPU</li><li><code>taskflow/cuda/algorithm/merge.hpp</code> for creating a parallel-merge task on a CUDA GPU</li><li><code>taskflow/cuda/algorithm/sort.hpp</code> for creating a parallel-sort task on a CUDA GPU</li><li><code>taskflow/cuda/algorithm/find.hpp</code> for creating a parallel-find task on a CUDA GPU</li></ul></section><section id="release-3-3-0_deprecated_items"><h2><a href="#release-3-3-0_deprecated_items">Deprecated and Removed Items</a></h2><p>This release does not have any deprecated and removed items.</p></section><section id="release-3-3-0_documentation"><h2><a href="#release-3-3-0_documentation">Documentation</a></h2><ul><li>Revised <a href="install.html" class="m-doc">Building and Installing</a><ul><li><a href="install.html#BAIBuildSanitizers" class="m-doc">Build Sanitizers</a></li></ul></li><li>Revised <a href="StaticTasking.html" class="m-doc">Static Tasking</a><ul><li><a href="StaticTasking.html#AttachUserDataToATask" class="m-doc">Attach User Data to a Task</a></li></ul></li><li>Revised <a href="ComposableTasking.html" class="m-doc">Composable Tasking</a><ul><li><a href="ComposableTasking.html#CreateACustomComposableGraph" class="m-doc">Create a Custom Composable Graph</a></li></ul></li><li>Revised <a href="ConditionalTasking.html" class="m-doc">Conditional Tasking</a><ul><li><a href="ConditionalTasking.html#CreateAMultiConditionTask" class="m-doc">Create a Multi-condition Task</a></li></ul></li><li>Revised <a href="GPUTaskingcudaFlow.html" class="m-doc">GPU Tasking (cudaFlow)</a></li><li>Revised <a href="GPUTaskingcudaFlowCapturer.html" class="m-doc">GPU Tasking (cudaFlowCapturer)</a></li><li>Revised <a href="LimitTheMaximumConcurrency.html" class="m-doc">Limit the Maximum Concurrency</a><ul><li><a href="LimitTheMaximumConcurrency.html#DefineAConflictGraph" class="m-doc">Define a Conflict Graph</a></li></ul></li><li>Revised <a href="ParallelSort.html" class="m-doc">Parallel Sort</a> to add header-include information</li><li>Revised <a href="ParallelReduction.html" class="m-doc">Parallel Reduction</a> to add header-include information</li><li>Revised <a href="cudaFlowAlgorithms.html" class="m-doc">cudaFlow Algorithms</a> to add header-include information</li><li>Revised <a href="cudaStandardAlgorithms.html" class="m-doc">CUDA Standard Algorithms</a> to add header-include information</li><li>Added <a href="RuntimeTasking.html" class="m-doc">Interact with the Runtime</a></li><li>Added <a href="ParallelTransforms.html" class="m-doc">Parallel Transforms</a></li><li>Added <a href="TaskParallelPipeline.html" class="m-doc">Task-parallel Pipeline</a></li></ul></section><section id="release-3-3-0_miscellaneous_items"><h2><a href="#release-3-3-0_miscellaneous_items">Miscellaneous Items</a></h2><p>We have published Taskflow in the following venues:</p><ol><li>Tsung-Wei Huang, Dian-Lun Lin, Chun-Xun Lin, and Yibo Lin, "<a href="https://tsung-wei-huang.github.io/papers/tpds21-taskflow.pdf">Taskflow: A Lightweight Parallel and Heterogeneous Task Graph Computing System</a>," <em>IEEE Transactions on Parallel and Distributed Systems (TPDS)</em>, vol. 33, no. 6, pp. 1303-1320, June 2022</li><li>Tsung-Wei Huang, "<a href="https://tsung-wei-huang.github.io/papers/tpds21-taskflow.pdf">TFProf: Profiling Large Taskflow Programs with Modern D3 and C++</a>," <em>IEEE International Workshop on Programming and Performance Visualization Tools (ProTools)</em>, St. Louis, Missouri, 2021</li></ol><p>Please do not hesitate to contact <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a> if you intend to collaborate with us on using Taskflow in your scientific computing projects.</p></section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</article></main>
|
|
<div class="m-doc-search" id="search">
|
|
<a href="#!" onclick="return hideSearch()"></a>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-m-8 m-push-m-2">
|
|
<div class="m-doc-search-header m-text m-small">
|
|
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
|
<div id="search-symbolcount">…</div>
|
|
</div>
|
|
<div class="m-doc-search-content">
|
|
<form>
|
|
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
|
</form>
|
|
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
|
<div id="search-help" class="m-text m-dim m-text-center">
|
|
<p class="m-noindent">Search for symbols, directories, files, pages or
|
|
modules. You can omit any prefix from the symbol or file path; adding a
|
|
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
|
directory.</p>
|
|
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
|
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
|
<span class="m-label m-dim">Enter</span> to go.
|
|
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
|
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
|
</div>
|
|
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
|
<ul id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="search-v2.js"></script>
|
|
<script src="searchdata-v2.js" async="async"></script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<p>Taskflow handbook is part of the <a href="https://taskflow.github.io">Taskflow project</a>, copyright © <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a>, 2018–2024.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
</body>
|
|
</html>
|