Merge pull request #1 from verilog-to-routing/master

Update from trunk

Author: tangxifan

.travis/script.sh

@@ -50,3 +50,9 @@ start_section "vtr.test.4" "${GREEN}Testing..${NC} ${CYAN}odin_reg_micro${NC}"
 end_section "vtr.test.4"
 
 $SPACER
+
+start_section "vtr.test.5" "${GREEN}Testing..${NC} ${CYAN}odin_reg_operators${NC}"
+./run_reg_test.pl odin_reg_operators
+end_section "vtr.test.5"
+
+$SPACER

CMakeLists.txt

@@ -23,6 +23,9 @@ option(VTR_ENABLE_COVERAGE "Enable code coverage tracking (gcov)" OFF)
 option(VTR_ENABLE_DEBUG_LOGGING "Enable debug logging" OFF)
 
 option(WITH_BLIFEXPLORER "Enable build with blifexplorer" OFF)
+option(WITH_LIBRTLNUMBER "Enable build with librtlnumber" OFF)
+option(WITH_OLD_ABC "Enable build with old abc" OFF)
+option(ODIN_DEBUG "Enable building oding with extra debug flags" OFF)
 
 set(VTR_VERSION_MAJOR 8)
 set(VTR_VERSION_MINOR 0)
@@ -92,7 +95,9 @@ else()
         "-Wredundant-decls"             #Warn if there are overlapping declarations
         "-Wswitch-default"              #Warn if a switch has no default
         "-Wundef"                       #Warn if #if() preprocessor refers to an undefined directive
+        "-Wunused"                      #Warn about unused variables/parameters
         "-Wunused-variable"             #Warn about variables that are not used
+        "-Wunused-parameter"            #Warn about function parameters which are unused
         "-Wdisabled-optimization"       #Warn when optimizations are skipped (usually due to large/complex code)
         "-Wnoexcept"                    #Warn when functions should be noexcept (i.e. compiler know it doesn't throw)
         "-Woverloaded-virtual"          #Warn when a function declaration overrides a virtual method
@@ -101,7 +106,14 @@ else()
         "-Wduplicated-cond"             #Warn about identical conditions in if-else chains
         "-Wduplicated-branches"         #Warn when different branches of an if-else chain are equivalent
         "-Wnull-dereference"            #Warn about null pointer dereference execution paths
+        "-Wuninitialized"               #Warn about unitialized values
+        "-Winit-self"                   #Warn about self-initialization
+        "-Wcatch-value=3"               #Warn when catch statements don't catch by reference
+        "-Wextra-semi"                  #Warn about redudnant semicolons
         #GCC-like optional
+        #"-Wsuggest-final-types"         #Suggest where 'final' would help if specified on a type methods
+        #"-Wsuggest-final-methods"       #Suggest where 'final' would help if specified on methods
+        #"-Wsuggest-override"            #Suggest where 'override' should be specified
         #"-Wold-style-cast"              #Warn about using c-style casts
         #"-Wconversion"                  #Warn when type conversions may change value
         #"-Wsign-conversion"             #Warn if a conversion may change the sign
@@ -113,6 +125,7 @@ else()
         #"-Wsign-promo"                  #Warn when overload resolution converts an unsigned type to signed when an unsigned overload exists
         #"-Wdouble-promotion"            #Warn when float is implicitly propted to double
         #"-Wuseless-cast"                #Warn about casts to the same type
+        #"-Wzero-as-null-pointer-constant" #Warn about using '0' instead of nullptr
         )
 endif()
 
@@ -155,6 +168,7 @@ if(VTR_ENABLE_SANITIZE)
     # -fuse-ld=gold force the gold linker to be used (required for sanitizers, but not enabled by default on some systems)
     set(SANITIZE_FLAGS "-g -fsanitize=address -fsanitize=leak -fsanitize=undefined -fuse-ld=gold")
     message(STATUS "SANTIIZE_FLAGS: ${SANITIZE_FLAGS}")
+    link_libraries("-static-libasan") #Fixes 'ASan runtime does not come first in initial library list'
 endif()
 
 #
@@ -191,10 +205,23 @@ if(VTR_ENABLE_DEBUG_LOGGING)
     message(STATUS "Logging Flags: ${LOGGING_FLAGS}")
 endif()
 
+if (CMAKE_MAKE_PROGRAM EQUAL "ninja" )
+    #Only for coloured output for ninja, it may be desired
+    #to not force colours with other make programs (e.g. if
+    #being parsed by an IDE).
+    if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
+        set(COLORED_COMPILE "-fdiagnostics-color=always")
+    elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
+        set(COLORED_COMPILE "-fcolor-diagnostics")
+    else()
+        set(COLORED_COMPILE "")
+    endif ()
+endif()
+
 #
 # Set final flags
 #
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARN_FLAGS} ${SANITIZE_FLAGS} ${PROFILING_FLAGS} ${COVERAGE_FLAGS} ${LOGGING_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}")
 
 
@@ -231,9 +258,13 @@ add_subdirectory(vpr)
 add_subdirectory(abc)
 add_subdirectory(ODIN_II)
 add_subdirectory(ace2)
+add_subdirectory(utils)
 if(WITH_BLIFEXPLORER)
     add_subdirectory(blifexplorer)
 endif()
+if(WITH_OLD_ABC)
+	add_subdirectory(abc_with_bb_support)
+endif()
 
 #Add extra compilation flags to suppress warnings from some libraries/tools
 # Note that target_compile_options() *appends* to the current compilation options of
@@ -245,10 +276,20 @@ if(CXX_COMPILER_SUPPORTS_-w)
     target_compile_options(libabc PRIVATE "-w")
     target_compile_options(abc PRIVATE "-w")
 endif()
+if(CXX_COMPILER_SUPPORTS_-w)
+    if(WITH_OLD_ABC)
+    target_compile_options(liboldabc PRIVATE "-w")
+    target_compile_options(oldabc PRIVATE "-w")
+    endif()
+endif()
 
 #Some ABC headers generate warnings, treat them as system headers to suppress warnings
 get_property(ABC_INCLUDE_DIRS TARGET libabc PROPERTY INCLUDE_DIRECTORIES)
 target_include_directories(libabc SYSTEM INTERFACE ${ABC_INCLUDE_DIRS})
+if(WITH_OLD_ABC)
+	get_property(OLD_ABC_INCLUDE_DIRS TARGET liboldabc PROPERTY INCLUDE_DIRECTORIES)
+	target_include_directories(liboldabc SYSTEM INTERFACE ${OLD_ABC_INCLUDE_DIRS})
+endif()
 
 #PugiXml has some deliberate switch fallthrough cases (as indicated by comments), but they
 #are tagged as warnings with g++-7 (the comments don't match g++-7's suppression regexes). 
@@ -306,11 +347,25 @@ set_target_properties(libtatum
     ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/libs/EXTERNAL/libtatum"
     LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/libs/EXTERNAL/libtatum"
     RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/libs/EXTERNAL/libtatum")
+if(WITH_LIBRTLNUMBER)
+    set_target_properties(librtlnumber rtl_number
+        PROPERTIES
+        ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/libs/librtlnumber"
+        LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/libs/librtlnumber"
+        RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/libs/librtlnumber")
+endif()
 set_target_properties(libabc abc 
     PROPERTIES
     ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/abc"
     LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/abc"
     RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/abc")
+if(WITH_OLD_ABC)
+	set_target_properties(liboldabc oldabc
+		PROPERTIES
+		ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/abc_with_bb_support"
+		LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/abc_with_bb_support"
+		RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/abc_with_bb_support")
+endif()
 set_target_properties(libvpr vpr
     PROPERTIES
     ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/vpr"

Makefile

@@ -1,4 +1,4 @@
-#This is a simple wrapper hiding cmake from non-expert end users.
+#This is a simple wrapper which hides cmake (for convenience, and from non-expert end users).
 #
 # It supports the targets:
 #   'make'           - builds everything (all libaries/executables)
@@ -13,21 +13,28 @@
 
 #Default build type
 # Possible values:
-#    release
-#    debug
+#    release_pgo	#Perform a 2-stage build with profile-guided compiler optimization
+#    release		#Build with compiler optimization
+#    debug			#Build with debug info and no compiler optimization
 BUILD_TYPE ?= release
 
+#Convert to lower case for consistency
+BUILD_TYPE := $(shell echo $(BUILD_TYPE) | tr '[:upper:]' '[:lower:]')
+
+#Trim any _pgo in the build type name (since it would not match any of
+#CMake's standard build types)
+CMAKE_BUILD_TYPE := $(shell echo $(BUILD_TYPE) | sed 's/_\?pgo//')
+
 #Allows users to pass parameters to cmake
 #  e.g. make CMAKE_PARAMS="-DVTR_ENABLE_SANITIZE=true"
-override CMAKE_PARAMS := -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -G 'Unix Makefiles' ${CMAKE_PARAMS}
+override CMAKE_PARAMS := -DCMAKE_BUILD_TYPE=$(CMAKE_BUILD_TYPE) -G 'Unix Makefiles' ${CMAKE_PARAMS}
 
 
 # -s : Suppresss makefile output (e.g. entering/leaving directories)
 # --output-sync target : For parallel compilation ensure output for each target is synchronized (make version >= 4.0)
 MAKEFLAGS := -s
 
-BUILD_DIR=./build
-GENERATED_MAKEFILE := $(BUILD_DIR)/Makefile
+BUILD_DIR ?= build
 
 #Check for the cmake exectuable
 CMAKE := $(shell command -v cmake 2> /dev/null)
@@ -38,31 +45,75 @@ export CTEST_OUTPUT_ON_FAILURE=TRUE
 #All targets in this make file are always out of date.
 # This ensures that any make target requests are forwarded to
 # the generated makefile
-.PHONY: all distclean $(GENERATED_MAKEFILE) $(MAKECMDGOALS)
+.PHONY: all distclean $(MAKECMDGOALS)
 
-#Build everything
-all: $(GENERATED_MAKEFILE)
-	@+$(MAKE) -C $(BUILD_DIR)
+#For an 'all' build with BUILD_TYPE containing 'pgo' this will perform a 2-stage compilation
+#with profile guided optimization. 
+#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),distclean)
+ifneq ($(MAKECMDGOALS),clean)
+all $(MAKECMDGOALS):
+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 pgo,$(BUILD_TYPE)))
+	#
+	#Profile Guided Optimization Build
+	#
+	@echo "Performing Profile Guided Optimization (PGO) build..."
+	#
+	#1st-stage build for profile generation
+	#
+	echo "cd $(BUILD_DIR) && $(CMAKE) $(CMAKE_PARAMS) -DVPR_PGO_CONFIG=prof_gen .. "
+	cd $(BUILD_DIR) && $(CMAKE) $(CMAKE_PARAMS) -DVPR_PGO_CONFIG=prof_gen .. 
+	@+$(MAKE) -C $(BUILD_DIR) $(MAKECMDGOALS)
+	#
+	#Run benchmarks to generate profiling data
+	#
+	echo "Generating profile data for PGO (may take several minutes)"
+	#Need titan benchmarks for pgo_profile task
+	@+$(MAKE) -C $(BUILD_DIR) get_titan_benchmarks
+	#Note profiling must be done serially to avoid corrupting the generated profiles
+	./run_reg_test.pl pgo_profile
+	#
+	#Configure 2nd-stage build to use profiling data to guide compiler optimization
+	#
+	echo "cd $(BUILD_DIR) && $(CMAKE) $(CMAKE_PARAMS) -DVPR_PGO_CONFIG=prof_use .. "
+	cd $(BUILD_DIR) && $(CMAKE) $(CMAKE_PARAMS) -DVPR_PGO_CONFIG=prof_use .. 
+else #BUILD_TYPE not containing 'pgo'
+	#
+	#Configure for standard build
+	#
+	@echo "Performing standard build..."
+	echo "cd $(BUILD_DIR) && $(CMAKE) $(CMAKE_PARAMS) .. "
+	cd $(BUILD_DIR) && $(CMAKE) $(CMAKE_PARAMS) .. 
+endif #BUILD_TYPE
+	#
+	#Final build
+	#
+	@echo "Building target(s): $(MAKECMDGOALS)"
+	@+$(MAKE) -C $(BUILD_DIR) $(MAKECMDGOALS)
+endif #clean
+endif #distclean
 
 #Call the generated Makefile's clean, and then remove all cmake generated files
-distclean: $(GENERATED_MAKEFILE)
-	@ echo "Cleaning build..."
-	@+$(MAKE) -C $(BUILD_DIR) clean 
+distclean: clean
 	@ echo "Removing build system files.."
 	@ rm -rf $(BUILD_DIR)
 	@ rm -rf CMakeFiles CMakeCache.txt #In case 'cmake .' was run in the source directory
 
-#Call cmake to generate the main Makefile
-$(GENERATED_MAKEFILE):
+clean:
 ifeq ($(CMAKE),)
 	$(error Required 'cmake' executable not found. On debian/ubuntu try 'sudo apt-get install cmake' to install)
 endif
+	@ echo "Cleaning files.."
+	#We run cmake so we can use the generated Makefile to clean any executables
+	#generated outside the build directory
 	@ mkdir -p $(BUILD_DIR)
 	echo "cd $(BUILD_DIR) && $(CMAKE) $(CMAKE_PARAMS) .. "
 	cd $(BUILD_DIR) && $(CMAKE) $(CMAKE_PARAMS) .. 
+	@+$(MAKE) -C $(BUILD_DIR) clean 
 
-#Forward any targets that are not named 'distclean' to the generated Makefile
-ifneq ($(MAKECMDGOALS),distclean)
-$(MAKECMDGOALS): $(GENERATED_MAKEFILE)
-	@+$(MAKE) -C $(BUILD_DIR) $(MAKECMDGOALS)
-endif

ODIN_II/CMakeLists.txt

@@ -2,6 +2,51 @@ cmake_minimum_required(VERSION 2.8.12)
 
 project("ODIN_II")
 
+#base extra flags for odin
+set(ODIN_EXTRA_FLAGS 
+    ""  # nothing for now
+)
+
+if(ODIN_DEBUG)
+
+    message("*** Compiling with Odin debug flags")
+
+    set(ODIN_REF_FLAGS
+        "-Wchkp"                    # Warn about memory access errors found by Pointer Bounds Checker
+        "-Wreturn-local-addr"       # Warn about returning a pointer/reference to a local or temporary variable.
+        "-Wnonnull"                 # Warn about NULL being passed to argument slots marked as requiring non-NULL
+    )
+
+    set(ODIN_SIGN_FLAGS
+        "-Wsign-compare"            # Warn about signed-unsigned comparisons
+        "-Wsign-conversion"         # Warn about signedness conversion
+        "-Wsign-promo"              # Warn when overload promotes from unsigned to signed
+        "-Wconversion"              # Warn for implicit type conversions that may change a value
+    )
+
+    set(ODIN_LIMITS_FLAGS
+        "-Wshift-count-overflow"    # Warn if shift count >= width of type
+        "-Wshift-count-negative"    # Warn if shift count is negative
+        "-Wstrict-overflow"         # Warn about optimizations that assume that signed overflow is undefined
+        "-Wtype-limits"             # Warn if a comparison is always true or always false due to the limited range of the data type
+    )
+
+    set(ODIN_EXTRA_FLAGS
+        "-g"
+        "-ggdb"
+        "-O0"
+        ""
+        ${ODIN_EXTRA_FLAGS}
+    ##############
+    # comment out the flag set you do not wish to see added below
+    #
+        ${ODIN_REF_FLAGS}
+        ${ODIN_SIGN_FLAGS}
+        ${ODIN_LIMITS_FLAGS}
+    )
+
+endif()
+
 #Flex and Bison are used to generate the parser
 find_package(BISON REQUIRED)
 find_package(FLEX REQUIRED)
@@ -48,17 +93,47 @@ add_library(libodin_ii STATIC
 target_include_directories(libodin_ii PUBLIC ${LIB_INCLUDE_DIRS})
 set_target_properties(libodin_ii PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 
+#################################
+# INCLUDE EXTRA ODIN FLAGS IS EXECUTED HERE
+#
+#  include the flags one at a time in case some are not supported and report the error
+#
+
+foreach(ODIN_FLAG ${ODIN_EXTRA_FLAGS})
 
+    CHECK_CXX_COMPILER_FLAG(${ODIN_FLAG} FLAG_TEST)
+
+    if(FLAG_TEST)
+        message("-- Performing Test CXX_SUPPORT_FLAG${ODIN_FLAG} - Success")
+        target_compile_options(libodin_ii PRIVATE ${ODIN_FLAG})
+    else()
+        message("-- Performing Test CXX_SUPPORT_FLAG${ODIN_FLAG} - Failure")
+    endif()
+
+endforeach()
+
+if(WITH_LIBRTLNUMBER)
+target_link_libraries(libodin_ii
+                        libvtrutil
+                        librtlnumber
+                        libarchfpga
+                        libabc
+                        libargparse
+                        ${CMAKE_DL_LIBS})
+else()
 target_link_libraries(libodin_ii
                         libvtrutil
                         libarchfpga
                         libabc
                         libargparse
                         ${CMAKE_DL_LIBS})
+endif()
 
 #Create the executable
 add_executable(odin_II ${EXEC_SOURCES})
+
 target_link_libraries(odin_II
                         libodin_ii)
 
+
 install(TARGETS odin_II libodin_ii DESTINATION bin)