Message.hh revision 9465
16145Snate@binkert.org/* 26145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 36145Snate@binkert.org * All rights reserved. 46145Snate@binkert.org * 56145Snate@binkert.org * Redistribution and use in source and binary forms, with or without 66145Snate@binkert.org * modification, are permitted provided that the following conditions are 76145Snate@binkert.org * met: redistributions of source code must retain the above copyright 86145Snate@binkert.org * notice, this list of conditions and the following disclaimer; 96145Snate@binkert.org * redistributions in binary form must reproduce the above copyright 106145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 116145Snate@binkert.org * documentation and/or other materials provided with the distribution; 126145Snate@binkert.org * neither the name of the copyright holders nor the names of its 136145Snate@binkert.org * contributors may be used to endorse or promote products derived from 146145Snate@binkert.org * this software without specific prior written permission. 156145Snate@binkert.org * 166145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 176145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 186145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 196145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 206145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 216145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 226145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 236145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 246145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 256145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 266145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 276145Snate@binkert.org */ 286145Snate@binkert.org 297039Snate@binkert.org#ifndef __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__ 307039Snate@binkert.org#define __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__ 316145Snate@binkert.org 327002Snate@binkert.org#include <iostream> 337002Snate@binkert.org 347453Snate@binkert.org#include "base/refcnt.hh" 357039Snate@binkert.org#include "mem/ruby/common/Global.hh" 368608Snilay@cs.wisc.edu#include "mem/ruby/common/TypeDefines.hh" 379171Snilay@cs.wisc.edu#include "mem/ruby/system/System.hh" 386145Snate@binkert.org 396145Snate@binkert.orgclass Message; 407453Snate@binkert.orgtypedef RefCountingPtr<Message> MsgPtr; 416145Snate@binkert.org 427453Snate@binkert.orgclass Message : public RefCounted 437039Snate@binkert.org{ 447039Snate@binkert.org public: 457039Snate@binkert.org Message() 469171Snilay@cs.wisc.edu : m_time(g_system_ptr->getTime()), 479171Snilay@cs.wisc.edu m_LastEnqueueTime(g_system_ptr->getTime()), 487453Snate@binkert.org m_DelayedCycles(0) 497453Snate@binkert.org { } 507453Snate@binkert.org 517453Snate@binkert.org Message(const Message &other) 527453Snate@binkert.org : m_time(other.m_time), 537453Snate@binkert.org m_LastEnqueueTime(other.m_LastEnqueueTime), 547453Snate@binkert.org m_DelayedCycles(other.m_DelayedCycles) 557453Snate@binkert.org { } 566145Snate@binkert.org 577039Snate@binkert.org virtual ~Message() { } 586145Snate@binkert.org 597039Snate@binkert.org virtual Message* clone() const = 0; 607039Snate@binkert.org virtual void print(std::ostream& out) const = 0; 617973Snilay@cs.wisc.edu virtual void setIncomingLink(int) {} 627973Snilay@cs.wisc.edu virtual void setVnet(int) {} 636145Snate@binkert.org 649302Snilay@cs.wisc.edu /** 659302Snilay@cs.wisc.edu * The two functions below are used for reading / writing the message 669302Snilay@cs.wisc.edu * functionally. The methods return true if the address in the packet 679302Snilay@cs.wisc.edu * matches the address / address range in the message. Each message 689302Snilay@cs.wisc.edu * class that can be potentially searched for the address needs to 699302Snilay@cs.wisc.edu * implement these methods. 709302Snilay@cs.wisc.edu */ 719302Snilay@cs.wisc.edu virtual bool functionalRead(Packet *pkt) = 0; 729302Snilay@cs.wisc.edu //{ fatal("Read functional access not implemented!"); } 739302Snilay@cs.wisc.edu virtual bool functionalWrite(Packet *pkt) = 0; 749302Snilay@cs.wisc.edu //{ fatal("Write functional access not implemented!"); } 759302Snilay@cs.wisc.edu 769465Snilay@cs.wisc.edu void setDelayedCycles(const Time cycles) { m_DelayedCycles = cycles; } 779465Snilay@cs.wisc.edu const Time getDelayedCycles() const {return m_DelayedCycles;} 789465Snilay@cs.wisc.edu 797039Snate@binkert.org void setLastEnqueueTime(const Time& time) { m_LastEnqueueTime = time; } 809465Snilay@cs.wisc.edu const Time getLastEnqueueTime() const {return m_LastEnqueueTime;} 816145Snate@binkert.org 827039Snate@binkert.org const Time& getTime() const { return m_time; } 837039Snate@binkert.org void setTime(const Time& new_time) { m_time = new_time; } 846145Snate@binkert.org 857039Snate@binkert.org private: 867039Snate@binkert.org Time m_time; 877039Snate@binkert.org Time m_LastEnqueueTime; // my last enqueue time 887039Snate@binkert.org int m_DelayedCycles; // my delayed cycles 896145Snate@binkert.org}; 906145Snate@binkert.org 917039Snate@binkert.orginline std::ostream& 927039Snate@binkert.orgoperator<<(std::ostream& out, const Message& obj) 936145Snate@binkert.org{ 947039Snate@binkert.org obj.print(out); 957039Snate@binkert.org out << std::flush; 967039Snate@binkert.org return out; 976145Snate@binkert.org} 986145Snate@binkert.org 997039Snate@binkert.org#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__ 100