sc_main.cc revision 13083 
1/*
2 * Copyright 2018 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Authors: Gabe Black
28 */
29
30#include <cstring>
31#include <string>
32
33#include "base/fiber.hh"
34#include "base/logging.hh"
35#include "base/types.hh"
36#include "sim/core.hh"
37#include "sim/eventq.hh"
38#include "sim/init.hh"
39#include "systemc/core/kernel.hh"
40#include "systemc/core/python.hh"
41#include "systemc/core/scheduler.hh"
42#include "systemc/ext/core/sc_main.hh"
43#include "systemc/ext/utils/sc_report_handler.hh"
44
45// A weak symbol to detect if sc_main has been defined, and if so where it is.
46[[gnu::weak]] int sc_main(int argc, char *argv[]);
47
48namespace sc_core
49{
50
51namespace
52{
53
54bool scMainCalled = false;
55
56int _argc = 0;
57char **_argv = NULL;
58
59class ScMainFiber : public Fiber
60{
61  public:
62    std::string resultStr;
63    int resultInt;
64
65    ScMainFiber() : resultInt(1) {}
66
67    void
68    main()
69    {
70        if (::sc_main) {
71            try {
72                resultInt = ::sc_main(_argc, _argv);
73                if (resultInt)
74                    resultStr = "sc_main returned non-zero";
75                else
76                    resultStr = "sc_main finished";
77                // Make sure no systemc events/notifications are scheduled
78                // after sc_main returns.
79            } catch (const sc_report &r) {
80                // There was an exception nobody caught.
81                resultStr = r.what();
82            }
83            ::sc_gem5::Kernel::scMainFinished(true);
84            ::sc_gem5::scheduler.clear();
85        } else {
86            // If python tries to call sc_main but no sc_main was defined...
87            fatal("sc_main called but not defined.\n");
88        }
89    }
90};
91
92ScMainFiber scMainFiber;
93
94// This wrapper adapts the python version of sc_main to the c++ version.
95void
96sc_main(pybind11::args args)
97{
98    panic_if(scMainCalled, "sc_main called more than once.");
99
100    _argc = args.size();
101    _argv = new char *[_argc];
102
103    // Initialize all the _argvs to NULL so we can delete [] them
104    // unconditionally.
105    for (int idx = 0; idx < _argc; idx++)
106        _argv[idx] = NULL;
107
108    // Attempt to convert all the arguments to strings. If that fails, clean
109    // up after ourselves. Also don't count this as a call to sc_main since
110    // we never got to the c++ version of that function.
111    try {
112        for (int idx = 0; idx < _argc; idx++) {
113            std::string arg = args[idx].cast<std::string>();
114            _argv[idx] = new char[arg.length() + 1];
115            strcpy(_argv[idx], arg.c_str());
116        }
117    } catch (...) {
118        // If that didn't work for some reason (probably a conversion error)
119        // blow away _argv and _argc and pass on the exception.
120        for (int idx = 0; idx < _argc; idx++)
121            delete [] _argv[idx];
122        delete [] _argv;
123        _argc = 0;
124        throw;
125    }
126
127    // At this point we're going to call the c++ sc_main, so we can't try
128    // again later.
129    scMainCalled = true;
130
131    scMainFiber.run();
132}
133
134int
135sc_main_result_code()
136{
137    return scMainFiber.resultInt;
138}
139
140std::string
141sc_main_result_str()
142{
143    return scMainFiber.resultStr;
144}
145
146// Make our sc_main wrapper available in the internal _m5 python module under
147// the systemc submodule.
148
149struct InstallScMain : public ::sc_gem5::PythonInitFunc
150{
151    void
152    run(pybind11::module &systemc) override
153    {
154        systemc.def("sc_main", &sc_main);
155        systemc.def("sc_main_result_code", &sc_main_result_code);
156        systemc.def("sc_main_result_str", &sc_main_result_str);
157    }
158} installScMain;
159
160sc_stop_mode _stop_mode = SC_STOP_FINISH_DELTA;
161
162} // anonymous namespace
163
164int
165sc_argc()
166{
167    return _argc;
168}
169
170const char *const *
171sc_argv()
172{
173    return _argv;
174}
175
176void
177sc_start()
178{
179    Tick now = ::sc_gem5::scheduler.getCurTick();
180    sc_start(sc_time::from_value(MaxTick - now), SC_EXIT_ON_STARVATION);
181}
182
183void
184sc_pause()
185{
186    if (::sc_gem5::Kernel::status() == SC_RUNNING)
187        ::sc_gem5::scheduler.schedulePause();
188}
189
190void
191sc_start(const sc_time &time, sc_starvation_policy p)
192{
193    if (time.value() == 0) {
194        ::sc_gem5::scheduler.oneCycle();
195    } else {
196        Tick now = ::sc_gem5::scheduler.getCurTick();
197        ::sc_gem5::scheduler.start(now + time.value(), p == SC_RUN_TO_TIME);
198    }
199}
200
201void
202sc_set_stop_mode(sc_stop_mode mode)
203{
204    if (sc_is_running()) {
205        SC_REPORT_ERROR("attempt to set sc_stop mode "
206                        "after start will be ignored", "");
207        return;
208    }
209    _stop_mode = mode;
210}
211
212sc_stop_mode
213sc_get_stop_mode()
214{
215    return _stop_mode;
216}
217
218void
219sc_stop()
220{
221    if (::sc_gem5::Kernel::status() == SC_STOPPED)
222        return;
223
224    if (sc_is_running()) {
225        bool finish_delta = (_stop_mode == SC_STOP_FINISH_DELTA);
226        ::sc_gem5::scheduler.scheduleStop(finish_delta);
227    } else {
228        ::sc_gem5::Kernel::stop();
229    }
230}
231
232const sc_time &
233sc_time_stamp()
234{
235    static sc_time tstamp;
236    Tick tick = ::sc_gem5::scheduler.getCurTick();
237    //XXX We're assuming the systemc time resolution is in ps.
238    // If tick is zero, the time scale may not be fixed yet, and
239    // SimClock::Int::ps may be zero.
240    tstamp = sc_time::from_value(tick ? tick / SimClock::Int::ps : 0);
241    return tstamp;
242}
243
244sc_dt::uint64
245sc_delta_count()
246{
247    return sc_gem5::scheduler.numCycles();
248}
249
250bool
251sc_is_running()
252{
253    return sc_get_status() & (SC_RUNNING | SC_PAUSED);
254}
255
256bool
257sc_pending_activity_at_current_time()
258{
259    return ::sc_gem5::scheduler.pendingCurr();
260}
261
262bool
263sc_pending_activity_at_future_time()
264{
265    return ::sc_gem5::scheduler.pendingFuture();
266}
267
268bool
269sc_pending_activity()
270{
271    return sc_pending_activity_at_current_time() ||
272           sc_pending_activity_at_future_time();
273}
274
275sc_time
276sc_time_to_pending_activity()
277{
278    return sc_time::from_value(::sc_gem5::scheduler.timeToPending());
279}
280
281sc_status
282sc_get_status()
283{
284    return ::sc_gem5::kernel ? ::sc_gem5::kernel->status() : SC_ELABORATION;
285}
286
287std::ostream &
288operator << (std::ostream &os, sc_status s)
289{
290    switch (s) {
291      case SC_ELABORATION:
292        os << "SC_ELABORATION";
293        break;
294      case SC_BEFORE_END_OF_ELABORATION:
295        os << "SC_BEFORE_END_OF_ELABORATION";
296        break;
297      case SC_END_OF_ELABORATION:
298        os << "SC_END_OF_ELABORATION";
299        break;
300      case SC_START_OF_SIMULATION:
301        os << "SC_START_OF_SIMULATION";
302        break;
303      case SC_RUNNING:
304        os << "SC_RUNNING";
305        break;
306      case SC_PAUSED:
307        os << "SC_PAUSED";
308        break;
309      case SC_STOPPED:
310        os << "SC_STOPPED";
311        break;
312      case SC_END_OF_SIMULATION:
313        os << "SC_END_OF_SIMULATION";
314        break;
315
316        // Nonstandard
317      case SC_END_OF_INITIALIZATION:
318        os << "SC_END_OF_INITIALIZATION";
319        break;
320      case SC_END_OF_UPDATE:
321        os << "SC_END_OF_UPDATE";
322        break;
323      case SC_BEFORE_TIMESTEP:
324        os << "SC_BEFORE_TIMESTEP";
325        break;
326
327      default:
328        if (s & SC_STATUS_ANY) {
329            const char *prefix = "(";
330            for (sc_status m = (sc_status)0x1;
331                    m < SC_STATUS_ANY; m = (sc_status)(m << 1)) {
332                if (m & s) {
333                    os << prefix;
334                    prefix = "|";
335                    os << m;
336                }
337            }
338            os << ")";
339        } else {
340            ccprintf(os, "%#x", s);
341        }
342    }
343
344    return os;
345}
346
347} // namespace sc_core
348