process.hh revision 12998
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#ifndef __SYSTEMC_CORE_PROCESS_HH__ 3112952Sgabeblack@google.com#define __SYSTEMC_CORE_PROCESS_HH__ 3212952Sgabeblack@google.com 3312952Sgabeblack@google.com#include <functional> 3412997Sgabeblack@google.com#include <memory> 3512957Sgabeblack@google.com#include <vector> 3612952Sgabeblack@google.com 3712952Sgabeblack@google.com#include "base/fiber.hh" 3812957Sgabeblack@google.com#include "sim/eventq.hh" 3912957Sgabeblack@google.com#include "systemc/core/bindinfo.hh" 4012953Sgabeblack@google.com#include "systemc/core/list.hh" 4112952Sgabeblack@google.com#include "systemc/core/object.hh" 4212952Sgabeblack@google.com#include "systemc/ext/core/sc_event.hh" 4312991Sgabeblack@google.com#include "systemc/ext/core/sc_export.hh" 4412957Sgabeblack@google.com#include "systemc/ext/core/sc_interface.hh" 4512952Sgabeblack@google.com#include "systemc/ext/core/sc_module.hh" 4612957Sgabeblack@google.com#include "systemc/ext/core/sc_port.hh" 4712952Sgabeblack@google.com#include "systemc/ext/core/sc_process_handle.hh" 4812997Sgabeblack@google.com#include "systemc/ext/utils/sc_report.hh" 4912952Sgabeblack@google.com 5012952Sgabeblack@google.comnamespace sc_gem5 5112952Sgabeblack@google.com{ 5212952Sgabeblack@google.com 5312957Sgabeblack@google.comclass Sensitivity 5412957Sgabeblack@google.com{ 5512957Sgabeblack@google.com protected: 5612957Sgabeblack@google.com Process *process; 5712957Sgabeblack@google.com 5812957Sgabeblack@google.com public: 5912957Sgabeblack@google.com Sensitivity(Process *p) : process(p) {} 6012957Sgabeblack@google.com virtual ~Sensitivity() {} 6112957Sgabeblack@google.com 6212959Sgabeblack@google.com virtual void notifyWork(Event *e); 6312957Sgabeblack@google.com void notify(Event *e); 6412957Sgabeblack@google.com void notify() { notify(nullptr); } 6512957Sgabeblack@google.com 6612957Sgabeblack@google.com const std::string name(); 6712957Sgabeblack@google.com}; 6812957Sgabeblack@google.com 6912957Sgabeblack@google.comclass SensitivityTimeout : virtual public Sensitivity 7012957Sgabeblack@google.com{ 7112957Sgabeblack@google.com private: 7212962Sgabeblack@google.com void timeout(); 7312962Sgabeblack@google.com EventWrapper<SensitivityTimeout, 7412962Sgabeblack@google.com &SensitivityTimeout::timeout> timeoutEvent; 7512962Sgabeblack@google.com ::sc_core::sc_time time; 7612957Sgabeblack@google.com 7712957Sgabeblack@google.com public: 7812957Sgabeblack@google.com SensitivityTimeout(Process *p, ::sc_core::sc_time t); 7912957Sgabeblack@google.com ~SensitivityTimeout(); 8012957Sgabeblack@google.com}; 8112957Sgabeblack@google.com 8212957Sgabeblack@google.comclass SensitivityEvent : virtual public Sensitivity 8312957Sgabeblack@google.com{ 8412957Sgabeblack@google.com private: 8512957Sgabeblack@google.com const ::sc_core::sc_event *event; 8612957Sgabeblack@google.com 8712957Sgabeblack@google.com public: 8812957Sgabeblack@google.com SensitivityEvent(Process *p, const ::sc_core::sc_event *e); 8912957Sgabeblack@google.com ~SensitivityEvent(); 9012957Sgabeblack@google.com}; 9112957Sgabeblack@google.com 9212957Sgabeblack@google.com//XXX This sensitivity can't be reused. To reset it, it has to be deleted and 9312957Sgabeblack@google.com//recreated. That works for dynamic sensitivities, but not for static. 9412957Sgabeblack@google.com//Fortunately processes can't be statically sensitive to sc_event_and_lists. 9512957Sgabeblack@google.comclass SensitivityEventAndList : virtual public Sensitivity 9612957Sgabeblack@google.com{ 9712957Sgabeblack@google.com private: 9812957Sgabeblack@google.com const ::sc_core::sc_event_and_list *list; 9912957Sgabeblack@google.com int count; 10012957Sgabeblack@google.com 10112957Sgabeblack@google.com public: 10212957Sgabeblack@google.com SensitivityEventAndList( 10312957Sgabeblack@google.com Process *p, const ::sc_core::sc_event_and_list *list); 10412957Sgabeblack@google.com ~SensitivityEventAndList(); 10512957Sgabeblack@google.com 10612962Sgabeblack@google.com void notifyWork(Event *e) override; 10712957Sgabeblack@google.com}; 10812957Sgabeblack@google.com 10912957Sgabeblack@google.comclass SensitivityEventOrList : virtual public Sensitivity 11012957Sgabeblack@google.com{ 11112957Sgabeblack@google.com private: 11212957Sgabeblack@google.com const ::sc_core::sc_event_or_list *list; 11312957Sgabeblack@google.com 11412957Sgabeblack@google.com public: 11512957Sgabeblack@google.com SensitivityEventOrList( 11612957Sgabeblack@google.com Process *p, const ::sc_core::sc_event_or_list *list); 11712957Sgabeblack@google.com ~SensitivityEventOrList(); 11812957Sgabeblack@google.com}; 11912957Sgabeblack@google.com 12012957Sgabeblack@google.com// Combined sensitivities. These trigger when any of their parts do. 12112957Sgabeblack@google.com 12212957Sgabeblack@google.comclass SensitivityTimeoutAndEvent : 12312957Sgabeblack@google.com public SensitivityTimeout, public SensitivityEvent 12412957Sgabeblack@google.com{ 12512957Sgabeblack@google.com public: 12612957Sgabeblack@google.com SensitivityTimeoutAndEvent( 12712957Sgabeblack@google.com Process *p, ::sc_core::sc_time t, const ::sc_core::sc_event *e) : 12812957Sgabeblack@google.com Sensitivity(p), SensitivityTimeout(p, t), SensitivityEvent(p, e) 12912957Sgabeblack@google.com {} 13012957Sgabeblack@google.com}; 13112957Sgabeblack@google.com 13212957Sgabeblack@google.comclass SensitivityTimeoutAndEventAndList : 13312957Sgabeblack@google.com public SensitivityTimeout, public SensitivityEventAndList 13412957Sgabeblack@google.com{ 13512957Sgabeblack@google.com public: 13612957Sgabeblack@google.com SensitivityTimeoutAndEventAndList( 13712957Sgabeblack@google.com Process *p, ::sc_core::sc_time t, 13812957Sgabeblack@google.com const ::sc_core::sc_event_and_list *eal) : 13912957Sgabeblack@google.com Sensitivity(p), SensitivityTimeout(p, t), 14012957Sgabeblack@google.com SensitivityEventAndList(p, eal) 14112957Sgabeblack@google.com {} 14212957Sgabeblack@google.com}; 14312957Sgabeblack@google.com 14412957Sgabeblack@google.comclass SensitivityTimeoutAndEventOrList : 14512957Sgabeblack@google.com public SensitivityTimeout, public SensitivityEventOrList 14612957Sgabeblack@google.com{ 14712957Sgabeblack@google.com public: 14812957Sgabeblack@google.com SensitivityTimeoutAndEventOrList( 14912957Sgabeblack@google.com Process *p, ::sc_core::sc_time t, 15012957Sgabeblack@google.com const ::sc_core::sc_event_or_list *eol) : 15112957Sgabeblack@google.com Sensitivity(p), SensitivityTimeout(p, t), 15212957Sgabeblack@google.com SensitivityEventOrList(p, eol) 15312957Sgabeblack@google.com {} 15412957Sgabeblack@google.com}; 15512957Sgabeblack@google.com 15612957Sgabeblack@google.comtypedef std::vector<Sensitivity *> Sensitivities; 15712957Sgabeblack@google.com 15812957Sgabeblack@google.com 15912957Sgabeblack@google.com/* 16012957Sgabeblack@google.com * Pending sensitivities. These are records of sensitivities to install later, 16112957Sgabeblack@google.com * once all the information to configure them is available. 16212957Sgabeblack@google.com */ 16312957Sgabeblack@google.com 16412957Sgabeblack@google.comclass PendingSensitivity 16512957Sgabeblack@google.com{ 16612957Sgabeblack@google.com protected: 16712957Sgabeblack@google.com Process *process; 16812957Sgabeblack@google.com 16912957Sgabeblack@google.com public: 17012957Sgabeblack@google.com virtual void finalize(Sensitivities &s) = 0; 17112957Sgabeblack@google.com PendingSensitivity(Process *p) : process(p) {} 17212957Sgabeblack@google.com virtual ~PendingSensitivity() {} 17312957Sgabeblack@google.com}; 17412957Sgabeblack@google.com 17512957Sgabeblack@google.comclass PendingSensitivityEvent : public PendingSensitivity 17612957Sgabeblack@google.com{ 17712957Sgabeblack@google.com private: 17812957Sgabeblack@google.com const sc_core::sc_event *event; 17912957Sgabeblack@google.com 18012957Sgabeblack@google.com public: 18112957Sgabeblack@google.com PendingSensitivityEvent(Process *p, const sc_core::sc_event *e) : 18212957Sgabeblack@google.com PendingSensitivity(p), event(e) {} 18312957Sgabeblack@google.com 18412957Sgabeblack@google.com void 18512957Sgabeblack@google.com finalize(Sensitivities &s) override 18612957Sgabeblack@google.com { 18712957Sgabeblack@google.com s.push_back(new SensitivityEvent(process, event)); 18812957Sgabeblack@google.com } 18912957Sgabeblack@google.com}; 19012957Sgabeblack@google.com 19112957Sgabeblack@google.comclass PendingSensitivityInterface : public PendingSensitivity 19212957Sgabeblack@google.com{ 19312957Sgabeblack@google.com private: 19412957Sgabeblack@google.com const sc_core::sc_interface *interface; 19512957Sgabeblack@google.com 19612957Sgabeblack@google.com public: 19712957Sgabeblack@google.com PendingSensitivityInterface(Process *p, const sc_core::sc_interface *i) : 19812957Sgabeblack@google.com PendingSensitivity(p), interface(i) 19912957Sgabeblack@google.com {} 20012957Sgabeblack@google.com 20112957Sgabeblack@google.com void 20212957Sgabeblack@google.com finalize(Sensitivities &s) override 20312957Sgabeblack@google.com { 20412957Sgabeblack@google.com s.push_back(new SensitivityEvent(process, 20512957Sgabeblack@google.com &interface->default_event())); 20612957Sgabeblack@google.com } 20712957Sgabeblack@google.com}; 20812957Sgabeblack@google.com 20912957Sgabeblack@google.comclass PendingSensitivityPort : public PendingSensitivity 21012957Sgabeblack@google.com{ 21112957Sgabeblack@google.com private: 21212957Sgabeblack@google.com const sc_core::sc_port_base *port; 21312957Sgabeblack@google.com 21412957Sgabeblack@google.com public: 21512957Sgabeblack@google.com PendingSensitivityPort(Process *p, const sc_core::sc_port_base *pb) : 21612957Sgabeblack@google.com PendingSensitivity(p), port(pb) 21712957Sgabeblack@google.com {} 21812957Sgabeblack@google.com 21912957Sgabeblack@google.com void 22012957Sgabeblack@google.com finalize(Sensitivities &s) override 22112957Sgabeblack@google.com { 22212957Sgabeblack@google.com for (int i = 0; i < port->size(); i++) { 22312957Sgabeblack@google.com const ::sc_core::sc_event *e = 22412957Sgabeblack@google.com &port->_gem5BindInfo[i]->interface->default_event(); 22512957Sgabeblack@google.com s.push_back(new SensitivityEvent(process, e)); 22612957Sgabeblack@google.com } 22712957Sgabeblack@google.com } 22812957Sgabeblack@google.com}; 22912957Sgabeblack@google.com 23012991Sgabeblack@google.comclass PendingSensitivityExport : public PendingSensitivity 23112991Sgabeblack@google.com{ 23212991Sgabeblack@google.com private: 23312991Sgabeblack@google.com const sc_core::sc_export_base *exp; 23412991Sgabeblack@google.com 23512991Sgabeblack@google.com public: 23612991Sgabeblack@google.com PendingSensitivityExport(Process *p, const sc_core::sc_export_base *exp) : 23712991Sgabeblack@google.com PendingSensitivity(p), exp(exp) 23812991Sgabeblack@google.com {} 23912991Sgabeblack@google.com 24012991Sgabeblack@google.com void 24112991Sgabeblack@google.com finalize(Sensitivities &s) override 24212991Sgabeblack@google.com { 24312991Sgabeblack@google.com s.push_back(new SensitivityEvent(process, 24412991Sgabeblack@google.com &exp->get_interface()->default_event())); 24512991Sgabeblack@google.com } 24612991Sgabeblack@google.com}; 24712991Sgabeblack@google.com 24812957Sgabeblack@google.comclass PendingSensitivityFinder : public PendingSensitivity 24912957Sgabeblack@google.com{ 25012957Sgabeblack@google.com private: 25112957Sgabeblack@google.com const sc_core::sc_event_finder *finder; 25212957Sgabeblack@google.com 25312957Sgabeblack@google.com public: 25412957Sgabeblack@google.com PendingSensitivityFinder(Process *p, const sc_core::sc_event_finder *f) : 25512957Sgabeblack@google.com PendingSensitivity(p), finder(f) 25612957Sgabeblack@google.com {} 25712957Sgabeblack@google.com 25812957Sgabeblack@google.com void 25912957Sgabeblack@google.com finalize(Sensitivities &s) override 26012957Sgabeblack@google.com { 26112957Sgabeblack@google.com s.push_back(new SensitivityEvent(process, &finder->find_event())); 26212957Sgabeblack@google.com } 26312957Sgabeblack@google.com}; 26412957Sgabeblack@google.com 26512957Sgabeblack@google.comtypedef std::vector<PendingSensitivity *> PendingSensitivities; 26612957Sgabeblack@google.com 26712957Sgabeblack@google.com 26812953Sgabeblack@google.comclass Process : public ::sc_core::sc_object, public ListNode 26912952Sgabeblack@google.com{ 27012952Sgabeblack@google.com public: 27112952Sgabeblack@google.com virtual ::sc_core::sc_curr_proc_kind procKind() const = 0; 27212961Sgabeblack@google.com bool needsStart() const { return _needsStart; } 27312952Sgabeblack@google.com bool dynamic() const { return _dynamic; } 27412952Sgabeblack@google.com bool isUnwinding() const { return _isUnwinding; } 27512997Sgabeblack@google.com void isUnwinding(bool v) { _isUnwinding = v; } 27612952Sgabeblack@google.com bool terminated() const { return _terminated; } 27712952Sgabeblack@google.com 27812952Sgabeblack@google.com void forEachKid(const std::function<void(Process *)> &work); 27912952Sgabeblack@google.com 28012952Sgabeblack@google.com bool suspended() const { return _suspended; } 28112952Sgabeblack@google.com bool disabled() const { return _disabled; } 28212952Sgabeblack@google.com 28312952Sgabeblack@google.com void suspend(bool inc_kids); 28412952Sgabeblack@google.com void resume(bool inc_kids); 28512952Sgabeblack@google.com void disable(bool inc_kids); 28612952Sgabeblack@google.com void enable(bool inc_kids); 28712952Sgabeblack@google.com 28812952Sgabeblack@google.com void kill(bool inc_kids); 28912952Sgabeblack@google.com void reset(bool inc_kids); 29012952Sgabeblack@google.com virtual void throw_it(ExceptionWrapperBase &exc, bool inc_kids); 29112952Sgabeblack@google.com 29212952Sgabeblack@google.com void injectException(ExceptionWrapperBase &exc); 29312952Sgabeblack@google.com ExceptionWrapperBase *excWrapper; 29412952Sgabeblack@google.com 29512952Sgabeblack@google.com void syncResetOn(bool inc_kids); 29612952Sgabeblack@google.com void syncResetOff(bool inc_kids); 29712952Sgabeblack@google.com 29812952Sgabeblack@google.com void incref() { refCount++; } 29912952Sgabeblack@google.com void decref() { refCount--; } 30012952Sgabeblack@google.com 30112952Sgabeblack@google.com const ::sc_core::sc_event &resetEvent() { return _resetEvent; } 30212952Sgabeblack@google.com const ::sc_core::sc_event &terminatedEvent() { return _terminatedEvent; } 30312952Sgabeblack@google.com 30412953Sgabeblack@google.com // This should only be called before initialization. 30512957Sgabeblack@google.com void dontInitialize(); 30612953Sgabeblack@google.com 30712953Sgabeblack@google.com void setStackSize(size_t size) { stackSize = size; } 30812953Sgabeblack@google.com 30912957Sgabeblack@google.com void finalize(); 31012957Sgabeblack@google.com 31112953Sgabeblack@google.com void run(); 31212953Sgabeblack@google.com 31312957Sgabeblack@google.com void addStatic(PendingSensitivity *); 31412957Sgabeblack@google.com void setDynamic(Sensitivity *); 31512957Sgabeblack@google.com 31612959Sgabeblack@google.com void satisfySensitivity(Sensitivity *); 31712959Sgabeblack@google.com 31812959Sgabeblack@google.com void ready(); 31912959Sgabeblack@google.com 32012953Sgabeblack@google.com virtual Fiber *fiber() { return Fiber::primaryFiber(); } 32112953Sgabeblack@google.com 32212953Sgabeblack@google.com static Process *newest() { return _newest; } 32312953Sgabeblack@google.com 32412997Sgabeblack@google.com void lastReport(::sc_core::sc_report *report); 32512997Sgabeblack@google.com ::sc_core::sc_report *lastReport() const; 32612997Sgabeblack@google.com 32712952Sgabeblack@google.com protected: 32812998Sgabeblack@google.com Process(const char *name, ProcessFuncWrapper *func, bool _dynamic); 32912953Sgabeblack@google.com 33012953Sgabeblack@google.com static Process *_newest; 33112952Sgabeblack@google.com 33212957Sgabeblack@google.com virtual ~Process() 33312957Sgabeblack@google.com { 33412957Sgabeblack@google.com delete func; 33512957Sgabeblack@google.com for (auto s: staticSensitivities) 33612957Sgabeblack@google.com delete s; 33712957Sgabeblack@google.com } 33812952Sgabeblack@google.com 33912952Sgabeblack@google.com ::sc_core::sc_event _resetEvent; 34012952Sgabeblack@google.com ::sc_core::sc_event _terminatedEvent; 34112952Sgabeblack@google.com 34212952Sgabeblack@google.com ProcessFuncWrapper *func; 34312952Sgabeblack@google.com sc_core::sc_curr_proc_kind _procKind; 34412961Sgabeblack@google.com bool _needsStart; 34512952Sgabeblack@google.com bool _dynamic; 34612952Sgabeblack@google.com bool _isUnwinding; 34712952Sgabeblack@google.com bool _terminated; 34812952Sgabeblack@google.com 34912998Sgabeblack@google.com void terminate(); 35012998Sgabeblack@google.com 35112952Sgabeblack@google.com bool _suspended; 35212959Sgabeblack@google.com bool _suspendedReady; 35312952Sgabeblack@google.com bool _disabled; 35412952Sgabeblack@google.com 35512952Sgabeblack@google.com bool _syncReset; 35612952Sgabeblack@google.com 35712952Sgabeblack@google.com int refCount; 35812952Sgabeblack@google.com 35912953Sgabeblack@google.com size_t stackSize; 36012957Sgabeblack@google.com 36112957Sgabeblack@google.com Sensitivities staticSensitivities; 36212957Sgabeblack@google.com PendingSensitivities pendingStaticSensitivities; 36312957Sgabeblack@google.com 36412957Sgabeblack@google.com Sensitivity *dynamicSensitivity; 36512997Sgabeblack@google.com 36612997Sgabeblack@google.com std::unique_ptr<::sc_core::sc_report> _lastReport; 36712952Sgabeblack@google.com}; 36812952Sgabeblack@google.com 36912957Sgabeblack@google.cominline void 37012959Sgabeblack@google.comSensitivity::notifyWork(Event *e) 37112959Sgabeblack@google.com{ 37212959Sgabeblack@google.com process->satisfySensitivity(this); 37312959Sgabeblack@google.com} 37412959Sgabeblack@google.com 37512959Sgabeblack@google.cominline void 37612957Sgabeblack@google.comSensitivity::notify(Event *e) 37712957Sgabeblack@google.com{ 37812957Sgabeblack@google.com if (!process->disabled()) 37912957Sgabeblack@google.com notifyWork(e); 38012957Sgabeblack@google.com} 38112957Sgabeblack@google.com 38212957Sgabeblack@google.cominline const std::string 38312957Sgabeblack@google.comSensitivity::name() 38412957Sgabeblack@google.com{ 38512957Sgabeblack@google.com return std::string(process->name()) + ".timeout"; 38612957Sgabeblack@google.com} 38712957Sgabeblack@google.com 38812952Sgabeblack@google.com} // namespace sc_gem5 38912952Sgabeblack@google.com 39012952Sgabeblack@google.com#endif //__SYSTEMC_CORE_PROCESS_HH__ 391