sc_process_handle.cc revision 13087:1df34ed84a4b
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 "base/logging.hh"
31#include "systemc/core/process.hh"
32#include "systemc/core/scheduler.hh"
33#include "systemc/ext/core/sc_main.hh"
34#include "systemc/ext/core/sc_process_handle.hh"
35
36namespace sc_core
37{
38
39const char *
40sc_unwind_exception::what() const throw()
41{
42    return _isReset ? "RESET" : "KILL";
43}
44
45bool
46sc_unwind_exception::is_reset() const
47{
48    return _isReset;
49}
50
51sc_unwind_exception::sc_unwind_exception() : _isReset(false) {}
52sc_unwind_exception::sc_unwind_exception(const sc_unwind_exception &e) :
53    _isReset(e._isReset)
54{}
55sc_unwind_exception::~sc_unwind_exception() throw() {}
56
57
58void
59sc_set_location(const char *file, int lineno)
60{
61    sc_process_b *current = ::sc_gem5::scheduler.current();
62    if (!current)
63        return;
64    current->file = file;
65    current->lineno = lineno;
66}
67
68
69sc_process_b *
70sc_get_curr_process_handle()
71{
72    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
73    return nullptr;
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    static sc_event non_event;
200    return _gem5_process ? _gem5_process->terminatedEvent() : non_event;
201}
202
203
204void
205sc_process_handle::suspend(sc_descendent_inclusion_info include_descendants)
206{
207    if (!_gem5_process)
208        return;
209    _gem5_process->suspend(include_descendants == SC_INCLUDE_DESCENDANTS);
210}
211
212void
213sc_process_handle::resume(sc_descendent_inclusion_info include_descendants)
214{
215    if (!_gem5_process)
216        return;
217    _gem5_process->resume(include_descendants == SC_INCLUDE_DESCENDANTS);
218}
219
220void
221sc_process_handle::disable(sc_descendent_inclusion_info include_descendants)
222{
223    if (!_gem5_process)
224        return;
225    _gem5_process->disable(include_descendants == SC_INCLUDE_DESCENDANTS);
226}
227
228void
229sc_process_handle::enable(sc_descendent_inclusion_info include_descendants)
230{
231    if (!_gem5_process)
232        return;
233    _gem5_process->enable(include_descendants == SC_INCLUDE_DESCENDANTS);
234}
235
236void
237sc_process_handle::kill(sc_descendent_inclusion_info include_descendants)
238{
239    if (!_gem5_process)
240        return;
241    _gem5_process->kill(include_descendants == SC_INCLUDE_DESCENDANTS);
242}
243
244void
245sc_process_handle::reset(sc_descendent_inclusion_info include_descendants)
246{
247    if (!_gem5_process)
248        return;
249    _gem5_process->reset(include_descendants == SC_INCLUDE_DESCENDANTS);
250}
251
252bool
253sc_process_handle::is_unwinding()
254{
255    if (!_gem5_process) {
256        //TODO This should generate a systemc style warning if the handle is
257        //invalid.
258        return false;
259    } else {
260        return _gem5_process->isUnwinding();
261    }
262}
263
264const sc_event &
265sc_process_handle::reset_event() const
266{
267    static sc_event non_event;
268    return _gem5_process ? _gem5_process->resetEvent() : non_event;
269}
270
271
272void
273sc_process_handle::sync_reset_on(
274        sc_descendent_inclusion_info include_descendants)
275{
276    if (!_gem5_process)
277        return;
278    _gem5_process->syncResetOn(include_descendants == SC_INCLUDE_DESCENDANTS);
279}
280
281void
282sc_process_handle::sync_reset_off(
283        sc_descendent_inclusion_info include_descendants)
284{
285    if (!_gem5_process)
286        return;
287    _gem5_process->syncResetOff(include_descendants == SC_INCLUDE_DESCENDANTS);
288}
289
290
291sc_process_handle
292sc_get_current_process_handle()
293{
294    if (sc_is_running())
295        return sc_process_handle(::sc_gem5::scheduler.current());
296    else
297        return sc_process_handle(::sc_gem5::Process::newest());
298}
299
300bool
301sc_is_unwinding()
302{
303    return sc_get_current_process_handle().is_unwinding();
304}
305
306bool sc_allow_process_control_corners;
307
308} // namespace sc_core
309