port_proxy.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2013, 2018 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * 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_PROXY_HH__
#define __MEM_PORT_PROXY_HH__
 
#include <functional>
#include <limits>
 
#include "mem/protocol/functional.hh"
#include "sim/byteswap.hh"
 
namespace gem5
{
 
class RequestPort;
class ThreadContext;
 
class PortProxy : FunctionalRequestProtocol
{
  public:
    typedef std::function<void(PacketPtr pkt)> SendFunctionalFunc;
 
  private:
    SendFunctionalFunc sendFunctional;
 
    const unsigned int _cacheLineSize;
 
    void
    recvFunctionalSnoop(PacketPtr pkt) override
    {
        // Since port proxies aren't anyone else's peer, they should never
        // receive snoops.
        panic("Port proxies should never receive snoops.");
    }
 
  public:
    PortProxy(SendFunctionalFunc func, unsigned int cache_line_size) :
        sendFunctional(func), _cacheLineSize(cache_line_size)
    {}
 
    // Helpers which create typical SendFunctionalFunc-s from other objects.
    PortProxy(ThreadContext *tc, unsigned int cache_line_size);
    PortProxy(const RequestPort &port, unsigned int cache_line_size);
 
    virtual ~PortProxy() {}
 
 
    void readBlobPhys(Addr addr, Request::Flags flags,
                      void *p, int size) const;
 
    void writeBlobPhys(Addr addr, Request::Flags flags,
                       const void *p, int size) const;
 
    void memsetBlobPhys(Addr addr, Request::Flags flags,
                        uint8_t v, int size) const;
 
 
 
    virtual bool
    tryReadBlob(Addr addr, void *p, int size) const
    {
        readBlobPhys(addr, 0, p, size);
        return true;
    }
 
    virtual bool
    tryWriteBlob(Addr addr, const void *p, int size) const
    {
        writeBlobPhys(addr, 0, p, size);
        return true;
    }
 
    virtual bool
    tryMemsetBlob(Addr addr, uint8_t val, int size) const
    {
        memsetBlobPhys(addr, 0, val, size);
        return true;
    }
 
 
 
    void
    readBlob(Addr addr, void *p, int size) const
    {
        if (!tryReadBlob(addr, p, size))
            fatal("readBlob(%#x, ...) failed", addr);
    }
 
    void
    writeBlob(Addr addr, const void *p, int size) const
    {
        if (!tryWriteBlob(addr, p, size))
            fatal("writeBlob(%#x, ...) failed", addr);
    }
 
    void
    memsetBlob(Addr addr, uint8_t v, int size) const
    {
        if (!tryMemsetBlob(addr, v, size))
            fatal("memsetBlob(%#x, ...) failed", addr);
    }
 
    template <typename T>
    T read(Addr address) const;
 
    template <typename T>
    void write(Addr address, const T &data) const;
 
    template <typename T>
    T read(Addr address, ByteOrder guest_byte_order) const;
 
    template <typename T>
    void write(Addr address, T data, ByteOrder guest_byte_order) const;
 
    bool tryWriteString(Addr addr, const char *str) const;
 
    void
    writeString(Addr addr, const char *str) const
    {
        if (!tryWriteString(addr, str))
            fatal("writeString(%#x, ...) failed", addr);
    }
 
    bool tryReadString(std::string &str, Addr addr) const;
 
    void
    readString(std::string &str, Addr addr) const
    {
        if (!tryReadString(str, addr))
            fatal("readString(%#x, ...) failed", addr);
    }
 
    bool tryReadString(char *str, Addr addr, size_t maxlen) const;
 
    void
    readString(char *str, Addr addr, size_t maxlen) const
    {
        if (!tryReadString(str, addr, maxlen))
            fatal("readString(%#x, ...) failed", addr);
    }
};
 
 
template <typename T>
T
PortProxy::read(Addr address) const
{
    T data;
    readBlob(address, &data, sizeof(T));
    return data;
}
 
template <typename T>
void
PortProxy::write(Addr address, const T &data) const
{
    writeBlob(address, &data, sizeof(T));
}
 
template <typename T>
T
PortProxy::read(Addr address, ByteOrder byte_order) const
{
    T data;
    readBlob(address, &data, sizeof(T));
    return gtoh(data, byte_order);
}
 
template <typename T>
void
PortProxy::write(Addr address, T data, ByteOrder byte_order) const
{
    data = htog(data, byte_order);
    writeBlob(address, &data, sizeof(T));
}
 
} // namespace gem5
 
#endif // __MEM_PORT_PROXY_HH__