mem-ruby: Support device memories
authorMatthew Poremba <matthew.poremba@amd.com>
Wed, 27 May 2020 22:28:51 +0000 (17:28 -0500)
committerMatthew Poremba <matthew.poremba@amd.com>
Wed, 1 Jul 2020 14:38:11 +0000 (14:38 +0000)
Adds support for device memories in the system and RubySystem classes.
Devices may register memory ranges with the system class and packets
which originate from the device MasterID will update the device memory
in Ruby. In RubySystem functional access is updated to keep the packets
within the Ruby network they originated from.

Change-Id: I47850df1dc1994485d471ccd9da89e8d88eb0d20
JIRA: https://gem5.atlassian.net/browse/GEM5-470
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/29653
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: kokoro <noreply+kokoro@google.com>
src/mem/ruby/network/Network.cc
src/mem/ruby/slicc_interface/AbstractController.cc
src/mem/ruby/slicc_interface/AbstractController.hh
src/mem/ruby/system/RubyPort.cc
src/mem/ruby/system/RubyPort.hh
src/mem/ruby/system/RubySystem.cc
src/mem/ruby/system/RubySystem.hh
src/mem/ruby/system/RubySystem.py
src/mem/slicc/symbols/StateMachine.py
src/sim/system.cc
src/sim/system.hh

index 982b57e27b4c72a3e19122b77da1ffa0ccc2a95c..ba847e5e85c086cc739f2dba42e0358af36d12f7 100644 (file)
@@ -55,6 +55,8 @@ Network::Network(const Params *p)
     m_virtual_networks = p->number_of_virtual_networks;
     m_control_msg_size = p->control_msg_size;
 
+    params()->ruby_system->registerNetwork(this);
+
     // Populate localNodeVersions with the version of each MachineType in
     // this network. This will be used to compute a global to local ID.
     // Do this by looking at the ext_node for each ext_link. There is one
@@ -64,6 +66,7 @@ Network::Network(const Params *p)
     for (auto &it : params()->ext_links) {
         AbstractController *cntrl = it->params()->ext_node;
         localNodeVersions[cntrl->getType()].push_back(cntrl->getVersion());
+        params()->ruby_system->registerMachineID(cntrl->getMachineID(), this);
     }
 
     // Compute a local ID for each MachineType using the same order as SLICC
@@ -104,8 +107,6 @@ Network::Network(const Params *p)
         m_ordered[i] = false;
     }
 
-    params()->ruby_system->registerNetwork(this);
-
     // Initialize the controller's network pointers
     for (std::vector<BasicExtLink*>::const_iterator i = p->ext_links.begin();
          i != p->ext_links.end(); ++i) {
index bdc88b9ef7b8a2ac4714dc1bdad7ed2105cd8aaf..9da87271e108361d474482bdba5a18eb5dce9819 100644 (file)
@@ -68,7 +68,6 @@ AbstractController::AbstractController(const Params *p)
 void
 AbstractController::init()
 {
-    params()->ruby_system->registerAbstractController(this);
     m_delayHistogram.init(10);
     uint32_t size = Network::getNumberOfVirtualNetworks();
     for (uint32_t i = 0; i < size; i++) {
index 1577cfa6fa37fcd4c2346b2c8b86ca029d073289..750a620bdd7f757fd192f49f6dd09c9bbb421956 100644 (file)
@@ -147,6 +147,7 @@ class AbstractController : public ClockedObject, public Consumer
 
   public:
     MachineID getMachineID() const { return m_machineID; }
+    MasterID getMasterId() const { return m_masterId; }
 
     Stats::Histogram& getDelayHist() { return m_delayHistogram; }
     Stats::Histogram& getDelayVCHist(uint32_t index)
index 92fed81dd2203a3442b4be9bd94159679801c36c..0526e65609071f9659972aee62f39652c87a02a4 100644 (file)
@@ -252,7 +252,7 @@ RubyPort::MemSlavePort::recvTimingReq(PacketPtr pkt)
     // Check for pio requests and directly send them to the dedicated
     // pio port.
     if (pkt->cmd != MemCmd::MemFenceReq) {
-        if (!isPhysMemAddress(pkt->getAddr())) {
+        if (!isPhysMemAddress(pkt)) {
             assert(ruby_port->memMasterPort.isConnected());
             DPRINTF(RubyPort, "Request address %#x assumed to be a "
                     "pio address\n", pkt->getAddr());
@@ -313,7 +313,7 @@ RubyPort::MemSlavePort::recvAtomic(PacketPtr pkt)
     // Check for pio requests and directly send them to the dedicated
     // pio port.
     if (pkt->cmd != MemCmd::MemFenceReq) {
-        if (!isPhysMemAddress(pkt->getAddr())) {
+        if (!isPhysMemAddress(pkt)) {
             assert(ruby_port->memMasterPort.isConnected());
             DPRINTF(RubyPort, "Request address %#x assumed to be a "
                     "pio address\n", pkt->getAddr());
@@ -371,7 +371,7 @@ RubyPort::MemSlavePort::recvFunctional(PacketPtr pkt)
 
     // Check for pio requests and directly send them to the dedicated
     // pio port.
-    if (!isPhysMemAddress(pkt->getAddr())) {
+    if (!isPhysMemAddress(pkt)) {
         DPRINTF(RubyPort, "Pio Request for address: 0x%#x\n", pkt->getAddr());
         assert(rp->pioMasterPort.isConnected());
         rp->pioMasterPort.sendFunctional(pkt);
@@ -431,7 +431,7 @@ RubyPort::ruby_hit_callback(PacketPtr pkt)
 
     // The packet was destined for memory and has not yet been turned
     // into a response
-    assert(system->isMemAddr(pkt->getAddr()));
+    assert(system->isMemAddr(pkt->getAddr()) || system->isDeviceMemAddr(pkt));
     assert(pkt->isRequest());
 
     // First we must retrieve the request port from the sender State
@@ -553,7 +553,16 @@ RubyPort::MemSlavePort::hitCallback(PacketPtr pkt)
     RubyPort *ruby_port = static_cast<RubyPort *>(&owner);
     RubySystem *rs = ruby_port->m_ruby_system;
     if (accessPhysMem) {
-        rs->getPhysMem()->access(pkt);
+        // We must check device memory first in case it overlaps with the
+        // system memory range.
+        if (ruby_port->system->isDeviceMemAddr(pkt)) {
+            auto dmem = ruby_port->system->getDeviceMemory(pkt->masterId());
+            dmem->access(pkt);
+        } else if (ruby_port->system->isMemAddr(pkt->getAddr())) {
+            rs->getPhysMem()->access(pkt);
+        } else {
+            panic("Packet is in neither device nor system memory!");
+        }
     } else if (needsResponse) {
         pkt->makeResponse();
     }
@@ -589,10 +598,11 @@ RubyPort::PioSlavePort::getAddrRanges() const
 }
 
 bool
-RubyPort::MemSlavePort::isPhysMemAddress(Addr addr) const
+RubyPort::MemSlavePort::isPhysMemAddress(PacketPtr pkt) const
 {
     RubyPort *ruby_port = static_cast<RubyPort *>(&owner);
-    return ruby_port->system->isMemAddr(addr);
+    return ruby_port->system->isMemAddr(pkt->getAddr())
+        || ruby_port->system->isDeviceMemAddr(pkt);
 }
 
 void
index b14e707465d7b41fdd912eb5ef41950334f8856d..1e21090ad65833e6318ed092d35c456ba679743f 100644 (file)
@@ -99,7 +99,7 @@ class RubyPort : public ClockedObject
         void addToRetryList();
 
       private:
-        bool isPhysMemAddress(Addr addr) const;
+        bool isPhysMemAddress(PacketPtr pkt) const;
     };
 
     class PioMasterPort : public QueuedMasterPort
index 9fa47362bc1e28ef5d5ae92442f036164baec249..5babf2ddaef8cf9997aaaa52ccbd913f7d64703d 100644 (file)
@@ -57,6 +57,7 @@
 #include "mem/simple_mem.hh"
 #include "sim/eventq.hh"
 #include "sim/simulate.hh"
+#include "sim/system.hh"
 
 using namespace std;
 
@@ -106,6 +107,61 @@ RubySystem::registerAbstractController(AbstractController* cntrl)
     m_abstract_controls[id.getType()][id.getNum()] = cntrl;
 }
 
+void
+RubySystem::registerMachineID(const MachineID& mach_id, Network* network)
+{
+    int network_id = -1;
+    for (int idx = 0; idx < m_networks.size(); ++idx) {
+        if (m_networks[idx].get() == network) {
+            network_id = idx;
+        }
+    }
+
+    fatal_if(network_id < 0, "Could not add MachineID %s. Network not found",
+             MachineIDToString(mach_id).c_str());
+
+    machineToNetwork.insert(std::make_pair(mach_id, network_id));
+}
+
+// This registers all master IDs in the system for functional reads. This
+// should be called in init() since master IDs are obtained in a SimObject's
+// constructor and there are functional reads/writes between init() and
+// startup().
+void
+RubySystem::registerMasterIDs()
+{
+    // Create the map for MasterID to network node. This is done in init()
+    // because all MasterIDs must be obtained in the constructor and
+    // AbstractControllers are registered in their constructor. This is done
+    // in two steps: (1) Add all of the AbstractControllers. Since we don't
+    // have a mapping of MasterID to MachineID this is the easiest way to
+    // filter out AbstractControllers from non-Ruby masters. (2) Go through
+    // the system's list of MasterIDs and add missing MasterIDs to network 0
+    // (the default).
+    for (auto& cntrl : m_abs_cntrl_vec) {
+        MasterID mid = cntrl->getMasterId();
+        MachineID mach_id = cntrl->getMachineID();
+
+        // These are setup in Network constructor and should exist
+        fatal_if(!machineToNetwork.count(mach_id),
+                 "No machineID %s. Does not belong to a Ruby network?",
+                 MachineIDToString(mach_id).c_str());
+
+        auto network_id = machineToNetwork[mach_id];
+        masterToNetwork.insert(std::make_pair(mid, network_id));
+
+        // Create helper vectors for each network to iterate over.
+        netCntrls[network_id].push_back(cntrl);
+    }
+
+    // Default all other master IDs to network 0
+    for (auto mid = 0; mid < params()->system->maxMasters(); ++mid) {
+        if (!masterToNetwork.count(mid)) {
+            masterToNetwork.insert(std::make_pair(mid, 0));
+        }
+    }
+}
+
 RubySystem::~RubySystem()
 {
     delete m_profiler;
@@ -341,6 +397,12 @@ RubySystem::unserialize(CheckpointIn &cp)
     makeCacheRecorder(uncompressed_trace, cache_trace_size, block_size_bytes);
 }
 
+void
+RubySystem::init()
+{
+    registerMasterIDs();
+}
+
 void
 RubySystem::startup()
 {
@@ -418,7 +480,6 @@ RubySystem::functionalRead(PacketPtr pkt)
     Addr line_address = makeLineAddress(address);
 
     AccessPermission access_perm = AccessPermission_NotPresent;
-    int num_controllers = m_abs_cntrl_vec.size();
 
     DPRINTF(RubySystem, "Functional Read request for %#x\n", address);
 
@@ -429,21 +490,26 @@ RubySystem::functionalRead(PacketPtr pkt)
     unsigned int num_backing_store = 0;
     unsigned int num_invalid = 0;
 
+    // Only send functional requests within the same network.
+    assert(masterToNetwork.count(pkt->masterId()));
+    int master_net_id = masterToNetwork[pkt->masterId()];
+    assert(netCntrls.count(master_net_id));
+
     AbstractController *ctrl_ro = nullptr;
     AbstractController *ctrl_rw = nullptr;
     AbstractController *ctrl_backing_store = nullptr;
 
     // In this loop we count the number of controllers that have the given
     // address in read only, read write and busy states.
-    for (unsigned int i = 0; i < num_controllers; ++i) {
-        access_perm = m_abs_cntrl_vec[i]-> getAccessPermission(line_address);
+    for (auto& cntrl : netCntrls[master_net_id]) {
+        access_perm = cntrl-> getAccessPermission(line_address);
         if (access_perm == AccessPermission_Read_Only){
             num_ro++;
-            if (ctrl_ro == nullptr) ctrl_ro = m_abs_cntrl_vec[i];
+            if (ctrl_ro == nullptr) ctrl_ro = cntrl;
         }
         else if (access_perm == AccessPermission_Read_Write){
             num_rw++;
-            if (ctrl_rw == nullptr) ctrl_rw = m_abs_cntrl_vec[i];
+            if (ctrl_rw == nullptr) ctrl_rw = cntrl;
         }
         else if (access_perm == AccessPermission_Busy)
             num_busy++;
@@ -456,7 +522,7 @@ RubySystem::functionalRead(PacketPtr pkt)
             // or not.
             num_backing_store++;
             if (ctrl_backing_store == nullptr)
-                ctrl_backing_store = m_abs_cntrl_vec[i];
+                ctrl_backing_store = cntrl;
         }
         else if (access_perm == AccessPermission_Invalid ||
                  access_perm == AccessPermission_NotPresent)
@@ -471,6 +537,7 @@ RubySystem::functionalRead(PacketPtr pkt)
     // The reason is because the Backing_Store memory could easily be stale, if
     // there are copies floating around the cache hierarchy, so you want to read
     // it only if it's not in the cache hierarchy at all.
+    int num_controllers = netCntrls[master_net_id].size();
     if (num_invalid == (num_controllers - 1) && num_backing_store == 1) {
         DPRINTF(RubySystem, "only copy in Backing_Store memory, read from it\n");
         ctrl_backing_store->functionalRead(line_address, pkt);
@@ -506,8 +573,8 @@ RubySystem::functionalRead(PacketPtr pkt)
         DPRINTF(RubySystem, "Controllers functionalRead lookup "
                             "(num_maybe_stale=%d, num_busy = %d)\n",
                 num_maybe_stale, num_busy);
-        for (unsigned int i = 0; i < num_controllers;++i) {
-            if (m_abs_cntrl_vec[i]->functionalReadBuffers(pkt))
+        for (auto& cntrl : netCntrls[master_net_id]) {
+            if (cntrl->functionalReadBuffers(pkt))
                 return true;
         }
         DPRINTF(RubySystem, "Network functionalRead lookup "
@@ -532,32 +599,35 @@ RubySystem::functionalWrite(PacketPtr pkt)
     Addr addr(pkt->getAddr());
     Addr line_addr = makeLineAddress(addr);
     AccessPermission access_perm = AccessPermission_NotPresent;
-    int num_controllers = m_abs_cntrl_vec.size();
 
     DPRINTF(RubySystem, "Functional Write request for %#x\n", addr);
 
     uint32_t M5_VAR_USED num_functional_writes = 0;
 
-    for (unsigned int i = 0; i < num_controllers;++i) {
-        num_functional_writes +=
-            m_abs_cntrl_vec[i]->functionalWriteBuffers(pkt);
+    // Only send functional requests within the same network.
+    assert(masterToNetwork.count(pkt->masterId()));
+    int master_net_id = masterToNetwork[pkt->masterId()];
+    assert(netCntrls.count(master_net_id));
+
+    for (auto& cntrl : netCntrls[master_net_id]) {
+        num_functional_writes += cntrl->functionalWriteBuffers(pkt);
 
-        access_perm = m_abs_cntrl_vec[i]->getAccessPermission(line_addr);
+        access_perm = cntrl->getAccessPermission(line_addr);
         if (access_perm != AccessPermission_Invalid &&
             access_perm != AccessPermission_NotPresent) {
             num_functional_writes +=
-                m_abs_cntrl_vec[i]->functionalWrite(line_addr, pkt);
+                cntrl->functionalWrite(line_addr, pkt);
         }
 
         // Also updates requests pending in any sequencer associated
         // with the controller
-        if (m_abs_cntrl_vec[i]->getCPUSequencer()) {
+        if (cntrl->getCPUSequencer()) {
             num_functional_writes +=
-                m_abs_cntrl_vec[i]->getCPUSequencer()->functionalWrite(pkt);
+                cntrl->getCPUSequencer()->functionalWrite(pkt);
         }
-        if (m_abs_cntrl_vec[i]->getDMASequencer()) {
+        if (cntrl->getDMASequencer()) {
             num_functional_writes +=
-                m_abs_cntrl_vec[i]->getDMASequencer()->functionalWrite(pkt);
+                cntrl->getDMASequencer()->functionalWrite(pkt);
         }
     }
 
index 240707285079be161dd0518b417f21ea071ced69..7ce5ce078d396cd50a8f79e86a4d596e4fad32fd 100644 (file)
@@ -35,6 +35,8 @@
 #ifndef __MEM_RUBY_SYSTEM_RUBYSYSTEM_HH__
 #define __MEM_RUBY_SYSTEM_RUBYSYSTEM_HH__
 
+#include <unordered_map>
+
 #include "base/callback.hh"
 #include "base/output.hh"
 #include "mem/packet.hh"
@@ -53,6 +55,7 @@ class RubySystem : public ClockedObject
     typedef RubySystemParams Params;
     RubySystem(const Params *p);
     ~RubySystem();
+    const Params *params() const { return (const Params *)_params; }
 
     // config accessors
     static int getRandomization() { return m_randomization; }
@@ -86,12 +89,15 @@ class RubySystem : public ClockedObject
     void unserialize(CheckpointIn &cp) override;
     void drainResume() override;
     void process();
+    void init() override;
     void startup() override;
     bool functionalRead(Packet *ptr);
     bool functionalWrite(Packet *ptr);
 
     void registerNetwork(Network*);
     void registerAbstractController(AbstractController*);
+    void registerMachineID(const MachineID& mach_id, Network* network);
+    void registerMasterIDs();
 
     bool eventQueueEmpty() { return eventq->empty(); }
     void enqueueRubyEvent(Tick tick)
@@ -135,6 +141,10 @@ class RubySystem : public ClockedObject
     std::vector<AbstractController *> m_abs_cntrl_vec;
     Cycles m_start_cycle;
 
+    std::unordered_map<MachineID, unsigned> machineToNetwork;
+    std::unordered_map<MasterID, unsigned> masterToNetwork;
+    std::unordered_map<unsigned, std::vector<AbstractController*>> netCntrls;
+
   public:
     Profiler* m_profiler;
     CacheRecorder* m_cache_recorder;
index 1ce4871dc583c12698d45889f2117d593c86987c..347896f6cf8dc95a44a135ada8c67578b4bce341 100644 (file)
@@ -25,6 +25,7 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 from m5.params import *
+from m5.proxy import *
 from m5.objects.ClockedObject import ClockedObject
 from m5.objects.SimpleMemory import *
 
@@ -41,6 +42,7 @@ class RubySystem(ClockedObject):
         "number of bits that a memory address requires");
 
     phys_mem = Param.SimpleMemory(NULL, "")
+    system = Param.System(Parent.any, "system object")
 
     access_backing_store = Param.Bool(False, "Use phys_mem as the functional \
         store and only use ruby for timing.")
index 2e9700fcfc8e83961e015480eddd9cd82cbcac1e..987f3b5f13c1d98903da97d4e56641220807dd5f 100644 (file)
@@ -558,6 +558,7 @@ $c_ident::$c_ident(const Params *p)
     m_machineID.type = MachineType_${ident};
     m_machineID.num = m_version;
     m_num_controllers++;
+    p->ruby_system->registerAbstractController(this);
 
     m_in_ports = $num_in_ports;
 ''')
index 6e5975e9d6c3df166d5af83175b1fe6cbb546b41..7057a9742e595621f748b31c49df1efe7bef2722 100644 (file)
@@ -417,6 +417,31 @@ System::isMemAddr(Addr addr) const
     return physmem.isMemAddr(addr);
 }
 
+void
+System::addDeviceMemory(MasterID masterId, AbstractMemory *deviceMemory)
+{
+    if (!deviceMemMap.count(masterId)) {
+        deviceMemMap.insert(std::make_pair(masterId, deviceMemory));
+    }
+}
+
+bool
+System::isDeviceMemAddr(PacketPtr pkt) const
+{
+    const MasterID& mid = pkt->masterId();
+
+    return (deviceMemMap.count(mid) &&
+            deviceMemMap.at(mid)->getAddrRange().contains(pkt->getAddr()));
+}
+
+AbstractMemory *
+System::getDeviceMemory(MasterID mid) const
+{
+    panic_if(!deviceMemMap.count(mid),
+             "No device memory found for MasterID %d\n", mid);
+    return deviceMemMap.at(mid);
+}
+
 void
 System::drainResume()
 {
index 72734f86d5d8bc8d5151d7b912fa7ea10cf9199a..9480821ecae29cef7d01e74c21a03247bb5f7ca2 100644 (file)
@@ -98,6 +98,9 @@ class System : public SimObject, public PCEventScope
     std::list<PCEvent *> liveEvents;
     SystemPort _systemPort;
 
+    // Map of memory address ranges for devices with their own backing stores
+    std::unordered_map<MasterID, AbstractMemory *> deviceMemMap;
+
   public:
 
     class Threads
@@ -353,6 +356,25 @@ class System : public SimObject, public PCEventScope
      */
     bool isMemAddr(Addr addr) const;
 
+    /**
+     * Add a physical memory range for a device. The ranges added here will
+     * be considered a non-PIO memory address if the masterId of the packet
+     * and range match something in the device memory map.
+     */
+    void addDeviceMemory(MasterID masterID, AbstractMemory *deviceMemory);
+
+    /**
+     * Similar to isMemAddr but for devices. Checks if a physical address
+     * of the packet match an address range of a device corresponding to the
+     * MasterId of the request.
+     */
+    bool isDeviceMemAddr(PacketPtr pkt) const;
+
+    /**
+     * Return a pointer to the device memory.
+     */
+    AbstractMemory *getDeviceMemory(MasterID masterID) const;
+
     /**
      * Get the architecture.
      */