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