process.hh revision 13206
1/* 2 * Copyright 2018 Google, Inc. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: redistributions of source code must retain the above copyright 7 * notice, this list of conditions and the following disclaimer; 8 * redistributions in binary form must reproduce the above copyright 9 * notice, this list of conditions and the following disclaimer in the 10 * documentation and/or other materials provided with the distribution; 11 * neither the name of the copyright holders nor the names of its 12 * contributors may be used to endorse or promote products derived from 13 * this software without specific prior written permission. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * 27 * Authors: Gabe Black 28 */ 29 30#ifndef __SYSTEMC_CORE_PROCESS_HH__ 31#define __SYSTEMC_CORE_PROCESS_HH__ 32 33#include <functional> 34#include <memory> 35#include <vector> 36 37#include "base/fiber.hh" 38#include "systemc/core/bindinfo.hh" 39#include "systemc/core/list.hh" 40#include "systemc/core/object.hh" 41#include "systemc/core/sched_event.hh" 42#include "systemc/core/sensitivity.hh" 43#include "systemc/ext/core/sc_event.hh" 44#include "systemc/ext/core/sc_module.hh" 45#include "systemc/ext/core/sc_process_handle.hh" 46 47namespace sc_core 48{ 49 50class sc_join; 51 52} // namespace sc_core 53 54namespace sc_gem5 55{ 56 57class ScHalt 58{}; 59 60class Process : public ::sc_core::sc_process_b, public ListNode 61{ 62 public: 63 virtual ::sc_core::sc_curr_proc_kind procKind() const = 0; 64 bool needsStart() const { return _needsStart; } 65 void needsStart(bool ns) { _needsStart = ns; } 66 bool dynamic() const { return _dynamic; } 67 bool isUnwinding() const { return _isUnwinding; } 68 void isUnwinding(bool v) { _isUnwinding = v; } 69 bool terminated() const { return _terminated; } 70 71 void forEachKid(const std::function<void(Process *)> &work); 72 73 bool suspended() const { return _suspended; } 74 bool disabled() const { return _disabled; } 75 76 void suspend(bool inc_kids); 77 void resume(bool inc_kids); 78 void disable(bool inc_kids); 79 void enable(bool inc_kids); 80 81 void kill(bool inc_kids); 82 void reset(bool inc_kids); 83 virtual void throw_it(ExceptionWrapperBase &exc, bool inc_kids); 84 85 void injectException(ExceptionWrapperBase &exc); 86 ExceptionWrapperBase *excWrapper; 87 88 void syncResetOn(bool inc_kids); 89 void syncResetOff(bool inc_kids); 90 91 void incref() { refCount++; } 92 void decref() { refCount--; } 93 94 const ::sc_core::sc_event &resetEvent() { return _resetEvent; } 95 const ::sc_core::sc_event &terminatedEvent() { return _terminatedEvent; } 96 97 void setStackSize(size_t size) { stackSize = size; } 98 99 void finalize(); 100 101 void run(); 102 103 void addStatic(StaticSensitivity *); 104 void setDynamic(DynamicSensitivity *); 105 void clearDynamic() { setDynamic(nullptr); } 106 107 ScEvent timeoutEvent; 108 void setTimeout(::sc_core::sc_time t); 109 void cancelTimeout(); 110 111 void satisfySensitivity(Sensitivity *); 112 113 void ready(); 114 115 virtual Fiber *fiber() { return Fiber::primaryFiber(); } 116 117 static Process *newest() { return _newest; } 118 119 void lastReport(::sc_core::sc_report *report); 120 ::sc_core::sc_report *lastReport() const; 121 122 bool hasStaticSensitivities() { return !staticSensitivities.empty(); } 123 bool internal() { return _internal; } 124 bool timedOut() { return _timedOut; } 125 126 bool dontInitialize() { return _dontInitialize; } 127 void dontInitialize(bool di) { _dontInitialize = di; } 128 129 void joinWait(::sc_core::sc_join *join) { joinWaiters.push_back(join); } 130 131 protected: 132 void timeout(); 133 134 Process(const char *name, ProcessFuncWrapper *func, bool internal=false); 135 136 static Process *_newest; 137 138 virtual ~Process() 139 { 140 popListNode(); 141 delete func; 142 for (auto s: staticSensitivities) { 143 s->clear(); 144 delete s; 145 } 146 clearDynamic(); 147 } 148 149 ::sc_core::sc_event _resetEvent; 150 ::sc_core::sc_event _terminatedEvent; 151 152 ProcessFuncWrapper *func; 153 sc_core::sc_curr_proc_kind _procKind; 154 155 bool _internal; 156 157 // Needed to support the deprecated "timed_out" function. 158 bool _timedOut; 159 160 bool _dontInitialize; 161 162 bool _needsStart; 163 bool _dynamic; 164 bool _isUnwinding; 165 bool _terminated; 166 167 void terminate(); 168 169 bool _suspended; 170 bool _suspendedReady; 171 bool _disabled; 172 173 bool _syncReset; 174 175 int refCount; 176 177 size_t stackSize; 178 179 StaticSensitivities staticSensitivities; 180 DynamicSensitivity *dynamicSensitivity; 181 182 std::unique_ptr<::sc_core::sc_report> _lastReport; 183 184 std::vector<::sc_core::sc_join *> joinWaiters; 185}; 186 187} // namespace sc_gem5 188 189#endif //__SYSTEMC_CORE_PROCESS_HH__ 190