mem-cache: Add multiple eviction stats
[gem5.git] / src / arch / arm / ArmPMU.py
index dc393be69b62d9860c720de9c8e71f0b776d835f..be9dbb86ea44d03746cc4f6ff7125d091a087f28 100644 (file)
@@ -1,5 +1,5 @@
 # -*- mode:python -*-
-# Copyright (c) 2009-2014 ARM Limited
+# Copyright (c) 2009-2014, 2017 ARM Limited
 # All rights reserved.
 #
 # The license below extends only to copyright in the software and shall
 #          Andreas Sandberg
 
 from m5.defines import buildEnv
-from m5.SimObject import SimObject
+from m5.SimObject import *
 from m5.params import *
 from m5.params import isNullPointer
 from m5.proxy import *
+from m5.objects.Gic import ArmInterruptPin
+
+class ProbeEvent(object):
+    def __init__(self, pmu, _eventId, obj, *listOfNames):
+        self.obj = obj
+        self.names = listOfNames
+        self.eventId = _eventId
+        self.pmu = pmu
+
+    def register(self):
+        if self.obj:
+            for name in self.names:
+                self.pmu.getCCObject().addEventProbe(self.eventId,
+                    self.obj.getCCObject(), name)
+
+class SoftwareIncrement(object):
+    def __init__(self,pmu, _eventId):
+        self.eventId = _eventId
+        self.pmu = pmu
+
+    def register(self):
+        self.pmu.getCCObject().addSoftwareIncrementEvent(self.eventId)
+
+ARCH_EVENT_CORE_CYCLES = 0x11
 
 class ArmPMU(SimObject):
     type = 'ArmPMU'
     cxx_class = 'ArmISA::PMU'
     cxx_header = 'arch/arm/pmu.hh'
 
-    @classmethod
-    def export_methods(cls, code):
-        code('''
-      void addEventProbe(unsigned int id,
-                        SimObject *obj, const char *name);
-''')
-
-    # To prevent cycles in the configuration hierarchy, we don't keep
-    # a list of supported events as a configuration param. Instead, we
-    # keep them in a local list and register them using the
-    # addEventProbe interface when other SimObjects register their
-    # probe listeners.
-    _deferred_event_types = []
+    cxx_exports = [
+        PyBindMethod("addEventProbe"),
+        PyBindMethod("addSoftwareIncrementEvent"),
+    ]
+
+    _events = None
+
+    def addEvent(self, newObject):
+        if not (isinstance(newObject, ProbeEvent)
+            or isinstance(newObject, SoftwareIncrement)):
+            raise TypeError("argument must be of ProbeEvent or "
+                "SoftwareIncrement type")
+
+        if not self._events:
+            self._events = []
+
+        self._events.append(newObject)
+
     # Override the normal SimObject::regProbeListeners method and
     # register deferred event handlers.
     def regProbeListeners(self):
-        for event_id, obj, name in self._deferred_event_types:
-            self.getCCObject().addEventProbe(event_id, obj.getCCObject(), name)
+        for event in self._events:
+           event.register()
 
         self.getCCObject().regProbeListeners()
 
-    def addEventProbe(self, event_id, obj, *args):
-        """Add a probe-based event to the PMU if obj is not None."""
+    def addArchEvents(self,
+                      cpu=None,
+                      itb=None, dtb=None,
+                      icache=None, dcache=None,
+                      l2cache=None):
+        """Add architected events to the PMU.
+
+        This method can be called multiple times with only a subset of
+        the keyword arguments set. This enables event registration in
+        configuration scripts to happen closer to the instantiation of
+        the instrumented objects (e.g., the memory system) instead of
+        a central point.
+
+        CPU events should also be registered once per CPU that is
+        sharing the PMU (e.g., when switching between CPU models).
+        """
 
-        if obj is None:
-            return
+        bpred = getattr(cpu, "branchPred", None) if cpu else None
+        if bpred is not None and isNullPointer(bpred):
+            bpred = None
 
-        for name in args:
-            self._deferred_event_types.append((event_id, obj, name))
+        self.addEvent(SoftwareIncrement(self,0x00))
+        # 0x01: L1I_CACHE_REFILL
+        self.addEvent(ProbeEvent(self,0x02, itb, "Refills"))
+        # 0x03: L1D_CACHE_REFILL
+        # 0x04: L1D_CACHE
+        self.addEvent(ProbeEvent(self,0x05, dtb, "Refills"))
+        self.addEvent(ProbeEvent(self,0x06, cpu, "RetiredLoads"))
+        self.addEvent(ProbeEvent(self,0x07, cpu, "RetiredStores"))
+        self.addEvent(ProbeEvent(self,0x08, cpu, "RetiredInsts"))
+        # 0x09: EXC_TAKEN
+        # 0x0A: EXC_RETURN
+        # 0x0B: CID_WRITE_RETIRED
+        self.addEvent(ProbeEvent(self,0x0C, cpu, "RetiredBranches"))
+        # 0x0D: BR_IMMED_RETIRED
+        # 0x0E: BR_RETURN_RETIRED
+        # 0x0F: UNALIGEND_LDST_RETIRED
+        self.addEvent(ProbeEvent(self,0x10, bpred, "Misses"))
+        self.addEvent(ProbeEvent(self, ARCH_EVENT_CORE_CYCLES, cpu,
+                                 "ActiveCycles"))
+        self.addEvent(ProbeEvent(self,0x12, bpred, "Branches"))
+        self.addEvent(ProbeEvent(self,0x13, cpu, "RetiredLoads",
+                                 "RetiredStores"))
+        # 0x14: L1I_CACHE
+        # 0x15: L1D_CACHE_WB
+        # 0x16: L2D_CACHE
+        # 0x17: L2D_CACHE_REFILL
+        # 0x18: L2D_CACHE_WB
+        # 0x19: BUS_ACCESS
+        # 0x1A: MEMORY_ERROR
+        # 0x1B: INST_SPEC
+        # 0x1C: TTBR_WRITE_RETIRED
+        # 0x1D: BUS_CYCLES
+        # 0x1E: CHAIN
+        # 0x1F: L1D_CACHE_ALLOCATE
+        # 0x20: L2D_CACHE_ALLOCATE
+        # 0x21: BR_RETIRED
+        # 0x22: BR_MIS_PRED_RETIRED
+        # 0x23: STALL_FRONTEND
+        # 0x24: STALL_BACKEND
+        # 0x25: L1D_TLB
+        # 0x26: L1I_TLB
+        # 0x27: L2I_CACHE
+        # 0x28: L2I_CACHE_REFILL
+        # 0x29: L3D_CACHE_ALLOCATE
+        # 0x2A: L3D_CACHE_REFILL
+        # 0x2B: L3D_CACHE
+        # 0x2C: L3D_CACHE_WB
+        # 0x2D: L2D_TLB_REFILL
+        # 0x2E: L2I_TLB_REFILL
+        # 0x2F: L2D_TLB
+        # 0x30: L2I_TLB
 
+    cycleEventId = Param.Int(ARCH_EVENT_CORE_CYCLES, "Cycle event id")
     platform = Param.Platform(Parent.any, "Platform this device is part of.")
     eventCounters = Param.Int(31, "Number of supported PMU counters")
-    pmuInterrupt = Param.Int(68, "PMU GIC interrupt number")
+    interrupt = Param.ArmInterruptPin("PMU interrupt")