arm: Clean up and document decoder API
[gem5.git] / src / arch / x86 / tlb.cc
index 100f8cf0f76ff85c833d8c72bd8be1116edf1276..dd0aed77092b37bf521256e4f5608a6ae7db9a43 100644 (file)
@@ -38,7 +38,9 @@
  */
 
 #include <cstring>
+#include <memory>
 
+#include "arch/generic/mmapped_ipr.hh"
 #include "arch/x86/insts/microldstop.hh"
 #include "arch/x86/regs/misc.hh"
 #include "arch/x86/regs/msr.hh"
 
 namespace X86ISA {
 
-TLB::TLB(const Params *p) : BaseTLB(p), configAddress(0), size(p->size)
+TLB::TLB(const Params *p) : BaseTLB(p), configAddress(0), size(p->size),
+    lruSeq(0)
 {
+    if (!size)
+        fatal("TLBs must have a non-zero size.\n");
     tlb = new TlbEntry[size];
     std::memset(tlb, 0, sizeof(TlbEntry) * size);
 
-    for (int x = 0; x < size; x++)
+    for (int x = 0; x < size; x++) {
+        tlb[x].trieHandle = NULL;
         freeList.push_back(&tlb[x]);
+    }
 
     walker = p->walker;
     walker->setTLB(this);
 }
 
-TlbEntry *
-TLB::insert(Addr vpn, TlbEntry &entry)
+void
+TLB::evictLRU()
 {
-    //TODO Deal with conflicting entries
+    // Find the entry with the lowest (and hence least recently updated)
+    // sequence number.
 
-    TlbEntry *newEntry = NULL;
-    if (!freeList.empty()) {
-        newEntry = freeList.front();
-        freeList.pop_front();
-    } else {
-        newEntry = entryList.back();
-        entryList.pop_back();
+    unsigned lru = 0;
+    for (unsigned i = 1; i < size; i++) {
+        if (tlb[i].lruSeq < tlb[lru].lruSeq)
+            lru = i;
     }
-    *newEntry = entry;
-    newEntry->vaddr = vpn;
-    entryList.push_front(newEntry);
-    return newEntry;
+
+    assert(tlb[lru].trieHandle);
+    trie.remove(tlb[lru].trieHandle);
+    tlb[lru].trieHandle = NULL;
+    freeList.push_back(&tlb[lru]);
 }
 
-TLB::EntryList::iterator
-TLB::lookupIt(Addr va, bool update_lru)
+TlbEntry *
+TLB::insert(Addr vpn, TlbEntry &entry)
 {
-    //TODO make this smarter at some point
-    EntryList::iterator entry;
-    for (entry = entryList.begin(); entry != entryList.end(); entry++) {
-        if ((*entry)->vaddr <= va && (*entry)->vaddr + (*entry)->size > va) {
-            DPRINTF(TLB, "Matched vaddr %#x to entry starting at %#x "
-                    "with size %#x.\n", va, (*entry)->vaddr, (*entry)->size);
-            if (update_lru) {
-                entryList.push_front(*entry);
-                entryList.erase(entry);
-                entry = entryList.begin();
-            }
-            break;
-        }
+    // If somebody beat us to it, just use that existing entry.
+    TlbEntry *newEntry = trie.lookup(vpn);
+    if (newEntry) {
+        assert(newEntry->vaddr == vpn);
+        return newEntry;
     }
-    return entry;
+
+    if (freeList.empty())
+        evictLRU();
+
+    newEntry = freeList.front();
+    freeList.pop_front();
+
+    *newEntry = entry;
+    newEntry->lruSeq = nextSeq();
+    newEntry->vaddr = vpn;
+    newEntry->trieHandle =
+    trie.insert(vpn, TlbEntryTrie::MaxBits - entry.logBytes, newEntry);
+    return newEntry;
 }
 
 TlbEntry *
 TLB::lookup(Addr va, bool update_lru)
 {
-    EntryList::iterator entry = lookupIt(va, update_lru);
-    if (entry == entryList.end())
-        return NULL;
-    else
-        return *entry;
+    TlbEntry *entry = trie.lookup(va);
+    if (entry && update_lru)
+        entry->lruSeq = nextSeq();
+    return entry;
 }
 
 void
-TLB::invalidateAll()
+TLB::flushAll()
 {
     DPRINTF(TLB, "Invalidating all entries.\n");
-    while (!entryList.empty()) {
-        TlbEntry *entry = entryList.front();
-        entryList.pop_front();
-        freeList.push_back(entry);
+    for (unsigned i = 0; i < size; i++) {
+        if (tlb[i].trieHandle) {
+            trie.remove(tlb[i].trieHandle);
+            tlb[i].trieHandle = NULL;
+            freeList.push_back(&tlb[i]);
+        }
     }
 }
 
@@ -139,16 +150,14 @@ TLB::setConfigAddress(uint32_t addr)
 }
 
 void
-TLB::invalidateNonGlobal()
+TLB::flushNonGlobal()
 {
     DPRINTF(TLB, "Invalidating all non global entries.\n");
-    EntryList::iterator entryIt;
-    for (entryIt = entryList.begin(); entryIt != entryList.end();) {
-        if (!(*entryIt)->global) {
-            freeList.push_back(*entryIt);
-            entryList.erase(entryIt++);
-        } else {
-            entryIt++;
+    for (unsigned i = 0; i < size; i++) {
+        if (tlb[i].trieHandle && !tlb[i].global) {
+            trie.remove(tlb[i].trieHandle);
+            tlb[i].trieHandle = NULL;
+            freeList.push_back(&tlb[i]);
         }
     }
 }
@@ -156,10 +165,11 @@ TLB::invalidateNonGlobal()
 void
 TLB::demapPage(Addr va, uint64_t asn)
 {
-    EntryList::iterator entry = lookupIt(va, false);
-    if (entry != entryList.end()) {
-        freeList.push_back(*entry);
-        entryList.erase(entry);
+    TlbEntry *entry = trie.lookup(va);
+    if (entry) {
+        trie.remove(entry->trieHandle);
+        entry->trieHandle = NULL;
+        freeList.push_back(entry);
     }
 }
 
@@ -177,7 +187,7 @@ TLB::translateInt(RequestPtr req, ThreadContext *tc)
 
         MiscRegIndex regNum;
         if (!msrAddrToIndex(regNum, vaddr))
-            return new GeneralProtection(0);
+            return std::make_shared<GeneralProtection>(0);
 
         //The index is multiplied by the size of a MiscReg so that
         //any memory dependence calculations will not see these as
@@ -217,6 +227,49 @@ TLB::translateInt(RequestPtr req, ThreadContext *tc)
     }
 }
 
+Fault
+TLB::finalizePhysical(RequestPtr req, ThreadContext *tc, Mode mode) const
+{
+    Addr paddr = req->getPaddr();
+
+    AddrRange m5opRange(0xFFFF0000, 0xFFFFFFFF);
+
+    if (m5opRange.contains(paddr)) {
+        if (m5opRange.contains(paddr)) {
+            req->setFlags(Request::MMAPPED_IPR | Request::GENERIC_IPR);
+            req->setPaddr(GenericISA::iprAddressPseudoInst(
+                            (paddr >> 8) & 0xFF,
+                            paddr & 0xFF));
+        }
+    } else if (FullSystem) {
+        // Check for an access to the local APIC
+        LocalApicBase localApicBase =
+            tc->readMiscRegNoEffect(MISCREG_APIC_BASE);
+        AddrRange apicRange(localApicBase.base * PageBytes,
+                            (localApicBase.base + 1) * PageBytes - 1);
+
+        if (apicRange.contains(paddr)) {
+            // The Intel developer's manuals say the below restrictions apply,
+            // but the linux kernel, because of a compiler optimization, breaks
+            // them.
+            /*
+            // Check alignment
+            if (paddr & ((32/8) - 1))
+                return new GeneralProtection(0);
+            // Check access size
+            if (req->getSize() != (32/8))
+                return new GeneralProtection(0);
+            */
+            // Force the access to be uncacheable.
+            req->setFlags(Request::UNCACHEABLE);
+            req->setPaddr(x86LocalAPICAddress(tc->contextId(),
+                                              paddr - apicRange.start()));
+        }
+    }
+
+    return NoFault;
+}
+
 Fault
 TLB::translate(RequestPtr req, ThreadContext *tc, Translation *translation,
         Mode mode, bool &delayedResponse, bool timing)
@@ -248,40 +301,36 @@ TLB::translate(RequestPtr req, ThreadContext *tc, Translation *translation,
             if (!(seg == SEGMENT_REG_TSG || seg == SYS_SEGMENT_REG_IDTR ||
                         seg == SEGMENT_REG_HS || seg == SEGMENT_REG_LS)
                     && !tc->readMiscRegNoEffect(MISCREG_SEG_SEL(seg)))
-                return new GeneralProtection(0);
+                return std::make_shared<GeneralProtection>(0);
             bool expandDown = false;
             SegAttr attr = tc->readMiscRegNoEffect(MISCREG_SEG_ATTR(seg));
             if (seg >= SEGMENT_REG_ES && seg <= SEGMENT_REG_HS) {
                 if (!attr.writable && (mode == Write || storeCheck))
-                    return new GeneralProtection(0);
+                    return std::make_shared<GeneralProtection>(0);
                 if (!attr.readable && mode == Read)
-                    return new GeneralProtection(0);
+                    return std::make_shared<GeneralProtection>(0);
                 expandDown = attr.expandDown;
 
             }
             Addr base = tc->readMiscRegNoEffect(MISCREG_SEG_BASE(seg));
             Addr limit = tc->readMiscRegNoEffect(MISCREG_SEG_LIMIT(seg));
-            // This assumes we're not in 64 bit mode. If we were, the default
-            // address size is 64 bits, overridable to 32.
-            int size = 32;
             bool sizeOverride = (flags & (AddrSizeFlagBit << FlagShift));
-            SegAttr csAttr = tc->readMiscRegNoEffect(MISCREG_CS_ATTR);
-            if ((csAttr.defaultSize && sizeOverride) ||
-                    (!csAttr.defaultSize && !sizeOverride))
-                size = 16;
-            Addr offset = bits(vaddr - base, size-1, 0);
+            unsigned logSize = sizeOverride ? (unsigned)m5Reg.altAddr
+                                            : (unsigned)m5Reg.defAddr;
+            int size = (1 << logSize) * 8;
+            Addr offset = bits(vaddr - base, size - 1, 0);
             Addr endOffset = offset + req->getSize() - 1;
             if (expandDown) {
                 DPRINTF(TLB, "Checking an expand down segment.\n");
                 warn_once("Expand down segments are untested.\n");
                 if (offset <= limit || endOffset <= limit)
-                    return new GeneralProtection(0);
+                    return std::make_shared<GeneralProtection>(0);
             } else {
                 if (offset > limit || endOffset > limit)
-                    return new GeneralProtection(0);
+                    return std::make_shared<GeneralProtection>(0);
             }
         }
-        if (m5Reg.mode != LongMode ||
+        if (m5Reg.submode != SixtyFourBitMode ||
                 (flags & (AddrSizeFlagBit << FlagShift)))
             vaddr &= mask(32);
         // If paging is enabled, do the translation.
@@ -315,7 +364,8 @@ TLB::translate(RequestPtr req, ThreadContext *tc, Translation *translation,
                         }
                     }
                     if (!success) {
-                        return new PageFault(vaddr, true, mode, true, false);
+                        return std::make_shared<PageFault>(vaddr, true, mode,
+                                                           true, false);
                     } else {
                         Addr alignedVaddr = p->pTable->pageAlign(vaddr);
                         DPRINTF(TLB, "Mapping %#x to %#x\n", alignedVaddr,
@@ -337,15 +387,17 @@ TLB::translate(RequestPtr req, ThreadContext *tc, Translation *translation,
                 // The page must have been present to get into the TLB in
                 // the first place. We'll assume the reserved bits are
                 // fine even though we're not checking them.
-                return new PageFault(vaddr, true, mode, inUser, false);
+                return std::make_shared<PageFault>(vaddr, true, mode, inUser,
+                                                   false);
             }
             if (storeCheck && badWrite) {
                 // This would fault if this were a write, so return a page
                 // fault that reflects that happening.
-                return new PageFault(vaddr, true, Write, inUser, false);
+                return std::make_shared<PageFault>(vaddr, true, Write, inUser,
+                                                   false);
             }
 
-            Addr paddr = entry->paddr | (vaddr & (entry->size-1));
+            Addr paddr = entry->paddr | (vaddr & mask(entry->logBytes));
             DPRINTF(TLB, "Translated %#x -> %#x.\n", vaddr, paddr);
             req->setPaddr(paddr);
             if (entry->uncacheable)
@@ -362,31 +414,8 @@ TLB::translate(RequestPtr req, ThreadContext *tc, Translation *translation,
         DPRINTF(TLB, "Translated %#x -> %#x.\n", vaddr, vaddr);
         req->setPaddr(vaddr);
     }
-    // Check for an access to the local APIC
-    if (FullSystem) {
-        LocalApicBase localApicBase =
-            tc->readMiscRegNoEffect(MISCREG_APIC_BASE);
-        Addr baseAddr = localApicBase.base * PageBytes;
-        Addr paddr = req->getPaddr();
-        if (baseAddr <= paddr && baseAddr + PageBytes > paddr) {
-            // The Intel developer's manuals say the below restrictions apply,
-            // but the linux kernel, because of a compiler optimization, breaks
-            // them.
-            /*
-            // Check alignment
-            if (paddr & ((32/8) - 1))
-                return new GeneralProtection(0);
-            // Check access size
-            if (req->getSize() != (32/8))
-                return new GeneralProtection(0);
-            */
-            // Force the access to be uncacheable.
-            req->setFlags(Request::UNCACHEABLE);
-            req->setPaddr(x86LocalAPICAddress(tc->contextId(),
-                        paddr - baseAddr));
-        }
-    }
-    return NoFault;
+
+    return finalizePhysical(req, tc, mode);
 }
 
 Fault
@@ -424,14 +453,45 @@ TLB::getWalker()
 void
 TLB::serialize(std::ostream &os)
 {
+    // Only store the entries in use.
+    uint32_t _size = size - freeList.size();
+    SERIALIZE_SCALAR(_size);
+    SERIALIZE_SCALAR(lruSeq);
+
+    uint32_t _count = 0;
+
+    for (uint32_t x = 0; x < size; x++) {
+        if (tlb[x].trieHandle != NULL) {
+            os << "\n[" << csprintf("%s.Entry%d", name(), _count) << "]\n";
+            tlb[x].serialize(os);
+            _count++;
+        }
+    }
 }
 
 void
 TLB::unserialize(Checkpoint *cp, const std::string &section)
 {
+    // Do not allow to restore with a smaller tlb.
+    uint32_t _size;
+    UNSERIALIZE_SCALAR(_size);
+    if (_size > size) {
+        fatal("TLB size less than the one in checkpoint!");
+    }
+
+    UNSERIALIZE_SCALAR(lruSeq);
+
+    for (uint32_t x = 0; x < _size; x++) {
+        TlbEntry *newEntry = freeList.front();
+        freeList.pop_front();
+
+        newEntry->unserialize(cp, csprintf("%s.Entry%d", name(), x));
+        newEntry->trieHandle = trie.insert(newEntry->vaddr,
+            TlbEntryTrie::MaxBits - newEntry->logBytes, newEntry);
+    }
 }
 
-MasterPort *
+BaseMasterPort *
 TLB::getMasterPort()
 {
     return &walker->getMasterPort("port");