BaseCPU.py revision 9788:5558ee8dd7d9 
1# Copyright (c) 2012 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 BranchPredictor import BranchPredictor
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
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    numThreads = Param.Unsigned(1, "number of HW thread contexts")
132
133    function_trace = Param.Bool(False, "Enable function trace")
134    function_trace_start = Param.Tick(0, "Tick to start function trace")
135
136    checker = Param.BaseCPU(NULL, "checker CPU")
137
138    do_checkpoint_insts = Param.Bool(True,
139        "enable checkpoint pseudo instructions")
140    do_statistics_insts = Param.Bool(True,
141        "enable statistics pseudo instructions")
142
143    profile = Param.Latency('0ns', "trace the kernel stack")
144    do_quiesce = Param.Bool(True, "enable quiesce instructions")
145
146    workload = VectorParam.Process([], "processes to run")
147
148    if buildEnv['TARGET_ISA'] == 'sparc':
149        dtb = Param.SparcTLB(SparcTLB(), "Data TLB")
150        itb = Param.SparcTLB(SparcTLB(), "Instruction TLB")
151        interrupts = Param.SparcInterrupts(
152                NULL, "Interrupt Controller")
153        isa = VectorParam.SparcISA([ isa_class() ], "ISA instance")
154    elif buildEnv['TARGET_ISA'] == 'alpha':
155        dtb = Param.AlphaTLB(AlphaDTB(), "Data TLB")
156        itb = Param.AlphaTLB(AlphaITB(), "Instruction TLB")
157        interrupts = Param.AlphaInterrupts(
158                NULL, "Interrupt Controller")
159        isa = VectorParam.AlphaISA([ isa_class() ], "ISA instance")
160    elif buildEnv['TARGET_ISA'] == 'x86':
161        dtb = Param.X86TLB(X86TLB(), "Data TLB")
162        itb = Param.X86TLB(X86TLB(), "Instruction TLB")
163        interrupts = Param.X86LocalApic(NULL, "Interrupt Controller")
164        isa = VectorParam.X86ISA([ isa_class() ], "ISA instance")
165    elif buildEnv['TARGET_ISA'] == 'mips':
166        dtb = Param.MipsTLB(MipsTLB(), "Data TLB")
167        itb = Param.MipsTLB(MipsTLB(), "Instruction TLB")
168        interrupts = Param.MipsInterrupts(
169                NULL, "Interrupt Controller")
170        isa = VectorParam.MipsISA([ isa_class() ], "ISA instance")
171    elif buildEnv['TARGET_ISA'] == 'arm':
172        dtb = Param.ArmTLB(ArmTLB(), "Data TLB")
173        itb = Param.ArmTLB(ArmTLB(), "Instruction TLB")
174        interrupts = Param.ArmInterrupts(
175                NULL, "Interrupt Controller")
176        isa = VectorParam.ArmISA([ isa_class() ], "ISA instance")
177    elif buildEnv['TARGET_ISA'] == 'power':
178        UnifiedTLB = Param.Bool(True, "Is this a Unified TLB?")
179        dtb = Param.PowerTLB(PowerTLB(), "Data TLB")
180        itb = Param.PowerTLB(PowerTLB(), "Instruction TLB")
181        interrupts = Param.PowerInterrupts(
182                NULL, "Interrupt Controller")
183        isa = VectorParam.PowerISA([ isa_class() ], "ISA instance")
184    else:
185        print "Don't know what TLB to use for ISA %s" % \
186            buildEnv['TARGET_ISA']
187        sys.exit(1)
188
189    max_insts_all_threads = Param.Counter(0,
190        "terminate when all threads have reached this inst count")
191    max_insts_any_thread = Param.Counter(0,
192        "terminate when any thread reaches this inst count")
193    simpoint_start_insts = VectorParam.Counter([],
194        "starting instruction counts of simpoints")
195    max_loads_all_threads = Param.Counter(0,
196        "terminate when all threads have reached this load count")
197    max_loads_any_thread = Param.Counter(0,
198        "terminate when any thread reaches this load count")
199    progress_interval = Param.Frequency('0Hz',
200        "frequency to print out the progress message")
201
202    switched_out = Param.Bool(False,
203        "Leave the CPU switched out after startup (used when switching " \
204        "between CPU models)")
205
206    tracer = Param.InstTracer(default_tracer, "Instruction tracer")
207
208    icache_port = MasterPort("Instruction Port")
209    dcache_port = MasterPort("Data Port")
210    _cached_ports = ['icache_port', 'dcache_port']
211
212    branchPred = Param.BranchPredictor(NULL, "Branch Predictor")
213
214    if buildEnv['TARGET_ISA'] in ['x86', 'arm']:
215        _cached_ports += ["itb.walker.port", "dtb.walker.port"]
216
217    _uncached_slave_ports = []
218    _uncached_master_ports = []
219    if buildEnv['TARGET_ISA'] == 'x86':
220        _uncached_slave_ports += ["interrupts.pio", "interrupts.int_slave"]
221        _uncached_master_ports += ["interrupts.int_master"]
222
223    def createInterruptController(self):
224        if buildEnv['TARGET_ISA'] == 'sparc':
225            self.interrupts = SparcInterrupts()
226        elif buildEnv['TARGET_ISA'] == 'alpha':
227            self.interrupts = AlphaInterrupts()
228        elif buildEnv['TARGET_ISA'] == 'x86':
229            self.interrupts = X86LocalApic(clock = Parent.clock * 16,
230                                           pio_addr=0x2000000000000000)
231            _localApic = self.interrupts
232        elif buildEnv['TARGET_ISA'] == 'mips':
233            self.interrupts = MipsInterrupts()
234        elif buildEnv['TARGET_ISA'] == 'arm':
235            self.interrupts = ArmInterrupts()
236        elif buildEnv['TARGET_ISA'] == 'power':
237            self.interrupts = PowerInterrupts()
238        else:
239            print "Don't know what Interrupt Controller to use for ISA %s" % \
240                buildEnv['TARGET_ISA']
241            sys.exit(1)
242
243    def connectCachedPorts(self, bus):
244        for p in self._cached_ports:
245            exec('self.%s = bus.slave' % p)
246
247    def connectUncachedPorts(self, bus):
248        for p in self._uncached_slave_ports:
249            exec('self.%s = bus.master' % p)
250        for p in self._uncached_master_ports:
251            exec('self.%s = bus.slave' % p)
252
253    def connectAllPorts(self, cached_bus, uncached_bus = None):
254        self.connectCachedPorts(cached_bus)
255        if not uncached_bus:
256            uncached_bus = cached_bus
257        self.connectUncachedPorts(uncached_bus)
258
259    def addPrivateSplitL1Caches(self, ic, dc, iwc = None, dwc = None):
260        self.icache = ic
261        self.dcache = dc
262        self.icache_port = ic.cpu_side
263        self.dcache_port = dc.cpu_side
264        self._cached_ports = ['icache.mem_side', 'dcache.mem_side']
265        if buildEnv['TARGET_ISA'] in ['x86', 'arm']:
266            if iwc and dwc:
267                self.itb_walker_cache = iwc
268                self.dtb_walker_cache = dwc
269                self.itb.walker.port = iwc.cpu_side
270                self.dtb.walker.port = dwc.cpu_side
271                self._cached_ports += ["itb_walker_cache.mem_side", \
272                                       "dtb_walker_cache.mem_side"]
273            else:
274                self._cached_ports += ["itb.walker.port", "dtb.walker.port"]
275
276            # Checker doesn't need its own tlb caches because it does
277            # functional accesses only
278            if self.checker != NULL:
279                self._cached_ports += ["checker.itb.walker.port", \
280                                       "checker.dtb.walker.port"]
281
282    def addTwoLevelCacheHierarchy(self, ic, dc, l2c, iwc = None, dwc = None):
283        self.addPrivateSplitL1Caches(ic, dc, iwc, dwc)
284        # Set a width of 32 bytes (256-bits), which is four times that
285        # of the default bus. The clock of the CPU is inherited by
286        # default.
287        self.toL2Bus = CoherentBus(width = 32)
288        self.connectCachedPorts(self.toL2Bus)
289        self.l2cache = l2c
290        self.toL2Bus.master = self.l2cache.cpu_side
291        self._cached_ports = ['l2cache.mem_side']
292
293    def createThreads(self):
294        self.isa = [ isa_class() for i in xrange(self.numThreads) ]
295        if self.checker != NULL:
296            self.checker.createThreads()
297
298    def addCheckerCpu(self):
299        pass
300