Define mpiexec variable at build time (#275)

Fixes #274.

Author: simonbyrne

.appveyor.yml

@@ -25,7 +25,9 @@ install:
         "https://download.microsoft.com/download/A/E/0/AE002626-9D9D-448D-8197-1EA510E297CE/msmpisetup.exe",
         "C:\projects\MSMpiSetup.exe")
   - C:\projects\MSMpiSetup.exe -unattend -minimal
-  - set PATH=C:\Program Files\Microsoft MPI\Bin;%PATH%
+  # This shouldn't typicallybe needed: the installer adds the directory to
+  # the PATH. For some reason this doesn't work on Appveyor
+  - set JULIA_MPIEXEC=C:\Program Files\Microsoft MPI\Bin\mpiexec.exe
 
 build_script:
   - echo "%JL_BUILD_SCRIPT%"

.travis.yml

@@ -36,7 +36,6 @@ matrix:
 before_install:
   - sh ./conf/travis-install-mpi.sh $MPI_IMPL
   - if [ "$TRAVIS_OS_NAME" == "linux" ]; then export JULIA_MPI_PATH=$HOME/$MPI_IMPL; fi
-  - if [ "$TRAVIS_OS_NAME" == "linux" ]; then export PATH=$HOME/$MPI_IMPL/bin:$PATH; fi
 # Work around OpenMPI attempting to create overly long temporary
 # file names - and erroring as a result
   - export TMPDIR=/tmp

deps/build.jl

@@ -7,14 +7,22 @@ end
 MPI_INCLUDE_PATH = get(ENV, "JULIA_MPI_INCLUDE_PATH") do
     MPI_PATH !== nothing ? joinpath(MPI_PATH,"include") : nothing
 end
-MPICC = get(ENV, "JULIA_MPICC") do
+mpicc = get(ENV, "JULIA_MPICC") do
     if MPI_PATH !== nothing
         joinpath(MPI_PATH,"bin","mpicc")
     else
         "mpicc"
     end
 end
 
+mpiexec = get(ENV, "JULIA_MPIEXEC") do
+    if MPI_PATH !== nothing
+        joinpath(MPI_PATH,"bin","mpiexec")
+    else
+        "mpiexec"
+    end
+end
+
 if haskey(ENV, "JULIA_MPI_CFLAGS")
     CFLAGS = split(ENV["JULIA_MPI_CFLAGS"])
 else
@@ -61,6 +69,7 @@ open("deps.jl","w") do f
     println(f, :(const libmpi = $libmpi))
     println(f, :(const libmpi_size = $libsize))
     println(f, :(const MPI_VERSION = $MPI_VERSION))
+    println(f, :(const mpiexec = $mpiexec))
 end
 
 if Sys.iswindows()
@@ -70,7 +79,7 @@ if Sys.iswindows()
 else
     include("gen_consts.jl")
 
-    run(`$MPICC gen_consts.c -o gen_consts $CFLAGS`)
+    run(`$mpicc gen_consts.c -o gen_consts $CFLAGS`)
 
     open("deps.jl","a") do f
         run(pipeline(`./gen_consts`, stdout = f))

docs/src/installing.md

@@ -28,6 +28,7 @@ controlled with the optional environment variables:
 - `JULIA_MPI_INCLUDE_PATH`: the directory containing the MPI header files.
 - `JULIA_MPI_CFlAGS`: C flags passed to the constant generation build (default: `-lmpi`)
 - `JULIA_MPICC`: MPI C compiler (default: `mpicc`)
+- `JULIA_MPIEXEC`: MPI startup command (default: `mpiexec`)
 
 If your MPI installation changes (e.g. it is upgraded by the system, or you switch
 libraries), you will need to re-run `build MPI` at the package prompt.

src/cman.jl

@@ -55,7 +55,7 @@ mutable struct MPIManager <: ClusterManager
     receiving_done::Channel{Nothing}
 
     function MPIManager(; np::Integer = Sys.CPU_THREADS,
-                          mpirun_cmd::Cmd = `mpiexec -n $np`,
+                          mpirun_cmd::Cmd = `$mpiexec -n $np`,
                           launch_timeout::Real = 60.0,
                           mode::TransportMode = MPI_ON_WORKERS,
                           master_tcp_interface::String="" )

test/runtests.jl

@@ -1,6 +1,8 @@
 using MPI
 using Test
 
+import MPI: mpiexec
+
 # Code coverage command line options; must correspond to src/julia.h
 # and src/ui/repl.c
 const JL_LOG_NONE = 0
@@ -25,7 +27,7 @@ function runtests()
 
     extra_args = []
     @static if !Sys.iswindows()
-        if occursin( "OpenRTE", read(`mpiexec --version`, String))
+        if occursin( "OpenRTE", read(`$mpiexec --version`, String))
             push!(extra_args,"--oversubscribe")
         end
     end
@@ -35,11 +37,11 @@ function runtests()
     for f in testfiles
         coverage_opt = coverage_opts[Base.JLOptions().code_coverage]
         if f ∈ singlefiles
-            run(`mpiexec $extra_args -n 1 $exename --code-coverage=$coverage_opt $(joinpath(testdir, f))`)
+            run(`$mpiexec $extra_args -n 1 $exename --code-coverage=$coverage_opt $(joinpath(testdir, f))`)
         elseif f ∈ juliafiles
             run(`$exename --code-coverage=$coverage_opt $(joinpath(testdir, f))`)
         else
-            run(`mpiexec $extra_args -n $nprocs $exename --code-coverage=$coverage_opt $(joinpath(testdir, f))`)
+            run(`$mpiexec $extra_args -n $nprocs $exename --code-coverage=$coverage_opt $(joinpath(testdir, f))`)
         end
         Base.with_output_color(:green,stdout) do io
             println(io,"\tSUCCESS: $f")

test/test_cman_julia.jl

@@ -2,10 +2,12 @@ using Test
 using MPI
 using Distributed
 
+import MPI: mpiexec
+
 # Start workers via `mpiexec` that communicate among themselves via MPI;
 # communicate with the workers via TCP
-if !Sys.iswindows() && occursin( "OpenRTE", open(f->read(f, String),`mpiexec --version`))
-    mgr = MPI.MPIManager(np=4, mpirun_cmd=`mpiexec --oversubscribe -n 4`)
+if !Sys.iswindows() && occursin( "OpenRTE", open(f->read(f, String),`$mpiexec --version`))
+    mgr = MPI.MPIManager(np=4, mpirun_cmd=`$mpiexec --oversubscribe -n 4`)
 else
     mgr = MPI.MPIManager(np=4)
 end