Merge remote-tracking branch 'origin' into two_stage_routing

Author: mustafabbas

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required configuration file version
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: htmldir
+  configuration: doc/src/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 2
+  install:
+    - requirements: doc/requirements.txt

.travis.yml

@@ -39,6 +39,7 @@ addons:
     - libxml++2.6-dev
     - perl
     - python
+    - python-lxml
     - texinfo
     - time
     - valgrind
@@ -75,8 +76,6 @@ stages:
   #   if: type != cron
   - name: Test
     if: type != cron
-  - name: Build Compatibility
-    if: type != cron
   - name: Build Coverity
     if: type = cron
 
@@ -104,67 +103,68 @@ jobs:
       name: "Basic Regression Tests"
       script:
         - ./.github/travis/build.sh
-        - ./run_reg_test.pl vtr_reg_basic -j2
+        - ./run_reg_test.pl vtr_reg_basic -show_failures -j2
     - stage: Test
       name: "Strong Regression Tests"
       script:
         - ./.github/travis/build.sh
-        - travis_wait 30 ./run_reg_test.pl vtr_reg_strong -j2
+        - travis_wait 30 ./run_reg_test.pl vtr_reg_strong -show_failures -j2
     - stage: Test
       name: "Basic Valgrind Memory Tests"
       script:
         - ./.github/travis/build.sh
-        - ./run_reg_test.pl vtr_reg_valgrind_small -j2
+        - ./run_reg_test.pl vtr_reg_valgrind_small -show_failures -j2
     - stage: Test
       name: "ODIN-II Micro Tests"
       script:
         - ./.github/travis/build.sh
-        - ./run_reg_test.pl odin_reg_micro -j2
+        - ./run_reg_test.pl odin_reg_micro -show_failures -j2
 
-    - stage: Build Compatibility
-      name: "GCC 5 (Ubuntu Xenial - 16.04)"
+    - stage: Test
+      name: "Build Compatibility: GCC 5 (Ubuntu Xenial - 16.04)"
       env:
         - MATRIX_EVAL="CC=gcc-5 && CXX=g++-5"
         - BUILD_TYPE=release_strict
       script:
         - ./.github/travis/build.sh
-    - stage: Build Compatibility
-      name: "GCC 6 (Debian Stretch)"
+    - stage: Test
+      name: "Build Compatibility: GCC 6 (Debian Stretch)"
       env:
         - MATRIX_EVAL="CC=gcc-6 && CXX=g++-6"
         - BUILD_TYPE=release_strict
       script:
         - ./.github/travis/build.sh
-    - stage: Build Compatibility
-      name: "GCC 7 (Ubuntu Bionic - 18.04)"
+    - stage: Test
+      name: "Build Compatibility: GCC 7 (Ubuntu Bionic - 18.04)"
       env:
          - MATRIX_EVAL="CC=gcc-7 && CXX=g++-7"
       script:
         - ./.github/travis/build.sh
-    - stage: Build Compatibility
-      name: "GCC 8 (Ubuntu Latest)"
+    - stage: Test
+      name: "Build Compatibility: GCC 8 (Ubuntu Latest)"
       env:
          - MATRIX_EVAL="CC=gcc-8 && CXX=g++-8"
       script:
         - ./.github/travis/build.sh
-    - stage: Build Compatibility
-      name: "GCC 9 (Latest Release)"
+    - stage: Test
+      name: "Build Compatibility: GCC 9 (Latest Release)"
       env:
          - MATRIX_EVAL="CC=gcc-9 && CXX=g++-9"
       script:
         - ./.github/travis/build.sh
-    - stage: Build Compatibility
-      name: "clang-6.0 (Debian + Ubuntu common)"
+    - stage: Test
+      name: "Build Compatibility: Clang 6 (Debian + Ubuntu common)"
       env:
          - MATRIX_EVAL="CC=clang-6.0 && CXX=clang++-6.0"
       script:
         - ./.github/travis/build.sh
-    - stage: Build Compatibility
-      name: "clang-8 (Latest Release)"
+    - stage: Test
+      name: "Build Compatibility: Clang 8 (Latest Release)"
       env:
          - MATRIX_EVAL="CC=clang-8 && CXX=clang++-8"
       script:
         - ./.github/travis/build.sh
+
     - stage: Build Coverity
       name: "Coverity Scan"
       env:

BUILDING.md

@@ -66,6 +66,7 @@ apt-get install \
 	libfontconfig1-dev \
 	libx11-dev \
 	libxft-dev \
+	libgtk-3-dev \
 	perl \
 	liblist-moreutils-perl \
 	python \

CMakeLists.txt

@@ -5,6 +5,13 @@ include(SupportCcache)
 
 project("VTR")
 
+#
+# VTR Build Options
+#
+set(VTR_COMPILE_OPTIONS "none" CACHE STRING "Specify whether vpr uses strict compiling options, e.g. -Werror")
+set(CACHE VTR_COMPILE_OPTIONS PROPERTY STRING strict none)
+
+
 if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
     message("CMAKE_SOURCE_DIR: ${CMAKE_SOURCE_DIR}")
     message("CMAKE_BINARY_DIR: ${CMAKE_BINARY_DIR}")
@@ -31,6 +38,7 @@ option(VTR_ENABLE_DEBUG_LOGGING "Enable debug logging" OFF)
 #Allow the user to decide weather to compile the graphics library
 set(VPR_USE_EZGL "auto" CACHE STRING "Specify whether vpr uses the graphics library")
 set_property(CACHE VPR_USE_EZGL PROPERTY STRINGS auto off on)
+option(VTR_ENABLE_CAPNPROTO "Enable capnproto binary serialization support in VPR." ON)
 
 option(WITH_BLIFEXPLORER "Enable build with blifexplorer" OFF)
 option(WITH_LIBRTLNUMBER "Enable build with librtlnumber" OFF)
@@ -196,7 +204,7 @@ endforeach()
 
 #Suppress IPO link warnings
 set(IPO_LINK_WARN_SUPRESS_FLAGS " ")
-set(IPO_LINK_WARN_SUPRESS_FLAGS_TO_CHECK 
+set(IPO_LINK_WARN_SUPRESS_FLAGS_TO_CHECK
     "-Wno-null-dereference"
     )
 foreach(flag ${IPO_LINK_WARN_SUPRESS_FLAGS_TO_CHECK})
@@ -269,8 +277,13 @@ endif()
 #
 # Set final flags
 #
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARN_FLAGS} ${SANITIZE_FLAGS} ${PROFILING_FLAGS} ${COVERAGE_FLAGS} ${LOGGING_FLAGS} ${COLORED_COMPILE}")
-message(STATUS "CMAKE_CXX_FLAGS: ${CMAKE_CXX_FLAGS}")
+separate_arguments(
+    ADDITIONAL_FLAGS UNIX_COMMAND "${SANITIZE_FLAGS} ${PROFILING_FLAGS} ${COVERAGE_FLAGS} ${LOGGING_FLAGS} ${COLORED_COMPILE}"
+    )
+add_compile_options(${ADDITIONAL_FLAGS})
+separate_arguments(
+    WARN_FLAGS UNIX_COMMAND "${WARN_FLAGS}"
+    )
 
 
 #
@@ -301,9 +314,9 @@ enable_testing()
 set(READLINE_FOUND FALSE)
 
 
-# set VPR_USE_EZGL in the root of VTR to decide whether to add 
-# subdirectory of graphics library, which prevents users 
-# without gtk/x11 libraries installed to build. VPR_USE_EZGL is 
+# set VPR_USE_EZGL in the root of VTR to decide whether to add
+# subdirectory of graphics library, which prevents users
+# without gtk/x11 libraries installed to build. VPR_USE_EZGL is
 # being used in both the vpr CMakeLists and libs/EXTERNAL CMakeLists.
 #
 # check if GTK and X11 are installed and turn on/off graphics
@@ -314,16 +327,21 @@ if (VPR_USE_EZGL STREQUAL "auto")
 
     if(GTK3_FOUND AND X11_FOUND)
         set(VPR_USE_EZGL "on")
+        message(STATUS "VPR Graphics: Enabled")
     else()
         set(VPR_USE_EZGL "off")
+        message(STATUS "VPR Graphics: Disabled (required libraries missing, on debia/ubuntu try: sudo apt install libgtk-3 libx11-dev")
     endif()
 endif()
 
 
 #Add the various sub-projects
-add_subdirectory(libs)
-add_subdirectory(vpr)
 add_subdirectory(abc)
+add_subdirectory(libs) #libs/CMakeLists.txt handles adding warnings flags to non-external libraries
+
+#Add the various tools
+add_compile_options(${WARN_FLAGS}) #Add warn flags for VTR tools
+add_subdirectory(vpr)
 add_subdirectory(ODIN_II)
 add_subdirectory(ace2)
 add_subdirectory(utils)

Makefile

@@ -33,7 +33,7 @@ override CMAKE_PARAMS := -DCMAKE_BUILD_TYPE=$(CMAKE_BUILD_TYPE) -G 'Unix Makefil
 #Are we doing a strict (i.e. warnings as errors) build?
 ifneq (,$(findstring strict,$(BUILD_TYPE)))
 	#Configure for strict build with VPR warning treated as errors
-override CMAKE_PARAMS := -DVPR_COMPILE_OPTIONS=strict ${CMAKE_PARAMS}
+override CMAKE_PARAMS := -DVTR_COMPILE_OPTIONS=strict ${CMAKE_PARAMS}
 endif #Strict build type
 
 # -s : Suppresss makefile output (e.g. entering/leaving directories)

ODIN_II/CMakeLists.txt

@@ -79,7 +79,7 @@ file(GLOB_RECURSE PARSER_SOURCES SRC/*.y)
 
 #Make the flex and bison targets
 flex_target(VerilogLexer ${LEXER_SOURCES} ${CMAKE_CURRENT_BINARY_DIR}/verilog_flex.c)
-bison_target(VerilogParser ${PARSER_SOURCES} ${CMAKE_CURRENT_BINARY_DIR}/verilog_bison.c)
+bison_target(VerilogParser ${PARSER_SOURCES} ${CMAKE_CURRENT_BINARY_DIR}/verilog_bison.c COMPILE_FLAGS "--verbose")
 add_flex_bison_dependency(VerilogLexer VerilogParser)
 
 #Get the include directories for the generated headers
@@ -112,7 +112,7 @@ add_library(libodin_ii STATIC
              ${LIB_HEADERS_H}
              ${LIB_HEADERS_HPP}
              ${LIB_SOURCES}
-             ${FLEX_VerilogLexer_OUTPUTS} 
+             ${FLEX_VerilogLexer_OUTPUTS}
              ${BISON_VerilogParser_OUTPUT_SOURCE})
 
 target_include_directories(libodin_ii PUBLIC ${LIB_INCLUDE_DIRS})
@@ -164,4 +164,19 @@ if (ODIN_USES_IPO)
     set_target_properties(odin_II PROPERTIES LINK_FLAGS ${IPO_LINK_WARN_SUPRESS_FLAGS})
 endif()
 
+set(ODIN_COMPILE_OPTIONS_FLAGS
+    #GCC-like
+    "-Werror"
+    )
+
+#add strict odin compiler flags, if set
+if(VTR_COMPILE_OPTIONS STREQUAL "strict")
+    message(STATUS "ODIN_II: building with strict flags")
+    foreach(ODIN_FLAG ${ODIN_COMPILE_OPTIONS_FLAGS})
+        message(STATUS "\tAdding CXX flag: ${ODIN_FLAG}")
+        target_compile_options(libodin_ii PRIVATE ${ODIN_FLAG})
+        target_compile_options(odin_II PRIVATE ${ODIN_FLAG})
+    endforeach()
+endif()
+
 install(TARGETS odin_II libodin_ii DESTINATION bin)

ODIN_II/Makefile

@@ -1,5 +1,5 @@
 ODIN_ROOT=$(PWD)
-NB_OF_PROCESS ?= $(shell nproc --all)
+NB_OF_PROCESS ?= $(shell python -c "import multiprocessing; print(multiprocessing.cpu_count())")
 
 ################
 # build with ninja when doable
@@ -47,6 +47,7 @@ clean:
 define _build_it_gen
 _build_it_$(1): _set_$(1)
 	cd $(BUILD_DIR) &&\
+	echo "Building with $(NB_OF_PROCESS) threads" &&\
 	$(BUILDER)
 
 $(1): _build_it_$(1)