Message.hh revision 9508
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" 359466Snilay@cs.wisc.edu#include "mem/packet.hh" 366145Snate@binkert.org 376145Snate@binkert.orgclass Message; 387453Snate@binkert.orgtypedef RefCountingPtr<Message> MsgPtr; 396145Snate@binkert.org 407453Snate@binkert.orgclass Message : public RefCounted 417039Snate@binkert.org{ 427039Snate@binkert.org public: 439508Snilay@cs.wisc.edu Message(Tick curTime) 449466Snilay@cs.wisc.edu : m_time(curTime), 459466Snilay@cs.wisc.edu m_LastEnqueueTime(curTime), 469508Snilay@cs.wisc.edu m_DelayedTicks(0) 477453Snate@binkert.org { } 487453Snate@binkert.org 497453Snate@binkert.org Message(const Message &other) 507453Snate@binkert.org : m_time(other.m_time), 517453Snate@binkert.org m_LastEnqueueTime(other.m_LastEnqueueTime), 529508Snilay@cs.wisc.edu m_DelayedTicks(other.m_DelayedTicks) 537453Snate@binkert.org { } 546145Snate@binkert.org 557039Snate@binkert.org virtual ~Message() { } 566145Snate@binkert.org 577039Snate@binkert.org virtual Message* clone() const = 0; 587039Snate@binkert.org virtual void print(std::ostream& out) const = 0; 597973Snilay@cs.wisc.edu virtual void setIncomingLink(int) {} 607973Snilay@cs.wisc.edu virtual void setVnet(int) {} 616145Snate@binkert.org 629302Snilay@cs.wisc.edu /** 639302Snilay@cs.wisc.edu * The two functions below are used for reading / writing the message 649302Snilay@cs.wisc.edu * functionally. The methods return true if the address in the packet 659302Snilay@cs.wisc.edu * matches the address / address range in the message. Each message 669302Snilay@cs.wisc.edu * class that can be potentially searched for the address needs to 679302Snilay@cs.wisc.edu * implement these methods. 689302Snilay@cs.wisc.edu */ 699302Snilay@cs.wisc.edu virtual bool functionalRead(Packet *pkt) = 0; 709302Snilay@cs.wisc.edu //{ fatal("Read functional access not implemented!"); } 719302Snilay@cs.wisc.edu virtual bool functionalWrite(Packet *pkt) = 0; 729302Snilay@cs.wisc.edu //{ fatal("Write functional access not implemented!"); } 739302Snilay@cs.wisc.edu 749508Snilay@cs.wisc.edu void setDelayedTicks(const Tick ticks) { m_DelayedTicks = ticks; } 759508Snilay@cs.wisc.edu const Tick getDelayedTicks() const {return m_DelayedTicks;} 769465Snilay@cs.wisc.edu 779508Snilay@cs.wisc.edu void setLastEnqueueTime(const Tick& time) { m_LastEnqueueTime = time; } 789508Snilay@cs.wisc.edu const Tick getLastEnqueueTime() const {return m_LastEnqueueTime;} 796145Snate@binkert.org 809508Snilay@cs.wisc.edu const Tick& getTime() const { return m_time; } 819508Snilay@cs.wisc.edu void setTime(const Tick& new_time) { m_time = new_time; } 826145Snate@binkert.org 837039Snate@binkert.org private: 849508Snilay@cs.wisc.edu Tick m_time; 859508Snilay@cs.wisc.edu Tick m_LastEnqueueTime; // my last enqueue time 869508Snilay@cs.wisc.edu Tick m_DelayedTicks; // my delayed cycles 876145Snate@binkert.org}; 886145Snate@binkert.org 897039Snate@binkert.orginline std::ostream& 907039Snate@binkert.orgoperator<<(std::ostream& out, const Message& obj) 916145Snate@binkert.org{ 927039Snate@binkert.org obj.print(out); 937039Snate@binkert.org out << std::flush; 947039Snate@binkert.org return out; 956145Snate@binkert.org} 966145Snate@binkert.org 977039Snate@binkert.org#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__ 98