RubyTester.hh (13799:15badf7874ee) RubyTester.hh (13892:0182a0601f66)
1/*
2 * Copyright (c) 2013 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
15 * Copyright (c) 2009 Advanced Micro Devices, Inc.
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 */
41
42#ifndef __CPU_RUBYTEST_RUBYTESTER_HH__
43#define __CPU_RUBYTEST_RUBYTESTER_HH__
44
45#include <iostream>
46#include <string>
47#include <vector>
48
49#include "cpu/testers/rubytest/CheckTable.hh"
1/*
2 * Copyright (c) 2013 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
15 * Copyright (c) 2009 Advanced Micro Devices, Inc.
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 */
41
42#ifndef __CPU_RUBYTEST_RUBYTESTER_HH__
43#define __CPU_RUBYTEST_RUBYTESTER_HH__
44
45#include <iostream>
46#include <string>
47#include <vector>
48
49#include "cpu/testers/rubytest/CheckTable.hh"
50#include "mem/mem_object.hh"
51#include "mem/packet.hh"
50#include "mem/packet.hh"
51#include "mem/port.hh"
52#include "mem/ruby/common/SubBlock.hh"
53#include "mem/ruby/common/TypeDefines.hh"
54#include "params/RubyTester.hh"
52#include "mem/ruby/common/SubBlock.hh"
53#include "mem/ruby/common/TypeDefines.hh"
54#include "params/RubyTester.hh"
55#include "sim/clocked_object.hh"
55
56
56class RubyTester : public MemObject
57class RubyTester : public ClockedObject
57{
58 public:
59 class CpuPort : public MasterPort
60 {
61 private:
62 RubyTester *tester;
63 // index for m_last_progress_vector and hitCallback
64 PortID globalIdx;
65
66 public:
67 //
68 // Currently, each instatiation of the RubyTester::CpuPort supports
69 // only instruction or data requests, not both. However, for those
70 // RubyPorts that support both types of requests, separate InstOnly
71 // and DataOnly CpuPorts will map to that RubyPort
72
73 CpuPort(const std::string &_name, RubyTester *_tester, PortID _id,
74 PortID _index)
75 : MasterPort(_name, _tester, _id), tester(_tester),
76 globalIdx(_index)
77 {}
78
79 protected:
80 virtual bool recvTimingResp(PacketPtr pkt);
81 virtual void recvReqRetry()
82 { panic("%s does not expect a retry\n", name()); }
83 };
84
85 struct SenderState : public Packet::SenderState
86 {
87 SubBlock subBlock;
88
89 SenderState(Addr addr, int size) : subBlock(addr, size) {}
90
91 };
92
93 typedef RubyTesterParams Params;
94 RubyTester(const Params *p);
95 ~RubyTester();
96
97 Port &getPort(const std::string &if_name,
98 PortID idx=InvalidPortID) override;
99
100 bool isInstOnlyCpuPort(int idx);
101 bool isInstDataCpuPort(int idx);
102
103 MasterPort* getReadableCpuPort(int idx);
104 MasterPort* getWritableCpuPort(int idx);
105
106 void init() override;
107
108 void wakeup();
109
110 void incrementCheckCompletions() { m_checks_completed++; }
111
112 void printStats(std::ostream& out) const {}
113 void clearStats() {}
114 void printConfig(std::ostream& out) const {}
115
116 void print(std::ostream& out) const;
117 bool getCheckFlush() { return m_check_flush; }
118
119 MasterID masterId() { return _masterId; }
120 protected:
121 EventFunctionWrapper checkStartEvent;
122
123 MasterID _masterId;
124
125 private:
126 void hitCallback(NodeID proc, SubBlock* data);
127
128 void checkForDeadlock();
129
130 // Private copy constructor and assignment operator
131 RubyTester(const RubyTester& obj);
132 RubyTester& operator=(const RubyTester& obj);
133
134 CheckTable* m_checkTable_ptr;
135 std::vector<Cycles> m_last_progress_vector;
136
137 int m_num_cpus;
138 uint64_t m_checks_completed;
139 std::vector<MasterPort*> writePorts;
140 std::vector<MasterPort*> readPorts;
141 uint64_t m_checks_to_complete;
142 int m_deadlock_threshold;
143 int m_num_writers;
144 int m_num_readers;
145 int m_wakeup_frequency;
146 bool m_check_flush;
147 int m_num_inst_only_ports;
148 int m_num_inst_data_ports;
149};
150
151inline std::ostream&
152operator<<(std::ostream& out, const RubyTester& obj)
153{
154 obj.print(out);
155 out << std::flush;
156 return out;
157}
158
159#endif // __CPU_RUBYTEST_RUBYTESTER_HH__
58{
59 public:
60 class CpuPort : public MasterPort
61 {
62 private:
63 RubyTester *tester;
64 // index for m_last_progress_vector and hitCallback
65 PortID globalIdx;
66
67 public:
68 //
69 // Currently, each instatiation of the RubyTester::CpuPort supports
70 // only instruction or data requests, not both. However, for those
71 // RubyPorts that support both types of requests, separate InstOnly
72 // and DataOnly CpuPorts will map to that RubyPort
73
74 CpuPort(const std::string &_name, RubyTester *_tester, PortID _id,
75 PortID _index)
76 : MasterPort(_name, _tester, _id), tester(_tester),
77 globalIdx(_index)
78 {}
79
80 protected:
81 virtual bool recvTimingResp(PacketPtr pkt);
82 virtual void recvReqRetry()
83 { panic("%s does not expect a retry\n", name()); }
84 };
85
86 struct SenderState : public Packet::SenderState
87 {
88 SubBlock subBlock;
89
90 SenderState(Addr addr, int size) : subBlock(addr, size) {}
91
92 };
93
94 typedef RubyTesterParams Params;
95 RubyTester(const Params *p);
96 ~RubyTester();
97
98 Port &getPort(const std::string &if_name,
99 PortID idx=InvalidPortID) override;
100
101 bool isInstOnlyCpuPort(int idx);
102 bool isInstDataCpuPort(int idx);
103
104 MasterPort* getReadableCpuPort(int idx);
105 MasterPort* getWritableCpuPort(int idx);
106
107 void init() override;
108
109 void wakeup();
110
111 void incrementCheckCompletions() { m_checks_completed++; }
112
113 void printStats(std::ostream& out) const {}
114 void clearStats() {}
115 void printConfig(std::ostream& out) const {}
116
117 void print(std::ostream& out) const;
118 bool getCheckFlush() { return m_check_flush; }
119
120 MasterID masterId() { return _masterId; }
121 protected:
122 EventFunctionWrapper checkStartEvent;
123
124 MasterID _masterId;
125
126 private:
127 void hitCallback(NodeID proc, SubBlock* data);
128
129 void checkForDeadlock();
130
131 // Private copy constructor and assignment operator
132 RubyTester(const RubyTester& obj);
133 RubyTester& operator=(const RubyTester& obj);
134
135 CheckTable* m_checkTable_ptr;
136 std::vector<Cycles> m_last_progress_vector;
137
138 int m_num_cpus;
139 uint64_t m_checks_completed;
140 std::vector<MasterPort*> writePorts;
141 std::vector<MasterPort*> readPorts;
142 uint64_t m_checks_to_complete;
143 int m_deadlock_threshold;
144 int m_num_writers;
145 int m_num_readers;
146 int m_wakeup_frequency;
147 bool m_check_flush;
148 int m_num_inst_only_ports;
149 int m_num_inst_data_ports;
150};
151
152inline std::ostream&
153operator<<(std::ostream& out, const RubyTester& obj)
154{
155 obj.print(out);
156 out << std::flush;
157 return out;
158}
159
160#endif // __CPU_RUBYTEST_RUBYTESTER_HH__