Visualize Your Hardware Topology Using hwloc
Tags: aws, archlinux, architecture, performance
Published: 2021-07-28 06:40:53

With multiple cores, shared caches, and NUMA architectures, modern computer platforms are becoming more sophisticated. Improving the efficiency of high-performance computing applications necessitates knowledge of both the application and the platform on which it operates, which can be challenging.

The sharing of many layers of caches among cores has resulted in a hierarchical hardware topology. The hierarchical structure of today's processors is further stressed by Non-Uniform Memory Access (NUMA) technology. The rising complexity and parallelism among computing nodes creates the conundrum of how to plan work in order to limit the impact of this complexity while yet enhancing efficiency. Two closely cooperating tasks, for example, should be clustered on cores with a shared cache. Two independent memory-intensive processes should be split across several sockets to improve memory throughput. But how do you make this selection if you don't have the visibility into the hardware topology?

It is vital to understand and have visibility into the hardware locality in order to successfully employ modern hardware for the aforementioned scenarios. Hardware Locality (hwloc) and Network Locality (netloc) are two programs that can assist you.

These two programs are hosted by the Open MPI Team. The Open MPI project has many members, contributors, and partners. Some of the [contributors](https://www.open-mpi.org/about/members/) to Open MPI project are Amazon, ARM, AMD and Facebook.

### So what is Hardware Locality (hwloc)?

From Open MPI website[1], "hwloc software package provides a portable abstraction of the hierarchical structure of modern architectures, including NUMA memory nodes, sockets, shared caches, cores, and simultaneous multithreading (across OS, versions, architectures, etc.). It also collects information about cache and memory, as well as the location of I/O devices such as network interfaces, InfiniBand HCAs, and GPUs."

hwloc is intended to help high-performance computing (HPC) applications at a high level, but it may also be used by any project that needs to leverage code and/or data locality on modern computing platforms to use them wisely and efficiently. It is quite useful as an engineer to be able to visualize and better understand the hardware topology.

netloc and hwloc are both included in hwloc releases beginning with hwloc 2.0. netloc is still in its early stages of development, but it now supports InfiniBand and OpenFlow-managed Ethernet networks. netloc is now available for Linux and Mac OS.

Here are some of the examples of hardware topology information you can gather using hwloc.

### Notebook

Below is the output of executing hwloc. hwloc was able to visualize & present the hardware of my notebook.
![Alt Text](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/u2gxq00oi4jfbwnpc4po.PNG)

The information from Windows Task Manager and the hwloc representation are compared below. It's worth mentioning that the L1 cache per core isn't visible in Task Manager, but the total L1 cache size is. You'd want to know that if you're working on a high-performance computing application.
![Alt Text](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/xq17gq6xykosa2jqdm6i.PNG)

### AWS EC2 R5.16xLarge Window Instance

Another EC2 instance, this time with R5.16xLarge. In this instance, we have a multi-node NUMA configuration. Also notice how the L3 cache is shared across all cores in same NumaNode, yet the L2 cache is per core. Also different cache sizes information is captured with hwloc.
![Alt Text](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/srb779th4tnli21kej85.png)

### 2x Xeon Sandy-Bridge-EP E5-2680 + 1x Xeon Phi + 1x InfiniBand HCA
![Alt Text](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/mvqzd1y2erqi5529502z.png)

For more such examples as to what hwloc can provide, visit the lstopo [link](https://www-lb.open-mpi.org/projects/hwloc/lstopo/).

If you work as a high-performance computing engineer, it is good to spend some time learning about the hwloc tool and how to utilize it to tackle some of the issues you may face when exploiting hardware.

**References:**
1. https://www-lb.open-mpi.org/projects/hwloc/
2. https://www-lb.open-mpi.org/projects/hwloc/tutorials/20160606-PATC-hwloc-tutorial.pdf
3. https://hal.inria.fr/inria-00496295/document
4. https://icl.cs.utk.edu/open-mpi/projects/hwloc/doc/hwloc-v2.0.0-letter.pdf

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

Thanks for reading!

If you enjoyed this article feel free to share on social media 🙂


Say Hello on: [Linkedin](https://www.linkedin.com/in/harinderseera/) | [Twitter](https://twitter.com/harinderseera) | [Polywork](https://www.polywork.com/harinderseera) 

Blogging: [Dev](https://dev.to/harinderseera) | [Hashnode](https://harinderseera.hashnode.dev/)

Github: [hseera](https://github.com/hseera)