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