circt-hls
What is this?: A collection of repositories used to realise various end-to-end high-level synthesis (HLS) flows centering around the CIRCT project.
The fud driver within Calyx is used as a general driver for the entire flow.
HLS flows
These are the (intended) end-to-end flows that can be run from this directory:
- C
- Polygeist
- CIRCT
- Staticlogic (Statically scheduled HLS)
- Calyx
- Calyx native compiler (not circt)
- Verilog
- Calyx native compiler (not circt)
- Calyx
- Handshake (dynamically scheduled HLS)
- FIRRTL
- HW
- Verilog
- HW
- FIRRTL
- Staticlogic (Statically scheduled HLS)
- CIRCT
- Vivado ("Classical" HLS)
- Verilog
- Polygeist
Setup
Build CIRCT
If you don't already have a CIRCT/MLIR build locally, checkout https://github.com/llvm/circt and go follow the instructions.
Build Polygeist
We'll build Polygeist using our existing MLIR/LLVM/Clang build.
NOTE: modify these paths to point to your own CIRCT/MLIR builds.
cd Polygeist
mkdir build
cd build
cmake -G Ninja .. \
-DMLIR_DIR=$PWD/../circt/llvm-project/build/lib/cmake/mlir \
-DCLANG_DIR=$PWD/../circt/llvm-project/build/lib/cmake/clang \
-DLLVM_TARGETS_TO_BUILD="host" \
-DLLVM_ENABLE_ASSERTIONS=ON \
-DCMAKE_BUILD_TYPE=DEBUG
ninja
ninja check-mlir-clang
Build Calyx
Note: skip this step if you already have a Calyx build available.
building the rust compiler:
cd calyx
cargo build
building the Calyx driver:
Install Flit:
pip3 install flit
Install fud:
cd calyx
flit -f fud/pyproject.toml install -s
Configure fud:
cd calyx
fud config global.futil_directory $(pwd)/target/debug/futil
Check the fud configuration:
fud check
If anything relevant is missing, make sure you have the corresponding application installed and available in your path.
Setting up the HLS fud stages
Setup Polygeist/MLIR/CIRCT stages:
NOTE: modify these paths to point to your own CIRCT/MLIR builds.
fud register polygeist -p $(pwd)/stages/Polygeist/stage.py
fud config external-stages.polygeist.exec $(pwd)/Polygeist/build/mlir-clang/mlir-clang
fud register circt -p $(pwd)/stages/CIRCT/stage.py
fud config external-stages.circt.bin_dir $(pwd)/../circt/build/bin
fud register mlir -p $(pwd)/stages/MLIR/stage.py
fud config external-stages.mlir.bin_dir $(pwd)/../circt/llvm/build/bin
We use the setting
fud config stages.circt_hls.toplevel ${toplevel}
to keep track of the top-level function to be compiled. This should match a function name in the input .c file. This will further be used as the top-level function when lowering SCFToCalyx.
To initialize this, please run:
fud config stages.circt_hls.toplevel ""
finally, run fud config to ensure that the variables were written correctly.
Usage
The following lists example commands for exercising the available flows. If you're interested about the specific passes that are getting executed through fud, add --verbose to the command line.
Statically scheduled
- Polygeist to mlir (scf)
fud exec "Polygeist/mlir-clang/Test/aff.c" \
--from c \
--to mlir-scf \
-s circt_hls.toplevel "kernel_deriche"
- Polygeist to mlir (calyx)
Error: need to lower for-to-while loops (still waiting for https://reviews.llvm.org/D108454).
fud exec "Polygeist/mlir-clang/Test/aff.c" \
--from c \
--to mlir-calyx \
-s circt_hls.toplevel "kernel_deriche"
- Polygeist to calyx
Error: invalid lowering of comb groups
fud exec "Polygeist/mlir-clang/Test/aff.c" \
--from c \
--to futil \
-s circt_hls.toplevel "kernel_deriche"
Dynamically scheduled
- Polygeist to mlir (handshake)
Error: issues in lowering the memref.alloc ops in standard to handshake. I think this goes back to what https://github.com/llvm/circt/pull/1538 is trying to solve.
fud exec "examples/c/fir/fir.c" \
--from c \
--to mlir-handshake \
-s circt_hls.toplevel fir
- Polygeist to mlir (FIRRTL)
error: issues in FIRRTL with unbounded memories
fud exec "examples/c/fir/fir.c" \
--from c \
--to mlir-firrtl \
-s circt_hls.toplevel fir
Vivado
...
12 Mar 23, 2022
8 May 23, 2022
27 Jan 4, 2023
1 Oct 14, 2022
76 Jan 7, 2023
7 Mar 5, 2022
1 Jul 11, 2022
14 Nov 25, 2022
1 Dec 16, 2021
6 Jun 25, 2022
20 Dec 13, 2022
13 Dec 15, 2022
42 Dec 29, 2022
2 Nov 21, 2022
1 Nov 27, 2021
15 Oct 14, 2022
1 Dec 11, 2021
5 Jan 3, 2022
9 Mar 12, 2022