main.cc (3645:2bf1f7c69254) main.cc (3868:5a58b399e883)
1/*
2 * Copyright (c) 2000-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 Raasch
29 * Nathan Binkert
30 * Steve Reinhardt
31 */
32
33///
34/// @file sim/main.cc
35///
36#include <Python.h> // must be before system headers... see Python docs
37
38#include <sys/types.h>
39#include <sys/stat.h>
40#include <errno.h>
41#include <libgen.h>
42#include <stdlib.h>
43#include <signal.h>
44#include <getopt.h>
45
46#include <list>
47#include <string>
48#include <vector>
49
50#include "base/callback.hh"
51#include "base/inifile.hh"
52#include "base/misc.hh"
53#include "base/output.hh"
54#include "base/pollevent.hh"
55#include "base/statistics.hh"
56#include "base/str.hh"
57#include "base/time.hh"
58#include "config/pythonhome.hh"
59#include "cpu/base.hh"
60#include "cpu/smt.hh"
61#include "mem/mem_object.hh"
62#include "mem/port.hh"
1/*
2 * Copyright (c) 2000-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 Raasch
29 * Nathan Binkert
30 * Steve Reinhardt
31 */
32
33///
34/// @file sim/main.cc
35///
36#include <Python.h> // must be before system headers... see Python docs
37
38#include <sys/types.h>
39#include <sys/stat.h>
40#include <errno.h>
41#include <libgen.h>
42#include <stdlib.h>
43#include <signal.h>
44#include <getopt.h>
45
46#include <list>
47#include <string>
48#include <vector>
49
50#include "base/callback.hh"
51#include "base/inifile.hh"
52#include "base/misc.hh"
53#include "base/output.hh"
54#include "base/pollevent.hh"
55#include "base/statistics.hh"
56#include "base/str.hh"
57#include "base/time.hh"
58#include "config/pythonhome.hh"
59#include "cpu/base.hh"
60#include "cpu/smt.hh"
61#include "mem/mem_object.hh"
62#include "mem/port.hh"
63#include "python/swig/init.hh"
63#include "sim/async.hh"
64#include "sim/builder.hh"
65#include "sim/host.hh"
66#include "sim/serialize.hh"
67#include "sim/sim_events.hh"
68#include "sim/sim_exit.hh"
69#include "sim/sim_object.hh"
70#include "sim/system.hh"
71#include "sim/stat_control.hh"
72#include "sim/stats.hh"
73#include "sim/root.hh"
74
75using namespace std;
76
77// See async.h.
78volatile bool async_event = false;
79volatile bool async_dump = false;
80volatile bool async_dumpreset = false;
81volatile bool async_exit = false;
82volatile bool async_io = false;
83volatile bool async_alarm = false;
84
85/// Stats signal handler.
86void
87dumpStatsHandler(int sigtype)
88{
89 async_event = true;
90 async_dump = true;
91}
92
93void
94dumprstStatsHandler(int sigtype)
95{
96 async_event = true;
97 async_dumpreset = true;
98}
99
100/// Exit signal handler.
101void
102exitNowHandler(int sigtype)
103{
104 async_event = true;
105 async_exit = true;
106}
107
108/// Abort signal handler.
109void
110abortHandler(int sigtype)
111{
112 cerr << "Program aborted at cycle " << curTick << endl;
113
114#if TRACING_ON
115 // dump trace buffer, if there is one
116 Trace::theLog.dump(cerr);
117#endif
118}
119
64#include "sim/async.hh"
65#include "sim/builder.hh"
66#include "sim/host.hh"
67#include "sim/serialize.hh"
68#include "sim/sim_events.hh"
69#include "sim/sim_exit.hh"
70#include "sim/sim_object.hh"
71#include "sim/system.hh"
72#include "sim/stat_control.hh"
73#include "sim/stats.hh"
74#include "sim/root.hh"
75
76using namespace std;
77
78// See async.h.
79volatile bool async_event = false;
80volatile bool async_dump = false;
81volatile bool async_dumpreset = false;
82volatile bool async_exit = false;
83volatile bool async_io = false;
84volatile bool async_alarm = false;
85
86/// Stats signal handler.
87void
88dumpStatsHandler(int sigtype)
89{
90 async_event = true;
91 async_dump = true;
92}
93
94void
95dumprstStatsHandler(int sigtype)
96{
97 async_event = true;
98 async_dumpreset = true;
99}
100
101/// Exit signal handler.
102void
103exitNowHandler(int sigtype)
104{
105 async_event = true;
106 async_exit = true;
107}
108
109/// Abort signal handler.
110void
111abortHandler(int sigtype)
112{
113 cerr << "Program aborted at cycle " << curTick << endl;
114
115#if TRACING_ON
116 // dump trace buffer, if there is one
117 Trace::theLog.dump(cerr);
118#endif
119}
120
120extern "C" {
121void init_main();
122void init_debug();
123}
124
125int
126main(int argc, char **argv)
127{
128 signal(SIGFPE, SIG_IGN); // may occur on misspeculated paths
129 signal(SIGTRAP, SIG_IGN);
130 signal(SIGUSR1, dumpStatsHandler); // dump intermediate stats
131 signal(SIGUSR2, dumprstStatsHandler); // dump and reset stats
132 signal(SIGINT, exitNowHandler); // dump final stats and exit
133 signal(SIGABRT, abortHandler);
134
135 Py_SetProgramName(argv[0]);
136
137 // default path to m5 python code is the currently executing
138 // file... Python ZipImporter will find embedded zip archive.
139 // The M5_ARCHIVE environment variable can be used to override this.
140 char *m5_archive = getenv("M5_ARCHIVE");
141 string pythonpath = m5_archive ? m5_archive : argv[0];
142
143 char *oldpath = getenv("PYTHONPATH");
144 if (oldpath != NULL) {
145 pythonpath += ":";
146 pythonpath += oldpath;
147 }
148
149 if (setenv("PYTHONPATH", pythonpath.c_str(), true) == -1)
150 fatal("setenv: %s\n", strerror(errno));
151
152 char *python_home = getenv("PYTHONHOME");
153 if (!python_home)
154 python_home = PYTHONHOME;
155 Py_SetPythonHome(python_home);
156
157 // initialize embedded Python interpreter
158 Py_Initialize();
159 PySys_SetArgv(argc, argv);
160
161 // initialize SWIG modules
121int
122main(int argc, char **argv)
123{
124 signal(SIGFPE, SIG_IGN); // may occur on misspeculated paths
125 signal(SIGTRAP, SIG_IGN);
126 signal(SIGUSR1, dumpStatsHandler); // dump intermediate stats
127 signal(SIGUSR2, dumprstStatsHandler); // dump and reset stats
128 signal(SIGINT, exitNowHandler); // dump final stats and exit
129 signal(SIGABRT, abortHandler);
130
131 Py_SetProgramName(argv[0]);
132
133 // default path to m5 python code is the currently executing
134 // file... Python ZipImporter will find embedded zip archive.
135 // The M5_ARCHIVE environment variable can be used to override this.
136 char *m5_archive = getenv("M5_ARCHIVE");
137 string pythonpath = m5_archive ? m5_archive : argv[0];
138
139 char *oldpath = getenv("PYTHONPATH");
140 if (oldpath != NULL) {
141 pythonpath += ":";
142 pythonpath += oldpath;
143 }
144
145 if (setenv("PYTHONPATH", pythonpath.c_str(), true) == -1)
146 fatal("setenv: %s\n", strerror(errno));
147
148 char *python_home = getenv("PYTHONHOME");
149 if (!python_home)
150 python_home = PYTHONHOME;
151 Py_SetPythonHome(python_home);
152
153 // initialize embedded Python interpreter
154 Py_Initialize();
155 PySys_SetArgv(argc, argv);
156
157 // initialize SWIG modules
162 init_main();
163 init_debug();
158 init_swig();
164
165 PyRun_SimpleString("import m5.main");
166 PyRun_SimpleString("m5.main.main()");
167
168 // clean up Python intepreter.
169 Py_Finalize();
170}
171
172
173void
174setOutputDir(const string &dir)
175{
176 simout.setDirectory(dir);
177}
178
179
180IniFile inifile;
181
182SimObject *
183createSimObject(const string &name)
184{
185 return SimObjectClass::createObject(inifile, name);
186}
187
188
189/**
190 * Pointer to the Python function that maps names to SimObjects.
191 */
192PyObject *resolveFunc = NULL;
193
194/**
195 * Convert a pointer to the Python object that SWIG wraps around a C++
196 * SimObject pointer back to the actual C++ pointer. See main.i.
197 */
198extern "C" SimObject *convertSwigSimObjectPtr(PyObject *);
199
200
201SimObject *
202resolveSimObject(const string &name)
203{
204 PyObject *pyPtr = PyEval_CallFunction(resolveFunc, "(s)", name.c_str());
205 if (pyPtr == NULL) {
206 PyErr_Print();
207 panic("resolveSimObject: failure on call to Python for %s", name);
208 }
209
210 SimObject *simObj = convertSwigSimObjectPtr(pyPtr);
211 if (simObj == NULL)
212 panic("resolveSimObject: failure on pointer conversion for %s", name);
213
214 return simObj;
215}
216
217
218/**
219 * Load config.ini into C++ database. Exported to Python via SWIG;
220 * invoked from m5.instantiate().
221 */
222void
223loadIniFile(PyObject *_resolveFunc)
224{
225 resolveFunc = _resolveFunc;
226 configStream = simout.find("config.out");
227
228 // The configuration database is now complete; start processing it.
229 inifile.load(simout.resolve("config.ini"));
230
231 // Initialize statistics database
232 Stats::InitSimStats();
233}
234
235
236/**
237 * Look up a MemObject port. Helper function for connectPorts().
238 */
239Port *
240lookupPort(SimObject *so, const std::string &name, int i)
241{
242 MemObject *mo = dynamic_cast<MemObject *>(so);
243 if (mo == NULL) {
244 warn("error casting SimObject %s to MemObject", so->name());
245 return NULL;
246 }
247
248 Port *p = mo->getPort(name, i);
249 if (p == NULL)
250 warn("error looking up port %s on object %s", name, so->name());
251 return p;
252}
253
254
255/**
256 * Connect the described MemObject ports. Called from Python via SWIG.
257 */
258int
259connectPorts(SimObject *o1, const std::string &name1, int i1,
260 SimObject *o2, const std::string &name2, int i2)
261{
262 Port *p1 = lookupPort(o1, name1, i1);
263 Port *p2 = lookupPort(o2, name2, i2);
264
265 if (p1 == NULL || p2 == NULL) {
266 warn("connectPorts: port lookup error");
267 return 0;
268 }
269
270 p1->setPeer(p2);
271 p2->setPeer(p1);
272
273 return 1;
274}
275
276/**
277 * Do final initialization steps after object construction but before
278 * start of simulation.
279 */
280void
281finalInit()
282{
283 // Parse and check all non-config-hierarchy parameters.
284 ParamContext::parseAllContexts(inifile);
285 ParamContext::checkAllContexts();
286
287 // Echo all parameter settings to stats file as well.
288 ParamContext::showAllContexts(*configStream);
289
290 // Do a second pass to finish initializing the sim objects
291 SimObject::initAll();
292
293 // Restore checkpointed state, if any.
294#if 0
295 configHierarchy.unserializeSimObjects();
296#endif
297
298 SimObject::regAllStats();
299
300 // Check to make sure that the stats package is properly initialized
301 Stats::check();
302
303 // Reset to put the stats in a consistent state.
304 Stats::reset();
305
306 SimStartup();
307}
308
309
310/** Simulate for num_cycles additional cycles. If num_cycles is -1
311 * (the default), do not limit simulation; some other event must
312 * terminate the loop. Exported to Python via SWIG.
313 * @return The SimLoopExitEvent that caused the loop to exit.
314 */
315SimLoopExitEvent *
316simulate(Tick num_cycles = MaxTick)
317{
318 warn("Entering event queue @ %d. Starting simulation...\n", curTick);
319
320 if (num_cycles < 0)
321 fatal("simulate: num_cycles must be >= 0 (was %d)\n", num_cycles);
322 else if (curTick + num_cycles < 0) //Overflow
323 num_cycles = MaxTick;
324 else
325 num_cycles = curTick + num_cycles;
326
327 Event *limit_event = schedExitSimLoop("simulate() limit reached",
328 num_cycles);
329
330 while (1) {
331 // there should always be at least one event (the SimLoopExitEvent
332 // we just scheduled) in the queue
333 assert(!mainEventQueue.empty());
334 assert(curTick <= mainEventQueue.nextTick() &&
335 "event scheduled in the past");
336
337 // forward current cycle to the time of the first event on the
338 // queue
339 curTick = mainEventQueue.nextTick();
340 Event *exit_event = mainEventQueue.serviceOne();
341 if (exit_event != NULL) {
342 // hit some kind of exit event; return to Python
343 // event must be subclass of SimLoopExitEvent...
344 SimLoopExitEvent *se_event = dynamic_cast<SimLoopExitEvent *>(exit_event);
345 if (se_event == NULL)
346 panic("Bogus exit event class!");
347
348 // if we didn't hit limit_event, delete it
349 if (se_event != limit_event) {
350 assert(limit_event->scheduled());
351 limit_event->deschedule();
352 delete limit_event;
353 }
354
355 return se_event;
356 }
357
358 if (async_event) {
359 async_event = false;
360 if (async_dump) {
361 async_dump = false;
362
363 using namespace Stats;
364 SetupEvent(Dump, curTick);
365 }
366
367 if (async_dumpreset) {
368 async_dumpreset = false;
369
370 using namespace Stats;
371 SetupEvent(Dump | Reset, curTick);
372 }
373
374 if (async_exit) {
375 async_exit = false;
376 exitSimLoop("user interrupt received");
377 }
378
379 if (async_io || async_alarm) {
380 async_io = false;
381 async_alarm = false;
382 pollQueue.service();
383 }
384 }
385 }
386
387 // not reached... only exit is return on SimLoopExitEvent
388}
389
390Event *
391createCountedDrain()
392{
393 return new CountedDrainEvent();
394}
395
396void
397cleanupCountedDrain(Event *counted_drain)
398{
399 CountedDrainEvent *event =
400 dynamic_cast<CountedDrainEvent *>(counted_drain);
401 if (event == NULL) {
402 fatal("Called cleanupCountedDrain() on an event that was not "
403 "a CountedDrainEvent.");
404 }
405 assert(event->getCount() == 0);
406 delete event;
407}
408
409void
410serializeAll(const std::string &cpt_dir)
411{
412 Serializable::serializeAll(cpt_dir);
413}
414
415void
416unserializeAll(const std::string &cpt_dir)
417{
418 Serializable::unserializeAll(cpt_dir);
419}
420
421/**
422 * Queue of C++ callbacks to invoke on simulator exit.
423 */
424CallbackQueue&
425exitCallbacks()
426{
427 static CallbackQueue theQueue;
428 return theQueue;
429}
430
431/**
432 * Register an exit callback.
433 */
434void
435registerExitCallback(Callback *callback)
436{
437 exitCallbacks().add(callback);
438}
439
440BaseCPU *
441convertToBaseCPUPtr(SimObject *obj)
442{
443 BaseCPU *ptr = dynamic_cast<BaseCPU *>(obj);
444
445 if (ptr == NULL)
446 warn("Casting to BaseCPU pointer failed");
447 return ptr;
448}
449
450System *
451convertToSystemPtr(SimObject *obj)
452{
453 System *ptr = dynamic_cast<System *>(obj);
454
455 if (ptr == NULL)
456 warn("Casting to System pointer failed");
457 return ptr;
458}
459
460
461/**
462 * Do C++ simulator exit processing. Exported to SWIG to be invoked
463 * when simulator terminates via Python's atexit mechanism.
464 */
465void
466doExitCleanup()
467{
468 exitCallbacks().process();
469 exitCallbacks().clear();
470
471 cout.flush();
472
473 ParamContext::cleanupAllContexts();
474
475 // print simulation stats
476 Stats::DumpNow();
477}
159
160 PyRun_SimpleString("import m5.main");
161 PyRun_SimpleString("m5.main.main()");
162
163 // clean up Python intepreter.
164 Py_Finalize();
165}
166
167
168void
169setOutputDir(const string &dir)
170{
171 simout.setDirectory(dir);
172}
173
174
175IniFile inifile;
176
177SimObject *
178createSimObject(const string &name)
179{
180 return SimObjectClass::createObject(inifile, name);
181}
182
183
184/**
185 * Pointer to the Python function that maps names to SimObjects.
186 */
187PyObject *resolveFunc = NULL;
188
189/**
190 * Convert a pointer to the Python object that SWIG wraps around a C++
191 * SimObject pointer back to the actual C++ pointer. See main.i.
192 */
193extern "C" SimObject *convertSwigSimObjectPtr(PyObject *);
194
195
196SimObject *
197resolveSimObject(const string &name)
198{
199 PyObject *pyPtr = PyEval_CallFunction(resolveFunc, "(s)", name.c_str());
200 if (pyPtr == NULL) {
201 PyErr_Print();
202 panic("resolveSimObject: failure on call to Python for %s", name);
203 }
204
205 SimObject *simObj = convertSwigSimObjectPtr(pyPtr);
206 if (simObj == NULL)
207 panic("resolveSimObject: failure on pointer conversion for %s", name);
208
209 return simObj;
210}
211
212
213/**
214 * Load config.ini into C++ database. Exported to Python via SWIG;
215 * invoked from m5.instantiate().
216 */
217void
218loadIniFile(PyObject *_resolveFunc)
219{
220 resolveFunc = _resolveFunc;
221 configStream = simout.find("config.out");
222
223 // The configuration database is now complete; start processing it.
224 inifile.load(simout.resolve("config.ini"));
225
226 // Initialize statistics database
227 Stats::InitSimStats();
228}
229
230
231/**
232 * Look up a MemObject port. Helper function for connectPorts().
233 */
234Port *
235lookupPort(SimObject *so, const std::string &name, int i)
236{
237 MemObject *mo = dynamic_cast<MemObject *>(so);
238 if (mo == NULL) {
239 warn("error casting SimObject %s to MemObject", so->name());
240 return NULL;
241 }
242
243 Port *p = mo->getPort(name, i);
244 if (p == NULL)
245 warn("error looking up port %s on object %s", name, so->name());
246 return p;
247}
248
249
250/**
251 * Connect the described MemObject ports. Called from Python via SWIG.
252 */
253int
254connectPorts(SimObject *o1, const std::string &name1, int i1,
255 SimObject *o2, const std::string &name2, int i2)
256{
257 Port *p1 = lookupPort(o1, name1, i1);
258 Port *p2 = lookupPort(o2, name2, i2);
259
260 if (p1 == NULL || p2 == NULL) {
261 warn("connectPorts: port lookup error");
262 return 0;
263 }
264
265 p1->setPeer(p2);
266 p2->setPeer(p1);
267
268 return 1;
269}
270
271/**
272 * Do final initialization steps after object construction but before
273 * start of simulation.
274 */
275void
276finalInit()
277{
278 // Parse and check all non-config-hierarchy parameters.
279 ParamContext::parseAllContexts(inifile);
280 ParamContext::checkAllContexts();
281
282 // Echo all parameter settings to stats file as well.
283 ParamContext::showAllContexts(*configStream);
284
285 // Do a second pass to finish initializing the sim objects
286 SimObject::initAll();
287
288 // Restore checkpointed state, if any.
289#if 0
290 configHierarchy.unserializeSimObjects();
291#endif
292
293 SimObject::regAllStats();
294
295 // Check to make sure that the stats package is properly initialized
296 Stats::check();
297
298 // Reset to put the stats in a consistent state.
299 Stats::reset();
300
301 SimStartup();
302}
303
304
305/** Simulate for num_cycles additional cycles. If num_cycles is -1
306 * (the default), do not limit simulation; some other event must
307 * terminate the loop. Exported to Python via SWIG.
308 * @return The SimLoopExitEvent that caused the loop to exit.
309 */
310SimLoopExitEvent *
311simulate(Tick num_cycles = MaxTick)
312{
313 warn("Entering event queue @ %d. Starting simulation...\n", curTick);
314
315 if (num_cycles < 0)
316 fatal("simulate: num_cycles must be >= 0 (was %d)\n", num_cycles);
317 else if (curTick + num_cycles < 0) //Overflow
318 num_cycles = MaxTick;
319 else
320 num_cycles = curTick + num_cycles;
321
322 Event *limit_event = schedExitSimLoop("simulate() limit reached",
323 num_cycles);
324
325 while (1) {
326 // there should always be at least one event (the SimLoopExitEvent
327 // we just scheduled) in the queue
328 assert(!mainEventQueue.empty());
329 assert(curTick <= mainEventQueue.nextTick() &&
330 "event scheduled in the past");
331
332 // forward current cycle to the time of the first event on the
333 // queue
334 curTick = mainEventQueue.nextTick();
335 Event *exit_event = mainEventQueue.serviceOne();
336 if (exit_event != NULL) {
337 // hit some kind of exit event; return to Python
338 // event must be subclass of SimLoopExitEvent...
339 SimLoopExitEvent *se_event = dynamic_cast<SimLoopExitEvent *>(exit_event);
340 if (se_event == NULL)
341 panic("Bogus exit event class!");
342
343 // if we didn't hit limit_event, delete it
344 if (se_event != limit_event) {
345 assert(limit_event->scheduled());
346 limit_event->deschedule();
347 delete limit_event;
348 }
349
350 return se_event;
351 }
352
353 if (async_event) {
354 async_event = false;
355 if (async_dump) {
356 async_dump = false;
357
358 using namespace Stats;
359 SetupEvent(Dump, curTick);
360 }
361
362 if (async_dumpreset) {
363 async_dumpreset = false;
364
365 using namespace Stats;
366 SetupEvent(Dump | Reset, curTick);
367 }
368
369 if (async_exit) {
370 async_exit = false;
371 exitSimLoop("user interrupt received");
372 }
373
374 if (async_io || async_alarm) {
375 async_io = false;
376 async_alarm = false;
377 pollQueue.service();
378 }
379 }
380 }
381
382 // not reached... only exit is return on SimLoopExitEvent
383}
384
385Event *
386createCountedDrain()
387{
388 return new CountedDrainEvent();
389}
390
391void
392cleanupCountedDrain(Event *counted_drain)
393{
394 CountedDrainEvent *event =
395 dynamic_cast<CountedDrainEvent *>(counted_drain);
396 if (event == NULL) {
397 fatal("Called cleanupCountedDrain() on an event that was not "
398 "a CountedDrainEvent.");
399 }
400 assert(event->getCount() == 0);
401 delete event;
402}
403
404void
405serializeAll(const std::string &cpt_dir)
406{
407 Serializable::serializeAll(cpt_dir);
408}
409
410void
411unserializeAll(const std::string &cpt_dir)
412{
413 Serializable::unserializeAll(cpt_dir);
414}
415
416/**
417 * Queue of C++ callbacks to invoke on simulator exit.
418 */
419CallbackQueue&
420exitCallbacks()
421{
422 static CallbackQueue theQueue;
423 return theQueue;
424}
425
426/**
427 * Register an exit callback.
428 */
429void
430registerExitCallback(Callback *callback)
431{
432 exitCallbacks().add(callback);
433}
434
435BaseCPU *
436convertToBaseCPUPtr(SimObject *obj)
437{
438 BaseCPU *ptr = dynamic_cast<BaseCPU *>(obj);
439
440 if (ptr == NULL)
441 warn("Casting to BaseCPU pointer failed");
442 return ptr;
443}
444
445System *
446convertToSystemPtr(SimObject *obj)
447{
448 System *ptr = dynamic_cast<System *>(obj);
449
450 if (ptr == NULL)
451 warn("Casting to System pointer failed");
452 return ptr;
453}
454
455
456/**
457 * Do C++ simulator exit processing. Exported to SWIG to be invoked
458 * when simulator terminates via Python's atexit mechanism.
459 */
460void
461doExitCleanup()
462{
463 exitCallbacks().process();
464 exitCallbacks().clear();
465
466 cout.flush();
467
468 ParamContext::cleanupAllContexts();
469
470 // print simulation stats
471 Stats::DumpNow();
472}