Merge pull request #432 from kswiecicki/hwloc-fix

Add requirement for HWLOC version

Author: lukaszstolarczuk

.github/scripts/install_hwloc.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+# Copyright (C) 2024 Intel Corporation
+# Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# install_hwloc.sh - Script for building and installing HWLOC library from source code
+
+set -e
+
+git clone -b hwloc-2.3.0 https://github.com/open-mpi/hwloc.git
+pushd hwloc
+./autogen.sh
+./configure
+make -j$(nproc)
+sudo make install -j$(nproc)
+popd

.github/workflows/basic.yml

@@ -127,12 +127,15 @@ jobs:
     - name: Install apt packages
       run: |
         sudo apt-get update
-        sudo apt-get install -y clang cmake libhwloc-dev libnuma-dev libjemalloc-dev libtbb-dev
+        sudo apt-get install -y clang cmake libnuma-dev libjemalloc-dev libtbb-dev
 
     - name: Install g++-7
       if: matrix.compiler.cxx == 'g++-7'
       run: sudo apt-get install -y ${{matrix.compiler.cxx}}
 
+    - name: Install libhwloc
+      run: .github/scripts/install_hwloc.sh
+
     - name: Configure build
       run: >
         cmake

.github/workflows/qemu.yml

@@ -123,4 +123,5 @@ jobs:
         fi
 
         scp -P 2222 ${{github.workspace}}/scripts/qemu/run-build.sh [email protected]:/home/cxltest
+        scp -P 2222 ${{github.workspace}}/.github/scripts/install_hwloc.sh [email protected]:/home/cxltest
         ssh [email protected] -p 2222 -t "bash /home/cxltest/run-build.sh https://github.com/$CI_REPO ${{env.CI_BRANCH}}"

CMakeLists.txt

@@ -170,9 +170,9 @@ if(WINDOWS)
     )
 endif()
 
-pkg_check_modules(LIBHWLOC hwloc)
+pkg_check_modules(LIBHWLOC hwloc>=2.3.0)
 if(NOT LIBHWLOC_FOUND)
-    find_package(LIBHWLOC REQUIRED hwloc)
+    find_package(LIBHWLOC 2.3.0 REQUIRED hwloc)
 endif()
 # add PATH to DLL on Windows
 set(DLL_PATH_LIST

README.md

@@ -30,7 +30,7 @@ using the Level Zero API and UMF Level Zero memory provider.
 ### Requirements
 
 Required packages:
-- libhwloc-dev (Linux) / hwloc (Windows)
+- libhwloc-dev >= 2.3.0 (Linux) / hwloc >= 2.3.0 (Windows)
 - C compiler
 - [CMake](https://cmake.org/) >= 3.14.0
 

cmake/FindLIBHWLOC.cmake

@@ -14,6 +14,29 @@ find_file(LIBHWLOC_HEADER NAMES hwloc.h)
 get_filename_component(LIBHWLOC_INCLUDE_DIR ${LIBHWLOC_HEADER} DIRECTORY)
 set(LIBHWLOC_INCLUDE_DIRS ${LIBHWLOC_INCLUDE_DIR})
 
+if(LIBHWLOC_INCLUDE_DIR)
+    if(EXISTS "${LIBHWLOC_INCLUDE_DIR}/hwloc/autogen/config.h")
+        file(
+            STRINGS "${LIBHWLOC_INCLUDE_DIR}/hwloc/autogen/config.h"
+            LIBHWLOC_VERSION
+            REGEX
+                "#define[ \t]HWLOC_VERSION[ \t]\"([0-9]+.[0-9]+.[0-9]+(rc[0-9])?)(-git)?\""
+        )
+        string(
+            REGEX
+            REPLACE
+                "#define[ \t]HWLOC_VERSION[ \t]\"([0-9]+.[0-9]+.[0-9]+(rc[0-9])?)(-git)?\""
+                "\\1"
+                LIBHWLOC_VERSION
+                "${LIBHWLOC_VERSION}")
+    else()
+        message(
+            WARNING
+                "LIBHWLOC_INCLUDE_DIR found, but header with version info is missing"
+        )
+    endif()
+endif()
+
 if(WINDOWS)
     find_file(LIBHWLOC_DLL NAMES "bin/hwloc-15.dll" "bin/libhwloc-15.dll")
     get_filename_component(LIBHWLOC_DLL_DIR ${LIBHWLOC_DLL} DIRECTORY)
@@ -25,9 +48,21 @@ if(LIBHWLOC_LIBRARY)
     message(STATUS "    LIBHWLOC_LIBRARIES = ${LIBHWLOC_LIBRARIES}")
     message(STATUS "    LIBHWLOC_INCLUDE_DIRS = ${LIBHWLOC_INCLUDE_DIRS}")
     message(STATUS "    LIBHWLOC_LIBRARY_DIRS = ${LIBHWLOC_LIBRARY_DIRS}")
+    message(STATUS "    LIBHWLOC_VERSION = ${LIBHWLOC_VERSION}")
     if(WINDOWS)
         message(STATUS "    LIBHWLOC_DLL_DIRS = ${LIBHWLOC_DLL_DIRS}")
     endif()
+
+    if(LIBHWLOC_FIND_VERSION)
+        if(NOT LIBHWLOC_VERSION)
+            message(FATAL_ERROR "Failed to retrieve libhwloc version")
+        elseif(NOT LIBHWLOC_VERSION VERSION_GREATER_EQUAL LIBHWLOC_FIND_VERSION)
+            message(
+                FATAL_ERROR
+                    "    Required version: ${LIBHWLOC_FIND_VERSION}, found ${LIBHWLOC_VERSION}"
+            )
+        endif()
+    endif()
 else()
     set(MSG_NOT_FOUND
         "libhwloc NOT found (set CMAKE_PREFIX_PATH to point the location)")

scripts/qemu/run-build.sh

@@ -10,7 +10,11 @@ repo=$1
 branch=$2
 
 echo password | sudo -Sk apt update
-echo password | sudo -Sk apt install -y git cmake gcc g++ numactl libnuma-dev libjemalloc-dev libtbb-dev libhwloc-dev
+echo password | sudo -Sk apt install -y git cmake gcc g++ numactl libnuma-dev libjemalloc-dev libtbb-dev
+
+# install packages required for building hwloc from source
+echo password | sudo -Sk apt install -y autoconf libtool
+source install_hwloc.sh
 
 numactl -H