eventq.cc revision 5774
12SN/A/* 21762SN/A * Copyright (c) 2000-2005 The Regents of The University of Michigan 35502Snate@binkert.org * Copyright (c) 2008 The Hewlett-Packard Development Company 42SN/A * All rights reserved. 52SN/A * 62SN/A * Redistribution and use in source and binary forms, with or without 72SN/A * modification, are permitted provided that the following conditions are 82SN/A * met: redistributions of source code must retain the above copyright 92SN/A * notice, this list of conditions and the following disclaimer; 102SN/A * redistributions in binary form must reproduce the above copyright 112SN/A * notice, this list of conditions and the following disclaimer in the 122SN/A * documentation and/or other materials provided with the distribution; 132SN/A * neither the name of the copyright holders nor the names of its 142SN/A * contributors may be used to endorse or promote products derived from 152SN/A * this software without specific prior written permission. 162SN/A * 172SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 182SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 192SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 202SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 212SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 222SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 232SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 242SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 252SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 262SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 272SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 282665Ssaidi@eecs.umich.edu * 292665Ssaidi@eecs.umich.edu * Authors: Steve Reinhardt 302665Ssaidi@eecs.umich.edu * Nathan Binkert 312665Ssaidi@eecs.umich.edu * Steve Raasch 322SN/A */ 332SN/A 345501Snate@binkert.org#include <cassert> 352SN/A#include <iostream> 362SN/A#include <string> 372SN/A#include <vector> 382SN/A 395502Snate@binkert.org#include "base/hashmap.hh" 405501Snate@binkert.org#include "base/misc.hh" 415501Snate@binkert.org#include "base/trace.hh" 421717SN/A#include "cpu/smt.hh" 435501Snate@binkert.org#include "sim/core.hh" 4456SN/A#include "sim/eventq.hh" 452SN/A 462SN/Ausing namespace std; 472SN/A 482SN/A// 492SN/A// Main Event Queue 502SN/A// 512SN/A// Events on this queue are processed at the *beginning* of each 522SN/A// cycle, before the pipeline simulation is performed. 532SN/A// 545605Snate@binkert.orgEventQueue mainEventQueue("Main Event Queue"); 552SN/A 564017Sstever@eecs.umich.edu#ifndef NDEBUG 574016Sstever@eecs.umich.eduCounter Event::instanceCounter = 0; 584017Sstever@eecs.umich.edu#endif 594016Sstever@eecs.umich.edu 605768Snate@binkert.orgEvent::~Event() 615768Snate@binkert.org{ 625774Snate@binkert.org assert(!scheduled()); 635768Snate@binkert.org} 645768Snate@binkert.org 655768Snate@binkert.orgconst std::string 665768Snate@binkert.orgEvent::name() const 675768Snate@binkert.org{ 685768Snate@binkert.org#ifndef NDEBUG 695768Snate@binkert.org return csprintf("Event_%d", instance); 705768Snate@binkert.org#else 715768Snate@binkert.org return csprintf("Event_%x", (uintptr_t)this); 725768Snate@binkert.org#endif 735768Snate@binkert.org} 745768Snate@binkert.org 755768Snate@binkert.org 765602Snate@binkert.orgEvent * 775602Snate@binkert.orgEvent::insertBefore(Event *event, Event *curr) 785502Snate@binkert.org{ 795503Snate@binkert.org // Either way, event will be the top element in the 'in bin' list 805502Snate@binkert.org // which is the pointer we need in order to look into the list, so 815502Snate@binkert.org // we need to insert that into the bin list. 825502Snate@binkert.org if (!curr || *event < *curr) { 835502Snate@binkert.org // Insert the event before the current list since it is in the future. 845502Snate@binkert.org event->nextBin = curr; 855503Snate@binkert.org event->nextInBin = NULL; 865502Snate@binkert.org } else { 875502Snate@binkert.org // Since we're on the correct list, we need to point to the next list 885502Snate@binkert.org event->nextBin = curr->nextBin; // curr->nextBin can now become stale 895502Snate@binkert.org 905503Snate@binkert.org // Insert event at the top of the stack 915503Snate@binkert.org event->nextInBin = curr; 925503Snate@binkert.org } 935502Snate@binkert.org 945503Snate@binkert.org return event; 955502Snate@binkert.org} 965502Snate@binkert.org 972SN/Avoid 982SN/AEventQueue::insert(Event *event) 992SN/A{ 1005502Snate@binkert.org // Deal with the head case 1015502Snate@binkert.org if (!head || *event <= *head) { 1025602Snate@binkert.org head = Event::insertBefore(event, head); 1035502Snate@binkert.org return; 1045502Snate@binkert.org } 1052SN/A 1065502Snate@binkert.org // Figure out either which 'in bin' list we are on, or where a new list 1075502Snate@binkert.org // needs to be inserted 1085503Snate@binkert.org Event *prev = head; 1095503Snate@binkert.org Event *curr = head->nextBin; 1105503Snate@binkert.org while (curr && *curr < *event) { 1115503Snate@binkert.org prev = curr; 1125503Snate@binkert.org curr = curr->nextBin; 1135502Snate@binkert.org } 1142SN/A 1155503Snate@binkert.org // Note: this operation may render all nextBin pointers on the 1165503Snate@binkert.org // prev 'in bin' list stale (except for the top one) 1175602Snate@binkert.org prev->nextBin = Event::insertBefore(event, curr); 1185502Snate@binkert.org} 1192SN/A 1205602Snate@binkert.orgEvent * 1215602Snate@binkert.orgEvent::removeItem(Event *event, Event *top) 1225502Snate@binkert.org{ 1235503Snate@binkert.org Event *curr = top; 1245503Snate@binkert.org Event *next = top->nextInBin; 1255502Snate@binkert.org 1265503Snate@binkert.org // if we removed the top item, we need to handle things specially 1275503Snate@binkert.org // and just remove the top item, fixing up the next bin pointer of 1285503Snate@binkert.org // the new top item 1295503Snate@binkert.org if (event == top) { 1305503Snate@binkert.org if (!next) 1315503Snate@binkert.org return top->nextBin; 1325503Snate@binkert.org next->nextBin = top->nextBin; 1335503Snate@binkert.org return next; 1345503Snate@binkert.org } 1355503Snate@binkert.org 1365503Snate@binkert.org // Since we already checked the current element, we're going to 1375503Snate@binkert.org // keep checking event against the next element. 1385503Snate@binkert.org while (event != next) { 1395503Snate@binkert.org if (!next) 1405502Snate@binkert.org panic("event not found!"); 1415502Snate@binkert.org 1425503Snate@binkert.org curr = next; 1435503Snate@binkert.org next = next->nextInBin; 1442SN/A } 1455502Snate@binkert.org 1465503Snate@binkert.org // remove next from the 'in bin' list since it's what we're looking for 1475503Snate@binkert.org curr->nextInBin = next->nextInBin; 1485503Snate@binkert.org return top; 1492SN/A} 1502SN/A 1512SN/Avoid 1522SN/AEventQueue::remove(Event *event) 1532SN/A{ 1542SN/A if (head == NULL) 1555502Snate@binkert.org panic("event not found!"); 1562SN/A 1575502Snate@binkert.org // deal with an event on the head's 'in bin' list (event has the same 1585502Snate@binkert.org // time as the head) 1595502Snate@binkert.org if (*head == *event) { 1605602Snate@binkert.org head = Event::removeItem(event, head); 1612SN/A return; 1622SN/A } 1632SN/A 1645502Snate@binkert.org // Find the 'in bin' list that this event belongs on 1652SN/A Event *prev = head; 1665502Snate@binkert.org Event *curr = head->nextBin; 1675502Snate@binkert.org while (curr && *curr < *event) { 1682SN/A prev = curr; 1695502Snate@binkert.org curr = curr->nextBin; 1702SN/A } 1712SN/A 1725502Snate@binkert.org if (!curr || *curr != *event) 1735502Snate@binkert.org panic("event not found!"); 1745502Snate@binkert.org 1755503Snate@binkert.org // curr points to the top item of the the correct 'in bin' list, when 1765503Snate@binkert.org // we remove an item, it returns the new top item (which may be 1775502Snate@binkert.org // unchanged) 1785602Snate@binkert.org prev->nextBin = Event::removeItem(event, curr); 1792SN/A} 1802SN/A 1812667Sstever@eecs.umich.eduEvent * 1822SN/AEventQueue::serviceOne() 1832SN/A{ 1845503Snate@binkert.org Event *event = head; 1855503Snate@binkert.org Event *next = head->nextInBin; 1865769Snate@binkert.org event->flags.clear(Event::Scheduled); 1875502Snate@binkert.org 1885503Snate@binkert.org if (next) { 1895503Snate@binkert.org // update the next bin pointer since it could be stale 1905503Snate@binkert.org next->nextBin = head->nextBin; 1915503Snate@binkert.org 1925503Snate@binkert.org // pop the stack 1935503Snate@binkert.org head = next; 1945503Snate@binkert.org } else { 1955502Snate@binkert.org // this was the only element on the 'in bin' list, so get rid of 1965502Snate@binkert.org // the 'in bin' list and point to the next bin list 1975503Snate@binkert.org head = head->nextBin; 1985502Snate@binkert.org } 1992SN/A 2002SN/A // handle action 2012667Sstever@eecs.umich.edu if (!event->squashed()) { 2022SN/A event->process(); 2032667Sstever@eecs.umich.edu if (event->isExitEvent()) { 2045769Snate@binkert.org assert(!event->flags.isSet(Event::AutoDelete)); // would be silly 2052667Sstever@eecs.umich.edu return event; 2062667Sstever@eecs.umich.edu } 2072667Sstever@eecs.umich.edu } else { 2085769Snate@binkert.org event->flags.clear(Event::Squashed); 2092667Sstever@eecs.umich.edu } 2102SN/A 2115769Snate@binkert.org if (event->flags.isSet(Event::AutoDelete) && !event->scheduled()) 2122SN/A delete event; 2132667Sstever@eecs.umich.edu 2142667Sstever@eecs.umich.edu return NULL; 2152SN/A} 2162SN/A 217224SN/Avoid 218224SN/AEvent::serialize(std::ostream &os) 219224SN/A{ 220224SN/A SERIALIZE_SCALAR(_when); 221224SN/A SERIALIZE_SCALAR(_priority); 2225769Snate@binkert.org short _flags = flags; 2235769Snate@binkert.org SERIALIZE_SCALAR(_flags); 224224SN/A} 225224SN/A 226224SN/Avoid 227237SN/AEvent::unserialize(Checkpoint *cp, const string §ion) 228224SN/A{ 2295695Snate@binkert.org if (scheduled()) 2305695Snate@binkert.org mainEventQueue.deschedule(this); 231224SN/A 232224SN/A UNSERIALIZE_SCALAR(_when); 233224SN/A UNSERIALIZE_SCALAR(_priority); 234224SN/A 235224SN/A // need to see if original event was in a scheduled, unsquashed 236224SN/A // state, but don't want to restore those flags in the current 237224SN/A // object itself (since they aren't immediately true) 2385769Snate@binkert.org short _flags; 2395769Snate@binkert.org UNSERIALIZE_SCALAR(_flags); 2405769Snate@binkert.org flags = _flags; 2415769Snate@binkert.org 2425769Snate@binkert.org bool wasScheduled = flags.isSet(Scheduled) && !flags.isSet(Squashed); 2435769Snate@binkert.org flags.clear(Squashed | Scheduled); 244224SN/A 245224SN/A if (wasScheduled) { 246224SN/A DPRINTF(Config, "rescheduling at %d\n", _when); 2475695Snate@binkert.org mainEventQueue.schedule(this, _when); 248224SN/A } 249224SN/A} 250224SN/A 2512SN/Avoid 252217SN/AEventQueue::serialize(ostream &os) 2532SN/A{ 254265SN/A std::list<Event *> eventPtrs; 255237SN/A 256237SN/A int numEvents = 0; 2575502Snate@binkert.org Event *nextBin = head; 2585502Snate@binkert.org while (nextBin) { 2595503Snate@binkert.org Event *nextInBin = nextBin; 2605502Snate@binkert.org 2615503Snate@binkert.org while (nextInBin) { 2625769Snate@binkert.org if (nextInBin->flags.isSet(Event::AutoSerialize)) { 2635502Snate@binkert.org eventPtrs.push_back(nextInBin); 2645502Snate@binkert.org paramOut(os, csprintf("event%d", numEvents++), 2655502Snate@binkert.org nextInBin->name()); 2665502Snate@binkert.org } 2675502Snate@binkert.org nextInBin = nextInBin->nextInBin; 2685503Snate@binkert.org } 2695502Snate@binkert.org 2705502Snate@binkert.org nextBin = nextBin->nextBin; 2712SN/A } 272237SN/A 273265SN/A SERIALIZE_SCALAR(numEvents); 274265SN/A 2755502Snate@binkert.org for (std::list<Event *>::iterator it = eventPtrs.begin(); 276265SN/A it != eventPtrs.end(); ++it) { 277265SN/A (*it)->nameOut(os); 278265SN/A (*it)->serialize(os); 279265SN/A } 2802SN/A} 2812SN/A 282237SN/Avoid 283237SN/AEventQueue::unserialize(Checkpoint *cp, const std::string §ion) 284237SN/A{ 285265SN/A int numEvents; 286265SN/A UNSERIALIZE_SCALAR(numEvents); 287265SN/A 288270SN/A std::string eventName; 289265SN/A for (int i = 0; i < numEvents; i++) { 290265SN/A // get the pointer value associated with the event 291270SN/A paramIn(cp, section, csprintf("event%d", i), eventName); 292265SN/A 293265SN/A // create the event based on its pointer value 294395SN/A Serializable::create(cp, eventName); 295237SN/A } 296237SN/A} 297237SN/A 2982SN/Avoid 2995501Snate@binkert.orgEventQueue::dump() const 3002SN/A{ 3012SN/A cprintf("============================================================\n"); 3022SN/A cprintf("EventQueue Dump (cycle %d)\n", curTick); 3032SN/A cprintf("------------------------------------------------------------\n"); 3042SN/A 3052SN/A if (empty()) 3062SN/A cprintf("<No Events>\n"); 3072SN/A else { 3085502Snate@binkert.org Event *nextBin = head; 3095502Snate@binkert.org while (nextBin) { 3105502Snate@binkert.org Event *nextInBin = nextBin; 3115503Snate@binkert.org while (nextInBin) { 3125503Snate@binkert.org nextInBin->dump(); 3135502Snate@binkert.org nextInBin = nextInBin->nextInBin; 3145503Snate@binkert.org } 3155502Snate@binkert.org 3165502Snate@binkert.org nextBin = nextBin->nextBin; 3172SN/A } 3182SN/A } 3192SN/A 3202SN/A cprintf("============================================================\n"); 3212SN/A} 3222SN/A 3235502Snate@binkert.orgbool 3245502Snate@binkert.orgEventQueue::debugVerify() const 3255502Snate@binkert.org{ 3265502Snate@binkert.org m5::hash_map<long, bool> map; 3275502Snate@binkert.org 3285502Snate@binkert.org Tick time = 0; 3295502Snate@binkert.org short priority = 0; 3305502Snate@binkert.org 3315502Snate@binkert.org Event *nextBin = head; 3325502Snate@binkert.org while (nextBin) { 3335503Snate@binkert.org Event *nextInBin = nextBin; 3345503Snate@binkert.org while (nextInBin) { 3355502Snate@binkert.org if (nextInBin->when() < time) { 3365502Snate@binkert.org cprintf("time goes backwards!"); 3375502Snate@binkert.org nextInBin->dump(); 3385502Snate@binkert.org return false; 3395502Snate@binkert.org } else if (nextInBin->when() == time && 3405502Snate@binkert.org nextInBin->priority() < priority) { 3415502Snate@binkert.org cprintf("priority inverted!"); 3425502Snate@binkert.org nextInBin->dump(); 3435502Snate@binkert.org return false; 3445502Snate@binkert.org } 3455502Snate@binkert.org 3465502Snate@binkert.org if (map[reinterpret_cast<long>(nextInBin)]) { 3475502Snate@binkert.org cprintf("Node already seen"); 3485502Snate@binkert.org nextInBin->dump(); 3495502Snate@binkert.org return false; 3505502Snate@binkert.org } 3515502Snate@binkert.org map[reinterpret_cast<long>(nextInBin)] = true; 3525502Snate@binkert.org 3535502Snate@binkert.org time = nextInBin->when(); 3545502Snate@binkert.org priority = nextInBin->priority(); 3555502Snate@binkert.org 3565502Snate@binkert.org nextInBin = nextInBin->nextInBin; 3575503Snate@binkert.org } 3585502Snate@binkert.org 3595502Snate@binkert.org nextBin = nextBin->nextBin; 3605502Snate@binkert.org } 3615502Snate@binkert.org 3625502Snate@binkert.org return true; 3635502Snate@binkert.org} 3645502Snate@binkert.org 3651019SN/Avoid 3661019SN/AdumpMainQueue() 3671019SN/A{ 3681019SN/A mainEventQueue.dump(); 3691019SN/A} 3701019SN/A 3712SN/A 3722SN/Aconst char * 3735336Shines@cs.fsu.eduEvent::description() const 3742SN/A{ 3752SN/A return "generic"; 3762SN/A} 3772SN/A 3782SN/Avoid 3792SN/AEvent::trace(const char *action) 3802SN/A{ 3812SN/A // This DPRINTF is unconditional because calls to this function 3822SN/A // are protected by an 'if (DTRACE(Event))' in the inlined Event 3832SN/A // methods. 3842SN/A // 3852SN/A // This is just a default implementation for derived classes where 3862SN/A // it's not worth doing anything special. If you want to put a 3872SN/A // more informative message in the trace, override this method on 3882SN/A // the particular subclass where you have the information that 3892SN/A // needs to be printed. 3902SN/A DPRINTFN("%s event %s @ %d\n", description(), action, when()); 3912SN/A} 3922SN/A 3932SN/Avoid 3945501Snate@binkert.orgEvent::dump() const 3952SN/A{ 3965501Snate@binkert.org cprintf("Event %s (%s)\n", name(), description()); 3975769Snate@binkert.org cprintf("Flags: %#x\n", flags); 3985501Snate@binkert.org#ifdef EVENTQ_DEBUG 3995501Snate@binkert.org cprintf("Created: %d\n", whenCreated); 4002SN/A#endif 4012SN/A if (scheduled()) { 4025501Snate@binkert.org#ifdef EVENTQ_DEBUG 4035501Snate@binkert.org cprintf("Scheduled at %d\n", whenScheduled); 4042SN/A#endif 4051019SN/A cprintf("Scheduled for %d, priority %d\n", when(), _priority); 4065501Snate@binkert.org } else { 4071019SN/A cprintf("Not Scheduled\n"); 4082SN/A } 4092SN/A} 410