Message.hh revision 10893
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> 3310472Sandreas.hansson@arm.com#include <memory> 3410808Snilay@cs.wisc.edu#include <stack> 357002Snate@binkert.org 369466Snilay@cs.wisc.edu#include "mem/packet.hh" 376145Snate@binkert.org 386145Snate@binkert.orgclass Message; 3910472Sandreas.hansson@arm.comtypedef std::shared_ptr<Message> MsgPtr; 406145Snate@binkert.org 4110472Sandreas.hansson@arm.comclass Message 427039Snate@binkert.org{ 437039Snate@binkert.org public: 449508Snilay@cs.wisc.edu Message(Tick curTime) 459466Snilay@cs.wisc.edu : m_time(curTime), 469466Snilay@cs.wisc.edu m_LastEnqueueTime(curTime), 4710893Snilay@cs.wisc.edu m_DelayedTicks(0), m_msg_counter(0) 4810876Snilay@cs.wisc.edu { } 497453Snate@binkert.org 507453Snate@binkert.org Message(const Message &other) 517453Snate@binkert.org : m_time(other.m_time), 527453Snate@binkert.org m_LastEnqueueTime(other.m_LastEnqueueTime), 5310893Snilay@cs.wisc.edu m_DelayedTicks(other.m_DelayedTicks), 5410893Snilay@cs.wisc.edu m_msg_counter(other.m_msg_counter) 557453Snate@binkert.org { } 566145Snate@binkert.org 577039Snate@binkert.org virtual ~Message() { } 586145Snate@binkert.org 5910472Sandreas.hansson@arm.com virtual MsgPtr 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 virtual bool functionalWrite(Packet *pkt) = 0; 739302Snilay@cs.wisc.edu 7410074Snilay@cs.wisc.edu //! Update the delay this message has experienced so far. 7510074Snilay@cs.wisc.edu void updateDelayedTicks(Tick curTime) 7610074Snilay@cs.wisc.edu { 7710074Snilay@cs.wisc.edu assert(m_LastEnqueueTime <= curTime); 7810074Snilay@cs.wisc.edu Tick delta = curTime - m_LastEnqueueTime; 7910074Snilay@cs.wisc.edu m_DelayedTicks += delta; 8010074Snilay@cs.wisc.edu } 819508Snilay@cs.wisc.edu const Tick getDelayedTicks() const {return m_DelayedTicks;} 829465Snilay@cs.wisc.edu 839508Snilay@cs.wisc.edu void setLastEnqueueTime(const Tick& time) { m_LastEnqueueTime = time; } 849508Snilay@cs.wisc.edu const Tick getLastEnqueueTime() const {return m_LastEnqueueTime;} 856145Snate@binkert.org 869508Snilay@cs.wisc.edu const Tick& getTime() const { return m_time; } 8710893Snilay@cs.wisc.edu void setMsgCounter(uint64_t c) { m_msg_counter = c; } 8810893Snilay@cs.wisc.edu uint64_t getMsgCounter() const { return m_msg_counter; } 896145Snate@binkert.org 907039Snate@binkert.org private: 9110893Snilay@cs.wisc.edu const Tick m_time; 929508Snilay@cs.wisc.edu Tick m_LastEnqueueTime; // my last enqueue time 939508Snilay@cs.wisc.edu Tick m_DelayedTicks; // my delayed cycles 9410893Snilay@cs.wisc.edu uint64_t m_msg_counter; // FIXME, should this be a 64-bit value? 956145Snate@binkert.org}; 966145Snate@binkert.org 9710893Snilay@cs.wisc.eduinline bool 9810893Snilay@cs.wisc.eduoperator>(const MsgPtr &lhs, const MsgPtr &rhs) 9910893Snilay@cs.wisc.edu{ 10010893Snilay@cs.wisc.edu const Message *l = lhs.get(); 10110893Snilay@cs.wisc.edu const Message *r = rhs.get(); 10210893Snilay@cs.wisc.edu 10310893Snilay@cs.wisc.edu if (l->getLastEnqueueTime() == r->getLastEnqueueTime()) { 10410893Snilay@cs.wisc.edu assert(l->getMsgCounter() != r->getMsgCounter()); 10510893Snilay@cs.wisc.edu return l->getMsgCounter() > r->getMsgCounter(); 10610893Snilay@cs.wisc.edu } 10710893Snilay@cs.wisc.edu return l->getLastEnqueueTime() > r->getLastEnqueueTime(); 10810893Snilay@cs.wisc.edu} 10910893Snilay@cs.wisc.edu 1107039Snate@binkert.orginline std::ostream& 1117039Snate@binkert.orgoperator<<(std::ostream& out, const Message& obj) 1126145Snate@binkert.org{ 1137039Snate@binkert.org obj.print(out); 1147039Snate@binkert.org out << std::flush; 1157039Snate@binkert.org return out; 1166145Snate@binkert.org} 1176145Snate@binkert.org 1187039Snate@binkert.org#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__ 119