SConstruct revision 10238
1955SN/A# -*- mode:python -*-
2955SN/A
39812Sandreas.hansson@arm.com# Copyright (c) 2013 ARM Limited
49812Sandreas.hansson@arm.com# All rights reserved.
59812Sandreas.hansson@arm.com#
69812Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall
79812Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual
89812Sandreas.hansson@arm.com# property including but not limited to intellectual property relating
99812Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software
109812Sandreas.hansson@arm.com# licensed hereunder.  You may use the software subject to the license
119812Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated
129812Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software,
139812Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form.
149812Sandreas.hansson@arm.com#
157816Ssteve.reinhardt@amd.com# Copyright (c) 2011 Advanced Micro Devices, Inc.
165871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
171762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
18955SN/A# All rights reserved.
19955SN/A#
20955SN/A# Redistribution and use in source and binary forms, with or without
21955SN/A# modification, are permitted provided that the following conditions are
22955SN/A# met: redistributions of source code must retain the above copyright
23955SN/A# notice, this list of conditions and the following disclaimer;
24955SN/A# redistributions in binary form must reproduce the above copyright
25955SN/A# notice, this list of conditions and the following disclaimer in the
26955SN/A# documentation and/or other materials provided with the distribution;
27955SN/A# neither the name of the copyright holders nor the names of its
28955SN/A# contributors may be used to endorse or promote products derived from
29955SN/A# this software without specific prior written permission.
30955SN/A#
31955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
422665Ssaidi@eecs.umich.edu#
432665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
445863Snate@binkert.org#          Nathan Binkert
45955SN/A
46955SN/A###################################################
47955SN/A#
48955SN/A# SCons top-level build description (SConstruct) file.
49955SN/A#
508878Ssteve.reinhardt@amd.com# While in this directory ('gem5'), just type 'scons' to build the default
512632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
528878Ssteve.reinhardt@amd.com# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
532632Sstever@eecs.umich.edu# the optimized full-system version).
54955SN/A#
558878Ssteve.reinhardt@amd.com# You can build gem5 in a different directory as long as there is a
562632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
572761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being
582632Sstever@eecs.umich.edu# built for the same host system.
592632Sstever@eecs.umich.edu#
602632Sstever@eecs.umich.edu# Examples:
612761Sstever@eecs.umich.edu#
622761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
632761Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
648878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
658878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
662761Sstever@eecs.umich.edu#
672761Sstever@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
682761Sstever@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
692761Sstever@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
702761Sstever@eecs.umich.edu#   file.
718878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
728878Ssteve.reinhardt@amd.com#   % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
732632Sstever@eecs.umich.edu#
742632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
758878Ssteve.reinhardt@amd.com# 'gem5' directory (or use -u or -C to tell scons where to find this
768878Ssteve.reinhardt@amd.com# file), you can use 'scons -h' to print all the gem5-specific build
772632Sstever@eecs.umich.edu# options as well.
78955SN/A#
79955SN/A###################################################
80955SN/A
815863Snate@binkert.org# Check for recent-enough Python and SCons versions.
825863Snate@binkert.orgtry:
835863Snate@binkert.org    # Really old versions of scons only take two options for the
845863Snate@binkert.org    # function, so check once without the revision and once with the
855863Snate@binkert.org    # revision, the first instance will fail for stuff other than
865863Snate@binkert.org    # 0.98, and the second will fail for 0.98.0
875863Snate@binkert.org    EnsureSConsVersion(0, 98)
885863Snate@binkert.org    EnsureSConsVersion(0, 98, 1)
895863Snate@binkert.orgexcept SystemExit, e:
905863Snate@binkert.org    print """
915863Snate@binkert.orgFor more details, see:
928878Ssteve.reinhardt@amd.com    http://gem5.org/Dependencies
935863Snate@binkert.org"""
945863Snate@binkert.org    raise
955863Snate@binkert.org
969812Sandreas.hansson@arm.com# We ensure the python version early because because python-config
979812Sandreas.hansson@arm.com# requires python 2.5
985863Snate@binkert.orgtry:
999812Sandreas.hansson@arm.com    EnsurePythonVersion(2, 5)
1005863Snate@binkert.orgexcept SystemExit, e:
1015863Snate@binkert.org    print """
1025863Snate@binkert.orgYou can use a non-default installation of the Python interpreter by
1039812Sandreas.hansson@arm.comrearranging your PATH so that scons finds the non-default 'python' and
1049812Sandreas.hansson@arm.com'python-config' first.
1055863Snate@binkert.org
1065863Snate@binkert.orgFor more details, see:
1078878Ssteve.reinhardt@amd.com    http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
1085863Snate@binkert.org"""
1095863Snate@binkert.org    raise
1105863Snate@binkert.org
1116654Snate@binkert.org# Global Python includes
112955SN/Aimport itertools
1135396Ssaidi@eecs.umich.eduimport os
1145863Snate@binkert.orgimport re
1155863Snate@binkert.orgimport subprocess
1164202Sbinkertn@umich.eduimport sys
1175863Snate@binkert.org
1185863Snate@binkert.orgfrom os import mkdir, environ
1195863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
1205863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
121955SN/Afrom os.path import join as joinpath, split as splitpath
1226654Snate@binkert.org
1235273Sstever@gmail.com# SCons includes
1245871Snate@binkert.orgimport SCons
1255273Sstever@gmail.comimport SCons.Node
1266655Snate@binkert.org
1278878Ssteve.reinhardt@amd.comextra_python_paths = [
1286655Snate@binkert.org    Dir('src/python').srcnode().abspath, # gem5 includes
1296655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1309219Spower.jg@gmail.com    ]
1316655Snate@binkert.org
1325871Snate@binkert.orgsys.path[1:1] = extra_python_paths
1336654Snate@binkert.org
1348947Sandreas.hansson@arm.comfrom m5.util import compareVersions, readCommand
1355396Ssaidi@eecs.umich.edufrom m5.util.terminal import get_termcap
1368120Sgblack@eecs.umich.edu
1378120Sgblack@eecs.umich.eduhelp_texts = {
1388120Sgblack@eecs.umich.edu    "options" : "",
1398120Sgblack@eecs.umich.edu    "global_vars" : "",
1408120Sgblack@eecs.umich.edu    "local_vars" : ""
1418120Sgblack@eecs.umich.edu}
1428120Sgblack@eecs.umich.edu
1438120Sgblack@eecs.umich.eduExport("help_texts")
1448879Ssteve.reinhardt@amd.com
1458879Ssteve.reinhardt@amd.com
1468879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from
1478879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h'
1488879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the
1498879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once
1508879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get
1518879Ssteve.reinhardt@amd.com# at the help texts from AddOptions.  See:
1528879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1538879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1548879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and
1558879Ssteve.reinhardt@amd.com# re-inject it via Help().  Ideally someday this bug will be fixed and
1568879Ssteve.reinhardt@amd.com# we can just use AddOption directly.
1578120Sgblack@eecs.umich.edudef AddLocalOption(*args, **kwargs):
1588120Sgblack@eecs.umich.edu    col_width = 30
1598120Sgblack@eecs.umich.edu
1608120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1618120Sgblack@eecs.umich.edu    if "help" in kwargs:
1628120Sgblack@eecs.umich.edu        length = len(help)
1638120Sgblack@eecs.umich.edu        if length >= col_width:
1648120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1658120Sgblack@eecs.umich.edu        else:
1668120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1678120Sgblack@eecs.umich.edu        help += kwargs["help"]
1688120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1698120Sgblack@eecs.umich.edu
1708120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1718879Ssteve.reinhardt@amd.com
1728879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true',
1738879Ssteve.reinhardt@amd.com               help="Add color to abbreviated scons output")
1748879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1758879Ssteve.reinhardt@amd.com               help="Don't add color to abbreviated scons output")
1768879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1778879Ssteve.reinhardt@amd.com               help='Override which build_opts file to use for defaults')
1788879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1799227Sandreas.hansson@arm.com               help='Disable style checking hooks')
1809227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1818879Ssteve.reinhardt@amd.com               help='Disable Link-Time Optimization for fast')
1828879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1838879Ssteve.reinhardt@amd.com               help='Update test reference outputs')
1848879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1858120Sgblack@eecs.umich.edu               help='Print full tool command lines')
1868947Sandreas.hansson@arm.com
1877816Ssteve.reinhardt@amd.comtermcap = get_termcap(GetOption('use_colors'))
1885871Snate@binkert.org
1895871Snate@binkert.org########################################################################
1906121Snate@binkert.org#
1915871Snate@binkert.org# Set up the main build environment.
1925871Snate@binkert.org#
1939926Sstan.czerniawski@arm.com########################################################################
1949926Sstan.czerniawski@arm.com
1959119Sandreas.hansson@arm.com# export TERM so that clang reports errors in color
19610068Sandreas.hansson@arm.comuse_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
19710068Sandreas.hansson@arm.com                 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
198955SN/A                 'PYTHONPATH', 'RANLIB', 'SWIG', 'TERM' ])
1999416SAndreas.Sandberg@ARM.com
2009416SAndreas.Sandberg@ARM.comuse_prefixes = [
2019416SAndreas.Sandberg@ARM.com    "M5",           # M5 configuration (e.g., path to kernels)
2029416SAndreas.Sandberg@ARM.com    "DISTCC_",      # distcc (distributed compiler wrapper) configuration
2039416SAndreas.Sandberg@ARM.com    "CCACHE_",      # ccache (caching compiler wrapper) configuration
2049416SAndreas.Sandberg@ARM.com    "CCC_",         # clang static analyzer configuration
2059416SAndreas.Sandberg@ARM.com    ]
2065871Snate@binkert.org
2075871Snate@binkert.orguse_env = {}
2089416SAndreas.Sandberg@ARM.comfor key,val in os.environ.iteritems():
2099416SAndreas.Sandberg@ARM.com    if key in use_vars or \
2105871Snate@binkert.org            any([key.startswith(prefix) for prefix in use_prefixes]):
211955SN/A        use_env[key] = val
2126121Snate@binkert.org
2138881Smarc.orr@gmail.commain = Environment(ENV=use_env)
2146121Snate@binkert.orgmain.Decider('MD5-timestamp')
2156121Snate@binkert.orgmain.root = Dir(".")         # The current directory (where this file lives).
2161533SN/Amain.srcdir = Dir("src")     # The source directory
2179239Sandreas.hansson@arm.com
2189239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys()
2199239Sandreas.hansson@arm.com
2209239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler
2219239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
2229239Sandreas.hansson@arm.com    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
2239239Sandreas.hansson@arm.com    Exit(1)
2249239Sandreas.hansson@arm.com
2259239Sandreas.hansson@arm.com# Check that swig is present
2269239Sandreas.hansson@arm.comif not 'SWIG' in main_dict_keys:
2279239Sandreas.hansson@arm.com    print "swig is not installed (package swig on Ubuntu and RedHat)"
2289239Sandreas.hansson@arm.com    Exit(1)
2296655Snate@binkert.org
2306655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
2316655Snate@binkert.org# as well
2326655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
2335871Snate@binkert.org
2345871Snate@binkert.org########################################################################
2355863Snate@binkert.org#
2365871Snate@binkert.org# Mercurial Stuff.
2378878Ssteve.reinhardt@amd.com#
2385871Snate@binkert.org# If the gem5 directory is a mercurial repository, we should do some
2395871Snate@binkert.org# extra things.
2405871Snate@binkert.org#
2415863Snate@binkert.org########################################################################
2426121Snate@binkert.org
2435863Snate@binkert.orghgdir = main.root.Dir(".hg")
2445871Snate@binkert.org
2458336Ssteve.reinhardt@amd.commercurial_style_message = """
2468336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
2478336Ssteve.reinhardt@amd.comagainst the gem5 style rules on hg commit and qrefresh commands.  This
2488336Ssteve.reinhardt@amd.comscript will now install the hook in your .hg/hgrc file.
2494678Snate@binkert.orgPress enter to continue, or ctrl-c to abort: """
2508336Ssteve.reinhardt@amd.com
2518336Ssteve.reinhardt@amd.commercurial_style_hook = """
2528336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2534678Snate@binkert.org# to provide the gem5 style-checking hooks
2544678Snate@binkert.org[extensions]
2554678Snate@binkert.orgstyle = %s/util/style.py
2564678Snate@binkert.org
2577827Snate@binkert.org[hooks]
2587827Snate@binkert.orgpretxncommit.style = python:style.check_style
2598336Ssteve.reinhardt@amd.compre-qrefresh.style = python:style.check_style
2604678Snate@binkert.org# End of SConstruct additions
2618336Ssteve.reinhardt@amd.com
2628336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2638336Ssteve.reinhardt@amd.com
2648336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2658336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2668336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2675871Snate@binkert.orghook. It is important.
2685871Snate@binkert.org"""
2698336Ssteve.reinhardt@amd.com
2708336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
2718336Ssteve.reinhardt@amd.com# Skip this if --ignore-style was specified, there's no .hg dir to
2728336Ssteve.reinhardt@amd.com# install a hook in, or there's no interactive terminal to prompt.
2738336Ssteve.reinhardt@amd.comif not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
2745871Snate@binkert.org    style_hook = True
2758336Ssteve.reinhardt@amd.com    try:
2768336Ssteve.reinhardt@amd.com        from mercurial import ui
2778336Ssteve.reinhardt@amd.com        ui = ui.ui()
2788336Ssteve.reinhardt@amd.com        ui.readconfig(hgdir.File('hgrc').abspath)
2798336Ssteve.reinhardt@amd.com        style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
2804678Snate@binkert.org                     ui.config('hooks', 'pre-qrefresh.style', None)
2815871Snate@binkert.org    except ImportError:
2824678Snate@binkert.org        print mercurial_lib_not_found
2838336Ssteve.reinhardt@amd.com
2848336Ssteve.reinhardt@amd.com    if not style_hook:
2858336Ssteve.reinhardt@amd.com        print mercurial_style_message,
2868336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
2878336Ssteve.reinhardt@amd.com        try:
2888336Ssteve.reinhardt@amd.com            raw_input()
2898336Ssteve.reinhardt@amd.com        except:
2908336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
2918336Ssteve.reinhardt@amd.com            sys.exit(1)
2928336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
2938336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
2948336Ssteve.reinhardt@amd.com        try:
2958336Ssteve.reinhardt@amd.com            hgrc = open(hgrc_path, 'a')
2968336Ssteve.reinhardt@amd.com            hgrc.write(mercurial_style_hook)
2978336Ssteve.reinhardt@amd.com            hgrc.close()
2988336Ssteve.reinhardt@amd.com        except:
2998336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
3005871Snate@binkert.org            sys.exit(1)
3016121Snate@binkert.org
302955SN/A
303955SN/A###################################################
3042632Sstever@eecs.umich.edu#
3052632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
306955SN/A# the target(s).
307955SN/A#
308955SN/A###################################################
309955SN/A
3108878Ssteve.reinhardt@amd.com# Find default configuration & binary.
311955SN/ADefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
3122632Sstever@eecs.umich.edu
3132632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
3142632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
3152632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
3162632Sstever@eecs.umich.edu        if l[i] == elt:
3172632Sstever@eecs.umich.edu            return i
3182632Sstever@eecs.umich.edu    raise ValueError, "element not found"
3198268Ssteve.reinhardt@amd.com
3208268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
3218268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
3228268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
3238268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
3248268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
3258268Ssteve.reinhardt@amd.com            for p in path_list]
3262632Sstever@eecs.umich.edu
3272632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
3282632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
3292632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
3308268Ssteve.reinhardt@amd.com# recognize that ALPHA_SE specifies the configuration because it
3312632Sstever@eecs.umich.edu# follow 'build' in the build path.
3328268Ssteve.reinhardt@amd.com
3338268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
3348268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
3358268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
3363718Sstever@eecs.umich.eduBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
3372634Sstever@eecs.umich.edu
3382634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
3395863Snate@binkert.org# collected targets reference.
3402638Sstever@eecs.umich.eduvariant_paths = []
3418268Ssteve.reinhardt@amd.combuild_root = None
3422632Sstever@eecs.umich.edufor t in BUILD_TARGETS:
3432632Sstever@eecs.umich.edu    path_dirs = t.split('/')
3442632Sstever@eecs.umich.edu    try:
3452632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
3462632Sstever@eecs.umich.edu    except:
3471858SN/A        print "Error: no non-leaf 'build' dir found on target path", t
3483716Sstever@eecs.umich.edu        Exit(1)
3492638Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
3502638Sstever@eecs.umich.edu    if not build_root:
3512638Sstever@eecs.umich.edu        build_root = this_build_root
3522638Sstever@eecs.umich.edu    else:
3532638Sstever@eecs.umich.edu        if this_build_root != build_root:
3542638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
3552638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
3565863Snate@binkert.org            Exit(1)
3575863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
3585863Snate@binkert.org    if variant_path not in variant_paths:
359955SN/A        variant_paths.append(variant_path)
3605341Sstever@gmail.com
3615341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
3625863Snate@binkert.orgif not isdir(build_root):
3637756SAli.Saidi@ARM.com    mkdir(build_root)
3645341Sstever@gmail.commain['BUILDROOT'] = build_root
3656121Snate@binkert.org
3664494Ssaidi@eecs.umich.eduExport('main')
3676121Snate@binkert.org
3681105SN/Amain.SConsignFile(joinpath(build_root, "sconsign"))
3692667Sstever@eecs.umich.edu
3702667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
3712667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
3722667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
3736121Snate@binkert.org# (soft) links work better.
3742667Sstever@eecs.umich.edumain.SetOption('duplicate', 'soft-copy')
3755341Sstever@gmail.com
3765863Snate@binkert.org#
3775341Sstever@gmail.com# Set up global sticky variables... these are common to an entire build
3785341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
3795341Sstever@gmail.com#
3808120Sgblack@eecs.umich.edu
3815341Sstever@gmail.comglobal_vars_file = joinpath(build_root, 'variables.global')
3828120Sgblack@eecs.umich.edu
3835341Sstever@gmail.comglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
3848120Sgblack@eecs.umich.edu
3856121Snate@binkert.orgglobal_vars.AddVariables(
3866121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
3878980Ssteve.reinhardt@amd.com    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
3889396Sandreas.hansson@arm.com    ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
3895397Ssaidi@eecs.umich.edu    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
3905397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
3917727SAli.Saidi@ARM.com    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
3928268Ssteve.reinhardt@amd.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
3936168Snate@binkert.org    ('EXTRAS', 'Add extra directories to the compilation', '')
3945341Sstever@gmail.com    )
3958120Sgblack@eecs.umich.edu
3968120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
3978120Sgblack@eecs.umich.eduglobal_vars.Update(main)
3986814Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
3995863Snate@binkert.org
4008120Sgblack@eecs.umich.edu# Save sticky variable settings back to current variables file
4015341Sstever@gmail.comglobal_vars.Save(global_vars_file, main)
4025863Snate@binkert.org
4038268Ssteve.reinhardt@amd.com# Parse EXTRAS variable to build list of all directories where we're
4046121Snate@binkert.org# look for sources etc.  This list is exported as extras_dir_list.
4056121Snate@binkert.orgbase_dir = main.srcdir.abspath
4068268Ssteve.reinhardt@amd.comif main['EXTRAS']:
4075742Snate@binkert.org    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4085742Snate@binkert.orgelse:
4095341Sstever@gmail.com    extras_dir_list = []
4105742Snate@binkert.org
4115742Snate@binkert.orgExport('base_dir')
4125341Sstever@gmail.comExport('extras_dir_list')
4136017Snate@binkert.org
4146121Snate@binkert.org# the ext directory should be on the #includes path
4156017Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
4167816Ssteve.reinhardt@amd.com
4177756SAli.Saidi@ARM.comdef strip_build_path(path, env):
4187756SAli.Saidi@ARM.com    path = str(path)
4197756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
4207756SAli.Saidi@ARM.com    if path.startswith(variant_base):
4217756SAli.Saidi@ARM.com        path = path[len(variant_base):]
4227756SAli.Saidi@ARM.com    elif path.startswith('build/'):
4237756SAli.Saidi@ARM.com        path = path[6:]
4247756SAli.Saidi@ARM.com    return path
4257816Ssteve.reinhardt@amd.com
4267816Ssteve.reinhardt@amd.com# Generate a string of the form:
4277816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
4287816Ssteve.reinhardt@amd.com# to print while building.
4297816Ssteve.reinhardt@amd.comclass Transform(object):
4307816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
4317816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
4327816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
4337816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
4347816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
4357756SAli.Saidi@ARM.com    tgts_color = termcap.Yellow + termcap.Bold
4367816Ssteve.reinhardt@amd.com
4377816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
4387816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
4397816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
4407816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
4417816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
4427816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
4437816Ssteve.reinhardt@amd.com                      + termcap.Normal
4447816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
4457816Ssteve.reinhardt@amd.com
4467816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
4477816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
4487816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
4497816Ssteve.reinhardt@amd.com        def strip(f):
4507816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
4517816Ssteve.reinhardt@amd.com        if len(source) > 0:
4527816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
4537816Ssteve.reinhardt@amd.com        else:
4547816Ssteve.reinhardt@amd.com            srcs = ['']
4557816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
4567816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
4577816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
4587816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
4597816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4607816Ssteve.reinhardt@amd.com        if com_pfx:
4617816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
4627816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
4637816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
4647816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
4657816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
4667816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
4677816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
4687816Ssteve.reinhardt@amd.com                pass
4697816Ssteve.reinhardt@amd.com            else:
4707816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
4717816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
4727816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
4737816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
4747816Ssteve.reinhardt@amd.com                    pass
4757816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
4767816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
4777816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
4787816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
4797816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
4807816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
4817816Ssteve.reinhardt@amd.com                    else:
4827816Ssteve.reinhardt@amd.com                        com_pfx = ''
4837816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
4847816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
4857816Ssteve.reinhardt@amd.com                    pass
4867816Ssteve.reinhardt@amd.com                else:
4877816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
4887816Ssteve.reinhardt@amd.com                    com_pfx = ''
4897816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
4907816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
4917816Ssteve.reinhardt@amd.com        def fmt(files):
4927816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
4937816Ssteve.reinhardt@amd.com            return ', '.join(f)
4947816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
4957816Ssteve.reinhardt@amd.com
4967816Ssteve.reinhardt@amd.comExport('Transform')
4978947Sandreas.hansson@arm.com
4988947Sandreas.hansson@arm.com# enable the regression script to use the termcap
4997756SAli.Saidi@ARM.commain['TERMCAP'] = termcap
5008120Sgblack@eecs.umich.edu
5017756SAli.Saidi@ARM.comif GetOption('verbose'):
5027756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
5037756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
5047756SAli.Saidi@ARM.comelse:
5057816Ssteve.reinhardt@amd.com    MakeAction = Action
5067816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
5077816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
5087816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
5097816Ssteve.reinhardt@amd.com    main['SWIGCOMSTR']      = Transform("SWIG")
5107816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
5117816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
5127816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
5137816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
5147816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
5157756SAli.Saidi@ARM.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
5167756SAli.Saidi@ARM.comExport('MakeAction')
5179227Sandreas.hansson@arm.com
5189227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
5199227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
5209227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
5219590Sandreas@sandberg.pp.se
5229590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
5239590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
5249590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
5259590Sandreas@sandberg.pp.se# compiler we're using.
5269590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
5276654Snate@binkert.org
5286654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
5295871Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
5306121Snate@binkert.org
5318946Sandreas.hansson@arm.commain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
5329419Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
5333940Ssaidi@eecs.umich.eduif main['GCC'] + main['CLANG'] > 1:
5343918Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
5353918Ssaidi@eecs.umich.edu    Exit(1)
5361858SN/A
5379556Sandreas.hansson@arm.com# Set up default C++ compiler flags
5389556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
5399556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
5409556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
5419556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
5429556Sandreas.hansson@arm.com    # Enable -Wall and then disable the few warnings that we
5439556Sandreas.hansson@arm.com    # consistently violate
5449556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
5459556Sandreas.hansson@arm.com    # We always compile using C++11, but only gcc >= 4.7 and clang 3.1
5469556Sandreas.hansson@arm.com    # actually use that name, so we stick with c++0x
5479556Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++0x'])
5489556Sandreas.hansson@arm.com    # Add selected sanity checks from -Wextra
5499556Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-Wmissing-field-initializers',
5509556Sandreas.hansson@arm.com                          '-Woverloaded-virtual'])
5519556Sandreas.hansson@arm.comelse:
5529556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
5539556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
5549556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
5559556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
5569556Sandreas.hansson@arm.com    if not CXX_version:
5579556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
5589556Sandreas.hansson@arm.com               termcap.Normal
5599556Sandreas.hansson@arm.com    else:
5609556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
5619556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
5629556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
5639556Sandreas.hansson@arm.com    print "       environment."
5649556Sandreas.hansson@arm.com    print "       "
5659556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
5669556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
5679556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
5689556Sandreas.hansson@arm.com    Exit(1)
5696121Snate@binkert.org
5709420Sandreas.hansson@arm.comif main['GCC']:
5719420Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.6 is chosen for its
5729420Sandreas.hansson@arm.com    # level of c++11 support. See
5739420Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details. 4.6 is also
5749420Sandreas.hansson@arm.com    # the first version with proper LTO support.
5759420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
5769420Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.6") < 0:
5779420Sandreas.hansson@arm.com        print 'Error: gcc version 4.6 or newer required.'
5789420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
5799420Sandreas.hansson@arm.com        Exit(1)
5809420Sandreas.hansson@arm.com
5817618SAli.Saidi@arm.com    main['GCC_VERSION'] = gcc_version
5827618SAli.Saidi@arm.com
5837618SAli.Saidi@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
5847739Sgblack@eecs.umich.edu    # unless LTO is explicitly turned off. Note that these flags
5859227Sandreas.hansson@arm.com    # are only used by the fast target.
5869227Sandreas.hansson@arm.com    if not GetOption('no_lto'):
5879227Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
5889227Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
5899227Sandreas.hansson@arm.com        # them later/
5909227Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
5919227Sandreas.hansson@arm.com
5929227Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
5939227Sandreas.hansson@arm.com        # scons with, we hardcode the use of the linker plugin
5949227Sandreas.hansson@arm.com        # which requires either gold or GNU ld >= 2.21
5959227Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
5969227Sandreas.hansson@arm.com                               '-fuse-linker-plugin']
5979227Sandreas.hansson@arm.com
5989227Sandreas.hansson@arm.com    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
5999227Sandreas.hansson@arm.com                                  '-fno-builtin-realloc', '-fno-builtin-free'])
6009227Sandreas.hansson@arm.com
6019227Sandreas.hansson@arm.comelif main['CLANG']:
6029227Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.0 is needed to
6039590Sandreas@sandberg.pp.se    # support similar features as gcc 4.6. See
6049590Sandreas@sandberg.pp.se    # http://clang.llvm.org/cxx_status.html for details
6059590Sandreas@sandberg.pp.se    clang_version_re = re.compile(".* version (\d+\.\d+)")
6068737Skoansin.tan@gmail.com    clang_version_match = clang_version_re.search(CXX_version)
6079420Sandreas.hansson@arm.com    if (clang_version_match):
6089420Sandreas.hansson@arm.com        clang_version = clang_version_match.groups()[0]
6099420Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.0") < 0:
6108737Skoansin.tan@gmail.com            print 'Error: clang version 3.0 or newer required.'
61110106SMitch.Hayenga@arm.com            print '       Installed version:', clang_version
6128737Skoansin.tan@gmail.com            Exit(1)
6138737Skoansin.tan@gmail.com    else:
6148737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
6158737Skoansin.tan@gmail.com        Exit(1)
6168737Skoansin.tan@gmail.com
6178737Skoansin.tan@gmail.com    # clang has a few additional warnings that we disable,
6188737Skoansin.tan@gmail.com    # tautological comparisons are allowed due to unsigned integers
6198737Skoansin.tan@gmail.com    # being compared to constants that happen to be 0, and extraneous
6208737Skoansin.tan@gmail.com    # parantheses are allowed due to Ruby's printing of the AST,
6218737Skoansin.tan@gmail.com    # finally self assignments are allowed as the generated CPU code
6229556Sandreas.hansson@arm.com    # is relying on this
6239556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-tautological-compare',
6249556Sandreas.hansson@arm.com                         '-Wno-parentheses',
6259556Sandreas.hansson@arm.com                         '-Wno-self-assign'])
6269556Sandreas.hansson@arm.com
6279556Sandreas.hansson@arm.com    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
6289556Sandreas.hansson@arm.com
6299556Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
6309556Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
6319556Sandreas.hansson@arm.com    if sys.platform == "darwin":
6329590Sandreas@sandberg.pp.se        main.Append(CXXFLAGS=['-stdlib=libc++'])
6339590Sandreas@sandberg.pp.se        main.Append(LIBS=['c++'])
6349420Sandreas.hansson@arm.com
6359846Sandreas.hansson@arm.comelse:
6369846Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6379846Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
6389846Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6398946Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
6403918Ssaidi@eecs.umich.edu    if not CXX_version:
6419068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6429068SAli.Saidi@ARM.com               termcap.Normal
6439068SAli.Saidi@ARM.com    else:
6449068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
6459068SAli.Saidi@ARM.com    print "       If you're trying to use a compiler other than GCC"
6469068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
6479068SAli.Saidi@ARM.com    print "       environment."
6489068SAli.Saidi@ARM.com    print "       "
6499068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
6509419Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
6519068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
6529068SAli.Saidi@ARM.com    Exit(1)
6539068SAli.Saidi@ARM.com
6549068SAli.Saidi@ARM.com# Set up common yacc/bison flags (needed for Ruby)
6559068SAli.Saidi@ARM.commain['YACCFLAGS'] = '-d'
6569068SAli.Saidi@ARM.commain['YACCHXXFILESUFFIX'] = '.hh'
6573918Ssaidi@eecs.umich.edu
6583918Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
6596157Snate@binkert.org# extra 'qdo' every time we run scons.
6606157Snate@binkert.orgif main['BATCH']:
6616157Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
6626157Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
6635397Ssaidi@eecs.umich.edu    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
6645397Ssaidi@eecs.umich.edu    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
6656121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
6666121Snate@binkert.org
6676121Snate@binkert.orgif sys.platform == 'cygwin':
6686121Snate@binkert.org    # cygwin has some header file issues...
6696121Snate@binkert.org    main.Append(CCFLAGS=["-Wno-uninitialized"])
6706121Snate@binkert.org
6715397Ssaidi@eecs.umich.edu# Check for the protobuf compiler
6721851SN/Aprotoc_version = readCommand([main['PROTOC'], '--version'],
6731851SN/A                             exception='').split()
6747739Sgblack@eecs.umich.edu
675955SN/A# First two words should be "libprotoc x.y.z"
6769396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
6779396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
6789396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
6799396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
6809396Sandreas.hansson@arm.com        termcap.Normal
6819396Sandreas.hansson@arm.com    main['PROTOC'] = False
6829396Sandreas.hansson@arm.comelse:
6839396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
6849396Sandreas.hansson@arm.com    # require 2.1.0
6859396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
6869396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
6879396Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
6889396Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
6899396Sandreas.hansson@arm.com            'or newer required.\n' + \
6909396Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
6919396Sandreas.hansson@arm.com            termcap.Normal
6929477Sandreas.hansson@arm.com        main['PROTOC'] = False
6939477Sandreas.hansson@arm.com    else:
6949477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
6959477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
6969477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
6979477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
6989477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
6999477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
7009477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
7019477Sandreas.hansson@arm.com            try:
7029477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
7039477Sandreas.hansson@arm.com                # using pkg-config
7049477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
7059477Sandreas.hansson@arm.com            except:
7069477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
7079477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
7089477Sandreas.hansson@arm.com                    termcap.Normal
7099477Sandreas.hansson@arm.com
7109477Sandreas.hansson@arm.com# Check for SWIG
7119477Sandreas.hansson@arm.comif not main.has_key('SWIG'):
7129477Sandreas.hansson@arm.com    print 'Error: SWIG utility not found.'
7139477Sandreas.hansson@arm.com    print '       Please install (see http://www.swig.org) and retry.'
7149396Sandreas.hansson@arm.com    Exit(1)
7153053Sstever@eecs.umich.edu
7166121Snate@binkert.org# Check for appropriate SWIG version
7173053Sstever@eecs.umich.eduswig_version = readCommand([main['SWIG'], '-version'], exception='').split()
7183053Sstever@eecs.umich.edu# First 3 words should be "SWIG Version x.y.z"
7193053Sstever@eecs.umich.eduif len(swig_version) < 3 or \
7203053Sstever@eecs.umich.edu        swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
7213053Sstever@eecs.umich.edu    print 'Error determining SWIG version.'
7229072Sandreas.hansson@arm.com    Exit(1)
7233053Sstever@eecs.umich.edu
7244742Sstever@eecs.umich.edumin_swig_version = '2.0.4'
7254742Sstever@eecs.umich.eduif compareVersions(swig_version[2], min_swig_version) < 0:
7263053Sstever@eecs.umich.edu    print 'Error: SWIG version', min_swig_version, 'or newer required.'
7273053Sstever@eecs.umich.edu    print '       Installed version:', swig_version[2]
7283053Sstever@eecs.umich.edu    Exit(1)
7298960Ssteve.reinhardt@amd.com
7306654Snate@binkert.org# Set up SWIG flags & scanner
7313053Sstever@eecs.umich.eduswig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
7323053Sstever@eecs.umich.edumain.Append(SWIGFLAGS=swig_flags)
7333053Sstever@eecs.umich.edu
7343053Sstever@eecs.umich.edu# filter out all existing swig scanners, they mess up the dependency
7359877Sandreas.hansson@arm.com# stuff for some reason
7369877Sandreas.hansson@arm.comscanners = []
7379877Sandreas.hansson@arm.comfor scanner in main['SCANNERS']:
7389877Sandreas.hansson@arm.com    skeys = scanner.skeys
7399877Sandreas.hansson@arm.com    if skeys == '.i':
7409585Sandreas@sandberg.pp.se        continue
7419877Sandreas.hansson@arm.com
7429585Sandreas@sandberg.pp.se    if isinstance(skeys, (list, tuple)) and '.i' in skeys:
7439877Sandreas.hansson@arm.com        continue
7449877Sandreas.hansson@arm.com
7459585Sandreas@sandberg.pp.se    scanners.append(scanner)
7462667Sstever@eecs.umich.edu
7474554Sbinkertn@umich.edu# add the new swig scanner that we like better
7486121Snate@binkert.orgfrom SCons.Scanner import ClassicCPP as CPPScanner
7492667Sstever@eecs.umich.eduswig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
7504554Sbinkertn@umich.eduscanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
7514554Sbinkertn@umich.edu
7524554Sbinkertn@umich.edu# replace the scanners list that has what we want
7536121Snate@binkert.orgmain['SCANNERS'] = scanners
7544554Sbinkertn@umich.edu
7554554Sbinkertn@umich.edu# Add a custom Check function to the Configure context so that we can
7564554Sbinkertn@umich.edu# figure out if the compiler adds leading underscores to global
7574781Snate@binkert.org# variables.  This is needed for the autogenerated asm files that we
7584554Sbinkertn@umich.edu# use for embedding the python code.
7594554Sbinkertn@umich.edudef CheckLeading(context):
7602667Sstever@eecs.umich.edu    context.Message("Checking for leading underscore in global variables...")
7614554Sbinkertn@umich.edu    # 1) Define a global variable called x from asm so the C compiler
7624554Sbinkertn@umich.edu    #    won't change the symbol at all.
7634554Sbinkertn@umich.edu    # 2) Declare that variable.
7644554Sbinkertn@umich.edu    # 3) Use the variable
7652667Sstever@eecs.umich.edu    #
7664554Sbinkertn@umich.edu    # If the compiler prepends an underscore, this will successfully
7672667Sstever@eecs.umich.edu    # link because the external symbol 'x' will be called '_x' which
7684554Sbinkertn@umich.edu    # was defined by the asm statement.  If the compiler does not
7696121Snate@binkert.org    # prepend an underscore, this will not successfully link because
7702667Sstever@eecs.umich.edu    # '_x' will have been defined by assembly, while the C portion of
7715522Snate@binkert.org    # the code will be trying to use 'x'
7725522Snate@binkert.org    ret = context.TryLink('''
7735522Snate@binkert.org        asm(".globl _x; _x: .byte 0");
7745522Snate@binkert.org        extern int x;
7755522Snate@binkert.org        int main() { return x; }
7765522Snate@binkert.org        ''', extension=".c")
7775522Snate@binkert.org    context.env.Append(LEADING_UNDERSCORE=ret)
7785522Snate@binkert.org    context.Result(ret)
7795522Snate@binkert.org    return ret
7805522Snate@binkert.org
7815522Snate@binkert.org# Add a custom Check function to test for structure members.
7825522Snate@binkert.orgdef CheckMember(context, include, decl, member, include_quotes="<>"):
7835522Snate@binkert.org    context.Message("Checking for member %s in %s..." %
7845522Snate@binkert.org                    (member, decl))
7855522Snate@binkert.org    text = """
7865522Snate@binkert.org#include %(header)s
7875522Snate@binkert.orgint main(){
7885522Snate@binkert.org  %(decl)s test;
7895522Snate@binkert.org  (void)test.%(member)s;
7905522Snate@binkert.org  return 0;
7915522Snate@binkert.org};
7925522Snate@binkert.org""" % { "header" : include_quotes[0] + include + include_quotes[1],
7935522Snate@binkert.org        "decl" : decl,
7945522Snate@binkert.org        "member" : member,
7955522Snate@binkert.org        }
7965522Snate@binkert.org
7979986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
7989986Sandreas@sandberg.pp.se    context.Result(ret)
7999986Sandreas@sandberg.pp.se    return ret
8009986Sandreas@sandberg.pp.se
8019986Sandreas@sandberg.pp.se# Platform-specific configuration.  Note again that we assume that all
8029986Sandreas@sandberg.pp.se# builds under a given build root run on the same host platform.
8039986Sandreas@sandberg.pp.seconf = Configure(main,
8049986Sandreas@sandberg.pp.se                 conf_dir = joinpath(build_root, '.scons_config'),
8059986Sandreas@sandberg.pp.se                 log_file = joinpath(build_root, 'scons_config.log'),
8069986Sandreas@sandberg.pp.se                 custom_tests = {
8079986Sandreas@sandberg.pp.se        'CheckLeading' : CheckLeading,
8089986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
8099986Sandreas@sandberg.pp.se        })
8109986Sandreas@sandberg.pp.se
8119986Sandreas@sandberg.pp.se# Check for leading underscores.  Don't really need to worry either
8129986Sandreas@sandberg.pp.se# way so don't need to check the return code.
8139986Sandreas@sandberg.pp.seconf.CheckLeading()
8149986Sandreas@sandberg.pp.se
8159986Sandreas@sandberg.pp.se# Check if we should compile a 64 bit binary on Mac OS X/Darwin
8169986Sandreas@sandberg.pp.setry:
8172638Sstever@eecs.umich.edu    import platform
8182638Sstever@eecs.umich.edu    uname = platform.uname()
8196121Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
8203716Sstever@eecs.umich.edu        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
8215522Snate@binkert.org            main.Append(CCFLAGS=['-arch', 'x86_64'])
8229986Sandreas@sandberg.pp.se            main.Append(CFLAGS=['-arch', 'x86_64'])
8239986Sandreas@sandberg.pp.se            main.Append(LINKFLAGS=['-arch', 'x86_64'])
8249986Sandreas@sandberg.pp.se            main.Append(ASFLAGS=['-arch', 'x86_64'])
8259986Sandreas@sandberg.pp.seexcept:
8265522Snate@binkert.org    pass
8275522Snate@binkert.org
8285522Snate@binkert.org# Recent versions of scons substitute a "Null" object for Configure()
8295522Snate@binkert.org# when configuration isn't necessary, e.g., if the "--help" option is
8301858SN/A# present.  Unfortuantely this Null object always returns false,
8315227Ssaidi@eecs.umich.edu# breaking all our configuration checks.  We replace it with our own
8325227Ssaidi@eecs.umich.edu# more optimistic null object that returns True instead.
8335227Ssaidi@eecs.umich.eduif not conf:
8345227Ssaidi@eecs.umich.edu    def NullCheck(*args, **kwargs):
8356654Snate@binkert.org        return True
8366654Snate@binkert.org
8377769SAli.Saidi@ARM.com    class NullConf:
8387769SAli.Saidi@ARM.com        def __init__(self, env):
8397769SAli.Saidi@ARM.com            self.env = env
8407769SAli.Saidi@ARM.com        def Finish(self):
8415227Ssaidi@eecs.umich.edu            return self.env
8425227Ssaidi@eecs.umich.edu        def __getattr__(self, mname):
8435227Ssaidi@eecs.umich.edu            return NullCheck
8445204Sstever@gmail.com
8455204Sstever@gmail.com    conf = NullConf(main)
8465204Sstever@gmail.com
8475204Sstever@gmail.com# Cache build files in the supplied directory.
8485204Sstever@gmail.comif main['M5_BUILD_CACHE']:
8495204Sstever@gmail.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
8505204Sstever@gmail.com    CacheDir(main['M5_BUILD_CACHE'])
8515204Sstever@gmail.com
8525204Sstever@gmail.com# Find Python include and library directories for embedding the
8535204Sstever@gmail.com# interpreter. We rely on python-config to resolve the appropriate
8545204Sstever@gmail.com# includes and linker flags. ParseConfig does not seem to understand
8555204Sstever@gmail.com# the more exotic linker flags such as -Xlinker and -export-dynamic so
8565204Sstever@gmail.com# we add them explicitly below. If you want to link in an alternate
8575204Sstever@gmail.com# version of python, see above for instructions on how to invoke
8585204Sstever@gmail.com# scons with the appropriate PATH set.
8595204Sstever@gmail.com#
8605204Sstever@gmail.com# First we check if python2-config exists, else we use python-config
8616121Snate@binkert.orgpython_config = readCommand(['which', 'python2-config'], exception='').strip()
8625204Sstever@gmail.comif not os.path.exists(python_config):
8637727SAli.Saidi@ARM.com    python_config = readCommand(['which', 'python-config'],
8647727SAli.Saidi@ARM.com                                exception='').strip()
8657727SAli.Saidi@ARM.compy_includes = readCommand([python_config, '--includes'],
8667727SAli.Saidi@ARM.com                          exception='').split()
8677727SAli.Saidi@ARM.com# Strip the -I from the include folders before adding them to the
8689812Sandreas.hansson@arm.com# CPPPATH
8699812Sandreas.hansson@arm.commain.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
8709812Sandreas.hansson@arm.com
8719812Sandreas.hansson@arm.com# Read the linker flags and split them into libraries and other link
8729812Sandreas.hansson@arm.com# flags. The libraries are added later through the call the CheckLib.
8739812Sandreas.hansson@arm.compy_ld_flags = readCommand([python_config, '--ldflags'], exception='').split()
8749812Sandreas.hansson@arm.compy_libs = []
8759812Sandreas.hansson@arm.comfor lib in py_ld_flags:
8769812Sandreas.hansson@arm.com     if not lib.startswith('-l'):
8779812Sandreas.hansson@arm.com         main.Append(LINKFLAGS=[lib])
8789812Sandreas.hansson@arm.com     else:
8799812Sandreas.hansson@arm.com         lib = lib[2:]
8809812Sandreas.hansson@arm.com         if lib not in py_libs:
8819812Sandreas.hansson@arm.com             py_libs.append(lib)
8829812Sandreas.hansson@arm.com
8839812Sandreas.hansson@arm.com# verify that this stuff works
8849812Sandreas.hansson@arm.comif not conf.CheckHeader('Python.h', '<>'):
8859812Sandreas.hansson@arm.com    print "Error: can't find Python.h header in", py_includes
8869812Sandreas.hansson@arm.com    print "Install Python headers (package python-dev on Ubuntu and RedHat)"
8879812Sandreas.hansson@arm.com    Exit(1)
8889812Sandreas.hansson@arm.com
8899812Sandreas.hansson@arm.comfor lib in py_libs:
8909812Sandreas.hansson@arm.com    if not conf.CheckLib(lib):
8919812Sandreas.hansson@arm.com        print "Error: can't find library %s required by python" % lib
8927727SAli.Saidi@ARM.com        Exit(1)
8935863Snate@binkert.org
8943118Sstever@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
8955863Snate@binkert.orgif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
8969239Sandreas.hansson@arm.com   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
8973118Sstever@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
8983118Sstever@eecs.umich.edu       Exit(1)
8995863Snate@binkert.org
9005863Snate@binkert.org# Check for zlib.  If the check passes, libz will be automatically
9015863Snate@binkert.org# added to the LIBS environment variable.
9025863Snate@binkert.orgif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
9033118Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
9043483Ssaidi@eecs.umich.edu          'and/or zlib.h header file.'
9053494Ssaidi@eecs.umich.edu    print '       Please install zlib and try again.'
9063494Ssaidi@eecs.umich.edu    Exit(1)
9073483Ssaidi@eecs.umich.edu
9083483Ssaidi@eecs.umich.edu# If we have the protobuf compiler, also make sure we have the
9093483Ssaidi@eecs.umich.edu# development libraries. If the check passes, libprotobuf will be
9103053Sstever@eecs.umich.edu# automatically added to the LIBS environment variable. After
9113053Sstever@eecs.umich.edu# this, we can use the HAVE_PROTOBUF flag to determine if we have
9123918Ssaidi@eecs.umich.edu# got both protoc and libprotobuf available.
9133053Sstever@eecs.umich.edumain['HAVE_PROTOBUF'] = main['PROTOC'] and \
9143053Sstever@eecs.umich.edu    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
9153053Sstever@eecs.umich.edu                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
9163053Sstever@eecs.umich.edu
9173053Sstever@eecs.umich.edu# If we have the compiler but not the library, print another warning.
9189396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
9199396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
9209396Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
9219396Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
9229396Sandreas.hansson@arm.com    termcap.Normal
9239396Sandreas.hansson@arm.com
9249396Sandreas.hansson@arm.com# Check for librt.
9259396Sandreas.hansson@arm.comhave_posix_clock = \
9269396Sandreas.hansson@arm.com    conf.CheckLibWithHeader(None, 'time.h', 'C',
9279477Sandreas.hansson@arm.com                            'clock_nanosleep(0,0,NULL,NULL);') or \
9289396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('rt', 'time.h', 'C',
9299477Sandreas.hansson@arm.com                            'clock_nanosleep(0,0,NULL,NULL);')
9309477Sandreas.hansson@arm.com
9319477Sandreas.hansson@arm.comhave_posix_timers = \
9329477Sandreas.hansson@arm.com    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
9339396Sandreas.hansson@arm.com                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
9347840Snate@binkert.org
9357865Sgblack@eecs.umich.eduif conf.CheckLib('tcmalloc'):
9367865Sgblack@eecs.umich.edu    main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
9377865Sgblack@eecs.umich.eduelif conf.CheckLib('tcmalloc_minimal'):
9387865Sgblack@eecs.umich.edu    main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
9397865Sgblack@eecs.umich.eduelse:
9407840Snate@binkert.org    print termcap.Yellow + termcap.Bold + \
9419900Sandreas@sandberg.pp.se          "You can get a 12% performance improvement by installing tcmalloc "\
9429900Sandreas@sandberg.pp.se          "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
9439900Sandreas@sandberg.pp.se          termcap.Normal
9449900Sandreas@sandberg.pp.se
9459591Sandreas@sandberg.pp.seif not have_posix_clock:
9469591Sandreas@sandberg.pp.se    print "Can't find library for POSIX clocks."
9479591Sandreas@sandberg.pp.se
9489590Sandreas@sandberg.pp.se# Check for <fenv.h> (C99 FP environment control)
9499590Sandreas@sandberg.pp.sehave_fenv = conf.CheckHeader('fenv.h', '<>')
9509045SAli.Saidi@ARM.comif not have_fenv:
9519045SAli.Saidi@ARM.com    print "Warning: Header file <fenv.h> not found."
9529071Sandreas.hansson@arm.com    print "         This host has no IEEE FP rounding mode control."
9539071Sandreas.hansson@arm.com
9549045SAli.Saidi@ARM.com# Check if we should enable KVM-based hardware virtualization. The API
9557840Snate@binkert.org# we rely on exists since version 2.6.36 of the kernel, but somehow
9567840Snate@binkert.org# the KVM_API_VERSION does not reflect the change. We test for one of
9577840Snate@binkert.org# the types as a fall back.
9581858SN/Ahave_kvm = conf.CheckHeader('linux/kvm.h', '<>') and \
9591858SN/A    conf.CheckTypeSize('struct kvm_xsave', '#include <linux/kvm.h>') != 0
9601858SN/Aif not have_kvm:
9611858SN/A    print "Info: Compatible header file <linux/kvm.h> not found, " \
9621858SN/A        "disabling KVM support."
9631858SN/A
9649903Sandreas.hansson@arm.com# Check if the requested target ISA is compatible with the host
9659903Sandreas.hansson@arm.comdef is_isa_kvm_compatible(isa):
9669903Sandreas.hansson@arm.com    isa_comp_table = {
9679903Sandreas.hansson@arm.com        "arm" : ( "armv7l" ),
9689903Sandreas.hansson@arm.com        "x86" : ( "x86_64" ),
9699903Sandreas.hansson@arm.com        }
9709651SAndreas.Sandberg@ARM.com    try:
9719903Sandreas.hansson@arm.com        import platform
9729651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
9739651SAndreas.Sandberg@ARM.com    except:
9749651SAndreas.Sandberg@ARM.com        print "Warning: Failed to determine host ISA."
9759651SAndreas.Sandberg@ARM.com        return False
9769651SAndreas.Sandberg@ARM.com
9779657Sandreas.sandberg@arm.com    return host_isa in isa_comp_table.get(isa, [])
9789883Sandreas@sandberg.pp.se
9799651SAndreas.Sandberg@ARM.com
9809651SAndreas.Sandberg@ARM.com# Check if the exclude_host attribute is available. We want this to
9819651SAndreas.Sandberg@ARM.com# get accurate instruction counts in KVM.
9829651SAndreas.Sandberg@ARM.commain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
9839651SAndreas.Sandberg@ARM.com    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
9849651SAndreas.Sandberg@ARM.com
9859651SAndreas.Sandberg@ARM.com
9869651SAndreas.Sandberg@ARM.com######################################################################
9879651SAndreas.Sandberg@ARM.com#
9889651SAndreas.Sandberg@ARM.com# Finish the configuration
9899651SAndreas.Sandberg@ARM.com#
9909986Sandreas@sandberg.pp.semain = conf.Finish()
9919986Sandreas@sandberg.pp.se
9929986Sandreas@sandberg.pp.se######################################################################
9939986Sandreas@sandberg.pp.se#
9949986Sandreas@sandberg.pp.se# Collect all non-global variables
9959986Sandreas@sandberg.pp.se#
9965863Snate@binkert.org
9975863Snate@binkert.org# Define the universe of supported ISAs
9985863Snate@binkert.orgall_isa_list = [ ]
9995863Snate@binkert.orgExport('all_isa_list')
10006121Snate@binkert.org
10011858SN/Aclass CpuModel(object):
10025863Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
10035863Snate@binkert.org    know about a particular CPU model.'''
10045863Snate@binkert.org
10055863Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
10065863Snate@binkert.org    dict = {}
10072139SN/A    list = []
10084202Sbinkertn@umich.edu    defaults = []
10094202Sbinkertn@umich.edu
10102139SN/A    # Constructor.  Automatically adds models to CpuModel.dict.
10116994Snate@binkert.org    def __init__(self, name, filename, includes, strings, default=False):
10126994Snate@binkert.org        self.name = name           # name of model
10136994Snate@binkert.org        self.filename = filename   # filename for output exec code
10146994Snate@binkert.org        self.includes = includes   # include files needed in exec file
10156994Snate@binkert.org        # The 'strings' dict holds all the per-CPU symbols we can
10166994Snate@binkert.org        # substitute into templates etc.
10176994Snate@binkert.org        self.strings = strings
10186994Snate@binkert.org
10196994Snate@binkert.org        # This cpu is enabled by default
10206994Snate@binkert.org        self.default = default
10216994Snate@binkert.org
10226994Snate@binkert.org        # Add self to dict
10236994Snate@binkert.org        if name in CpuModel.dict:
10246994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
10256994Snate@binkert.org        CpuModel.dict[name] = self
10266994Snate@binkert.org        CpuModel.list.append(name)
10276994Snate@binkert.org
10286994Snate@binkert.orgExport('CpuModel')
10296994Snate@binkert.org
10306994Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
10316994Snate@binkert.org# one invocation to the next (unless overridden, in which case the new
10326994Snate@binkert.org# value becomes sticky).
10336994Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
10346994Snate@binkert.orgExport('sticky_vars')
10356994Snate@binkert.org
10366994Snate@binkert.org# Sticky variables that should be exported
10376994Snate@binkert.orgexport_vars = []
10386994Snate@binkert.orgExport('export_vars')
10392155SN/A
10405863Snate@binkert.org# For Ruby
10411869SN/Aall_protocols = []
10421869SN/AExport('all_protocols')
10435863Snate@binkert.orgprotocol_dirs = []
10445863Snate@binkert.orgExport('protocol_dirs')
10454202Sbinkertn@umich.eduslicc_includes = []
10466108Snate@binkert.orgExport('slicc_includes')
10476108Snate@binkert.org
10486108Snate@binkert.org# Walk the tree and execute all SConsopts scripts that wil add to the
10496108Snate@binkert.org# above variables
10509219Spower.jg@gmail.comif GetOption('verbose'):
10519219Spower.jg@gmail.com    print "Reading SConsopts"
10529219Spower.jg@gmail.comfor bdir in [ base_dir ] + extras_dir_list:
10539219Spower.jg@gmail.com    if not isdir(bdir):
10549219Spower.jg@gmail.com        print "Error: directory '%s' does not exist" % bdir
10559219Spower.jg@gmail.com        Exit(1)
10569219Spower.jg@gmail.com    for root, dirs, files in os.walk(bdir):
10579219Spower.jg@gmail.com        if 'SConsopts' in files:
10584202Sbinkertn@umich.edu            if GetOption('verbose'):
10595863Snate@binkert.org                print "Reading", joinpath(root, 'SConsopts')
106010135SCurtis.Dunham@arm.com            SConscript(joinpath(root, 'SConsopts'))
10618474Sgblack@eecs.umich.edu
10625742Snate@binkert.orgall_isa_list.sort()
10638268Ssteve.reinhardt@amd.com
10648268Ssteve.reinhardt@amd.comsticky_vars.AddVariables(
10658268Ssteve.reinhardt@amd.com    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
10665742Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
10675341Sstever@gmail.com                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
10688474Sgblack@eecs.umich.edu                 sorted(CpuModel.list)),
10698474Sgblack@eecs.umich.edu    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
10705342Sstever@gmail.com                 False),
10714202Sbinkertn@umich.edu    BoolVariable('SS_COMPATIBLE_FP',
10724202Sbinkertn@umich.edu                 'Make floating-point results compatible with SimpleScalar',
10734202Sbinkertn@umich.edu                 False),
10745863Snate@binkert.org    BoolVariable('USE_SSE2',
10755863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
10766994Snate@binkert.org                 False),
10776994Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
10786994Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
10795863Snate@binkert.org    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
10805863Snate@binkert.org    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm),
10815863Snate@binkert.org    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
10825863Snate@binkert.org                  all_protocols),
10835863Snate@binkert.org    )
10845863Snate@binkert.org
10855863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
10865863Snate@binkert.orgexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
10877840Snate@binkert.org                'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF',
10885863Snate@binkert.org                'HAVE_PERF_ATTR_EXCLUDE_HOST']
10895952Ssaidi@eecs.umich.edu
10909651SAndreas.Sandberg@ARM.com###################################################
10919219Spower.jg@gmail.com#
10929219Spower.jg@gmail.com# Define a SCons builder for configuration flag headers.
10931869SN/A#
10941858SN/A###################################################
10955863Snate@binkert.org
10969420Sandreas.hansson@arm.com# This function generates a config header file that #defines the
10979986Sandreas@sandberg.pp.se# variable symbol to the current variable setting (0 or 1).  The source
10989986Sandreas@sandberg.pp.se# operands are the name of the variable and a Value node containing the
10991858SN/A# value of the variable.
1100955SN/Adef build_config_file(target, source, env):
1101955SN/A    (variable, value) = [s.get_contents() for s in source]
11021869SN/A    f = file(str(target[0]), 'w')
11031869SN/A    print >> f, '#define', variable, value
11041869SN/A    f.close()
11051869SN/A    return None
11061869SN/A
11075863Snate@binkert.org# Combine the two functions into a scons Action object.
11085863Snate@binkert.orgconfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
11095863Snate@binkert.org
11101869SN/A# The emitter munges the source & target node lists to reflect what
11115863Snate@binkert.org# we're really doing.
11121869SN/Adef config_emitter(target, source, env):
11135863Snate@binkert.org    # extract variable name from Builder arg
11141869SN/A    variable = str(target[0])
11151869SN/A    # True target is config header file
11161869SN/A    target = joinpath('config', variable.lower() + '.hh')
11171869SN/A    val = env[variable]
11188483Sgblack@eecs.umich.edu    if isinstance(val, bool):
11191869SN/A        # Force value to 0/1
11201869SN/A        val = int(val)
11211869SN/A    elif isinstance(val, str):
11221869SN/A        val = '"' + val + '"'
11235863Snate@binkert.org
11245863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
11251869SN/A    return ([target], [Value(variable), Value(val)])
11265863Snate@binkert.org
11275863Snate@binkert.orgconfig_builder = Builder(emitter = config_emitter, action = config_action)
11283356Sbinkertn@umich.edu
11293356Sbinkertn@umich.edumain.Append(BUILDERS = { 'ConfigFile' : config_builder })
11303356Sbinkertn@umich.edu
11313356Sbinkertn@umich.edu# libelf build is shared across all configs in the build root.
11323356Sbinkertn@umich.edumain.SConscript('ext/libelf/SConscript',
11334781Snate@binkert.org                variant_dir = joinpath(build_root, 'libelf'))
11345863Snate@binkert.org
11355863Snate@binkert.org# gzstream build is shared across all configs in the build root.
11361869SN/Amain.SConscript('ext/gzstream/SConscript',
11371869SN/A                variant_dir = joinpath(build_root, 'gzstream'))
11381869SN/A
11396121Snate@binkert.org# libfdt build is shared across all configs in the build root.
11401869SN/Amain.SConscript('ext/libfdt/SConscript',
11412638Sstever@eecs.umich.edu                variant_dir = joinpath(build_root, 'libfdt'))
11426121Snate@binkert.org
11436121Snate@binkert.org# fputils build is shared across all configs in the build root.
11442638Sstever@eecs.umich.edumain.SConscript('ext/fputils/SConscript',
11455749Scws3k@cs.virginia.edu                variant_dir = joinpath(build_root, 'fputils'))
11466121Snate@binkert.org
11476121Snate@binkert.org# DRAMSim2 build is shared across all configs in the build root.
11485749Scws3k@cs.virginia.edumain.SConscript('ext/dramsim2/SConscript',
11499537Satgutier@umich.edu                variant_dir = joinpath(build_root, 'dramsim2'))
11509537Satgutier@umich.edu
11519537Satgutier@umich.edu###################################################
11529537Satgutier@umich.edu#
11539888Sandreas@sandberg.pp.se# This function is used to set up a directory with switching headers
11549888Sandreas@sandberg.pp.se#
11559888Sandreas@sandberg.pp.se###################################################
11569888Sandreas@sandberg.pp.se
115710066Sandreas.hansson@arm.commain['ALL_ISA_LIST'] = all_isa_list
115810066Sandreas.hansson@arm.comall_isa_deps = {}
115910066Sandreas.hansson@arm.comdef make_switching_dir(dname, switch_headers, env):
116010066Sandreas.hansson@arm.com    # Generate the header.  target[0] is the full path of the output
11611869SN/A    # header to generate.  'source' is a dummy variable, since we get the
11621869SN/A    # list of ISAs from env['ALL_ISA_LIST'].
11633546Sgblack@eecs.umich.edu    def gen_switch_hdr(target, source, env):
11643546Sgblack@eecs.umich.edu        fname = str(target[0])
11653546Sgblack@eecs.umich.edu        isa = env['TARGET_ISA'].lower()
11663546Sgblack@eecs.umich.edu        try:
11676121Snate@binkert.org            f = open(fname, 'w')
11685863Snate@binkert.org            print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
11693546Sgblack@eecs.umich.edu            f.close()
11703546Sgblack@eecs.umich.edu        except IOError:
11713546Sgblack@eecs.umich.edu            print "Failed to create %s" % fname
11723546Sgblack@eecs.umich.edu            raise
11734781Snate@binkert.org
11744781Snate@binkert.org    # Build SCons Action object. 'varlist' specifies env vars that this
11756658Snate@binkert.org    # action depends on; when env['ALL_ISA_LIST'] changes these actions
11766658Snate@binkert.org    # should get re-executed.
11774781Snate@binkert.org    switch_hdr_action = MakeAction(gen_switch_hdr,
11783546Sgblack@eecs.umich.edu                          Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
11793546Sgblack@eecs.umich.edu
11803546Sgblack@eecs.umich.edu    # Instantiate actions for each header
11813546Sgblack@eecs.umich.edu    for hdr in switch_headers:
11827756SAli.Saidi@ARM.com        env.Command(hdr, [], switch_hdr_action)
11837816Ssteve.reinhardt@amd.com
11843546Sgblack@eecs.umich.edu    isa_target = Dir('.').up().name.lower().replace('_', '-')
11853546Sgblack@eecs.umich.edu    env['PHONY_BASE'] = '#'+isa_target
11863546Sgblack@eecs.umich.edu    all_isa_deps[isa_target] = None
11873546Sgblack@eecs.umich.edu
11884202Sbinkertn@umich.eduExport('make_switching_dir')
11893546Sgblack@eecs.umich.edu
11903546Sgblack@eecs.umich.edu# all-isas -> all-deps -> all-environs -> all_targets
11913546Sgblack@eecs.umich.edumain.Alias('#all-isas', [])
1192955SN/Amain.Alias('#all-deps', '#all-isas')
1193955SN/A
1194955SN/A# Dummy target to ensure all environments are created before telling
1195955SN/A# SCons what to actually make (the command line arguments).  We attach
11965863Snate@binkert.org# them to the dependence graph after the environments are complete.
119710135SCurtis.Dunham@arm.comORIG_BUILD_TARGETS = list(BUILD_TARGETS) # force a copy; gets closure to work.
119810135SCurtis.Dunham@arm.comdef environsComplete(target, source, env):
11995343Sstever@gmail.com    for t in ORIG_BUILD_TARGETS:
12005343Sstever@gmail.com        main.Depends('#all-targets', t)
12016121Snate@binkert.org
12025863Snate@binkert.org# Each build/* switching_dir attaches its *-environs target to #all-environs.
12034773Snate@binkert.orgmain.Append(BUILDERS = {'CompleteEnvirons' :
12045863Snate@binkert.org                        Builder(action=MakeAction(environsComplete, None))})
12052632Sstever@eecs.umich.edumain.CompleteEnvirons('#all-environs', [])
12065863Snate@binkert.org
12072023SN/Adef doNothing(**ignored): pass
12085863Snate@binkert.orgmain.Append(BUILDERS = {'Dummy': Builder(action=MakeAction(doNothing, None))})
12095863Snate@binkert.org
12105863Snate@binkert.org# The final target to which all the original targets ultimately get attached.
12115863Snate@binkert.orgmain.Dummy('#all-targets', '#all-environs')
12125863Snate@binkert.orgBUILD_TARGETS[:] = ['#all-targets']
12135863Snate@binkert.org
12145863Snate@binkert.org###################################################
12155863Snate@binkert.org#
121610135SCurtis.Dunham@arm.com# Define build environments for selected configurations.
121710135SCurtis.Dunham@arm.com#
12182632Sstever@eecs.umich.edu###################################################
12195863Snate@binkert.org
12202023SN/Afor variant_path in variant_paths:
12212632Sstever@eecs.umich.edu    if not GetOption('silent'):
12225863Snate@binkert.org        print "Building in", variant_path
12235342Sstever@gmail.com
12245863Snate@binkert.org    # Make a copy of the build-root environment to use for this config.
12252632Sstever@eecs.umich.edu    env = main.Clone()
12265863Snate@binkert.org    env['BUILDDIR'] = variant_path
12275863Snate@binkert.org
12288267Ssteve.reinhardt@amd.com    # variant_dir is the tail component of build path, and is used to
12298120Sgblack@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
12308267Ssteve.reinhardt@amd.com    (build_root, variant_dir) = splitpath(variant_path)
12318267Ssteve.reinhardt@amd.com
12328267Ssteve.reinhardt@amd.com    # Set env variables according to the build directory config.
12338267Ssteve.reinhardt@amd.com    sticky_vars.files = []
12348267Ssteve.reinhardt@amd.com    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
12358267Ssteve.reinhardt@amd.com    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
12368267Ssteve.reinhardt@amd.com    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
12378267Ssteve.reinhardt@amd.com    current_vars_file = joinpath(build_root, 'variables', variant_dir)
12388267Ssteve.reinhardt@amd.com    if isfile(current_vars_file):
12395863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
12405863Snate@binkert.org        if not GetOption('silent'):
12415863Snate@binkert.org            print "Using saved variables file %s" % current_vars_file
12422632Sstever@eecs.umich.edu    else:
12438267Ssteve.reinhardt@amd.com        # Build dir-specific variables file doesn't exist.
12448267Ssteve.reinhardt@amd.com
12458267Ssteve.reinhardt@amd.com        # Make sure the directory is there so we can create it later
12462632Sstever@eecs.umich.edu        opt_dir = dirname(current_vars_file)
12471888SN/A        if not isdir(opt_dir):
12485863Snate@binkert.org            mkdir(opt_dir)
12495863Snate@binkert.org
12501858SN/A        # Get default build variables from source tree.  Variables are
12518120Sgblack@eecs.umich.edu        # normally determined by name of $VARIANT_DIR, but can be
12528120Sgblack@eecs.umich.edu        # overridden by '--default=' arg on command line.
12537756SAli.Saidi@ARM.com        default = GetOption('default')
12542598SN/A        opts_dir = joinpath(main.root.abspath, 'build_opts')
12555863Snate@binkert.org        if default:
12561858SN/A            default_vars_files = [joinpath(build_root, 'variables', default),
12571858SN/A                                  joinpath(opts_dir, default)]
12581858SN/A        else:
12595863Snate@binkert.org            default_vars_files = [joinpath(opts_dir, variant_dir)]
12601858SN/A        existing_files = filter(isfile, default_vars_files)
12611858SN/A        if existing_files:
12621858SN/A            default_vars_file = existing_files[0]
12635863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
12641871SN/A            print "Variables file %s not found,\n  using defaults in %s" \
12651858SN/A                  % (current_vars_file, default_vars_file)
12661858SN/A        else:
12671858SN/A            print "Error: cannot find variables file %s or " \
12681858SN/A                  "default file(s) %s" \
12699651SAndreas.Sandberg@ARM.com                  % (current_vars_file, ' or '.join(default_vars_files))
12709651SAndreas.Sandberg@ARM.com            Exit(1)
12719651SAndreas.Sandberg@ARM.com
12729651SAndreas.Sandberg@ARM.com    # Apply current variable settings to env
12739900Sandreas@sandberg.pp.se    sticky_vars.Update(env)
12749900Sandreas@sandberg.pp.se
12759900Sandreas@sandberg.pp.se    help_texts["local_vars"] += \
12769900Sandreas@sandberg.pp.se        "Build variables for %s:\n" % variant_dir \
12779651SAndreas.Sandberg@ARM.com                 + sticky_vars.GenerateHelpText(env)
12789651SAndreas.Sandberg@ARM.com
12799651SAndreas.Sandberg@ARM.com    # Process variable settings.
12809651SAndreas.Sandberg@ARM.com
12819651SAndreas.Sandberg@ARM.com    if not have_fenv and env['USE_FENV']:
12829986Sandreas@sandberg.pp.se        print "Warning: <fenv.h> not available; " \
12839986Sandreas@sandberg.pp.se              "forcing USE_FENV to False in", variant_dir + "."
12849986Sandreas@sandberg.pp.se        env['USE_FENV'] = False
12859986Sandreas@sandberg.pp.se
12869986Sandreas@sandberg.pp.se    if not env['USE_FENV']:
12879986Sandreas@sandberg.pp.se        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
12889986Sandreas@sandberg.pp.se        print "         FP results may deviate slightly from other platforms."
12895863Snate@binkert.org
12905863Snate@binkert.org    if env['EFENCE']:
12911869SN/A        env.Append(LIBS=['efence'])
12921965SN/A
12937739Sgblack@eecs.umich.edu    if env['USE_KVM']:
12941965SN/A        if not have_kvm:
12952761Sstever@eecs.umich.edu            print "Warning: Can not enable KVM, host seems to lack KVM support"
12965863Snate@binkert.org            env['USE_KVM'] = False
12971869SN/A        elif not have_posix_timers:
12985863Snate@binkert.org            print "Warning: Can not enable KVM, host seems to lack support " \
12992667Sstever@eecs.umich.edu                "for POSIX timers"
13001869SN/A            env['USE_KVM'] = False
13011869SN/A        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
13022929Sktlim@umich.edu            print "Info: KVM support disabled due to unsupported host and " \
13032929Sktlim@umich.edu                "target ISA combination"
13045863Snate@binkert.org            env['USE_KVM'] = False
13052929Sktlim@umich.edu
1306955SN/A    # Warn about missing optional functionality
13078120Sgblack@eecs.umich.edu    if env['USE_KVM']:
13088120Sgblack@eecs.umich.edu        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
13098120Sgblack@eecs.umich.edu            print "Warning: perf_event headers lack support for the " \
13108120Sgblack@eecs.umich.edu                "exclude_host attribute. KVM instruction counts will " \
13118120Sgblack@eecs.umich.edu                "be inaccurate."
13128120Sgblack@eecs.umich.edu
13138120Sgblack@eecs.umich.edu    # Save sticky variable settings back to current variables file
13148120Sgblack@eecs.umich.edu    sticky_vars.Save(current_vars_file, env)
13158120Sgblack@eecs.umich.edu
13168120Sgblack@eecs.umich.edu    if env['USE_SSE2']:
13178120Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
13188120Sgblack@eecs.umich.edu
1319    # The src/SConscript file sets up the build rules in 'env' according
1320    # to the configured variables.  It returns a list of environments,
1321    # one for each variant build (debug, opt, etc.)
1322    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
1323
1324def pairwise(iterable):
1325    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
1326    a, b = itertools.tee(iterable)
1327    b.next()
1328    return itertools.izip(a, b)
1329
1330# Create false dependencies so SCons will parse ISAs, establish
1331# dependencies, and setup the build Environments serially. Either
1332# SCons (likely) and/or our SConscripts (possibly) cannot cope with -j
1333# greater than 1. It appears to be standard race condition stuff; it
1334# doesn't always fail, but usually, and the behaviors are different.
1335# Every time I tried to remove this, builds would fail in some
1336# creative new way. So, don't do that. You'll want to, though, because
1337# tests/SConscript takes a long time to make its Environments.
1338for t1, t2 in pairwise(sorted(all_isa_deps.iterkeys())):
1339    main.Depends('#%s-deps'     % t2, '#%s-deps'     % t1)
1340    main.Depends('#%s-environs' % t2, '#%s-environs' % t1)
1341
1342# base help text
1343Help('''
1344Usage: scons [scons options] [build variables] [target(s)]
1345
1346Extra scons options:
1347%(options)s
1348
1349Global build variables:
1350%(global_vars)s
1351
1352%(local_vars)s
1353''' % help_texts)
1354