process.hh revision 12991
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> 3412957Sgabeblack@google.com#include <vector> 3512952Sgabeblack@google.com 3612952Sgabeblack@google.com#include "base/fiber.hh" 3712957Sgabeblack@google.com#include "sim/eventq.hh" 3812957Sgabeblack@google.com#include "systemc/core/bindinfo.hh" 3912953Sgabeblack@google.com#include "systemc/core/list.hh" 4012952Sgabeblack@google.com#include "systemc/core/object.hh" 4112952Sgabeblack@google.com#include "systemc/ext/core/sc_event.hh" 4212991Sgabeblack@google.com#include "systemc/ext/core/sc_export.hh" 4312957Sgabeblack@google.com#include "systemc/ext/core/sc_interface.hh" 4412952Sgabeblack@google.com#include "systemc/ext/core/sc_module.hh" 4512957Sgabeblack@google.com#include "systemc/ext/core/sc_port.hh" 4612952Sgabeblack@google.com#include "systemc/ext/core/sc_process_handle.hh" 4712952Sgabeblack@google.com 4812952Sgabeblack@google.comnamespace sc_gem5 4912952Sgabeblack@google.com{ 5012952Sgabeblack@google.com 5112957Sgabeblack@google.comclass Sensitivity 5212957Sgabeblack@google.com{ 5312957Sgabeblack@google.com protected: 5412957Sgabeblack@google.com Process *process; 5512957Sgabeblack@google.com 5612957Sgabeblack@google.com public: 5712957Sgabeblack@google.com Sensitivity(Process *p) : process(p) {} 5812957Sgabeblack@google.com virtual ~Sensitivity() {} 5912957Sgabeblack@google.com 6012959Sgabeblack@google.com virtual void notifyWork(Event *e); 6112957Sgabeblack@google.com void notify(Event *e); 6212957Sgabeblack@google.com void notify() { notify(nullptr); } 6312957Sgabeblack@google.com 6412957Sgabeblack@google.com const std::string name(); 6512957Sgabeblack@google.com}; 6612957Sgabeblack@google.com 6712957Sgabeblack@google.comclass SensitivityTimeout : virtual public Sensitivity 6812957Sgabeblack@google.com{ 6912957Sgabeblack@google.com private: 7012962Sgabeblack@google.com void timeout(); 7112962Sgabeblack@google.com EventWrapper<SensitivityTimeout, 7212962Sgabeblack@google.com &SensitivityTimeout::timeout> timeoutEvent; 7312962Sgabeblack@google.com ::sc_core::sc_time time; 7412957Sgabeblack@google.com 7512957Sgabeblack@google.com public: 7612957Sgabeblack@google.com SensitivityTimeout(Process *p, ::sc_core::sc_time t); 7712957Sgabeblack@google.com ~SensitivityTimeout(); 7812957Sgabeblack@google.com}; 7912957Sgabeblack@google.com 8012957Sgabeblack@google.comclass SensitivityEvent : virtual public Sensitivity 8112957Sgabeblack@google.com{ 8212957Sgabeblack@google.com private: 8312957Sgabeblack@google.com const ::sc_core::sc_event *event; 8412957Sgabeblack@google.com 8512957Sgabeblack@google.com public: 8612957Sgabeblack@google.com SensitivityEvent(Process *p, const ::sc_core::sc_event *e); 8712957Sgabeblack@google.com ~SensitivityEvent(); 8812957Sgabeblack@google.com}; 8912957Sgabeblack@google.com 9012957Sgabeblack@google.com//XXX This sensitivity can't be reused. To reset it, it has to be deleted and 9112957Sgabeblack@google.com//recreated. That works for dynamic sensitivities, but not for static. 9212957Sgabeblack@google.com//Fortunately processes can't be statically sensitive to sc_event_and_lists. 9312957Sgabeblack@google.comclass SensitivityEventAndList : virtual public Sensitivity 9412957Sgabeblack@google.com{ 9512957Sgabeblack@google.com private: 9612957Sgabeblack@google.com const ::sc_core::sc_event_and_list *list; 9712957Sgabeblack@google.com int count; 9812957Sgabeblack@google.com 9912957Sgabeblack@google.com public: 10012957Sgabeblack@google.com SensitivityEventAndList( 10112957Sgabeblack@google.com Process *p, const ::sc_core::sc_event_and_list *list); 10212957Sgabeblack@google.com ~SensitivityEventAndList(); 10312957Sgabeblack@google.com 10412962Sgabeblack@google.com void notifyWork(Event *e) override; 10512957Sgabeblack@google.com}; 10612957Sgabeblack@google.com 10712957Sgabeblack@google.comclass SensitivityEventOrList : virtual public Sensitivity 10812957Sgabeblack@google.com{ 10912957Sgabeblack@google.com private: 11012957Sgabeblack@google.com const ::sc_core::sc_event_or_list *list; 11112957Sgabeblack@google.com 11212957Sgabeblack@google.com public: 11312957Sgabeblack@google.com SensitivityEventOrList( 11412957Sgabeblack@google.com Process *p, const ::sc_core::sc_event_or_list *list); 11512957Sgabeblack@google.com ~SensitivityEventOrList(); 11612957Sgabeblack@google.com}; 11712957Sgabeblack@google.com 11812957Sgabeblack@google.com// Combined sensitivities. These trigger when any of their parts do. 11912957Sgabeblack@google.com 12012957Sgabeblack@google.comclass SensitivityTimeoutAndEvent : 12112957Sgabeblack@google.com public SensitivityTimeout, public SensitivityEvent 12212957Sgabeblack@google.com{ 12312957Sgabeblack@google.com public: 12412957Sgabeblack@google.com SensitivityTimeoutAndEvent( 12512957Sgabeblack@google.com Process *p, ::sc_core::sc_time t, const ::sc_core::sc_event *e) : 12612957Sgabeblack@google.com Sensitivity(p), SensitivityTimeout(p, t), SensitivityEvent(p, e) 12712957Sgabeblack@google.com {} 12812957Sgabeblack@google.com}; 12912957Sgabeblack@google.com 13012957Sgabeblack@google.comclass SensitivityTimeoutAndEventAndList : 13112957Sgabeblack@google.com public SensitivityTimeout, public SensitivityEventAndList 13212957Sgabeblack@google.com{ 13312957Sgabeblack@google.com public: 13412957Sgabeblack@google.com SensitivityTimeoutAndEventAndList( 13512957Sgabeblack@google.com Process *p, ::sc_core::sc_time t, 13612957Sgabeblack@google.com const ::sc_core::sc_event_and_list *eal) : 13712957Sgabeblack@google.com Sensitivity(p), SensitivityTimeout(p, t), 13812957Sgabeblack@google.com SensitivityEventAndList(p, eal) 13912957Sgabeblack@google.com {} 14012957Sgabeblack@google.com}; 14112957Sgabeblack@google.com 14212957Sgabeblack@google.comclass SensitivityTimeoutAndEventOrList : 14312957Sgabeblack@google.com public SensitivityTimeout, public SensitivityEventOrList 14412957Sgabeblack@google.com{ 14512957Sgabeblack@google.com public: 14612957Sgabeblack@google.com SensitivityTimeoutAndEventOrList( 14712957Sgabeblack@google.com Process *p, ::sc_core::sc_time t, 14812957Sgabeblack@google.com const ::sc_core::sc_event_or_list *eol) : 14912957Sgabeblack@google.com Sensitivity(p), SensitivityTimeout(p, t), 15012957Sgabeblack@google.com SensitivityEventOrList(p, eol) 15112957Sgabeblack@google.com {} 15212957Sgabeblack@google.com}; 15312957Sgabeblack@google.com 15412957Sgabeblack@google.comtypedef std::vector<Sensitivity *> Sensitivities; 15512957Sgabeblack@google.com 15612957Sgabeblack@google.com 15712957Sgabeblack@google.com/* 15812957Sgabeblack@google.com * Pending sensitivities. These are records of sensitivities to install later, 15912957Sgabeblack@google.com * once all the information to configure them is available. 16012957Sgabeblack@google.com */ 16112957Sgabeblack@google.com 16212957Sgabeblack@google.comclass PendingSensitivity 16312957Sgabeblack@google.com{ 16412957Sgabeblack@google.com protected: 16512957Sgabeblack@google.com Process *process; 16612957Sgabeblack@google.com 16712957Sgabeblack@google.com public: 16812957Sgabeblack@google.com virtual void finalize(Sensitivities &s) = 0; 16912957Sgabeblack@google.com PendingSensitivity(Process *p) : process(p) {} 17012957Sgabeblack@google.com virtual ~PendingSensitivity() {} 17112957Sgabeblack@google.com}; 17212957Sgabeblack@google.com 17312957Sgabeblack@google.comclass PendingSensitivityEvent : public PendingSensitivity 17412957Sgabeblack@google.com{ 17512957Sgabeblack@google.com private: 17612957Sgabeblack@google.com const sc_core::sc_event *event; 17712957Sgabeblack@google.com 17812957Sgabeblack@google.com public: 17912957Sgabeblack@google.com PendingSensitivityEvent(Process *p, const sc_core::sc_event *e) : 18012957Sgabeblack@google.com PendingSensitivity(p), event(e) {} 18112957Sgabeblack@google.com 18212957Sgabeblack@google.com void 18312957Sgabeblack@google.com finalize(Sensitivities &s) override 18412957Sgabeblack@google.com { 18512957Sgabeblack@google.com s.push_back(new SensitivityEvent(process, event)); 18612957Sgabeblack@google.com } 18712957Sgabeblack@google.com}; 18812957Sgabeblack@google.com 18912957Sgabeblack@google.comclass PendingSensitivityInterface : public PendingSensitivity 19012957Sgabeblack@google.com{ 19112957Sgabeblack@google.com private: 19212957Sgabeblack@google.com const sc_core::sc_interface *interface; 19312957Sgabeblack@google.com 19412957Sgabeblack@google.com public: 19512957Sgabeblack@google.com PendingSensitivityInterface(Process *p, const sc_core::sc_interface *i) : 19612957Sgabeblack@google.com PendingSensitivity(p), interface(i) 19712957Sgabeblack@google.com {} 19812957Sgabeblack@google.com 19912957Sgabeblack@google.com void 20012957Sgabeblack@google.com finalize(Sensitivities &s) override 20112957Sgabeblack@google.com { 20212957Sgabeblack@google.com s.push_back(new SensitivityEvent(process, 20312957Sgabeblack@google.com &interface->default_event())); 20412957Sgabeblack@google.com } 20512957Sgabeblack@google.com}; 20612957Sgabeblack@google.com 20712957Sgabeblack@google.comclass PendingSensitivityPort : public PendingSensitivity 20812957Sgabeblack@google.com{ 20912957Sgabeblack@google.com private: 21012957Sgabeblack@google.com const sc_core::sc_port_base *port; 21112957Sgabeblack@google.com 21212957Sgabeblack@google.com public: 21312957Sgabeblack@google.com PendingSensitivityPort(Process *p, const sc_core::sc_port_base *pb) : 21412957Sgabeblack@google.com PendingSensitivity(p), port(pb) 21512957Sgabeblack@google.com {} 21612957Sgabeblack@google.com 21712957Sgabeblack@google.com void 21812957Sgabeblack@google.com finalize(Sensitivities &s) override 21912957Sgabeblack@google.com { 22012957Sgabeblack@google.com for (int i = 0; i < port->size(); i++) { 22112957Sgabeblack@google.com const ::sc_core::sc_event *e = 22212957Sgabeblack@google.com &port->_gem5BindInfo[i]->interface->default_event(); 22312957Sgabeblack@google.com s.push_back(new SensitivityEvent(process, e)); 22412957Sgabeblack@google.com } 22512957Sgabeblack@google.com } 22612957Sgabeblack@google.com}; 22712957Sgabeblack@google.com 22812991Sgabeblack@google.comclass PendingSensitivityExport : public PendingSensitivity 22912991Sgabeblack@google.com{ 23012991Sgabeblack@google.com private: 23112991Sgabeblack@google.com const sc_core::sc_export_base *exp; 23212991Sgabeblack@google.com 23312991Sgabeblack@google.com public: 23412991Sgabeblack@google.com PendingSensitivityExport(Process *p, const sc_core::sc_export_base *exp) : 23512991Sgabeblack@google.com PendingSensitivity(p), exp(exp) 23612991Sgabeblack@google.com {} 23712991Sgabeblack@google.com 23812991Sgabeblack@google.com void 23912991Sgabeblack@google.com finalize(Sensitivities &s) override 24012991Sgabeblack@google.com { 24112991Sgabeblack@google.com s.push_back(new SensitivityEvent(process, 24212991Sgabeblack@google.com &exp->get_interface()->default_event())); 24312991Sgabeblack@google.com } 24412991Sgabeblack@google.com}; 24512991Sgabeblack@google.com 24612957Sgabeblack@google.comclass PendingSensitivityFinder : public PendingSensitivity 24712957Sgabeblack@google.com{ 24812957Sgabeblack@google.com private: 24912957Sgabeblack@google.com const sc_core::sc_event_finder *finder; 25012957Sgabeblack@google.com 25112957Sgabeblack@google.com public: 25212957Sgabeblack@google.com PendingSensitivityFinder(Process *p, const sc_core::sc_event_finder *f) : 25312957Sgabeblack@google.com PendingSensitivity(p), finder(f) 25412957Sgabeblack@google.com {} 25512957Sgabeblack@google.com 25612957Sgabeblack@google.com void 25712957Sgabeblack@google.com finalize(Sensitivities &s) override 25812957Sgabeblack@google.com { 25912957Sgabeblack@google.com s.push_back(new SensitivityEvent(process, &finder->find_event())); 26012957Sgabeblack@google.com } 26112957Sgabeblack@google.com}; 26212957Sgabeblack@google.com 26312957Sgabeblack@google.comtypedef std::vector<PendingSensitivity *> PendingSensitivities; 26412957Sgabeblack@google.com 26512957Sgabeblack@google.com 26612953Sgabeblack@google.comclass Process : public ::sc_core::sc_object, public ListNode 26712952Sgabeblack@google.com{ 26812952Sgabeblack@google.com public: 26912952Sgabeblack@google.com virtual ::sc_core::sc_curr_proc_kind procKind() const = 0; 27012961Sgabeblack@google.com bool needsStart() const { return _needsStart; } 27112952Sgabeblack@google.com bool dynamic() const { return _dynamic; } 27212952Sgabeblack@google.com bool isUnwinding() const { return _isUnwinding; } 27312952Sgabeblack@google.com bool terminated() const { return _terminated; } 27412952Sgabeblack@google.com 27512952Sgabeblack@google.com void forEachKid(const std::function<void(Process *)> &work); 27612952Sgabeblack@google.com 27712952Sgabeblack@google.com bool suspended() const { return _suspended; } 27812952Sgabeblack@google.com bool disabled() const { return _disabled; } 27912952Sgabeblack@google.com 28012952Sgabeblack@google.com void suspend(bool inc_kids); 28112952Sgabeblack@google.com void resume(bool inc_kids); 28212952Sgabeblack@google.com void disable(bool inc_kids); 28312952Sgabeblack@google.com void enable(bool inc_kids); 28412952Sgabeblack@google.com 28512952Sgabeblack@google.com void kill(bool inc_kids); 28612952Sgabeblack@google.com void reset(bool inc_kids); 28712952Sgabeblack@google.com virtual void throw_it(ExceptionWrapperBase &exc, bool inc_kids); 28812952Sgabeblack@google.com 28912952Sgabeblack@google.com void injectException(ExceptionWrapperBase &exc); 29012952Sgabeblack@google.com ExceptionWrapperBase *excWrapper; 29112952Sgabeblack@google.com 29212952Sgabeblack@google.com void syncResetOn(bool inc_kids); 29312952Sgabeblack@google.com void syncResetOff(bool inc_kids); 29412952Sgabeblack@google.com 29512952Sgabeblack@google.com void incref() { refCount++; } 29612952Sgabeblack@google.com void decref() { refCount--; } 29712952Sgabeblack@google.com 29812952Sgabeblack@google.com const ::sc_core::sc_event &resetEvent() { return _resetEvent; } 29912952Sgabeblack@google.com const ::sc_core::sc_event &terminatedEvent() { return _terminatedEvent; } 30012952Sgabeblack@google.com 30112953Sgabeblack@google.com // This should only be called before initialization. 30212957Sgabeblack@google.com void dontInitialize(); 30312953Sgabeblack@google.com 30412953Sgabeblack@google.com void setStackSize(size_t size) { stackSize = size; } 30512953Sgabeblack@google.com 30612957Sgabeblack@google.com void finalize(); 30712957Sgabeblack@google.com 30812953Sgabeblack@google.com void run(); 30912953Sgabeblack@google.com 31012957Sgabeblack@google.com void addStatic(PendingSensitivity *); 31112957Sgabeblack@google.com void setDynamic(Sensitivity *); 31212957Sgabeblack@google.com 31312959Sgabeblack@google.com void satisfySensitivity(Sensitivity *); 31412959Sgabeblack@google.com 31512959Sgabeblack@google.com void ready(); 31612959Sgabeblack@google.com 31712953Sgabeblack@google.com virtual Fiber *fiber() { return Fiber::primaryFiber(); } 31812953Sgabeblack@google.com 31912953Sgabeblack@google.com static Process *newest() { return _newest; } 32012953Sgabeblack@google.com 32112952Sgabeblack@google.com protected: 32212961Sgabeblack@google.com Process(const char *name, ProcessFuncWrapper *func, bool _dynamic, 32312961Sgabeblack@google.com bool needs_start); 32412953Sgabeblack@google.com 32512953Sgabeblack@google.com static Process *_newest; 32612952Sgabeblack@google.com 32712957Sgabeblack@google.com virtual ~Process() 32812957Sgabeblack@google.com { 32912957Sgabeblack@google.com delete func; 33012957Sgabeblack@google.com for (auto s: staticSensitivities) 33112957Sgabeblack@google.com delete s; 33212957Sgabeblack@google.com } 33312952Sgabeblack@google.com 33412952Sgabeblack@google.com ::sc_core::sc_event _resetEvent; 33512952Sgabeblack@google.com ::sc_core::sc_event _terminatedEvent; 33612952Sgabeblack@google.com 33712952Sgabeblack@google.com ProcessFuncWrapper *func; 33812952Sgabeblack@google.com sc_core::sc_curr_proc_kind _procKind; 33912961Sgabeblack@google.com bool _needsStart; 34012952Sgabeblack@google.com bool _dynamic; 34112952Sgabeblack@google.com bool _isUnwinding; 34212952Sgabeblack@google.com bool _terminated; 34312952Sgabeblack@google.com 34412952Sgabeblack@google.com bool _suspended; 34512959Sgabeblack@google.com bool _suspendedReady; 34612952Sgabeblack@google.com bool _disabled; 34712952Sgabeblack@google.com 34812952Sgabeblack@google.com bool _syncReset; 34912952Sgabeblack@google.com 35012952Sgabeblack@google.com int refCount; 35112952Sgabeblack@google.com 35212953Sgabeblack@google.com size_t stackSize; 35312957Sgabeblack@google.com 35412957Sgabeblack@google.com Sensitivities staticSensitivities; 35512957Sgabeblack@google.com PendingSensitivities pendingStaticSensitivities; 35612957Sgabeblack@google.com 35712957Sgabeblack@google.com Sensitivity *dynamicSensitivity; 35812952Sgabeblack@google.com}; 35912952Sgabeblack@google.com 36012957Sgabeblack@google.cominline void 36112959Sgabeblack@google.comSensitivity::notifyWork(Event *e) 36212959Sgabeblack@google.com{ 36312959Sgabeblack@google.com process->satisfySensitivity(this); 36412959Sgabeblack@google.com} 36512959Sgabeblack@google.com 36612959Sgabeblack@google.cominline void 36712957Sgabeblack@google.comSensitivity::notify(Event *e) 36812957Sgabeblack@google.com{ 36912957Sgabeblack@google.com if (!process->disabled()) 37012957Sgabeblack@google.com notifyWork(e); 37112957Sgabeblack@google.com} 37212957Sgabeblack@google.com 37312957Sgabeblack@google.cominline const std::string 37412957Sgabeblack@google.comSensitivity::name() 37512957Sgabeblack@google.com{ 37612957Sgabeblack@google.com return std::string(process->name()) + ".timeout"; 37712957Sgabeblack@google.com} 37812957Sgabeblack@google.com 37912952Sgabeblack@google.com} // namespace sc_gem5 38012952Sgabeblack@google.com 38112952Sgabeblack@google.com#endif //__SYSTEMC_CORE_PROCESS_HH__ 382