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