Merge branch 'master' into api_num_configurable_edges

Author: behzadmehmood-rs

.github/scripts/install_dependencies.sh

@@ -10,6 +10,7 @@ sudo apt install -y \
   binutils \
   binutils-gold \
   build-essential \
+  capnproto \
   cmake \
   ctags \
   curl \
@@ -20,6 +21,7 @@ sudo apt install -y \
   git \
   gperf \
   libcairo2-dev \
+  libcapnp-dev \
   libgtk-3-dev \
   libevent-dev \
   libfontconfig1-dev \
@@ -54,3 +56,9 @@ sudo apt install -y \
 #  libtbb-dev
 
 pip install -r requirements.txt
+
+git clone https://github.com/capnproto/capnproto-java.git $GITHUB_WORKSPACE/env/capnproto-java
+pushd $GITHUB_WORKSPACE/env/capnproto-java
+make
+sudo make install
+popd

CMakeLists.txt

@@ -40,6 +40,7 @@ option(VTR_ENABLE_CAPNPROTO "Enable capnproto binary serialization support in VP
 #Allow the user to enable/disable VPR analytic placement
 #VPR option --enable_analytic_placer is also required for Analytic Placement
 option(VPR_ANALYTIC_PLACE "Enable analytic placement in VPR." ON)
+option(VPR_ENABLE_INTERCHANGE "Enable FPGA interchange." ON)
 
 option(WITH_BLIFEXPLORER "Enable build with blifexplorer" OFF)
 
@@ -121,6 +122,11 @@ endif()
 # Build type flags
 #
 
+set(EXTRA_FLAGS "")
+if(VPR_ENABLE_INTERCHANGE)
+    set(EXTRA_FLAGS "-lz")
+endif()
+
 if(NOT MSVC)
     # for GCC and Clang
     set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -O0 -g3")
@@ -295,7 +301,7 @@ endif()
 # Set final flags
 #
 separate_arguments(
-    ADDITIONAL_FLAGS UNIX_COMMAND "${SANITIZE_FLAGS} ${PROFILING_FLAGS} ${COVERAGE_FLAGS} ${LOGGING_FLAGS} ${COLORED_COMPILE}"
+    ADDITIONAL_FLAGS UNIX_COMMAND "${SANITIZE_FLAGS} ${PROFILING_FLAGS} ${COVERAGE_FLAGS} ${LOGGING_FLAGS} ${COLORED_COMPILE} ${EXTRA_FLAGS}"
     )
 separate_arguments(
     WARN_FLAGS UNIX_COMMAND "${WARN_FLAGS}"
@@ -366,7 +372,6 @@ if (VPR_USE_EZGL STREQUAL "auto")
     endif()
 endif()
 
-
 #Add the various sub-projects
 if(${WITH_ABC})
     add_subdirectory(abc)

ODIN_II/Makefile

@@ -1,6 +1,18 @@
 ODIN_ROOT=$(PWD)
 NB_OF_PROCESS ?= $(shell /usr/bin/env python3 -c "import multiprocessing; print(multiprocessing.cpu_count())")
 
+# handling elaborator name
+ifdef ELABORATOR
+_ELABORATOR=$(shell echo $(ELABORATOR) | tr '[:lower:]' '[:upper:]')
+else
+_ELABORATOR=ODIN
+endif
+
+# Yosys+Odin-II compile flags
+ifeq ($(_ELABORATOR), YOSYS)
+_YOSYS_COMPILE_FLAG="-DODIN_USE_YOSYS=ON"
+endif
+
 ################
 # build with ninja when doable
 ################
@@ -57,33 +69,29 @@ $(ODIN_BUILD_DIR)/.%.build: _init
 
 _set_build: $(ODIN_BUILD_DIR)/.regular.build
 	cd $(BUILD_DIR) &&\
-	cmake $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) ..
+	cmake $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) $(_YOSYS_COMPILE_FLAG) ..
 
 _set_debug: $(ODIN_BUILD_DIR)/.debug.build 
 	cd $(BUILD_DIR) &&\
-	cmake $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) -DODIN_DEBUG=on ..
+	cmake $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) $(_YOSYS_COMPILE_FLAG) -DODIN_DEBUG=on ..
 
 _set_warn: $(ODIN_BUILD_DIR)/.warn.build
 	cd $(BUILD_DIR) &&\
-	cmake $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) -DODIN_WARN=on ..
+	cmake $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) $(_YOSYS_COMPILE_FLAG) -DODIN_WARN=on ..
 
 _set_gcov: $(ODIN_BUILD_DIR)/.gcov.build
 	cd $(BUILD_DIR) &&\
-	cmake $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) -DODIN_COVERAGE=on ..
+	cmake $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) $(_YOSYS_COMPILE_FLAG) -DODIN_COVERAGE=on ..
 
 _set_clang_tidy: $(ODIN_BUILD_DIR)/.tidy.build
 	cd $(BUILD_DIR) &&\
-	cmake  $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) -DODIN_TIDY=on ..
+	cmake  $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) $(_YOSYS_COMPILE_FLAG) -DODIN_TIDY=on ..
 
 _set_sanitize: $(ODIN_BUILD_DIR)/.sanitize.build
 	cd $(BUILD_DIR) &&\
-	cmake  $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) -DODIN_SANITIZE=on ..
+	cmake  $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) $(_YOSYS_COMPILE_FLAG) -DODIN_SANITIZE=on ..
 
-_set_yosys+odin: $(ODIN_BUILD_DIR)/.yosys+odin.build
-	cd $(BUILD_DIR) &&\
-	cmake  $(CMAKE_GEN_ARGS) $(CMAKE_ARGS) -DODIN_USE_YOSYS=ON ..
-
-BUILD_IT_TARGETS = build debug warn gcov clang_tidy sanitize yosys+odin
+BUILD_IT_TARGETS = build debug warn gcov clang_tidy sanitize
 $(foreach  t,$(BUILD_IT_TARGETS), $(eval $(call _build_it_gen,$(t))))
 
 scrub:
@@ -105,17 +113,27 @@ test_coverage:
 	$(MAKE) gcovr
 
 test:
+ifeq ($(_ELABORATOR), ODIN)
 	$(MAKE) sanitize \
 	&& ./verify_odin.sh --no_report -j $(NB_OF_PROCESS) \
 			-t regression_test/benchmark/suite/light_suite \
 			-t regression_test/benchmark/suite/vtr_light_suite \
 	&& $(MAKE) build \
 	&& ./verify_odin.sh --no_report --continue -j $(NB_OF_PROCESS) \
 		-t regression_test/benchmark/suite/heavy_suite; \
-	./verify_odin.sh --status_only	
-
+	./verify_odin.sh --status_only
+else ifeq ($(_ELABORATOR), YOSYS)
+	$(MAKE) sanitize ELABORATOR=YOSYS \
+	&& ./verify_odin.sh --no_report -j $(NB_OF_PROCESS) \
+			-t regression_test/benchmark/suite/yosys+odin/techmap_lightsuite \
+	&& $(MAKE) build ELABORATOR=YOSYS \
+	&& ./verify_odin.sh --no_report --continue -j $(NB_OF_PROCESS) \
+		-t regression_test/benchmark/suite/yosys+odin/techmap_heavysuite; \
+	./verify_odin.sh --status_only
+endif
 
 generate_expectation:
+ifeq ($(_ELABORATOR), ODIN)
 	$(MAKE) sanitize \
 	&& ./verify_odin.sh --$@ --no_report -j $(NB_OF_PROCESS) \
 			-t regression_test/benchmark/suite/light_suite \
@@ -124,8 +142,18 @@ generate_expectation:
 	&& ./verify_odin.sh --$@ --no_report --continue -j $(NB_OF_PROCESS) \
 		-t regression_test/benchmark/suite/heavy_suite; \
 	./verify_odin.sh --status_only	
+else ifeq ($(_ELABORATOR), YOSYS)
+	$(MAKE) sanitize ELABORATOR=YOSYS \
+	&& ./verify_odin.sh --$@ --no_report -j $(NB_OF_PROCESS) \
+			-t regression_test/benchmark/suite/yosys+odin/techmap_lightsuite \
+	$(MAKE) build ELABORATOR=YOSYS \
+	&& ./verify_odin.sh --$@ --no_report --continue -j $(NB_OF_PROCESS) \
+		-t regression_test/benchmark/suite/yosys+odin/techmap_heavysuite; \
+	./verify_odin.sh --status_only
+endif
 
 regenerate_expectation:
+ifeq ($(_ELABORATOR), ODIN)
 	$(MAKE) sanitize \
 	&& ./verify_odin.sh --$@ --no_report -j $(NB_OF_PROCESS) \
 			-t regression_test/benchmark/suite/light_suite \
@@ -134,3 +162,12 @@ regenerate_expectation:
 	&& ./verify_odin.sh --$@ --no_report --continue -j $(NB_OF_PROCESS) \
 		-t regression_test/benchmark/suite/heavy_suite; \
 	./verify_odin.sh --status_only	
+else ifeq ($(_ELABORATOR), YOSYS)
+	$(MAKE) sanitize ELABORATOR=YOSYS \
+	&& ./verify_odin.sh --$@ --no_report -j $(NB_OF_PROCESS) \
+			-t regression_test/benchmark/suite/yosys+odin/techmap_lightsuite \
+	$(MAKE) build ELABORATOR=YOSYS \
+	&& ./verify_odin.sh --$@ --no_report --continue -j $(NB_OF_PROCESS) \
+		-t regression_test/benchmark/suite/yosys+odin/techmap_heavysuite; \
+	./verify_odin.sh --status_only
+endif

ODIN_II/regression_test/tools/run_yosys.sh

@@ -39,7 +39,7 @@ RED=$'\033[31;1m'
 NC=$'\033[0m' # No Color
 
 # defaults
-_YOSYS_EXEC="yosys"
+_YOSYS_EXEC="${VTR_DIR}/libs/EXTERNAL/libyosys/yosys"
 _TEST_INPUT_LIST=()
 _VERILOG_INPUT_LIST=()
 _REGENERATE_BLIF="off"

ODIN_II/regression_test/tools/synth.tcl

@@ -4,7 +4,7 @@ yosys -import
 # Feel free to specify file paths using "$env(VTR_ROOT)/ ..." 
 
 # Read the hardware decription Verilog
-read_verilog -nomem2reg -nolatches $env(VTR_ROOT)/ODIN_II/regression_test/benchmark/verilog/common/mux.v;
+read_verilog -nomem2reg -nolatches $env(TCL_CIRCUIT);
 # Check that cells match libraries and find top module
 hierarchy -check -auto-top;
 
@@ -20,8 +20,8 @@ memory_collect; memory_dff; opt;
 # Looking for combinatorial loops, wires with multiple drivers and used wires without any driver.
 check;
 # resolve asynchronous dffs
-techmap -map $env(VTR_ROOT)/ODIN_II/techlib/adff2dff.v;
-techmap -map $env(VTR_ROOT)/ODIN_II/techlib/adffe2dff.v;
+techmap -map $env(ODIN_TECHLIB)/adff2dff.v;
+techmap -map $env(ODIN_TECHLIB)/adffe2dff.v;
 # convert mem block to bram/rom
 
 # [NOTE]: Yosys complains about expression width more than 24 bits.
@@ -40,3 +40,5 @@ opt -undriven -full; # -noff #potential option to remove all sdff and etc. Only
 autoname;
 # Print statistics
 stat;
+
+write_blif -param -impltf $env(TCL_BLIF);

dev/subtree_config.xml

@@ -44,4 +44,9 @@
         internal_path="libs/EXTERNAL/libinterchange"
         external_url="https://github.com/chipsalliance/fpga-interchange-schema.git"
         default_external_ref="main"/>
+    <subtree
+        name="libcatch2"
+        internal_path="libs/EXTERNAL/libcatch2"
+        external_url="https://github.com/catchorg/Catch2.git"
+        default_external_ref="devel"/>
 </subtrees>

doc/src/index.rst

@@ -37,6 +37,8 @@ For more specific documentation about VPR see :ref:`vpr`.
    arch/index
    vpr/index
    odin/index
+   yosys+odin/index
+   yosys/index
    abc/index
    tutorials/index
    utils/index

doc/src/odin/dev_guide/contributing.md

@@ -28,14 +28,18 @@ Make changes to that branch.
 Then, create a pull request with that branch and **include WIP in the title.**
 This will automatically indicate that this PR is not ready to be merged.
 Continue to work on the branch, pushing the commits regularly.
-Like a PR, test cases are also needed to be included through the use of benchmarks.
+Like a PR, test cases must be included through the use of benchmarks.
 See [regression tests](./regression_tests) for further instruction.
 
 ### Formating
 
 Odin II shares the same contributing philosophy as [VPR](https://docs.verilogtorouting.org/en/latest/dev/contributing/contributing/).
 Most importantly PRs will be rejected if they do not respect the coding standard: see [VPRs coding standard](https://docs.verilogtorouting.org/en/latest/dev/developing/#code-formatting)
 
+To correct any code formatting issues flagged by the CI system, simply run ``make format`` to adapt the newly added code to VPR's coding standard.
+If you have made alterations to python scripts, you would probably need to run ``make format-py`` and ``./dev/pylint_check.py`` from the VTR root directory to correct the python code formatting and check for lint errors. 
+
+
 ## Odin II's Flow
 
 Odin II functions by systematically executing a set of steps determined by the files and arguments passed in.