Skip to content

README.md

Latest commit

 

History

History
185 lines (143 loc) · 5.36 KB

README.md

File metadata and controls

185 lines (143 loc) · 5.36 KB
Raw

Amoeba

Amoeba is an MLIR project for representing and transforming portable task-level dataflow programs. It owns the Taskflow dialect, generic Taskflow transformations, and the integration layer used to connect Taskflow programs to architecture-specific backends.

Neura is currently the first supported backend and is consumed as a pinned Git submodule. The project is structured so that additional spatial dataflow backends can be integrated without moving architecture-specific concepts into the Taskflow core.

Architecture

Frontend and loop dialects
          |
          v
  Taskflow dialect             portable task abstraction
          |
          v
  Backend integration          backend-specific conversion and optimization
          |
          v
  Neura backend                current multi-CGRA backend

The ownership boundary is:

  • Amoeba core owns the Taskflow dialect and backend-independent passes.
  • Amoeba backend adapters translate and optimize Taskflow for a particular backend.
  • Backend projects own their target dialects, architecture models, lowerings, mapping, and target-specific transformations.

See the Backend integration guide for the detailed layout, the Neura integration path, and instructions for adding another backend.

Repository layout

amoeba/
|-- include/
|   |-- TaskflowDialect/       # Taskflow dialect and pass interfaces
|   |-- Conversion/            # Backend-independent conversion interfaces
|   `-- Backend/               # Public backend integration interfaces
|-- lib/
|   |-- TaskflowDialect/       # Taskflow implementation and generic passes
|   |-- Conversion/            # Backend-independent conversions
|   `-- Backend/               # Backend adapter implementations
|-- thirdparty/
|   `-- neura/                 # Neura Git submodule
|-- tools/
|   `-- mlir-amoeba-opt/       # Amoeba optimizer driver
`-- test/                      # Core, conversion, end-to-end, and backend tests

Prerequisites

Amoeba requires:

  • a C++17 compiler, with clang and clang++ used by the reference build;
  • CMake, Ninja, and Make;
  • ccache and lld for the reference LLVM build;
  • LLVM/MLIR at commit 6146a88f60492b520a36f8f8f3231e15f3cc6082; and
  • Git submodule support.

This is the same LLVM revision used by the current Neura build instructions and Amoeba CI.

Checkout

Clone Amoeba together with its backend dependency:

git clone --recurse-submodules git@github.com:coredac/amoeba.git
cd amoeba

For an existing checkout, initialize or update the pinned Neura revision with:

git submodule update --init --recursive
git submodule status

Build LLVM and MLIR

Clone LLVM, check out the pinned revision, and create an out-of-tree build:

git clone https://github.com/llvm/llvm-project.git
cd llvm-project
git checkout 6146a88f60492b520a36f8f8f3231e15f3cc6082
mkdir build && cd build

cmake -G Ninja ../llvm \
  -DLLVM_ENABLE_PROJECTS="mlir;clang" \
  -DLLVM_BUILD_EXAMPLES=OFF \
  -DLLVM_TARGETS_TO_BUILD="Native" \
  -DCMAKE_BUILD_TYPE=Release \
  -DLLVM_ENABLE_ASSERTIONS=ON \
  -DCMAKE_C_COMPILER=clang \
  -DCMAKE_CXX_COMPILER=clang++ \
  -DCMAKE_CXX_STANDARD=17 \
  -DCMAKE_CXX_FLAGS="-std=c++17 -frtti" \
  -DLLVM_ENABLE_LLD=ON \
  -DMLIR_INSTALL_AGGREGATE_OBJECTS=ON \
  -DLLVM_ENABLE_RTTI=ON \
  -DLLVM_CCACHE_BUILD=ON \
  -DCMAKE_C_COMPILER_LAUNCHER=ccache \
  -DCMAKE_CXX_COMPILER_LAUNCHER=ccache

cmake --build . --parallel 2

The LLVM and MLIR test suites can be checked with:

cmake --build . --target check-mlir
cmake --build . --target check-clang

Build Amoeba

From the Amoeba repository root, create a separate build directory and point CMake to the LLVM/MLIR build above:

mkdir build && cd build

cmake .. \
  -DCMAKE_BUILD_TYPE=Release \
  -DLLVM_DIR=/path/to/llvm-project/build/lib/cmake/llvm \
  -DMLIR_DIR=/path/to/llvm-project/build/lib/cmake/mlir \
  -DMLIR_SOURCE_DIR=/path/to/llvm-project/mlir \
  -DMLIR_BINARY_DIR=/path/to/llvm-project/build

make

The Neura submodule is added with EXCLUDE_FROM_ALL. CMake therefore builds the Neura targets required by Amoeba without treating the standalone Neura tools as part of the default Amoeba build.

Command-line tool

The build produces mlir-amoeba-opt, an mlir-opt-style driver that registers the Taskflow dialect, Amoeba conversions, and all backends enabled in the build:

./build/tools/mlir-amoeba-opt/mlir-amoeba-opt --help

For example, an affine program can be converted to Taskflow with:

./build/tools/mlir-amoeba-opt/mlir-amoeba-opt input.mlir \
  --convert-affine-to-taskflow \
  -o output.mlir

Neura-specific passes and options are registered by the Neura adapter. The architecture and latency options are exposed as --neura-architecture-spec and --neura-latency-spec.

Tests

After building Amoeba, run the complete lit suite from amoeba/build:

cd test
llvm-lit . -v

If llvm-lit is not on PATH, invoke it with the full path instead, for example /path/to/llvm-project/build/bin/llvm-lit . -v.

The suite covers Taskflow conversions and transformations, end-to-end lowering, and integration with the Neura backend.