sc_main.cc revision 12861
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 3212837Sgabeblack@google.com#include "base/logging.hh" 3312837Sgabeblack@google.com#include "python/pybind11/pybind.hh" 3412837Sgabeblack@google.com#include "sim/init.hh" 3512837Sgabeblack@google.com#include "systemc/ext/core/sc_main.hh" 3612861Sgabeblack@google.com#include "systemc/ext/utils/sc_report_handler.hh" 3712837Sgabeblack@google.com 3812837Sgabeblack@google.com// A default version of this function in case one isn't otherwise defined. 3912837Sgabeblack@google.com// This ensures everything will link properly whether or not the user defined 4012837Sgabeblack@google.com// a custom sc_main function. If they didn't but still try to call it, throw 4112837Sgabeblack@google.com// an error and die. 4212837Sgabeblack@google.com[[gnu::weak]] int 4312837Sgabeblack@google.comsc_main(int argc, char *argv[]) 4412837Sgabeblack@google.com{ 4512837Sgabeblack@google.com // If python attempts to call sc_main but no sc_main was defined... 4612837Sgabeblack@google.com fatal("sc_main called but not defined.\n"); 4712837Sgabeblack@google.com} 4812837Sgabeblack@google.com 4912837Sgabeblack@google.comnamespace sc_core 5012837Sgabeblack@google.com{ 5112837Sgabeblack@google.com 5212837Sgabeblack@google.comnamespace 5312837Sgabeblack@google.com{ 5412837Sgabeblack@google.com 5512837Sgabeblack@google.combool scMainCalled = false; 5612837Sgabeblack@google.com 5712837Sgabeblack@google.comint _argc = 0; 5812837Sgabeblack@google.comchar **_argv = NULL; 5912837Sgabeblack@google.com 6012837Sgabeblack@google.com// This wrapper adapts the python version of sc_main to the c++ version. 6112837Sgabeblack@google.comvoid 6212837Sgabeblack@google.comsc_main(pybind11::args args) 6312837Sgabeblack@google.com{ 6412837Sgabeblack@google.com panic_if(scMainCalled, "sc_main called more than once."); 6512837Sgabeblack@google.com 6612837Sgabeblack@google.com _argc = args.size(); 6712837Sgabeblack@google.com _argv = new char *[_argc]; 6812837Sgabeblack@google.com 6912837Sgabeblack@google.com // Initialize all the _argvs to NULL so we can delete [] them 7012837Sgabeblack@google.com // unconditionally. 7112837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) 7212837Sgabeblack@google.com _argv[idx] = NULL; 7312837Sgabeblack@google.com 7412837Sgabeblack@google.com // Attempt to convert all the arguments to strings. If that fails, clean 7512837Sgabeblack@google.com // up after ourselves. Also don't count this as a call to sc_main since 7612837Sgabeblack@google.com // we never got to the c++ version of that function. 7712837Sgabeblack@google.com try { 7812837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) { 7912837Sgabeblack@google.com std::string arg = args[idx].cast<std::string>(); 8012837Sgabeblack@google.com _argv[idx] = new char[arg.length() + 1]; 8112837Sgabeblack@google.com strcpy(_argv[idx], arg.c_str()); 8212837Sgabeblack@google.com } 8312837Sgabeblack@google.com } catch (...) { 8412837Sgabeblack@google.com // If that didn't work for some reason (probably a conversion error) 8512837Sgabeblack@google.com // blow away _argv and _argc and pass on the exception. 8612837Sgabeblack@google.com for (int idx = 0; idx < _argc; idx++) 8712837Sgabeblack@google.com delete [] _argv[idx]; 8812837Sgabeblack@google.com delete [] _argv; 8912837Sgabeblack@google.com _argc = 0; 9012837Sgabeblack@google.com throw; 9112837Sgabeblack@google.com } 9212837Sgabeblack@google.com 9312837Sgabeblack@google.com // At this point we're going to call the c++ sc_main, so we can't try 9412837Sgabeblack@google.com // again later. 9512837Sgabeblack@google.com scMainCalled = true; 9612837Sgabeblack@google.com 9712837Sgabeblack@google.com //TODO Start a new fiber to call sc_main from. 9812837Sgabeblack@google.com ::sc_main(_argc, _argv); 9912837Sgabeblack@google.com} 10012837Sgabeblack@google.com 10112837Sgabeblack@google.com// Make our sc_main wrapper available in the internal _m5 python module under 10212837Sgabeblack@google.com// the systemc submodule. 10312837Sgabeblack@google.comvoid 10412837Sgabeblack@google.comsystemc_pybind(pybind11::module &m_internal) 10512837Sgabeblack@google.com{ 10612837Sgabeblack@google.com pybind11::module m = m_internal.def_submodule("systemc"); 10712837Sgabeblack@google.com m.def("sc_main", &sc_main); 10812837Sgabeblack@google.com} 10912837Sgabeblack@google.comEmbeddedPyBind embed_("systemc", &systemc_pybind); 11012837Sgabeblack@google.com 11112861Sgabeblack@google.comsc_stop_mode _stop_mode = SC_STOP_FINISH_DELTA; 11212861Sgabeblack@google.comsc_status _status = SC_ELABORATION; 11312861Sgabeblack@google.com 11412861Sgabeblack@google.comuint64_t _deltaCycles = 0; 11512861Sgabeblack@google.com 11612837Sgabeblack@google.com} // anonymous namespace 11712837Sgabeblack@google.com 11812837Sgabeblack@google.comint 11912837Sgabeblack@google.comsc_argc() 12012837Sgabeblack@google.com{ 12112837Sgabeblack@google.com return _argc; 12212837Sgabeblack@google.com} 12312837Sgabeblack@google.com 12412837Sgabeblack@google.comconst char *const * 12512837Sgabeblack@google.comsc_argv() 12612837Sgabeblack@google.com{ 12712837Sgabeblack@google.com return _argv; 12812837Sgabeblack@google.com} 12912837Sgabeblack@google.com 13012860Sgabeblack@google.comvoid 13112860Sgabeblack@google.comsc_start() 13212860Sgabeblack@google.com{ 13312860Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 13412860Sgabeblack@google.com} 13512860Sgabeblack@google.com 13612860Sgabeblack@google.comvoid 13712860Sgabeblack@google.comsc_pause() 13812860Sgabeblack@google.com{ 13912860Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 14012860Sgabeblack@google.com} 14112860Sgabeblack@google.com 14212860Sgabeblack@google.comvoid 14312860Sgabeblack@google.comsc_start(const sc_time &time, sc_starvation_policy p) 14412860Sgabeblack@google.com{ 14512860Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 14612860Sgabeblack@google.com} 14712860Sgabeblack@google.com 14812860Sgabeblack@google.comvoid 14912860Sgabeblack@google.comsc_set_stop_mode(sc_stop_mode mode) 15012860Sgabeblack@google.com{ 15112861Sgabeblack@google.com if (sc_is_running()) { 15212861Sgabeblack@google.com SC_REPORT_ERROR("attempt to set sc_stop mode " 15312861Sgabeblack@google.com "after start will be ignored", ""); 15412861Sgabeblack@google.com return; 15512861Sgabeblack@google.com } 15612861Sgabeblack@google.com _stop_mode = mode; 15712860Sgabeblack@google.com} 15812860Sgabeblack@google.com 15912860Sgabeblack@google.comsc_stop_mode 16012860Sgabeblack@google.comsc_get_stop_mode() 16112860Sgabeblack@google.com{ 16212861Sgabeblack@google.com return _stop_mode; 16312860Sgabeblack@google.com} 16412860Sgabeblack@google.com 16512860Sgabeblack@google.comvoid 16612860Sgabeblack@google.comsc_stop() 16712860Sgabeblack@google.com{ 16812860Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 16912860Sgabeblack@google.com} 17012860Sgabeblack@google.com 17112860Sgabeblack@google.comconst sc_time & 17212860Sgabeblack@google.comsc_time_stamp() 17312860Sgabeblack@google.com{ 17412860Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 17512860Sgabeblack@google.com return *(sc_time *)nullptr; 17612860Sgabeblack@google.com} 17712860Sgabeblack@google.com 17812860Sgabeblack@google.comsc_dt::uint64 17912860Sgabeblack@google.comsc_delta_count() 18012860Sgabeblack@google.com{ 18112861Sgabeblack@google.com return _deltaCycles; 18212860Sgabeblack@google.com} 18312860Sgabeblack@google.com 18412860Sgabeblack@google.combool 18512860Sgabeblack@google.comsc_is_running() 18612860Sgabeblack@google.com{ 18712861Sgabeblack@google.com return _status & (SC_RUNNING | SC_PAUSED); 18812860Sgabeblack@google.com} 18912860Sgabeblack@google.com 19012860Sgabeblack@google.combool 19112860Sgabeblack@google.comsc_pending_activity_at_current_time() 19212860Sgabeblack@google.com{ 19312860Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 19412860Sgabeblack@google.com return false; 19512860Sgabeblack@google.com} 19612860Sgabeblack@google.com 19712860Sgabeblack@google.combool 19812860Sgabeblack@google.comsc_pending_activity_at_future_time() 19912860Sgabeblack@google.com{ 20012860Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 20112860Sgabeblack@google.com return false; 20212860Sgabeblack@google.com} 20312860Sgabeblack@google.com 20412860Sgabeblack@google.combool 20512860Sgabeblack@google.comsc_pending_activity() 20612860Sgabeblack@google.com{ 20712861Sgabeblack@google.com return sc_pending_activity_at_current_time() || 20812861Sgabeblack@google.com sc_pending_activity_at_future_time(); 20912860Sgabeblack@google.com} 21012860Sgabeblack@google.com 21112860Sgabeblack@google.comsc_time 21212860Sgabeblack@google.comsc_time_to_pending_activity() 21312860Sgabeblack@google.com{ 21412860Sgabeblack@google.com warn("%s not implemented.\n", __PRETTY_FUNCTION__); 21512860Sgabeblack@google.com return sc_time(); 21612860Sgabeblack@google.com} 21712860Sgabeblack@google.com 21812860Sgabeblack@google.comsc_status 21912860Sgabeblack@google.comsc_get_status() 22012860Sgabeblack@google.com{ 22112861Sgabeblack@google.com return _status; 22212860Sgabeblack@google.com} 22312860Sgabeblack@google.com 22412837Sgabeblack@google.com} // namespace sc_core 225