Consumer.hh revision 7021
16145Snate@binkert.org 26145Snate@binkert.org/* 36145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 46145Snate@binkert.org * All rights reserved. 56145Snate@binkert.org * 66145Snate@binkert.org * Redistribution and use in source and binary forms, with or without 76145Snate@binkert.org * modification, are permitted provided that the following conditions are 86145Snate@binkert.org * met: redistributions of source code must retain the above copyright 96145Snate@binkert.org * notice, this list of conditions and the following disclaimer; 106145Snate@binkert.org * redistributions in binary form must reproduce the above copyright 116145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 126145Snate@binkert.org * documentation and/or other materials provided with the distribution; 136145Snate@binkert.org * neither the name of the copyright holders nor the names of its 146145Snate@binkert.org * contributors may be used to endorse or promote products derived from 156145Snate@binkert.org * this software without specific prior written permission. 166145Snate@binkert.org * 176145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 186145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 196145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 206145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 216145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 226145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 236145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 246145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 256145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 266145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 276145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 286145Snate@binkert.org */ 296145Snate@binkert.org 306145Snate@binkert.org/* 316145Snate@binkert.org * $Id$ 326145Snate@binkert.org * 336145Snate@binkert.org * Description: This is the virtual base class of all classes that can 346145Snate@binkert.org * be the targets of wakeup events. There is only two methods, 356145Snate@binkert.org * wakeup() and print() and no data members. 366145Snate@binkert.org * 376145Snate@binkert.org */ 386145Snate@binkert.org 396145Snate@binkert.org#ifndef CONSUMER_H 406145Snate@binkert.org#define CONSUMER_H 416145Snate@binkert.org 427002Snate@binkert.org#include <iostream> 437021Stushar@csail.mit.edu#include <set> 447002Snate@binkert.org 456154Snate@binkert.org#include "mem/ruby/common/Global.hh" 466154Snate@binkert.org#include "mem/ruby/eventqueue/RubyEventQueue.hh" 476145Snate@binkert.org 486145Snate@binkert.orgclass MessageBuffer; 496145Snate@binkert.org 506145Snate@binkert.orgclass Consumer { 516145Snate@binkert.orgpublic: 526145Snate@binkert.org // Constructors 536891SBrad.Beckmann@amd.com Consumer() { m_last_scheduled_wakeup = 0; m_last_wakeup = 0; } 546145Snate@binkert.org 556145Snate@binkert.org // Destructor 566145Snate@binkert.org virtual ~Consumer() { } 576145Snate@binkert.org 586145Snate@binkert.org // Public Methods - pure virtual methods 597021Stushar@csail.mit.edu void triggerWakeup(RubyEventQueue * eventQueue) 607021Stushar@csail.mit.edu { 617021Stushar@csail.mit.edu Time time = eventQueue->getTime(); 627021Stushar@csail.mit.edu if (m_last_wakeup != time) { 637021Stushar@csail.mit.edu wakeup(); m_last_wakeup = time; 647021Stushar@csail.mit.edu } 657021Stushar@csail.mit.edu } 666145Snate@binkert.org virtual void wakeup() = 0; 677002Snate@binkert.org virtual void print(std::ostream& out) const = 0; 687021Stushar@csail.mit.edu const Time& getLastScheduledWakeup() const 697021Stushar@csail.mit.edu { 707021Stushar@csail.mit.edu return m_last_scheduled_wakeup; 717021Stushar@csail.mit.edu } 727021Stushar@csail.mit.edu void setLastScheduledWakeup(const Time& time) 737021Stushar@csail.mit.edu { 747021Stushar@csail.mit.edu m_last_scheduled_wakeup = time; 757021Stushar@csail.mit.edu } 767021Stushar@csail.mit.edu bool alreadyScheduled(Time time) 777021Stushar@csail.mit.edu { 787021Stushar@csail.mit.edu return (m_scheduled_wakeups.find(time) != m_scheduled_wakeups.end()); 797021Stushar@csail.mit.edu } 807021Stushar@csail.mit.edu void insertScheduledWakeupTime(Time time) 817021Stushar@csail.mit.edu { 827021Stushar@csail.mit.edu m_scheduled_wakeups.insert(time); 837021Stushar@csail.mit.edu } 847021Stushar@csail.mit.edu void removeScheduledWakeupTime(Time time) 857021Stushar@csail.mit.edu { 867021Stushar@csail.mit.edu assert(alreadyScheduled(time)); 877021Stushar@csail.mit.edu m_scheduled_wakeups.erase(time); 887021Stushar@csail.mit.edu } 896145Snate@binkert.org 906145Snate@binkert.orgprivate: 916145Snate@binkert.org // Private Methods 926145Snate@binkert.org 936145Snate@binkert.org // Data Members (m_ prefix) 946145Snate@binkert.org Time m_last_scheduled_wakeup; 957021Stushar@csail.mit.edu std::set<Time> m_scheduled_wakeups; 966145Snate@binkert.org Time m_last_wakeup; 976145Snate@binkert.org}; 986145Snate@binkert.org 996145Snate@binkert.org// Output operator declaration 1006145Snate@binkert.orginline extern 1017002Snate@binkert.orgstd::ostream& operator<<(std::ostream& out, const Consumer& obj); 1026145Snate@binkert.org 1036145Snate@binkert.org// ******************* Definitions ******************* 1046145Snate@binkert.org 1056145Snate@binkert.org// Output operator definition 1066145Snate@binkert.orginline extern 1077002Snate@binkert.orgstd::ostream& operator<<(std::ostream& out, const Consumer& obj) 1086145Snate@binkert.org{ 1096145Snate@binkert.org obj.print(out); 1107002Snate@binkert.org out << std::flush; 1116145Snate@binkert.org return out; 1126145Snate@binkert.org} 1136145Snate@binkert.org 1146145Snate@binkert.org#endif //CONSUMER_H 115