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 "cpu/base.hh"
59#include "cpu/smt.hh"
60#include "mem/mem_object.hh"
61#include "mem/port.hh"
62#include "sim/async.hh"
63#include "sim/builder.hh"
64#include "sim/host.hh"
65#include "sim/sim_events.hh"
66#include "sim/sim_exit.hh"
67#include "sim/sim_object.hh"
68#include "sim/stat_control.hh"
69#include "sim/stats.hh"
70#include "sim/root.hh"
71
72using namespace std;
73
74// See async.h.
75volatile bool async_event = false;
76volatile bool async_dump = false;
77volatile bool async_dumpreset = false;
78volatile bool async_exit = false;
79volatile bool async_io = false;
80volatile bool async_alarm = false;
81
82/// Stats signal handler.
83void
84dumpStatsHandler(int sigtype)
85{
86 async_event = true;
87 async_dump = true;
88}
89
90void
91dumprstStatsHandler(int sigtype)
92{
93 async_event = true;
94 async_dumpreset = true;
95}
96
97/// Exit signal handler.
98void
99exitNowHandler(int sigtype)
100{
101 async_event = true;
102 async_exit = true;
103}
104
105/// Abort signal handler.
106void
107abortHandler(int sigtype)
108{
109 cerr << "Program aborted at cycle " << curTick << endl;
110
111#if TRACING_ON
112 // dump trace buffer, if there is one
113 Trace::theLog.dump(cerr);
114#endif
115}
116
117/// Simulator executable name
118char *myProgName = "";
119
120/// Show brief help message.
121void
122showBriefHelp(ostream &out)
123{
124 char *prog = basename(myProgName);
125
126 ccprintf(out, "Usage:\n");
127 ccprintf(out,
128"%s [-p <path>] [-i ] [-h] <config file>\n"
129"\n"
130" -p, --path <path> prepends <path> to PYTHONPATH instead of using\n"
131" built-in zip archive. Useful when developing/debugging\n"
132" changes to built-in Python libraries, as the new Python\n"
133" can be tested without building a new m5 binary.\n\n"
134" -i, --interactive forces entry into interactive mode after the supplied\n"
135" script is executed (just like the -i option to the\n"
136" Python interpreter).\n\n"
137" -h Prints this help\n\n"
138" <configfile> config file name which ends in .py. (Normally you can\n"
139" run <configfile> --help to get help on that config files\n"
140" parameters.\n\n",
141 prog);
142
143}
144
145const char *briefCopyright =
146"Copyright (c) 2001-2006\n"
147"The Regents of The University of Michigan\n"
148"All Rights Reserved\n";
149
150/// Print welcome message.
151void
152sayHello(ostream &out)
153{
154 extern const char *compileDate; // from date.cc
155
156 ccprintf(out, "M5 Simulator System\n");
157 // display copyright
158 ccprintf(out, "%s\n", briefCopyright);
159 ccprintf(out, "M5 compiled %d\n", compileDate);
160 ccprintf(out, "M5 started %s\n", Time::start);
161
162 char *host = getenv("HOSTNAME");
163 if (!host)
164 host = getenv("HOST");
165
166 if (host)
167 ccprintf(out, "M5 executing on %s\n", host);
168}
169
170
171extern "C" { void init_cc_main(); }
172
173int
174main(int argc, char **argv)
175{
176 // Saze off program name
177 myProgName = argv[0];
178
179 sayHello(cerr);
180
181 signal(SIGFPE, SIG_IGN); // may occur on misspeculated paths
182 signal(SIGTRAP, SIG_IGN);
183 signal(SIGUSR1, dumpStatsHandler); // dump intermediate stats
184 signal(SIGUSR2, dumprstStatsHandler); // dump and reset stats
185 signal(SIGINT, exitNowHandler); // dump final stats and exit
186 signal(SIGABRT, abortHandler);
187
188 Py_SetProgramName(argv[0]);
189
190 // default path to m5 python code is the currently executing
191 // file... Python ZipImporter will find embedded zip archive
192 char *pythonpath = argv[0];
193
194 bool interactive = false;
195 bool show_help = false;
196 bool getopt_done = false;
197 int opt_index = 0;
198
199 static struct option long_options[] = {
200 {"python", 1, 0, 'p'},
201 {"interactive", 0, 0, 'i'},
202 {"help", 0, 0, 'h'},
203 {0,0,0,0}
204 };
205
206 do {
207 switch (getopt_long(argc, argv, "+p:ih", long_options, &opt_index)) {
208 // -p <path> prepends <path> to PYTHONPATH instead of
209 // using built-in zip archive. Useful when
210 // developing/debugging changes to built-in Python
211 // libraries, as the new Python can be tested without
212 // building a new m5 binary.
213 case 'p':
214 pythonpath = optarg;
215 break;
216
217 // -i forces entry into interactive mode after the
218 // supplied script is executed (just like the -i option to
219 // the Python interpreter).
220 case 'i':
221 interactive = true;
222 break;
223
224 case 'h':
225 show_help = true;
226 break;
227 case -1:
228 getopt_done = true;
229 break;
230
231 default:
232 fatal("Unrecognized option %c\n", optopt);
233 }
234 } while (!getopt_done);
235
236 if (show_help) {
237 showBriefHelp(cerr);
238 exit(1);
239 }
240
241 // Fix up argc & argv to hide arguments we just processed.
242 // getopt() sets optind to the index of the first non-processed
243 // argv element.
244 argc -= optind;
245 argv += optind;
246
247 // Set up PYTHONPATH to make sure the m5 module is found
248 string newpath(pythonpath);
249
250 char *oldpath = getenv("PYTHONPATH");
251 if (oldpath != NULL) {
252 newpath += ":";
253 newpath += oldpath;
254 }
255
256 if (setenv("PYTHONPATH", newpath.c_str(), true) == -1)
257 fatal("setenv: %s\n", strerror(errno));
258
259 // initialize embedded Python interpreter
260 Py_Initialize();
261 PySys_SetArgv(argc, argv);
262
263 // initialize SWIG 'cc_main' module
264 init_cc_main();
265
266 if (argc > 0) {
267 // extra arg(s): first is script file, remaining ones are args
268 // to script file
269 char *filename = argv[0];
270 FILE *fp = fopen(filename, "r");
271 if (!fp) {
272 fatal("cannot open file '%s'\n", filename);
273 }
274
275 PyRun_AnyFile(fp, filename);
276 } else {
277 // no script file argument... force interactive prompt
278 interactive = true;
279 }
280
281 if (interactive) {
282 // The following code to import readline was copied from Python
283 // 2.4.3's Modules/main.c.
284 // Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006
285 // Python Software Foundation; All Rights Reserved
286 // We should only enable this if we're actually using an
287 // interactive prompt.
288 PyObject *v;
289 v = PyImport_ImportModule("readline");
290 if (v == NULL)
291 PyErr_Clear();
292 else
293 Py_DECREF(v);
294
295 PyRun_InteractiveLoop(stdin, "stdin");
296 }
297
298 // clean up Python intepreter.
299 Py_Finalize();
300}
301
302
303void
304setOutputDir(const string &dir)
305{
306 simout.setDirectory(dir);
307}
308
309
310IniFile inifile;
311
312SimObject *
313createSimObject(const string &name)
314{
315 return SimObjectClass::createObject(inifile, name);
316}
317
318
319/**
320 * Pointer to the Python function that maps names to SimObjects.
321 */
322PyObject *resolveFunc = NULL;
323
324/**
325 * Convert a pointer to the Python object that SWIG wraps around a C++
326 * SimObject pointer back to the actual C++ pointer. See main.i.
327 */
328extern "C" SimObject *convertSwigSimObjectPtr(PyObject *);
329
330
331SimObject *
332resolveSimObject(const string &name)
333{
334 PyObject *pyPtr = PyEval_CallFunction(resolveFunc, "(s)", name.c_str());
335 if (pyPtr == NULL) {
336 PyErr_Print();
337 panic("resolveSimObject: failure on call to Python for %s", name);
338 }
339
340 SimObject *simObj = convertSwigSimObjectPtr(pyPtr);
341 if (simObj == NULL)
342 panic("resolveSimObject: failure on pointer conversion for %s", name);
343
344 return simObj;
345}
346
347
348/**
349 * Load config.ini into C++ database. Exported to Python via SWIG;
350 * invoked from m5.instantiate().
351 */
352void
353loadIniFile(PyObject *_resolveFunc)
354{
355 resolveFunc = _resolveFunc;
356 configStream = simout.find("config.out");
357
358 // The configuration database is now complete; start processing it.
359 inifile.load("config.ini");
360
361 // Initialize statistics database
362 Stats::InitSimStats();
363}
364
365
366/**
367 * Look up a MemObject port. Helper function for connectPorts().
368 */
369Port *
370lookupPort(SimObject *so, const std::string &name, int i)
371{
372 MemObject *mo = dynamic_cast<MemObject *>(so);
373 if (mo == NULL) {
374 warn("error casting SimObject %s to MemObject", so->name());
375 return NULL;
376 }
377
378 Port *p = mo->getPort(name, i);
379 if (p == NULL)
380 warn("error looking up port %s on object %s", name, so->name());
381 return p;
382}
383
384
385/**
386 * Connect the described MemObject ports. Called from Python via SWIG.
387 */
388int
389connectPorts(SimObject *o1, const std::string &name1, int i1,
390 SimObject *o2, const std::string &name2, int i2)
391{
392 Port *p1 = lookupPort(o1, name1, i1);
393 Port *p2 = lookupPort(o2, name2, i2);
394
395 if (p1 == NULL || p2 == NULL) {
396 warn("connectPorts: port lookup error");
397 return 0;
398 }
399
400 p1->setPeer(p2);
401 p2->setPeer(p1);
402
403 return 1;
404}
405
406/**
407 * Do final initialization steps after object construction but before
408 * start of simulation.
409 */
410void
411finalInit()
412{
413 // Parse and check all non-config-hierarchy parameters.
414 ParamContext::parseAllContexts(inifile);
415 ParamContext::checkAllContexts();
416
417 // Echo all parameter settings to stats file as well.
418 ParamContext::showAllContexts(*configStream);
419
420 // Do a second pass to finish initializing the sim objects
421 SimObject::initAll();
422
423 // Restore checkpointed state, if any.
424#if 0
425 configHierarchy.unserializeSimObjects();
426#endif
427
428 SimObject::regAllStats();
429
430 // Check to make sure that the stats package is properly initialized
431 Stats::check();
432
433 // Reset to put the stats in a consistent state.
434 Stats::reset();
435
436 SimStartup();
437}
438
439
440/** Simulate for num_cycles additional cycles. If num_cycles is -1
441 * (the default), do not limit simulation; some other event must
442 * terminate the loop. Exported to Python via SWIG.
443 * @return The SimLoopExitEvent that caused the loop to exit.
444 */
445SimLoopExitEvent *
446simulate(Tick num_cycles = -1)
447{
448 warn("Entering event queue @ %d. Starting simulation...\n", curTick);
449
450 // Fix up num_cycles. Special default value -1 means simulate
451 // "forever"... schedule event at MaxTick just to be safe.
452 // Otherwise it's a delta for additional cycles to simulate past
453 // curTick, and thus must be non-negative.
454 if (num_cycles == -1)
455 num_cycles = MaxTick;
456 else if (num_cycles < 0)
457 fatal("simulate: num_cycles must be >= 0 (was %d)\n", num_cycles);
458 else
459 num_cycles = curTick + num_cycles;
460
461 Event *limit_event = new SimLoopExitEvent(num_cycles,
462 "simulate() limit reached");
463
464 while (1) {
465 // there should always be at least one event (the SimLoopExitEvent
466 // we just scheduled) in the queue
467 assert(!mainEventQueue.empty());
468 assert(curTick <= mainEventQueue.nextTick() &&
469 "event scheduled in the past");
470
471 // forward current cycle to the time of the first event on the
472 // queue
473 curTick = mainEventQueue.nextTick();
474 Event *exit_event = mainEventQueue.serviceOne();
475 if (exit_event != NULL) {
476 // hit some kind of exit event; return to Python
477 // event must be subclass of SimLoopExitEvent...
478 SimLoopExitEvent *se_event = dynamic_cast<SimLoopExitEvent *>(exit_event);
479 if (se_event == NULL)
480 panic("Bogus exit event class!");
481
482 // if we didn't hit limit_event, delete it
483 if (se_event != limit_event) {
484 assert(limit_event->scheduled());
485 limit_event->deschedule();
486 delete limit_event;
487 }
488
489 return se_event;
490 }
491
492 if (async_event) {
493 async_event = false;
494 if (async_dump) {
495 async_dump = false;
496
497 using namespace Stats;
498 SetupEvent(Dump, curTick);
499 }
500
501 if (async_dumpreset) {
502 async_dumpreset = false;
503
504 using namespace Stats;
505 SetupEvent(Dump | Reset, curTick);
506 }
507
508 if (async_exit) {
509 async_exit = false;
510 exitSimLoop("user interrupt received");
511 }
512
513 if (async_io || async_alarm) {
514 async_io = false;
515 async_alarm = false;
516 pollQueue.service();
517 }
518 }
519 }
520
521 // not reached... only exit is return on SimLoopExitEvent
522}
523
524/**
525 * Queue of C++ callbacks to invoke on simulator exit.
526 */
527CallbackQueue exitCallbacks;
528
529/**
530 * Register an exit callback.
531 */
532void
533registerExitCallback(Callback *callback)
534{
535 exitCallbacks.add(callback);
536}
537
538/**
539 * Do C++ simulator exit processing. Exported to SWIG to be invoked
540 * when simulator terminates via Python's atexit mechanism.
541 */
542void
543doExitCleanup()
544{
545 exitCallbacks.process();
546 exitCallbacks.clear();
547
548 cout.flush();
549
550 ParamContext::cleanupAllContexts();
551
552 // print simulation stats
553 Stats::DumpNow();
554}