Merge pull request #75 from Minres/develop

prepare next release

Author: eyck

.gitignore

@@ -5,3 +5,4 @@
 /.project
 /build/
 /.cproject
+/.venv

CMakeLists.txt

@@ -14,6 +14,7 @@ option(SC_WITH_PHASE_CALLBACKS "Whether SystemC is built with simulation phase c
 option(SC_WITH_PHASE_CALLBACK_TRACING "whether SystemC was build with phase callbacks for tracing. It needs to match the SystemC build configuration" OFF)
 set(SCC_ARCHIVE_DIR_MODIFIER "" CACHE STRING "additional directory levels to store static library archives") 
 set(SCC_LIBRARY_DIR_MODIFIER "" CACHE STRING "additional directory levels to store libraries") 
+option(WITH_SCP4SCC "adds SCP compatibility layer for SCC, cannot be used together with a copy of SCP" OFF)
 
 include(Common)
 
@@ -120,7 +121,7 @@ if (ENABLE_CLANG_TIDY)
     endif()
 endif()
 
-find_package(Boost 1.70 REQUIRED COMPONENTS system date_time) # header only libraries must not be added here
+find_package(Boost REQUIRED QUIET COMPONENTS system date_time) # header only libraries must not be added here
 find_package(lz4 QUIET)
 if(NOT ${lz4_FOUND})
     find_package(PkgConfig QUIET)
@@ -182,8 +183,6 @@ if(SystemC_FOUND)
         target_link_libraries(scc INTERFACE ${Boost_datetime_LIBRARY})
     endif()
     target_link_libraries(scc INTERFACE scc-util scc-sysc components interfaces scv-tr)
-    target_link_libraries(scc INTERFACE ${FMT_TARGET} spdlog::spdlog)
-    
     set_target_properties(scc PROPERTIES
         PUBLIC_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/src/scc.h
     )
@@ -196,6 +195,9 @@ if(SystemC_FOUND)
 	                                  $<TARGET_OBJECTS:scv-tr>
 	                                  )
 	    set_target_properties(scc_shared PROPERTIES CXX_VISIBILITY_PRESET hidden)
+		if(TARGET Boost::stacktrace_backtrace)
+		    target_link_libraries(scc_shared PUBLIC Boost::stacktrace_backtrace dl)
+		endif()
 	    add_library(scc::scc_shared ALIAS scc_shared)
 	endif()
     install(TARGETS scc

README.md

@@ -15,9 +15,9 @@ Here is a short list of features.
 
 * Automatic tracer
 
-  The tracer(s) allow to automatically discover signals and sc_variables (see below) and register them with the trace file. If the configurer is being used the tracing can be controlled on an per-instance base 
+  The tracer(s) allow to automatically discover signals and sc_variables (see below) and register them with the trace file. If the configurer is being used the tracing can be controlled on an per-instance base
 
-* Various optimized trace file implementations   
+* Various optimized trace file implementations
   * compressed VCD
   * FST (used by [GTKWave](http://gtkwave.sourceforge.net/) and [Surfer](https://surfer-project.org/))
 
@@ -60,7 +60,7 @@ The full documentation can be found at the [Github pages](https://minres.github.
 Build notes
 =======================================
 
-If SystemC is build using cmake with `SC_WITH_PHASE_CALLBACK_TRACING=ON` (which is the default for SystemC 2.3.4), tracing will not work. Either SystemC is being installed with SC_WITH_PHASE_CALLBACK_TRACING=ON (which is the prefered way as this setting is in sync with the automake configure configuration, see https://github.com/accellera-official/systemc/issues/24) or the SCC is being build using `SC_WITH_PHASE_CALLBACK_TRACING=ON`.
+If SystemC is build using cmake with `SC_WITH_PHASE_CALLBACK_TRACING=ON` (which is the default for SystemC 2.3.4), tracing will not work. Either SystemC is being installed with SC_WITH_PHASE_CALLBACK_TRACING=ON (which is the prefered way as this setting is in sync with the automake configure configuration, see <https://github.com/accellera-official/systemc/issues/24>) or the SCC is being build using `SC_WITH_PHASE_CALLBACK_TRACING=ON`.
 
 Build instructions using conan
 =======================================
@@ -72,11 +72,11 @@ On Linux
 
 The suggested build steps are:
 
-- create a build directory and enter into it
-- execute cmake with applicable options 
-- execute build
-- install build
-- run tests
+* create a build directory and enter into it
+* execute cmake with applicable options
+* execute build
+* install build
+* run tests
 
 For example:
 
@@ -91,6 +91,9 @@ For example:
 
 ```
 
+> **_NOTE:_**  **Do not install SCC in the same installation directory as SystemC.**
+SCC follows the convention of mapping C++ namespaces directly into the directory hierarchy. As many SCC components are related to TLM 2.0, a significant portion of the SCC code resides in the `tlm` namespace, which results in the creation of a `tlm` directory under SCC's `include` folder. The SystemC itself also provides a `tlm` header file (or directory) in its own include path. If SCC and SystemC are installed into the same prefix, this results in a clash to create a directory where a file or another directory already exists—causing installation errors. Install SCC and SystemC into separate directories.
+
 On Windows
 =======================================
 

cmake/FindSLSSystemC.cmake

@@ -16,6 +16,8 @@ This module provides the following imported targets, if found:
   The SystemC Verification library
 ``SystemC::cci``
   The SystemC CCI library
+``SystemC::ftblocks``
+  The SNPS FTBlocks library
 
 Result Variables
 ^^^^^^^^^^^^^^^^
@@ -78,6 +80,12 @@ SET(_CCI_HINTS
   ${_COMMON_HINTS}
   )
 
+SET(_FTB_HINTS
+  $ENV{SNPS_VP_HOME}/IP_common/FT_blocks/include
+  $ENV{SNPS_VP_HOME}/IP_common/FT_blocks/lib/linux.$ENV{SNPS_VP_COMPILER}-64
+  ${_COMMON_HINTS}
+  )
+
 SET(_COMMON_PATHS
   /usr/include/systemc
   /usr/lib
@@ -148,7 +156,7 @@ if(SLSSystemC_FOUND)
   set(SystemC_FOUND True)
   get_filename_component(SNPS_LIB_DIR ${SnpsVP_LIBRARY} DIRECTORY)
   set(SystemC_LIBRARY_DIRS ${SNPS_LIB_DIR})
-  set(SystemC_LIBRARIES sc_main ${SNPS_LIBS})     
+  set(SystemC_LIBRARIES ${SNPS_LIBS})     
   set(SystemC_INCLUDE_DIRS ${TLM_INCLUDE_DIR} ${SystemC_INCLUDE_DIR})
   set(SystemC_DEFINITIONS ${PC_SystemC_CFLAGS_OTHER})
 endif()
@@ -182,9 +190,23 @@ FIND_LIBRARY(SCV_LIBRARY
   PATHS ${_COMMON_PATHS}
 )
 
+FIND_PATH(FTB_INCLUDE_DIR
+  NAMES snps_port_handler.h
+  HINTS ${_FTB_HINTS}
+  PATHS ${_COMMON_PATHS}
+)
+
+FIND_LIBRARY(FTB_LIBRARY
+  NAMES ftblocks
+  HINTS ${_FTB_HINTS}
+  PATHS ${_COMMON_PATHS}
+)
+
 mark_as_advanced(
   SCV_INCLUDE_DIR
   SCV_LIBRARY
+  FTB_INCLUDE_DIR
+  FTB_LIBRARY
 )
 
 find_package_handle_standard_args(SCV
@@ -211,3 +233,27 @@ if(SCV_FOUND AND NOT TARGET SystemC::scv)
   )
 endif()
 
+find_package_handle_standard_args(FTB
+  FOUND_VAR FTB_FOUND
+  REQUIRED_VARS
+    FTB_LIBRARY
+    FTB_INCLUDE_DIR
+  VERSION_VAR 2.0.1
+)
+
+if(FTB_FOUND)
+  set(FTB_LIBRARIES ${FTB_LIBRARY})
+  set(FTB_INCLUDE_DIRS ${FTB_INCLUDE_DIR})
+  set(FTB_DEFINITIONS ${PC_FTB_CFLAGS_OTHER})
+endif()
+
+if(FTB_FOUND AND NOT TARGET SystemC::ftblocks)
+  add_library(SystemC::ftblocks UNKNOWN IMPORTED)
+  
+  set_target_properties(SystemC::ftblocks PROPERTIES
+    IMPORTED_LOCATION "${FTB_LIBRARY}"
+    INTERFACE_COMPILE_OPTIONS "${PC_FTB_CFLAGS_OTHER}"
+    INTERFACE_INCLUDE_DIRECTORIES "${FTB_INCLUDE_DIR}"
+  )
+endif()
+

cmake/SystemCPackage.cmake

@@ -3,8 +3,8 @@ if(NOT SystemC_FOUND)
     if(USE_CWR_SYSTEMC)
         find_package(SLSSystemC REQUIRED)
         set(SystemC_LIBRARIES SystemC::systemc)
-	elseif(USE_VCS_SYSTEMC)
-	    find_package(VCSSystemC REQUIRED)
+    elseif(USE_VCS_SYSTEMC)
+	find_package(VCSSystemC REQUIRED)
         set(SystemC_LIBRARIES SystemC::systemc)
     elseif(USE_NCSC_SYSTEMC)
         find_package(XMSystemC REQUIRED)

cmake/clang-format.cmake

@@ -6,6 +6,7 @@ file(GLOB_RECURSE ALL_SOURCE_FILES ${CLANG_FORMAT_CXX_FILE_EXTENSIONS})
 # Don't include some common build folders
 set(CLANG_FORMAT_EXCLUDE_PATTERNS ${CLANG_FORMAT_EXCLUDE_PATTERNS} "/CMakeFiles/" "cmake")
 
+message(STATUS "Enumerating files for clang-format")
 # get all project files file
 foreach (SOURCE_FILE ${ALL_SOURCE_FILES}) 
     foreach (EXCLUDE_PATTERN ${CLANG_FORMAT_EXCLUDE_PATTERNS})
@@ -15,6 +16,7 @@ foreach (SOURCE_FILE ${ALL_SOURCE_FILES})
         endif () 
     endforeach ()
 endforeach ()
+message(STATUS "Done enumerating files for clang-format")
 
 set(FORMAT_TARGET_NAME format)
 if(NOT CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)