comm => communicator

Included workflows

• See .github/workflows/README

Read the documentation

To learn comm, read the full documentation that is automatically generated whenever a push occurs to "master".

Get code

git clone git@github.com:DARMA-tasking/comm.git

Required

• MPI, installed and accessible via CC/CXX
• Ninja, installed and accessible
• magistrate, (vt ecosystem), cloned like:

cd comm/lib
git clone git@github.com:DARMA-tasking/magistrate.git

Usage

With scripts

In comm/:

# Building
./ci/build_cpp.sh "$PWD" "$PWD/build/ci"

# Testing
./ci/test_cpp.sh "$PWD" "$PWD/build/ci"

With cmake

In comm/:

# Building
cmake -S . -B build

# Compiling
cmake --build build
cmake --build build --parallel # Faster

# Installing
cmake --install build --prefix "$PWD/install"

# Testing
./build/tests/comm_tests
ctest --test-dir build --output-on-failure

## Optional multi-rank test run
mpirun -np 2 ./build/tests/comm_tests

# Examples
./build/examples/[filename]
# Example: ./build/examples/dummy1

# Documentation
xdg-open build/html/index.html # Linux
open build/html/index.html # macOS

Upgrade external libraries procedure

• See lib/UPDATE.md

Logging

Logging components are registered by name and represented by cheap, copyable handles. Registration is idempotent, so separate call sites asking for the same name receive the same component and share its enabled state.

#include <comm/util/logging.h>

namespace logging = comm::util;

auto const scheduler_log = logging::registerComponent("Scheduler");

logging::enable(scheduler_log);
COMM_LOG(scheduler_log, normal, "scheduled task {}\n", task_id);

// Configuration code can target a registered component without its handle.
logging::disable("Scheduler");
logging::enable("Scheduler");
COMM_LOG("Scheduler", verbose, "queue depth={}\n", queue.size());

The optional second argument to registerComponent controls the initial state: registerComponent("Metrics", true). The first registration wins. Name-based enable, disable, and findComponent do not implicitly register unknown names, which makes configuration typos detectable.