process.hh revision 13206
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 "systemc/core/bindinfo.hh" 3912953Sgabeblack@google.com#include "systemc/core/list.hh" 4012952Sgabeblack@google.com#include "systemc/core/object.hh" 4113063Sgabeblack@google.com#include "systemc/core/sched_event.hh" 4213206Sgabeblack@google.com#include "systemc/core/sensitivity.hh" 4312952Sgabeblack@google.com#include "systemc/ext/core/sc_event.hh" 4412952Sgabeblack@google.com#include "systemc/ext/core/sc_module.hh" 4512952Sgabeblack@google.com#include "systemc/ext/core/sc_process_handle.hh" 4612952Sgabeblack@google.com 4713196Sgabeblack@google.comnamespace sc_core 4813196Sgabeblack@google.com{ 4913196Sgabeblack@google.com 5013196Sgabeblack@google.comclass sc_join; 5113196Sgabeblack@google.com 5213196Sgabeblack@google.com} // namespace sc_core 5313196Sgabeblack@google.com 5412952Sgabeblack@google.comnamespace sc_gem5 5512952Sgabeblack@google.com{ 5612952Sgabeblack@google.com 5713175Sgabeblack@google.comclass ScHalt 5813175Sgabeblack@google.com{}; 5913175Sgabeblack@google.com 6013087Sgabeblack@google.comclass Process : public ::sc_core::sc_process_b, public ListNode 6112952Sgabeblack@google.com{ 6212952Sgabeblack@google.com public: 6312952Sgabeblack@google.com virtual ::sc_core::sc_curr_proc_kind procKind() const = 0; 6412961Sgabeblack@google.com bool needsStart() const { return _needsStart; } 6513093Sgabeblack@google.com void needsStart(bool ns) { _needsStart = ns; } 6612952Sgabeblack@google.com bool dynamic() const { return _dynamic; } 6712952Sgabeblack@google.com bool isUnwinding() const { return _isUnwinding; } 6812997Sgabeblack@google.com void isUnwinding(bool v) { _isUnwinding = v; } 6912952Sgabeblack@google.com bool terminated() const { return _terminated; } 7012952Sgabeblack@google.com 7112952Sgabeblack@google.com void forEachKid(const std::function<void(Process *)> &work); 7212952Sgabeblack@google.com 7312952Sgabeblack@google.com bool suspended() const { return _suspended; } 7412952Sgabeblack@google.com bool disabled() const { return _disabled; } 7512952Sgabeblack@google.com 7612952Sgabeblack@google.com void suspend(bool inc_kids); 7712952Sgabeblack@google.com void resume(bool inc_kids); 7812952Sgabeblack@google.com void disable(bool inc_kids); 7912952Sgabeblack@google.com void enable(bool inc_kids); 8012952Sgabeblack@google.com 8112952Sgabeblack@google.com void kill(bool inc_kids); 8212952Sgabeblack@google.com void reset(bool inc_kids); 8312952Sgabeblack@google.com virtual void throw_it(ExceptionWrapperBase &exc, bool inc_kids); 8412952Sgabeblack@google.com 8512952Sgabeblack@google.com void injectException(ExceptionWrapperBase &exc); 8612952Sgabeblack@google.com ExceptionWrapperBase *excWrapper; 8712952Sgabeblack@google.com 8812952Sgabeblack@google.com void syncResetOn(bool inc_kids); 8912952Sgabeblack@google.com void syncResetOff(bool inc_kids); 9012952Sgabeblack@google.com 9112952Sgabeblack@google.com void incref() { refCount++; } 9212952Sgabeblack@google.com void decref() { refCount--; } 9312952Sgabeblack@google.com 9412952Sgabeblack@google.com const ::sc_core::sc_event &resetEvent() { return _resetEvent; } 9512952Sgabeblack@google.com const ::sc_core::sc_event &terminatedEvent() { return _terminatedEvent; } 9612952Sgabeblack@google.com 9712953Sgabeblack@google.com void setStackSize(size_t size) { stackSize = size; } 9812953Sgabeblack@google.com 9912957Sgabeblack@google.com void finalize(); 10012957Sgabeblack@google.com 10112953Sgabeblack@google.com void run(); 10212953Sgabeblack@google.com 10313206Sgabeblack@google.com void addStatic(StaticSensitivity *); 10413206Sgabeblack@google.com void setDynamic(DynamicSensitivity *); 10513206Sgabeblack@google.com void clearDynamic() { setDynamic(nullptr); } 10613206Sgabeblack@google.com 10713206Sgabeblack@google.com ScEvent timeoutEvent; 10813206Sgabeblack@google.com void setTimeout(::sc_core::sc_time t); 10913206Sgabeblack@google.com void cancelTimeout(); 11012957Sgabeblack@google.com 11112959Sgabeblack@google.com void satisfySensitivity(Sensitivity *); 11212959Sgabeblack@google.com 11312959Sgabeblack@google.com void ready(); 11412959Sgabeblack@google.com 11512953Sgabeblack@google.com virtual Fiber *fiber() { return Fiber::primaryFiber(); } 11612953Sgabeblack@google.com 11712953Sgabeblack@google.com static Process *newest() { return _newest; } 11812953Sgabeblack@google.com 11912997Sgabeblack@google.com void lastReport(::sc_core::sc_report *report); 12012997Sgabeblack@google.com ::sc_core::sc_report *lastReport() const; 12112997Sgabeblack@google.com 12213180Sgabeblack@google.com bool hasStaticSensitivities() { return !staticSensitivities.empty(); } 12313180Sgabeblack@google.com bool internal() { return _internal; } 12413189Sgabeblack@google.com bool timedOut() { return _timedOut; } 12513180Sgabeblack@google.com 12613194Sgabeblack@google.com bool dontInitialize() { return _dontInitialize; } 12713194Sgabeblack@google.com void dontInitialize(bool di) { _dontInitialize = di; } 12813194Sgabeblack@google.com 12913196Sgabeblack@google.com void joinWait(::sc_core::sc_join *join) { joinWaiters.push_back(join); } 13013196Sgabeblack@google.com 13112952Sgabeblack@google.com protected: 13213206Sgabeblack@google.com void timeout(); 13313206Sgabeblack@google.com 13413180Sgabeblack@google.com Process(const char *name, ProcessFuncWrapper *func, bool internal=false); 13512953Sgabeblack@google.com 13612953Sgabeblack@google.com static Process *_newest; 13712952Sgabeblack@google.com 13812957Sgabeblack@google.com virtual ~Process() 13912957Sgabeblack@google.com { 14013072Sgabeblack@google.com popListNode(); 14112957Sgabeblack@google.com delete func; 14213206Sgabeblack@google.com for (auto s: staticSensitivities) { 14313206Sgabeblack@google.com s->clear(); 14412957Sgabeblack@google.com delete s; 14513206Sgabeblack@google.com } 14613206Sgabeblack@google.com clearDynamic(); 14712957Sgabeblack@google.com } 14812952Sgabeblack@google.com 14912952Sgabeblack@google.com ::sc_core::sc_event _resetEvent; 15012952Sgabeblack@google.com ::sc_core::sc_event _terminatedEvent; 15112952Sgabeblack@google.com 15212952Sgabeblack@google.com ProcessFuncWrapper *func; 15312952Sgabeblack@google.com sc_core::sc_curr_proc_kind _procKind; 15413180Sgabeblack@google.com 15513180Sgabeblack@google.com bool _internal; 15613180Sgabeblack@google.com 15713189Sgabeblack@google.com // Needed to support the deprecated "timed_out" function. 15813189Sgabeblack@google.com bool _timedOut; 15913189Sgabeblack@google.com 16013194Sgabeblack@google.com bool _dontInitialize; 16113194Sgabeblack@google.com 16212961Sgabeblack@google.com bool _needsStart; 16312952Sgabeblack@google.com bool _dynamic; 16412952Sgabeblack@google.com bool _isUnwinding; 16512952Sgabeblack@google.com bool _terminated; 16612952Sgabeblack@google.com 16712998Sgabeblack@google.com void terminate(); 16812998Sgabeblack@google.com 16912952Sgabeblack@google.com bool _suspended; 17012959Sgabeblack@google.com bool _suspendedReady; 17112952Sgabeblack@google.com bool _disabled; 17212952Sgabeblack@google.com 17312952Sgabeblack@google.com bool _syncReset; 17412952Sgabeblack@google.com 17512952Sgabeblack@google.com int refCount; 17612952Sgabeblack@google.com 17712953Sgabeblack@google.com size_t stackSize; 17812957Sgabeblack@google.com 17913206Sgabeblack@google.com StaticSensitivities staticSensitivities; 18013206Sgabeblack@google.com DynamicSensitivity *dynamicSensitivity; 18112997Sgabeblack@google.com 18212997Sgabeblack@google.com std::unique_ptr<::sc_core::sc_report> _lastReport; 18313196Sgabeblack@google.com 18413196Sgabeblack@google.com std::vector<::sc_core::sc_join *> joinWaiters; 18512952Sgabeblack@google.com}; 18612952Sgabeblack@google.com 18712952Sgabeblack@google.com} // namespace sc_gem5 18812952Sgabeblack@google.com 18912952Sgabeblack@google.com#endif //__SYSTEMC_CORE_PROCESS_HH__ 190