src/mem/ruby/slicc_interface/NetworkMessage.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_SLICC_INTERFACE_NETWORKMESSAGE_HH__
  30 #define __MEM_RUBY_SLICC_INTERFACE_NETWORKMESSAGE_HH__
  31
  32 #include <iostream>
  33
  34 #include "mem/protocol/MessageSizeType.hh"
  35 #include "mem/ruby/common/NetDest.hh"
  36 #include "mem/ruby/slicc_interface/Message.hh"
  37
  38 class NetworkMessage;
  39 typedef RefCountingPtr<NetworkMessage> NetMsgPtr;
  40
  41 class NetworkMessage : public Message
  42 {
  43   public:
  44     NetworkMessage(Tick curTime)
  45         : Message(curTime), m_internal_dest_valid(false)
  46     { }
  47
  48     NetworkMessage(const NetworkMessage &other)
  49         : Message(other), m_internal_dest(other.m_internal_dest),
  50           m_internal_dest_valid(other.m_internal_dest_valid)
  51     { }
  52
  53     virtual ~NetworkMessage() { }
  54
  55     virtual const NetDest& getDestination() const = 0;
  56     virtual NetDest& getDestination() = 0;
  57     virtual const MessageSizeType& getMessageSize() const = 0;
  58     virtual MessageSizeType& getMessageSize() = 0;
  59
  60     const NetDest&
  61     getInternalDestination() const
  62     {
  63         if (!m_internal_dest_valid)
  64             return getDestination();
  65
  66         return m_internal_dest;
  67     }
  68
  69     NetDest&
  70     getInternalDestination()
  71     {
  72         if (!m_internal_dest_valid) {
  73             m_internal_dest = getDestination();
  74             m_internal_dest_valid = true;
  75         }
  76         return m_internal_dest;
  77     }
  78
  79     virtual void print(std::ostream& out) const = 0;
  80
  81     int getIncomingLink() const { return incoming_link; }
  82     void setIncomingLink(int link) { incoming_link = link; }
  83     int getVnet() const { return vnet; }
  84     void setVnet(int net) { vnet = net; }
  85
  86   private:
  87     NetDest m_internal_dest;
  88     bool m_internal_dest_valid;
  89     int incoming_link;
  90     int vnet;
  91 };
  92
  93 inline std::ostream&
  94 operator<<(std::ostream& out, const NetworkMessage& obj)
  95 {
  96     obj.print(out);
  97     out << std::flush;
  98     return out;
  99 }
 100
 101 #endif // __MEM_RUBY_SLICC_INTERFACE_NETWORKMESSAGE_HH__