hwlocality_objects(3) [debian man page]

Topology Objects(3)					     Hardware Locality (hwloc)					       Topology Objects(3)

NAME

       Topology Objects -

   Data Structures
       struct hwloc_obj_memory_s
	   Object memory.
       struct hwloc_obj
	   Structure of a topology object.
       union hwloc_obj_attr_u
	   Object type-specific Attributes.
       struct hwloc_distances_s
	   Distances between objects.
       struct hwloc_obj_info_s
	   Object info.

   Typedefs
       typedef struct hwloc_obj * hwloc_obj_t

Typedef Documentation
   typedef struct hwloc_obj* hwloc_obj_t
       Convenience typedef; a pointer to a struct hwloc_obj.

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

Version 1.4.1							  Mon Feb 27 2012					       Topology Objects(3)

OpenFabrics-Specific Functions(3)			     Hardware Locality (hwloc)				 OpenFabrics-Specific Functions(3)

NAME

       OpenFabrics-Specific Functions -

   Functions
       static inline int hwloc_ibv_get_device_cpuset (hwloc_topology_t topology , struct ibv_device *ibdev, hwloc_cpuset_t set)
       static inline hwloc_obj_t hwloc_ibv_get_device_osdev_by_name (hwloc_topology_t topology, const char *ibname)
       static inline hwloc_obj_t hwloc_ibv_get_device_osdev (hwloc_topology_t topology, struct ibv_device *ibdev)

Detailed Description
Function Documentation
   static inline int hwloc_ibv_get_device_cpuset (hwloc_topology_t topology, struct ibv_device *ibdev, hwloc_cpuset_tset) [static]
       Get the CPU set of logical processors that are physically close to device ibdev. Return the CPU set describing the locality of the
       OpenFabrics device ibdev.

       Topology topology and device ibdev must match the local machine. I/O devices detection is 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_ibv_get_device_osdev() and hwloc_ibv_get_device_osdev_by_name().

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

   static inline hwloc_obj_t hwloc_ibv_get_device_osdev (hwloc_topology_ttopology, struct ibv_device *ibdev) [static]
       Get the hwloc OS device object corresponding to the OpenFabrics device ibdev. Return the OS device object describing the OpenFabrics device
       ibdev. Returns NULL if there is none.

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

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

   static inline hwloc_obj_t hwloc_ibv_get_device_osdev_by_name (hwloc_topology_ttopology, const char *ibname) [static]
       Get the hwloc OS device object corresponding to the OpenFabrics device named ibname. Return the OS device object describing the OpenFabrics
       device whose name is ibname. Returns NULL if there is none. The name ibname is usually obtained from ibv_get_device_name().

       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 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.7							  Sun Apr 7 2013				 OpenFabrics-Specific Functions(3)