SConscript revision 3520
12139SN/A# -*- mode:python -*-
22139SN/A
32139SN/A# Copyright (c) 2006 The Regents of The University of Michigan
42139SN/A# All rights reserved.
52139SN/A#
62139SN/A# Redistribution and use in source and binary forms, with or without
72139SN/A# modification, are permitted provided that the following conditions are
82139SN/A# met: redistributions of source code must retain the above copyright
92139SN/A# notice, this list of conditions and the following disclaimer;
102139SN/A# redistributions in binary form must reproduce the above copyright
112139SN/A# notice, this list of conditions and the following disclaimer in the
122139SN/A# documentation and/or other materials provided with the distribution;
132139SN/A# neither the name of the copyright holders nor the names of its
142139SN/A# contributors may be used to endorse or promote products derived from
152139SN/A# this software without specific prior written permission.
162139SN/A#
172139SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
182139SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
192139SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
202139SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
212139SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
222139SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
232139SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
242139SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
252139SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
262139SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
272139SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
282665Ssaidi@eecs.umich.edu#
292665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
302139SN/A
312718Sstever@eecs.umich.eduimport os.path, sys
322139SN/A
332139SN/A# Import build environment variable from SConstruct.
342139SN/AImport('env')
352139SN/A
362152SN/A# Right now there are no source files immediately in this directory
372152SN/Asources = []
382152SN/A
392152SN/A#################################################################
402139SN/A#
412139SN/A# ISA "switch header" generation.
422139SN/A#
432139SN/A# Auto-generate arch headers that include the right ISA-specific
442139SN/A# header based on the setting of THE_ISA preprocessor variable.
452152SN/A#
462152SN/A#################################################################
472139SN/A
482139SN/A# List of headers to generate
492139SN/Aisa_switch_hdrs = Split('''
502984Sgblack@eecs.umich.edu	arguments.hh
512439SN/A	faults.hh
523520Sgblack@eecs.umich.edu	interrupts.hh
532139SN/A	isa_traits.hh
543170Sstever@eecs.umich.edu        locked_mem.hh
552439SN/A	process.hh
562460SN/A	regfile.hh
572439SN/A	stacktrace.hh
582972Sgblack@eecs.umich.edu	syscallreturn.hh
592171SN/A	tlb.hh
602439SN/A	types.hh
612439SN/A	utility.hh
622170SN/A	vtophys.hh
632139SN/A        ''')
642139SN/A
652139SN/A# Generate the header.  target[0] is the full path of the output
662139SN/A# header to generate.  'source' is a dummy variable, since we get the
672139SN/A# list of ISAs from env['ALL_ISA_LIST'].
682139SN/Adef gen_switch_hdr(target, source, env):
692139SN/A    fname = str(target[0])
702139SN/A    basename = os.path.basename(fname)
712139SN/A    f = open(fname, 'w')
722139SN/A    f.write('#include "arch/isa_specific.hh"\n')
732139SN/A    cond = '#if'
742139SN/A    for isa in env['ALL_ISA_LIST']:
752139SN/A        f.write('%s THE_ISA == %s_ISA\n#include "arch/%s/%s"\n'
762139SN/A                % (cond, isa.upper(), isa, basename))
772139SN/A        cond = '#elif'
782139SN/A    f.write('#else\n#error "THE_ISA not set"\n#endif\n')
792139SN/A    f.close()
802139SN/A    return 0
812139SN/A
822139SN/A# String to print when generating header
832139SN/Adef gen_switch_hdr_string(target, source, env):
842139SN/A    return "Generating ISA switch header " + str(target[0])
852139SN/A
862139SN/A# Build SCons Action object. 'varlist' specifies env vars that this
872178SN/A# action depends on; when env['ALL_ISA_LIST'] changes these actions
882139SN/A# should get re-executed.
892139SN/Aswitch_hdr_action = Action(gen_switch_hdr, gen_switch_hdr_string,
902139SN/A                           varlist=['ALL_ISA_LIST'])
912139SN/A
922139SN/A# Instantiate actions for each header
932139SN/Afor hdr in isa_switch_hdrs:
942139SN/A    env.Command(hdr, [], switch_hdr_action)
952152SN/A
962152SN/A#################################################################
972152SN/A#
982152SN/A# Include architecture-specific files.
992152SN/A#
1002152SN/A#################################################################
1012152SN/A
1022152SN/A#
1032152SN/A# Build a SCons scanner for ISA files
1042152SN/A#
1052152SN/Aimport SCons.Scanner
1062152SN/A
1072504SN/Aisa_scanner = SCons.Scanner.Classic("ISAScan",
1082504SN/A                                    [".isa", ".ISA"],
1092504SN/A                                    "SRCDIR",
1102504SN/A                                    r'^\s*##include\s+"([\w/.-]*)"')
1112152SN/A
1122504SN/Aenv.Append(SCANNERS = isa_scanner)
1132152SN/A
1142152SN/A#
1152152SN/A# Now create a Builder object that uses isa_parser.py to generate C++
1162152SN/A# output from the ISA description (*.isa) files.
1172152SN/A#
1182152SN/A
1192152SN/A# Convert to File node to fix path
1202152SN/Aisa_parser = File('isa_parser.py')
1212632Sstever@eecs.umich.educpu_models_file = File('../cpu/cpu_models.py')
1222155SN/A
1232155SN/A# This sucks in the defintions of the CpuModel objects.
1242155SN/Aexecfile(cpu_models_file.srcnode().abspath)
1252155SN/A
1262155SN/A# Several files are generated from the ISA description.
1272155SN/A# We always get the basic decoder and header file.
1282155SN/Aisa_desc_gen_files = Split('decoder.cc decoder.hh')
1292155SN/A# We also get an execute file for each selected CPU model.
1302155SN/Aisa_desc_gen_files += [CpuModel.dict[cpu].filename
1312155SN/A                       for cpu in env['CPU_MODELS']]
1322152SN/A
1332766Sktlim@umich.edu# Also include the CheckerCPU as one of the models if it is being
1342766Sktlim@umich.edu# enabled via command line.
1352766Sktlim@umich.eduif env['USE_CHECKER']:
1362766Sktlim@umich.edu    isa_desc_gen_files += [CpuModel.dict['CheckerCPU'].filename]
1372766Sktlim@umich.edu
1382152SN/A# The emitter patches up the sources & targets to include the
1392152SN/A# autogenerated files as targets and isa parser itself as a source.
1402152SN/Adef isa_desc_emitter(target, source, env):
1412155SN/A    return (isa_desc_gen_files, [isa_parser, cpu_models_file] + source)
1422152SN/A
1432152SN/A# Pieces are in place, so create the builder.
1442718Sstever@eecs.umich.edupython = sys.executable  # use same Python binary used to run scons
1452921Sktlim@umich.edu
1462921Sktlim@umich.edu# Also include the CheckerCPU as one of the models if it is being
1472921Sktlim@umich.edu# enabled via command line.
1482921Sktlim@umich.eduif env['USE_CHECKER']:
1492921Sktlim@umich.edu    isa_desc_builder = Builder(action=python + ' $SOURCES $TARGET.dir $CPU_MODELS CheckerCPU',
1502921Sktlim@umich.edu                               emitter = isa_desc_emitter)
1512921Sktlim@umich.eduelse:
1522921Sktlim@umich.edu    isa_desc_builder = Builder(action=python + ' $SOURCES $TARGET.dir $CPU_MODELS',
1532921Sktlim@umich.edu                               emitter = isa_desc_emitter)
1542152SN/A
1552152SN/Aenv.Append(BUILDERS = { 'ISADesc' : isa_desc_builder })
1562152SN/A
1572152SN/A#
1582152SN/A# Now include other ISA-specific sources from the ISA subdirectories.
1592152SN/A#
1602152SN/A
1612152SN/Aisa = env['TARGET_ISA'] # someday this may be a list of ISAs
1622152SN/A
1632152SN/A# Let the target architecture define what additional sources it needs
1642667Sstever@eecs.umich.edusources += SConscript(os.path.join(isa, 'SConscript'), exports = 'env')
1652152SN/A
1662152SN/AReturn('sources')
167