Add support for MacOS with ARM CPUs (CMake + GitHub Action) (#25)

* First draft of macOS support in CMakeLists and Github Actions recipe for build and test

* fix typo in FFTW package name for brew

* Rename macOS workflow to not clash with the Ubuntu workflow

* test if OpenMP is really required at all

* Remove not used dependency OpenMP

* Test if setting C++ standard to 11 helps with the whitespace required error

* Test if setting C++ standard to 14 helps with auto not allowed in lambda parameter

* Test brew hdf5 package without mpi

* Add macOS installation instructions

* Test both brew packages hdf5 and hdf5-mpi at the same time (conflicting?)

* Revert "Test both brew packages hdf5 and hdf5-mpi at the same time (conflicting?)"

This reverts commit 32bd02a.

* Add libomp to macOS dependency installation instructions

* Revert "Remove not used dependency OpenMP"

This reverts commit f3e52ea.

* Add libomp to github action

* Set OpenMP_ROOT in github action recipe to enable CMake on macOS to find OpenMP

* test explicit path to libomp instead

* Revert "test explicit path to libomp instead"

This reverts commit b82d5d9.

* try another fix for OpenMP problem

* add missing backslash in multiline command

* remove cmake from brew install commands as it's included in macos-14 runner anyway

* Mention OpenMP macOS issue with CMake in the README

* Do not set C++14 standard

* Try using the macos-15 image, and set C++11 standard

* Do not set any C++ standard in the CMakeLists

* Rename file and workflow

* first native macos build config

* Empty-Commit

* manual pre-commit trigger

* export some env variables to make cmake aligned with other cases

* added the env variables in the right place

* removed commented line setting cpp standard

* Add Changelog entry

---------

Co-authored-by: Ishaan Desai <[email protected]>
Co-authored-by: ac133718 <[email protected]>
Co-authored-by: sanathkeshav <[email protected]>

Author: 4 people

.github/workflows/build_and_test_mac.yaml

@@ -0,0 +1,79 @@
+name: Build and test macOS 15
+# Builds FANS for macOS 15 on Apple Silicon CPU and runs the tests.
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.event_name }}-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{github.event_name == 'pull_request'}}
+
+jobs:
+  build-macos:
+    name: macOS 15
+    runs-on: macos-15
+    env:
+      FANS_BUILD_DIR: build
+    strategy:
+      fail-fast: false
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install FANS dependencies
+        run: |
+          brew install gnu-time cmake gcc@14
+          brew install open-mpi --build-from-source --cc=gcc-14
+          brew install fftw hdf5-mpi eigen
+
+      - name: Generate build directory
+        run: mkdir -p ${{ env.FANS_BUILD_DIR }}
+
+      - name: Configure
+        working-directory: ${{ env.FANS_BUILD_DIR }}
+        env:
+          CC: gcc-14
+          CXX: g++-14
+          MPICC: mpicc
+          MPICXX: mpicxx
+        run: |
+          cmake --version
+          cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
+
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: macOS 15 CMakeCache
+          path: ${{ env.FANS_BUILD_DIR }}/CMakeCache.txt
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: macOS 15 CMakeLogs
+          path: '${{ env.FANS_BUILD_DIR }}/CMakeFiles/*.log'
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: macOS 15 CompileCommands
+          path: ${{ env.FANS_BUILD_DIR }}/compile_commands.json
+
+      - name: Compile
+        working-directory: ${{ env.FANS_BUILD_DIR }}
+        run:
+          cmake --build . -j $(nproc) || cmake --build . -j1
+
+      - name: Tests
+        working-directory: ${{ env.FANS_BUILD_DIR }}
+        env:
+          CTEST_OUTPUT_ON_FAILURE: 1
+        run: ctest
+
+      - uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: macOS 15 CTest logs
+          path: ${{ env.FANS_BUILD_DIR }}/Testing/Temporary/LastTest.log

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## latest
 
+- Native support for MacOS https://github.com/DataAnalyticsEngineering/FANS/pull/25
 - Remove Ubuntu 20.04 from testing and Docker support https://github.com/DataAnalyticsEngineering/FANS/pull/51
 - Add support for `--version` command line argument for checking the version of FANS
 - Modify way to provide micro structure in JSON input https://github.com/DataAnalyticsEngineering/FANS/pull/43

CMakeLists.txt

@@ -56,7 +56,11 @@ set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
 # From https://stackoverflow.com/questions/73248130/how-to-avoid-the-removal-of-the-rpath-during-cmake-install-step
 
 # Set RPATH to be relative and honor user overrides, whether at the command line or FetchContent
-set(RPATH_BASE "$ORIGIN")
+if(APPLE)
+        set(RPATH_BASE "@loader_path")
+else()
+        set(RPATH_BASE "$ORIGIN")
+endif()
 file(RELATIVE_PATH REL_PATH_LIB
         "/${CMAKE_INSTALL_BINDIR}/"
         "/${CMAKE_INSTALL_LIBDIR}/")
@@ -109,7 +113,7 @@ endif ()
 add_library(FANS::FANS ALIAS FANS_FANS)
 
 if (CMAKE_SYSTEM_PROCESSOR MATCHES "arm|aarch64")
-    target_compile_options(FANS_FANS PUBLIC -march=armv8-a+simd+fp+crypto)
+
 elseif (CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64")
     # Detecting if there is avx2 and fma support on linux
     # Deteced together, because these flags were introduced by Intel Haskell 4th. Gen

README.md

@@ -37,6 +37,16 @@ apt-get install \
     libfftw3-mpi-dev
 ```
 
+On macOS, you can obtain the dependencies using `brew` and set the environment variables:
+
+```zsh
+brew install gnu-time cmake gcc@14
+brew install open-mpi --build-from-source --cc=gcc-14
+brew install fftw hdf5-mpi eigen
+
+export CC=gcc-14 CXX=g++-14 MPICC=mpicc MPICXX=mpicxx
+```
+
 Also, we recommend to set up a Python virtual environment for the `FANS_Dashboard`:
 
 ```bash

include/general.h

@@ -41,14 +41,20 @@ using namespace Eigen;
 #define FANS_MALLOC_H
 
 /* Usage: V *data = FANS_malloc<V>(n); */
-
 template <class V>
-inline V *FANS_malloc(size_t n)
+inline V *FANS_malloc(std::size_t n)
 {
-    // V* out = new V[n];
-    V *out = (V *) aligned_alloc(4 * sizeof(V), n * sizeof(V));
-
-    return out;
+    if (n == 0)
+        throw std::invalid_argument("FANS_malloc: zero-byte request");
+    void *p = fftw_malloc(n * sizeof(V)); // SIMD-friendly alignment
+    if (!p)
+        throw std::bad_alloc();
+    return static_cast<V *>(p);
+}
+template <class V>
+inline void FANS_free(V *p)
+{
+    fftw_free(p);
 }
 #endif // FANS_MALLOC_H
 

test/run_tests.sh

@@ -8,11 +8,14 @@ fi
 
 num_processes=$2
 
+TIME_CMD="command time -v"
+[[ "$OSTYPE" == "darwin"* ]] && TIME_CMD="command gtime -v"
+
 # Run the jobs serially
-command time -v mpiexec -n $num_processes ./FANS input_files/test_LinearThermal.json test_LinearThermal.h5 > test_LinearThermal.log 2>&1
+$TIME_CMD mpiexec -n $num_processes ./FANS input_files/test_LinearThermal.json test_LinearThermal.h5 > test_LinearThermal.log 2>&1
 
-command time -v mpiexec -n $num_processes ./FANS input_files/test_LinearElastic.json test_LinearElastic.h5 > test_LinearElastic.log 2>&1
+$TIME_CMD mpiexec -n $num_processes ./FANS input_files/test_LinearElastic.json test_LinearElastic.h5 > test_LinearElastic.log 2>&1
 
-command time -v mpiexec -n $num_processes ./FANS input_files/test_PseudoPlastic.json test_PseudoPlastic.h5 > test_PseudoPlastic.log 2>&1
+$TIME_CMD mpiexec -n $num_processes ./FANS input_files/test_PseudoPlastic.json test_PseudoPlastic.h5 > test_PseudoPlastic.log 2>&1
 
-command time -v mpiexec -n $num_processes ./FANS input_files/test_J2Plasticity.json test_J2Plasticity.h5 > test_J2Plasticity.log 2>&1
+$TIME_CMD mpiexec -n $num_processes ./FANS input_files/test_J2Plasticity.json test_J2Plasticity.h5 > test_J2Plasticity.log 2>&1