Consumer.hh revision 6891
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 426154Snate@binkert.org#include "mem/ruby/common/Global.hh" 436154Snate@binkert.org#include "mem/ruby/eventqueue/RubyEventQueue.hh" 446145Snate@binkert.org 456145Snate@binkert.orgclass MessageBuffer; 466145Snate@binkert.org 476145Snate@binkert.orgclass Consumer { 486145Snate@binkert.orgpublic: 496145Snate@binkert.org // Constructors 506891SBrad.Beckmann@amd.com Consumer() { m_last_scheduled_wakeup = 0; m_last_wakeup = 0; } 516145Snate@binkert.org 526145Snate@binkert.org // Destructor 536145Snate@binkert.org virtual ~Consumer() { } 546145Snate@binkert.org 556145Snate@binkert.org // Public Methods - pure virtual methods 566285Snate@binkert.org // void triggerWakeup() { Time time = g_eventQueue_ptr->getTime(); if (m_last_wakeup != time) { wakeup(); m_last_wakeup = time; }} 576285Snate@binkert.org void triggerWakeup(RubyEventQueue * eventQueue) { Time time = eventQueue->getTime(); if (m_last_wakeup != time) { wakeup(); m_last_wakeup = time; }} 586145Snate@binkert.org virtual void wakeup() = 0; 596145Snate@binkert.org virtual void print(ostream& out) const = 0; 606145Snate@binkert.org const Time& getLastScheduledWakeup() const { return m_last_scheduled_wakeup; } 616145Snate@binkert.org void setLastScheduledWakeup(const Time& time) { m_last_scheduled_wakeup = time; } 626145Snate@binkert.org 636145Snate@binkert.orgprivate: 646145Snate@binkert.org // Private Methods 656145Snate@binkert.org 666145Snate@binkert.org // Data Members (m_ prefix) 676145Snate@binkert.org Time m_last_scheduled_wakeup; 686145Snate@binkert.org Time m_last_wakeup; 696145Snate@binkert.org}; 706145Snate@binkert.org 716145Snate@binkert.org// Output operator declaration 726145Snate@binkert.orginline extern 736145Snate@binkert.orgostream& operator<<(ostream& out, const Consumer& obj); 746145Snate@binkert.org 756145Snate@binkert.org// ******************* Definitions ******************* 766145Snate@binkert.org 776145Snate@binkert.org// Output operator definition 786145Snate@binkert.orginline extern 796145Snate@binkert.orgostream& operator<<(ostream& out, const Consumer& obj) 806145Snate@binkert.org{ 816145Snate@binkert.org obj.print(out); 826145Snate@binkert.org out << flush; 836145Snate@binkert.org return out; 846145Snate@binkert.org} 856145Snate@binkert.org 866145Snate@binkert.org#endif //CONSUMER_H 87