SConscript revision 3940 
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	kernel_stats.hh
55        locked_mem.hh
56        mmaped_ipr.hh
57	process.hh
58	regfile.hh
59	remote_gdb.hh
60	stacktrace.hh
61	syscallreturn.hh
62	tlb.hh
63	types.hh
64	utility.hh
65	vtophys.hh
66        ''')
67
68# Set up this directory to support switching headers
69env.make_switching_dir('arch', isa_switch_hdrs, env)
70
71#################################################################
72#
73# Include architecture-specific files.
74#
75#################################################################
76
77#
78# Build a SCons scanner for ISA files
79#
80import SCons.Scanner
81
82isa_scanner = SCons.Scanner.Classic("ISAScan",
83                                    [".isa", ".ISA"],
84                                    "SRCDIR",
85                                    r'^\s*##include\s+"([\w/.-]*)"')
86
87env.Append(SCANNERS = isa_scanner)
88
89#
90# Now create a Builder object that uses isa_parser.py to generate C++
91# output from the ISA description (*.isa) files.
92#
93
94# Convert to File node to fix path
95isa_parser = File('isa_parser.py')
96cpu_models_file = File('../cpu/cpu_models.py')
97
98# This sucks in the defintions of the CpuModel objects.
99execfile(cpu_models_file.srcnode().abspath)
100
101# Several files are generated from the ISA description.
102# We always get the basic decoder and header file.
103isa_desc_gen_files = Split('decoder.cc decoder.hh')
104# We also get an execute file for each selected CPU model.
105isa_desc_gen_files += [CpuModel.dict[cpu].filename
106                       for cpu in env['CPU_MODELS']]
107
108# Also include the CheckerCPU as one of the models if it is being
109# enabled via command line.
110if env['USE_CHECKER']:
111    isa_desc_gen_files += [CpuModel.dict['CheckerCPU'].filename]
112
113# The emitter patches up the sources & targets to include the
114# autogenerated files as targets and isa parser itself as a source.
115def isa_desc_emitter(target, source, env):
116    return (isa_desc_gen_files, [isa_parser, cpu_models_file] + source)
117
118# Pieces are in place, so create the builder.
119python = sys.executable  # use same Python binary used to run scons
120
121# Also include the CheckerCPU as one of the models if it is being
122# enabled via command line.
123if env['USE_CHECKER']:
124    isa_desc_builder = Builder(action=python + ' $SOURCES $TARGET.dir $CPU_MODELS CheckerCPU',
125                               emitter = isa_desc_emitter)
126else:
127    isa_desc_builder = Builder(action=python + ' $SOURCES $TARGET.dir $CPU_MODELS',
128                               emitter = isa_desc_emitter)
129
130env.Append(BUILDERS = { 'ISADesc' : isa_desc_builder })
131
132#
133# Now include other ISA-specific sources from the ISA subdirectories.
134#
135
136isa = env['TARGET_ISA'] # someday this may be a list of ISAs
137
138# Let the target architecture define what additional sources it needs
139sources += SConscript(os.path.join(isa, 'SConscript'), exports = 'env')
140
141Return('sources')
142