init.cc revision 11988
15522Snate@binkert.org/* 211988Sandreas.sandberg@arm.com * Copyright (c) 2012, 2017 ARM Limited 39397Sandreas.hansson@arm.com * All rights reserved 49397Sandreas.hansson@arm.com * 59397Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 69397Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 79397Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 89397Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 99397Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 109397Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 119397Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 129397Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 139397Sandreas.hansson@arm.com * 145522Snate@binkert.org * Copyright (c) 2000-2005 The Regents of The University of Michigan 155522Snate@binkert.org * Copyright (c) 2008 The Hewlett-Packard Development Company 165522Snate@binkert.org * All rights reserved. 175522Snate@binkert.org * 185522Snate@binkert.org * Redistribution and use in source and binary forms, with or without 195522Snate@binkert.org * modification, are permitted provided that the following conditions are 205522Snate@binkert.org * met: redistributions of source code must retain the above copyright 215522Snate@binkert.org * notice, this list of conditions and the following disclaimer; 225522Snate@binkert.org * redistributions in binary form must reproduce the above copyright 235522Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 245522Snate@binkert.org * documentation and/or other materials provided with the distribution; 255522Snate@binkert.org * neither the name of the copyright holders nor the names of its 265522Snate@binkert.org * contributors may be used to endorse or promote products derived from 275522Snate@binkert.org * this software without specific prior written permission. 285522Snate@binkert.org * 295522Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 305522Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 315522Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 325522Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 335522Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 345522Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 355522Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 365522Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 375522Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 385522Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 395522Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 405522Snate@binkert.org * 415522Snate@binkert.org * Authors: Nathan Binkert 425522Snate@binkert.org */ 435522Snate@binkert.org 4411808Sandreas.sandberg@arm.com#include <Python.h> 4511808Sandreas.sandberg@arm.com 4611793Sbrandon.potter@amd.com#include "sim/init.hh" 4711793Sbrandon.potter@amd.com 485522Snate@binkert.org#include <marshal.h> 498229Snate@binkert.org#include <zlib.h> 505522Snate@binkert.org 518229Snate@binkert.org#include <iostream> 527674Snate@binkert.org#include <list> 535522Snate@binkert.org#include <string> 545522Snate@binkert.org 555522Snate@binkert.org#include "base/cprintf.hh" 565522Snate@binkert.org#include "base/misc.hh" 576216Snate@binkert.org#include "base/types.hh" 589397Sandreas.hansson@arm.com#include "config/have_protobuf.hh" 5911988Sandreas.sandberg@arm.com#include "python/pybind11/pybind.hh" 605522Snate@binkert.org#include "sim/async.hh" 615522Snate@binkert.org#include "sim/core.hh" 625522Snate@binkert.org 639397Sandreas.hansson@arm.com#if HAVE_PROTOBUF 649397Sandreas.hansson@arm.com#include <google/protobuf/stubs/common.h> 6511793Sbrandon.potter@amd.com 669397Sandreas.hansson@arm.com#endif 679397Sandreas.hansson@arm.com 685522Snate@binkert.orgusing namespace std; 6911988Sandreas.sandberg@arm.comnamespace py = pybind11; 705522Snate@binkert.org 715522Snate@binkert.org// The python library is totally messed up with respect to constness, 725522Snate@binkert.org// so make a simple macro to make life a little easier 735522Snate@binkert.org#define PyCC(x) (const_cast<char *>(x)) 745522Snate@binkert.org 757674Snate@binkert.orgEmbeddedPython *EmbeddedPython::importer = NULL; 767674Snate@binkert.orgPyObject *EmbeddedPython::importerModule = NULL; 777674Snate@binkert.orgEmbeddedPython::EmbeddedPython(const char *filename, const char *abspath, 788946Sandreas.hansson@arm.com const char *modpath, const unsigned char *code, int zlen, int len) 797674Snate@binkert.org : filename(filename), abspath(abspath), modpath(modpath), code(code), 807674Snate@binkert.org zlen(zlen), len(len) 817674Snate@binkert.org{ 827674Snate@binkert.org // if we've added the importer keep track of it because we need it 837674Snate@binkert.org // to bootstrap. 847674Snate@binkert.org if (string(modpath) == string("importer")) 857674Snate@binkert.org importer = this; 867674Snate@binkert.org else 877674Snate@binkert.org getList().push_back(this); 887674Snate@binkert.org} 897674Snate@binkert.org 907674Snate@binkert.orglist<EmbeddedPython *> & 917674Snate@binkert.orgEmbeddedPython::getList() 927674Snate@binkert.org{ 937674Snate@binkert.org static list<EmbeddedPython *> the_list; 947674Snate@binkert.org return the_list; 957674Snate@binkert.org} 967674Snate@binkert.org 977674Snate@binkert.org/* 987674Snate@binkert.org * Uncompress and unmarshal the code object stored in the 997674Snate@binkert.org * EmbeddedPython 1007674Snate@binkert.org */ 1017674Snate@binkert.orgPyObject * 1027674Snate@binkert.orgEmbeddedPython::getCode() const 1037674Snate@binkert.org{ 1047674Snate@binkert.org Bytef marshalled[len]; 1057674Snate@binkert.org uLongf unzlen = len; 1067674Snate@binkert.org int ret = uncompress(marshalled, &unzlen, (const Bytef *)code, zlen); 1077674Snate@binkert.org if (ret != Z_OK) 1087674Snate@binkert.org panic("Could not uncompress code: %s\n", zError(ret)); 1097674Snate@binkert.org assert(unzlen == (uLongf)len); 1107674Snate@binkert.org 1117674Snate@binkert.org return PyMarshal_ReadObjectFromString((char *)marshalled, len); 1127674Snate@binkert.org} 1137674Snate@binkert.org 1147674Snate@binkert.orgbool 1157674Snate@binkert.orgEmbeddedPython::addModule() const 1167674Snate@binkert.org{ 1177674Snate@binkert.org PyObject *code = getCode(); 1187674Snate@binkert.org PyObject *result = PyObject_CallMethod(importerModule, PyCC("add_module"), 1197674Snate@binkert.org PyCC("sssO"), filename, abspath, modpath, code); 1207674Snate@binkert.org if (!result) { 1217674Snate@binkert.org PyErr_Print(); 1227674Snate@binkert.org return false; 1237674Snate@binkert.org } 1247674Snate@binkert.org 1257674Snate@binkert.org Py_DECREF(result); 1267674Snate@binkert.org return true; 1277674Snate@binkert.org} 1287674Snate@binkert.org 1295522Snate@binkert.org/* 1305522Snate@binkert.org * Load and initialize all of the python parts of M5, including Swig 1315522Snate@binkert.org * and the embedded module importer. 1325522Snate@binkert.org */ 1335522Snate@binkert.orgint 1347674Snate@binkert.orgEmbeddedPython::initAll() 1355522Snate@binkert.org{ 1365522Snate@binkert.org // Load the importer module 1377674Snate@binkert.org PyObject *code = importer->getCode(); 1387674Snate@binkert.org importerModule = PyImport_ExecCodeModule(PyCC("importer"), code); 1397674Snate@binkert.org if (!importerModule) { 1405522Snate@binkert.org PyErr_Print(); 1415522Snate@binkert.org return 1; 1425522Snate@binkert.org } 1435522Snate@binkert.org 1445522Snate@binkert.org // Load the rest of the embedded python files into the embedded 1455522Snate@binkert.org // python importer 1467674Snate@binkert.org list<EmbeddedPython *>::iterator i = getList().begin(); 1477674Snate@binkert.org list<EmbeddedPython *>::iterator end = getList().end(); 1487674Snate@binkert.org for (; i != end; ++i) 1497674Snate@binkert.org if (!(*i)->addModule()) 1505522Snate@binkert.org return 1; 1515522Snate@binkert.org 1525522Snate@binkert.org return 0; 1535522Snate@binkert.org} 1545522Snate@binkert.org 15511548Sandreas.hansson@arm.comEmbeddedSwig::EmbeddedSwig(void (*init_func)(), const string& _context) 15611548Sandreas.hansson@arm.com : initFunc(init_func), context(_context) 1577674Snate@binkert.org{ 1587674Snate@binkert.org getList().push_back(this); 1597674Snate@binkert.org} 1607674Snate@binkert.org 1617674Snate@binkert.orglist<EmbeddedSwig *> & 1627674Snate@binkert.orgEmbeddedSwig::getList() 1637674Snate@binkert.org{ 1647674Snate@binkert.org static list<EmbeddedSwig *> the_list; 1657674Snate@binkert.org return the_list; 1667674Snate@binkert.org} 1677674Snate@binkert.org 1687674Snate@binkert.orgvoid 1697674Snate@binkert.orgEmbeddedSwig::initAll() 1707674Snate@binkert.org{ 17111548Sandreas.hansson@arm.com char* old_context = _Py_PackageContext; 17211548Sandreas.hansson@arm.com // initialize SWIG modules. initFunc() is autogenerated and calls 1737674Snate@binkert.org // all of the individual swig initialization functions. 17411548Sandreas.hansson@arm.com for (auto i : getList()) { 17511548Sandreas.hansson@arm.com // to ensure that the loaded modules are placed in the right 17611548Sandreas.hansson@arm.com // package we have to be a bit unorthodox and directly 17711548Sandreas.hansson@arm.com // manipulate the package context since swig simply calls 17811548Sandreas.hansson@arm.com // Py_InitModule with nothing but the module name of the 17911548Sandreas.hansson@arm.com // wrapper 18011548Sandreas.hansson@arm.com char* cstr = new char[i->context.size() + 1]; 18111548Sandreas.hansson@arm.com strcpy(cstr, i->context.c_str()); 18211548Sandreas.hansson@arm.com _Py_PackageContext = cstr; 18311548Sandreas.hansson@arm.com i->initFunc(); 18411548Sandreas.hansson@arm.com delete[] cstr; 18511548Sandreas.hansson@arm.com } 18611548Sandreas.hansson@arm.com _Py_PackageContext = old_context; 1877674Snate@binkert.org} 1887674Snate@binkert.org 18911988Sandreas.sandberg@arm.comEmbeddedPyBind::EmbeddedPyBind(const char *_name, 19011988Sandreas.sandberg@arm.com void (*init_func)(py::module &), 19111988Sandreas.sandberg@arm.com const char *_base) 19211988Sandreas.sandberg@arm.com : initFunc(init_func), registered(false), name(_name), base(_base) 19311988Sandreas.sandberg@arm.com{ 19411988Sandreas.sandberg@arm.com getMap()[_name] = this; 19511988Sandreas.sandberg@arm.com} 19611988Sandreas.sandberg@arm.com 19711988Sandreas.sandberg@arm.comEmbeddedPyBind::EmbeddedPyBind(const char *_name, 19811988Sandreas.sandberg@arm.com void (*init_func)(py::module &)) 19911988Sandreas.sandberg@arm.com : initFunc(init_func), registered(false), name(_name), base("") 20011988Sandreas.sandberg@arm.com{ 20111988Sandreas.sandberg@arm.com getMap()[_name] = this; 20211988Sandreas.sandberg@arm.com} 20311988Sandreas.sandberg@arm.com 20411988Sandreas.sandberg@arm.comvoid 20511988Sandreas.sandberg@arm.comEmbeddedPyBind::init(py::module &m) 20611988Sandreas.sandberg@arm.com{ 20711988Sandreas.sandberg@arm.com if (!registered) { 20811988Sandreas.sandberg@arm.com initFunc(m); 20911988Sandreas.sandberg@arm.com registered = true; 21011988Sandreas.sandberg@arm.com } else { 21111988Sandreas.sandberg@arm.com cprintf("Warning: %s already registered.\n", name); 21211988Sandreas.sandberg@arm.com } 21311988Sandreas.sandberg@arm.com} 21411988Sandreas.sandberg@arm.com 21511988Sandreas.sandberg@arm.combool 21611988Sandreas.sandberg@arm.comEmbeddedPyBind::depsReady() const 21711988Sandreas.sandberg@arm.com{ 21811988Sandreas.sandberg@arm.com return base.empty() || getMap()[base]->registered; 21911988Sandreas.sandberg@arm.com} 22011988Sandreas.sandberg@arm.com 22111988Sandreas.sandberg@arm.comstd::map<std::string, EmbeddedPyBind *> & 22211988Sandreas.sandberg@arm.comEmbeddedPyBind::getMap() 22311988Sandreas.sandberg@arm.com{ 22411988Sandreas.sandberg@arm.com static std::map<std::string, EmbeddedPyBind *> objs; 22511988Sandreas.sandberg@arm.com return objs; 22611988Sandreas.sandberg@arm.com} 22711988Sandreas.sandberg@arm.com 22811988Sandreas.sandberg@arm.comvoid 22911988Sandreas.sandberg@arm.comEmbeddedPyBind::initAll() 23011988Sandreas.sandberg@arm.com{ 23111988Sandreas.sandberg@arm.com std::list<EmbeddedPyBind *> pending; 23211988Sandreas.sandberg@arm.com 23311988Sandreas.sandberg@arm.com py::module m_m5 = py::module("_m5"); 23411988Sandreas.sandberg@arm.com m_m5.attr("__package__") = py::cast("_m5"); 23511988Sandreas.sandberg@arm.com 23611988Sandreas.sandberg@arm.com pybind_init_core(m_m5); 23711988Sandreas.sandberg@arm.com pybind_init_debug(m_m5); 23811988Sandreas.sandberg@arm.com 23911988Sandreas.sandberg@arm.com pybind_init_event(m_m5); 24011988Sandreas.sandberg@arm.com pybind_init_pyobject(m_m5); 24111988Sandreas.sandberg@arm.com pybind_init_stats(m_m5); 24211988Sandreas.sandberg@arm.com 24311988Sandreas.sandberg@arm.com for (auto &kv : getMap()) { 24411988Sandreas.sandberg@arm.com auto &obj = kv.second; 24511988Sandreas.sandberg@arm.com if (obj->base.empty()) { 24611988Sandreas.sandberg@arm.com obj->init(m_m5); 24711988Sandreas.sandberg@arm.com } else { 24811988Sandreas.sandberg@arm.com pending.push_back(obj); 24911988Sandreas.sandberg@arm.com } 25011988Sandreas.sandberg@arm.com } 25111988Sandreas.sandberg@arm.com 25211988Sandreas.sandberg@arm.com while (!pending.empty()) { 25311988Sandreas.sandberg@arm.com for (auto it = pending.begin(); it != pending.end(); ) { 25411988Sandreas.sandberg@arm.com EmbeddedPyBind &obj = **it; 25511988Sandreas.sandberg@arm.com if (obj.depsReady()) { 25611988Sandreas.sandberg@arm.com obj.init(m_m5); 25711988Sandreas.sandberg@arm.com it = pending.erase(it); 25811988Sandreas.sandberg@arm.com } else { 25911988Sandreas.sandberg@arm.com ++it; 26011988Sandreas.sandberg@arm.com } 26111988Sandreas.sandberg@arm.com } 26211988Sandreas.sandberg@arm.com } 26311988Sandreas.sandberg@arm.com} 26411988Sandreas.sandberg@arm.com 2657674Snate@binkert.orgint 2667674Snate@binkert.orginitM5Python() 2677674Snate@binkert.org{ 2687674Snate@binkert.org EmbeddedSwig::initAll(); 26911988Sandreas.sandberg@arm.com EmbeddedPyBind::initAll(); 2707674Snate@binkert.org return EmbeddedPython::initAll(); 2717674Snate@binkert.org} 2727674Snate@binkert.org 2735522Snate@binkert.org/* 2748234Snate@binkert.org * Make the commands array weak so that they can be overridden (used 2758234Snate@binkert.org * by unit tests to specify a different python main function. 2768234Snate@binkert.org */ 2778234Snate@binkert.orgconst char * __attribute__((weak)) m5MainCommands[] = { 2788234Snate@binkert.org "import m5", 2798234Snate@binkert.org "m5.main()", 2808234Snate@binkert.org 0 // sentinel is required 2818234Snate@binkert.org}; 2828234Snate@binkert.org 2838234Snate@binkert.org/* 2845522Snate@binkert.org * Start up the M5 simulator. This mostly vectors into the python 2855522Snate@binkert.org * main function. 2865522Snate@binkert.org */ 2875522Snate@binkert.orgint 2885522Snate@binkert.orgm5Main(int argc, char **argv) 2895522Snate@binkert.org{ 2909397Sandreas.hansson@arm.com#if HAVE_PROTOBUF 2919397Sandreas.hansson@arm.com // Verify that the version of the protobuf library that we linked 2929397Sandreas.hansson@arm.com // against is compatible with the version of the headers we 2939397Sandreas.hansson@arm.com // compiled against. 2949397Sandreas.hansson@arm.com GOOGLE_PROTOBUF_VERIFY_VERSION; 2959397Sandreas.hansson@arm.com#endif 2969397Sandreas.hansson@arm.com 2975522Snate@binkert.org PySys_SetArgv(argc, argv); 2985522Snate@binkert.org 2995522Snate@binkert.org // We have to set things up in the special __main__ module 3005522Snate@binkert.org PyObject *module = PyImport_AddModule(PyCC("__main__")); 3015522Snate@binkert.org if (module == NULL) 3025522Snate@binkert.org panic("Could not import __main__"); 3035522Snate@binkert.org PyObject *dict = PyModule_GetDict(module); 3045522Snate@binkert.org 3055522Snate@binkert.org // import the main m5 module 3065522Snate@binkert.org PyObject *result; 3078234Snate@binkert.org const char **command = m5MainCommands; 3088234Snate@binkert.org 3098234Snate@binkert.org // evaluate each command in the m5MainCommands array (basically a 3108234Snate@binkert.org // bunch of python statements. 3118234Snate@binkert.org while (*command) { 3128234Snate@binkert.org result = PyRun_String(*command, Py_file_input, dict, dict); 3138234Snate@binkert.org if (!result) { 3148234Snate@binkert.org PyErr_Print(); 3158234Snate@binkert.org return 1; 3168234Snate@binkert.org } 3178234Snate@binkert.org Py_DECREF(result); 3188234Snate@binkert.org 3198234Snate@binkert.org command++; 3205522Snate@binkert.org } 3215522Snate@binkert.org 3229397Sandreas.hansson@arm.com#if HAVE_PROTOBUF 3239397Sandreas.hansson@arm.com google::protobuf::ShutdownProtobufLibrary(); 3249397Sandreas.hansson@arm.com#endif 3259397Sandreas.hansson@arm.com 3265522Snate@binkert.org return 0; 3275522Snate@binkert.org} 3285601Snate@binkert.org 3295601Snate@binkert.orgPyMODINIT_FUNC 3305601Snate@binkert.orginitm5(void) 3315601Snate@binkert.org{ 3325601Snate@binkert.org initM5Python(); 3335601Snate@binkert.org PyImport_ImportModule(PyCC("m5")); 3345601Snate@binkert.org} 335