Consumer.hh (9499:b03b556a8fbb) Consumer.hh (9557:8666e81607a6)
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 "sim/clocked_object.hh"
42
43class Consumer
44{
45 public:
46 Consumer(ClockedObject *_em)
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 "sim/clocked_object.hh"
42
43class Consumer
44{
45 public:
46 Consumer(ClockedObject *_em)
47 : m_last_scheduled_wakeup(0), m_last_wakeup(0), em(_em)
47 : m_last_scheduled_wakeup(0), em(_em)
48 {
49 }
50
51 virtual
52 ~Consumer()
53 { }
54
55 virtual void wakeup() = 0;
56 virtual void print(std::ostream& out) const = 0;
57 virtual void storeEventInfo(int info) {}
58
59 const Tick&
60 getLastScheduledWakeup() const
61 {
62 return m_last_scheduled_wakeup;
63 }
64
65 void
66 setLastScheduledWakeup(const Tick& time)
67 {
68 m_last_scheduled_wakeup = time;
69 }
70
71 bool
72 alreadyScheduled(Tick time)
73 {
74 return m_scheduled_wakeups.find(time) != m_scheduled_wakeups.end();
75 }
76
77 void
78 insertScheduledWakeupTime(Tick time)
79 {
80 m_scheduled_wakeups.insert(time);
81 }
82
83 void
84 removeScheduledWakeupTime(Tick time)
85 {
86 assert(alreadyScheduled(time));
87 m_scheduled_wakeups.erase(time);
88 }
89
90 void scheduleEvent(Cycles timeDelta);
91 void scheduleEventAbsolute(Cycles timeAbs);
92
93 private:
94 Tick m_last_scheduled_wakeup;
95 std::set<Tick> m_scheduled_wakeups;
48 {
49 }
50
51 virtual
52 ~Consumer()
53 { }
54
55 virtual void wakeup() = 0;
56 virtual void print(std::ostream& out) const = 0;
57 virtual void storeEventInfo(int info) {}
58
59 const Tick&
60 getLastScheduledWakeup() const
61 {
62 return m_last_scheduled_wakeup;
63 }
64
65 void
66 setLastScheduledWakeup(const Tick& time)
67 {
68 m_last_scheduled_wakeup = time;
69 }
70
71 bool
72 alreadyScheduled(Tick time)
73 {
74 return m_scheduled_wakeups.find(time) != m_scheduled_wakeups.end();
75 }
76
77 void
78 insertScheduledWakeupTime(Tick time)
79 {
80 m_scheduled_wakeups.insert(time);
81 }
82
83 void
84 removeScheduledWakeupTime(Tick time)
85 {
86 assert(alreadyScheduled(time));
87 m_scheduled_wakeups.erase(time);
88 }
89
90 void scheduleEvent(Cycles timeDelta);
91 void scheduleEventAbsolute(Cycles timeAbs);
92
93 private:
94 Tick m_last_scheduled_wakeup;
95 std::set<Tick> m_scheduled_wakeups;
96 Tick m_last_wakeup;
97 ClockedObject *em;
98
99 class ConsumerEvent : public Event
100 {
101 public:
102 ConsumerEvent(Consumer* _consumer)
103 : Event(Default_Pri, AutoDelete), m_consumer_ptr(_consumer)
104 {
105 }
106
107 void process()
108 {
109 m_consumer_ptr->wakeup();
110 m_consumer_ptr->removeScheduledWakeupTime(when());
111 }
112
113 private:
114 Consumer* m_consumer_ptr;
115 };
116};
117
118inline std::ostream&
119operator<<(std::ostream& out, const Consumer& obj)
120{
121 obj.print(out);
122 out << std::flush;
123 return out;
124}
125
126#endif // __MEM_RUBY_COMMON_CONSUMER_HH__
96 ClockedObject *em;
97
98 class ConsumerEvent : public Event
99 {
100 public:
101 ConsumerEvent(Consumer* _consumer)
102 : Event(Default_Pri, AutoDelete), m_consumer_ptr(_consumer)
103 {
104 }
105
106 void process()
107 {
108 m_consumer_ptr->wakeup();
109 m_consumer_ptr->removeScheduledWakeupTime(when());
110 }
111
112 private:
113 Consumer* m_consumer_ptr;
114 };
115};
116
117inline std::ostream&
118operator<<(std::ostream& out, const Consumer& obj)
119{
120 obj.print(out);
121 out << std::flush;
122 return out;
123}
124
125#endif // __MEM_RUBY_COMMON_CONSUMER_HH__