eventq.cc revision 8232
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" 438232Snate@binkert.org#include "debug/Config.hh" 445501Snate@binkert.org#include "sim/core.hh" 4556SN/A#include "sim/eventq.hh" 462SN/A 472SN/Ausing namespace std; 482SN/A 492SN/A// 502SN/A// Main Event Queue 512SN/A// 522SN/A// Events on this queue are processed at the *beginning* of each 532SN/A// cycle, before the pipeline simulation is performed. 542SN/A// 555605Snate@binkert.orgEventQueue mainEventQueue("Main Event Queue"); 562SN/A 574017Sstever@eecs.umich.edu#ifndef NDEBUG 584016Sstever@eecs.umich.eduCounter Event::instanceCounter = 0; 594017Sstever@eecs.umich.edu#endif 604016Sstever@eecs.umich.edu 615768Snate@binkert.orgEvent::~Event() 625768Snate@binkert.org{ 635774Snate@binkert.org assert(!scheduled()); 647059Snate@binkert.org flags = 0; 655768Snate@binkert.org} 665768Snate@binkert.org 675768Snate@binkert.orgconst std::string 685768Snate@binkert.orgEvent::name() const 695768Snate@binkert.org{ 705768Snate@binkert.org#ifndef NDEBUG 715768Snate@binkert.org return csprintf("Event_%d", instance); 725768Snate@binkert.org#else 735768Snate@binkert.org return csprintf("Event_%x", (uintptr_t)this); 745768Snate@binkert.org#endif 755768Snate@binkert.org} 765768Snate@binkert.org 775768Snate@binkert.org 785602Snate@binkert.orgEvent * 795602Snate@binkert.orgEvent::insertBefore(Event *event, Event *curr) 805502Snate@binkert.org{ 815503Snate@binkert.org // Either way, event will be the top element in the 'in bin' list 825502Snate@binkert.org // which is the pointer we need in order to look into the list, so 835502Snate@binkert.org // we need to insert that into the bin list. 845502Snate@binkert.org if (!curr || *event < *curr) { 855502Snate@binkert.org // Insert the event before the current list since it is in the future. 865502Snate@binkert.org event->nextBin = curr; 875503Snate@binkert.org event->nextInBin = NULL; 885502Snate@binkert.org } else { 895502Snate@binkert.org // Since we're on the correct list, we need to point to the next list 905502Snate@binkert.org event->nextBin = curr->nextBin; // curr->nextBin can now become stale 915502Snate@binkert.org 925503Snate@binkert.org // Insert event at the top of the stack 935503Snate@binkert.org event->nextInBin = curr; 945503Snate@binkert.org } 955502Snate@binkert.org 965503Snate@binkert.org return event; 975502Snate@binkert.org} 985502Snate@binkert.org 992SN/Avoid 1002SN/AEventQueue::insert(Event *event) 1012SN/A{ 1025502Snate@binkert.org // Deal with the head case 1035502Snate@binkert.org if (!head || *event <= *head) { 1045602Snate@binkert.org head = Event::insertBefore(event, head); 1055502Snate@binkert.org return; 1065502Snate@binkert.org } 1072SN/A 1085502Snate@binkert.org // Figure out either which 'in bin' list we are on, or where a new list 1095502Snate@binkert.org // needs to be inserted 1105503Snate@binkert.org Event *prev = head; 1115503Snate@binkert.org Event *curr = head->nextBin; 1125503Snate@binkert.org while (curr && *curr < *event) { 1135503Snate@binkert.org prev = curr; 1145503Snate@binkert.org curr = curr->nextBin; 1155502Snate@binkert.org } 1162SN/A 1175503Snate@binkert.org // Note: this operation may render all nextBin pointers on the 1185503Snate@binkert.org // prev 'in bin' list stale (except for the top one) 1195602Snate@binkert.org prev->nextBin = Event::insertBefore(event, curr); 1205502Snate@binkert.org} 1212SN/A 1225602Snate@binkert.orgEvent * 1235602Snate@binkert.orgEvent::removeItem(Event *event, Event *top) 1245502Snate@binkert.org{ 1255503Snate@binkert.org Event *curr = top; 1265503Snate@binkert.org Event *next = top->nextInBin; 1275502Snate@binkert.org 1285503Snate@binkert.org // if we removed the top item, we need to handle things specially 1295503Snate@binkert.org // and just remove the top item, fixing up the next bin pointer of 1305503Snate@binkert.org // the new top item 1315503Snate@binkert.org if (event == top) { 1325503Snate@binkert.org if (!next) 1335503Snate@binkert.org return top->nextBin; 1345503Snate@binkert.org next->nextBin = top->nextBin; 1355503Snate@binkert.org return next; 1365503Snate@binkert.org } 1375503Snate@binkert.org 1385503Snate@binkert.org // Since we already checked the current element, we're going to 1395503Snate@binkert.org // keep checking event against the next element. 1405503Snate@binkert.org while (event != next) { 1415503Snate@binkert.org if (!next) 1425502Snate@binkert.org panic("event not found!"); 1435502Snate@binkert.org 1445503Snate@binkert.org curr = next; 1455503Snate@binkert.org next = next->nextInBin; 1462SN/A } 1475502Snate@binkert.org 1485503Snate@binkert.org // remove next from the 'in bin' list since it's what we're looking for 1495503Snate@binkert.org curr->nextInBin = next->nextInBin; 1505503Snate@binkert.org return top; 1512SN/A} 1522SN/A 1532SN/Avoid 1542SN/AEventQueue::remove(Event *event) 1552SN/A{ 1562SN/A if (head == NULL) 1575502Snate@binkert.org panic("event not found!"); 1582SN/A 1595502Snate@binkert.org // deal with an event on the head's 'in bin' list (event has the same 1605502Snate@binkert.org // time as the head) 1615502Snate@binkert.org if (*head == *event) { 1625602Snate@binkert.org head = Event::removeItem(event, head); 1632SN/A return; 1642SN/A } 1652SN/A 1665502Snate@binkert.org // Find the 'in bin' list that this event belongs on 1672SN/A Event *prev = head; 1685502Snate@binkert.org Event *curr = head->nextBin; 1695502Snate@binkert.org while (curr && *curr < *event) { 1702SN/A prev = curr; 1715502Snate@binkert.org curr = curr->nextBin; 1722SN/A } 1732SN/A 1745502Snate@binkert.org if (!curr || *curr != *event) 1755502Snate@binkert.org panic("event not found!"); 1765502Snate@binkert.org 1775503Snate@binkert.org // curr points to the top item of the the correct 'in bin' list, when 1785503Snate@binkert.org // we remove an item, it returns the new top item (which may be 1795502Snate@binkert.org // unchanged) 1805602Snate@binkert.org prev->nextBin = Event::removeItem(event, curr); 1812SN/A} 1822SN/A 1832667Sstever@eecs.umich.eduEvent * 1842SN/AEventQueue::serviceOne() 1852SN/A{ 1865503Snate@binkert.org Event *event = head; 1875503Snate@binkert.org Event *next = head->nextInBin; 1885769Snate@binkert.org event->flags.clear(Event::Scheduled); 1895502Snate@binkert.org 1905503Snate@binkert.org if (next) { 1915503Snate@binkert.org // update the next bin pointer since it could be stale 1925503Snate@binkert.org next->nextBin = head->nextBin; 1935503Snate@binkert.org 1945503Snate@binkert.org // pop the stack 1955503Snate@binkert.org head = next; 1965503Snate@binkert.org } else { 1975502Snate@binkert.org // this was the only element on the 'in bin' list, so get rid of 1985502Snate@binkert.org // the 'in bin' list and point to the next bin list 1995503Snate@binkert.org head = head->nextBin; 2005502Snate@binkert.org } 2012SN/A 2022SN/A // handle action 2032667Sstever@eecs.umich.edu if (!event->squashed()) { 2042SN/A event->process(); 2052667Sstever@eecs.umich.edu if (event->isExitEvent()) { 2065769Snate@binkert.org assert(!event->flags.isSet(Event::AutoDelete)); // would be silly 2072667Sstever@eecs.umich.edu return event; 2082667Sstever@eecs.umich.edu } 2092667Sstever@eecs.umich.edu } else { 2105769Snate@binkert.org event->flags.clear(Event::Squashed); 2112667Sstever@eecs.umich.edu } 2122SN/A 2135769Snate@binkert.org if (event->flags.isSet(Event::AutoDelete) && !event->scheduled()) 2142SN/A delete event; 2152667Sstever@eecs.umich.edu 2162667Sstever@eecs.umich.edu return NULL; 2172SN/A} 2182SN/A 219224SN/Avoid 220224SN/AEvent::serialize(std::ostream &os) 221224SN/A{ 222224SN/A SERIALIZE_SCALAR(_when); 223224SN/A SERIALIZE_SCALAR(_priority); 2245769Snate@binkert.org short _flags = flags; 2255769Snate@binkert.org SERIALIZE_SCALAR(_flags); 226224SN/A} 227224SN/A 228224SN/Avoid 229237SN/AEvent::unserialize(Checkpoint *cp, const string §ion) 230224SN/A{ 2315695Snate@binkert.org if (scheduled()) 2325695Snate@binkert.org mainEventQueue.deschedule(this); 233224SN/A 234224SN/A UNSERIALIZE_SCALAR(_when); 235224SN/A UNSERIALIZE_SCALAR(_priority); 236224SN/A 2375769Snate@binkert.org short _flags; 2385769Snate@binkert.org UNSERIALIZE_SCALAR(_flags); 2397452SLisa.Hsu@amd.com 2407452SLisa.Hsu@amd.com // Old checkpoints had no concept of the Initialized flag 2417452SLisa.Hsu@amd.com // so restoring from old checkpoints always fail. 2427452SLisa.Hsu@amd.com // Events are initialized on construction but original code 2437452SLisa.Hsu@amd.com // "flags = _flags" would just overwrite the initialization. 2447452SLisa.Hsu@amd.com // So, read in the checkpoint flags, but then set the Initialized 2457452SLisa.Hsu@amd.com // flag on top of it in order to avoid failures. 2467451SLisa.Hsu@amd.com assert(initialized()); 2475769Snate@binkert.org flags = _flags; 2487451SLisa.Hsu@amd.com flags.set(Initialized); 2495769Snate@binkert.org 2507452SLisa.Hsu@amd.com // need to see if original event was in a scheduled, unsquashed 2517452SLisa.Hsu@amd.com // state, but don't want to restore those flags in the current 2527452SLisa.Hsu@amd.com // object itself (since they aren't immediately true) 2535769Snate@binkert.org bool wasScheduled = flags.isSet(Scheduled) && !flags.isSet(Squashed); 2545769Snate@binkert.org flags.clear(Squashed | Scheduled); 255224SN/A 256224SN/A if (wasScheduled) { 257224SN/A DPRINTF(Config, "rescheduling at %d\n", _when); 2585695Snate@binkert.org mainEventQueue.schedule(this, _when); 259224SN/A } 260224SN/A} 261224SN/A 2622SN/Avoid 263217SN/AEventQueue::serialize(ostream &os) 2642SN/A{ 265265SN/A std::list<Event *> eventPtrs; 266237SN/A 267237SN/A int numEvents = 0; 2685502Snate@binkert.org Event *nextBin = head; 2695502Snate@binkert.org while (nextBin) { 2705503Snate@binkert.org Event *nextInBin = nextBin; 2715502Snate@binkert.org 2725503Snate@binkert.org while (nextInBin) { 2735769Snate@binkert.org if (nextInBin->flags.isSet(Event::AutoSerialize)) { 2745502Snate@binkert.org eventPtrs.push_back(nextInBin); 2755502Snate@binkert.org paramOut(os, csprintf("event%d", numEvents++), 2765502Snate@binkert.org nextInBin->name()); 2775502Snate@binkert.org } 2785502Snate@binkert.org nextInBin = nextInBin->nextInBin; 2795503Snate@binkert.org } 2805502Snate@binkert.org 2815502Snate@binkert.org nextBin = nextBin->nextBin; 2822SN/A } 283237SN/A 284265SN/A SERIALIZE_SCALAR(numEvents); 285265SN/A 2865502Snate@binkert.org for (std::list<Event *>::iterator it = eventPtrs.begin(); 287265SN/A it != eventPtrs.end(); ++it) { 288265SN/A (*it)->nameOut(os); 289265SN/A (*it)->serialize(os); 290265SN/A } 2912SN/A} 2922SN/A 293237SN/Avoid 294237SN/AEventQueue::unserialize(Checkpoint *cp, const std::string §ion) 295237SN/A{ 296265SN/A int numEvents; 297265SN/A UNSERIALIZE_SCALAR(numEvents); 298265SN/A 299270SN/A std::string eventName; 300265SN/A for (int i = 0; i < numEvents; i++) { 301265SN/A // get the pointer value associated with the event 302270SN/A paramIn(cp, section, csprintf("event%d", i), eventName); 303265SN/A 304265SN/A // create the event based on its pointer value 305395SN/A Serializable::create(cp, eventName); 306237SN/A } 307237SN/A} 308237SN/A 3092SN/Avoid 3105501Snate@binkert.orgEventQueue::dump() const 3112SN/A{ 3122SN/A cprintf("============================================================\n"); 3137823Ssteve.reinhardt@amd.com cprintf("EventQueue Dump (cycle %d)\n", curTick()); 3142SN/A cprintf("------------------------------------------------------------\n"); 3152SN/A 3162SN/A if (empty()) 3172SN/A cprintf("<No Events>\n"); 3182SN/A else { 3195502Snate@binkert.org Event *nextBin = head; 3205502Snate@binkert.org while (nextBin) { 3215502Snate@binkert.org Event *nextInBin = nextBin; 3225503Snate@binkert.org while (nextInBin) { 3235503Snate@binkert.org nextInBin->dump(); 3245502Snate@binkert.org nextInBin = nextInBin->nextInBin; 3255503Snate@binkert.org } 3265502Snate@binkert.org 3275502Snate@binkert.org nextBin = nextBin->nextBin; 3282SN/A } 3292SN/A } 3302SN/A 3312SN/A cprintf("============================================================\n"); 3322SN/A} 3332SN/A 3345502Snate@binkert.orgbool 3355502Snate@binkert.orgEventQueue::debugVerify() const 3365502Snate@binkert.org{ 3375502Snate@binkert.org m5::hash_map<long, bool> map; 3385502Snate@binkert.org 3395502Snate@binkert.org Tick time = 0; 3405502Snate@binkert.org short priority = 0; 3415502Snate@binkert.org 3425502Snate@binkert.org Event *nextBin = head; 3435502Snate@binkert.org while (nextBin) { 3445503Snate@binkert.org Event *nextInBin = nextBin; 3455503Snate@binkert.org while (nextInBin) { 3465502Snate@binkert.org if (nextInBin->when() < time) { 3475502Snate@binkert.org cprintf("time goes backwards!"); 3485502Snate@binkert.org nextInBin->dump(); 3495502Snate@binkert.org return false; 3505502Snate@binkert.org } else if (nextInBin->when() == time && 3515502Snate@binkert.org nextInBin->priority() < priority) { 3525502Snate@binkert.org cprintf("priority inverted!"); 3535502Snate@binkert.org nextInBin->dump(); 3545502Snate@binkert.org return false; 3555502Snate@binkert.org } 3565502Snate@binkert.org 3575502Snate@binkert.org if (map[reinterpret_cast<long>(nextInBin)]) { 3585502Snate@binkert.org cprintf("Node already seen"); 3595502Snate@binkert.org nextInBin->dump(); 3605502Snate@binkert.org return false; 3615502Snate@binkert.org } 3625502Snate@binkert.org map[reinterpret_cast<long>(nextInBin)] = true; 3635502Snate@binkert.org 3645502Snate@binkert.org time = nextInBin->when(); 3655502Snate@binkert.org priority = nextInBin->priority(); 3665502Snate@binkert.org 3675502Snate@binkert.org nextInBin = nextInBin->nextInBin; 3685503Snate@binkert.org } 3695502Snate@binkert.org 3705502Snate@binkert.org nextBin = nextBin->nextBin; 3715502Snate@binkert.org } 3725502Snate@binkert.org 3735502Snate@binkert.org return true; 3745502Snate@binkert.org} 3755502Snate@binkert.org 3761019SN/Avoid 3771019SN/AdumpMainQueue() 3781019SN/A{ 3791019SN/A mainEventQueue.dump(); 3801019SN/A} 3811019SN/A 3822SN/A 3832SN/Aconst char * 3845336Shines@cs.fsu.eduEvent::description() const 3852SN/A{ 3862SN/A return "generic"; 3872SN/A} 3882SN/A 3892SN/Avoid 3902SN/AEvent::trace(const char *action) 3912SN/A{ 3922SN/A // This DPRINTF is unconditional because calls to this function 3932SN/A // are protected by an 'if (DTRACE(Event))' in the inlined Event 3942SN/A // methods. 3952SN/A // 3962SN/A // This is just a default implementation for derived classes where 3972SN/A // it's not worth doing anything special. If you want to put a 3982SN/A // more informative message in the trace, override this method on 3992SN/A // the particular subclass where you have the information that 4002SN/A // needs to be printed. 4012SN/A DPRINTFN("%s event %s @ %d\n", description(), action, when()); 4022SN/A} 4032SN/A 4042SN/Avoid 4055501Snate@binkert.orgEvent::dump() const 4062SN/A{ 4075501Snate@binkert.org cprintf("Event %s (%s)\n", name(), description()); 4085769Snate@binkert.org cprintf("Flags: %#x\n", flags); 4095501Snate@binkert.org#ifdef EVENTQ_DEBUG 4105501Snate@binkert.org cprintf("Created: %d\n", whenCreated); 4112SN/A#endif 4122SN/A if (scheduled()) { 4135501Snate@binkert.org#ifdef EVENTQ_DEBUG 4145501Snate@binkert.org cprintf("Scheduled at %d\n", whenScheduled); 4152SN/A#endif 4161019SN/A cprintf("Scheduled for %d, priority %d\n", when(), _priority); 4175501Snate@binkert.org } else { 4181019SN/A cprintf("Not Scheduled\n"); 4192SN/A } 4202SN/A} 4217063Snate@binkert.org 4227063Snate@binkert.orgEventQueue::EventQueue(const string &n) 4237063Snate@binkert.org : objName(n), head(NULL) 4247063Snate@binkert.org{} 425