gem5  v21.1.0.2
AbstractCacheEntry.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are
19  * met: redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer;
21  * redistributions in binary form must reproduce the above copyright
22  * notice, this list of conditions and the following disclaimer in the
23  * documentation and/or other materials provided with the distribution;
24  * neither the name of the copyright holders nor the names of its
25  * contributors may be used to endorse or promote products derived from
26  * this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 /*
42  * Common base class for a machine node.
43  */
44 
45 #ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCACHEENTRY_HH__
46 #define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCACHEENTRY_HH__
47 
48 #include <iostream>
49 
50 #include "base/logging.hh"
54 #include "mem/ruby/protocol/AccessPermission.hh"
55 
56 namespace gem5
57 {
58 
59 namespace ruby
60 {
61 
63 {
64  private:
65  // The last access tick for the cache entry.
67 
68  public:
70  virtual ~AbstractCacheEntry() = 0;
71 
72  // Get/Set permission of the entry
73  AccessPermission getPermission() const;
74  void changePermission(AccessPermission new_perm);
75 
77  virtual void print(std::ostream& out) const = 0;
78 
79  // The methods below are those called by ruby runtime, add when it
80  // is absolutely necessary and should all be virtual function.
81  virtual DataBlock&
83  {
84  panic("getDataBlk() not implemented!");
85 
86  // Dummy return to appease the compiler
87  static DataBlock b;
88  return b;
89  }
90 
92  virtual int& getNumValidBlocks()
93  {
94  return validBlocks;
95  }
96 
97  // Functions for locking and unlocking the cache entry. These are required
98  // for supporting atomic memory accesses.
99  void setLocked(int context);
100  void clearLocked();
101  bool isLocked(int context) const;
102 
103  // Address of this block, required by CacheMemory
105  // Holds info whether the address is locked.
106  // Required for implementing LL/SC operations.
107  int m_locked;
108 
109  AccessPermission m_Permission; // Access permission for this
110  // block, required by CacheMemory
111 
112  // Get the last access Tick.
114 
115  // Set the last access Tick.
116  void setLastAccess(Tick tick) { m_last_touch_tick = tick; }
117 
118  // hardware transactional memory
119  void setInHtmReadSet(bool val);
120  void setInHtmWriteSet(bool val);
121  bool getInHtmReadSet() const;
122  bool getInHtmWriteSet() const;
123  virtual void invalidateEntry() {}
124 
125  private:
126  // hardware transactional memory
129 };
130 
131 inline std::ostream&
132 operator<<(std::ostream& out, const AbstractCacheEntry& obj)
133 {
134  obj.print(out);
135  out << std::flush;
136  return out;
137 }
138 
139 } // namespace ruby
140 } // namespace gem5
141 
142 #endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCACHEENTRY_HH__
gem5::ruby::AbstractCacheEntry::changePermission
void changePermission(AccessPermission new_perm)
Definition: AbstractCacheEntry.cc:74
gem5::ruby::AbstractCacheEntry::m_Permission
AccessPermission m_Permission
Definition: AbstractCacheEntry.hh:109
gem5::ruby::operator<<
std::ostream & operator<<(std::ostream &os, const BoolVec &myvector)
Definition: BoolVec.cc:49
gem5::ruby::AbstractCacheEntry
Definition: AbstractCacheEntry.hh:62
gem5::ruby::AbstractCacheEntry::validBlocks
int validBlocks
Definition: AbstractCacheEntry.hh:91
gem5::ruby::AbstractCacheEntry::~AbstractCacheEntry
virtual ~AbstractCacheEntry()=0
Definition: AbstractCacheEntry.cc:62
gem5::ruby::AbstractCacheEntry::getInHtmReadSet
bool getInHtmReadSet() const
Definition: AbstractCacheEntry.cc:118
gem5::X86ISA::val
Bitfield< 63 > val
Definition: misc.hh:775
gem5::ruby::AbstractCacheEntry::m_last_touch_tick
Tick m_last_touch_tick
Definition: AbstractCacheEntry.hh:66
gem5::ruby::AbstractCacheEntry::clearLocked
void clearLocked()
Definition: AbstractCacheEntry.cc:91
gem5::ruby::AbstractCacheEntry::setLastAccess
void setLastAccess(Tick tick)
Definition: AbstractCacheEntry.hh:116
gem5::ruby::AbstractCacheEntry::print
virtual void print(std::ostream &out) const =0
replaceable_entry.hh
gem5::ruby::AbstractCacheEntry::m_htmInReadSet
bool m_htmInReadSet
Definition: AbstractCacheEntry.hh:127
gem5::ArmISA::b
Bitfield< 7 > b
Definition: misc_types.hh:381
gem5::ruby::AbstractCacheEntry::getNumValidBlocks
virtual int & getNumValidBlocks()
Definition: AbstractCacheEntry.hh:92
gem5::ReplaceableEntry::print
virtual std::string print() const
Prints relevant information about this entry.
Definition: replaceable_entry.hh:119
DataBlock.hh
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::ruby::AbstractCacheEntry::getInHtmWriteSet
bool getInHtmWriteSet() const
Definition: AbstractCacheEntry.cc:124
gem5::ruby::AbstractCacheEntry::setInHtmReadSet
void setInHtmReadSet(bool val)
Definition: AbstractCacheEntry.cc:106
gem5::ruby::AbstractCacheEntry::setLocked
void setLocked(int context)
Definition: AbstractCacheEntry.cc:84
gem5::ruby::AbstractCacheEntry::m_htmInWriteSet
bool m_htmInWriteSet
Definition: AbstractCacheEntry.hh:128
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::ruby::AbstractCacheEntry::invalidateEntry
virtual void invalidateEntry()
Definition: AbstractCacheEntry.hh:123
gem5::ruby::AbstractCacheEntry::setInHtmWriteSet
void setInHtmWriteSet(bool val)
Definition: AbstractCacheEntry.cc:112
Address.hh
gem5::ruby::AbstractCacheEntry::getLastAccess
Tick getLastAccess()
Definition: AbstractCacheEntry.hh:113
gem5::ReplaceableEntry
A replaceable entry is a basic entry in a 2d table-like structure that needs to have replacement func...
Definition: replaceable_entry.hh:63
gem5::ruby::AbstractCacheEntry::AbstractCacheEntry
AbstractCacheEntry()
Definition: AbstractCacheEntry.cc:52
gem5::ruby::AbstractCacheEntry::getDataBlk
virtual DataBlock & getDataBlk()
Definition: AbstractCacheEntry.hh:82
logging.hh
gem5::ruby::AbstractCacheEntry::getPermission
AccessPermission getPermission() const
Definition: AbstractCacheEntry.cc:68
gem5::ruby::AbstractCacheEntry::isLocked
bool isLocked(int context) const
Definition: AbstractCacheEntry.cc:98
gem5::ruby::DataBlock
Definition: DataBlock.hh:60
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ruby::AbstractCacheEntry::m_locked
int m_locked
Definition: AbstractCacheEntry.hh:107
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:177
gem5::ruby::AbstractCacheEntry::m_Address
Addr m_Address
Definition: AbstractCacheEntry.hh:104

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