replica
/
hanchenye-scalehls
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[README] add detailed build & test instruction; update TODOs list

This commit is contained in:
Hanchen Ye 2020-09-15 00:57:44 -05:00
parent 6ca221dfae
commit aa14c60a91
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -3,30 +3,37 @@
This project aims to create a framework that ultimately converts an algorithm written in a high level language into an efficient hardware implementation. With multiple levels of intermediate representations (IRs), MLIR appears to be the ideal tool for exploring ways to optimize the eventual design at various levels of abstraction (e.g. various levels of parallelism). Our framework will be based on MLIR, it will incorporate a backend for high level synthesis (HLS) C/C++ code. However, the key contribution will be our parametrization and optimization of a tremendously large design space.
## Quick Start
This setup assumes that you have built LLVM and MLIR in `$LLVM_BUILD_DIR`. To build and launch the tests, run
This setup assumes that you have built LLVM and MLIR in `$LLVM_BUILD_DIR` and this repository is cloned to `$SCALEHLS_DIR`. To build and launch the tests, run
```sh
mkdir build && cd build
cmake -G Ninja .. -DMLIR_DIR=$LLVM_BUILD_DIR/lib/cmake/mlir -DLLVM_EXTERNAL_LIT=$LLVM_BUILD_DIR/bin/llvm-lit
mkdir $SCALEHLS_DIR/build
cd $SCALEHLS_DIR/build
cmake -G Ninja .. -DMLIR_DIR=$LLVM_BUILD_DIR/lib/cmake/mlir -DLLVM_DIR=$LLVM_BUILD_DIR/build/lib/cmake/llvm -DLLVM_ENABLE_ASSERTIONS=ON -DCMAKE_BUILD_TYPE=DEBUG
cmake --build . --target check-scalehls
export PATH=$SCALEHLS_DIR/build/bin:$PATH
```
After the installation and test successfully completed, you should be able to run
```sh
bin/scalehls-translate -emit-hlscpp ../test/EmitHLSCpp/test_*.mlir
cd $SCALEHLS_DIR
scalehls-opt -convert-to-hlscpp test/Conversion/ConvertToHLSCpp/test_*.mlir
# scalehls-opt -convert-to-hlscpp -hlscpp-pragma-insertion test/Dialect/HLSCpp/test_*.mlir
scalehls-opt -convert-to-hlscpp -hlscpp-pragma-insertion test/EmitHLSCpp/test_*.mlir | scalehls-translate -emit-hlscpp
```
## TODO List
## TODOs List
### scalehls-estimator: EstimateQoR
1. **Tooling initial implementation.**
1. **Research on the estimation methodology;**
2. EstimateQoR and scalehls-estimator implementation.
### scalehls-translate: EmitHLSCpp
1. **Test HLS C++ emitter with some real benchmarks;**
2. **TODOs in EmitHLSCpp.cpp;**
2. TODOs in EmitHLSCpp.cpp;
4. Support memref/tensor cast/view/subview operations;
5. Support atomic/complex/extention -related operations.
### scalehls-opt: PragmaInsertion
### HLSCpp Dialect
1. **TODOs in HLSCpp/Ops.td.**
1. TODOs in HLSCpp/Ops.td.
## References
1. [MLIR Documents](https://mlir.llvm.org)