event.cc revision 13295
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/event.hh" 31 32#include <algorithm> 33#include <cstring> 34#include <utility> 35 36#include "base/logging.hh" 37#include "sim/core.hh" 38#include "systemc/core/module.hh" 39#include "systemc/core/scheduler.hh" 40#include "systemc/ext/core/sc_main.hh" 41#include "systemc/ext/core/sc_module.hh" 42 43namespace sc_gem5 44{ 45 46Event::Event(sc_core::sc_event *_sc_event) : Event(_sc_event, nullptr) {} 47 48Event::Event(sc_core::sc_event *_sc_event, const char *_basename_cstr) : 49 _sc_event(_sc_event), _basename(_basename_cstr ? _basename_cstr : ""), 50 delayedNotify([this]() { this->notify(); }), _triggeredStamp(~0ULL) 51{ 52 if (_basename == "" && ::sc_core::sc_is_running()) 53 _basename = ::sc_core::sc_gen_unique_name("event"); 54 55 parent = pickParentObj(); 56 57 std::string original_name = _basename; 58 _basename = pickUniqueName(parent, _basename); 59 60 if (parent) { 61 Object *obj = Object::getFromScObject(parent); 62 obj->addChildEvent(_sc_event); 63 } else { 64 topLevelEvents.emplace(topLevelEvents.end(), _sc_event); 65 } 66 67 std::string path = parent ? (std::string(parent->name()) + ".") : ""; 68 69 if (original_name != "" && _basename != original_name) { 70 std::string message = path + original_name + 71 ". Latter declaration will be renamed to " + 72 path + _basename; 73 SC_REPORT_WARNING("(W505) object already exists", message.c_str()); 74 } 75 76 _name = path + _basename; 77 78 allEvents.emplace(allEvents.end(), _sc_event); 79 80 // Determine if we're in the hierarchy (created once initialization starts 81 // means no). 82} 83 84Event::~Event() 85{ 86 if (parent) { 87 Object *obj = Object::getFromScObject(parent); 88 obj->delChildEvent(_sc_event); 89 } else { 90 EventsIt it = find(topLevelEvents.begin(), topLevelEvents.end(), 91 _sc_event); 92 assert(it != topLevelEvents.end()); 93 std::swap(*it, topLevelEvents.back()); 94 topLevelEvents.pop_back(); 95 } 96 97 EventsIt it = findEvent(_name); 98 std::swap(*it, allEvents.back()); 99 allEvents.pop_back(); 100 101 if (delayedNotify.scheduled()) 102 scheduler.deschedule(&delayedNotify); 103} 104 105const std::string & 106Event::name() const 107{ 108 return _name; 109} 110 111const std::string & 112Event::basename() const 113{ 114 return _basename; 115} 116 117bool 118Event::inHierarchy() const 119{ 120 return _name.length() != 0; 121} 122 123sc_core::sc_object * 124Event::getParentObject() const 125{ 126 return parent; 127} 128 129void 130Event::notify(StaticSensitivities &senses) 131{ 132 for (auto s: senses) 133 s->notify(this); 134} 135 136void 137Event::notify(DynamicSensitivities &senses) 138{ 139 int size = senses.size(); 140 int pos = 0; 141 while (pos < size) { 142 if (senses[pos]->notify(this)) 143 senses[pos] = senses[--size]; 144 else 145 pos++; 146 } 147 senses.resize(size); 148} 149 150void 151Event::notify() 152{ 153 if (scheduler.inUpdate()) { 154 SC_REPORT_ERROR("(E521) immediate notification is not allowed " 155 "during update phase or elaboration", ""); 156 } 157 158 // An immediate notification overrides any pending delayed notification. 159 if (delayedNotify.scheduled()) 160 scheduler.deschedule(&delayedNotify); 161 162 _triggeredStamp = scheduler.changeStamp(); 163 notify(staticSenseMethod); 164 notify(dynamicSenseMethod); 165 notify(staticSenseThread); 166 notify(dynamicSenseThread); 167} 168 169void 170Event::notify(const sc_core::sc_time &t) 171{ 172 if (delayedNotify.scheduled()) { 173 if (scheduler.delayed(t) >= delayedNotify.when()) 174 return; 175 176 scheduler.deschedule(&delayedNotify); 177 } 178 scheduler.schedule(&delayedNotify, t); 179} 180 181void 182Event::cancel() 183{ 184 if (delayedNotify.scheduled()) 185 scheduler.deschedule(&delayedNotify); 186} 187 188bool 189Event::triggered() const 190{ 191 return _triggeredStamp == scheduler.changeStamp(); 192} 193 194void 195Event::clearParent() 196{ 197 if (!parent) 198 return; 199 Object::getFromScObject(parent)->delChildEvent(sc_event()); 200 parent = nullptr; 201 topLevelEvents.emplace(topLevelEvents.end(), sc_event()); 202} 203 204Events topLevelEvents; 205Events allEvents; 206 207EventsIt 208findEvent(const std::string &name) 209{ 210 EventsIt it; 211 for (it = allEvents.begin(); it != allEvents.end(); it++) 212 if (!strcmp((*it)->name(), name.c_str())) 213 break; 214 215 return it; 216} 217 218} // namespace sc_gem5 219