GarnetSyntheticTraffic.hh revision 11661:2bc3962f59fe 
1/*
2 * Copyright (c) 2016 Georgia Institute of Technology
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Tushar Krishna
29 */
30
31#ifndef __CPU_GARNET_SYNTHETIC_TRAFFIC_HH__
32#define __CPU_GARNET_SYNTHETIC_TRAFFIC_HH__
33
34#include <set>
35
36#include "base/statistics.hh"
37#include "mem/mem_object.hh"
38#include "mem/port.hh"
39#include "params/GarnetSyntheticTraffic.hh"
40#include "sim/eventq.hh"
41#include "sim/sim_exit.hh"
42#include "sim/sim_object.hh"
43#include "sim/stats.hh"
44
45enum TrafficType {BIT_COMPLEMENT_ = 0,
46                  BIT_REVERSE_ = 1,
47                  BIT_ROTATION_ = 2,
48                  NEIGHBOR_ = 3,
49                  SHUFFLE_ = 4,
50                  TORNADO_ = 5,
51                  TRANSPOSE_ = 6,
52                  UNIFORM_RANDOM_ = 7,
53                  NUM_TRAFFIC_PATTERNS_};
54
55class Packet;
56class GarnetSyntheticTraffic : public MemObject
57{
58  public:
59    typedef GarnetSyntheticTrafficParams Params;
60    GarnetSyntheticTraffic(const Params *p);
61
62    virtual void init();
63
64    // main simulation loop (one cycle)
65    void tick();
66
67    virtual BaseMasterPort &getMasterPort(const std::string &if_name,
68                                          PortID idx = InvalidPortID);
69
70    /**
71     * Print state of address in memory system via PrintReq (for
72     * debugging).
73     */
74    void printAddr(Addr a);
75
76  protected:
77    class TickEvent : public Event
78    {
79      private:
80        GarnetSyntheticTraffic *cpu;
81
82      public:
83        TickEvent(GarnetSyntheticTraffic *c) : Event(CPU_Tick_Pri), cpu(c) {}
84        void process() { cpu->tick(); }
85        virtual const char *description() const
86        {
87            return "GarnetSyntheticTraffic tick";
88        }
89    };
90
91    TickEvent tickEvent;
92
93    class CpuPort : public MasterPort
94    {
95        GarnetSyntheticTraffic *tester;
96
97      public:
98
99        CpuPort(const std::string &_name, GarnetSyntheticTraffic *_tester)
100            : MasterPort(_name, _tester), tester(_tester)
101        { }
102
103      protected:
104
105        virtual bool recvTimingResp(PacketPtr pkt);
106
107        virtual void recvReqRetry();
108    };
109
110    CpuPort cachePort;
111
112    class GarnetSyntheticTrafficSenderState : public Packet::SenderState
113    {
114      public:
115        /** Constructor. */
116        GarnetSyntheticTrafficSenderState(uint8_t *_data)
117            : data(_data)
118        { }
119
120        // Hold onto data pointer
121        uint8_t *data;
122    };
123
124    PacketPtr retryPkt;
125    unsigned size;
126    int id;
127
128    std::map<std::string, TrafficType> trafficStringToEnum;
129
130    unsigned blockSizeBits;
131
132    Tick noResponseCycles;
133
134    int numDestinations;
135    Tick simCycles;
136    int numPacketsMax;
137    int numPacketsSent;
138    int singleSender;
139    int singleDest;
140
141    std::string trafficType; // string
142    TrafficType traffic; // enum from string
143    double injRate;
144    int injVnet;
145    int precision;
146
147    const Cycles responseLimit;
148
149    MasterID masterId;
150
151    void completeRequest(PacketPtr pkt);
152
153    void generatePkt();
154    void sendPkt(PacketPtr pkt);
155    void initTrafficType();
156
157    void doRetry();
158
159    friend class MemCompleteEvent;
160};
161
162#endif // __CPU_GARNET_SYNTHETIC_TRAFFIC_HH__
163
164
165
166