pagetable_walker.hh revision 8864:fe907afe14a3 
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_PAGE_TABLE_WALKER_HH__
41#define __ARCH_X86_PAGE_TABLE_WALKER_HH__
42
43#include <vector>
44
45#include "arch/x86/pagetable.hh"
46#include "arch/x86/tlb.hh"
47#include "base/fast_alloc.hh"
48#include "base/types.hh"
49#include "mem/mem_object.hh"
50#include "mem/packet.hh"
51#include "params/X86PagetableWalker.hh"
52#include "sim/faults.hh"
53#include "sim/system.hh"
54
55class ThreadContext;
56
57namespace X86ISA
58{
59    class Walker : public MemObject
60    {
61      protected:
62        // Port for accessing memory
63        class WalkerPort : public Port
64        {
65          public:
66            WalkerPort(const std::string &_name, Walker * _walker) :
67                  Port(_name, _walker), walker(_walker)
68            {}
69
70          protected:
71            Walker *walker;
72
73            bool recvTiming(PacketPtr pkt);
74            Tick recvAtomic(PacketPtr pkt);
75            void recvFunctional(PacketPtr pkt);
76            void recvRangeChange();
77            void recvRetry();
78            bool isSnooping() { return true; }
79        };
80
81        friend class WalkerPort;
82        WalkerPort port;
83
84        // State to track each walk of the page table
85        class WalkerState : public FastAlloc
86        {
87          private:
88            enum State {
89                Ready,
90                Waiting,
91                // Long mode
92                LongPML4, LongPDP, LongPD, LongPTE,
93                // PAE legacy mode
94                PAEPDP, PAEPD, PAEPTE,
95                // Non PAE legacy mode with and without PSE
96                PSEPD, PD, PTE
97            };
98
99          protected:
100            Walker *walker;
101            ThreadContext *tc;
102            RequestPtr req;
103            State state;
104            State nextState;
105            int dataSize;
106            bool enableNX;
107            unsigned inflight;
108            TlbEntry entry;
109            PacketPtr read;
110            std::vector<PacketPtr> writes;
111            Fault timingFault;
112            TLB::Translation * translation;
113            BaseTLB::Mode mode;
114            bool functional;
115            bool timing;
116            bool retrying;
117            bool started;
118          public:
119            WalkerState(Walker * _walker, BaseTLB::Translation *_translation,
120                    RequestPtr _req, bool _isFunctional = false) :
121                        walker(_walker), req(_req), state(Ready),
122                        nextState(Ready), inflight(0),
123                        translation(_translation),
124                        functional(_isFunctional), timing(false),
125                        retrying(false), started(false)
126            {
127            }
128            void initState(ThreadContext * _tc, BaseTLB::Mode _mode,
129                           bool _isTiming = false);
130            Fault startWalk();
131            Fault startFunctional(Addr &addr, Addr &pageSize);
132            bool recvPacket(PacketPtr pkt);
133            bool isRetrying();
134            bool wasStarted();
135            bool isTiming();
136            void retry();
137            std::string name() const {return walker->name();}
138
139          private:
140            void setupWalk(Addr vaddr);
141            Fault stepWalk(PacketPtr &write);
142            void sendPackets();
143            void endWalk();
144            Fault pageFault(bool present);
145        };
146
147        friend class WalkerState;
148        // State for timing and atomic accesses (need multiple per walker in
149        // the case of multiple outstanding requests in timing mode)
150        std::list<WalkerState *> currStates;
151        // State for functional accesses (only need one of these per walker)
152        WalkerState funcState;
153
154        struct WalkerSenderState : public Packet::SenderState
155        {
156            WalkerState * senderWalk;
157            Packet::SenderState * saved;
158            WalkerSenderState(WalkerState * _senderWalk,
159                    Packet::SenderState * _saved) :
160                senderWalk(_senderWalk), saved(_saved) {}
161        };
162
163      public:
164        // Kick off the state machine.
165        Fault start(ThreadContext * _tc, BaseTLB::Translation *translation,
166                RequestPtr req, BaseTLB::Mode mode);
167        Fault startFunctional(ThreadContext * _tc, Addr &addr,
168                Addr &pageSize, BaseTLB::Mode mode);
169        Port *getPort(const std::string &if_name, int idx = -1);
170
171      protected:
172        // The TLB we're supposed to load.
173        TLB * tlb;
174        System * sys;
175        MasterID masterId;
176
177        // Functions for dealing with packets.
178        bool recvTiming(PacketPtr pkt);
179        void recvRetry();
180        bool sendTiming(WalkerState * sendingState, PacketPtr pkt);
181
182      public:
183
184        void setTLB(TLB * _tlb)
185        {
186            tlb = _tlb;
187        }
188
189        typedef X86PagetableWalkerParams Params;
190
191        const Params *
192        params() const
193        {
194            return static_cast<const Params *>(_params);
195        }
196
197        Walker(const Params *params) :
198            MemObject(params), port(name() + ".port", this),
199            funcState(this, NULL, NULL, true), tlb(NULL), sys(params->system),
200            masterId(sys->getMasterId(name()))
201        {
202        }
203    };
204}
205#endif // __ARCH_X86_PAGE_TABLE_WALKER_HH__
206