Merge pull request #259 from abs-tudelft/static-vhdl

Add fletchgen option to output static VHDL support files as well

Author: mbrobbel

codegen/cpp/fletchgen/CMakeLists.txt

@@ -42,6 +42,30 @@ if(NOT TARGET fletcher::c)
   add_subdirectory(../../../common/c common-c)
 endif()
 
+
+FetchContent_Declare(cmakerc
+  GIT_REPOSITORY  https://github.com/vector-of-bool/cmrc.git
+  GIT_TAG         master
+)
+FetchContent_MakeAvailable(cmakerc)
+
+file(
+    GLOB_RECURSE RESOURCE_FILES
+    LIST_DIRECTORIES false
+    "${CMAKE_CURRENT_SOURCE_DIR}/../../../hardware/**/*"
+)
+cmrc_add_resource_library(
+    fletchgen-resources
+    ALIAS fletchgen::resources
+    NAMESPACE fletchgen
+    WHENCE "${CMAKE_CURRENT_SOURCE_DIR}/../../.."
+    ${RESOURCE_FILES}
+)
+set_property(
+    TARGET fletchgen-resources
+    PROPERTY POSITION_INDEPENDENT_CODE ON
+)
+
 add_compile_unit(
   OPT
   NAME fletchgen::obj
@@ -66,6 +90,7 @@ add_compile_unit(
     src/fletchgen/profiler.cc
     src/fletchgen/axi4_lite.cc
     src/fletchgen/external.cc
+    src/fletchgen/static_vhdl.cc
 
     src/fletchgen/srec/recordbatch.cc
     src/fletchgen/srec/srec.cc
@@ -92,6 +117,7 @@ add_compile_unit(
     fletcher::c
     CLI11::CLI11
     Threads::Threads
+    fletchgen::resources
 )
 
 add_compile_unit(

codegen/cpp/fletchgen/src/fletchgen/fletchgen.cc

@@ -28,10 +28,12 @@
 #include "fletchgen/srec/recordbatch.h"
 #include "fletchgen/top/sim.h"
 #include "fletchgen/top/axi.h"
+#include "fletchgen/static_vhdl.h"
 
 namespace fletchgen {
 
 int fletchgen(int argc, char **argv) {
+
   // Start logging
   std::string program_name = fletchgen::GetProgramName(argv[0]);
   fletcher::StartLogging(program_name, FLETCHER_LOG_DEBUG, program_name + ".log");
@@ -161,6 +163,11 @@ int fletchgen(int argc, char **argv) {
     */
   }
 
+  // Write static VHDL support files for Fletcher.
+  if (options->static_vhdl) {
+    write_static_vhdl("vhdl/support");
+  }
+
   // Wait for vhdmmio.
   if (!vhdmmio.joinable()) {
     FLETCHER_LOG(INFO, "Waiting for vhdmmio to complete...");

codegen/cpp/fletchgen/src/fletchgen/options.cc

@@ -93,6 +93,8 @@ bool Options::Parse(Options *options, int argc, char **argv) {
   app.add_flag("--vivado_hls", options->vivado_hls,
                "Generate a Vivado HLS kernel template.");
 
+  app.add_flag("--static-vhdl", options->static_vhdl, "Write static VHDL support files.");
+
   // Other options:
   app.add_flag("-v,--version", options->version,
                "Show version.");

codegen/cpp/fletchgen/src/fletchgen/options.h

@@ -59,6 +59,8 @@ struct Options {
   bool axi_top = false;
   /// Whether to simulate an AXI top level.
   bool sim_top = false;
+  /// Whether to generate static VHDL files (copied from hardware directory, embedded as resources).
+  bool static_vhdl = false;
   /// Whether to backup any existing generated files.
   bool backup = false;
 

codegen/cpp/fletchgen/src/fletchgen/static_vhdl.cc

@@ -0,0 +1,43 @@
+// Copyright 2018-2019 Delft University of Technology
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "fletchgen/static_vhdl.h"
+
+#include <cmrc/cmrc.hpp>
+#include <fstream>
+#include <algorithm>
+#include <sys/stat.h>
+#include <sys/types.h>
+
+CMRC_DECLARE(fletchgen);
+
+namespace fletchgen {
+
+void write_static_vhdl(const std::string &real_dir, const std::string &emb_dir) {
+  mkdir(real_dir.c_str(), 0777);
+  for (const auto &dirent : cmrc::fletchgen::get_filesystem().iterate_directory(emb_dir)) {
+    if (dirent.is_file()) {
+      std::ofstream real_file;
+      real_file.open(real_dir + "/" + dirent.filename());
+      std::ostream_iterator<char> out_it{real_file};
+      auto emb_file = cmrc::fletchgen::get_filesystem().open(emb_dir + "/" + dirent.filename());
+      std::copy(emb_file.cbegin(), emb_file.cend(), out_it);
+      real_file.close();
+    } else {
+      write_static_vhdl(real_dir + "/" + dirent.filename(), emb_dir + "/" + dirent.filename());
+    }
+  }
+}
+
+}  // namespace fletchgen

codegen/cpp/fletchgen/src/fletchgen/static_vhdl.h

@@ -0,0 +1,29 @@
+// Copyright 2018-2019 Delft University of Technology
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#include <string>
+
+namespace fletchgen {
+
+/**
+ * @brief Writes Fletcher's static VHDL files to the given directory.
+ * @param real_dir  The real directory to write to.
+ * @param emb_dir   The embedded filesystem directory to read from, defaulting
+ *                  to the toplevel resource directory ("hardware").
+ */
+void write_static_vhdl(const std::string &real_dir, const std::string &emb_dir = "hardware");
+
+}  // namespace fletchgen