Merge pull request #266 from layus/cache_generated_code

Cache generated code & Gen source archive

Author: sjmackenzie

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "stdlib"]
 	path = stdlib
 	url = git://github.com/mozart/mozart2-stdlib.git
+[submodule "gtest"]
+	path = vm/vm/test/gtest
+	url = http://github.com/google/googletest

CMakeLists.txt

@@ -1,4 +1,12 @@
 cmake_minimum_required(VERSION 2.8)
+
+# This needs to be before "project(..)".
+if(NOT DEFINED CMAKE_BUILD_TYPE)
+  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: Debug Release")
+endif()
+message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
+
+
 project(MOZART CXX)
 
 ENABLE_TESTING()
@@ -11,6 +19,13 @@ include(MozartProperties)
 set(MOZART_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
 set(MOZART_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}")
 
+set(DEFAULT_MOZART_GENERATOR_FLAGS
+      "--std=c++0x"
+      "-Wno-invalid-noreturn"
+      "-Wno-return-type"
+      "-Wno-braced-scalar-init" # Silence warning for macro ATOMIC_FLAG_INIT in atomic_base.h
+   )
+
 # Some helpers when using MinGW
 if(MINGW)
   get_filename_component(CMAKE_MAKE_PROGRAM_PATH "${CMAKE_MAKE_PROGRAM}" PATH)
@@ -32,7 +47,9 @@ if(MINGW)
   set(DEFAULT_MOZART_GENERATOR_FLAGS
         "-I${MINGW_ROOT}/${GCC_ARCH_TRIPLE}/include/c++"
         "-I${MINGW_ROOT}/${GCC_ARCH_TRIPLE}/include/c++/${GCC_ARCH_TRIPLE}"
-        "-I${MINGW_ROOT}/${GCC_ARCH_TRIPLE}/include")  
+        "-I${MINGW_ROOT}/${GCC_ARCH_TRIPLE}/include"
+        ${DEFAULT_MOZART_GENERATOR_FLAGS}
+     )
 
   set(BOOST_ROOT "${MINGW_ROOT}"
       CACHE PATH "Path where Boost is installed")
@@ -42,8 +59,6 @@ if(MINGW)
       enable_language(RC)
         set(CMAKE_RC_COMPILE_OBJECT
 	    "<CMAKE_RC_COMPILER> <FLAGS> -O coff <DEFINES> -i <SOURCE> -o <OBJECT>")
-else()
-  set(DEFAULT_MOZART_GENERATOR_FLAGS "")
 endif()
 
 # Some configuration
@@ -53,6 +68,22 @@ if(WIN32)
   set(DEFAULT_MOZART_GENERATOR_FLAGS "-DMOZART_WINDOWS=1" ${DEFAULT_MOZART_GENERATOR_FLAGS})
 endif()
 
+# CMake does not allow to add dependencies to "builtin" targets like package_source.
+# We therefore wrap package_source in our own dist target.
+
+if("${MOZART_BUILD_DIR}/" MATCHES "${MOZART_DIR}/.*")
+  message(WARNING "You are compiling inside the source tree. Generating source tarballs will not work correctly.")
+endif()
+add_custom_target(dist COMMAND ${CMAKE_MAKE_PROGRAM} package_source)
+configure_file(cmake_local/MozartConfigVersion.cmake.in
+    ${CMAKE_CURRENT_BINARY_DIR}/cmake_local/MozartConfigVersion.cmake @ONLY)
+define_property(GLOBAL PROPERTY SRCS_INSTALLED_DIRS
+    BRIEF_DOCS "List of source files"
+    FULL_DOCS "List of source/dest pairs of path to be included in the source archive")
+set_property(GLOBAL APPEND PROPERTY SRCS_INSTALLED_DIRS
+    "${CMAKE_CURRENT_SOURCE_DIR}" "/"
+    "${CMAKE_CURRENT_BINARY_DIR}/cmake_local/" "/cmake_local/")
+
 # The subdirectories which contain the real thing
 
 add_subdirectory(vm)
@@ -111,6 +142,19 @@ set(CPACK_RPM_PACKAGE_ARCHITECTURE "${MOZART_PROP_PLATFORM_ARCH}")
 set(CPACK_RPM_PACKAGE_REQUIRES "tcl >= 8.5, tk >= 8.5, emacs")
 set(CPACK_RPM_PACKAGE_GROUP "Development/Languages")
 
+# Configuration of the Source generator
+
+set(CPACK_SOURCE_GENERATOR "ZIP")
+get_property(CPACK_SOURCE_INSTALLED_DIRECTORIES GLOBAL PROPERTY SRCS_INSTALLED_DIRS)
+set(CPACK_SOURCE_IGNORE_FILES
+    "/\\\\.git"
+    "\\\\.astbi$"
+    "\\\\.ast$"
+    "/bootcompiler/project/project/"
+    "/bootcompiler/project/target/"
+    "/bootcompiler/target/"
+)
+
 # Configuration of Inno Setup files
 
 if(WIN32)

boosthost/emulator/CMakeLists.txt

@@ -40,12 +40,13 @@ endif()
 
 # Mozart VM library
 
-include_directories("${MOZART_DIR}/vm/vm/main" "${MOZART_BUILD_DIR}/vm/vm/main")
+get_property(GENERATED_SOURCES_DIR GLOBAL PROPERTY GENERATED_SOURCES_DIR)
+include_directories("${MOZART_DIR}/vm/vm/main" "${GENERATED_SOURCES_DIR}")
 
 # Mozart VM Boost environment library
 
-include_directories("${MOZART_DIR}/vm/boostenv/main"
-    "${MOZART_BUILD_DIR}/vm/boostenv/main")
+get_property(GENERATED_BOOSTSOURCES_DIR GLOBAL PROPERTY GENERATED_BOOSTSOURCES_DIR)
+include_directories("${MOZART_DIR}/vm/boostenv/main" "${GENERATED_BOOSTSOURCES_DIR}")
 
 
 # Compile the executable

cmake_local/MozartConfigVersion.cmake.in

@@ -0,0 +1,4 @@
+
+set(MOZART_PROP_OZ_VERSION "@MOZART_PROP_OZ_VERSION@")
+set(MOZART_PROP_OZ_DATE "@MOZART_PROP_OZ_DATE@")
+

cmake_local/MozartProperties.cmake

@@ -14,40 +14,49 @@ endif()
 
 target_architecture(MOZART_PROP_PLATFORM_ARCH)
 
+# For source tarballs, oz.version and os.date
+# are exported id MozartConfigVersion.cmake
+include(MozartConfigVersion
+  RESULT_VARIABLE MOZART_CACHED_BUILD OPTIONAL)
+
 # oz.version
 
-execute_process(
-  COMMAND ${GIT_EXECUTABLE} describe --dirty
-  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
-  OUTPUT_VARIABLE git_describe_output
-  ERROR_QUIET
-  OUTPUT_STRIP_TRAILING_WHITESPACE)
-
-if("${git_describe_output}" MATCHES "^v[0-9].+-[0-9]+-g[0-9a-f]+(-dirty)?$")
-  string(REGEX REPLACE "^v(.+)-([0-9]+)-g([0-9a-f]+)((-dirty)?)$" "\\1+build.\\2.\\3\\4"
-         MOZART_PROP_OZ_VERSION "${git_describe_output}")
-elseif("${git_describe_output}" MATCHES "^v[0-9].+[0-9](-dirty)?$")
-  string(REGEX REPLACE "^v(.+)$" "\\1"
-         MOZART_PROP_OZ_VERSION "${git_describe_output}")
-else()
-  message(WARNING "'git describe --dirty' did not return something sensible")
-  set(MOZART_PROP_OZ_VERSION "unknown")
+if(NOT MOZART_CACHED_BUILD)
+  execute_process(
+    COMMAND ${GIT_EXECUTABLE} describe --dirty
+    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+    OUTPUT_VARIABLE git_describe_output
+    ERROR_QUIET
+    OUTPUT_STRIP_TRAILING_WHITESPACE)
+
+  if("${git_describe_output}" MATCHES "^v[0-9].+-[0-9]+-g[0-9a-f]+(-dirty)?$")
+    string(REGEX REPLACE "^v(.+)-([0-9]+)-g([0-9a-f]+)((-dirty)?)$" "\\1+build.\\2.\\3\\4"
+           MOZART_PROP_OZ_VERSION "${git_describe_output}")
+  elseif("${git_describe_output}" MATCHES "^v[0-9].+[0-9](-dirty)?$")
+    string(REGEX REPLACE "^v(.+)$" "\\1"
+           MOZART_PROP_OZ_VERSION "${git_describe_output}")
+  else()
+    message(WARNING "'git describe --dirty' did not return something sensible")
+    set(MOZART_PROP_OZ_VERSION "unknown")
+  endif()
+
+  unset(git_describe_output)
 endif()
 
-unset(git_describe_output)
-
 # oz.date
 
-execute_process(
-  COMMAND ${GIT_EXECUTABLE} log "--format=%aD" -1
-  WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
-  OUTPUT_VARIABLE git_date_output
-  ERROR_QUIET
-  OUTPUT_STRIP_TRAILING_WHITESPACE)
+if(NOT MOZART_CACHED_BUILD)
+  execute_process(
+    COMMAND ${GIT_EXECUTABLE} log "--format=%aD" -1
+    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+    OUTPUT_VARIABLE git_date_output
+    ERROR_QUIET
+    OUTPUT_STRIP_TRAILING_WHITESPACE)
 
-set(MOZART_PROP_OZ_DATE "${git_date_output}")
+  set(MOZART_PROP_OZ_DATE "${git_date_output}")
 
-unset(git_date_output)
+  unset(git_date_output)
+endif()
 
 # Display which version we found
 

lib/CMakeLists.txt

@@ -79,8 +79,9 @@ set(BOOTCOMPILER_DEFINES -D NO_GUMP)
 set(BOOTCOMPILER_BASEENV_DATA_FILE "${STAGE_0_CACHE}/baseenv.txt")
 set(BOOTCOMPILER_COMMAND
     ${Java_JAVA_EXECUTABLE} -jar  ${JAVA_OPTIONS} "${BOOTCOMPILER_JAR}")
+get_property(GENERATED_SOURCES_DIR GLOBAL PROPERTY GENERATED_SOURCES_DIR)
 set(BOOTCOMPILER_COMMON_OPTIONS
-    -m "${MOZART_BUILD_DIR}/vm/vm/main/"
+    -m "${GENERATED_SOURCES_DIR}/"
     ${BOOTCOMPILER_DEFINES})
 set(BOOTCOMPILER_COMMON_DEPENDS
     gensources bootcompiler "${BOOTCOMPILER_JAR}")
@@ -102,7 +103,7 @@ add_custom_command(
 set(STAGE_0_OUTPUTS "${STAGE_0_BASE_OZF}")
 
 foreach(FUNCTOR "${RUNTIME_FUNCTOR}" "${INIT_FUNCTOR}" ${SYS_FUNCTORS} ${COMPILER_FUNCTORS})
-  if("${FUNCTOR}" MATCHES "${INIT_FUNCTOR}")
+  if("${FUNCTOR}" STREQUAL "${INIT_FUNCTOR}")
     set(FUNCTOR_OZF "${STAGE_0_CACHE}/Init.ozf")
   else()
     get_filename_component(FUNCTOR_BASENAME ${FUNCTOR} NAME_WE)

vm/CMakeLists.txt

@@ -9,10 +9,6 @@ set(DEFAULT_LLVM_SRC_DIR "${ep_base}/Source/llvm")
 set(DEFAULT_LLVM_BUILD_DIR "${ep_base}/Build/llvm")
 set(LLVM_SRC_DIR ${DEFAULT_LLVM_SRC_DIR} CACHE PATH "Path to LLVM sources (with Clang)")
 set(LLVM_BUILD_DIR ${DEFAULT_LLVM_BUILD_DIR} CACHE PATH "Path to LLVM build (with Clang)")
-set(DEFAULT_GTEST_SRC_DIR "${ep_base}/Source/gtest")
-set(DEFAULT_GTEST_BUILD_DIR "${ep_base}/Build/gtest")
-set(GTEST_SRC_DIR ${DEFAULT_GTEST_SRC_DIR} CACHE PATH "Path to GTest sources")
-set(GTEST_BUILD_DIR ${DEFAULT_GTEST_BUILD_DIR} CACHE PATH "Path to GTest build")
 
 set(MOZART_GENERATOR_FLAGS "${DEFAULT_MOZART_GENERATOR_FLAGS}" CACHE STRING
     "Additional flags for the generator parser (clang)")

vm/boostenv/main/CMakeLists.txt

@@ -33,61 +33,80 @@ endif()
 
 # Mozart VM library
 
-include_directories("${CMAKE_CURRENT_SOURCE_DIR}/../../vm/main"
-    "${CMAKE_CURRENT_BINARY_DIR}/../../vm/main")
+get_property(GENERATED_SOURCES_DIR GLOBAL PROPERTY GENERATED_SOURCES_DIR)
+include_directories("${MOZART_SOURCE_DIR}/vm/vm/main" "${GENERATED_SOURCES_DIR}")
+link_directories("${MOZART_BINARY_DIR}/vm/vm/main")
 
-link_directories("${CMAKE_CURRENT_BINARY_DIR}/../../vm/main")
-
-include_directories(${CMAKE_CURRENT_BINARY_DIR})
+set(GENERATED_BOOSTSOURCES_CACHED_DIR ${CMAKE_CURRENT_SOURCE_DIR}/cached/)
+set(GENERATED_BOOSTSOURCES_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated/)
 
 # Generate sources
+find_program(clang_bin clang++)
 
 add_custom_command(
-  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/boostenv.gen
+  OUTPUT ${GENERATED_BOOSTSOURCES_BINARY_DIR}/boostenv.gen
 
   # First pass: generate data types and interfaces
-  COMMAND ${LLVM_BUILD_DIR}/bin/clang++ "${CXX_STD_OPT}"
-    -Wno-invalid-noreturn -Wno-return-type
-    -o ${CMAKE_CURRENT_BINARY_DIR}/boostenv.ast
+  COMMAND ${clang_bin}
+    -o ${GENERATED_BOOSTSOURCES_BINARY_DIR}/boostenv.ast
     -I ${Boost_INCLUDE_DIRS}
     -I ${CMAKE_CURRENT_SOURCE_DIR}/../../vm/main
     -DMOZART_GENERATOR
     ${MOZART_GENERATOR_FLAGS}
     ${CMAKE_CURRENT_SOURCE_DIR}/boostenv.hh
   COMMAND generator intfimpl
-    ${CMAKE_CURRENT_BINARY_DIR}/boostenv.ast
-    ${CMAKE_CURRENT_BINARY_DIR}/
+    ${GENERATED_BOOSTSOURCES_BINARY_DIR}/boostenv.ast
+    ${GENERATED_BOOSTSOURCES_BINARY_DIR}/
 
   # Second pass: generate builtin information
-  COMMAND ${LLVM_BUILD_DIR}/bin/clang++ "${CXX_STD_OPT}"
-    -Wno-invalid-noreturn -Wno-return-type
-    -o ${CMAKE_CURRENT_BINARY_DIR}/boostenvmodules.astbi
+  COMMAND ${clang_bin}
+    -o ${GENERATED_BOOSTSOURCES_BINARY_DIR}/boostenvmodules.astbi
     -I ${Boost_INCLUDE_DIRS}
-    -I ${CMAKE_CURRENT_BINARY_DIR}
+    -I ${GENERATED_BOOSTSOURCES_BINARY_DIR}
     -I ${CMAKE_CURRENT_SOURCE_DIR}/../../vm/main
-    -I ${CMAKE_CURRENT_BINARY_DIR}/../../vm/main
+    -I ${GENERATED_BOOSTSOURCES_BINARY_DIR}/../../vm/main
     -DMOZART_BUILTIN_GENERATOR
     ${MOZART_GENERATOR_FLAGS}
     ${CMAKE_CURRENT_SOURCE_DIR}/boostenvmodules.hh
   COMMAND generator builtins
-    ${CMAKE_CURRENT_BINARY_DIR}/boostenvmodules.astbi
-    ${CMAKE_CURRENT_BINARY_DIR}/
+    ${GENERATED_BOOSTSOURCES_BINARY_DIR}/boostenvmodules.astbi
+    ${GENERATED_BOOSTSOURCES_BINARY_DIR}/
     boostenvbuiltins
 
   # Tag
-  COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/boostenv.gen
+  COMMAND ${CMAKE_COMMAND} -E touch ${GENERATED_BOOSTSOURCES_BINARY_DIR}/boostenv.gen
 
   DEPENDS generator gensources
   IMPLICIT_DEPENDS CXX "${CMAKE_CURRENT_SOURCE_DIR}/boostenvmodules.hh"
   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
   COMMENT "Generate sources for boostenv"
   VERBATIM)
 
+
+# Use the cached files if they exist.
+
+if(EXISTS ${GENERATED_BOOSTSOURCES_CACHED_DIR}/boostenv.gen)
+    set(GENERATED_BOOSTSOURCES_DIR ${GENERATED_BOOSTSOURCES_CACHED_DIR})
+else()
+    set(GENERATED_BOOSTSOURCES_DIR ${GENERATED_BOOSTSOURCES_BINARY_DIR})
+    file(MAKE_DIRECTORY ${GENERATED_BOOSTSOURCES_BINARY_DIR})
+endif()
+set_property(GLOBAL PROPERTY GENERATED_BOOSTSOURCES_DIR "${GENERATED_BOOSTSOURCES_DIR}")
+
 add_custom_target(genboostsources
-  DEPENDS boostenv.gen
+  DEPENDS ${GENERATED_BOOSTSOURCES_DIR}/boostenv.gen
   VERBATIM)
 
+
+# Include the generated files in the source archive.
+
+set_property(GLOBAL APPEND PROPERTY SRCS_INSTALLED_DIRS
+    "${GENERATED_BOOSTSOURCES_DIR}" "/vm/boostenv/main/cached/")
+
+add_dependencies(dist genboostsources)
+
 # Boost environment library
+include_directories(${GENERATED_BOOSTSOURCES_DIR})
 
 add_library(mozartvmboost boostvm.cc boostenvmodules.cc)
 add_dependencies(mozartvmboost genboostsources)

vm/generator/CMakeLists.txt

@@ -1,29 +1,3 @@
-if("${LLVM_SRC_DIR}" STREQUAL "${DEFAULT_LLVM_SRC_DIR}" AND
-   NOT EXISTS "${LLVM_BUILD_DIR}/bin/clang++")
-
-  separate_arguments(LLVM_CMAKE_ARGS UNIX_COMMAND
-    "-DCMAKE_BUILD_TYPE=Release
-     -DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}
-     -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-     -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-     -DCMAKE_CXX_FLAGS=\"${CMAKE_CXX_FLAGS}\""
-  )
-
-  ExternalProject_Add(llvm
-    SVN_REPOSITORY http://llvm.org/svn/llvm-project/llvm/tags/RELEASE_371/final
-    CMAKE_ARGS ${LLVM_CMAKE_ARGS}
-    INSTALL_COMMAND ""
-    TEST_COMMAND ""
-    )
-  ExternalProject_Add_Step(llvm download_clang
-    COMMAND svn co http://llvm.org/svn/llvm-project/cfe/tags/RELEASE_371/final ${ep_base}/Source/llvm/tools/clang
-    DEPENDEES download
-    DEPENDERS update
-    )
-  ExternalProject_Add_Step(llvm update_clang
-    COMMAND svn update ${ep_base}/Source/llvm/tools/clang
-    DEPENDEES update
-    DEPENDERS build
-    )
+if(NOT MOZART_CACHED_BUILD)
+  add_subdirectory(main)
 endif()
-add_subdirectory(main)

vm/generator/main/CMakeLists.txt

@@ -1,26 +1,13 @@
-set(CLANG_SRC_DIR "${LLVM_SRC_DIR}/tools/clang")
-set(CLANG_BUILD_DIR "${LLVM_BUILD_DIR}/tools/clang")
 
-add_definitions(-D__STDC_LIMIT_MACROS -D__STDC_CONSTANT_MACROS)
+find_package(LLVM REQUIRED CONFIG)
+message(STATUS "Found LLVM ${LLVM_PACKAGE_VERSION}")
+message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
 
-set(CMAKE_CXX_FLAGS "-Wall -Wno-enum-compare -Wno-strict-aliasing -std=gnu++0x ${CMAKE_CXX_FLAGS}")
+find_package(Clang REQUIRED CONFIG)
+message(STATUS "Found Clang using ClangConfig.cmake in: ${Clang_DIR}")
 
-# Depending on the platform and version of clang, the clang library will
-# be named libclang or liblibclang. Now we detect that.
-find_library(CLANG_LIBRARY
-  NAMES clang libclang
-  PATHS "${LLVM_BUILD_DIR}/lib"
-  NO_DEFAULT_PATH)
-if("${CLANG_LIBRARY}" MATCHES "CLANG_LIBRARY-NOTFOUND")
-  message(FATAL_ERROR "Could not find clang library in ${LLVM_BUILD_DIR}")
-endif()
+#include_directories(${LLVM_INCLUDE_DIRS})
+#add_definitions(${LLVM_DEFINITIONS})
 
-include_directories(
-  "${LLVM_SRC_DIR}/include"
-  "${LLVM_BUILD_DIR}/include"
-  "${CLANG_SRC_DIR}/include"
-  "${CLANG_BUILD_DIR}/include")
-link_directories("${LLVM_BUILD_DIR}/lib")
-add_executable(generator generator.cc interfaces.cc implementations.cc
-  builtins.cc utils.cc)
-target_link_libraries(generator "${CLANG_LIBRARY}")
+add_executable(generator EXCLUDE_FROM_ALL generator.cc interfaces.cc implementations.cc builtins.cc utils.cc)
+target_link_libraries(generator clangFrontend clangAST)