include mkl libraries for intel compiler on linux and macOS

.github/actions/test-fc/action.yml

@@ -58,6 +58,22 @@ runs:
         }
         rm hw.exe
 
+    - name: Test compile Fortran (pwsh)
+      working-directory: test
+      if: ${{ (success() || failure()) && runner.os == 'Windows' }}
+      shell: pwsh
+      run: |
+        ${{ env.FC }} -o hw.exe hw.f90 
+        $output=$(& ".\hw.exe")
+        if ($output -match "hello world") {
+            write-output $output
+        } else {
+            write-output "unexpected output: $output"
+            exit 1
+        }
+        rm hw.exe
+
+
     - name: Test compile Fortran (powershell)
       working-directory: test
       if: ${{ (success() || failure()) && runner.os == 'Windows' }}

.github/actions/test-mkl/action.yml

@@ -0,0 +1,34 @@
+name: Test mkl
+description: Test installation of mkl libraries
+inputs:
+  compiler:
+    description: "Toolchain or compiler to install"
+    required: true
+  version:
+    description: "Version of toolchain or compiler"
+    required: true
+  install_mkl: 
+    description: "If MKL should be installed along with the compiler"
+    required: false
+    default: "false"
+runs:
+  using: "composite"
+  steps:
+    - name: Test compile and link mkl (bash)
+      working-directory: test
+      shell: bash
+      run: |
+        if [[ "${{ inputs.compiler }}" =~ "intel" ]] && [[ "${{ inputs.install_mkl }}" == "true" ]] && ([[ "${{ inputs.version }}" != "2021.5" ]] && [[ "$runner.os" != "macOS" ]]); then
+         if [ "$RUNNER_OS" == "macOS" ]; then
+         # required for macOS 11, intel-classic 2021.1-2021.10
+         # required for macOS 12, intel-classic 2021.1, 2021.4, 2021.6, 2021.10
+         # for all others, setting DYLD path through environment works correctly
+           export DYLD_LIBRARY_PATH="${{ env.MKLLIB }}:$DYLD_LIBRARY_PATH"
+         fi
+         linking="-L${{ env.MKLLIB }} -lmkl_intel_lp64 -lmkl_sequential -lmkl_core" 
+         # hello world with blas call program
+         ${{ env.FC }} $args $linking -o hw_mkl hw_mkl.f90
+         output=$(./hw_mkl '2>&1')
+         [[ "$output" == *"hello world   9.00000000000000"* ]] && echo "$output" || (echo "Unexpected Fortran program 'hw_mkl' output: $output"; exit 1)
+         rm hw_mkl
+        fi

.github/compat/long_compat.csv

@@ -1,4 +1,5 @@
 runner,compiler,version,support
+macos-13,intel-classic,2021.5,✓runner,compiler,version,support
 macos-11,gcc,10,✓
 macos-11,gcc,11,✓
 macos-11,gcc,12,✓

.github/workflows/test.yml

@@ -74,6 +74,7 @@ jobs:
         with:
           compiler: ${{ matrix.toolchain.compiler }}
           version: ${{ matrix.toolchain.version }}
+          install_mkl: true
 
       # - name: Debug with tmate
       #   uses: mxschmitt/action-tmate@v3
@@ -85,6 +86,14 @@ jobs:
           compiler: ${{ matrix.toolchain.compiler }}
           version: ${{ matrix.toolchain.version }}
 
+      - name: Test MKL libraries
+        if: steps.setup-fortran.outcome == 'success' && runner.os != 'windows'
+        uses: ./.github/actions/test-mkl
+        with:
+          compiler: ${{ matrix.toolchain.compiler }}
+          version: ${{ matrix.toolchain.version }}
+          install_mkl: true
+
       - name: Test C compiler
         continue-on-error: true
         if: needs.options.outputs.mode == 'report' && steps.setup-fortran.outcome == 'success'

README.md

@@ -35,6 +35,7 @@ jobs:
           - {compiler: gcc, version: 13}
           - {compiler: intel, version: '2023.2'}
           - {compiler: intel-classic, version: '2021.10'}
+          - {compiler: intel-classic, version: '2021.10'}
           - {compiler: nvidia-hpc, version: '23.11'}
         include:
           - os: ubuntu-latest
@@ -48,11 +49,13 @@ jobs:
             toolchain: {compiler: nvidia-hpc, version: '23.11'}
 
     steps:
-      - uses: fortran-lang/setup-fortran@v1
+      - uses: ssciwr/setup-fortran@v0.1
         id: setup-fortran
         with:
           compiler: ${{ matrix.toolchain.compiler }}
           version: ${{ matrix.toolchain.version }}
+          install_mkl: "true"
+
 
       - run: |
           ${{ env.FC }} ... # environment vars FC, CC, and CXX are set
@@ -68,6 +71,7 @@ jobs:
   - *intel-classic* (for `ifort`)
   - *nvidia-hpc* (for `nvfortran`)
 - *version*: Version of the compiler toolchain. See [runner compatibility](#runner-compatibility) charts below.
+- *install_mkl*: If MKL libraries should be installed alongsider the intel compiler. Defaults to `false`.
 
 
 ## Outputs
@@ -116,6 +120,8 @@ Toolchain support varies across GitHub-hosted runner images.
 
 **Note:** Intel's `ifx` compiler is not supported on macOS, so the `intel` option redirects to `intel-classic` (`ifort`).
 
+**Note:** MKL libraries can only be installed for the Intel Fortran compiler, and only on linux and MacOS operating systems; with the exception of intel-classic 2021.5, for which no compatible library is available.
+
 ## License
 
 Licensed under the Apache License, Version 2.0 (the “License”);

action.yml

@@ -1,4 +1,4 @@
-name: "Setup Fortran"
+name: "Setup Fortran and libraries"
 description: "Setup Fortran compiler and toolchain"
 inputs:
   compiler:
@@ -8,6 +8,10 @@ inputs:
   version:
     description: "Version of toolchain or compiler"
     required: false
+  install_mkl:
+    description: "If MKL should be installed along with the compiler"
+    required: false
+    default: "false"
 outputs:
   fc:
     description: "Path to Fortran compiler"
@@ -50,6 +54,7 @@ runs:
       env:
         COMPILER: ${{ inputs.compiler }}
         VERSION: ${{ inputs.version }}
+        INSTALL_MKL: ${{ inputs.install_mkl }}
       run: |
         action_path=$(echo '/${{ github.action_path }}' | sed -e 's/\\/\//g' -e 's/://')
         source "$action_path/setup-fortran.sh"
@@ -69,11 +74,11 @@ runs:
             ;;
           intel-classic)
             version=${VERSION:-2023.2.0}
-            install_intel $platform true
+            install_intel $platform true ${{ inputs.install_mkl }}
             ;;
           intel)
             version=${VERSION:-2024.0}
-            install_intel $platform false
+            install_intel $platform false ${{ inputs.install_mkl }}
             ;;
           nvidia-hpc)
             version=${VERSION:-23.11}
@@ -87,6 +92,7 @@ runs:
         echo "FC=${FC}" >> $GITHUB_ENV
         echo "CC=${CC}" >> $GITHUB_ENV
         echo "CXX=${CXX}" >> $GITHUB_ENV
+        echo "MKLLIB=${MKLLIB}" >> $GITHUB_ENV
 
     # save oneAPI cache and activate environment
     - name: Save cache
@@ -129,6 +135,7 @@ runs:
         echo FC=$FC>>$GITHUB_ENV
         echo CC=$CC>>$GITHUB_ENV
         echo CXX=$CXX>>$GITHUB_ENV
+        echo "MKLLIB=$MKLLIB" >> $GITHUB_ENV
 
         # set fpm env vars
         echo FPM_FC=$FC>>$GITHUB_ENV
@@ -139,6 +146,7 @@ runs:
         echo fc=$FC>>$GITHUB_OUTPUT
         echo cc=$CC>>$GITHUB_OUTPUT
         echo cxx=$CXX>>$GITHUB_OUTPUT
+        echo MKLLIB=$MKLLIB>>$GITHUB_OUTPUT
 
     # GitHub Actions prepends GNU linker to the PATH before all bash steps, hide it so MSVC linker is found
     - name: Hide GNU linker (Windows)

install-mkl-macos.sh

@@ -0,0 +1,22 @@
+MACOS_BASEKIT_URL=$1
+
+if [ "$MACOS_BASEKIT_URL" == "" ]; then
+  echo "ERROR: MACOS_BASEKIT_URL is empty - please check the version mapping for MKL"
+  echo "SKIPPING MKL installation..."
+elif [ "$MACOS_BASEKIT_URL" == "2021.5" ]; then
+  echo "ERROR: MKL not available for this intel compiler version"
+  echo "SKIPPING MKL installation..."
+else
+  require_fetch
+  $fetch $MACOS_BASEKIT_URL > m_BASEKit.dmg
+  ls -lh
+  hdiutil verify m_BASEKit.dmg
+  hdiutil attach m_BASEKit.dmg
+  sudo /Volumes/"$(basename "$MACOS_BASEKIT_URL" .dmg)"/bootstrapper.app/Contents/MacOS/bootstrapper -s \
+    --action install \
+    --eula=accept \
+    --continue-with-optional-error=yes \
+    --log-dir=.
+  hdiutil detach /Volumes/"$(basename "$MACOS_BASEKIT_URL" .dmg)" -quiet
+  rm m_BASEKit.dmg
+fi