Message.hh revision 10074:0e013fa647ac
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_MESSAGE_HH__ 30#define __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__ 31 32#include <iostream> 33 34#include "base/refcnt.hh" 35#include "mem/packet.hh" 36 37class Message; 38typedef RefCountingPtr<Message> MsgPtr; 39 40class Message : public RefCounted 41{ 42 public: 43 Message(Tick curTime) 44 : m_time(curTime), 45 m_LastEnqueueTime(curTime), 46 m_DelayedTicks(0) 47 { } 48 49 Message(const Message &other) 50 : m_time(other.m_time), 51 m_LastEnqueueTime(other.m_LastEnqueueTime), 52 m_DelayedTicks(other.m_DelayedTicks) 53 { } 54 55 virtual ~Message() { } 56 57 virtual Message* clone() const = 0; 58 virtual void print(std::ostream& out) const = 0; 59 virtual void setIncomingLink(int) {} 60 virtual void setVnet(int) {} 61 62 /** 63 * The two functions below are used for reading / writing the message 64 * functionally. The methods return true if the address in the packet 65 * matches the address / address range in the message. Each message 66 * class that can be potentially searched for the address needs to 67 * implement these methods. 68 */ 69 virtual bool functionalRead(Packet *pkt) = 0; 70 //{ fatal("Read functional access not implemented!"); } 71 virtual bool functionalWrite(Packet *pkt) = 0; 72 //{ fatal("Write functional access not implemented!"); } 73 74 //! Update the delay this message has experienced so far. 75 void updateDelayedTicks(Tick curTime) 76 { 77 assert(m_LastEnqueueTime <= curTime); 78 Tick delta = curTime - m_LastEnqueueTime; 79 m_DelayedTicks += delta; 80 } 81 const Tick getDelayedTicks() const {return m_DelayedTicks;} 82 83 void setLastEnqueueTime(const Tick& time) { m_LastEnqueueTime = time; } 84 const Tick getLastEnqueueTime() const {return m_LastEnqueueTime;} 85 86 const Tick& getTime() const { return m_time; } 87 void setTime(const Tick& new_time) { m_time = new_time; } 88 89 private: 90 Tick m_time; 91 Tick m_LastEnqueueTime; // my last enqueue time 92 Tick m_DelayedTicks; // my delayed cycles 93}; 94 95inline std::ostream& 96operator<<(std::ostream& out, const Message& obj) 97{ 98 obj.print(out); 99 out << std::flush; 100 return out; 101} 102 103#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__ 104