hwlocality_linux(3)

✨ NAME ✨

hwlocality_linux(3) — Linux-specific helpers 💖

Bestie, this is the Linux-only corner of hwloc: it’s giving “kernel cpumap files but make it cute,” and it’s here to help. 🐧✨

---

🌸 SYNOPSIS 🌸

🎀 Functions 🎀

int hwloc_linux_set_tid_cpubind (hwloc_topology_t topology, pid_t tid,
    hwloc_const_cpuset_t set)
int hwloc_linux_get_tid_cpubind (hwloc_topology_t topology, pid_t tid,
    hwloc_cpuset_t set)
int hwloc_linux_get_tid_last_cpu_location (hwloc_topology_t topology,
    pid_t tid, hwloc_bitmap_t set)
int hwloc_linux_read_path_as_cpumask (const char *path, hwloc_bitmap_t
    set)

---

🧠 Detailed Description 🧠

Okay so this section is literally: it includes helpers for manipulating Linux kernel cpumap files, plus hwloc equivalents of the Linux sched_setaffinity and sched_getaffinity system calls. That’s the whole vibe. 🫶

---

👑 Function Documentation 👑

💅 int hwloc_linux_get_tid_cpubind (hwloc_topology_t topology, pid_t tid, hwloc_cpuset_t set)

This one gets the current binding of thread tid. The CPU-set set — which the caller already allocated, bestie, don’t forget — gets filled with the list of PUs that the thread was last bound to. 🧵✨

The behavior is exactly the same as the Linux sched_getaffinity system call, except it uses a hwloc cpuset. No cap.

Returns 0 on success, -1 on error.

Note: This is equivalent to calling hwloc_get_proc_cpubind() with HWLOC_CPUBIND_THREAD as flags. 💖

---

🦋 int hwloc_linux_get_tid_last_cpu_location (hwloc_topology_t topology, pid_t tid, hwloc_bitmap_t set)

This one gets the last physical CPU where thread tid ran. The CPU-set set — again, previously allocated by the caller — is filled with the PU that the thread last ran on. 📍🔥

Returns 0 on success, -1 on error.

Note: This is equivalent to calling hwloc_get_proc_last_cpu_location() with HWLOC_CPUBIND_THREAD as flags. 🫶

---

🎀 int hwloc_linux_read_path_as_cpumask (const char * path, hwloc_bitmap_t set)

Convert a Linux kernel cpumask file path into a hwloc bitmap set. Might be used when reading CPU set from sysfs attributes such as topology and caches for processors, or local_cpus for devices. 🗂️✨

Returns 0 on success, -1 on error.

Note: This function ignores the HWLOC_FSROOT environment variable. Lowkey important, highkey iconic. 💅

---

🌈 int hwloc_linux_set_tid_cpubind (hwloc_topology_t topology, pid_t tid, hwloc_const_cpuset_t set)

Bind a thread tid on CPUs given in cpuset set. The behavior is exactly the same as the Linux sched_setaffinity system call, but it uses a hwloc cpuset. 💅🔥

Returns 0 on success, -1 on error.

Note: This is equivalent to calling hwloc_set_proc_cpubind() with HWLOC_CPUBIND_THREAD as flags. 👑

---

🌟 Author 🌟

Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code. So yes, the robots wrote this one, but we’re giving it main character energy anyway. 🤖💖

---

💌 Cute sign-off: Hardware Locality (hwloc) · Version 2.15.0 · hwlocality_linux(3) — the footer date isn’t listed on this one, bestie, but the source and version are absolutely serving. 🫶✨