process.cc revision 12999
112952Sgabeblack@google.com/* 212952Sgabeblack@google.com * Copyright 2018 Google, Inc. 312952Sgabeblack@google.com * 412952Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512952Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612952Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712952Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812952Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912952Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012952Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112952Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212952Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312952Sgabeblack@google.com * this software without specific prior written permission. 1412952Sgabeblack@google.com * 1512952Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612952Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712952Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812952Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912952Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012952Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112952Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212952Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312952Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412952Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512952Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612952Sgabeblack@google.com * 2712952Sgabeblack@google.com * Authors: Gabe Black 2812952Sgabeblack@google.com */ 2912952Sgabeblack@google.com 3012952Sgabeblack@google.com#include "systemc/core/process.hh" 3112957Sgabeblack@google.com 3212957Sgabeblack@google.com#include "base/logging.hh" 3312957Sgabeblack@google.com#include "systemc/core/event.hh" 3412953Sgabeblack@google.com#include "systemc/core/scheduler.hh" 3512998Sgabeblack@google.com#include "systemc/ext/core/sc_process_handle.hh" 3612998Sgabeblack@google.com#include "systemc/ext/utils/sc_report_handler.hh" 3712952Sgabeblack@google.com 3812952Sgabeblack@google.comnamespace sc_gem5 3912952Sgabeblack@google.com{ 4012952Sgabeblack@google.com 4112957Sgabeblack@google.comSensitivityTimeout::SensitivityTimeout(Process *p, ::sc_core::sc_time t) : 4212962Sgabeblack@google.com Sensitivity(p), timeoutEvent(this), time(t) 4312957Sgabeblack@google.com{ 4412962Sgabeblack@google.com Tick when = scheduler.getCurTick() + time.value(); 4512962Sgabeblack@google.com scheduler.schedule(&timeoutEvent, when); 4612957Sgabeblack@google.com} 4712957Sgabeblack@google.com 4812957Sgabeblack@google.comSensitivityTimeout::~SensitivityTimeout() 4912957Sgabeblack@google.com{ 5012957Sgabeblack@google.com if (timeoutEvent.scheduled()) 5112962Sgabeblack@google.com scheduler.deschedule(&timeoutEvent); 5212962Sgabeblack@google.com} 5312962Sgabeblack@google.com 5412962Sgabeblack@google.comvoid 5512962Sgabeblack@google.comSensitivityTimeout::timeout() 5612962Sgabeblack@google.com{ 5712962Sgabeblack@google.com scheduler.eventHappened(); 5812962Sgabeblack@google.com notify(); 5912957Sgabeblack@google.com} 6012957Sgabeblack@google.com 6112957Sgabeblack@google.comSensitivityEvent::SensitivityEvent( 6212957Sgabeblack@google.com Process *p, const ::sc_core::sc_event *e) : Sensitivity(p), event(e) 6312957Sgabeblack@google.com{ 6412957Sgabeblack@google.com Event::getFromScEvent(event)->addSensitivity(this); 6512957Sgabeblack@google.com} 6612957Sgabeblack@google.com 6712957Sgabeblack@google.comSensitivityEvent::~SensitivityEvent() 6812957Sgabeblack@google.com{ 6912957Sgabeblack@google.com Event::getFromScEvent(event)->delSensitivity(this); 7012957Sgabeblack@google.com} 7112957Sgabeblack@google.com 7212957Sgabeblack@google.comSensitivityEventAndList::SensitivityEventAndList( 7312957Sgabeblack@google.com Process *p, const ::sc_core::sc_event_and_list *list) : 7412957Sgabeblack@google.com Sensitivity(p), list(list), count(0) 7512957Sgabeblack@google.com{ 7612957Sgabeblack@google.com for (auto e: list->events) 7712957Sgabeblack@google.com Event::getFromScEvent(e)->addSensitivity(this); 7812957Sgabeblack@google.com} 7912957Sgabeblack@google.com 8012957Sgabeblack@google.comSensitivityEventAndList::~SensitivityEventAndList() 8112957Sgabeblack@google.com{ 8212957Sgabeblack@google.com for (auto e: list->events) 8312957Sgabeblack@google.com Event::getFromScEvent(e)->delSensitivity(this); 8412957Sgabeblack@google.com} 8512957Sgabeblack@google.com 8612957Sgabeblack@google.comvoid 8712957Sgabeblack@google.comSensitivityEventAndList::notifyWork(Event *e) 8812957Sgabeblack@google.com{ 8912957Sgabeblack@google.com e->delSensitivity(this); 9012957Sgabeblack@google.com count++; 9112957Sgabeblack@google.com if (count == list->events.size()) 9212959Sgabeblack@google.com process->satisfySensitivity(this); 9312957Sgabeblack@google.com} 9412957Sgabeblack@google.com 9512957Sgabeblack@google.comSensitivityEventOrList::SensitivityEventOrList( 9612957Sgabeblack@google.com Process *p, const ::sc_core::sc_event_or_list *list) : 9712957Sgabeblack@google.com Sensitivity(p), list(list) 9812957Sgabeblack@google.com{ 9912957Sgabeblack@google.com for (auto e: list->events) 10012957Sgabeblack@google.com Event::getFromScEvent(e)->addSensitivity(this); 10112957Sgabeblack@google.com} 10212957Sgabeblack@google.com 10312957Sgabeblack@google.comSensitivityEventOrList::~SensitivityEventOrList() 10412957Sgabeblack@google.com{ 10512957Sgabeblack@google.com for (auto e: list->events) 10612957Sgabeblack@google.com Event::getFromScEvent(e)->delSensitivity(this); 10712957Sgabeblack@google.com} 10812957Sgabeblack@google.com 10912957Sgabeblack@google.com 11012952Sgabeblack@google.comclass UnwindExceptionReset : public ::sc_core::sc_unwind_exception 11112952Sgabeblack@google.com{ 11212952Sgabeblack@google.com public: 11312995Sgabeblack@google.com UnwindExceptionReset() { _isReset = true; } 11412952Sgabeblack@google.com}; 11512952Sgabeblack@google.com 11612952Sgabeblack@google.comclass UnwindExceptionKill : public ::sc_core::sc_unwind_exception 11712952Sgabeblack@google.com{ 11812952Sgabeblack@google.com public: 11912995Sgabeblack@google.com UnwindExceptionKill() {} 12012952Sgabeblack@google.com}; 12112952Sgabeblack@google.com 12212952Sgabeblack@google.comtemplate <typename T> 12312952Sgabeblack@google.comstruct BuiltinExceptionWrapper : public ExceptionWrapperBase 12412952Sgabeblack@google.com{ 12512952Sgabeblack@google.com public: 12612952Sgabeblack@google.com T t; 12712952Sgabeblack@google.com void throw_it() override { throw t; } 12812952Sgabeblack@google.com}; 12912952Sgabeblack@google.com 13012952Sgabeblack@google.comBuiltinExceptionWrapper<UnwindExceptionReset> resetException; 13112952Sgabeblack@google.comBuiltinExceptionWrapper<UnwindExceptionKill> killException; 13212952Sgabeblack@google.com 13312952Sgabeblack@google.com 13412952Sgabeblack@google.comvoid 13512952Sgabeblack@google.comProcess::forEachKid(const std::function<void(Process *)> &work) 13612952Sgabeblack@google.com{ 13712952Sgabeblack@google.com for (auto &kid: get_child_objects()) { 13812952Sgabeblack@google.com Process *p_kid = dynamic_cast<Process *>(kid); 13912952Sgabeblack@google.com if (p_kid) 14012952Sgabeblack@google.com work(p_kid); 14112952Sgabeblack@google.com } 14212952Sgabeblack@google.com} 14312952Sgabeblack@google.com 14412952Sgabeblack@google.comvoid 14512952Sgabeblack@google.comProcess::suspend(bool inc_kids) 14612952Sgabeblack@google.com{ 14712952Sgabeblack@google.com if (inc_kids) 14812952Sgabeblack@google.com forEachKid([](Process *p) { p->suspend(true); }); 14912952Sgabeblack@google.com 15012952Sgabeblack@google.com if (!_suspended) { 15112952Sgabeblack@google.com _suspended = true; 15212959Sgabeblack@google.com _suspendedReady = false; 15312952Sgabeblack@google.com } 15412952Sgabeblack@google.com 15512953Sgabeblack@google.com if (procKind() != ::sc_core::SC_METHOD_PROC_ && 15612953Sgabeblack@google.com scheduler.current() == this) { 15712953Sgabeblack@google.com scheduler.yield(); 15812952Sgabeblack@google.com } 15912952Sgabeblack@google.com} 16012952Sgabeblack@google.com 16112952Sgabeblack@google.comvoid 16212952Sgabeblack@google.comProcess::resume(bool inc_kids) 16312952Sgabeblack@google.com{ 16412952Sgabeblack@google.com if (inc_kids) 16512952Sgabeblack@google.com forEachKid([](Process *p) { p->resume(true); }); 16612952Sgabeblack@google.com 16712952Sgabeblack@google.com if (_suspended) { 16812952Sgabeblack@google.com _suspended = false; 16912959Sgabeblack@google.com if (_suspendedReady) 17012959Sgabeblack@google.com ready(); 17112959Sgabeblack@google.com _suspendedReady = false; 17212952Sgabeblack@google.com } 17312952Sgabeblack@google.com} 17412952Sgabeblack@google.com 17512952Sgabeblack@google.comvoid 17612952Sgabeblack@google.comProcess::disable(bool inc_kids) 17712952Sgabeblack@google.com{ 17812952Sgabeblack@google.com if (inc_kids) 17912952Sgabeblack@google.com forEachKid([](Process *p) { p->disable(true); }); 18012952Sgabeblack@google.com 18112999Sgabeblack@google.com if (!::sc_core::sc_allow_process_control_corners && 18212999Sgabeblack@google.com dynamic_cast<SensitivityTimeout *>(dynamicSensitivity)) { 18312999Sgabeblack@google.com std::string message("attempt to disable a thread with timeout wait: "); 18412999Sgabeblack@google.com message += name(); 18512999Sgabeblack@google.com SC_REPORT_ERROR("Undefined process control interaction", 18612999Sgabeblack@google.com message.c_str()); 18712999Sgabeblack@google.com } 18812999Sgabeblack@google.com 18912952Sgabeblack@google.com _disabled = true; 19012952Sgabeblack@google.com} 19112952Sgabeblack@google.com 19212952Sgabeblack@google.comvoid 19312952Sgabeblack@google.comProcess::enable(bool inc_kids) 19412952Sgabeblack@google.com{ 19512952Sgabeblack@google.com 19612952Sgabeblack@google.com if (inc_kids) 19712952Sgabeblack@google.com forEachKid([](Process *p) { p->enable(true); }); 19812952Sgabeblack@google.com 19912952Sgabeblack@google.com _disabled = false; 20012952Sgabeblack@google.com} 20112952Sgabeblack@google.com 20212952Sgabeblack@google.comvoid 20312952Sgabeblack@google.comProcess::kill(bool inc_kids) 20412952Sgabeblack@google.com{ 20512952Sgabeblack@google.com // Propogate the kill to our children no matter what happens to us. 20612952Sgabeblack@google.com if (inc_kids) 20712952Sgabeblack@google.com forEachKid([](Process *p) { p->kill(true); }); 20812952Sgabeblack@google.com 20912952Sgabeblack@google.com // If we're in the middle of unwinding, ignore the kill request. 21012952Sgabeblack@google.com if (_isUnwinding) 21112952Sgabeblack@google.com return; 21212952Sgabeblack@google.com 21312995Sgabeblack@google.com // Update our state. 21412998Sgabeblack@google.com terminate(); 21512995Sgabeblack@google.com _isUnwinding = true; 21612995Sgabeblack@google.com 21712998Sgabeblack@google.com // Make sure this process isn't marked ready 21812998Sgabeblack@google.com popListNode(); 21912998Sgabeblack@google.com 22012998Sgabeblack@google.com // Inject the kill exception into this process if it's started. 22112998Sgabeblack@google.com if (!_needsStart) 22212998Sgabeblack@google.com injectException(killException); 22312952Sgabeblack@google.com 22412952Sgabeblack@google.com _terminatedEvent.notify(); 22512952Sgabeblack@google.com} 22612952Sgabeblack@google.com 22712952Sgabeblack@google.comvoid 22812952Sgabeblack@google.comProcess::reset(bool inc_kids) 22912952Sgabeblack@google.com{ 23012952Sgabeblack@google.com // Propogate the reset to our children no matter what happens to us. 23112952Sgabeblack@google.com if (inc_kids) 23212952Sgabeblack@google.com forEachKid([](Process *p) { p->reset(true); }); 23312952Sgabeblack@google.com 23412952Sgabeblack@google.com // If we're in the middle of unwinding, ignore the reset request. 23512952Sgabeblack@google.com if (_isUnwinding) 23612952Sgabeblack@google.com return; 23712952Sgabeblack@google.com 23812995Sgabeblack@google.com 23912998Sgabeblack@google.com if (_needsStart) { 24012998Sgabeblack@google.com scheduler.runNow(this); 24112998Sgabeblack@google.com } else { 24212998Sgabeblack@google.com _isUnwinding = true; 24312998Sgabeblack@google.com injectException(resetException); 24412998Sgabeblack@google.com } 24512952Sgabeblack@google.com 24612952Sgabeblack@google.com _resetEvent.notify(); 24712952Sgabeblack@google.com} 24812952Sgabeblack@google.com 24912952Sgabeblack@google.comvoid 25012952Sgabeblack@google.comProcess::throw_it(ExceptionWrapperBase &exc, bool inc_kids) 25112952Sgabeblack@google.com{ 25212952Sgabeblack@google.com if (inc_kids) 25312952Sgabeblack@google.com forEachKid([&exc](Process *p) { p->throw_it(exc, true); }); 25412998Sgabeblack@google.com 25512998Sgabeblack@google.com // Only inject an exception into threads that have started. 25612998Sgabeblack@google.com if (!_needsStart) 25712998Sgabeblack@google.com injectException(exc); 25812952Sgabeblack@google.com} 25912952Sgabeblack@google.com 26012952Sgabeblack@google.comvoid 26112952Sgabeblack@google.comProcess::injectException(ExceptionWrapperBase &exc) 26212952Sgabeblack@google.com{ 26312952Sgabeblack@google.com excWrapper = &exc; 26412995Sgabeblack@google.com scheduler.runNow(this); 26512952Sgabeblack@google.com}; 26612952Sgabeblack@google.com 26712952Sgabeblack@google.comvoid 26812952Sgabeblack@google.comProcess::syncResetOn(bool inc_kids) 26912952Sgabeblack@google.com{ 27012952Sgabeblack@google.com if (inc_kids) 27112952Sgabeblack@google.com forEachKid([](Process *p) { p->syncResetOn(true); }); 27212952Sgabeblack@google.com 27312952Sgabeblack@google.com _syncReset = true; 27412952Sgabeblack@google.com} 27512952Sgabeblack@google.com 27612952Sgabeblack@google.comvoid 27712952Sgabeblack@google.comProcess::syncResetOff(bool inc_kids) 27812952Sgabeblack@google.com{ 27912952Sgabeblack@google.com if (inc_kids) 28012952Sgabeblack@google.com forEachKid([](Process *p) { p->syncResetOff(true); }); 28112952Sgabeblack@google.com 28212952Sgabeblack@google.com _syncReset = false; 28312952Sgabeblack@google.com} 28412952Sgabeblack@google.com 28512952Sgabeblack@google.comvoid 28612957Sgabeblack@google.comProcess::dontInitialize() 28712957Sgabeblack@google.com{ 28812957Sgabeblack@google.com scheduler.dontInitialize(this); 28912957Sgabeblack@google.com} 29012957Sgabeblack@google.com 29112957Sgabeblack@google.comvoid 29212957Sgabeblack@google.comProcess::finalize() 29312957Sgabeblack@google.com{ 29412957Sgabeblack@google.com for (auto &s: pendingStaticSensitivities) { 29512957Sgabeblack@google.com s->finalize(staticSensitivities); 29612957Sgabeblack@google.com delete s; 29712957Sgabeblack@google.com s = nullptr; 29812957Sgabeblack@google.com } 29912957Sgabeblack@google.com pendingStaticSensitivities.clear(); 30012957Sgabeblack@google.com}; 30112957Sgabeblack@google.com 30212957Sgabeblack@google.comvoid 30312953Sgabeblack@google.comProcess::run() 30412952Sgabeblack@google.com{ 30512953Sgabeblack@google.com bool reset; 30612953Sgabeblack@google.com do { 30712953Sgabeblack@google.com reset = false; 30812953Sgabeblack@google.com try { 30912953Sgabeblack@google.com func->call(); 31012995Sgabeblack@google.com } catch(const ::sc_core::sc_unwind_exception &exc) { 31112953Sgabeblack@google.com reset = exc.is_reset(); 31212995Sgabeblack@google.com _isUnwinding = false; 31312953Sgabeblack@google.com } 31412953Sgabeblack@google.com } while (reset); 31512953Sgabeblack@google.com} 31612952Sgabeblack@google.com 31712957Sgabeblack@google.comvoid 31812957Sgabeblack@google.comProcess::addStatic(PendingSensitivity *s) 31912957Sgabeblack@google.com{ 32012957Sgabeblack@google.com pendingStaticSensitivities.push_back(s); 32112957Sgabeblack@google.com} 32212957Sgabeblack@google.com 32312957Sgabeblack@google.comvoid 32412957Sgabeblack@google.comProcess::setDynamic(Sensitivity *s) 32512957Sgabeblack@google.com{ 32612957Sgabeblack@google.com delete dynamicSensitivity; 32712957Sgabeblack@google.com dynamicSensitivity = s; 32812957Sgabeblack@google.com} 32912957Sgabeblack@google.com 33012959Sgabeblack@google.comvoid 33112959Sgabeblack@google.comProcess::satisfySensitivity(Sensitivity *s) 33212959Sgabeblack@google.com{ 33312959Sgabeblack@google.com // If there's a dynamic sensitivity and this wasn't it, ignore. 33412959Sgabeblack@google.com if (dynamicSensitivity && dynamicSensitivity != s) 33512959Sgabeblack@google.com return; 33612959Sgabeblack@google.com 33712959Sgabeblack@google.com setDynamic(nullptr); 33812959Sgabeblack@google.com ready(); 33912959Sgabeblack@google.com} 34012959Sgabeblack@google.com 34112959Sgabeblack@google.comvoid 34212959Sgabeblack@google.comProcess::ready() 34312959Sgabeblack@google.com{ 34412996Sgabeblack@google.com if (disabled()) 34512996Sgabeblack@google.com return; 34612959Sgabeblack@google.com if (suspended()) 34712959Sgabeblack@google.com _suspendedReady = true; 34812959Sgabeblack@google.com else 34912959Sgabeblack@google.com scheduler.ready(this); 35012959Sgabeblack@google.com} 35112959Sgabeblack@google.com 35212997Sgabeblack@google.comvoid 35312997Sgabeblack@google.comProcess::lastReport(::sc_core::sc_report *report) 35412997Sgabeblack@google.com{ 35512997Sgabeblack@google.com if (report) { 35612997Sgabeblack@google.com _lastReport = std::unique_ptr<::sc_core::sc_report>( 35712997Sgabeblack@google.com new ::sc_core::sc_report(*report)); 35812997Sgabeblack@google.com } else { 35912997Sgabeblack@google.com _lastReport = nullptr; 36012997Sgabeblack@google.com } 36112997Sgabeblack@google.com} 36212997Sgabeblack@google.com 36312997Sgabeblack@google.com::sc_core::sc_report *Process::lastReport() const { return _lastReport.get(); } 36412997Sgabeblack@google.com 36512998Sgabeblack@google.comProcess::Process(const char *name, ProcessFuncWrapper *func, bool _dynamic) : 36612953Sgabeblack@google.com ::sc_core::sc_object(name), excWrapper(nullptr), func(func), 36712998Sgabeblack@google.com _needsStart(true), _dynamic(_dynamic), _isUnwinding(false), 36812953Sgabeblack@google.com _terminated(false), _suspended(false), _disabled(false), 36912957Sgabeblack@google.com _syncReset(false), refCount(0), stackSize(::Fiber::DefaultStackSize), 37012957Sgabeblack@google.com dynamicSensitivity(nullptr) 37112953Sgabeblack@google.com{ 37212953Sgabeblack@google.com _newest = this; 37312953Sgabeblack@google.com} 37412952Sgabeblack@google.com 37512998Sgabeblack@google.comvoid 37612998Sgabeblack@google.comProcess::terminate() 37712998Sgabeblack@google.com{ 37812998Sgabeblack@google.com _terminated = true; 37912998Sgabeblack@google.com _suspendedReady = false; 38012998Sgabeblack@google.com _suspended = false; 38112998Sgabeblack@google.com _syncReset = false; 38212998Sgabeblack@google.com delete dynamicSensitivity; 38312998Sgabeblack@google.com dynamicSensitivity = nullptr; 38412998Sgabeblack@google.com for (auto s: staticSensitivities) 38512998Sgabeblack@google.com delete s; 38612998Sgabeblack@google.com staticSensitivities.clear(); 38712998Sgabeblack@google.com} 38812998Sgabeblack@google.com 38912953Sgabeblack@google.comProcess *Process::_newest; 39012952Sgabeblack@google.com 39112952Sgabeblack@google.comvoid 39212952Sgabeblack@google.comthrow_it_wrapper(Process *p, ExceptionWrapperBase &exc, bool inc_kids) 39312952Sgabeblack@google.com{ 39412952Sgabeblack@google.com p->throw_it(exc, inc_kids); 39512952Sgabeblack@google.com} 39612952Sgabeblack@google.com 39712952Sgabeblack@google.com} // namespace sc_gem5 398