2 * Copyright (c) 2000-2005 The Regents of The University of Michigan
3 * Copyright (c) 2008 The Hewlett-Packard Development Company
4 * Copyright (c) 2013 Advanced Micro Devices, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
9 * met: redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer;
11 * redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution;
14 * neither the name of the copyright holders nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * Authors: Steve Reinhardt
38 #include <unordered_map>
41 #include "base/misc.hh"
42 #include "base/trace.hh"
44 #include "debug/Checkpoint.hh"
45 #include "sim/core.hh"
46 #include "sim/eventq_impl.hh"
55 // Events on these queues are processed at the *beginning* of each
56 // cycle, before the pipeline simulation is performed.
58 uint32_t numMainEventQueues
= 0;
59 vector
<EventQueue
*> mainEventQueue
;
60 __thread EventQueue
*_curEventQueue
= NULL
;
61 bool inParallelMode
= false;
64 getEventQueue(uint32_t index
)
66 while (numMainEventQueues
<= index
) {
68 mainEventQueue
.push_back(
69 new EventQueue(csprintf("MainEventQueue-%d", index
)));
72 return mainEventQueue
[index
];
76 Counter
Event::instanceCounter
= 0;
89 return csprintf("Event_%d", instance
);
91 return csprintf("Event_%x", (uintptr_t)this);
97 Event::insertBefore(Event
*event
, Event
*curr
)
99 // Either way, event will be the top element in the 'in bin' list
100 // which is the pointer we need in order to look into the list, so
101 // we need to insert that into the bin list.
102 if (!curr
|| *event
< *curr
) {
103 // Insert the event before the current list since it is in the future.
104 event
->nextBin
= curr
;
105 event
->nextInBin
= NULL
;
107 // Since we're on the correct list, we need to point to the next list
108 event
->nextBin
= curr
->nextBin
; // curr->nextBin can now become stale
110 // Insert event at the top of the stack
111 event
->nextInBin
= curr
;
118 EventQueue::insert(Event
*event
)
120 // Deal with the head case
121 if (!head
|| *event
<= *head
) {
122 head
= Event::insertBefore(event
, head
);
126 // Figure out either which 'in bin' list we are on, or where a new list
127 // needs to be inserted
129 Event
*curr
= head
->nextBin
;
130 while (curr
&& *curr
< *event
) {
132 curr
= curr
->nextBin
;
135 // Note: this operation may render all nextBin pointers on the
136 // prev 'in bin' list stale (except for the top one)
137 prev
->nextBin
= Event::insertBefore(event
, curr
);
141 Event::removeItem(Event
*event
, Event
*top
)
144 Event
*next
= top
->nextInBin
;
146 // if we removed the top item, we need to handle things specially
147 // and just remove the top item, fixing up the next bin pointer of
152 next
->nextBin
= top
->nextBin
;
156 // Since we already checked the current element, we're going to
157 // keep checking event against the next element.
158 while (event
!= next
) {
160 panic("event not found!");
163 next
= next
->nextInBin
;
166 // remove next from the 'in bin' list since it's what we're looking for
167 curr
->nextInBin
= next
->nextInBin
;
172 EventQueue::remove(Event
*event
)
175 panic("event not found!");
177 assert(event
->queue
== this);
179 // deal with an event on the head's 'in bin' list (event has the same
181 if (*head
== *event
) {
182 head
= Event::removeItem(event
, head
);
186 // Find the 'in bin' list that this event belongs on
188 Event
*curr
= head
->nextBin
;
189 while (curr
&& *curr
< *event
) {
191 curr
= curr
->nextBin
;
194 if (!curr
|| *curr
!= *event
)
195 panic("event not found!");
197 // curr points to the top item of the the correct 'in bin' list, when
198 // we remove an item, it returns the new top item (which may be
200 prev
->nextBin
= Event::removeItem(event
, curr
);
204 EventQueue::serviceOne()
206 std::lock_guard
<EventQueue
> lock(*this);
208 Event
*next
= head
->nextInBin
;
209 event
->flags
.clear(Event::Scheduled
);
212 // update the next bin pointer since it could be stale
213 next
->nextBin
= head
->nextBin
;
218 // this was the only element on the 'in bin' list, so get rid of
219 // the 'in bin' list and point to the next bin list
220 head
= head
->nextBin
;
224 if (!event
->squashed()) {
225 // forward current cycle to the time when this event occurs.
226 setCurTick(event
->when());
229 if (event
->isExitEvent()) {
230 assert(!event
->flags
.isSet(Event::Managed
) ||
231 !event
->flags
.isSet(Event::IsMainQueue
)); // would be silly
235 event
->flags
.clear(Event::Squashed
);
244 Event::serialize(CheckpointOut
&cp
) const
246 SERIALIZE_SCALAR(_when
);
247 SERIALIZE_SCALAR(_priority
);
248 short _flags
= flags
;
249 SERIALIZE_SCALAR(_flags
);
253 Event::unserialize(CheckpointIn
&cp
)
255 assert(!scheduled());
257 UNSERIALIZE_SCALAR(_when
);
258 UNSERIALIZE_SCALAR(_priority
);
261 UNSERIALIZE_SCALAR(_flags
);
263 // Old checkpoints had no concept of the Initialized flag
264 // so restoring from old checkpoints always fail.
265 // Events are initialized on construction but original code
266 // "flags = _flags" would just overwrite the initialization.
267 // So, read in the checkpoint flags, but then set the Initialized
268 // flag on top of it in order to avoid failures.
269 assert(initialized());
271 flags
.set(Initialized
);
273 // need to see if original event was in a scheduled, unsquashed
274 // state, but don't want to restore those flags in the current
275 // object itself (since they aren't immediately true)
276 if (flags
.isSet(Scheduled
) && !flags
.isSet(Squashed
)) {
277 flags
.clear(Squashed
| Scheduled
);
279 DPRINTF(Checkpoint
, "Event '%s' need to be scheduled @%d\n",
285 EventQueue::checkpointReschedule(Event
*event
)
287 // It's safe to call insert() directly here since this method
288 // should only be called when restoring from a checkpoint (which
289 // happens before thread creation).
290 if (event
->flags
.isSet(Event::Scheduled
))
294 EventQueue::dump() const
296 cprintf("============================================================\n");
297 cprintf("EventQueue Dump (cycle %d)\n", curTick());
298 cprintf("------------------------------------------------------------\n");
301 cprintf("<No Events>\n");
303 Event
*nextBin
= head
;
305 Event
*nextInBin
= nextBin
;
308 nextInBin
= nextInBin
->nextInBin
;
311 nextBin
= nextBin
->nextBin
;
315 cprintf("============================================================\n");
319 EventQueue::debugVerify() const
321 std::unordered_map
<long, bool> map
;
326 Event
*nextBin
= head
;
328 Event
*nextInBin
= nextBin
;
330 if (nextInBin
->when() < time
) {
331 cprintf("time goes backwards!");
334 } else if (nextInBin
->when() == time
&&
335 nextInBin
->priority() < priority
) {
336 cprintf("priority inverted!");
341 if (map
[reinterpret_cast<long>(nextInBin
)]) {
342 cprintf("Node already seen");
346 map
[reinterpret_cast<long>(nextInBin
)] = true;
348 time
= nextInBin
->when();
349 priority
= nextInBin
->priority();
351 nextInBin
= nextInBin
->nextInBin
;
354 nextBin
= nextBin
->nextBin
;
361 EventQueue::replaceHead(Event
* s
)
371 for (uint32_t i
= 0; i
< numMainEventQueues
; ++i
) {
372 mainEventQueue
[i
]->dump();
378 Event::description() const
384 Event::trace(const char *action
)
386 // This DPRINTF is unconditional because calls to this function
387 // are protected by an 'if (DTRACE(Event))' in the inlined Event
390 // This is just a default implementation for derived classes where
391 // it's not worth doing anything special. If you want to put a
392 // more informative message in the trace, override this method on
393 // the particular subclass where you have the information that
394 // needs to be printed.
395 DPRINTFN("%s event %s @ %d\n", description(), action
, when());
401 cprintf("Event %s (%s)\n", name(), description());
402 cprintf("Flags: %#x\n", flags
);
404 cprintf("Created: %d\n", whenCreated
);
408 cprintf("Scheduled at %d\n", whenScheduled
);
410 cprintf("Scheduled for %d, priority %d\n", when(), _priority
);
412 cprintf("Not Scheduled\n");
416 EventQueue::EventQueue(const string
&n
)
417 : objName(n
), head(NULL
), _curTick(0)
422 EventQueue::asyncInsert(Event
*event
)
424 async_queue_mutex
.lock();
425 async_queue
.push_back(event
);
426 async_queue_mutex
.unlock();
430 EventQueue::handleAsyncInsertions()
432 assert(this == curEventQueue());
433 async_queue_mutex
.lock();
435 while (!async_queue
.empty()) {
436 insert(async_queue
.front());
437 async_queue
.pop_front();
440 async_queue_mutex
.unlock();