Provided by: libhwloc-doc_1.11.12-3_all

**NAME**

hwlocality_creation

**SYNOPSIS**

Typedefstypedef struct hwloc_topology *hwloc_topology_tFunctionsinthwloc_topology_init(hwloc_topology_t*topologyp) inthwloc_topology_load(hwloc_topology_ttopology) voidhwloc_topology_destroy(hwloc_topology_ttopology) inthwloc_topology_dup(hwloc_topology_t*newtopology,hwloc_topology_toldtopology) voidhwloc_topology_check(hwloc_topology_ttopology)

**Detailed** **Description**

**Typedef** **Documentation**

typedefstructhwloc_topology*hwloc_topology_tTopology context. To be initialized withhwloc_topology_init()and built withhwloc_topology_load().

**Function** **Documentation**

voidhwloc_topology_check(hwloc_topology_ttopology)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 checkedNote:This routine is only useful to developers. The input topology should have been previously loaded withhwloc_topology_load().voidhwloc_topology_destroy(hwloc_topology_ttopology)Terminate and free a topology context.Parameters:topologyis the topology to be freedinthwloc_topology_dup(hwloc_topology_t*newtopology,hwloc_topology_toldtopology)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.Note:Object userdata is not duplicated since hwloc does not know what it point to. The objects of both old and new topologies will point to the same userdata.inthwloc_topology_init(hwloc_topology_t*topologyp)Allocate a topology context.Parameters:topologypis assigned a pointer to the new allocated context.Returns:0 on success, -1 on error.inthwloc_topology_load(hwloc_topology_ttopology)Build the actual topology. Build the actual topology once initialized withhwloc_topology_init()and tuned withTopologyDetectionConfigurationandQueryroutines. 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.Note:On failure, the topology is reinitialized. It should be either destroyed withhwloc_topology_destroy()or configured and loaded again. This function may be called only once per topology. The binding of the current thread or process may temporarily change during this call but it will be restored before it returns.Seealso:TopologyDetectionConfigurationandQuery

**Author**

Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code.