hwlocality_gl(3)

🦋 hwlocality_gl(3) 🦋

okay so this is from the Library Functions Manual — the Hardware Locality (hwloc) one — and it's giving OpenGL display interoperability, bestie. no cap, let's go 💖

🎀 NAME 🎀

hwlocality_gl - Interoperability with OpenGL displays

✨ SYNOPSIS ✨

💖 Functions 💖

hwloc_obj_t hwloc_gl_get_display_osdev_by_port_device (hwloc_topology_t
    topology, unsigned port, unsigned device)
hwloc_obj_t hwloc_gl_get_display_osdev_by_name (hwloc_topology_t
    topology, const char *name)
int hwloc_gl_get_display_by_osdev (hwloc_topology_t topology,
    hwloc_obj_t osdev, unsigned *port, unsigned *device)

🌸 Detailed Description 🌸

This interface is literally your way to retrieve topology information about OpenGL displays.

Only the NVIDIA display locality information is currently available — it's using the NV-CONTROL X11 extension and the NVCtrl library, iykyk.

⚠️ This code may hang when trying to connect to the X server. Hence the GL component is disabled unless HWLOC_GL=1 in the environment.

💅 Function Documentation 💅

hwloc_gl_get_display_by_osdev [inline]

int hwloc_gl_get_display_by_osdev (hwloc_topology_t topology, hwloc_obj_t
       osdev, unsigned * port, unsigned * device) [inline]

Gets the OpenGL display port and device corresponding to the given hwloc OS object. Retrieves the OpenGL display port (server) in port and device (screen) in screen that correspond to the given hwloc OS device object.

💖 Returns 💖

• 0 on success.
• -1 if none could be found.

The topology (topology) does not necessarily have to match the current machine. For instance the topology may be an XML import of a remote host. I/O devices detection and the GL component must be enabled in the topology.

📝 Note 📝

The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server. Set HWLOC_GL=1 in the environment to reenable it.

hwloc_gl_get_display_osdev_by_name [inline]

hwloc_obj_t hwloc_gl_get_display_osdev_by_name (hwloc_topology_t topology,
       const char * name) [inline]

Gets the hwloc OS device object corresponding to the OpenGL display given by name.

💖 Returns 💖

• The hwloc OS device object describing the OpenGL display whose name is name, built as ":port.device" such as ":0.0".
• NULL if none could be found.

The topology (topology) does not necessarily have to match the current machine. For instance the topology may be an XML import of a remote host. I/O devices detection and the GL component must be enabled in the topology.

📝 Note 📝

The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server. Set HWLOC_GL=1 in the environment to reenable it. The corresponding PCI device object can be obtained by looking at the OS device parent object (unless PCI devices are filtered out).

hwloc_gl_get_display_osdev_by_port_device [inline]

hwloc_obj_t hwloc_gl_get_display_osdev_by_port_device (hwloc_topology_t
       topology, unsigned port, unsigned device) [inline]

Gets the hwloc OS device object corresponding to the OpenGL display given by port and device index.

💖 Returns 💖

• The hwloc OS device object describing the OpenGL display whose port (server) is port and device (screen) is device.
• NULL if none could be found.

The topology (topology) does not necessarily have to match the current machine. For instance the topology may be an XML import of a remote host. I/O devices detection and the GL component must be enabled in the topology.

📝 Note 📝

The GL backend creating these OS devices is disabled by default since it may cause hwloc to hang when trying to connect to the X server. Set HWLOC_GL=1 in the environment to reenable it. The corresponding PCI device object can be obtained by looking at the OS device parent object (unless PCI devices are filtered out).

🌟 Author 🌟

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

---

okay that's the whole vibe, bestie 🫶 this is from the Hardware Locality (hwloc) manual, Version 2.15.0 — date: not listed in the original footer, so we're not inventing one — periodt 💅✨