2 * Copyright (c) 2000-2005 The Regents of The University of Michigan
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.
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.
28 * Authors: Steve Raasch
36 #include <Python.h> // must be before system headers... see Python docs
38 #include <sys/types.h>
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"
61 #include "mem/mem_object.hh"
62 #include "mem/port.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"
78 volatile bool async_event
= false;
79 volatile bool async_dump
= false;
80 volatile bool async_dumpreset
= false;
81 volatile bool async_exit
= false;
82 volatile bool async_io
= false;
83 volatile bool async_alarm
= false;
85 /// Stats signal handler.
87 dumpStatsHandler(int sigtype
)
94 dumprstStatsHandler(int sigtype
)
97 async_dumpreset
= true;
100 /// Exit signal handler.
102 exitNowHandler(int sigtype
)
108 /// Abort signal handler.
110 abortHandler(int sigtype
)
112 cerr
<< "Program aborted at cycle " << curTick
<< endl
;
115 // dump trace buffer, if there is one
116 Trace::theLog
.dump(cerr
);
120 extern "C" { void init_cc_main(); }
123 main(int argc
, char **argv
)
125 signal(SIGFPE
, SIG_IGN
); // may occur on misspeculated paths
126 signal(SIGTRAP
, SIG_IGN
);
127 signal(SIGUSR1
, dumpStatsHandler
); // dump intermediate stats
128 signal(SIGUSR2
, dumprstStatsHandler
); // dump and reset stats
129 signal(SIGINT
, exitNowHandler
); // dump final stats and exit
130 signal(SIGABRT
, abortHandler
);
132 Py_SetProgramName(argv
[0]);
134 // default path to m5 python code is the currently executing
135 // file... Python ZipImporter will find embedded zip archive.
136 // The M5_ARCHIVE environment variable can be used to override this.
137 char *m5_archive
= getenv("M5_ARCHIVE");
138 string pythonpath
= m5_archive
? m5_archive
: argv
[0];
140 char *oldpath
= getenv("PYTHONPATH");
141 if (oldpath
!= NULL
) {
143 pythonpath
+= oldpath
;
146 if (setenv("PYTHONPATH", pythonpath
.c_str(), true) == -1)
147 fatal("setenv: %s\n", strerror(errno
));
149 char *python_home
= getenv("PYTHONHOME");
151 python_home
= PYTHONHOME
;
152 Py_SetPythonHome(python_home
);
154 // initialize embedded Python interpreter
156 PySys_SetArgv(argc
, argv
);
158 // initialize SWIG 'cc_main' module
161 PyRun_SimpleString("import m5.main");
162 PyRun_SimpleString("m5.main.main()");
164 // clean up Python intepreter.
170 setOutputDir(const string
&dir
)
172 simout
.setDirectory(dir
);
179 createSimObject(const string
&name
)
181 return SimObjectClass::createObject(inifile
, name
);
186 * Pointer to the Python function that maps names to SimObjects.
188 PyObject
*resolveFunc
= NULL
;
191 * Convert a pointer to the Python object that SWIG wraps around a C++
192 * SimObject pointer back to the actual C++ pointer. See main.i.
194 extern "C" SimObject
*convertSwigSimObjectPtr(PyObject
*);
198 resolveSimObject(const string
&name
)
200 PyObject
*pyPtr
= PyEval_CallFunction(resolveFunc
, "(s)", name
.c_str());
203 panic("resolveSimObject: failure on call to Python for %s", name
);
206 SimObject
*simObj
= convertSwigSimObjectPtr(pyPtr
);
208 panic("resolveSimObject: failure on pointer conversion for %s", name
);
215 * Load config.ini into C++ database. Exported to Python via SWIG;
216 * invoked from m5.instantiate().
219 loadIniFile(PyObject
*_resolveFunc
)
221 resolveFunc
= _resolveFunc
;
222 configStream
= simout
.find("config.out");
224 // The configuration database is now complete; start processing it.
225 inifile
.load(simout
.resolve("config.ini"));
227 // Initialize statistics database
228 Stats::InitSimStats();
233 * Look up a MemObject port. Helper function for connectPorts().
236 lookupPort(SimObject
*so
, const std::string
&name
, int i
)
238 MemObject
*mo
= dynamic_cast<MemObject
*>(so
);
240 warn("error casting SimObject %s to MemObject", so
->name());
244 Port
*p
= mo
->getPort(name
, i
);
246 warn("error looking up port %s on object %s", name
, so
->name());
252 * Connect the described MemObject ports. Called from Python via SWIG.
255 connectPorts(SimObject
*o1
, const std::string
&name1
, int i1
,
256 SimObject
*o2
, const std::string
&name2
, int i2
)
258 Port
*p1
= lookupPort(o1
, name1
, i1
);
259 Port
*p2
= lookupPort(o2
, name2
, i2
);
261 if (p1
== NULL
|| p2
== NULL
) {
262 warn("connectPorts: port lookup error");
273 * Do final initialization steps after object construction but before
274 * start of simulation.
279 // Parse and check all non-config-hierarchy parameters.
280 ParamContext::parseAllContexts(inifile
);
281 ParamContext::checkAllContexts();
283 // Echo all parameter settings to stats file as well.
284 ParamContext::showAllContexts(*configStream
);
286 // Do a second pass to finish initializing the sim objects
287 SimObject::initAll();
289 // Restore checkpointed state, if any.
291 configHierarchy
.unserializeSimObjects();
294 SimObject::regAllStats();
296 // Check to make sure that the stats package is properly initialized
299 // Reset to put the stats in a consistent state.
306 /** Simulate for num_cycles additional cycles. If num_cycles is -1
307 * (the default), do not limit simulation; some other event must
308 * terminate the loop. Exported to Python via SWIG.
309 * @return The SimLoopExitEvent that caused the loop to exit.
312 simulate(Tick num_cycles
= MaxTick
)
314 warn("Entering event queue @ %d. Starting simulation...\n", curTick
);
317 fatal("simulate: num_cycles must be >= 0 (was %d)\n", num_cycles
);
318 else if (curTick
+ num_cycles
< 0) //Overflow
319 num_cycles
= MaxTick
;
321 num_cycles
= curTick
+ num_cycles
;
323 Event
*limit_event
= schedExitSimLoop("simulate() limit reached",
327 // there should always be at least one event (the SimLoopExitEvent
328 // we just scheduled) in the queue
329 assert(!mainEventQueue
.empty());
330 assert(curTick
<= mainEventQueue
.nextTick() &&
331 "event scheduled in the past");
333 // forward current cycle to the time of the first event on the
335 curTick
= mainEventQueue
.nextTick();
336 Event
*exit_event
= mainEventQueue
.serviceOne();
337 if (exit_event
!= NULL
) {
338 // hit some kind of exit event; return to Python
339 // event must be subclass of SimLoopExitEvent...
340 SimLoopExitEvent
*se_event
= dynamic_cast<SimLoopExitEvent
*>(exit_event
);
341 if (se_event
== NULL
)
342 panic("Bogus exit event class!");
344 // if we didn't hit limit_event, delete it
345 if (se_event
!= limit_event
) {
346 assert(limit_event
->scheduled());
347 limit_event
->deschedule();
359 using namespace Stats
;
360 SetupEvent(Dump
, curTick
);
363 if (async_dumpreset
) {
364 async_dumpreset
= false;
366 using namespace Stats
;
367 SetupEvent(Dump
| Reset
, curTick
);
372 exitSimLoop("user interrupt received");
375 if (async_io
|| async_alarm
) {
383 // not reached... only exit is return on SimLoopExitEvent
389 return new CountedDrainEvent();
393 cleanupCountedDrain(Event
*counted_drain
)
395 CountedDrainEvent
*event
=
396 dynamic_cast<CountedDrainEvent
*>(counted_drain
);
398 fatal("Called cleanupCountedDrain() on an event that was not "
399 "a CountedDrainEvent.");
401 assert(event
->getCount() == 0);
406 serializeAll(const std::string
&cpt_dir
)
408 Serializable::serializeAll(cpt_dir
);
412 unserializeAll(const std::string
&cpt_dir
)
414 Serializable::unserializeAll(cpt_dir
);
418 * Queue of C++ callbacks to invoke on simulator exit.
423 static CallbackQueue theQueue
;
428 * Register an exit callback.
431 registerExitCallback(Callback
*callback
)
433 exitCallbacks().add(callback
);
437 convertToBaseCPUPtr(SimObject
*obj
)
439 BaseCPU
*ptr
= dynamic_cast<BaseCPU
*>(obj
);
442 warn("Casting to BaseCPU pointer failed");
447 convertToSystemPtr(SimObject
*obj
)
449 System
*ptr
= dynamic_cast<System
*>(obj
);
452 warn("Casting to System pointer failed");
458 * Do C++ simulator exit processing. Exported to SWIG to be invoked
459 * when simulator terminates via Python's atexit mechanism.
464 exitCallbacks().process();
465 exitCallbacks().clear();
469 ParamContext::cleanupAllContexts();
471 // print simulation stats