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