gem5  v21.1.0.2
TimerTable.hh
Go to the documentation of this file.
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 
39 
40 namespace gem5
41 {
42 
43 namespace ruby
44 {
45 
47 {
48  public:
49  TimerTable();
50 
51  void
52  setConsumer(Consumer* consumer_ptr)
53  {
54  assert(m_consumer_ptr == NULL);
55  m_consumer_ptr = consumer_ptr;
56  }
57 
58  void
59  setDescription(const std::string& name)
60  {
61  m_name = name;
62  }
63 
64  bool isReady(Tick curTime) const;
65  Addr nextAddress() const;
66  bool isSet(Addr address) const { return !!m_map.count(address); }
67  void set(Addr address, Tick ready_time);
68  void unset(Addr address);
69  void print(std::ostream& out) const;
70 
71  private:
72  void updateNext() const;
73 
74  // Private copy constructor and assignment operator
75  TimerTable(const TimerTable& obj);
76  TimerTable& operator=(const TimerTable& obj);
77 
78  // Data Members (m_prefix)
79 
80  // use a std::map for the address map as this container is sorted
81  // and ensures a well-defined iteration order
82  typedef std::map<Addr, Tick> AddressMap;
84  mutable bool m_next_valid;
85  mutable Tick m_next_time; // Only valid if m_next_valid is true
86  mutable Addr m_next_address; // Only valid if m_next_valid is true
87 
90 
91  std::string m_name;
92 };
93 
94 inline std::ostream&
95 operator<<(std::ostream& out, const TimerTable& obj)
96 {
97  obj.print(out);
98  out << std::flush;
99  return out;
100 }
101 
102 } // namespace ruby
103 } // namespace gem5
104 
105 #endif // __MEM_RUBY_STRUCTURES_TIMERTABLE_HH__
gem5::ruby::TimerTable::AddressMap
std::map< Addr, Tick > AddressMap
Definition: TimerTable.hh:82
gem5::ruby::operator<<
std::ostream & operator<<(std::ostream &os, const BoolVec &myvector)
Definition: BoolVec.cc:49
gem5::ruby::TimerTable
Definition: TimerTable.hh:46
gem5::ruby::TimerTable::m_next_valid
bool m_next_valid
Definition: TimerTable.hh:84
gem5::ruby::Consumer
Definition: Consumer.hh:61
gem5::ruby::TimerTable::m_name
std::string m_name
Definition: TimerTable.hh:91
gem5::ruby::TimerTable::set
void set(Addr address, Tick ready_time)
Definition: TimerTable.cc:71
gem5::ruby::TimerTable::isSet
bool isSet(Addr address) const
Definition: TimerTable.hh:66
gem5::ruby::TimerTable::TimerTable
TimerTable()
Definition: TimerTable.cc:39
gem5::ruby::TimerTable::setDescription
void setDescription(const std::string &name)
Definition: TimerTable.hh:59
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::ruby::TimerTable::m_map
AddressMap m_map
Definition: TimerTable.hh:83
name
const std::string & name()
Definition: trace.cc:49
gem5::ruby::TimerTable::print
void print(std::ostream &out) const
Definition: TimerTable.cc:101
gem5::ruby::TimerTable::updateNext
void updateNext() const
Definition: TimerTable.cc:106
Consumer.hh
Address.hh
gem5::ruby::TimerTable::unset
void unset(Addr address)
Definition: TimerTable.cc:88
gem5::ruby::TimerTable::isReady
bool isReady(Tick curTime) const
Definition: TimerTable.cc:48
gem5::ruby::TimerTable::m_next_time
Tick m_next_time
Definition: TimerTable.hh:85
gem5::ruby::TimerTable::setConsumer
void setConsumer(Consumer *consumer_ptr)
Definition: TimerTable.hh:52
gem5::ruby::TimerTable::nextAddress
Addr nextAddress() const
Definition: TimerTable.cc:61
gem5::ruby::TimerTable::m_consumer_ptr
Consumer * m_consumer_ptr
Consumer to signal a wakeup()
Definition: TimerTable.hh:89
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ruby::TimerTable::operator=
TimerTable & operator=(const TimerTable &obj)
gem5::ruby::TimerTable::m_next_address
Addr m_next_address
Definition: TimerTable.hh:86

Generated on Tue Sep 21 2021 12:25:42 for gem5 by doxygen 1.8.17