gem5  v21.1.0.2
DirectoryMemory.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017,2019 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 #ifndef __MEM_RUBY_STRUCTURES_DIRECTORYMEMORY_HH__
42 #define __MEM_RUBY_STRUCTURES_DIRECTORYMEMORY_HH__
43 
44 #include <iostream>
45 #include <string>
46 
47 #include "base/addr_range.hh"
49 #include "mem/ruby/protocol/DirectoryRequestType.hh"
51 #include "params/RubyDirectoryMemory.hh"
52 #include "sim/sim_object.hh"
53 
54 namespace gem5
55 {
56 
57 namespace ruby
58 {
59 
60 class DirectoryMemory : public SimObject
61 {
62  public:
63  typedef RubyDirectoryMemoryParams Params;
64  DirectoryMemory(const Params &p);
66 
67  void init();
68 
80  uint64_t mapAddressToLocalIdx(Addr address);
81 
82  uint64_t getSize() { return m_size_bytes; }
83 
84  bool isPresent(Addr address);
85  AbstractCacheEntry *lookup(Addr address);
86  AbstractCacheEntry *allocate(Addr address, AbstractCacheEntry* new_entry);
87 
88  // Explicitly free up this address
89  void deallocate(Addr address);
90 
91  void print(std::ostream& out) const;
92  void recordRequestType(DirectoryRequestType requestType);
93 
94  private:
95  // Private copy constructor and assignment operator
96  DirectoryMemory(const DirectoryMemory& obj);
98 
99  private:
100  const std::string m_name;
102  // int m_size; // # of memory module blocks this directory is
103  // responsible for
104  uint64_t m_size_bytes;
105  uint64_t m_size_bits;
106  uint64_t m_num_entries;
107 
113 };
114 
115 inline std::ostream&
116 operator<<(std::ostream& out, const DirectoryMemory& obj)
117 {
118  obj.print(out);
119  out << std::flush;
120  return out;
121 }
122 
123 } // namespace ruby
124 } // namespace gem5
125 
126 #endif // __MEM_RUBY_STRUCTURES_DIRECTORYMEMORY_HH__
gem5::ruby::DirectoryMemory::addrRanges
const AddrRangeList addrRanges
The address range for which the directory responds.
Definition: DirectoryMemory.hh:112
gem5::ruby::DirectoryMemory::getSize
uint64_t getSize()
Definition: DirectoryMemory.hh:82
gem5::ruby::DirectoryMemory::operator=
DirectoryMemory & operator=(const DirectoryMemory &obj)
gem5::ruby::DirectoryMemory::mapAddressToLocalIdx
uint64_t mapAddressToLocalIdx(Addr address)
Return the index in the directory based on an address.
Definition: DirectoryMemory.cc:101
gem5::ruby::DirectoryMemory::m_size_bits
uint64_t m_size_bits
Definition: DirectoryMemory.hh:105
gem5::ruby::DirectoryMemory::~DirectoryMemory
~DirectoryMemory()
Definition: DirectoryMemory.cc:78
gem5::ruby::DirectoryMemory::m_entries
AbstractCacheEntry ** m_entries
Definition: DirectoryMemory.hh:101
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::DirectoryMemory::init
void init()
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: DirectoryMemory.cc:70
gem5::ruby::DirectoryMemory::allocate
AbstractCacheEntry * allocate(Addr address, AbstractCacheEntry *new_entry)
Definition: DirectoryMemory.cc:126
AbstractCacheEntry.hh
gem5::ruby::DirectoryMemory::recordRequestType
void recordRequestType(DirectoryRequestType requestType)
Definition: DirectoryMemory.cc:161
gem5::ruby::DirectoryMemory::Params
RubyDirectoryMemoryParams Params
Definition: DirectoryMemory.hh:63
gem5::ruby::DirectoryMemory::isPresent
bool isPresent(Addr address)
Definition: DirectoryMemory.cc:90
gem5::ruby::DirectoryMemory::deallocate
void deallocate(Addr address)
Definition: DirectoryMemory.cc:142
sim_object.hh
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::ruby::DirectoryMemory::m_num_entries
uint64_t m_num_entries
Definition: DirectoryMemory.hh:106
gem5::ruby::DirectoryMemory::DirectoryMemory
DirectoryMemory(const Params &p)
Definition: DirectoryMemory.cc:58
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::ruby::DirectoryMemory
Definition: DirectoryMemory.hh:60
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
addr_range.hh
Address.hh
gem5::ruby::DirectoryMemory::m_name
const std::string m_name
Definition: DirectoryMemory.hh:100
gem5::ruby::DirectoryMemory::m_size_bytes
uint64_t m_size_bytes
Definition: DirectoryMemory.hh:104
std::list< AddrRange >
gem5::ruby::DirectoryMemory::lookup
AbstractCacheEntry * lookup(Addr address)
Definition: DirectoryMemory.cc:115
gem5::ruby::DirectoryMemory::print
void print(std::ostream &out) const
Definition: DirectoryMemory.cc:156
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40

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