hwlocality_helper_types(3)

📦
version 2.15.0 · 13 versions
, in arch rolling

✨ NAME ✨

hwlocality_helper_types(3) — Kinds of object Type 💅

Welcome to the hwlocality_helper_types(3) page from the Library Functions Manual, bestie! This is where hwloc helps you figure out what kind of object type you’re holding, with six tiny check functions that are lowkey iconic. 🫶

🫶 SYNOPSIS 🫶

Functions

int hwloc_obj_type_is_normal (hwloc_obj_type_t type)
int hwloc_obj_type_is_io (hwloc_obj_type_t type)
int hwloc_obj_type_is_memory (hwloc_obj_type_t type)
int hwloc_obj_type_is_cache (hwloc_obj_type_t type)
int hwloc_obj_type_is_dcache (hwloc_obj_type_t type)
int hwloc_obj_type_is_icache (hwloc_obj_type_t type)

Six functions, same adorable shape: you hand over a hwloc_obj_type_t type, and they hand back an int that’s either 1 for “yes bestie” or 0 for “nope.” No cap. ✨

🌸 Detailed Description 🌸

Okay so every object type is either Normal (i.e. hwloc_obj_type_is_normal() returns 1), or Memory (i.e. hwloc_obj_type_is_memory() returns 1) or I/O (i.e. hwloc_obj_type_is_io() returns 1) or Misc (i.e. equal to HWLOC_OBJ_MISC). It cannot be of more than one of these kinds. Periodt. 💅

See also Object Kind in Terms and Definitions. 🦋

💅 Function Documentation 💅

🍓 int hwloc_obj_type_is_cache (hwloc_obj_type_t type)

Checks whether an object type is a CPU Cache — that’s Data, Unified or Instruction. Memory-side caches are not CPU caches, bestie. 🎀

Returns: 1 if an object of type type is a Cache, 0 otherwise.

🌈 int hwloc_obj_type_is_dcache (hwloc_obj_type_t type)

Checks whether an object type is a CPU Data or Unified Cache. Memory-side caches are not CPU caches. 🧚

Returns: 1 if an object of type type is a CPU Data or Unified Cache, 0 otherwise.

⭐ int hwloc_obj_type_is_icache (hwloc_obj_type_t type)

Checks whether an object type is a CPU Instruction Cache. Memory-side caches are not CPU caches. 💛

Returns: 1 if an object of type type is a CPU Instruction Cache, 0 otherwise.

🔥 int hwloc_obj_type_is_io (hwloc_obj_type_t type)

Checks whether an object type is I/O. I/O objects are objects attached to their parents in the I/O children list. The current lineup includes Bridges, PCI and OS devices. 👑

Returns: 1 if an object of type type is a I/O object, 0 otherwise.

🦋 int hwloc_obj_type_is_memory (hwloc_obj_type_t type)

Checks whether an object type is Memory. Memory objects are objects attached to their parents in the Memory children list. The current lineup includes NUMA nodes and Memory-side caches. 💜

Returns: 1 if an object of type type is a Memory object, 0 otherwise.

🌸 int hwloc_obj_type_is_normal (hwloc_obj_type_t type)

Checks whether an object type is Normal. Normal objects are objects of the main CPU hierarchy (Machine, Package, Core, PU, CPU caches, etc.), but they are not NUMA nodes, I/O devices or Misc objects. 🎀

They are attached to parent as Normal children, not as Memory, I/O or Misc children.

Returns: 1 if an object of type type is a Normal object, 0 otherwise.

👑 Author 👑

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

okay that’s the whole page bestie 🫶 footer shoutout: Hardware Locality (hwloc), Version 2.15.0, page hwlocality_helper_types(3) — mwah, bye! 💖🎀

📦 where this page comes from