Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.2.2

  |   Home   |   Support   |   FAQ   |  
Create and Destroy Topologies

Functions

int hwloc_topology_init (hwloc_topology_t *topologyp)
 Allocate a topology context.
int hwloc_topology_load (hwloc_topology_t topology)
 Build the actual topology.
void hwloc_topology_destroy (hwloc_topology_t topology)
 Terminate and free a topology context.
void hwloc_topology_check (hwloc_topology_t topology)
 Run internal checks on a topology structure.

Function Documentation

void hwloc_topology_check ( hwloc_topology_t  topology)

Run internal checks on a topology structure.

The program aborts if an inconsistency is detected in the given topology.

Parameters:
topologyis the topology to be checked
Note:
This routine is only useful to developers.
The input topology should have been previously loaded with hwloc_topology_load().
void hwloc_topology_destroy ( hwloc_topology_t  topology)

Terminate and free a topology context.

Parameters:
topologyis the topology to be freed
int hwloc_topology_init ( hwloc_topology_t topologyp)

Allocate a topology context.

Parameters:
[out]topologypis assigned a pointer to the new allocated context.
Returns:
0 on success, -1 on error.
int hwloc_topology_load ( hwloc_topology_t  topology)

Build the actual topology.

Build the actual topology once initialized with hwloc_topology_init() and tuned with Configure Topology Detection routines. No other routine may be called earlier using this topology context.

Parameters:
topologyis the topology to be loaded with objects.
Returns:
0 on success, -1 on error.
See also:
Configure Topology Detection