port_terminator.hh

Go to the documentation of this file.

/*
 * 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 __MEM_PORT_TERMINATOR_HH__
#define __MEM_PORT_TERMINATOR_HH__

 
#include <vector>
 
#include "mem/port.hh"
#include "params/PortTerminator.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
class PortTerminator : public SimObject
{
  private:
    class ReqPort : public RequestPort
    {
      public:
        ReqPort(const std::string &name):
            RequestPort(name)
        {}
      protected:
        bool recvTimingResp(PacketPtr pkt) override
        {
            panic("Received an unexpected response. RequestPorts on a "
            "PortTerminator never issue any requests. Therefore, they should "
            "never receive a response.\n");
        }
 
        void recvReqRetry() override
        {
            return;
        }
 
        void recvRangeChange() override
        {
            return;
        }
    };

    class RespPort : public ResponsePort
    {
      public:
        RespPort(const std::string &name):
            ResponsePort(name)
        {}
 
        Tick recvAtomic(PacketPtr) override
        {
            panic("PortTerminator recvAtomic should never be called");
        }
 
        bool recvTimingReq(PacketPtr) override
        {
            panic("PortTerminator recvTimingReq should never be called");
        }
 
        void recvRespRetry() override
        {
            panic("PortTerminator recvRespRetry should never be called");
        }
 
        void recvFunctional(PacketPtr) override
        {
            panic("PortTerminator recvFunctional should never be called");
        }
 
        AddrRangeList getAddrRanges() const override
        {
            panic("PortTerminator getAddrRanges should never be called");
        }
    };
 
    std::vector<ReqPort> reqPorts;
 
    std::vector<RespPort> respPorts;
 
  public:
    PortTerminator(const PortTerminatorParams &params);
 
    Port &getPort(const std::string &if_name,
                    PortID idx = InvalidPortID) override;
};
 
}
 
#endif // __MEM_PORT_TERMINATOR_HH__