hwlocality_creation(3) Hardware Locality (hwloc) hwlocality_creation(3)NAME
hwlocality_creation - Topology Creation and Destruction
Typedefs
typedef struct hwloc_topology * hwloc_topology_t
Functions
int hwloc_topology_init (hwloc_topology_t *topologyp)
int hwloc_topology_load (hwloc_topology_t topology)
void hwloc_topology_destroy (hwloc_topology_t topology)
int hwloc_topology_dup (hwloc_topology_t *newtopology, hwloc_topology_t
oldtopology)
void hwloc_topology_check (hwloc_topology_t topology)
Detailed DescriptionTypedef Documentation
typedef struct hwloc_topology* hwloc_topology_t
Topology context. To be initialized with hwloc_topology_init() and
built with hwloc_topology_load().
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:
topology is 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:
topology is the topology to be freed
int hwloc_topology_dup (hwloc_topology_t * newtopology, hwloc_topology_t
oldtopology)
Duplicate a topology. The entire topology structure as well as its
objects are duplicated into a new one.
This is useful for keeping a backup while modifying a topology.
int hwloc_topology_init (hwloc_topology_t * topologyp)
Allocate a topology context.
Parameters:
topologyp is 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 Topology Detection
Configuration and Query routines. No other routine may be called
earlier using this topology context.
Parameters:
topology is the topology to be loaded with objects.
Returns:
0 on success, -1 on error.
Note:
On failure, the topology is reinitialized. It should be either
destroyed with hwloc_topology_destroy() or configured and loaded
again.
This function may be called only once per topology.
See also:
Topology Detection Configuration and Query
Author
Generated automatically by Doxygen for Hardware Locality (hwloc) from
the source code.
Version 1.11.1 Thu Oct 15 2015 hwlocality_creation(3)
