RubyDirectedTester.hh revision 8950 
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
3 * Copyright (c) 2009-2010 Advanced Micro Devices, Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30#ifndef __CPU_DIRECTEDTEST_RUBYDIRECTEDTESTER_HH__
31#define __CPU_DIRECTEDTEST_RUBYDIRECTEDTESTER_HH__
32
33#include <iostream>
34#include <string>
35#include <vector>
36
37#include "mem/ruby/common/DataBlock.hh"
38#include "mem/ruby/common/Global.hh"
39#include "mem/ruby/common/SubBlock.hh"
40#include "mem/ruby/system/RubyPort.hh"
41#include "mem/mem_object.hh"
42#include "mem/packet.hh"
43#include "params/RubyDirectedTester.hh"
44
45class DirectedGenerator;
46
47class RubyDirectedTester : public MemObject
48{
49  public:
50    class CpuPort : public MasterPort
51    {
52      private:
53        RubyDirectedTester *tester;
54
55      public:
56        CpuPort(const std::string &_name, RubyDirectedTester *_tester,
57                uint32_t _idx)
58            : MasterPort(_name, _tester), tester(_tester), idx(_idx)
59        {}
60
61        uint32_t idx;
62
63      protected:
64        virtual bool recvTiming(PacketPtr pkt);
65        virtual void recvRetry()
66        { panic("%s does not expect a retry\n", name()); }
67    };
68
69    typedef RubyDirectedTesterParams Params;
70    RubyDirectedTester(const Params *p);
71    ~RubyDirectedTester();
72
73    virtual MasterPort &getMasterPort(const std::string &if_name,
74                                      int idx = -1);
75
76    MasterPort* getCpuPort(int idx);
77
78    virtual void init();
79
80    void wakeup();
81
82    void incrementCycleCompletions() { m_requests_completed++; }
83
84    void printStats(std::ostream& out) const {}
85    void clearStats() {}
86    void printConfig(std::ostream& out) const {}
87
88    void print(std::ostream& out) const;
89
90  protected:
91    class DirectedStartEvent : public Event
92    {
93      private:
94        RubyDirectedTester *tester;
95
96      public:
97        DirectedStartEvent(RubyDirectedTester *_tester)
98            : Event(CPU_Tick_Pri), tester(_tester)
99        {}
100        void process() { tester->wakeup(); }
101        virtual const char *description() const { return "Directed tick"; }
102    };
103
104    DirectedStartEvent directedStartEvent;
105
106  private:
107    void hitCallback(NodeID proc, Addr addr);
108
109    void checkForDeadlock();
110
111    // Private copy constructor and assignment operator
112    RubyDirectedTester(const RubyDirectedTester& obj);
113    RubyDirectedTester& operator=(const RubyDirectedTester& obj);
114
115    uint64 m_requests_completed;
116    std::vector<MasterPort*> ports;
117    uint64 m_requests_to_complete;
118    DirectedGenerator* generator;
119};
120
121#endif // __CPU_DIRECTEDTEST_RUBYDIRECTEDTESTER_HH__
122