table of contents
hwlocality_helper_topology_sets(3) | Hardware Locality (hwloc) | hwlocality_helper_topology_sets(3) |
NAME¶
hwlocality_helper_topology_sets - CPU and node sets of entire topologies
SYNOPSIS¶
Functions¶
hwloc_const_cpuset_t
hwloc_topology_get_complete_cpuset (hwloc_topology_t topology)
hwloc_const_cpuset_t hwloc_topology_get_topology_cpuset
(hwloc_topology_t topology)
hwloc_const_cpuset_t hwloc_topology_get_allowed_cpuset
(hwloc_topology_t topology)
hwloc_const_nodeset_t hwloc_topology_get_complete_nodeset
(hwloc_topology_t topology)
hwloc_const_nodeset_t hwloc_topology_get_topology_nodeset
(hwloc_topology_t topology)
hwloc_const_nodeset_t hwloc_topology_get_allowed_nodeset
(hwloc_topology_t topology)
Detailed Description¶
Function Documentation¶
hwloc_const_cpuset_t hwloc_topology_get_allowed_cpuset (hwloc_topology_t topology)¶
Get allowed CPU set.
Returns
Note
If the topology flag HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED was not set, this is identical to hwloc_topology_get_topology_cpuset(), which means all PUs are allowed.
If HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED was set, applying hwloc_bitmap_intersects() on the result of this function and on an object cpuset checks whether there are allowed PUs inside that object. Applying hwloc_bitmap_and() returns the list of these allowed PUs.
The returned cpuset is not newly allocated and should thus not be changed or freed, hwloc_bitmap_dup() must be used to obtain a local copy.
hwloc_const_nodeset_t hwloc_topology_get_allowed_nodeset (hwloc_topology_t topology)¶
Get allowed node set.
Returns
Note
If the topology flag HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED was not set, this is identical to hwloc_topology_get_topology_nodeset(), which means all NUMA nodes are allowed.
If HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED was set, applying hwloc_bitmap_intersects() on the result of this function and on an object nodeset checks whether there are allowed NUMA nodes inside that object. Applying hwloc_bitmap_and() returns the list of these allowed NUMA nodes.
The returned nodeset is not newly allocated and should thus not be changed or freed, hwloc_bitmap_dup() must be used to obtain a local copy.
hwloc_const_cpuset_t hwloc_topology_get_complete_cpuset (hwloc_topology_t topology)¶
Get complete CPU set.
Returns
Note
The returned cpuset is not newly allocated and should thus not be changed or freed; hwloc_bitmap_dup() must be used to obtain a local copy.
This is equivalent to retrieving the root object complete CPU-set.
hwloc_const_nodeset_t hwloc_topology_get_complete_nodeset (hwloc_topology_t topology)¶
Get complete node set.
Returns
Note
The returned nodeset is not newly allocated and should thus not be changed or freed; hwloc_bitmap_dup() must be used to obtain a local copy.
This is equivalent to retrieving the root object complete nodeset.
hwloc_const_cpuset_t hwloc_topology_get_topology_cpuset (hwloc_topology_t topology)¶
Get topology CPU set.
Returns
Note
The returned cpuset is not newly allocated and should thus not be changed or freed; hwloc_bitmap_dup() must be used to obtain a local copy.
This is equivalent to retrieving the root object CPU-set.
hwloc_const_nodeset_t hwloc_topology_get_topology_nodeset (hwloc_topology_t topology)¶
Get topology node set.
Returns
Note
The returned nodeset is not newly allocated and should thus not be changed or freed; hwloc_bitmap_dup() must be used to obtain a local copy.
This is equivalent to retrieving the root object nodeset.
Author¶
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code.
Mon Dec 4 2023 | Version 2.10.0 |