gups_gen.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 __CPU_TESTERS_TRAFFIC_GEN_GUPS_GEN_HH__
#define __CPU_TESTERS_TRAFFIC_GEN_GUPS_GEN_HH__
 
#include <queue>
#include <unordered_map>
#include <vector>
 
#include "base/statistics.hh"
#include "mem/port.hh"
#include "params/GUPSGen.hh"
#include "sim/clocked_object.hh"
#include "sim/system.hh"
 
namespace gem5
{
 
class GUPSGen : public ClockedObject
{
  private:
 
    class GenPort : public RequestPort
    {
      private:
 
        GUPSGen *owner;
 
        bool _blocked;
 
        PacketPtr blockedPacket;
 
      public:
 
        GenPort(const std::string& name, GUPSGen *owner) :
            RequestPort(name), owner(owner), _blocked(false),
            blockedPacket(nullptr)
        {}
 
        bool blocked(){
            return _blocked;
        }
 
        void sendTimingPacket(PacketPtr pkt);
 
        void sendFunctionalPacket(PacketPtr pkt);
 
      protected:
 
        bool recvTimingResp(PacketPtr pkt) override;
 
        void recvReqRetry() override;
    };
 
    virtual void init() override;
 
    virtual void startup() override;
 
    Addr indexToAddr (uint64_t index);
 
    PacketPtr getReadPacket(Addr addr, unsigned int size);
 
    PacketPtr getWritePacket(Addr addr, unsigned int size, uint8_t* data);
 
    void handleResponse(PacketPtr pkt);
 
    void wakeUp();
 
    void createNextReq();
 
    EventFunctionWrapper nextCreateEvent;
 
    void sendNextReq();
 
    EventFunctionWrapper nextSendEvent;
 
    std::unordered_map<RequestPtr, uint64_t> updateTable;
 
    std::unordered_map<RequestPtr, Tick> exitTimes;
 
    std::queue<PacketPtr> requestPool;
 
    std::queue<PacketPtr> responsePool;
 
    int64_t numUpdates;
 
    int64_t tableSize;
 
    System *const system;
 
    const RequestorID requestorId;
 
    GenPort port;
 
    Addr startAddr;
 
    const uint64_t memSize;
 
    int updateLimit;
 
    const int elementSize;
 
    int reqQueueSize;
 
    bool initMemory;
 
    bool doneReading;
 
    int onTheFlyRequests;
 
    int readRequests;
 
    struct GUPSGenStat : public statistics::Group
    {
        GUPSGenStat(GUPSGen* parent);
        void regStats() override;
 
        statistics::Scalar totalUpdates;
        statistics::Formula GUPS;
 
        statistics::Scalar totalReads;
        statistics::Scalar totalBytesRead;
        statistics::Formula avgReadBW;
        statistics::Scalar totalReadLat;
        statistics::Formula avgReadLat;
 
        statistics::Scalar totalWrites;
        statistics::Scalar totalBytesWritten;
        statistics::Formula avgWriteBW;
        statistics::Scalar totalWriteLat;
        statistics::Formula avgWriteLat;
    } stats;
 
  public:
 
    GUPSGen(const GUPSGenParams &params);
 
    Port &getPort(const std::string &if_name,
                PortID idx=InvalidPortID) override;
};
 
}
 
#endif // __CPU_TESTERS_TRAFFIC_GEN_GUPS_GEN_HH__