Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.7.2

  |   Home   |   Support   |   FAQ   |  
Get Some Topology Information


enum  hwloc_get_type_depth_e {


HWLOC_DECLSPEC unsigned hwloc_topology_get_depth (hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure
HWLOC_DECLSPEC int hwloc_get_type_depth (hwloc_topology_t topology, hwloc_obj_type_t type)
HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure
HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth (hwloc_topology_t topology, unsigned depth) __hwloc_attribute_pure
static __hwloc_inline int hwloc_get_nbobjs_by_type (hwloc_topology_t topology, hwloc_obj_type_t type) __hwloc_attribute_pure
HWLOC_DECLSPEC int hwloc_topology_is_thissystem (hwloc_topology_t __hwloc_restrict topology) __hwloc_attribute_pure
HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags (hwloc_topology_t topology)

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.

Enumeration Type Documentation


No object of given type exists in the topology.


Objects of given type exist at different depth in the topology.


Virtual depth for bridge object level.


Virtual depth for PCI device object level.


Virtual depth for software device object level.

Function Documentation

HWLOC_DECLSPEC hwloc_obj_type_t hwloc_get_depth_type ( hwloc_topology_t  topology,
unsigned  depth 

Returns the type of objects at depth depth.

-1 if depth depth does not exist.
HWLOC_DECLSPEC unsigned hwloc_get_nbobjs_by_depth ( hwloc_topology_t  topology,
unsigned  depth 

Returns the width of level at depth depth.

static __hwloc_inline int hwloc_get_nbobjs_by_type ( hwloc_topology_t  topology,
hwloc_obj_type_t  type 

Returns the width of level type type.

If no object for that type exists, 0 is returned. If there are several levels with objects of that type, -1 is returned.

HWLOC_DECLSPEC int hwloc_get_type_depth ( hwloc_topology_t  topology,
hwloc_obj_type_t  type 

Returns the depth of objects of type type.

If no object of this type is present on the underlying architecture, or if the OS doesn't provide this kind of information, the function returns HWLOC_TYPE_DEPTH_UNKNOWN.

If type is absent but a similar type is acceptable, see also hwloc_get_type_or_below_depth() and hwloc_get_type_or_above_depth().

If some objects of the given type exist in different levels, for instance L1 and L2 caches, or L1i and L1d caches, the function returns HWLOC_TYPE_DEPTH_MULTIPLE. See hwloc_get_cache_type_depth() in hwloc/helper.h to better handle this case.

If an I/O object type is given, the function returns a virtual value because I/O objects are stored in special levels that are not CPU-related. This virtual depth may be passed to other hwloc functions such as hwloc_get_obj_by_depth() but it should not be considered as an actual depth by the application. In particular, it should not be compared with any other object depth or with the entire topology depth.

HWLOC_DECLSPEC unsigned hwloc_topology_get_depth ( hwloc_topology_t __hwloc_restrict  topology)

Get the depth of the hierarchical tree of objects.

This is the depth of HWLOC_OBJ_PU objects plus one.

HWLOC_DECLSPEC unsigned long hwloc_topology_get_flags ( hwloc_topology_t  topology)

Get OR'ed flags of a topology.

Get the OR'ed set of hwloc_topology_flags_e of a topology.

the flags previously set with hwloc_topology_set_flags().
HWLOC_DECLSPEC int hwloc_topology_is_thissystem ( hwloc_topology_t __hwloc_restrict  topology)

Does the topology context come from this system?

1 if this topology context was built using the system running this program.
0 instead (for instance if using another file-system root, a XML topology file, or a synthetic topology).