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