include mkl libraries for intel compiler on linux and macOS

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

@@ -0,0 +1,38 @@
+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
+           MKLLIB="$MKLROOT/lib"
+           export DYLD_LIBRARY_PATH="$MKLLIB:$DYLD_LIBRARY_PATH"
+         elif [ "$RUNNER_OS" == "Linux" ]; then
+           MKLLIB="$MKLROOT/latest/lib/intel64"
+           export LD_LIBRARY_PATH="$MKLLIB:$LD_LIBRARY_PATH"
+         fi
+         linking="-L$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/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
@@ -115,8 +119,8 @@ Toolchain support varies across GitHub-hosted runner images.
 <!-- compat ends -->
 
 **Note:** Intel's `ifx` compiler is not supported on macOS, so the `intel` option redirects to `intel-classic` (`ifort`).
-
 **Note:** LFortran is currently only discoverable by name with `bash` on Windows, see [here for context](https://github.com/fortran-lang/setup-fortran/pull/57#issuecomment-2021605094).
+**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
 

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"
@@ -57,6 +61,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"
@@ -76,11 +81,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}
@@ -140,6 +145,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
@@ -150,7 +156,6 @@ runs:
         echo fc=$FC>>$GITHUB_OUTPUT
         echo cc=$CC>>$GITHUB_OUTPUT
         echo cxx=$CXX>>$GITHUB_OUTPUT
-
     - name: Hide GNU linker (Windows)
       if: runner.os == 'Windows' && !contains(inputs.compiler, 'gcc')
       shell: bash

install-intel-macos.sh

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

setup-fortran.sh

@@ -171,6 +171,7 @@ LD_LIBRARY_PATH=$LD_LIBRARY_PATH
 LIBRARY_PATH=$LIBRARY_PATH
 INFOPATH=$INFOPATH
 MANPATH=$MANPATH
+MKLROOT=$MKLROOT
 ONEAPI_ROOT=$ONEAPI_ROOT
 CLASSPATH=$CLASSPATH
 CMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH
@@ -244,6 +245,19 @@ intel_version_map_l()
   fi
 }
 
+mkl_version_map_l()
+{
+  local intel_version=$1
+  case $intel_version in
+    2021.1 | 2021.1.2)
+      mkl_version=2021.1.1
+      ;;
+    *)
+      mkl_version=$intel_version
+      ;;
+  esac
+}
+
 intel_version_map_m()
 {
   local actual_version=$1
@@ -278,6 +292,25 @@ intel_version_map_m()
   esac
 }
 
+mkl_version_map_m()
+{
+  local intel_version=$1
+  case $intel_version in
+    2021.1.0 | 2021.2.0 | 2021.3.0 | 2021.4.0 | 2022.2.0 | 2022.3.0 | 2022.3.1 | 2023.0.0 )
+      mkl_version=2022.2.0
+      ;;
+    2022.1.0)
+      mkl_version=""
+      ;;
+    2023.1.0)
+      mkl_version=2023.1.0
+      ;;
+    *)
+      mkl_version=2023.2.0
+      ;;
+  esac
+}
+
 intel_version_map_w()
 {
   local actual_version=$1
@@ -328,7 +361,10 @@ install_intel_apt()
 {
   local version=$1
   local classic=$2
+  local mkl_version=$1
+  local install_mkl=$3
   intel_version_map_l $version $classic
+  mkl_version_map_l $version
 
   require_fetch
   local _KEY="GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB"
@@ -342,84 +378,95 @@ install_intel_apt()
   # c/cpp compiler package names changed with 2024+
   case $version in
     2024*)
-      sudo apt-get install \
-        intel-oneapi-compiler-{fortran,dpcpp-cpp}-$version
+      cpp_name=dpcpp-cpp
       ;;
     *)
-      sudo apt-get install \
-        intel-oneapi-compiler-{fortran,dpcpp-cpp-and-cpp-classic}-$version
+      cpp_name=dpcpp-cpp-and-cpp-classic
       ;;
   esac
 
+  if $install_mkl; then
+    sudo apt-get install -y \
+      intel-oneapi-compiler-{fortran,"$cpp_name"}-$version \
+      intel-oneapi-mkl-$mkl_version
+  else
+    sudo apt-get install -y \
+      intel-oneapi-compiler-{fortran,"$cpp_name"}-$version 
+  fi
+
   source /opt/intel/oneapi/setvars.sh
   export_intel_vars
 }
 
 install_intel_dmg()
 {
   local version=$1
+  local mkl_version=$1
+  local install_mkl=$2
   intel_version_map_m $version
+  mkl_version_map_m $version
 
   case $version in
     2021.1.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/17426/m_BaseKit_p_2021.1.0.2427.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/17398/m_HPCKit_p_2021.1.0.2681.dmg
       ;;
     2021.2.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/17714/m_BaseKit_p_2021.2.0.2855.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/17643/m_HPCKit_p_2021.2.0.2903.dmg
       ;;
     2021.3.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/17969/m_BaseKit_p_2021.3.0.3043.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/17890/m_HPCKit_p_2021.3.0.3226.dmg
       ;;
     2021.4.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18256/m_BaseKit_p_2021.4.0.3384.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18242/m_HPCKit_p_2021.4.0.3389.dmg
       ;;
     2022.1.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18342/m_BaseKit_p_2022.1.0.92.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18341/m_HPCKit_p_2022.1.0.86.dmg
       ;;
     2022.2.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/18675/m_BaseKit_p_2022.2.0.226_offline.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/18681/m_HPCKit_p_2022.2.0.158_offline.dmg
       ;;
     2022.3.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18865/m_BaseKit_p_2022.3.0.8743.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18866/m_HPCKit_p_2022.3.0.8685.dmg
       ;;
     2022.3.1)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18971/m_BaseKit_p_2022.3.1.17244.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/18977/m_HPCKit_p_2022.3.1.15344.dmg
       ;;
     2023.0.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/19080/m_BaseKit_p_2023.0.0.25441.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/irc_nas/19086/m_HPCKit_p_2023.0.0.25440.dmg
       ;;
     2023.1.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/2516a0a0-de4d-4f3d-9e83-545b32127dbb/m_BaseKit_p_2023.1.0.45568.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/a99cb1c5-5af6-4824-9811-ae172d24e594/m_HPCKit_p_2023.1.0.44543.dmg
       ;;
     2023.2.0)
-      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/cd013e6c-49c4-488b-8b86-25df6693a9b7/m_BaseKit_p_2023.2.0.49398.dmg
       MACOS_HPCKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/edb4dc2f-266f-47f2-8d56-21bc7764e119/m_HPCKit_p_2023.2.0.49443.dmg
       ;;
     *)
       exit 1
       ;;
   esac
 
-  require_fetch
-  $fetch $MACOS_HPCKIT_URL > m_HPCKit.dmg
-  hdiutil attach m_HPCKit.dmg
-  sudo /Volumes/"$(basename "$MACOS_HPCKIT_URL" .dmg)"/bootstrapper.app/Contents/MacOS/bootstrapper -s \
-    --action install \
-    --eula=accept \
-    --continue-with-optional-error=yes \
-    --log-dir=.
-  hdiutil detach /Volumes/"$(basename "$MACOS_HPCKIT_URL" .dmg)" -quiet
-  rm m_HPCKit.dmg
+  case $mkl_version in
+    2022.2.0)
+      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/18675/m_BaseKit_p_2022.2.0.226_offline.dmg
+      ;;
+    2023.1.0)
+      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/2516a0a0-de4d-4f3d-9e83-545b32127dbb/m_BaseKit_p_2023.1.0.45568.dmg
+      ;;
+    2023.2.0)
+      MACOS_BASEKIT_URL=https://registrationcenter-download.intel.com/akdlm/IRC_NAS/cd013e6c-49c4-488b-8b86-25df6693a9b7/m_BaseKit_p_2023.2.0.49398.dmg
+      ;;
+    "")
+      ;;
+    *)
+      exit 1
+      ;;
+  esac
+
+  if $install_mkl; then
+    source "$GITHUB_ACTION_PATH/install-intel-macos.sh" true $MACOS_BASEKIT_URL
+  fi
+
+  source "$GITHUB_ACTION_PATH/install-intel-macos.sh" false $MACOS_HPCKIT_URL
 
   source /opt/intel/oneapi/setvars.sh
   export_intel_vars
@@ -476,12 +523,15 @@ install_intel()
 {
   local platform=$1
   local classic=$2
+  local install_mkl=$3
+  mkl_subdir=""
   case $platform in
     linux*)
-      install_intel_apt $version $classic
+      install_intel_apt $version $classic $install_mkl
+      mkl_subdir="intel64"
       ;;
     darwin*)
-      install_intel_dmg $version
+      install_intel_dmg $version $install_mkl
       ;;
     mingw*)
       install_intel_win $version $classic
@@ -507,6 +557,11 @@ install_intel()
     export CC="icx"
     export CXX="icpx"
   fi
+
+  if $install_mkl; then
+    export MKLLIB="$ONEAPI_ROOT/mkl/latest/lib/$mkl_subdir"
+    export MKLROOT="$ONEAPI_ROOT/mkl/latest"
+  fi
 }
 
 export_nvidiahpc_vars()