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/module.hh"
34#include "systemc/core/scheduler.hh"
35
36namespace sc_gem5
37{
38
39namespace
40{
41
42bool stopAfterCallbacks = false;
43bool startComplete = false;
44bool endComplete = false;
45
46sc_core::sc_status _status = sc_core::SC_ELABORATION;
47
48} // anonymous namespace
49
50bool Kernel::startOfSimulationComplete() { return startComplete; }
51bool Kernel::endOfSimulationComplete() { return endComplete; }
52
53sc_core::sc_status Kernel::status() { return _status; }
54void Kernel::status(sc_core::sc_status s) { _status = s; }
55
56Kernel::Kernel(Params *params) :
57 SimObject(params), t0Event(this, false, EventBase::Default_Pri - 1)
58{
59 // Install ourselves as the scheduler's event manager.
60 ::sc_gem5::scheduler.setEventQueue(eventQueue());
61}
62
63void
64Kernel::init()
65{
66 status(::sc_core::SC_BEFORE_END_OF_ELABORATION);
67 for (auto m: sc_gem5::allModules) {
68 callbackModule(m);
69 m->sc_mod()->before_end_of_elaboration();
70 }
71 callbackModule(nullptr);
72
73 if (stopAfterCallbacks)
74 stopWork();
75}
76
77void
78Kernel::regStats()
79{
80 for (auto m: sc_gem5::allModules)
81 for (auto p: m->ports)
82 p->_gem5Finalize();
83
84 status(::sc_core::SC_END_OF_ELABORATION);
85 for (auto m: sc_gem5::allModules)
86 m->sc_mod()->end_of_elaboration();
87
88 if (stopAfterCallbacks)
89 stopWork();
90}
91
92void
93Kernel::startup()
94{
95 status(::sc_core::SC_START_OF_SIMULATION);
96 for (auto m: sc_gem5::allModules)
97 m->sc_mod()->start_of_simulation();
98
99 startComplete = true;
100
101 if (stopAfterCallbacks)
102 stopWork();
103
104 kernel->status(::sc_core::SC_RUNNING);
105
106 schedule(t0Event, curTick());
107 // Run update once before the event queue starts.
108 ::sc_gem5::scheduler.update();
109}
110
111void
112Kernel::stop()
113{
114 if (status() < ::sc_core::SC_RUNNING)
115 stopAfterCallbacks = true;
116 else
117 stopWork();
118}
119
120void
121Kernel::stopWork()
122{
123 status(::sc_core::SC_END_OF_SIMULATION);
124 for (auto m: sc_gem5::allModules)
125 m->sc_mod()->end_of_simulation();
126
127 endComplete = true;
128
129 status(::sc_core::SC_STOPPED);
130
131 if (stopAfterCallbacks)
132 fatal("Simulation called sc_stop during elaboration.\n");
133}
134
135void
136Kernel::t0Handler()
137{
138 // Now that the event queue has started, mark all the processes that
139 // need to be initialized as ready to run.
140 //
141 // This event has greater priority than delta notifications and so will
142 // happen before them, honoring the ordering for the initialization phase
143 // in the spec. The delta phase will happen at normal priority, and then
144 // the event which runs the processes which is at a lower priority.
145 ::sc_gem5::scheduler.prepareForInit();
146
147 status(::sc_core::SC_RUNNING);
148}
149
150Kernel *kernel;
151
152} // namespace sc_gem5
153
154sc_gem5::Kernel *
155SystemC_KernelParams::create()
156{
157 panic_if(sc_gem5::kernel,
158 "Only one systemc kernel object may be defined.\n");
159 sc_gem5::kernel = new sc_gem5::Kernel(this);
160 return sc_gem5::kernel;
161}