Skip to content

Upgrading to v2.0 API

Jump to bottom
Brice Goglin edited this page Nov 3, 2015 · 45 revisions

Here is a list of recommended ways to work-around API changes.

Detecting the hwloc version

To detect whether your building against hwloc 2.0.0 or later:

#if HWLOC_API_VERSION >= 0x20000
...
#endif

HWLOC_OBJ_CACHE replaced

Replaced with HWLOC_OBJ_L1CACHE, ..., HWLOC_OBJ_L5CACHE, HWLOC_OBJ_L1ICACHE, ..., HWLOC_OBJ_L3ICACHE. hwloc_get_cache_type_depth() is not really needed to disambiguate cache types anymore. hwloc_obj_type_is_cache(), hwloc_obj_type_is_dcache() and hwloc_obj_type_is_icache() may be used to check whether a given type is a cache, data/unified cache or instruction cache.

I/O and Misc children

I/O children are not in the main object children list anymore. They are in the list starting at obj->io_first_child and whose size if obj->io_arity.

Misc children are not in the main object children list anymore. They are in the list starting at obj->misc_first_child and whose size if obj->misc_arity.

hwloc_topology_insert_misc_object_by_cpuset() and hwloc_topology_insert_misc_object_by_parent() replaced

hwloc_topology_insert_misc_object_by_cpuset() is replaced with hwloc_topology_alloc_group_object() and hwloc_topology_insert_group_object().

hwloc_topology_insert_misc_object_by_parent() is replaced with hwloc_topology_insert_misc_object()

hwloc_topology_set_fsroot() removed

hwloc_topology_set_fsroot() was removed. For remote/offline debugging, the HWLOC_FSROOT environment variable is still supported for the same behavior.

hwloc_obj_type_sscanf() modified

Pass an union hwloc_obj_attr_u instead of specific attributes. And get back attributes from the union cache or group fields.

hwloc_topology_ignore_type() replaced

Superseded by hwloc_topology_set_type_filter(topology, type, HWLOC_TYPE_FILTER_KEEP_NONE);

hwloc_topology_ignore_type_keep_structure() replaced

Superseded by hwloc_topology_set_type_filter(topology, type, HWLOC_TYPE_FILTER_KEEP_STRUCTURE);

Also, the meaning has changed (only entire levels may be ignored, instead of single objects), the old behavior is not available anymore.

hwloc_topology_ignore_all_keep_structure() replaced

Superseded by hwloc_topology_set_all_types_filter(topology, HWLOC_TYPE_FILTER_KEEP_STRUCTURE);

Also, the meaning has changed (only entire levels may be ignored, instead of single objects), the old behavior is not available anymore.

HWLOC_TOPOLOGY_FLAG_ICACHES replaced

Superseded by hwloc_topology_set_icache_types_filter(topology, HWLOC_TYPE_FILTER_KEEP_ALL);

HWLOC_TOPOLOGY_FLAG_WHOLE_IO replaced

Superseded by hwloc_topology_set_icache_types_filter(topology, HWLOC_TYPE_FILTER_KEEP_ALL);

HWLOC_TOPOLOGY_FLAG_IO_DEVICES and HWLOC_TOPOLOGY_FLAG_IO_BRIDGES replaced

Superseded by hwloc_topology_set_io_types_filter(topology, HWLOC_OBJ_BRIDGE, HWLOC_TYPE_FILTER_KEEP_IMPORTANT);

hwloc_fill_object_sets() renamed

Renamed into hwloc_obj_add_children_sets().

hwloc_obj_snprintf() removed

Removed, long-deprecated by hwloc_obj_type_snprintf() and hwloc_obj_attr_snprintf()

obj->online_cpuset removed

The field has been removed from hwloc_obj_t. Offline are simply listed in the complete_cpuset as previously.

obj->os_level removed

The object field has been removed.

Custom interface removed

hwloc_topology_set_custom(), hwloc_custom_insert_topology() and hwloc_custom_insert_group_object_by_parent() removed from the API.

The corresponding hwloc-assembler and hwloc-assembler-remote command-line tools also removed.

The custom interface is not available anymore. Topologies always start with object with valid cpusets and nodesets.

HWLOC_MEMBIND_REPLICATE removed

Not available anymore (no supported operating system supports it).

Clone this wiki locally