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