pagetable_walker.hh revision 8975 
16157Snate@binkert.org/*
26157Snate@binkert.org * Copyright (c) 2007 The Hewlett-Packard Development Company
36157Snate@binkert.org * All rights reserved.
46157Snate@binkert.org *
56157Snate@binkert.org * The license below extends only to copyright in the software and shall
66157Snate@binkert.org * not be construed as granting a license to any other intellectual
76157Snate@binkert.org * property including but not limited to intellectual property relating
86157Snate@binkert.org * to a hardware implementation of the functionality of the software
96157Snate@binkert.org * licensed hereunder.  You may use the software subject to the license
106157Snate@binkert.org * terms below provided that you ensure that this notice is replicated
116157Snate@binkert.org * unmodified and in its entirety in all distributions of the software,
126157Snate@binkert.org * modified or unmodified, in source code or in binary form.
136157Snate@binkert.org *
146157Snate@binkert.org * Redistribution and use in source and binary forms, with or without
156157Snate@binkert.org * modification, are permitted provided that the following conditions are
166157Snate@binkert.org * met: redistributions of source code must retain the above copyright
176157Snate@binkert.org * notice, this list of conditions and the following disclaimer;
186157Snate@binkert.org * redistributions in binary form must reproduce the above copyright
196157Snate@binkert.org * notice, this list of conditions and the following disclaimer in the
206157Snate@binkert.org * documentation and/or other materials provided with the distribution;
216157Snate@binkert.org * neither the name of the copyright holders nor the names of its
226157Snate@binkert.org * contributors may be used to endorse or promote products derived from
236157Snate@binkert.org * this software without specific prior written permission.
246157Snate@binkert.org *
256157Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
266157Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
276157Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
286157Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
296157Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
306157Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
316157Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
326157Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
336168Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
346168Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
356168Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
366157Snate@binkert.org *
376157Snate@binkert.org * Authors: Gabe Black
386157Snate@binkert.org */
396157Snate@binkert.org
406157Snate@binkert.org#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 recvTimingResp(PacketPtr pkt);
74
75            /**
76             * Snooping a coherence request, do nothing.
77             */
78            void recvTimingSnoopReq(PacketPtr pkt) { }
79            Tick recvAtomicSnoop(PacketPtr pkt) { return 0; }
80            void recvFunctionalSnoop(PacketPtr pkt) { }
81            void recvRetry();
82            bool isSnooping() const { return true; }
83        };
84
85        friend class WalkerPort;
86        WalkerPort port;
87
88        // State to track each walk of the page table
89        class WalkerState : public FastAlloc
90        {
91          private:
92            enum State {
93                Ready,
94                Waiting,
95                // Long mode
96                LongPML4, LongPDP, LongPD, LongPTE,
97                // PAE legacy mode
98                PAEPDP, PAEPD, PAEPTE,
99                // Non PAE legacy mode with and without PSE
100                PSEPD, PD, PTE
101            };
102
103          protected:
104            Walker *walker;
105            ThreadContext *tc;
106            RequestPtr req;
107            State state;
108            State nextState;
109            int dataSize;
110            bool enableNX;
111            unsigned inflight;
112            TlbEntry entry;
113            PacketPtr read;
114            std::vector<PacketPtr> writes;
115            Fault timingFault;
116            TLB::Translation * translation;
117            BaseTLB::Mode mode;
118            bool functional;
119            bool timing;
120            bool retrying;
121            bool started;
122          public:
123            WalkerState(Walker * _walker, BaseTLB::Translation *_translation,
124                    RequestPtr _req, bool _isFunctional = false) :
125                        walker(_walker), req(_req), state(Ready),
126                        nextState(Ready), inflight(0),
127                        translation(_translation),
128                        functional(_isFunctional), timing(false),
129                        retrying(false), started(false)
130            {
131            }
132            void initState(ThreadContext * _tc, BaseTLB::Mode _mode,
133                           bool _isTiming = false);
134            Fault startWalk();
135            Fault startFunctional(Addr &addr, unsigned &logBytes);
136            bool recvPacket(PacketPtr pkt);
137            bool isRetrying();
138            bool wasStarted();
139            bool isTiming();
140            void retry();
141            std::string name() const {return walker->name();}
142
143          private:
144            void setupWalk(Addr vaddr);
145            Fault stepWalk(PacketPtr &write);
146            void sendPackets();
147            void endWalk();
148            Fault pageFault(bool present);
149        };
150
151        friend class WalkerState;
152        // State for timing and atomic accesses (need multiple per walker in
153        // the case of multiple outstanding requests in timing mode)
154        std::list<WalkerState *> currStates;
155        // State for functional accesses (only need one of these per walker)
156        WalkerState funcState;
157
158        struct WalkerSenderState : public Packet::SenderState
159        {
160            WalkerState * senderWalk;
161            Packet::SenderState * saved;
162            WalkerSenderState(WalkerState * _senderWalk,
163                    Packet::SenderState * _saved) :
164                senderWalk(_senderWalk), saved(_saved) {}
165        };
166
167      public:
168        // Kick off the state machine.
169        Fault start(ThreadContext * _tc, BaseTLB::Translation *translation,
170                RequestPtr req, BaseTLB::Mode mode);
171        Fault startFunctional(ThreadContext * _tc, Addr &addr,
172                unsigned &logBytes, BaseTLB::Mode mode);
173        MasterPort &getMasterPort(const std::string &if_name, int idx = -1);
174
175      protected:
176        // The TLB we're supposed to load.
177        TLB * tlb;
178        System * sys;
179        MasterID masterId;
180
181        // Functions for dealing with packets.
182        bool recvTimingResp(PacketPtr pkt);
183        void recvRetry();
184        bool sendTiming(WalkerState * sendingState, PacketPtr pkt);
185
186      public:
187
188        void setTLB(TLB * _tlb)
189        {
190            tlb = _tlb;
191        }
192
193        typedef X86PagetableWalkerParams Params;
194
195        const Params *
196        params() const
197        {
198            return static_cast<const Params *>(_params);
199        }
200
201        Walker(const Params *params) :
202            MemObject(params), port(name() + ".port", this),
203            funcState(this, NULL, NULL, true), tlb(NULL), sys(params->system),
204            masterId(sys->getMasterId(name()))
205        {
206        }
207    };
208}
209#endif // __ARCH_X86_PAGE_TABLE_WALKER_HH__
210