SConscript revision 2665:a124942bacb8 
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#
29# Authors: Steve Reinhardt
30
31import os
32import os.path
33
34# Import build environment variable from SConstruct.
35Import('env')
36
37#################################################################
38#
39# Generate StaticInst execute() method signatures.
40#
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.
44#
45#################################################################
46
47# CPU model-specific data is contained in cpu_models.py
48# Convert to SCons File node to get path handling
49models_db = File('cpu_models.py')
50# slurp in contents of file
51execfile(models_db.srcnode().abspath)
52
53# Template for execute() signature.
54exec_sig_template = '''
55virtual Fault execute(%s *xc, Trace::InstRecord *traceData) const = 0;
56virtual Fault initiateAcc(%s *xc, Trace::InstRecord *traceData) const
57{ panic("initiateAcc not defined!"); };
58virtual Fault completeAcc(Packet *pkt, %s *xc,
59                          Trace::InstRecord *traceData) const
60{ panic("completeAcc not defined!"); };
61'''
62
63# Generate header.  
64def gen_cpu_exec_signatures(target, source, env):
65    f = open(str(target[0]), 'w')
66    print >> f, '''
67#ifndef __CPU_STATIC_INST_EXEC_SIGS_HH__
68#define __CPU_STATIC_INST_EXEC_SIGS_HH__
69'''
70    for cpu in env['CPU_MODELS']:
71        xc_type = CpuModel.dict[cpu].strings['CPU_exec_context']
72        print >> f, exec_sig_template % (xc_type, xc_type, xc_type)
73    print >> f, '''
74#endif  // __CPU_STATIC_INST_EXEC_SIGS_HH__
75'''
76
77# Generate string that gets printed when header is rebuilt
78def gen_sigs_string(target, source, env):
79    return "Generating static_inst_exec_sigs.hh: " \
80           + ', '.join(env['CPU_MODELS'])
81
82# Add command to generate header to environment.
83env.Command('static_inst_exec_sigs.hh', models_db,
84            Action(gen_cpu_exec_signatures, gen_sigs_string,
85                   varlist = ['CPU_MODELS']))
86
87#################################################################
88#
89# Include CPU-model-specific files based on set of models
90# specified in CPU_MODELS build option.
91#
92#################################################################
93
94sources = []
95
96need_simple_base = False
97if 'AtomicSimpleCPU' in env['CPU_MODELS']:
98    need_simple_base = True
99    sources += Split('simple/atomic.cc')
100
101if 'TimingSimpleCPU' in env['CPU_MODELS']:
102    need_simple_base = True
103    sources += Split('simple/timing.cc')
104
105if need_simple_base:
106    sources += Split('simple/base.cc')
107
108if 'FastCPU' in env['CPU_MODELS']:
109    sources += Split('fast/cpu.cc')
110
111if 'AlphaFullCPU' in env['CPU_MODELS']:
112    sources += Split('''
113        o3/2bit_local_pred.cc
114        o3/alpha_dyn_inst.cc
115        o3/alpha_cpu.cc
116        o3/alpha_cpu_builder.cc
117        o3/bpred_unit.cc
118        o3/btb.cc
119        o3/commit.cc
120        o3/decode.cc
121        o3/fetch.cc
122        o3/free_list.cc
123        o3/cpu.cc
124        o3/iew.cc
125        o3/inst_queue.cc
126        o3/ldstq.cc
127        o3/mem_dep_unit.cc
128        o3/ras.cc
129        o3/rename.cc
130        o3/rename_map.cc
131        o3/rob.cc
132        o3/sat_counter.cc
133        o3/store_set.cc
134        o3/tournament_pred.cc
135        ''')
136
137# FullCPU sources are included from m5/SConscript since they're not
138# below this point in the file hierarchy.
139
140# Convert file names to SCons File objects.  This takes care of the
141# path relative to the top of the directory tree.
142sources = [File(s) for s in sources]
143
144Return('sources')
145
146