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