sc_main.cc revision 13077
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); 6513077Sgabeblack@google.com // Make sure no systemc events/notifications are scheduled 6613077Sgabeblack@google.com // after sc_main returns. 6713077Sgabeblack@google.com ::sc_gem5::Kernel::scMainFinished(true); 6813077Sgabeblack@google.com ::sc_gem5::scheduler.clear(); 6912949Sgabeblack@google.com } else { 7012949Sgabeblack@google.com // If python tries to call sc_main but no sc_main was defined... 7112949Sgabeblack@google.com fatal("sc_main called but not defined.\n"); 7212949Sgabeblack@google.com } 7312862Sgabeblack@google.com } 7412862Sgabeblack@google.com}; 7512862Sgabeblack@google.com 7612862Sgabeblack@google.comScMainFiber scMainFiber; 7712862Sgabeblack@google.com 7812837Sgabeblack@google.com// This wrapper adapts the python version of sc_main to the c++ version. 7912837Sgabeblack@google.comvoid 8012837Sgabeblack@google.comsc_main(pybind11::args args) 8112837Sgabeblack@google.com{ 8212837Sgabeblack@google.com panic_if(scMainCalled, "sc_main called more than once."); 8312837Sgabeblack@google.com 8412837Sgabeblack@google.com _argc = args.size(); 8512837Sgabeblack@google.com _argv = new char *[_argc]; 8612837Sgabeblack@google.com 8712837Sgabeblack@google.com // Initialize all the _argvs to NULL so we can delete [] them 8812837Sgabeblack@google.com // unconditionally. 8912837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) 9012837Sgabeblack@google.com _argv[idx] = NULL; 9112837Sgabeblack@google.com 9212837Sgabeblack@google.com // Attempt to convert all the arguments to strings. If that fails, clean 9312837Sgabeblack@google.com // up after ourselves. Also don't count this as a call to sc_main since 9412837Sgabeblack@google.com // we never got to the c++ version of that function. 9512837Sgabeblack@google.com try { 9612837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) { 9712837Sgabeblack@google.com std::string arg = args[idx].cast<std::string>(); 9812837Sgabeblack@google.com _argv[idx] = new char[arg.length() + 1]; 9912837Sgabeblack@google.com strcpy(_argv[idx], arg.c_str()); 10012837Sgabeblack@google.com } 10112837Sgabeblack@google.com } catch (...) { 10212837Sgabeblack@google.com // If that didn't work for some reason (probably a conversion error) 10312837Sgabeblack@google.com // blow away _argv and _argc and pass on the exception. 10412837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) 10512837Sgabeblack@google.com delete [] _argv[idx]; 10612837Sgabeblack@google.com delete [] _argv; 10712837Sgabeblack@google.com _argc = 0; 10812837Sgabeblack@google.com throw; 10912837Sgabeblack@google.com } 11012837Sgabeblack@google.com 11112837Sgabeblack@google.com // At this point we're going to call the c++ sc_main, so we can't try 11212837Sgabeblack@google.com // again later. 11312837Sgabeblack@google.com scMainCalled = true; 11412837Sgabeblack@google.com 11512862Sgabeblack@google.com scMainFiber.run(); 11612837Sgabeblack@google.com} 11712837Sgabeblack@google.com 11812837Sgabeblack@google.com// Make our sc_main wrapper available in the internal _m5 python module under 11912837Sgabeblack@google.com// the systemc submodule. 12013038Sgabeblack@google.com 12113038Sgabeblack@google.comstruct InstallScMain : public ::sc_gem5::PythonInitFunc 12212837Sgabeblack@google.com{ 12313038Sgabeblack@google.com void 12413038Sgabeblack@google.com run(pybind11::module &systemc) override 12513038Sgabeblack@google.com { 12613038Sgabeblack@google.com systemc.def("sc_main", &sc_main); 12713038Sgabeblack@google.com } 12813038Sgabeblack@google.com} installScMain; 12912837Sgabeblack@google.com 13012861Sgabeblack@google.comsc_stop_mode _stop_mode = SC_STOP_FINISH_DELTA; 13112861Sgabeblack@google.com 13212837Sgabeblack@google.com} // anonymous namespace 13312837Sgabeblack@google.com 13412837Sgabeblack@google.comint 13512837Sgabeblack@google.comsc_argc() 13612837Sgabeblack@google.com{ 13712837Sgabeblack@google.com return _argc; 13812837Sgabeblack@google.com} 13912837Sgabeblack@google.com 14012837Sgabeblack@google.comconst char *const * 14112837Sgabeblack@google.comsc_argv() 14212837Sgabeblack@google.com{ 14312837Sgabeblack@google.com return _argv; 14412837Sgabeblack@google.com} 14512837Sgabeblack@google.com 14612860Sgabeblack@google.comvoid 14712860Sgabeblack@google.comsc_start() 14812860Sgabeblack@google.com{ 14912962Sgabeblack@google.com Tick now = ::sc_gem5::scheduler.getCurTick(); 15012961Sgabeblack@google.com sc_start(sc_time::from_value(MaxTick - now), SC_EXIT_ON_STARVATION); 15112860Sgabeblack@google.com} 15212860Sgabeblack@google.com 15312860Sgabeblack@google.comvoid 15412860Sgabeblack@google.comsc_pause() 15512860Sgabeblack@google.com{ 15612990Sgabeblack@google.com if (::sc_gem5::Kernel::status() == SC_RUNNING) 15712961Sgabeblack@google.com ::sc_gem5::scheduler.schedulePause(); 15812860Sgabeblack@google.com} 15912860Sgabeblack@google.com 16012860Sgabeblack@google.comvoid 16112860Sgabeblack@google.comsc_start(const sc_time &time, sc_starvation_policy p) 16212860Sgabeblack@google.com{ 16313061Sgabeblack@google.com if (time.value() == 0) { 16413061Sgabeblack@google.com ::sc_gem5::scheduler.oneCycle(); 16513061Sgabeblack@google.com } else { 16613061Sgabeblack@google.com Tick now = ::sc_gem5::scheduler.getCurTick(); 16713061Sgabeblack@google.com ::sc_gem5::scheduler.start(now + time.value(), p == SC_RUN_TO_TIME); 16813061Sgabeblack@google.com } 16912860Sgabeblack@google.com} 17012860Sgabeblack@google.com 17112860Sgabeblack@google.comvoid 17212860Sgabeblack@google.comsc_set_stop_mode(sc_stop_mode mode) 17312860Sgabeblack@google.com{ 17412861Sgabeblack@google.com if (sc_is_running()) { 17512861Sgabeblack@google.com SC_REPORT_ERROR("attempt to set sc_stop mode " 17612861Sgabeblack@google.com "after start will be ignored", ""); 17712861Sgabeblack@google.com return; 17812861Sgabeblack@google.com } 17912861Sgabeblack@google.com _stop_mode = mode; 18012860Sgabeblack@google.com} 18112860Sgabeblack@google.com 18212860Sgabeblack@google.comsc_stop_mode 18312860Sgabeblack@google.comsc_get_stop_mode() 18412860Sgabeblack@google.com{ 18512861Sgabeblack@google.com return _stop_mode; 18612860Sgabeblack@google.com} 18712860Sgabeblack@google.com 18812860Sgabeblack@google.comvoid 18912860Sgabeblack@google.comsc_stop() 19012860Sgabeblack@google.com{ 19112990Sgabeblack@google.com if (::sc_gem5::Kernel::status() == SC_STOPPED) 19212961Sgabeblack@google.com return; 19312961Sgabeblack@google.com 19412961Sgabeblack@google.com if (sc_is_running()) { 19512961Sgabeblack@google.com bool finish_delta = (_stop_mode == SC_STOP_FINISH_DELTA); 19612961Sgabeblack@google.com ::sc_gem5::scheduler.scheduleStop(finish_delta); 19712961Sgabeblack@google.com } else { 19812990Sgabeblack@google.com ::sc_gem5::Kernel::stop(); 19912961Sgabeblack@google.com } 20012860Sgabeblack@google.com} 20112860Sgabeblack@google.com 20212860Sgabeblack@google.comconst sc_time & 20312860Sgabeblack@google.comsc_time_stamp() 20412860Sgabeblack@google.com{ 20512956Sgabeblack@google.com static sc_time tstamp; 20612962Sgabeblack@google.com Tick tick = ::sc_gem5::scheduler.getCurTick(); 20712956Sgabeblack@google.com //XXX We're assuming the systemc time resolution is in ps. 20812956Sgabeblack@google.com tstamp = sc_time::from_value(tick / SimClock::Int::ps); 20912956Sgabeblack@google.com return tstamp; 21012860Sgabeblack@google.com} 21112860Sgabeblack@google.com 21212860Sgabeblack@google.comsc_dt::uint64 21312860Sgabeblack@google.comsc_delta_count() 21412860Sgabeblack@google.com{ 21512956Sgabeblack@google.com return sc_gem5::scheduler.numCycles(); 21612860Sgabeblack@google.com} 21712860Sgabeblack@google.com 21812860Sgabeblack@google.combool 21912860Sgabeblack@google.comsc_is_running() 22012860Sgabeblack@google.com{ 22112982Sgabeblack@google.com return sc_get_status() & (SC_RUNNING | SC_PAUSED); 22212860Sgabeblack@google.com} 22312860Sgabeblack@google.com 22412860Sgabeblack@google.combool 22512860Sgabeblack@google.comsc_pending_activity_at_current_time() 22612860Sgabeblack@google.com{ 22712962Sgabeblack@google.com return ::sc_gem5::scheduler.pendingCurr(); 22812860Sgabeblack@google.com} 22912860Sgabeblack@google.com 23012860Sgabeblack@google.combool 23112860Sgabeblack@google.comsc_pending_activity_at_future_time() 23212860Sgabeblack@google.com{ 23312962Sgabeblack@google.com return ::sc_gem5::scheduler.pendingFuture(); 23412860Sgabeblack@google.com} 23512860Sgabeblack@google.com 23612860Sgabeblack@google.combool 23712860Sgabeblack@google.comsc_pending_activity() 23812860Sgabeblack@google.com{ 23912861Sgabeblack@google.com return sc_pending_activity_at_current_time() || 24012861Sgabeblack@google.com sc_pending_activity_at_future_time(); 24112860Sgabeblack@google.com} 24212860Sgabeblack@google.com 24312860Sgabeblack@google.comsc_time 24412860Sgabeblack@google.comsc_time_to_pending_activity() 24512860Sgabeblack@google.com{ 24612962Sgabeblack@google.com return sc_time::from_value(::sc_gem5::scheduler.timeToPending()); 24712860Sgabeblack@google.com} 24812860Sgabeblack@google.com 24912860Sgabeblack@google.comsc_status 25012860Sgabeblack@google.comsc_get_status() 25112860Sgabeblack@google.com{ 25212982Sgabeblack@google.com return ::sc_gem5::kernel ? ::sc_gem5::kernel->status() : SC_ELABORATION; 25312860Sgabeblack@google.com} 25412860Sgabeblack@google.com 25513043Sgabeblack@google.comstd::ostream & 25613043Sgabeblack@google.comoperator << (std::ostream &os, sc_status s) 25713043Sgabeblack@google.com{ 25813043Sgabeblack@google.com switch (s) { 25913043Sgabeblack@google.com case SC_ELABORATION: 26013043Sgabeblack@google.com os << "SC_ELABORATION"; 26113043Sgabeblack@google.com break; 26213043Sgabeblack@google.com case SC_BEFORE_END_OF_ELABORATION: 26313043Sgabeblack@google.com os << "SC_BEFORE_END_OF_ELABORATION"; 26413043Sgabeblack@google.com break; 26513043Sgabeblack@google.com case SC_END_OF_ELABORATION: 26613043Sgabeblack@google.com os << "SC_END_OF_ELABORATION"; 26713043Sgabeblack@google.com break; 26813043Sgabeblack@google.com case SC_START_OF_SIMULATION: 26913043Sgabeblack@google.com os << "SC_START_OF_SIMULATION"; 27013043Sgabeblack@google.com break; 27113043Sgabeblack@google.com case SC_RUNNING: 27213043Sgabeblack@google.com os << "SC_RUNNING"; 27313043Sgabeblack@google.com break; 27413043Sgabeblack@google.com case SC_PAUSED: 27513043Sgabeblack@google.com os << "SC_PAUSED"; 27613043Sgabeblack@google.com break; 27713043Sgabeblack@google.com case SC_STOPPED: 27813043Sgabeblack@google.com os << "SC_STOPPED"; 27913043Sgabeblack@google.com break; 28013043Sgabeblack@google.com case SC_END_OF_SIMULATION: 28113043Sgabeblack@google.com os << "SC_END_OF_SIMULATION"; 28213043Sgabeblack@google.com break; 28313043Sgabeblack@google.com 28413043Sgabeblack@google.com // Nonstandard 28513043Sgabeblack@google.com case SC_END_OF_INITIALIZATION: 28613043Sgabeblack@google.com os << "SC_END_OF_INITIALIZATION"; 28713043Sgabeblack@google.com break; 28813043Sgabeblack@google.com case SC_END_OF_UPDATE: 28913043Sgabeblack@google.com os << "SC_END_OF_UPDATE"; 29013043Sgabeblack@google.com break; 29113043Sgabeblack@google.com case SC_BEFORE_TIMESTEP: 29213043Sgabeblack@google.com os << "SC_BEFORE_TIMESTEP"; 29313043Sgabeblack@google.com break; 29413043Sgabeblack@google.com 29513043Sgabeblack@google.com default: 29613043Sgabeblack@google.com if (s & SC_STATUS_ANY) { 29713043Sgabeblack@google.com const char *prefix = "("; 29813043Sgabeblack@google.com for (sc_status m = (sc_status)0x1; 29913043Sgabeblack@google.com m < SC_STATUS_ANY; m = (sc_status)(m << 1)) { 30013043Sgabeblack@google.com if (m & s) { 30113043Sgabeblack@google.com os << prefix; 30213043Sgabeblack@google.com prefix = "|"; 30313043Sgabeblack@google.com os << m; 30413043Sgabeblack@google.com } 30513043Sgabeblack@google.com } 30613043Sgabeblack@google.com os << ")"; 30713043Sgabeblack@google.com } else { 30813043Sgabeblack@google.com ccprintf(os, "%#x", s); 30913043Sgabeblack@google.com } 31013043Sgabeblack@google.com } 31113043Sgabeblack@google.com 31213043Sgabeblack@google.com return os; 31313043Sgabeblack@google.com} 31413043Sgabeblack@google.com 31512837Sgabeblack@google.com} // namespace sc_core 316