WIP: Alternative ISA dispatching

.github/scripts/get_cpu_info.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+# Copyright 2025 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Script to get CPU information using platform-agnostic python packages
+
+# Install python packages if not present in the environment
+if ! python -m pip show archspec > /dev/null 2>&1; then
+    python -m pip install archspec
+fi
+
+if ! python -m pip show py-cpuinfo > /dev/null 2>&1; then
+    python -m pip install py-cpuinfo
+fi
+
+# Print host microarchitecture
+python -c "import archspec.cpu; \
+    print('Host Microarchitecture[archspec]:', archspec.cpu.host().name)"
+
+# Print full CPU information
+python -c "import pprint, cpuinfo; \
+    print('CPU info[py-cpuinfo]:'); \
+    pprint.pprint(cpuinfo.get_cpu_info(), indent=4, compact=True)"

.github/scripts/install_sde.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+# Copyright 2025 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+wget --content-disposition "https://downloadmirror.intel.com/850782/sde-external-9.53.0-2025-03-16-lin.tar.xz"
+tar -xf sde-external-*-lin.tar.xz
+cd sde-external-*/
+echo "$PWD" >> $GITHUB_PATH

.github/workflows/build-linux-arm.yml

@@ -47,6 +47,10 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
+    - name: Get CPU info
+      run: |
+        bash ${GITHUB_WORKSPACE}/.github/scripts/get_cpu_info.sh
+
     - name: Configure build
       working-directory: ${{ runner.temp }}
       env:
@@ -70,3 +74,17 @@ jobs:
           CTEST_OUTPUT_ON_FAILURE: 1
       working-directory: ${{ runner.temp }}/build/tests
       run: ctest -C ${{ matrix.build_type }}
+
+    - name: Build Python Bindings
+      env:
+        CXX: ${{ matrix.cxx }}
+        CC: ${{ matrix.cc }}
+      run: |
+        cd bindings/python
+        python -m pip install .
+
+    - name: Run Python Microarch Test
+      run: |
+        cd bindings/python
+        python -c "import svs; svs.microarch.describe()"
+        python -m unittest discover -p "test_microarch.py" -s .

.github/workflows/build-linux.yml

@@ -56,6 +56,12 @@ jobs:
        source /opt/intel/oneapi/setvars.sh
        printenv >> $GITHUB_ENV
 
+    - name: Install Intel(R) SDE
+      run: source ${GITHUB_WORKSPACE}/.github/scripts/install_sde.sh
+
+    - name: Get CPU info
+      run: bash ${GITHUB_WORKSPACE}/.github/scripts/get_cpu_info.sh
+
     - name: Configure build
       working-directory: ${{ runner.temp }}
       env:
@@ -86,3 +92,21 @@ jobs:
           CTEST_OUTPUT_ON_FAILURE: 1
       working-directory: ${{ runner.temp }}/build/examples/cpp
       run: ctest -C RelWithDebugInfo
+
+    - name: Build Python Bindings
+      env:
+        CXX: ${{ matrix.cxx }}
+        CC: ${{ matrix.cc }}
+      run: |
+        cd bindings/python
+        python -m pip install .
+
+    - name: Run Python Microarch Test with SDE
+      run: |
+        cd bindings/python
+        for flag in nhm hsw skx clx icl; do
+          echo "SDE emulation: $flag"
+          export SDE_FLAG=$flag
+          sde64 -$flag -- python -c "import svs; svs.microarch.describe()"
+          sde64 -$flag -- python -m unittest discover -p "test_microarch.py" -s .
+        done

.github/workflows/build-macos.yaml

@@ -46,6 +46,10 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
+    - name: Get CPU info
+      run: |
+        bash ${GITHUB_WORKSPACE}/.github/scripts/get_cpu_info.sh
+
     - name: Install Compiler
       run: |
         echo "Installing ${{ matrix.package }}..."
@@ -83,3 +87,28 @@ jobs:
           CTEST_OUTPUT_ON_FAILURE: 1
       working-directory: ${{ runner.temp }}/build/tests
       run: ctest -C ${{ matrix.build_type }}
+
+    - name: Build Python Bindings
+      env:
+        CXX: ${{ matrix.cxx }}
+        CC: ${{ matrix.cc }}
+      run: |
+        if [[ "${{ matrix.needs_prefix }}" == "true" ]]; then
+          # For non-default packages like llvm@15, get the install prefix
+          COMPILER_PREFIX=$(brew --prefix ${{ matrix.package }})
+          export CC="${COMPILER_PREFIX}/bin/${{ matrix.cc_name }}"
+          export CXX="${COMPILER_PREFIX}/bin/${{ matrix.cxx_name }}"
+        else
+          # For versioned GCC installs, the name is usually directly available
+          export CC="${{ matrix.cc_name }}"
+          export CXX="${{ matrix.cxx_name }}"
+        fi
+
+        cd bindings/python
+        python -m pip install .
+
+    - name: Run Python Microarch Test
+      run: |
+        cd bindings/python
+        python -c "import svs; svs.microarch.describe()"
+        python -m unittest discover -p "test_microarch.py" -s .

.github/workflows/cibuildwheel.yml

@@ -43,6 +43,10 @@ jobs:
     - name: Install cibuildwheel
       run: python -m pip install cibuildwheel
 
+    - name: Get CPU info
+      run: |
+        bash ${GITHUB_WORKSPACE}/.github/scripts/get_cpu_info.sh
+
     # Install inside the temporary working directory.
     - name: Build Wheel
       env:

.licenserc.yaml

@@ -45,6 +45,9 @@ header:
     - 'THIRD-PARTY-PROGRAMS'
     - '.github/renovate.json'
     - 'cmake/mkl_functions'
+    - 'cmake/microarch_targets_aarch64'
+    - 'cmake/microarch_targets_aarch64_darwin'
+    - 'cmake/microarch_targets_x86_64' 
     - 'cmake/patches/tomlplusplus_v330.patch'
     - 'docker/x86_64/manylinux2014/oneAPI.repo'
     - 'docs/cpp/index/loader-compatibility.csv'

CMakeLists.txt

@@ -67,6 +67,7 @@ target_compile_options(
 
 include("cmake/options.cmake")
 
+include("cmake/microarch.cmake")
 include("cmake/clang-tidy.cmake")
 include("cmake/eve.cmake")
 include("cmake/pthread.cmake")
@@ -80,6 +81,8 @@ include("cmake/toml.cmake")
 ##### Build Objects
 #####
 
+create_microarch_instantiations()
+
 if(SVS_BUILD_BINARIES)
     add_subdirectory(utils)
 endif()
@@ -105,7 +108,7 @@ endif()
 ##### Install Logic
 #####
 
-include(GNUInstallDirs)
+include(GNUInstallDirs) 
 
 # Location of auxiliary generated cmake files to help consumers of this package.
 set(LIB_CONFIG_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/svs")

benchmark/CMakeLists.txt

@@ -48,7 +48,7 @@ set(SHARED_LIBRARY_FILES
     src/inverted/memory/executables/memory_test.cpp
 )
 
-add_library(svs_benchmark_library SHARED ${SHARED_LIBRARY_FILES})
+add_library(svs_benchmark_library SHARED ${SHARED_LIBRARY_FILES} ${MICROARCH_OBJECT_FILES})
 target_include_directories(svs_benchmark_library PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include)
 
 # Minimal
@@ -104,7 +104,7 @@ target_link_libraries(
     PUBLIC
         ${SVS_LIB}
         svs_compile_options
-        svs_native_options
+        ${MICROARCH_OBJECT_FILES}
         fmt::fmt
 )
 

bindings/python/CMakeLists.txt

@@ -24,68 +24,9 @@ FetchContent_Declare(
 )
 FetchContent_MakeAvailable(pybind11)
 
-# Try to find the Python executable.
-#
-# If it's given as part of the Cmake arguments given by "scikit build", then use that.
-# Otherwise, fall back to using plain old "python".
-# If *THAT* doesn't work, give up.
-if(DEFINED PYTHON_EXECUTABLE)
-    set(SVS_PYTHON_EXECUTABLE "${PYTHON_EXECUTABLE}")
-else()
-    set(SVS_PYTHON_EXECUTABLE "python")
-endif()
-
-# The micro architectures to compile for.
-if(NOT DEFINED SVS_MICROARCHS)
-    set(SVS_MICROARCHS native)
-endif()
-
 # Include the SVS library directly.
 add_subdirectory("../.." "${CMAKE_CURRENT_BINARY_DIR}/svs")
 
-# Run the python script to get optimization flags for the desired back-ends.
-#
-# FLAGS_SCRIPT - Path to the Python script that will take the compiler, compiler version,
-#   and list of desired microarchitectures and generate optimization flags for each
-#   microarchitecture.
-#
-# FLAGS_TEXT_FILE - List of optimization flags for each architecture.
-#   Expected format:
-#       -march=arch1,-mtune=arch1
-#       -march=arch2,-mtune=arch2
-#       ...
-#       -march=archN,-mtune=archN
-#
-#   The number of lines should be equal to the number of microarchitectures.
-#   NOTE: The entries within each line are separated by a comma on purpose to allow CMake
-#   to read the whole file as a List and then use string replacement on the commas to turn
-#   each line into a list in its own right.
-#
-# TEMP_JSON - JSON Manifest file describing the generated binaries. This is meant to be
-#   included in the Python package to allow the Python code to reason about the packaged
-#   libraries and select the correct one for loading.
-#
-set(FLAGS_SCRIPT "${CMAKE_CURRENT_LIST_DIR}/microarch.py")
-set(FLAGS_TEXT_FILE "${CMAKE_CURRENT_BINARY_DIR}/optimization_flags.txt")
-set(FLAGS_MANIFEST_JSON "${CMAKE_CURRENT_BINARY_DIR}/flags_manifest.json")
-
-execute_process(
-    COMMAND
-        ${SVS_PYTHON_EXECUTABLE}
-        ${FLAGS_SCRIPT}
-        ${FLAGS_TEXT_FILE}
-        ${FLAGS_MANIFEST_JSON}
-        --compiler ${CMAKE_CXX_COMPILER_ID}
-        --compiler-version ${CMAKE_CXX_COMPILER_VERSION}
-        --microarchitectures ${SVS_MICROARCHS}
-    COMMAND_ERROR_IS_FATAL ANY
-)
-
-file(STRINGS "${FLAGS_TEXT_FILE}" OPTIMIZATION_FLAGS)
-message("Flags: ${OPTIMIZATION_FLAGS}")
-list(LENGTH OPTIMIZATION_FLAGS OPT_FLAGS_LENGTH)
-message("Length of flags: ${OPT_FLAGS_LENGTH}")
-
 # C++ files makind up the python bindings.
 set(CPP_FILES
     src/allocator.cpp
@@ -98,51 +39,33 @@ set(CPP_FILES
     src/svs_mkl.cpp
 )
 
-# Generate a shared library for each target microarchitecture.
-foreach(MICRO OPT_FLAGS IN ZIP_LISTS SVS_MICROARCHS OPTIMIZATION_FLAGS)
-    set(LIB_NAME "_svs_${MICRO}")
+set(LIB_NAME "_svs")
+pybind11_add_module(${LIB_NAME} MODULE ${CPP_FILES} ${MICROARCH_OBJECT_FILES})
+target_link_libraries(${LIB_NAME} PRIVATE pybind11::module)
+target_link_libraries(${LIB_NAME} PUBLIC svs::svs)
+# Dependency "fmt::fmt" obtained from "svs"
+target_link_libraries(${LIB_NAME} PRIVATE svs::compile_options fmt::fmt svs::microarch_options_base)
+target_include_directories(
+    ${LIB_NAME}
+    PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>
+)
 
-    pybind11_add_module(${LIB_NAME} MODULE ${CPP_FILES})
-    target_link_libraries(${LIB_NAME} PUBLIC svs::svs)
-    # Dependency "fmt::fmt" obtained from "svs"
-    target_link_libraries(${LIB_NAME} PRIVATE svs::compile_options fmt::fmt)
+if(DEFINED SKBUILD)
+    install(TARGETS ${LIB_NAME} DESTINATION .)
 
-    string(REPLACE "," ";" OPT_FLAGS ${OPT_FLAGS})
-    message("OPT Flags: ${OPT_FLAGS}")
-    target_compile_options(${LIB_NAME} PRIVATE ${OPT_FLAGS})
+    # The extension module may need to load build or included libraries when loaded.
 
-    # Header files.
-    target_include_directories(
+    # Placing build depedencies in the package and using relative RPATHs that
+    # don't point outside of the package means that the built package is
+    # relocatable. This allows for safe binary redistribution.
+    set_target_properties(
         ${LIB_NAME}
-        PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>
+        PROPERTIES
+            INSTALL_RPATH "$ORIGIN/${CMAKE_INSTALL_LIBDIR}"
     )
-
-    # Comunicate to the C++ library the desired name of the library
-    target_compile_options(${LIB_NAME} PRIVATE "-DSVS_MODULE_NAME=${LIB_NAME}")
-
-    # If scikit build is running the compilation process,
-    if(DEFINED SKBUILD)
-        install(TARGETS ${LIB_NAME} DESTINATION .)
-
-        # The extension module may need to load build or included libraries when loaded.
-
-        # Placing build depedencies in the package and using relative RPATHs that
-        # don't point outside of the package means that the built package is
-        # relocatable. This allows for safe binary redistribution.
-        set_target_properties(
-            ${LIB_NAME}
-            PROPERTIES
-                INSTALL_RPATH "$ORIGIN/${CMAKE_INSTALL_LIBDIR}"
-        )
-    endif()
-endforeach()
+endif()
 
 if(DEFINED SKBUILD)
-    # Install the manifest JSON file.
-    # This is kind of a hack to avoid the needing to explicitly move JSON file into the
-    # source folder of the python library.
-    install(FILES ${FLAGS_MANIFEST_JSON} DESTINATION .)
-
     # Install header files.
     install(
         DIRECTORY "${CMAKE_CURRENT_LIST_DIR}/include/svs"