ExtMaster.cc revision 11158:a84eecaaa866 
1// Copyright (c) 2015 ARM Limited
2// All rights reserved.
3//
4// The license below extends only to copyright in the software and shall
5// not be construed as granting a license to any other intellectual
6// property including but not limited to intellectual property relating
7// to a hardware implementation of the functionality of the software
8// licensed hereunder.  You may use the software subject to the license
9// terms below provided that you ensure that this notice is replicated
10// unmodified and in its entirety in all distributions of the software,
11// modified or unmodified, in source code or in binary form.
12//
13// Redistribution and use in source and binary forms, with or without
14// modification, are permitted provided that the following conditions are
15// met: redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer;
17// redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution;
20// neither the name of the copyright holders nor the names of its
21// contributors may be used to endorse or promote products derived from
22// this software without specific prior written permission.
23//
24// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35
36// Copyright 2009-2014 Sandia Coporation.  Under the terms
37// of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
38// Government retains certain rights in this software.
39//
40// Copyright (c) 2009-2014, Sandia Corporation
41// All rights reserved.
42//
43// For license information, see the LICENSE file in the current directory.
44
45#include "gem5.hh"
46
47#include <sst_config.h>
48
49#include <mem/packet.hh>
50
51#include <sst/core/component.h>
52#include <sst/core/params.h>
53#include <sst/core/link.h>
54#include <sst/elements/memHierarchy/memNIC.h>
55
56#ifdef fatal  // gem5 sets this
57#undef fatal
58#endif
59
60using namespace SST;
61using namespace SST::gem5;
62using namespace SST::MemHierarchy;
63
64ExtMaster::ExtMaster(gem5Component *g, Output &o, ::ExternalMaster& p,
65        std::string &n) :
66    Port(n, p), out(o), port(p), simPhase(CONSTRUCTION),
67    gem5(g), name(n)
68{
69    Params _p; // will be ignored
70    nic = dynamic_cast<MemNIC*>(gem5->loadModuleWithComponent("memHierarchy.memNIC", g, _p));
71
72    MemNIC::ComponentInfo ci;
73    ci.num_vcs = 1;
74    ci.link_port = "network";
75    ci.link_bandwidth = "16GB/s";
76    ci.link_inbuf_size = "1KB";
77    ci.link_outbuf_size = "1KB";
78    ci.network_addr = 0; // hard coded at the moment
79    ci.type = MemNIC::TypeDirectoryCtrl;
80    nic->moduleInit(ci, new Event::Handler<ExtMaster>
81                                          (this, &ExtMaster::handleEvent));
82}
83
84void
85ExtMaster::init(unsigned phase)
86{
87    simPhase = INIT;
88
89    if (phase == 0) {
90        assert(nic);
91        for (auto range : getAddrRanges()) {
92            MemNIC::ComponentTypeInfo ti;
93            ti.rangeStart = range.start();
94            ti.rangeEnd = range.end();
95            ti.interleaveSize = 0;
96            ti.interleaveStep = 0;
97            nic->addTypeInfo(ti);
98            ranges.insert(range);
99        }
100    }
101
102    nic->init(phase);
103}
104
105void
106ExtMaster::setup(void)
107{
108    nic->setup();
109
110    simPhase = RUN;
111}
112
113void
114ExtMaster::finish(void)
115{
116    nic->finish();
117}
118
119void
120ExtMaster::clock(void)
121{
122    nic->clock();
123}
124
125void
126ExtMaster::handleEvent(SST::Event* event)
127{
128    if (simPhase == CONSTRUCTION) {
129        out.fatal(CALL_INFO, 1, "received Event during Construction phase\n");
130    }
131
132    MemEvent *ev = dynamic_cast<MemEvent*>(event);
133    if (!ev) {
134        out.fatal(CALL_INFO, 1, "Can't handle non-MemEvent Event's\n");
135    }
136
137    Command cmdI = ev->getCmd(); // command in - SST
138    MemCmd::Command cmdO;        // command out - gem5
139    bool data = false;
140
141    switch (cmdI) {
142        case GetS:      cmdO = MemCmd::ReadReq;                break;
143        case GetX:      cmdO = MemCmd::WriteReq;  data = true; break;
144        case GetSEx:
145        case PutS:
146        case PutM:
147        case PutE:
148        case PutX:
149        case PutXE:
150        case Inv:
151        case FetchInv:
152        case FetchInvX:
153
154        case NACK:
155
156        case NULLCMD:
157        case GetSResp:
158        case GetXResp:
159        case FetchResp:
160        case FetchXResp:
161            out.fatal(CALL_INFO, 1, "Don't know how to convert "
162                                    "SST command %s to gem5\n",
163                      CommandString[cmdI]);
164    }
165
166    Request::FlagsType flags = 0;
167    if (ev->queryFlag(MemEvent::F_LOCKED))
168        flags |= Request::LOCKED_RMW;
169    if (ev->queryFlag(MemEvent::F_NONCACHEABLE))
170        flags |= Request::UNCACHEABLE;
171    if (ev->isLoadLink()) {
172        assert(cmdI == GetS);
173        cmdO = MemCmd::LoadLockedReq;
174    } else if (ev->isStoreConditional()) {
175        assert(cmdI == GetX);
176        cmdO = MemCmd::StoreCondReq;
177    }
178
179    auto req = new Request(ev->getAddr(), ev->getSize(), flags, 0);
180    req->setThreadContext(ev->getGroupId(), 0);
181
182    auto pkt = new Packet(req, cmdO);
183    pkt->allocate();
184    if (data) {
185        pkt->setData(ev->getPayload().data());
186    }
187    pkt->pushSenderState(new SenderState(ev));
188
189    if (blocked() || !sendTimingReq(pkt))
190        sendQ.push_back(pkt);
191}
192
193bool
194ExtMaster::recvTimingResp(PacketPtr pkt) {
195    if (simPhase == INIT) {
196        out.fatal(CALL_INFO, 1, "not prepared to handle INIT-phase traffic\n");
197    }
198
199    // get original SST packet from gem5 SenderState
200    auto senderState = dynamic_cast<SenderState*>(pkt->popSenderState());
201    if (!senderState)
202        out.fatal(CALL_INFO, 1, "gem5 senderState corrupt\n");
203
204    // make (new) response packet, discard (old) original request
205    MemEvent* ev = senderState->event;
206    delete senderState;
207
208    MemEvent* resp = ev->makeResponse();
209    delete ev;
210
211    // copy the payload and then destroy gem5 packet
212    resp->setPayload(pkt->getSize(), pkt->getPtr<uint8_t>());
213    delete pkt->req;
214    delete pkt;
215
216    nic->send(resp);
217    return true;
218}
219
220void
221ExtMaster::recvReqRetry() {
222    while (blocked() && sendTimingReq(sendQ.front())) {
223        sendQ.pop_front();
224    }
225}
226
227void
228ExtMaster::recvRangeChange() {
229    for (auto range : getAddrRanges()) {
230        if (ranges.find(range) == ranges.end()) { // i.e. if not found,
231            MemNIC::ComponentTypeInfo ti;      // indicating a new range.
232            ti.rangeStart = range.start();
233            ti.rangeEnd = range.end();
234            ti.interleaveSize = 0;
235            ti.interleaveStep = 0;
236            nic->addTypeInfo(ti);
237            ranges.insert(range);
238        }
239    }
240}
241