src/mem/ruby/eventqueue/RubyEventQueueNode.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 #ifndef __MEM_RUBY_EVENTQUEUE_RUBYEVENTQUEUENODE_HH__
  30 #define __MEM_RUBY_EVENTQUEUE_RUBYEVENTQUEUENODE_HH__
  31
  32 #include <iostream>
  33
  34 #include "mem/ruby/common/Consumer.hh"
  35 #include "mem/ruby/common/Global.hh"
  36 #include "sim/eventq.hh"
  37
  38 class RubyEventQueueNode : public Event
  39 {
  40   public:
  41     RubyEventQueueNode(Consumer* _consumer, RubyEventQueue* _eventq)
  42         : m_consumer_ptr(_consumer), m_eventq_ptr(_eventq)
  43     {
  44         setFlags(AutoDelete);
  45     }
  46
  47     void print(std::ostream& out) const;
  48     virtual void
  49     process()
  50     {
  51         m_consumer_ptr->wakeup();
  52         m_consumer_ptr->removeScheduledWakeupTime(m_eventq_ptr->getTime());
  53     }
  54     virtual const char *description() const { return "Ruby Event"; }
  55
  56   private:
  57     Consumer* m_consumer_ptr;
  58     RubyEventQueue* m_eventq_ptr;
  59 };
  60
  61 inline std::ostream&
  62 operator<<(std::ostream& out, const RubyEventQueueNode& obj)
  63 {
  64     obj.print(out);
  65     out << std::flush;
  66     return out;
  67 }
  68
  69 #endif // __MEM_RUBY_EVENTQUEUE_EVENTQUEUENODE_HH__