SConscript revision 2623 
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
61# Generate header.  
62def gen_cpu_exec_signatures(target, source, env):
63    f = open(str(target[0]), 'w')
64    print >> f, '''
65#ifndef __CPU_STATIC_INST_EXEC_SIGS_HH__
66#define __CPU_STATIC_INST_EXEC_SIGS_HH__
67'''
68    for cpu in env['CPU_MODELS']:
69        xc_type = CpuModel.dict[cpu].strings['CPU_exec_context']
70        print >> f, exec_sig_template % (xc_type, xc_type, xc_type)
71    print >> f, '''
72#endif  // __CPU_STATIC_INST_EXEC_SIGS_HH__
73'''
74
75# Generate string that gets printed when header is rebuilt
76def gen_sigs_string(target, source, env):
77    return "Generating static_inst_exec_sigs.hh: " \
78           + ', '.join(env['CPU_MODELS'])
79
80# Add command to generate header to environment.
81env.Command('static_inst_exec_sigs.hh', models_db,
82            Action(gen_cpu_exec_signatures, gen_sigs_string,
83                   varlist = ['CPU_MODELS']))
84
85#################################################################
86#
87# Include CPU-model-specific files based on set of models
88# specified in CPU_MODELS build option.
89#
90#################################################################
91
92sources = []
93
94need_simple_base = False
95if 'AtomicSimpleCPU' in env['CPU_MODELS']:
96    need_simple_base = True
97    sources += Split('simple/atomic.cc')
98
99if 'TimingSimpleCPU' in env['CPU_MODELS']:
100    need_simple_base = True
101    sources += Split('simple/timing.cc')
102
103if need_simple_base:
104    sources += Split('simple/base.cc')
105
106if 'FastCPU' in env['CPU_MODELS']:
107    sources += Split('fast/cpu.cc')
108
109if 'AlphaFullCPU' in env['CPU_MODELS']:
110    sources += Split('''
111        o3/2bit_local_pred.cc
112        o3/alpha_dyn_inst.cc
113        o3/alpha_cpu.cc
114        o3/alpha_cpu_builder.cc
115        o3/bpred_unit.cc
116        o3/btb.cc
117        o3/commit.cc
118        o3/decode.cc
119        o3/fetch.cc
120        o3/free_list.cc
121        o3/cpu.cc
122        o3/iew.cc
123        o3/inst_queue.cc
124        o3/ldstq.cc
125        o3/mem_dep_unit.cc
126        o3/ras.cc
127        o3/rename.cc
128        o3/rename_map.cc
129        o3/rob.cc
130        o3/sat_counter.cc
131        o3/store_set.cc
132        o3/tournament_pred.cc
133        ''')
134
135# FullCPU sources are included from m5/SConscript since they're not
136# below this point in the file hierarchy.
137
138# Convert file names to SCons File objects.  This takes care of the
139# path relative to the top of the directory tree.
140sources = [File(s) for s in sources]
141
142Return('sources')
143
144