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 SimpleTimingPort
51 {
52 private:
53 RubyDirectedTester *tester;
54
55 public:
56 CpuPort(const std::string &_name, RubyDirectedTester *_tester, uint _idx)
56 CpuPort(const std::string &_name, RubyDirectedTester *_tester, uint32_t _idx)
57 : SimpleTimingPort(_name, _tester), tester(_tester), idx(_idx)
58 {}
59
60 uint idx;
60 uint32_t idx;
61
62 protected:
63 virtual bool recvTiming(PacketPtr pkt);
64 virtual Tick recvAtomic(PacketPtr pkt);
65 };
66
67 typedef RubyDirectedTesterParams Params;
68 RubyDirectedTester(const Params *p);
69 ~RubyDirectedTester();
70
71 virtual Port *getPort(const std::string &if_name, int idx = -1);
72
73 Port* getCpuPort(int idx);
74
75 virtual void init();
76
77 void wakeup();
78
79 void incrementCycleCompletions() { m_requests_completed++; }
80
81 void printStats(std::ostream& out) const {}
82 void clearStats() {}
83 void printConfig(std::ostream& out) const {}
84
85 void print(std::ostream& out) const;
86
87 protected:
88 class DirectedStartEvent : public Event
89 {
90 private:
91 RubyDirectedTester *tester;
92
93 public:
94 DirectedStartEvent(RubyDirectedTester *_tester)
95 : Event(CPU_Tick_Pri), tester(_tester)
96 {}
97 void process() { tester->wakeup(); }
98 virtual const char *description() const { return "Directed tick"; }
99 };
100
101 DirectedStartEvent directedStartEvent;
102
103 private:
104 void hitCallback(NodeID proc, Addr addr);
105
106 void checkForDeadlock();
107
108 // Private copy constructor and assignment operator
109 RubyDirectedTester(const RubyDirectedTester& obj);
110 RubyDirectedTester& operator=(const RubyDirectedTester& obj);
111
112 uint64 m_requests_completed;
113 std::vector<CpuPort*> ports;
114 uint64 m_requests_to_complete;
115 DirectedGenerator* generator;
116};
117
118#endif // __CPU_DIRECTEDTEST_RUBYDIRECTEDTESTER_HH__