eki-project
diff --git a/‎.gitlab-ci.yml‎
Lines changed: 17 additions & 18 deletions b/‎.gitlab-ci.yml‎
Lines changed: 17 additions & 18 deletions
diff --git a/‎.gitmodules‎
Lines changed: 6 additions & 0 deletions b/‎.gitmodules‎
Lines changed: 6 additions & 0 deletions
diff --git a/‎CMakeLists.txt‎
Lines changed: 5 additions & 11 deletions b/‎CMakeLists.txt‎
Lines changed: 5 additions & 11 deletions
diff --git a/‎README.md‎
Lines changed: 18 additions & 8 deletions b/‎README.md‎
Lines changed: 18 additions & 8 deletions
@@ -16,19 +16,18 @@ workflow:
 
 .load-modules:
   before_script:
-    - ml vis/Graphviz/8.1.0-GCCcore-12.3.0 fpga xilinx/xrt/2.16 devel/Doxygen/1.9.7-GCCcore-12.3.0 compiler/GCC/12.3.0 devel/CMake/3.26.3-GCCcore-12.3.0 devel/Boost/1.82.0-GCC-12.3.0
-    
-build-dependencies:
+    - ml vis/Graphviz/8.1.0-GCCcore-12.3.0 fpga xilinx/xrt/2.16 devel/Doxygen/1.9.8-GCCcore-13.2.0 compiler/GCC/13.3.0 devel/CMake/3.29.3-GCCcore-13.3.0
+init-repo:
   id_tokens:
     CI_JOB_JWT:
       aud: https://git.uni-paderborn.de
   stage: prepare
   variables:
     #SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p normal -t 2:00:00 -N 1 -n 1 --cpus-per-task=128"
-    SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc -t 2:00:00"
+    SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc -t 0:05:00"
   extends: .load-modules
   script:
-    - ./buildDependencies.sh
+    - git submodule update --init --recursive
   artifacts:
     paths:
       - "deps/"
@@ -40,7 +39,7 @@ build-unittests:
       aud: https://git.uni-paderborn.de
   stage: build
   needs:
-    - build-dependencies
+    - init-repo
   variables:
     #SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p normal -t 2:00:00 -N 1 -n 1 --cpus-per-task=128"
     SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc -t 2:00:00"
@@ -60,7 +59,7 @@ build-integrationtests:
       aud: https://git.uni-paderborn.de
   stage: build
   needs:
-    - build-dependencies
+    - init-repo
   variables:
     #SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p normal -t 2:00:00 -N 1 -n 1 --cpus-per-task=128"
     SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc -t 2:00:00"
@@ -85,7 +84,7 @@ build-regressiontests:
       aud: https://git.uni-paderborn.de
   stage: build
   needs:
-    - build-dependencies
+    - init-repo
   variables:
     #SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p normal -t 2:00:00 -N 1 -n 1 --cpus-per-task=128"
     SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc -t 2:00:00"
@@ -122,13 +121,13 @@ run-unittests:
   stage: test
   needs:
     - build-unittests
-    - build-dependencies
+    - init-repo
   variables:
     #SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p normal -t 0:30:00 -N 1 -n 1 --cpus-per-task=2 --mem-per-cpu=2G"
     SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc -t 2:00:00"
   extends: .load-modules
   script:
-    - export LD_LIBRARY_PATH="$(pwd)/deps/finn_boost/stage/lib/boost/:$LD_LIBRARY_PATH"
+    - export LD_LIBRARY_PATH="$(pwd)/build/libs:$LD_LIBRARY_PATH"
     - cd build
     - ctest --output-on-failure --output-junit ctest-results.xml
   artifacts:
@@ -146,12 +145,12 @@ run-integrationtests:
   stage: test
   needs:
     - build-integrationtests
-    - build-dependencies
+    - init-repo
   variables:
     SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc  -t 0:30:00"
   extends: .load-modules
   script:
-    - export LD_LIBRARY_PATH="$(pwd)/deps/finn_boost/stage/lib/boost/:$LD_LIBRARY_PATH"
+    - export LD_LIBRARY_PATH="$(pwd)/build/libs:$LD_LIBRARY_PATH"
     # Reset FPGAs and setup Host Memory Access
     - ml xilinx/u55c/u55c_gen3x16_xdma_3_202210_1
     - xbutil reset -d 0000:c1:00.1
@@ -165,6 +164,7 @@ run-integrationtests:
     # Test Synchronous Inference with Host memory
     - cp ../../example_networks/jet-structure-classification-with-host-mem/* .
     - ./SyncInference
+    - ./AsyncInference
 
     # Reset FPGAs again
     - xbutil reset -d 0000:c1:00.1
@@ -174,8 +174,7 @@ run-integrationtests:
     - cd ../../build-no-host-mem/integrationtest
     - cp ../../example_networks/jet-structure-classification-without-host-mem/* .
     - ./SyncInference
-
-    # TODO: Run regression tests + asynchronous inference
+    - ./AsyncInference
 
 run-regressiontests:
   id_tokens:
@@ -184,13 +183,13 @@ run-regressiontests:
   stage: test
   needs:
     - build-regressiontests
-    - build-dependencies
+    - init-repo
   variables:
     #SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p normal -t 0:30:00 -N 1 -n 1 --cpus-per-task=2 --mem-per-cpu=2G"
-    SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc -t 0:30:00"
+    SCHEDULER_PARAMETERS: "-A hpc-prf-ekiapp -p hacc -t 10:00:00"
   extends: .load-modules
   script:
-    - export LD_LIBRARY_PATH="$(pwd)/deps/finn_boost/stage/lib/boost/:$LD_LIBRARY_PATH"
+    - export LD_LIBRARY_PATH="$(pwd)/build/libs:$LD_LIBRARY_PATH"
     # Reset FPGAs and setup Host Memory Access
     - ml xilinx/u55c/u55c_gen3x16_xdma_3_202210_1
     - xbutil reset -d 0000:c1:00.1
@@ -202,7 +201,7 @@ run-regressiontests:
 
     - cd build/benchmarks
     - cp ../../example_networks/jet-structure-classification-with-host-mem/* .
-    - ../_deps/googlebenchmark-src/tools/compare.py -a -d results.json benchmarks ../../benchmarks/expectedPerformance.json ./SynchronousInferenceBenchmark | tee benchmark_output.txt
+    - ../_deps/googlebenchmark-src/tools/compare.py -a -d results.json benchmarks ../../benchmarks/expectedPerformance.json ./RegressionTest | tee benchmark_output.txt
     # Extract the OVERALL_GEOMEAN p-value and check if it exceeds the threshold
     - THRESHOLD=0.05
     - GEOMEAN=$(grep "OVERALL_GEOMEAN" benchmark_output.txt)
 
@@ -10,3 +10,9 @@
 [submodule "external/xsimd"]
 	path = external/xsimd
 	url = https://github.com/xtensor-stack/xsimd.git
+[submodule "external/popl"]
+	path = external/popl
+	url = https://github.com/badaix/popl.git
+[submodule "external/plog"]
+	path = external/plog
+	url = https://github.com/SergiusTheBest/plog.git
@@ -44,7 +44,6 @@ set(BENCHMARK_ENABLE_TESTING OFF)
 include(cmake/CheckSubmodules.cmake)
 
 # Doxygen
-
 if (CMAKE_BUILD_TYPE STREQUAL "Release")
 option(FINN_BUILD_DOC "Build documentation" ON)
 else()
@@ -72,14 +71,6 @@ endif()
 
 #INCLUDES
 
-#Set Boost policies for compatibility
-if(POLICY CMP0167)
-  cmake_policy(SET CMP0167 OLD)
-endif()
-if(POLICY CMP0144)
-  cmake_policy(SET CMP0144 NEW)
-endif()
-
 #Threads
 set(THREADS_PREFER_PTHREAD_FLAG ON)
 find_package(Threads REQUIRED)
@@ -92,8 +83,11 @@ find_package(XRT REQUIRED)
 #OpenMP
 find_package(OpenMP REQUIRED)
 
-#Boost
-find_package(Boost 1.79.0 COMPONENTS system log log_setup program_options filesystem ${BOOST_THREAD} REQUIRED)
+#popl
+include_directories(SYSTEM external/popl/include)
+
+#plog
+include_directories(SYSTEM external/plog/include)
 
 #xsimd
 add_subdirectory(external/xsimd)
 
@@ -19,9 +19,20 @@ FINN+ on the other hand will configure and build the driver for you completely a
 
 ### Using the driver
 
+You can either use the driver as a standalone executable or as a library. For the use of the C++ driver as a library, please have a look at the section for [library use](#using-the-driver-as-a-library).
+If you just want to use the C++ driver for FINN as an alternative for the default PYNQ driver, it is now possible to directly generate the C++ driver and all of its configutation files from [FINN](https://github.com/Xilinx/finn) and [FINN+](https://github.com/eki-project/finn-plus)!
+
+Just select `build_cfg.DataflowOutputType.CPP_DRIVER` instead of `build_cfg.DataflowOutputType.PYNQ_DRIVER` in your build script in `generate_outputs`.
+
+FINN will then generate all config files for you. For FINN it is then necessary to build the driver yourself. See section [Building the Driver](#building-the-driver).
+
+FINN+ on the other hand will configure and build the driver for you completely automatically. We would therefore recommend using FINN+ instead of standard FINN.
+
+### Using the driver
+
 You can either use the driver as a standalone executable or as a library. For the use of the C++ driver as a library, please have a look at the section for [library use](#using-the-driver-as-a-library).
 
-If you ever need help on which arguments the driver requires, simply use the ```--help``` flag on the driver.
+If you ever need help on which arguments the driver requires, simply use the ```--help``` flag on the driver. The executable for the driver is, by default, located in the `build/bin` folder after compiling the driver.
 
 The following options are supported by the C++ driver executable to match the PYNQ driver:
 
@@ -37,7 +48,7 @@ Options:
   --check                              Outputs the compile time configuration
 ```
 
-If the execution of the C++ driver fails due to missing libraries such as `libfinnc_core.so`, it might be necessary to set the `LD_LIBRARY_PATH` environment variable:
+If the execution of the C++ driver fails due to missing libraries such as `libfinn_core.so`, it might be necessary to set the `LD_LIBRARY_PATH` environment variable:
 
 ```bash
 export LD_LIBRARY_PATH="$(pwd)/build/libs:$LD_LIBRARY_PATH"
@@ -51,7 +62,6 @@ export LD_LIBRARY_PATH="$(pwd)/build/libs:$LD_LIBRARY_PATH"
 
 * Install XRT Runtime and development packages. You can find them here: [Download](https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/alveo/u280.html)
 * If you use a non default install directory for XRT (default: ```/opt/xilinx/xrt```) set the XRT env var to your XRT development package installation ```export XILINX_XRT=<path>```.
-* Additionally, an installation of boost>=1.79.0 is required. You can install it on debian based sytems using `sudo apt install libboost-all-dev`
 
 **General information for building and using the C++ driver**:
 
@@ -72,7 +82,7 @@ It is assumed, that you used FINN and now want to build the generated driver. Co
 Building the driver is as easy as running:
 
 ```bash
-./buildDependencies.sh
+git submodule update --init --recursive
 mkdir build && cd build
 cmake -DCMAKE_BUILD_TYPE=Release -DFINN_ENABLE_SANITIZERS=OFF -DFINN_HEADER_LOCATION=../AcceleratorDatatypes.h -DFINN_USE_HOST_MEM=OFF ..
 make -j $(nprocs)
@@ -107,7 +117,7 @@ If left undefined, the path will be ```../../src/config/exampleConfig.json``` (a
 You will first have to load a few dependencies before being able to build the project:
 
 ```bash
-ml compiler/GCCcore/11.3.0 compiler/GCC/11.3.0 lib/pybind11/2.9.2-GCCcore-11.3.0 devel/Boost/1.79.0-GCC-11.3.0 lib/fmt/9.1.0-GCCcore-11.3.0
+ml compiler/GCCcore/11.3.0 compiler/GCC/11.3.0 lib/pybind11/2.9.2-GCCcore-11.3.0 lib/fmt/9.1.0-GCCcore-11.3.0
 ml devel Autoconf/2.71-GCCcore-11.3.0
 ml lang Bison/3.8.2-GCCcore-11.3.0 flex/2.6.4-GCCcore-11.3.0
 ml fpga xilinx/xrt/2.14
@@ -123,7 +133,7 @@ To execute the driver on the boards, write a job script. The job script should l
 #SBATCH -o cpp-finn_out_%j.out
 #SBATCH --constraint=xilinx_u280_xrt2.14
 
-ml compiler/GCCcore/11.3.0 compiler/GCC/11.3.0 lib/pybind11/2.9.2-GCCcore-11.3.0 devel/Boost/1.79.0-GCC-11.3.0 lib/fmt/9.1.0-GCCcore-11.3.0
+ml compiler/GCCcore/11.3.0 compiler/GCC/11.3.0 lib/pybind11/2.9.2-GCCcore-11.3.0 lib/fmt/9.1.0-GCCcore-11.3.0
 ml devel Autoconf/2.71-GCCcore-11.3.0
 ml lang Bison/3.8.2-GCCcore-11.3.0 flex/2.6.4-GCCcore-11.3.0
 ml fpga xilinx/xrt/2.14
@@ -148,8 +158,8 @@ add_subdirectory(external/finn-cpp-driver)
 #Link an example application against the finn driver
 add_executable(example example.cpp)
 target_include_directories(example SYSTEM PRIVATE ${XRT_INCLUDE_DIRS} ${FINN_SRC_DIR})
-target_link_directories(example PRIVATE ${XRT_LIB_CORE_LOCATION} ${XRT_LIB_OCL_LOCATION} ${BOOST_LIBRARYDIR})
-target_link_libraries(example PRIVATE finnc_core finnc_options Threads::Threads OpenCL xrt_coreutil uuid finnc_utils finn_config ${Boost_LIBRARIES} nlohmann_json::nlohmann_json OpenMP::OpenMP_CXX)
+target_link_directories(example PRIVATE ${XRT_LIB_CORE_LOCATION} ${XRT_LIB_OCL_LOCATION})
+target_link_libraries(example PRIVATE finnc_core finnc_options Threads::Threads OpenCL xrt_coreutil uuid finnc_utils finn_config nlohmann_json::nlohmann_json OpenMP::OpenMP_CXX)
 ```
 
 ### Known Issues