2 * Copyright (c) 2014 Advanced Micro Devices, Inc.
3 * Copyright (c) 2003 The Regents of The University of Michigan
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * Authors: Steve Reinhardt
34 * Declarations of a non-full system Page Table.
37 #ifndef __MEM_PAGE_TABLE_HH__
38 #define __MEM_PAGE_TABLE_HH__
41 #include <unordered_map>
43 #include "base/intmath.hh"
44 #include "base/types.hh"
45 #include "mem/request.hh"
46 #include "sim/serialize.hh"
50 class EmulationPageTable : public Serializable
58 Entry(Addr paddr, uint64_t flags) : paddr(paddr), flags(flags) {}
63 typedef std::unordered_map<Addr, Entry> PTable;
64 typedef PTable::iterator PTableItr;
68 const Addr offsetMask;
71 const std::string _name;
76 const std::string &__name, uint64_t _pid, Addr _pageSize) :
77 pageSize(_pageSize), offsetMask(mask(floorLog2(_pageSize))),
78 _pid(_pid), _name(__name), shared(false)
80 assert(isPowerOf2(pageSize));
83 uint64_t pid() const { return _pid; };
85 virtual ~EmulationPageTable() {};
87 /* generic page table mapping flags
89 * bit 0 - no-clobber | clobber
90 * bit 2 - cacheable | uncacheable
91 * bit 3 - read-write | read-only
93 enum MappingFlags : uint32_t {
99 // flag which marks the page table as shared among software threads
102 virtual void initState() {};
104 // for DPRINTF compatibility
105 const std::string name() const { return _name; }
107 Addr pageAlign(Addr a) { return (a & ~offsetMask); }
108 Addr pageOffset(Addr a) { return (a & offsetMask); }
111 * Maps a virtual memory region to a physical memory region.
112 * @param vaddr The starting virtual address of the region.
113 * @param paddr The starting physical address where the region is mapped.
114 * @param size The length of the region.
115 * @param flags Generic mapping flags that can be set by or-ing values
116 * from MappingFlags enum.
118 virtual void map(Addr vaddr, Addr paddr, int64_t size, uint64_t flags = 0);
119 virtual void remap(Addr vaddr, int64_t size, Addr new_vaddr);
120 virtual void unmap(Addr vaddr, int64_t size);
123 * Check if any pages in a region are already allocated
124 * @param vaddr The starting virtual address of the region.
125 * @param size The length of the region.
126 * @return True if no pages in the region are mapped.
128 virtual bool isUnmapped(Addr vaddr, int64_t size);
132 * @param vaddr The virtual address.
133 * @return The page table entry corresponding to vaddr.
135 const Entry *lookup(Addr vaddr);
139 * @param vaddr The virtual address.
140 * @param paddr Physical address from translation.
141 * @return True if translation exists
143 bool translate(Addr vaddr, Addr &paddr);
146 * Simplified translate function (just check for translation)
147 * @param vaddr The virtual address.
148 * @return True if translation exists
150 bool translate(Addr vaddr) { Addr dummy; return translate(vaddr, dummy); }
153 * Perform a translation on the memory request, fills in paddr
155 * @param req The memory request.
157 Fault translate(const RequestPtr &req);
159 void getMappings(std::vector<std::pair<Addr, Addr>> *addr_mappings);
161 void serialize(CheckpointOut &cp) const override;
162 void unserialize(CheckpointIn &cp) override;
165 #endif // __MEM_PAGE_TABLE_HH__