src/mem/ruby/buffers/MessageBufferNode.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_BUFFERS_MESSAGEBUFFERNODE_HH__
  30 #define __MEM_RUBY_BUFFERS_MESSAGEBUFFERNODE_HH__
  31
  32 #include <iostream>
  33
  34 #include "mem/ruby/slicc_interface/Message.hh"
  35
  36 class MessageBufferNode
  37 {
  38   public:
  39     MessageBufferNode()
  40         : m_time(0), m_msg_counter(0)
  41     {}
  42
  43     MessageBufferNode(const Cycles& time, uint64_t counter,
  44                       const MsgPtr& msgptr)
  45         : m_time(time), m_msg_counter(counter), m_msgptr(msgptr)
  46     {}
  47
  48     void print(std::ostream& out) const;
  49
  50   public:
  51     Cycles m_time;
  52     uint64_t m_msg_counter; // FIXME, should this be a 64-bit value?
  53     MsgPtr m_msgptr;
  54 };
  55
  56 inline bool
  57 operator>(const MessageBufferNode& n1, const MessageBufferNode& n2)
  58 {
  59     if (n1.m_time == n2.m_time) {
  60         assert(n1.m_msg_counter != n2.m_msg_counter);
  61         return n1.m_msg_counter > n2.m_msg_counter;
  62     } else {
  63         return n1.m_time > n2.m_time;
  64     }
  65 }
  66
  67 inline std::ostream&
  68 operator<<(std::ostream& out, const MessageBufferNode& obj)
  69 {
  70     obj.print(out);
  71     out << std::flush;
  72     return out;
  73 }
  74
  75 #endif // __MEM_RUBY_BUFFERS_MESSAGEBUFFERNODE_HH__