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