sim_object.cc (2839:d5dd8a3cdea0) sim_object.cc (2840:227f7c4f8c81)
1/*
2 * Copyright (c) 2001-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#include <assert.h>
33
34#include "base/callback.hh"
35#include "base/inifile.hh"
36#include "base/match.hh"
37#include "base/misc.hh"
38#include "base/trace.hh"
39#include "base/stats/events.hh"
1/*
2 * Copyright (c) 2001-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#include <assert.h>
33
34#include "base/callback.hh"
35#include "base/inifile.hh"
36#include "base/match.hh"
37#include "base/misc.hh"
38#include "base/trace.hh"
39#include "base/stats/events.hh"
40#include "base/serializer.hh"
41#include "sim/host.hh"
42#include "sim/sim_object.hh"
43#include "sim/stats.hh"
44#include "sim/param.hh"
45
46using namespace std;
47
48
49////////////////////////////////////////////////////////////////////////
50//
51// SimObject member definitions
52//
53////////////////////////////////////////////////////////////////////////
54
55//
56// static list of all SimObjects, used for initialization etc.
57//
58SimObject::SimObjectList SimObject::simObjectList;
59
60namespace Stats {
61 extern ObjectMatch event_ignore;
62}
63
64//
65// SimObject constructor: used to maintain static simObjectList
66//
67SimObject::SimObject(Params *p)
68 : _params(p)
69{
70#ifdef DEBUG
71 doDebugBreak = false;
72#endif
73
74 doRecordEvent = !Stats::event_ignore.match(name());
75 simObjectList.push_back(this);
76 state = Atomic;
77}
78
79//
80// SimObject constructor: used to maintain static simObjectList
81//
82SimObject::SimObject(const string &_name)
83 : _params(new Params)
84{
85 _params->name = _name;
86#ifdef DEBUG
87 doDebugBreak = false;
88#endif
89
90 doRecordEvent = !Stats::event_ignore.match(name());
91 simObjectList.push_back(this);
92 state = Atomic;
93}
94
95void
96SimObject::connect()
97{
98}
99
100void
101SimObject::init()
102{
103}
104
105//
106// no default statistics, so nothing to do in base implementation
107//
108void
109SimObject::regStats()
110{
111}
112
113void
114SimObject::regFormulas()
115{
116}
117
118void
119SimObject::resetStats()
120{
121}
122
123//
124// static function:
125// call regStats() on all SimObjects and then regFormulas() on all
126// SimObjects.
127//
128struct SimObjectResetCB : public Callback
129{
130 virtual void process() { SimObject::resetAllStats(); }
131};
132
133namespace {
134 static SimObjectResetCB StatResetCB;
135}
136
137void
138SimObject::regAllStats()
139{
140 SimObjectList::iterator i;
141 SimObjectList::iterator end = simObjectList.end();
142
143 /**
144 * @todo change cprintfs to DPRINTFs
145 */
146 for (i = simObjectList.begin(); i != end; ++i) {
147#ifdef STAT_DEBUG
148 cprintf("registering stats for %s\n", (*i)->name());
149#endif
150 (*i)->regStats();
151 }
152
153 for (i = simObjectList.begin(); i != end; ++i) {
154#ifdef STAT_DEBUG
155 cprintf("registering formulas for %s\n", (*i)->name());
156#endif
157 (*i)->regFormulas();
158 }
159
160 Stats::registerResetCallback(&StatResetCB);
161}
162
163//
164// static function: call connect() on all SimObjects.
165//
166void
167SimObject::connectAll()
168{
169 SimObjectList::iterator i = simObjectList.begin();
170 SimObjectList::iterator end = simObjectList.end();
171
172 for (; i != end; ++i) {
173 SimObject *obj = *i;
174 obj->connect();
175 }
176}
177
178//
179// static function: call init() on all SimObjects.
180//
181void
182SimObject::initAll()
183{
184 SimObjectList::iterator i = simObjectList.begin();
185 SimObjectList::iterator end = simObjectList.end();
186
187 for (; i != end; ++i) {
188 SimObject *obj = *i;
189 obj->init();
190 }
191}
192
193//
194// static function: call resetStats() on all SimObjects.
195//
196void
197SimObject::resetAllStats()
198{
199 SimObjectList::iterator i = simObjectList.begin();
200 SimObjectList::iterator end = simObjectList.end();
201
202 for (; i != end; ++i) {
203 SimObject *obj = *i;
204 obj->resetStats();
205 }
206}
207
208//
209// static function: serialize all SimObjects.
210//
211void
212SimObject::serializeAll(ostream &os)
213{
214 SimObjectList::reverse_iterator ri = simObjectList.rbegin();
215 SimObjectList::reverse_iterator rend = simObjectList.rend();
216
217 for (; ri != rend; ++ri) {
218 SimObject *obj = *ri;
219 obj->nameOut(os);
220 obj->serialize(os);
221 }
222}
223
224void
225SimObject::unserializeAll(Checkpoint *cp)
226{
227 SimObjectList::reverse_iterator ri = simObjectList.rbegin();
228 SimObjectList::reverse_iterator rend = simObjectList.rend();
229
230 for (; ri != rend; ++ri) {
231 SimObject *obj = *ri;
232 DPRINTFR(Config, "Unserializing '%s'\n",
233 obj->name());
234 if(cp->sectionExists(obj->name()))
235 obj->unserialize(cp, obj->name());
236 else
237 warn("Not unserializing '%s': no section found in checkpoint.\n",
238 obj->name());
239 }
240}
241
242#ifdef DEBUG
243//
244// static function: flag which objects should have the debugger break
245//
246void
247SimObject::debugObjectBreak(const string &objs)
248{
249 SimObjectList::const_iterator i = simObjectList.begin();
250 SimObjectList::const_iterator end = simObjectList.end();
251
252 ObjectMatch match(objs);
253 for (; i != end; ++i) {
254 SimObject *obj = *i;
255 obj->doDebugBreak = match.match(obj->name());
256 }
257}
258
259void
260debugObjectBreak(const char *objs)
261{
262 SimObject::debugObjectBreak(string(objs));
263}
264#endif
265
266void
267SimObject::recordEvent(const std::string &stat)
268{
269 if (doRecordEvent)
270 Stats::recordEvent(stat);
271}
272
273bool
274SimObject::drain(Event *drain_event)
275{
276 if (state != DrainedAtomic && state != Atomic) {
277 panic("Must implement your own drain function if it is to be used "
278 "in timing mode!");
279 }
280 state = DrainedAtomic;
281 return false;
282}
283
284void
285SimObject::resume()
286{
287 if (state == DrainedAtomic) {
288 state = Atomic;
289 } else if (state == DrainedTiming) {
290 state = Timing;
291 }
292}
293
294void
295SimObject::setMemoryMode(State new_mode)
296{
297 assert(new_mode == Timing || new_mode == Atomic);
298 if (state == DrainedAtomic && new_mode == Timing) {
299 state = DrainedTiming;
300 } else if (state == DrainedTiming && new_mode == Atomic) {
301 state = DrainedAtomic;
302 } else {
303 state = new_mode;
304 }
305}
306
307void
308SimObject::switchOut()
309{
310 panic("Unimplemented!");
311}
312
313void
314SimObject::takeOverFrom(BaseCPU *cpu)
315{
316 panic("Unimplemented!");
317}
318
319DEFINE_SIM_OBJECT_CLASS_NAME("SimObject", SimObject)
40#include "sim/host.hh"
41#include "sim/sim_object.hh"
42#include "sim/stats.hh"
43#include "sim/param.hh"
44
45using namespace std;
46
47
48////////////////////////////////////////////////////////////////////////
49//
50// SimObject member definitions
51//
52////////////////////////////////////////////////////////////////////////
53
54//
55// static list of all SimObjects, used for initialization etc.
56//
57SimObject::SimObjectList SimObject::simObjectList;
58
59namespace Stats {
60 extern ObjectMatch event_ignore;
61}
62
63//
64// SimObject constructor: used to maintain static simObjectList
65//
66SimObject::SimObject(Params *p)
67 : _params(p)
68{
69#ifdef DEBUG
70 doDebugBreak = false;
71#endif
72
73 doRecordEvent = !Stats::event_ignore.match(name());
74 simObjectList.push_back(this);
75 state = Atomic;
76}
77
78//
79// SimObject constructor: used to maintain static simObjectList
80//
81SimObject::SimObject(const string &_name)
82 : _params(new Params)
83{
84 _params->name = _name;
85#ifdef DEBUG
86 doDebugBreak = false;
87#endif
88
89 doRecordEvent = !Stats::event_ignore.match(name());
90 simObjectList.push_back(this);
91 state = Atomic;
92}
93
94void
95SimObject::connect()
96{
97}
98
99void
100SimObject::init()
101{
102}
103
104//
105// no default statistics, so nothing to do in base implementation
106//
107void
108SimObject::regStats()
109{
110}
111
112void
113SimObject::regFormulas()
114{
115}
116
117void
118SimObject::resetStats()
119{
120}
121
122//
123// static function:
124// call regStats() on all SimObjects and then regFormulas() on all
125// SimObjects.
126//
127struct SimObjectResetCB : public Callback
128{
129 virtual void process() { SimObject::resetAllStats(); }
130};
131
132namespace {
133 static SimObjectResetCB StatResetCB;
134}
135
136void
137SimObject::regAllStats()
138{
139 SimObjectList::iterator i;
140 SimObjectList::iterator end = simObjectList.end();
141
142 /**
143 * @todo change cprintfs to DPRINTFs
144 */
145 for (i = simObjectList.begin(); i != end; ++i) {
146#ifdef STAT_DEBUG
147 cprintf("registering stats for %s\n", (*i)->name());
148#endif
149 (*i)->regStats();
150 }
151
152 for (i = simObjectList.begin(); i != end; ++i) {
153#ifdef STAT_DEBUG
154 cprintf("registering formulas for %s\n", (*i)->name());
155#endif
156 (*i)->regFormulas();
157 }
158
159 Stats::registerResetCallback(&StatResetCB);
160}
161
162//
163// static function: call connect() on all SimObjects.
164//
165void
166SimObject::connectAll()
167{
168 SimObjectList::iterator i = simObjectList.begin();
169 SimObjectList::iterator end = simObjectList.end();
170
171 for (; i != end; ++i) {
172 SimObject *obj = *i;
173 obj->connect();
174 }
175}
176
177//
178// static function: call init() on all SimObjects.
179//
180void
181SimObject::initAll()
182{
183 SimObjectList::iterator i = simObjectList.begin();
184 SimObjectList::iterator end = simObjectList.end();
185
186 for (; i != end; ++i) {
187 SimObject *obj = *i;
188 obj->init();
189 }
190}
191
192//
193// static function: call resetStats() on all SimObjects.
194//
195void
196SimObject::resetAllStats()
197{
198 SimObjectList::iterator i = simObjectList.begin();
199 SimObjectList::iterator end = simObjectList.end();
200
201 for (; i != end; ++i) {
202 SimObject *obj = *i;
203 obj->resetStats();
204 }
205}
206
207//
208// static function: serialize all SimObjects.
209//
210void
211SimObject::serializeAll(ostream &os)
212{
213 SimObjectList::reverse_iterator ri = simObjectList.rbegin();
214 SimObjectList::reverse_iterator rend = simObjectList.rend();
215
216 for (; ri != rend; ++ri) {
217 SimObject *obj = *ri;
218 obj->nameOut(os);
219 obj->serialize(os);
220 }
221}
222
223void
224SimObject::unserializeAll(Checkpoint *cp)
225{
226 SimObjectList::reverse_iterator ri = simObjectList.rbegin();
227 SimObjectList::reverse_iterator rend = simObjectList.rend();
228
229 for (; ri != rend; ++ri) {
230 SimObject *obj = *ri;
231 DPRINTFR(Config, "Unserializing '%s'\n",
232 obj->name());
233 if(cp->sectionExists(obj->name()))
234 obj->unserialize(cp, obj->name());
235 else
236 warn("Not unserializing '%s': no section found in checkpoint.\n",
237 obj->name());
238 }
239}
240
241#ifdef DEBUG
242//
243// static function: flag which objects should have the debugger break
244//
245void
246SimObject::debugObjectBreak(const string &objs)
247{
248 SimObjectList::const_iterator i = simObjectList.begin();
249 SimObjectList::const_iterator end = simObjectList.end();
250
251 ObjectMatch match(objs);
252 for (; i != end; ++i) {
253 SimObject *obj = *i;
254 obj->doDebugBreak = match.match(obj->name());
255 }
256}
257
258void
259debugObjectBreak(const char *objs)
260{
261 SimObject::debugObjectBreak(string(objs));
262}
263#endif
264
265void
266SimObject::recordEvent(const std::string &stat)
267{
268 if (doRecordEvent)
269 Stats::recordEvent(stat);
270}
271
272bool
273SimObject::drain(Event *drain_event)
274{
275 if (state != DrainedAtomic && state != Atomic) {
276 panic("Must implement your own drain function if it is to be used "
277 "in timing mode!");
278 }
279 state = DrainedAtomic;
280 return false;
281}
282
283void
284SimObject::resume()
285{
286 if (state == DrainedAtomic) {
287 state = Atomic;
288 } else if (state == DrainedTiming) {
289 state = Timing;
290 }
291}
292
293void
294SimObject::setMemoryMode(State new_mode)
295{
296 assert(new_mode == Timing || new_mode == Atomic);
297 if (state == DrainedAtomic && new_mode == Timing) {
298 state = DrainedTiming;
299 } else if (state == DrainedTiming && new_mode == Atomic) {
300 state = DrainedAtomic;
301 } else {
302 state = new_mode;
303 }
304}
305
306void
307SimObject::switchOut()
308{
309 panic("Unimplemented!");
310}
311
312void
313SimObject::takeOverFrom(BaseCPU *cpu)
314{
315 panic("Unimplemented!");
316}
317
318DEFINE_SIM_OBJECT_CLASS_NAME("SimObject", SimObject)