[oneTBB] Add a page with constraints helpers to the spec #650
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Isaev, Ilya <[email protected]>
isaevil
force-pushed
the
add-numa-arena-helper
branch
from
93dbd8a to
f819fc1
Compare
Signed-off-by: Isaev, Ilya <[email protected]>
|
@aleksei-fedotov @akukanov Please take a look. |
| .. cpp:function:: std::vector<oneapi::tbb::task_arena> create_numa_task_arenas(oneapi::tbb::task_arena::constraints other_constraints = {}, unsigned reserved_slots = 0) | ||
|
|
||
| Returns a ``std::vector`` of ``task_arena`` objects, each bound to a separate NUMA node. | ||
| The number of created ``task_arena`` is equal to the number of NUMA nodes available on the system. |
There was a problem hiding this comment.
Shall it be less strict and, thus, more accurate?
Suggested change
| The number of created ``task_arena`` is equal to the number of NUMA nodes available on the system. | |
| The number of created ``task_arena`` is equal to the number of NUMA nodes detected on the system. |
|
|
||
| .. cpp:function:: std::vector<oneapi::tbb::task_arena> create_numa_task_arenas(oneapi::tbb::task_arena::constraints other_constraints = {}, unsigned reserved_slots = 0) | ||
|
|
||
| Returns a ``std::vector`` of ``task_arena`` objects, each bound to a separate NUMA node. |
There was a problem hiding this comment.
Make it closer to the proposed RFC?
Suggested change
| Returns a ``std::vector`` of ``task_arena`` objects, each bound to a separate NUMA node. | |
| Returns a ``std::vector`` of non-initialized ``task_arena`` objects, each bound to a separate NUMA node. |
| .. SPDX-License-Identifier: CC-BY-4.0 | ||
|
|
||
| ========================= | ||
| Constrained Arena Helpers |
There was a problem hiding this comment.
Perhaps, task_arena Helpers might be more suitable as a name in case we would want to extend this page with other helpers, thus, avoiding creating a new one?
| Functions | ||
| --------- | ||
|
|
||
| .. cpp:function:: std::vector<oneapi::tbb::task_arena> create_numa_task_arenas(oneapi::tbb::task_arena::constraints other_constraints = {}, unsigned reserved_slots = 0) |
There was a problem hiding this comment.
Shorten?
Suggested change
| .. cpp:function:: std::vector<oneapi::tbb::task_arena> create_numa_task_arenas(oneapi::tbb::task_arena::constraints other_constraints = {}, unsigned reserved_slots = 0) | |
| .. cpp:function:: std::vector<oneapi::tbb::task_arena> create_numa_task_arenas(oneapi::tbb::task_arena::constraints constraints = {}, unsigned reserved_slots = 0) |
Comment on lines
+31
to
+33
| It optionally takes additional ``other_constraints`` argument to be applied to each created | ||
| ``task_arena``, ignoring ``numa_id`` value. The second optional ``reserved_slots`` argument | ||
| allows to reserve a number of slots in each created ``task_arena`` for application threads. |
There was a problem hiding this comment.
Perhaps,
Suggested change
| It optionally takes additional ``other_constraints`` argument to be applied to each created | |
| ``task_arena``, ignoring ``numa_id`` value. The second optional ``reserved_slots`` argument | |
| allows to reserve a number of slots in each created ``task_arena`` for application threads. | |
| Additional ``constraints`` argument can be specified to further limit the threads joined | |
| the ``task_arena`` objects. The ``numa_id`` value in the ``constraints`` argument is | |
| ignored. The ``reserved_slots`` argument allows reserving specified number of slots in | |
| ``task_arena`` objects for application threads. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a page that describes helper APIs to simplify constrained arena creations. Currently it is a single function
oneapi::tbb::create_numa_task_arenasfrom corresponding RFC.