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         ''')
  50
  51 # Generate the header.  target[0] is the full path of the output
  52 # header to generate.  'source' is a dummy variable, since we get the
  53 # list of ISAs from env['ALL_ISA_LIST'].
  54 def gen_switch_hdr(target, source, env):
  55     fname = str(target[0])
  56     basename = os.path.basename(fname)
  57     f = open(fname, 'w')
  58     f.write('#include "arch/isa_specific.hh"\n')
  59     cond = '#if'
  60     for isa in env['ALL_ISA_LIST']:
  61         f.write('%s THE_ISA == %s_ISA\n#include "arch/%s/%s"\n'
  62                 % (cond, isa.upper(), isa, basename))
  63         cond = '#elif'
  64     f.write('#else\n#error "THE_ISA not set"\n#endif\n')
  65     f.close()
  66     return 0
  67
  68 # String to print when generating header
  69 def gen_switch_hdr_string(target, source, env):
  70     return "Generating ISA switch header " + str(target[0])
  71
  72 # Build SCons Action object. 'varlist' specifies env vars that this
  73 # action depdnds on; when env['ALL_ISA_LIST'] changes these actions
  74 # should get re-executed.
  75 switch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
  76                            varlist=['ALL_ISA_LIST'])
  77
  78 # Instantiate actions for each header
  79 for hdr in isa_switch_hdrs:
  80     env.Command(hdr, [], switch_hdr_action)
  81
  82 #################################################################
  83 #
  84 # Include architecture-specific files.
  85 #
  86 #################################################################
  87
  88 #
  89 # Build a SCons scanner for ISA files
  90 #
  91 import SCons.Scanner
  92
  93 def ISAScan():
  94    return SCons.Scanner.Classic("ISAScan",
  95                                 "$ISASUFFIXES",
  96                                 "SRCDIR",
  97                                 '^[ \t]*##[ \t]*include[ \t]*"([^>"]+)"')
  98
  99 def ISAPath(env, dir, target=None, source=None, a=None):
 100    return (Dir(env['SRCDIR']), Dir('.'))
 101
 102 iscan = Scanner(function = ISAScan().scan, skeys = [".isa", ".ISA"],
 103                 path_function = ISAPath)
 104 env.Append(SCANNERS = iscan)
 105
 106 #
 107 # Now create a Builder object that uses isa_parser.py to generate C++
 108 # output from the ISA description (*.isa) files.
 109 #
 110
 111 # several files are generated from the ISA description
 112 isa_desc_gen_files = Split('''
 113         decoder.cc
 114         alpha_o3_exec.cc
 115         fast_cpu_exec.cc
 116         simple_cpu_exec.cc
 117         full_cpu_exec.cc
 118         decoder.hh
 119         ''')
 120
 121 # Convert to File node to fix path
 122 isa_parser = File('isa_parser.py')
 123
 124 # The emitter patches up the sources & targets to include the
 125 # autogenerated files as targets and isa parser itself as a source.
 126 def isa_desc_emitter(target, source, env):
 127     return (isa_desc_gen_files, [isa_parser] + source)
 128
 129 # Pieces are in place, so create the builder.
 130 isa_desc_builder = Builder(action='${SOURCES[0]} ${SOURCES[1]} $TARGET.dir',
 131                            source_scanner = iscan,
 132                            emitter = isa_desc_emitter)
 133
 134 env.Append(BUILDERS = { 'ISADesc' : isa_desc_builder })
 135
 136 #
 137 # Now include other ISA-specific sources from the ISA subdirectories.
 138 #
 139
 140 isa = env['TARGET_ISA'] # someday this may be a list of ISAs
 141
 142 # Let the target architecture define what additional sources it needs
 143 sources += SConscript(os.path.join(isa, 'SConscript'),
 144                       exports = 'env', duplicate = False)
 145
 146 Return('sources')