kernel.cc revision 13281
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 ::sc_gem5::scheduler.elaborationDone(true); 87} 88 89void 90Kernel::regStats() 91{ 92 if (scMainDone || stopAfterCallbacks) 93 return; 94 95 try { 96 for (auto p: allPorts) 97 p->finalize(); 98 for (auto p: allPorts) 99 p->regPort(); 100 101 status(::sc_core::SC_END_OF_ELABORATION); 102 for (auto p: allPorts) 103 p->sc_port_base()->end_of_elaboration(); 104 for (auto m: sc_gem5::allModules) 105 m->endOfElaboration(); 106 for (auto c: sc_gem5::allChannels) 107 c->sc_chan()->end_of_elaboration(); 108 } catch (...) { 109 ::sc_gem5::scheduler.throwToScMain(); 110 } 111} 112 113void 114Kernel::startup() 115{ 116 if (scMainDone) 117 return; 118 119 schedule(t0Event, curTick()); 120 121 if (stopAfterCallbacks) 122 return; 123 124 try { 125 status(::sc_core::SC_START_OF_SIMULATION); 126 for (auto p: allPorts) 127 p->sc_port_base()->start_of_simulation(); 128 for (auto m: sc_gem5::allModules) 129 m->startOfSimulation(); 130 for (auto c: sc_gem5::allChannels) 131 c->sc_chan()->start_of_simulation(); 132 } catch (...) { 133 ::sc_gem5::scheduler.throwToScMain(); 134 } 135 136 startComplete = true; 137 138 if (stopAfterCallbacks) 139 stopWork(); 140 141 kernel->status(::sc_core::SC_RUNNING); 142} 143 144void 145Kernel::stop() 146{ 147 if (status() < ::sc_core::SC_RUNNING) 148 stopAfterCallbacks = true; 149 else 150 stopWork(); 151} 152 153void 154Kernel::stopWork() 155{ 156 status(::sc_core::SC_END_OF_SIMULATION); 157 try { 158 for (auto p: allPorts) 159 p->sc_port_base()->end_of_simulation(); 160 for (auto m: sc_gem5::allModules) 161 m->endOfSimulation(); 162 for (auto c: sc_gem5::allChannels) 163 c->sc_chan()->end_of_simulation(); 164 } catch (...) { 165 ::sc_gem5::scheduler.throwToScMain(); 166 } 167 168 endComplete = true; 169 170 status(::sc_core::SC_STOPPED); 171} 172 173void 174Kernel::t0Handler() 175{ 176 if (stopAfterCallbacks) { 177 scheduler.clear(); 178 ::sc_gem5::scheduler.initPhase(); 179 scheduler.scheduleStop(false); 180 } else { 181 ::sc_gem5::scheduler.initPhase(); 182 status(::sc_core::SC_RUNNING); 183 } 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