kernel.cc revision 13130:e67ad27f0858 
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    if (stopAfterCallbacks)
91        stopWork();
92}
93
94void
95Kernel::regStats()
96{
97    if (scMainDone)
98        return;
99
100    for (auto m: sc_gem5::allModules)
101        for (auto p: m->ports)
102            p->_gem5Finalize();
103
104    status(::sc_core::SC_END_OF_ELABORATION);
105    for (auto m: sc_gem5::allModules) {
106        callbackModule(m);
107        m->sc_mod()->end_of_elaboration();
108        for (auto p: m->ports)
109            p->end_of_elaboration();
110        for (auto e: m->exports)
111            e->end_of_elaboration();
112    }
113    callbackModule(nullptr);
114    for (auto c: sc_gem5::allChannels)
115        c->sc_chan()->end_of_elaboration();
116
117    if (stopAfterCallbacks)
118        stopWork();
119}
120
121void
122Kernel::startup()
123{
124    if (scMainDone)
125        return;
126
127    status(::sc_core::SC_START_OF_SIMULATION);
128    for (auto m: sc_gem5::allModules) {
129        m->sc_mod()->start_of_simulation();
130        for (auto p: m->ports)
131            p->start_of_simulation();
132        for (auto e: m->exports)
133            e->start_of_simulation();
134    }
135    for (auto c: sc_gem5::allChannels)
136        c->sc_chan()->start_of_simulation();
137
138    startComplete = true;
139
140    if (stopAfterCallbacks)
141        stopWork();
142
143    kernel->status(::sc_core::SC_RUNNING);
144
145    schedule(t0Event, curTick());
146    // Run update once before the event queue starts.
147    ::sc_gem5::scheduler.update();
148}
149
150void
151Kernel::stop()
152{
153    if (status() < ::sc_core::SC_RUNNING)
154        stopAfterCallbacks = true;
155    else
156        stopWork();
157}
158
159void
160Kernel::stopWork()
161{
162    status(::sc_core::SC_END_OF_SIMULATION);
163    for (auto m: sc_gem5::allModules) {
164        m->sc_mod()->end_of_simulation();
165        for (auto p: m->ports)
166            p->end_of_simulation();
167        for (auto e: m->exports)
168            e->end_of_simulation();
169    }
170    for (auto c: sc_gem5::allChannels)
171        c->sc_chan()->end_of_simulation();
172
173    endComplete = true;
174
175    status(::sc_core::SC_STOPPED);
176}
177
178void
179Kernel::t0Handler()
180{
181    ::sc_gem5::scheduler.initPhase();
182
183    status(::sc_core::SC_RUNNING);
184}
185
186Kernel *kernel;
187
188} // namespace sc_gem5
189
190sc_gem5::Kernel *
191SystemC_KernelParams::create()
192{
193    panic_if(sc_gem5::kernel,
194            "Only one systemc kernel object may be defined.\n");
195    sc_gem5::kernel = new sc_gem5::Kernel(this);
196    return sc_gem5::kernel;
197}
198