Initial commit

CMakeLists.txt

@@ -0,0 +1,54 @@
+cmake_minimum_required(VERSION 2.8)
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/../cmake) # main (top) cmake dir
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # project specific cmake dir
+set(CMAKE_CXX_STANDARD 14) # tODO move up to a general cmake config for all sub projects ?
+
+# CMake useful variables
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib") 
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib")
+
+# Set the name of your project here
+project("iss")
+
+# Set the version number of your project here (format is MAJOR.MINOR.PATCHLEVEL - e.g. 1.0.0)
+set(VERSION_MAJOR "0")
+set(VERSION_MINOR "0")
+set(VERSION_PATCH "1")
+set(VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH})
+
+include(Common)
+
+## Git (and its revision)
+find_package(Git QUIET) # if we don't find git or FindGit.cmake is not on the system we ignore it.
+## The Git module will trigger a reconfiguration for each pull that will bring a new revision on the local repository
+set (VCS_REVISION "-1")
+if(GIT_FOUND)
+    include(GetGitRevisionDescription)
+    get_git_head_revision(GIT_REFSPEC GIT_SHA1)
+    message(STATUS "GIT branch ${GIT_REFSPEC}")
+    message(STATUS "GIT revision ${GIT_SHA1}")
+    set (VCS_REVISION ${GIT_SHA1})
+endif()
+
+if(DEFINED ENV{LLVM_HOME})
+find_path (LLVM_DIR LLVM-Config.cmake $ENV{LLVM_HOME}/lib/cmake/llvm)
+message(STATUS "LLVM_DIR = ${LLVM_DIR}")
+endif(DEFINED ENV{LLVM_HOME})
+
+find_package(LLVM REQUIRED CONFIG)
+message(STATUS "Found LLVM ${LLVM_PACKAGE_VERSION}")
+message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
+
+# This sets the include directory for the reference project. This is the -I flag in gcc.
+include_directories(
+    ${PROJECT_SOURCE_DIR}/incl
+    ${PROJECT_SOURCE_DIR}/../external/easyloggingpp/src
+    ${LLVM_INCLUDE_DIRS}
+)
+
+add_dependent_header(util)
+
+add_definitions(${LLVM_DEFINITIONS})
+
+add_subdirectory(src)

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2016, MINRES Technologies GmbH
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,42 @@
+# JIT-ISS
+A versatile Just-in-time (JIT) compiling instruction set simulator (ISS)
+
+**JIT-ISS README**
+
+This is currently a proof of concept and work in progress, so use at your own risk. It is currently set-up as an Eclipse CDT project and based on LLVM. To build it you need latest LLVM and Eclipse CDT version 4.6 aka Neon.
+
+To build with SystemC the define WITH_SYSTEMC needs to be set. Then a simple proof-of-concept system is created. Mainly missing are platform peripherals and interrupt handling. It reaches about 5 MIPS in lock-step mode on a MacBook Pro (Core i7-4870HQ@2.5GHz) running in a Docker container.
+
+JIT-ISS uses libGIS (https://github.com/vsergeev/libGIS) as well as ELFIO (http://elfio.sourceforge.net/), both under MIT license 
+
+**What's missing**
+
+* only AVR instruction set implemented but not verified
+
+**Planned features**
+
+* add platform peripherals
+  * timers
+  * gpio
+  * ext interrupt registers and functionality
+* and more
+
+**Quick start**
+
+* you need to have a decent compiler, make and cmake installed
+* install LLVM 3.9 or 4.0 according to http://apt.llvm.org/
+* download and install SystemC from http://accellera.org/downloads/standards/systemc
+  * optionally download and install SystemC Verification Library (SCV) from Accelera into the same location
+* checkout source from git
+* start an out-of-source build like so (e.g. when using LLVM 3.9 and bash)
+```    
+    cd JIT-ISS
+    mkdir build
+    cd build
+    LLVM_HOME=/usr/lib/llvm-3.9 cmake ..
+    make
+```
+* if the SystemC installation is not to be found be cmake you can optionally specify the location by either setting the following environment variables pointing to the installation
+  - SYSTEMC_HOME
+  - SYSTEMC_PREFIX
+

cmake/CPackConfig.cmake

@@ -0,0 +1,82 @@
+# @author  Barthélémy von Haller
+
+# General CPack configuration 
+# Info: http://www.itk.org/Wiki/CMake:Component_Install_With_CPack
+# _____________________________________________________________________________
+
+set(CPACK_PACKAGE_NAME "iss")
+
+if(APPLE)
+  set(CPACK_PACKAGE_VENDOR "Organisation") # PackageMaker doesn't like http://
+else()
+  set(CPACK_PACKAGE_VENDOR "http://example.com") # deb lintian insists on URL
+endif()
+
+set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Example project")
+set(CPACK_PACKAGE_CONTACT "Person name <name@example.com>")
+set(CPACK_PACKAGE_VERSION ${VERSION})
+set(CPACK_PACKAGE_VERSION_MAJOR ${VERSION_MAJOR})
+set(CPACK_PACKAGE_VERSION_MINOR ${VERSION_MINOR})
+set(CPACK_PACKAGE_VERSION_PATCH ${VERSION_PATCH})
+set(CPACK_RPM_PACKAGE_DEBUG 0)
+
+# Select package generator
+if(MSVC)
+  set(CPACK_GENERATOR "NSIS")
+endif(MSVC)
+
+if(APPLE)
+  set(CPACK_GENERATOR "PackageMaker")
+  set(CPACK_SET_DESTDIR ON)
+endif(APPLE)
+
+if (${CMAKE_SYSTEM_NAME} MATCHES Linux)
+  find_program(RPM_EXE rpmbuild)
+  if(${RPM_EXE} MATCHES RPM_EXE-NOTFOUND)
+    set(CPACK_GENERATOR "TGZ;DEB")
+  else()
+    set(CPACK_GENERATOR "TGZ;DEB;RPM")
+  endif()
+endif(${CMAKE_SYSTEM_NAME} MATCHES Linux)
+
+# Components
+# See www.cmake.org/Wiki/CMake:Component_Install_With_CPack#Controlling_Differents_Ways_of_packaging_components
+# _____________________________________________________________________________
+set(CPACK_COMPONENT_INSTALL ON)
+set(CPACK_COMPONENTS_ALL libs devel doc)
+
+set(CPACK_COMPONENT_LIBS_DISPLAY_NAME "Libraries")
+set(CPACK_COMPONENT_LIBS_DESCRIPTION "Runtime libraries.")
+set(CPACK_COMPONENT_LIBS_GROUP "Runtime")
+# express component dependencies this way, it will translate into package dependencies where applicable
+set(CPACK_COMPONENT_LIBS_DEPENDS doc)
+
+set(CPACK_COMPONENT_DOCS_DISPLAY_NAME "Documents")
+set(CPACK_COMPONENT_DOCS_DESCRIPTION "User Documentation")
+set(CPACK_COMPONENT_DOCS_GROUP "Documentation")
+
+set(CPACK_COMPONENT_DEV_DISPLAY_NAME "Development files")
+set(CPACK_COMPONENT_DEV_DESCRIPTION "Development header files and libraries, as well as cmake config files.")
+set(CPACK_COMPONENT_DEV_GROUP "Development")
+set(CPACK_COMPONENT_DEV_DEPENDS libs)
+
+# Debian specific configuration (minimum)
+# _____________________________________________________________________________
+
+set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${CPACK_PACKAGE_CONTACT}")
+SET(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.3.1-6), libboost-test-dev")
+SET(CPACK_DEBIAN_PACKAGE_CONFLICTS "Hello0-apps")
+
+# RPM specific configuration (minimum)
+# _____________________________________________________________________________
+set(CPACK_RPM_PACKAGE_LICENSE "Proprietary")
+set(CPACK_RPM_PACKAGE_GROUP "Development/Libraries")
+set(CPACK_RPM_PACKAGE_VERSION ${VERSION})
+set(CPACK_RPM_COMPONENT_INSTALL ON)   # necessary even if CPACK_COMPONENT_INSTALL set to ON. A bug in my opinion.
+
+# OS X PackageMaker
+# _____________________________________________________________________________
+set(CPACK_OSX_PACKAGE_VERSION "10.5")
+
+include (InstallRequiredSystemLibraries)
+include (CPack)

cmake/issConfig.cmake

@@ -0,0 +1 @@
+include("${CMAKE_CURRENT_LIST_DIR}/issTargets.cmake")

incl/iss/arch/traits.h

@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * Copyright (C) 2017, MINRES Technologies GmbH
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * 3. Neither the name of the copyright holder nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * Contributors:
+ *       eyck@minres.com - initial API and implementation
+ ******************************************************************************/
+
+#ifndef _TRAITS_H_
+#define _TRAITS_H_
+
+namespace iss {
+namespace arch {
+
+template<typename ARCH>
+struct traits {
+
+};
+}
+}
+
+#endif /* _TRAITS_H_ */