process.hh revision 13285:86dc66ffac35 
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#ifndef __SYSTEMC_CORE_PROCESS_HH__
31#define __SYSTEMC_CORE_PROCESS_HH__
32
33#include <functional>
34#include <memory>
35#include <vector>
36
37#include "base/fiber.hh"
38#include "systemc/core/list.hh"
39#include "systemc/core/module.hh"
40#include "systemc/core/object.hh"
41#include "systemc/core/sched_event.hh"
42#include "systemc/core/sensitivity.hh"
43#include "systemc/ext/core/sc_event.hh"
44#include "systemc/ext/core/sc_module.hh"
45#include "systemc/ext/core/sc_process_handle.hh"
46
47namespace sc_core
48{
49
50class sc_join;
51
52} // namespace sc_core
53
54namespace sc_gem5
55{
56
57class ScHalt
58{};
59
60class Process : public ::sc_core::sc_process_b, public ListNode
61{
62  public:
63    virtual ::sc_core::sc_curr_proc_kind procKind() const = 0;
64    bool needsStart() const { return _needsStart; }
65    void needsStart(bool ns) { _needsStart = ns; }
66    bool dynamic() const { return _dynamic; }
67    bool isUnwinding() const { return _isUnwinding; }
68    void isUnwinding(bool v) { _isUnwinding = v; }
69    bool terminated() const { return _terminated; }
70
71    void forEachKid(const std::function<void(Process *)> &work);
72
73    bool suspended() const { return _suspended; }
74    bool disabled() const { return _disabled; }
75
76    void suspend(bool inc_kids);
77    void resume(bool inc_kids);
78    void disable(bool inc_kids);
79    void enable(bool inc_kids);
80
81    void kill(bool inc_kids);
82    void reset(bool inc_kids);
83    virtual void throw_it(ExceptionWrapperBase &exc, bool inc_kids);
84
85    void injectException(ExceptionWrapperBase &exc);
86    ExceptionWrapperBase *excWrapper;
87
88    void syncResetOn(bool inc_kids);
89    void syncResetOff(bool inc_kids);
90
91    void signalReset(bool set, bool sync);
92
93    void incref() { refCount++; }
94    void decref() { refCount--; }
95
96    const ::sc_core::sc_event &resetEvent() { return _resetEvent; }
97    const ::sc_core::sc_event &terminatedEvent() { return _terminatedEvent; }
98
99    void setStackSize(size_t size) { stackSize = size; }
100
101    void run();
102
103    void addStatic(StaticSensitivity *);
104    void setDynamic(DynamicSensitivity *);
105    void clearDynamic() { setDynamic(nullptr); }
106    void addReset(ResetSensitivity *);
107
108    ScEvent timeoutEvent;
109    void setTimeout(::sc_core::sc_time t);
110    void cancelTimeout();
111
112    void satisfySensitivity(Sensitivity *);
113
114    void ready();
115
116    virtual Fiber *fiber() { return Fiber::primaryFiber(); }
117
118    static Process *newest() { return _newest; }
119
120    void lastReport(::sc_core::sc_report *report);
121    ::sc_core::sc_report *lastReport() const;
122
123    bool hasStaticSensitivities() { return !staticSensitivities.empty(); }
124    bool internal() { return _internal; }
125    bool timedOut() { return _timedOut; }
126    bool inReset() { return _syncReset || syncResetCount || asyncResetCount; }
127
128    bool dontInitialize() { return _dontInitialize; }
129    void dontInitialize(bool di) { _dontInitialize = di; }
130
131    void joinWait(::sc_core::sc_join *join) { joinWaiters.push_back(join); }
132
133    void waitCount(int count) { _waitCount = count; }
134
135    const char *uniqueName(const char *seed) { return nameGen.gen(seed); }
136
137  protected:
138    void timeout();
139
140    Process(const char *name, ProcessFuncWrapper *func, bool internal=false);
141
142    static Process *_newest;
143
144    virtual ~Process()
145    {
146        popListNode();
147        delete func;
148        for (auto s: staticSensitivities) {
149            s->clear();
150            delete s;
151        }
152        clearDynamic();
153    }
154
155    ::sc_core::sc_event _resetEvent;
156    ::sc_core::sc_event _terminatedEvent;
157
158    ProcessFuncWrapper *func;
159    sc_core::sc_curr_proc_kind _procKind;
160
161    bool _internal;
162
163    // Needed to support the deprecated "timed_out" function.
164    bool _timedOut;
165
166    bool _dontInitialize;
167
168    bool _needsStart;
169    bool _dynamic;
170    bool _isUnwinding;
171    bool _terminated;
172
173    void terminate();
174
175    bool _suspended;
176    bool _suspendedReady;
177    bool _disabled;
178
179    bool _syncReset;
180
181    int syncResetCount;
182    int asyncResetCount;
183
184    int _waitCount;
185
186    int refCount;
187
188    size_t stackSize;
189
190    StaticSensitivities staticSensitivities;
191    DynamicSensitivity *dynamicSensitivity;
192    ResetSensitivities resetSensitivities;
193
194    std::unique_ptr<::sc_core::sc_report> _lastReport;
195
196    std::vector<::sc_core::sc_join *> joinWaiters;
197
198    UniqueNameGen nameGen;
199};
200
201} // namespace sc_gem5
202
203#endif  //__SYSTEMC_CORE_PROCESS_HH__
204