hwlocality_windows(3)

🌸 NAME 🌸

hwlocality_windows — Windows-specific helpers 💖

Okay bestie, this is the hwlocality_windows(3) page in the Library Functions Manual, and it's all about the Windows-specific helpers. Slay.

✨ SYNOPSIS ✨

🌈 Functions 🌈

Here are the functions, exact and untouched:

       int hwloc_windows_get_nr_processor_groups (hwloc_topology_t topology,
           unsigned long flags)
       int hwloc_windows_get_processor_group_cpuset (hwloc_topology_t topology,
           unsigned pg_index, hwloc_cpuset_t cpuset, unsigned long flags)

💖 Detailed Description 💖

Okay so these functions query Windows processor groups. Windows processor groups partition the operating system into virtual sets of up to 64 neighbor PUs. That's the whole vibe: threads and processes may only be bound inside a single group.

Even though Windows processor groups may be exposed in the hwloc hierarchy as hwloc Groups, they are also often merged into existing hwloc objects such as NUMA nodes or Packages. This API provides explicit information about Windows processor groups so that applications know whether binding to a large set of PUs may fail because it spans over multiple Windows processor groups. No cap, that's literally the point.

🎀 Function Documentation 🎀

💜 hwloc_windows_get_nr_processor_groups 💜

Exact signature, because we do not play with signatures:

       int hwloc_windows_get_nr_processor_groups (hwloc_topology_t topology,
           unsigned long flags)

Get the number of Windows processor groups. flags must be 0 for now. Periodt.

Returns:

• at least 1 on success.
• -1 on error, for instance if the topology does not match the current system (e.g. loaded from another machine through XML).

🦋 hwloc_windows_get_processor_group_cpuset 🦋

Exact signature again, bestie:

       int hwloc_windows_get_processor_group_cpuset (hwloc_topology_t topology,
           unsigned pg_index, hwloc_cpuset_t cpuset, unsigned long flags)

Get the CPU-set of a Windows processor group. More specifically, get the set of PU included in the processor group specified by pg_index. pg_index must be between 0 and the value returned by hwloc_windows_get_nr_processor_groups() minus 1. That range check is not optional, iykyk.

flags must be 0 for now.

Returns:

• 0 on success.
• -1 on error, for instance if pg_index is invalid, or if the topology does not match the current system (e.g. loaded from another machine through XML).

✨ Author ✨

This page was generated automatically by Doxygen for Hardware Locality (hwloc) from the source code. So it's auto-generated, not handwritten — still iconic.

---

Cute sign-off: Hardware Locality (hwloc), Version 2.15.0, and hwlocality_windows(3) 💅 The original footer didn't list a date, so I'm not inventing one — no cap. 🫶