DragonFly On-Line Manual Pages

hwlocality_nvml(3)         Hardware Locality (hwloc)        hwlocality_nvml(3)

NAME
       hwlocality_nvml - Interoperability with the NVIDIA Management Library

   Functions
       static int hwloc_nvml_get_device_cpuset (hwloc_topology_t topology,
           nvmlDevice_t device, hwloc_cpuset_t set)
       static hwloc_obj_t hwloc_nvml_get_device_osdev_by_index
           (hwloc_topology_t topology, unsigned idx)
       static hwloc_obj_t hwloc_nvml_get_device_osdev (hwloc_topology_t
           topology, nvmlDevice_t device)

Detailed Description
       This interface offers ways to retrieve topology information about
       devices managed by the NVIDIA Management Library (NVML).

Function Documentation
   static int hwloc_nvml_get_device_cpuset (hwloc_topology_t topology,
       nvmlDevice_t device, hwloc_cpuset_t set) [inline],  [static]
       Get the CPU set of logical processors that are physically close to NVML
       device device. Return the CPU set describing the locality of the NVML
       device device.

       Topology topology and device device must match the local machine. I/O
       devices detection and the NVML component are not needed in the
       topology.

       The function only returns the locality of the device. If more
       information about the device is needed, OS objects should be used
       instead, see hwloc_nvml_get_device_osdev() and
       hwloc_nvml_get_device_osdev_by_index().

       This function is currently only implemented in a meaningful way for
       Linux; other systems will simply get a full cpuset.

   static hwloc_obj_t hwloc_nvml_get_device_osdev (hwloc_topology_t topology,
       nvmlDevice_t device) [inline],  [static]
       Get the hwloc OS device object corresponding to NVML device device.
       Return the hwloc OS device object that describes the given NVML device
       device. Return NULL if there is none.

       Topology topology and device device must match the local machine. I/O
       devices detection and the NVML component must be enabled in the
       topology. If not, the locality of the object may still be found using
       hwloc_nvml_get_device_cpuset().

       Note:
           The corresponding hwloc PCI device may be found by looking at the
           result parent pointer.

   static hwloc_obj_t hwloc_nvml_get_device_osdev_by_index (hwloc_topology_t
       topology, unsigned idx) [inline],  [static]
       Get the hwloc OS device object corresponding to the NVML device whose
       index is idx. Return the OS device object describing the NVML device
       whose index is idx. Returns NULL if there is none.

       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 NVML component must be enabled in
       the topology.

       Note:
           The corresponding PCI device object can be obtained by looking at
           the OS device parent object.

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

Version 1.11.1                  Thu Oct 15 2015             hwlocality_nvml(3)