HWLOC_GET_OBJ_COVERING_CPUSET(3)

📦
version 2.15.0 · 13 versions
, in arch rolling

🦋 hwlocality...nd_covering(3) 🦋

okay so bestie, welcome to hwlocality...nd_covering(3) from the Library Functions Manual — this is the page about finding objects that cover at least a CPU set 💅✨

🌸 NAME 🌸

hwlocality_helper_find_covering — Finding Objects covering at least CPU set 🎀

✨ SYNOPSIS ✨

Functions

hwloc_obj_t hwloc_get_child_covering_cpuset (hwloc_topology_t topology,
    hwloc_const_cpuset_t set, hwloc_obj_t parent)
hwloc_obj_t hwloc_get_obj_covering_cpuset (hwloc_topology_t topology,
    hwloc_const_cpuset_t set)
hwloc_obj_t hwloc_get_next_obj_covering_cpuset_by_depth
    (hwloc_topology_t topology, hwloc_const_cpuset_t set, int depth,
    hwloc_obj_t prev)
hwloc_obj_t hwloc_get_next_obj_covering_cpuset_by_type (hwloc_topology_t
    topology, hwloc_const_cpuset_t set, hwloc_obj_type_t type,
    hwloc_obj_t prev)

🫶 DETAILED DESCRIPTION 🫶

no extra prose here, bestie — this page goes straight into the function docs 💖

💖 FUNCTION DOCUMENTATION 💖

🌟 hwloc_obj_t hwloc_get_child_covering_cpuset (hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_t parent) [inline]

Get the child covering at least CPU set set. 🧚

Returns

  • the child that covers the set entirely.
  • NULL if no child matches or if set is empty.
Note: This function cannot work if parent does not have a CPU set (I/O or Misc objects). 😭

🌈 hwloc_obj_t hwloc_get_next_obj_covering_cpuset_by_depth (hwloc_topology_t topology, hwloc_const_cpuset_t set, int depth, hwloc_obj_t prev) [inline]

Iterate through same-depth objects covering at least CPU set set. The next invokation should pass the previous return value in prev so as to obtain the next object covering at least another part of set. 🔥

Returns

  • the first object at depth depth covering at least part of CPU set set if object prev is NULL.
  • the next one if prev is not NULL.
  • NULL if there is no next object.
Note: This function cannot work if objects at the given depth do not have CPU sets (I/O or Misc objects). 💀

🦋 hwloc_obj_t hwloc_get_next_obj_covering_cpuset_by_type (hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_type_t type, hwloc_obj_t prev) [inline]

Iterate through same-type objects covering at least CPU set set. The next invokation should pass the previous return value in prev so as to obtain the next object of type type covering at least another part of set. ✨

Returns

  • the first object of type type covering at least part of CPU set set if object prev is NULL.
  • the next one if prev is not NULL.
  • NULL if there is no next object.
  • NULL if there is no depth for the given type.
  • NULL if there are multiple depths for the given type, the caller should fallback to hwloc_get_next_obj_covering_cpuset_by_depth().
Note: This function cannot work if objects of the given type do not have CPU sets (I/O or Misc objects). 🙈

🎀 hwloc_obj_t hwloc_get_obj_covering_cpuset (hwloc_topology_t topology, hwloc_const_cpuset_t set) [inline]

Get the lowest object covering at least CPU set set. 👑

Returns

  • the lowest object covering the set entirely.
  • NULL if no object matches or if set is empty.

👑 AUTHOR 👑

Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code. 🫶

and that’s the page, bestie 💖 the footer energy is Hardware Locality (hwloc), Version 2.15.0, page hwlocality...nd_covering(3) — no date shown on this one, so no fake timestamp from me 🌸✨

📦 where this page comes from