Consumer.hh (7039:bc0b6ea676b5) Consumer.hh (7973:e5550966464a)
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/*
30 * This is the virtual base class of all classes that can be the
31 * targets of wakeup events. There is only two methods, wakeup() and
32 * print() and no data members.
33 */
34
35#ifndef __MEM_RUBY_COMMON_CONSUMER_HH__
36#define __MEM_RUBY_COMMON_CONSUMER_HH__
37
38#include <iostream>
39#include <set>
40
41#include "mem/ruby/common/Global.hh"
42#include "mem/ruby/eventqueue/RubyEventQueue.hh"
43
44class MessageBuffer;
45
46class Consumer
47{
48 public:
49 Consumer()
50 : m_last_scheduled_wakeup(0), m_last_wakeup(0)
51 {
52 }
53
54 virtual
55 ~Consumer()
56 { }
57
58 void
59 triggerWakeup(RubyEventQueue *eventQueue)
60 {
61 Time time = eventQueue->getTime();
62 if (m_last_wakeup != time) {
63 wakeup();
64 m_last_wakeup = time;
65 }
66 }
67
68 virtual void wakeup() = 0;
69 virtual void print(std::ostream& out) const = 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/*
30 * This is the virtual base class of all classes that can be the
31 * targets of wakeup events. There is only two methods, wakeup() and
32 * print() and no data members.
33 */
34
35#ifndef __MEM_RUBY_COMMON_CONSUMER_HH__
36#define __MEM_RUBY_COMMON_CONSUMER_HH__
37
38#include <iostream>
39#include <set>
40
41#include "mem/ruby/common/Global.hh"
42#include "mem/ruby/eventqueue/RubyEventQueue.hh"
43
44class MessageBuffer;
45
46class Consumer
47{
48 public:
49 Consumer()
50 : m_last_scheduled_wakeup(0), m_last_wakeup(0)
51 {
52 }
53
54 virtual
55 ~Consumer()
56 { }
57
58 void
59 triggerWakeup(RubyEventQueue *eventQueue)
60 {
61 Time time = eventQueue->getTime();
62 if (m_last_wakeup != time) {
63 wakeup();
64 m_last_wakeup = time;
65 }
66 }
67
68 virtual void wakeup() = 0;
69 virtual void print(std::ostream& out) const = 0;
70 virtual void storeEventInfo(int info) {}
70
71 const Time&
72 getLastScheduledWakeup() const
73 {
74 return m_last_scheduled_wakeup;
75 }
76
77 void
78 setLastScheduledWakeup(const Time& time)
79 {
80 m_last_scheduled_wakeup = time;
81 }
82
83 bool
84 alreadyScheduled(Time time)
85 {
86 return m_scheduled_wakeups.find(time) != m_scheduled_wakeups.end();
87 }
88
89 void
90 insertScheduledWakeupTime(Time time)
91 {
92 m_scheduled_wakeups.insert(time);
93 }
94
95 void
96 removeScheduledWakeupTime(Time time)
97 {
98 assert(alreadyScheduled(time));
99 m_scheduled_wakeups.erase(time);
100 }
101
102 private:
103 Time m_last_scheduled_wakeup;
104 std::set<Time> m_scheduled_wakeups;
105 Time m_last_wakeup;
106};
107
108inline std::ostream&
109operator<<(std::ostream& out, const Consumer& obj)
110{
111 obj.print(out);
112 out << std::flush;
113 return out;
114}
115
116#endif // __MEM_RUBY_COMMON_CONSUMER_HH__
71
72 const Time&
73 getLastScheduledWakeup() const
74 {
75 return m_last_scheduled_wakeup;
76 }
77
78 void
79 setLastScheduledWakeup(const Time& time)
80 {
81 m_last_scheduled_wakeup = time;
82 }
83
84 bool
85 alreadyScheduled(Time time)
86 {
87 return m_scheduled_wakeups.find(time) != m_scheduled_wakeups.end();
88 }
89
90 void
91 insertScheduledWakeupTime(Time time)
92 {
93 m_scheduled_wakeups.insert(time);
94 }
95
96 void
97 removeScheduledWakeupTime(Time time)
98 {
99 assert(alreadyScheduled(time));
100 m_scheduled_wakeups.erase(time);
101 }
102
103 private:
104 Time m_last_scheduled_wakeup;
105 std::set<Time> m_scheduled_wakeups;
106 Time m_last_wakeup;
107};
108
109inline std::ostream&
110operator<<(std::ostream& out, const Consumer& obj)
111{
112 obj.print(out);
113 out << std::flush;
114 return out;
115}
116
117#endif // __MEM_RUBY_COMMON_CONSUMER_HH__