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