sc_process_handle.cc revision 13128:60311a75e876 
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#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    warn("%s not implemented.\n", __PRETTY_FUNCTION__);
74    return nullptr;
75}
76
77
78sc_process_handle::sc_process_handle() : _gem5_process(nullptr) {}
79
80sc_process_handle::sc_process_handle(const sc_process_handle &handle) :
81    _gem5_process(handle._gem5_process)
82{
83    if (_gem5_process)
84        _gem5_process->incref();
85}
86
87sc_process_handle::sc_process_handle(sc_object *obj) :
88    _gem5_process(dynamic_cast<::sc_gem5::Process *>(obj))
89{
90    if (_gem5_process)
91        _gem5_process->incref();
92}
93
94sc_process_handle::~sc_process_handle()
95{
96    if (_gem5_process)
97        _gem5_process->decref();
98}
99
100
101bool
102sc_process_handle::valid() const
103{
104    return _gem5_process != nullptr;
105}
106
107
108sc_process_handle &
109sc_process_handle::operator = (const sc_process_handle &handle)
110{
111    if (_gem5_process)
112        _gem5_process->decref();
113    _gem5_process = handle._gem5_process;
114    if (_gem5_process)
115        _gem5_process->incref();
116    return *this;
117}
118
119bool
120sc_process_handle::operator == (const sc_process_handle &handle) const
121{
122    return _gem5_process && handle._gem5_process &&
123        (_gem5_process == handle._gem5_process);
124}
125
126bool
127sc_process_handle::operator != (const sc_process_handle &handle) const
128{
129    return !(handle == *this);
130}
131
132bool
133sc_process_handle::operator < (const sc_process_handle &other) const
134{
135    return _gem5_process < other._gem5_process;
136}
137
138void
139sc_process_handle::swap(sc_process_handle &handle)
140{
141    ::sc_gem5::Process *temp = handle._gem5_process;
142    handle._gem5_process = _gem5_process;
143    _gem5_process = temp;
144}
145
146
147const char *
148sc_process_handle::name() const
149{
150    return _gem5_process ? _gem5_process->name() : "";
151}
152
153sc_curr_proc_kind
154sc_process_handle::proc_kind() const
155{
156    return _gem5_process ? _gem5_process->procKind() : SC_NO_PROC_;
157}
158
159const std::vector<sc_object *> &
160sc_process_handle::get_child_objects() const
161{
162    static const std::vector<sc_object *> empty;
163    return _gem5_process ? _gem5_process->get_child_objects() : empty;
164}
165
166const std::vector<sc_event *> &
167sc_process_handle::get_child_events() const
168{
169    static const std::vector<sc_event *> empty;
170    return _gem5_process ? _gem5_process->get_child_events() : empty;
171}
172
173sc_object *
174sc_process_handle::get_parent_object() const
175{
176    return _gem5_process ? _gem5_process->get_parent_object() : nullptr;
177}
178
179sc_object *
180sc_process_handle::get_process_object() const
181{
182    return _gem5_process;
183}
184
185bool
186sc_process_handle::dynamic() const
187{
188    return _gem5_process ? _gem5_process->dynamic() : false;
189}
190
191bool
192sc_process_handle::terminated() const
193{
194    return _gem5_process ? _gem5_process->terminated() : false;
195}
196
197const sc_event &
198sc_process_handle::terminated_event() const
199{
200    if (!_gem5_process) {
201        SC_REPORT_WARNING("(W570) attempt to use an empty "
202                "process handle ignored", "terminated_event()");
203        static sc_event non_event;
204        return non_event;
205    }
206    return _gem5_process->terminatedEvent();
207}
208
209
210void
211sc_process_handle::suspend(sc_descendent_inclusion_info include_descendants)
212{
213    if (!_gem5_process) {
214        SC_REPORT_WARNING("(W570) attempt to use an empty "
215                "process handle ignored", "suspend()");
216        return;
217    }
218    _gem5_process->suspend(include_descendants == SC_INCLUDE_DESCENDANTS);
219}
220
221void
222sc_process_handle::resume(sc_descendent_inclusion_info include_descendants)
223{
224    if (!_gem5_process) {
225        SC_REPORT_WARNING("(W570) attempt to use an empty "
226                "process handle ignored", "resume()");
227        return;
228    }
229    _gem5_process->resume(include_descendants == SC_INCLUDE_DESCENDANTS);
230}
231
232void
233sc_process_handle::disable(sc_descendent_inclusion_info include_descendants)
234{
235    if (!_gem5_process) {
236        SC_REPORT_WARNING("(W570) attempt to use an empty "
237                "process handle ignored", "disable()");
238        return;
239    }
240    _gem5_process->disable(include_descendants == SC_INCLUDE_DESCENDANTS);
241}
242
243void
244sc_process_handle::enable(sc_descendent_inclusion_info include_descendants)
245{
246    if (!_gem5_process) {
247        SC_REPORT_WARNING("(W570) attempt to use an empty "
248                "process handle ignored", "enable()");
249        return;
250    }
251    _gem5_process->enable(include_descendants == SC_INCLUDE_DESCENDANTS);
252}
253
254void
255sc_process_handle::kill(sc_descendent_inclusion_info include_descendants)
256{
257    if (!_gem5_process) {
258        SC_REPORT_WARNING("(W570) attempt to use an empty "
259                "process handle ignored", "kill()");
260        return;
261    }
262    _gem5_process->kill(include_descendants == SC_INCLUDE_DESCENDANTS);
263}
264
265void
266sc_process_handle::reset(sc_descendent_inclusion_info include_descendants)
267{
268    if (!_gem5_process) {
269        SC_REPORT_WARNING("(W570) attempt to use an empty "
270                "process handle ignored", "reset()");
271        return;
272    }
273    _gem5_process->reset(include_descendants == SC_INCLUDE_DESCENDANTS);
274}
275
276bool
277sc_process_handle::is_unwinding()
278{
279    if (!_gem5_process) {
280        SC_REPORT_WARNING("(W570) attempt to use an empty "
281                "process handle ignored", "is_unwinding()");
282        return false;
283    }
284    return _gem5_process->isUnwinding();
285}
286
287const sc_event &
288sc_process_handle::reset_event() const
289{
290    if (!_gem5_process) {
291        SC_REPORT_WARNING("(W570) attempt to use an empty "
292                "process handle ignored", "reset()");
293        static sc_event non_event;
294        return non_event;
295    }
296    return _gem5_process->resetEvent();
297}
298
299
300void
301sc_process_handle::sync_reset_on(
302        sc_descendent_inclusion_info include_descendants)
303{
304    if (!_gem5_process) {
305        SC_REPORT_WARNING("(W570) attempt to use an empty "
306                "process handle ignored", "sync_reset_on()");
307        return;
308    }
309    _gem5_process->syncResetOn(include_descendants == SC_INCLUDE_DESCENDANTS);
310}
311
312void
313sc_process_handle::sync_reset_off(
314        sc_descendent_inclusion_info include_descendants)
315{
316    if (!_gem5_process) {
317        SC_REPORT_WARNING("(W570) attempt to use an empty "
318                "process handle ignored", "sync_reset_off()");
319        return;
320    }
321    _gem5_process->syncResetOff(include_descendants == SC_INCLUDE_DESCENDANTS);
322}
323
324
325sc_process_handle
326sc_get_current_process_handle()
327{
328    if (sc_is_running())
329        return sc_process_handle(::sc_gem5::scheduler.current());
330    else
331        return sc_process_handle(::sc_gem5::Process::newest());
332}
333
334bool
335sc_is_unwinding()
336{
337    return sc_get_current_process_handle().is_unwinding();
338}
339
340bool sc_allow_process_control_corners;
341
342} // namespace sc_core
343