Message.hh revision 10895
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" 3710895Snilay@cs.wisc.edu#include "mem/protocol/MessageSizeType.hh" 3810895Snilay@cs.wisc.edu#include "mem/ruby/common/NetDest.hh" 396145Snate@binkert.org 406145Snate@binkert.orgclass Message; 4110472Sandreas.hansson@arm.comtypedef std::shared_ptr<Message> MsgPtr; 426145Snate@binkert.org 4310472Sandreas.hansson@arm.comclass Message 447039Snate@binkert.org{ 457039Snate@binkert.org public: 469508Snilay@cs.wisc.edu Message(Tick curTime) 479466Snilay@cs.wisc.edu : m_time(curTime), 489466Snilay@cs.wisc.edu m_LastEnqueueTime(curTime), 4910893Snilay@cs.wisc.edu m_DelayedTicks(0), m_msg_counter(0) 5010876Snilay@cs.wisc.edu { } 517453Snate@binkert.org 527453Snate@binkert.org Message(const Message &other) 537453Snate@binkert.org : m_time(other.m_time), 547453Snate@binkert.org m_LastEnqueueTime(other.m_LastEnqueueTime), 5510893Snilay@cs.wisc.edu m_DelayedTicks(other.m_DelayedTicks), 5610893Snilay@cs.wisc.edu m_msg_counter(other.m_msg_counter) 577453Snate@binkert.org { } 586145Snate@binkert.org 597039Snate@binkert.org virtual ~Message() { } 606145Snate@binkert.org 6110472Sandreas.hansson@arm.com virtual MsgPtr clone() const = 0; 627039Snate@binkert.org virtual void print(std::ostream& out) const = 0; 6310895Snilay@cs.wisc.edu 6410895Snilay@cs.wisc.edu virtual const MessageSizeType& getMessageSize() const 6510895Snilay@cs.wisc.edu { panic("MessageSizeType() called on wrong message!"); } 6610895Snilay@cs.wisc.edu virtual MessageSizeType& getMessageSize() 6710895Snilay@cs.wisc.edu { panic("MessageSizeType() called on wrong message!"); } 686145Snate@binkert.org 699302Snilay@cs.wisc.edu /** 709302Snilay@cs.wisc.edu * The two functions below are used for reading / writing the message 719302Snilay@cs.wisc.edu * functionally. The methods return true if the address in the packet 729302Snilay@cs.wisc.edu * matches the address / address range in the message. Each message 739302Snilay@cs.wisc.edu * class that can be potentially searched for the address needs to 749302Snilay@cs.wisc.edu * implement these methods. 759302Snilay@cs.wisc.edu */ 769302Snilay@cs.wisc.edu virtual bool functionalRead(Packet *pkt) = 0; 779302Snilay@cs.wisc.edu virtual bool functionalWrite(Packet *pkt) = 0; 789302Snilay@cs.wisc.edu 7910074Snilay@cs.wisc.edu //! Update the delay this message has experienced so far. 8010074Snilay@cs.wisc.edu void updateDelayedTicks(Tick curTime) 8110074Snilay@cs.wisc.edu { 8210074Snilay@cs.wisc.edu assert(m_LastEnqueueTime <= curTime); 8310074Snilay@cs.wisc.edu Tick delta = curTime - m_LastEnqueueTime; 8410074Snilay@cs.wisc.edu m_DelayedTicks += delta; 8510074Snilay@cs.wisc.edu } 869508Snilay@cs.wisc.edu const Tick getDelayedTicks() const {return m_DelayedTicks;} 879465Snilay@cs.wisc.edu 889508Snilay@cs.wisc.edu void setLastEnqueueTime(const Tick& time) { m_LastEnqueueTime = time; } 899508Snilay@cs.wisc.edu const Tick getLastEnqueueTime() const {return m_LastEnqueueTime;} 906145Snate@binkert.org 919508Snilay@cs.wisc.edu const Tick& getTime() const { return m_time; } 9210893Snilay@cs.wisc.edu void setMsgCounter(uint64_t c) { m_msg_counter = c; } 9310893Snilay@cs.wisc.edu uint64_t getMsgCounter() const { return m_msg_counter; } 946145Snate@binkert.org 9510895Snilay@cs.wisc.edu // Functions related to network traversal 9610895Snilay@cs.wisc.edu virtual const NetDest& getDestination() const 9710895Snilay@cs.wisc.edu { panic("getDestination() called on wrong message!"); } 9810895Snilay@cs.wisc.edu virtual NetDest& getDestination() 9910895Snilay@cs.wisc.edu { panic("getDestination() called on wrong message!"); } 10010895Snilay@cs.wisc.edu 10110895Snilay@cs.wisc.edu int getIncomingLink() const { return incoming_link; } 10210895Snilay@cs.wisc.edu void setIncomingLink(int link) { incoming_link = link; } 10310895Snilay@cs.wisc.edu int getVnet() const { return vnet; } 10410895Snilay@cs.wisc.edu void setVnet(int net) { vnet = net; } 10510895Snilay@cs.wisc.edu 1067039Snate@binkert.org private: 10710893Snilay@cs.wisc.edu const Tick m_time; 1089508Snilay@cs.wisc.edu Tick m_LastEnqueueTime; // my last enqueue time 1099508Snilay@cs.wisc.edu Tick m_DelayedTicks; // my delayed cycles 11010893Snilay@cs.wisc.edu uint64_t m_msg_counter; // FIXME, should this be a 64-bit value? 11110895Snilay@cs.wisc.edu 11210895Snilay@cs.wisc.edu // Variables for required network traversal 11310895Snilay@cs.wisc.edu int incoming_link; 11410895Snilay@cs.wisc.edu int vnet; 1156145Snate@binkert.org}; 1166145Snate@binkert.org 11710893Snilay@cs.wisc.eduinline bool 11810893Snilay@cs.wisc.eduoperator>(const MsgPtr &lhs, const MsgPtr &rhs) 11910893Snilay@cs.wisc.edu{ 12010893Snilay@cs.wisc.edu const Message *l = lhs.get(); 12110893Snilay@cs.wisc.edu const Message *r = rhs.get(); 12210893Snilay@cs.wisc.edu 12310893Snilay@cs.wisc.edu if (l->getLastEnqueueTime() == r->getLastEnqueueTime()) { 12410893Snilay@cs.wisc.edu assert(l->getMsgCounter() != r->getMsgCounter()); 12510893Snilay@cs.wisc.edu return l->getMsgCounter() > r->getMsgCounter(); 12610893Snilay@cs.wisc.edu } 12710893Snilay@cs.wisc.edu return l->getLastEnqueueTime() > r->getLastEnqueueTime(); 12810893Snilay@cs.wisc.edu} 12910893Snilay@cs.wisc.edu 1307039Snate@binkert.orginline std::ostream& 1317039Snate@binkert.orgoperator<<(std::ostream& out, const Message& obj) 1326145Snate@binkert.org{ 1337039Snate@binkert.org obj.print(out); 1347039Snate@binkert.org out << std::flush; 1357039Snate@binkert.org return out; 1366145Snate@binkert.org} 1376145Snate@binkert.org 1387039Snate@binkert.org#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__ 139