Message.hh (10808:c1694b4032a6) Message.hh (10876:7544f29b7dfc)
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)
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)
48 {
49 timeStamps.push(curTime);
50 }
48 { }
51
52 Message(const Message &other)
53 : m_time(other.m_time),
54 m_LastEnqueueTime(other.m_LastEnqueueTime),
49
50 Message(const Message &other)
51 : m_time(other.m_time),
52 m_LastEnqueueTime(other.m_LastEnqueueTime),
55 m_DelayedTicks(other.m_DelayedTicks), timeStamps(other.timeStamps)
53 m_DelayedTicks(other.m_DelayedTicks)
56 { }
57
58 virtual ~Message() { }
59
60 virtual MsgPtr clone() const = 0;
61 virtual void print(std::ostream& out) const = 0;
62 virtual void setIncomingLink(int) {}
63 virtual void setVnet(int) {}
64
65 /**
66 * The two functions below are used for reading / writing the message
67 * functionally. The methods return true if the address in the packet
68 * matches the address / address range in the message. Each message
69 * class that can be potentially searched for the address needs to
70 * implement these methods.
71 */
72 virtual bool functionalRead(Packet *pkt) = 0;
73 //{ fatal("Read functional access not implemented!"); }
74 virtual bool functionalWrite(Packet *pkt) = 0;
75 //{ fatal("Write functional access not implemented!"); }
76
77 //! Update the delay this message has experienced so far.
78 void updateDelayedTicks(Tick curTime)
79 {
80 assert(m_LastEnqueueTime <= curTime);
81 Tick delta = curTime - m_LastEnqueueTime;
82 m_DelayedTicks += delta;
83 }
84 const Tick getDelayedTicks() const {return m_DelayedTicks;}
85
86 void setLastEnqueueTime(const Tick& time) { m_LastEnqueueTime = time; }
87 const Tick getLastEnqueueTime() const {return m_LastEnqueueTime;}
88
89 const Tick& getTime() const { return m_time; }
90 void setTime(const Tick& new_time) { m_time = new_time; }
91
92 private:
93 Tick m_time;
94 Tick m_LastEnqueueTime; // my last enqueue time
95 Tick m_DelayedTicks; // my delayed cycles
54 { }
55
56 virtual ~Message() { }
57
58 virtual MsgPtr clone() const = 0;
59 virtual void print(std::ostream& out) const = 0;
60 virtual void setIncomingLink(int) {}
61 virtual void setVnet(int) {}
62
63 /**
64 * The two functions below are used for reading / writing the message
65 * functionally. The methods return true if the address in the packet
66 * matches the address / address range in the message. Each message
67 * class that can be potentially searched for the address needs to
68 * implement these methods.
69 */
70 virtual bool functionalRead(Packet *pkt) = 0;
71 //{ fatal("Read functional access not implemented!"); }
72 virtual bool functionalWrite(Packet *pkt) = 0;
73 //{ fatal("Write functional access not implemented!"); }
74
75 //! Update the delay this message has experienced so far.
76 void updateDelayedTicks(Tick curTime)
77 {
78 assert(m_LastEnqueueTime <= curTime);
79 Tick delta = curTime - m_LastEnqueueTime;
80 m_DelayedTicks += delta;
81 }
82 const Tick getDelayedTicks() const {return m_DelayedTicks;}
83
84 void setLastEnqueueTime(const Tick& time) { m_LastEnqueueTime = time; }
85 const Tick getLastEnqueueTime() const {return m_LastEnqueueTime;}
86
87 const Tick& getTime() const { return m_time; }
88 void setTime(const Tick& new_time) { m_time = new_time; }
89
90 private:
91 Tick m_time;
92 Tick m_LastEnqueueTime; // my last enqueue time
93 Tick m_DelayedTicks; // my delayed cycles
96 std::stack<Tick> timeStamps;
97};
98
99inline std::ostream&
100operator<<(std::ostream& out, const Message& obj)
101{
102 obj.print(out);
103 out << std::flush;
104 return out;
105}
106
107#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__
94};
95
96inline std::ostream&
97operator<<(std::ostream& out, const Message& obj)
98{
99 obj.print(out);
100 out << std::flush;
101 return out;
102}
103
104#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__