1# -*- mode:python -*-
2
3# Copyright (c) 2006 The Regents of The University of Michigan
4# All rights reserved.
5#
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.
16#
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.
28
29import os
30import os.path
31
32# Import build environment variable from SConstruct.
33Import('env')
34
35#################################################################
36#
37# Generate StaticInst execute() method signatures.
38#
39# There must be one signature for each CPU model compiled in.
40# Since the set of compiled-in models is flexible, we generate a
41# header containing the appropriate set of signatures on the fly.
42#
43#################################################################
44
45# CPU model-specific data is contained in cpu_models.py
46# Convert to SCons File node to get path handling
47models_db = File('cpu_models.py')
48# slurp in contents of file
49execfile(models_db.srcnode().abspath)
50
51# Template for execute() signature.
52exec_sig_template = '''
53virtual Fault execute(%s *xc, Trace::InstRecord *traceData) const = 0;
54virtual Fault initiateAcc(%s *xc, Trace::InstRecord *traceData) const
55{ panic("initiateAcc not defined!"); };
56virtual Fault completeAcc(Packet *pkt, %s *xc,
57 Trace::InstRecord *traceData) const
58{ panic("completeAcc not defined!"); };
59'''
60
61mem_ini_sig_template = '''
62virtual Fault initiateAcc(%s *xc, Trace::InstRecord *traceData) const { panic("Not defined!"); };
63'''
64
65mem_comp_sig_template = '''
66virtual Fault completeAcc(uint8_t *data, %s *xc, Trace::InstRecord *traceData) const { panic("Not defined!"); return NoFault; };
67'''
68
69# Generate header.
70def gen_cpu_exec_signatures(target, source, env):
71 f = open(str(target[0]), 'w')
72 print >> f, '''
73#ifndef __CPU_STATIC_INST_EXEC_SIGS_HH__
74#define __CPU_STATIC_INST_EXEC_SIGS_HH__
75'''
76 for cpu in env['CPU_MODELS']:
77 xc_type = CpuModel.dict[cpu].strings['CPU_exec_context']
78 print >> f, exec_sig_template % (xc_type, xc_type, xc_type)
79 print >> f, '''
80#endif // __CPU_STATIC_INST_EXEC_SIGS_HH__
81'''
82
83# Generate string that gets printed when header is rebuilt
84def gen_sigs_string(target, source, env):
85 return "Generating static_inst_exec_sigs.hh: " \
86 + ', '.join(env['CPU_MODELS'])
87
88# Add command to generate header to environment.
89env.Command('static_inst_exec_sigs.hh', models_db,
90 Action(gen_cpu_exec_signatures, gen_sigs_string,
91 varlist = ['CPU_MODELS']))
92
93#################################################################
94#
95# Include CPU-model-specific files based on set of models
96# specified in CPU_MODELS build option.
97#
98#################################################################
99
100sources = []
101
102need_simple_base = False
103if 'AtomicSimpleCPU' in env['CPU_MODELS']:
104 need_simple_base = True
105 sources += Split('simple/atomic.cc')
106
107if 'TimingSimpleCPU' in env['CPU_MODELS']:
108 need_simple_base = True
109 sources += Split('simple/timing.cc')
110
111if need_simple_base:
112 sources += Split('simple/base.cc')
113
114if 'FastCPU' in env['CPU_MODELS']:
115 sources += Split('fast/cpu.cc')
116
117if 'AlphaFullCPU' in env['CPU_MODELS']:
118 sources += Split('''
119 o3/2bit_local_pred.cc
120 o3/alpha_dyn_inst.cc
121 o3/alpha_cpu.cc
122 o3/alpha_cpu_builder.cc
123 o3/bpred_unit.cc
124 o3/btb.cc
125 o3/commit.cc
126 o3/decode.cc
127 o3/fetch.cc
128 o3/free_list.cc
129 o3/fu_pool.cc
130 o3/cpu.cc
131 o3/iew.cc
132 o3/inst_queue.cc
133 o3/lsq_unit.cc
134 o3/lsq.cc
135 o3/mem_dep_unit.cc
136 o3/ras.cc
137 o3/rename.cc
138 o3/rename_map.cc
139 o3/rob.cc
140 o3/scoreboard.cc
141 o3/store_set.cc
142 o3/tournament_pred.cc
143 ''')
144
145if 'OzoneSimpleCPU' in env['CPU_MODELS']:
146 sources += Split('''
147 ozone/cpu.cc
148 ozone/cpu_builder.cc
149 ozone/dyn_inst.cc
150 ozone/front_end.cc
151 ozone/inorder_back_end.cc
152 ozone/inst_queue.cc
153 ozone/rename_table.cc
154 ''')
155
156if 'OzoneCPU' in env['CPU_MODELS']:
157 sources += Split('''
158 ozone/back_end.cc
159 ozone/lsq_unit.cc
160 ozone/lw_back_end.cc
161 ozone/lw_lsq.cc
162 ''')
163
164if 'CheckerCPU' in env['CPU_MODELS']:
165 sources += Split('''
166 checker/cpu.cc
167 checker/cpu_builder.cc
168 checker/o3_cpu_builder.cc
169 ''')
170
171# FullCPU sources are included from m5/SConscript since they're not
172# below this point in the file hierarchy.
173
174# Convert file names to SCons File objects. This takes care of the
175# path relative to the top of the directory tree.
176sources = [File(s) for s in sources]
177
178Return('sources')
179