TimerTable.hh revision 7055 
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_SYSTEM_TIMERTABLE_HH__
30#define __MEM_RUBY_SYSTEM_TIMERTABLE_HH__
31
32#include <cassert>
33#include <iostream>
34#include <string>
35
36#include "mem/gems_common/Map.hh"
37#include "mem/ruby/common/Address.hh"
38#include "mem/ruby/common/Global.hh"
39
40class Consumer;
41
42class TimerTable
43{
44  public:
45    TimerTable();
46
47    static void printConfig(std::ostream& out) {}
48
49    void
50    setConsumer(Consumer* consumer_ptr)
51    {
52        assert(m_consumer_ptr == NULL);
53        m_consumer_ptr = consumer_ptr;
54    }
55
56    void
57    setDescription(const std::string& name)
58    {
59        m_name = name;
60    }
61
62    bool isReady() const;
63    const Address& readyAddress() const;
64    bool isSet(const Address& address) const { return m_map.exist(address); }
65    void set(const Address& address, Time relative_latency);
66    void unset(const Address& address);
67    void print(std::ostream& out) const;
68
69  private:
70    void updateNext() const;
71
72    // Private copy constructor and assignment operator
73    TimerTable(const TimerTable& obj);
74    TimerTable& operator=(const TimerTable& obj);
75
76    // Data Members (m_prefix)
77    Map<Address, Time> m_map;
78    mutable bool m_next_valid;
79    mutable Time m_next_time; // Only valid if m_next_valid is true
80    mutable Address m_next_address;  // Only valid if m_next_valid is true
81    Consumer* m_consumer_ptr;  // Consumer to signal a wakeup()
82    std::string m_name;
83};
84
85inline std::ostream&
86operator<<(std::ostream& out, const TimerTable& obj)
87{
88    obj.print(out);
89    out << std::flush;
90    return out;
91}
92
93#endif // __MEM_RUBY_SYSTEM_TIMERTABLE_HH__
94