BaseCPU.py revision 10190:fb83d025d1c3 
1# Copyright (c) 2012-2013 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Copyright (c) 2005-2008 The Regents of The University of Michigan
14# Copyright (c) 2011 Regents of the University of California
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: Nathan Binkert
41#          Rick Strong
42#          Andreas Hansson
43
44import sys
45
46from m5.defines import buildEnv
47from m5.params import *
48from m5.proxy import *
49
50from Bus import CoherentBus
51from InstTracer import InstTracer
52from ExeTracer import ExeTracer
53from MemObject import MemObject
54from ClockDomain import *
55
56default_tracer = ExeTracer()
57
58if buildEnv['TARGET_ISA'] == 'alpha':
59    from AlphaTLB import AlphaDTB, AlphaITB
60    from AlphaInterrupts import AlphaInterrupts
61    from AlphaISA import AlphaISA
62    isa_class = AlphaISA
63elif buildEnv['TARGET_ISA'] == 'sparc':
64    from SparcTLB import SparcTLB
65    from SparcInterrupts import SparcInterrupts
66    from SparcISA import SparcISA
67    isa_class = SparcISA
68elif buildEnv['TARGET_ISA'] == 'x86':
69    from X86TLB import X86TLB
70    from X86LocalApic import X86LocalApic
71    from X86ISA import X86ISA
72    isa_class = X86ISA
73elif buildEnv['TARGET_ISA'] == 'mips':
74    from MipsTLB import MipsTLB
75    from MipsInterrupts import MipsInterrupts
76    from MipsISA import MipsISA
77    isa_class = MipsISA
78elif buildEnv['TARGET_ISA'] == 'arm':
79    from ArmTLB import ArmTLB, ArmStage2IMMU, ArmStage2DMMU
80    from ArmInterrupts import ArmInterrupts
81    from ArmISA import ArmISA
82    isa_class = ArmISA
83elif buildEnv['TARGET_ISA'] == 'power':
84    from PowerTLB import PowerTLB
85    from PowerInterrupts import PowerInterrupts
86    from PowerISA import PowerISA
87    isa_class = PowerISA
88
89class BaseCPU(MemObject):
90    type = 'BaseCPU'
91    abstract = True
92    cxx_header = "cpu/base.hh"
93
94    @classmethod
95    def export_methods(cls, code):
96        code('''
97    void switchOut();
98    void takeOverFrom(BaseCPU *cpu);
99    bool switchedOut();
100    void flushTLBs();
101    Counter totalInsts();
102    void scheduleInstStop(ThreadID tid, Counter insts, const char *cause);
103    void scheduleLoadStop(ThreadID tid, Counter loads, const char *cause);
104''')
105
106    @classmethod
107    def memory_mode(cls):
108        """Which memory mode does this CPU require?"""
109        return 'invalid'
110
111    @classmethod
112    def require_caches(cls):
113        """Does the CPU model require caches?
114
115        Some CPU models might make assumptions that require them to
116        have caches.
117        """
118        return False
119
120    @classmethod
121    def support_take_over(cls):
122        """Does the CPU model support CPU takeOverFrom?"""
123        return False
124
125    def takeOverFrom(self, old_cpu):
126        self._ccObject.takeOverFrom(old_cpu._ccObject)
127
128
129    system = Param.System(Parent.any, "system object")
130    cpu_id = Param.Int(-1, "CPU identifier")
131    socket_id = Param.Unsigned(0, "Physical Socket identifier")
132    numThreads = Param.Unsigned(1, "number of HW thread contexts")
133
134    function_trace = Param.Bool(False, "Enable function trace")
135    function_trace_start = Param.Tick(0, "Tick to start function trace")
136
137    checker = Param.BaseCPU(NULL, "checker CPU")
138
139    do_checkpoint_insts = Param.Bool(True,
140        "enable checkpoint pseudo instructions")
141    do_statistics_insts = Param.Bool(True,
142        "enable statistics pseudo instructions")
143
144    profile = Param.Latency('0ns', "trace the kernel stack")
145    do_quiesce = Param.Bool(True, "enable quiesce instructions")
146
147    workload = VectorParam.Process([], "processes to run")
148
149    if buildEnv['TARGET_ISA'] == 'sparc':
150        dtb = Param.SparcTLB(SparcTLB(), "Data TLB")
151        itb = Param.SparcTLB(SparcTLB(), "Instruction TLB")
152        interrupts = Param.SparcInterrupts(
153                NULL, "Interrupt Controller")
154        isa = VectorParam.SparcISA([ isa_class() ], "ISA instance")
155    elif buildEnv['TARGET_ISA'] == 'alpha':
156        dtb = Param.AlphaTLB(AlphaDTB(), "Data TLB")
157        itb = Param.AlphaTLB(AlphaITB(), "Instruction TLB")
158        interrupts = Param.AlphaInterrupts(
159                NULL, "Interrupt Controller")
160        isa = VectorParam.AlphaISA([ isa_class() ], "ISA instance")
161    elif buildEnv['TARGET_ISA'] == 'x86':
162        dtb = Param.X86TLB(X86TLB(), "Data TLB")
163        itb = Param.X86TLB(X86TLB(), "Instruction TLB")
164        interrupts = Param.X86LocalApic(NULL, "Interrupt Controller")
165        isa = VectorParam.X86ISA([ isa_class() ], "ISA instance")
166    elif buildEnv['TARGET_ISA'] == 'mips':
167        dtb = Param.MipsTLB(MipsTLB(), "Data TLB")
168        itb = Param.MipsTLB(MipsTLB(), "Instruction TLB")
169        interrupts = Param.MipsInterrupts(
170                NULL, "Interrupt Controller")
171        isa = VectorParam.MipsISA([ isa_class() ], "ISA instance")
172    elif buildEnv['TARGET_ISA'] == 'arm':
173        dtb = Param.ArmTLB(ArmTLB(), "Data TLB")
174        itb = Param.ArmTLB(ArmTLB(), "Instruction TLB")
175        istage2_mmu = Param.ArmStage2MMU(ArmStage2IMMU(), "Stage 2 trans")
176        dstage2_mmu = Param.ArmStage2MMU(ArmStage2DMMU(), "Stage 2 trans")
177        interrupts = Param.ArmInterrupts(
178                NULL, "Interrupt Controller")
179        isa = VectorParam.ArmISA([ isa_class() ], "ISA instance")
180    elif buildEnv['TARGET_ISA'] == 'power':
181        UnifiedTLB = Param.Bool(True, "Is this a Unified TLB?")
182        dtb = Param.PowerTLB(PowerTLB(), "Data TLB")
183        itb = Param.PowerTLB(PowerTLB(), "Instruction TLB")
184        interrupts = Param.PowerInterrupts(
185                NULL, "Interrupt Controller")
186        isa = VectorParam.PowerISA([ isa_class() ], "ISA instance")
187    else:
188        print "Don't know what TLB to use for ISA %s" % \
189            buildEnv['TARGET_ISA']
190        sys.exit(1)
191
192    max_insts_all_threads = Param.Counter(0,
193        "terminate when all threads have reached this inst count")
194    max_insts_any_thread = Param.Counter(0,
195        "terminate when any thread reaches this inst count")
196    simpoint_start_insts = VectorParam.Counter([],
197        "starting instruction counts of simpoints")
198    max_loads_all_threads = Param.Counter(0,
199        "terminate when all threads have reached this load count")
200    max_loads_any_thread = Param.Counter(0,
201        "terminate when any thread reaches this load count")
202    progress_interval = Param.Frequency('0Hz',
203        "frequency to print out the progress message")
204
205    switched_out = Param.Bool(False,
206        "Leave the CPU switched out after startup (used when switching " \
207        "between CPU models)")
208
209    tracer = Param.InstTracer(default_tracer, "Instruction tracer")
210
211    icache_port = MasterPort("Instruction Port")
212    dcache_port = MasterPort("Data Port")
213    _cached_ports = ['icache_port', 'dcache_port']
214
215    if buildEnv['TARGET_ISA'] in ['x86', 'arm']:
216        _cached_ports += ["itb.walker.port", "dtb.walker.port"]
217        if buildEnv['TARGET_ISA'] in ['arm']:
218            _cached_ports += ["istage2_mmu.stage2_tlb.walker.port",
219                              "dstage2_mmu.stage2_tlb.walker.port"]
220
221    _uncached_slave_ports = []
222    _uncached_master_ports = []
223    if buildEnv['TARGET_ISA'] == 'x86':
224        _uncached_slave_ports += ["interrupts.pio", "interrupts.int_slave"]
225        _uncached_master_ports += ["interrupts.int_master"]
226
227    def createInterruptController(self):
228        if buildEnv['TARGET_ISA'] == 'sparc':
229            self.interrupts = SparcInterrupts()
230        elif buildEnv['TARGET_ISA'] == 'alpha':
231            self.interrupts = AlphaInterrupts()
232        elif buildEnv['TARGET_ISA'] == 'x86':
233            self.apic_clk_domain = DerivedClockDomain(clk_domain =
234                                                      Parent.clk_domain,
235                                                      clk_divider = 16)
236            self.interrupts = X86LocalApic(clk_domain = self.apic_clk_domain,
237                                           pio_addr=0x2000000000000000)
238            _localApic = self.interrupts
239        elif buildEnv['TARGET_ISA'] == 'mips':
240            self.interrupts = MipsInterrupts()
241        elif buildEnv['TARGET_ISA'] == 'arm':
242            self.interrupts = ArmInterrupts()
243        elif buildEnv['TARGET_ISA'] == 'power':
244            self.interrupts = PowerInterrupts()
245        else:
246            print "Don't know what Interrupt Controller to use for ISA %s" % \
247                buildEnv['TARGET_ISA']
248            sys.exit(1)
249
250    def connectCachedPorts(self, bus):
251        for p in self._cached_ports:
252            exec('self.%s = bus.slave' % p)
253
254    def connectUncachedPorts(self, bus):
255        for p in self._uncached_slave_ports:
256            exec('self.%s = bus.master' % p)
257        for p in self._uncached_master_ports:
258            exec('self.%s = bus.slave' % p)
259
260    def connectAllPorts(self, cached_bus, uncached_bus = None):
261        self.connectCachedPorts(cached_bus)
262        if not uncached_bus:
263            uncached_bus = cached_bus
264        self.connectUncachedPorts(uncached_bus)
265
266    def addPrivateSplitL1Caches(self, ic, dc, iwc = None, dwc = None):
267        self.icache = ic
268        self.dcache = dc
269        self.icache_port = ic.cpu_side
270        self.dcache_port = dc.cpu_side
271        self._cached_ports = ['icache.mem_side', 'dcache.mem_side']
272        if buildEnv['TARGET_ISA'] in ['x86', 'arm']:
273            if iwc and dwc:
274                self.itb_walker_cache = iwc
275                self.dtb_walker_cache = dwc
276                if buildEnv['TARGET_ISA'] in ['arm']:
277                    self.itb_walker_cache_bus = CoherentBus()
278                    self.dtb_walker_cache_bus = CoherentBus()
279                    self.itb_walker_cache_bus.master = iwc.cpu_side
280                    self.dtb_walker_cache_bus.master = dwc.cpu_side
281                    self.itb.walker.port = self.itb_walker_cache_bus.slave
282                    self.dtb.walker.port = self.dtb_walker_cache_bus.slave
283                    self.istage2_mmu.stage2_tlb.walker.port = self.itb_walker_cache_bus.slave
284                    self.dstage2_mmu.stage2_tlb.walker.port = self.dtb_walker_cache_bus.slave
285                else:
286                    self.itb.walker.port = iwc.cpu_side
287                    self.dtb.walker.port = dwc.cpu_side
288                self._cached_ports += ["itb_walker_cache.mem_side", \
289                                       "dtb_walker_cache.mem_side"]
290            else:
291                self._cached_ports += ["itb.walker.port", "dtb.walker.port"]
292
293                if buildEnv['TARGET_ISA'] in ['arm']:
294                    self._cached_ports += ["istage2_mmu.stage2_tlb.walker.port", \
295                                           "dstage2_mmu.stage2_tlb.walker.port"]
296
297            # Checker doesn't need its own tlb caches because it does
298            # functional accesses only
299            if self.checker != NULL:
300                self._cached_ports += ["checker.itb.walker.port", \
301                                       "checker.dtb.walker.port"]
302                if buildEnv['TARGET_ISA'] in ['arm']:
303                    self._cached_ports += ["checker.istage2_mmu.stage2_tlb.walker.port", \
304                                           "checker.dstage2_mmu.stage2_tlb.walker.port"]
305
306    def addTwoLevelCacheHierarchy(self, ic, dc, l2c, iwc = None, dwc = None):
307        self.addPrivateSplitL1Caches(ic, dc, iwc, dwc)
308        # Set a width of 32 bytes (256-bits), which is four times that
309        # of the default bus. The clock of the CPU is inherited by
310        # default.
311        self.toL2Bus = CoherentBus(width = 32)
312        self.connectCachedPorts(self.toL2Bus)
313        self.l2cache = l2c
314        self.toL2Bus.master = self.l2cache.cpu_side
315        self._cached_ports = ['l2cache.mem_side']
316
317    def createThreads(self):
318        self.isa = [ isa_class() for i in xrange(self.numThreads) ]
319        if self.checker != NULL:
320            self.checker.createThreads()
321
322    def addCheckerCpu(self):
323        pass
324