sc_main.cc revision 13038
112837Sgabeblack@google.com/* 212837Sgabeblack@google.com * Copyright 2018 Google, Inc. 312837Sgabeblack@google.com * 412837Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512837Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612837Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712837Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812837Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912837Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012837Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112837Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212837Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312837Sgabeblack@google.com * this software without specific prior written permission. 1412837Sgabeblack@google.com * 1512837Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612837Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712837Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812837Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912837Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012837Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112837Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212837Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312837Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412837Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512837Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612837Sgabeblack@google.com * 2712837Sgabeblack@google.com * Authors: Gabe Black 2812837Sgabeblack@google.com */ 2912837Sgabeblack@google.com 3012837Sgabeblack@google.com#include <cstring> 3112837Sgabeblack@google.com 3212862Sgabeblack@google.com#include "base/fiber.hh" 3312837Sgabeblack@google.com#include "base/logging.hh" 3412862Sgabeblack@google.com#include "base/types.hh" 3512956Sgabeblack@google.com#include "sim/core.hh" 3612862Sgabeblack@google.com#include "sim/eventq.hh" 3712837Sgabeblack@google.com#include "sim/init.hh" 3812982Sgabeblack@google.com#include "systemc/core/kernel.hh" 3913038Sgabeblack@google.com#include "systemc/core/python.hh" 4012956Sgabeblack@google.com#include "systemc/core/scheduler.hh" 4112837Sgabeblack@google.com#include "systemc/ext/core/sc_main.hh" 4212861Sgabeblack@google.com#include "systemc/ext/utils/sc_report_handler.hh" 4312837Sgabeblack@google.com 4412949Sgabeblack@google.com// A weak symbol to detect if sc_main has been defined, and if so where it is. 4512949Sgabeblack@google.com[[gnu::weak]] int sc_main(int argc, char *argv[]); 4612837Sgabeblack@google.com 4712837Sgabeblack@google.comnamespace sc_core 4812837Sgabeblack@google.com{ 4912837Sgabeblack@google.com 5012837Sgabeblack@google.comnamespace 5112837Sgabeblack@google.com{ 5212837Sgabeblack@google.com 5312837Sgabeblack@google.combool scMainCalled = false; 5412837Sgabeblack@google.com 5512837Sgabeblack@google.comint _argc = 0; 5612837Sgabeblack@google.comchar **_argv = NULL; 5712837Sgabeblack@google.com 5812862Sgabeblack@google.comclass ScMainFiber : public Fiber 5912862Sgabeblack@google.com{ 6012862Sgabeblack@google.com void 6112862Sgabeblack@google.com main() 6212862Sgabeblack@google.com { 6312949Sgabeblack@google.com if (::sc_main) { 6412949Sgabeblack@google.com ::sc_main(_argc, _argv); 6512949Sgabeblack@google.com } else { 6612949Sgabeblack@google.com // If python tries to call sc_main but no sc_main was defined... 6712949Sgabeblack@google.com fatal("sc_main called but not defined.\n"); 6812949Sgabeblack@google.com } 6912862Sgabeblack@google.com } 7012862Sgabeblack@google.com}; 7112862Sgabeblack@google.com 7212862Sgabeblack@google.comScMainFiber scMainFiber; 7312862Sgabeblack@google.com 7412837Sgabeblack@google.com// This wrapper adapts the python version of sc_main to the c++ version. 7512837Sgabeblack@google.comvoid 7612837Sgabeblack@google.comsc_main(pybind11::args args) 7712837Sgabeblack@google.com{ 7812837Sgabeblack@google.com panic_if(scMainCalled, "sc_main called more than once."); 7912837Sgabeblack@google.com 8012837Sgabeblack@google.com _argc = args.size(); 8112837Sgabeblack@google.com _argv = new char *[_argc]; 8212837Sgabeblack@google.com 8312837Sgabeblack@google.com // Initialize all the _argvs to NULL so we can delete [] them 8412837Sgabeblack@google.com // unconditionally. 8512837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) 8612837Sgabeblack@google.com _argv[idx] = NULL; 8712837Sgabeblack@google.com 8812837Sgabeblack@google.com // Attempt to convert all the arguments to strings. If that fails, clean 8912837Sgabeblack@google.com // up after ourselves. Also don't count this as a call to sc_main since 9012837Sgabeblack@google.com // we never got to the c++ version of that function. 9112837Sgabeblack@google.com try { 9212837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) { 9312837Sgabeblack@google.com std::string arg = args[idx].cast<std::string>(); 9412837Sgabeblack@google.com _argv[idx] = new char[arg.length() + 1]; 9512837Sgabeblack@google.com strcpy(_argv[idx], arg.c_str()); 9612837Sgabeblack@google.com } 9712837Sgabeblack@google.com } catch (...) { 9812837Sgabeblack@google.com // If that didn't work for some reason (probably a conversion error) 9912837Sgabeblack@google.com // blow away _argv and _argc and pass on the exception. 10012837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) 10112837Sgabeblack@google.com delete [] _argv[idx]; 10212837Sgabeblack@google.com delete [] _argv; 10312837Sgabeblack@google.com _argc = 0; 10412837Sgabeblack@google.com throw; 10512837Sgabeblack@google.com } 10612837Sgabeblack@google.com 10712837Sgabeblack@google.com // At this point we're going to call the c++ sc_main, so we can't try 10812837Sgabeblack@google.com // again later. 10912837Sgabeblack@google.com scMainCalled = true; 11012837Sgabeblack@google.com 11112862Sgabeblack@google.com scMainFiber.run(); 11212837Sgabeblack@google.com} 11312837Sgabeblack@google.com 11412837Sgabeblack@google.com// Make our sc_main wrapper available in the internal _m5 python module under 11512837Sgabeblack@google.com// the systemc submodule. 11613038Sgabeblack@google.com 11713038Sgabeblack@google.comstruct InstallScMain : public ::sc_gem5::PythonInitFunc 11812837Sgabeblack@google.com{ 11913038Sgabeblack@google.com void 12013038Sgabeblack@google.com run(pybind11::module &systemc) override 12113038Sgabeblack@google.com { 12213038Sgabeblack@google.com systemc.def("sc_main", &sc_main); 12313038Sgabeblack@google.com } 12413038Sgabeblack@google.com} installScMain; 12512837Sgabeblack@google.com 12612861Sgabeblack@google.comsc_stop_mode _stop_mode = SC_STOP_FINISH_DELTA; 12712861Sgabeblack@google.com 12812837Sgabeblack@google.com} // anonymous namespace 12912837Sgabeblack@google.com 13012837Sgabeblack@google.comint 13112837Sgabeblack@google.comsc_argc() 13212837Sgabeblack@google.com{ 13312837Sgabeblack@google.com return _argc; 13412837Sgabeblack@google.com} 13512837Sgabeblack@google.com 13612837Sgabeblack@google.comconst char *const * 13712837Sgabeblack@google.comsc_argv() 13812837Sgabeblack@google.com{ 13912837Sgabeblack@google.com return _argv; 14012837Sgabeblack@google.com} 14112837Sgabeblack@google.com 14212860Sgabeblack@google.comvoid 14312860Sgabeblack@google.comsc_start() 14412860Sgabeblack@google.com{ 14512962Sgabeblack@google.com Tick now = ::sc_gem5::scheduler.getCurTick(); 14612961Sgabeblack@google.com sc_start(sc_time::from_value(MaxTick - now), SC_EXIT_ON_STARVATION); 14712860Sgabeblack@google.com} 14812860Sgabeblack@google.com 14912860Sgabeblack@google.comvoid 15012860Sgabeblack@google.comsc_pause() 15112860Sgabeblack@google.com{ 15212990Sgabeblack@google.com if (::sc_gem5::Kernel::status() == SC_RUNNING) 15312961Sgabeblack@google.com ::sc_gem5::scheduler.schedulePause(); 15412860Sgabeblack@google.com} 15512860Sgabeblack@google.com 15612860Sgabeblack@google.comvoid 15712860Sgabeblack@google.comsc_start(const sc_time &time, sc_starvation_policy p) 15812860Sgabeblack@google.com{ 15912962Sgabeblack@google.com Tick now = ::sc_gem5::scheduler.getCurTick(); 16012961Sgabeblack@google.com ::sc_gem5::scheduler.start(now + time.value(), p == SC_RUN_TO_TIME); 16112860Sgabeblack@google.com} 16212860Sgabeblack@google.com 16312860Sgabeblack@google.comvoid 16412860Sgabeblack@google.comsc_set_stop_mode(sc_stop_mode mode) 16512860Sgabeblack@google.com{ 16612861Sgabeblack@google.com if (sc_is_running()) { 16712861Sgabeblack@google.com SC_REPORT_ERROR("attempt to set sc_stop mode " 16812861Sgabeblack@google.com "after start will be ignored", ""); 16912861Sgabeblack@google.com return; 17012861Sgabeblack@google.com } 17112861Sgabeblack@google.com _stop_mode = mode; 17212860Sgabeblack@google.com} 17312860Sgabeblack@google.com 17412860Sgabeblack@google.comsc_stop_mode 17512860Sgabeblack@google.comsc_get_stop_mode() 17612860Sgabeblack@google.com{ 17712861Sgabeblack@google.com return _stop_mode; 17812860Sgabeblack@google.com} 17912860Sgabeblack@google.com 18012860Sgabeblack@google.comvoid 18112860Sgabeblack@google.comsc_stop() 18212860Sgabeblack@google.com{ 18312990Sgabeblack@google.com if (::sc_gem5::Kernel::status() == SC_STOPPED) 18412961Sgabeblack@google.com return; 18512961Sgabeblack@google.com 18612961Sgabeblack@google.com if (sc_is_running()) { 18712961Sgabeblack@google.com bool finish_delta = (_stop_mode == SC_STOP_FINISH_DELTA); 18812961Sgabeblack@google.com ::sc_gem5::scheduler.scheduleStop(finish_delta); 18912961Sgabeblack@google.com } else { 19012990Sgabeblack@google.com ::sc_gem5::Kernel::stop(); 19112961Sgabeblack@google.com } 19212860Sgabeblack@google.com} 19312860Sgabeblack@google.com 19412860Sgabeblack@google.comconst sc_time & 19512860Sgabeblack@google.comsc_time_stamp() 19612860Sgabeblack@google.com{ 19712956Sgabeblack@google.com static sc_time tstamp; 19812962Sgabeblack@google.com Tick tick = ::sc_gem5::scheduler.getCurTick(); 19912956Sgabeblack@google.com //XXX We're assuming the systemc time resolution is in ps. 20012956Sgabeblack@google.com tstamp = sc_time::from_value(tick / SimClock::Int::ps); 20112956Sgabeblack@google.com return tstamp; 20212860Sgabeblack@google.com} 20312860Sgabeblack@google.com 20412860Sgabeblack@google.comsc_dt::uint64 20512860Sgabeblack@google.comsc_delta_count() 20612860Sgabeblack@google.com{ 20712956Sgabeblack@google.com return sc_gem5::scheduler.numCycles(); 20812860Sgabeblack@google.com} 20912860Sgabeblack@google.com 21012860Sgabeblack@google.combool 21112860Sgabeblack@google.comsc_is_running() 21212860Sgabeblack@google.com{ 21312982Sgabeblack@google.com return sc_get_status() & (SC_RUNNING | SC_PAUSED); 21412860Sgabeblack@google.com} 21512860Sgabeblack@google.com 21612860Sgabeblack@google.combool 21712860Sgabeblack@google.comsc_pending_activity_at_current_time() 21812860Sgabeblack@google.com{ 21912962Sgabeblack@google.com return ::sc_gem5::scheduler.pendingCurr(); 22012860Sgabeblack@google.com} 22112860Sgabeblack@google.com 22212860Sgabeblack@google.combool 22312860Sgabeblack@google.comsc_pending_activity_at_future_time() 22412860Sgabeblack@google.com{ 22512962Sgabeblack@google.com return ::sc_gem5::scheduler.pendingFuture(); 22612860Sgabeblack@google.com} 22712860Sgabeblack@google.com 22812860Sgabeblack@google.combool 22912860Sgabeblack@google.comsc_pending_activity() 23012860Sgabeblack@google.com{ 23112861Sgabeblack@google.com return sc_pending_activity_at_current_time() || 23212861Sgabeblack@google.com sc_pending_activity_at_future_time(); 23312860Sgabeblack@google.com} 23412860Sgabeblack@google.com 23512860Sgabeblack@google.comsc_time 23612860Sgabeblack@google.comsc_time_to_pending_activity() 23712860Sgabeblack@google.com{ 23812962Sgabeblack@google.com return sc_time::from_value(::sc_gem5::scheduler.timeToPending()); 23912860Sgabeblack@google.com} 24012860Sgabeblack@google.com 24112860Sgabeblack@google.comsc_status 24212860Sgabeblack@google.comsc_get_status() 24312860Sgabeblack@google.com{ 24412982Sgabeblack@google.com return ::sc_gem5::kernel ? ::sc_gem5::kernel->status() : SC_ELABORATION; 24512860Sgabeblack@google.com} 24612860Sgabeblack@google.com 24712837Sgabeblack@google.com} // namespace sc_core 248