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