src/mem/ruby/common/Consumer.hh

   1 /*
   2  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /*
  30  * This is the virtual base class of all classes that can be the
  31  * targets of wakeup events.  There is only two methods, wakeup() and
  32  * print() and no data members.
  33  */
  34
  35 #ifndef __MEM_RUBY_COMMON_CONSUMER_HH__
  36 #define __MEM_RUBY_COMMON_CONSUMER_HH__
  37
  38 #include <iostream>
  39 #include <set>
  40
  41 #include "sim/clocked_object.hh"
  42
  43 class Consumer
  44 {
  45   public:
  46     Consumer(ClockedObject *_em)
  47         : em(_em)
  48     {
  49     }
  50
  51     virtual
  52     ~Consumer()
  53     { }
  54
  55     virtual void wakeup() = 0;
  56     virtual void print(std::ostream& out) const = 0;
  57     virtual void storeEventInfo(int info) {}
  58
  59     bool
  60     alreadyScheduled(Tick time)
  61     {
  62         return m_scheduled_wakeups.find(time) != m_scheduled_wakeups.end();
  63     }
  64
  65     void
  66     insertScheduledWakeupTime(Tick time)
  67     {
  68         m_scheduled_wakeups.insert(time);
  69     }
  70
  71     void scheduleEventAbsolute(Tick timeAbs);
  72
  73   protected:
  74     void scheduleEvent(Cycles timeDelta);
  75
  76   private:
  77     std::set<Tick> m_scheduled_wakeups;
  78     ClockedObject *em;
  79 };
  80
  81 inline std::ostream&
  82 operator<<(std::ostream& out, const Consumer& obj)
  83 {
  84     obj.print(out);
  85     out << std::flush;
  86     return out;
  87 }
  88
  89 #endif // __MEM_RUBY_COMMON_CONSUMER_HH__