process.hh revision 12998:68d2c7538b82
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 "sim/eventq.hh" 39#include "systemc/core/bindinfo.hh" 40#include "systemc/core/list.hh" 41#include "systemc/core/object.hh" 42#include "systemc/ext/core/sc_event.hh" 43#include "systemc/ext/core/sc_export.hh" 44#include "systemc/ext/core/sc_interface.hh" 45#include "systemc/ext/core/sc_module.hh" 46#include "systemc/ext/core/sc_port.hh" 47#include "systemc/ext/core/sc_process_handle.hh" 48#include "systemc/ext/utils/sc_report.hh" 49 50namespace sc_gem5 51{ 52 53class Sensitivity 54{ 55 protected: 56 Process *process; 57 58 public: 59 Sensitivity(Process *p) : process(p) {} 60 virtual ~Sensitivity() {} 61 62 virtual void notifyWork(Event *e); 63 void notify(Event *e); 64 void notify() { notify(nullptr); } 65 66 const std::string name(); 67}; 68 69class SensitivityTimeout : virtual public Sensitivity 70{ 71 private: 72 void timeout(); 73 EventWrapper<SensitivityTimeout, 74 &SensitivityTimeout::timeout> timeoutEvent; 75 ::sc_core::sc_time time; 76 77 public: 78 SensitivityTimeout(Process *p, ::sc_core::sc_time t); 79 ~SensitivityTimeout(); 80}; 81 82class SensitivityEvent : virtual public Sensitivity 83{ 84 private: 85 const ::sc_core::sc_event *event; 86 87 public: 88 SensitivityEvent(Process *p, const ::sc_core::sc_event *e); 89 ~SensitivityEvent(); 90}; 91 92//XXX This sensitivity can't be reused. To reset it, it has to be deleted and 93//recreated. That works for dynamic sensitivities, but not for static. 94//Fortunately processes can't be statically sensitive to sc_event_and_lists. 95class SensitivityEventAndList : virtual public Sensitivity 96{ 97 private: 98 const ::sc_core::sc_event_and_list *list; 99 int count; 100 101 public: 102 SensitivityEventAndList( 103 Process *p, const ::sc_core::sc_event_and_list *list); 104 ~SensitivityEventAndList(); 105 106 void notifyWork(Event *e) override; 107}; 108 109class SensitivityEventOrList : virtual public Sensitivity 110{ 111 private: 112 const ::sc_core::sc_event_or_list *list; 113 114 public: 115 SensitivityEventOrList( 116 Process *p, const ::sc_core::sc_event_or_list *list); 117 ~SensitivityEventOrList(); 118}; 119 120// Combined sensitivities. These trigger when any of their parts do. 121 122class SensitivityTimeoutAndEvent : 123 public SensitivityTimeout, public SensitivityEvent 124{ 125 public: 126 SensitivityTimeoutAndEvent( 127 Process *p, ::sc_core::sc_time t, const ::sc_core::sc_event *e) : 128 Sensitivity(p), SensitivityTimeout(p, t), SensitivityEvent(p, e) 129 {} 130}; 131 132class SensitivityTimeoutAndEventAndList : 133 public SensitivityTimeout, public SensitivityEventAndList 134{ 135 public: 136 SensitivityTimeoutAndEventAndList( 137 Process *p, ::sc_core::sc_time t, 138 const ::sc_core::sc_event_and_list *eal) : 139 Sensitivity(p), SensitivityTimeout(p, t), 140 SensitivityEventAndList(p, eal) 141 {} 142}; 143 144class SensitivityTimeoutAndEventOrList : 145 public SensitivityTimeout, public SensitivityEventOrList 146{ 147 public: 148 SensitivityTimeoutAndEventOrList( 149 Process *p, ::sc_core::sc_time t, 150 const ::sc_core::sc_event_or_list *eol) : 151 Sensitivity(p), SensitivityTimeout(p, t), 152 SensitivityEventOrList(p, eol) 153 {} 154}; 155 156typedef std::vector<Sensitivity *> Sensitivities; 157 158 159/* 160 * Pending sensitivities. These are records of sensitivities to install later, 161 * once all the information to configure them is available. 162 */ 163 164class PendingSensitivity 165{ 166 protected: 167 Process *process; 168 169 public: 170 virtual void finalize(Sensitivities &s) = 0; 171 PendingSensitivity(Process *p) : process(p) {} 172 virtual ~PendingSensitivity() {} 173}; 174 175class PendingSensitivityEvent : public PendingSensitivity 176{ 177 private: 178 const sc_core::sc_event *event; 179 180 public: 181 PendingSensitivityEvent(Process *p, const sc_core::sc_event *e) : 182 PendingSensitivity(p), event(e) {} 183 184 void 185 finalize(Sensitivities &s) override 186 { 187 s.push_back(new SensitivityEvent(process, event)); 188 } 189}; 190 191class PendingSensitivityInterface : public PendingSensitivity 192{ 193 private: 194 const sc_core::sc_interface *interface; 195 196 public: 197 PendingSensitivityInterface(Process *p, const sc_core::sc_interface *i) : 198 PendingSensitivity(p), interface(i) 199 {} 200 201 void 202 finalize(Sensitivities &s) override 203 { 204 s.push_back(new SensitivityEvent(process, 205 &interface->default_event())); 206 } 207}; 208 209class PendingSensitivityPort : public PendingSensitivity 210{ 211 private: 212 const sc_core::sc_port_base *port; 213 214 public: 215 PendingSensitivityPort(Process *p, const sc_core::sc_port_base *pb) : 216 PendingSensitivity(p), port(pb) 217 {} 218 219 void 220 finalize(Sensitivities &s) override 221 { 222 for (int i = 0; i < port->size(); i++) { 223 const ::sc_core::sc_event *e = 224 &port->_gem5BindInfo[i]->interface->default_event(); 225 s.push_back(new SensitivityEvent(process, e)); 226 } 227 } 228}; 229 230class PendingSensitivityExport : public PendingSensitivity 231{ 232 private: 233 const sc_core::sc_export_base *exp; 234 235 public: 236 PendingSensitivityExport(Process *p, const sc_core::sc_export_base *exp) : 237 PendingSensitivity(p), exp(exp) 238 {} 239 240 void 241 finalize(Sensitivities &s) override 242 { 243 s.push_back(new SensitivityEvent(process, 244 &exp->get_interface()->default_event())); 245 } 246}; 247 248class PendingSensitivityFinder : public PendingSensitivity 249{ 250 private: 251 const sc_core::sc_event_finder *finder; 252 253 public: 254 PendingSensitivityFinder(Process *p, const sc_core::sc_event_finder *f) : 255 PendingSensitivity(p), finder(f) 256 {} 257 258 void 259 finalize(Sensitivities &s) override 260 { 261 s.push_back(new SensitivityEvent(process, &finder->find_event())); 262 } 263}; 264 265typedef std::vector<PendingSensitivity *> PendingSensitivities; 266 267 268class Process : public ::sc_core::sc_object, public ListNode 269{ 270 public: 271 virtual ::sc_core::sc_curr_proc_kind procKind() const = 0; 272 bool needsStart() const { return _needsStart; } 273 bool dynamic() const { return _dynamic; } 274 bool isUnwinding() const { return _isUnwinding; } 275 void isUnwinding(bool v) { _isUnwinding = v; } 276 bool terminated() const { return _terminated; } 277 278 void forEachKid(const std::function<void(Process *)> &work); 279 280 bool suspended() const { return _suspended; } 281 bool disabled() const { return _disabled; } 282 283 void suspend(bool inc_kids); 284 void resume(bool inc_kids); 285 void disable(bool inc_kids); 286 void enable(bool inc_kids); 287 288 void kill(bool inc_kids); 289 void reset(bool inc_kids); 290 virtual void throw_it(ExceptionWrapperBase &exc, bool inc_kids); 291 292 void injectException(ExceptionWrapperBase &exc); 293 ExceptionWrapperBase *excWrapper; 294 295 void syncResetOn(bool inc_kids); 296 void syncResetOff(bool inc_kids); 297 298 void incref() { refCount++; } 299 void decref() { refCount--; } 300 301 const ::sc_core::sc_event &resetEvent() { return _resetEvent; } 302 const ::sc_core::sc_event &terminatedEvent() { return _terminatedEvent; } 303 304 // This should only be called before initialization. 305 void dontInitialize(); 306 307 void setStackSize(size_t size) { stackSize = size; } 308 309 void finalize(); 310 311 void run(); 312 313 void addStatic(PendingSensitivity *); 314 void setDynamic(Sensitivity *); 315 316 void satisfySensitivity(Sensitivity *); 317 318 void ready(); 319 320 virtual Fiber *fiber() { return Fiber::primaryFiber(); } 321 322 static Process *newest() { return _newest; } 323 324 void lastReport(::sc_core::sc_report *report); 325 ::sc_core::sc_report *lastReport() const; 326 327 protected: 328 Process(const char *name, ProcessFuncWrapper *func, bool _dynamic); 329 330 static Process *_newest; 331 332 virtual ~Process() 333 { 334 delete func; 335 for (auto s: staticSensitivities) 336 delete s; 337 } 338 339 ::sc_core::sc_event _resetEvent; 340 ::sc_core::sc_event _terminatedEvent; 341 342 ProcessFuncWrapper *func; 343 sc_core::sc_curr_proc_kind _procKind; 344 bool _needsStart; 345 bool _dynamic; 346 bool _isUnwinding; 347 bool _terminated; 348 349 void terminate(); 350 351 bool _suspended; 352 bool _suspendedReady; 353 bool _disabled; 354 355 bool _syncReset; 356 357 int refCount; 358 359 size_t stackSize; 360 361 Sensitivities staticSensitivities; 362 PendingSensitivities pendingStaticSensitivities; 363 364 Sensitivity *dynamicSensitivity; 365 366 std::unique_ptr<::sc_core::sc_report> _lastReport; 367}; 368 369inline void 370Sensitivity::notifyWork(Event *e) 371{ 372 process->satisfySensitivity(this); 373} 374 375inline void 376Sensitivity::notify(Event *e) 377{ 378 if (!process->disabled()) 379 notifyWork(e); 380} 381 382inline const std::string 383Sensitivity::name() 384{ 385 return std::string(process->name()) + ".timeout"; 386} 387 388} // namespace sc_gem5 389 390#endif //__SYSTEMC_CORE_PROCESS_HH__ 391