quo-vadis

This project is under active development and is currently not stable.

A next-generation, machine-independent coordination layer to arbitrate access among multiple runtime components and map tasks efficiently to heterogeneous architectures.

Building

mkdir build && cd build && cmake .. && make

Or, using ninja, perform the following:

mkdir build && cd build && cmake -G Ninja .. && ninja

Build Options

Below is a table of build options for quo-vadis (QV). Options can be specified in a variety of ways using cmake or ccmake. For example,

cmake -DQV_GPU_SUPPORT=OFF -DQV_FORTRAN_SUPPORT=OFF ..

Option	Default	Comment
QV_FORTRAN_SUPPORT	ON	Toggle Fortran support
QV_GPU_SUPPORT	ON	Toggle GPU support
QV_MPI_SUPPORT	ON	Toggle MPI support
QV_OMP_SUPPORT	ON	Toggle OpenMP support

Developer Build Options

Below is a table of build options for quo-vadis developers. Options can be specified in a variety of ways using cmake or ccmake. For example,

cmake -DQV_SANITIZE=address ..

Option	Default	Comment
QV_SANITIZE	none	Available: address;thread;undefined

Testing

ctest
# Or target a specific suite of tests
ctest -L core
# Or verbosely
ctest -V

Environment Variables

QV_PORT # The port number used for client/server communication.
QV_TMPDIR # Directory used for temporary files.
QV_VEXCEPT # When set to any value provides verbose exception output.

For developers and debugging:

HWLOC_XMLFILE # Path to system topology XML file.

Examples

# Launch the daemon with specified port.
build/src/quo-vadisd --port 55996
# Run a test.
./build/tests/test-process-scopes

QV supports both manual and automatic quo-vadisd startup for MPI applications. For this to work, the path to quo-vadisd must be in your PATH.

# Set PATH to location of quo-vadisd. For installs
# this will commonly be set to CMAKE_INSTALL_PREFIX/bin.
PATH=$PWD/build/src:$PATH
# Optionally set the communication port via environment variable.
# If QV_PORT is not set, then QV will chose a default port for you.
# Run a test.
mpiexec -n 2 build/tests/test-mpi-scopes

Internal Software Dependencies

• hwloc (https://github.com/open-mpi/hwloc)
• cereal (https://github.com/USCiLab/cereal)
• spdlog (https://github.com/gabime/spdlog)

External Software Dependencies

• Required
  • ZeroMQ (https://github.com/zeromq/libzmq)
• Optional
  • An MPI-3 implementation (https://www.open-mpi.org, https://www.mpich.org)

Packaging for Developers

# To generate source distributions, run the following:
cd build
make package_source

Los Alamos National Laboratory Code Release

LA-CC-21-084