Message.hh revision 10893:f567e80c0714 
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#include <memory>
34#include <stack>
35
36#include "mem/packet.hh"
37
38class Message;
39typedef std::shared_ptr<Message> MsgPtr;
40
41class Message
42{
43  public:
44    Message(Tick curTime)
45        : m_time(curTime),
46          m_LastEnqueueTime(curTime),
47          m_DelayedTicks(0), m_msg_counter(0)
48    { }
49
50    Message(const Message &other)
51        : m_time(other.m_time),
52          m_LastEnqueueTime(other.m_LastEnqueueTime),
53          m_DelayedTicks(other.m_DelayedTicks),
54          m_msg_counter(other.m_msg_counter)
55    { }
56
57    virtual ~Message() { }
58
59    virtual MsgPtr 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    virtual bool functionalWrite(Packet *pkt) = 0;
73
74    //! Update the delay this message has experienced so far.
75    void updateDelayedTicks(Tick curTime)
76    {
77        assert(m_LastEnqueueTime <= curTime);
78        Tick delta = curTime - m_LastEnqueueTime;
79        m_DelayedTicks += delta;
80    }
81    const Tick getDelayedTicks() const {return m_DelayedTicks;}
82
83    void setLastEnqueueTime(const Tick& time) { m_LastEnqueueTime = time; }
84    const Tick getLastEnqueueTime() const {return m_LastEnqueueTime;}
85
86    const Tick& getTime() const { return m_time; }
87    void setMsgCounter(uint64_t c) { m_msg_counter = c; }
88    uint64_t getMsgCounter() const { return m_msg_counter; }
89
90  private:
91    const Tick m_time;
92    Tick m_LastEnqueueTime; // my last enqueue time
93    Tick m_DelayedTicks; // my delayed cycles
94    uint64_t m_msg_counter; // FIXME, should this be a 64-bit value?
95};
96
97inline bool
98operator>(const MsgPtr &lhs, const MsgPtr &rhs)
99{
100    const Message *l = lhs.get();
101    const Message *r = rhs.get();
102
103    if (l->getLastEnqueueTime() == r->getLastEnqueueTime()) {
104        assert(l->getMsgCounter() != r->getMsgCounter());
105        return l->getMsgCounter() > r->getMsgCounter();
106    }
107    return l->getLastEnqueueTime() > r->getLastEnqueueTime();
108}
109
110inline std::ostream&
111operator<<(std::ostream& out, const Message& obj)
112{
113    obj.print(out);
114    out << std::flush;
115    return out;
116}
117
118#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__
119