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"
| 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/sc_main_fiber.hh"
|
41#include "systemc/core/scheduler.hh"
42#include "systemc/ext/core/messages.hh"
43#include "systemc/ext/core/sc_main.hh"
44#include "systemc/ext/utils/sc_report_handler.hh"
45#include "systemc/utils/report.hh"
46
| 42#include "systemc/core/scheduler.hh"
43#include "systemc/ext/core/messages.hh"
44#include "systemc/ext/core/sc_main.hh"
45#include "systemc/ext/utils/sc_report_handler.hh"
46#include "systemc/utils/report.hh"
47
|
47// A weak symbol to detect if sc_main has been defined, and if so where it is.
48[[gnu::weak]] int sc_main(int argc, char *argv[]);
49
| |
50namespace sc_core
51{
52
53namespace
54{
55
| 48namespace sc_core
49{
50
51namespace
52{
53
|
56bool scMainCalled = false;
57
58int _argc = 0;
59char **_argv = NULL;
60
61class ScMainFiber : public Fiber
62{
63 public:
64 std::string resultStr;
65 int resultInt;
66
67 ScMainFiber() : resultInt(1) {}
68
69 void
70 main()
71 {
72 if (::sc_main) {
73 try {
74 resultInt = ::sc_main(_argc, _argv);
75 if (resultInt)
76 resultStr = "sc_main returned non-zero";
77 else
78 resultStr = "sc_main finished";
79 // Make sure no systemc events/notifications are scheduled
80 // after sc_main returns.
81 } catch (const sc_report &r) {
82 // There was an exception nobody caught.
83 resultStr = "uncaught sc_report";
84 sc_gem5::reportHandlerProc(
85 r, sc_report_handler::get_catch_actions());
86 } catch (...) {
87 // There was some other type of exception we need to wrap.
88 resultStr = "uncaught exception";
89 sc_gem5::reportHandlerProc(
90 ::sc_gem5::reportifyException(),
91 sc_report_handler::get_catch_actions());
92 }
93 ::sc_gem5::Kernel::scMainFinished(true);
94 ::sc_gem5::scheduler.clear();
95 } else {
96 // If python tries to call sc_main but no sc_main was defined...
97 fatal("sc_main called but not defined.\n");
98 }
99 }
100};
101
102ScMainFiber scMainFiber;
103
| |
104// This wrapper adapts the python version of sc_main to the c++ version.
105void
106sc_main(pybind11::args args)
107{
| 54// This wrapper adapts the python version of sc_main to the c++ version.
55void
56sc_main(pybind11::args args)
57{
|
108 panic_if(scMainCalled, "sc_main called more than once.");
| 58 panic_if(::sc_gem5::scMainFiber.called(),
59 "sc_main called more than once.");
|
109
| 60
|
110 _argc = args.size();
111 _argv = new char *[_argc];
| 61 int argc = args.size();
62 char **argv = new char *[argc];
|
112
| 63
|
113 // Initialize all the _argvs to NULL so we can delete [] them
| 64 // Initialize all the argvs to NULL so we can delete [] them
|
114 // unconditionally.
| 65 // unconditionally.
|
115 for (int idx = 0; idx < _argc; idx++)
116 _argv[idx] = NULL;
| 66 for (int idx = 0; idx < argc; idx++)
67 argv[idx] = NULL;
|
117
118 // Attempt to convert all the arguments to strings. If that fails, clean
119 // up after ourselves. Also don't count this as a call to sc_main since
120 // we never got to the c++ version of that function.
121 try {
| 68
69 // Attempt to convert all the arguments to strings. If that fails, clean
70 // up after ourselves. Also don't count this as a call to sc_main since
71 // we never got to the c++ version of that function.
72 try {
|
122 for (int idx = 0; idx < _argc; idx++) {
| 73 for (int idx = 0; idx < argc; idx++) {
|
123 std::string arg = args[idx].cast<std::string>();
| 74 std::string arg = args[idx].cast<std::string>();
|
124 _argv[idx] = new char[arg.length() + 1];
125 strcpy(_argv[idx], arg.c_str());
| 75 argv[idx] = new char[arg.length() + 1];
76 strcpy(argv[idx], arg.c_str());
|
126 }
127 } catch (...) {
128 // If that didn't work for some reason (probably a conversion error)
| 77 }
78 } catch (...) {
79 // If that didn't work for some reason (probably a conversion error)
|
129 // blow away _argv and _argc and pass on the exception.
130 for (int idx = 0; idx < _argc; idx++)
131 delete [] _argv[idx];
132 delete [] _argv;
133 _argc = 0;
| 80 // blow away argv and argc and pass on the exception.
81 for (int idx = 0; idx < argc; idx++)
82 delete [] argv[idx];
83 delete [] argv;
84 argc = 0;
|
134 throw;
135 }
136
| 85 throw;
86 }
87
|
137 // At this point we're going to call the c++ sc_main, so we can't try
138 // again later.
139 scMainCalled = true;
140
141 scMainFiber.run();
| 88 ::sc_gem5::scMainFiber.setArgs(argc, argv);
89 ::sc_gem5::scMainFiber.run();
|
142}
143
144int
145sc_main_result_code()
146{
| 90}
91
92int
93sc_main_result_code()
94{
|
147 return scMainFiber.resultInt;
| 95 return ::sc_gem5::scMainFiber.resultInt();
|
148}
149
150std::string
151sc_main_result_str()
152{
| 96}
97
98std::string
99sc_main_result_str()
100{
|
153 return scMainFiber.resultStr;
| 101 return ::sc_gem5::scMainFiber.resultStr();
|
154}
155
156// Make our sc_main wrapper available in the internal _m5 python module under
157// the systemc submodule.
158
159struct InstallScMain : public ::sc_gem5::PythonInitFunc
160{
161 void
162 run(pybind11::module &systemc) override
163 {
164 systemc.def("sc_main", &sc_main);
165 systemc.def("sc_main_result_code", &sc_main_result_code);
166 systemc.def("sc_main_result_str", &sc_main_result_str);
167 }
168} installScMain;
169
170sc_stop_mode _stop_mode = SC_STOP_FINISH_DELTA;
171
172} // anonymous namespace
173
174int
175sc_argc()
176{
| 102}
103
104// Make our sc_main wrapper available in the internal _m5 python module under
105// the systemc submodule.
106
107struct InstallScMain : public ::sc_gem5::PythonInitFunc
108{
109 void
110 run(pybind11::module &systemc) override
111 {
112 systemc.def("sc_main", &sc_main);
113 systemc.def("sc_main_result_code", &sc_main_result_code);
114 systemc.def("sc_main_result_str", &sc_main_result_str);
115 }
116} installScMain;
117
118sc_stop_mode _stop_mode = SC_STOP_FINISH_DELTA;
119
120} // anonymous namespace
121
122int
123sc_argc()
124{
|
177 return _argc;
| 125 return ::sc_gem5::scMainFiber.argc();
|
178}
179
180const char *const *
181sc_argv()
182{
| 126}
127
128const char *const *
129sc_argv()
130{
|
183 return _argv;
| 131 return ::sc_gem5::scMainFiber.argv();
|
184}
185
186void
187sc_start()
188{
189 Tick now = ::sc_gem5::scheduler.getCurTick();
190 sc_start(sc_time::from_value(MaxTick - now), SC_EXIT_ON_STARVATION);
191}
192
193void
194sc_pause()
195{
196 if (::sc_gem5::Kernel::status() == SC_RUNNING)
197 ::sc_gem5::scheduler.schedulePause();
198}
199
200void
201sc_start(const sc_time &time, sc_starvation_policy p)
202{
203 if (time.value() == 0) {
204 ::sc_gem5::scheduler.oneCycle();
205 } else {
206 Tick now = ::sc_gem5::scheduler.getCurTick();
207 if (MaxTick - now < time.value())
208 SC_REPORT_ERROR(SC_ID_SIMULATION_TIME_OVERFLOW_, "");
209 ::sc_gem5::scheduler.start(now + time.value(), p == SC_RUN_TO_TIME);
210 }
211}
212
213void
214sc_set_stop_mode(sc_stop_mode mode)
215{
216 if (sc_is_running()) {
217 SC_REPORT_ERROR(SC_ID_STOP_MODE_AFTER_START_, "");
218 return;
219 }
220 _stop_mode = mode;
221}
222
223sc_stop_mode
224sc_get_stop_mode()
225{
226 return _stop_mode;
227}
228
229void
230sc_stop()
231{
232 static bool stop_called = false;
233 if (stop_called) {
234 static bool stop_warned = false;
235 if (!stop_warned)
236 SC_REPORT_WARNING(SC_ID_SIMULATION_STOP_CALLED_TWICE_, "");
237 stop_warned = true;
238 return;
239 }
240 stop_called = true;
241
242 if (::sc_gem5::Kernel::status() == SC_STOPPED)
243 return;
244
245 if ((sc_get_status() & SC_RUNNING)) {
246 bool finish_delta = (_stop_mode == SC_STOP_FINISH_DELTA);
247 ::sc_gem5::scheduler.scheduleStop(finish_delta);
248 } else {
249 ::sc_gem5::Kernel::stop();
250 }
251}
252
253const sc_time &
254sc_time_stamp()
255{
256 static sc_time tstamp(1.0, SC_SEC);
257 tstamp = sc_time::from_value(::sc_gem5::scheduler.getCurTick());
258 return tstamp;
259}
260
261sc_dt::uint64
262sc_delta_count()
263{
264 return sc_gem5::scheduler.numCycles();
265}
266
267bool
268sc_is_running()
269{
270 return sc_get_status() & (SC_RUNNING | SC_PAUSED);
271}
272
273bool
274sc_pending_activity_at_current_time()
275{
276 return ::sc_gem5::scheduler.pendingCurr();
277}
278
279bool
280sc_pending_activity_at_future_time()
281{
282 return ::sc_gem5::scheduler.pendingFuture();
283}
284
285bool
286sc_pending_activity()
287{
288 return sc_pending_activity_at_current_time() ||
289 sc_pending_activity_at_future_time();
290}
291
292sc_time
293sc_time_to_pending_activity()
294{
295 return sc_time::from_value(::sc_gem5::scheduler.timeToPending());
296}
297
298sc_status
299sc_get_status()
300{
301 return ::sc_gem5::kernel ? ::sc_gem5::kernel->status() : SC_ELABORATION;
302}
303
304std::ostream &
305operator << (std::ostream &os, sc_status s)
306{
307 switch (s) {
308 case SC_ELABORATION:
309 os << "SC_ELABORATION";
310 break;
311 case SC_BEFORE_END_OF_ELABORATION:
312 os << "SC_BEFORE_END_OF_ELABORATION";
313 break;
314 case SC_END_OF_ELABORATION:
315 os << "SC_END_OF_ELABORATION";
316 break;
317 case SC_START_OF_SIMULATION:
318 os << "SC_START_OF_SIMULATION";
319 break;
320 case SC_RUNNING:
321 os << "SC_RUNNING";
322 break;
323 case SC_PAUSED:
324 os << "SC_PAUSED";
325 break;
326 case SC_STOPPED:
327 os << "SC_STOPPED";
328 break;
329 case SC_END_OF_SIMULATION:
330 os << "SC_END_OF_SIMULATION";
331 break;
332
333 // Nonstandard
334 case SC_END_OF_INITIALIZATION:
335 os << "SC_END_OF_INITIALIZATION";
336 break;
337 case SC_END_OF_UPDATE:
338 os << "SC_END_OF_UPDATE";
339 break;
340 case SC_BEFORE_TIMESTEP:
341 os << "SC_BEFORE_TIMESTEP";
342 break;
343
344 default:
345 if (s & SC_STATUS_ANY) {
346 const char *prefix = "(";
347 for (sc_status m = (sc_status)0x1;
348 m < SC_STATUS_ANY; m = (sc_status)(m << 1)) {
349 if (m & s) {
350 os << prefix;
351 prefix = "|";
352 os << m;
353 }
354 }
355 os << ")";
356 } else {
357 ccprintf(os, "%#x", s);
358 }
359 }
360
361 return os;
362}
363
364} // namespace sc_core
| 132}
133
134void
135sc_start()
136{
137 Tick now = ::sc_gem5::scheduler.getCurTick();
138 sc_start(sc_time::from_value(MaxTick - now), SC_EXIT_ON_STARVATION);
139}
140
141void
142sc_pause()
143{
144 if (::sc_gem5::Kernel::status() == SC_RUNNING)
145 ::sc_gem5::scheduler.schedulePause();
146}
147
148void
149sc_start(const sc_time &time, sc_starvation_policy p)
150{
151 if (time.value() == 0) {
152 ::sc_gem5::scheduler.oneCycle();
153 } else {
154 Tick now = ::sc_gem5::scheduler.getCurTick();
155 if (MaxTick - now < time.value())
156 SC_REPORT_ERROR(SC_ID_SIMULATION_TIME_OVERFLOW_, "");
157 ::sc_gem5::scheduler.start(now + time.value(), p == SC_RUN_TO_TIME);
158 }
159}
160
161void
162sc_set_stop_mode(sc_stop_mode mode)
163{
164 if (sc_is_running()) {
165 SC_REPORT_ERROR(SC_ID_STOP_MODE_AFTER_START_, "");
166 return;
167 }
168 _stop_mode = mode;
169}
170
171sc_stop_mode
172sc_get_stop_mode()
173{
174 return _stop_mode;
175}
176
177void
178sc_stop()
179{
180 static bool stop_called = false;
181 if (stop_called) {
182 static bool stop_warned = false;
183 if (!stop_warned)
184 SC_REPORT_WARNING(SC_ID_SIMULATION_STOP_CALLED_TWICE_, "");
185 stop_warned = true;
186 return;
187 }
188 stop_called = true;
189
190 if (::sc_gem5::Kernel::status() == SC_STOPPED)
191 return;
192
193 if ((sc_get_status() & SC_RUNNING)) {
194 bool finish_delta = (_stop_mode == SC_STOP_FINISH_DELTA);
195 ::sc_gem5::scheduler.scheduleStop(finish_delta);
196 } else {
197 ::sc_gem5::Kernel::stop();
198 }
199}
200
201const sc_time &
202sc_time_stamp()
203{
204 static sc_time tstamp(1.0, SC_SEC);
205 tstamp = sc_time::from_value(::sc_gem5::scheduler.getCurTick());
206 return tstamp;
207}
208
209sc_dt::uint64
210sc_delta_count()
211{
212 return sc_gem5::scheduler.numCycles();
213}
214
215bool
216sc_is_running()
217{
218 return sc_get_status() & (SC_RUNNING | SC_PAUSED);
219}
220
221bool
222sc_pending_activity_at_current_time()
223{
224 return ::sc_gem5::scheduler.pendingCurr();
225}
226
227bool
228sc_pending_activity_at_future_time()
229{
230 return ::sc_gem5::scheduler.pendingFuture();
231}
232
233bool
234sc_pending_activity()
235{
236 return sc_pending_activity_at_current_time() ||
237 sc_pending_activity_at_future_time();
238}
239
240sc_time
241sc_time_to_pending_activity()
242{
243 return sc_time::from_value(::sc_gem5::scheduler.timeToPending());
244}
245
246sc_status
247sc_get_status()
248{
249 return ::sc_gem5::kernel ? ::sc_gem5::kernel->status() : SC_ELABORATION;
250}
251
252std::ostream &
253operator << (std::ostream &os, sc_status s)
254{
255 switch (s) {
256 case SC_ELABORATION:
257 os << "SC_ELABORATION";
258 break;
259 case SC_BEFORE_END_OF_ELABORATION:
260 os << "SC_BEFORE_END_OF_ELABORATION";
261 break;
262 case SC_END_OF_ELABORATION:
263 os << "SC_END_OF_ELABORATION";
264 break;
265 case SC_START_OF_SIMULATION:
266 os << "SC_START_OF_SIMULATION";
267 break;
268 case SC_RUNNING:
269 os << "SC_RUNNING";
270 break;
271 case SC_PAUSED:
272 os << "SC_PAUSED";
273 break;
274 case SC_STOPPED:
275 os << "SC_STOPPED";
276 break;
277 case SC_END_OF_SIMULATION:
278 os << "SC_END_OF_SIMULATION";
279 break;
280
281 // Nonstandard
282 case SC_END_OF_INITIALIZATION:
283 os << "SC_END_OF_INITIALIZATION";
284 break;
285 case SC_END_OF_UPDATE:
286 os << "SC_END_OF_UPDATE";
287 break;
288 case SC_BEFORE_TIMESTEP:
289 os << "SC_BEFORE_TIMESTEP";
290 break;
291
292 default:
293 if (s & SC_STATUS_ANY) {
294 const char *prefix = "(";
295 for (sc_status m = (sc_status)0x1;
296 m < SC_STATUS_ANY; m = (sc_status)(m << 1)) {
297 if (m & s) {
298 os << prefix;
299 prefix = "|";
300 os << m;
301 }
302 }
303 os << ")";
304 } else {
305 ccprintf(os, "%#x", s);
306 }
307 }
308
309 return os;
310}
311
312} // namespace sc_core
|