base.hh (3125:febd811bccc6) base.hh (3126:756092c6383c)
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
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: Steve Reinhardt
29 * Nathan Binkert
30 */
31
32#ifndef __CPU_BASE_HH__
33#define __CPU_BASE_HH__
34
35#include <vector>
36
37#include "base/statistics.hh"
38#include "config/full_system.hh"
39#include "sim/eventq.hh"
40#include "mem/mem_object.hh"
41#include "arch/isa_traits.hh"
42
43class BranchPred;
44class CheckerCPU;
45class ThreadContext;
46class System;
47class Port;
48
49class CPUProgressEvent : public Event
50{
51 protected:
52 Tick interval;
53 Counter lastNumInst;
54 BaseCPU *cpu;
55
56 public:
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
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: Steve Reinhardt
29 * Nathan Binkert
30 */
31
32#ifndef __CPU_BASE_HH__
33#define __CPU_BASE_HH__
34
35#include <vector>
36
37#include "base/statistics.hh"
38#include "config/full_system.hh"
39#include "sim/eventq.hh"
40#include "mem/mem_object.hh"
41#include "arch/isa_traits.hh"
42
43class BranchPred;
44class CheckerCPU;
45class ThreadContext;
46class System;
47class Port;
48
49class CPUProgressEvent : public Event
50{
51 protected:
52 Tick interval;
53 Counter lastNumInst;
54 BaseCPU *cpu;
55
56 public:
57 CPUProgressEvent(EventQueue *q, Tick ival, BaseCPU *_cpu)
58 : Event(q, Event::Stat_Event_Pri), interval(ival), lastNumInst(0), cpu(_cpu)
59 { schedule(curTick + interval); }
57 CPUProgressEvent(EventQueue *q, Tick ival, BaseCPU *_cpu);
60
61 void process();
62
63 virtual const char *description();
64};
65
66class BaseCPU : public MemObject
67{
68 protected:
69 // CPU's clock period in terms of the number of ticks of curTime.
70 Tick clock;
71
72 public:
73// Tick currentTick;
74 inline Tick frequency() const { return Clock::Frequency / clock; }
75 inline Tick cycles(int numCycles) const { return clock * numCycles; }
76 inline Tick curCycle() const { return curTick / clock; }
77
78#if FULL_SYSTEM
79 protected:
80 uint64_t interrupts[TheISA::NumInterruptLevels];
81 uint64_t intstatus;
82
83 public:
84 virtual void post_interrupt(int int_num, int index);
85 virtual void clear_interrupt(int int_num, int index);
86 virtual void clear_interrupts();
87 bool checkInterrupts;
88
89 bool check_interrupt(int int_num) const {
90 if (int_num > TheISA::NumInterruptLevels)
91 panic("int_num out of bounds\n");
92
93 return interrupts[int_num] != 0;
94 }
95
96 bool check_interrupts() const { return intstatus != 0; }
97 uint64_t intr_status() const { return intstatus; }
98
99 class ProfileEvent : public Event
100 {
101 private:
102 BaseCPU *cpu;
103 int interval;
104
105 public:
106 ProfileEvent(BaseCPU *cpu, int interval);
107 void process();
108 };
109 ProfileEvent *profileEvent;
110#endif
111
112 protected:
113 std::vector<ThreadContext *> threadContexts;
114
115 public:
116
117 /// Notify the CPU that the indicated context is now active. The
118 /// delay parameter indicates the number of ticks to wait before
119 /// executing (typically 0 or 1).
120 virtual void activateContext(int thread_num, int delay) {}
121
122 /// Notify the CPU that the indicated context is now suspended.
123 virtual void suspendContext(int thread_num) {}
124
125 /// Notify the CPU that the indicated context is now deallocated.
126 virtual void deallocateContext(int thread_num) {}
127
128 /// Notify the CPU that the indicated context is now halted.
129 virtual void haltContext(int thread_num) {}
130
131 public:
132 struct Params
133 {
134 std::string name;
135 int numberOfThreads;
136 bool deferRegistration;
137 Counter max_insts_any_thread;
138 Counter max_insts_all_threads;
139 Counter max_loads_any_thread;
140 Counter max_loads_all_threads;
58
59 void process();
60
61 virtual const char *description();
62};
63
64class BaseCPU : public MemObject
65{
66 protected:
67 // CPU's clock period in terms of the number of ticks of curTime.
68 Tick clock;
69
70 public:
71// Tick currentTick;
72 inline Tick frequency() const { return Clock::Frequency / clock; }
73 inline Tick cycles(int numCycles) const { return clock * numCycles; }
74 inline Tick curCycle() const { return curTick / clock; }
75
76#if FULL_SYSTEM
77 protected:
78 uint64_t interrupts[TheISA::NumInterruptLevels];
79 uint64_t intstatus;
80
81 public:
82 virtual void post_interrupt(int int_num, int index);
83 virtual void clear_interrupt(int int_num, int index);
84 virtual void clear_interrupts();
85 bool checkInterrupts;
86
87 bool check_interrupt(int int_num) const {
88 if (int_num > TheISA::NumInterruptLevels)
89 panic("int_num out of bounds\n");
90
91 return interrupts[int_num] != 0;
92 }
93
94 bool check_interrupts() const { return intstatus != 0; }
95 uint64_t intr_status() const { return intstatus; }
96
97 class ProfileEvent : public Event
98 {
99 private:
100 BaseCPU *cpu;
101 int interval;
102
103 public:
104 ProfileEvent(BaseCPU *cpu, int interval);
105 void process();
106 };
107 ProfileEvent *profileEvent;
108#endif
109
110 protected:
111 std::vector<ThreadContext *> threadContexts;
112
113 public:
114
115 /// Notify the CPU that the indicated context is now active. The
116 /// delay parameter indicates the number of ticks to wait before
117 /// executing (typically 0 or 1).
118 virtual void activateContext(int thread_num, int delay) {}
119
120 /// Notify the CPU that the indicated context is now suspended.
121 virtual void suspendContext(int thread_num) {}
122
123 /// Notify the CPU that the indicated context is now deallocated.
124 virtual void deallocateContext(int thread_num) {}
125
126 /// Notify the CPU that the indicated context is now halted.
127 virtual void haltContext(int thread_num) {}
128
129 public:
130 struct Params
131 {
132 std::string name;
133 int numberOfThreads;
134 bool deferRegistration;
135 Counter max_insts_any_thread;
136 Counter max_insts_all_threads;
137 Counter max_loads_any_thread;
138 Counter max_loads_all_threads;
141 Counter stats_reset_inst;
142 Tick clock;
143 bool functionTrace;
144 Tick functionTraceStart;
145 System *system;
146#if FULL_SYSTEM
147 int cpu_id;
148 Tick profile;
149#endif
150 Tick progress_interval;
151 BaseCPU *checker;
152
153 Params();
154 };
155
156 const Params *params;
157
158 BaseCPU(Params *params);
159 virtual ~BaseCPU();
160
161 virtual void init();
162 virtual void startup();
163 virtual void regStats();
164
165 virtual void activateWhenReady(int tid) {};
166
167 void registerThreadContexts();
168
169 /// Prepare for another CPU to take over execution. When it is
170 /// is ready (drained pipe) it signals the sampler.
171 virtual void switchOut();
172
173 /// Take over execution from the given CPU. Used for warm-up and
174 /// sampling.
175 virtual void takeOverFrom(BaseCPU *);
176
177 /**
178 * Number of threads we're actually simulating (<= SMT_MAX_THREADS).
179 * This is a constant for the duration of the simulation.
180 */
181 int number_of_threads;
182
183 /**
184 * Vector of per-thread instruction-based event queues. Used for
185 * scheduling events based on number of instructions committed by
186 * a particular thread.
187 */
188 EventQueue **comInstEventQueue;
189
190 /**
191 * Vector of per-thread load-based event queues. Used for
192 * scheduling events based on number of loads committed by
193 *a particular thread.
194 */
195 EventQueue **comLoadEventQueue;
196
197 System *system;
198
199#if FULL_SYSTEM
200 /**
201 * Serialize this object to the given output stream.
202 * @param os The stream to serialize to.
203 */
204 virtual void serialize(std::ostream &os);
205
206 /**
207 * Reconstruct the state of this object from a checkpoint.
208 * @param cp The checkpoint use.
209 * @param section The section name of this object
210 */
211 virtual void unserialize(Checkpoint *cp, const std::string &section);
212
213#endif
214
215 /**
216 * Return pointer to CPU's branch predictor (NULL if none).
217 * @return Branch predictor pointer.
218 */
219 virtual BranchPred *getBranchPred() { return NULL; };
220
221 virtual Counter totalInstructions() const { return 0; }
222
223 // Function tracing
224 private:
225 bool functionTracingEnabled;
226 std::ostream *functionTraceStream;
227 Addr currentFunctionStart;
228 Addr currentFunctionEnd;
229 Tick functionEntryTick;
230 void enableFunctionTrace();
231 void traceFunctionsInternal(Addr pc);
232
233 protected:
234 void traceFunctions(Addr pc)
235 {
236 if (functionTracingEnabled)
237 traceFunctionsInternal(pc);
238 }
239
240 private:
241 static std::vector<BaseCPU *> cpuList; //!< Static global cpu list
242
243 public:
244 static int numSimulatedCPUs() { return cpuList.size(); }
245 static Counter numSimulatedInstructions()
246 {
247 Counter total = 0;
248
249 int size = cpuList.size();
250 for (int i = 0; i < size; ++i)
251 total += cpuList[i]->totalInstructions();
252
253 return total;
254 }
255
256 public:
257 // Number of CPU cycles simulated
258 Stats::Scalar<> numCycles;
259};
260
261#endif // __CPU_BASE_HH__
139 Tick clock;
140 bool functionTrace;
141 Tick functionTraceStart;
142 System *system;
143#if FULL_SYSTEM
144 int cpu_id;
145 Tick profile;
146#endif
147 Tick progress_interval;
148 BaseCPU *checker;
149
150 Params();
151 };
152
153 const Params *params;
154
155 BaseCPU(Params *params);
156 virtual ~BaseCPU();
157
158 virtual void init();
159 virtual void startup();
160 virtual void regStats();
161
162 virtual void activateWhenReady(int tid) {};
163
164 void registerThreadContexts();
165
166 /// Prepare for another CPU to take over execution. When it is
167 /// is ready (drained pipe) it signals the sampler.
168 virtual void switchOut();
169
170 /// Take over execution from the given CPU. Used for warm-up and
171 /// sampling.
172 virtual void takeOverFrom(BaseCPU *);
173
174 /**
175 * Number of threads we're actually simulating (<= SMT_MAX_THREADS).
176 * This is a constant for the duration of the simulation.
177 */
178 int number_of_threads;
179
180 /**
181 * Vector of per-thread instruction-based event queues. Used for
182 * scheduling events based on number of instructions committed by
183 * a particular thread.
184 */
185 EventQueue **comInstEventQueue;
186
187 /**
188 * Vector of per-thread load-based event queues. Used for
189 * scheduling events based on number of loads committed by
190 *a particular thread.
191 */
192 EventQueue **comLoadEventQueue;
193
194 System *system;
195
196#if FULL_SYSTEM
197 /**
198 * Serialize this object to the given output stream.
199 * @param os The stream to serialize to.
200 */
201 virtual void serialize(std::ostream &os);
202
203 /**
204 * Reconstruct the state of this object from a checkpoint.
205 * @param cp The checkpoint use.
206 * @param section The section name of this object
207 */
208 virtual void unserialize(Checkpoint *cp, const std::string &section);
209
210#endif
211
212 /**
213 * Return pointer to CPU's branch predictor (NULL if none).
214 * @return Branch predictor pointer.
215 */
216 virtual BranchPred *getBranchPred() { return NULL; };
217
218 virtual Counter totalInstructions() const { return 0; }
219
220 // Function tracing
221 private:
222 bool functionTracingEnabled;
223 std::ostream *functionTraceStream;
224 Addr currentFunctionStart;
225 Addr currentFunctionEnd;
226 Tick functionEntryTick;
227 void enableFunctionTrace();
228 void traceFunctionsInternal(Addr pc);
229
230 protected:
231 void traceFunctions(Addr pc)
232 {
233 if (functionTracingEnabled)
234 traceFunctionsInternal(pc);
235 }
236
237 private:
238 static std::vector<BaseCPU *> cpuList; //!< Static global cpu list
239
240 public:
241 static int numSimulatedCPUs() { return cpuList.size(); }
242 static Counter numSimulatedInstructions()
243 {
244 Counter total = 0;
245
246 int size = cpuList.size();
247 for (int i = 0; i < size; ++i)
248 total += cpuList[i]->totalInstructions();
249
250 return total;
251 }
252
253 public:
254 // Number of CPU cycles simulated
255 Stats::Scalar<> numCycles;
256};
257
258#endif // __CPU_BASE_HH__