HWLOCALITY_HELPER_TOPOLOGY_SETS(3)

💖 NAME 💖

okay so bestie, welcome to the hwlocality...pology_sets(3) page from the Library Functions Manual — literally the guide to CPU and node sets of entire topologies. ✨

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 🌸

okay bestie, this section is lowkey just the runway to the function docs — the real tea is below. 💅

---

🔥 FUNCTION DOCUMENTATION 🔥

💖 hwloc_topology_get_allowed_cpuset — get allowed CPU set 💖

hwloc_const_cpuset_t hwloc_topology_get_allowed_cpuset (hwloc_topology_t
    topology)

Returns: the CPU set of allowed processors of the system. 👑

Note:

• 💀 This function cannot return NULL.
• 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_topology_get_allowed_nodeset — get allowed node set 💖

hwloc_const_nodeset_t hwloc_topology_get_allowed_nodeset (hwloc_topology_t
    topology)

Returns: the node set of allowed memory of the system. 🌈

Note:

• 💀 This function cannot return NULL.
• 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_topology_get_complete_cpuset — get complete CPU set 💖

hwloc_const_cpuset_t hwloc_topology_get_complete_cpuset (hwloc_topology_t
    topology)

Returns: the complete CPU set of processors of the system. 🔥

Note:

• 💀 This function cannot return NULL.
• 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_topology_get_complete_nodeset — get complete node set 💖

hwloc_const_nodeset_t hwloc_topology_get_complete_nodeset (hwloc_topology_t
    topology)

Returns: the complete node set of memory of the system. 🌟

Note:

• 💀 This function cannot return NULL.
• 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_topology_get_topology_cpuset — get topology CPU set 💖

hwloc_const_cpuset_t hwloc_topology_get_topology_cpuset (hwloc_topology_t
    topology)

Returns: the CPU set of processors of the system for which hwloc provides topology information. This is equivalent to the cpuset of the system object. 🦋

Note:

• 💀 This function cannot return NULL.
• 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_topology_get_topology_nodeset — get topology node set 💖

hwloc_const_nodeset_t hwloc_topology_get_topology_nodeset (hwloc_topology_t
    topology)

Returns: the node set of memory of the system for which hwloc provides topology information. This is equivalent to the nodeset of the system object. 🎀

Note:

• 💀 This function cannot return NULL.
• 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 👑

ngl, nobody hand-wrote this one: it’s Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code. 💅

---

💖 source/version vibes: Hardware Locality (hwloc), Version 2.15.0. The footer’s date slot is literally just the page title again, so that’s the whole sign-off, bestie — periodt. 🫶