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