[arcilator] Add JIT runtime environment library and stdio hooks

integration_test/arcilator/JIT/runtime-environment.mlir

@@ -0,0 +1,40 @@
+// RUN: arcilator %s --run --jit-entry=main 2>&1 >/dev/null | FileCheck -strict-whitespace %s
+// REQUIRES: arcilator-jit
+
+// CHECK: Hello World!{{[[:space:]]}}
+
+module {
+
+  llvm.func @_arc_env_get_print_stream(i32) -> !llvm.ptr
+  llvm.func @_arc_libc_fprintf(!llvm.ptr, !llvm.ptr, ...) -> i32
+  llvm.func @_arc_libc_fputc(i32, !llvm.ptr) -> i32
+  llvm.func @_arc_libc_fputs(!llvm.ptr, !llvm.ptr) -> i32
+
+  llvm.mlir.global internal constant @global_hello("He%c%co \00") {addr_space = 0 : i32}
+  llvm.mlir.global internal constant @global_world("World\00") {addr_space = 0 : i32}
+
+  arc.model @dut io !hw.modty<> {
+  ^bb0(%arg0: !arc.storage):
+    %cst0 = llvm.mlir.constant(0 : i32) : i32
+    %ascii_em = llvm.mlir.constant(33 : i32) : i32
+    %ascii_lf = llvm.mlir.constant(10 : i32) : i32
+    %ascii_l = llvm.mlir.constant(108 : i32) : i32
+    %stderr = llvm.call @_arc_env_get_print_stream(%cst0) : (i32) -> !llvm.ptr
+
+    %hello = llvm.mlir.addressof @global_hello : !llvm.ptr
+    %0 = llvm.call @_arc_libc_fprintf(%stderr, %hello, %ascii_l, %ascii_l) vararg(!llvm.func<i32 (ptr, ptr, ...)>) : (!llvm.ptr, !llvm.ptr, i32, i32) -> i32
+
+    %world = llvm.mlir.addressof @global_world : !llvm.ptr
+    %1 = llvm.call @_arc_libc_fputs(%world, %stderr) : (!llvm.ptr, !llvm.ptr) -> i32
+
+    %2 = llvm.call @_arc_libc_fputc(%ascii_em, %stderr) : (i32, !llvm.ptr) -> i32
+    %3 = llvm.call @_arc_libc_fputc(%ascii_lf, %stderr) : (i32, !llvm.ptr) -> i32
+  }
+
+  func.func @main() {
+    arc.sim.instantiate @dut as %arg0 {
+      arc.sim.step %arg0 : !arc.sim.instance<@dut>
+    }
+    return
+  }
+}

tools/arcilator/CMakeLists.txt

@@ -1,7 +1,8 @@
 if(ARCILATOR_JIT_ENABLED)
   add_compile_definitions(ARCILATOR_ENABLE_JIT)
+  add_subdirectory(jit-env)
   set(ARCILATOR_JIT_LLVM_COMPONENTS native)
-  set(ARCILATOR_JIT_DEPS MLIRExecutionEngine)
+  set(ARCILATOR_JIT_DEPS MLIRExecutionEngine arc-jit-env)
 endif()
 
 set(LLVM_LINK_COMPONENTS Support ${ARCILATOR_JIT_LLVM_COMPONENTS})
@@ -45,3 +46,9 @@ configure_file(arcilator-runtime.h
   ${CIRCT_TOOLS_DIR}/arcilator-runtime.h)
 add_custom_target(arcilator-runtime-header SOURCES
   ${CIRCT_TOOLS_DIR}/arcilator-runtime.h)
+
+if(ARCILATOR_JIT_ENABLED)
+  target_include_directories(arcilator PRIVATE
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/jit-env>
+  )
+endif()

tools/arcilator/arcilator-runtime.h

@@ -1,12 +1,63 @@
 // NOLINTBEGIN
 #pragma once
 #include <array>
+#include <cstdarg>
 #include <cstdint>
+#include <cstdio>
 #include <cstring>
 #include <functional>
 #include <ostream>
 #include <vector>
 
+// Sanity checks for binary compatibility
+#ifdef __BYTE_ORDER__
+#if (__BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__)
+#error Unsupported endianess
+#endif
+#endif
+static_assert(sizeof(int) == 4, "Unsupported ABI");
+static_assert(sizeof(long long) == 8, "Unsupported ABI");
+
+// ---  Exports to the IR ---
+
+#ifdef _WIN32
+#define ARCEXPORT(rtype) extern "C" __declspec(dllexport) rtype __cdecl
+#else
+#define ARCEXPORT(rtype) extern "C" rtype
+#endif
+
+// libc Adapters
+ARCEXPORT(int) _arc_libc_fprintf(FILE *stream, const char *format, ...) {
+  int result;
+  va_list args;
+  va_start(args, format);
+  result = vfprintf(stream, format, args);
+  va_end(args);
+  return result;
+}
+
+ARCEXPORT(int) _arc_libc_fputs(const char *str, FILE *stream) {
+  return fputs(str, stream);
+}
+
+ARCEXPORT(int) _arc_libc_fputc(int ch, FILE *stream) {
+  return fputc(ch, stream);
+}
+
+// Runtime Environment calls
+
+#define ARC_ENV_DECL_GET_PRINT_STREAM(idarg)                                   \
+  ARCEXPORT(FILE *) _arc_env_get_print_stream(uint32_t idarg)
+
+#ifndef ARC_NO_DEFAULT_GET_PRINT_STREAM
+ARC_ENV_DECL_GET_PRINT_STREAM(id) {
+  (void)id;
+  return stderr;
+}
+#endif // ARC_NO_DEFAULT_GET_PRINT_STREAM
+
+// ----------------
+
 struct Signal {
   const char *name;
   unsigned offset;

tools/arcilator/arcilator.cpp

@@ -52,6 +52,7 @@
 #include "mlir/Target/LLVMIR/Export.h"
 #include "mlir/Transforms/GreedyPatternRewriteDriver.h"
 #include "mlir/Transforms/Passes.h"
+#include "llvm/ADT/ScopeExit.h"
 #include "llvm/IR/LLVMContext.h"
 #include "llvm/IR/Module.h"
 #include "llvm/Support/CommandLine.h"
@@ -62,6 +63,10 @@
 #include "llvm/Support/TargetSelect.h"
 #include "llvm/Support/ToolOutputFile.h"
 
+#ifdef ARCILATOR_ENABLE_JIT
+#include "arcilator-jit-env.h"
+#endif
+
 #include <optional>
 
 using namespace mlir;
@@ -430,6 +435,16 @@ static LogicalResult processBuffer(
       return failure();
     }
 
+    auto envInitResult = arc_jit_runtime_env_init();
+    if (envInitResult != 0) {
+      llvm::errs() << "Initialization of arcilator runtime library failed ("
+                   << envInitResult << ").\n";
+      return failure();
+    }
+
+    auto envDeinit =
+        llvm::make_scope_exit([] { arc_jit_runtime_env_deinit(); });
+
     mlir::ExecutionEngineOptions engineOptions;
     engineOptions.jitCodeGenOptLevel = llvm::CodeGenOptLevel::Aggressive;
     engineOptions.transformer = mlir::makeOptimizingTransformer(

tools/arcilator/jit-env/CMakeLists.txt

@@ -0,0 +1,32 @@
+add_library(arc-jit-env SHARED arcilator-jit-env.cpp)
+
+if(WIN32)
+# Put the DLL into the binary directory so we don't have
+# to worry about it not being found.
+set_target_properties(arc-jit-env
+    PROPERTIES
+        LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib
+        RUNTIME_OUTPUT_DIRECTORY ${CIRCT_TOOLS_DIR}$<0:>
+        CXX_VISIBILITY_PRESET "default"
+)
+install(TARGETS arc-jit-env
+  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  COMPONENT arc-jit-env
+)
+
+else()
+
+set_target_properties(arc-jit-env
+    PROPERTIES
+        LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib
+        RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib
+        CXX_VISIBILITY_PRESET "default"
+)
+install(TARGETS arc-jit-env
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  COMPONENT arc-jit-env
+)
+
+endif()
+

tools/arcilator/jit-env/arcilator-jit-env.cpp

@@ -0,0 +1,20 @@
+//===- arcilator-jit-env.cpp - Internal arcilator JIT API -----------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// Implementation of the arcilator JIT runtime environment API facing
+// the arcilator.cpp.
+//
+//===----------------------------------------------------------------------===//
+
+#include "../arcilator-runtime.h"
+
+#define ARCJITENV_EXPORTS
+#include "arcilator-jit-env.h"
+
+ARCJITENV_API int arc_jit_runtime_env_init(void) { return 0; }
+ARCJITENV_API void arc_jit_runtime_env_deinit(void) { return; }

tools/arcilator/jit-env/arcilator-jit-env.h

@@ -0,0 +1,34 @@
+//===- arcilator-jit-env.h - Internal arcilator JIT API -------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+//
+// Declarations of the JIT runtime environment API facing the arcilator.cpp.
+//
+//===----------------------------------------------------------------------===//
+
+#pragma once
+
+#ifdef _WIN32
+
+#ifdef ARCJITENV_EXPORTS
+#define ARCJITENV_API extern "C" __declspec(dllexport)
+#else
+#define ARCJITENV_API extern "C" __declspec(dllimport)
+#endif // ARCJITENV_EXPORTS
+
+#else
+
+#define ARCJITENV_API extern "C"
+
+#endif // _WIN32
+
+// These don't do anything at the moment. It is still
+// required to call them to make sure the library
+// is linked and loaded before the JIT engine starts.
+
+ARCJITENV_API int arc_jit_runtime_env_init(void);
+ARCJITENV_API void arc_jit_runtime_env_deinit(void);