First PIM modifications

Recent breaking changes in the DRAMSys API require user code to be
updated. These updates have been applied to the gem5 integration.

Furthermore, as DRAMSys started to use CMake dependency management,
it is no longer sensible to maintain two separate build systems for
DRAMSys. The use of the DRAMSys integration in gem5 will therefore
from now on require that CMake is installed on the target machine.

Additionally, support for snapshots have been implemented into DRAMSys
and coupled with gem5's checkpointing API.

Change-Id: I1ab25deba2a8478ff97c477694813ac123d60379

configs/example/dramsys.py

@@ -37,9 +37,8 @@ system.mem_mode = "timing"
 system.cpu = traffic_gen
 
 dramsys = DRAMSys(
-    configuration="ext/dramsys/DRAMSys/DRAMSys/"
-    "library/resources/simulations/ddr4-example.json",
-    resource_directory="ext/dramsys/DRAMSys/DRAMSys/library/resources",
+    configuration="ext/dramsys/DRAMSys/configs/ddr4-example.json",
+    resource_directory="ext/dramsys/DRAMSys/configs",
 )
 
 system.target = dramsys

configs/example/gem5_library/arm-baremetal.py

@@ -0,0 +1,52 @@
+from gem5.isas import ISA
+from m5.objects import (
+    ArmDefaultRelease,
+)
+from gem5.utils.requires import requires
+from gem5.resources.workload import CustomWorkload
+from gem5.resources.resource import BinaryResource
+from gem5.simulate.simulator import Simulator
+from m5.objects import VExpress_GEM5_Foundation
+from gem5.components.boards.arm_baremetal_board import ArmBareMetalBoard
+from gem5.components.memory import DRAMSysDDR3_1600
+from gem5.components.processors.cpu_types import CPUTypes
+from gem5.components.processors.simple_processor import SimpleProcessor
+
+requires(isa_required=ISA.ARM)
+
+from gem5.components.cachehierarchies.classic.private_l1_private_l2_cache_hierarchy import (
+    PrivateL1PrivateL2CacheHierarchy,
+)
+from gem5.components.cachehierarchies.classic.no_cache import NoCache
+
+cache_hierarchy = PrivateL1PrivateL2CacheHierarchy(
+    l1d_size="16kB", l1i_size="16kB", l2_size="256kB"
+)
+# cache_hierarchy = NoCache()
+
+memory = DRAMSysDDR3_1600(recordable=True)
+processor = SimpleProcessor(cpu_type=CPUTypes.O3, num_cores=1, isa=ISA.ARM)
+release = ArmDefaultRelease()
+platform = VExpress_GEM5_Foundation()
+
+board = ArmBareMetalBoard(
+    clk_freq="3GHz",
+    processor=processor,
+    memory=memory,
+    cache_hierarchy=cache_hierarchy,
+    release=release,
+    platform=platform,
+)
+
+board.m5ops_base = 0x10010000
+
+workload = CustomWorkload(
+    "set_baremetal_workload",
+    {
+        "kernel": BinaryResource("aarch64"),
+    },
+)
+board.set_workload(workload)
+
+simulator = Simulator(board=board)
+simulator.run()

configs/example/gem5_library/dramsys/dramsys-traffic.py

@@ -31,16 +31,14 @@ DRAMSys simulator.
 DRRAMSys simulator. Please consult 'ext/dramsys/README' on how to compile
 correctly. If this is not done correctly this script will run with error.
 """
-import m5
-from gem5.components.memory import DRAMSysMem
+
+from gem5.components.memory.dramsys import DRAMSysMem
 from gem5.components.boards.test_board import TestBoard
 from gem5.components.processors.linear_generator import LinearGenerator
-from m5.objects import Root
+from gem5.simulate.simulator import Simulator
 
 memory = DRAMSysMem(
-    configuration="ext/dramsys/DRAMSys/DRAMSys/"
-    "library/resources/simulations/ddr4-example.json",
-    resource_directory="ext/dramsys/DRAMSys/DRAMSys/library/resources",
+    configuration="ext/dramsys/DRAMSys/configs/ddr4-example.json",
     recordable=True,
     size="4GB",
 )
@@ -51,12 +49,16 @@ generator = LinearGenerator(
     num_cores=1,
     max_addr=memory.get_size(),
 )
+
 board = TestBoard(
     clk_freq="3GHz", generator=generator, memory=memory, cache_hierarchy=None
 )
 
-root = Root(full_system=False, system=board)
-board._pre_instantiate()
-m5.instantiate()
-generator.start_traffic()
-exit_event = m5.simulate()
+simulator = Simulator(board=board)
+simulator.run()
+
+print(
+    "Exiting @ tick {} because {}.".format(
+        simulator.get_current_tick(), simulator.get_last_exit_event_cause()
+    )
+)

ext/dramsys/CMakeLists.txt

@@ -0,0 +1,38 @@
+# Copyright (c) 2023 Fraunhofer IESE
+# 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 holders 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
+# OWNER 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.
+
+cmake_minimum_required(VERSION 3.22.0)
+project(DRAMSys)
+
+set(BUILD_SHARED_LIBS OFF)
+
+add_library(systemc INTERFACE)
+
+target_include_directories(systemc INTERFACE "${SCONS_SOURCE_DIR}/src/systemc/ext/systemc_home/include")
+
+add_library(SystemC::systemc ALIAS systemc)
+
+add_subdirectory(DRAMSys)

ext/dramsys/README

@@ -1,10 +1,13 @@
-Follow these steps to get DRAMSys as part of gem5
+Follow these steps to build DRAMSys as part of gem5
 
 1. Go to ext/dramsys (this directory)
-2. Clone DRAMSys: 'git clone --recursive git@github.com:tukl-msd/DRAMSys.git DRAMSys'
-3. Change directory to DRAMSys: 'cd DRAMSys'
-4. Checkout the correct commit: 'git checkout -b gem5 09f6dcbb91351e6ee7cadfc7bc8b29d97625db8f'
+2. Clone DRAMSys: 'git clone https://github.com/tukl-msd/DRAMSys --branch v5.0 --depth 1 DRAMSys'
+
+The latest verified working version is v5.0, but later versions might work too.
+gem5 will automatically pick up DRAMSys as an external module when it is rebuilt.
 
 If you wish to run a simulation using the gem5 processor cores, make sure to enable the storage mode in DRAMSys.
 This is done by setting the value of the "StoreMode" key to "Store" in the base configuration file.
 Those configuration file can be found in 'DRAMSys/library/resources/configs/simulator'.
+
+Currently, DRAMSys is only supported in conjunction with a cache. Running DRAMSys in Release mode without caches will silently fail!

ext/dramsys/SConscript

@@ -25,72 +25,54 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 import os
+import subprocess
 
-Import('env')
+Import("env")
 
-build_root = Dir('../..').abspath
-src_root = Dir('DRAMSys/DRAMSys/library').srcnode().abspath
+build_root = Dir("../..").abspath
+build_current = Dir(".").abspath
+src_root = Dir(".").srcnode().abspath
+scons_root = Dir("#").abspath
 
 # See if we got a cloned DRAMSys repo as a subdirectory and set the
 # HAVE_DRAMSys flag accordingly
-if not os.path.exists(Dir('.').srcnode().abspath + '/DRAMSys'):
-    env['HAVE_DRAMSYS'] = False
+if not os.path.exists(Dir(".").srcnode().abspath + "/DRAMSys"):
+    env["HAVE_DRAMSYS"] = False
     Return()
 
-env['HAVE_DRAMSYS'] = True
+env["HAVE_DRAMSYS"] = True
 
-dramsys_files = []
-dramsys_configuration_files = []
+subprocess.run(
+    [
+        "cmake",
+        f"-S{src_root}",
+        f"-B{build_current}",
+        "-DCMAKE_BUILD_TYPE=Release",
+        f"-DSCONS_SOURCE_DIR:STRING={scons_root}",
+        "-DDRAMSYS_BUILD_CLI=OFF"
+    ],
+    check=True
+)
 
-dramsys_files.extend(Glob("%s/*.cpp" % f"{src_root}/src/controller"))
-for root, dirs, files in os.walk(f"{src_root}/src/controller", topdown=False):
-    for dir in dirs:
-        dramsys_files.extend(Glob("%s/*.cpp" % os.path.join(root, dir)))
+subprocess.run(
+    ["cmake", "--build", build_current],
+    check=True
+)
 
-dramsys_files.extend(Glob("%s/*.cpp" % f"{src_root}/src/simulation"))
-for root, dirs, files in os.walk(f"{src_root}/src/simulation", topdown=False):
-    for dir in dirs:
-        dramsys_files.extend(Glob("%s/*.cpp" % os.path.join(root, dir)))
+env.Append(LIBS="DRAMSys_libdramsys")
+env.Append(LIBPATH=Dir("./DRAMSys/src/libdramsys").abspath)
 
-dramsys_files.extend(Glob("%s/*.cpp" % f"{src_root}/src/configuration"))
-for root, dirs, files in os.walk(f"{src_root}/src/configuration", topdown=False):
-    for dir in dirs:
-        dramsys_files.extend(Glob("%s/*.cpp" % os.path.join(root, dir)))
+env.Append(LIBS="DRAMSys_Configuration")
+env.Append(LIBPATH=Dir("./DRAMSys/src/configuration").abspath)
 
-dramsys_files.extend(Glob("%s/*.cpp" % f"{src_root}/src/error"))
-dramsys_files.extend(Glob(f"{src_root}/src/error/ECC/Bit.cpp"))
-dramsys_files.extend(Glob(f"{src_root}/src/error/ECC/ECC.cpp"))
-dramsys_files.extend(Glob(f"{src_root}/src/error/ECC/Word.cpp"))
+env.Append(LIBS="sqlite3")
+env.Append(LIBPATH=Dir("./DRAMSys/lib/sqlite3").abspath)
 
-dramsys_files.extend(Glob("%s/*.cpp" % f"{src_root}/src/common"))
-dramsys_files.extend(Glob("%s/*.cpp" % f"{src_root}/src/common/configuration"))
-dramsys_files.extend(Glob("%s/*.cpp" % f"{src_root}/src/common/configuration/memspec"))
-dramsys_files.extend(Glob("%s/*.c" % f"{src_root}/src/common/third_party/sqlite-amalgamation"))
+env.Append(CPPPATH=src_root + "/DRAMSys/src/libdramsys")
+env.Append(CPPPATH=src_root + "/DRAMSys/src/configuration")
+env.Append(CPPPATH=src_root + "/DRAMSys/src/util")
+env.Append(CPPPATH=src_root + "/DRAMSys/lib/nlohmann_json/include")
 
-env.Prepend(CPPPATH=[
-    src_root + "/src",
-    src_root + "/src/common/configuration",
-    src_root + "/src/common/third_party/nlohmann/include",
-])
-
-env.Prepend(CPPDEFINES=[("DRAMSysResourceDirectory", '\\"' + os.getcwd() + '/resources' + '\\"')])
 env.Prepend(CPPDEFINES=[("SYSTEMC_VERSION", 20191203)])
-
-dramsys = env.Clone()
-
-if '-Werror' in dramsys['CCFLAGS']:
-    dramsys['CCFLAGS'].remove('-Werror')
-
-dramsys.Prepend(CPPPATH=[
-    src_root + "/src/common/third_party/sqlite-amalgamation",
-    build_root + "/systemc/ext"
-])
-
-dramsys.Prepend(CPPDEFINES=[("SQLITE_ENABLE_RTREE", "1")])
-
-dramsys_configuration = env.Clone()
-
-dramsys.Library('dramsys', dramsys_files)
-
-env.Append(LIBS=['dramsys', 'dl'])
-env.Append(LIBPATH=[Dir('.')])
+env.Prepend(CPPDEFINES=[("DRAMSYS_RESOURCE_DIR",
+                         '\\"' + os.getcwd() + '/DRAMSys/configs' + '\\"')])

src/mem/SConscript

@@ -124,6 +124,7 @@ if env['HAVE_DRAMSIM3']:
 if env['HAVE_DRAMSYS']:
     SimObject('DRAMSys.py', sim_objects=['DRAMSys'])
     Source('dramsys_wrapper.cc')
+    Source('dramsys.cc')
 
 SimObject('MemChecker.py', sim_objects=['MemChecker', 'MemCheckerMonitor'])
 Source('mem_checker.cc')

src/mem/dramsys.cc

@@ -0,0 +1,141 @@
+/*
+ * Copyright (c) 2023 Fraunhofer IESE
+ * 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 holders 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
+ * OWNER 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.
+ */
+
+#include "dramsys.hh"
+
+namespace gem5
+{
+
+namespace memory
+{
+
+DRAMSys::DRAMSys(Params const& params) :
+    AbstractMemory(params),
+    tlmWrapper(dramSysWrapper.tSocket, params.name + ".tlm", InvalidPortID),
+    config(::DRAMSys::Config::from_path(params.configuration,
+                                        params.resource_directory)),
+    dramSysWrapper(
+        params.name.c_str(), config, params.recordable, params.range)
+    // checker("checker")
+{
+    // checker.initiator_socket.bind(dramSysWrapper.tSocket);
+
+    dramSysWrapper.dramsys->registerIdleCallback(
+        [this]
+        {
+            if (dramSysWrapper.dramsys->idle())
+            {
+                signalDrainDone();
+            }
+        });
+}
+
+gem5::Port& DRAMSys::getPort(const std::string& if_name, PortID idx)
+{
+    if (if_name != "tlm")
+    {
+        return AbstractMemory::getPort(if_name, idx);
+    }
+
+    return tlmWrapper;
+}
+
+DrainState DRAMSys::drain()
+{
+    return dramSysWrapper.dramsys->idle() ? DrainState::Drained
+                                          : DrainState::Draining;
+}
+
+void DRAMSys::serialize(CheckpointOut& cp) const
+{
+    std::filesystem::path checkpointPath = CheckpointIn::dir();
+
+    auto topLevelObjects = sc_core::sc_get_top_level_objects();
+    for (auto const* object : topLevelObjects)
+    {
+        std::function<void(sc_core::sc_object const*)> serialize;
+        serialize =
+            [&serialize, &checkpointPath](sc_core::sc_object const* object)
+        {
+            auto const* serializableObject =
+                dynamic_cast<::DRAMSys::Serialize const*>(object);
+
+            if (serializableObject != nullptr)
+            {
+                std::string dumpFileName(object->name());
+                dumpFileName += ".pmem";
+                std::ofstream stream(checkpointPath / dumpFileName,
+                                     std::ios::binary);
+                serializableObject->serialize(stream);
+            }
+
+            for (auto const* childObject : object->get_child_objects())
+            {
+                serialize(childObject);
+            }
+        };
+
+        serialize(object);
+    }
+}
+
+void DRAMSys::unserialize(CheckpointIn& cp)
+{
+    std::filesystem::path checkpointPath = CheckpointIn::dir();
+
+    auto topLevelObjects = sc_core::sc_get_top_level_objects();
+    for (auto* object : topLevelObjects)
+    {
+        std::function<void(sc_core::sc_object*)> deserialize;
+        deserialize =
+            [&deserialize, &checkpointPath](sc_core::sc_object* object)
+        {
+            auto* deserializableObject =
+                dynamic_cast<::DRAMSys::Deserialize*>(object);
+
+            if (deserializableObject != nullptr)
+            {
+                std::string dumpFileName(object->name());
+                dumpFileName += ".pmem";
+                std::ifstream stream(checkpointPath / dumpFileName,
+                                     std::ios::binary);
+                deserializableObject->deserialize(stream);
+            }
+
+            for (auto* childObject : object->get_child_objects())
+            {
+                deserialize(childObject);
+            }
+        };
+
+        deserialize(object);
+    }
+}
+
+} // namespace memory
+} // namespace gem5

src/mem/dramsys.hh

@@ -29,10 +29,11 @@
 #ifndef __MEM_DRAMSYS_H__
 #define __MEM_DRAMSYS_H__
 
-#include "DRAMSysConfiguration.h"
+#include "DRAMSys/config/DRAMSysConfiguration.h"
 #include "mem/abstract_mem.hh"
 #include "mem/dramsys_wrapper.hh"
 #include "params/DRAMSys.hh"
+// #include "tlm2_base_protocol_checker.h"
 
 namespace gem5
 {
@@ -43,37 +44,22 @@ namespace memory
 class DRAMSys : public AbstractMemory
 {
     PARAMS(DRAMSys);
-    sc_gem5::TlmTargetWrapper<32> tlmWrapper;
+    sc_gem5::TlmTargetWrapper<> tlmWrapper;
 
   public:
-    DRAMSys(Params const &params)
-        : AbstractMemory(params),
-          tlmWrapper(dramSysWrapper.tSocket,
-              params.name + ".tlm",
-              InvalidPortID),
-          config(DRAMSysConfiguration::from_path(
-              params.configuration,
-              params.resource_directory)),
-          dramSysWrapper(params.name.c_str(),
-            config,
-            params.recordable,
-            params.range)
-    {
-    }
+    DRAMSys(Params const& params);
 
-    gem5::Port &getPort(const std::string &if_name, PortID idx) override
-    {
-        if (if_name != "tlm")
-        {
-            return AbstractMemory::getPort(if_name, idx);
-        }
+    gem5::Port& getPort(const std::string& if_name, PortID idx) override;
 
-        return tlmWrapper;
-    }
+    DrainState drain() override;
+
+    void serialize(CheckpointOut& cp) const override;
+    void unserialize(CheckpointIn& cp) override;
 
   private:
-    DRAMSysConfiguration::Configuration config;
+    ::DRAMSys::Config::Configuration config;
     DRAMSysWrapper dramSysWrapper;
+    // tlm_utils::tlm2_base_protocol_checker<> checker;
 };
 
 } // namespace memory

src/mem/dramsys_wrapper.cc

@@ -36,7 +36,7 @@ namespace memory
 
 DRAMSysWrapper::DRAMSysWrapper(
     sc_core::sc_module_name name,
-    DRAMSysConfiguration::Configuration const &config,
+    ::DRAMSys::Config::Configuration const &config,
     bool recordable,
     AddrRange range) :
     sc_core::sc_module(name),
@@ -44,28 +44,41 @@ DRAMSysWrapper::DRAMSysWrapper(
     range(range)
 {
     tSocket.register_nb_transport_fw(this, &DRAMSysWrapper::nb_transport_fw);
-    tSocket.register_transport_dbg(this, &DRAMSysWrapper::transport_dbg);
     iSocket.register_nb_transport_bw(this, &DRAMSysWrapper::nb_transport_bw);
+
+    tSocket.register_b_transport(this, &DRAMSysWrapper::b_transport);
+
+    tSocket.register_transport_dbg(this, &DRAMSysWrapper::transport_dbg);
     iSocket.bind(dramsys->tSocket);
 
     // Register a callback to compensate for the destructor not
     // being called.
     registerExitCallback(
-        [this]()
+        []()
         {
             // Workaround for BUG GEM5-1233
             sc_gem5::Kernel::stop();
         });
 }
 
-std::shared_ptr<::DRAMSys>
+std::shared_ptr<::DRAMSys::DRAMSys>
 DRAMSysWrapper::instantiateDRAMSys(
     bool recordable,
-    DRAMSysConfiguration::Configuration const &config)
+    ::DRAMSys::Config::Configuration const &config)
 {
     return recordable
-        ? std::make_shared<::DRAMSysRecordable>("DRAMSys", config)
-        : std::make_shared<::DRAMSys>("DRAMSys", config);
+        ? std::make_shared<::DRAMSys::DRAMSysRecordable>("DRAMSys", config)
+        : std::make_shared<::DRAMSys::DRAMSys>("DRAMSys", config);
+}
+
+void DRAMSysWrapper::b_transport(
+    tlm::tlm_generic_payload &payload,
+    sc_core::sc_time &delay)
+{
+    // Subtract base address offset
+    payload.set_address(payload.get_address() - range.start());
+
+    iSocket->b_transport(payload, delay);
 }
 
 tlm::tlm_sync_enum DRAMSysWrapper::nb_transport_fw(
@@ -76,6 +89,24 @@ tlm::tlm_sync_enum DRAMSysWrapper::nb_transport_fw(
     // Subtract base address offset
     payload.set_address(payload.get_address() - range.start());
 
+    if (payload.get_address() < 0x4000 && payload.is_write() && phase == tlm::BEGIN_REQ)
+    {
+        char *msg = reinterpret_cast<char*>(payload.get_data_ptr());
+        for (std::size_t i = 0; i < payload.get_data_length(); i++)
+        {
+            if (msg[i] != '\0')
+            {
+                message.push_back(msg[i]);
+            }
+            else
+            {
+                std::cout << message << std::endl;
+                message.clear();
+                break;
+            }
+        }
+    }
+
     return iSocket->nb_transport_fw(payload, phase, fwDelay);
 }
 

src/mem/dramsys_wrapper.hh

@@ -32,13 +32,14 @@
 #include <iostream>
 #include <memory>
 
-#include "DRAMSysConfiguration.h"
+#include "DRAMSys/config/DRAMSysConfiguration.h"
+#include "DRAMSys/simulation/DRAMSysRecordable.h"
 #include "mem/abstract_mem.hh"
 #include "params/DRAMSys.hh"
 #include "sim/core.hh"
-#include "simulation/DRAMSysRecordable.h"
 #include "systemc/core/kernel.hh"
 #include "systemc/ext/core/sc_module_name.hh"
+
 #include "systemc/ext/systemc"
 #include "systemc/ext/tlm"
 #include "systemc/ext/tlm_utils/simple_target_socket.h"
@@ -57,14 +58,14 @@ class DRAMSysWrapper : public sc_core::sc_module
   public:
     SC_HAS_PROCESS(DRAMSysWrapper);
     DRAMSysWrapper(sc_core::sc_module_name name,
-                   DRAMSysConfiguration::Configuration const &config,
+                   ::DRAMSys::Config::Configuration const &config,
                    bool recordable,
                    AddrRange range);
 
   private:
-    static std::shared_ptr<::DRAMSys>
+    static std::shared_ptr<::DRAMSys::DRAMSys>
     instantiateDRAMSys(bool recordable,
-        DRAMSysConfiguration::Configuration const &config);
+        ::DRAMSys::Config::Configuration const &config);
 
     tlm::tlm_sync_enum nb_transport_fw(tlm::tlm_generic_payload &payload,
                                        tlm::tlm_phase &phase,
@@ -74,12 +75,16 @@ class DRAMSysWrapper : public sc_core::sc_module
                                        tlm::tlm_phase &phase,
                                        sc_core::sc_time &bwDelay);
 
+    void b_transport(tlm::tlm_generic_payload &payload,
+                     sc_core::sc_time &delay);
+
     unsigned int transport_dbg(tlm::tlm_generic_payload &trans);
 
     tlm_utils::simple_initiator_socket<DRAMSysWrapper> iSocket;
     tlm_utils::simple_target_socket<DRAMSysWrapper> tSocket;
 
-    std::shared_ptr<::DRAMSys> dramsys;
+    std::shared_ptr<::DRAMSys::DRAMSys> dramsys;
+    std::string message;
 
     AddrRange range;
 };

src/python/SConscript

@@ -51,6 +51,7 @@ PySource('gem5.components.boards', 'gem5/components/boards/simple_board.py')
 PySource('gem5.components.boards', 'gem5/components/boards/test_board.py')
 PySource('gem5.components.boards', 'gem5/components/boards/x86_board.py')
 PySource('gem5.components.boards', 'gem5/components/boards/arm_board.py')
+PySource('gem5.components.boards', 'gem5/components/boards/arm_baremetal_board.py')
 PySource('gem5.components.boards',
     "gem5/components/boards/kernel_disk_workload.py")
 PySource('gem5.components.boards',

src/python/gem5/components/boards/arm_baremetal_board.py

@@ -0,0 +1,298 @@
+# Copyright (c) 2022 The Regents of the University of California
+# 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 holders 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
+# OWNER 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.
+
+from m5.objects import (
+    Port,
+    IOXBar,
+    Bridge,
+    BadAddr,
+    Terminal,
+    AddrRange,
+    ArmSystem,
+    ArmRelease,
+    ArmFsWorkload,
+    VoltageDomain,
+    SrcClockDomain,
+    ArmDefaultRelease,
+    VExpress_GEM5_Base,
+    VExpress_GEM5_Foundation,
+    SimObject,
+    VncServer,
+)
+
+from abc import ABCMeta
+from ...isas import ISA
+from ...utils.requires import requires
+from ...utils.override import overrides
+from typing import List, Sequence, Tuple
+from .abstract_board import AbstractBoard
+from ...resources.resource import AbstractResource, BinaryResource
+from .kernel_disk_workload import KernelDiskWorkload
+from ..cachehierarchies.classic.no_cache import NoCache
+from ..processors.abstract_processor import AbstractProcessor
+from ..memory.abstract_memory_system import AbstractMemorySystem
+from ..cachehierarchies.abstract_cache_hierarchy import AbstractCacheHierarchy
+
+
+class ArmBareMetalBoard(ArmSystem, AbstractBoard):
+    __metaclass__ = ABCMeta
+
+    def __init__(
+        self,
+        clk_freq: str,
+        processor: AbstractProcessor,
+        memory: AbstractMemorySystem,
+        cache_hierarchy: AbstractCacheHierarchy,
+        platform: VExpress_GEM5_Base = VExpress_GEM5_Foundation(),
+        release: ArmRelease = ArmDefaultRelease(),
+    ) -> None:
+        # The platform and the clk has to be set before calling the super class
+        self._platform = platform
+        self._clk_freq = clk_freq
+
+        super().__init__()
+        AbstractBoard.__init__(
+            self,
+            clk_freq=clk_freq,
+            processor=processor,
+            memory=memory,
+            cache_hierarchy=cache_hierarchy,
+        )
+
+        # This board requires ARM ISA to work.
+        requires(isa_required=ISA.ARM)
+
+        # Setting up ARM release here. We use the ARM default release, which
+        # corresponds to an ARMv8 system.
+        self.release = release
+
+        # Setting multi_proc of ArmSystem by counting the number of processors.
+        if processor.get_num_cores() == 1:
+            self.multi_proc = False
+        else:
+            self.multi_proc = True
+
+    @overrides(AbstractBoard)
+    def _setup_board(self) -> None:
+        # This board is expected to run full-system simulation.
+        # Loading ArmFsWorkload() from `src/arch/arm/ArmFsWorkload.py`
+        self.workload = ArmFsWorkload()
+
+        # We are fixing the following variable for the ArmSystem to work. The
+        # security extension is checked while generating the dtb file in
+        # realview. This board does not have security extension enabled.
+        self._have_psci = False
+
+        # highest_el_is_64 is set to True. True if the register width of the
+        # highest implemented exception level is 64 bits.
+        self.highest_el_is_64 = True
+
+        # Setting up the voltage and the clock domain here for the ARM board.
+        # The ArmSystem/RealView expects voltage_domain to be a parameter.
+        # The voltage and the clock frequency are taken from the devices.py
+        # file from configs/example/arm. We set the clock to the same frequency
+        # as the user specified in the config script.
+        self.voltage_domain = VoltageDomain(voltage="1.0V")
+        self.clk_domain = SrcClockDomain(
+            clock=self._clk_freq, voltage_domain=self.voltage_domain
+        )
+
+        # The ARM board supports both Terminal and VncServer.
+        self.terminal = Terminal()
+        self.vncserver = VncServer()
+
+        # Incoherent I/O Bus
+        self.iobus = IOXBar()
+        self.iobus.badaddr_responder = BadAddr()
+        self.iobus.default = self.iobus.badaddr_responder.pio
+
+        # We now need to setup the dma_ports.
+        self._dma_ports = None
+
+        # RealView sets up most of the on-chip and off-chip devices and GIC
+        # for the ARM board. These devices' information is also used to
+        # generate the dtb file. We then connect the I/O devices to the
+        # I/O bus.
+        self._setup_io_devices()
+
+        # Once the realview is setup, we can continue setting up the memory
+        # ranges. ArmBoard's memory can only be setup once realview is
+        # initialized.
+        memory = self.get_memory()
+        mem_size = memory.get_size()
+
+        # The following code is taken from configs/example/arm/devices.py. It
+        # sets up all the memory ranges for the board.
+        self.mem_ranges = []
+        success = False
+        for mem_range in self.realview._mem_regions:
+            size_in_range = min(mem_size, mem_range.size())
+            self.mem_ranges.append(
+                AddrRange(start=mem_range.start, size=size_in_range)
+            )
+
+            mem_size -= size_in_range
+            if mem_size == 0:
+                success = True
+                break
+
+        if success:
+            memory.set_memory_range(self.mem_ranges)
+        else:
+            raise ValueError("Memory size too big for platform capabilities")
+
+    def _setup_io_devices(self) -> None:
+        """
+        This method first sets up the platform. ARM uses `realview` platform.
+        Most of the on-chip and off-chip devices are setup by the realview
+        platform. Once realview is setup, we connect the I/O devices to the
+        I/O bus.
+        """
+
+        # Currently, the ArmBoard supports VExpress_GEM5_V1,
+        # VExpress_GEM5_V1_HDLcd and VExpress_GEM5_Foundation.
+        # VExpress_GEM5_V2 and VExpress_GEM5_V2_HDLcd are not supported by the
+        # ArmBoard.
+        self.realview = self._platform
+
+        # We need to setup the global interrupt controller (GIC) addr for the
+        # realview system.
+        if hasattr(self.realview.gic, "cpu_addr"):
+            self.gic_cpu_addr = self.realview.gic.cpu_addr
+
+        # IO devices has to setup before incorporating the caches in the case
+        # of ruby caches. Otherwise the DMA controllers are incorrectly
+        # created. The IO device has to be attached first. This is done in the
+        # realview class.
+        if self.get_cache_hierarchy().is_ruby():
+            # All the on-chip devices are attached in this method.
+            self.realview.attachOnChipIO(
+                self.iobus,
+                dma_ports=self.get_dma_ports(),
+                mem_ports=self.get_memory().get_mem_ports(),
+            )
+            self.realview.attachIO(self.iobus, dma_ports=self.get_dma_ports())
+
+        else:
+            # We either have iocache or dmabridge depending upon the
+            # cache_hierarchy. If we have "NoCache", then we use the dmabridge.
+            # Otherwise, we use the iocache on the board.
+
+            # We setup the iobridge for the ARM Board. The default
+            # cache_hierarchy's NoCache class has an iobridge has a latency
+            # of 10. We are using an iobridge with latency = 50ns, taken
+            # from the configs/example/arm/devices.py.
+            self.iobridge = Bridge(delay="50ns")
+            self.iobridge.mem_side_port = self.iobus.cpu_side_ports
+            self.iobridge.cpu_side_port = (
+                self.cache_hierarchy.get_mem_side_port()
+            )
+
+            if isinstance(self.cache_hierarchy, NoCache) is True:
+                # This corresponds to a machine without caches. We have a DMA
+                # bridge in this case. Parameters of this bridge are also taken
+                # from the common/example/arm/devices.py file.
+                self.dmabridge = Bridge(delay="50ns", ranges=self.mem_ranges)
+                self.dmabridge.mem_side_port = (
+                    self.cache_hierarchy.get_cpu_side_port()
+                )
+                self.dmabridge.cpu_side_port = self.iobus.mem_side_ports
+
+            # The classic caches are setup in the  _setup_io_cache() method
+            # defined under the cachehierarchy class. Verified it with both
+            # PrivateL1PrivateL2CacheHierarchy and PrivateL1CacheHierarchy
+            # classes.
+            self.realview.attachOnChipIO(
+                self.cache_hierarchy.membus, self.iobridge
+            )
+            self.realview.attachIO(self.iobus)
+
+    @overrides(AbstractBoard)
+    def has_io_bus(self) -> bool:
+        return True
+
+    @overrides(AbstractBoard)
+    def get_io_bus(self) -> IOXBar:
+        return self.iobus
+
+    @overrides(AbstractBoard)
+    def has_coherent_io(self) -> bool:
+        # The setup of the caches gets a little tricky here. We need to
+        # override the default cache_hierarchy.iobridge due to different delay
+        # values (see method _setup_io_devices()). One way to do it would be to
+        # prevent creating cache_hierarchy.iobridge altogether. We trick
+        # NoCache() to assume that this board has no coherent_io and we we
+        # simply setup our own iobridge in the _setup_io_devices() method.
+        if isinstance(self.cache_hierarchy, NoCache):
+            return False
+        # In all other cases, we use the default values setup in the
+        # respective cache hierarchy class.
+        return True
+
+    @overrides(AbstractBoard)
+    def get_mem_side_coherent_io_port(self) -> Port:
+        return self.iobus.mem_side_ports
+
+    @overrides(AbstractBoard)
+    def has_dma_ports(self) -> bool:
+        return True
+
+    @overrides(AbstractBoard)
+    def get_dma_ports(self) -> List[Port]:
+        # The DMA ports differ depending upon the cache hierarchy. The method
+        # self.set_dma_ports takes care of that. In the case of ruby caches,
+        # this method should initially return an empty list.
+        if self.cache_hierarchy.is_ruby():
+            if self._dma_ports is None:
+                self._dma_ports = []
+
+        # _dma_ports should always be empty for classic caches.
+        return self._dma_ports
+
+    @overrides(AbstractBoard)
+    def connect_system_port(self, port: Port) -> None:
+        self.system_port = port
+
+    @overrides(AbstractBoard)
+    def _setup_memory_ranges(self) -> None:
+        """
+        The ArmBoard's memory can only be setup after realview is setup. We set
+        this up in the `_setup_board` function.
+        """
+        pass
+
+    def set_baremetal_workload(self, kernel: BinaryResource) -> None:
+        self._set_fullsystem(True)
+        self.workload.object_file = kernel.get_local_path()
+
+    @overrides(SimObject)
+    def createCCObject(self):
+        """We override this function as it is called in `m5.instantiate`. This
+        means we can insert a check to ensure the `_connect_things` function
+        has been run.
+        """
+        super()._connect_things_check()
+        super().createCCObject()

src/python/gem5/components/memory/dramsys.py

@@ -24,7 +24,8 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-import m5
+from typing import Tuple, Sequence, List, Optional
+from pathlib import Path
 
 from m5.objects import (
     DRAMSys,
@@ -40,27 +41,46 @@ from ...utils.override import overrides
 from ..boards.abstract_board import AbstractBoard
 from .abstract_memory_system import AbstractMemorySystem
 
-from typing import Tuple, Sequence, List
+
+DEFAULT_DRAMSYS_DIRECTORY = Path("ext/dramsys/DRAMSys")
 
 
 class DRAMSysMem(AbstractMemorySystem):
+    """
+    A DRAMSys memory controller.
+
+    This class requires gem5 to be built with DRAMSys (see ext/dramsys).
+    The specified memory size does not control the simulated memory size but it's sole purpose is
+    to notify gem5 of DRAMSys's memory size.
+    Therefore it has to match the DRAMSys configuration.
+    DRAMSys is configured using JSON files, whose base configuration has to be passed as a
+    parameter. Sub-configs are specified relative to the optional resource directory parameter.
+    """
+
     def __init__(
         self,
         configuration: str,
         size: str,
-        resource_directory: str,
         recordable: bool,
+        resource_directory: Optional[str] = None,
     ) -> None:
         """
         :param configuration: Path to the base configuration JSON for DRAMSys.
         :param size: Memory size of DRAMSys. Must match the size specified in JSON configuration.
-        :param resource_directory: Path to the base resource directory for DRAMSys.
         :param recordable: Whether the database recording feature of DRAMSys is enabled.
+        :param resource_directory: Path to the base resource directory for DRAMSys.
         """
         super().__init__()
+
+        resource_directory_path = (
+            DEFAULT_DRAMSYS_DIRECTORY / "configs"
+            if resource_directory is None
+            else Path(resource_directory)
+        )
+
         self.dramsys = DRAMSys(
             configuration=configuration,
-            resource_directory=resource_directory,
+            resource_directory=resource_directory_path.as_posix(),
             recordable=recordable,
         )
 
@@ -97,56 +117,72 @@ class DRAMSysMem(AbstractMemorySystem):
 
 
 class DRAMSysDDR4_1866(DRAMSysMem):
+    """
+    An example DDR4 1866 DRAMSys configuration.
+    """
+
     def __init__(self, recordable: bool):
         """
         :param recordable: Whether the database recording feature of DRAMSys is enabled.
         """
         super().__init__(
-            configuration="ext/dramsys/DRAMSys/DRAMSys/"
-            "library/resources/simulations/ddr4-example.json",
+            configuration=(
+                DEFAULT_DRAMSYS_DIRECTORY / "configs/ddr4-example.json"
+            ).as_posix(),
             size="4GB",
-            resource_directory="ext/dramsys/DRAMSys/DRAMSys/library/resources",
             recordable=recordable,
         )
 
 
 class DRAMSysDDR3_1600(DRAMSysMem):
+    """
+    An example DDR3 1600 DRAMSys configuration.
+    """
+
     def __init__(self, recordable: bool):
         """
         :param recordable: Whether the database recording feature of DRAMSys is enabled.
         """
         super().__init__(
-            configuration="ext/dramsys/DRAMSys/DRAMSys/"
-            "library/resources/simulations/ddr3-gem5-se.json",
-            size="4GB",
-            resource_directory="ext/dramsys/DRAMSys/DRAMSys/library/resources",
+            configuration=(
+                DEFAULT_DRAMSYS_DIRECTORY / "configs/ddr3-gem5-se.json"
+            ).as_posix(),
+            size="1GB",
             recordable=recordable,
         )
 
 
 class DRAMSysLPDDR4_3200(DRAMSysMem):
+    """
+    An example LPDDR4 3200 DRAMSys configuration.
+    """
+
     def __init__(self, recordable: bool):
         """
         :param recordable: Whether the database recording feature of DRAMSys is enabled.
         """
         super().__init__(
-            configuration="ext/dramsys/DRAMSys/DRAMSys/"
-            "library/resources/simulations/lpddr4-example.json",
-            size="4GB",
-            resource_directory="ext/dramsys/DRAMSys/DRAMSys/library/resources",
+            configuration=(
+                DEFAULT_DRAMSYS_DIRECTORY / "configs/lpddr4-example.json"
+            ).as_posix(),
+            size="1GB",
             recordable=recordable,
         )
 
 
 class DRAMSysHBM2(DRAMSysMem):
+    """
+    An example HBM2 DRAMSys configuration.
+    """
+
     def __init__(self, recordable: bool):
         """
         :param recordable: Whether the database recording feature of DRAMSys is enabled.
         """
         super().__init__(
-            configuration="ext/dramsys/DRAMSys/DRAMSys/"
-            "library/resources/simulations/hbm2-example.json",
-            size="4GB",
-            resource_directory="ext/dramsys/DRAMSys/DRAMSys/library/resources",
+            configuration=(
+                DEFAULT_DRAMSYS_DIRECTORY / "configs/hbm2-example.json"
+            ).as_posix(),
+            size="1GB",
             recordable=recordable,
         )

src/systemc/tlm_bridge/gem5_to_tlm.cc

@@ -67,6 +67,7 @@
 #include "params/Gem5ToTlmBridge512.hh"
 #include "sim/eventq.hh"
 #include "sim/system.hh"
+#include "systemc/ext/tlm_core/2/generic_payload/gp.hh"
 #include "systemc/tlm_bridge/sc_ext.hh"
 #include "systemc/tlm_bridge/sc_mm.hh"
 
@@ -152,6 +153,7 @@ packet2payload(PacketPtr packet)
     trans->acquire();
 
     trans->set_address(packet->getAddr());
+    trans->set_response_status(tlm::TLM_INCOMPLETE_RESPONSE);
 
     /* Check if this transaction was allocated by mm */
     sc_assert(trans->has_mm());
@@ -480,7 +482,7 @@ Gem5ToTlmBridge<BITWIDTH>::recvRespRetry()
 
     tlm::tlm_generic_payload *trans = blockingResponse;
     blockingResponse = nullptr;
-    PacketPtr packet = packetMap[blockingResponse];
+    PacketPtr packet = packetMap[trans];
     sc_assert(packet);
 
     bool need_retry = !bridgeResponsePort.sendTimingResp(packet);