src/arch/SConscript

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