src/mem/ruby/common/Consumer.hh

   1
   2 /*
   3  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer;
  10  * redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution;
  13  * neither the name of the copyright holders nor the names of its
  14  * contributors may be used to endorse or promote products derived from
  15  * this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * $Id$
  32  *
  33  * Description: This is the virtual base class of all classes that can
  34  * be the targets of wakeup events.  There is only two methods,
  35  * wakeup() and print() and no data members.
  36  *
  37  */
  38
  39 #ifndef CONSUMER_H
  40 #define CONSUMER_H
  41
  42 #include <iostream>
  43 #include <set>
  44
  45 #include "mem/ruby/common/Global.hh"
  46 #include "mem/ruby/eventqueue/RubyEventQueue.hh"
  47
  48 class MessageBuffer;
  49
  50 class Consumer {
  51 public:
  52   // Constructors
  53   Consumer() { m_last_scheduled_wakeup = 0; m_last_wakeup = 0; }
  54
  55   // Destructor
  56   virtual ~Consumer() { }
  57
  58   // Public Methods - pure virtual methods
  59   void triggerWakeup(RubyEventQueue * eventQueue)
  60   {
  61       Time time = eventQueue->getTime();
  62       if (m_last_wakeup != time) {
  63           wakeup(); m_last_wakeup = time;
  64       }
  65   }
  66   virtual void wakeup() = 0;
  67   virtual void print(std::ostream& out) const = 0;
  68   const Time& getLastScheduledWakeup() const
  69   {
  70       return m_last_scheduled_wakeup;
  71   }
  72   void setLastScheduledWakeup(const Time& time)
  73   {
  74       m_last_scheduled_wakeup = time;
  75   }
  76   bool alreadyScheduled(Time time)
  77   {
  78       return (m_scheduled_wakeups.find(time) != m_scheduled_wakeups.end());
  79   }
  80   void insertScheduledWakeupTime(Time time)
  81   {
  82       m_scheduled_wakeups.insert(time);
  83   }
  84   void removeScheduledWakeupTime(Time time)
  85   {
  86       assert(alreadyScheduled(time));
  87       m_scheduled_wakeups.erase(time);
  88   }
  89
  90 private:
  91   // Private Methods
  92
  93   // Data Members (m_ prefix)
  94   Time m_last_scheduled_wakeup;
  95   std::set<Time> m_scheduled_wakeups;
  96   Time m_last_wakeup;
  97 };
  98
  99 // Output operator declaration
 100 inline extern
 101 std::ostream& operator<<(std::ostream& out, const Consumer& obj);
 102
 103 // ******************* Definitions *******************
 104
 105 // Output operator definition
 106 inline extern
 107 std::ostream& operator<<(std::ostream& out, const Consumer& obj)
 108 {
 109   obj.print(out);
 110   out << std::flush;
 111   return out;
 112 }
 113
 114 #endif //CONSUMER_H