sc_main.cc revision 13083
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>
3113081Sgabeblack@google.com#include <string>
3212837Sgabeblack@google.com
3312862Sgabeblack@google.com#include "base/fiber.hh"
3412837Sgabeblack@google.com#include "base/logging.hh"
3512862Sgabeblack@google.com#include "base/types.hh"
3612956Sgabeblack@google.com#include "sim/core.hh"
3712862Sgabeblack@google.com#include "sim/eventq.hh"
3812837Sgabeblack@google.com#include "sim/init.hh"
3912982Sgabeblack@google.com#include "systemc/core/kernel.hh"
4013038Sgabeblack@google.com#include "systemc/core/python.hh"
4112956Sgabeblack@google.com#include "systemc/core/scheduler.hh"
4212837Sgabeblack@google.com#include "systemc/ext/core/sc_main.hh"
4312861Sgabeblack@google.com#include "systemc/ext/utils/sc_report_handler.hh"
4412837Sgabeblack@google.com
4512949Sgabeblack@google.com// A weak symbol to detect if sc_main has been defined, and if so where it is.
4612949Sgabeblack@google.com[[gnu::weak]] int sc_main(int argc, char *argv[]);
4712837Sgabeblack@google.com
4812837Sgabeblack@google.comnamespace sc_core
4912837Sgabeblack@google.com{
5012837Sgabeblack@google.com
5112837Sgabeblack@google.comnamespace
5212837Sgabeblack@google.com{
5312837Sgabeblack@google.com
5412837Sgabeblack@google.combool scMainCalled = false;
5512837Sgabeblack@google.com
5612837Sgabeblack@google.comint _argc = 0;
5712837Sgabeblack@google.comchar **_argv = NULL;
5812837Sgabeblack@google.com
5912862Sgabeblack@google.comclass ScMainFiber : public Fiber
6012862Sgabeblack@google.com{
6113081Sgabeblack@google.com  public:
6213081Sgabeblack@google.com    std::string resultStr;
6313081Sgabeblack@google.com    int resultInt;
6413081Sgabeblack@google.com
6513081Sgabeblack@google.com    ScMainFiber() : resultInt(1) {}
6613081Sgabeblack@google.com
6712862Sgabeblack@google.com    void
6812862Sgabeblack@google.com    main()
6912862Sgabeblack@google.com    {
7012949Sgabeblack@google.com        if (::sc_main) {
7113081Sgabeblack@google.com            try {
7213081Sgabeblack@google.com                resultInt = ::sc_main(_argc, _argv);
7313081Sgabeblack@google.com                if (resultInt)
7413081Sgabeblack@google.com                    resultStr = "sc_main returned non-zero";
7513081Sgabeblack@google.com                else
7613081Sgabeblack@google.com                    resultStr = "sc_main finished";
7713081Sgabeblack@google.com                // Make sure no systemc events/notifications are scheduled
7813081Sgabeblack@google.com                // after sc_main returns.
7913081Sgabeblack@google.com            } catch (const sc_report &r) {
8013081Sgabeblack@google.com                // There was an exception nobody caught.
8113081Sgabeblack@google.com                resultStr = r.what();
8213081Sgabeblack@google.com            }
8313077Sgabeblack@google.com            ::sc_gem5::Kernel::scMainFinished(true);
8413077Sgabeblack@google.com            ::sc_gem5::scheduler.clear();
8512949Sgabeblack@google.com        } else {
8612949Sgabeblack@google.com            // If python tries to call sc_main but no sc_main was defined...
8712949Sgabeblack@google.com            fatal("sc_main called but not defined.\n");
8812949Sgabeblack@google.com        }
8912862Sgabeblack@google.com    }
9012862Sgabeblack@google.com};
9112862Sgabeblack@google.com
9212862Sgabeblack@google.comScMainFiber scMainFiber;
9312862Sgabeblack@google.com
9412837Sgabeblack@google.com// This wrapper adapts the python version of sc_main to the c++ version.
9512837Sgabeblack@google.comvoid
9612837Sgabeblack@google.comsc_main(pybind11::args args)
9712837Sgabeblack@google.com{
9812837Sgabeblack@google.com    panic_if(scMainCalled, "sc_main called more than once.");
9912837Sgabeblack@google.com
10012837Sgabeblack@google.com    _argc = args.size();
10112837Sgabeblack@google.com    _argv = new char *[_argc];
10212837Sgabeblack@google.com
10312837Sgabeblack@google.com    // Initialize all the _argvs to NULL so we can delete [] them
10412837Sgabeblack@google.com    // unconditionally.
10512837Sgabeblack@google.com    for (int idx = 0; idx < _argc; idx++)
10612837Sgabeblack@google.com        _argv[idx] = NULL;
10712837Sgabeblack@google.com
10812837Sgabeblack@google.com    // Attempt to convert all the arguments to strings. If that fails, clean
10912837Sgabeblack@google.com    // up after ourselves. Also don't count this as a call to sc_main since
11012837Sgabeblack@google.com    // we never got to the c++ version of that function.
11112837Sgabeblack@google.com    try {
11212837Sgabeblack@google.com        for (int idx = 0; idx < _argc; idx++) {
11312837Sgabeblack@google.com            std::string arg = args[idx].cast<std::string>();
11412837Sgabeblack@google.com            _argv[idx] = new char[arg.length() + 1];
11512837Sgabeblack@google.com            strcpy(_argv[idx], arg.c_str());
11612837Sgabeblack@google.com        }
11712837Sgabeblack@google.com    } catch (...) {
11812837Sgabeblack@google.com        // If that didn't work for some reason (probably a conversion error)
11912837Sgabeblack@google.com        // blow away _argv and _argc and pass on the exception.
12012837Sgabeblack@google.com        for (int idx = 0; idx < _argc; idx++)
12112837Sgabeblack@google.com            delete [] _argv[idx];
12212837Sgabeblack@google.com        delete [] _argv;
12312837Sgabeblack@google.com        _argc = 0;
12412837Sgabeblack@google.com        throw;
12512837Sgabeblack@google.com    }
12612837Sgabeblack@google.com
12712837Sgabeblack@google.com    // At this point we're going to call the c++ sc_main, so we can't try
12812837Sgabeblack@google.com    // again later.
12912837Sgabeblack@google.com    scMainCalled = true;
13012837Sgabeblack@google.com
13112862Sgabeblack@google.com    scMainFiber.run();
13212837Sgabeblack@google.com}
13312837Sgabeblack@google.com
13413081Sgabeblack@google.comint
13513081Sgabeblack@google.comsc_main_result_code()
13613081Sgabeblack@google.com{
13713081Sgabeblack@google.com    return scMainFiber.resultInt;
13813081Sgabeblack@google.com}
13913081Sgabeblack@google.com
14013081Sgabeblack@google.comstd::string
14113081Sgabeblack@google.comsc_main_result_str()
14213081Sgabeblack@google.com{
14313081Sgabeblack@google.com    return scMainFiber.resultStr;
14413081Sgabeblack@google.com}
14513081Sgabeblack@google.com
14612837Sgabeblack@google.com// Make our sc_main wrapper available in the internal _m5 python module under
14712837Sgabeblack@google.com// the systemc submodule.
14813038Sgabeblack@google.com
14913038Sgabeblack@google.comstruct InstallScMain : public ::sc_gem5::PythonInitFunc
15012837Sgabeblack@google.com{
15113038Sgabeblack@google.com    void
15213038Sgabeblack@google.com    run(pybind11::module &systemc) override
15313038Sgabeblack@google.com    {
15413038Sgabeblack@google.com        systemc.def("sc_main", &sc_main);
15513081Sgabeblack@google.com        systemc.def("sc_main_result_code", &sc_main_result_code);
15613081Sgabeblack@google.com        systemc.def("sc_main_result_str", &sc_main_result_str);
15713038Sgabeblack@google.com    }
15813038Sgabeblack@google.com} installScMain;
15912837Sgabeblack@google.com
16012861Sgabeblack@google.comsc_stop_mode _stop_mode = SC_STOP_FINISH_DELTA;
16112861Sgabeblack@google.com
16212837Sgabeblack@google.com} // anonymous namespace
16312837Sgabeblack@google.com
16412837Sgabeblack@google.comint
16512837Sgabeblack@google.comsc_argc()
16612837Sgabeblack@google.com{
16712837Sgabeblack@google.com    return _argc;
16812837Sgabeblack@google.com}
16912837Sgabeblack@google.com
17012837Sgabeblack@google.comconst char *const *
17112837Sgabeblack@google.comsc_argv()
17212837Sgabeblack@google.com{
17312837Sgabeblack@google.com    return _argv;
17412837Sgabeblack@google.com}
17512837Sgabeblack@google.com
17612860Sgabeblack@google.comvoid
17712860Sgabeblack@google.comsc_start()
17812860Sgabeblack@google.com{
17912962Sgabeblack@google.com    Tick now = ::sc_gem5::scheduler.getCurTick();
18012961Sgabeblack@google.com    sc_start(sc_time::from_value(MaxTick - now), SC_EXIT_ON_STARVATION);
18112860Sgabeblack@google.com}
18212860Sgabeblack@google.com
18312860Sgabeblack@google.comvoid
18412860Sgabeblack@google.comsc_pause()
18512860Sgabeblack@google.com{
18612990Sgabeblack@google.com    if (::sc_gem5::Kernel::status() == SC_RUNNING)
18712961Sgabeblack@google.com        ::sc_gem5::scheduler.schedulePause();
18812860Sgabeblack@google.com}
18912860Sgabeblack@google.com
19012860Sgabeblack@google.comvoid
19112860Sgabeblack@google.comsc_start(const sc_time &time, sc_starvation_policy p)
19212860Sgabeblack@google.com{
19313061Sgabeblack@google.com    if (time.value() == 0) {
19413061Sgabeblack@google.com        ::sc_gem5::scheduler.oneCycle();
19513061Sgabeblack@google.com    } else {
19613061Sgabeblack@google.com        Tick now = ::sc_gem5::scheduler.getCurTick();
19713061Sgabeblack@google.com        ::sc_gem5::scheduler.start(now + time.value(), p == SC_RUN_TO_TIME);
19813061Sgabeblack@google.com    }
19912860Sgabeblack@google.com}
20012860Sgabeblack@google.com
20112860Sgabeblack@google.comvoid
20212860Sgabeblack@google.comsc_set_stop_mode(sc_stop_mode mode)
20312860Sgabeblack@google.com{
20412861Sgabeblack@google.com    if (sc_is_running()) {
20512861Sgabeblack@google.com        SC_REPORT_ERROR("attempt to set sc_stop mode "
20612861Sgabeblack@google.com                        "after start will be ignored", "");
20712861Sgabeblack@google.com        return;
20812861Sgabeblack@google.com    }
20912861Sgabeblack@google.com    _stop_mode = mode;
21012860Sgabeblack@google.com}
21112860Sgabeblack@google.com
21212860Sgabeblack@google.comsc_stop_mode
21312860Sgabeblack@google.comsc_get_stop_mode()
21412860Sgabeblack@google.com{
21512861Sgabeblack@google.com    return _stop_mode;
21612860Sgabeblack@google.com}
21712860Sgabeblack@google.com
21812860Sgabeblack@google.comvoid
21912860Sgabeblack@google.comsc_stop()
22012860Sgabeblack@google.com{
22112990Sgabeblack@google.com    if (::sc_gem5::Kernel::status() == SC_STOPPED)
22212961Sgabeblack@google.com        return;
22312961Sgabeblack@google.com
22412961Sgabeblack@google.com    if (sc_is_running()) {
22512961Sgabeblack@google.com        bool finish_delta = (_stop_mode == SC_STOP_FINISH_DELTA);
22612961Sgabeblack@google.com        ::sc_gem5::scheduler.scheduleStop(finish_delta);
22712961Sgabeblack@google.com    } else {
22812990Sgabeblack@google.com        ::sc_gem5::Kernel::stop();
22912961Sgabeblack@google.com    }
23012860Sgabeblack@google.com}
23112860Sgabeblack@google.com
23212860Sgabeblack@google.comconst sc_time &
23312860Sgabeblack@google.comsc_time_stamp()
23412860Sgabeblack@google.com{
23512956Sgabeblack@google.com    static sc_time tstamp;
23612962Sgabeblack@google.com    Tick tick = ::sc_gem5::scheduler.getCurTick();
23712956Sgabeblack@google.com    //XXX We're assuming the systemc time resolution is in ps.
23813083Sgabeblack@google.com    // If tick is zero, the time scale may not be fixed yet, and
23913083Sgabeblack@google.com    // SimClock::Int::ps may be zero.
24013083Sgabeblack@google.com    tstamp = sc_time::from_value(tick ? tick / SimClock::Int::ps : 0);
24112956Sgabeblack@google.com    return tstamp;
24212860Sgabeblack@google.com}
24312860Sgabeblack@google.com
24412860Sgabeblack@google.comsc_dt::uint64
24512860Sgabeblack@google.comsc_delta_count()
24612860Sgabeblack@google.com{
24712956Sgabeblack@google.com    return sc_gem5::scheduler.numCycles();
24812860Sgabeblack@google.com}
24912860Sgabeblack@google.com
25012860Sgabeblack@google.combool
25112860Sgabeblack@google.comsc_is_running()
25212860Sgabeblack@google.com{
25312982Sgabeblack@google.com    return sc_get_status() & (SC_RUNNING | SC_PAUSED);
25412860Sgabeblack@google.com}
25512860Sgabeblack@google.com
25612860Sgabeblack@google.combool
25712860Sgabeblack@google.comsc_pending_activity_at_current_time()
25812860Sgabeblack@google.com{
25912962Sgabeblack@google.com    return ::sc_gem5::scheduler.pendingCurr();
26012860Sgabeblack@google.com}
26112860Sgabeblack@google.com
26212860Sgabeblack@google.combool
26312860Sgabeblack@google.comsc_pending_activity_at_future_time()
26412860Sgabeblack@google.com{
26512962Sgabeblack@google.com    return ::sc_gem5::scheduler.pendingFuture();
26612860Sgabeblack@google.com}
26712860Sgabeblack@google.com
26812860Sgabeblack@google.combool
26912860Sgabeblack@google.comsc_pending_activity()
27012860Sgabeblack@google.com{
27112861Sgabeblack@google.com    return sc_pending_activity_at_current_time() ||
27212861Sgabeblack@google.com           sc_pending_activity_at_future_time();
27312860Sgabeblack@google.com}
27412860Sgabeblack@google.com
27512860Sgabeblack@google.comsc_time
27612860Sgabeblack@google.comsc_time_to_pending_activity()
27712860Sgabeblack@google.com{
27812962Sgabeblack@google.com    return sc_time::from_value(::sc_gem5::scheduler.timeToPending());
27912860Sgabeblack@google.com}
28012860Sgabeblack@google.com
28112860Sgabeblack@google.comsc_status
28212860Sgabeblack@google.comsc_get_status()
28312860Sgabeblack@google.com{
28412982Sgabeblack@google.com    return ::sc_gem5::kernel ? ::sc_gem5::kernel->status() : SC_ELABORATION;
28512860Sgabeblack@google.com}
28612860Sgabeblack@google.com
28713043Sgabeblack@google.comstd::ostream &
28813043Sgabeblack@google.comoperator << (std::ostream &os, sc_status s)
28913043Sgabeblack@google.com{
29013043Sgabeblack@google.com    switch (s) {
29113043Sgabeblack@google.com      case SC_ELABORATION:
29213043Sgabeblack@google.com        os << "SC_ELABORATION";
29313043Sgabeblack@google.com        break;
29413043Sgabeblack@google.com      case SC_BEFORE_END_OF_ELABORATION:
29513043Sgabeblack@google.com        os << "SC_BEFORE_END_OF_ELABORATION";
29613043Sgabeblack@google.com        break;
29713043Sgabeblack@google.com      case SC_END_OF_ELABORATION:
29813043Sgabeblack@google.com        os << "SC_END_OF_ELABORATION";
29913043Sgabeblack@google.com        break;
30013043Sgabeblack@google.com      case SC_START_OF_SIMULATION:
30113043Sgabeblack@google.com        os << "SC_START_OF_SIMULATION";
30213043Sgabeblack@google.com        break;
30313043Sgabeblack@google.com      case SC_RUNNING:
30413043Sgabeblack@google.com        os << "SC_RUNNING";
30513043Sgabeblack@google.com        break;
30613043Sgabeblack@google.com      case SC_PAUSED:
30713043Sgabeblack@google.com        os << "SC_PAUSED";
30813043Sgabeblack@google.com        break;
30913043Sgabeblack@google.com      case SC_STOPPED:
31013043Sgabeblack@google.com        os << "SC_STOPPED";
31113043Sgabeblack@google.com        break;
31213043Sgabeblack@google.com      case SC_END_OF_SIMULATION:
31313043Sgabeblack@google.com        os << "SC_END_OF_SIMULATION";
31413043Sgabeblack@google.com        break;
31513043Sgabeblack@google.com
31613043Sgabeblack@google.com        // Nonstandard
31713043Sgabeblack@google.com      case SC_END_OF_INITIALIZATION:
31813043Sgabeblack@google.com        os << "SC_END_OF_INITIALIZATION";
31913043Sgabeblack@google.com        break;
32013043Sgabeblack@google.com      case SC_END_OF_UPDATE:
32113043Sgabeblack@google.com        os << "SC_END_OF_UPDATE";
32213043Sgabeblack@google.com        break;
32313043Sgabeblack@google.com      case SC_BEFORE_TIMESTEP:
32413043Sgabeblack@google.com        os << "SC_BEFORE_TIMESTEP";
32513043Sgabeblack@google.com        break;
32613043Sgabeblack@google.com
32713043Sgabeblack@google.com      default:
32813043Sgabeblack@google.com        if (s & SC_STATUS_ANY) {
32913043Sgabeblack@google.com            const char *prefix = "(";
33013043Sgabeblack@google.com            for (sc_status m = (sc_status)0x1;
33113043Sgabeblack@google.com                    m < SC_STATUS_ANY; m = (sc_status)(m << 1)) {
33213043Sgabeblack@google.com                if (m & s) {
33313043Sgabeblack@google.com                    os << prefix;
33413043Sgabeblack@google.com                    prefix = "|";
33513043Sgabeblack@google.com                    os << m;
33613043Sgabeblack@google.com                }
33713043Sgabeblack@google.com            }
33813043Sgabeblack@google.com            os << ")";
33913043Sgabeblack@google.com        } else {
34013043Sgabeblack@google.com            ccprintf(os, "%#x", s);
34113043Sgabeblack@google.com        }
34213043Sgabeblack@google.com    }
34313043Sgabeblack@google.com
34413043Sgabeblack@google.com    return os;
34513043Sgabeblack@google.com}
34613043Sgabeblack@google.com
34712837Sgabeblack@google.com} // namespace sc_core
348