1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
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 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions are
16 * met: redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer;
18 * redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution;
21 * neither the name of the copyright holders nor the names of its
22 * contributors may be used to endorse or promote products derived from
23 * this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 *
37 * Authors: Gabe Black
38 */
39
40#ifndef __ARCH_X86_TLB_HH__
41#define __ARCH_X86_TLB_HH__
42
43#include <list>
44#include <vector>
45
46#include "arch/generic/tlb.hh"
47#include "arch/x86/pagetable.hh"
48#include "base/trie.hh"
49#include "mem/request.hh"
50#include "params/X86TLB.hh"
51
52class ThreadContext;
53
54namespace X86ISA
55{
56    class Walker;
57
58    class TLB : public BaseTLB
59    {
60      protected:
61        friend class Walker;
62
63        typedef std::list<TlbEntry *> EntryList;
64
65        uint32_t configAddress;
66
67      public:
68
69        typedef X86TLBParams Params;
70        TLB(const Params *p);
71
72        void takeOverFrom(BaseTLB *otlb) override {}
73
74        TlbEntry *lookup(Addr va, bool update_lru = true);
75
76        void setConfigAddress(uint32_t addr);
77
78      protected:
79
80        EntryList::iterator lookupIt(Addr va, bool update_lru = true);
81
82        Walker * walker;
83
84      public:
85        Walker *getWalker();
86
87        void flushAll() override;
88
89        void flushNonGlobal();
90
91        void demapPage(Addr va, uint64_t asn) override;
92
93      protected:
94        uint32_t size;
95
96        std::vector<TlbEntry> tlb;
97
98        EntryList freeList;
99
100        TlbEntryTrie trie;
101        uint64_t lruSeq;
102
103        // Statistics
104        Stats::Scalar rdAccesses;
105        Stats::Scalar wrAccesses;
106        Stats::Scalar rdMisses;
107        Stats::Scalar wrMisses;
108
109        Fault translateInt(const RequestPtr &req, ThreadContext *tc);
110
111        Fault translate(const RequestPtr &req, ThreadContext *tc,
112                Translation *translation, Mode mode,
113                bool &delayedResponse, bool timing);
114
115      public:
116
117        void evictLRU();
118
119        uint64_t
120        nextSeq()
121        {
122            return ++lruSeq;
123        }
124
125        Fault translateAtomic(
126            const RequestPtr &req, ThreadContext *tc, Mode mode) override;
127        void translateTiming(
128            const RequestPtr &req, ThreadContext *tc,
129            Translation *translation, Mode mode) override;
130
131        /**
132         * Do post-translation physical address finalization.
133         *
134         * Some addresses, for example requests going to the APIC,
135         * need post-translation updates. Such physical addresses are
136         * remapped into a "magic" part of the physical address space
137         * by this method.
138         *
139         * @param req Request to updated in-place.
140         * @param tc Thread context that created the request.
141         * @param mode Request type (read/write/execute).
142         * @return A fault on failure, NoFault otherwise.
143         */
144        Fault finalizePhysical(const RequestPtr &req, ThreadContext *tc,
145                               Mode mode) const override;
146
147        TlbEntry *insert(Addr vpn, const TlbEntry &entry);
148
149        /*
150         * Function to register Stats
151         */
152        void regStats() override;
153
154        // Checkpointing
155        void serialize(CheckpointOut &cp) const override;
156        void unserialize(CheckpointIn &cp) override;
157
158        /**
159         * Get the table walker port. This is used for
160         * migrating port connections during a CPU takeOverFrom()
161         * call. For architectures that do not have a table walker,
162         * NULL is returned, hence the use of a pointer rather than a
163         * reference. For X86 this method will always return a valid
164         * port pointer.
165         *
166         * @return A pointer to the walker port
167         */
168        Port *getTableWalkerPort() override;
169    };
170}
171
172#endif // __ARCH_X86_TLB_HH__
173