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