MEM: Introduce the master/slave port sub-classes in C++
[gem5.git] / src / arch / arm / tlb.cc
1 /*
2 * Copyright (c) 2010 ARM Limited
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 * Copyright (c) 2001-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ali Saidi
41 * Nathan Binkert
42 * Steve Reinhardt
43 */
44
45 #include <string>
46 #include <vector>
47
48 #include "arch/arm/faults.hh"
49 #include "arch/arm/pagetable.hh"
50 #include "arch/arm/system.hh"
51 #include "arch/arm/table_walker.hh"
52 #include "arch/arm/tlb.hh"
53 #include "arch/arm/utility.hh"
54 #include "base/inifile.hh"
55 #include "base/str.hh"
56 #include "base/trace.hh"
57 #include "cpu/thread_context.hh"
58 #include "debug/Checkpoint.hh"
59 #include "debug/TLB.hh"
60 #include "debug/TLBVerbose.hh"
61 #include "mem/page_table.hh"
62 #include "params/ArmTLB.hh"
63 #include "sim/full_system.hh"
64 #include "sim/process.hh"
65
66 using namespace std;
67 using namespace ArmISA;
68
69 TLB::TLB(const Params *p)
70 : BaseTLB(p), size(p->size) , tableWalker(p->walker),
71 rangeMRU(1), bootUncacheability(false), miscRegValid(false)
72 {
73 table = new TlbEntry[size];
74 memset(table, 0, sizeof(TlbEntry) * size);
75
76 tableWalker->setTlb(this);
77 }
78
79 TLB::~TLB()
80 {
81 if (table)
82 delete [] table;
83 }
84
85 bool
86 TLB::translateFunctional(ThreadContext *tc, Addr va, Addr &pa)
87 {
88 if (!miscRegValid)
89 updateMiscReg(tc);
90 TlbEntry *e = lookup(va, contextId, true);
91 if (!e)
92 return false;
93 pa = e->pAddr(va);
94 return true;
95 }
96
97 TlbEntry*
98 TLB::lookup(Addr va, uint8_t cid, bool functional)
99 {
100
101 TlbEntry *retval = NULL;
102
103 // Maitaining LRU array
104
105 int x = 0;
106 while (retval == NULL && x < size) {
107 if (table[x].match(va, cid)) {
108
109 // We only move the hit entry ahead when the position is higher than rangeMRU
110 if (x > rangeMRU) {
111 TlbEntry tmp_entry = table[x];
112 for(int i = x; i > 0; i--)
113 table[i] = table[i-1];
114 table[0] = tmp_entry;
115 retval = &table[0];
116 } else {
117 retval = &table[x];
118 }
119 break;
120 }
121 x++;
122 }
123
124 DPRINTF(TLBVerbose, "Lookup %#x, cid %#x -> %s ppn %#x size: %#x pa: %#x ap:%d\n",
125 va, cid, retval ? "hit" : "miss", retval ? retval->pfn : 0,
126 retval ? retval->size : 0, retval ? retval->pAddr(va) : 0,
127 retval ? retval->ap : 0);
128 ;
129 return retval;
130 }
131
132 // insert a new TLB entry
133 void
134 TLB::insert(Addr addr, TlbEntry &entry)
135 {
136 DPRINTF(TLB, "Inserting entry into TLB with pfn:%#x size:%#x vpn: %#x"
137 " asid:%d N:%d global:%d valid:%d nc:%d sNp:%d xn:%d ap:%#x"
138 " domain:%#x\n", entry.pfn, entry.size, entry.vpn, entry.asid,
139 entry.N, entry.global, entry.valid, entry.nonCacheable, entry.sNp,
140 entry.xn, entry.ap, entry.domain);
141
142 if (table[size-1].valid)
143 DPRINTF(TLB, " - Replacing Valid entry %#x, asn %d ppn %#x size: %#x ap:%d\n",
144 table[size-1].vpn << table[size-1].N, table[size-1].asid,
145 table[size-1].pfn << table[size-1].N, table[size-1].size,
146 table[size-1].ap);
147
148 //inserting to MRU position and evicting the LRU one
149
150 for(int i = size-1; i > 0; i--)
151 table[i] = table[i-1];
152 table[0] = entry;
153
154 inserts++;
155 }
156
157 void
158 TLB::printTlb()
159 {
160 int x = 0;
161 TlbEntry *te;
162 DPRINTF(TLB, "Current TLB contents:\n");
163 while (x < size) {
164 te = &table[x];
165 if (te->valid)
166 DPRINTF(TLB, " * %#x, asn %d ppn %#x size: %#x ap:%d\n",
167 te->vpn << te->N, te->asid, te->pfn << te->N, te->size, te->ap);
168 x++;
169 }
170 }
171
172
173 void
174 TLB::flushAll()
175 {
176 DPRINTF(TLB, "Flushing all TLB entries\n");
177 int x = 0;
178 TlbEntry *te;
179 while (x < size) {
180 te = &table[x];
181 if (te->valid) {
182 DPRINTF(TLB, " - %#x, asn %d ppn %#x size: %#x ap:%d\n",
183 te->vpn << te->N, te->asid, te->pfn << te->N, te->size, te->ap);
184 flushedEntries++;
185 }
186 x++;
187 }
188
189 memset(table, 0, sizeof(TlbEntry) * size);
190
191 flushTlb++;
192 }
193
194
195 void
196 TLB::flushMvaAsid(Addr mva, uint64_t asn)
197 {
198 DPRINTF(TLB, "Flushing mva %#x asid: %#x\n", mva, asn);
199 TlbEntry *te;
200
201 te = lookup(mva, asn);
202 while (te != NULL) {
203 DPRINTF(TLB, " - %#x, asn %d ppn %#x size: %#x ap:%d\n",
204 te->vpn << te->N, te->asid, te->pfn << te->N, te->size, te->ap);
205 te->valid = false;
206 flushedEntries++;
207 te = lookup(mva,asn);
208 }
209 flushTlbMvaAsid++;
210 }
211
212 void
213 TLB::flushAsid(uint64_t asn)
214 {
215 DPRINTF(TLB, "Flushing all entries with asid: %#x\n", asn);
216
217 int x = 0;
218 TlbEntry *te;
219
220 while (x < size) {
221 te = &table[x];
222 if (te->asid == asn) {
223 te->valid = false;
224 DPRINTF(TLB, " - %#x, asn %d ppn %#x size: %#x ap:%d\n",
225 te->vpn << te->N, te->asid, te->pfn << te->N, te->size, te->ap);
226 flushedEntries++;
227 }
228 x++;
229 }
230 flushTlbAsid++;
231 }
232
233 void
234 TLB::flushMva(Addr mva)
235 {
236 DPRINTF(TLB, "Flushing all entries with mva: %#x\n", mva);
237
238 int x = 0;
239 TlbEntry *te;
240
241 while (x < size) {
242 te = &table[x];
243 Addr v = te->vpn << te->N;
244 if (mva >= v && mva < v + te->size) {
245 te->valid = false;
246 DPRINTF(TLB, " - %#x, asn %d ppn %#x size: %#x ap:%d\n",
247 te->vpn << te->N, te->asid, te->pfn << te->N, te->size, te->ap);
248 flushedEntries++;
249 }
250 x++;
251 }
252 flushTlbMva++;
253 }
254
255 void
256 TLB::serialize(ostream &os)
257 {
258 DPRINTF(Checkpoint, "Serializing Arm TLB\n");
259
260 SERIALIZE_SCALAR(_attr);
261
262 int num_entries = size;
263 SERIALIZE_SCALAR(num_entries);
264 for(int i = 0; i < size; i++){
265 nameOut(os, csprintf("%s.TlbEntry%d", name(), i));
266 table[i].serialize(os);
267 }
268 }
269
270 void
271 TLB::unserialize(Checkpoint *cp, const string &section)
272 {
273 DPRINTF(Checkpoint, "Unserializing Arm TLB\n");
274
275 UNSERIALIZE_SCALAR(_attr);
276 int num_entries;
277 UNSERIALIZE_SCALAR(num_entries);
278 for(int i = 0; i < min(size, num_entries); i++){
279 table[i].unserialize(cp, csprintf("%s.TlbEntry%d", section, i));
280 }
281 miscRegValid = false;
282 }
283
284 void
285 TLB::regStats()
286 {
287 instHits
288 .name(name() + ".inst_hits")
289 .desc("ITB inst hits")
290 ;
291
292 instMisses
293 .name(name() + ".inst_misses")
294 .desc("ITB inst misses")
295 ;
296
297 instAccesses
298 .name(name() + ".inst_accesses")
299 .desc("ITB inst accesses")
300 ;
301
302 readHits
303 .name(name() + ".read_hits")
304 .desc("DTB read hits")
305 ;
306
307 readMisses
308 .name(name() + ".read_misses")
309 .desc("DTB read misses")
310 ;
311
312 readAccesses
313 .name(name() + ".read_accesses")
314 .desc("DTB read accesses")
315 ;
316
317 writeHits
318 .name(name() + ".write_hits")
319 .desc("DTB write hits")
320 ;
321
322 writeMisses
323 .name(name() + ".write_misses")
324 .desc("DTB write misses")
325 ;
326
327 writeAccesses
328 .name(name() + ".write_accesses")
329 .desc("DTB write accesses")
330 ;
331
332 hits
333 .name(name() + ".hits")
334 .desc("DTB hits")
335 ;
336
337 misses
338 .name(name() + ".misses")
339 .desc("DTB misses")
340 ;
341
342 accesses
343 .name(name() + ".accesses")
344 .desc("DTB accesses")
345 ;
346
347 flushTlb
348 .name(name() + ".flush_tlb")
349 .desc("Number of times complete TLB was flushed")
350 ;
351
352 flushTlbMva
353 .name(name() + ".flush_tlb_mva")
354 .desc("Number of times TLB was flushed by MVA")
355 ;
356
357 flushTlbMvaAsid
358 .name(name() + ".flush_tlb_mva_asid")
359 .desc("Number of times TLB was flushed by MVA & ASID")
360 ;
361
362 flushTlbAsid
363 .name(name() + ".flush_tlb_asid")
364 .desc("Number of times TLB was flushed by ASID")
365 ;
366
367 flushedEntries
368 .name(name() + ".flush_entries")
369 .desc("Number of entries that have been flushed from TLB")
370 ;
371
372 alignFaults
373 .name(name() + ".align_faults")
374 .desc("Number of TLB faults due to alignment restrictions")
375 ;
376
377 prefetchFaults
378 .name(name() + ".prefetch_faults")
379 .desc("Number of TLB faults due to prefetch")
380 ;
381
382 domainFaults
383 .name(name() + ".domain_faults")
384 .desc("Number of TLB faults due to domain restrictions")
385 ;
386
387 permsFaults
388 .name(name() + ".perms_faults")
389 .desc("Number of TLB faults due to permissions restrictions")
390 ;
391
392 instAccesses = instHits + instMisses;
393 readAccesses = readHits + readMisses;
394 writeAccesses = writeHits + writeMisses;
395 hits = readHits + writeHits + instHits;
396 misses = readMisses + writeMisses + instMisses;
397 accesses = readAccesses + writeAccesses + instAccesses;
398 }
399
400 Fault
401 TLB::translateSe(RequestPtr req, ThreadContext *tc, Mode mode,
402 Translation *translation, bool &delay, bool timing)
403 {
404 if (!miscRegValid)
405 updateMiscReg(tc);
406 Addr vaddr = req->getVaddr();
407 uint32_t flags = req->getFlags();
408
409 bool is_fetch = (mode == Execute);
410 bool is_write = (mode == Write);
411
412 if (!is_fetch) {
413 assert(flags & MustBeOne);
414 if (sctlr.a || !(flags & AllowUnaligned)) {
415 if (vaddr & flags & AlignmentMask) {
416 return new DataAbort(vaddr, 0, is_write, ArmFault::AlignmentFault);
417 }
418 }
419 }
420
421 Addr paddr;
422 Process *p = tc->getProcessPtr();
423
424 if (!p->pTable->translate(vaddr, paddr))
425 return Fault(new GenericPageTableFault(vaddr));
426 req->setPaddr(paddr);
427
428 return NoFault;
429 }
430
431 Fault
432 TLB::trickBoxCheck(RequestPtr req, Mode mode, uint8_t domain, bool sNp)
433 {
434 return NoFault;
435 }
436
437 Fault
438 TLB::walkTrickBoxCheck(Addr pa, Addr va, Addr sz, bool is_exec,
439 bool is_write, uint8_t domain, bool sNp)
440 {
441 return NoFault;
442 }
443
444 Fault
445 TLB::translateFs(RequestPtr req, ThreadContext *tc, Mode mode,
446 Translation *translation, bool &delay, bool timing, bool functional)
447 {
448 // No such thing as a functional timing access
449 assert(!(timing && functional));
450
451 if (!miscRegValid) {
452 updateMiscReg(tc);
453 DPRINTF(TLBVerbose, "TLB variables changed!\n");
454 }
455
456 Addr vaddr = req->getVaddr();
457 uint32_t flags = req->getFlags();
458
459 bool is_fetch = (mode == Execute);
460 bool is_write = (mode == Write);
461 bool is_priv = isPriv && !(flags & UserMode);
462
463 req->setAsid(contextId.asid);
464
465 DPRINTF(TLBVerbose, "CPSR is priv:%d UserMode:%d\n",
466 isPriv, flags & UserMode);
467 // If this is a clrex instruction, provide a PA of 0 with no fault
468 // This will force the monitor to set the tracked address to 0
469 // a bit of a hack but this effectively clrears this processors monitor
470 if (flags & Request::CLEAR_LL){
471 req->setPaddr(0);
472 req->setFlags(Request::UNCACHEABLE);
473 req->setFlags(Request::CLEAR_LL);
474 return NoFault;
475 }
476 if ((req->isInstFetch() && (!sctlr.i)) ||
477 ((!req->isInstFetch()) && (!sctlr.c))){
478 req->setFlags(Request::UNCACHEABLE);
479 }
480 if (!is_fetch) {
481 assert(flags & MustBeOne);
482 if (sctlr.a || !(flags & AllowUnaligned)) {
483 if (vaddr & flags & AlignmentMask) {
484 alignFaults++;
485 return new DataAbort(vaddr, 0, is_write, ArmFault::AlignmentFault);
486 }
487 }
488 }
489
490 Fault fault;
491
492 if (!sctlr.m) {
493 req->setPaddr(vaddr);
494 if (sctlr.tre == 0) {
495 req->setFlags(Request::UNCACHEABLE);
496 } else {
497 if (nmrr.ir0 == 0 || nmrr.or0 == 0 || prrr.tr0 != 0x2)
498 req->setFlags(Request::UNCACHEABLE);
499 }
500
501 // Set memory attributes
502 TlbEntry temp_te;
503 tableWalker->memAttrs(tc, temp_te, sctlr, 0, 1);
504 temp_te.shareable = true;
505 DPRINTF(TLBVerbose, "(No MMU) setting memory attributes: shareable:\
506 %d, innerAttrs: %d, outerAttrs: %d\n", temp_te.shareable,
507 temp_te.innerAttrs, temp_te.outerAttrs);
508 setAttr(temp_te.attributes);
509
510 return trickBoxCheck(req, mode, 0, false);
511 }
512
513 DPRINTF(TLBVerbose, "Translating vaddr=%#x context=%d\n", vaddr, contextId);
514 // Translation enabled
515
516 TlbEntry *te = lookup(vaddr, contextId);
517 if (te == NULL) {
518 if (req->isPrefetch()){
519 //if the request is a prefetch don't attempt to fill the TLB
520 //or go any further with the memory access
521 prefetchFaults++;
522 return new PrefetchAbort(vaddr, ArmFault::PrefetchTLBMiss);
523 }
524
525 if (is_fetch)
526 instMisses++;
527 else if (is_write)
528 writeMisses++;
529 else
530 readMisses++;
531
532 // start translation table walk, pass variables rather than
533 // re-retreaving in table walker for speed
534 DPRINTF(TLB, "TLB Miss: Starting hardware table walker for %#x(%d)\n",
535 vaddr, contextId);
536 fault = tableWalker->walk(req, tc, contextId, mode, translation,
537 timing, functional);
538 if (timing && fault == NoFault) {
539 delay = true;
540 // for timing mode, return and wait for table walk
541 return fault;
542 }
543 if (fault)
544 return fault;
545
546 te = lookup(vaddr, contextId);
547 if (!te)
548 printTlb();
549 assert(te);
550 } else {
551 if (is_fetch)
552 instHits++;
553 else if (is_write)
554 writeHits++;
555 else
556 readHits++;
557 }
558
559 // Set memory attributes
560 DPRINTF(TLBVerbose,
561 "Setting memory attributes: shareable: %d, innerAttrs: %d, \
562 outerAttrs: %d\n",
563 te->shareable, te->innerAttrs, te->outerAttrs);
564 setAttr(te->attributes);
565 if (te->nonCacheable) {
566 req->setFlags(Request::UNCACHEABLE);
567
568 // Prevent prefetching from I/O devices.
569 if (req->isPrefetch()) {
570 return new PrefetchAbort(vaddr, ArmFault::PrefetchUncacheable);
571 }
572 }
573
574 if (!bootUncacheability &&
575 ((ArmSystem*)tc->getSystemPtr())->adderBootUncacheable(vaddr))
576 req->setFlags(Request::UNCACHEABLE);
577
578 switch ( (dacr >> (te->domain * 2)) & 0x3) {
579 case 0:
580 domainFaults++;
581 DPRINTF(TLB, "TLB Fault: Data abort on domain. DACR: %#x domain: %#x"
582 " write:%d sNp:%d\n", dacr, te->domain, is_write, te->sNp);
583 if (is_fetch)
584 return new PrefetchAbort(vaddr,
585 (te->sNp ? ArmFault::Domain0 : ArmFault::Domain1));
586 else
587 return new DataAbort(vaddr, te->domain, is_write,
588 (te->sNp ? ArmFault::Domain0 : ArmFault::Domain1));
589 case 1:
590 // Continue with permissions check
591 break;
592 case 2:
593 panic("UNPRED domain\n");
594 case 3:
595 req->setPaddr(te->pAddr(vaddr));
596 fault = trickBoxCheck(req, mode, te->domain, te->sNp);
597 if (fault)
598 return fault;
599 return NoFault;
600 }
601
602 uint8_t ap = te->ap;
603
604 if (sctlr.afe == 1)
605 ap |= 1;
606
607 bool abt;
608
609 /* if (!sctlr.xp)
610 ap &= 0x3;
611 */
612 switch (ap) {
613 case 0:
614 DPRINTF(TLB, "Access permissions 0, checking rs:%#x\n", (int)sctlr.rs);
615 if (!sctlr.xp) {
616 switch ((int)sctlr.rs) {
617 case 2:
618 abt = is_write;
619 break;
620 case 1:
621 abt = is_write || !is_priv;
622 break;
623 case 0:
624 case 3:
625 default:
626 abt = true;
627 break;
628 }
629 } else {
630 abt = true;
631 }
632 break;
633 case 1:
634 abt = !is_priv;
635 break;
636 case 2:
637 abt = !is_priv && is_write;
638 break;
639 case 3:
640 abt = false;
641 break;
642 case 4:
643 panic("UNPRED premissions\n");
644 case 5:
645 abt = !is_priv || is_write;
646 break;
647 case 6:
648 case 7:
649 abt = is_write;
650 break;
651 default:
652 panic("Unknown permissions\n");
653 }
654 if ((is_fetch) && (abt || te->xn)) {
655 permsFaults++;
656 DPRINTF(TLB, "TLB Fault: Prefetch abort on permission check. AP:%d priv:%d"
657 " write:%d sNp:%d\n", ap, is_priv, is_write, te->sNp);
658 return new PrefetchAbort(vaddr,
659 (te->sNp ? ArmFault::Permission0 :
660 ArmFault::Permission1));
661 } else if (abt) {
662 permsFaults++;
663 DPRINTF(TLB, "TLB Fault: Data abort on permission check. AP:%d priv:%d"
664 " write:%d sNp:%d\n", ap, is_priv, is_write, te->sNp);
665 return new DataAbort(vaddr, te->domain, is_write,
666 (te->sNp ? ArmFault::Permission0 :
667 ArmFault::Permission1));
668 }
669
670 req->setPaddr(te->pAddr(vaddr));
671 // Check for a trickbox generated address fault
672 fault = trickBoxCheck(req, mode, te->domain, te->sNp);
673 if (fault)
674 return fault;
675
676 return NoFault;
677 }
678
679 Fault
680 TLB::translateAtomic(RequestPtr req, ThreadContext *tc, Mode mode)
681 {
682 bool delay = false;
683 Fault fault;
684 if (FullSystem)
685 fault = translateFs(req, tc, mode, NULL, delay, false);
686 else
687 fault = translateSe(req, tc, mode, NULL, delay, false);
688 assert(!delay);
689 return fault;
690 }
691
692 Fault
693 TLB::translateFunctional(RequestPtr req, ThreadContext *tc, Mode mode)
694 {
695 bool delay = false;
696 Fault fault;
697 if (FullSystem)
698 fault = translateFs(req, tc, mode, NULL, delay, false, true);
699 else
700 fault = translateSe(req, tc, mode, NULL, delay, false);
701 assert(!delay);
702 return fault;
703 }
704
705 Fault
706 TLB::translateTiming(RequestPtr req, ThreadContext *tc,
707 Translation *translation, Mode mode)
708 {
709 assert(translation);
710 bool delay = false;
711 Fault fault;
712 if (FullSystem)
713 fault = translateFs(req, tc, mode, translation, delay, true);
714 else
715 fault = translateSe(req, tc, mode, translation, delay, true);
716 DPRINTF(TLBVerbose, "Translation returning delay=%d fault=%d\n", delay, fault !=
717 NoFault);
718 if (!delay)
719 translation->finish(fault, req, tc, mode);
720 else
721 translation->markDelayed();
722 return fault;
723 }
724
725 MasterPort*
726 TLB::getMasterPort()
727 {
728 return &tableWalker->getMasterPort("port");
729 }
730
731
732
733 ArmISA::TLB *
734 ArmTLBParams::create()
735 {
736 return new ArmISA::TLB(this);
737 }