Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.0.2

  |   Home   |   Support   |   FAQ   |  

Advanced Traversal Helpers

Functions

unsigned hwloc_get_closest_objs (hwloc_topology_t topology, hwloc_obj_t src, hwloc_obj_t *restrict objs, unsigned max)
 Do a depth-first traversal of the topology to find and sort.
static inline
hwloc_obj_t
 
hwloc_get_obj_below_by_type (hwloc_topology_t topology, hwloc_obj_type_t type1, unsigned idx1, hwloc_obj_type_t type2, unsigned idx2)
 Find an object below another object, both specified by types and indexes.
static inline
hwloc_obj_t
 
hwloc_get_obj_below_array_by_type (hwloc_topology_t topology, int nr, hwloc_obj_type_t *typev, unsigned *idxv)
 Find an object below a chain of objects specified by types and indexes.

Function Documentation

unsigned hwloc_get_closest_objs ( hwloc_topology_t  topology,
hwloc_obj_t  src,
hwloc_obj_t *restrict  objs,
unsigned  max 
)

Do a depth-first traversal of the topology to find and sort.

all objects that are at the same depth than src. Report in objs up to max physically closest ones to src.

Returns:
the number of objects returned in objs.
static inline hwloc_obj_t hwloc_get_obj_below_array_by_type ( hwloc_topology_t  topology,
int  nr,
hwloc_obj_type_t typev,
unsigned *  idxv 
) [static]

Find an object below a chain of objects specified by types and indexes.

This is a generalized version of hwloc_get_obj_below_by_type().

Arrays typev and idxv must contain nr types and indexes.

Start from the top system object and walk the arrays typev and idxv. For each type and index couple in the arrays, look under the previously found object to find the index-th object of the given type. Indexes are specified within the parent, not withing the entire system.

For instance, if nr is 3, typev contains NODE, SOCKET and CORE, and idxv contains 0, 1 and 2, return the third core object below the second socket below the first NUMA node.

static inline hwloc_obj_t hwloc_get_obj_below_by_type ( hwloc_topology_t  topology,
hwloc_obj_type_t  type1,
unsigned  idx1,
hwloc_obj_type_t  type2,
unsigned  idx2 
) [static]

Find an object below another object, both specified by types and indexes.

Start from the top system object and find object of type type1 and index idx1. Then look below this object and find another object of type type2 and index idx2. Indexes are specified within the parent, not withing the entire system.

For instance, if type1 is SOCKET, idx1 is 2, type2 is CORE and idx2 is 3, return the fourth core object below the third socket.