3 # Copyright (c) 2006 The Regents of The University of Michigan
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.
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.
29 # Authors: Steve Reinhardt
35 #################################################################
37 # ISA "switch header" generation.
39 # Auto-generate arch headers that include the right ISA-specific
40 # header based on the setting of THE_ISA preprocessor variable.
42 #################################################################
44 # List of headers to generate
45 isa_switch_hdrs = Split('''
66 # Set up this directory to support switching headers
67 make_switching_dir('arch', isa_switch_hdrs, env)
69 #################################################################
71 # Include architecture-specific files.
73 #################################################################
76 # Build a SCons scanner for ISA files
80 isa_scanner = SCons.Scanner.Classic("ISAScan",
83 r'^\s*##include\s+"([\w/.-]*)"')
85 env.Append(SCANNERS = isa_scanner)
88 # Now create a Builder object that uses isa_parser.py to generate C++
89 # output from the ISA description (*.isa) files.
92 isa_parser = File('isa_parser.py')
94 # The emitter patches up the sources & targets to include the
95 # autogenerated files as targets and isa parser itself as a source.
96 def isa_desc_emitter(target, source, env):
97 cpu_models = list(env['CPU_MODELS'])
98 if env['USE_CHECKER']:
99 cpu_models.append('CheckerCPU')
101 # Several files are generated from the ISA description.
102 # We always get the basic decoder and header file.
103 target = [ 'decoder.cc', 'decoder.hh', 'max_inst_regs.hh' ]
104 # We also get an execute file for each selected CPU model.
105 target += [CpuModel.dict[cpu].filename for cpu in cpu_models]
107 # List the isa parser as a source.
108 source += [ isa_parser ]
109 # Add in the CPU models.
110 source += [ Value(m) for m in cpu_models ]
112 return target, source
116 # import ply here because SCons screws with sys.path when performing actions.
119 def isa_desc_action_func(target, source, env):
120 # Add the current directory to the system path so we can import files
121 sys.path[0:0] = [ ARCH_DIR.srcnode().abspath ]
124 # Skip over the ISA description itself and the parser to the CPU models.
125 models = [ s.get_contents() for s in source[2:] ]
126 cpu_models = [CpuModel.dict[cpu] for cpu in models]
127 parser = isa_parser.ISAParser(target[0].dir.abspath, cpu_models)
128 parser.parse_isa_desc(source[0].abspath)
129 isa_desc_action = MakeAction(isa_desc_action_func, Transform("ISA DESC", 1))
131 # Also include the CheckerCPU as one of the models if it is being
132 # enabled via command line.
133 isa_desc_builder = Builder(action=isa_desc_action, emitter=isa_desc_emitter)
135 env.Append(BUILDERS = { 'ISADesc' : isa_desc_builder })
138 DebugFlag('FloatRegs')
139 DebugFlag('MiscRegs')
140 CompoundFlag('Registers', [ 'IntRegs', 'FloatRegs', 'MiscRegs' ])