1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 *          Steve Reinhardt
30 */
31
32#ifndef __ARCH_ALPHA_PAGETABLE_H__
33#define __ARCH_ALPHA_PAGETABLE_H__
34
35#include "arch/alpha/isa_traits.hh"
36#include "arch/alpha/utility.hh"
37
38namespace AlphaISA {
39
40struct VAddr
41{
42    static const int ImplBits = 43;
43    static const Addr ImplMask = (ULL(1) << ImplBits) - 1;
44    static const Addr UnImplMask = ~ImplMask;
45
46    Addr addr;
47
48    VAddr(Addr a) : addr(a) {}
49    operator Addr() const { return addr; }
50    const VAddr &operator=(Addr a) { addr = a; return *this; }
51
52    Addr vpn() const { return (addr & ImplMask) >> PageShift; }
53    Addr page() const { return addr & PageMask; }
54    Addr offset() const { return addr & PageOffset; }
55
56    Addr level3() const
57    { return PteAddr(addr >> PageShift); }
58    Addr level2() const
59    { return PteAddr(addr >> (NPtePageShift + PageShift)); }
60    Addr level1() const
61    { return PteAddr(addr >> (2 * NPtePageShift + PageShift)); }
62};
63
64struct PageTableEntry
65{
66    PageTableEntry(uint64_t e) : entry(e) {}
67    uint64_t entry;
68    operator uint64_t() const { return entry; }
69    const PageTableEntry &operator=(uint64_t e) { entry = e; return *this; }
70    const PageTableEntry &operator=(const PageTableEntry &e)
71    { entry = e.entry; return *this; }
72
73    Addr _pfn()  const { return (entry >> 32) & 0xffffffff; }
74    Addr _sw()   const { return (entry >> 16) & 0xffff; }
75    int  _rsv0() const { return (entry >> 14) & 0x3; }
76    bool _uwe()  const { return (entry >> 13) & 0x1; }
77    bool _kwe()  const { return (entry >> 12) & 0x1; }
78    int  _rsv1() const { return (entry >> 10) & 0x3; }
79    bool _ure()  const { return (entry >>  9) & 0x1; }
80    bool _kre()  const { return (entry >>  8) & 0x1; }
81    bool _nomb() const { return (entry >>  7) & 0x1; }
82    int  _gh()   const { return (entry >>  5) & 0x3; }
83    bool _asm_()  const { return (entry >>  4) & 0x1; }
84    bool _foe()  const { return (entry >>  3) & 0x1; }
85    bool _fow()  const { return (entry >>  2) & 0x1; }
86    bool _for()  const { return (entry >>  1) & 0x1; }
87    bool valid() const { return (entry >>  0) & 0x1; }
88
89    Addr paddr() const { return _pfn() << PageShift; }
90};
91
92// ITB/DTB table entry
93struct TlbEntry : public Serializable
94{
95    Addr tag;               // virtual page number tag
96    Addr ppn;               // physical page number
97    uint8_t xre;            // read permissions - VMEM_PERM_* mask
98    uint8_t xwe;            // write permissions - VMEM_PERM_* mask
99    uint8_t asn;            // address space number
100    bool asma;              // address space match
101    bool fonr;              // fault on read
102    bool fonw;              // fault on write
103    bool valid;             // valid page table entry
104
105
106    //Construct an entry that maps to physical address addr.
107    TlbEntry(Addr _asn, Addr _vaddr, Addr _paddr,
108             bool uncacheable, bool read_only)
109    {
110        VAddr vaddr(_vaddr);
111        VAddr paddr(_paddr);
112        tag = vaddr.vpn();
113        ppn = paddr.vpn();
114        xre = 15;
115        xwe = 15;
116        asn = _asn;
117        asma = false;
118        fonr = false;
119        fonw = false;
120        valid = true;
121        if (uncacheable || read_only)
122            warn("Alpha TlbEntry does not support uncacheable"
123                 " or read-only mappings\n");
124    }
125
126    TlbEntry()
127        : tag(0), ppn(0), xre(0), xwe(0), asn(0),
128          asma(false), fonr(0), fonw(0), valid(0)
129    {
130    }
131
132    void
133    updateVaddr(Addr new_vaddr)
134    {
135        VAddr vaddr(new_vaddr);
136        tag = vaddr.vpn();
137    }
138
139    Addr
140    pageStart()
141    {
142        return ppn << PageShift;
143    }
144
145    void serialize(CheckpointOut &cp) const override;
146    void unserialize(CheckpointIn &cp) override;
147};
148
149} // namespace AlphaISA
150
151#endif // __ARCH_ALPHA_PAGETABLE_H__
152
153