process.cc revision 13093:bea17ab221ef
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#include "systemc/core/process.hh" 31 32#include "base/logging.hh" 33#include "systemc/core/event.hh" 34#include "systemc/core/scheduler.hh" 35#include "systemc/ext/core/sc_process_handle.hh" 36#include "systemc/ext/utils/sc_report_handler.hh" 37 38namespace sc_gem5 39{ 40 41SensitivityTimeout::SensitivityTimeout(Process *p, ::sc_core::sc_time t) : 42 Sensitivity(p), timeoutEvent([this]() { this->timeout(); }) 43{ 44 scheduler.schedule(&timeoutEvent, t); 45} 46 47SensitivityTimeout::~SensitivityTimeout() 48{ 49 if (timeoutEvent.scheduled()) 50 scheduler.deschedule(&timeoutEvent); 51} 52 53void 54SensitivityTimeout::timeout() 55{ 56 notify(); 57} 58 59SensitivityEvent::SensitivityEvent( 60 Process *p, const ::sc_core::sc_event *e) : Sensitivity(p), event(e) 61{ 62 Event::getFromScEvent(event)->addSensitivity(this); 63} 64 65SensitivityEvent::~SensitivityEvent() 66{ 67 Event::getFromScEvent(event)->delSensitivity(this); 68} 69 70SensitivityEventAndList::SensitivityEventAndList( 71 Process *p, const ::sc_core::sc_event_and_list *list) : 72 Sensitivity(p), list(list), count(0) 73{ 74 for (auto e: list->events) 75 Event::getFromScEvent(e)->addSensitivity(this); 76} 77 78SensitivityEventAndList::~SensitivityEventAndList() 79{ 80 for (auto e: list->events) 81 Event::getFromScEvent(e)->delSensitivity(this); 82} 83 84void 85SensitivityEventAndList::notifyWork(Event *e) 86{ 87 e->delSensitivity(this); 88 count++; 89 if (count == list->events.size()) 90 process->satisfySensitivity(this); 91} 92 93SensitivityEventOrList::SensitivityEventOrList( 94 Process *p, const ::sc_core::sc_event_or_list *list) : 95 Sensitivity(p), list(list) 96{ 97 for (auto e: list->events) 98 Event::getFromScEvent(e)->addSensitivity(this); 99} 100 101SensitivityEventOrList::~SensitivityEventOrList() 102{ 103 for (auto e: list->events) 104 Event::getFromScEvent(e)->delSensitivity(this); 105} 106 107void 108SensitivityTimeoutAndEventAndList::notifyWork(Event *e) 109{ 110 if (e) { 111 // An event went off which must be part of the sc_event_and_list. 112 SensitivityEventAndList::notifyWork(e); 113 } else { 114 // There's no inciting event, so this must be a timeout. 115 SensitivityTimeout::notifyWork(e); 116 } 117} 118 119 120class UnwindExceptionReset : public ::sc_core::sc_unwind_exception 121{ 122 public: 123 UnwindExceptionReset() { _isReset = true; } 124}; 125 126class UnwindExceptionKill : public ::sc_core::sc_unwind_exception 127{ 128 public: 129 UnwindExceptionKill() {} 130}; 131 132template <typename T> 133struct BuiltinExceptionWrapper : public ExceptionWrapperBase 134{ 135 public: 136 T t; 137 void throw_it() override { throw t; } 138}; 139 140BuiltinExceptionWrapper<UnwindExceptionReset> resetException; 141BuiltinExceptionWrapper<UnwindExceptionKill> killException; 142 143 144void 145Process::forEachKid(const std::function<void(Process *)> &work) 146{ 147 for (auto &kid: get_child_objects()) { 148 Process *p_kid = dynamic_cast<Process *>(kid); 149 if (p_kid) 150 work(p_kid); 151 } 152} 153 154void 155Process::suspend(bool inc_kids) 156{ 157 if (inc_kids) 158 forEachKid([](Process *p) { p->suspend(true); }); 159 160 if (!_suspended) { 161 _suspended = true; 162 _suspendedReady = false; 163 } 164 165 if (procKind() != ::sc_core::SC_METHOD_PROC_ && 166 scheduler.current() == this) { 167 scheduler.yield(); 168 } 169} 170 171void 172Process::resume(bool inc_kids) 173{ 174 if (inc_kids) 175 forEachKid([](Process *p) { p->resume(true); }); 176 177 if (_suspended) { 178 _suspended = false; 179 if (_suspendedReady) 180 ready(); 181 _suspendedReady = false; 182 } 183} 184 185void 186Process::disable(bool inc_kids) 187{ 188 if (inc_kids) 189 forEachKid([](Process *p) { p->disable(true); }); 190 191 if (!::sc_core::sc_allow_process_control_corners && 192 dynamic_cast<SensitivityTimeout *>(dynamicSensitivity)) { 193 std::string message("attempt to disable a thread with timeout wait: "); 194 message += name(); 195 SC_REPORT_ERROR("Undefined process control interaction", 196 message.c_str()); 197 } 198 199 _disabled = true; 200} 201 202void 203Process::enable(bool inc_kids) 204{ 205 206 if (inc_kids) 207 forEachKid([](Process *p) { p->enable(true); }); 208 209 _disabled = false; 210} 211 212void 213Process::kill(bool inc_kids) 214{ 215 // Propogate the kill to our children no matter what happens to us. 216 if (inc_kids) 217 forEachKid([](Process *p) { p->kill(true); }); 218 219 // If we're in the middle of unwinding, ignore the kill request. 220 if (_isUnwinding) 221 return; 222 223 // Update our state. 224 terminate(); 225 _isUnwinding = true; 226 227 // Make sure this process isn't marked ready 228 popListNode(); 229 230 // Inject the kill exception into this process if it's started. 231 if (!_needsStart) 232 injectException(killException); 233} 234 235void 236Process::reset(bool inc_kids) 237{ 238 // Propogate the reset to our children no matter what happens to us. 239 if (inc_kids) 240 forEachKid([](Process *p) { p->reset(true); }); 241 242 // If we're in the middle of unwinding, ignore the reset request. 243 if (_isUnwinding) 244 return; 245 246 247 if (_needsStart) { 248 scheduler.runNow(this); 249 } else { 250 _isUnwinding = true; 251 injectException(resetException); 252 } 253 254 _resetEvent.notify(); 255} 256 257void 258Process::throw_it(ExceptionWrapperBase &exc, bool inc_kids) 259{ 260 if (inc_kids) 261 forEachKid([&exc](Process *p) { p->throw_it(exc, true); }); 262 263 // Only inject an exception into threads that have started. 264 if (!_needsStart) 265 injectException(exc); 266} 267 268void 269Process::injectException(ExceptionWrapperBase &exc) 270{ 271 excWrapper = &exc; 272 scheduler.runNow(this); 273}; 274 275void 276Process::syncResetOn(bool inc_kids) 277{ 278 if (inc_kids) 279 forEachKid([](Process *p) { p->syncResetOn(true); }); 280 281 _syncReset = true; 282} 283 284void 285Process::syncResetOff(bool inc_kids) 286{ 287 if (inc_kids) 288 forEachKid([](Process *p) { p->syncResetOff(true); }); 289 290 _syncReset = false; 291} 292 293void 294Process::dontInitialize() 295{ 296 scheduler.dontInitialize(this); 297} 298 299void 300Process::finalize() 301{ 302 for (auto &s: pendingStaticSensitivities) { 303 s->finalize(staticSensitivities); 304 delete s; 305 s = nullptr; 306 } 307 pendingStaticSensitivities.clear(); 308}; 309 310void 311Process::run() 312{ 313 bool reset; 314 do { 315 reset = false; 316 try { 317 func->call(); 318 } catch(const ::sc_core::sc_unwind_exception &exc) { 319 reset = exc.is_reset(); 320 _isUnwinding = false; 321 } 322 } while (reset); 323 needsStart(true); 324} 325 326void 327Process::addStatic(PendingSensitivity *s) 328{ 329 pendingStaticSensitivities.push_back(s); 330} 331 332void 333Process::setDynamic(Sensitivity *s) 334{ 335 delete dynamicSensitivity; 336 dynamicSensitivity = s; 337} 338 339void 340Process::satisfySensitivity(Sensitivity *s) 341{ 342 // If there's a dynamic sensitivity and this wasn't it, ignore. 343 if (dynamicSensitivity && dynamicSensitivity != s) 344 return; 345 346 setDynamic(nullptr); 347 ready(); 348} 349 350void 351Process::ready() 352{ 353 if (disabled()) 354 return; 355 if (suspended()) 356 _suspendedReady = true; 357 else 358 scheduler.ready(this); 359} 360 361void 362Process::lastReport(::sc_core::sc_report *report) 363{ 364 if (report) { 365 _lastReport = std::unique_ptr<::sc_core::sc_report>( 366 new ::sc_core::sc_report(*report)); 367 } else { 368 _lastReport = nullptr; 369 } 370} 371 372::sc_core::sc_report *Process::lastReport() const { return _lastReport.get(); } 373 374Process::Process(const char *name, ProcessFuncWrapper *func, bool _dynamic) : 375 ::sc_core::sc_process_b(name), excWrapper(nullptr), func(func), 376 _needsStart(true), _dynamic(_dynamic), _isUnwinding(false), 377 _terminated(false), _suspended(false), _disabled(false), 378 _syncReset(false), refCount(0), stackSize(::Fiber::DefaultStackSize), 379 dynamicSensitivity(nullptr) 380{ 381 _newest = this; 382} 383 384void 385Process::terminate() 386{ 387 _terminated = true; 388 _suspendedReady = false; 389 _suspended = false; 390 _syncReset = false; 391 delete dynamicSensitivity; 392 dynamicSensitivity = nullptr; 393 for (auto s: staticSensitivities) 394 delete s; 395 staticSensitivities.clear(); 396 397 _terminatedEvent.notify(); 398} 399 400Process *Process::_newest; 401 402void 403throw_it_wrapper(Process *p, ExceptionWrapperBase &exc, bool inc_kids) 404{ 405 p->throw_it(exc, inc_kids); 406} 407 408} // namespace sc_gem5 409