[Infra]: - adding "update_submodules" option to the main VTR makefile

         - adding "vtr-submodules.sh" to github scripts
         - changing Surelog custom target to an external project

Signed-off-by: Seyed Alireza Damghani <sdamghan@unb.ca>

Author: sdamghan

.github/scripts/install_dependencies.sh

@@ -39,6 +39,7 @@ sudo apt install -y \
   valgrind \
   zip \
   qt5-default \
+  default-jdk \
   clang-format-7 \
   g++-7 \
   gcc-7 \

.github/scripts/run-vtr.sh

@@ -13,6 +13,8 @@ if ! { [ $VTR_TEST == "vtr_reg_strong" ] || [ $VTR_TEST == "odin_reg_strong" ] \
 	source $SCRIPT_DIR/vtr-full-setup.sh
 fi
 
+# Update VtR submodules
+source $SCRIPT_DIR/vtr-submodules.sh
 # Build VtR
 source $SCRIPT_DIR/vtr-build.sh
 # Run the reg test.

.github/scripts/vtr-submodules.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+echo
+echo "========================================"
+echo "VtR Submodules Update"
+echo "----------------------------------------"
+
+# Update GitHub submodules of Yosys plugins
+if { [ $VTR_TEST == "vtr_reg_yosys" ] || [ $VTR_TEST == "vtr_reg_yosys_odin" ]; }; then
+	make update_submodules
+fi

Makefile

@@ -59,6 +59,7 @@ export CTEST_OUTPUT_ON_FAILURE=TRUE
 #For a BUILD_TYPE without 'pgo', a single stage (non-pgo) compilation is performed.
 
 #Forward any targets that are not named 'distclean' or 'clean' to the generated Makefile
+ifneq ($(MAKECMDGOALS),update_submodules)
 ifneq ($(MAKECMDGOALS),distclean)
 ifneq ($(MAKECMDGOALS),clean)
 all $(MAKECMDGOALS):
@@ -69,12 +70,6 @@ ifeq ($(CMAKE),)
 	$(error Required 'cmake' executable not found. On debian/ubuntu try 'sudo apt-get install cmake' to install)
 endif
 	@ mkdir -p $(BUILD_DIR)
-
-ifneq (,$(findstring -DYOSYS_SV_UHDM_PLUGIN=ON,$(CMAKE_PARAMS)))
-	@echo "Performing Git Submodule Recursive Update on the VTR Submodules..."
-	git submodule update --init --recursive
-endif
-
 ifneq (,$(findstring pgo,$(BUILD_TYPE)))
 	#
 	#Profile Guided Optimization Build
@@ -114,6 +109,12 @@ endif #BUILD_TYPE
 	@+$(MAKE) -C $(BUILD_DIR) $(MAKECMDGOALS)
 endif #clean
 endif #distclean
+endif #update_submodules
+
+# Update GitHub submodules exist in VTR repository
+update_submodules: 
+	@echo "Performing Git Submodule Recursive Update on the VTR Submodules..."
+	git submodule update --init --recursive
 
 #Call the generated Makefile's clean, and then remove all cmake generated files
 distclean: clean

libs/EXTERNAL/CMakeLists.txt

@@ -1,3 +1,5 @@
+include(ExternalProject)
+
 #Manually synchronized external libraries
 add_subdirectory(libpugixml)
 
@@ -31,39 +33,50 @@ if(${ODIN_USE_YOSYS} OR ${WITH_YOSYS})
         set(YOSYS_DATDIR ${libyosys_BINARY_DIR}/share/yosys)
         # keep record of the yosys-uhdm-plugin-integration path
         set(SURELOG_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/Surelog)
+        set(SURELOG_BINARY_DIR ${SURELOG_SOURCE_DIR}/build)
         set(YOSYS_F4PGA_PLUGINS_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/yosys-f4pga-plugins)
 
-        # building Surelog and UHDM in a custom command to avoid any target conflict with VTR targets
-        add_custom_command( OUTPUT ${libyosys_BINARY_DIR}/bin/surelog ${libyosys_BINARY_DIR}/bin/uhdm-dump ${libyosys_BINARY_DIR}/bin/uhdm-hier  DEPENDS yosys 
-                            # Surelog
-                            COMMAND ${CMAKE_COMMAND} -DCMAKE_BUILD_TYPE=Release
-                                                     -DCMAKE_INSTALL_PREFIX=${libyosys_BINARY_DIR}
-                                                     -DCMAKE_POSITION_INDEPENDENT_CODE=ON 
-                                                     -S ${SURELOG_SOURCE_DIR}
-                                                     -B ${SURELOG_SOURCE_DIR}/build
-                                                     -Wno-deprecated
-                                                     > /dev/null 2>&1
-                            COMMAND ${CMAKE_COMMAND} --build ${SURELOG_SOURCE_DIR}/build
-                                                     -j${CMAKE_BUILD_PARALLEL_LEVEL}
-                                                     > /dev/null 2>&1
-                            COMMAND ${CMAKE_COMMAND} --install ${SURELOG_SOURCE_DIR}/build
-                                                     > /dev/null 2>&1
-                            # UHDM
-                            COMMAND ${MAKE_PROGRAM}  -C ${YOSYS_F4PGA_PLUGINS_SOURCE_DIR}
-                                                     PATH=${libyosys_BINARY_DIR}/bin/:$ENV{PATH}
-                                                     UHDM_INSTALL_DIR=${libyosys_BINARY_DIR}
-                                                     install
-                                                     -j${CMAKE_BUILD_PARALLEL_LEVEL}
-                                                     > /dev/null 2>&1
-
-                            WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
-
-        # create a custom target out of the plugins compilation result
-        add_custom_target(yosys-plugins ALL 
-                          DEPENDS 
-                          ${libyosys_BINARY_DIR}/bin/surelog 
-                          ${libyosys_BINARY_DIR}/bin/uhdm-dump
-                          ${libyosys_BINARY_DIR}/bin/uhdm-hier)
+        ExternalProject_Add(surelog
+            # root directory for Surelog project
+            PREFIX ""
+            
+            # setting source, build and install directories
+            SOURCE_DIR "${SURELOG_SOURCE_DIR}"
+            # BINARY_DIR "${SURELOG_BINARY_DIR}"
+            BUILD_IN_SOURCE ON
+            INSTALL_DIR "${SURELOG_BINARY_DIR}"
+
+            # define Surelog cache values
+            CMAKE_CACHE_DEFAULT_ARGS 
+                "-DCMAKE_BUILD_TYPE:STRING=Release"
+                "-DCMAKE_INSTALL_PREFIX:FILEPATH=${libyosys_BINARY_DIR}"
+                "-DCMAKE_POSITION_INDEPENDENT_CODE:BOOL=ON"
+                "-DCMAKE_WARN_DEPRECATED:BOOL=OFF"
+
+            # redirect logs to a logfile
+            LOG_BUILD ON
+            LOG_UPDATE ON
+            LOG_INSTALL ON
+            LOG_DOWNLOAD ON
+            LOG_CONFIGURE ON
+            LOG_OUTPUT_ON_FAILURE ON
+            
+            # usefull flags
+            EXCLUDE_FROM_ALL ON
+            DEPENDS yosys
+        )
+
+        # building Surelog and UHDM in a custom target to avoid any target conflict with VTR targets
+        add_custom_target(yosys-plugins ALL DEPENDS surelog yosys
+                          # uhdm
+                          COMMAND ${MAKE_PROGRAM}  -C ${YOSYS_F4PGA_PLUGINS_SOURCE_DIR}
+                                                   PATH=${libyosys_BINARY_DIR}/bin/:$ENV{PATH}
+                                                   UHDM_INSTALL_DIR=${libyosys_BINARY_DIR}
+                                                   install
+                                                   -j${CMAKE_BUILD_PARALLEL_LEVEL}
+
+                          WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                          )
     endif()
 
     # In addition to libyosys in the build folder, we copy the libyosys directory