Support for Open MPI

Author: dalcinl

.codespellrc

@@ -0,0 +1,4 @@
+# https://github.com/codespell-project/codespell #-*- mode: conf -*-
+
+[codespell]
+ignore-words-list = pevent

.github/workflows/cd-wheel.yml

@@ -7,12 +7,12 @@ on:  # yamllint disable-line rule:truthy
   workflow_call:
     inputs:
       mpiname:
-        description: 'MPI'
+        description: 'MPI Name'
         default: 'mpich'
         required: false
         type: string
       version:
-        description: 'Version'
+        description: 'MPI Version'
         default: ''
         required: false
         type: string
@@ -39,6 +39,7 @@ on:  # yamllint disable-line rule:truthy
         type: choice
         options:
           - mpich
+          - openmpi
       version:
         description: 'Version'
         default: ''
@@ -122,6 +123,11 @@ jobs:
     - id: checkout
       uses: actions/checkout@v4
 
+    - id: setup-autotools
+      if: ${{ runner.os == 'macOS' && runner.arch == 'ARM64' }}
+      run: |
+        brew install autoconf automake libtool
+
     - id: setup-gfortran
       if: ${{ runner.os == 'macOS' }}
       run: |

.github/workflows/cd.yml

@@ -7,13 +7,14 @@ on:  # yamllint disable-line rule:truthy
   workflow_dispatch:
     inputs:
       mpiname:
-        description: 'MPI'
+        description: 'MPI Name'
         default: 'mpich'
         type: choice
         options:
           - mpich
+          - openmpi
       version:
-        description: 'Version'
+        description: 'MPI Version'
         default: ''
         required: false
         type: string

README.md

@@ -1,29 +1,33 @@
-# mpich-publish
+# mpi-publish
 
-This repository builds and publishes [MPICH](https://mpich.org)
-Python wheels able to run in a variety of
+This repository builds and publishes [MPICH](https://www.mpich.org) and
+[Open MPI](https://www.open-mpi.org/) Python wheels able to run in
+a variety of
 
 - operating systems: *Linux*, *macOS*;
 - processor architectures: *AMD64*, *ARM64*, *PPC64*;
 - Python implementations: *CPython*, *PyPy*.
 
-MPICH wheels are uploaded to the [Anaconda.org](https://anaconda.org/mpi4py)
+MPI wheels are uploaded to the [Anaconda.org](https://anaconda.org/mpi4py)
 package server. These wheels can be installed with `pip` specifying the
 alternative index URL:
 
 ```sh
 python -m pip install mpich -i https://pypi.anaconda.org/mpi4py/simple
 ```
 
+```sh
+python -m pip install openmpi -i https://pypi.anaconda.org/mpi4py/simple
+```
+
 > [!CAUTION]
-> MPICH wheels are distributed with a focus on ease of use, compatibility,
-> and interoperability. The Linux MPICH wheels are built in somewhat
-> constrained environments with relatively dated Linux distributions
+> MPI wheels are distributed with a focus on ease of use, compatibility, and
+> interoperability. The Linux wheels are built in somewhat constrained
+> environments with relatively dated Linux distributions
 > ([manylinux](https://github.com/pypa/manylinux) container images).
 > Therefore, they may lack support for high-performance features like
 > cross-memory attach (XPMEM/CMA). In production scenarios, it is recommended
-> to use external (either custom-built or system-provided) MPICH
-> installations.
+> to use external (either custom-built or system-provided) MPI installations.
 
 > [!TIP]
 > [Intel MPI](https://software.intel.com/intel-mpi-library) distributes [Linux

bootstrap.sh

@@ -3,14 +3,24 @@ set -euo pipefail
 
 mpiname=${MPINAME:-mpich}
 
+PROJECT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+PACKAGE=$PROJECT/package
+SOURCE=$PACKAGE/source
+
 if test "$mpiname" = "mpich"; then
     version=${VERSION:-4.2.0}
     urlbase="https://www.mpich.org/static/downloads/$version"
     tarball="$mpiname-$version.tar.gz"
     license=COPYRIGHT
 fi
 
-SOURCE=package/source
+if test "$mpiname" = "openmpi"; then
+    version=${VERSION:-5.0.2}
+    urlbase=https://download.open-mpi.org/release/open-mpi/v${version%.*}
+    tarball="$mpiname-$version.tar.gz"
+    license=LICENSE
+fi
+
 if test ! -d "$SOURCE"; then
     if test ! -f "$tarball"; then
         echo downloading "$urlbase"/"$tarball"...
@@ -21,6 +31,14 @@ if test ! -d "$SOURCE"; then
     echo extracting "$tarball" to "$SOURCE"...
     tar xf "$tarball"
     mv "$mpiname-$version" "$SOURCE"
+    if test "$mpiname-$(uname)" = "openmpi-Darwin"; then
+        cd "$SOURCE"/3rd-party
+        tar xf libevent-*.tar.gz
+        cd libevent-*
+        echo running autogen.sh on "$(basename "$(pwd)")"
+        ./autogen.sh
+        cd "$PROJECT"
+    fi
 else
     echo reusing directory "$SOURCE"...
 fi

check-wheel.sh

@@ -74,6 +74,29 @@ if test "$mpiname" = "mpich"; then
     fi
 fi
 
+if test "$mpiname" = "openmpi"; then
+    headers=(
+        "$data"/include/mpi.h
+    )
+    scripts=(
+        "$data"/bin/mpicc
+        "$data"/bin/mpic++
+        "$data"/bin/mpicxx
+        "$data"/bin/mpiexec
+        "$data"/bin/mpirun
+    )
+    programs=(
+        "$data"/bin/ompi_info
+        "$data"/bin/opal_wrapper
+    )
+    libraries=(
+        "$data"/lib/libmpi.*
+        "$data"/lib/libopen-*.*
+    )
+    runlibs+='|lib(z|util|event.*|hwloc)'$soregex
+    runlibs+='|lib(open-(pal|rte)|pmix)'$soregex
+fi
+
 check-dso() {
     local dso=$1 out1="" out2=""
     echo checking "$dso"...

cibw-build-mpi.sh

@@ -4,9 +4,12 @@ set -euo pipefail
 mpiname="${MPINAME:-mpich}"
 variant="${VARIANT:-}"
 
-SOURCE=${SOURCE:-$PWD/package/source}
-WORKDIR=${WORKDIR:-$PWD/package/workdir}
-DESTDIR=${DESTDIR:-$PWD/package/install}
+PROJECT=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+PACKAGE=$PROJECT/package
+
+SOURCE=${SOURCE:-$PACKAGE/source}
+WORKDIR=${WORKDIR:-$PACKAGE/workdir}
+DESTDIR=${DESTDIR:-$PACKAGE/install}
 PREFIX=${PREFIX:-"/opt/$mpiname"}
 
 if test "$mpiname" = "mpich"; then
@@ -40,6 +43,30 @@ if test "$mpiname" = "mpich"; then
     sed -i.orig "$disable_doc" "$SOURCE"/Makefile.in
 fi
 
+if test "$mpiname" = "openmpi"; then
+    options=(
+        --enable-debug # FIXME
+        CC=cc
+        CXX=c++
+        --prefix="$PREFIX"
+        --disable-dlopen
+        --disable-oshmem
+        --without-ofi
+        --without-ucx
+        --without-psm2
+        --without-cuda
+        --without-rocm
+        --with-pmix=internal
+        --with-prrte=internal
+        --with-libevent=internal
+        --with-hwloc=internal
+        --disable-static
+        --disable-sphinx
+    )
+    if test "$(uname)" = Darwin; then
+        options=("${options[@]/--disable-static}") # libevent
+    fi
+fi
 
 if test "$(uname)" = Darwin; then
     export MACOSX_DEPLOYMENT_TARGET="11.0"
@@ -170,5 +197,147 @@ fi
 
 } # fixup-mpich()
 
+fixup-openmpi() {
+
+cd "${DESTDIR}${PREFIX}"
+rm -fr include/ev*
+rm -fr include/hwloc*
+rm -fr include/pmix*
+rm -fr include/prte*
+rm -f  include/mpif*.h
+rm -f  include/*/*/*mpifh.h
+rm -f  bin/ev*
+rm -f  bin/hwloc*
+rm -f  bin/lstopo*
+
+#rm -f  bin/pmix_info
+rm -f  bin/palloc
+rm -f  bin/pattrs
+rm -f  bin/pctrl
+rm -f  bin/pevent
+rm -f  bin/plookup
+rm -f  bin/pps
+rm -f  bin/pquery
+
+#rm -f  bin/prte_info
+#rm -f  bin/prte
+#rm -f  bin/prted
+#rm -f  bin/prterun
+rm -f  bin/prun
+rm -f  bin/psched
+rm -f  bin/pterm
+
+rm -fr sbin
+rm -f  bin/pmixcc
+rm -f  bin/mpif77
+rm -f  bin/mpif90
+rm -f  bin/mpifort
+rm -f  bin/oshrun
+rm -f  lib/*.mod
+rm -f  lib/lib*.a
+rm -f  lib/lib*.la
+rm -f  lib/libmpi_mpifh*.*
+rm -f  lib/libmpi_usempi*.*
+rm -f  lib/libompitrace.*
+rm -fr lib/openmpi
+rm -fr lib/pkgconfig
+rm -fr share/bash-completion
+rm -fr share/doc
+rm -fr share/man
+rm -fr share/hwloc
+rm -fr share/prte/rst
+rm -f  share/openmpi/mpif77-wrapper-data.txt
+rm -f  share/openmpi/mpif90-wrapper-data.txt
+rm -f  share/openmpi/mpifort-wrapper-data.txt
+rm -f  share/pmix/pmixcc-wrapper-data.txt
+rm -f  share/*/*.supp
+rm -f  share/*/*/example.conf
+
+cd "${DESTDIR}${PREFIX}/bin"
+unset executables
+for exe in 'mpirun' 'ompi*' 'pmix*' 'prte*' 'opal*' 'orte*'; do
+    while IFS= read -r filename
+    do executables+=("$(basename "$filename")")
+    done < <(find . -name "$exe" -type f)
+done
+
+cd "${DESTDIR}${PREFIX}/lib"
+unset libraries
+for lib in 'lib*.so.*' 'lib*.*.dylib'; do
+    while IFS= read -r filename
+    do libraries+=("$(basename "$filename")")
+    done < <(find . -name "$lib" -type f)
+done
+
+if test "$(uname)" = Linux; then
+    cd "${DESTDIR}${PREFIX}/bin"
+    for exe in "${executables[@]}"; do
+        patchelf --set-rpath "\$ORIGIN/../lib" "$exe"
+    done
+    cd "${DESTDIR}${PREFIX}/lib"
+    for lib in lib*.so; do
+        patchelf --set-rpath "\$ORIGIN" "$lib"
+        soname=$(patchelf --print-soname "$lib")
+        if test -L "$soname"; then
+            mv "$(readlink "$soname")" "$soname"
+            ln -sf "$soname" "$lib"
+        fi
+    done
+fi
+
+if test "$(uname)" = Darwin; then
+    cd "${DESTDIR}${PREFIX}/bin"
+    for exe in "${executables[@]}"; do
+        install_name_tool -add_rpath "@executable_path/../lib/" "$exe"
+        unset dependencies
+        while IFS= read -r dep
+        do dependencies+=("$dep")
+        done < <(otool -L "$exe" | sed 1,1d)
+        for dep in "${dependencies[@]}"; do
+            if test "$(dirname "$dep")" = "$(dirname "$PREFIX/lib/.")"; then
+                installname="@rpath/$(basename "$dep")"
+                install_name_tool -change "$dep" "$installname" "$exe"
+            fi
+        done
+    done
+    cd "${DESTDIR}${PREFIX}/lib"
+    for lib in lib*.*.dylib; do
+        install_name_tool -id "@rpath/$lib" "$lib"
+        install_name_tool -add_rpath "@loader_path/" "$lib"
+        while IFS= read -r dep
+        do dependencies+=("$dep")
+        done < <(otool -L "$lib" | sed 1,1d)
+        for dep in "${dependencies[@]}"; do
+            if test "$(dirname "$dep")" = "$(dirname "$PREFIX/lib/.")"; then
+                installname="@rpath/$(basename "$dep")"
+                install_name_tool -change "$dep" "$installname" "$lib"
+            fi
+        done
+    done
+fi
+
+cd "${DESTDIR}${PREFIX}/bin"
+wrapper_cmd=opal_wrapper
+wrapper_bin="$WORKDIR/$wrapper_cmd"
+wrapper_src="$PROJECT/cibw-ompi-wrapper.c"
+cc -DWRAPPER="$wrapper_cmd" "$wrapper_src" -o "$wrapper_bin"
+executables=(mpicc mpicxx mpiCC mpic++)
+for exe in "${executables[@]}"; do
+    install "$wrapper_bin" "$exe"
+done
+
+cd "${DESTDIR}${PREFIX}/bin"
+wrapper_cmd=orun_wrapper
+wrapper_bin="$WORKDIR/$wrapper_cmd"
+wrapper_src="$PROJECT/cibw-ompi-wrapper.c"
+cc -DWRAPPER="$wrapper_cmd" "$wrapper_src" -o "$wrapper_bin"
+cp -a mpirun "$wrapper_cmd"
+executables=(mpirun mpiexec)
+for exe in "${executables[@]}"; do
+    install "$wrapper_bin" "$exe"
+done
+
+} # fixup-openmpi()
+
 echo fixing install tree
 fixup-"$mpiname"

cibw-check-mpi.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 set -euo pipefail
 
-mpiname="${MPINAME:-mpich}"
+pkgname=$(pip list | awk '/mpich|openmpi/ {print $1}')
+mpiname=${pkgname%_*}
 
 tempdir="$(mktemp -d)"
 trap 'rm -rf $tempdir' EXIT
@@ -27,6 +28,15 @@ int main(int argc, char *argv[])
 EOF
 ln -s helloworld.c helloworld.cxx
 
+if test "$mpiname" = "openmpi"; then
+    export OMPI_ALLOW_RUN_AS_ROOT=1
+    export OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1
+    export OMPI_MCA_rmaps_base_oversubscribe=true
+    export OMPI_MCA_rmaps_default_mapping_policy=:oversubscribe
+    export OMPI_MCA_plm_rsh_agent=false
+    export OMPI_MCA_plm_ssh_agent=false
+fi
+
 RUN() { echo + "$@"; "$@"; }
 
 if test "$mpiname" = "mpich"; then