Skip to content

Commit

Permalink
#672: docs: cleanup fix some stylistic issues
Browse files Browse the repository at this point in the history
  • Loading branch information
lifflander committed Jun 16, 2020
1 parent 1fb0897 commit ac588a7
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
19 changes: 10 additions & 9 deletions src/active-messenger.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@
The active messenger, accessed via `vt::theMsg()`, asynchronously sends and
receives messages across nodes using MPI internally. When sending a message, it
uses the \vt registry to consistently dispatch messages and data to handlers
(function pointers, functors, or methods) across nodes (even with address space
randomization). Each message contains an envelope `vt::Envelope` to store
meta-data associated with the message, such as the destination and handler to
trigger when it arrives. Sending a message entails setting up the envelope,
optionally serializing the message (depending on whether the serialize overload is
(function pointers, functors, or methods) across nodes.

Each message contains an envelope `vt::Envelope` to store meta-data associated
with the message, such as the destination and handler to trigger when it
arrives. Sending a message entails setting up the envelope, optionally
serializing the message (depending on whether the serialize overload is
present), and then using `MPI_Isend` to asynchronously transfer the bytes to the
destination node. On the receive side, the active messenger is always probing for a
incoming message and begins a transfer when it discovers one. The \vt scheduler
polls the active messenger to make progress on any incoming messages.
destination node. On the receive side, the active messenger is always probing
for a incoming message and begins a transfer when it discovers one. The \vt
scheduler polls the active messenger to make progress on any incoming messages.

\copydoc vt::messaging::ActiveMessenger

\section am-simple-example Sending a message

\code{.cpp}
\endcode
\endcode
33 changes: 16 additions & 17 deletions src/vt.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

\page introduction Introduction to DARMA/vt
\brief Overview of functionality in \vt

Expand All @@ -21,21 +20,21 @@ management.

\section vt-features Features in vt

- Active messaging to type-safe handlers across nodes
- Groups for scalable construction of node subsets
- Optional serialization of messages
- Termination detection across entire or subset of DAG with \e epochs
- Opaque callbacks/pipes to generalized endpoints
- Efficient memory pooling for message allocation
- RDMA using MPI one-sided for data transfer
- Asynchronous Collectives across nodes/groups (scatter, async barrier, reduce, ...)
- General scheduler with prioritization
- Built-in interoperability with MPI and threading libraries (Kokkos, OpenMP, ...)
- Object groups for node-level encapsulation
- Virtual contexts for migratable virtualization and dispatch
- Abstractions for multi-dimensional indices, mapping, and linearization
- Virtual collections (dense, sparse, dynamic insertable) for decomposing domains
- Fully distributed load balancer for virtual entities
- Active messaging to type-safe handlers across nodes
- Groups for scalable construction of node subsets
- Optional serialization of messages
- Termination detection across entire or subset of DAG with \e epochs
- Opaque callbacks/pipes to generalized endpoints
- Efficient memory pooling for message allocation
- RDMA using MPI one-sided for data transfer
- Asynchronous Collectives across nodes/groups (scatter, async barrier, reduce, ...)
- General scheduler with prioritization
- Built-in interoperability with MPI and threading libraries (Kokkos, OpenMP, ...)
- Object groups for node-level encapsulation
- Virtual contexts for migratable virtualization and dispatch
- Abstractions for multi-dimensional indices, mapping, and linearization
- Virtual collections (dense, sparse, dynamic insertable) for decomposing domains
- Fully distributed load balancer for virtual entities

\section vt-components Components in vt

Expand Down Expand Up @@ -92,4 +91,4 @@ management.
\note An active message broadcast sends to all nodes except for
the sender (root of the broadcast).
\endparblock
\endparblock
\endparblock

0 comments on commit ac588a7

Please sign in to comment.