Consumer.hh revision 7039:bc0b6ea676b5
110915Sandreas.sandberg@arm.com/*
211313Sandreas.sandberg@arm.com * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
310915Sandreas.sandberg@arm.com * All rights reserved.
410915Sandreas.sandberg@arm.com *
510915Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without
610915Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are
710915Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright
810915Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer;
910915Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright
1010915Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the
1110915Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution;
1210915Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its
1310915Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from
1410915Sandreas.sandberg@arm.com * this software without specific prior written permission.
1510915Sandreas.sandberg@arm.com *
1610915Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1710915Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1810915Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1910915Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
2010915Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2110915Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2210915Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2310915Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2410915Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2510915Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2610915Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2710915Sandreas.sandberg@arm.com */
2810915Sandreas.sandberg@arm.com
2910915Sandreas.sandberg@arm.com/*
3010915Sandreas.sandberg@arm.com * This is the virtual base class of all classes that can be the
3110915Sandreas.sandberg@arm.com * targets of wakeup events.  There is only two methods, wakeup() and
3210915Sandreas.sandberg@arm.com * print() and no data members.
3310915Sandreas.sandberg@arm.com */
3410915Sandreas.sandberg@arm.com
3510915Sandreas.sandberg@arm.com#ifndef __MEM_RUBY_COMMON_CONSUMER_HH__
3610915Sandreas.sandberg@arm.com#define __MEM_RUBY_COMMON_CONSUMER_HH__
3710915Sandreas.sandberg@arm.com
3810915Sandreas.sandberg@arm.com#include <iostream>
3910915Sandreas.sandberg@arm.com#include <set>
4010915Sandreas.sandberg@arm.com
4110915Sandreas.sandberg@arm.com#include "mem/ruby/common/Global.hh"
4210915Sandreas.sandberg@arm.com#include "mem/ruby/eventqueue/RubyEventQueue.hh"
4310915Sandreas.sandberg@arm.com
4410915Sandreas.sandberg@arm.comclass MessageBuffer;
4510915Sandreas.sandberg@arm.com
4610915Sandreas.sandberg@arm.comclass Consumer
4710915Sandreas.sandberg@arm.com{
4810915Sandreas.sandberg@arm.com  public:
4910915Sandreas.sandberg@arm.com    Consumer()
5010915Sandreas.sandberg@arm.com        : m_last_scheduled_wakeup(0), m_last_wakeup(0)
5110915Sandreas.sandberg@arm.com    {
5210915Sandreas.sandberg@arm.com    }
5310915Sandreas.sandberg@arm.com
5410915Sandreas.sandberg@arm.com    virtual
5510915Sandreas.sandberg@arm.com    ~Consumer()
5610915Sandreas.sandberg@arm.com    { }
5710915Sandreas.sandberg@arm.com
5810915Sandreas.sandberg@arm.com    void
5910915Sandreas.sandberg@arm.com    triggerWakeup(RubyEventQueue *eventQueue)
6010915Sandreas.sandberg@arm.com    {
6110915Sandreas.sandberg@arm.com        Time time = eventQueue->getTime();
6210915Sandreas.sandberg@arm.com        if (m_last_wakeup != time) {
6310915Sandreas.sandberg@arm.com            wakeup();
6410915Sandreas.sandberg@arm.com            m_last_wakeup = time;
6510915Sandreas.sandberg@arm.com        }
6610915Sandreas.sandberg@arm.com    }
6710915Sandreas.sandberg@arm.com
6810915Sandreas.sandberg@arm.com    virtual void wakeup() = 0;
6910915Sandreas.sandberg@arm.com    virtual void print(std::ostream& out) const = 0;
7010915Sandreas.sandberg@arm.com
7110915Sandreas.sandberg@arm.com    const Time&
7210915Sandreas.sandberg@arm.com    getLastScheduledWakeup() const
7310915Sandreas.sandberg@arm.com    {
7410915Sandreas.sandberg@arm.com        return m_last_scheduled_wakeup;
7510915Sandreas.sandberg@arm.com    }
7610915Sandreas.sandberg@arm.com
7710915Sandreas.sandberg@arm.com    void
7810915Sandreas.sandberg@arm.com    setLastScheduledWakeup(const Time& time)
7910915Sandreas.sandberg@arm.com    {
8010915Sandreas.sandberg@arm.com        m_last_scheduled_wakeup = time;
8110915Sandreas.sandberg@arm.com    }
8210915Sandreas.sandberg@arm.com
8310915Sandreas.sandberg@arm.com    bool
8410915Sandreas.sandberg@arm.com    alreadyScheduled(Time time)
8510915Sandreas.sandberg@arm.com    {
8610915Sandreas.sandberg@arm.com        return m_scheduled_wakeups.find(time) != m_scheduled_wakeups.end();
8710915Sandreas.sandberg@arm.com    }
8811313Sandreas.sandberg@arm.com
8911313Sandreas.sandberg@arm.com    void
9010915Sandreas.sandberg@arm.com    insertScheduledWakeupTime(Time time)
9110915Sandreas.sandberg@arm.com    {
9210915Sandreas.sandberg@arm.com        m_scheduled_wakeups.insert(time);
9310915Sandreas.sandberg@arm.com    }
9410915Sandreas.sandberg@arm.com
9510915Sandreas.sandberg@arm.com    void
9610915Sandreas.sandberg@arm.com    removeScheduledWakeupTime(Time time)
9710915Sandreas.sandberg@arm.com    {
9810915Sandreas.sandberg@arm.com        assert(alreadyScheduled(time));
9910915Sandreas.sandberg@arm.com        m_scheduled_wakeups.erase(time);
10010915Sandreas.sandberg@arm.com    }
10110915Sandreas.sandberg@arm.com
10210915Sandreas.sandberg@arm.com  private:
10310915Sandreas.sandberg@arm.com    Time m_last_scheduled_wakeup;
10410915Sandreas.sandberg@arm.com    std::set<Time> m_scheduled_wakeups;
10510915Sandreas.sandberg@arm.com    Time m_last_wakeup;
10610915Sandreas.sandberg@arm.com};
10710915Sandreas.sandberg@arm.com
10810915Sandreas.sandberg@arm.cominline std::ostream&
10910915Sandreas.sandberg@arm.comoperator<<(std::ostream& out, const Consumer& obj)
11010915Sandreas.sandberg@arm.com{
11110915Sandreas.sandberg@arm.com    obj.print(out);
11210915Sandreas.sandberg@arm.com    out << std::flush;
11310915Sandreas.sandberg@arm.com    return out;
11410915Sandreas.sandberg@arm.com}
11510915Sandreas.sandberg@arm.com
11610915Sandreas.sandberg@arm.com#endif // __MEM_RUBY_COMMON_CONSUMER_HH__
11710915Sandreas.sandberg@arm.com