event.cc revision 13299
112955Sgabeblack@google.com/* 212955Sgabeblack@google.com * Copyright 2018 Google, Inc. 312955Sgabeblack@google.com * 412955Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512955Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612955Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712955Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812955Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912955Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012955Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112955Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212955Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312955Sgabeblack@google.com * this software without specific prior written permission. 1412955Sgabeblack@google.com * 1512955Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612955Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712955Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812955Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912955Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012955Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112955Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212955Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312955Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412955Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512955Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612955Sgabeblack@google.com * 2712955Sgabeblack@google.com * Authors: Gabe Black 2812955Sgabeblack@google.com */ 2912955Sgabeblack@google.com 3012955Sgabeblack@google.com#include "systemc/core/event.hh" 3112955Sgabeblack@google.com 3212988Sgabeblack@google.com#include <algorithm> 3312955Sgabeblack@google.com#include <cstring> 3412955Sgabeblack@google.com#include <utility> 3512955Sgabeblack@google.com 3612957Sgabeblack@google.com#include "base/logging.hh" 3712957Sgabeblack@google.com#include "sim/core.hh" 3812955Sgabeblack@google.com#include "systemc/core/module.hh" 3912955Sgabeblack@google.com#include "systemc/core/scheduler.hh" 4013086Sgabeblack@google.com#include "systemc/ext/core/sc_main.hh" 4113086Sgabeblack@google.com#include "systemc/ext/core/sc_module.hh" 4212955Sgabeblack@google.com 4312955Sgabeblack@google.comnamespace sc_gem5 4412955Sgabeblack@google.com{ 4512955Sgabeblack@google.com 4613086Sgabeblack@google.comEvent::Event(sc_core::sc_event *_sc_event) : Event(_sc_event, nullptr) {} 4712955Sgabeblack@google.com 4813086Sgabeblack@google.comEvent::Event(sc_core::sc_event *_sc_event, const char *_basename_cstr) : 4913086Sgabeblack@google.com _sc_event(_sc_event), _basename(_basename_cstr ? _basename_cstr : ""), 5013243Sgabeblack@google.com delayedNotify([this]() { this->notify(); }), _triggeredStamp(~0ULL) 5112955Sgabeblack@google.com{ 5213086Sgabeblack@google.com if (_basename == "" && ::sc_core::sc_is_running()) 5313086Sgabeblack@google.com _basename = ::sc_core::sc_gen_unique_name("event"); 5413086Sgabeblack@google.com 5513268Sgabeblack@google.com parent = pickParentObj(); 5612955Sgabeblack@google.com 5713179Sgabeblack@google.com std::string original_name = _basename; 5813179Sgabeblack@google.com _basename = pickUniqueName(parent, _basename); 5913127Sgabeblack@google.com 6012955Sgabeblack@google.com if (parent) { 6112955Sgabeblack@google.com Object *obj = Object::getFromScObject(parent); 6212988Sgabeblack@google.com obj->addChildEvent(_sc_event); 6312955Sgabeblack@google.com } else { 6412988Sgabeblack@google.com topLevelEvents.emplace(topLevelEvents.end(), _sc_event); 6512955Sgabeblack@google.com } 6612955Sgabeblack@google.com 6713179Sgabeblack@google.com std::string path = parent ? (std::string(parent->name()) + ".") : ""; 6813179Sgabeblack@google.com 6913179Sgabeblack@google.com if (original_name != "" && _basename != original_name) { 7013179Sgabeblack@google.com std::string message = path + original_name + 7113179Sgabeblack@google.com ". Latter declaration will be renamed to " + 7213179Sgabeblack@google.com path + _basename; 7313179Sgabeblack@google.com SC_REPORT_WARNING("(W505) object already exists", message.c_str()); 7413179Sgabeblack@google.com } 7513179Sgabeblack@google.com 7613179Sgabeblack@google.com _name = path + _basename; 7712955Sgabeblack@google.com 7812955Sgabeblack@google.com allEvents.emplace(allEvents.end(), _sc_event); 7912955Sgabeblack@google.com 8012955Sgabeblack@google.com // Determine if we're in the hierarchy (created once initialization starts 8112955Sgabeblack@google.com // means no). 8212955Sgabeblack@google.com} 8312955Sgabeblack@google.com 8412955Sgabeblack@google.comEvent::~Event() 8512955Sgabeblack@google.com{ 8612955Sgabeblack@google.com if (parent) { 8712955Sgabeblack@google.com Object *obj = Object::getFromScObject(parent); 8812988Sgabeblack@google.com obj->delChildEvent(_sc_event); 8912955Sgabeblack@google.com } else { 9012988Sgabeblack@google.com EventsIt it = find(topLevelEvents.begin(), topLevelEvents.end(), 9112988Sgabeblack@google.com _sc_event); 9212988Sgabeblack@google.com assert(it != topLevelEvents.end()); 9312988Sgabeblack@google.com std::swap(*it, topLevelEvents.back()); 9412955Sgabeblack@google.com topLevelEvents.pop_back(); 9512955Sgabeblack@google.com } 9612955Sgabeblack@google.com 9712955Sgabeblack@google.com EventsIt it = findEvent(_name); 9812955Sgabeblack@google.com std::swap(*it, allEvents.back()); 9912955Sgabeblack@google.com allEvents.pop_back(); 10012957Sgabeblack@google.com 10113063Sgabeblack@google.com if (delayedNotify.scheduled()) 10213063Sgabeblack@google.com scheduler.deschedule(&delayedNotify); 10312955Sgabeblack@google.com} 10412955Sgabeblack@google.com 10512955Sgabeblack@google.comconst std::string & 10612955Sgabeblack@google.comEvent::name() const 10712955Sgabeblack@google.com{ 10812955Sgabeblack@google.com return _name; 10912955Sgabeblack@google.com} 11012955Sgabeblack@google.com 11112955Sgabeblack@google.comconst std::string & 11212955Sgabeblack@google.comEvent::basename() const 11312955Sgabeblack@google.com{ 11412955Sgabeblack@google.com return _basename; 11512955Sgabeblack@google.com} 11612955Sgabeblack@google.com 11712955Sgabeblack@google.combool 11812955Sgabeblack@google.comEvent::inHierarchy() const 11912955Sgabeblack@google.com{ 12012955Sgabeblack@google.com return _name.length() != 0; 12112955Sgabeblack@google.com} 12212955Sgabeblack@google.com 12312955Sgabeblack@google.comsc_core::sc_object * 12412955Sgabeblack@google.comEvent::getParentObject() const 12512955Sgabeblack@google.com{ 12612955Sgabeblack@google.com return parent; 12712955Sgabeblack@google.com} 12812955Sgabeblack@google.com 12912955Sgabeblack@google.comvoid 13013208Sgabeblack@google.comEvent::notify(StaticSensitivities &senses) 13113208Sgabeblack@google.com{ 13213208Sgabeblack@google.com for (auto s: senses) 13313208Sgabeblack@google.com s->notify(this); 13413208Sgabeblack@google.com} 13513208Sgabeblack@google.com 13613208Sgabeblack@google.comvoid 13713208Sgabeblack@google.comEvent::notify(DynamicSensitivities &senses) 13813208Sgabeblack@google.com{ 13913208Sgabeblack@google.com int size = senses.size(); 14013208Sgabeblack@google.com int pos = 0; 14113208Sgabeblack@google.com while (pos < size) { 14213208Sgabeblack@google.com if (senses[pos]->notify(this)) 14313208Sgabeblack@google.com senses[pos] = senses[--size]; 14413208Sgabeblack@google.com else 14513208Sgabeblack@google.com pos++; 14613208Sgabeblack@google.com } 14713208Sgabeblack@google.com senses.resize(size); 14813208Sgabeblack@google.com} 14913208Sgabeblack@google.com 15013208Sgabeblack@google.comvoid 15112955Sgabeblack@google.comEvent::notify() 15212955Sgabeblack@google.com{ 15313187Sgabeblack@google.com if (scheduler.inUpdate()) { 15413187Sgabeblack@google.com SC_REPORT_ERROR("(E521) immediate notification is not allowed " 15513187Sgabeblack@google.com "during update phase or elaboration", ""); 15613187Sgabeblack@google.com } 15713187Sgabeblack@google.com 15813073Sgabeblack@google.com // An immediate notification overrides any pending delayed notification. 15913073Sgabeblack@google.com if (delayedNotify.scheduled()) 16013073Sgabeblack@google.com scheduler.deschedule(&delayedNotify); 16113073Sgabeblack@google.com 16213243Sgabeblack@google.com _triggeredStamp = scheduler.changeStamp(); 16313208Sgabeblack@google.com notify(staticSenseMethod); 16413208Sgabeblack@google.com notify(dynamicSenseMethod); 16513208Sgabeblack@google.com notify(staticSenseThread); 16613208Sgabeblack@google.com notify(dynamicSenseThread); 16712955Sgabeblack@google.com} 16812955Sgabeblack@google.com 16912955Sgabeblack@google.comvoid 17012955Sgabeblack@google.comEvent::notify(const sc_core::sc_time &t) 17112955Sgabeblack@google.com{ 17213063Sgabeblack@google.com if (delayedNotify.scheduled()) { 17313063Sgabeblack@google.com if (scheduler.delayed(t) >= delayedNotify.when()) 17412957Sgabeblack@google.com return; 17512957Sgabeblack@google.com 17613063Sgabeblack@google.com scheduler.deschedule(&delayedNotify); 17712957Sgabeblack@google.com } 17813063Sgabeblack@google.com scheduler.schedule(&delayedNotify, t); 17912955Sgabeblack@google.com} 18012955Sgabeblack@google.com 18112955Sgabeblack@google.comvoid 18213299Sgabeblack@google.comEvent::notifyDelayed(const sc_core::sc_time &t) 18313299Sgabeblack@google.com{ 18413299Sgabeblack@google.com if (delayedNotify.scheduled()) { 18513299Sgabeblack@google.com SC_REPORT_ERROR("(E531) notify_delayed() cannot be called on events " 18613299Sgabeblack@google.com "that have pending notifications", ""); 18713299Sgabeblack@google.com } 18813299Sgabeblack@google.com notify(t); 18913299Sgabeblack@google.com} 19013299Sgabeblack@google.com 19113299Sgabeblack@google.comvoid 19212955Sgabeblack@google.comEvent::cancel() 19312955Sgabeblack@google.com{ 19413063Sgabeblack@google.com if (delayedNotify.scheduled()) 19513063Sgabeblack@google.com scheduler.deschedule(&delayedNotify); 19612955Sgabeblack@google.com} 19712955Sgabeblack@google.com 19812955Sgabeblack@google.combool 19912955Sgabeblack@google.comEvent::triggered() const 20012955Sgabeblack@google.com{ 20113243Sgabeblack@google.com return _triggeredStamp == scheduler.changeStamp(); 20212955Sgabeblack@google.com} 20312955Sgabeblack@google.com 20413295Sgabeblack@google.comvoid 20513295Sgabeblack@google.comEvent::clearParent() 20613295Sgabeblack@google.com{ 20713295Sgabeblack@google.com if (!parent) 20813295Sgabeblack@google.com return; 20913295Sgabeblack@google.com Object::getFromScObject(parent)->delChildEvent(sc_event()); 21013295Sgabeblack@google.com parent = nullptr; 21113295Sgabeblack@google.com topLevelEvents.emplace(topLevelEvents.end(), sc_event()); 21213295Sgabeblack@google.com} 21313295Sgabeblack@google.com 21412955Sgabeblack@google.comEvents topLevelEvents; 21512955Sgabeblack@google.comEvents allEvents; 21612955Sgabeblack@google.com 21712955Sgabeblack@google.comEventsIt 21812955Sgabeblack@google.comfindEvent(const std::string &name) 21912955Sgabeblack@google.com{ 22012955Sgabeblack@google.com EventsIt it; 22112955Sgabeblack@google.com for (it = allEvents.begin(); it != allEvents.end(); it++) 22212955Sgabeblack@google.com if (!strcmp((*it)->name(), name.c_str())) 22312955Sgabeblack@google.com break; 22412955Sgabeblack@google.com 22512955Sgabeblack@google.com return it; 22612955Sgabeblack@google.com} 22712955Sgabeblack@google.com 22812955Sgabeblack@google.com} // namespace sc_gem5 229