hwlocality_creation - Topology Creation and Destruction

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

Hardware Locality (hwloc)                        Version 2.12.0                           hwlocality_creation(3)

inthwloc_topology_abi_check(hwloc_topology_ttopology)
       Verify that the topology is compatible with the current hwloc library. This is useful when using the same
       topology structure (in memory) in different libraries that may use different hwloc installations (for
       instance if one library embeds a specific version of hwloc, while another library uses a default system-
       wide hwloc installation).

       If all libraries/programs use the same hwloc installation, this function always returns success.

       Returns
           0 on success.

           -1 with errno set to EINVAL if incompatible.

       Note
           If sharing between processes with hwloc_shmem_topology_write(), the relevant check is already
           performed inside hwloc_shmem_topology_adopt().

   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.

       Parameterstopology 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().

   voidhwloc_topology_destroy(hwloc_topology_ttopology)
       Terminate and free a topology context.

       Parameterstopology is the topology to be freed

   inthwloc_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.

       Returns
           0 on success, -1 on error.

       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.

       Parameterstopologyp is 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 with hwloc_topology_init() and
       tuned with TopologyDetectionConfigurationandQuery and ChangingtheSourceofTopologyDiscovery
       routines. No other routine may be called earlier using this topology context.

       Parameterstopology 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.

           The binding of the current thread or process may temporarily change during this call but it will be
           restored before it returns.

       SeealsoTopologyDetectionConfigurationandQuery and ChangingtheSourceofTopologyDiscovery

       hwlocality_creation - Topology Creation and Destruction

Typedefs
       typedef struct hwloc_topology * hwloc_topology_tFunctions
       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)
       int hwloc_topology_abi_check (hwloc_topology_t topology)
       void hwloc_topology_check (hwloc_topology_t topology)

typedefstructhwloc_topology*hwloc_topology_t
       Topology context. To be initialized with hwloc_topology_init() and built with hwloc_topology_load().