event.cc revision 11988
111988Sandreas.sandberg@arm.com/* 211988Sandreas.sandberg@arm.com * Copyright (c) 2017 ARM Limited 311988Sandreas.sandberg@arm.com * All rights reserved 411988Sandreas.sandberg@arm.com * 511988Sandreas.sandberg@arm.com * The license below extends only to copyright in the software and shall 611988Sandreas.sandberg@arm.com * not be construed as granting a license to any other intellectual 711988Sandreas.sandberg@arm.com * property including but not limited to intellectual property relating 811988Sandreas.sandberg@arm.com * to a hardware implementation of the functionality of the software 911988Sandreas.sandberg@arm.com * licensed hereunder. You may use the software subject to the license 1011988Sandreas.sandberg@arm.com * terms below provided that you ensure that this notice is replicated 1111988Sandreas.sandberg@arm.com * unmodified and in its entirety in all distributions of the software, 1211988Sandreas.sandberg@arm.com * modified or unmodified, in source code or in binary form. 1311988Sandreas.sandberg@arm.com * 1411988Sandreas.sandberg@arm.com * Copyright (c) 2006 The Regents of The University of Michigan 1511988Sandreas.sandberg@arm.com * Copyright (c) 2013 Advanced Micro Devices, Inc. 1611988Sandreas.sandberg@arm.com * Copyright (c) 2013 Mark D. Hill and David A. Wood 1711988Sandreas.sandberg@arm.com * All rights reserved. 1811988Sandreas.sandberg@arm.com * 1911988Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without 2011988Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are 2111988Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright 2211988Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer; 2311988Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright 2411988Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the 2511988Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution; 2611988Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its 2711988Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from 2811988Sandreas.sandberg@arm.com * this software without specific prior written permission. 2911988Sandreas.sandberg@arm.com * 3011988Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 3111988Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3211988Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 3311988Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 3411988Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3511988Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3611988Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3711988Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3811988Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3911988Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 4011988Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 4111988Sandreas.sandberg@arm.com * 4211988Sandreas.sandberg@arm.com * Authors: Nathan Binkert 4311988Sandreas.sandberg@arm.com * Andreas Sandberg 4411988Sandreas.sandberg@arm.com */ 4511988Sandreas.sandberg@arm.com 4611988Sandreas.sandberg@arm.com#include "pybind11/pybind11.h" 4711988Sandreas.sandberg@arm.com#include "pybind11/stl.h" 4811988Sandreas.sandberg@arm.com 4911988Sandreas.sandberg@arm.com#include "sim/eventq.hh" 5011988Sandreas.sandberg@arm.com#include "sim/sim_events.hh" 5111988Sandreas.sandberg@arm.com#include "sim/sim_exit.hh" 5211988Sandreas.sandberg@arm.com#include "sim/simulate.hh" 5311988Sandreas.sandberg@arm.com 5411988Sandreas.sandberg@arm.comnamespace py = pybind11; 5511988Sandreas.sandberg@arm.com 5611988Sandreas.sandberg@arm.com/** 5711988Sandreas.sandberg@arm.com * PyBind wrapper for Events 5811988Sandreas.sandberg@arm.com * 5911988Sandreas.sandberg@arm.com * We need to wrap the Event class with some Python glue code to 6011988Sandreas.sandberg@arm.com * enable method overrides in Python and memory management. Unlike its 6111988Sandreas.sandberg@arm.com * C++ cousin, PyEvents need to override __call__ instead of 6211988Sandreas.sandberg@arm.com * Event::process(). 6311988Sandreas.sandberg@arm.com * 6411988Sandreas.sandberg@arm.com * Memory management is mostly done using reference counting in 6511988Sandreas.sandberg@arm.com * Python. However, PyBind can't keep track of the reference the event 6611988Sandreas.sandberg@arm.com * queue holds to a scheduled event. We therefore need to inhibit 6711988Sandreas.sandberg@arm.com * deletion and hand over ownership to the event queue in case a 6811988Sandreas.sandberg@arm.com * scheduled event loses all of its Python references. 6911988Sandreas.sandberg@arm.com */ 7011988Sandreas.sandberg@arm.comclass PyEvent : public Event 7111988Sandreas.sandberg@arm.com{ 7211988Sandreas.sandberg@arm.com public: 7311988Sandreas.sandberg@arm.com struct Deleter { 7411988Sandreas.sandberg@arm.com void operator()(PyEvent *ev) { 7511988Sandreas.sandberg@arm.com assert(!ev->isAutoDelete()); 7611988Sandreas.sandberg@arm.com if (ev->scheduled()) { 7711988Sandreas.sandberg@arm.com // The event is scheduled, give ownership to the event 7811988Sandreas.sandberg@arm.com // queue. 7911988Sandreas.sandberg@arm.com ev->setFlags(Event::AutoDelete); 8011988Sandreas.sandberg@arm.com } else { 8111988Sandreas.sandberg@arm.com // The event isn't scheduled, hence Python owns it and 8211988Sandreas.sandberg@arm.com // we need to free it here. 8311988Sandreas.sandberg@arm.com delete ev; 8411988Sandreas.sandberg@arm.com } 8511988Sandreas.sandberg@arm.com } 8611988Sandreas.sandberg@arm.com }; 8711988Sandreas.sandberg@arm.com 8811988Sandreas.sandberg@arm.com PyEvent(Event::Priority priority) 8911988Sandreas.sandberg@arm.com : Event(priority) 9011988Sandreas.sandberg@arm.com { } 9111988Sandreas.sandberg@arm.com 9211988Sandreas.sandberg@arm.com void process() override { 9311988Sandreas.sandberg@arm.com if (isAutoDelete()) { 9411988Sandreas.sandberg@arm.com // Ownership of the event was handed over to the event queue 9511988Sandreas.sandberg@arm.com // because the last revference in Python land was GCed. We 9611988Sandreas.sandberg@arm.com // need to claim the object again since we're creating a new 9711988Sandreas.sandberg@arm.com // Python reference. 9811988Sandreas.sandberg@arm.com clearFlags(AutoDelete); 9911988Sandreas.sandberg@arm.com } 10011988Sandreas.sandberg@arm.com 10111988Sandreas.sandberg@arm.com // Call the Python implementation as __call__. This provides a 10211988Sandreas.sandberg@arm.com // slightly more Python-friendly interface. 10311988Sandreas.sandberg@arm.com PYBIND11_OVERLOAD_PURE_NAME(void, PyEvent, "__call__", process); 10411988Sandreas.sandberg@arm.com } 10511988Sandreas.sandberg@arm.com}; 10611988Sandreas.sandberg@arm.com 10711988Sandreas.sandberg@arm.comvoid 10811988Sandreas.sandberg@arm.compybind_init_event(py::module &m_native) 10911988Sandreas.sandberg@arm.com{ 11011988Sandreas.sandberg@arm.com py::module m = m_native.def_submodule("event"); 11111988Sandreas.sandberg@arm.com 11211988Sandreas.sandberg@arm.com m.def("simulate", &simulate, 11311988Sandreas.sandberg@arm.com py::arg("ticks") = MaxTick); 11411988Sandreas.sandberg@arm.com m.def("exitSimLoop", &exitSimLoop); 11511988Sandreas.sandberg@arm.com m.def("getEventQueue", []() { return curEventQueue(); }, 11611988Sandreas.sandberg@arm.com py::return_value_policy::reference); 11711988Sandreas.sandberg@arm.com m.def("setEventQueue", [](EventQueue *q) { return curEventQueue(q); }); 11811988Sandreas.sandberg@arm.com m.def("getEventQueue", &getEventQueue, 11911988Sandreas.sandberg@arm.com py::return_value_policy::reference); 12011988Sandreas.sandberg@arm.com 12111988Sandreas.sandberg@arm.com py::class_<EventQueue>(m, "EventQueue") 12211988Sandreas.sandberg@arm.com .def("name", [](EventQueue *eq) { return eq->name(); }) 12311988Sandreas.sandberg@arm.com .def("dump", &EventQueue::dump) 12411988Sandreas.sandberg@arm.com .def("schedule", [](EventQueue *eq, PyEvent *e, Tick t) { 12511988Sandreas.sandberg@arm.com eq->schedule(e, t); 12611988Sandreas.sandberg@arm.com }, py::arg("event"), py::arg("when")) 12711988Sandreas.sandberg@arm.com .def("deschedule", [](EventQueue *eq, PyEvent *e) { 12811988Sandreas.sandberg@arm.com eq->deschedule(e); 12911988Sandreas.sandberg@arm.com }, py::arg("event")) 13011988Sandreas.sandberg@arm.com .def("reschedule", [](EventQueue *eq, PyEvent *e, Tick t, bool alw) { 13111988Sandreas.sandberg@arm.com eq->reschedule(e, t, alw); 13211988Sandreas.sandberg@arm.com }, py::arg("event"), py::arg("tick"), py::arg("always") = false) 13311988Sandreas.sandberg@arm.com ; 13411988Sandreas.sandberg@arm.com 13511988Sandreas.sandberg@arm.com // TODO: Ownership of global exit events has always been a bit 13611988Sandreas.sandberg@arm.com // questionable. We currently assume they are owned by the C++ 13711988Sandreas.sandberg@arm.com // word. This is what the old SWIG code did, but that will result 13811988Sandreas.sandberg@arm.com // in memory leaks. 13911988Sandreas.sandberg@arm.com py::class_<GlobalSimLoopExitEvent, 14011988Sandreas.sandberg@arm.com std::unique_ptr<GlobalSimLoopExitEvent, py::nodelete>>( 14111988Sandreas.sandberg@arm.com m, "GlobalSimLoopExitEvent") 14211988Sandreas.sandberg@arm.com .def("getCause", &GlobalSimLoopExitEvent::getCause) 14311988Sandreas.sandberg@arm.com .def("getCode", &GlobalSimLoopExitEvent::getCode) 14411988Sandreas.sandberg@arm.com ; 14511988Sandreas.sandberg@arm.com 14611988Sandreas.sandberg@arm.com // TODO: We currently export a wrapper class and not the Event 14711988Sandreas.sandberg@arm.com // base class. This wil be problematic if we ever return an event 14811988Sandreas.sandberg@arm.com // from C++. 14911988Sandreas.sandberg@arm.com py::class_<PyEvent, std::unique_ptr<PyEvent, PyEvent::Deleter>> 15011988Sandreas.sandberg@arm.com c_event(m, "Event"); 15111988Sandreas.sandberg@arm.com c_event 15211988Sandreas.sandberg@arm.com .def(py::init<Event::Priority>(), 15311988Sandreas.sandberg@arm.com py::arg("priority") = (int)Event::Default_Pri) 15411988Sandreas.sandberg@arm.com .def("name", &Event::name) 15511988Sandreas.sandberg@arm.com .def("dump", &Event::dump) 15611988Sandreas.sandberg@arm.com .def("scheduled", &Event::scheduled) 15711988Sandreas.sandberg@arm.com .def("squash", &Event::squash) 15811988Sandreas.sandberg@arm.com .def("squashed", &Event::squashed) 15911988Sandreas.sandberg@arm.com .def("isExitEvent", &Event::isExitEvent) 16011988Sandreas.sandberg@arm.com .def("isAutoDelete", &Event::isAutoDelete) 16111988Sandreas.sandberg@arm.com .def("when", &Event::when) 16211988Sandreas.sandberg@arm.com .def("priority", &Event::priority) 16311988Sandreas.sandberg@arm.com ; 16411988Sandreas.sandberg@arm.com 16511988Sandreas.sandberg@arm.com#define PRIO(n) c_event.attr(# n) = py::cast((int)Event::n) 16611988Sandreas.sandberg@arm.com PRIO(Minimum_Pri); 16711988Sandreas.sandberg@arm.com PRIO(Minimum_Pri); 16811988Sandreas.sandberg@arm.com PRIO(Debug_Enable_Pri); 16911988Sandreas.sandberg@arm.com PRIO(Debug_Break_Pri); 17011988Sandreas.sandberg@arm.com PRIO(CPU_Switch_Pri); 17111988Sandreas.sandberg@arm.com PRIO(Delayed_Writeback_Pri); 17211988Sandreas.sandberg@arm.com PRIO(Default_Pri); 17311988Sandreas.sandberg@arm.com PRIO(DVFS_Update_Pri); 17411988Sandreas.sandberg@arm.com PRIO(Serialize_Pri); 17511988Sandreas.sandberg@arm.com PRIO(CPU_Tick_Pri); 17611988Sandreas.sandberg@arm.com PRIO(Stat_Event_Pri); 17711988Sandreas.sandberg@arm.com PRIO(Progress_Event_Pri); 17811988Sandreas.sandberg@arm.com PRIO(Sim_Exit_Pri); 17911988Sandreas.sandberg@arm.com PRIO(Maximum_Pri); 18011988Sandreas.sandberg@arm.com} 181