src/mem/port.cc

   1 /*
   2  * Copyright (c) 2012,2015,2017 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Copyright (c) 2002-2005 The Regents of The University of Michigan
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions are
  19  * met: redistributions of source code must retain the above copyright
  20  * notice, this list of conditions and the following disclaimer;
  21  * redistributions in binary form must reproduce the above copyright
  22  * notice, this list of conditions and the following disclaimer in the
  23  * documentation and/or other materials provided with the distribution;
  24  * neither the name of the copyright holders nor the names of its
  25  * contributors may be used to endorse or promote products derived from
  26  * this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  */
  40
  41 /**
  42  * @file
  43  * Port object definitions.
  44  */
  45 #include "mem/port.hh"
  46
  47 #include "base/trace.hh"
  48 #include "sim/sim_object.hh"
  49
  50 namespace
  51 {
  52
  53 class DefaultRequestPort : public RequestPort
  54 {
  55   protected:
  56     [[noreturn]] void
  57     blowUp() const
  58     {
  59         throw UnboundPortException();
  60     }
  61
  62   public:
  63     DefaultRequestPort() : RequestPort("default_request_port", nullptr) {}
  64
  65     // Atomic protocol.
  66     Tick recvAtomicSnoop(PacketPtr) override { blowUp(); }
  67
  68     // Timing protocol.
  69     bool recvTimingResp(PacketPtr) override { blowUp(); }
  70     void recvTimingSnoopReq(PacketPtr) override { blowUp(); }
  71     void recvReqRetry() override { blowUp(); }
  72     void recvRetrySnoopResp() override { blowUp(); }
  73
  74     // Functional protocol.
  75     void recvFunctionalSnoop(PacketPtr) override { blowUp(); }
  76 };
  77
  78 class DefaultResponsePort : public ResponsePort
  79 {
  80   protected:
  81     [[noreturn]] void
  82     blowUp() const
  83     {
  84         throw UnboundPortException();
  85     }
  86
  87   public:
  88     DefaultResponsePort() : ResponsePort("default_response_port", nullptr) {}
  89
  90     // Atomic protocol.
  91     Tick recvAtomic(PacketPtr) override { blowUp(); }
  92
  93     // Timing protocol.
  94     bool recvTimingReq(PacketPtr) override { blowUp(); }
  95     bool tryTiming(PacketPtr) override { blowUp(); }
  96     bool recvTimingSnoopResp(PacketPtr) override { blowUp(); }
  97     void recvRespRetry() override { blowUp(); }
  98
  99     // Functional protocol.
 100     void recvFunctional(PacketPtr) override { blowUp(); }
 101
 102     // General.
 103     AddrRangeList getAddrRanges() const override { return AddrRangeList(); }
 104 };
 105
 106 DefaultRequestPort defaultRequestPort;
 107 DefaultResponsePort defaultResponsePort;
 108
 109 } // anonymous namespace
 110
 111 /**
 112  * Request port
 113  */
 114 RequestPort::RequestPort(const std::string& name, SimObject* _owner,
 115     PortID _id) : Port(name, _id), _responsePort(&defaultResponsePort),
 116     owner(*_owner)
 117 {
 118 }
 119
 120 RequestPort::~RequestPort()
 121 {
 122 }
 123
 124 void
 125 RequestPort::bind(Port &peer)
 126 {
 127     auto *response_port = dynamic_cast<ResponsePort *>(&peer);
 128     fatal_if(!response_port, "Can't bind port %s to non-response port %s.",
 129              name(), peer.name());
 130     // request port keeps track of the response port
 131     _responsePort = response_port;
 132     Port::bind(peer);
 133     // response port also keeps track of request port
 134     _responsePort->responderBind(*this);
 135 }
 136
 137 void
 138 RequestPort::unbind()
 139 {
 140     panic_if(!isConnected(), "Can't unbind request port %s which is "
 141     "not bound.", name());
 142     _responsePort->responderUnbind();
 143     _responsePort = &defaultResponsePort;
 144     Port::unbind();
 145 }
 146
 147 AddrRangeList
 148 RequestPort::getAddrRanges() const
 149 {
 150     return _responsePort->getAddrRanges();
 151 }
 152
 153 void
 154 RequestPort::printAddr(Addr a)
 155 {
 156     auto req = std::make_shared<Request>(
 157         a, 1, 0, Request::funcRequestorId);
 158
 159     Packet pkt(req, MemCmd::PrintReq);
 160     Packet::PrintReqState prs(std::cerr);
 161     pkt.senderState = &prs;
 162
 163     sendFunctional(&pkt);
 164 }
 165
 166 /**
 167  * Response port
 168  */
 169 ResponsePort::ResponsePort(const std::string& name, SimObject* _owner,
 170     PortID id) : Port(name, id), _requestPort(&defaultRequestPort),
 171     defaultBackdoorWarned(false), owner(*_owner)
 172 {
 173 }
 174
 175 ResponsePort::~ResponsePort()
 176 {
 177 }
 178
 179 void
 180 ResponsePort::responderUnbind()
 181 {
 182     _requestPort = &defaultRequestPort;
 183     Port::unbind();
 184 }
 185
 186 void
 187 ResponsePort::responderBind(RequestPort& request_port)
 188 {
 189     _requestPort = &request_port;
 190     Port::bind(request_port);
 191 }
 192
 193 Tick
 194 ResponsePort::recvAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor)
 195 {
 196     if (!defaultBackdoorWarned) {
 197         warn("Port %s doesn't support requesting a back door.", name());
 198         defaultBackdoorWarned = true;
 199     }
 200     return recvAtomic(pkt);
 201 }