SConscript revision 3536
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.path, sys
32
33# Import build environment variable from SConstruct.
34Import('env')
35
36# Right now there are no source files immediately in this directory
37sources = []
38
39#################################################################
40#
41# ISA "switch header" generation.
42#
43# Auto-generate arch headers that include the right ISA-specific
44# header based on the setting of THE_ISA preprocessor variable.
45#
46#################################################################
47
48# List of headers to generate
49isa_switch_hdrs = Split('''
50	arguments.hh
51	faults.hh
52	interrupts.hh
53	isa_traits.hh
54        locked_mem.hh
55	process.hh
56	regfile.hh
57	remote_gdb.hh
58	stacktrace.hh
59	syscallreturn.hh
60	tlb.hh
61	types.hh
62	utility.hh
63	vtophys.hh
64        ''')
65
66# Generate the header.  target[0] is the full path of the output
67# header to generate.  'source' is a dummy variable, since we get the
68# list of ISAs from env['ALL_ISA_LIST'].
69def gen_switch_hdr(target, source, env):
70    fname = str(target[0])
71    basename = os.path.basename(fname)
72    f = open(fname, 'w')
73    f.write('#include "arch/isa_specific.hh"\n')
74    cond = '#if'
75    for isa in env['ALL_ISA_LIST']:
76        f.write('%s THE_ISA == %s_ISA\n#include "arch/%s/%s"\n'
77                % (cond, isa.upper(), isa, basename))
78        cond = '#elif'
79    f.write('#else\n#error "THE_ISA not set"\n#endif\n')
80    f.close()
81    return 0
82
83# String to print when generating header
84def gen_switch_hdr_string(target, source, env):
85    return "Generating ISA switch header " + str(target[0])
86
87# Build SCons Action object. 'varlist' specifies env vars that this
88# action depends on; when env['ALL_ISA_LIST'] changes these actions
89# should get re-executed.
90switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
91                           varlist=['ALL_ISA_LIST'])
92
93# Instantiate actions for each header
94for hdr in isa_switch_hdrs:
95    env.Command(hdr, [], switch_hdr_action)
96
97#################################################################
98#
99# Include architecture-specific files.
100#
101#################################################################
102
103#
104# Build a SCons scanner for ISA files
105#
106import SCons.Scanner
107
108isa_scanner = SCons.Scanner.Classic("ISAScan",
109                                    [".isa", ".ISA"],
110                                    "SRCDIR",
111                                    r'^\s*##include\s+"([\w/.-]*)"')
112
113env.Append(SCANNERS = isa_scanner)
114
115#
116# Now create a Builder object that uses isa_parser.py to generate C++
117# output from the ISA description (*.isa) files.
118#
119
120# Convert to File node to fix path
121isa_parser = File('isa_parser.py')
122cpu_models_file = File('../cpu/cpu_models.py')
123
124# This sucks in the defintions of the CpuModel objects.
125execfile(cpu_models_file.srcnode().abspath)
126
127# Several files are generated from the ISA description.
128# We always get the basic decoder and header file.
129isa_desc_gen_files = Split('decoder.cc decoder.hh')
130# We also get an execute file for each selected CPU model.
131isa_desc_gen_files += [CpuModel.dict[cpu].filename
132                       for cpu in env['CPU_MODELS']]
133
134# Also include the CheckerCPU as one of the models if it is being
135# enabled via command line.
136if env['USE_CHECKER']:
137    isa_desc_gen_files += [CpuModel.dict['CheckerCPU'].filename]
138
139# The emitter patches up the sources & targets to include the
140# autogenerated files as targets and isa parser itself as a source.
141def isa_desc_emitter(target, source, env):
142    return (isa_desc_gen_files, [isa_parser, cpu_models_file] + source)
143
144# Pieces are in place, so create the builder.
145python = sys.executable  # use same Python binary used to run scons
146
147# Also include the CheckerCPU as one of the models if it is being
148# enabled via command line.
149if env['USE_CHECKER']:
150    isa_desc_builder = Builder(action=python + ' $SOURCES $TARGET.dir $CPU_MODELS CheckerCPU',
151                               emitter = isa_desc_emitter)
152else:
153    isa_desc_builder = Builder(action=python + ' $SOURCES $TARGET.dir $CPU_MODELS',
154                               emitter = isa_desc_emitter)
155
156env.Append(BUILDERS = { 'ISADesc' : isa_desc_builder })
157
158#
159# Now include other ISA-specific sources from the ISA subdirectories.
160#
161
162isa = env['TARGET_ISA'] # someday this may be a list of ISAs
163
164# Let the target architecture define what additional sources it needs
165sources += SConscript(os.path.join(isa, 'SConscript'), exports = 'env')
166
167Return('sources')
168