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