kernel.cc revision 13207 
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/kernel.hh"
31
32#include "base/logging.hh"
33#include "systemc/core/channel.hh"
34#include "systemc/core/module.hh"
35#include "systemc/core/port.hh"
36#include "systemc/core/scheduler.hh"
37
38namespace sc_gem5
39{
40
41namespace
42{
43
44bool scMainDone = false;
45bool stopAfterCallbacks = false;
46bool startComplete = false;
47bool endComplete = false;
48
49sc_core::sc_status _status = sc_core::SC_ELABORATION;
50
51} // anonymous namespace
52
53bool Kernel::startOfSimulationComplete() { return startComplete; }
54bool Kernel::endOfSimulationComplete() { return endComplete; }
55
56bool Kernel::scMainFinished() { return scMainDone; }
57void Kernel::scMainFinished(bool finished) { scMainDone = finished; }
58
59sc_core::sc_status Kernel::status() { return _status; }
60void Kernel::status(sc_core::sc_status s) { _status = s; }
61
62Kernel::Kernel(Params *params) :
63    SimObject(params), t0Event(this, false, EventBase::Default_Pri - 1)
64{
65    // Install ourselves as the scheduler's event manager.
66    ::sc_gem5::scheduler.setEventQueue(eventQueue());
67}
68
69void
70Kernel::init()
71{
72    if (scMainDone)
73        return;
74
75    if (stopAfterCallbacks)
76        fatal("Simulation called sc_stop during elaboration.\n");
77
78    status(::sc_core::SC_BEFORE_END_OF_ELABORATION);
79    for (auto p: allPorts)
80        p->sc_port_base()->before_end_of_elaboration();
81    for (auto m: sc_gem5::allModules)
82        m->beforeEndOfElaboration();
83    for (auto c: sc_gem5::allChannels)
84        c->sc_chan()->before_end_of_elaboration();
85}
86
87void
88Kernel::regStats()
89{
90    if (scMainDone || stopAfterCallbacks)
91        return;
92
93    try {
94        for (auto p: allPorts)
95            p->finalize();
96
97        status(::sc_core::SC_END_OF_ELABORATION);
98        for (auto p: allPorts)
99            p->sc_port_base()->end_of_elaboration();
100        for (auto m: sc_gem5::allModules)
101            m->endOfElaboration();
102        for (auto c: sc_gem5::allChannels)
103            c->sc_chan()->end_of_elaboration();
104    } catch (...) {
105        ::sc_gem5::scheduler.throwToScMain();
106    }
107
108    ::sc_gem5::scheduler.elaborationDone(true);
109}
110
111void
112Kernel::startup()
113{
114    if (scMainDone)
115        return;
116
117    schedule(t0Event, curTick());
118
119    if (stopAfterCallbacks)
120        return;
121
122    try {
123        status(::sc_core::SC_START_OF_SIMULATION);
124        for (auto p: allPorts)
125            p->sc_port_base()->start_of_simulation();
126        for (auto m: sc_gem5::allModules)
127            m->startOfSimulation();
128        for (auto c: sc_gem5::allChannels)
129            c->sc_chan()->start_of_simulation();
130    } catch (...) {
131        ::sc_gem5::scheduler.throwToScMain();
132    }
133
134    startComplete = true;
135
136    if (stopAfterCallbacks)
137        stopWork();
138
139    kernel->status(::sc_core::SC_RUNNING);
140}
141
142void
143Kernel::stop()
144{
145    if (status() < ::sc_core::SC_RUNNING)
146        stopAfterCallbacks = true;
147    else
148        stopWork();
149}
150
151void
152Kernel::stopWork()
153{
154    status(::sc_core::SC_END_OF_SIMULATION);
155    try {
156        for (auto p: allPorts)
157            p->sc_port_base()->end_of_simulation();
158        for (auto m: sc_gem5::allModules)
159            m->endOfSimulation();
160        for (auto c: sc_gem5::allChannels)
161            c->sc_chan()->end_of_simulation();
162    } catch (...) {
163        ::sc_gem5::scheduler.throwToScMain();
164    }
165
166    endComplete = true;
167
168    status(::sc_core::SC_STOPPED);
169}
170
171void
172Kernel::t0Handler()
173{
174    if (stopAfterCallbacks) {
175        scheduler.clear();
176        ::sc_gem5::scheduler.initPhase();
177        scheduler.scheduleStop(false);
178    } else {
179        ::sc_gem5::scheduler.initPhase();
180        status(::sc_core::SC_RUNNING);
181    }
182}
183
184Kernel *kernel;
185
186} // namespace sc_gem5
187
188sc_gem5::Kernel *
189SystemC_KernelParams::create()
190{
191    panic_if(sc_gem5::kernel,
192            "Only one systemc kernel object may be defined.\n");
193    sc_gem5::kernel = new sc_gem5::Kernel(this);
194    return sc_gem5::kernel;
195}
196