Compare commits

...
Author SHA1 Message Date
kboyarinov 0baaad609a Fix indexer_node implementation, add test 2022-10-26 06:36:29 -05:00
kboyarinov cb8fa21a84 Get rid of C++03 rudiments 2022-10-24 08:52:54 -05:00
Ilya Isaev 912cd2b0b3 Fix build with source dir path containing spaces (#930)
Signed-off-by: Isaev, Ilya <ilya.isaev@intel.com>
2022-10-20 10:30:35 +02:00
Dirk MuellerandMo Zhou e8666c0b9c Add s390x, hppa and riscv64 architecture detection (#917)
* Fix build failure for s390x and hppa architectures.

Signed-off-by: Mo Zhou <cdluminate@gmail.com>

* Add riscv64 architecture detection

Signed-off-by: Dirk Müller <dirk@dmllr.de>

Signed-off-by: Mo Zhou <cdluminate@gmail.com>
Signed-off-by: Dirk Müller <dirk@dmllr.de>
Co-authored-by: Mo Zhou <cdluminate@gmail.com>
2022-10-18 11:34:09 +03:00
Vladislav Shchapov 71b04524d0 Workaround for test_dynamic_link builded with gcc and lto
Signed-off-by: Vladislav Shchapov <vladislav@shchapov.ru>
2022-10-17 19:19:23 +01:00
Ilya Isaev aa247fa816 [tbb::parallel_for_each] Don't call destructor for uninitialized object (#933)
Current implementation of parallel_for_each may call destructors for uninitialized objects when using Input iterator and count of elements in block is less than max_block_size. This is UB and can lead to incorrect memory access in some scenarios.

Signed-off-by: Isaev, Ilya <ilya.isaev@intel.com>
2022-10-17 14:03:06 +02:00
Kavin Teenakul 13544f9432 Update INSTALL.md (#820)
fix typo
2022-10-13 18:12:13 +03:00
AlexandraandPavel Kumbrasev 635761449f Update testing_approach.rst (#937)
* Update testing_approach.rst

* Update doc/main/intro/testing_approach.rst

Co-authored-by: Pavel Kumbrasev <pavel.kumbrasev@intel.com>

Co-authored-by: Pavel Kumbrasev <pavel.kumbrasev@intel.com>
2022-10-11 18:08:27 +02:00
Pavel Kumbrasev 6bfd29bde7 Exclude includes from version.h during .rc files comilation (#928)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2022-10-05 12:57:13 +02:00
egfefey e6459e22ae Delete resource.rc (#922) 2022-10-05 11:17:35 +01:00
egfefey 85792ca411 Egfefey patch windows dll (#916)
* Restoring Windows DLL details information

This restores the detailed information in the Windows dll. This has been absent from the revamped oneTBB.

* Update CMakeLists.txt

Enabling build of Windows resource file.

* Update CMakeLists.txt

Updating copyright year

* Add files via upload

Adding Windows resource file for tbbmalloc

* Update CMakeLists.txt

Enabling building of tbbmalloc resource file

* Add files via upload

Adding tbbmalloc_proxy Windows resource file

* Update CMakeLists.txt

Enabling the build of tbbmalloc_proxy resource file

* Add files via upload

Adding tbbbind resource file

* Update CMakeLists.txt

Enabling tbbbind resource file build

* Update resource.rc

Product name update in resource file

* Update CMakeLists.txt

Restricting resource build to default tbbbind

* Add files via upload

Replacing resource.rc with tbb.rc to conform with other dlls (tbbmalloc, tbbbind etc)

* Update CMakeLists.txt

Update from resource.rc to tbb.rc

* Update CMakeLists.txt

Updating copyright year

* Update CMakeLists.txt

Updating the copyright year

* Update tbb.rc

Removing "Windows" from the product name and sourcing the version from version.h

* Update tbb_bind.rc

Removing "Windows" from the product name and sourcing the version info from version.h

* Update tbbmalloc.rc

Removing "Windows" from the product name and sourcing the version info from version.h

* Update tbbmalloc_proxy.rc

Removing "Windows" from the product name and sourcing the version info from version.h
2022-09-30 12:51:10 -05:00
kboyarinov 3fbdbb8b2e Fix the implicit deduction guides on MacOS (#898) 2022-09-28 14:12:46 +03:00
Vladislav Shchapov 3c91aea522 Fix universal binary build on macos. (#919)
Signed-off-by: Vladislav Shchapov <vladislav@shchapov.ru>
2022-09-27 13:15:06 +02:00
Ilya Isaev 2eccd5f998 Fix tbb4py test sporadic fails (#913)
There are sporadic fails with tbb4py test (test.py). The problem is that some test cases rely on the fact, that submitted async work will not finish until calling get with timeout. To do there is a call for time.sleep in functor submitted. Sporadically, expected result is not happening (like OSX example in issue) so to prevent that, the blocking is used.

Signed-off-by: Isaev, Ilya <ilya.isaev@intel.com>
2022-09-26 16:14:17 +02:00
cc3a9aa992 Correct behavior for proportional_mode (#904)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Co-authored-by: kboyarinov <konstantin.boyarinov@intel.com>
Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>
2022-09-26 14:29:27 +01:00
Alexandra 104fb5c9de Testing approach doc (#914)
* Signed-off-by:Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com

* Update testing_approach.rst
2022-09-26 12:35:30 +02:00
Pavel Kumbrasev f10350212b Remove unused function from _concurrent_queue_base.h (#915)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2022-09-23 14:18:20 +01:00
kboyarinov 8155aaeb6b Fix concurrent queues not to require default constructor from T (#886)
* Fix concurrent_queue::clear not to require default ctor

* Suppress warning about the unused variable in release mode

* Fix the conformance test not to rely on the additional item in dtor

* template->class in template template parameter

* Rework the fix

* Remove unnecessary flag from internal pop method

* Minor clean-up

* Add exception macros to the test

* Add whitespace

* Fix PR comments

* Fix logic for a build with no exceptions
2022-09-05 11:03:53 +03:00
Alexandra f3747fed09 Fix an analytics script (#874) 2022-09-01 10:43:46 +02:00
Valentina Kats a748475d7a Update version number for oneTBB 2021.8.0 (#883)
* Update version.h

* Address feedback
2022-08-31 13:23:25 +02:00
kboyarinov 57f8bb1d99 Fix concurrent_bounded_queue::pop return type (#888) 2022-08-29 17:33:37 +03:00
Jakub Kopal 01fa1414a2 Fix concurrent-queue pop comment (#809)
* fix concurrent-queue pop comment

* Update copyright date
2022-08-29 11:07:03 +03:00
Anuya Welling dce182a7b5 Fixing clang error on tbb numa test (#867) 2022-08-17 14:48:23 -05:00
Kirigami 5cb212d447 add loongarch support (#850)
* add loongarch support

* update the copyright year of ittnotify_config.h
2022-08-14 11:21:51 +03:00
Timmie Smith 323260671b Resolving doctest errors - correcting test classifications. (#856) 2022-07-15 19:25:59 -05:00
Anuya Welling 4b895704d8 Addressing doctest error - found wrong tag : number (#855) 2022-07-13 08:39:34 -05:00
andreastedile fc824596aa Fix typo (#852)
Signed-off-by: andreastedile <andrea.stedile@studenti.unitn.it>
2022-07-06 18:04:32 -05:00
Vladislav Shchapov bc7e83a2f0 Fix signed/unsigned compare. (#849)
Signed-off-by: Vladislav Shchapov <vladislav@shchapov.ru>
2022-06-29 10:46:52 -05:00
Anuya Welling 0a521127a8 Tbb numa bug fix (#842)
* Add fix for close scheme numa affinity.

Signed-off-by: sarathnandu <sarath.nandu.ramachandran.nair@intel.com>
2022-06-27 18:12:30 -05:00
sarathnanduandAnuya Welling 5deb46f4c2 Add Win Numa test-cases (#846)
* Added tests for overflow and using all threads

Signed-off-by: Sarath Nandu R <sarath.nandu.ramachandran.nair@intel.com>
Co-authored-by: Anuya Welling <anuya.welling@intel.com>
2022-06-27 18:04:48 -05:00
Christoph Erhardt 801df0edeb Fix overeager stripping of compile flag (#716)
The existing regex strips all occurrences of the given string from
`${CMAKE_CXX_FLAGS}`, regardless of whether it is just a substring of a
flag. For instance, `-Werror=format-security` gets truncated to
`=format-security`.

The new regex makes sure that only whole words get replaced.

Signed-off-by: Christoph Erhardt <github@sicherha.de>
2022-06-02 10:04:22 -05:00
Dmitri Mokhov 451e76ef68 Do not store in LargeObjectCache objects whose sizes align to maxHugeSize (#838)
Signed-off-by: Dmitri Mokhov <dmitri.n.mokhov@intel.com>
2022-05-26 12:56:50 -05:00
Valentina Kats faaf43c4ab Update RELEASE_NOTES.md for oneTBB 2021.6 (#835) 2022-05-20 13:21:25 -05:00
Alexey Veprev 9d2a3477ce CMake/readme: fix note (#805) 2022-04-01 16:49:55 +03:00
Alexandra 3e352b4812 Update layout.html (#815) 2022-03-25 14:02:28 +03:00
Alexandra 4aa0b0b2db Update examples.rst (#816) 2022-03-24 16:52:43 +03:00
Alexandra 3859d1111f Update conf.py (#812) 2022-03-22 17:52:55 +03:00
Alexandra efea9935d1 Update intro_gsg.rst (#811) 2022-03-21 14:42:01 +03:00
Anton PotapovandAlexandra ed9d4b5e9a TBB DOC : Dev Guide: Task Scheduler Bypass and How Does Task Scheduler Works (#521)
* TBB DOC : Dev Guide: Task Scheduler Bypass and How Task Scheduler
Works

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>
2022-03-21 11:24:26 +03:00
Alexandra 0a0a5926ee Update conf.py (#810) 2022-03-18 18:26:28 +03:00
Alexandra 2c4f282e86 Update intro_gsg.rst (#808) 2022-03-18 16:53:06 +03:00
Alexandra 05023723ff Update Get Started Guide (#803) 2022-03-16 13:25:18 +03:00
Alex 500abe33f8 Workaround conflict with _CRTDBG_MAP_ALLOC (#787)
* Workaround conflict with _CRTDBG_MAP_ALLOC

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-03-15 09:21:35 +03:00
Ilya Isaev 1da8f0d33b Add topic about "Lazy Initiliazation" pattern to Design patterns (#790)
New topic about Lazy initialization pattern and how it can be implemented using oneapi::tbb::collaborative_call_once has been added.

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2022-03-09 16:56:39 +03:00
a938322524 Document a way to flow graph can be attached to arbitrary task_arena (#785)
* Document a way to flow graph can be attached to arbitrary task_arena

task_arena interface provides mechanisms to guide tasks execution within the arena by
setting the preferred computation units or restricting part of computation units. In some
cases, you may want to use mechanisms within a flow graph.

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>
Co-authored-by: Alexandra Epanchinzeva <alexandra.epanchinzeva@intel.com>
2022-03-09 15:04:40 +03:00
Vladislav Shchapov af90f6cffc CMake/test: fix -rdynamic for full LTO build (#798)
Signed-off-by: Vladislav Shchapov <phprus@gmail.com>
2022-03-05 10:11:43 +03:00
Alexandra e386960a77 Instruction for building the docs locally (#778) 2022-03-04 19:49:25 +03:00
Alexandra ce0d258e72 Update doc structure and add new files (#791) 2022-03-02 18:37:52 +03:00
Sergey Zheltov 09346731f1 CI: don't run copyright_check on master branch (#792) 2022-02-28 19:11:12 +03:00
Aleksei Fedotov e5cbe500d2 Actualize documentation about proportional splitting constructor in Range (#728)
Actualize documentation about proportional splitting

Signed-off-by: Fedotov, Aleksei <aleksei.fedotov@intel.com>
2022-02-28 10:34:08 +03:00
KseniiaBakina a392038c6d Add copyright checker (#784) 2022-02-28 06:59:04 +03:00
Ilya Isaev f8102d5ba7 Fix test_collaborative_call_once SIGABRT on ARM 32 bit(#789)
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2022-02-24 16:56:05 +03:00
Alex 31cba51f69 Rework incorrect assert in try_destroy_arena (#781)
Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-02-21 11:33:26 +03:00
Alex ab1409e16b Fix incorrect assertion in test_eh_algorithms (#771)
* Fix incorrect assertion in test_eh_algorithms

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-02-21 11:02:56 +03:00
Pavel Kumbrasev a8681a54c2 Remove suspend_callback_wrapper struct (#780)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2022-02-21 10:06:32 +03:00
Pavel KumbrasevandAlex e77098d67f Call suspend user function on the calling thread (#727)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
Co-authored-by: Alex <alexei.katranov@intel.com>
2022-02-18 11:44:43 +03:00
Alexandra 6666292fbf Update conf.py (#774) 2022-02-16 14:49:57 +03:00
Alexey Veprev c9e43df346 version.h: fix year (#772)
Signed-off-by: Veprev, Alexey <alexey.veprev@intel.com>
2022-02-10 11:01:19 +03:00
Alexey Veprev 39c6fa3010 Update version number for 2021.7 (#770)
Signed-off-by: Veprev, Alexey <alexey.veprev@intel.com>
2022-02-09 15:47:50 +03:00
Sergey Zheltov 690aaf497a Update copyright year 2021 -> 2022 (#769)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2022-02-09 12:59:44 +03:00
kboyarinov 56cb263e40 Fix incorrect access to concurrent_hash_map from transparent insertion (#759)
* Fix incorrect access

* Add test for chmap access modes

* Change copyright year for test_concurrent_hash_map.cpp
2022-02-07 16:45:43 +03:00
Alex 18e06f7f6b Simplify private worker synchronization mechanism (#754)
Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-02-07 15:03:03 +03:00
Anton PotapovandAlexandra fd76f45215 Documentation update for unpreview task_handle and related stuff (#755)
* Unpreview task_handle and related stuff

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>
2022-02-07 12:35:20 +03:00
Julien Voisin 3a7f96db56 mallinfo is only defined on glibc and android (#764)
It currently prevents compilation under musl:

```
[ 90%] Building CXX object src/tbbmalloc_proxy/CMakeFiles/tbbmalloc_proxy.dir/proxy.cpp.o
/__w/mimalloc-bench/mimalloc-bench/extern/tbb/src/tbbmalloc_proxy/proxy.cpp:263:26: error: return type 'struct mallinfo' is incomplete
  263 | struct mallinfo mallinfo() __THROW
      |                          ^
compilation terminated due to -Wfatal-errors.
``
2022-02-07 09:56:15 +03:00
Alexandra e274a9e4b3 Update CONTRIBUTING.md (#765) 2022-02-04 21:39:41 +03:00
Alex f5ed9a6b6a Workaround ASAN false positive in test_eh_algorithm (#767)
Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-02-04 14:12:45 +03:00
Rui Ueyama 6a15b64093 Make tbb compile with musl libc (#748)
TBB resumable tasks are implemented using getcontext() and setcontext()
on Unix-like systems. These functions are deprecated in the recent
versions of POSIX and may not exist. musl libc does not provide these
functions.

There's unfortunately no way to detect musl (musl intentionally do not
define macros like `__MUSL__`), so __TBB_RESUMABLE_TASKS is defined if
`__GLIBC__`. glibc-compatible libc's such as uClibc defines `__GLIBC__`,
so it should work as a catch-all condition.

Signed-off-by: Rui Ueyama <ruiu@cs.stanford.edu>
2022-02-04 13:32:11 +03:00
fpliu c17f1ec1cb CMake: fix ANDROID_STL handling (issue #710) (#729)
ANDROID_STL variable is optional, it may be empty. ${ANDROID_STL} should be enclosed in quotation marks.

Reference:
https://developer.android.com/ndk/guides/cmake#android_stl

Signed-off-by: leleliu008 <leleliu008@gmail.com>
2022-02-04 10:58:53 +03:00
Alex 219c42520c Fix external thread termination (#762)
* Fix external thread termination
* Fix tls key corruption for the last external thread
* Refactor task_dispatch attach/detach logic

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-02-04 10:21:05 +03:00
Vladimir SerovandAleksei Fedotov 5d21288abc Code coverage for overwrite_node (#760)
Test for coverage cancel function of oneapi::tbb::flow::overwrite_node::register_predecessor_task

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>
2022-02-03 13:32:09 +03:00
Sergey Zheltov 2a9ed7045e CI: replace testing on Windows Server 2016 + VS2017 with Server 2022 + VS2022 (#763)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2022-02-02 19:14:21 +03:00
Sergey Zheltov c21e688ad0 Update copyright year 2021 -> 2022 (#761)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2022-02-01 19:40:54 +03:00
Sergey Zheltov cd6a5f9f4a CI: fix documentation build error (#753) 2022-01-27 15:08:48 +03:00
Vertexwahn 3c76824ade Add Bazel build support for macOS (#746)
Signed-off-by: Julian Amann <julian.amann@tum.de>
2022-01-27 10:48:48 +03:00
Pavel Kumbrasev 525a38895c Fix incorrect synchronization in private server (#739)
* Fix a race in thread shutdown protocol

Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2022-01-26 15:21:41 +03:00
Ilya Isaevandvlserov 57f524ca71 clang-tidy: use nullptr instead of NULL (#631)
This patch applies clang-tidy check- modernize-use-nullptr

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
Co-authored-by: vlserov <vladimir.serov@intel.com>
2022-01-26 12:39:57 +03:00
Alex 4d2254b08f Improve code readability in private_worker (#752)
Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-01-26 07:46:34 +03:00
Alexandra 4eda0f93a7 Update pull_request_template.md (#751)
Signed-off-by: Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com
2022-01-25 14:45:12 +03:00
Ilya Isaev e0cc518745 Split tbb::flow::join_node testing into separate test files (#741)
In order to reduce GOT size on MIPS that leads to linkage errors (relocation truncated to fit: R_MIPS_GOT_PAGE) in debug, tbb::flow::join_node testing was split into separate files.

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2022-01-24 19:19:36 +03:00
Sergey Zheltov 35e0f552bd Fix DLL loading for tbb4py on Windows (#749)
* Fix DLL loading for tbb4py on Windows

Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>

* Fix copyright year

Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2022-01-24 18:35:12 +03:00
Anton Potapov 74207e5d2d Fix race in conformance_task_arena (#744)
* Fix race in conformance_task_arena

- call observe(false) in the derived observer destructor
- do the same for all observers in the tests 

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2022-01-24 12:25:29 +03:00
Sergey Zheltov 13f9f32b3a Update copyright year 2021 -> 2022 (#743)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2022-01-21 17:09:47 +03:00
kboyarinovandAlexei Katranov 555bc873f8 Fix unordered and ordered containers ranges for empty containers (#703)
* Fix container::range_type behavior in case of empty containers

* Remove test that violates the spec

* Fix range.begin to point to a value node

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>

* Remove first_value_node from empty

Co-authored-by: Alexei Katranov <alexei.katranov@intel.com>
2022-01-21 11:09:12 +03:00
Alexey Oralov 1bfd90d19a Delete tbb_gen_vars (#742)
Signed-off-by: Aleksey Oralov <alexey.oralov@intel.com>
2022-01-20 22:22:38 +03:00
Pavel Kumbrasev a36bf9cb86 Fix incorrect resize behavior with first_block (#735)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2022-01-20 12:01:21 +03:00
Alexey VeprevandAlexandra 70ac2444f5 INSTALL.md: add example for multi-config generators (#736)
Signed-off-by: Veprev, Alexey <alexey.veprev@intel.com>

Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>
2022-01-19 12:21:21 +03:00
Alexandra 1318c0582e Update conf.py (#737)
Signed-off-by: Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com
2022-01-18 16:26:45 +03:00
Alexandra 6b0507b72d Update RELEASE_NOTES.md (#734)
Signed-off-by: Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com
2022-01-17 15:18:23 +03:00
Anton PotapovandPavel Kumbrasev 84efdd2a87 making task_group_context::is_proxy race free (#726)
* making task_group_context::is_proxy race free

using special value of task_group_context::my_state (former my_lifetime_state) to avoid
races on task_group_context::my_traits

the race was on task_group_context::my_traits member
- it was read by the is_proxy() member during task spawning
- it was written to in bind_to() function on first task spawning

- some renamings
 -  task_group_context::my_state -> my_may_have_children
 -  task_group_context::my_lifetime_state ->my_state
 -  task_group_context::lifetime_state -> state

- removed unused enum values

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
Co-authored-by: Pavel Kumbrasev <pavel.kumbrasev@intel.com>
2022-01-17 15:15:22 +03:00
Anton Potapov f1ba69bde9 Rectifing testing of some preview features controlled by __TBB_CPF_BUILD (#732)
Explicit enabling of task_group related preview features was removed, in favor of logic in test/common/config.h

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2022-01-17 09:47:24 +03:00
Anton Potapov 14d3d41f81 Missed part of task_group_exptensions unpreview (#668) (#731)
Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2022-01-17 09:46:23 +03:00
Alex ec39c5463d Fix overflow in concurrent_hash_map (#704)
Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-01-13 12:29:23 +03:00
Alex 1eaccf7a8c Improve task arena test coverage (#725)
Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2022-01-13 12:29:07 +03:00
Anton Potapov 3db67b5ba2 Fixed deadlock in the task_group conforance tests (#699)
- use same arena for task_group::run() and task_group::wait() methods
- use single thread environment for test stability

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2022-01-11 22:39:11 +03:00
Ilya Isaev 4ba6676737 Update doctest version to 2.4.7 (#692)
Updated doctest version to the new released 2.4.7 and applied necessary locally made workarounds

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2022-01-10 18:55:21 +03:00
Anton Potapov 603d9f7e17 Fix Migration Guide Link (#721) 2022-01-10 17:23:02 +03:00
Ivan Kochin e386c96deb Update the name of the link to the CMake readme (#722)
Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2022-01-10 15:32:25 +03:00
Vladimir Serov d1667d514d VS2015: fix possible unreached code warning (#706)
Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-12-30 09:48:40 +03:00
AlexandAnton Potapov 5fc0a5f6b3 task_scheduler_handle productization (#566)
* task_scheduler_handle productization

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com

Co-authored-by: Anton Potapov <anton.potapov@intel.com>
2021-12-29 21:28:56 +03:00
Alex 90b0671b31 Resolve doxygen class naming conflicts (#705)
* Fix doxygen class naming conflicts

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-12-28 17:30:10 +03:00
Alexey Veprev 0860b7f562 CMake: convert TBB_SIGNTOOL path TO_CMAKE_PATH (#701)
Signed-off-by: Veprev, Alexey alexey.veprev@intel.com
2021-12-27 11:15:16 +03:00
Vladislav Shchapov 013035b4e9 Fix issue #687 (test_eh_thread) (#697)
Signed-off-by: Vladislav Shchapov <phprus@gmail.com>
2021-12-23 17:17:24 +03:00
Vladimir Serov 534428d0f8 Build issue: GCC 4.8 bug (#693)
Class template inheritance doesn't work well with function-local types
Move class definition to global scope

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-12-22 16:52:00 +03:00
Andrey Semashev 8a87469451 Optimize x86 atomic_fence (#328)
* Added optimized x86 atomic_fence for gcc-compatible compilers.

On x86 (32 and 64-bit) any lock-prefixed instruction provides sequential
consistency guarantees for atomic operations and is more efficient than
mfence.

We are choosing a "lock not" on a dummy byte on the stack for the following
reasons:

 - The "not" instruction does not affect flags or clobber any registers.
   The memory operand is presumably accessible through esp/rsp.
 - The dummy byte variable is at the top of the stack, which is likely
   hot in cache.
 - The dummy variable does not alias any other data on the stack, which
   means the "lock not" instruction won't introduce any false data
   dependencies with prior or following instructions.

In order to avoid various sanitizers and valgrind complaining, we have to
initialize the dummy variable to zero prior to the operation.

Additionally, for memory orders weaker than seq_cst there is no need for
any special instructions, and we only need a compiler fence. For the relaxed
memory order we don't need even that.

This optimization is only enabled for gcc up to version 11. In gcc 11 the
compiler implements a similar optimization for std::atomic_thread_fence.
Compilers compatible with gcc (namely, clang up to 13 and icc up to 2021.3.0,
inclusively) identify themselves as gcc < 11 and also benefit from this
optimization, as they otherwise generate mfence for
std::atomic_thread_fence(std::memory_order_seq_cst).

Signed-off-by: Andrey Semashev <andrey.semashev@gmail.com>

* Removed explicit mfence in atomic_fence on Windows.

The necessary instructions according to the memory order argument
should already be generated by std::atomic_thread_fence.

Signed-off-by: Andrey Semashev <andrey.semashev@gmail.com>

* Removed memory order argument from atomic_fence.

The code uses memory_order_seq_cst in all call sites of atomic_fence,
so remove the argument and simplifiy the implementation a bit. Also, renamed
the function to make the memory order it implements apparent.

Signed-off-by: Andrey Semashev <andrey.semashev@gmail.com>
2021-12-22 13:18:30 +03:00
74b7fc748b Moving task_group_exptensions out of the preview (#668)
Moving task_group_exptensions out of the preview

- moved all but :
  - is_inside_task
  - scheduller bypass

- replaced exceptions with asserts for undefined behavior
 - made some flags in the tests non-atomic for TSAN to raise a flag if
implementation is incorrect

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
Co-authored-by: Ilya Isaev <ilya.isaev@intel.com>
Co-authored-by: Alex <alexei.katranov@intel.com>
2021-12-21 12:03:42 +03:00
Alexandra 6563a2225b Update README.md (#674)
* Update README.md

Signed-off-by: Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
2021-12-21 11:28:07 +03:00
Khem Raj 883c2e5245 Musl/linux can not use RTLD_DEEPBIND (#684)
Exclude non-glibc linux systems along with android
Fixes
src/tbb/dynamic_link.cpp:417:29: error: use
 of undeclared identifier 'RTLD_DEEPBIND'                                                                                    |             flags = flags | RTLD_DEEPBIND;
|                             ^

Signed-off-by: Khem Raj <raj.khem@gmail.com>
2021-12-15 19:08:07 +03:00
Ilya MishinandSerov, Vladimir 0815661e4c Fix limiter_node decrementer (#647)
* Fix limiter_node decrementer

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Fix align

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* add new variable for check unused decrements

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove iostream

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove unnesessary cast

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* align whitespaces

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Fix whitespace alignment

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>

* Revert workaround for GCC

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>

Co-authored-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-12-13 11:59:05 +03:00
Vladimir Serov 6edb5c3ae9 Deallocate object with based on actual type (#667)
* Deallocate object with based on actual type

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-12-13 11:58:32 +03:00
Alexandra 56d44d28bb Restructuring the docs (#683) 2021-12-10 16:41:38 +03:00
Vladimir Serov 952845afef Suppress data race during ittnotify initialization (#659)
Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-12-08 12:33:41 +03:00
Ilya MishinandAleksei Fedotov 324afd9e4d Catch exception in lightweight node (#623)
* Add raii to aggregator to prevent stuck

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Add test

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Reuse tbb raii guard

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Add header

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* execute_and_wait lightweight task

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove unused headers

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove space

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove std::function

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* noexcept lightweight body

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix cmake

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix space

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* gcc error

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* declval gateway_type

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* new tests

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* template tests

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* macro TBB_USE_EXCEPTIONS

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Apply suggestions from code review

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>
2021-12-08 11:46:43 +03:00
Ivan Kochin 4eec89fe7a Check the swappable requirement for the parallel_sort algorithm (#656)
Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-12-06 17:43:26 +03:00
مهدي شينون (Mehdi Chinoune) f5de7b039e Copy tbb.lib only with MSVC (#679) 2021-12-06 17:22:05 +03:00
Andrey Semashev b7a062e2d9 Use memalign, posix_memalign and _aligned_malloc to allocate aligned memory. (#671)
This uses the standard allocator for allocating and freeing memory with
higher alignment requirements instead of the hand-rolled implementation.

Signed-off-by: Andrey Semashev <andrey.semashev@gmail.com>
2021-12-03 16:44:04 +03:00
kboyarinov fc8717e18c Move heterogeneous extensions from preview (#672) 2021-12-03 15:20:05 +03:00
Ilya Isaev 2713d41e4c Fix incorrect definition of assignment operator in containers (#676)
* Fixed incorrect definitions of assignment operators in associative containers.

This fixes incorrect return types of assignment operators imported from
base classes. Other than copy and move assignment operators, which are
generated by the compiler even if imported with a using-declaration,
the imported operators will be returning a reference to the base class
instead of the derived class.

Fixes https://github.com/oneapi-src/oneTBB/issues/372.

Signed-off-by: Andrey Semashev <andrey.semashev@gmail.com>
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-12-02 13:02:24 +03:00
Ilya Isaev cf0a673956 collaborative_call_once: alignment with Spec 1.1 (#662)
collaborative_call_once is moved from preview. Also added conformance_collaborative_call_once test file

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-11-29 12:33:09 +03:00
Alexandra fb8ae3b97d Update RELEASE_NOTES.md (#670)
Signed-off-by: Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com
2021-11-24 16:09:49 +03:00
Pavel Kumbrasev 3ab999a0a7 Move mutexes out of preview (#666)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-11-22 11:52:52 +03:00
Alexandra 46d3acde26 Update conf.py (#664)
* Signed-off-by:Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com

* Update conf.py

* Update conf.py
2021-11-19 17:11:53 +03:00
AlexandAnton Potapov 7631793a32 Fix stack overflow protection mechanism (#553)
* Fix stack size calculation

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
Co-authored-by: Anton Potapov <anton.potapov@intel.com>
2021-11-19 15:07:25 +03:00
Alexandra 3692900c51 Update README.md (#663)
* Update README.md

* Update README.md
2021-11-18 11:34:24 +03:00
AlexandraandAlexey Veprev 25f8494f45 Installation Guide (#630)
* Installation Guide

* Update INSTALL.md

* Update README.md

* Update INSTALL.md

* Update INSTALL.md

* Update INSTALL.md

* Update INSTALL.md

* Update INSTALL.md

Co-authored-by: Alexey Veprev <alexey.veprev@intel.com>

* Update INSTALL.md

* Update README.md

* Update INSTALL.md

* Update README.md

Co-authored-by: Alexey Veprev <alexey.veprev@intel.com>
2021-11-18 11:18:41 +03:00
Sergey Zheltov 252ee0d301 CMake: fix warning 'LNK4044: unrecognized option /openmp' (#661)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2021-11-17 20:27:54 +03:00
Alexandra 7b3cb6747d New docs and update README.md (#660)
* Signed-off-by:Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com

* Update SYSTEM_REQUIREMENTS.md

* Update SYSTEM_REQUIREMENTS.md
2021-11-17 12:10:00 +03:00
Ivan Kochin bd4fb54e72 Disable the TBBbind target during the static library build (#658)
* Disable the TBBbind target during the static library build

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-11-16 21:15:11 +03:00
588c6a9f8b task_group extensions: documentation for task_group::run_and_wait(task_handle&&) method (#563)
* task_group extensions:

	- documentation for task_group::run_and_wait(task_handle&&) method

Co-authored-by: Alex <alexei.katranov@intel.com>
Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>
2021-11-16 16:42:02 +03:00
Alexandra b2cbc926ec Update conf.py (#652)
* Update conf.py

* static folder
2021-11-16 12:52:17 +03:00
Alexandra 7dee0fbd15 Update index.rst (#655)
Signed-off-by: Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com
2021-11-16 11:20:12 +03:00
Ivan Kochin 9052aaabd9 Remove several redundant steps inside the parallel_sort algorithm (#657)
Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-11-16 09:40:53 +03:00
AndrewDeanMSandAndrew Dean 2915b9b93f CMake: add option TBBMALLOC_PROXY_BUILD (#586)
Signed-off-by: Andrew Dean <Andrew.Dean@microsoft.com>

Co-authored-by: Andrew Dean <Andrew.Dean@microsoft.com>
2021-11-12 22:57:58 +03:00
Ilya Isaev 51277f0e58 Fix typo in detail/_config.h (#645)
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-11-09 18:33:27 +03:00
Julien Schueller ce47617377 Fix build with MinGW (#618)
Signed-off-by: Julien Schueller <schueller at phimeca dot com>
2021-11-09 17:14:14 +03:00
Ilya Isaev c8211a2168 Fix code coverage on macOS (#643)
Changed macro logic to let bool governor::wait_package_enabled() be called on macOS

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-11-09 15:44:36 +03:00
Ilya Isaev e82d250338 Check presence of Hugepagesize field (#594)
Don't enable HP and THP support if there is no Hugepagesize field in /proc/meminfo
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-11-02 23:02:53 +03:00
Ganael Laplanche cb885710ab Fix build on FreeBSD (#613)
__unix__ is defined on FreeBSD and makes #elif __FreeBSD__ section skipped

Signed-off-by: Ganael Laplanche <ganael.laplanche@martymac.org>
2021-11-02 16:30:59 +03:00
Alexey Veprev cf29ce8177 PR template: add signed-off-by checkbox (#638)
Signed-off-by: Veprev, Alexey alexey.veprev@intel.com
2021-11-02 16:20:36 +03:00
Alexey Veprev 8c9445dee5 CMake: add python_build target to ALL (#635)
Signed-off-by: Veprev, Alexey alexey.veprev@intel.com
2021-10-29 15:45:40 +03:00
Ivan Kochinandkboyarinov b95bbc9c9f Rvalue and constant ranges support for the tbb::parallel_sort algorithm (#605)
* Use forwarding reference for the parallel_sort overload that takes range

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
Co-authored-by: kboyarinov <konstantin.boyarinov@intel.com>
2021-10-29 11:52:42 +03:00
Alexandra 7c7be274a1 Create Bazel.md (#632) 2021-10-28 12:29:33 +03:00
Ivan Kochin 6feeba8035 Use native CMake way to detect the IPO support (#608)
* Use native CMake way to detect the IPO support

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-10-27 17:23:32 +03:00
Vertexwahn 01a68ed7b3 Improve Bazel support (#592)
* Improve Bazel build documentation
* Update Bazel version
* Add support for waitpkg to the Bazel build
2021-10-25 23:03:13 +03:00
Ilya Isaev ba947f1806 Changes in code after applying some clang-tidy check fixes (#620)
Applied fixes from clang-tidy(readability and modernize)

Signed-off-by: Ilya Isaev ilya.isaev@intel.com
2021-10-21 12:43:09 +03:00
Ilya Mishin adf44fbf25 Clang-format sudoku example and fix CI check (#629)
* Clang-format sudoku example

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* try use clang-format-10

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* one more pointer

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* check clang-format

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* check clang-format-10

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-10-20 15:10:54 +03:00
Vladislav Shchapov d439ddfb80 Fix build error if defined _WIN32_WINNT (#603)
- define NOMINMAX in the tests if not defined
2021-10-20 11:53:03 +03:00
Ivan Kochin 963dfbf770 Remove wrong "global" entry point from the tbbbind entry points list on Windows (#626)
Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-10-20 10:40:13 +03:00
Ilya Isaev 15c838cea3 vars.bat: fix issue with no TBB in PATH (#622)
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-10-19 16:31:53 +03:00
Alexey Veprev 1b41b7e6cc Update version to 2021.6 (#621)
Signed-off-by: Veprev, Alexey <alexey.veprev@intel.com>
2021-10-18 18:37:23 +03:00
Ilya Mishin a1f53c8fa2 Remove tbbproxy library dependency from nuget package (#619)
Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-10-14 17:33:47 +03:00
Ganael Laplanche c4a42feb53 Fix FreeBSD/amd64 build on 13-STABLE and 14-CURRENT (clang >= 12.0.1) (#614)
Fix build on FreeBSD/amd64 with clang >= 12 or gcc >= 11
2021-10-14 14:11:56 +03:00
Ilya Mishin 106e08a45a Fix memory leak in sudoku example (#607)
* Fix memory leak in sudoku example

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* right macro

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove iostream

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove hardcoded value

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* do one board copy instead of three copies

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* make task_group local

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-10-14 12:30:40 +03:00
vlserov 1168c5cb83 Clang13 warnings fixing (#612)
Resolved warnings: deprecated-copy, unused-but-set-variable

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-10-13 19:14:42 +03:00
Ilya Isaev 155a9af909 vars.bat: add variable with full path to DLLs (#611)
Signed-off-by: Ilya Isaev ilya.isaev@intel.com
2021-10-13 13:23:13 +03:00
Ilya Isaev ef970eb0d9 Detect 32 bit x86 systems while adding -mwaitpkg option (#609)
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-10-08 11:40:15 +03:00
Sergey Zheltov b61fd08145 CMake: disable build of tbbmalloc_proxy on Windows ARM64 (#604)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2021-10-07 19:26:03 +03:00
Felix Yan 6fad69889d Define ITT_ARCH_IA64 when undefiend (#550) 2021-10-07 09:16:16 +03:00
Anton PotapovandPavel Kumbrasev 3c20b8f0b2 Revamp left over removal (#602)
* Revamp left over removal

Signed-off-by: Anton Potapov <anton.potapov@intel.com>

Co-authored-by: Pavel Kumbrasev <pavel.kumbrasev@intel.com>
2021-10-06 12:44:31 +03:00
Ivan Kochin 70bf10c0a9 Include missed <cstdint> header to oneapi/tbb/info.h (#601)
This header is required to use `intptr_t`.
2021-10-04 18:59:40 +03:00
Alexandra 144f75fd65 Clean-up (#598) 2021-10-01 19:40:53 +03:00
Alexandra b3d63b7a7f Update conf.py (#597) 2021-10-01 17:42:30 +03:00
Alex a8206f8540 Skip leak test in test_arena_constaints with tsan (#595)
Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-10-01 13:07:21 +03:00
Anton Potapov 4ca7d964db Fixed possible buffer overrun in dynamic_link (#591)
Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-09-30 15:51:05 +03:00
Ilya Isaev c09c4163ca Use yield function from tbb in tbbmalloc (#590)
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-09-30 09:11:34 +03:00
Vertexwahn 5ab8e5f6ea Fix spelling (contex -> context) (#593) 2021-09-30 08:37:33 +03:00
Pavel Kumbrasev f13f3ef35a Correct commit_wait in rml_monitor (#581)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-09-29 14:49:27 +03:00
Ilya Isaev d65c9b3a5f Fix test_tbb_header compiling on Windows with IntelLLVM (#589)
Fixed compilation error on Windows while compiling with IntelLLVM compiler: "#include resolved using non-portable Microsoft search rules"

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-09-28 18:09:51 +03:00
Ilya Mishin e6162e8838 Fix comment in test_limiter_node (#585)
Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-09-24 17:43:45 +03:00
Sergey Zheltov 43169c243f CMake: fix compile options for Windows ARM64 (#579)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2021-09-16 19:18:49 +03:00
Alexandra 5d7abed881 Update index.rst (#578) 2021-09-15 12:46:54 +03:00
Anton PotapovandAlexandra f580ec8edb DOC: Migration guide: Deferred task creation (#537)
- added Deferred task creation chapter

Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-09-14 21:53:25 +03:00
Anton Potapov c4a120705f [DOC]: Update Get Started Guide (#575)
- added code sample
2021-09-14 18:33:42 +03:00
Alexandra 3b1bc31f45 [DOC]: Update Get Started Guide (#564) 2021-09-14 16:55:00 +03:00
e8037363ac DOC: Migration guide chapter for Scheduler Bypass (#525)
* DOC: Migration guide chapter for Scheduler Bypass

Signed-off-by: Anton Potapov <anton.potapov@intel.com>

* DOC: Migration guide chapter for Scheduler Bypass

Minor code cleanups for code samples

Co-authored-by: Pavel <pavel.kumbrasev@intel.com>
Signed-off-by: Anton Potapov <anton.potapov@intel.com>

* DOC: Migration guide chapter for Scheduler Bypass

- fixed wording

Co-authored-by: Alex <alexei.katranov@intel.com>
Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>

* DOC: Migration guide chapter for Scheduler Bypass

- fixed wording

* DOC: Migration guide chapter for Scheduler Bypass

- fixed code sample
- add sentence about what defer is doing

Signed-off-by: Anton Potapov <anton.potapov@intel.com>

* DOC: Migration guide chapter for Scheduler Bypass

- fixed wording

Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>

Co-authored-by: Pavel <pavel.kumbrasev@intel.com>
Co-authored-by: Alex <alexei.katranov@intel.com>
Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>
2021-09-14 15:57:16 +03:00
Alexandra 0a57bda871 Update index.rst (#572) 2021-09-14 11:08:07 +03:00
Ekaterina Mekhnetsova 4624e4ff59 Remove old tms configurations (#571)
* Remove old tms configurations

* Update custom.js
2021-09-10 13:50:24 +03:00
Ilya Mishin 7567de93ae Workaround gcc bug in test_limiter_node (#569)
* Workaround gcc bug in test_limiter_node

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* unify workaround

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-09-07 18:29:59 +03:00
Alex 97ac8f4324 Disable RTM based tests under TSAN (#567)
* Disable RTM based tests (speculative mutexes) under TSAN

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-09-07 11:26:55 +03:00
PavelandAlex 40a9a10600 Fix memory semantics in queuing_rw_mutex (#552)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

Co-authored-by: Alex <alexei.katranov@intel.com>
2021-09-03 17:05:11 +03:00
Alexey Oralov 5d8ddb3fb6 Add PR template (#554)
Signed-off-by: Alexey Oralov alexey.oralov@intel.com
2021-09-03 09:25:41 +03:00
vlserovandpavelkumbrasev 4d3f9752d0 Performance: Avoid lock during working with multiple arenas (#562)
Synchronization order of calls function market::adjust_demand should
be made for arena, not for the market itself.

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
Co-authored-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-09-02 15:22:24 +03:00
Ekaterina Mekhnetsova 0a2b398702 Add analytics script for documentation (#561)
* Add analytics script for doc

* Update layout.html
2021-09-02 13:45:25 +03:00
Alexey Veprev 497a2b1695 Update version to 2021.5 (#559)
Signed-off-by: Veprev, Alexey <alexey.veprev@intel.com>
2021-09-01 17:07:44 +03:00
Pavel 86fe3f04c1 Fix arena layout (#557)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-08-31 15:03:40 +03:00
Anton PotapovandAlex dd8f8a7826 task_group extensions run_and_wait(task_handle&&) method (#538)
* task_group extensions:

- added task_group::run_and_wait(task_handle&&) method

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
Co-authored-by: Alex <alexei.katranov@intel.com>
2021-08-31 14:51:53 +03:00
Ilya Isaev f81abcb640 Increase number of iterations to cover 'resume_node::reset' call (#551)
Increased number of iterations to have a more stable coverage of resume_node::reset() function.

Signed-off-by: Ilya Isaev ilya.isaev@intel.com
2021-08-30 13:54:46 +03:00
Ilya Mishin 6aab19f72a Cover remove_edge with successor::input_ports_type (#549)
Signed-off-by: Ilya Mishin <ilya.mishin@intel.com>
2021-08-27 12:59:13 +03:00
Alexandra a6b90fc9f5 Contribution guidelines (#506)
* Signed-off-by:Alexandra Epanchinzeva alexandra.epanchinzeva@intel.com

* Minor fixes

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md
2021-08-26 17:55:23 +03:00
Ivan Kochin 1ea36d9e9d Cover the constraints_threads_per_core() reserved interface by testing (#544)
* Cover the constraints_threads_per_core reserved interface by testing

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-08-25 13:12:07 +03:00
Ilya IsaevandAlex 9924f9e808 Fix static build on Windows (#543)
This patch fixes issue with reference leak reported by test_global_control and test_tbb_fork on static build.

Signed-off-by: Isaev, Ilya ilya.isaev@intel.com

Co-authored-by: Alex <alexei.katranov@intel.com>
2021-08-24 14:23:05 +03:00
Ekaterina Mekhnetsova b60c4d3631 Update conf.py (#545) 2021-08-24 10:40:49 +03:00
Ekaterina Mekhnetsova 0695d176ff DOC: Add a link to Intel cookies (#542)
* Add a link to Intel cookies

* Update syntax
2021-08-24 10:29:57 +03:00
Pavel c6045a4f6f Fix using tbb::this_task_arena::current_thread_index() with uninitilized arena (#541)
Fix using tbb::this_task_arena::current_thread_index() with uninitilized arena
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-08-23 09:48:35 +03:00
vlserov d2405e35d1 Remove unused template class tls (#536)
Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-08-18 10:46:17 +03:00
Ilya Mishin de0109bed0 Improve Flow Graph conformance tests (#410)
* continue and function node

* multifunction node

* input node

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* buffering nodes

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* new input and output messages

* service nodes

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* green CI

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* graph reset tests

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* additional reset tests

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix codestyle issues

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* copy constructor fix

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* sfinae fix

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix unique_ptr on cxx11

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* style fixes

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* copy_constructor fix

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix atomic initialization

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fid data race

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-08-12 11:29:31 +03:00
AlexandAlexandra b44f164b5c [DOC] Fix task_scheduler_handle description (#509)
* [DOC] Fix task_scheduler_hadnle description

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>

Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>
2021-08-12 10:51:15 +03:00
Sergey Zheltov 1167f54bdf CMake: suppress alignment warning for ARM64-MSVC (#532)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2021-08-11 20:39:08 +03:00
Ilya Isaev 8584c45634 Code coverage fixes (#516)
In scope of this patch TBB_BUILD and TBBMALLOC_BUILD options were added. It was done to support scenarios when we are testing without tbbmalloc. It allows us to cover place where we fail to link with tbbmalloc and start using std_cache_aligned_allocate/deallocate.

Signed-off-by: Ilya Isaev ilya.isaev@intel.com
2021-08-09 11:52:01 +03:00
Ilya Mishin 1ecde27f49 Fix inclusive language usage issues in tbbmalloc (#522)
Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-08-06 11:45:00 +03:00
vlserov 5a643c2360 GCC 11: suppress stringop-overread warning (#519)
1. Using thread_local for non-pointer types instead of tbb::detail::r1::tls
2. Replace magic-value with valid pointer

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-08-05 15:57:27 +03:00
Alexey Veprev 357c9b27fa Update version number for 2021.4 (#520)
Signed-off-by: Veprev, Alexey alexey.veprev@intel.com
2021-08-02 18:20:31 +03:00
Alex 4df48f9850 Fix a race condition in AddrRange in tbbmalloc (#518)
The change fixes a possible crash of realloc when replaced with tbbmalloc_proxy on Linux.

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-07-30 21:09:57 +03:00
Pavel 552f342b26 Add workaround for incorrect soft limit initialization (#512)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-07-30 15:59:06 +03:00
Alexandpavelkumbrasev 34c7d170ca Add heavy mix test for the scheduler (#490)
The test found a couple of issues that are also addressed in the patch

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
Co-authored-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-07-30 15:58:14 +03:00
Ivan KochinandAlexey Veprev 7ec3cf8408 Fix the HWLOC linking when it was found using pkg-config (#508)
* Use imported target instead of variables during the HWLOC search using pkg-config
* Remove redundant code + rephrase the description
* Fix the indentation
* Rework testing

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>

Co-authored-by: Alexey Veprev <alexey.veprev@intel.com>
2021-07-30 15:21:15 +03:00
Ilya Mishin a070e5f208 Fix optimization flag on icx Windows Release build (#513)
Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-07-29 15:50:48 +03:00
Michael Vitrano 7d70bb51c3 Support building for Windows ARM64 (#507)
* Support building for Windows ARM64

Signed-off-by: Michael Vitrano <michaelvitrano@gmail.com>
2021-07-26 18:23:29 +03:00
Ivan Kochin b53726aac7 Prevent linking HWLOC 2.4 with tbbbind_2_5 (#501)
* Prevent linking HWLOC 2.4 with tbbbind_2_5
* Fix typo
* Rename and extend the comment

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-07-23 14:49:49 +03:00
vlserov fcb8377bee ASAN: test_task_group timeout (#502)
Disable memory leak tests under ASAN

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-07-22 14:41:20 +03:00
Ilya Mishin dbccbee9f5 ICX compiler support on windows (#499)
* Support ICX on windows

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* clang macro

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* update compiler map

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix intptr_t

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix duplicate

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix spaces

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* fix spaces 2

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* update style

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Update CMakeLists.txt

* Update test_openmp.cpp
2021-07-22 10:43:27 +03:00
Ivan Kochin edc30c82a1 Bind internal pinning observer lifetime to internal arena (#488)
* Bind internal pinning observer lifetime to the internal arena
* Control the tbbbind system_topology lifetime manually
* Fix entry point name
* Apply review remarks:
 * rename platform_topology to system_topology inside tbbbind
 * other minor fixes

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-07-21 23:01:03 +03:00
7941f880cb Fix build and tests of statically linked oneTBB (#492)
Fix build of libraries and tests while linking statically.

Signed-off-by: buzyaba <isaev.ameninc@gmail.com>

Co-authored-by: Alexey Veprev <alexey.veprev@intel.com>
Co-authored-by: buzyaba <isaev.ameninc@gmail.com>
2021-07-21 15:56:23 +03:00
8827ea7d1d Add export attributes + bug fixes (#351)
* Change (_WIN32 || _WIN64) to (_WIN32)

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add _MSC_VER guards around #pragma warning directives

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Tweak MUTEX_INITIALIZER to suppress warnings

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Undefine PATH_MAX before redefining to suppress warnings

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Wrap #undef PATH_MAX

Co-authored-by: Alex <alexei.katranov@intel.com>

* Add lib prefix to dll names on mingw

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Quote LINK_FLAGS and LINK_DEPENDS to avoid space in paths problem

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Move #include <cstring> outside of #if _WIN32 block

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* wchar_t everywhere

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add export attributes

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Tweak export macros

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add export directives to tbbmalloc

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Wrap version script arguments + Undefine __STRICT_ANSI__

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Export directives for tbbbind

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Temporarily disable def files flag

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Fix __STRICT_ANSI__ undefine

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Fix macro in spin_mutex.h

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add export directives to task_group.h

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add waitpkg detection

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Tweak x86_64 detection

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Fix -U__STRICT_ANSI__ again

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Do not link with dl on mingw

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add extra include files for allocator.cpp

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add export directives for version.h

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Move export directives macro to a separate file

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Split export directives into separate macros

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Remove tbbmalloc symbols from proxy.h

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Replace TBBMALLOC_EXPORT with TBB_EXPORT in tbb_allocator.h

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Include scalable_allocator.h in tbbmalloc.cpp

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Disable C4275 in _exception.h

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add export directives for is_writer

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add export directives for _waitable_atomic.h

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Create macro for tbbbind

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Include <new> in scalable_allocator.h

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add export case for Apple OS

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add VERSION and SOVERSION

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Fix warnings under MSYS2 + GCC 10.3.x

* Trying to fix Linux CI

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Remove std::this_thread::yield() dependency on Windows

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Apply suggestions + fix typo

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Add def file flags back in

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Tweak export directives mechanism

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

* Change bool to auto to prevent warnings on VS2015

Signed-off-by: Long Nguyen <nguyen.long.908132@gmail.com>

Co-authored-by: Alex <alexei.katranov@intel.com>
Co-authored-by: Vittorio Romeo <vittorio.romeo@outlook.com>
2021-07-21 10:04:02 +03:00
Alexandpavelkumbrasev a080baf996 Additional set of Thread Sanitizer related fixes (#482)
- Fix incorrect assert in concurrent_hash_map implementation
- Fix incorrect asserts in global_control implementation
- Fix exception pointer inside task_group_context
- Rework racy asserts in test_flow_graph_whitebox
- Improve test_eh_algorithm to work with sanitizers
- Disable memory limit test in test_malloc_compliance
- Add lifetime asserts in collaborative_call_once
- Rework backref space in tbbmalloc to use atomics
- Fix a lifetime issue in utils::SpinBariier
- Some tests were disabled

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
Co-authored-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-07-19 14:47:09 +03:00
Ilya Isaev 9cef57778c Workaround non-zero exit code (#496)
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-07-19 09:19:45 +03:00
Ilya Isaev e279ae19cb Remove dead code for code coverage (#497)
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-07-19 09:12:58 +03:00
Ilya Mishin 1098f48187 Fix failed test_limiter_node on gcc10,11 release build (#493)
Signed-off-by: ilya.mishin <ilya.mishin@intel.com>
2021-07-16 18:00:30 +03:00
Olga Malysheva a85a8bd32f Update third-party-programs.txt (#495)
Signed-off-by: Olga Malysheva <Olga.Malysheva@intel.com>
2021-07-16 16:29:00 +03:00
Ilya Isaev 35147e0021 Simplify synchronization logic in task_group_context (#462)
The current synchronization in task_group_context made by more then one atomic variable. This code hard to debug and each ThreadSanitizer report in this code usual require unreadable workaround to fix it. To improve correctness and readability of this code it was decided to rewrite synchronization using mutex.

Signed-off-by: Ilya Isaev ilya.isaev@intel.com
2021-07-16 12:03:21 +03:00
vlserov 68e075cbb9 ASAN: leak in test_arena_constraints/conformance_arena_constraints (#484)
Memory leak has been caused by ThirdParty library.
Adding LSAN suppression list for filter known issues.

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-07-14 09:10:47 +03:00
Pavel b3fb839485 Enable thread-based resumable tasks under ASan (#486)
Signed-off-by: pavelkumbrasev <pavel.kumbrasev@intel.com>
2021-07-09 15:26:02 +03:00
Vertexwahn 6164044548 Add support for Bazel build (#442)
Signed-off-by: Vertexwahn <julian.amann@tum.de>
2021-07-08 11:04:01 +03:00
Alex 8e7f9e14ba Fix internal allocator related issues (#480)
*For some reason, GCC does not instrument tbbmalloc with TSan when lto is enabled.
*Fix race in internal allocator on handler pointer initialization.
*Simplify checks in conformance_parallel_for

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-07-08 09:32:20 +03:00
Ivan Kochin a3151ce8ac Fix tests compilation on FreeBSD (#425)
* Use right affinity mask type during tests compilation on FreeBSD
* Disable priority inversion testing on FreeBSD
* Fix test_malloc_compliance compilation
* Add TODO, remove redundant blank line

Signed-off-by: Kochin, Ivan <kochin.ivan@intel.com>
2021-07-08 08:01:30 +03:00
43c1805ec6 Add thread based resumable tasks (#479)
Co-authored-by: vlserov <vladimir.serov@intel.com>
Co-authored-by: pavelkumbrasev <pavel.kumbrasev@intel.com>

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-07-07 09:11:23 +03:00
Ilya Mishin c94904e909 oneAPI pkg-config support (#452)
* oneAPI pkg-config support

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* tbb and tbb32

* remove uwp

* remove unnecessary variable

* define variable

* correct install

* remove exec_prefix

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* new path

* update vars

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* absolute paths for CMAKE_INSTALL_*DIR

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove )

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-07-06 18:43:44 +03:00
Alexey Oralov c75ed5bf40 Update path to archive (#483)
Signed-off-by: Alexey Oralov alexey.oralov@intel.com
2021-07-06 13:38:13 +03:00
Alexey Oralov 055cc6eaa0 CI: enable publishing of documentation on pages (#473)
Signed-off-by: Aleksey Oralov <alexey.oralov@intel.com>
2021-07-06 13:05:41 +03:00
Ivan Kochin 07300f7eab Prevent vars generation conflict (#469)
Signed-off-by: Kochin, Ivan <kochin.ivan@intel.com>
2021-07-06 07:33:42 +03:00
Alexey Veprev a3a6cd638d CMake: fix path to tbb.pc.in file (#476)
Signed-off-by: Veprev, Alexey <alexey.veprev@intel.com>
2021-07-05 17:23:29 +03:00
Alex 59ac78fa87 Fix flow graph tests under Thread Sanitizer (#444)
* Fix fg tests under tsan

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-07-05 11:49:17 +03:00
Pablo Romero 734f0bc0be Add support for QNX Neutrino (#440)
* Added support for QCC (QNX GNU Compiler)
* Enable source code compilation with non-Linux Unix systems with special focus on QNX.

Signed-off-by: promero <promero@mathworks.com>
2021-07-02 18:44:55 +03:00
vlserov de8bf52c4a ASAN: test_handle_perror (#472)
test_handle_perror doesn't depend on TBB library.
Only include paths are required.

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-07-02 15:13:20 +03:00
Ivan Kochin c646de018a Fix LTO flags for Visual Studio compilation with old Cmake versions(<3.13) (#471)
Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-07-01 18:22:16 +03:00
Ivan KochinandAleksei Fedotov e96dbf4b48 Upgrade from HWLOC 2.4 to HWLOC 2.5 (#448)
* Upgrade from HWLOC 2.4 to HWLOC 2.5
* Introduce tbbbind_2_5 library
* Remove tbbbind_2_4 library
* Use the HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING topology flag (introduces as a part of HWLOC 2.5) to restrict topology discovering to process binding
* Fix testing on Linux
* Apply review comments
* Improve wording: variable -> substring
* Use right tbbbind version for incompatible hwlocs test
* Rework option semantic
* Update README.md for CMake
* Rework readme
* Update cmake/README.md

Signed-off-by: Kochin, Ivan <kochin.ivan@intel.com>

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>
2021-07-01 15:07:39 +03:00
vlserov 94b62cc1d8 ASAN: test_malloc_whitebox (#467)
Reverting ASAN fix for test_malloc_regression #415
Turn off memory leaks test in test_malloc_regression test case

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-07-01 11:31:04 +03:00
Ilya Isaev 112076d06c Improve code coverage (#463)
Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-07-01 10:09:04 +03:00
kboyarinov 4a23d00235 Multiple fixes for constraints (#465)
* Fix a typo in chmap, temporary rename concept range

* Rename range concept, add workaround for Windows

* Reimplement with respect to prospective destructors

* Fix fibonacci
2021-06-30 16:22:06 +03:00
Ivan Kochin a3635ce50b Fix LTO flags on Windows for old CMake versions (#466)
* Fix LTO flags for old CMake versions
* Update cmake/README.md

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-06-30 01:01:00 +03:00
Mircho Rodozov fa944e1960 Remove arch macros checks for getSmallObjectIndex (#461)
Remove arch macros checks for getSmallObjectIndex 

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-06-29 21:09:43 +03:00
Ivan Kochin 3e4ab55091 Fix dlopen flags for loading tbbmalloc and rml (#457)
* Fix dlopen flags for loading tbbmalloc and rml
* Rework macro definition approach
* Use correct macro name

Signed-off-by: Kochin, Ivan <kochin.ivan@intel.com>
2021-06-29 09:41:39 +03:00
Alexey Oralov 67c1171696 Add build documentation to CI (#423)
Signed-off-by: Aleksey Oralov <alexey.oralov@intel.com>
2021-06-28 17:44:37 +03:00
Anton Potapov c0b91bdba9 ASAN: disable OOM test in test_malloc_compliance (#459)
Out Of Memory conditions simulated in the ReallocParam test breaking ASAN, so skip this case under it.

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-06-28 10:25:55 +03:00
Anton Potapov 3a47fb3718 ASAN: disable test_malloc_overload (#458)
- ASAN overload malloc/free, so test is no longer test TBBMalloc

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-06-28 10:21:31 +03:00
Anton Potapov 3a6580652d ASAN: disable tests causing OOM conditions (#456)
- do not run theses tests under ASAN :
   - test_eh_thread
   - test_malloc_new_handler

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-06-25 12:05:27 +03:00
Alex 2ca2a5f206 Fix leaking proxy task objects (#431)
* Fix leaking proxy task objects

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-06-25 09:15:57 +03:00
Ivan Kochin 0354fc109f Solve the issue with different incompatible HWLOC library versions in one executable (#426)
* Solve the issue with different incompatible hwlocs in one executable
* Support macOS and Windows
* Fix flags on Windows and MacOS
* Try to fix Windows compilation
* Add warning suppression
* Rename the CMake variable
* Fix the RTLD_DEEPBIND flag placement condition
* Improve naming
* Change flags logic
* Suppress MSVC 2015 warning: 'int': forcing value to bool 'true' or 'false'

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
2021-06-23 19:45:29 +03:00
Anton PotapovandAleksei Fedotov 4386b0f0cd task_group extensions : task_handle comparison operators unit tests (#451)
* task_group extensions

- unit tests for empty check / comparison operators

Signed-off-by: Anton Potapov <anton.potapov@intel.com>

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>
2021-06-23 14:12:52 +03:00
kboyarinov 16b6a651a9 Fix error C3864 for constraints on Windows (#449)
* Fix Windows warning on constraints

* Fix whitespaces
2021-06-23 12:16:05 +03:00
Anton Potapov ec505c7d5a Workaround GCC 11 warning in concurrent_unordered_base (#447)
Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-06-22 12:16:57 +03:00
Ivan KochinandAnton Potapov e1b24895e6 SOM example: enable mandatory concurrency (#450)
SOM requires mandatory concurrency to prevent hanging on 1-threaded configurations since this example has cross-graph dependencies

* SOM example: enable mandatory concurrency
* Add include & define NOMINMAX
* Improve comment wording

Signed-off-by: Kochin Ivan <kochin.ivan@intel.com>
Co-authored-by: Anton Potapov <anton.potapov@intel.com>
2021-06-22 09:38:19 +03:00
Ivan Kochin ac3d43b691 Enable intermodular optimization during the compilation (#432)
* Enable IPO during the compilation
* Add compilation flag for clang++
* Rework CMake approach
* Disable LTO on Android due to Android NDK bug
* Remove redundant code

Signed-off-by: Kochin, Ivan <kochin.ivan@intel.com>
2021-06-21 12:23:49 +03:00
vlserov fbc48b39c6 ASAN: Use after scope in conformance_concurrent_queue (#435)
Updating concurrent_queue_rep to accept Allocator as a function parameter instead of holding reference to it.

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-06-18 10:21:25 +03:00
Sergey Zheltov 29009a8e51 Fix oneTBB package version in CMake integration (#446)
Signed-off-by: Zheltov, Sergey1 <sergey1.zheltov@intel.com>
2021-06-17 12:10:46 +03:00
Ilya Isaev 4beec37a1d Fix TSAN errors in collaborative_call_once (#445)
* Fix TSAN errors in collaborative_call_once

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-06-17 07:34:44 +03:00
Khem Raj 933a38a460 arena: Remove dead code (#429)
Fixes clang warning
arena.cpp:226:19: error: variable 'drained' set b
ut not used [-Werror,-Wunused-but-set-variable]
|     std::intptr_t drained = 0;
|                   ^

Signed-off-by: Khem Raj <raj.khem@gmail.com>
2021-06-17 07:34:08 +03:00
Ilya Mishin 64715f43d8 Fix failed mips debug build (#443)
* Fix mips debug join_node tests

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Macro in header

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Macro name

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* Right macro

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove unnecessary macro

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* macro only in join_node test

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>
2021-06-16 12:09:09 +03:00
Alexandra 2526dcf136 Update README.md (#436)
* Update README.md
2021-06-10 15:05:29 +03:00
Ilya Mishin b36260b443 Enable all join_node constructors testing (#441)
* enable all constructors testing

Signed-off-by: Mishin, Ilya <ilya.mishin@intel.com>

* remove unnecessary definitions
2021-06-10 13:37:16 +03:00
vlserov 345a2204ca ASAN: skip test_malloc_atexit under ASAN (#434)
Skip test_malloc_atexit since it not applicable under ASAN.

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-06-10 12:05:36 +03:00
Alex 81dd27c4f6 Fix some gcc11 warnings (#433)
* Supress mallinfo deprecation warning in test_malloc_overload.cpp
* Fix warning in flow_graph_types_impl

Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-06-09 12:00:48 +03:00
Ivan Kochin 55f9b17864 Update doctest version to 2.4.6 (#413)
* Update doctest version to 2.4.6

Signed-off-by: Kochin, Ivan <kochin.ivan@intel.com>
2021-06-08 17:43:37 +03:00
PavelandAlexei Katranov 3119997522 Improve wakeup signal propagation in private server (#427)
* Improve wakeup signal propagation in private server

Signed-off-by: pkumbras <pavel.kumbrasev@intel.com>

Co-authored-by: Alexei Katranov <alexei.katranov@intel.com>
2021-06-07 16:51:19 +03:00
Rupanshu Yadav fc9a3bbc78 Fix grammatical mistake in README.md (#428) 2021-06-04 21:25:36 +03:00
Ilya MishinandAleksei Fedotov 25e2b1dd25 Fix negative delta in limiter_node decrementer (#422)
* fix negative delta in limiter_node decrementer

* add assert

* fix warning

* add new test

* refactor test

* more checks

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>

* counter to right place

* fix build

Co-authored-by: Aleksei Fedotov <aleksei.fedotov@intel.com>
2021-06-04 17:27:08 +03:00
vlserov 4b479c1e0b ASAN fix for test_malloc_regression (#415)
ASAN allocator never releases memory to OS, instead of it just marks those memory as "freed".
Generic OS functions for getting currently allocated memory aren't working correctly under ASAN.

- Using __sanitizer_get_current_allocated_bytes func instead of generic OS func for getting currently allocated memory

Signed-off-by: Serov, Vladimir <vladimir.serov@intel.com>
2021-06-02 16:55:58 +03:00
Ilya IsaevandAlex bf1f2ab6eb Add collaborative_call_once algorithm (#397)
collaborative_call_once is a function similar to std::call_once but allows waiting threads to join oneTBB parallel construction called inside the initializing functor. The semantics of exceptions is also similar to std::call_once: whenever the exception is thrown, it is rethrown on the initializing thread and this or other thread can try to call initializing functor again until it is completed without an exception.

This pull request integrates #357. It is reworked to avoid dynamic memory allocation and fit the state into one word (see state machine in #267).  In cooperation with @BenFrantzDale @HenryHeffanFormlabs

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>

Co-authored-by: Alex <alexei.katranov@intel.com>
2021-06-02 16:44:25 +03:00
Anton Potapov fde1856728 task_group extensions (task_handle) minor cleanups (#404)
- moved task_handle related stuff to separate header file
- replaced free standing helper functions with single "acessor" class
- removed needless condition in the ctx_of() function

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-06-01 15:34:30 +03:00
Anton Potapov 16350adcff ASAN: fix memory leak in concurrent_skip_list move assign operator (#409)
- delete head node as well beffore move assigning
 - introduced internal helper member function delete_head


Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-05-31 18:11:34 +03:00
Ilya Isaev 012aea0351 Fix shellcheck scan errors and warnings (#411)
* Fix shellcheck errors and warnings

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>

* Apply comments and parse args properly on ZSH

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>

* Parse ia32 via regex

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>

* arg_ia32 to tbb_arg_ia32

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>

* Fix indenting

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>

* Change regex

Signed-off-by: Ilya Isaev <ilya.isaev@intel.com>
2021-05-26 20:20:51 +03:00
Ivan KochinandAlex c52c62ba78 Remove the same test cases to fix MIPS compilation (#412)
* Remove the same test cases to fix MIPS compilation

* Update test/tbb/test_join_node_msg_key_matching.cpp

Co-authored-by: Ivan Kochin <iv.kochin@gmail.com>

Co-authored-by: Alex <alexei.katranov@intel.com>
2021-05-25 14:33:00 +03:00
Alexei Katranov 3b04521726 Fix atomic usage in conformance_parallel_pipeline
Signed-off-by: Alexei Katranov <alexei.katranov@intel.com>
2021-05-25 08:02:10 +03:00
Jan Tojnar fa3268c3df CMake/pkg-config: fix paths in .pc file with absolute GNUInstallDirs (#395)
Signed-off-by: Jan Tojnar <jtojnar@gmail.com>
2021-05-21 18:46:06 +03:00
Ivan KochinandKochin, Ivan 5d4a4acf95 Fix the logic that depends on optional copy elision (#402)
* Fix the behavior when copy elision is disabled

* Update test/tbb/test_task_arena.cpp

* Rework doctest ContextScope destruction to fix MSVC compilation

* Remove raii_guard assignment + remove std::move from doctest

* Fix typo

* Rework the fix for doctest to get rid of hangs on Windows

* Add static assertion to check constructors noexcept state

* Remove copy elision disabling flag

* Add a comment with the reason of absence of std::move

Co-authored-by: Kochin, Ivan <ivan.kochin@intel.com>
2021-05-21 12:37:58 +03:00
Anton Potapov 0063fb3c76 ASAN fix for test_eh_algorithm (fixup for #401) (#403)
- fixup for #401

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-05-21 12:03:25 +03:00
Anton Potapov d8251013ce ASAN use after scope fix for concurrent_skip_list (#400)
- removed reference to container allocator from skip_list_node
 - added special skip_list_node::create skip_list_node::destroy static
methods

 - moved concurrent_skip_list, *_map/*multimap, *set/*multiset into d2
namespace due layout change of skip_list_node


Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-05-21 10:50:08 +03:00
Anton Potapov 444fd2bd0f ASAN fix for test_eh_algorithm (#401)
- fixed read out of bounds

Signed-off-by: Anton Potapov <anton.potapov@intel.com>
2021-05-19 18:52:27 +03:00
Ilya Mishin 3e9e8c9c4d Add threshold requirement for eh tests (#399)
* Add threshold requirement for eeh tests

* typo error fix
2021-05-18 12:40:09 +03:00
Tobias Fischer c46e2aa03e Pull in https://github.com/oneapi-src/oneTBB/pull/299 2021-05-17 20:05:20 +03:00
Alexey Veprev a497817ca0 README: add CI status badge (#398)
Signed-off-by: Alexey Veprev <alexey.veprev@intel.com>
2021-05-17 14:39:38 +03:00
tbbdev 8b6f831c68 Commit oneTBB source code 5ba997e1 2021-05-17 10:52:00 +03:00
Sergey Zheltov 6aa706d879 CI: fix a typo in the job name (#392) 2021-05-07 21:24:55 +03:00
Sergey Zheltov 6caecf9630 CI: enable testing via GitHub Actions (#390) 2021-05-07 17:15:01 +03:00
tbbdev be66b3a1cf Commit oneTBB source code 614fdc20 2021-05-07 16:29:12 +03:00
tbbdev 478de5b188 Commit oneTBB source code 82ff8707 2021-05-05 10:28:54 +03:00
615 changed files with 32132 additions and 10158 deletions
+19
View File
@@ -0,0 +1,19 @@
# Copyright (c) 2021 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# DISCLAIMER: Bazel support is community-based. The maintainers do not
# use Bazel internally. The Bazel build can have security risks or
# optimization gaps.
build --symlink_prefix=/ # Out of source build
+1
View File
@@ -0,0 +1 @@
5.0.0
+40
View File
@@ -0,0 +1,40 @@
### Description
_Add a comprehensive description of proposed changes_
Fixes # - _issue number(s) if exists_
- [ ] - git commit message contains an appropriate signed-off-by string _(see [CONTRIBUTING.md](https://github.com/oneapi-src/oneTBB/blob/master/CONTRIBUTING.md#pull-requests) for details)_
### Type of change
_Choose one or multiple, leave empty if none of the other choices apply_
_Add a respective label(s) to PR if you have permissions_
- [ ] bug fix - _change that fixes an issue_
- [ ] new feature - _change that adds functionality_
- [ ] tests - _change in tests_
- [ ] infrastructure - _change in infrastructure and CI_
- [ ] documentation - _documentation update_
### Tests
- [ ] added - _required for new features and some bug fixes_
- [ ] not needed
### Documentation
- [ ] updated in # - _add PR number_
- [ ] needs to be updated
- [ ] not needed
### Breaks backward compatibility
- [ ] Yes
- [ ] No
- [ ] Unknown
### Notify the following users
_List users with `@` to send notifications_
### Other information
+60
View File
@@ -0,0 +1,60 @@
#!/bin/bash
#
# Copyright (c) 2021 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
SCAN_TARGET=$1
SKIP_PATTERN='*/.github/*'
# Ignored cases
IGNORE_COMMAND="sed -e /.*\\sOd\\s*=.*/d \
-e /.*\\sOt\\s*=.*/d \
-e /.*\\siff\\s*=.*/d \
-e /.*\\sith\\s*=.*/d \
-e /.*\\scas\\s*=.*/d \
-e /.*\\sCAS\\s*=.*/d \
-e /.*\\ssom\\s*=.*/d \
-e /.*\\sSOM\\s*=.*/d \
-e /.*\\suint\\s*=.*/d \
-e /.*\\sUINT\\s*=.*/d \
-e /.*\\scopyable\\s*=.*/d \
-e /.*\\sCopyable\\s*=.*/d \
-e /.*\\sFo\\s*=.*/d \
-e /.*pipeline_filters.h.*nd\\s*=.*/d \
-e /.*ittnotify.h.*unx\\s*=.*/d \
-e /.*bzlib.cpp.*MSDOS\\s*=.*/d \
-e /.*test_task.cpp.*tE\\s*=.*/d \
-e /.*backend.cpp.*resSize\\s*=.*/d \
-e /.*test_join_node.h.*Ned\\s*=.*/d \
-e /.*test_indexer_node.cpp.*OT\\s*=.*/d \
-e /.*allocator_stl_test_common.h.*Aci*\\s*=.*/d \
-e /.*seismic_video.cpp.*DialogBox\\s*=.*/d \
-e /.*test_composite_node.cpp.*que\\s*=.*/d \
-e /.*blocksort.cpp.*hiSt\\s*=.*/d \
-e /.*compress.cpp.*fave\\s*=.*/d \
-e /.*count_strings.cpp.*ue\\s*=.*/d \
-e /.*count_strings.cpp.*nd\\s*=.*/d \
-e /.*count_strings.cpp.*ths\\s*=.*/d \
-e /.*polygon_overlay\/README.md.*ist\\s*=.*/d \
-e /.*_pipeline_filters.h.*nd\\s*=.*/d \
-e /.*sub_string_finder\/README.md.*ba\\s*=.*/d"
SCAN_RESULT=`codespell --quiet-level=2 --skip "${SKIP_PATTERN}" ${SCAN_TARGET}`
SCAN_RESULT=`echo -e "${SCAN_RESULT}" | ${IGNORE_COMMAND}`
echo "${SCAN_RESULT}"
if [[ ! -z ${SCAN_RESULT} ]]; then
exit 1
fi
+338
View File
@@ -0,0 +1,338 @@
# Copyright (c) 2021-2022 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
name: oneTBB CI
on:
push:
branches: [master]
pull_request:
branches: [master]
types:
- opened
- synchronize
- reopened
env:
BUILD_CONCURRENCY: 2
MACOS_BUILD_CONCURRENCY: 3
TEST_TIMEOUT: 180
jobs:
codespell:
runs-on: [ubuntu-20.04]
timeout-minutes: 10
steps:
- uses: actions/checkout@v2
- name: Run scan
run: |
sudo apt update && sudo apt install -y codespell
${GITHUB_WORKSPACE}/.github/scripts/codespell.sh `pwd`
examples_clang-format:
runs-on: [ubuntu-20.04]
timeout-minutes: 10
steps:
- uses: actions/checkout@v2
- name: Run scan
run: |
command -v clang-format-10
cp -r examples examples_formatted
find examples_formatted -regex '.*\.\(cpp\|hpp\)' -exec clang-format-10 -style=file -i {} \;
diff -r examples examples_formatted
documentation:
needs: [codespell]
env:
BUILD_TYPE: oss
runs-on: [ubuntu-20.04]
timeout-minutes: 10
steps:
- uses: actions/checkout@v2
- name: Install prerequisites
run: |
pip3 install -U Jinja2
pip3 install git+https://github.com/executablebooks/sphinx-book-theme.git
echo GITHUB_SHA_SHORT=${GITHUB_SHA::8} >> $GITHUB_ENV
mkdir html
- name: Build documentation
run: |
export BUILD_TYPE=${BUILD_TYPE} && sphinx-build doc html
tar -czvf html.tar.gz html/
- name: Save docs
uses: actions/upload-artifact@v2.2.1
with:
name: oneTBB-html-docs-${{ env.GITHUB_SHA_SHORT }}
path: html.tar.gz
pages:
if: ${{ github.ref == 'refs/heads/master' }}
runs-on: ubuntu-latest
needs: [documentation]
steps:
- name: Checkout gh-pages
uses: actions/checkout@v2
with:
ref: gh-pages
path: gh-pages
- name: Set env
run: echo GITHUB_SHA_SHORT=${GITHUB_SHA::8} >> $GITHUB_ENV
- name: Download documetation
uses: actions/download-artifact@v2
with:
name: oneTBB-html-docs-${{ env.GITHUB_SHA_SHORT }}
- name: Publish to github pages
run: |
tar -xvf html.tar.gz
cd gh-pages
rm -rf *
touch .nojekyll # https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/
cp -r ../html/* .
git config user.name github-actions
git config user.email github-actions@github.com
git add .
git commit --reset-author --amend -m "Update from GitHub Actions"
git push --force origin gh-pages
copyright_check:
if: ${{ github.ref != 'refs/heads/master' }}
runs-on: [ubuntu-20.04]
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Run check
run: |
sed -i \
-e "/Copyright (c) .* Intel Corporation/s/ \([0-9]\+\)[-0-9]*/ \\1-$(date +%Y)/" \
-e "/Copyright (c) .* Intel Corporation/s/$(date +%Y)-$(date +%Y)/$(date +%Y)/" \
$(git diff --diff-filter=d --name-only ${{ github.event.pull_request.base.sha }})
git checkout -- third-party-programs.txt
git diff > years.diff
if [[ -s years.diff ]]; then
echo "Wrong copyright years"
cat years.diff
exit 1
fi
python_module_test_ubuntu18-04:
runs-on: [ubuntu-18.04]
timeout-minutes: 15
steps:
- uses: actions/checkout@v2
- name: Run testing
run: |
mkdir build && cd build
cmake -DTBB4PY_BUILD=ON -DCMAKE_CXX_COMPILER=g++ -DCMAKE_C_COMPILER=gcc ..
make VERBOSE=1 -j${BUILD_CONCURRENCY} python_build
ctest -R python_test --output-on-failure --timeout ${TEST_TIMEOUT}
linux-testing:
name: ${{ matrix.os }}_${{ matrix.cxx_compiler }}_cxx${{ matrix.std }}_${{ matrix.build_type }}_preview=${{ matrix.preview }}
runs-on: ['${{ matrix.os }}']
timeout-minutes: 45
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-18.04
c_compiler: gcc
cxx_compiler: g++
std: 14
build_type: relwithdebinfo
preview: 'OFF'
- os: ubuntu-20.04
c_compiler: gcc
cxx_compiler: g++
std: 17
build_type: release
preview: 'ON'
- os: ubuntu-20.04
c_compiler: gcc-10
cxx_compiler: g++-10
std: 20
build_type: debug
preview: 'ON'
steps:
- uses: actions/checkout@v2
- name: Run testing
shell: bash
run: |
set -x
mkdir build && cd build
cmake -DCMAKE_CXX_STANDARD=${{ matrix.std }} -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
-DCMAKE_CXX_COMPILER=${{ matrix.cxx_compiler }} -DCMAKE_C_COMPILER=${{ matrix.c_compiler }} -DTBB_CPF=${{ matrix.preview }} ..
make VERBOSE=1 -j${BUILD_CONCURRENCY}
ctest --timeout ${TEST_TIMEOUT} --output-on-failure
macos-testing:
name: ${{ matrix.os }}_${{ matrix.cxx_compiler }}_cxx${{ matrix.std }}_${{ matrix.build_type }}_preview=${{ matrix.preview }}
runs-on: ['${{ matrix.os }}']
timeout-minutes: 45
strategy:
fail-fast: false
matrix:
include:
- os: macos-10.15
c_compiler: clang
cxx_compiler: clang++
std: 14
build_type: relwithdebinfo
preview: 'ON'
steps:
- uses: actions/checkout@v2
- name: Run testing
shell: bash
run: |
set -x
mkdir build && cd build
cmake -DCMAKE_CXX_STANDARD=${{ matrix.std }} -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
-DCMAKE_CXX_COMPILER=${{ matrix.cxx_compiler }} -DCMAKE_C_COMPILER=${{ matrix.c_compiler }} -DTBB_CPF=${{ matrix.preview }} ..
make VERBOSE=1 -j${MACOS_BUILD_CONCURRENCY}
ctest --timeout ${TEST_TIMEOUT} --output-on-failure
windows-testing:
name: ${{ matrix.job_name }}
runs-on: ['${{ matrix.os }}']
timeout-minutes: 45
strategy:
fail-fast: false
matrix:
include:
- os: windows-2019
generator: Visual Studio 16 2019
c_compiler: cl
cxx_compiler: cl
std: 14
build_type: relwithdebinfo
preview: 'ON'
job_name: windows_cl2019_cxx14_relwithdebinfo_preview=ON
- os: windows-2022
generator: Visual Studio 17 2022
c_compiler: cl
cxx_compiler: cl
std: 17
build_type: relwithdebinfo
preview: 'OFF'
job_name: windows_cl2022_cxx17_relwithdebinfo_preview=OFF
steps:
- uses: actions/checkout@v2
- name: Run testing
run: |
mkdir build
cd build
cmake -G "${{ matrix.generator }}" -A x64 -DCMAKE_CXX_STANDARD=${{ matrix.std }} `
-DCMAKE_BUILD_TYPE=${{ matrix.build_type }} -DCMAKE_CXX_COMPILER=${{ matrix.cxx_compiler }} `
-DCMAKE_C_COMPILER=${{ matrix.c_compiler }} -DTBB_CPF=${{ matrix.preview }} ..
cmake --build . --config ${{ matrix.build_type }} -j -v
ctest -C ${{ matrix.build_type }} --timeout ${env:TEST_TIMEOUT} --output-on-failure
linux-examples-testing:
name: examples_${{ matrix.os }}_${{ matrix.cxx_compiler }}_cxx${{ matrix.std }}_${{ matrix.build_type }}_preview=${{ matrix.preview }}
runs-on: ['${{ matrix.os }}']
timeout-minutes: 20
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-18.04
c_compiler: gcc
cxx_compiler: g++
std: 14
build_type: relwithdebinfo
preview: 'OFF'
- os: ubuntu-20.04
c_compiler: gcc
cxx_compiler: g++
std: 17
build_type: release
preview: 'ON'
- os: ubuntu-20.04
c_compiler: gcc-10
cxx_compiler: g++-10
std: 20
build_type: debug
preview: 'ON'
steps:
- uses: actions/checkout@v2
- name: Run testing
shell: bash
run: |
set -x
mkdir build && cd build
cmake -DCMAKE_CXX_STANDARD=${{ matrix.std }} -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
-DCMAKE_CXX_COMPILER=${{ matrix.cxx_compiler }} -DCMAKE_C_COMPILER=${{ matrix.c_compiler }} \
-DTBB_CPF=${{ matrix.preview }} -DTBB_TEST=OFF -DTBB_EXAMPLES=ON ..
cmake --build . -v --target light_test_examples
macos-examples-testing:
name: examples_${{ matrix.os }}_${{ matrix.cxx_compiler }}_cxx${{ matrix.std }}_${{ matrix.build_type }}_preview=${{ matrix.preview }}
runs-on: ['${{ matrix.os }}']
timeout-minutes: 20
strategy:
fail-fast: false
matrix:
include:
- os: macos-10.15
c_compiler: clang
cxx_compiler: clang++
std: 14
build_type: relwithdebinfo
preview: 'ON'
steps:
- uses: actions/checkout@v2
- name: Run testing
shell: bash
run: |
set -x
mkdir build && cd build
cmake -DCMAKE_CXX_STANDARD=${{ matrix.std }} -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
-DCMAKE_CXX_COMPILER=${{ matrix.cxx_compiler }} -DCMAKE_C_COMPILER=${{ matrix.c_compiler }} \
-DTBB_CPF=${{ matrix.preview }} -DTBB_TEST=OFF -DTBB_EXAMPLES=ON ..
cmake --build . -v --target light_test_examples
windows-examples-testing:
name: ${{ matrix.job_name }}
runs-on: ['${{ matrix.os }}']
timeout-minutes: 20
strategy:
fail-fast: false
matrix:
include:
- os: windows-2019
generator: Visual Studio 16 2019
c_compiler: cl
cxx_compiler: cl
std: 14
build_type: relwithdebinfo
preview: 'ON'
job_name: examples_windows_cl2019_cxx14_relwithdebinfo_preview=ON
- os: windows-2022
generator: Visual Studio 17 2022
c_compiler: cl
cxx_compiler: cl
std: 17
build_type: relwithdebinfo
preview: 'OFF'
job_name: examples_windows_cl2022_cxx17_relwithdebinfo_preview=OFF
steps:
- uses: actions/checkout@v2
- name: Run testing
run: |
mkdir build
cd build
cmake -G "${{ matrix.generator }}" -A x64 -DCMAKE_CXX_STANDARD=${{ matrix.std }} `
-DCMAKE_BUILD_TYPE=${{ matrix.build_type }} -DCMAKE_CXX_COMPILER=${{ matrix.cxx_compiler }} `
-DCMAKE_C_COMPILER=${{ matrix.c_compiler }} -DTBB_CPF=${{ matrix.preview }} -DTBB_TEST=OFF -DTBB_EXAMPLES=ON ..
cmake --build . -v --target light_test_examples
+118
View File
@@ -0,0 +1,118 @@
# Copyright (c) 2021-2022 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# DISCLAIMER: Bazel support is community-based. The maintainers do not
# use Bazel internally. The Bazel build can have security risks or
# optimization gaps.
package(
default_visibility = ["//visibility:public"],
)
cc_library(
name = "tbb",
srcs = glob([
"src/tbb/*.cpp",
"src/tbb/*.h",
]) + select({
"@platforms//cpu:x86_64": glob(["src/tbb/tools_api/**/*.h"]),
"//conditions:default": [],
}),
hdrs = glob([
"include/tbb/*.h",
"include/oneapi/*.h",
"include/oneapi/tbb/*.h",
"include/oneapi/tbb/detail/*.h",
]),
copts = ["-w"] + select({
"@bazel_tools//platforms:windows": [""],
"//conditions:default": ["-mwaitpkg"],
}),
defines =
select({
"@platforms//cpu:x86_64": ["__TBB_NO_IMPLICIT_LINKAGE"],
"//conditions:default": [
"USE_PTHREAD",
],
}) +
select({
"@bazel_tools//platforms:osx": ["_XOPEN_SOURCE"],
"//conditions:default": [],
}),
includes = [
"include",
],
linkopts =
select({
"@bazel_tools//platforms:windows": [],
"@bazel_tools//platforms:linux": [
"-ldl",
"-pthread",
"-lrt",
],
"//conditions:default": ["-pthread"],
}),
local_defines = select({
"@platforms//cpu:x86_64": [
"__TBB_USE_ITT_NOTIFY",
],
"//conditions:default": [],
}) + [
"__TBB_BUILD",
],
textual_hdrs = select({
"@platforms//cpu:x86_64": [
"src/tbb/tools_api/ittnotify_static.c",
],
"//conditions:default": [],
}),
)
cc_library(
name = "tbbmalloc",
srcs =
glob([
"src/tbbmalloc/*.h",
"src/tbb/*.h",
"src/tbbmalloc_proxy/*.h",
]) + [
"src/tbbmalloc/backend.cpp",
"src/tbbmalloc/backref.cpp",
"src/tbbmalloc/frontend.cpp",
"src/tbbmalloc/large_objects.cpp",
"src/tbbmalloc/tbbmalloc.cpp",
],
hdrs = glob([
"include/tbb/*.h",
"include/oneapi/tbb/detail/*.h",
"include/oneapi/tbb/*.h",
]),
includes = [
"include",
],
local_defines = [
"__TBBMALLOC_BUILD",
],
)
cc_library(
name = "tbbmalloc_proxy",
srcs = [
"src/tbbmalloc_proxy/function_replacement.cpp",
"src/tbbmalloc_proxy/proxy.cpp",
],
deps = [
":tbbmalloc",
],
)
+96
View File
@@ -0,0 +1,96 @@
# Bazel* build support
The main build system of oneTBB is CMake*.
[Bazel*](https://bazel.build/) support is community-based.
The Bazel configuration may not include recommended compiler and/or linker flags used in the official CMake configuration.
---
**NOTE**
Bazel is not recommended for use by oneTBB maintainers. Thus, it is not used internally.
---
The Bazel oneTBB build is currently only intended for a subset of oneTBB that suffices restricted use cases.
Pull requests to improve the Bazel build experience are welcome.
The standard Bazel approach to handling third-party libraries is static linking. It is the best practice within the Bazel ecosystem.
## Using oneTBB as a dependency
This example demonstrates how to use oneTBB as a dependency within a Bazel project.
The following file structure is assumed:
```
example
├── .bazelrc
├── BUILD.bazel
├── main.cpp
└── WORKSPACE.bazel
```
_WORKSPACE.bazel_:
```python
load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
git_repository(
name = "oneTBB",
branch = "master",
remote = "https://github.com/oneapi-src/oneTBB/",
)
```
In the *WORKSPACE* file, the oneTBB GitHub* repository is fetched.
_BUILD.bazel_:
```python
cc_binary(
name = "Demo",
srcs = ["main.cpp"],
deps = ["@oneTBB//:tbb"],
)
```
The *BUILD* file defines a binary named `Demo` that has a dependency to oneTBB.
_main.cpp_:
```c++
#include "oneapi/tbb/version.h"
#include <iostream>
int main() {
std::cout << "Hello from oneTBB "
<< TBB_VERSION_MAJOR << "."
<< TBB_VERSION_MINOR << "."
<< TBB_VERSION_PATCH
<< "!" << std::endl;
return 0;
}
```
The expected output of this program is the current version of oneTBB.
Switch to the folder with the files created earlier and run the binary with `bazel run //:Demo`.
## Build oneTBB using Bazel
Run ```bazel build //...``` in the oneTBB root directory.
## Compiler support
The Bazel build uses the compiler flag `-mwaitpkg` in non-Windows* builds.
This flag is supported by the GNU* Compiler Collection (GCC) version 9.3, Clang* 12, and newer versions of those tools.
---
**NOTE**
To use the Bazel build with earlier versions of GCC, remove `-mwaitpkg` flag as it leads to errors during compilation.
---
+36 -7
View File
@@ -1,4 +1,4 @@
# Copyright (c) 2020-2021 Intel Corporation
# Copyright (c) 2020-2022 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -60,6 +60,7 @@ unset(_tbb_ver_minor)
include(CheckCXXCompilerFlag)
include(GNUInstallDirs)
include(CMakeDependentOption)
# ---------------------------------------------------------------------------------------------------------
# Handle C++ standard version.
@@ -98,14 +99,20 @@ option(TBB_STRICT "Treat compiler warnings as errors" ON)
option(TBB_WINDOWS_DRIVER "Build as Universal Windows Driver (UWD)" OFF)
option(TBB_NO_APPCONTAINER "Apply /APPCONTAINER:NO (for testing binaries for Windows Store)" OFF)
option(TBB4PY_BUILD "Enable tbb4py build" OFF)
option(TBB_BUILD "Enable tbb build" ON)
option(TBBMALLOC_BUILD "Enable tbbmalloc build" ON)
cmake_dependent_option(TBBMALLOC_PROXY_BUILD "Enable tbbmalloc_proxy build" ON "TBBMALLOC_BUILD" OFF)
option(TBB_CPF "Enable preview features of the library" OFF)
option(TBB_FIND_PACKAGE "Enable search for external oneTBB using find_package instead of build from sources" OFF)
option(TBB_DISABLE_HWLOC_AUTOMATIC_SEARCH "Disable HWLOC automatic search by pkg-config tool" OFF)
option(TBB_ENABLE_IPO "Enable Interprocedural Optimization (IPO) during the compilation" ON)
if (NOT DEFINED BUILD_SHARED_LIBS)
set(BUILD_SHARED_LIBS ON)
endif()
if (NOT BUILD_SHARED_LIBS)
set(CMAKE_POSITION_INDEPENDENT_CODE ON)
message(WARNING "You are building oneTBB as a static library. This is highly discouraged and such configuration is not supported. Consider building a dynamic library to avoid unforeseen issues.")
endif()
@@ -177,6 +184,22 @@ foreach(FILE_WITH_EXTRA_TARGETS ${FILES_WITH_EXTRA_TARGETS})
include(${FILE_WITH_EXTRA_TARGETS})
endforeach()
# - Enabling LTO on Android causes the NDK bug.
# NDK throws the warning: "argument unused during compilation: '-Wa,--noexecstack'"
# - For some reason GCC does not instrument code with Thread Sanitizer when lto is enabled and C linker is used.
if (TBB_ENABLE_IPO AND BUILD_SHARED_LIBS AND NOT ANDROID_PLATFORM AND NOT TBB_SANITIZE MATCHES "thread")
if (NOT CMAKE_VERSION VERSION_LESS 3.9)
cmake_policy(SET CMP0069 NEW)
include(CheckIPOSupported)
check_ipo_supported(RESULT TBB_IPO_PROPERTY)
else()
set(TBB_IPO_FLAGS TRUE)
endif()
if (TBB_IPO_PROPERTY OR TBB_IPO_FLAGS)
message(STATUS "IPO enabled")
endif()
endif()
set(TBB_COMPILER_SETTINGS_FILE ${CMAKE_CURRENT_SOURCE_DIR}/cmake/compilers/${CMAKE_CXX_COMPILER_ID}.cmake)
if (EXISTS ${TBB_COMPILER_SETTINGS_FILE})
include(${TBB_COMPILER_SETTINGS_FILE})
@@ -190,12 +213,18 @@ if (TBB_FIND_PACKAGE OR TBB_DIR)
message(STATUS "Using external TBB for testing")
find_package(TBB REQUIRED)
else()
add_subdirectory(src/tbb)
if (TBB_BUILD)
add_subdirectory(src/tbb)
endif()
if (NOT "${CMAKE_SYSTEM_PROCESSOR}" MATCHES "mips")
add_subdirectory(src/tbbmalloc)
add_subdirectory(src/tbbmalloc_proxy)
if (APPLE)
message(STATUS "TBBBind build target is disabled due to unsupported environment")
if (TBBMALLOC_BUILD)
add_subdirectory(src/tbbmalloc)
if(TBBMALLOC_PROXY_BUILD AND NOT "${MSVC_CXX_ARCHITECTURE_ID}" MATCHES "ARM64")
add_subdirectory(src/tbbmalloc_proxy)
endif()
endif()
if (APPLE OR NOT BUILD_SHARED_LIBS)
message(STATUS "TBBBind build targets are disabled due to unsupported environment")
else()
add_subdirectory(src/tbbbind)
endif()
@@ -249,7 +278,7 @@ if (TBB_BENCH)
endif()
if (ANDROID_PLATFORM)
if (${ANDROID_STL} STREQUAL "c++_shared")
if ("${ANDROID_STL}" STREQUAL "c++_shared")
configure_file(
"${ANDROID_NDK}/sources/cxx-stl/llvm-libc++/libs/${ANDROID_ABI}/libc++_shared.so"
"${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/libc++_shared.so"
+58
View File
@@ -0,0 +1,58 @@
<!--
******************************************************************************
* 
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/-->
# How to Contribute
As an open source project, we welcome community contributions to oneAPI Threading Building Blocks (oneTBB). This document explains how to participate in project conversations, log bugs and enhancement requests, and submit code patches to the project.
## Licensing
Licensing is very important to open source projects. It helps ensure the software continues to be available under the terms that the author desired. The oneTBB project uses the [Apache 2.0 License](https://github.com/oneapi-src/oneTBB/blob/master/LICENSE.txt), a permissive open source license that allows you to freely use, modify, and distribute your own products that include Apache 2.0 licensed software. By contributing to the oneTBB project, you agree to the license and copyright terms therein and release your own contributions under these terms.
Some imported or reused components within oneTBB use other licenses, as described in [third-party-programs.txt](https://github.com/oneapi-src/oneTBB/blob/master/third-party-programs.txt). By carefully reviewing potential contributions and enforcing a [Developer Certification of Origin (DCO)](https://developercertificate.org/) for contributed code, we can ensure that the community can develop products with oneTBB without concerns over patent or copyright issues.
The DCO is an attestation attached to every contribution made by every developer. In the commit message of the contribution, (described later), the developer simply adds a Signed-off-by statement and thereby agrees to the DCO.
## Prerequisites
As a contributor, you’ll want to be familiar with the oneTBB project and the repository layout. You should also know how to use it as explained in the [oneTBB documentation](https://oneapi-src.github.io/oneTBB/) and how to set up your build development environment to configure, build, and test oneTBB as explained in the [oneTBB Build System Description](cmake/README.md).
## Issues
If you face a problem, first check out open [oneTBB GitHub issues](https://github.com/oneapi-src/oneTBB/issues) to see if the issue you’d like to address is already reported. You may find users that have encountered the bug you’re finding or have similar ideas for changes or additions.
You can use issues to report a problem, make a feature request, or add comments on an existing issue.
## Pull Requests
You can find all [open oneTBB pull requests](https://github.com/oneapi-src/oneTBB/pulls) on GitHub.
No anonymous contributions are accepted. The name in the commit message Signed-off-by line and your email must match the change authorship information. Make sure your .gitconfig is set up correctly so you can use `git commit -s` for signing your patches:
`git config --global user.name "Taylor Developer"`
`git config --global user.email taylor.developer@company.com`
### Before contributing changes directly to the oneTBB repository
* Make sure you can build the product and run all the tests with your patch.
* For a larger feature, provide a relevant test.
* Document your code. The oneTBB project uses reStructuredText for documentation.
* Update the copyright year in the first line of the changing file(s).
For example, if you commit your changes in 2022:
* the copyright year should be `2005-2022` for existing files
* the copyright year should be `2022` for new files
* Submit a pull request into the master branch. You can submit changes with a pull request (preferred) or by sending an email patch.
Continuous Integration (CI) testing is enabled for the repository. Your pull request must pass all checks before it can be merged. We will review your contribution and may provide feedback to guide you if any additional fixes or modifications are necessary. When reviewed and accepted, your pull request will be merged into our GitHub repository.
+122
View File
@@ -0,0 +1,122 @@
# Installation from Sources
## Prerequisites
- Make sure you have installed CMake version 3.1 (or newer) on your system. oneTBB uses CMake build configuration.
- Configure and build oneTBB. To work with build configurations, see [Build System Description](cmake/README.md).
## Configure oneTBB
At the command prompt, type:
```
cmake <options> <repo_root>
```
You may want to use some additional options for configuration:
| Option | Purpose | Description |
| ------ |------ | ------ |
| `-G <generator>` | Specify project generator | For more information, run cmake `–help`. |
|`-DCMAKE_BUILD_TYPE=Debug` | Specify for Debug build | Not applicable for multi-configuration generators such as Visual Studio generator. |
## Build oneTBB
To build the system, run:
```
cmake --build . <options>
```
Some useful build options:
- `--target <target>` - specific target, "all" is default.
- `--config <Release|Debug>` - build configuration, applicable only for multi-config generators such as Visual Studio generator.
## Install and Pack oneTBB
---
**NOTE**
Be careful about installing prefix. It defaults to `/usr/local` on UNIX* and `c:/Program Files/${PROJECT_NAME}` on Windows* OS.
You can define custom `CMAKE_INSTALL_PREFIX` during configuration:
```
cmake -DCMAKE_INSTALL_PREFIX=/my/install/prefix ..
```
---
Installation can also be done using:
```
cmake --install <project-binary-dir>
```
Special ``--install`` target can alternatively be used for installation, e.g. ``make install``.
You can use the ``install`` components for partial installation.
The following install components are supported:
- `runtime` - oneTBB runtime package (core shared libraries and `.dll` files on Windows* OS).
- `devel` - oneTBB development package (header files, CMake integration files, library symbolic links, and `.lib` files on Windows* OS).
- `tbb4py` - [oneTBB Module for Python](#onetbb-python-module-support).
If you want to install specific components after configuration and build, run:
```bash
cmake -DCOMPONENT=<component> [-DBUILD_TYPE=<build-type>] -P cmake_install.cmake
```
Simple packaging using CPack is supported.
The following commands allow you to create a simple portable package that includes header files, libraries, and integration files for CMake:
```bash
cmake <options> ..
cpack
```
## Example of Installation
### Single-configuration generators
The following example demonstrates how to install oneTBB for single-configuration generators (e.g. GNU Make, Ninja, etc.).
```bash
# Do our experiments in /tmp
cd /tmp
# Clone oneTBB repository
git clone https://github.com/oneapi-src/oneTBB.git
cd oneTBB
# Create binary directory for out-of-source build
mkdir build && cd build
# Configure: customize CMAKE_INSTALL_PREFIX and disable TBB_TEST to avoid tests build
cmake -DCMAKE_INSTALL_PREFIX=/tmp/my_installed_onetbb -DTBB_TEST=OFF ..
# Build
cmake --build .
# Install
cmake --install .
# Well done! Your installed oneTBB is in /tmp/my_installed_onetbb
```
### Multi-configuration generators
The following example demonstrates how to install oneTBB for multi-configuration generators such as Visual Studio*.
Choose the configuration during the build and install steps:
```batch
REM Do our experiments in %TMP%
cd %TMP%
REM Clone oneTBB repository
git clone https://github.com/oneapi-src/oneTBB.git
cd oneTBB
REM Create binary directory for out-of-source build
mkdir build && cd build
REM Configure: customize CMAKE_INSTALL_PREFIX and disable TBB_TEST to avoid tests build
cmake -DCMAKE_INSTALL_PREFIX=%TMP%\my_installed_onetbb -DTBB_TEST=OFF ..
REM Build "release with debug information" configuration
cmake --build . --config relwithdebinfo
REM Install "release with debug information" configuration
cmake --install . --config relwithdebinfo
REM Well done! Your installed oneTBB is in %TMP%\my_installed_onetbb
```
+35 -30
View File
@@ -1,49 +1,54 @@
# oneAPI Threading Building Blocks
[![Apache License Version 2.0](https://img.shields.io/badge/license-Apache_2.0-green.svg)](LICENSE.txt)
[![Apache License Version 2.0](https://img.shields.io/badge/license-Apache_2.0-green.svg)](LICENSE.txt) [![oneTBB CI](https://github.com/oneapi-src/oneTBB/actions/workflows/ci.yml/badge.svg)](https://github.com/oneapi-src/oneTBB/actions/workflows/ci.yml?query=branch%3Amaster)
oneAPI Threading Building Blocks (oneTBB) lets you easily write parallel C++ programs that take
full advantage of multicore performance, that are portable, composable and have future-proof scalability.
oneTBB is a flexible C++ library that simplifies the work of adding parallelism
to complex applications, even if you are not a threading expert.
The library lets you easily write parallel programs that take full advantage of the multi-core performance. Such programs are portable,
composable and have a future-proof scalability. oneTBB provides you with functions, interfaces, and classes to parallelize and scale the code.
All you have to do is to use the templates.
The library differs from typical threading packages in the following ways:
* oneTBB enables you to specify logical parallelism instead of threads.
* oneTBB targets threading for performance.
* oneTBB is compatible with other threading packages.
* oneTBB emphasizes scalable, data parallel programming.
* oneTBB relies on generic programming.
Refer to oneTBB [examples](examples) and [samples](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneTBB) to see how you can use the library.
oneTBB is a part of [oneAPI](https://oneapi.io). The current branch implements version 1.1 of oneAPI Specification.
## Release Information
Here are [Release Notes]( https://software.intel.com/en-us/articles/intel-oneapi-threading-building-blocks-release-notes) and
[System Requirements](https://software.intel.com/en-us/articles/intel-oneapi-threading-building-blocks-system-requirements).
Here are [Release Notes](RELEASE_NOTES.md) and [System Requirements](SYSTEM_REQUIREMENTS.md).
## Documentation
* [oneTBB documentation](https://software.intel.com/en-us/oneapi-tbb-documentation)
* README for build system: [cmake/README.md](cmake/README.md)
* [oneTBB Specification](https://spec.oneapi.com/versions/latest/elements/oneTBB/source/nested-index.html)
* [oneTBB Developer Guide and Reference](https://oneapi-src.github.io/oneTBB)
* [Migrating from TBB to oneTBB](https://oneapi-src.github.io/oneTBB/main/tbb_userguide/Migration_Guide.html)
* [README for the CMake build system](cmake/README.md)
* [oneTBB Testing Approach](https://oneapi-src.github.io/oneTBB/main/intro/testing_approach.html)
* [Basic support for the Bazel build system](Bazel.md)
* [oneTBB Discussions](https://github.com/oneapi-src/oneTBB/discussions)
## Installation
See [Installation from Sources](INSTALL.md) to learn how to install oneTBB.
## Support
Please report issues and suggestions via
[GitHub issues](https://github.com/oneapi-src/oneTBB/issues) or start a topic on the
[oneTBB forum](https://community.intel.com/t5/Intel-oneAPI-Threading-Building/bd-p/oneapi-threading-building-blocks).
Please report issues and suggestions via [GitHub issues](https://github.com/oneapi-src/oneTBB/issues). See our [documentation](./CONTRIBUTING.md##Issues) to learn how to work with them.
## How to Contribute
To contribute to oneTBB, please open a GitHub pull request (preferred) or send us a patch by e-mail.
Please use the sign-off line at the end of the patch.
Your signature certifies that you wrote the patch or
otherwise have the right to pass it on as an open-source patch.
The rules are pretty simple:
if you can certify the https://developercertificate.org then you just add a line to every git commit message:
```
Signed-off-by: Name Surname <user@email.com>
```
Use your real name (sorry, no pseudonyms or anonymous contributions).
If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`.
We welcome community contributions, so check our [Contributing Guidelines](CONTRIBUTING.md)
to learn more.
## License
oneAPI Threading Building Blocks is licensed under [Apache License, Version 2.0](LICENSE.txt).
By its terms, contributions submitted to the project are also done under that license.
## Security
To report security issues please go to https://intel.com/security.
## Engineering team contacts
* [E-mail us.](mailto:inteltbbdevelopers@intel.com)
* [Email us.](mailto:inteltbbdevelopers@intel.com)
------------------------------------------------------------------------
Intel and the Intel logo are trademarks of Intel Corporation or its subsidiaries in the U.S. and/or other countries.
\* Other names and brands may be claimed as the property of others.
\* All names and brands may be claimed as the property of others.
+53
View File
@@ -0,0 +1,53 @@
<!--
******************************************************************************
* 
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/-->
# Release Notes <!-- omit in toc -->
This document contains changes of oneTBB compared to the last release.
## Table of Contents <!-- omit in toc -->
- [New Features](#new_features)
- [Known Limitations](#known-limitations)
- [Fixed Issues](#fixed-issues)
- [Open-source Contributions Integrated](#open-source-contributions-integrated)
## :white_check_mark: New Features
- Improved support and use of the latest C++ standards for parallel_sort that allows using this algorithm with user-defined and standard library-defined objects with modern semantics.
- The following features are now fully functional: task_arena extensions, collaborative_call_once, adaptive mutexes, heterogeneous overloads for concurrent_hash_map, and task_scheduler_handle.
- Added support for Windows* Server 2022 and Python 3.10.
## :rotating_light: Known Limitations
- An application using Parallel STL algorithms in libstdc++ versions 9 and 10 may fail to compile due to incompatible interface changes between earlier versions of Threading Building Blocks (TBB) and oneAPI Threading Building Blocks (oneTBB). Disable support for Parallel STL algorithms by defining PSTL_USE_PARALLEL_POLICIES (in libstdc++ 9) or _GLIBCXX_USE_TBB_PAR_BACKEND (in libstdc++ 10) macro to zero before inclusion of the first standard header file in each translation unit.
- On Linux* OS, if oneAPI Threading Building Blocks (oneTBB) or Threading Building Blocks (TBB) are installed in a system folder like /usr/lib64, the application may fail to link due to the order in which the linker searches for libraries. Use the -L linker option to specify the correct location of oneTBB library. This issue does not affect the program execution.
- The oneapi::tbb::info namespace interfaces might unexpectedly change the process affinity mask on Windows* OS systems (see https://github.com/open-mpi/hwloc/issues/366 for details) when using hwloc version lower than 2.5.
- Using a hwloc version other than 1.11, 2.0, or 2.5 may cause an undefined behavior on Windows OS. See https://github.com/open-mpi/hwloc/issues/477 for details.
- The NUMA topology may be detected incorrectly on Windows OS machines where the number of NUMA node threads exceeds the size of 1 processor group.
- On Windows OS on ARM64*, when compiling an application using oneTBB with the Microsoft* Compiler, the compiler issues a warning C4324 that a structure was padded due to the alignment specifier. Consider suppressing the warning by specifying /wd4324 to the compiler command line.
- oneTBB does not support fork(), to work-around the issue, consider using task_scheduler_handle to join oneTBB worker threads before using fork().
- C++ exception handling mechanism on Windows* OS on ARM64* might corrupt memory if an exception is thrown from any oneTBB parallel algorithm (see Windows* OS on ARM64* compiler issue: https://developercommunity.visualstudio.com/t/ARM64-incorrect-stack-unwinding-for-alig/1544293).
## :hammer: Fixed Issues
- Memory allocator crash on a system with an incomplete /proc/meminfo (GitHub* [#584](https://github.com/oneapi-src/oneTBB/issues/584)).
- Incorrect blocking of task stealing (GitHub* #[478](https://github.com/oneapi-src/oneTBB/issues/478)).
- Hang due to incorrect decrement of a limiter_node (GitHub* [#634](https://github.com/oneapi-src/oneTBB/issues/634)).
- Memory corruption in some rare cases when passing big messages in a flow graph (GitHub* [#639](https://github.com/oneapi-src/oneTBB/issues/639)).
- Possible deadlock in a throwable flow graph node with a lightweight policy. The lightweight policy is now ignored for functors that can throw exceptions (GitHub* [#420](https://github.com/oneapi-src/oneTBB/issues/420)).
- Crash when obtaining a range from empty ordered and unordered containers (GitHub* [#641](https://github.com/oneapi-src/oneTBB/issues/641)).
- Deadlock in a concurrent_vector resize() that could happen when the new size is less than the previous size (GitHub* [#733](https://github.com/oneapi-src/oneTBB/issues/733)).
## :octocat: Open-source Contributions Integrated
- Improved aligned memory allocation. Contributed by Andrey Semashev (https://github.com/oneapi-src/oneTBB/pull/671).
- Optimized usage of atomic_fence on IA-32 and Intel(R) 64 architectures. Contributed by Andrey Semashev (https://github.com/oneapi-src/oneTBB/pull/328).
- Fixed incorrect definition of the assignment operator in containers. Contributed by Andrey Semashev (https://github.com/oneapi-src/oneTBB/issues/372).
+65
View File
@@ -0,0 +1,65 @@
<!--
******************************************************************************
* 
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/-->
# System Requirements <!-- omit in toc -->
This document provides details about hardware, operating system, and software prerequisites for the oneAPI Threading Building Blocks (oneTBB).
## Table of Contents <!-- omit in toc -->
- [Supported Hardware](#supported-hardware)
- [Software](#software)
- [Supported Operating Systems](#supported-operating-systems)
- [Supported Compilers](#supported-compilers)
## Supported Hardware
- Intel(R) Celeron(R) processor family
- Intel(R) Core* processor family
- Intel(R) Xeon(R) processor family
- Intel(R) Xeon Phi* processor family
- Intel(R) Atom* processor family
- Non-Intel(R) processors compatible with the processors listed above
## Software
### Supported Operating Systems
- Systems with Microsoft* Windows* operating systems
- Microsoft* Windows* 10
- Microsoft* Windows* Server 2016
- Microsoft* Windows* Server 2019
- Systems with Linux* operating systems
- Clear Linux*
- Amazon* Linux 2
- CentOS* 8
- Debian* 10
- Fedora* 34
- Red Hat* Enterprise Linux* 7, 8
- SuSE* Linux* Enterprise Server 15
- Ubuntu* 18.04 LTS, 20.04, 21.04
- Systems with macOS* operating systems
- macOS* 10.15, 11.x
- Systems with Android* operating systems
- Android* 9
### Supported Compilers
- Intel* oneAPI DPC++/C++ Compiler
- Intel* C++ Compiler 19.0 and 19.1 version
- Microsoft* Visual C++ 14.1 (Microsoft* Visual Studio* 2017, Windows* OS only)
- Microsoft* Visual C++ 14.2 (Microsoft* Visual Studio* 2019, Windows* OS only)
- For each supported Linux* operating system, the standard gcc version provided with that operating system is supported
- GNU Compilers (gcc) 4.8.5 - 11.1.1
- GNU C Library (glibc) version 2.17 - 2.33
- Clang* 6.0.0 - 12.0.0
+19
View File
@@ -0,0 +1,19 @@
# Copyright (c) 2021 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# DISCLAIMER: Bazel support is community-based. The maintainers do not
# use Bazel internally. The Bazel build can have security risks or
# optimization gaps.
workspace(name = "oneTBB")
+79 -58
View File
@@ -9,21 +9,22 @@ TBB_STRICT:BOOL - Treat compiler warnings as errors (ON by default)
TBB_SANITIZE:STRING - Sanitizer parameter, passed to compiler/linker
TBB_SIGNTOOL:FILEPATH - Tool for digital signing, used in post install step for libraries if provided.
TBB_SIGNTOOL_ARGS:STRING - Additional arguments for TBB_SIGNTOOL, used if TBB_SIGNTOOL is set.
TBB4PY_BUILD:BOOL - Enable Intel(R) oneAPI Threading Building Blocks (oneTBB) Python module build (OFF by default)
TBB_BUILD:BOOL - Enable Intel(R) oneAPI Threading Building Blocks (oneTBB) build (ON by default)
TBBMALLOC_BUILD:BOOL - Enable Intel(R) oneAPI Threading Building Blocks (oneTBB) memory allocator build (ON by default)
TBBMALLOC_PROXY_BUILD:BOOL - Enable Intel(R) oneAPI Threading Building Blocks (oneTBB) memory allocator proxy build (requires TBBMALLOC_BUILD. ON by default)
TBB4PY_BUILD:BOOL - Enable Intel(R) oneAPI Threading Building Blocks (oneTBB) Python module build (OFF by default)
TBB_CPF:BOOL - Enable preview features of the library (OFF by default)
TBB_INSTALL_VARS:BOOL - Enable auto-generated vars installation(packages generated by `cpack` and `make install` will also include the vars script)(OFF by default)
TBB_VALGRIND_MEMCHECK:BOOL - Enable scan for memory leaks using Valgrind (OFF by default)
TBB_DISABLE_HWLOC_AUTOMATIC_SEARCH - Disable HWLOC automatic search by pkg-config tool (OFF by default)
TBB_ENABLE_IPO - Enable Interprocedural Optimization (IPO) during the compilation (ON by default)
```
## Configure, build and test
### Prerequisites
* CMake >= 3.1
## Configure, build, and test
### Preparation
In order to perform out-of-source build you have to create a build directory and go there:
To perform out-of-source build, create a build directory and go there:
```bash
mkdir /tmp/my-build
@@ -37,22 +38,45 @@ cmake <options> <repo_root>
```
Some useful options:
- `-G <generator>` - specify particular project generator, see `cmake --help` for details.
- `-DCMAKE_BUILD_TYPE=Debug` - specify for Debug build, it doesn't applicable for multi-config generators, e.g. for Visual Studio generator).
- `-G <generator>` - specify particular project generator. See `cmake --help` for details.
- `-DCMAKE_BUILD_TYPE=Debug` - specify for Debug build. It is not applicable for multiconfig generators, e.g. for Visual Studio* generator.
#### TBBBind library configuration
The TBBbind library has two versions: `tbbbind` and `tbbbind_2_0`. Each of these versions is linked with corresponding HWLOC library version: `tbbbind` links with HWLOC 1.11.x , `tbbbind_2_0` links with HWLOC 2.x.
The TBBbind library has three versions: `tbbbind`, `tbbbind_2_0`, and `tbbbind_2_5`. Each of these versions is linked with corresponding HWLOC library version:
- `tbbbind` links with HWLOC 1.11.x
- `tbbbind_2_0` links with HWLOC 2.1–2.4
- `tbbbind_2_5` links with HWLOC 2.5 and later
To enable the TBBBind library build or special tests that performed inside the HWLOC environment, please specify the following CMake variables:
The search for a suitable version of the HWLOC library is enabled by default. If you want to use a specific version of the library, you can specify the path to it manually using the following CMake variables:
- `CMAKE_HWLOC_<HWLOC_VER>_LIBRARY_PATH` - path to the corresponding HWLOC version shared library on Linux or path to `.lib` file on Windows.
- `CMAKE_HWLOC_<HWLOC_VER>_INCLUDE_PATH` - path to the corresponding HWLOC version includes directory.
- `CMAKE_HWLOC_<HWLOC_VER>_LIBRARY_PATH` - path to the corresponding HWLOC version shared library on Linux* OS or path to `.lib` file on Windows* OS
- `CMAKE_HWLOC_<HWLOC_VER>_INCLUDE_PATH` - path to the corresponding HWLOC version including directory
Windows requires one additional variable for correct TBBBind library building:
---
**NOTE:** Automatic HWLOC searching requires CMake version 3.6 or higher.
---
Windows* OS requires an additional variable for correct TBBBind library building:
- `CMAKE_HWLOC_<HWLOC_VER>_DLL_PATH` - path to the corresponding HWLOC version `.dll` file.
`HWLOC_VER` variable used above can be replaced with one of the two values: `1_11` for the `tbbbind` library configuration and `2` for the `tbbbind_2_0` library configuration.
`HWLOC_VER` substring used earlier can be replaced with one of the three values:
- `1_11` for the `tbbbind` library configuration
- `2` for the `tbbbind_2_0` library configuration
- `2_5` for the `tbbbind_2_5` library configuration
If you specify variables for several TBBBind versions, the building process for all of these versions is performed during single build session.
---
**TIP**
Specify the `TBB_DISABLE_HWLOC_AUTOMATIC_SEARCH` to disable HWLOC libraries automatic search.
---
### Build
@@ -62,20 +86,27 @@ cmake --build . <options>
Some useful options:
- `--target <target>` - specific target, "all" is default.
- `--config <Release|Debug>` - build configuration, applicable only for multi-config generators, e.g. Visual Studio generator.
- `--config <Release|Debug>` - build configuration, applicable only for multiconfig generators, e.g. Visual Studio* generator.
Binaries are placed to `./<compiler-id>_<compiler-ver>_cxx<stdver>_<build-type>` (for example, `./gnu_4.8_cxx11_release`)
The binaries are placed to `./<compiler-id>_<compiler-ver>_cxx<stdver>_<build-type>`. For example, `./gnu_4.8_cxx11_release`.
#### Build for 32-bit
* Intel Compiler: just source Intel(R) C++ Compiler with `ia32` and build as usual.
* MSVC: use switch for [generator](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html) (e.g. `-A Win32` for [VS2019](https://cmake.org/cmake/help/latest/generator/Visual%20Studio%2016%202019.html)) during the configuration stage and then build as usual.
* GCC/Clang: specify `-m32` during the configuration: `CXXFLAGS=-m32 cmake ..` or `cmake -DCMAKE_CXX_FLAGS=-m32 ..`
* Any other compiler which builds for 64-bit by default: specify 32-bit compiler key during the configuration as above.
* **Intel(R) Compiler**. Source Intel(R) C++ Compiler with `ia32` and build as usual.
* **MSVC**. Use switch for [generator](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html) (e.g. `-A Win32` for [VS2019](https://cmake.org/cmake/help/latest/generator/Visual%20Studio%2016%202019.html)) during the configuration stage and then build as usual.
* **GCC/Clang**. Specify `-m32` during the configuration. It can be `CXXFLAGS=-m32 cmake ..` or `cmake -DCMAKE_CXX_FLAGS=-m32 ..`
* For any other compiler, which builds for 64-bit by default, specify 32-bit compiler key during the configuration as above.
#### Windows specific builds (CMake 3.15 or newer is required)
#### Windows* OS specific builds
* Dynamic linkage with CRT: default behavior, can be explicitly specified by setting `CMAKE_MSVC_RUNTIME_LIBRARY` to `MultiThreadedDLL` or `MultiThreadedDebugDLL`.
---
**NOTE**
Following builds require CMake version 3.15 or higher.
---
* **Dynamic linkage with C Runtime Library (CRT)**. The default behavior can be explicitly specified by setting `CMAKE_MSVC_RUNTIME_LIBRARY` to `MultiThreadedDLL` or `MultiThreadedDebugDLL`.
```bash
cmake .. # dynamic linkage is used by default
```
@@ -85,20 +116,27 @@ cmake -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL ..
```bash
cmake -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDebugDLL -DCMAKE_BUILD_TYPE=Debug ..
```
* Static linkage with CRT: set `CMAKE_MSVC_RUNTIME_LIBRARY` to `MultiThreaded` or `MultiThreadedDebug`.
* **Static linkage with CRT**. Set `CMAKE_MSVC_RUNTIME_LIBRARY` to `MultiThreaded` or `MultiThreadedDebug`.
```bash
cmake -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded ..
```
```bash
cmake -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDebug -DCMAKE_BUILD_TYPE=Debug ..
```
* Windows 10 Universal Windows application build: set `CMAKE_SYSTEM_NAME` to `WindowsStore` and `CMAKE_SYSTEM_VERSION` to `10.0`.
* **Windows* OS 10 Universal Windows application build**. Set `CMAKE_SYSTEM_NAME` to `WindowsStore` and `CMAKE_SYSTEM_VERSION` to `10.0`.
---
**NOTE**
Set `TBB_NO_APPCONTAINER` to `ON` in order to apply `/APPCONTAINER:NO` option during the compilation (used for testing).
---
_Note: set `TBB_NO_APPCONTAINER` to `ON` in order to apply `/APPCONTAINER:NO` option during the compilation (used for testing)._
```bash
cmake -DCMAKE_SYSTEM_NAME:STRING=WindowsStore -DCMAKE_SYSTEM_VERSION:STRING=10.0 ..
```
* Universal Windows Driver build: set `TBB_WINDOWS_DRIVER` to `ON` and use static linkage with CRT (see above).
* **Universal Windows* OS Driver build**. Set `TBB_WINDOWS_DRIVER` to `ON` and use static linkage with CRT.
```bash
cmake -DTBB_WINDOWS_DRIVER=ON -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded ..
@@ -107,29 +145,32 @@ cmake -DTBB_WINDOWS_DRIVER=ON -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded ..
### Test
#### Build test
Using default ('all') target:
To build a test, use the default target 'all':
```
cmake --build .
```
or using specific test target:
Or use a specific test target:
```
cmake --build . --target <test> # e.g. test_version
```
#### Run test
Using CTest:
You can run a test by using CTest:
```bash
ctest
```
or using 'test' target:
Or by using 'test' target:
```bash
cmake --build . --target test # currently doesn't work on Windows
cmake --build . --target test # currently does not work on Windows* OS
```
## Sanitizers - сonfigure, build and run
## Installation
See [Installation from Sources](../INSTALL.md) to learn how to install oneTBB.
## Sanitizers - сonfigure, build, and run
```bash
mkdir build
@@ -139,7 +180,7 @@ make -j
ctest -V
```
## Valgrind memcheck - configure, build and run
## Valgrind memcheck - configure, build, and run
### Prerequisites
* Valgrind tool executable
@@ -151,7 +192,9 @@ cmake -DTBB_VALGRIND_MEMCHECK=ON ..
make -j memcheck-<test name> # or memcheck-all to scan all tests
```
## Test specification (Doxygen)
## Test specification
Use Doxygen to generate oneTBB test specification:
```bash
mkdir build
@@ -160,29 +203,6 @@ cmake -DTBB_TEST_SPEC=ON ..
make test_spec
```
## Intallation and packaging
**NOTE: be careful about installation: avoid commands like `make install` unless you fully understand the consequences.**
The following install components are supported:
- `runtime` - oneTBB runtime package (core shared libraries and `.dll` files on Windows).
- `devel` - oneTBB development package (header files, CMake integration files, library symbolic links and `.lib` files on Windows).
- `tbb4py` - [oneTBB Module for Python](#onetbb-python-module-support).
How to install specific components after configuration and build:
```bash
cmake -DCOMPONENT=<component> [-DBUILD_TYPE=<build-type>] -P cmake_install.cmake
```
Simple packaging using CPack is supported.
The following commands allow to create a simple portable package which includes header files, libraries and integration files for CMake:
```bash
cmake <options> ..
cpack
```
## TBBConfig - integration of binary packages
It is a configuration module that is used for integration of prebuilt oneTBB. It consists of two files (TBBConfig.cmake and TBBConfigVersion.cmake) and can be used via [find_package](https://cmake.org/cmake/help/latest/command/find_package.html) function.
@@ -274,6 +294,7 @@ Variable | Description
`TBB_LIB_LINK_LIBS ` | Applied to libraries as link libraries
`TBB_TEST_COMPILE_FLAGS` | Applied to tests as compile options
Please specify the `LINK` options prefixed with dash(-) for MSVC(Visual Studio) compiler with CMake < 3.13 to avoid issues caused by `target_link_libraries` CMake command usage.
#### Specific options
+10 -3
View File
@@ -1,4 +1,4 @@
# Copyright (c) 2020-2021 Intel Corporation
# Copyright (c) 2020-2022 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -31,9 +31,16 @@ if (NOT TBB_STRICT AND COMMAND tbb_remove_compile_flag)
tbb_remove_compile_flag(-Werror)
endif()
if (NOT "${CMAKE_OSX_ARCHITECTURES}" MATCHES "^arm64$" AND CMAKE_SYSTEM_PROCESSOR STREQUAL x86_64)
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -mrtm)
# Enable Intel(R) Transactional Synchronization Extensions (-mrtm) and WAITPKG instructions support (-mwaitpkg) on relevant processors
if (CMAKE_OSX_ARCHITECTURES)
set(_tbb_target_architectures "${CMAKE_OSX_ARCHITECTURES}")
else()
set(_tbb_target_architectures "${CMAKE_SYSTEM_PROCESSOR}")
endif()
if ("${_tbb_target_architectures}" MATCHES "(x86_64|amd64|AMD64)") # OSX systems are 64-bit only
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -mrtm $<$<NOT:$<VERSION_LESS:${CMAKE_CXX_COMPILER_VERSION},12.0>>:-mwaitpkg>)
endif()
unset(_tbb_target_architectures)
# TBB malloc settings
set(TBBMALLOC_LIB_COMPILE_FLAGS -fno-rtti -fno-exceptions)
+18 -4
View File
@@ -12,12 +12,18 @@
# See the License for the specific language governing permissions and
# limitations under the License.
if (APPLE)
if (MINGW)
set(TBB_LINK_DEF_FILE_FLAG "")
set(TBB_DEF_FILE_PREFIX "")
elseif (APPLE)
set(TBB_LINK_DEF_FILE_FLAG -Wl,-exported_symbols_list,)
set(TBB_DEF_FILE_PREFIX mac${TBB_ARCH})
# For correct ucontext.h structures layout
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -D_XOPEN_SOURCE)
elseif (MSVC)
include(${CMAKE_CURRENT_LIST_DIR}/MSVC.cmake)
return()
else()
set(TBB_LINK_DEF_FILE_FLAG -Wl,--version-script=)
set(TBB_DEF_FILE_PREFIX lin${TBB_ARCH})
@@ -37,15 +43,23 @@ if (NOT TBB_STRICT AND COMMAND tbb_remove_compile_flag)
tbb_remove_compile_flag(-Werror)
endif()
if (CMAKE_SYSTEM_PROCESSOR STREQUAL x86_64)
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -mrtm)
# Enable Intel(R) Transactional Synchronization Extensions (-mrtm) and WAITPKG instructions support (-mwaitpkg) on relevant processors
if (CMAKE_SYSTEM_PROCESSOR MATCHES "(AMD64|amd64|i.86|x86)")
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -mrtm $<$<NOT:$<VERSION_LESS:${CMAKE_CXX_COMPILER_VERSION},12.0>>:-mwaitpkg>)
endif()
set(TBB_COMMON_LINK_LIBS dl)
set(TBB_COMMON_LINK_LIBS ${CMAKE_DL_LIBS})
if (ANDROID_PLATFORM)
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} $<$<NOT:$<CONFIG:Debug>>:-D_FORTIFY_SOURCE=2>)
endif()
if (MINGW)
list(APPEND TBB_COMMON_COMPILE_FLAGS -U__STRICT_ANSI__)
endif()
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:-flto>)
set(TBB_IPO_LINK_FLAGS $<$<NOT:$<CONFIG:Debug>>:-flto>)
# TBB malloc settings
set(TBBMALLOC_LIB_COMPILE_FLAGS -fno-rtti -fno-exceptions)
+22 -7
View File
@@ -1,4 +1,4 @@
# Copyright (c) 2020-2021 Intel Corporation
# Copyright (c) 2020-2022 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -12,7 +12,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.
if (APPLE)
if (MINGW)
set(TBB_LINK_DEF_FILE_FLAG "")
set(TBB_DEF_FILE_PREFIX "")
elseif (APPLE)
set(TBB_LINK_DEF_FILE_FLAG -Wl,-exported_symbols_list,)
set(TBB_DEF_FILE_PREFIX mac${TBB_ARCH})
@@ -32,11 +35,14 @@ if (NOT CMAKE_GENERATOR MATCHES "Ninja" AND NOT CMAKE_CXX_DEPENDS_USE_COMPILER)
set(TBB_MMD_FLAG -MMD)
endif()
if (CMAKE_SYSTEM_PROCESSOR STREQUAL x86_64)
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -mrtm)
# Enable Intel(R) Transactional Synchronization Extensions (-mrtm) and WAITPKG instructions support (-mwaitpkg) on relevant processors
if (CMAKE_SYSTEM_PROCESSOR MATCHES "(AMD64|amd64|i.86|x86)")
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -mrtm $<$<AND:$<NOT:$<CXX_COMPILER_ID:Intel>>,$<NOT:$<VERSION_LESS:${CMAKE_CXX_COMPILER_VERSION},11.0>>>:-mwaitpkg>)
endif()
set(TBB_COMMON_LINK_LIBS dl)
if (NOT MINGW)
set(TBB_COMMON_LINK_LIBS dl)
endif()
# Ignore -Werror set through add_compile_options() or added to CMAKE_CXX_FLAGS if TBB_STRICT is disabled.
if (NOT TBB_STRICT AND COMMAND tbb_remove_compile_flag)
@@ -48,11 +54,20 @@ if (NOT ${CMAKE_CXX_COMPILER_ID} STREQUAL Intel)
set(TBB_DSE_FLAG $<$<NOT:$<VERSION_LESS:${CMAKE_CXX_COMPILER_VERSION},6.0>>:-flifetime-dse=1>)
endif()
# Workaround for heavy tests
# Workaround for heavy tests and too many symbols in debug (rellocation truncated to fit: R_MIPS_CALL16)
if ("${CMAKE_SYSTEM_PROCESSOR}" MATCHES "mips")
set(TBB_TEST_COMPILE_FLAGS ${TBB_TEST_COMPILE_FLAGS} -DTBB_TEST_LOW_WORKLOAD)
set(TBB_TEST_COMPILE_FLAGS ${TBB_TEST_COMPILE_FLAGS} -DTBB_TEST_LOW_WORKLOAD $<$<CONFIG:DEBUG>:-fPIE -mxgot>)
set(TBB_TEST_LINK_FLAGS ${TBB_TEST_LINK_FLAGS} $<$<CONFIG:DEBUG>:-pie>)
endif()
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:-flto>)
set(TBB_IPO_LINK_FLAGS $<$<NOT:$<CONFIG:Debug>>:-flto>)
if (MINGW AND CMAKE_SYSTEM_PROCESSOR MATCHES "i.86")
list (APPEND TBB_COMMON_COMPILE_FLAGS -msse2)
endif ()
# TBB malloc settings
set(TBBMALLOC_LIB_COMPILE_FLAGS -fno-rtti -fno-exceptions)
set(TBB_OPENMP_FLAG -fopenmp)
+5
View File
@@ -16,11 +16,14 @@ if (MSVC)
include(${CMAKE_CURRENT_LIST_DIR}/MSVC.cmake)
set(TBB_WARNING_LEVEL ${TBB_WARNING_LEVEL} /W3)
set(TBB_OPENMP_FLAG /Qopenmp)
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:/Qipo>)
set(TBB_IPO_LINK_FLAGS $<$<NOT:$<CONFIG:Debug>>:/INCREMENTAL:NO>)
elseif (APPLE)
include(${CMAKE_CURRENT_LIST_DIR}/AppleClang.cmake)
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -fstack-protector -Wformat -Wformat-security
$<$<NOT:$<CONFIG:Debug>>:-fno-omit-frame-pointer -qno-opt-report-embed -D_FORTIFY_SOURCE=2>)
set(TBB_OPENMP_FLAG -qopenmp)
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:-ipo>)
else()
include(${CMAKE_CURRENT_LIST_DIR}/GNU.cmake)
set(TBB_LIB_LINK_FLAGS ${TBB_LIB_LINK_FLAGS} -static-intel -Wl,-z,relro,-z,now,)
@@ -28,4 +31,6 @@ else()
$<$<NOT:$<CONFIG:Debug>>:-qno-opt-report-embed -D_FORTIFY_SOURCE=2>
$<$<EQUAL:${TBB_ARCH},32>:-falign-stack=maintain-16-byte>)
set(TBB_OPENMP_FLAG -qopenmp)
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:-ipo>)
endif()
set(TBB_IPO_LINK_FLAGS ${TBB_IPO_LINK_FLAGS} ${TBB_IPO_COMPILE_FLAGS})
+23
View File
@@ -0,0 +1,23 @@
# Copyright (c) 2020-2021 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
if (WIN32)
include(${CMAKE_CURRENT_LIST_DIR}/MSVC.cmake)
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:/Qipo>)
set(TBB_IPO_LINK_FLAGS $<$<NOT:$<CONFIG:Debug>>:/INCREMENTAL:NO>)
else()
include(${CMAKE_CURRENT_LIST_DIR}/Clang.cmake)
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:-ipo>)
endif()
set(TBB_IPO_LINK_FLAGS ${TBB_IPO_LINK_FLAGS} ${TBB_IPO_COMPILE_FLAGS})
+19 -5
View File
@@ -19,10 +19,12 @@ set(TBB_DEF_FILE_PREFIX win${TBB_ARCH})
# TODO: consider use of CMP0092 CMake policy.
string(REGEX REPLACE "/W[0-4]" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
# Warning suppression C4324: structure was padded due to alignment specifier
set(TBB_WARNING_LEVEL $<$<NOT:$<CXX_COMPILER_ID:Intel>>:/W4> $<$<BOOL:${TBB_STRICT}>:/WX>)
# Warning suppression C4324: structure was padded due to alignment specifier
set(TBB_WARNING_SUPPRESS /wd4324)
set(TBB_TEST_COMPILE_FLAGS /bigobj)
set(TBB_TEST_COMPILE_FLAGS ${TBB_TEST_COMPILE_FLAGS} /bigobj)
if (MSVC_VERSION LESS_EQUAL 1900)
# Warning suppression C4503 for VS2015 and earlier:
# decorated name length exceeded, name was truncated.
@@ -31,7 +33,7 @@ if (MSVC_VERSION LESS_EQUAL 1900)
set(TBB_TEST_COMPILE_FLAGS ${TBB_TEST_COMPILE_FLAGS} /wd4503)
endif()
set(TBB_LIB_COMPILE_FLAGS -D_CRT_SECURE_NO_WARNINGS /GS)
set(TBB_COMMON_COMPILE_FLAGS /volatile:iso /FS)
set(TBB_COMMON_COMPILE_FLAGS /volatile:iso /FS /EHsc)
# Ignore /WX set through add_compile_options() or added to CMAKE_CXX_FLAGS if TBB_STRICT is disabled.
if (NOT TBB_STRICT AND COMMAND tbb_remove_compile_flag)
@@ -40,7 +42,7 @@ endif()
if (WINDOWS_STORE OR TBB_WINDOWS_DRIVER)
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} /D_WIN32_WINNT=0x0A00)
set(TBB_COMMON_LINK_FLAGS /NODEFAULTLIB:kernel32.lib /INCREMENTAL:NO)
set(TBB_COMMON_LINK_FLAGS -NODEFAULTLIB:kernel32.lib -INCREMENTAL:NO)
set(TBB_COMMON_LINK_LIBS OneCore.lib)
endif()
@@ -55,7 +57,7 @@ if (WINDOWS_STORE)
string(REGEX REPLACE "WindowsApp.lib" "" CMAKE_CXX_STANDARD_LIBRARIES "${CMAKE_CXX_STANDARD_LIBRARIES}")
if (TBB_NO_APPCONTAINER)
set(TBB_LIB_LINK_FLAGS ${TBB_LIB_LINK_FLAGS} /APPCONTAINER:NO)
set(TBB_LIB_LINK_FLAGS ${TBB_LIB_LINK_FLAGS} -APPCONTAINER:NO)
endif()
endif()
@@ -69,4 +71,16 @@ if (TBB_WINDOWS_DRIVER)
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} /D _UNICODE /DUNICODE /DWINAPI_FAMILY=WINAPI_FAMILY_APP /D__WRL_NO_DEFAULT_LIB__)
endif()
if (CMAKE_CXX_COMPILER_ID MATCHES "(Clang|IntelLLVM)")
if (CMAKE_SYSTEM_PROCESSOR MATCHES "(x86|AMD64|i.86)")
set(TBB_COMMON_COMPILE_FLAGS ${TBB_COMMON_COMPILE_FLAGS} -mrtm -mwaitpkg)
endif()
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:-flto>)
set(TBB_IPO_LINK_FLAGS $<$<NOT:$<CONFIG:Debug>>:-flto>)
else()
set(TBB_IPO_COMPILE_FLAGS $<$<NOT:$<CONFIG:Debug>>:/GL>)
set(TBB_IPO_LINK_FLAGS $<$<NOT:$<CONFIG:Debug>>:-LTCG> $<$<NOT:$<CONFIG:Debug>>:-INCREMENTAL:NO>)
endif()
set(TBB_OPENMP_FLAG /openmp)
set(TBB_OPENMP_NO_LINK_FLAG TRUE) # TBB_OPENMP_FLAG will be used only on compilation but not on linkage
+18
View File
@@ -0,0 +1,18 @@
# Copyright (c) 2021 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/compilers/GNU.cmake)
# Remove dl library not present in QNX systems
unset(TBB_COMMON_LINK_LIBS)
+19
View File
@@ -40,6 +40,10 @@ function(tbb_generate_config)
set(TBB_VERSION ${tbb_gen_cfg_VERSION})
set(_tbb_pc_lib_name tbb)
set(_prefix_for_pc_file "\${pcfiledir}/../../")
set(_includedir_for_pc_file "\${prefix}/include")
set(TBB_COMPONENTS_BIN_VERSION "
set(_tbb_bin_version ${tbb_gen_cfg_TBB_BINARY_VERSION})
set(_tbbmalloc_bin_version ${tbb_gen_cfg_TBBMALLOC_BINARY_VERSION})
@@ -60,12 +64,20 @@ else ()
set(_tbb_subdir ia32/gcc4.8)
endif()
")
set(_libdir_for_pc_file "\${prefix}/lib/intel64/gcc4.8")
configure_file(${_tbb_gen_cfg_path}/../integration/pkg-config/tbb.pc.in ${config_install_dir}/tbb.pc @ONLY)
set(_libdir_for_pc_file "\${prefix}/lib/ia32/gcc4.8")
configure_file(${_tbb_gen_cfg_path}/../integration/pkg-config/tbb.pc.in ${config_install_dir}/tbb32.pc @ONLY)
endif()
elseif (tbb_gen_cfg_SYSTEM_NAME STREQUAL "Darwin")
set(TBB_LIB_PREFIX "lib")
set(TBB_LIB_EXT "\${_\${_tbb_component}_bin_version}.dylib")
set(TBB_IMPLIB_RELEASE "")
set(TBB_IMPLIB_DEBUG "")
set(_libdir_for_pc_file "\${prefix}/lib")
configure_file(${_tbb_gen_cfg_path}/../integration/pkg-config/tbb.pc.in ${config_install_dir}/tbb.pc @ONLY)
elseif (tbb_gen_cfg_SYSTEM_NAME STREQUAL "Windows")
set(TBB_LIB_PREFIX "")
set(TBB_LIB_EXT "dll")
@@ -95,6 +107,13 @@ else ()
set(_tbb_subdir ia32/\${_tbb_subdir})
endif()
")
set(_tbb_pc_lib_name ${_tbb_pc_lib_name}${TBB_BINARY_VERSION})
set(_libdir_for_pc_file "\${prefix}/lib/intel64/vc14")
configure_file(${_tbb_gen_cfg_path}/../integration/pkg-config/tbb.pc.in ${config_install_dir}/tbb.pc @ONLY)
set(_libdir_for_pc_file "\${prefix}/lib/ia32/vc14")
configure_file(${_tbb_gen_cfg_path}/../integration/pkg-config/tbb.pc.in ${config_install_dir}/tbb32.pc @ONLY)
endif()
set(TBB_HANDLE_BIN_VERSION "
+11 -8
View File
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
list(APPEND HWLOC_REQUIRED_VERSIONS 1_11 2 2_4)
list(APPEND HWLOC_REQUIRED_VERSIONS 1_11 2 2_5)
foreach(hwloc_version ${HWLOC_REQUIRED_VERSIONS})
if (NOT WIN32)
@@ -45,19 +45,22 @@ endforeach()
unset(HWLOC_TARGET_NAME)
if (NOT HWLOC_TARGET_EXPLICITLY_DEFINED)
if (NOT HWLOC_TARGET_EXPLICITLY_DEFINED AND
# No hwloc auto detection for cross compilation
NOT CMAKE_CROSSCOMPILING AND
NOT TBB_DISABLE_HWLOC_AUTOMATIC_SEARCH
)
find_package(PkgConfig QUIET)
if (PKG_CONFIG_FOUND)
pkg_search_module(HWLOC hwloc)
if (HWLOC_FOUND)
if (PKG_CONFIG_FOUND AND NOT CMAKE_VERSION VERSION_LESS 3.6)
pkg_search_module(HWLOC hwloc IMPORTED_TARGET)
if (TARGET PkgConfig::HWLOC)
if (HWLOC_VERSION VERSION_LESS 2)
set(TBBBIND_LIBRARY_NAME tbbbind)
elseif(HWLOC_VERSION VERSION_LESS 2.4)
elseif(HWLOC_VERSION VERSION_LESS 2.5)
set(TBBBIND_LIBRARY_NAME tbbbind_2_0)
else()
set(TBBBIND_LIBRARY_NAME tbbbind_2_4)
set(TBBBIND_LIBRARY_NAME tbbbind_2_5)
endif()
endif()
endif()
endif()
+1
View File
@@ -14,6 +14,7 @@
# Add code signing as post-install step.
if (DEFINED TBB_SIGNTOOL)
file(TO_CMAKE_PATH "${TBB_SIGNTOOL}" TBB_SIGNTOOL)
install(CODE "
file(GLOB_RECURSE FILES_TO_SIGN \${CMAKE_INSTALL_PREFIX}/*${CMAKE_SHARED_LIBRARY_SUFFIX})
execute_process(COMMAND ${TBB_SIGNTOOL} \${FILES_TO_SIGN} ${TBB_SIGNTOOL_ARGS})
+4
View File
@@ -34,5 +34,9 @@ if (NOT ${FLAG_DISPLAY_NAME})
"please try another compiler or omit TBB_SANITIZE variable")
endif()
set(TBB_TESTS_ENVIRONMENT ${TBB_TESTS_ENVIRONMENT}
"TSAN_OPTIONS=suppressions=${CMAKE_CURRENT_SOURCE_DIR}/cmake/suppressions/tsan.suppressions"
"LSAN_OPTIONS=suppressions=${CMAKE_CURRENT_SOURCE_DIR}/cmake/suppressions/lsan.suppressions")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${TBB_SANITIZE_OPTION}")
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${TBB_SANITIZE_OPTION}")
+2 -6
View File
@@ -26,22 +26,18 @@ set(DLL_REL_PATH "redist")
file(READ ${CMAKE_CURRENT_LIST_DIR}/../../include/oneapi/tbb/version.h _tbb_version_info)
string(REGEX REPLACE ".*#define TBB_VERSION_MAJOR ([0-9]+).*" "\\1" _tbb_ver_major "${_tbb_version_info}")
string(REGEX REPLACE ".*#define TBB_VERSION_MINOR ([0-9]+).*" "\\1" _tbb_ver_minor "${_tbb_version_info}")
string(REGEX REPLACE ".*#define TBB_INTERFACE_VERSION ([0-9]+).*" "\\1" _tbb_interface_ver "${_tbb_version_info}")
string(REGEX REPLACE ".*#define TBB_VERSION_PATCH ([0-9]+).*" "\\1" _tbb_ver_patch "${_tbb_version_info}")
string(REGEX REPLACE ".*#define __TBB_BINARY_VERSION ([0-9]+).*" "\\1" TBB_BINARY_VERSION "${_tbb_version_info}")
file(READ ${CMAKE_CURRENT_LIST_DIR}/../../CMakeLists.txt _tbb_cmakelist)
string(REGEX REPLACE ".*TBBMALLOC_BINARY_VERSION ([0-9]+).*" "\\1" TBBMALLOC_BINARY_VERSION "${_tbb_cmakelist}")
set(TBBMALLOC_PROXY_BINARY_VERSION ${TBBMALLOC_BINARY_VERSION})
string(REGEX REPLACE ".*TBBBIND_BINARY_VERSION ([0-9]+).*" "\\1" TBBBIND_BINARY_VERSION "${_tbb_cmakelist}")
# Parse patch and tweak versions from interface version: e.g. 12014 --> 01 - patch version, 4 - tweak version.
math(EXPR _tbb_ver_patch "${_tbb_interface_ver} % 1000 / 10")
math(EXPR _tbb_ver_tweak "${_tbb_interface_ver} % 10")
set(COMMON_ARGS
TBB_ROOT_REL_PATH ${TBB_ROOT_REL_PATH}
INC_REL_PATH ${INC_REL_PATH}
LIB_REL_PATH ${LIB_REL_PATH}
VERSION ${_tbb_ver_major}.${_tbb_ver_minor}.${_tbb_ver_patch}.${_tbb_ver_tweak}
VERSION ${_tbb_ver_major}.${_tbb_ver_minor}.${_tbb_ver_patch}
TBB_BINARY_VERSION ${TBB_BINARY_VERSION}
TBBMALLOC_BINARY_VERSION ${TBBMALLOC_BINARY_VERSION}
TBBMALLOC_PROXY_BINARY_VERSION ${TBBMALLOC_PROXY_BINARY_VERSION}
+2
View File
@@ -0,0 +1,2 @@
# LSAN suppression for ltdl library known issue.
leak:libltdl.so
+3
View File
@@ -0,0 +1,3 @@
# TSAN suppression for known issues.
# Possible data race during ittnotify initialization. Low impact.
race:__itt_nullify_all_pointers
+22 -7
View File
@@ -1,4 +1,4 @@
# Copyright (c) 2020-2021 Intel Corporation
# Copyright (c) 2020-2022 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@ macro(tbb_remove_compile_flag flag)
set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY COMPILE_OPTIONS ${_tbb_compile_options})
unset(_tbb_compile_options)
if (CMAKE_CXX_FLAGS)
string(REGEX REPLACE ${flag} "" CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
string(REGEX REPLACE "(^|[ \t\r\n]+)${flag}($|[ \t\r\n]+)" " " CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
endif()
endmacro()
@@ -36,9 +36,24 @@ macro(tbb_install_target target)
DESTINATION ${CMAKE_INSTALL_LIBDIR}
COMPONENT devel)
install(TARGETS ${target}
LIBRARY
DESTINATION ${CMAKE_INSTALL_LIBDIR}
NAMELINK_ONLY
COMPONENT devel)
if (BUILD_SHARED_LIBS)
install(TARGETS ${target}
LIBRARY
DESTINATION ${CMAKE_INSTALL_LIBDIR}
NAMELINK_ONLY
COMPONENT devel)
endif()
endmacro()
macro(tbb_handle_ipo target)
if (TBB_IPO_PROPERTY)
set_target_properties(${target} PROPERTIES INTERPROCEDURAL_OPTIMIZATION TRUE)
elseif (TBB_IPO_FLAGS)
target_compile_options(${target} PRIVATE ${TBB_IPO_COMPILE_FLAGS})
if (COMMAND target_link_options)
target_link_options(${target} PRIVATE ${TBB_IPO_LINK_FLAGS})
else()
target_link_libraries(${target} PRIVATE ${TBB_IPO_LINK_FLAGS})
endif()
endif()
endmacro()
Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

+48
View File
@@ -0,0 +1,48 @@
.. _Before_You_Begin:
Before You Begin
****************
After installing |short_name|, you need to set the environment variables:
#. Go to the oneTBB installation directory (``<install_dir>``). By default, ``<install_dir>`` is the following:
* On Linux* OS:
* For superusers (root): ``/opt/intel/oneapi``
* For ordinary users (non-root): ``$HOME/intel/oneapi``
* On Windows* OS:
* ``<Program Files>\Intel\oneAPI``
#. Set the environment variables, using the script in <install_dir>, by running
* On Linux* OS:
``vars.{sh|csh} in <install_dir>/tbb/latest/env``
* On Windows* OS:
``vars.bat in <install_dir>/tbb/latest/env``
Example
*******
Below you can find a typical example for a |short_name| algorithm.
The sample calculates a sum of all integer numbers from 1 to 100.
.. code:: cpp
int sum = oneapi::tbb::parallel_reduce(oneapi::tbb::blocked_range<int>(1,101), 0,
[](oneapi::tbb::blocked_range<int> const& r, int init) -> int {
for (int v = r.begin(); v != r.end(); v++ ) {
init += v;
}
return init;
},
[](int lhs, int rhs) -> int {
return lhs + rhs;
}
);
+45
View File
@@ -0,0 +1,45 @@
.. _examples:
oneTBB Samples
==============
Refer to the following examples to see how |short_name| works.
* **Containers**
* `concurrent_hash_map <https://github.com/oneapi-src/oneTBB/tree/master/examples/concurrent_hash_map>`_
* `concurrent_priority_queue <https://github.com/oneapi-src/oneTBB/tree/master/examples/concurrent_priority_queue>`_
* `Flow Graph <https://github.com/oneapi-src/oneTBB/tree/master/examples/graph>`_
* `A solution to the binpacking problem using a queue_node, a buffer_node, and function_node. <https://github.com/oneapi-src/oneTBB/tree/master/examples/graph/binpack>`_
* `Cholesky Factorization algorithm <https://github.com/oneapi-src/oneTBB/tree/master/examples/graph/cholesky>`_
* `An implementation of dining philosophers in graph using the reserving join_node <https://github.com/oneapi-src/oneTBB/tree/master/examples/graph/dining_philosophers>`_
* `A parallel implementation of bzip2 block-sorting file compressor <https://github.com/oneapi-src/oneTBB/tree/master/examples/graph/fgbzip2>`_
* `An example of a collection of digital logic gates that can be easily composed into larger circuits <https://github.com/oneapi-src/oneTBB/tree/master/examples/graph/logic_sim>`_
* `An example of a Kohonen Self-Organizing Map using cancellation <https://github.com/oneapi-src/oneTBB/tree/master/examples/graph/som>`_
* `Split computational kernel for execution between CPU and GPU <https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneTBB/tbb-async-sycl>`_
* **Algorithms**
* `parallel_for <https://github.com/oneapi-src/oneTBB/tree/master/examples/parallel_for>`_
* `Game of life overlay <https://github.com/oneapi-src/oneTBB/tree/master/examples/parallel_for/game_of_life>`_
* `Polygon overlay <https://github.com/oneapi-src/oneTBB/tree/master/examples/parallel_for/polygon_overlay>`_
* `Parallel seismic wave simulation <https://github.com/oneapi-src/oneTBB/tree/master/examples/parallel_for/seismic>`_
* `Parallel 2-D raytracer/renderer <https://github.com/oneapi-src/oneTBB/tree/master/examples/parallel_for/tachyon>`_
* `Find largest matching substrings <https://github.com/oneapi-src/oneTBB/tree/master/examples/getting_started>`_
* `Resumable task: Split computational kernel for execution between CPU and GPU <https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneTBB/tbb-resumable-tasks-sycl>`_
* `parallel_for_each <https://github.com/oneapi-src/oneTBB/tree/master/examples/parallel_for_each>`_
* `parallel_pipeline <https://github.com/oneapi-src/oneTBB/tree/master/examples/parallel_pipeline>`_
* `parallel_reduce <https://github.com/oneapi-src/oneTBB/tree/master/examples/parallel_reduce>`_
* **Task Scheduler**
* `task_arena <https://github.com/oneapi-src/oneTBB/tree/master/examples/task_arena>`_
* `task_group <https://github.com/oneapi-src/oneTBB/tree/master/examples/task_group>`_
* `Execute similar computational kernels, with one task executing the SYCL* code and the other task executing the oneTBB code <https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneTBB/tbb-task-sycl>`_
* **Other**
* `Compute Fibonacci numbers in different ways <https://github.com/oneapi-src/oneTBB/tree/master/examples/test_all>`_
+15
View File
@@ -0,0 +1,15 @@
.. _Get_Started_Guide:
Get Started with |short_name|
==============================
.. include:: intro_gsg.rst
.. include:: system_requirements.rst
.. include:: before_beginning_and_example.rst
Find more
*********
See our `documentation <https://oneapi-src.github.io/oneTBB/>`_ to learn more about |short_name|.
+7
View File
@@ -0,0 +1,7 @@
.. _installation:
Installation
============
See the `installation instructions <https://github.com/oneapi-src/oneTBB/blob/master/INSTALL.md>`_
that will help you to install |short_name| successfully.
+23
View File
@@ -0,0 +1,23 @@
.. _Intro_gsg:
|full_name| is a runtime-based parallel programming model for C++ code that uses threads.
It consists of a template-based runtime library to help you harness the latent performance of multi-core processors.
oneTBB enables you to simplify parallel programming by breaking computation into parallel running tasks. Within a single process,
parallelism is carried out through threads, an operating system mechanism that allows the same or different sets of instructions
to be executed simultaneously.
Here you can see one of the possible executions of tasks by threads.
.. figure:: /GSG/Images/how-oneTBB-works.png
:scale: 70%
:align: center
Use oneTBB to write scalable applications that:
* Specify logical parallel structure instead of threads
* Emphasize data-parallel programming
* Take advantage of concurrent collections and parallel algorithms
oneTBB supports nested parallelism and load balancing. It means that you can use the library without being worried about oversubscribing a system.
+6
View File
@@ -0,0 +1,6 @@
.. _System_Requirements:
System Requirements
*******************
Refer to the `oneTBB System Requirements <https://github.com/oneapi-src/oneTBB/blob/master/SYSTEM_REQUIREMENTS.md>`_.
+36
View File
@@ -0,0 +1,36 @@
#===============================================================================
# Copyright (C) 2022 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#===============================================================================
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = doc
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+34
View File
@@ -0,0 +1,34 @@
# How to build oneTBB documentation
Our documentation is written in restructured text markup (.rst) and built using [Sphinx](http://www.sphinx-doc.org/en/master/).
This document explains how to build oneTBB documentation locally.
## Prerequisites
- Python 3.7.0 or higher
- Sphinx
## Build documentation
Do the following to generate HTML output of the documentation:
1. Clone oneTBB repository:
```
git clone https://github.com/oneapi-src/oneTBB.git
```
2. Go to the `doc` folder:
```
cd oneTBB/doc
```
3. Run in the command line:
```
make html
```
That's it! Your built documentation is located in the ``build/html`` folder.
+37
View File
@@ -0,0 +1,37 @@
window.MathJax = {
TeX: {
Macros: {
src: '\\operatorname{src}',
srclayer: '\\operatorname{src\\_layer}',
srciter: '\\operatorname{src\\_iter}',
srciterc: '\\operatorname{src\\_iter\\_c}',
weights: '\\operatorname{weights}',
weightslayer: '\\operatorname{weights\\_layer}',
weightsiter: '\\operatorname{weights\\_iter}',
weightspeephole: '\\operatorname{weights\\_peephole}',
weightsprojection: '\\operatorname{weights\\_projection}',
bias: '\\operatorname{bias}',
dst: '\\operatorname{dst}',
dstlayer: '\\operatorname{dst\\_layer}',
dstiter: '\\operatorname{dst\\_iter}',
dstiterc: '\\operatorname{dst\\_iter\\_c}',
diffsrc: '\\operatorname{diff\\_src}',
diffsrclayer: '\\operatorname{diff\\_src\\_layer}',
diffsrciter: '\\operatorname{diff\\_src\\_iter}',
diffsrciterc: '\\operatorname{diff\\_src\\_iter\\_c}',
diffweights: '\\operatorname{diff\\_weights}',
diffweightslayer: '\\operatorname{diff\\_weights\\_layer}',
diffweightsiter: '\\operatorname{diff\\_weights\\_iter}',
diffweightspeephole: '\\operatorname{diff\\_weights\\_peephole}',
diffweightsprojection: '\\operatorname{diff\\_weights\\_projection}',
diffbias: '\\operatorname{diff\\_bias}',
diffdst: '\\operatorname{diff\\_dst}',
diffdstlayer: '\\operatorname{diff\\_dst\\_layer}',
diffdstiter: '\\operatorname{diff\\_dst\\_iter}',
diffdstiterc: '\\operatorname{diff\\_dst\\_iter\\_c}',
diffgamma: '\\operatorname{diff\\_\\gamma}',
diffbeta: '\\operatorname{diff\\_\\beta}',
workspace: '\\operatorname{workspace}'
}
}
}
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 467 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

+13
View File
@@ -0,0 +1,13 @@
/* override table width restrictions */
@media screen and (min-width: 767px) {
.wy-table-responsive table td {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}
.wy-table-responsive {
overflow: visible !important;
}
}
+301
View File
@@ -0,0 +1,301 @@
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
SOURCE_DIR = os.path.dirname(__file__)
LATEX_DIR = os.path.join(SOURCE_DIR, '_latex')
PREAMBLE_FILE = os.path.join(LATEX_DIR, 'preamble.tex')
TITLE_PAGE_FILE = os.path.join(LATEX_DIR, 'title_page.tex')
BUILD_TYPE = os.getenv("BUILD_TYPE")
# -- Project information -----------------------------------------------------
if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
project = u'Intel® oneAPI Threading Building Blocks (oneTBB)'
else:
project = u'oneTBB'
copyright = u'2022, Intel Corporation'
author = u'Intel'
# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
release = u''
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['main/_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
#master_doc = 'main/title_main'
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
# Syntax highlighting for the :: directive
highlight_language = 'cpp'
if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
rst_prolog = """
.. |full_name| replace:: Intel\ |reg|\ oneAPI Threading Building Blocks (oneTBB)
.. |short_name| replace:: oneTBB
.. |product| replace:: oneTBB
.. |reg| unicode:: U+000AE
.. |copy| unicode:: U+000A9
.. |base_tk| replace:: Intel\ |reg|\ oneAPI Base Toolkit
.. |dpcpp| replace:: Intel\ |reg|\ oneAPI DPC++/C++ Compiler
"""
else:
rst_prolog = """
.. |full_name| replace:: oneAPI Threading Building Blocks (oneTBB)
.. |short_name| replace:: oneTBB
.. |product| replace:: oneTBB
.. |reg| unicode:: U+000AE
.. |copy| unicode:: U+000A9
.. |base_tk| replace:: Intel\ |reg|\ oneAPI Base Toolkit
.. |dpcpp| replace:: Intel\ |reg|\ oneAPI DPC++/C++ Compiler
"""
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme = 'sphinx_book_theme'
if BUILD_TYPE == 'dita':
html_theme_options = {
'repository_url': 'https://github.com/oneapi-src/oneTBB',
'path_to_docs': 'doc',
'repository_branch': 'master'
}
else:
html_theme_options = {
'repository_url': 'https://github.com/oneapi-src/oneTBB',
'path_to_docs': 'doc/main',
'use_issues_button': True,
'use_edit_page_button': True,
'repository_branch': 'master',
'extra_footer': '<p align="right"><a href="https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html">Cookies</a></p>'
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
if BUILD_TYPE == 'oneapi' or BUILD_TYPE == 'dita':
html_context = {
'css_files': [
'_static/theme_overrides.css', # override wide tables in RTD theme
],
}
else:
html_js_files = ['custom.js']
html_logo = '_static/oneAPI-rgb-rev-100.png'
html_favicon = '_static/favicons.png'
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'sphinx-infodevdoc'
# -- Options for LaTeX output ------------------------------------------------
#latex_engine = 'xelatex'
#PDF_TITLE = 'Information Development Template'
#
#with open(PREAMBLE_FILE, 'r', encoding='utf-8') as f:
# PREAMBLE = f.read()
#
#with open(TITLE_PAGE_FILE, 'r', encoding='utf-8') as f:
# TITLE_PAGE = f.read().replace('<PDF_TITLE>', PDF_TITLE)
#
#
#latex_elements = {
# # The paper size ('letterpaper' or 'a4paper').
# #
# 'extraclassoptions': 'openany,oneside',
# 'babel' : '\\usepackage[english]{babel}',
# 'papersize': 'a4paper',
# 'releasename':" ",
# # Sonny, Lenny, Glenn, Conny, Rejne, Bjarne and Bjornstrup
# # 'fncychap': '\\usepackage[Lenny]{fncychap}',
# 'fncychap': '',
# #'fontpkg': '\\usepackage{amsmath,amsfonts,amssymb,amsthm}',
#
# 'figure_align':'htbp',
# # The font size ('10pt', '11pt' or '12pt').
# #
# 'pointsize': '12pt',
#
# # Additional stuff for the LaTeX preamble.
# #
# 'preamble': PREAMBLE,
#
# 'maketitle': TITLE_PAGE,
# # Latex figure (float) alignment
# #
# # 'figure_align': 'htbp',
# 'sphinxsetup': \
# 'hmargin={0.7in,0.7in}, vmargin={1in,1in}, \
# verbatimwithframe=true, \
# TitleColor={rgb}{0,0.686,0.941}, \
# HeaderFamily=\\rmfamily\\bfseries, \
# InnerLinkColor={rgb}{0,0.686,0.941}, \
# OuterLinkColor={rgb}{0,0.686,0.941}',
#
# 'tableofcontents':' '
#}
#
#latex_logo = '_latex/intel_logo.png'
## Grouping the document tree into LaTeX files. List of tuples
## (source start file, target name, title,
## author, documentclass [howto, manual, or own class]).
#latex_documents = [
# (master_doc, 'sphinx-infodev.tex', u'sphinx-infodev Documentation',
# u'Intel', 'manual'),
#]
#breathe_projects = { #todd-mod
# project: "../doxygen/xml"
#}
#breathe_default_project = project
# Setup the exhale extension
#exhale_args = { #todd-mod
# # These arguments are required
# "containmentFolder": "./api",
# "rootFileName": "library_root.rst",
# "rootFileTitle": "Library API",
# "doxygenStripFromPath": "..",
# "fullApiSubSectionTitle": 'Full API'
#}
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'sphinx-infodev', u'sphinx-infodev Documentation',
[author], 1)
]
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'sphinx-infodev', u'sphinx-infodev Documentation',
author, 'sphinx-infodev', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
+15
View File
@@ -0,0 +1,15 @@
|full_name|
===========
.. include:: index/index_intro.rst
The following are some important topics for the ``novice user``:
* :ref:`Get_Started_Guide` gives you a brief explanation of what oneTBB is.
* :ref:`Benefits` describes how |short_name| differs from typical threading packages.
* :ref:`Package_Contents` describes dynamic library files and header files for Windows*, Linux*, and macOS* operating systems used in |short_name|.
.. include:: index/useful_topics.rst
.. include:: index/toctree.rst
+5
View File
@@ -0,0 +1,5 @@
.. _index_intro:
This document contains information about |short_name|.
It is a flexible performance library that let you break computation into parallel running tasks.
+34
View File
@@ -0,0 +1,34 @@
.. _toctree:
.. toctree::
:caption: About
:maxdepth: 1
/main/intro/help_support
/main/intro/notation
/main/intro/intro_os
/main/intro/Benefits
/main/intro/testing_approach
.. toctree::
:caption: Get Started
:maxdepth: 2
/GSG/get_started
/GSG/installation
/GSG/examples
.. toctree::
:maxdepth: 3
:caption: Developer Guide
/main/tbb_userguide/title
.. toctree::
:maxdepth: 3
:caption: Developer Reference
/main/reference/reference
+5
View File
@@ -0,0 +1,5 @@
.. _Usefull_Topics:
The following is an important topic for the ``experienced user``:
:ref:`Migration_Guide` describes how to migrate from TBB to oneTBB.
+16
View File
@@ -0,0 +1,16 @@
{% extends "!layout.html" %}
{% block extrahead %}
<script defer type="text/javascript" src="https://www.intel.com/content/dam/www/global/wap/performance-config.js" ></script>
<script type="text/javascript">
// Configure TMS settings
var wapLocalCode = 'us-en'; // Dynamically set per localized site, see mapping table for values
var wapSection = "oneapi-tbb"; // WAP team will give you a unique section for your site
// Load TMS
(function () {
var url = 'https://www.intel.com/content/dam/www/global/wap/tms-loader.js'; // WAP file URL
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; po.src = url;
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
})();
</script>
<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
{% endblock %}
+88
View File
@@ -0,0 +1,88 @@
.. _Benefits:
|short_name| Benefits
=====================
|full_name| is a library that helps you leverage multi-core performance
without having to be a threading expert. Typically you can improve
performance for multi-core processors by implementing the key points
explained in the early sections of the Developer Guide. As your
expertise grows, you may want to dive into more complex subjects that
are covered in advanced sections.
There are a variety of approaches to parallel programming, ranging from
using platform-dependent threading primitives to exotic new languages.
The advantage of oneTBB is that it works at a higher level than raw
threads, yet does not require exotic languages or compilers. You can use
it with any compiler supporting ISO C++. The library differs from
typical threading packages in the following ways:
- **oneTBB enables you to specify logical paralleism instead of
threads**. Most threading packages require you to specify threads.
Programming directly in terms of threads can be tedious and lead to
inefficient programs, because threads are low-level, heavy constructs
that are close to the hardware. Direct programming with threads
forces you to efficiently map logical tasks onto threads. In
contrast, the oneTBB run-time library automatically maps logical
parallelism onto threads in a way that makes efficient use of
processor resources.
- **oneTBB targets threading for performance**. Most general-purpose
threading packages support many different kinds of threading, such as
threading for asynchronous events in graphical user interfaces. As a
result, general-purpose packages tend to be low-level tools that
provide a foundation, not a solution. Instead, oneTBB focuses on the
particular goal of parallelizing computationally intensive work,
delivering higher-level, simpler solutions.
- **oneTBB is compatible with other threading packages.** Because the
library is not designed to address all threading problems, it can
coexist seamlessly with other threading packages.
- **oneTBB emphasizes scalable, data parallel programming**. Breaking a
program up into separate functional blocks, and assigning a separate
thread to each block is a solution that typically does not scale well
since typically the number of functional blocks is fixed. In
contrast, oneTBB emphasizes *data-parallel* programming, enabling
multiple threads to work on different parts of a collection.
Data-parallel programming scales well to larger numbers of processors
by dividing the collection into smaller pieces. With data-parallel
programming, program performance increases as you add processors.
- **oneTBB relies on generic programming**. Traditional libraries
specify interfaces in terms of specific types or base classes.
Instead, oneAPI Threading Building Blocks uses generic programming.
The essence of generic programming is writing the best possible
algorithms with the fewest constraints. The C++ Standard Template
Library (STL) is a good example of generic programming in which the
interfaces are specified by *requirements* on types. For example, C++
STL has a template function ``sort`` that sorts a sequence abstractly
defined in terms of iterators on the sequence. The requirements on
the iterators are:
- Provide random access
- The expression ``*i<*j`` is true if the item pointed to by
iterator ``i`` should precede the item pointed to by iterator
``j``, and false otherwise.
- The expression ``swap(*i,*j)`` swaps two elements.
Specification in terms of requirements on types enables the template to
sort many different representations of sequences, such as vectors and
deques. Similarly, the oneTBB templates specify requirements on types,
not particular types, and thus adapt to different data representations.
Generic programming enables oneTBB to deliver high performance
algorithms with broad applicability.
Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

+15
View File
@@ -0,0 +1,15 @@
.. _help_support:
Getting Help and Support
========================
.. container:: section
.. rubric:: Getting Technical Support
:class: sectiontitle
For general information about oneTBB technical support, product
updates, user forums, FAQs, tips and tricks and other support
questions, go to `GitHub issues <https://github.com/oneapi-src/oneTBB/issues>`_.
+35
View File
@@ -0,0 +1,35 @@
.. _intro:
Introduction
============
|full_name| is a library that supports scalable parallel programming using
standard ISO C++ code. It does not require special languages or
compilers. It is designed to promote scalable data parallel programming.
Additionally, it fully supports nested parallelism, so you can build
larger parallel components from smaller parallel components. To use the
library, you specify tasks, not threads, and let the library map tasks
onto threads in an efficient manner.
Many of the library interfaces employ generic programming, in which
interfaces are defined by requirements on types and not specific types.
The C++ Standard Template Library (STL) is an example of generic
programming. Generic programming enables oneTBB to be flexible yet
efficient. The generic interfaces enable you to customize components to
your specific needs.
.. note::
|full_name| requires C++11 standard compiler support.
The net result is that oneTBB enables you to specify parallelism far
more conveniently than using raw threads, and at the same time can
improve performance.
+106
View File
@@ -0,0 +1,106 @@
.. _notation:
Notational Conventions
======================
The following conventions may be used in this document.
.. container:: tablenoborder
.. list-table::
:header-rows: 1
* - Convention
- Explanation
- Example
* - \ *Italic*
- Used for introducing new terms, denotation of terms, placeholders, or titles of manuals.
- The filename consists of the *basename* and the *extension*.
* - \ ``Monospace``
- Indicates directory paths and filenames, commands and command line options, function names, methods, classes, data structures in body text, source code.
- \ ``ippsapi.h`` \ ``\alt\include`` Use the okCreateObjs() function to... \ ``printf("hello, world\n");``
* - [ ]
- Items enclosed in brackets are optional.
- Fa[c] Indicates Fa or Fac.
* - { \| }
- Braces and vertical bars indicate the choice of one item from a selection of two or more items.
- X{K \| W \| P} Indicates XK, XW, or XP.
* - "[" "]" "{" | " }" "|"
- Writing a metacharacter in quotation marks negates the syntactical meaning stated above; | the character is taken as a literal.
- "[" X "]" [ Y ] Denotes the letter X enclosed in brackets, optionally followed by the letter Y.
* - ...
- The ellipsis indicates that the previous item can be repeated several times.
- \ ``filename`` ... Indicates that one or more filenames can be specified.
* - ,...
- The ellipsis preceded by a comma indicates that the previous item can be repeated several times, | separated by commas.
- \ ``word`` ,... Indicates that one or more words can be specified. If more than one word is specified, the words are comma-separated.
.. container:: section
Class members are summarized by informal class declarations that
describe the class as it seems to clients, not how it is actually
implemented. For example, here is an informal declaration of class
``Foo``:
::
class Foo {
public:
int x();
int y;
~Foo();
};
The actual implementation might look like:
::
namespace internal {
class FooBase {
protected:
int x();
};
class Foo_v3: protected FooBase {
private:
int internal_stuff;
public:
using FooBase::x;
int y;
};
}
typedef internal::Foo_v3 Foo;
The example shows two cases where the actual implementation departs
from the informal declaration:
- ``Foo`` is actually a typedef to ``Foo_v3``.
- Method ``x()`` is inherited from a protected base class.
- The destructor is an implicit method generated by the compiler.
The informal declarations are intended to show you what you need to
know to use the class without the distraction of irrelevant clutter
particular to the implementation.
+31
View File
@@ -0,0 +1,31 @@
.. _testing_approach:
Testing Approach
================
There are four main types of errors/hazards you can encounter in the development of libraries for parallelism:
* Interface correspondence to specification
* Memory errors
* Data race
* Race conditions and deadlocks
|short_name| testing approach is designed to provide high coverage of these error types.
All types of errors are covered with unit testing and review.
Code coverage metrics are tracked to ensure high code coverage with tests. Uncovered branches are analyzed manually.
Memory errors and data races are additionally covered by special tools that include thread and memory sanitizers.
Race conditions and deadlocks are the most complicated errors.
They are covered by:
* **Unit tests** that, however, have limited capability to catch such errors
* **Integration tests**. Multiple different functionalities are heavily combined to emulate user use cases that may trigger such errors based on prior knowledge and expertise.
* **Stress testing with different possible combinations**. It ensures that even rarely triggered error conditions are caught by testing.
.. note:: Every fix is required to be covered by a test to guarantee the detection of such issues in the future.
Continuous Integration triggers all the tests on each commit. This ensures that:
* Issues are detected, starting from the early development phase and up to the moment of integration of changes into the library.
* The highest quality of the library is maintained even in such error-prone domains as parallelism.
Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 283 KiB

@@ -0,0 +1,163 @@
.. _concurrent_lru_cache:
concurrent_lru_cache
====================
.. note::
To enable this feature, define the ``TBB_PREVIEW_CONCURRENT_LRU_CACHE`` macro to 1.
A Class Template for Least Recently Used cache with concurrent operations.
.. contents::
:local:
:depth: 1
Description
***********
A ``concurrent_lru_cache`` container maps keys to values with the ability
to limit the number of stored unused values. For each key, there is at most one item
stored in the container.
The container permits multiple threads to concurrently retrieve items from it.
The container tracks which items are in use by returning a proxy
``concurrent_lru_cache::handle`` object that refers to an item instead of its value.
Once there are no ``handle`` objects holding reference to an item, it is considered unused.
The container stores all the items that are currently in use plus a limited
number of unused items. Excessive unused items are erased according to
least recently used policy.
When no item is found for a given key, the container calls the user-specified
``value_function_type`` object to construct a value for the key, and stores that value.
The ``value_function_type`` object must be thread-safe.
API
***
Header
------
.. code:: cpp
#include "oneapi/tbb/concurrent_lru_cache.h"
Synopsis
--------
.. code:: cpp
namespace oneapi {
namespace tbb {
template <typename Key, typename Value, typename ValueFunctionType = Value (*)(Key)>
class concurrent_lru_cache {
public:
using key_type = Key;
using value_type = Value;
using pointer = value_type*;
using const_pointer = const value_type*;
using reference = value_type&;
using const_reference = const value_type&;
using value_function_type = ValueFunctionType;
class handle {
public:
handle();
handle( handle&& other );
~handle();
handle& operator=( handle&& other );
operator bool() const;
value_type& value();
}; // class handle
concurrent_lru_cache( value_function_type f, std::size_t number_of_lru_history_items );
~concurrent_lru_cache();
handle operator[]( key_type key );
}; // class concurrent_lru_cache
} // namespace tbb
} // namespace oneapi
Member Functions
----------------
.. cpp:function:: concurrent_lru_cache( value_function_type f, std::size_t number_of_lru_history_items );
**Effects**: Constructs an empty cache that can keep up to ``number_of_lru_history_items``
unused values, with a function object ``f`` for constructing new values.
-------------------------------------------------------
.. cpp:function:: ~concurrent_lru_cache();
**Effects**: Destroys the ``concurrent_lru_cache``. Calls the destructors of the stored elements and
deallocates the used storage.
The behavior is undefined in case of concurrent operations with ``*this``.
-------------------------------------------------------
.. cpp:function:: handle operator[]( key_type k );
**Effects**: Searches the container for an item that corresponds to the given key.
If such an item is not found, the user-specified function object is called to
construct a value that is inserted into the container.
**Returns**: a ``handle`` object holding reference to the matching value.
Member Objects
--------------
``handle`` class
^^^^^^^^^^^^^^^^
**Member Functions**
.. cpp:function:: handle();
**Effects**: Constructs a ``handle`` object that does not refer to any value.
--------------------------------------------------
.. cpp:function:: handle( handle&& other );
**Effects**: Transfers the reference to the value stored in ``concurrent_lru_cache``
from ``other`` to the newly constructed object. Upon completion,
``other`` no longer refers to any value.
---------------------------------------------------
.. cpp:function:: ~handle();
**Effects**: Releases the reference (if it exists) to a value stored in ``concurrent_lru_cache``.
The behavior is undefined for concurrent operations with ``*this``.
---------------------------------------------------
.. cpp:function:: handle& operator=( handle&& other );
**Effects**: Transfers the reference to a value stored in ``concurrent_lru_cache`` from ``other``
to ``*this``. If existed, the previous reference held by ``*this`` is released. Upon
completion ``other`` no longer refers to any value.
**Returns**: a reference to ``*this``.
---------------------------------------------------
.. cpp:function:: operator bool() const;
**Returns**: ``true`` if ``*this`` holds reference to a value, ``false`` otherwise.
---------------------------------------------------
.. cpp:function:: value_type& value();
**Returns**: a reference to a ``value_type`` object stored in ``concurrent_lru_cache``.
The behavior is undefined if ``*this`` does not refer to any value.
@@ -0,0 +1,118 @@
.. _constraints_extensions:
task_arena::constraints extensions
======================================
.. note::
To enable this feature, set the ``TBB_PREVIEW_TASK_ARENA_CONSTRAINTS_EXTENSION`` macro to 1.
.. contents::
:local:
:depth: 1
Description
***********
These extensions allow to customize ``tbb::task_arena::constraints`` with the following properties:
* On machines with Intel® Hybrid Technology set the preferred core type for threads working within the task arena.
* Limit the maximum number of threads that can be scheduled to one core simultaneously.
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/task_arena.h>
Synopsis
--------
.. code:: cpp
namespace oneapi {
namespace tbb {
class task_arena {
public:
struct constraints {
constraints& set_numa_id(numa_node_id id);
constraints& set_max_concurrency(int maximal_concurrency);
constraints& set_core_type(core_type_id id);
constraints& set_max_threads_per_core(int threads_number);
numa_node_id numa_id = task_arena::automatic;
int max_concurrency = task_arena::automatic;
core_type_id core_type = task_arena::automatic;
int max_threads_per_core = task_arena::automatic;
}; // struct constraints
}; // class task_arena
} // namespace tbb
} // namespace oneapi
Member Functions
----------------
.. cpp:function:: constraints& set_numa_id(numa_node_id id)
Sets the ``numa_id`` field to the ``id``.
**Returns:** Reference to ``*this``.
.. cpp:function:: constraints& set_max_concurrency(int maximal_concurrency)
Sets the ``max_concurrency`` field to the ``maximal_concurrency``.
**Returns:** Reference to ``*this``.
.. cpp:function:: constraints& set_core_type(core_type_id id)
Sets the ``core_type`` field to the ``id``.
**Returns:** Reference to ``*this``.
.. cpp:function:: constraints& set_max_threads_per_core(int threads_number)
Sets the ``max_threads_per_core`` field to the ``threads_number``.
**Returns:** Reference to ``*this``.
Member Objects
--------------
.. cpp:member:: numa_node_id numa_id
An integral logical index uniquely identifying a NUMA node. All threads joining the
``task_arena`` are bound to this NUMA node.
.. note::
To obtain a valid NUMA node ID, call ``oneapi::tbb::info::numa_nodes()``.
.. cpp:member:: int max_concurrency
The maximum number of threads that can participate in work processing within the
``task_arena`` at the same time.
.. cpp:member:: core_type_id core_type
An integral logical index uniquely identifying a core type. All threads joining the
``task_arena`` are bound to this core type.
.. note::
To obtain a valid core type node ID, call ``oneapi::tbb::info::core_types()``.
.. cpp:member:: int max_threads_per_core
The maximum number of threads that can be scheduled to one core simultaneously.
See also:
* :doc:`oneapi::tbb::info namespace preview extensions <info_namespace_extensions>`
* `oneapi::tbb::task_arena specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/task_scheduler/task_arena/task_arena_cls.html>`_
@@ -0,0 +1,104 @@
.. _constructors_for_fg_nodes:
Constructors for Flow Graph nodes
=================================
.. note::
To enable this feature, define the ``TBB_PREVIEW_FLOW_GRAPH_FEATURES`` macro to 1.
.. contents::
:local:
:depth: 1
Description
***********
The "Helper Functions for Expressing Graphs" feature adds a set of new constructors
that can be used to construct a node that ``follows`` or ``precedes`` a set of nodes.
Where possible, the constructors support Class Template Argument Deduction (since C++17).
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/flow_graph.h>
Syntax
------
.. code:: cpp
// continue_node
continue_node(follows(...), Body body, Policy = Policy());
continue_node(precedes(...), Body body, Policy = Policy());
continue_node(follows(...), int number_of_predecessors, Body body, Policy = Policy());
continue_node(precedes(...), int number_of_predecessors, Body body, Policy = Policy());
// function_node
function_node(follows(...), std::size_t concurrency, Policy = Policy());
function_node(precedes(...), std::size_t concurrency, Policy = Policy());
// input_node
input_node(precedes(...), body);
// multifunction_node
multifunction_node(follows(...), std::size_t concurrency, Body body);
multifunction_node(precedes(...), std::size_t concurrency, Body body);
// async_node
async_node(follows(...), std::size_t concurrency, Body body);
async_node(precedes(...), std::size_t concurrency, Body body);
// overwrite_node
explicit overwrite_node(follows(...));
explicit overwrite_node(precedes(...));
// write_once_node
explicit write_once_node(follows(...));
explicit write_once_node(precedes(...));
// buffer_node
explicit buffer_node(follows(...));
explicit buffer_node(precedes(...));
// queue_node
explicit queue_node(follows(...));
explicit queue_node(precedes(...));
// priority_queue_node
explicit priority_queue_node(follows(...), const Compare& comp = Compare());
explicit priority_queue_node(precedes(...), const Compare& compare = Compare());
// sequencer_node
sequencer_node(follows(...), const Sequencer& s);
sequencer_node(precedes(...), const Sequencer& s);
// limiter_node
limiter_node(follows(...), std::size_t threshold);
limiter_node(precedes(...), std::size_t threshold);
// broadcast_node
explicit broadcast_node(follows(...));
explicit broadcast_node(precedes(...));
// join_node
explicit join_node(follows(...), Policy = Policy());
explicit join_node(precedes(...), Policy = Policy());
// split_node
explicit split_node(follows(...));
explicit split_node(precedes(...));
// indexer_node
indexer_node(follows(...));
indexer_node(precedes(...));
See Also
********
:ref:`follows_precedes`
+158
View File
@@ -0,0 +1,158 @@
.. _custom_mutex_chmap:
The customizing mutex type for ``concurrent_hash_map``
======================================================
.. note::
To enable this feature, define the ``TBB_PREVIEW_CONCURRENT_HASH_MAP_EXTENSIONS`` macro to 1.
.. contents::
:local:
:depth: 1
Description
***********
oneTBB ``concurrnent_hash_map`` class uses reader-writer mutex
to provide thread safety and avoid data races for insert, lookup, and erasure operations. This feature adds an extra template parameter
for ``concurrent_hash_map`` that allows to customize the type of the reader-writer mutex.
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/concurrent_hash_map.h>
Synopsis
--------
.. code:: cpp
namespace oneapi {
namespace tbb {
template <typename Key, typename T,
typename HashCompare = tbb_hash_compare<Key>,
typename Allocator = tbb_allocator<std::pair<const Key, T>>,
typename Mutex = spin_rw_mutex>
class concurrent_hash_map {
using mutex_type = Mutex;
};
} // namespace tbb
} // namespace oneapi
Type requirements
-----------------
The type of the mutex passed as a template argument for ``concurrent_hash_map`` should
meet the requirements of `ReaderWriterMutex <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/named_requirements/mutexes/rw_mutex.html>`_.
It should also provide the following API:
.. cpp:function:: bool ReaderWriterMutex::scoped_lock::is_writer() const;
**Returns**: ``true`` if the ``scoped_lock`` object acquires the mutex as a writer, ``false`` otherwise.
The behavior is undefined if the ``scoped_lock`` object does not acquire the mutex.
``oneapi::tbb::spin_rw_mutex``, ``oneapi::tbb::speculative_spin_rw_mutex``, ``oneapi::tbb::queuing_rw_mutex``, ``oneapi::tbb::null_rw_mutex``,
and ``oneapi::tbb::rw_mutex`` meet the requirements above.
.. rubric:: Example
The example below demonstrates how to wrap ``std::shared_mutex`` (C++17) to meet the requirements
of `ReaderWriterMutex` and how to customize ``concurrent_hash_map`` to use this mutex.
.. code:: cpp
#define TBB_PREVIEW_CONCURRENT_HASH_MAP_EXTENSIONS 1
#include "oneapi/tbb/concurrent_hash_map.h"
#include <shared_mutex>
class SharedMutexWrapper {
public:
// ReaderWriterMutex requirements
static constexpr bool is_rw_mutex = true;
static constexpr bool is_recursive_mutex = false;
static constexpr bool is_fair_mutex = false;
class scoped_lock {
public:
scoped_lock() : my_mutex_ptr(nullptr), my_writer_flag(false) {}
scoped_lock(SharedMutexWrapper& mutex, bool write = true)
: my_mutex_ptr(&mutex), my_writer_flag(write)
{
if (my_writer_flag) {
my_mutex_ptr->my_mutex.lock();
} else {
my_mutex_ptr->my_mutex.lock_shared();
}
}
~scoped_lock() {
if (my_mutex_ptr) release();
}
void acquire(SharedMutexWrapper& mutex, bool write = true) {
if (my_mutex_ptr) release();
my_mutex_ptr = &mutex;
my_writer_flag = write;
if (my_writer_flag) {
my_mutex_ptr->my_mutex.lock();
} else {
my_mutex_ptr->my_mutex.lock_shared();
}
}
void release() {
if (my_writer_flag) {
my_mutex_ptr->my_mutex.unlock();
} else {
my_mutex_ptr->my_mutex.unlock_shared();
}
}
bool upgrade_to_writer() {
// std::shared_mutex does not have the upgrade/downgrade parallel_for_each_semantics
if (my_writer_flag) return true; // Already a writer
my_mutex_ptr->my_mutex.unlock_shared();
my_mutex_ptr->my_mutex.lock();
return false; // The lock was reacquired
}
bool downgrade_to_reader() {
if (!my_writer_flag) return true; // Already a reader
my_mutex_ptr->my_mutex.unlock();
my_mutex_ptr->my_mutex.lock_shared();
return false;
}
bool is_writer() const {
return my_writer_flag;
}
private:
SharedMutexWrapper* my_mutex_ptr;
bool my_writer_flag;
};
private:
std::shared_mutex my_mutex;
}; // struct SharedMutexWrapper
int main() {
using map_type = oneapi::tbb::concurrent_hash_map<int, int,
oneapi::tbb::tbb_hash_compare<int>,
oneapi::tbb::tbb_allocator<std::pair<const int, int>>,
SharedMutexWrapper>;
map_type map; // This object will use SharedMutexWrapper for thread safety of insert/find/erase operations
}
@@ -0,0 +1,78 @@
.. _follows_precedes:
``follows`` and ``precedes`` function templates
===============================================
.. note::
To enable this feature, define the ``TBB_PREVIEW_FLOW_GRAPH_FEATURES`` macro to 1.
The ``follows`` and ``precedes`` helper functions aid in expressing
dependencies between nodes when building oneTBB flow graphs. These helper functions can
only be used while constructing the node.
.. contents::
:local:
:depth: 1
Description
***********
The ``follows`` helper function specifies that the node being constructed is
the successor of the set of nodes passed as an argument.
The ``precedes`` helper function specifies that the node being constructed is
the predecessor of the set of nodes passed as an argument.
Functions ``follows`` and ``precedes`` are meant to replace the graph argument, which is
passed as the first argument to the constructor of the node. The graph argument for the
node being constructed is obtained either from the specified node set or the sequence of nodes passed
to ``follows`` or ``precedes``.
If the nodes passed to ``follows`` or ``precedes`` belong to
different graphs, the behavior is undefined.
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/flow_graph.h>
Syntax
------
.. code:: cpp
// node_set is an exposition-only name for the type returned from make_node_set function
template <typename NodeType, typename... NodeTypes>
/*unspecified*/ follows( node_set<NodeType, NodeTypes...>& set );
template <typename NodeType, typename... NodeTypes>
/*unspecified*/ follows( NodeType& node, NodeTypes&... nodes );
template <typename NodeType, typename... NodeTypes>
/*unspecified*/ precedes( node_set<NodeType, NodeTypes...>& set );
template <typename NodeType, typename... NodeTypes>
/*unspecified*/ precedes( NodeType& node, NodeTypes&... nodes );
Input Parameters
----------------
Either a set or a sequence of nodes can be used as arguments for ``follows`` and
``precedes``. The following expressions are equivalent:
.. code-block:: cpp
:caption: A set of nodes as an input
auto handlers = make_node_set(n1, n2, n3);
broadcast_node<int> input(precedes(handlers));
.. code-block:: cpp
:caption: A sequence of nodes as an input
broadcast_node<int> input(precedes(n1, n2, n3));
@@ -0,0 +1,118 @@
.. _helpers_for_expressing_graphs:
Helper Functions for Expressing Graphs
======================================
.. note::
To enable this feature, define the ``TBB_PREVIEW_FLOW_GRAPH_FEATURES`` macro to 1.
Helper functions are intended to make creation of the flow graphs less verbose.
.. contents::
:local:
:depth: 1
Description
***********
This feature adds ``make_edges``, ``make_node_set``,
``follows`` and ``precedes`` functions to ``oneapi::tbb::flow`` namespace.
These functions simplify the process of building flow graphs by allowing to gather nodes
into sets and connect them to other nodes in the graph.
API
***
.. toctree::
:titlesonly:
constructors_for_nodes
follows_and_precedes_functions
make_node_set_function
make_edges_function
Example
*******
Consider the graph depicted below.
.. figure:: ./Resources/fg_api_graph_structure.png
:align: center
In the examples below, C++17 Class Template Argument Deduction is used
to avoid template parameter specification where possible.
**Regular API**
.. code:: cpp
#include <oneapi/tbb/flow_graph.h>
int main() {
using namespace oneapi::tbb::flow;
graph g;
broadcast_node<int> input(g);
function_node doubler(g, unlimited, [](const int& v) { return 2 * v; });
function_node squarer(g, unlimited, [](const int&) { return v * v; });
function_node cuber(g, unlimited, [](const int& v) { return v * v * v; });
join_node<std::tuple<int, int, int>> join(g);
int sum = 0;
function_node summer(g, serial, [&](const std::tuple<int, int, int>& v) {
int sub_sum = std::get<0>(v) + std::get<1>(v) + std::get<2>(v);
sum += sub_sum;
return sub_sum;
});
make_edge(input, doubler);
make_edge(input, squarer);
make_edge(input, cuber);
make_edge(doubler, std::get<0>(join.input_ports()));
make_edge(squarer, std::get<1>(join.input_ports()));
make_edge(cuber, std::get<2>(join.input_ports()));
make_edge(join, summer);
for (int i = 1; i <= 10; ++i) {
input.try_put(i);
}
g.wait_for_all();
}
**Preview API**
.. code:: cpp
#define TBB_PREVIEW_FLOW_GRAPH_FEATURES 1
#include <oneapi/tbb/flow_graph.h>
int main() {
using namespace oneapi::tbb::flow;
graph g;
function_node doubler(g, unlimited, [](const int& v) { return 2 * v; });
function_node squarer(g, unlimited, [](const int&) { return v * v; });
function_node cuber(g, unlimited, [](const int& v) { return v * v * v; });
auto handlers = make_node_set(doubler, squarer, cuber);
broadcast_node input(precedes(handlers));
join_node join(follows(handlers));
int sum = 0;
function_node summer(follows(join), serial,
[&](const std::tuple<int, int, int>& v) {
int sub_sum = std::get<0>(v) + std::get<1>(v) + std::get<2>(v);
sum += sub_sum;
return sub_sum;
});
for (int i = 1; i <= 10; ++i) {
input.try_put(i);
}
g.wait_for_all();
}
+17
View File
@@ -0,0 +1,17 @@
.. _info_namespace:
oneapi::tbb::info namespace
===========================
The ``oneapi::tbb::info`` namespace satisfies `the corresponding oneTBB specification section
<https://spec.oneapi.com/versions/latest/elements/oneTBB/source/info_namespace.html>`_.
The |full_name| implementation requires `the hwloc library <https://www-lb.open-mpi.org/projects/hwloc>`_
to query NUMA(version >= 1.11) and Hybrid CPUs(version >= 2.4) topology information.
See also:
* `info namespace specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/info_namespace.html>`_
* `oneapi::tbb::task_arena specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/task_scheduler/task_arena/task_arena_cls.html>`_
* :doc:`oneapi::tbb::info namespace preview extensions <info_namespace_extensions>`
* :doc:`task_arena::constraints class preview extensions <constraints_extensions>`
@@ -0,0 +1,71 @@
.. _info_namespace_extensions:
oneapi::tbb::info namespace extensions
======================================
.. note::
To enable this feature, set the ``TBB_PREVIEW_TASK_ARENA_CONSTRAINTS_EXTENSION`` macro to 1.
.. contents::
:local:
:depth: 1
Description
***********
These extensions allow to query information about execution environment.
.. contents::
:local:
:depth: 1
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/info.h>
Syntax
------
.. code:: cpp
namespace oneapi {
namespace tbb {
using core_type_id = /*implementation-defined*/;
namespace info {
std::vector<core_type_id> core_types();
int default_concurrency(task_arena::constraints c);
}
}
}
Types
-----
``core_type_id`` - Represents core type identifier.
Functions
---------
.. cpp:function:: std::vector<core_type_id> core_types()
Returns the vector of integral indexes that indicate available core types.
The indexes are sorted from the least performant to the most performant core type.
.. note::
If error occurs during system topology parsing, returns vector containing single element
that equals to ``task_arena::automatic``.
.. cpp:function:: int default_concurrency(task_arena::constraints c)
Returns concurrency level for the given constraints.
See also:
* :doc:`task_arena::constraints class preview extensions <constraints_extensions>`
* `info namespace specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/info_namespace.html>`_
@@ -0,0 +1,81 @@
.. _make_edges:
``make_edges`` function template
================================
.. note::
To enable this feature, define the ``TBB_PREVIEW_FLOW_GRAPH_FEATURES`` macro to 1.
.. contents::
:local:
:depth: 1
Description
***********
The ``make_edges`` function template creates edges between a single node
and each node in a set of nodes.
There are two ways to connect nodes in a set and a single node using
``make_edges``:
.. figure:: ./Resources/make_edges_usage.png
:align: center
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/flow_graph.h>
Syntax
------
.. code:: cpp
// node_set is an exposition-only name for the type returned from make_node_set function
template <typename NodeType, typename Node, typename... Nodes>
void make_edges(node_set<Node, Nodes...>& set, NodeType& node);
template <typename NodeType, typename Node, typename... Nodes>
void make_edges(NodeType& node, node_set<Node, Nodes...>& set);
Example
-------
The example implements the graph structure in the picture below.
.. figure:: ./Resources/make_edges_example.png
:align: center
.. code:: cpp
#define TBB_PREVIEW_FLOW_GRAPH_FEATURES 1
#include <oneapi/tbb/flow_graph.h>
int main() {
using namespace oneapi::tbb::flow;
graph g;
broadcast_node<int> input(g);
function_node doubler(g, unlimited, [](const int& i) { return 2 * i; });
function_node squarer(g, unlimited, [](const int& i) { return i * i; });
function_node cuber(g, unlimited, [](const int& i) { return i * i * i; });
buffer_node<int> buffer(g);
auto handlers = make_node_set(doubler, squarer, cuber);
make_edges(input, handlers);
make_edges(handlers, buffer);
for (int i = 1; i <= 10; ++i) {
input.try_put(i);
}
g.wait_for_all();
}
@@ -0,0 +1,42 @@
.. _make_node_set:
``make_node_set`` function template
===================================
.. note::
To enable this feature, define the ``TBB_PREVIEW_FLOW_GRAPH_FEATURES`` macro to 1.
.. contents::
:local:
:depth: 1
Description
***********
The ``make_node_set`` function template creates a set of nodes that
can be passed as arguments to ``make_edges``, ``follows`` and ``precedes`` functions.
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/flow_graph.h>
Syntax
------
.. code:: cpp
template <typename Node, typename... Nodes>
/*unspecified*/ make_node_set( Node& node, Nodes&... nodes );
See Also
********
:ref:`make_edges`
:ref:`follows_precedes`
@@ -0,0 +1,66 @@
.. _parallel_for_each_semantics:
parallel_for_each Body semantics and requirements
=================================================
.. contents::
:local:
:depth: 1
Description
***********
This page clarifies `ParallelForEachBody <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/named_requirements/algorithms/par_for_each_body.html>`_
named requirements for ``tbb::parallel_for_each`` algorithm specification.
.. code:: cpp
namespace oneapi {
namespace tbb {
template <typaname InputIterator, typename Body>
void parallel_for_each( InputIterator first, InputIterator last, Body body ); // overload (1)
template <typename InputIterator, typename Body>
void parallel_for_each( InputIterator first, InputIterator last, Body body, task_group_context& group ); // overload (2)
template <typename Container, typename Body>
void parallel_for_each( Container& c, Body body ); // overload (3)
template <typename Container, typename Body>
void parallel_for_each( Container& c, Body body, task_group_context& group ); // overload (4)
template <typename Container, typename Body>
void parallel_for_each( const Container& c, Body body ); // overload (5)
template <typename Container, typename Body>
void parallel_for_each( const Container& c, Body body, task_group_context& group ); // overload (6)
} // namespace tbb
} // namespace oneapi
Terms
-----
* ``iterator`` determines the type of the iterator passed into ``parallel_for_each`` algorithm (which is ``InputIterator`` for overloads `(1)` and `(2)`
and ``decltype(std::begin(c))`` for overloads `(3) - (6)`)
* ``value_type`` - the type ``typename std::iterator_traits<iterator>::value_type``
* ``reference`` - the type ``typename std::iterator_traits<iterator>::reference``.
Requirements for different iterator types
-----------------------------------------
If the ``iterator`` satisfies `Input iterator` named requirements from [input.iterators] ISO C++ Standard section and do not satisfies
`Forward iterator` named requirements from [forward.iterators] ISO C++ Standard section, ``tbb::parallel_for_each`` requires the execution
of the ``body`` with an object of type ``const value_type&`` or ``value_type&&`` to be well-formed. If both forms are well-formed, an overload with
rvalue reference will be preferred.
.. caution::
If the ``Body`` only takes non-const lvalue reference to ``value_type``, named requirements above are violated and the program can be ill-formed.
If the ``iterator`` satisfies `Forward iterator` named requirements from [forward.iterators] ISO C++ Standard section, ``tbb::parallel_for_each`` requires the execution of the ``body``
with an object of type ``reference`` to be well-formed.
Requirements for ``Body`` with ``feeder`` argument
--------------------------------------------------
Additional elements submitted into ``tbb::parallel_for_each`` through the ``feeder::add`` passes to the ``Body`` as rvalues and therefore the corresponding
execution of the ``Body`` is required to be well-formed.
@@ -0,0 +1,72 @@
.. _parallel_sort_ranges_extension:
parallel_sort ranges interface extension
========================================
.. contents::
:local:
:depth: 1
Description
***********
|full_name| implementation extends the `oneapi::tbb::parallel_sort specification <https://spec.oneapi.io/versions/latest/elements/oneTBB/source/algorithms/functions/parallel_sort_func.html>`_
with overloads that takes the container by forwarding reference.
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/parallel_sort.h>
Syntax
------
.. code:: cpp
namespace oneapi {
namespace tbb {
template <typename Container>
void parallel_sort( Container&& c );
template <typename Container, typename Compare>
void parallel_sort( Container&& c, const Compare& comp );
} // namespace tbb
} // namespace oneapi
Functions
---------
.. cpp:function:: template <typename Container> void parallel_sort( Container&& c );
Equivalent to ``parallel_sort( std::begin(c), std::end(c), comp )``, where `comp` uses `operator<` to determine relative orderings.
.. cpp:function:: template <typename Container, typename Compare> void parallel_sort( Container&& c, const Compare& comp );
Equivalent to ``parallel_sort( std::begin(c), std::end(c), comp )``.
Example
-------
This interface may be used for sorting rvalue or constant views:
.. code:: cpp
#include <array>
#include <span> // requires C++20
#include <oneapi/tbb/parallel_sort.h>
std::span<int> get_span() {
static std::array<int, 3> arr = {3, 2, 1};
return std::span<int>(arr);
}
int main() {
tbb::parallel_sort(get_span());
}
+53
View File
@@ -0,0 +1,53 @@
.. _reference:
|short_name| API Reference
==========================
For oneTBB API Reference, refer to `oneAPI Specification <https://spec.oneapi.com/>`_. The current supported
version of oneAPI Specification is 1.0.
Specification extensions
************************
|full_name| implements the `oneTBB specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/nested-index.html>`_.
This document provides additional details or restrictions where necessary.
It also describes features that are not included in the oneTBB specification.
.. toctree::
:titlesonly:
info_namespace
parallel_for_each_semantics
parallel_sort_ranges_extension
Preview features
****************
A preview feature is a component of oneTBB introduced to receive early feedback from
users.
The key properties of a preview feature are:
- It is off by default and must be explicitly enabled.
- It is intended to have a high quality implementation.
- There is no guarantee of future existence or compatibility.
- It may have limited or no support in tools such as correctness analyzers, profilers and debuggers.
.. caution::
A preview feature is subject to change in future. It might be removed or significantly
altered in future releases. Changes to a preview feature do NOT require
usual deprecation and removal process. Therefore, using preview features in production code
is strongly discouraged.
.. toctree::
:titlesonly:
type_specified_message_keys
scalable_memory_pools
helpers_for_expressing_graphs
concurrent_lru_cache_cls
constraints_extensions
info_namespace_extensions
task_group_extensions
custom_mutex_chmap
@@ -0,0 +1,43 @@
.. _scalable_memory_pools_reference:
Scalable Memory Pools
=====================
.. note::
To enable this feature, set the ``TBB_PREVIEW_MEMORY_POOL`` macro to 1.
Memory pools allocate and free memory from a specified region or an underlying allocator using
thread-safe, scalable operations. The following table summarizes the Memory Pool named requirement.
Here, ``P`` represents an instance of the memory pool class.
.. container:: tablenoborder
.. list-table::
:header-rows: 1
* - Pseudo-Signature
- Semantics
* - \ ``~P() throw();``
- Destructor. Frees all the allocated memory.
* - \ ``void P::recycle();``
- Frees all the allocated memory.
* - \ ``void* P::malloc(size_t n);``
- Returns a pointer to ``n`` bytes allocated from the memory pool.
* - \ ``void P::free(void* ptr);``
- Frees the memory object specified via ``ptr`` pointer.
* - \ ``void* P::realloc(void* ptr, size_t n);``
- Reallocates the memory object pointed by ``ptr`` to ``n`` bytes.
.. container:: section
.. rubric:: Model Types
:class: sectiontitle
The ``memory_pool`` template class and the ``fixed_pool`` class meet the Memory Pool named requirement.
.. toctree::
:titlesonly:
scalable_memory_pools/memory_pool_cls
scalable_memory_pools/fixed_pool_cls
scalable_memory_pools/memory_pool_allocator_cls
@@ -0,0 +1,76 @@
.. _fixed_pool_cls:
fixed_pool
==========
.. note::
To enable this feature, set the ``TBB_PREVIEW_MEMORY_POOL`` macro to 1.
A class for scalable memory allocation from a buffer of fixed size.
.. contents::
:local:
:depth: 1
Description
***********
``fixed_pool`` allocates and frees memory in a way that scales with the number of processors.
All the memory available for the allocation is initially passed through arguments of the constructor.
``fixed_pool`` meet the :doc:`Memory Pool named requirement<../scalable_memory_pools>`.
API
***
Header
------
.. code:: cpp
#include "oneapi/tbb/memory_pool.h"
Synopsis
--------
.. code:: cpp
namespace oneapi {
namespace tbb {
class fixed_pool {
public:
fixed_pool(void *buffer, size_t size);
fixed_pool(const fixed_pool& other) = delete;
fixed_pool& operator=(const fixed_pool& other) = delete;
~fixed_pool();
void recycle();
void* malloc(size_t size);
void free(void* ptr);
void* realloc(void* ptr, size_t size);
};
} // namespace tbb
} // namespace oneapi
Member Functions
----------------
.. cpp:function:: fixed_pool(void *buffer, size_t size)
**Effects**: Constructs a memory pool to manage the memory of size ``size`` pointed to by ``buffer``.
Throws the ``bad_alloc`` exception if the library fails to construct an instance of the class.
Examples
********
The code below provides a simple example of allocation from a fixed pool.
.. code:: cpp
#define TBB_PREVIEW_MEMORY_POOL 1
#include "oneapi/tbb/memory_pool.h"
...
char buf[1024*1024];
oneapi::tbb::fixed_pool my_pool(buf, 1024*1024);
void* my_ptr = my_pool.malloc(10);
my_pool.free(my_ptr);}
@@ -0,0 +1,117 @@
.. _memory_pool_allocator_cls:
memory_pool_allocator
=====================
.. note::
To enable this feature, set the ``TBB_PREVIEW_MEMORY_POOL`` macro to 1.
A class template that provides a memory pool with a C++ allocator interface.
.. contents::
:local:
:depth: 1
Description
***********
``memory_pool_allocator`` meets the allocator requirements from the [allocator.requirements] ISO C++ Standard section
It also provides a constructor to allocate and deallocate memory.
This constructor is linked with an instance of either the ``memory_pool`` or the ``fixed_pool`` class.
The class is mainly intended for enabling memory pools within STL containers.
API
***
Header
------
.. code:: cpp
#include "oneapi/tbb/memory_pool.h"
Synopsis
--------
.. code:: cpp
namespace oneapi {
namespace tbb {
template<typename T>
class memory_pool_allocator {
public:
using value_type = T;
using pointer = value_type*;
using const_pointer = const value_type*;
using reference = value_type&;
using const_reference = const value_type&;
using size_type = size_t;
using difference_type = ptrdiff_t;
template<typename U> struct rebind {
using other = memory_pool_allocator<U>;
};
explicit memory_pool_allocator(memory_pool &pool) throw();
explicit memory_pool_allocator(fixed_pool &pool) throw();
memory_pool_allocator(const memory_pool_allocator& src) throw();
template<typename U>
memory_pool_allocator(const memory_pool_allocator<U,P>& src) throw();
pointer address(reference x) const;
const_pointer address(const_reference x) const;
pointer allocate(size_type n, const void* hint=0);
void deallocate(pointer p, size_type);
size_type max_size() const throw();
void construct(pointer p, const T& value);
void destroy(pointer p);
};
template<>
class memory_pool_allocator<void> {
public:
using pointer = void*;
using const_pointer = const void*;
using value_type = void;
template<typename U> struct rebind {
using other = memory_pool_allocator<U>;
};
memory_pool_allocator(memory_pool &pool) throw();
memory_pool_allocator(fixed_pool &pool) throw();
memory_pool_allocator(const memory_pool_allocator& src) throw();
template<typename U>
memory_pool_allocator(const memory_pool_allocator<U>& src) throw();
};
} // namespace tbb
} // namespace oneapi
template<typename T, typename U>
inline bool operator==( const memory_pool_allocator<T>& a,
const memory_pool_allocator<U>& b);
template<typename T, typename U>
inline bool operator!=( const memory_pool_allocator<T>& a,
const memory_pool_allocator<U>& b);
Member Functions
----------------
.. cpp:function:: explicit memory_pool_allocator(memory_pool &pool)
**Effects**: Constructs a memory pool allocator serviced by ``memory_pool`` instance pool.
-------------------------------------------------------
.. cpp:function:: explicit memory_pool_allocator(fixed_pool &pool)
**Effects**: Constructs a memory pool allocator serviced by ``fixed_pool`` instance pool.
Examples
********
The code below provides a simple example of container construction with the use of a memory pool.
.. code:: cpp
#define TBB_PREVIEW_MEMORY_POOL 1
#include "oneapi/tbb/memory_pool.h"
...
typedef oneapi::tbb::memory_pool_allocator<int>
pool_allocator_t;
std::list<int, pool_allocator_t> my_list(pool_allocator_t( my_pool ));
@@ -0,0 +1,80 @@
.. _memory_pool_cls:
memory_pool
===========
.. note::
To enable this feature, set the ``TBB_PREVIEW_MEMORY_POOL`` macro to 1.
A class template for scalable memory allocation from memory blocks provided by an underlying allocator.
.. contents::
:local:
:depth: 1
Description
***********
A ``memory_pool`` allocates and frees memory in a way that scales with the number of processors.
The memory is obtained as big chunks from an underlying allocator specified by the template
argument. The latter must satisfy the subset of the allocator requirements from the [allocator.requirements]
ISO C++ Standard section. A ``memory_pool`` meet the :doc:`Memory Pool named requirement<../scalable_memory_pools>`.
.. caution::
If the underlying allocator refers to another scalable memory pool, the inner pool (or pools)
must be destroyed before the outer pool is destroyed or recycled.
API
***
Header
------
.. code:: cpp
#include "oneapi/tbb/memory_pool.h"
Synopsis
--------
.. code:: cpp
namespace oneapi {
namespace tbb {
template <typename Alloc>
class memory_pool {
public:
explicit memory_pool(const Alloc &src = Alloc());
memory_pool(const memory_pool& other) = delete;
memory_pool& operator=(const memory_pool& other) = delete;
~memory_pool();
void recycle();
void *malloc(size_t size);
void free(void* ptr);
void *realloc(void* ptr, size_t size);
};
}
}
Member Functions
----------------
.. cpp:function:: explicit memory_pool(const Alloc &src = Alloc())
**Effects**: Constructs a memory pool with an instance of underlying memory allocator of type ``Alloc`` copied from ``src``.
Throws the ``bad_alloc`` exception if runtime fails to construct an instance of the class.
Examples
********
The code below provides a simple example of allocation from an extensible memory pool.
.. code:: cpp
#define TBB_PREVIEW_MEMORY_POOL 1
#include "oneapi/tbb/memory_pool.h"
...
oneapi::tbb::memory_pool<std::allocator<char> > my_pool;
void* my_ptr = my_pool.malloc(10);
my_pool.free(my_ptr);
@@ -0,0 +1,91 @@
.. _task_group_extensions:
task_group extensions
=====================
.. note::
To enable these extensions, set the ``TBB_PREVIEW_TASK_GROUP_EXTENSIONS`` macro to 1.
.. contents::
:local:
:depth: 1
Description
***********
|full_name| implementation extends the `tbb::task_group specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/task_scheduler/task_group/task_group_cls.html>`_ with the following members:
- requirements for a user-provided function object
API
***
Header
------
.. code:: cpp
#include <oneapi/tbb/task_group.h>
Synopsis
--------
.. code:: cpp
namespace oneapi {
namespace tbb {
class task_group {
public:
//only the requirements for the return type of function F are changed
template<typename F>
task_handle defer(F&& f);
//only the requirements for the return type of function F are changed
template<typename F>
task_group_status run_and_wait(const F& f);
//only the requirements for the return type of function F are changed
template<typename F>
void run(F&& f);
};
} // namespace tbb
} // namespace oneapi
Member Functions
----------------
.. cpp:function:: template<typename F> task_handle defer(F&& f)
As an optimization hint, ``F`` might return a ``task_handle``, which task object can be executed next.
.. note::
The ``task_handle`` returned by the function must be created using ``*this`` ``task_group``. That is, the one for which the run method is called, otherwise it is undefined behavior.
.. cpp:function:: template<typename F> task_group_status run_and_wait(const F& f)
As an optimization hint, ``F`` might return a ``task_handle``, which task object can be executed next.
.. note::
The ``task_handle`` returned by the function must be created using ``*this`` ``task_group``. That is, the one for which the run method is called, otherwise it is undefined behavior.
.. cpp:function:: template<typename F> void run(F&& f)
As an optimization hint, ``F`` might return a ``task_handle``, which task object can be executed next.
.. note::
The ``task_handle`` returned by the function must be created with ``*this`` ``task_group``. It means, with the one for which run method is called, otherwise it is an undefined behavior.
.. rubric:: See also
* `oneapi::tbb::task_group specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/task_scheduler/task_group/task_group_cls.html>`_
* `oneapi::tbb::task_group_context specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/task_scheduler/scheduling_controls/task_group_context_cls.html>`_
* `oneapi::tbb::task_group_status specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/task_scheduler/task_group/task_group_status_enum.html>`_
* :doc:`oneapi::tbb::task_handle class <task_group_extensions/task_handle>`
@@ -0,0 +1,69 @@
.. _class_join_node_extension:
Type-specified message keys for join_node
=========================================
.. note::
To enable this feature, define the ``TBB_PREVIEW_FLOW_GRAPH_FEATURES`` macro to 1.
.. contents::
:local:
:depth: 1
Description
***********
The extension allows a key matching ``join_node`` to obtain keys via functions associated with
its input types. The extension simplifies the existing approach by removing the need to
provide a function object for each input port of ``join_node``.
API
***
Header
------
.. code:: cpp
#include "oneapi/tbb/flow_graph.h"
Syntax
------
The extension adds a special constructor to the ``join_node`` interface when the
``key_matching<typename K, class KHash=tbb_hash_compare>`` policy is
used. The constructor has the following signature:
.. code:: cpp
join_node( graph &g )
When constructed this way, a ``join_node`` calls the
``key_from_message`` function for each incoming message to obtain the key associated
with it. The default implementation of ``key_from_message`` is the following
.. code:: cpp
namespace oneapi {
namespace tbb {
namespace flow {
template <typename K, typename T>
K key_from_message( const T &t ) {
return t.key();
}
}
}
}
``T`` is one of the user-provided types in ``OutputTuple`` and is
used to construct the ``join_node``, and ``K`` is the key type
of the node.
By default, the ``key()`` method defined in the message class will be called.
Alternatively, the user can define its own ``key_from_message`` function in the
same namespace with the message type. This function will be found via C++ argument-dependent
lookup and used in place of the default implementation.
See Also
********
`join_node Specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/flow_graph/join_node_cls.html>`_
@@ -0,0 +1,96 @@
.. _Advanced_Example:
Advanced Example
================
An example of a more advanced associative operation is to find the index
where ``Foo(i)`` is minimized. A serial version might look like this:
::
long SerialMinIndexFoo( const float a[], size_t n ) {
float value_of_min = FLT_MAX; // FLT_MAX from <climits>
long index_of_min = -1;
for( size_t i=0; i<n; ++i ) {
float value = Foo(a[i]);
if( value<value_of_min ) {
value_of_min = value;
index_of_min = i;
}
}
return index_of_min;
}
The loop works by keeping track of the minimum value found so far, and
the index of this value. This is the only information carried between
loop iterations. To convert the loop to use ``parallel_reduce``, the
function object must keep track of the carried information, and how to
merge this information when iterations are spread across multiple
threads. Also, the function object must record a pointer to ``a`` to
provide context.
The following code shows the complete function object.
::
class MinIndexFoo {
const float *const my_a;
public:
float value_of_min;
long index_of_min;
void operator()( const blocked_range<size_t>& r ) {
const float *a = my_a;
for( size_t i=r.begin(); i!=r.end(); ++i ) {
float value = Foo(a[i]);
if( value<value_of_min ) {
value_of_min = value;
index_of_min = i;
}
}
}
 
MinIndexFoo( MinIndexFoo& x, split ) :
my_a(x.my_a),
value_of_min(FLT_MAX), // FLT_MAX from <climits>
index_of_min(-1)
{}
 
void join( const SumFoo& y ) {
if( y.value_of_min<value_of_min ) {
value_of_min = y.value_of_min;
index_of_min = y.index_of_min;
}
}
MinIndexFoo( const float a[] ) :
my_a(a),
value_of_min(FLT_MAX), // FLT_MAX from <climits>
index_of_min(-1),
{}
};
Now ``SerialMinIndex`` can be rewritten using ``parallel_reduce`` as
shown below:
::
long ParallelMinIndexFoo( float a[], size_t n ) {
MinIndexFoo mif(a);
parallel_reduce(blocked_range<size_t>(0,n), mif );
return mif.index_of_min;
}
@@ -0,0 +1,75 @@
.. _Advanced_Topic_Other_Kinds_of_Iteration_Spaces:
Advanced Topic: Other Kinds of Iteration Spaces
===============================================
The examples so far have used the class ``blocked_range<T>`` to specify ranges.
This class is useful in many situations, but it does not fit every situation.
You can use |full_name| to define your own iteration space objects. The object
must specify how it can be split into subspaces by providing a basic splitting
constructor, an optional proportional splitting constructor, and two predicate
methods. If your class is called ``R``, the methods and constructors should be
as follows:
::
class R {
// True if range is empty
bool empty() const;
// True if range can be split into non-empty subranges
bool is_divisible() const;
// Splits r into subranges r and *this
R( R& r, split );
// (optional) Splits r into subranges r and *this in proportion p
R( R& r, proportional_split p );
...
};
The method ``empty`` should return true if the range is empty. The
method ``is_divisible`` should return true if the range can be split
into two non-empty subspaces, and such a split is worth the overhead.
The basic splitting constructor should take two arguments:
- The first of type ``R``
- The second of type oneapi::tbb::split
The second argument is not used; it serves only to distinguish the
constructor from an ordinary copy constructor. The basic splitting
constructor should attempt to split ``r`` roughly into two halves, and
update ``r`` to be the first half, and set the constructed object as the
second half.
Unlike the basic splitting constructor, the proportional splitting
constructor is optional and takes the second argument of type
``oneapi::tbb::proportional_split``. The type has methods ``left`` and ``right``
that return the values of the proportion. These values should be used to
split ``r`` accordingly, so that the updated ``r`` corresponds to the
left part of the proportion, and the constructed object corresponds to
the right part.
Both splitting constructors should guarantee that the updated ``r`` part
and the constructed object are not empty. The parallel algorithm
templates call the splitting constructors on ``r`` only if
``r.is_divisible`` is true.
The iteration space does not have to be linear. Look at
``oneapi/tbb/blocked_range2d.h`` for an example of a range that is
two-dimensional. Its splitting constructor attempts to split the range
along its longest axis. When used with ``parallel_for``, it causes the
loop to be "recursively blocked" in a way that improves cache usage.
This nice cache behavior means that using ``parallel_for`` over a
``blocked_range2d<T>`` can make a loop run faster than the sequential
equivalent, even on a single processor.
@@ -0,0 +1,42 @@
.. _Allocator_Configuration:
Configuring the Memory Allocator
================================
The oneTBB memory allocator provides the following API functions and
environment variables to configure its behavior:
- the ``scalable_allocation_command`` function instructs the allocator
to perform a certain action, such as cleaning up its internal memory
buffers.
- the ``scalable_allocation_mode`` function allows an application to
set certain parameters for the memory allocator, such as an option to
map memory in huge pages or define a recommended heap size. These
settings take effect until modified by another call to
``scalable_allocation_mode``.
Some of the memory allocator parameters can also be set via system
environment variables. It can be useful to adjust the behavior without
modifying application source code, to ensure that a setting takes effect
as early as possible, or to avoid explicit dependency on the oneTBB
allocator binaries. The following environment variables are recognized:
- ``TBB_MALLOC_USE_HUGE_PAGES`` controls usage of huge pages for memory
mapping.
- ``TBB_MALLOC_SET_HUGE_OBJECT_THRESHOLD`` defines the lower bound for
the size (bytes), that is interpreted as huge and not released during
regular cleanup operations.
These variables only take effect at the time the memory manager is
initialized; later environment changes are ignored. A call to
``scalable_allocation_mode`` overrides the effect of the corresponding
environment variable.
@@ -0,0 +1,23 @@
.. _Automatic_Chunking:
Automatic Chunking
==================
A parallel loop construct incurs overhead cost for every chunk of work
that it schedules. |full_name|
chooses chunk sizes automatically, depending upon load balancing
needs. The heuristic attempts to limit overheads while
still providing ample opportunities for load balancing.
.. CAUTION::
Typically a loop needs to take at least a million clock cycles to
make it worth using ``parallel_for``. For example, a loop that takes
at least 500 microseconds on a 2 GHz processor might benefit from
``parallel_for``.
The default automatic chunking is recommended for most uses. As with
most heuristics, however, there are situations where controlling the
chunk size more precisely might yield better performance.
@@ -0,0 +1,22 @@
.. _Automically_Replacing_malloc:
Automatically Replacing ``malloc`` and Other C/C++ Functions for Dynamic Memory Allocation
==========================================================================================
On Windows*, Linux\* operating systems, it is possible to automatically
replace all calls to standard functions for dynamic memory allocation
(such as ``malloc``) with the |full_name| scalable equivalents.
Doing so can sometimes improve application performance.
Replacements are provided by the proxy library (the library names can be
found in platform-specific sections below). A proxy library and a
scalable memory allocator library should be taken from the same release
of oneTBB, otherwise the libraries may be mutually incompatible.
.. toctree::
:maxdepth: 4
../tbb_userguide/Windows_C_Dynamic_Memory_Interface_Replacement
../tbb_userguide/Linux_C_Dynamic_Memory_Interface_Replacement
@@ -0,0 +1,107 @@
.. _Bandwidth_and_Cache_Affinity:
Bandwidth and Cache Affinity
============================
For a sufficiently simple function ``Foo``, the examples might not show
good speedup when written as parallel loops. The cause could be
insufficient system bandwidth between the processors and memory. In that
case, you may have to rethink your algorithm to take better advantage of
cache. Restructuring to better utilize the cache usually benefits the
parallel program as well as the serial program.
An alternative to restructuring that works in some cases is
``affinity_partitioner.`` It not only automatically chooses the
grainsize, but also optimizes for cache affinity and tries to distribute
the data uniformly among threads. Using ``affinity_partitioner`` can
significantly improve performance when:
- The computation does a few operations per data access.
- The data acted upon by the loop fits in cache.
- The loop, or a similar loop, is re-executed over the same data.
- There are more than two hardware threads available (and especially if
the number of threads is not a power of two). If only two threads are
available, the default scheduling in |full_name|
usually provides sufficient cache affinity.
The following code shows how to use ``affinity_partitioner``.
::
#include "oneapi/tbb.h"
 
void ParallelApplyFoo( float a[], size_t n ) {
static affinity_partitioner ap;
parallel_for(blocked_range<size_t>(0,n), ApplyFoo(a), ap);
}
 
void TimeStepFoo( float a[], size_t n, int steps ) {
for( int t=0; t<steps; ++t )
ParallelApplyFoo( a, n );
}
In the example, the ``affinity_partitioner`` object ``ap`` lives between
loop iterations. It remembers where iterations of the loop ran, so that
each iteration can be handed to the same thread that executed it before.
The example code gets the lifetime of the partitioner right by declaring
the ``affinity_partitioner`` as a local static object. Another approach
would be to declare it at a scope outside the iterative loop in
``TimeStepFoo``, and hand it down the call chain to ``parallel_for``.
If the data does not fit across the system’s caches, there may be little
benefit. The following figure shows the situations.
.. container:: fignone
:name: fig3
Benefit of Affinity Determined by Relative Size of Data Set and Cache
|image0|
The next figure shows how parallel speedup might vary with the size of a
data set. The computation for the example is ``A[i]+=B[i]`` for ``i`` in
the range [0,N). It was chosen for dramatic effect. You are unlikely to
see quite this much variation in your code. The graph shows not much
improvement at the extremes. For small N, parallel scheduling overhead
dominates, resulting in little speedup. For large N, the data set is too
large to be carried in cache between loop invocations. The peak in the
middle is the sweet spot for affinity. Hence ``affinity_partitioner``
should be considered a tool, not a cure-all, when there is a low ratio
of computations to memory accesses.
.. container:: fignone
:name: fig4
Improvement from Affinity Dependent on Array Size
|image1|
.. |image0| image:: Images/image007.jpg
:width: 453px
:height: 178px
.. |image1| image:: Images/image008.jpg
:width: 551px
:height: 192px
@@ -0,0 +1,16 @@
.. _Basic_Flow_Graph_concepts:
Basic Flow Graph Concepts
=========================
.. toctree::
:maxdepth: 4
../tbb_userguide/Graph_Object
../tbb_userguide/Nodes
../tbb_userguide/Edges
../tbb_userguide/Mapping_Nodes2Tasks
../tbb_userguide/Flow_Graph_Message_Passing_Protocol
../tbb_userguide/Flow_Graph_Single_Vs_Broadcast
../tbb_userguide/Flow_Graph_Buffering_in_Nodes
../tbb_userguide/Flow_Graph_Reservation
@@ -0,0 +1,46 @@
.. _Cancellation_Without_An_Exception:
Cancellation Without An Exception
=================================
To cancel an algorithm but not throw an exception, use the expression ``current_context()->cancel_group_execution()``.
The part ``current_context()`` references the ``task_group_context*`` of the currently executing task if any on the current thread.
Calling ``cancel_group_execution()`` cancels all tasks in its ``task_group_context``, which is explained in more detail in :ref:`Cancellation_and_Nested_Parallelism`.
The method returns ``true`` if it actually causes cancellation, ``false`` if the ``task_group_context`` was already cancelled.
The example below shows how to use ``current_context()->cancel_group_execution()``.
::
#include "oneapi/tbb.h"
#include <vector>
#include <iostream>
 
using namespace oneapi::tbb;
using namespace std;
 
vector<int> Data;
 
struct Update {
void operator()( const blocked_range<int>& r ) const {
for( int i=r.begin(); i!=r.end(); ++i )
if( i<Data.size() ) {
++Data[i];
} else {
// Cancel related tasks.
if( current_context()->cancel_group_execution() )
cout << "Index " << i << " caused cancellation\n";
return;
}
}
};
 
int main() {
Data.resize(1000);
parallel_for( blocked_range<int>(0, 2000), Update());
return 0;
}
@@ -0,0 +1,136 @@
.. _Cancellation_and_Nested_Parallelism:
Cancellation and Nested Parallelism
===================================
The discussion so far was simplified by assuming non-nested parallelism
and skipping details of ``task_group_context``. This topic explains
both.
An |full_name| algorithm executes
by creating ``task`` objects that execute the snippets of code that you
supply to the algorithm template. By default, these ``task`` objects are
associated with a ``task_group_context`` created by the algorithm.
Nested oneTBB algorithms create a tree of these ``task_group_context``
objects. Cancelling a ``task_group_context`` cancels all of its child
``task_group_context`` objects, and transitively all its descendants.
Hence an algorithm and all algorithms it called can be cancelled with a
single request.
Exceptions propagate upwards. Cancellation propagates downwards. The
opposition interplays to cleanly stop a nested computation when an
exception occurs. For example, consider the tree in the following
figure. Imagine that each node represents an algorithm and its
``task_group_context``.
.. container:: fignone
:name: fig6
Tree of task_group_context
|image0|
Suppose that the algorithm in C throws an exception and no node catches
the exception. oneTBB propagates the exception upwards, cancelling
related subtrees downwards, as follows:
#. Handle exception in C:
a. Capture exception in C.
b. Cancel tasks in C.
c. Throw exception from C to B.
#. Handle exception in B:
a. Capture exception in B.
b. Cancel tasks in B and, by downwards propagation, in D.
c. Throw an exception out of B to A.
#. Handle exception in A:
a. Capture exception in A.
b. Cancel tasks in A and, by downwards propagation, in E, F, and G.
c. Throw an exception upwards out of A.
If your code catches the exception at any level, then oneTBB does not
propagate it any further. For example, an exception that does not escape
outside the body of a ``parallel_for`` does not cause cancellation of
other iterations.
To prevent downwards propagation of cancellation into an algorithm,
construct an 'isolated' ``task_group_context`` on the stack and pass it
to the algorithm explicitly. The example uses C++11 lambda expressions for brevity.
::
#include "oneapi/tbb.h"
 
bool Data[1000][1000];
 
int main() {
try {
parallel_for( 0, 1000, 1,
[]( int i ) {
task_group_context root(task_group_context::isolated);
parallel_for( 0, 1000, 1,
[]( int ) {
Data[i][j] = true;
},
root);
throw "oops";
});
} catch(...) {
}
return 0;
}
The example performs two parallel loops: an outer loop over ``i`` and
inner loop over ``j``. The creation of the isolated
``task_group_context`` ``root`` protects the inner loop from downwards
propagation of cancellation from the ``i`` loop. When the exception
propagates to the outer loop, any pending ``outer`` iterations are
cancelled, but not inner iterations for an outer iteration that started.
Hence when the program completes, each row of ``Data`` may be different,
depending upon whether its iteration ``i`` ran at all, but within a row,
the elements will be homogeneously ``false`` or ``true``, not a mixture.
Removing the blue text would permit cancellation to propagate down into
the inner loop. In that case, a row of ``Data`` might end up with both
``true`` and ``false`` values.
.. |image0| image:: Images/image013.jpg
:width: 261px
:height: 131px
@@ -0,0 +1,108 @@
.. _Concurrent_Queue_Classes:
Concurrent Queue Classes
========================
Template class ``concurrent_queue<T,Alloc>`` implements a concurrent
queue with values of type ``T``. Multiple threads may simultaneously
push and pop elements from the queue. The queue is unbounded and has no
blocking operations. The fundamental operations on it are ``push`` and
``try_pop``. The ``push`` operation works just like ``push`` for a
std::queue. The operation ``try_pop`` pops an item if it is available.
The check and popping have to be done in a single operation for sake of
thread safety.
For example, consider the following serial code:
::
extern std::queue<T> MySerialQueue;
T item;
if( !MySerialQueue.empty() ) {
item = MySerialQueue.front();
MySerialQueue.pop_front();
... process item...
}
Even if each std::queue method were implemented in a thread-safe manner,
the composition of those methods as shown in the example would not be
thread safe if there were other threads also popping from the same
queue. For example, ``MySerialQueue.empty()`` might return true just
before another thread snatches the last item from ``MySerialQueue``.
The equivalent thread-safe |full_name| code is:
::
extern concurrent_queue<T> MyQueue;
T item;
if( MyQueue.try_pop(item) ) {
...process item...
}
In a single-threaded program, a queue is a first-in first-out structure.
But if multiple threads are pushing and popping concurrently, the
definition of "first" is uncertain. Use of ``concurrent_queue``
guarantees that if a thread pushes two values, and another thread pops
those two values, they will be popped in the same order that they were
pushed.
Template class ``concurrent_queue`` is unbounded and has no methods that
wait. It is up to the user to provide synchronization to avoid overflow,
or to wait for the queue to become non-empty. Typically this is
appropriate when the synchronization has to be done at a higher level.
Template class ``concurrent_bounded_queue<T,Alloc>`` is a variant that
adds blocking operations and the ability to specify a capacity. The
methods of particular interest on it are:
- ``pop(item)`` waits until it can succeed.
- ``push(item)`` waits until it can succeed without exceeding the
queue's capacity.
- ``try_push(item)`` pushes ``item`` only if it would not exceed the
queue's capacity.
- size() returns a *signed* integer.
The value of concurrent_queue::size() is defined as the number of push
operations started minus the number of pop operations started. If pops
outnumber pushes, ``size()`` becomes negative. For example, if a
``concurrent_queue`` is empty, and there are ``n`` pending pop
operations, ``size()`` returns -\ ``n``. This provides an easy way for
producers to know how many consumers are waiting on the queue. Method
``empty()`` is defined to be true if and only if ``size()`` is not
positive.
By default, a ``concurrent_bounded_queue`` is unbounded. It may hold any
number of values, until memory runs out. It can be bounded by setting
the queue capacity with method ``set_capacity``.Setting the capacity
causes ``push`` to block until there is room in the queue. Bounded
queues are slower than unbounded queues, so if there is a constraint
elsewhere in your program that prevents the queue from becoming too
large, it is better not to set the capacity. If you do not need the
bounds or the blocking pop, consider using ``concurrent_queue`` instead.
.. toctree::
:maxdepth: 4
../tbb_userguide/Iterating_Over_a_Concurrent_Queue_for_Debugging
../tbb_userguide/When_Not_to_Use_Queues
+30
View File
@@ -0,0 +1,30 @@
.. _Constraints:
Constrained APIs
================
Starting from C++20, most of |full_name| APIs are constrained to
enforce `named requirements <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/named_requirements.html>`_ on
template arguments types.
The violations of these requirements are detected at a compile time during the template instantiation.
.. rubric:: Example
.. code:: cpp
// Call for body(oneapi::tbb::blocked_range) is ill-formed
// oneapi::tbb::parallel_for call results in constraint failure
auto body = [](const int& r) { /*...*/ };
oneapi::tbb::parallel_for(oneapi::tbb::blocked_range{1, 10}, body);
// Error example:
// error: no matching function to call to oneapi::tbb::parallel_for
// note: constraints not satisfied
// note: the required expression 'body(range)' is invalid
body(range);
.. caution::
The code that violates named requirements but compiles successfully until C++20,
may not compile in C++20 mode due to early and strict constraints diagnostics.
+55
View File
@@ -0,0 +1,55 @@
.. _Containers:
Containers
==========
|full_name| provides highly concurrent
container classes. These containers can be used with raw Windows\* OS or
Linux\* OS threads, or in conjunction with task-based programming.
A concurrent container allows multiple threads to concurrently access
and update items in the container. Typical C++ STL containers do not
permit concurrent update; attempts to modify them concurrently often
result in corrupting the container. STL containers can be wrapped in a
mutex to make them safe for concurrent access, by letting only one
thread operate on the container at a time, but that approach eliminates
concurrency, thus restricting parallel speedup.
Containers provided by oneTBB offer a much higher level of concurrency,
via one or both of the following methods:
- **Fine-grained locking:** Multiple threads operate on the container
by locking only those portions they really need to lock. As long as
different threads access different portions, they can proceed
concurrently.
- **Lock-free techniques:** Different threads account and correct for
the effects of other interfering threads.
Notice that highly-concurrent containers come at a cost. They typically
have higher overheads than regular STL containers. Operations on
highly-concurrent containers may take longer than for STL containers.
Therefore, use highly-concurrent containers when the speedup from the
additional concurrency that they enable outweighs their slower
sequential performance.
.. CAUTION::
As with most objects in C++, the constructor or destructor of a
container object must not be invoked concurrently with another
operation on the same object. Otherwise the resulting race may cause
the operation to be executed on an undefined object.
.. toctree::
:maxdepth: 4
../tbb_userguide/concurrent_hash_map
../tbb_userguide/concurrent_vector_ug
../tbb_userguide/Concurrent_Queue_Classes
../tbb_userguide/Summary_of_Containers
@@ -0,0 +1,170 @@
.. _Controlling_Chunking:
Controlling Chunking
====================
Chunking is controlled by a *partitioner* and a *grainsize.*\ To gain
the most control over chunking, you specify both.
- Specify ``simple_partitioner()`` as the third argument to
``parallel_for``. Doing so turns off automatic chunking.
- Specify the grainsize when constructing the range. The thread
argument form of the constructor is
``blocked_range<T>(begin,end,grainsize)``. The default value of
``grainsize`` is 1. It is in units of loop iterations per chunk.
If the chunks are too small, the overhead may exceed the performance
advantage.
The following code is the last example from parallel_for, modified to
use an explicit grainsize ``G``.
::
#include "oneapi/tbb.h"
 
void ParallelApplyFoo( float a[], size_t n ) {
parallel_for(blocked_range<size_t>(0,n,G), ApplyFoo(a),
simple_partitioner());
}
The grainsize sets a minimum threshold for parallelization. The
``parallel_for`` in the example invokes ``ApplyFoo::operator()`` on
chunks, possibly of different sizes. Let *chunksize* be the number of
iterations in a chunk. Using ``simple_partitioner`` guarantees that
[G/2] <= *chunksize* <= G.
There is also an intermediate level of control where you specify the
grainsize for the range, but use an ``auto_partitioner`` and
``affinity_partitioner``. An ``auto_partitioner`` is the default
partitioner. Both partitioners implement the automatic grainsize
heuristic described in :ref:`Automatic_Chunking`. An
``affinity_partitioner`` implies an additional hint, as explained later
in Section :ref:`Bandwidth_and_Cache_Affinity`. Though these partitioners
may cause chunks to have more than G iterations, they never generate
chunks with less than [G/2] iterations. Specifying a range with an
explicit grainsize may occasionally be useful to prevent these
partitioners from generating wastefully small chunks if their heuristics
fail.
Because of the impact of grainsize on parallel loops, it is worth
reading the following material even if you rely on ``auto_partitioner``
and ``affinity_partitioner`` to choose the grainsize automatically.
.. container:: tablenoborder
.. list-table::
:header-rows: 1
* - |image0|
- |image1|
* - Case A
- Case B
The above figure illustrates the impact of grainsize by showing the
useful work as the gray area inside a brown border that represents
overhead. Both Case A and Case B have the same total gray area. Case A
shows how too small a grainsize leads to a relatively high proportion of
overhead. Case B shows how a large grainsize reduces this proportion, at
the cost of reducing potential parallelism. The overhead as a fraction
of useful work depends upon the grainsize, not on the number of grains.
Consider this relationship and not the total number of iterations or
number of processors when setting a grainsize.
A rule of thumb is that ``grainsize`` iterations of ``operator()``
should take at least 100,000 clock cycles to execute. For example, if a
single iteration takes 100 clocks, then the ``grainsize`` needs to be at
least 1000 iterations. When in doubt, do the following experiment:
#. Set the ``grainsize`` parameter higher than necessary. The grainsize
is specified in units of loop iterations. If you have no idea of how
many clock cycles an iteration might take, start with
``grainsize``\ =100,000. The rationale is that each iteration
normally requires at least one clock per iteration. In most cases,
step 3 will guide you to a much smaller value.
#. Run your algorithm.
#. Iteratively halve the ``grainsize`` parameter and see how much the
algorithm slows down or speeds up as the value decreases.
A drawback of setting a grainsize too high is that it can reduce
parallelism. For example, if the grainsize is 1000 and the loop has 2000
iterations, the ``parallel_for`` distributes the loop across only two
processors, even if more are available. However, if you are unsure, err
on the side of being a little too high instead of a little too low,
because too low a value hurts serial performance, which in turns hurts
parallel performance if there is other parallelism available higher up
in the call tree.
.. tip::
You do not have to set the grainsize too precisely.
The next figure shows the typical "bathtub curve" for execution time
versus grainsize, based on the floating point ``a[i]=b[i]*c``
computation over a million indices. There is little work per iteration.
The times were collected on a four-socket machine with eight hardware
threads.
.. container:: fignone
:name: fig2
Wall Clock Time Versus Grainsize
|image2|
The scale is logarithmic. The downward slope on the left side indicates
that with a grainsize of one, most of the overhead is parallel
scheduling overhead, not useful work. An increase in grainsize brings a
proportional decrease in parallel overhead. Then the curve flattens out
because the parallel overhead becomes insignificant for a sufficiently
large grainsize. At the end on the right, the curve turns up because the
chunks are so large that there are fewer chunks than available hardware
threads. Notice that a grainsize over the wide range 100-100,000 works
quite well.
.. tip::
A general rule of thumb for parallelizing loop nests is to
parallelize the outermost one possible. The reason is that each
iteration of an outer loop is likely to provide a bigger grain of
work than an iteration of an inner loop.
.. |image0| image:: Images/image002.jpg
:width: 161px
:height: 163px
.. |image1| image:: Images/image004.jpg
:width: 157px
:height: 144px
.. |image2| image:: Images/image006.jpg
:width: 462px
:height: 193px
@@ -0,0 +1,84 @@
.. _Cook_Until_Done_parallel_do:
Cook Until Done: parallel_for_each
==================================
For some loops, the end of the iteration space is not known in advance,
or the loop body may add more iterations to do before the loop exits.
You can deal with both situations using the template class ``oneapi::tbb::parallel_for_each``.
A linked list is an example of an iteration space that is not known in
advance. In parallel programming, it is usually better to use dynamic
arrays instead of linked lists, because accessing items in a linked list
is inherently serial. But if you are limited to linked lists, the items
can be safely processed in parallel, and processing each item takes at
least a few thousand instructions, you can use ``parallel_for_each`` to
gain some parallelism.
For example, consider the following serial code:
::
void SerialApplyFooToList( const std::list<Item>& list ) {
for( std::list<Item>::const_iterator i=list.begin() i!=list.end(); ++i )
Foo(*i);
}
If ``Foo`` takes at least a few thousand instructions to run, you can
get parallel speedup by converting the loop to use
``parallel_for_each``. To do so, define an object with a ``const``
qualified ``operator()``. This is similar to a C++ function object from
the C++ standard header ``<functional>``, except that ``operator()``
must be ``const``.
::
class ApplyFoo {
public:
void operator()( Item& item ) const {
Foo(item);
}
};
The parallel form of ``SerialApplyFooToList`` is as follows:
::
void ParallelApplyFooToList( const std::list<Item>& list ) {
parallel_for_each( list.begin(), list.end(), ApplyFoo() );
}
An invocation of ``parallel_for_each`` never causes two threads to act
on an input iterator concurrently. Thus typical definitions of input
iterators for sequential programs work correctly. This convenience makes
``parallel_for_each`` unscalable, because the fetching of work is
serial. But in many situations, you still get useful speedup over doing
things sequentially.
There are two ways that ``parallel_for_each`` can acquire work scalably.
- The iterators can be random-access iterators.
- The body argument to ``parallel_for_each``, if it takes a second
argument *feeder* of type ``parallel_for_each<Item>&``, can add more
work by calling ``feeder.add(item)``. For example, suppose processing
a node in a tree is a prerequisite to processing its descendants.
With ``parallel_for_each``, after processing a node, you could use
``feeder.add`` to add the descendant nodes. The instance of
``parallel_for_each`` does not terminate until all items have been
processed.
+198
View File
@@ -0,0 +1,198 @@
.. _Data_Flow_Graph:
Data Flow Graph
===============
In a data flow graph, nodes are computations that send and receive data
messages. Some nodes may only send messages, others may only receive
messages, and others may send messages in response to messages that they
receive.
In the following data flow graph, the left-most node generates the
integer values from 1 to 10 and passes them to two successor nodes. One
of the successors squares each value it receives and passes the result
downstream. The second successor cubes each value it receives and passes
the result downstream. The right-most node receives values from both of
the middle nodes. As it receives each value, it adds it to a running sum
of values. When the application is run to completion, the value of sum
will be equal to the sum of the sequence of squares and cubes from 1 to
10.
.. container:: fignone
:name: simple_data_flow_title
Simple Data Flow Graph
.. container:: imagecenter
|image0|
The following code snippet shows an implementation of the **Simple Data
Flow Graph** shown above:
::
int sum = 0;
graph g;
function_node< int, int > squarer( g, unlimited, [](const int &v) {
return v*v;
} );
function_node< int, int > cuber( g, unlimited, [](const int &v) {
return v*v*v;
} );
function_node< int, int > summer( g, 1, [&](const int &v ) -> int {
return sum += v;
} );
make_edge( squarer, summer );
make_edge( cuber, summer );
for ( int i = 1; i <= 10; ++i ) {
squarer.try_put(i);
cuber.try_put(i);
}
g.wait_for_all();
cout << "Sum is " << sum << "\n";
In the implementation above, the following function_nodes are created:
- one to square values
- one to cube values
- one to add values to the global sum
Since the squarer and cuber nodes are side-effect free, they are created
with an unlimited concurrency. The summer node updates the sum through a
reference to a global variable and therefore is not safe to execute in
parallel. It is therefore created with a concurrency limit of 1. The
node F from **Simple Data Flow Graph** above is implemented as a loop
that puts messages to both the squarer and cuber node.
A slight improvement over the first implementation is to introduce an
additional node type, a ``broadcast_node``. A ``broadcast_node`` broadcasts any
message it receives to all of its successors.
This enables replacing the two ``try_put``'s in the loop with a single
``try_put``:
::
broadcast_node<int> b(g);
make_edge( b, squarer );
make_edge( b, cuber );
for ( int i = 1; i <= 10; ++i ) {
b.try_put(i);
}
g.wait_for_all();
An even better option, which will make the implementation even more like
the **Simple Data Flow Graph** above, is to introduce an ``input_node``. An
``input_node``, as the name implies only sends messages and does not
receive messages. Its constructor takes two arguments:
::
template< typename Body > input_node( graph &g, Body body)
The body is a function object, or lambda expression, that contains a
function operator:
::
Output Body::operator()( oneapi::tbb::flow_control &fc );
You can replace the loop in the example with an ``input_node``
::
input_node< int > src( g, src_body(10) );
make_edge( src, squarer );
make_edge( src, cuber );
src.activate();
g.wait_for_all();
The runtime library will repeatedly invoke the function operator in
``src_body`` until ``fc.stop()`` is invoked inside the body. You therefore
need to create body that will act like the body of the loop in the **Simple Data Flow Graph**
above. The final implementation after all of these changes is shown
below:
::
class src_body {
const int my_limit;
int my_next_value;
public:
src_body(int l) : my_limit(l), my_next_value(1) {}
int operator()( oneapi::tbb::flow_control& fc ) {
if ( my_next_value <= my_limit ) {
return my_next_value++;
} else {
fc.stop();
return int();
}
}
};
int main() {
int sum = 0;
graph g;
function_node< int, int > squarer( g, unlimited, [](const int &v) {
return v*v;
} );
function_node< int, int > cuber( g, unlimited, [](const int &v) {
return v*v*v;
} );
function_node< int, int > summer( g, 1, [&](const int &v ) -> int {
return sum += v;
} );
make_edge( squarer, summer );
make_edge( cuber, summer );
input_node< int > src( g, src_body(10) );
make_edge( src, squarer );
make_edge( src, cuber );
src.activate();
g.wait_for_all();
cout << "Sum is " << sum << "\n";
}
This final implementation has all of the nodes and edges from the
**Simple Data Flow Graph** above. In this simple example, there is not
much advantage in using an ``input_node`` over an explicit loop. But,
because an ``input_node`` is able to react to the behavior of downstream
nodes, it can limit memory use in more complex graphs. For more
information, see:ref:`create_token_based_system` .
.. |image0| image:: Images/flow_graph.jpg
@@ -0,0 +1,56 @@
.. _Debug_Versus_Release_Libraries:
Debug Versus Release Libraries
==============================
The following table details the |full_name|
dynamic shared libraries that come in debug and release
versions.
.. container:: tablenoborder
.. list-table::
:header-rows: 1
* - Library
- Description
- When to Use
* - | ``tbb_debug``
| ``tbbmalloc_debug``
| ``tbbmalloc_proxy_debug``
| ``tbbbind_debug``
- These versions have extensive internal checking for correct use of the library.
- Use with code that is compiled with the macro ``TBB_USE_DEBUG`` set to 1.
* - | ``tbb``
| ``tbbmalloc``
| ``tbbmalloc_proxy``
| ``tbbbind``
- These versions deliver top performance. They eliminate most checking for correct use of the library.
- Use with code compiled with ``TBB_USE_DEBUG`` undefined or set to zero.
.. tip::
Test your programs with the debug versions of the libraries first, to
assure that you are using the library correctly.  With the release
versions, incorrect usage may result in unpredictable program
behavior.
oneTBB supports Intel® Inspector, Intel® VTune™ Profiler and Intel® Advisor.
Full support of these tools requires compiling with macro ``TBB_USE_PROFILING_TOOLS=1``.
That symbol defaults to 1 in the following conditions:
- When ``TBB_USE_DEBUG=1``.
- On the Microsoft Windows\* operating system, when ``_DEBUG=1``.
The :ref:`reference` section explains the default values in more detail.
.. CAUTION::
The instrumentation support for Intel® Inspector becomes live after
the first initialization of the task library. If the library
components are used before this initialization occurs, Intel® Inspector
may falsely report race conditions that are not really races.
+147
View File
@@ -0,0 +1,147 @@
.. _Dependence_Graph:
Dependence Graph
================
In a dependence graph, the nodes invoke body objects to perform
computations and the edges create a partial ordering of these
computations. At runtime, the library spawns and schedules tasks to
execute the body objects when it is legal to do so according to the
specified partial ordering. The following figure shows an example of an
application that could be expressed using a dependence graph.
.. container:: fignone
:name: dependence_graph_make_sandwitch
Dependence Graph for Making a Sandwich
.. container:: imagecenter
|image0|
Dependence graphs are a special case of data flow graphs, where the data
passed between nodes are of type oneapi::tbb::flow::continue_msg. Unlike a
general data flow graph, nodes in a dependence graph do not spawn a task
for each message they receive. Instead, they are aware of the number of
predecessors they have, count the messages they receive and only spawn a
task to execute their body when this count is equal to the total number
of their predecessors.
The following figure shows another example of a dependence graph. It has
the same topology as the figure above, but with simple functions
replacing the sandwich making steps. In this partial ordering, function
A must complete executing before any other computation starts executing.
Function B must complete before C and D start executing; and E must
complete before D and F start executing. This is a partial ordering
because, for example, there is no explicit ordering requirement between
B and E or C and F.
.. container:: fignone
:name: simple_dependence_graph
Simple Dependence Graph
.. container:: imagecenter
|image1|
To implement this as a flow graph, continue_node objects are used for
the nodes and continue_msg objects as the messages. A continue_node
constructor takes two arguments:
::
template< typename Body > continue_node( graph &g, Body body)
The first argument is the graph it belongs to and the second is a
function object or lambda expression. Unlike a function_node, a
continue_node is always assumed to have unlimited concurrency and will
immediately spawn a task whenever its dependencies are met.
The following code snippet is an implementation of the example in this
figure.
::
typedef continue_node< continue_msg > node_t;
typedef const continue_msg & msg_t;
int main() {
oneapi::tbb::flow::graph g;
node_t A(g, [](msg_t){ a(); } );
node_t B(g, [](msg_t){ b(); } );
node_t C(g, [](msg_t){ c(); } );
node_t D(g, [](msg_t){ d(); } );
node_t E(g, [](msg_t){ e(); } );
node_t F(g, [](msg_t){ f(); } );
make_edge(A, B);
make_edge(B, C);
make_edge(B, D);
make_edge(A, E);
make_edge(E, D);
make_edge(E, F);
A.try_put( continue_msg() );
g.wait_for_all();
return 0;
}
One possible execution of this graph is shown below. The execution of D
does not start until both B and E are finished. While a task is waiting
in the wait_for_all, its thread can participate in executing other tasks
from the oneTBB work pool.
.. container:: fignone
Execution Timeline for a Dependence Graph
.. container:: imagecenter
|image2|
Again, it is important to note that all execution in the flow graph
happens asynchronously. The call to A.try_put returns control to the
calling thread quickly, after incrementing the counter and spawning a
task to execute the body of A. Likewise, the body tasks execute the
lambda expressions and then put a continue_msg to all successor nodes,
if any. Only the call to wait_for_all blocks, as it should, and even in
this case the calling thread may be used to execute tasks from the
oneTBB work pool while it is waiting.
The above timeline shows the sequence when there are enough threads to
execute all of the tasks that can be executed concurrently in parallel.
If there are fewer threads, then some tasks that are spawned will need
to wait until a thread is available to execute them.
.. |image0| image:: Images/flow_graph_complex.jpg
:width: 440px
:height: 337px
.. |image1| image:: Images/dependence_graph.jpg
.. |image2| image:: Images/execution_timeline_dependence.jpg
+46
View File
@@ -0,0 +1,46 @@
.. _Edges:
Flow Graph Basics: Edges
========================
Most applications contain multiple nodes with edges connecting them to
each other. In the flow graph interface, edges are directed channels
over which messages are passed. They are created by calling the function
``make_edge( p, s )`` with two arguments: ``p``, the predecessor, and ``s``, the
successor. You can modify the example used in the **Nodes** topic to
include a second node that squares the value it receives before printing
it and then connect that to the first node with an edge.
::
graph g;
function_node< int, int > n( g, unlimited, []( int v ) -> int {
cout << v;
spin_for( v );
cout << v;
return v;
} );
function_node< int, int > m( g, 1, []( int v ) -> int {
v *= v;
cout << v;
spin_for( v );
cout << v;
return v;
} );
make_edge( n, m );
n.try_put( 1 );
n.try_put( 2 );
n.try_put( 3 );
g.wait_for_all();
Now there are two ``function_node``s, ``n`` and ``m``. The call to ``make_edge`` creates
an edge from ``n`` to ``m``. The node n is created with unlimited concurrency,
while ``m`` has a concurrency limit of 1. The invocations of ``n`` can all
proceed in parallel, while the invocations of ``m`` will be serialized.
Because there is an edge from ``n`` to ``m``, each value ``v``, returned by ``n``, will
be automatically passed to node ``m`` by the runtime library.
@@ -0,0 +1,79 @@
.. _Exceptions_and_Cancellation:
Exceptions and Cancellation
===========================
|full_name| supports exceptions and
cancellation. When code inside an oneTBB algorithm throws an exception,
the following steps generally occur:
#. The exception is captured. Any further exceptions inside the
algorithm are ignored.
#. The algorithm is cancelled. Pending iterations are not executed. If
there is oneTBB parallelism nested inside, the nested parallelism may
also be cancelled as explained in :ref:`Cancellation_and_Nested_Parallelism`.
#. Once all parts of the algorithm stop, an exception is thrown on the
thread that invoked the algorithm.
The exception thrown in step 3 might be the original exception, or might
merely be a summary of type ``captured_exception``. The latter usually
occurs on current systems because propagating exceptions between threads
requires support for the C++ ``std::exception_ptr`` functionality. As
compilers evolve to support this functionality, future versions of
oneTBB might throw the original exception. So be sure your code can
catch either type of exception. The following example demonstrates
exception handling.
::
#include "oneapi/tbb.h"
#include <vector>
#include <iostream>
 
using namespace oneapi::tbb;
using namespace std;
 
vector<int> Data;
 
struct Update {
void operator()( const blocked_range<int>& r ) const {
for( int i=r.begin(); i!=r.end(); ++i )
Data.at(i) += 1;
}
};
 
int main() {
Data.resize(1000);
try {
parallel_for( blocked_range<int>(0, 2000), Update());
} catch( out_of_range& ex ) {
cout << "out_of_range: " << ex.what() << endl;
}
return 0;
}
The ``parallel_for`` attempts to iterate over 2000 elements of a vector
with only 1000 elements. Hence the expression ``Data.at(i)`` sometimes
throws an exception ``std::out_of_range`` during execution of the
algorithm. When the exception happens, the algorithm is cancelled and an
exception thrown at the call site to ``parallel_for``.
.. toctree::
:maxdepth: 4
../tbb_userguide/Cancellation_Without_An_Exception
../tbb_userguide/Cancellation_and_Nested_Parallelism
+14
View File
@@ -0,0 +1,14 @@
.. _Flow_Graph:
Parallelizing Data Flow and Dependence Graphs
=============================================
.. toctree::
:maxdepth: 4
../tbb_userguide/Parallelizing_Flow_Graph
../tbb_userguide/Basic_Flow_Graph_concepts
../tbb_userguide/Graph_Main_Categories
../tbb_userguide/Predefined_Node_Types
../tbb_userguide/Flow_Graph_Tips
../tbb_userguide/estimate_flow_graph_performance
@@ -0,0 +1,42 @@
.. _Flow_Graph_Buffering_in_Nodes:
Flow Graph Basics: Buffering and Forwarding
===========================================
|full_name| flow graph nodes use messages
to communicate data and to enforce dependencies. If a node passes a
message successfully to any successor, no further action is taken with
the message by that node. As noted in the section on Single-push vs.
Broadcast-push, a message may be passed to one or to multiple
successors, depending on the type of the node, how many successors are
connected to the node, and whether the message is pushed or pulled.
There are times when a node cannot successfully push a message to any
successor. In this case what happens to the message depends on the type
of the node. The two possibilities are:
- The node stores the message to be forwarded later.
- The node discards the message.
If a node discards messages that are not forwarded, and this behavior is
not desired, the node should be connected to a buffering node that does
store messages that cannot be pushed.
If a message has been stored by a node, there are two ways it can be
passed to another node:
- A successor to the node can pull the message using ``try_get()`` or
``try_reserve()``.
- A successor can be connected using ``make_edge()``.
If a ``try_get()`` successfully forwards a message, it is removed from
the node that stored it. If a node is connected using ``make_edge`` the
node will attempt to push a stored message to the new successor.
@@ -0,0 +1,47 @@
.. _Flow_Graph_Message_Passing_Protocol:
Flow Graph Basics: Message Passing Protocol
===========================================
|full_name| flow graph operates by passing
messages between nodes. A node may not be able to receive and process a
message from its predecessor. For a graph to operate most-efficiently,
if this occurs the state of the edge between the nodes can change its
state to pull so when the successor is able to handle a message it can
query its predecessor to see if a message is available. If the edge did
not reverse from push to pull, the predecessor node would have to
repeatedly attempt to forward its message until the successor accepts
it. This would consume resources needlessly.
Once the edge is in pull mode, when the successor is not busy, it will
try to pull a message from a predecessor.
#. If a predecessor has a message, the successor will process it and the
edge will remain in pull mode.
#. If the predecessor has no message, the edge between the nodes will
switch from pull to push mode.
The state diagram of this Push-Pull protocol is:
.. container:: fignone
:name: basic_push_pull
**The dynamic push / pull protocol.**
.. container:: imagecenter
|image0|
.. |image0| image:: Images/flow_graph_message_passing_protocol.jpg
:width: 442px
:height: 196px
@@ -0,0 +1,286 @@
.. _Flow_Graph_Reservation:
Flow Graph Basics: Reservation
==============================
|full_name| flow graph
``join_node`` has four possible policies: ``queueing``, ``reserving``,
``key_matching`` and ``tag_matching``. ``join_nodes`` need messages at
every input before they can create an output message. The reserving
``join_node`` does not have internal buffering, and it does not pull
messages from its inputs until it has a message at each input. To create
an output message it temporarily reserves a message at each input port,
and only if all input ports succeed reserving messages will an output
message be created. If any input port fails to reserve a message, no
message will be pulled by the ``join_node``.
To support the reserving ``join_node`` some nodes support
**reservation** of their outputs. The way reservation works is:
- When a node connected to a reserving ``join_node`` in push state
tries to push a message, the ``join_node`` always rejects the push
and the edge connecting the nodes is switched to pull mode.
- The reserving input port calls ``try_reserve`` on each edge in pull
state. This may fail; if so, the reserving input port switches that
edge to push state, and tries to reserve the next node connected by
an edge in pull state. While the input port's predecessor is in
reserved state, no other node can retrieve the reserved value.
- If each input port successfully reserves an edge in pull state, the
reserving ``join_node`` will create a message using the reserved
messages and try to push the resulting message to any nodes connected
to it.
- If the message is successfully pushed to a successor, the
predecessors that were reserved are signaled that the messages were
used (by calling ``try_consume()``.) Those messages will be discarded
by the predecessor nodes, because they have been successfully pushed.
- If the message was not successfully pushed to any successor, the
predecessors that were reserved are signaled that the messages were
not used (by calling ``try_release()``.) At this point, the messages
may be pushed to or pulled by other nodes.
Because the reserving ``join_node`` will only attempt to push when each
input port has at least one edge in a pull state, and will only attempt
to create and push a message if all input ports succeed reserving
messages, at least one of the predecessors to each of the reserving
``join_node`` input ports must be reservable.
The following example demonstrates a reserving ``join_node``'s behavior.
``buffer_nodes`` buffer their output, so they accept a switch of their
output edge from push to pull mode. ``broadcast_nodes`` do not buffer
messages and do not support ``try_get()`` or ``try_reserve()``.
::
void run_example2() { // example for Flow_Graph_Reservation.xml
graph g;
broadcast_node<int> bn(g);
buffer_node<int> buf1(g);
buffer_node<int> buf2(g);
typedef join_node<tuple<int,int> reserving> join_type;
join_type jn(g);
buffer_node<join_type::output_type> buf_out(g);
join_type::output_type tuple_out;
int icnt;
// join_node predecessors are both reservable buffer_nodes
make_edge(buf1,input_port<0>jn));
make_edge(bn,input_port<0>jn)); // attach a broadcast_node
make_edge(buf2,input_port<1>jn));
make_edge(jn, buf_out);
bn.try_put(2);
buf1.try_put(3);
buf2.try_put(4);
buf2.try_put(7);
g.wait_for_all();
while (buf_out.try_get(tuple_out)) {
printf("join_node output == (%d,%d)\n",get<0>tuple_out), get<1>tuple_out) );
}
if(buf1.try_get(icnt)) printf("buf1 had %d\n", icnt);
else printf("buf1 was empty\n");
if(buf2.try_get(icnt)) printf("buf2 had %d\n", icnt);
else printf("buf2 was empty\n");
}
In the example above, port 0 of the reserving ``join_node`` ``jn`` has
two predecessors: a ``buffer_node`` ``buf1`` and a ``broadcast_node``
``bn``. Port 1 of the ``join_node`` has one predecessor, ``buffer_node``
``buf2``.
.. container:: fignone
:name: reserve_step1
.. container:: imagecenter
|image0|
We will discuss one possible execution sequence (the scheduling of tasks
may differ slightly, but the end result will be the same.)
::
bn.try_put(2);
``bn`` attempts to forward 2 to ``jn``. ``jn`` does not accept the value
and the arc from ``bn`` to ``jn`` reverses. Because neither bn nor jn
buffer messages, the message is dropped. Because not all the inputs to
``jn`` have available predecessors, ``jn`` does nothing further.
.. CAUTION::
Any node which does not support reservation will not work correctly
when attached to a reserving ``join_node``. This program demonstrates
why this occurs; connecting non-reserving nodes to nodes requiring
support for reservation is **not** recommended practice.
.. container:: fignone
:name: reserve_step2
.. container:: imagecenter
|image1|
::
buf1.try_put(3);
``buf1`` attempts to forward 3 to ``jn``. ``jn`` does not accept the
value and the arc from ``buf1`` to ``jn`` reverses. Because not all the
inputs to ``jn`` have available predecessors, ``jn`` does nothing
further.
.. container:: fignone
:name: reserve_step3
.. container:: imagecenter
|image2|
::
buf2.try_put(4);
``buf2`` attempts to forward 4 to ``jn``. ``jn`` does not accept the
value and the arc from ``buf2`` to ``jn`` reverses. Now both inputs of
``jn`` have predecessors, a task to build and forward a message from
``jn`` will be spawned. We assume that task is not yet executing.
.. container:: fignone
:name: reserve_step4
.. container:: imagecenter
|image3|
::
buf2.try_put(7);
``buf2`` has no successor (because the arc to ``jn`` is reversed,) so it
stores the value 7.
.. container:: fignone
:name: reserve_step5
.. container:: imagecenter
|image4|
Now the task spawned to run ``jn`` runs.
- ``jn`` tries to reserve ``bn``, which fails. The arc to ``bn``
switches back to the forward direction.
- ``jn`` tries to reserve ``buf1``, which succeeds (reserved nodes are
colored grey.) ``jn`` receives the value 3 from ``buf1``, but it
remains in ``buf1`` (in case the attempt to forward a message from
``jn`` fails.)
- ``jn`` tries to reserve ``buf2``, which succeeds. ``jn`` receives the
value 4 from ``buf2``, but it remains in ``buf2``.
- ``jn`` constructs the output message ``tuple<3,4>``.
.. container:: fignone
:name: reserve_step6
.. container:: imagecenter
|image5|
Now ``jn`` pushes its message to ``buf_out``, which accepts it. Because
the push succeeded, ``jn`` signals ``buf1`` and ``buf2`` that the
reserved values were used, and the buffers discard those values. Now
``jn`` attempts to reserve again.
- No attempt to pull from ``bn`` is made, because the edge from ``bn``
to ``jn`` is in push state.
- ``jn`` tries to reserve ``buf1``, which fails. The arc to ``buf1``
switches back to the forward direction.
- ``jn`` does not try any further actions.
.. container:: fignone
:name: reserve_step7
.. container:: imagecenter
|image6|
No further activity occurs in the graph, and the ``wait_for_all()`` will
complete. The output of this code is
::
join_node output == (3,4)
buf1 was empty
buf2 had 7
.. |image0| image:: Images/flow_graph_reserve_buffers_1.png
:width: 400px
:height: 222px
.. |image1| image:: Images/flow_graph_reserve_buffers_2.png
:width: 400px
:height: 222px
.. |image2| image:: Images/flow_graph_reserve_buffers_3.png
:width: 400px
:height: 222px
.. |image3| image:: Images/flow_graph_reserve_buffers_4.png
:width: 400px
:height: 222px
.. |image4| image:: Images/flow_graph_reserve_buffers_5.png
:width: 400px
:height: 222px
.. |image5| image:: Images/flow_graph_reserve_buffers_6.png
:width: 400px
:height: 222px
.. |image6| image:: Images/flow_graph_reserve_buffers_7.png
:width: 400px
:height: 222px

Some files were not shown because too many files have changed in this diff Show More