CPUArch dispatching and unified shared library

.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:
@@ -65,8 +69,26 @@ jobs:
       working-directory: ${{ runner.temp }}/build
       run: make -j$(nproc)
 
+    - name: Validate MicroArch symbols
+      working-directory: ${{ runner.temp }}/build
+      run: python ${GITHUB_WORKSPACE}/tools/validate_microarch_symbols.py .
+
     - name: Run tests
       env:
           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:
@@ -75,6 +81,10 @@ jobs:
       working-directory: ${{ runner.temp }}/build
       run: make -j$(nproc)
 
+    - name: Validate MicroArch symbols
+      working-directory: ${{ runner.temp }}/build
+      run: python ${GITHUB_WORKSPACE}/tools/validate_microarch_symbols.py .
+
     - name: Run tests
       env:
           CTEST_OUTPUT_ON_FAILURE: 1
@@ -86,3 +96,22 @@ 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 .
+          sde64 -$flag -- python -m unittest discover -p "example*.py" -s ${GITHUB_WORKSPACE}/examples/python
+        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:

.gitignore

@@ -20,3 +20,6 @@ __pycache__/
 
 # Example generated files.
 example_data_*/
+
+# Auto-generated microarch macros header
+include/svs/lib/microarch_macros.h

.licenserc.yaml

@@ -45,6 +45,12 @@ header:
     - 'THIRD-PARTY-PROGRAMS'
     - '.github/renovate.json'
     - 'cmake/mkl_functions'
+    - 'cmake/microarch_list_aarch64'
+    - 'cmake/microarch_list_aarch64_darwin'
+    - 'cmake/microarch_list_x86_64'
+    - '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

@@ -34,9 +34,14 @@ set(SVS_VERSION_MAJOR ${PROJECT_VERSION_MAJOR})
 set(SVS_VERSION_MINOR ${PROJECT_VERSION_MINOR})
 set(SVS_VERSION_PATCH ${PROJECT_VERSION_PATCH})
 
+# SVS targets:
+# - svs_devel (${SVS_LIB}) - the internal target
+# - svs_export (svs::svs) - the exported target for end users of the library
 add_library(${SVS_LIB} INTERFACE)
-set_target_properties(${SVS_LIB} PROPERTIES EXPORT_NAME svs)
-add_library(svs::svs ALIAS ${SVS_LIB})
+add_library(svs_export INTERFACE)
+set_target_properties(svs_export PROPERTIES EXPORT_NAME svs)
+target_link_libraries(svs_export INTERFACE ${SVS_LIB})
+add_library(svs::svs ALIAS svs_export)
 
 # Runtime include directories are established in the installation logic.
 target_include_directories(
@@ -61,12 +66,20 @@ target_compile_options(
     "-DSVS_VERSION_PATCH=${SVS_VERSION_PATCH}"
 )
 
+# Provide microarchitecture-specific template instantiations.
+set(SVS_MICROARCH_INSTANCE_FILES
+    cmake/microarch_instantiations/cosine.cpp
+    cmake/microarch_instantiations/euclidean.cpp
+    cmake/microarch_instantiations/inner_product.cpp
+)
+
 #####
 ##### Options and extra build steps
 #####
 
 include("cmake/options.cmake")
 
+include("cmake/microarch.cmake")
 include("cmake/clang-tidy.cmake")
 include("cmake/eve.cmake")
 include("cmake/pthread.cmake")
@@ -112,7 +125,7 @@ set(LIB_CONFIG_INSTALL_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/svs")
 
 # Install headers and target information.
 install(
-    TARGETS svs_devel svs_compile_options svs_native_options
+    TARGETS svs_export svs_devel svs_compile_options
     EXPORT svs-targets
     INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
 )
@@ -163,4 +176,3 @@ install(FILES
     ${SVS_CMAKE_FIND_FILES}
     DESTINATION "${LIB_CONFIG_INSTALL_DIR}"
 )
-

benchmark/CMakeLists.txt

@@ -102,13 +102,15 @@ endif()
 target_link_libraries(
     svs_benchmark_library
     PUBLIC
-        ${SVS_LIB}
+        svs::svs
         svs_compile_options
-        svs_native_options
+        svs_microarch_options_base
         fmt::fmt
 )
 
 # Build the shared library.
 set(EXE_FILES src/main.cpp)
 add_executable(svs_benchmark ${EXE_FILES})
 target_link_libraries(svs_benchmark PRIVATE svs_benchmark_library)
+
+svs_register_static_dimensions(96 100 128 200 768)