derek/gem5
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

misc,ext: Add gem5/SST integration

Browse Source 
Enable a gem5 system to be an SST::Component.

This change includes,
  - SST::gem5Component: responsible for,
      - initializing the Python environment for gem5
      - instantiating gem5 SimObjects
      - connecting SST::SSTResponderSubComponent to
gem5::OutgoingRequestBridge
      - hanlding the gem5 event queue (no thread-synchronization)
      - handling executing gem5 events
  - SST::SSTResponderSubComponent: responsible for,
      - receiving gem5 requests and sending the requests to
memory.
      - sending responses to the corresponding
gem5::OutgoingRequestBridge.
  - SST::SSTResponder: owned by SSTResponderSubComponent, the
actual actor that sends gem5's requests to memory.
  - gem5::OutgoingRequestBridge: receives the requests from
gem5 and sends them to SST. This SimObject allows the initialization
requests to be cached and the receiver could query the
initialization data later on.
  - gem5::SSTResponderInterface: the interface specifying how SST
communicates with gem5.
  - A working example of a gem5/SST setup.

More information is available at ext/sst/README.md.
For installation instructions, please refer to ext/sst/INSTALL.md.

Change-Id: I6b81260ef825415bcfe72b8a078854f4c94de782
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/50468
Reviewed-by: Giacomo Travaglini <giacomo.travaglini@arm.com>
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Maintainer: Giacomo Travaglini <giacomo.travaglini@arm.com>
Tested-by: kokoro <noreply+kokoro@google.com>
This commit is contained in:
Hoa Nguyen
2021-09-16 12:48:53 -07:00
parent 39d4cdcd6b
commit 7bc9b0175f
28 changed files with 2077 additions and 1235 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
src/sst/OutgoingRequestBridge.py Normal file
View File

@@ -0,0 +1,39 @@
# Copyright (c) 2021 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.params import *
from m5.SimObject import SimObject
class OutgoingRequestBridge(SimObject):
type = 'OutgoingRequestBridge'
cxx_header = "sst/outgoing_request_bridge.hh"
cxx_class = 'gem5::OutgoingRequestBridge'
port = ResponsePort("Response Port")
physical_address_ranges = VectorParam.AddrRange(
[AddrRange(0x80000000, MaxAddr)],
"Physical address ranges."
)

32
src/sst/SConscript Normal file
View File

@@ -0,0 +1,32 @@
# Copyright (c) 2021 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.
Import('*')
SimObject('OutgoingRequestBridge.py')
Source('outgoing_request_bridge.cc')
Source('sst_responder_interface.cc')

154
src/sst/outgoing_request_bridge.cc Normal file
View File

@@ -0,0 +1,154 @@
// Copyright (c) 2021 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.
#include "sst/outgoing_request_bridge.hh"
#include <cassert>
#include <iomanip>
#include <sstream>
#include "base/trace.hh"
namespace gem5
{
OutgoingRequestBridge::OutgoingRequestBridge(
const OutgoingRequestBridgeParams &params) :
SimObject(params),
outgoingPort(std::string(name()), this),
sstResponder(nullptr),
physicalAddressRanges(params.physical_address_ranges.begin(),
params.physical_address_ranges.end())
{
}
OutgoingRequestBridge::~OutgoingRequestBridge()
{
}
OutgoingRequestBridge::
OutgoingRequestPort::OutgoingRequestPort(const std::string &name_,
OutgoingRequestBridge* owner_) :
ResponsePort(name_, owner_)
{
owner = owner_;
}
OutgoingRequestBridge::
OutgoingRequestPort::~OutgoingRequestPort()
{
}
void
OutgoingRequestBridge::init()
{
if (outgoingPort.isConnected())
outgoingPort.sendRangeChange();
}
Port &
OutgoingRequestBridge::getPort(const std::string &if_name, PortID idx)
{
return outgoingPort;
}
AddrRangeList
OutgoingRequestBridge::getAddrRanges() const
{
return outgoingPort.getAddrRanges();
}
std::vector<std::pair<Addr, std::vector<uint8_t>>>
OutgoingRequestBridge::getInitData() const
{
return initData;
}
void
OutgoingRequestBridge::setResponder(SSTResponderInterface* responder)
{
sstResponder = responder;
}
bool
OutgoingRequestBridge::sendTimingResp(gem5::PacketPtr pkt)
{
return outgoingPort.sendTimingResp(pkt);
}
void
OutgoingRequestBridge::sendTimingSnoopReq(gem5::PacketPtr pkt)
{
outgoingPort.sendTimingSnoopReq(pkt);
}
void
OutgoingRequestBridge::handleRecvFunctional(PacketPtr pkt)
{
uint8_t* ptr = pkt->getPtr<uint8_t>();
uint64_t size = pkt->getSize();
std::vector<uint8_t> data(ptr, ptr+size);
initData.push_back(std::make_pair(pkt->getAddr(), data));
}
Tick
OutgoingRequestBridge::
OutgoingRequestPort::recvAtomic(PacketPtr pkt)
{
assert(false && "OutgoingRequestPort::recvAtomic not implemented");
return Tick();
}
void
OutgoingRequestBridge::
OutgoingRequestPort::recvFunctional(PacketPtr pkt)
{
owner->handleRecvFunctional(pkt);
}
bool
OutgoingRequestBridge::
OutgoingRequestPort::recvTimingReq(PacketPtr pkt)
{
owner->sstResponder->handleRecvTimingReq(pkt);
return true;
}
void
OutgoingRequestBridge::
OutgoingRequestPort::recvRespRetry()
{
owner->sstResponder->handleRecvRespRetry();
}
AddrRangeList
OutgoingRequestBridge::
OutgoingRequestPort::getAddrRanges() const
{
return owner->physicalAddressRanges;
}
}; // namespace gem5

122
src/sst/outgoing_request_bridge.hh Normal file
View File

@@ -0,0 +1,122 @@
// Copyright (c) 2021 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.
#ifndef __SST_OUTGOING_REQUEST_BRIDGE_HH__
#define __SST_OUTGOING_REQUEST_BRIDGE_HH__
#include <utility>
#include <vector>
#include "mem/port.hh"
#include "params/OutgoingRequestBridge.hh"
#include "sim/sim_object.hh"
#include "sst/sst_responder_interface.hh"
/**
* - OutgoingRequestBridge acts as a SimObject owning pointers to both a gem5
* OutgoingRequestPort and an SST port (via SSTResponderInterface). This bridge
* will forward gem5 packets from the gem5 port to the SST interface. Responses
* from SST will be handle by OutgoingRequestPort itself. Note: the bridge
* should be decoupled from the SST libraries so that it'll be
* SST-version-independent. Thus, there's no translation between a gem5 packet
* and SST Response here.
*
* - OutgoingRequestPort is a specialized ResponsePort working with
* OutgoingRequestBridge.
*/
namespace gem5
{
class OutgoingRequestBridge: public SimObject
{
public:
class OutgoingRequestPort: public ResponsePort
{
private:
OutgoingRequestBridge* owner;
public:
OutgoingRequestPort(const std::string &name_,
OutgoingRequestBridge* owner_);
~OutgoingRequestPort();
Tick recvAtomic(PacketPtr pkt);
void recvFunctional(PacketPtr pkt);
bool recvTimingReq(PacketPtr pkt);
void recvRespRetry();
AddrRangeList getAddrRanges() const;
};
public:
// a gem5 ResponsePort
OutgoingRequestPort outgoingPort;
// pointer to the corresponding SST responder
SSTResponderInterface* sstResponder;
// this vector holds the initialization data sent by gem5
std::vector<std::pair<Addr, std::vector<uint8_t>>> initData;
AddrRangeList physicalAddressRanges;
public:
OutgoingRequestBridge(const OutgoingRequestBridgeParams &params);
~OutgoingRequestBridge();
// Required to let the OutgoingRequestPort to send range change request.
void init();
// Returns the range of addresses that the ports will handle.
// Currently, it will return the range of [0x80000000, inf), which is
// specific to RISCV (SiFive's HiFive boards).
AddrRangeList getAddrRanges() const;
// Required to return a port during gem5 instantiate phase.
Port & getPort(const std::string &if_name, PortID idx);
// Returns the buffered data for initialization. This is necessary as
// when gem5 sends functional requests to memory for initialization,
// the connection in SST Memory Hierarchy has not been constructed yet.
std::vector<std::pair<Addr, std::vector<uint8_t>>> getInitData() const;
// gem5 Component (from SST) will call this function to let set the
// bridge's corresponding SSTResponderSubComponent (which implemented
// SSTResponderInterface). I.e., this will connect this bridge to the
// corresponding port in SST.
void setResponder(SSTResponderInterface* responder);
// This function is called when SST wants to sent a timing response to gem5
bool sendTimingResp(PacketPtr pkt);
// This function is called when SST sends response having an invalidate .
void sendTimingSnoopReq(PacketPtr pkt);
// This function is called when gem5 wants to send a non-timing request
// to SST. Should only be called during the SST construction phase, i.e.
// not at the simulation time.
void handleRecvFunctional(PacketPtr pkt);
};
}; // namespace gem5
#endif //__SST_OUTGOING_REQUEST_BRIDGE_HH__

36
src/sst/sst_responder_interface.cc Normal file
View File

@@ -0,0 +1,36 @@
// Copyright (c) 2021 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.
#include "sst/sst_responder_interface.hh"
namespace gem5
{
SSTResponderInterface::SSTResponderInterface()
{
}
}; // namespace gem5

69
src/sst/sst_responder_interface.hh Normal file
View File

@@ -0,0 +1,69 @@
// Copyright (c) 2021 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.
#ifndef __SST_RESPONDER_INTERFACE_HH__
#define __SST_RESPONDER_INTERFACE_HH__
#include <string>
#include "mem/port.hh"
/**
* SSTResponderInterface provides an interface specified gem5's expectations
* on the functionality of an SST Responder. This interfaces expects
* SST Responder to be able to handle gem5 packet on recvTimingReq(),
* recvRespRetry(), and recvFunctional().
*/
namespace gem5
{
class SSTResponderInterface
{
public:
SSTResponderInterface();
virtual ~SSTResponderInterface() {};
// This function is called when OutgoingRequestBridge wants to forward
// a gem5 request to SST, i.e. when OutgoingRequestPort::recvTimingReq()
// is called.
virtual bool handleRecvTimingReq(PacketPtr pkt) = 0;
// This function is called when OutogingRequestPort::recvRespRetry() is
// called.
virtual void handleRecvRespRetry() = 0;
// This function is called when OutgoingRequestBridge wants to send a
// non-timing request. This function should only be called during the
// SST construction phrase, i.e. not at simulation time.
virtual void handleRecvFunctional(PacketPtr pkt) = 0;
};
} // namespace gem5
#endif // __SST_RESPONDER_INTERFACE_HH__