Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.7.2

  |   Home   |   Support   |   FAQ   |  
Retrieve Objects


HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth (hwloc_topology_t topology, unsigned depth, unsigned idx) __hwloc_attribute_pure
static __hwloc_inline hwloc_obj_t hwloc_get_obj_by_type (hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure

Detailed Description

Be sure to see the figure in termsanddefs that shows a complete topology tree, including depths, child/sibling/cousin relationships, and an example of an asymmetric topology where one socket has fewer caches than its peers.

Function Documentation

HWLOC_DECLSPEC hwloc_obj_t hwloc_get_obj_by_depth ( hwloc_topology_t  topology,
unsigned  depth,
unsigned  idx 

Returns the topology object at logical index idx from depth depth.

static __hwloc_inline hwloc_obj_t hwloc_get_obj_by_type ( hwloc_topology_t  topology,
hwloc_obj_type_t  type,
unsigned  idx 

Returns the topology object at logical index idx with type type.

If no object for that type exists, NULL is returned. If there are several levels with objects of that type, NULL is returned and ther caller may fallback to hwloc_get_obj_by_depth().