gem5  v21.1.0.2
backdoor.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2019 Google, Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met: redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer;
8  * redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution;
11  * neither the name of the copyright holders nor the names of its
12  * contributors may be used to endorse or promote products derived from
13  * this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef __MEM_BACKDOOR_HH__
29 #define __MEM_BACKDOOR_HH__
30 
31 #include <cstdint>
32 #include <functional>
33 #include <memory>
34 
35 #include "base/addr_range.hh"
36 #include "base/callback.hh"
37 
38 namespace gem5
39 {
40 
42 {
43  public:
44  // Callbacks from this back door are set up using a callable which accepts
45  // a const reference to this back door as their only parameter.
46  typedef std::function<void(const MemBackdoor &backdoor)> CbFunction;
47 
48  public:
49  enum Flags
50  {
51  // How data is allowed to be accessed through this backdoor.
52  NoAccess = 0x0,
53  Readable = 0x1,
54  Writeable = 0x2
55  };
56 
57  // The range in the guest address space covered by this back door.
58  const AddrRange &range() const { return _range; }
59  void range(const AddrRange &r) { _range = r; }
60 
61  // A pointer to the data accessible through this back door.
62  uint8_t *ptr() const { return _ptr; }
63  void ptr(uint8_t *p) { _ptr = p; }
64 
65  /*
66  * Helper functions to make it easier to set/check particular flags.
67  */
68 
69  bool readable() const { return _flags & Readable; }
70  void
71  readable(bool r)
72  {
73  if (r)
74  _flags = (Flags)(_flags | Readable);
75  else
76  _flags = (Flags)(_flags & ~Readable);
77  }
78 
79  bool writeable() const { return _flags & Writeable; }
80  void
81  writeable(bool w)
82  {
83  if (w)
85  else
86  _flags = (Flags)(_flags & ~Writeable);
87  }
88 
89  Flags flags() const { return _flags; }
90  void flags(Flags f) { _flags = f; }
91 
93  _range(r), _ptr(p), _flags(flags)
94  {}
95 
97  {}
98 
99  // Set up a callable to be called when this back door is invalidated. This
100  // lets holders update their bookkeeping to remove any references to it,
101  // and/or to propogate that invalidation to other interested parties.
102  void
104  {
105  invalidationCallbacks.push_back([this,func](){ func(*this); });
106  }
107 
108  // Notify and clear invalidation callbacks when the data in the backdoor
109  // structure is no longer valid/current. The backdoor might then be
110  // updated or even deleted without having to worry about stale data being
111  // used.
112  void
114  {
116  invalidationCallbacks.clear();
117  }
118 
119  private:
121 
123  uint8_t *_ptr;
125 };
126 
128 
129 } // namespace gem5
130 
131 #endif //__MEM_BACKDOOR_HH__
gem5::MemBackdoor::writeable
void writeable(bool w)
Definition: backdoor.hh:81
gem5::CallbackQueue
Definition: callback.hh:38
gem5::MipsISA::w
Bitfield< 0 > w
Definition: pra_constants.hh:281
gem5::MemBackdoor::Writeable
@ Writeable
Definition: backdoor.hh:54
gem5::MemBackdoor::ptr
void ptr(uint8_t *p)
Definition: backdoor.hh:63
gem5::ArmISA::f
Bitfield< 6 > f
Definition: misc_types.hh:67
gem5::MemBackdoor::_range
AddrRange _range
Definition: backdoor.hh:122
gem5::MemBackdoorPtr
MemBackdoor * MemBackdoorPtr
Definition: backdoor.hh:127
gem5::MemBackdoor::MemBackdoor
MemBackdoor(AddrRange r, uint8_t *p, Flags flags)
Definition: backdoor.hh:92
gem5::MemBackdoor::invalidate
void invalidate()
Definition: backdoor.hh:113
gem5::MemBackdoor::readable
bool readable() const
Definition: backdoor.hh:69
gem5::MemBackdoor::invalidationCallbacks
CallbackQueue invalidationCallbacks
Definition: backdoor.hh:120
gem5::MemBackdoor::addInvalidationCallback
void addInvalidationCallback(CbFunction func)
Definition: backdoor.hh:103
gem5::MemBackdoor::_flags
Flags _flags
Definition: backdoor.hh:124
gem5::MemBackdoor::flags
Flags flags() const
Definition: backdoor.hh:89
gem5::MemBackdoor::range
void range(const AddrRange &r)
Definition: backdoor.hh:59
gem5::MemBackdoor::Flags
Flags
Definition: backdoor.hh:49
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::MemBackdoor::_ptr
uint8_t * _ptr
Definition: backdoor.hh:123
gem5::MemBackdoor::MemBackdoor
MemBackdoor()
Definition: backdoor.hh:96
gem5::MemBackdoor
Definition: backdoor.hh:41
addr_range.hh
gem5::MemBackdoor::writeable
bool writeable() const
Definition: backdoor.hh:79
gem5::MemBackdoor::ptr
uint8_t * ptr() const
Definition: backdoor.hh:62
gem5::MemBackdoor::NoAccess
@ NoAccess
Definition: backdoor.hh:52
gem5::MemBackdoor::range
const AddrRange & range() const
Definition: backdoor.hh:58
gem5::MemBackdoor::readable
void readable(bool r)
Definition: backdoor.hh:71
gem5::MemBackdoor::CbFunction
std::function< void(const MemBackdoor &backdoor)> CbFunction
Definition: backdoor.hh:46
gem5::MipsISA::r
r
Definition: pra_constants.hh:98
gem5::AddrRange
The AddrRange class encapsulates an address range, and supports a number of tests to check if two ran...
Definition: addr_range.hh:71
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::MemBackdoor::Readable
@ Readable
Definition: backdoor.hh:53
gem5::CallbackQueue::process
void process()
Definition: callback.hh:49
gem5::MemBackdoor::flags
void flags(Flags f)
Definition: backdoor.hh:90
callback.hh

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