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 "systemc/core/process.hh"
31#include "systemc/core/scheduler.hh"
32#include "systemc/ext/core/messages.hh"
33#include "systemc/ext/core/sc_main.hh"
34#include "systemc/ext/core/sc_process_handle.hh"
35#include "systemc/ext/utils/sc_report_handler.hh"
36
37namespace sc_core
38{
39
40const char *
41sc_unwind_exception::what() const throw()
42{
43    return _isReset ? "RESET" : "KILL";
44}
45
46bool
47sc_unwind_exception::is_reset() const
48{
49    return _isReset;
50}
51
52sc_unwind_exception::sc_unwind_exception() : _isReset(false) {}
53sc_unwind_exception::sc_unwind_exception(const sc_unwind_exception &e) :
54    _isReset(e._isReset)
55{}
56sc_unwind_exception::~sc_unwind_exception() throw() {}
57
58
59void
60sc_set_location(const char *file, int lineno)
61{
62    sc_process_b *current = ::sc_gem5::scheduler.current();
63    if (!current)
64        return;
65    current->file = file;
66    current->lineno = lineno;
67}
68
69
70sc_process_b *
71sc_get_curr_process_handle()
72{
73    return ::sc_gem5::scheduler.current();
74}
75
76
77sc_process_handle::sc_process_handle() : _gem5_process(nullptr) {}
78
79sc_process_handle::sc_process_handle(const sc_process_handle &handle) :
80    _gem5_process(handle._gem5_process)
81{
82    if (_gem5_process)
83        _gem5_process->incref();
84}
85
86sc_process_handle::sc_process_handle(sc_object *obj) :
87    _gem5_process(dynamic_cast<::sc_gem5::Process *>(obj))
88{
89    if (_gem5_process)
90        _gem5_process->incref();
91}
92
93sc_process_handle::~sc_process_handle()
94{
95    if (_gem5_process)
96        _gem5_process->decref();
97}
98
99
100bool
101sc_process_handle::valid() const
102{
103    return _gem5_process != nullptr;
104}
105
106
107sc_process_handle &
108sc_process_handle::operator = (const sc_process_handle &handle)
109{
110    if (_gem5_process)
111        _gem5_process->decref();
112    _gem5_process = handle._gem5_process;
113    if (_gem5_process)
114        _gem5_process->incref();
115    return *this;
116}
117
118bool
119sc_process_handle::operator == (const sc_process_handle &handle) const
120{
121    return _gem5_process && handle._gem5_process &&
122        (_gem5_process == handle._gem5_process);
123}
124
125bool
126sc_process_handle::operator != (const sc_process_handle &handle) const
127{
128    return !(handle == *this);
129}
130
131bool
132sc_process_handle::operator < (const sc_process_handle &other) const
133{
134    return _gem5_process < other._gem5_process;
135}
136
137void
138sc_process_handle::swap(sc_process_handle &handle)
139{
140    ::sc_gem5::Process *temp = handle._gem5_process;
141    handle._gem5_process = _gem5_process;
142    _gem5_process = temp;
143}
144
145
146const char *
147sc_process_handle::name() const
148{
149    return _gem5_process ? _gem5_process->name() : "";
150}
151
152sc_curr_proc_kind
153sc_process_handle::proc_kind() const
154{
155    return _gem5_process ? _gem5_process->procKind() : SC_NO_PROC_;
156}
157
158const std::vector<sc_object *> &
159sc_process_handle::get_child_objects() const
160{
161    static const std::vector<sc_object *> empty;
162    return _gem5_process ? _gem5_process->get_child_objects() : empty;
163}
164
165const std::vector<sc_event *> &
166sc_process_handle::get_child_events() const
167{
168    static const std::vector<sc_event *> empty;
169    return _gem5_process ? _gem5_process->get_child_events() : empty;
170}
171
172sc_object *
173sc_process_handle::get_parent_object() const
174{
175    return _gem5_process ? _gem5_process->get_parent_object() : nullptr;
176}
177
178sc_object *
179sc_process_handle::get_process_object() const
180{
181    return _gem5_process;
182}
183
184bool
185sc_process_handle::dynamic() const
186{
187    return _gem5_process ? _gem5_process->dynamic() : false;
188}
189
190bool
191sc_process_handle::terminated() const
192{
193    return _gem5_process ? _gem5_process->terminated() : false;
194}
195
196const sc_event &
197sc_process_handle::terminated_event() const
198{
199    if (!_gem5_process) {
200        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "terminated_event()");
201        static sc_gem5::InternalScEvent non_event;
202        return non_event;
203    }
204    return _gem5_process->terminatedEvent();
205}
206
207
208void
209sc_process_handle::suspend(sc_descendent_inclusion_info include_descendants)
210{
211    if (!_gem5_process) {
212        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "suspend()");
213        return;
214    }
215    _gem5_process->suspend(include_descendants == SC_INCLUDE_DESCENDANTS);
216}
217
218void
219sc_process_handle::resume(sc_descendent_inclusion_info include_descendants)
220{
221    if (!_gem5_process) {
222        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "resume()");
223        return;
224    }
225    _gem5_process->resume(include_descendants == SC_INCLUDE_DESCENDANTS);
226}
227
228void
229sc_process_handle::disable(sc_descendent_inclusion_info include_descendants)
230{
231    if (!_gem5_process) {
232        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "disable()");
233        return;
234    }
235    _gem5_process->disable(include_descendants == SC_INCLUDE_DESCENDANTS);
236}
237
238void
239sc_process_handle::enable(sc_descendent_inclusion_info include_descendants)
240{
241    if (!_gem5_process) {
242        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "enable()");
243        return;
244    }
245    _gem5_process->enable(include_descendants == SC_INCLUDE_DESCENDANTS);
246}
247
248void
249sc_process_handle::kill(sc_descendent_inclusion_info include_descendants)
250{
251    if (!_gem5_process) {
252        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "kill()");
253        return;
254    }
255    _gem5_process->kill(include_descendants == SC_INCLUDE_DESCENDANTS);
256}
257
258void
259sc_process_handle::reset(sc_descendent_inclusion_info include_descendants)
260{
261    if (!_gem5_process) {
262        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "reset()");
263        return;
264    }
265    _gem5_process->reset(include_descendants == SC_INCLUDE_DESCENDANTS);
266}
267
268bool
269sc_process_handle::is_unwinding()
270{
271    if (!_gem5_process) {
272        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "is_unwinding()");
273        return false;
274    }
275    return _gem5_process->isUnwinding();
276}
277
278const sc_event &
279sc_process_handle::reset_event() const
280{
281    if (!_gem5_process) {
282        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "reset()");
283        static sc_gem5::InternalScEvent non_event;
284        return non_event;
285    }
286    return _gem5_process->resetEvent();
287}
288
289
290void
291sc_process_handle::sync_reset_on(
292        sc_descendent_inclusion_info include_descendants)
293{
294    if (!_gem5_process) {
295        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "sync_reset_on()");
296        return;
297    }
298    _gem5_process->syncResetOn(include_descendants == SC_INCLUDE_DESCENDANTS);
299}
300
301void
302sc_process_handle::sync_reset_off(
303        sc_descendent_inclusion_info include_descendants)
304{
305    if (!_gem5_process) {
306        SC_REPORT_WARNING(SC_ID_EMPTY_PROCESS_HANDLE_, "sync_reset_off()");
307        return;
308    }
309    _gem5_process->syncResetOff(include_descendants == SC_INCLUDE_DESCENDANTS);
310}
311
312
313sc_process_handle
314sc_get_current_process_handle()
315{
316    if (sc_is_running())
317        return sc_process_handle(::sc_gem5::scheduler.current());
318    else
319        return sc_process_handle(::sc_gem5::Process::newest());
320}
321
322bool
323sc_is_unwinding()
324{
325    return sc_get_current_process_handle().is_unwinding();
326}
327
328bool sc_allow_process_control_corners;
329
330} // namespace sc_core
331