process.cc revision 13063
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) : 4213063Sgabeblack@google.com Sensitivity(p), timeoutEvent([this]() { this->timeout(); }) 4312957Sgabeblack@google.com{ 4413063Sgabeblack@google.com scheduler.schedule(&timeoutEvent, t); 4512957Sgabeblack@google.com} 4612957Sgabeblack@google.com 4712957Sgabeblack@google.comSensitivityTimeout::~SensitivityTimeout() 4812957Sgabeblack@google.com{ 4912957Sgabeblack@google.com if (timeoutEvent.scheduled()) 5012962Sgabeblack@google.com scheduler.deschedule(&timeoutEvent); 5112962Sgabeblack@google.com} 5212962Sgabeblack@google.com 5312962Sgabeblack@google.comvoid 5412962Sgabeblack@google.comSensitivityTimeout::timeout() 5512962Sgabeblack@google.com{ 5612962Sgabeblack@google.com notify(); 5712957Sgabeblack@google.com} 5812957Sgabeblack@google.com 5912957Sgabeblack@google.comSensitivityEvent::SensitivityEvent( 6012957Sgabeblack@google.com Process *p, const ::sc_core::sc_event *e) : Sensitivity(p), event(e) 6112957Sgabeblack@google.com{ 6212957Sgabeblack@google.com Event::getFromScEvent(event)->addSensitivity(this); 6312957Sgabeblack@google.com} 6412957Sgabeblack@google.com 6512957Sgabeblack@google.comSensitivityEvent::~SensitivityEvent() 6612957Sgabeblack@google.com{ 6712957Sgabeblack@google.com Event::getFromScEvent(event)->delSensitivity(this); 6812957Sgabeblack@google.com} 6912957Sgabeblack@google.com 7012957Sgabeblack@google.comSensitivityEventAndList::SensitivityEventAndList( 7112957Sgabeblack@google.com Process *p, const ::sc_core::sc_event_and_list *list) : 7212957Sgabeblack@google.com Sensitivity(p), list(list), count(0) 7312957Sgabeblack@google.com{ 7412957Sgabeblack@google.com for (auto e: list->events) 7512957Sgabeblack@google.com Event::getFromScEvent(e)->addSensitivity(this); 7612957Sgabeblack@google.com} 7712957Sgabeblack@google.com 7812957Sgabeblack@google.comSensitivityEventAndList::~SensitivityEventAndList() 7912957Sgabeblack@google.com{ 8012957Sgabeblack@google.com for (auto e: list->events) 8112957Sgabeblack@google.com Event::getFromScEvent(e)->delSensitivity(this); 8212957Sgabeblack@google.com} 8312957Sgabeblack@google.com 8412957Sgabeblack@google.comvoid 8512957Sgabeblack@google.comSensitivityEventAndList::notifyWork(Event *e) 8612957Sgabeblack@google.com{ 8712957Sgabeblack@google.com e->delSensitivity(this); 8812957Sgabeblack@google.com count++; 8912957Sgabeblack@google.com if (count == list->events.size()) 9012959Sgabeblack@google.com process->satisfySensitivity(this); 9112957Sgabeblack@google.com} 9212957Sgabeblack@google.com 9312957Sgabeblack@google.comSensitivityEventOrList::SensitivityEventOrList( 9412957Sgabeblack@google.com Process *p, const ::sc_core::sc_event_or_list *list) : 9512957Sgabeblack@google.com Sensitivity(p), list(list) 9612957Sgabeblack@google.com{ 9712957Sgabeblack@google.com for (auto e: list->events) 9812957Sgabeblack@google.com Event::getFromScEvent(e)->addSensitivity(this); 9912957Sgabeblack@google.com} 10012957Sgabeblack@google.com 10112957Sgabeblack@google.comSensitivityEventOrList::~SensitivityEventOrList() 10212957Sgabeblack@google.com{ 10312957Sgabeblack@google.com for (auto e: list->events) 10412957Sgabeblack@google.com Event::getFromScEvent(e)->delSensitivity(this); 10512957Sgabeblack@google.com} 10612957Sgabeblack@google.com 10712957Sgabeblack@google.com 10812952Sgabeblack@google.comclass UnwindExceptionReset : public ::sc_core::sc_unwind_exception 10912952Sgabeblack@google.com{ 11012952Sgabeblack@google.com public: 11112995Sgabeblack@google.com UnwindExceptionReset() { _isReset = true; } 11212952Sgabeblack@google.com}; 11312952Sgabeblack@google.com 11412952Sgabeblack@google.comclass UnwindExceptionKill : public ::sc_core::sc_unwind_exception 11512952Sgabeblack@google.com{ 11612952Sgabeblack@google.com public: 11712995Sgabeblack@google.com UnwindExceptionKill() {} 11812952Sgabeblack@google.com}; 11912952Sgabeblack@google.com 12012952Sgabeblack@google.comtemplate <typename T> 12112952Sgabeblack@google.comstruct BuiltinExceptionWrapper : public ExceptionWrapperBase 12212952Sgabeblack@google.com{ 12312952Sgabeblack@google.com public: 12412952Sgabeblack@google.com T t; 12512952Sgabeblack@google.com void throw_it() override { throw t; } 12612952Sgabeblack@google.com}; 12712952Sgabeblack@google.com 12812952Sgabeblack@google.comBuiltinExceptionWrapper<UnwindExceptionReset> resetException; 12912952Sgabeblack@google.comBuiltinExceptionWrapper<UnwindExceptionKill> killException; 13012952Sgabeblack@google.com 13112952Sgabeblack@google.com 13212952Sgabeblack@google.comvoid 13312952Sgabeblack@google.comProcess::forEachKid(const std::function<void(Process *)> &work) 13412952Sgabeblack@google.com{ 13512952Sgabeblack@google.com for (auto &kid: get_child_objects()) { 13612952Sgabeblack@google.com Process *p_kid = dynamic_cast<Process *>(kid); 13712952Sgabeblack@google.com if (p_kid) 13812952Sgabeblack@google.com work(p_kid); 13912952Sgabeblack@google.com } 14012952Sgabeblack@google.com} 14112952Sgabeblack@google.com 14212952Sgabeblack@google.comvoid 14312952Sgabeblack@google.comProcess::suspend(bool inc_kids) 14412952Sgabeblack@google.com{ 14512952Sgabeblack@google.com if (inc_kids) 14612952Sgabeblack@google.com forEachKid([](Process *p) { p->suspend(true); }); 14712952Sgabeblack@google.com 14812952Sgabeblack@google.com if (!_suspended) { 14912952Sgabeblack@google.com _suspended = true; 15012959Sgabeblack@google.com _suspendedReady = false; 15112952Sgabeblack@google.com } 15212952Sgabeblack@google.com 15312953Sgabeblack@google.com if (procKind() != ::sc_core::SC_METHOD_PROC_ && 15412953Sgabeblack@google.com scheduler.current() == this) { 15512953Sgabeblack@google.com scheduler.yield(); 15612952Sgabeblack@google.com } 15712952Sgabeblack@google.com} 15812952Sgabeblack@google.com 15912952Sgabeblack@google.comvoid 16012952Sgabeblack@google.comProcess::resume(bool inc_kids) 16112952Sgabeblack@google.com{ 16212952Sgabeblack@google.com if (inc_kids) 16312952Sgabeblack@google.com forEachKid([](Process *p) { p->resume(true); }); 16412952Sgabeblack@google.com 16512952Sgabeblack@google.com if (_suspended) { 16612952Sgabeblack@google.com _suspended = false; 16712959Sgabeblack@google.com if (_suspendedReady) 16812959Sgabeblack@google.com ready(); 16912959Sgabeblack@google.com _suspendedReady = false; 17012952Sgabeblack@google.com } 17112952Sgabeblack@google.com} 17212952Sgabeblack@google.com 17312952Sgabeblack@google.comvoid 17412952Sgabeblack@google.comProcess::disable(bool inc_kids) 17512952Sgabeblack@google.com{ 17612952Sgabeblack@google.com if (inc_kids) 17712952Sgabeblack@google.com forEachKid([](Process *p) { p->disable(true); }); 17812952Sgabeblack@google.com 17912999Sgabeblack@google.com if (!::sc_core::sc_allow_process_control_corners && 18012999Sgabeblack@google.com dynamic_cast<SensitivityTimeout *>(dynamicSensitivity)) { 18112999Sgabeblack@google.com std::string message("attempt to disable a thread with timeout wait: "); 18212999Sgabeblack@google.com message += name(); 18312999Sgabeblack@google.com SC_REPORT_ERROR("Undefined process control interaction", 18412999Sgabeblack@google.com message.c_str()); 18512999Sgabeblack@google.com } 18612999Sgabeblack@google.com 18712952Sgabeblack@google.com _disabled = true; 18812952Sgabeblack@google.com} 18912952Sgabeblack@google.com 19012952Sgabeblack@google.comvoid 19112952Sgabeblack@google.comProcess::enable(bool inc_kids) 19212952Sgabeblack@google.com{ 19312952Sgabeblack@google.com 19412952Sgabeblack@google.com if (inc_kids) 19512952Sgabeblack@google.com forEachKid([](Process *p) { p->enable(true); }); 19612952Sgabeblack@google.com 19712952Sgabeblack@google.com _disabled = false; 19812952Sgabeblack@google.com} 19912952Sgabeblack@google.com 20012952Sgabeblack@google.comvoid 20112952Sgabeblack@google.comProcess::kill(bool inc_kids) 20212952Sgabeblack@google.com{ 20312952Sgabeblack@google.com // Propogate the kill to our children no matter what happens to us. 20412952Sgabeblack@google.com if (inc_kids) 20512952Sgabeblack@google.com forEachKid([](Process *p) { p->kill(true); }); 20612952Sgabeblack@google.com 20712952Sgabeblack@google.com // If we're in the middle of unwinding, ignore the kill request. 20812952Sgabeblack@google.com if (_isUnwinding) 20912952Sgabeblack@google.com return; 21012952Sgabeblack@google.com 21112995Sgabeblack@google.com // Update our state. 21212998Sgabeblack@google.com terminate(); 21312995Sgabeblack@google.com _isUnwinding = true; 21412995Sgabeblack@google.com 21512998Sgabeblack@google.com // Make sure this process isn't marked ready 21612998Sgabeblack@google.com popListNode(); 21712998Sgabeblack@google.com 21812998Sgabeblack@google.com // Inject the kill exception into this process if it's started. 21912998Sgabeblack@google.com if (!_needsStart) 22012998Sgabeblack@google.com injectException(killException); 22112952Sgabeblack@google.com} 22212952Sgabeblack@google.com 22312952Sgabeblack@google.comvoid 22412952Sgabeblack@google.comProcess::reset(bool inc_kids) 22512952Sgabeblack@google.com{ 22612952Sgabeblack@google.com // Propogate the reset to our children no matter what happens to us. 22712952Sgabeblack@google.com if (inc_kids) 22812952Sgabeblack@google.com forEachKid([](Process *p) { p->reset(true); }); 22912952Sgabeblack@google.com 23012952Sgabeblack@google.com // If we're in the middle of unwinding, ignore the reset request. 23112952Sgabeblack@google.com if (_isUnwinding) 23212952Sgabeblack@google.com return; 23312952Sgabeblack@google.com 23412995Sgabeblack@google.com 23512998Sgabeblack@google.com if (_needsStart) { 23612998Sgabeblack@google.com scheduler.runNow(this); 23712998Sgabeblack@google.com } else { 23812998Sgabeblack@google.com _isUnwinding = true; 23912998Sgabeblack@google.com injectException(resetException); 24012998Sgabeblack@google.com } 24112952Sgabeblack@google.com 24212952Sgabeblack@google.com _resetEvent.notify(); 24312952Sgabeblack@google.com} 24412952Sgabeblack@google.com 24512952Sgabeblack@google.comvoid 24612952Sgabeblack@google.comProcess::throw_it(ExceptionWrapperBase &exc, bool inc_kids) 24712952Sgabeblack@google.com{ 24812952Sgabeblack@google.com if (inc_kids) 24912952Sgabeblack@google.com forEachKid([&exc](Process *p) { p->throw_it(exc, true); }); 25012998Sgabeblack@google.com 25112998Sgabeblack@google.com // Only inject an exception into threads that have started. 25212998Sgabeblack@google.com if (!_needsStart) 25312998Sgabeblack@google.com injectException(exc); 25412952Sgabeblack@google.com} 25512952Sgabeblack@google.com 25612952Sgabeblack@google.comvoid 25712952Sgabeblack@google.comProcess::injectException(ExceptionWrapperBase &exc) 25812952Sgabeblack@google.com{ 25912952Sgabeblack@google.com excWrapper = &exc; 26012995Sgabeblack@google.com scheduler.runNow(this); 26112952Sgabeblack@google.com}; 26212952Sgabeblack@google.com 26312952Sgabeblack@google.comvoid 26412952Sgabeblack@google.comProcess::syncResetOn(bool inc_kids) 26512952Sgabeblack@google.com{ 26612952Sgabeblack@google.com if (inc_kids) 26712952Sgabeblack@google.com forEachKid([](Process *p) { p->syncResetOn(true); }); 26812952Sgabeblack@google.com 26912952Sgabeblack@google.com _syncReset = true; 27012952Sgabeblack@google.com} 27112952Sgabeblack@google.com 27212952Sgabeblack@google.comvoid 27312952Sgabeblack@google.comProcess::syncResetOff(bool inc_kids) 27412952Sgabeblack@google.com{ 27512952Sgabeblack@google.com if (inc_kids) 27612952Sgabeblack@google.com forEachKid([](Process *p) { p->syncResetOff(true); }); 27712952Sgabeblack@google.com 27812952Sgabeblack@google.com _syncReset = false; 27912952Sgabeblack@google.com} 28012952Sgabeblack@google.com 28112952Sgabeblack@google.comvoid 28212957Sgabeblack@google.comProcess::dontInitialize() 28312957Sgabeblack@google.com{ 28412957Sgabeblack@google.com scheduler.dontInitialize(this); 28512957Sgabeblack@google.com} 28612957Sgabeblack@google.com 28712957Sgabeblack@google.comvoid 28812957Sgabeblack@google.comProcess::finalize() 28912957Sgabeblack@google.com{ 29012957Sgabeblack@google.com for (auto &s: pendingStaticSensitivities) { 29112957Sgabeblack@google.com s->finalize(staticSensitivities); 29212957Sgabeblack@google.com delete s; 29312957Sgabeblack@google.com s = nullptr; 29412957Sgabeblack@google.com } 29512957Sgabeblack@google.com pendingStaticSensitivities.clear(); 29612957Sgabeblack@google.com}; 29712957Sgabeblack@google.com 29812957Sgabeblack@google.comvoid 29912953Sgabeblack@google.comProcess::run() 30012952Sgabeblack@google.com{ 30112953Sgabeblack@google.com bool reset; 30212953Sgabeblack@google.com do { 30312953Sgabeblack@google.com reset = false; 30412953Sgabeblack@google.com try { 30512953Sgabeblack@google.com func->call(); 30612995Sgabeblack@google.com } catch(const ::sc_core::sc_unwind_exception &exc) { 30712953Sgabeblack@google.com reset = exc.is_reset(); 30812995Sgabeblack@google.com _isUnwinding = false; 30912953Sgabeblack@google.com } 31012953Sgabeblack@google.com } while (reset); 31112953Sgabeblack@google.com} 31212952Sgabeblack@google.com 31312957Sgabeblack@google.comvoid 31412957Sgabeblack@google.comProcess::addStatic(PendingSensitivity *s) 31512957Sgabeblack@google.com{ 31612957Sgabeblack@google.com pendingStaticSensitivities.push_back(s); 31712957Sgabeblack@google.com} 31812957Sgabeblack@google.com 31912957Sgabeblack@google.comvoid 32012957Sgabeblack@google.comProcess::setDynamic(Sensitivity *s) 32112957Sgabeblack@google.com{ 32212957Sgabeblack@google.com delete dynamicSensitivity; 32312957Sgabeblack@google.com dynamicSensitivity = s; 32412957Sgabeblack@google.com} 32512957Sgabeblack@google.com 32612959Sgabeblack@google.comvoid 32712959Sgabeblack@google.comProcess::satisfySensitivity(Sensitivity *s) 32812959Sgabeblack@google.com{ 32912959Sgabeblack@google.com // If there's a dynamic sensitivity and this wasn't it, ignore. 33012959Sgabeblack@google.com if (dynamicSensitivity && dynamicSensitivity != s) 33112959Sgabeblack@google.com return; 33212959Sgabeblack@google.com 33312959Sgabeblack@google.com setDynamic(nullptr); 33412959Sgabeblack@google.com ready(); 33512959Sgabeblack@google.com} 33612959Sgabeblack@google.com 33712959Sgabeblack@google.comvoid 33812959Sgabeblack@google.comProcess::ready() 33912959Sgabeblack@google.com{ 34012996Sgabeblack@google.com if (disabled()) 34112996Sgabeblack@google.com return; 34212959Sgabeblack@google.com if (suspended()) 34312959Sgabeblack@google.com _suspendedReady = true; 34412959Sgabeblack@google.com else 34512959Sgabeblack@google.com scheduler.ready(this); 34612959Sgabeblack@google.com} 34712959Sgabeblack@google.com 34812997Sgabeblack@google.comvoid 34912997Sgabeblack@google.comProcess::lastReport(::sc_core::sc_report *report) 35012997Sgabeblack@google.com{ 35112997Sgabeblack@google.com if (report) { 35212997Sgabeblack@google.com _lastReport = std::unique_ptr<::sc_core::sc_report>( 35312997Sgabeblack@google.com new ::sc_core::sc_report(*report)); 35412997Sgabeblack@google.com } else { 35512997Sgabeblack@google.com _lastReport = nullptr; 35612997Sgabeblack@google.com } 35712997Sgabeblack@google.com} 35812997Sgabeblack@google.com 35912997Sgabeblack@google.com::sc_core::sc_report *Process::lastReport() const { return _lastReport.get(); } 36012997Sgabeblack@google.com 36112998Sgabeblack@google.comProcess::Process(const char *name, ProcessFuncWrapper *func, bool _dynamic) : 36212953Sgabeblack@google.com ::sc_core::sc_object(name), excWrapper(nullptr), func(func), 36312998Sgabeblack@google.com _needsStart(true), _dynamic(_dynamic), _isUnwinding(false), 36412953Sgabeblack@google.com _terminated(false), _suspended(false), _disabled(false), 36512957Sgabeblack@google.com _syncReset(false), refCount(0), stackSize(::Fiber::DefaultStackSize), 36612957Sgabeblack@google.com dynamicSensitivity(nullptr) 36712953Sgabeblack@google.com{ 36812953Sgabeblack@google.com _newest = this; 36912953Sgabeblack@google.com} 37012952Sgabeblack@google.com 37112998Sgabeblack@google.comvoid 37212998Sgabeblack@google.comProcess::terminate() 37312998Sgabeblack@google.com{ 37412998Sgabeblack@google.com _terminated = true; 37512998Sgabeblack@google.com _suspendedReady = false; 37612998Sgabeblack@google.com _suspended = false; 37712998Sgabeblack@google.com _syncReset = false; 37812998Sgabeblack@google.com delete dynamicSensitivity; 37912998Sgabeblack@google.com dynamicSensitivity = nullptr; 38012998Sgabeblack@google.com for (auto s: staticSensitivities) 38112998Sgabeblack@google.com delete s; 38212998Sgabeblack@google.com staticSensitivities.clear(); 38313006Sgabeblack@google.com 38413006Sgabeblack@google.com _terminatedEvent.notify(); 38512998Sgabeblack@google.com} 38612998Sgabeblack@google.com 38712953Sgabeblack@google.comProcess *Process::_newest; 38812952Sgabeblack@google.com 38912952Sgabeblack@google.comvoid 39012952Sgabeblack@google.comthrow_it_wrapper(Process *p, ExceptionWrapperBase &exc, bool inc_kids) 39112952Sgabeblack@google.com{ 39212952Sgabeblack@google.com p->throw_it(exc, inc_kids); 39312952Sgabeblack@google.com} 39412952Sgabeblack@google.com 39512952Sgabeblack@google.com} // namespace sc_gem5 396