3 # Copyright (c) 2006 The Regents of The University of Michigan
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions are
8 # met: redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer;
10 # redistributions in binary form must reproduce the above copyright
11 # notice, this list of conditions and the following disclaimer in the
12 # documentation and/or other materials provided with the distribution;
13 # neither the name of the copyright holders nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 # Authors: Steve Reinhardt
34 # Import build environment variable from SConstruct.
37 #################################################################
39 # Generate StaticInst execute() method signatures.
41 # There must be one signature for each CPU model compiled in.
42 # Since the set of compiled-in models is flexible, we generate a
43 # header containing the appropriate set of signatures on the fly.
45 #################################################################
47 # CPU model-specific data is contained in cpu_models.py
48 # Convert to SCons File node to get path handling
49 models_db = File('cpu_models.py')
50 # slurp in contents of file
51 execfile(models_db.srcnode().abspath)
53 # Template for execute() signature.
54 exec_sig_template = '''
55 virtual Fault execute(%s *xc, Trace::InstRecord *traceData) const = 0;
56 virtual Fault initiateAcc(%s *xc, Trace::InstRecord *traceData) const
57 { panic("initiateAcc not defined!"); M5_DUMMY_RETURN };
58 virtual Fault completeAcc(Packet *pkt, %s *xc,
59 Trace::InstRecord *traceData) const
60 { panic("completeAcc not defined!"); M5_DUMMY_RETURN };
63 mem_ini_sig_template = '''
64 virtual Fault initiateAcc(%s *xc, Trace::InstRecord *traceData) const { panic("Not defined!"); M5_DUMMY_RETURN };
67 mem_comp_sig_template = '''
68 virtual Fault completeAcc(uint8_t *data, %s *xc, Trace::InstRecord *traceData) const { panic("Not defined!"); return NoFault; M5_DUMMY_RETURN };
71 # Generate a temporary CPU list, including the CheckerCPU if
72 # it's enabled. This isn't used for anything else other than StaticInst
74 temp_cpu_list = env['CPU_MODELS'][:]
76 if env['USE_CHECKER']:
77 temp_cpu_list.append('CheckerCPU')
80 def gen_cpu_exec_signatures(target, source, env):
81 f = open(str(target[0]), 'w')
83 #ifndef __CPU_STATIC_INST_EXEC_SIGS_HH__
84 #define __CPU_STATIC_INST_EXEC_SIGS_HH__
86 for cpu in temp_cpu_list:
87 xc_type = CpuModel.dict[cpu].strings['CPU_exec_context']
88 print >> f, exec_sig_template % (xc_type, xc_type, xc_type)
90 #endif // __CPU_STATIC_INST_EXEC_SIGS_HH__
93 # Generate string that gets printed when header is rebuilt
94 def gen_sigs_string(target, source, env):
95 return "Generating static_inst_exec_sigs.hh: " \
96 + ', '.join(temp_cpu_list)
98 # Add command to generate header to environment.
99 env.Command('static_inst_exec_sigs.hh', models_db,
100 Action(gen_cpu_exec_signatures, gen_sigs_string,
101 varlist = temp_cpu_list))
103 env.Depends('static_inst_exec_sigs.hh', Value(env['USE_CHECKER']))
104 env.Depends('static_inst_exec_sigs.hh', Value(env['CPU_MODELS']))
106 # List of suppported CPUs by the Checker. Errors out if USE_CHECKER=True
107 # and one of these are not being used.
108 CheckerSupportedCPUList = ['O3CPU', 'OzoneCPU']
110 #################################################################
112 # Include CPU-model-specific files based on set of models
113 # specified in CPU_MODELS build option.
115 #################################################################
117 # Keep a list of CPU models that support SMT
118 env['SMT_CPU_MODELS'] = []
122 need_simple_base = False
123 if 'AtomicSimpleCPU' in env['CPU_MODELS']:
124 need_simple_base = True
125 sources += Split('simple/atomic.cc')
127 if 'TimingSimpleCPU' in env['CPU_MODELS']:
128 need_simple_base = True
129 sources += Split('simple/timing.cc')
132 sources += Split('simple/base.cc')
134 if 'FastCPU' in env['CPU_MODELS']:
135 sources += Split('fast/cpu.cc')
138 if 'O3CPU' in env['CPU_MODELS']:
140 sources += SConscript('o3/SConscript', exports = 'env')
161 sources += Split('memtest/memtest.cc')
162 if env['USE_CHECKER']:
163 sources += Split('o3/checker_builder.cc')
165 env['SMT_CPU_MODELS'].append('O3CPU') # Checker doesn't support SMT right now
167 if 'OzoneCPU' in env['CPU_MODELS']:
170 ozone/base_dyn_inst.cc
178 ozone/rename_table.cc
180 if env['USE_CHECKER']:
181 sources += Split('ozone/checker_builder.cc')
185 o3/2bit_local_pred.cc
188 o3/tournament_pred.cc
191 if env['USE_CHECKER']:
192 sources += Split('checker/cpu.cc')
193 checker_supports = False
194 for i in CheckerSupportedCPUList:
195 if i in env['CPU_MODELS']:
196 checker_supports = True
197 if not checker_supports:
198 print "Checker only supports CPU models",
199 for i in CheckerSupportedCPUList:
201 print ", please set USE_CHECKER=False or use one of those CPU models"
205 # FullCPU sources are included from src/SConscript since they're not
206 # below this point in the file hierarchy.
208 # Convert file names to SCons File objects. This takes care of the
209 # path relative to the top of the directory tree.
210 sources = [File(s) for s in sources]