gem5/src/sim/init.cc

275 lines
7 KiB
C++
Raw Normal View History

/*
* Copyright (c) 2000-2005 The Regents of The University of Michigan
* Copyright (c) 2008 The Hewlett-Packard Development Company
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met: redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer;
* redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution;
* neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authors: Nathan Binkert
*/
#include <Python.h>
2011-04-15 19:44:06 +02:00
#include <marshal.h>
2011-04-15 19:44:06 +02:00
#include <zlib.h>
2011-04-15 19:44:06 +02:00
#include <csignal>
#include <iostream>
2011-04-15 19:44:06 +02:00
#include <list>
#include <string>
#include "base/cprintf.hh"
#include "base/misc.hh"
2009-05-17 23:34:52 +02:00
#include "base/types.hh"
#include "sim/async.hh"
#include "sim/core.hh"
#include "sim/init.hh"
using namespace std;
/// Stats signal handler.
void
dumpStatsHandler(int sigtype)
{
async_event = true;
async_statdump = true;
}
void
dumprstStatsHandler(int sigtype)
{
async_event = true;
async_statdump = true;
async_statreset = true;
}
/// Exit signal handler.
void
exitNowHandler(int sigtype)
{
async_event = true;
async_exit = true;
}
/// Abort signal handler.
void
abortHandler(int sigtype)
{
ccprintf(cerr, "Program aborted at cycle %d\n", curTick());
}
/*
* M5 can do several special things when various signals are sent.
* None are mandatory.
*/
void
initSignals()
{
// Floating point exceptions may happen on misspeculated paths, so
// ignore them
signal(SIGFPE, SIG_IGN);
// We use SIGTRAP sometimes for debugging
signal(SIGTRAP, SIG_IGN);
// Dump intermediate stats
signal(SIGUSR1, dumpStatsHandler);
// Dump intermediate stats and reset them
signal(SIGUSR2, dumprstStatsHandler);
// Exit cleanly on Interrupt (Ctrl-C)
signal(SIGINT, exitNowHandler);
// Print out cycle number on abort
signal(SIGABRT, abortHandler);
}
// The python library is totally messed up with respect to constness,
// so make a simple macro to make life a little easier
#define PyCC(x) (const_cast<char *>(x))
EmbeddedPython *EmbeddedPython::importer = NULL;
PyObject *EmbeddedPython::importerModule = NULL;
EmbeddedPython::EmbeddedPython(const char *filename, const char *abspath,
const char *modpath, const char *code, int zlen, int len)
: filename(filename), abspath(abspath), modpath(modpath), code(code),
zlen(zlen), len(len)
{
// if we've added the importer keep track of it because we need it
// to bootstrap.
if (string(modpath) == string("importer"))
importer = this;
else
getList().push_back(this);
}
list<EmbeddedPython *> &
EmbeddedPython::getList()
{
static list<EmbeddedPython *> the_list;
return the_list;
}
/*
* Uncompress and unmarshal the code object stored in the
* EmbeddedPython
*/
PyObject *
EmbeddedPython::getCode() const
{
Bytef marshalled[len];
uLongf unzlen = len;
int ret = uncompress(marshalled, &unzlen, (const Bytef *)code, zlen);
if (ret != Z_OK)
panic("Could not uncompress code: %s\n", zError(ret));
assert(unzlen == (uLongf)len);
return PyMarshal_ReadObjectFromString((char *)marshalled, len);
}
bool
EmbeddedPython::addModule() const
{
PyObject *code = getCode();
PyObject *result = PyObject_CallMethod(importerModule, PyCC("add_module"),
PyCC("sssO"), filename, abspath, modpath, code);
if (!result) {
PyErr_Print();
return false;
}
Py_DECREF(result);
return true;
}
/*
* Load and initialize all of the python parts of M5, including Swig
* and the embedded module importer.
*/
int
EmbeddedPython::initAll()
{
// Load the importer module
PyObject *code = importer->getCode();
importerModule = PyImport_ExecCodeModule(PyCC("importer"), code);
if (!importerModule) {
PyErr_Print();
return 1;
}
// Load the rest of the embedded python files into the embedded
// python importer
list<EmbeddedPython *>::iterator i = getList().begin();
list<EmbeddedPython *>::iterator end = getList().end();
for (; i != end; ++i)
if (!(*i)->addModule())
return 1;
return 0;
}
EmbeddedSwig::EmbeddedSwig(void (*init_func)())
: initFunc(init_func)
{
getList().push_back(this);
}
list<EmbeddedSwig *> &
EmbeddedSwig::getList()
{
static list<EmbeddedSwig *> the_list;
return the_list;
}
void
EmbeddedSwig::initAll()
{
// initialize SWIG modules. initSwig() is autogenerated and calls
// all of the individual swig initialization functions.
list<EmbeddedSwig *>::iterator i = getList().begin();
list<EmbeddedSwig *>::iterator end = getList().end();
for (; i != end; ++i)
(*i)->initFunc();
}
int
initM5Python()
{
EmbeddedSwig::initAll();
return EmbeddedPython::initAll();
}
/*
* Make the commands array weak so that they can be overridden (used
* by unit tests to specify a different python main function.
*/
const char * __attribute__((weak)) m5MainCommands[] = {
"import m5",
"m5.main()",
0 // sentinel is required
};
/*
* Start up the M5 simulator. This mostly vectors into the python
* main function.
*/
int
m5Main(int argc, char **argv)
{
PySys_SetArgv(argc, argv);
// We have to set things up in the special __main__ module
PyObject *module = PyImport_AddModule(PyCC("__main__"));
if (module == NULL)
panic("Could not import __main__");
PyObject *dict = PyModule_GetDict(module);
// import the main m5 module
PyObject *result;
const char **command = m5MainCommands;
// evaluate each command in the m5MainCommands array (basically a
// bunch of python statements.
while (*command) {
result = PyRun_String(*command, Py_file_input, dict, dict);
if (!result) {
PyErr_Print();
return 1;
}
Py_DECREF(result);
command++;
}
return 0;
}
PyMODINIT_FUNC
initm5(void)
{
initM5Python();
PyImport_ImportModule(PyCC("m5"));
}