GarnetSyntheticTraffic.hh revision 13784 
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    Port &getPort(const std::string &if_name,
68                  PortID idx=InvalidPortID) override;
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    EventFunctionWrapper tickEvent;
78
79    class CpuPort : public MasterPort
80    {
81        GarnetSyntheticTraffic *tester;
82
83      public:
84
85        CpuPort(const std::string &_name, GarnetSyntheticTraffic *_tester)
86            : MasterPort(_name, _tester), tester(_tester)
87        { }
88
89      protected:
90
91        virtual bool recvTimingResp(PacketPtr pkt);
92
93        virtual void recvReqRetry();
94    };
95
96    CpuPort cachePort;
97
98    class GarnetSyntheticTrafficSenderState : public Packet::SenderState
99    {
100      public:
101        /** Constructor. */
102        GarnetSyntheticTrafficSenderState(uint8_t *_data)
103            : data(_data)
104        { }
105
106        // Hold onto data pointer
107        uint8_t *data;
108    };
109
110    PacketPtr retryPkt;
111    unsigned size;
112    int id;
113
114    std::map<std::string, TrafficType> trafficStringToEnum;
115
116    unsigned blockSizeBits;
117
118    Tick noResponseCycles;
119
120    int numDestinations;
121    Tick simCycles;
122    int numPacketsMax;
123    int numPacketsSent;
124    int singleSender;
125    int singleDest;
126
127    std::string trafficType; // string
128    TrafficType traffic; // enum from string
129    double injRate;
130    int injVnet;
131    int precision;
132
133    const Cycles responseLimit;
134
135    MasterID masterId;
136
137    void completeRequest(PacketPtr pkt);
138
139    void generatePkt();
140    void sendPkt(PacketPtr pkt);
141    void initTrafficType();
142
143    void doRetry();
144
145    friend class MemCompleteEvent;
146};
147
148#endif // __CPU_GARNET_SYNTHETIC_TRAFFIC_HH__
149