Copyright © 2009 CNRS

Copyright © 2009-2018 Inria.  All rights reserved.

Copyright © 2009-2013 Université Bordeaux

Copyright © 2009-2011 Cisco Systems, Inc.  All rights reserved.

$COPYRIGHT$

Additional copyrights may follow

$HEADER$

===========================================================================

This file contains the main features as well as overviews of specific

bug fixes (and other actions) for each version of hwloc since version

0.9 (as initially released as "libtopology", then re-branded to "hwloc"

in v0.9.1).

Version 2.0.3 (also included in 1.11.12 when appropriate)

-------------

* Fix build on Cygwin, thanks to Marco Atzeri for the patches.

* Fix a corner case of hwloc_topology_restrict() where children would

  become out-of-order.

* Fix the return length of export_xmlbuffer() functions to always

  include the ending \0.

* Fix lstopo --children-order argument parsing.

Version 2.0.2 (also included in 1.11.11 when appropriate)

-------------

* Add support for Hygon Dhyana processors in the x86 backend,

  thanks to Pu Wen for the patch.

* Fix symbol renaming to also rename internal components,

  thanks to Evan Ramos for the patch.

* Fix build on HP-UX, thanks to Richard Lloyd for reporting the issues.

* Detect PCI link speed without being root on Linux >= 4.13.

* Add HWLOC_VERSION* macros to the public headers,

  thanks to Gilles Gouaillardet for the suggestion.

Version 2.0.1 (also included in 1.11.10 when relevant)

-------------

* Bump the library soname to 15:0:0 to avoid conflicts with hwloc 1.11.x

  releases. The hwloc 2.0.0 soname was buggy (12:0:0), applications will

  have to be recompiled.

* Serialize pciaccess discovery to fix concurrent topology loads in

  multiple threads.

* Fix hwloc-dump-hwdata to only process SMBIOS information that correspond

  to the KNL and KNM configuration.

* Add a heuristic for guessing KNL/KNM memory and cluster modes when

  hwloc-dump-hwdata could not run as root earlier.

* Add --no-text lstopo option to remove text from some boxes in the

  graphical output. Mostly useful for removing Group labels.

* Some minor fixes to memory binding.

Version 2.0.0

-------------

*** The ABI of the library has changed. ***

  For instance some hwloc_obj fields were reordered, added or removed, see below.

  + HWLOC_API_VERSION and hwloc_get_api_version() now give 0x00020000.

  + See "How do I handle ABI breaks and API upgrades ?" in the FAQ

    and "Upgrading to hwloc 2.0 API" in the documentation.

* Major API changes

  + Memory, I/O and Misc objects are now stored in dedicated children lists,

    not in the usual children list that is now only used for CPU-side objects.

    - hwloc_get_next_child() may still be used to iterate over these 4 lists

      of children at once.

    - hwloc_obj_type_is_normal(), _memory() and _io() may be used to check

      the kind of a given object type.

  + Topologies always have at least one NUMA object. On non-NUMA machines,

    a single NUMA object is added to describe the entire machine memory.

    The NUMA level cannot be ignored anymore.

  + The NUMA level is special since NUMA nodes are not in the main hierarchy

    of objects anymore. Its depth is a fake negative depth that should not be

    compared with normal levels.

    - If all memory objects are attached to parents at the same depth,

      it may be retrieved with hwloc_get_memory_parents_depth().

  + The HWLOC_OBJ_CACHE type is replaced with 8 types HWLOC_OBJ_L[1-5]CACHE

    and HWLOC_OBJ_L[1-3]ICACHE that remove the need to disambiguate levels

    when looking for caches with _by_type() functions.

    - New hwloc_obj_type_is_{,d,i}cache() functions may be used to check whether

      a given type is a cache.

  + Reworked ignoring/filtering API

    - Replace hwloc_topology_ignore*() functions with hwloc_topology_set_type_filter()

      and hwloc_topology_set_all_types_filter().

      . Contrary to hwloc_topology_ignore_{type,all}_keep_structure() which

        removed individual objects, HWLOC_TYPE_FILTER_KEEP_STRUCTURE only removes

        entire levels (so that topology do not become too asymmetric).

    - Remove HWLOC_TOPOLOGY_FLAG_ICACHES in favor of hwloc_topology_set_icache_types_filter()

      with HWLOC_TYPE_FILTER_KEEP_ALL.

    - Remove HWLOC_TOPOLOGY_FLAG_IO_DEVICES, _IO_BRIDGES and _WHOLE_IO in favor of

      hwloc_topology_set_io_types_filter() with HWLOC_TYPE_FILTER_KEEP_ALL or

      HWLOC_TYPE_FILTER_KEEP_IMPORTANT.

  + The distance API has been completely reworked. It is now described

    in hwloc/distances.h.

  + Return values

    - Most functions in hwloc/bitmap.h now return an int that may be negative

      in case of failure to realloc/extend the internal storage of a bitmap.

    - hwloc_obj_add_info() also returns an int in case allocations fail.

* Minor API changes

  + Object attributes

    - obj->memory is removed.

      . local_memory and page_types attributes are now in obj->attr->numanode

      . total_memory moves obj->total_memory.

    - Objects do not have allowed_cpuset and allowed_nodeset anymore.

      They are only available for the entire topology using

      hwloc_topology_get_allowed_cpuset() and hwloc_topology_get_allowed_nodeset().

    - Objects now have a "subtype" field that supersedes former "Type" and

      "CoProcType" info attributes.

  + Object and level depths are now signed ints.

  + Object string printing and parsing

    - hwloc_type_sscanf() deprecates the old hwloc_obj_type_sscanf().

    - hwloc_type_sscanf_as_depth() is added to convert a type name into

      a level depth.

    - hwloc_obj_cpuset_snprintf() is deprecated in favor of hwloc_bitmap_snprintf().

  + Misc objects

    - Replace hwloc_topology_insert_misc_object_by_cpuset() with

      hwloc_topology_insert_group_object() to precisely specify the location

      of an additional hierarchy level in the topology.

    - Misc objects have their own level and depth to iterate over all of them.

    - Misc objects may now only be inserted as a leaf object with

      hwloc_topology_insert_misc_object() which deprecates

      hwloc_topology_insert_misc_object_by_parent().

  + hwloc_topology_restrict() doesn't remove objects that contain memory

    by default anymore.

    - The list of existing restrict flags was modified.

  + The discovery support array now contains some NUMA specific bits.

  + XML export functions take an additional flags argument,

    for instance for exporting XMLs that are compatible with hwloc 1.x.

  + Functions diff_load_xml*(), diff_export_xml*() and diff_destroy() in

    hwloc/diff.h do not need a topology as first parameter anymore.

  + hwloc_parse_cpumap_file () superseded by hwloc_linux_read_path_as_cpumask()

    in hwloc/linux.h.

  + HWLOC_MEMBIND_DEFAULT and HWLOC_MEMBIND_FIRSTTOUCH were clarified.

* New APIs and Features

  + Add hwloc/shmem.h for sharing topologies between processes running on

    the same machine (for reducing the memory footprint).

  + Add the experimental netloc subproject. It is disabled by default

    and can be enabled with --enable-netloc.

    It currently brings command-line tools to gather and visualize the

    topology of InfiniBand fabrics, and an API to convert such topologies

    into Scotch architectures for process mapping.

    See the documentation for details.

* Removed APIs and features

  + Remove the online_cpuset from struct hwloc_obj. Offline PUs get unknown

    topologies on Linux nowadays, and wrong topology on Solaris. Other OS

    do not support them. And one cannot do much about them anyway. Just keep

    them in complete_cpuset.

  + Remove the now-unused "System" object type HWLOC_OBJ_SYSTEM,

    defined to MACHINE for backward compatibility.

  + The almost-unused "os_level" attribute has been removed from the

    hwloc_obj structure.

  + Remove the custom interface for assembling the topologies of different

    nodes as well as the hwloc-assembler tools.

  + hwloc_topology_set_fsroot() is removed, the environment variable

    HWLOC_FSROOT may be used for the same remote testing/debugging purpose.

  + Remove the deprecated hwloc_obj_snprintf(), hwloc_obj_type_of_string(),

    hwloc_distribute[v]().

  * Remove Myrinet Express interoperability (hwloc/myriexpress.h).

  + Remove Kerrighed support from the Linux backend.

  + Remove Tru64 (OSF/1) support.

    - Remove HWLOC_MEMBIND_REPLICATE which wasn't available anywhere else.

* Backend improvements

  + Linux

    - OS devices do not have to be attached through PCI anymore,

      for instance enabling the discovery of NVDIMM block devices.

    - Remove the dependency on libnuma.

    - Add a SectorSize attribute to block OS devices.

  + Mac OS X

    - Fix detection of cores and hyperthreads.

    - Add CPUVendor, Model, ... attributes.

  + Windows

    - Add get_area_memlocation().

* Tools

  + lstopo and hwloc-info have a new --filter option matching the new filtering API.

  + lstopo can be given --children-order=plain to force a basic displaying

    of memory and normal children together below their parent.

  + hwloc-distances was removed and replaced with lstopo --distances.

* Misc

  + Exports

    - Exporting to synthetic now ignores I/O and Misc objects.

  + PCI discovery

    - Separate OS device discovery from PCI discovery. Only the latter is disabled

      with --disable-pci at configure time. Both may be disabled with --disable-io.

    - The `linuxpci' component is now renamed into `linuxio'.

    - The old `libpci' component name from hwloc 1.6 is not supported anymore,

      only the `pci' name from hwloc 1.7 is now recognized.

    - The HWLOC_PCI_<domain>_<bus>_LOCALCPUS environment variables are superseded

      with a single HWLOC_PCI_LOCALITY where bus ranges may be specified.

    - Do not set PCI devices and bridges name automatically. Vendor and device

      names are already in info attributes.

  + Components and discovery

    - Add HWLOC_SYNTHETIC environment variable to enforce a synthetic topology

      as if hwloc_topology_set_synthetic() had been called.

    - HWLOC_COMPONENTS doesn't support xml or synthetic component attributes

      anymore, they should be passed in HWLOC_XMLFILE or HWLOC_SYNTHETIC instead.

    - HWLOC_COMPONENTS takes precedence over other environment variables

      for selecting components.

  + hwloc now requires a C99 compliant compiler.

Version 1.11.9

--------------

* Add support for Zhaoxin ZX-C and ZX-D processors in the x86 backend,

  thanks to Jeff Zhao for the patch.

* Fix AMD Epyc 24-core L3 cache locality in the x86 backend.

* Don't crash in the x86 backend when the CPUID vendor string is unknown.

* Fix the missing pu discovery support bit on some OS.

* Fix the management of the lstopoStyle info attribute for custom colors.

* Add verbose warnings when failing to load hwloc v2.0+ XMLs.

Version 1.11.8

--------------

* Multiple Solaris improvements, thanks to Maureen Chew for the help:

  + Detect caches on Sparc.

  + Properly detect allowed/disallowed PUs and NUMA nodes with processor sets.

  + Add hwloc_get_last_cpu_location() support for the current thread.

* Add support for CUDA compute capability 7.0 and fix support for 6.[12].

* Tools improvements

  + Fix search for objects by physical index in command-line tools.

  + Add missing "cpubind:get_thisthread_last_cpu_location" in the output

    of hwloc-info --support.

  + Add --pid and --name to specify target processes in hwloc-ps.

  + Display thread names in lstopo and hwloc-ps on Linux.

* Doc improvements

  + Add a FAQ entry about building on Windows.

  + Install missing sub-manpage for hwloc_obj_add_info() and

    hwloc_obj_get_info_by_name().

Version 1.11.7

--------------

* Fix hwloc-bind --membind for CPU-less NUMA nodes (again).

  Thanks to Gilles Gouaillardet for reporting the issue.

* Fix a memory leak on IBM S/390 platforms running Linux.

* Fix a memory leak when forcing the x86 backend first on amd64/topoext

  platforms running Linux.

* Command-line tools now support "hbm" instead "numanode" for filtering

  only high-bandwidth memory nodes when selecting locations.

  + hwloc-bind also support --hbm and --no-hbm for filtering only or

    no HBM nodes.

  Thanks to Nicolas Denoyelle for the suggestion.

* Add --children and --descendants to hwloc-info for listing object

  children or object descendants of a specific type.

* Add --no-index, --index, --no-attrs, --attrs to disable/enable display

  of index numbers or attributes in the graphical lstopo output.

* Try to gather hwloc-dump-hwdata output from all possible locations

  in hwloc-gather-topology.

* Updates to the documentation of locations in hwloc(7) and

  command-line tools manpages.

Version 1.11.6

--------------

* Make the Linux discovery about twice faster, especially on the CPU side,

  by trying to avoid sysfs file accesses as much as possible.

* Add support for AMD Family 17h processors (Zen) SMT cores in the Linux

  and x86 backends.

* Add the HWLOC_TOPOLOGY_FLAG_THISSYSTEM_ALLOWED_RESOURCES flag (and the

  HWLOC_THISSYSTEM_ALLOWED_RESOURCES environment variable) for reading the

  set of allowed resources from the local operating system even if the

  topology was loaded from XML or synthetic.

* Fix hwloc_bitmap_set/clr_range() for infinite ranges that do not

  overlap currently defined ranges in the bitmap.

* Don't reset the lstopo zoom scale when moving the X11 window.

* lstopo now has --flags for manually setting topology flags.

* hwloc_get_depth_type() returns HWLOC_TYPE_DEPTH_UNKNOWN for Misc objects.

Version 1.11.5

--------------

* Add support for Knights Mill Xeon Phi, thanks to Piotr Luc for the patch.

* Reenable distance gathering on Solaris, disabled by mistake since v1.0.

  Thanks to TU Wien for the help.

* Fix hwloc_get_*obj*_inside_cpuset() functions to ignore objects with

  empty CPU sets, for instance, CPU-less NUMA nodes such as KNL MCDRAM.

  Thanks to Nicolas Denoyelle for the report.

* Fix XML import of multiple distance matrices.

* Add a FAQ entry about "hwloc is only a structural model, it ignores

  performance models, memory bandwidth, etc.?"

Version 1.11.4

--------------

* Add MemoryMode and ClusterMode attributes in the Machine object on KNL.

  Add doc/examples/get-knl-modes.c for an example of retrieving them.

  Thanks to Grzegorz Andrejczuk.

* Fix Linux build with -m32 with respect to libudev.

  Thanks to Paul Hargrove for reporting the issue.

* Fix build with Visual Studio 2015, thanks to Eloi Gaudry for reporting

  the issue and providing the patch.

* Don't forget to display OS device children in the graphical lstopo.

* Fix a memory leak on Solaris, thanks to Bryon Gloden for the patch.

* Properly handle realloc() failures, thanks to Bryon Gloden for reporting

  the issue.

* Fix lstopo crash in ascii/fig/windows outputs when some objects have a

  lstopoStyle info attribute.

Version 1.11.3

--------------

* Bug fixes

  + Fix a memory leak on Linux S/390 hosts with books.

  + Fix /proc/mounts parsing on Linux by using mntent.h.

    Thanks to Nathan Hjelm for reporting the issue.

  + Fix a x86 infinite loop on VMware due to the x2APIC feature being

    advertised without actually being fully supported.

    Thanks to Jianjun Wen for reporting the problem and testing the patch.

  + Fix the return value of hwloc_alloc() on mmap() failure.

    Thanks to Hugo Brunie for reporting the issue.

  + Fix the return value of command-line tools in some error cases.

  + Do not break individual thread bindings during x86 backend discovery in a

    multithreaded process. Thanks to Farouk Mansouri for the report.

  + Fix hwloc-bind --membind for CPU-less NUMA nodes.

  + Fix some corner cases in the XML export/import of application userdata.

* API Improvements

  + Add HWLOC_MEMBIND_BYNODESET flag so that membind() functions accept

    either cpusets or nodesets.

  + Add hwloc_get_area_memlocation() to check where pages are actually

    allocated. Only implemented on Linux for now.

    - There's no _nodeset() variant, but the new flag HWLOC_MEMBIND_BYNODESET

      is supported.

  + Make hwloc_obj_type_sscanf() parse back everything that may be outputted

    by hwloc_obj_type_snprintf().

* Detection Improvements

  + Allow the x86 backend to add missing cache levels, so that it completes

    what the Solaris backend lacks.

    Thanks to Ryan Zezeski for reporting the issue.

  + Do not filter-out FibreChannel PCI adapters by default anymore.

    Thanks to Matt Muggeridge for the report.

  + Add support for CUDA compute capability 6.x.

* Tools

  + Add --support to hwloc-info to list supported features, just like with

    hwloc_topology_get_support().

    - Also add --objects and --topology to explicitly switch between the

      default modes.

  + Add --tid to let hwloc-bind operate on individual threads on Linux.

  + Add --nodeset to let hwloc-bind report memory binding as NUMA node sets.

  + hwloc-annotate and lstopo don't drop application userdata from XMLs anymore.

    - Add --cu to hwloc-annotate to drop these application userdata.

  + Make the hwloc-dump-hwdata dump directory configurable through configure

    options such as --runstatedir or --localstatedir.

* Misc Improvements

  + Add systemd service template contrib/systemd/hwloc-dump-hwdata.service

    for launching hwloc-dump-hwdata at boot on Linux.

    Thanks to Grzegorz Andrejczuk.

  + Add HWLOC_PLUGINS_BLACKLIST environment variable to prevent some plugins

    from being loaded. Thanks to Alexandre Denis for the suggestion.

  + Small improvements for various Windows build systems,

    thanks to Jonathan L Peyton and Marco Atzeri.

Version 1.11.2

--------------

* Improve support for Intel Knights Landing Xeon Phi on Linux:

  + Group local NUMA nodes of normal memory (DDR) and high-bandwidth memory

    (MCDRAM) together through "Cluster" groups so that the local MCDRAM is

    easy to find.

    - See "How do I find the local MCDRAM NUMA node on Intel Knights

      Landing Xeon Phi?" in the documentation.

    - For uniformity across all KNL configurations, always have a NUMA node

      object even if the host is UMA.

  + Fix the detection of the memory-side cache:

    - Add the hwloc-dump-hwdata superuser utility to dump SMBIOS information

      into /var/run/hwloc/ as root during boot, and load this dumped

      information from the hwloc library at runtime.

    - See "Why do I need hwloc-dump-hwdata for caches on Intel Knights

      Landing Xeon Phi?" in the documentation.

  Thanks to Grzegorz Andrejczuk for the patches and for the help.

* The x86 and linux backends may now be combined for discovering CPUs

  through x86 CPUID and memory from the Linux kernel.

  This is useful for working around buggy CPU information reported by Linux

  (for instance the AMD Bulldozer/Piledriver bug below).

  Combination is enabled by passing HWLOC_COMPONENTS=x86 in the environment.

* Fix L3 cache sharing on AMD Opteron 63xx (Piledriver) and 62xx (Bulldozer)

  in the x86 backend. Thanks to many users who helped.

* Fix the overzealous L3 cache sharing fix added to the x86 backend in 1.11.1

  for AMD Opteron 61xx (Magny-Cours) processors.

* The x86 backend may now add the info attribute Inclusive=0 or 1 to caches

  it discovers, or to caches discovered by other backends earlier.

  Thanks to Guillaume Beauchamp for the patch.

* Fix the management on alloc_membind() allocation failures on AIX, HP-UX

  and OSF/Tru64.

* Fix spurious failures to load with ENOMEM on AIX in case of Misc objects

  below PUs.

* lstopo improvements in X11 and Windows graphical mode:

  + Add + - f 1 shortcuts to manually zoom-in, zoom-out, reset the scale,

    or fit the entire window.

  + Display all keyboard shortcuts in the console.

* Debug messages may be disabled at runtime by passing HWLOC_DEBUG_VERBOSE=0

  in the environment when --enable-debug was passed to configure.

* Add a FAQ entry "What are these Group objects in my topology?".

Version 1.11.1

--------------

* Detection fixes

  + Hardwire the topology of Fujitsu K-computer, FX10, FX100 servers to

    workaround buggy Linux kernels.

    Thanks to Takahiro Kawashima and Gilles Gouaillardet.

  + Fix L3 cache information on AMD Opteron 61xx Magny-Cours processors

    in the x86 backend. Thanks to Guillaume Beauchamp for the patch.

  + Detect block devices directly attached to PCI without a controller,

    for instance NVMe disks. Thanks to Barry M. Tannenbaum.

  + Add the PCISlot attribute to all PCI functions instead of only the

    first one.

* Miscellaneous internal fixes

  + Ignore PCI bridges that could fail assertions by reporting buggy

    secondary-subordinate bus numbers

    Thanks to George Bosilca for reporting the issue.

  + Fix an overzealous assertion when inserting an intermediate Group object

    while Groups are totally ignored.

  + Fix a memory leak on Linux on AMD processors with dual-core compute units.

    Thanks to Bob Benner.

  + Fix a memory leak on failure to load a xml diff file.

  + Fix some segfaults when inputting an invalid synthetic description.

  + Fix a segfault when plugins fail to find core symbols.

    Thanks to Guy Streeter.

* Many fixes and improvements in the Windows backend:

  + Fix the discovery of more than 32 processors and multiple processor

    groups. Thanks to Barry M. Tannenbaum for the help.

  + Add thread binding set support in case of multiple process groups.

  + Add thread binding get support.

  + Add get_last_cpu_location() support for the current thread.

  + Disable the unsupported process binding in case of multiple processor

    groups.

  + Fix/update the Visual Studio support under contrib/windows.

    Thanks to Eloi Gaudry for the help.

* Tools fixes

  + Fix a segfault when displaying logical indexes in the graphical lstopo.

    Thanks to Guillaume Mercier for reporting the issue.

  + Fix lstopo linking with X11 libraries, for instance on Mac OS X.

    Thanks to Scott Atchley and Pierre Ramet for reporting the issue.

  + hwloc-annotate, hwloc-diff and hwloc-patch do not drop unavailable

    resources from the output anymore and those may be annotated as well.

  + Command-line tools may now import XML from the standard input with -i -.xml

  + Add missing documentation for the hwloc-info --no-icaches option.

Version 1.11.0

--------------

* API

  + Socket objects are renamed into Package to align with the terminology

    used by processor vendors. The old HWLOC_OBJ_SOCKET type and "Socket"

    name are still supported for backward compatibility.

  + HWLOC_OBJ_NODE is replaced with HWLOC_OBJ_NUMANODE for clarification.

    HWLOC_OBJ_NODE is still supported for backward compatibility.

    "Node" and "NUMANode" strings are supported as in earlier releases.

* Detection improvements

  + Add support for Intel Knights Landing Xeon Phi.

    Thanks to Grzegorz Andrejczuk and Lukasz Anaczkowski.

  + Add Vendor, Model, Revision, SerialNumber, Type and LinuxDeviceID

    info attributes to Block OS devices on Linux. Thanks to Vineet Pedaballe

    for the help.

    - Add --disable-libudev to avoid dependency on the libudev library.

  + Add "MemoryModule" Misc objects with information about DIMMs, on Linux

    when privileged and when I/O is enabled.

    Thanks to Vineet Pedaballe for the help.

  + Add a PCISlot attribute to PCI devices on Linux when supported to

    identify the physical PCI slot where the board is plugged.

  + Add CPUStepping info attribute on x86 processors,

    thanks to Thomas Röhl for the suggestion.

  + Ignore the device-tree on non-Power architectures to avoid buggy

    detection on ARM. Thanks to Orion Poplawski for reporting the issue.

  + Work-around buggy Xeon E5v3 BIOS reporting invalid PCI-NUMA affinity

    for the PCI links on the second processor.

  + Add support for CUDA compute capability 5.x, thanks Benjamin Worpitz.

  + Many fixes to the x86 backend

    - Add L1i and fix L2/L3 type on old AMD processors without topoext support.

    - Fix Intel CPU family and model numbers when basic family isn't 6 or 15.

    - Fix package IDs on recent AMD processors.

    - Fix misc issues due to incomplete APIC IDs on x2APIC processors.

    - Avoid buggy discovery on old SGI Altix UVs with non-unique APIC IDs.

  + Gather total machine memory on NetBSD.

* Tools

  + lstopo

    - Collapse identical PCI devices unless --no-collapse is given.

      This avoids gigantic outputs when a PCI device contains dozens of

      identical virtual functions.

    - The ASCII art output is now called "ascii", for instance in

      "lstopo -.ascii".

      The former "txt" extension is retained for backward compatibility.

    - Automatically scales graphical box width to the inner text in Cairo,

      ASCII and Windows outputs.

    - Add --rect to lstopo to force rectangular layout even for NUMA nodes.

    - Add --restrict-flags to configure the behavior of --restrict.

    - Objects may have a "Type" info attribute to specify a better type name

      and display it in lstopo.

    - Really export all verbose information to the given output file.

  + hwloc-annotate

    - May now operate on all types of objects, including I/O.

    - May now insert Misc objects in the topology.

    - Do not drop instruction caches and I/O devices from the output anymore.

  + Fix lstopo path in hwloc-gather-topology after install.

* Misc

  + Fix hwloc/cudart.h for machines with multiple PCI domains,

    thanks to Imre Kerr for reporting the problem.

  + Fix PCI Bridge-specific depth attribute.

  + Fix hwloc_bitmap_intersect() for two infinite bitmaps.

  + Fix some corner cases in the building of levels on large NUMA machines

    with non-uniform NUMA groups and I/Os.

  + Improve the performance of object insertion by cpuset for large

    topologies.

  + Prefix verbose XML import errors with the source name.

  + Improve pkg-config checks and error messages.

  + Fix excluding after a component with an argument in the HWLOC_COMPONENTS

    environment variable.

* Documentation

  + Fix the recommended way in documentation and examples to allocate memory

    on some node, it should use HWLOC_MEMBIND_BIND.

    Thanks to Nicolas Bouzat for reporting the issue.

  + Add a "Miscellaneous objects" section in the documentation.

  + Add a FAQ entry "What happens to my topology if I disable symmetric

    multithreading, hyper-threading, etc. ?" to the documentation.

Version 1.10.1

--------------

* Actually remove disallowed NUMA nodes from nodesets when the whole-system

  flag isn't enabled.

* Fix the gathering of PCI domains. Thanks to James Custer for reporting

  the issue and providing a patch.

* Fix the merging of identical parent and child in presence of Misc objects.

  Thanks to Dave Love for reporting the issue.

* Fix some misordering of children when merging with ignore_keep_structure()

  in partially allowed topologies.

* Fix an overzealous assertion in the debug code when running on a single-PU

  host with I/O. Thanks to Thomas Van Doren for reporting the issue.

* Don't forget to setup NUMA node object nodesets in x86 backend (for BSDs)

  and OSF/Tru64 backend.

* Fix cpuid-x86 build error with gcc -O3 on x86-32. Thanks to Thomas Van Doren

  for reporting the issue.

* Fix support for future very large caches in the x86 backend.

* Fix vendor/device names for SR-IOV PCI devices on Linux.

* Fix an unlikely crash in case of buggy hierarchical distance matrix.

* Fix PU os_index on some AIX releases. Thanks to Hendryk Bockelmann and

  Erik Schnetter for helping debugging.

* Fix hwloc_bitmap_isincluded() in case of infinite sets.

* Change hwloc-ls.desktop into a lstopo.desktop and only install it if

  lstopo is built with Cairo/X11 support. It cannot work with a non-graphical

  lstopo or hwloc-ls.

* Add support for the renaming of Socket into Package in future releases.

* Add support for the replacement of HWLOC_OBJ_NODE with HWLOC_OBJ_NUMANODE

  in future releases.

* Clarify the documentation of distance matrices in hwloc.h and in the manpage

  of the hwloc-distances. Thanks to Dave Love for the suggestion.

* Improve some error messages by displaying more information about the

  hwloc library in use.

* Document how to deal with the ABI break when upgrading to the upcoming 2.0

  See "How do I handle ABI breaks and API upgrades ?" in the FAQ.

Version 1.10.0

--------------

* API

  + Add hwloc_topology_export_synthetic() to export a topology to a

    synthetic string without using lstopo. See the Synthetic topologies

    section in the documentation.

  + Add hwloc_topology_set/get_userdata() to let the application save

    a private pointer in the topology whenever it needs a way to find

    its own object corresponding to a topology.

  + Add hwloc_get_numanode_obj_by_os_index() and document that this function

    as well as hwloc_get_pu_obj_by_os_index() are good at converting

    nodesets and cpusets into objects.

  + hwloc_distrib() does not ignore any objects anymore when there are

    too many of them. They get merged with others instead.

    Thanks to Tim Creech for reporting the issue.

* Tools

  + hwloc-bind --get <command-line> now executes the command after displaying

    the binding instead of ignoring the command entirely.

    Thanks to John Donners for the suggestion.

  + Clarify that memory sizes shown in lstopo are local by default

    unless specified (total memory added in the root object).

* Synthetic topologies

  + Synthetic topology descriptions may now specify attributes such as

    memory sizes and OS indexes. See the Synthetic topologies section

    in the documentation.

  + lstopo now exports in this fully-detailed format by default.

    The new option --export-synthetic-flags may be used to revert

    back the old format.

* Documentation

  + Add the doc/examples/ subdirectory with several real-life examples,

    including the already existing hwloc-hello.C for basics.

    Thanks to Rob Aulwes for the suggestion.

  + Improve the documentation of CPU and memory binding in the API.

  + Add a FAQ entry about operating system errors, especially on AMD

    platforms with buggy cache information.

  + Add a FAQ entry about loading many topologies in a single program.

* Misc

  + Work around buggy Linux kernels reporting 2 sockets instead

    1 socket with 2 NUMA nodes for each Xeon E5 v3 (Haswell) processor.

  + pciutils/libpci support is now removed since libpciaccess works

    well and there's also a Linux-specific PCI backend. For the record,

    pciutils was GPL and therefore disabled by default since v1.6.2.

  + Add --disable-cpuid configure flag to work around buggy processor

    simulators reporting invalid CPUID information.

    Thanks for Andrew Friedley for reporting the issue.

  + Fix a racy use of libltdl when manipulating multiple topologies in

    different threads.

    Thanks to Andra Hugo for reporting the issue and testing patches.

  + Fix some build failures in private/misc.h.

    Thanks to Pavan Balaji and Ralph Castain for the reports.

  + Fix failures to detect X11/Xutil.h on some Solaris platforms.

    Thanks to Siegmar Gross for reporting the failure.

  + The plugin ABI has changed, this release will not load plugins

    built against previous hwloc releases.

Version 1.9.1

-------------

* Fix a crash when the PCI locality is invalid. Attach to the root object

  instead. Thanks to Nicolas Denoyelle for reporting the issue.

* Fix -f in lstopo manpage. Thanks to Jirka Hladky for reporting the issue.

* Fix hwloc_obj_type_sscanf() and others when strncasecmp() is not properly

  available. Thanks to Nick Papior Andersen for reporting the problem.

* Mark Linux file descriptors as close-on-exec to avoid leaks on exec.

* Fix some minor memory leaks.

Version 1.9.0

-------------

* API

  + Add hwloc_obj_type_sscanf() to extend hwloc_obj_type_of_string() with

    type-specific attributes such as Cache/Group depth and Cache type.

    hwloc_obj_type_of_string() is moved to hwloc/deprecated.h.

  + Add hwloc_linux_get_tid_last_cpu_location() for retrieving the

    last CPU where a Linux thread given by TID ran.

  + Add hwloc_distrib() to extend the old hwloc_distribute[v]() functions.

    hwloc_distribute[v]() is moved to hwloc/deprecated.h.

  + Don't mix total and local memory when displaying verbose object attributes

    with hwloc_obj_attr_snprintf() or in lstopo.

* Backends

  + Add CPUVendor, CPUModelNumber and CPUFamilyNumber info attributes for

    x86, ia64 and Xeon Phi sockets on Linux, to extend the x86-specific

    support added in v1.8.1. Requested by Ralph Castain.

  + Add many CPU- and Platform-related info attributes on ARM and POWER

    platforms, in the Machine and Socket objects.

  + Add CUDA info attributes describing the number of multiprocessors and

    cores and the size of the global, shared and L2 cache memories in CUDA

    OS devices.

  + Add OpenCL info attributes describing the number of compute units and

    the global memory size in OpenCL OS devices.

  + The synthetic backend now accepts extended types such as L2Cache, L1i or

    Group3. lstopo also exports synthetic strings using these extended types.

* Tools

  + lstopo

    - Do not overwrite output files by default anymore.

      Pass -f or --force to enforce it.

    - Display OpenCL, CUDA and Xeon Phi numbers of cores and memory sizes

      in the graphical output.

    - Fix export to stdout when specifying a Cairo-based output type

      with --of.

  + hwloc-ps

    - Add -e or --get-last-cpu-location to report where processes/threads

      run instead of where they are bound.

    - Report locations as likely-more-useful objects such as Cores or Sockets

      instead of Caches when possible.

  + hwloc-bind

    - Fix failure on Windows when not using --pid.

    - Add -e as a synonym to --get-last-cpu-location.

  + hwloc-distrib

    - Add --reverse to distribute using last objects first and singlify

      into last bits first. Thanks to Jirka Hladky for the suggestion.

  + hwloc-info

    - Report unified caches when looking for data or instruction cache

      ancestor objects.

* Misc

  + Add experimental Visual Studio support under contrib/windows.

    Thanks to Eloi Gaudry for his help and for providing the first draft.

  + Fix some overzealous assertions and warnings about the ordering of

    objects on a level with respect to cpusets. The ordering is only

    guaranteed for complete cpusets (based on the first bit in sets).

  + Fix some memory leaks when importing xml diffs and when exporting a

    "too complex" entry.

Version 1.8.1

-------------

* Fix the cpuid code on Windows 64bits so that the x86 backend gets

  enabled as expected and can populate CPU information.

  Thanks to Robin Scher for reporting the problem.

* Add CPUVendor/CPUModelNumber/CPUFamilyNumber attributes when running

  on x86 architecture. Thanks to Ralph Castain for the suggestion.

* Work around buggy BIOS reporting duplicate NUMA nodes on Linux.

  Thanks to Jeff Becker for reporting the problem and testing the patch.

* Add a name to the lstopo graphical window. Thanks to Michael Prokop

  for reporting the issue.

Version 1.8.0

-------------

* New components

  + Add the "linuxpci" component that always works on Linux even when

    libpciaccess and libpci aren't available (and even with a modified

    file-system root). By default the old "pci" component runs first

    because "linuxpci" lacks device names (obj->name is always NULL).

* API

  + Add the topology difference API in hwloc/diff.h for manipulating

    many similar topologies.

  + Add hwloc_topology_dup() for duplicating an entire topology.

  + hwloc.h and hwloc/helper.h have been reorganized to clarify the

    documentation sections. The actual inline code has moved out of hwloc.h

    into the new hwloc/inlines.h.

  + Deprecated functions are now in hwloc/deprecated.h, and not in the

    official documentation anymore.

* Tools

  + Add hwloc-diff and hwloc-patch tools together with the new diff API.

  + Add hwloc-compress-dir to (de)compress an entire directory of XML files

    using hwloc-diff and hwloc-patch.

  + Object colors in the graphical output of lstopo may be changed by adding

    a "lstopoStyle" info attribute. See CUSTOM COLORS in the lstopo(1) manpage

    for details. Thanks to Jirka Hladky for discussing the idea.

  + hwloc-gather-topology may now gather I/O-related files on Linux when

    --io is given. Only the linuxpci component supports discovering I/O

    objects from these extended tarballs.

  + hwloc-annotate now supports --ri to remove/replace info attributes with

    a given name.

  + hwloc-info supports "root" and "all" special locations for dumping

    information about the root object.

  + lstopo now supports --append-legend to append custom lines of text

    to the legend in the graphical output. Thanks to Jirka Hladky for

    discussing the idea.

  + hwloc-calc and friends have a more robust parsing of locations given

    on the command-line and they report useful error messages about it.

  + Add --whole-system to hwloc-bind, hwloc-calc, hwloc-distances and

    hwloc-distrib, and add --restrict to hwloc-bind for uniformity among

    tools.

* Misc

  + Calling hwloc_topology_load() or hwloc_topology_set_*() on an already

    loaded topology now returns an error (deprecated since release 1.6.1).

  + Fix the initialisation of cpusets and nodesets in Group objects added

    when inserting PCI hostbridges.

  + Never merge Group objects that were added explicitly by the user with

    hwloc_custom_insert_group_object_by_parent().

  + Add a sanity check during dynamic plugin loading to prevent some

    crashes when hwloc is dynamically loaded by another plugin mechanisms.

  + Add --with-hwloc-plugins-path to specify the install/load directories

    of plugins.

  + Add the MICSerialNumber info attribute to the root object when running

    hwloc inside a Xeon Phi to match the same attribute in the MIC OS device

    when running in the host.

Version 1.7.2

-------------

* Do not create invalid block OS devices on very old Linux kernel such

  as RHEL4 2.6.9.

* Fix PCI subvendor/device IDs.

* Fix the management of Misc objects inserted by parent.

  Thanks to Jirka Hladky for reporting the problem.

* Add a Port<n>State into attribute to OpenFabrics OS devices.

* Add a MICSerialNumber info attribute to Xeon PHI/MIC OS devices.

* Improve verbose error messages when failing to load from XML.

Version 1.7.1

-------------

* Fix a failed assertion in the distance grouping code when loading a XML

  file that already contains some groups.

  Thanks to Laercio Lima Pilla for reporting the problem.

* Remove unexpected Group objects when loading XML topologies with I/O

  objects and NUMA distances.

  Thanks to Elena Elkina for reporting the problem and testing patches.

* Fix PCI link speed discovery when using libpciaccess.

* Fix invalid libpciaccess virtual function device/vendor IDs when using

  SR-IOV PCI devices on Linux.

* Fix GL component build with old NVCtrl releases.

  Thanks to Jirka Hladky for reporting the problem.

* Fix embedding breakage caused by libltdl.

  Thanks to Pavan Balaji for reporting the problem.

* Always use the system-wide libltdl instead of shipping one inside hwloc.

* Document issues when enabling plugins while embedding hwloc in another

  project, in the documentation section Embedding hwloc in Other Software.

* Add a FAQ entry "How to get useful topology information on NetBSD?"

  in the documentation.

* Somes fixes in the renaming code for embedding.

* Miscellaneous minor build fixes.

Version 1.7.0

-------------

* New operating system backends

  + Add BlueGene/Q compute node kernel (CNK) support. See the FAQ in the

    documentation for details. Thanks to Jeff Hammond, Christopher Samuel

    and Erik Schnetter for their help.

  + Add NetBSD support, thanks to Aleksej Saushev.

* New I/O device discovery

  + Add co-processor OS devices such as "mic0" for Intel Xeon Phi (MIC)

    on Linux. Thanks to Jerome Vienne for helping.

  + Add co-processor OS devices such as "cuda0" for NVIDIA CUDA-capable GPUs.

  + Add co-processor OS devices such as "opencl0d0" for OpenCL GPU devices

    on the AMD OpenCL implementation.

  + Add GPU OS devices such as ":0.0" for NVIDIA X11 displays.

  + Add GPU OS devices such as "nvml0" for NVIDIA GPUs.

    Thanks to Marwan Abdellah and Stefan Eilemann for helping.

  These new OS devices have some string info attributes such as CoProcType,

  GPUModel, etc. to better identify them.

  See the I/O Devices and Attributes documentation sections for details.

* New components

  + Add the "opencl", "cuda", "nvml" and "gl" components for I/O device

    discovery.

  + "nvml" also improves the discovery of NVIDIA GPU PCIe link speed.

  All of these new components may be built as plugins. They may also be

  disabled entirely by passing --disable-opencl/cuda/nvml/gl to configure.

  See the I/O Devices, Components and Plugins, and FAQ documentation

  sections for details.

* API

  + Add hwloc_topology_get_flags().

  + Add hwloc/plugins.h for building external plugins.

    See the Adding new discovery components and plugins section.

* Interoperability

  + Add hwloc/opencl.h, hwloc/nvml.h, hwloc/gl.h and hwloc/intel-mic.h

    to retrieve the locality of OS devices that correspond to AMD OpenCL

    GPU devices or indexes, to NVML devices or indexes, to NVIDIA X11

    displays, or to Intel Xeon Phi (MIC) device indexes.

  + Add new helpers in hwloc/cuda.h and hwloc/cudart.h to convert

    between CUDA devices or indexes and hwloc OS devices.

  + Add hwloc_ibv_get_device_osdev() and clarify the requirements

    of the OpenFabrics Verbs helpers in hwloc/openfabrics-verbs.h.

* Tools

  + hwloc-info is not only a synonym of lstopo -s anymore, it also

    dumps information about objects given on the command-line.

* Documentation

  + Add a section "Existing components and plugins".

  + Add a list of common OS devices in section "Software devices".

  + Add a new FAQ entry "Why is lstopo slow?" about lstopo slowness

    issues because of GPUs.

  + Clarify the documentation of inline helpers in hwloc/myriexpress.h

    and hwloc/openfabrics-verbs.h.

* Misc

  + Improve cache detection on AIX.

  + The HWLOC_COMPONENTS variable now excludes the components whose

    names are prefixed with '-'.

  + lstopo --ignore PU now works when displaying the topology in

    graphical and textual mode (not when exporting to XML).

  + Make sure I/O options always appear in lstopo usage, not only when

    using pciutils/libpci.

  + Remove some unneeded Linux specific includes from some interoperability

    headers.

  + Fix some inconsistencies in hwloc-distrib and hwloc-assembler-remote

    manpages. Thanks to Guy Streeter for the report.

  + Fix a memory leak on AIX when getting memory binding.

  + Fix many small memory leaks on Linux.

  + The `libpci' component is now called `pci' but the old name is still

    accepted in the HWLOC_COMPONENTS variable for backward compatibility.

Version 1.6.2

-------------

* Use libpciaccess instead of pciutils/libpci by default for I/O discovery.

  pciutils/libpci is only used if --enable-libpci is given to configure

  because its GPL license may taint hwloc. See the Installation section

  in the documentation for details.

* Fix get_cpubind on Solaris when bound to a single PU with

  processor_bind(). Thanks to Eugene Loh for reporting the problem

  and providing a patch.

Version 1.6.1

-------------

* Fix some crash or buggy detection in the x86 backend when Linux

  cgroups/cpusets restrict the available CPUs.

* Fix the pkg-config output with --libs --static.

  Thanks to Erik Schnetter for reporting one of the problems.

* Fix the output of hwloc-calc -H --hierarchical when using logical

  indexes in the output.

* Calling hwloc_topology_load() multiple times on the same topology

  is officially deprecated. hwloc will warn in such cases.

* Add some documentation about existing plugins/components, package

  dependencies, and I/O devices specification on the command-line.

Version 1.6.0

-------------

* Major changes

  + Reorganize the backend infrastructure to support dynamic selection

    of components and dynamic loading of plugins. For details, see the