page_table.hh revision 12448:b299e560f1d8 
1/*
2 * Copyright (c) 2014 Advanced Micro Devices, Inc.
3 * Copyright (c) 2003 The Regents of The University of Michigan
4 * All rights reserved.
5 *
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.
16 *
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.
28 *
29 * Authors: Steve Reinhardt
30 */
31
32/**
33 * @file
34 * Declarations of a non-full system Page Table.
35 */
36
37#ifndef __MEM_PAGE_TABLE_HH__
38#define __MEM_PAGE_TABLE_HH__
39
40#include <string>
41#include <unordered_map>
42
43#include "arch/isa_traits.hh"
44#include "arch/tlb.hh"
45#include "base/intmath.hh"
46#include "base/types.hh"
47#include "config/the_isa.hh"
48#include "mem/request.hh"
49#include "sim/serialize.hh"
50
51class ThreadContext;
52
53class EmulationPageTable : public Serializable
54{
55  protected:
56    typedef std::unordered_map<Addr, TheISA::TlbEntry *> PTable;
57    typedef PTable::iterator PTableItr;
58    PTable pTable;
59
60    const Addr pageSize;
61    const Addr offsetMask;
62
63    const uint64_t pid;
64    const std::string _name;
65
66  public:
67
68    EmulationPageTable(
69            const std::string &__name, uint64_t _pid, Addr _pageSize) :
70            pageSize(_pageSize), offsetMask(mask(floorLog2(_pageSize))),
71            pid(_pid), _name(__name)
72    {
73        assert(isPowerOf2(pageSize));
74    }
75
76    virtual ~EmulationPageTable();
77
78    /* generic page table mapping flags
79     *              unset | set
80     * bit 0 - no-clobber | clobber
81     * bit 1 - present    | not-present
82     * bit 2 - cacheable  | uncacheable
83     * bit 3 - read-write | read-only
84     */
85    enum MappingFlags : uint32_t {
86        Zero        = 0,
87        Clobber     = 1,
88        NotPresent  = 2,
89        Uncacheable = 4,
90        ReadOnly    = 8,
91    };
92
93    virtual void initState(ThreadContext* tc) {};
94
95    // for DPRINTF compatibility
96    const std::string name() const { return _name; }
97
98    Addr pageAlign(Addr a)  { return (a & ~offsetMask); }
99    Addr pageOffset(Addr a) { return (a &  offsetMask); }
100
101    /**
102     * Maps a virtual memory region to a physical memory region.
103     * @param vaddr The starting virtual address of the region.
104     * @param paddr The starting physical address where the region is mapped.
105     * @param size The length of the region.
106     * @param flags Generic mapping flags that can be set by or-ing values
107     *              from MappingFlags enum.
108     */
109    virtual void map(Addr vaddr, Addr paddr, int64_t size, uint64_t flags = 0);
110    virtual void remap(Addr vaddr, int64_t size, Addr new_vaddr);
111    virtual void unmap(Addr vaddr, int64_t size);
112
113    /**
114     * Check if any pages in a region are already allocated
115     * @param vaddr The starting virtual address of the region.
116     * @param size The length of the region.
117     * @return True if no pages in the region are mapped.
118     */
119    virtual bool isUnmapped(Addr vaddr, int64_t size);
120
121    /**
122     * Lookup function
123     * @param vaddr The virtual address.
124     * @return entry The page table entry corresponding to vaddr.
125     */
126    virtual bool lookup(Addr vaddr, TheISA::TlbEntry &entry);
127
128    /**
129     * Translate function
130     * @param vaddr The virtual address.
131     * @param paddr Physical address from translation.
132     * @return True if translation exists
133     */
134    bool translate(Addr vaddr, Addr &paddr);
135
136    /**
137     * Simplified translate function (just check for translation)
138     * @param vaddr The virtual address.
139     * @return True if translation exists
140     */
141    bool translate(Addr vaddr) { Addr dummy; return translate(vaddr, dummy); }
142
143    /**
144     * Perform a translation on the memory request, fills in paddr
145     * field of req.
146     * @param req The memory request.
147     */
148    Fault translate(RequestPtr req);
149
150    void getMappings(std::vector<std::pair<Addr, Addr>> *addr_mappings);
151
152    void serialize(CheckpointOut &cp) const override;
153    void unserialize(CheckpointIn &cp) override;
154};
155
156#endif // __MEM_PAGE_TABLE_HH__
157